rnr.i2c.i2c Class Reference

I2C class. More...

Public Member Functions
def	__init__ (self)
	Class constructor.
def	__del__ (self)
	Destructor.
def	open (self, device)
	Open a I2C bus device. More...
def	close (self)
	Close an open I2C bus device. More...
def	is_open (self)
	Test if I2C bus is open. More...
def	read (self, addr, count)
	Read data from an attached device connected to the open I2C bus. More...
def	write (self, addr, buf)
	Write data to an attached device connected to the open I2C bus. More...
def	transfer (self, addr, buf, count)
	Transfer data to an attached device connected to the open I2C bus and receive response. More...
def	write_read (self, addr, buf, count)
	Write/read data to/from an attached device connected to the open I2C bus. More...
def	check (self, addr)
	Test for the existence of a device with the given address. More...
def	scan (self)
	Scan I2C bus for all attached devices. More...
def	__init__ (self)
	Class constructor.
def	__del__ (self)
	Destructor.
def	open (self, device)
	Open a I2C bus device. More...
def	close (self)
	Close an open I2C bus device. More...
def	is_open (self)
	Test if I2C bus is open. More...
def	read (self, addr, count)
	Read data from an attached device connected to the open I2C bus. More...
def	write (self, addr, buf)
	Write data to an attached device connected to the open I2C bus. More...
def	transfer (self, addr, buf, count)
	Transfer data to an attached device connected to the open I2C bus and receive response. More...
def	write_read (self, addr, buf, count)
	Write/read data to/from an attached device connected to the open I2C bus. More...
def	check (self, addr)
	Test for the existence of a device with the given address. More...
def	scan (self)
	Scan I2C bus for all attached devices. More...
def	__init__ (self)
	Class constructor.
def	__del__ (self)
	Destructor.
def	open (self, device)
	Open a I2C bus device. More...
def	close (self)
	Close an open I2C bus device. More...
def	is_open (self)
	Test if I2C bus is open. More...
def	read (self, addr, count)
	Read data from an attached device connected to the open I2C bus. More...
def	write (self, addr, buf)
	Write data to an attached device connected to the open I2C bus. More...
def	transfer (self, addr, buf, count)
	Transfer data to an attached device connected to the open I2C bus and receive response. More...
def	write_read (self, addr, buf, count)
	Write/read data to/from an attached device connected to the open I2C bus. More...
def	check (self, addr)
	Test for the existence of a device with the given address. More...
def	scan (self)
	Scan I2C bus for all attached devices. More...

Public Attributes
	m_device
	m_fd
	m_addr

Detailed Description

I2C class.

Definition at line 107 of file i2c.py.

Member Function Documentation

def rnr.i2c.i2c.check	(		self,
			addr
	)

Test for the existence of a device with the given address.

Parameters

addr	Device address to check.

Returns

True or False.

Definition at line 278 of file i2c.py.

References rnr.i2c.i2c.m_addr, and rnr.i2c.i2c.m_fd.

Referenced by rnr.i2c.i2c.check(), and rnr.i2c.i2c.scan().

  def check(self, addr):
    rc = i2ccore.i2ccore_check(self.m_fd, self.m_addr, addr)
    self.m_addr = addr
    if rc == 1:
      return True
    else:
      return False

def rnr.i2c.i2c.check	(		self,
			addr
	)

Test for the existence of a device with the given address.

Parameters

addr	Device address to check.

Returns

True or False.

Definition at line 278 of file i2c.py.

References rnr.i2c.i2c.check(), rnr.i2c.i2c.m_addr, and rnr.i2c.i2c.m_fd.

  def check(self, addr):
    rc = i2ccore.i2ccore_check(self.m_fd, self.m_addr, addr)
    self.m_addr = addr
    if rc == 1:
      return True
    else:
      return False

def rnr.i2c.i2c.check	(		self,
			addr
	)

Test for the existence of a device with the given address.

Parameters

addr	Device address to check.

Returns

True or False.

Definition at line 278 of file i2c.py.

References rnr.i2c.i2c.check(), rnr.i2c.i2c.m_addr, and rnr.i2c.i2c.m_fd.

  def check(self, addr):
    rc = i2ccore.i2ccore_check(self.m_fd, self.m_addr, addr)
    self.m_addr = addr
    if rc == 1:
      return True
    else:
      return False

def rnr.i2c.i2c.close

(

self

)

Close an open I2C bus device.

Raises I2CException on error.

Definition at line 144 of file i2c.py.

References rnr.i2c.i2c.m_addr, rnr.i2c.i2c.m_device, and rnr.i2c.i2c.m_fd.

Referenced by rnr.i2c.i2c.__del__(), and rnr.i2c.i2c.close().

  def close(self):
    if self.m_fd >= 0:
      rc = i2ccore.i2ccore_close(self.m_fd)
      if rc < 0:
        e = -rc
        raise I2CException("%s: close(): %s: (errno=%d)." % \
            (self.m_device, os.strerror(e), e))
    self.m_device  = ""
    self.m_fd      = -1
    self.m_addr    = I2C_ADDR_NONE

def rnr.i2c.i2c.close

(

self

)

Close an open I2C bus device.

Raises I2CException on error.

Definition at line 144 of file i2c.py.

References rnr.i2c.i2c.close(), rnr.i2c.i2c.m_addr, rnr.i2c.i2c.m_device, and rnr.i2c.i2c.m_fd.

  def close(self):
    if self.m_fd >= 0:
      rc = i2ccore.i2ccore_close(self.m_fd)
      if rc < 0:
        e = -rc
        raise I2CException("%s: close(): %s: (errno=%d)." % \
            (self.m_device, os.strerror(e), e))
    self.m_device  = ""
    self.m_fd      = -1
    self.m_addr    = I2C_ADDR_NONE

def rnr.i2c.i2c.close

(

self

)

Close an open I2C bus device.

Raises I2CException on error.

Definition at line 144 of file i2c.py.

References rnr.i2c.i2c.close(), rnr.i2c.i2c.m_addr, rnr.i2c.i2c.m_device, and rnr.i2c.i2c.m_fd.

  def close(self):
    if self.m_fd >= 0:
      rc = i2ccore.i2ccore_close(self.m_fd)
      if rc < 0:
        e = -rc
        raise I2CException("%s: close(): %s: (errno=%d)." % \
            (self.m_device, os.strerror(e), e))
    self.m_device  = ""
    self.m_fd      = -1
    self.m_addr    = I2C_ADDR_NONE

def rnr.i2c.i2c.is_open

(

self

)

Test if I2C bus is open.

Returns

True or False.

Definition at line 160 of file i2c.py.

References rnr.i2c.i2c.is_open(), and rnr.i2c.i2c.m_fd.

  def is_open(self):
    if self.m_fd < 0:
      return False
    else:
      return True

def rnr.i2c.i2c.is_open

(

self

)

Test if I2C bus is open.

Returns

True or False.

Definition at line 160 of file i2c.py.

References rnr.i2c.i2c.m_fd.

Referenced by rnr.i2c.i2c.is_open().

  def is_open(self):
    if self.m_fd < 0:
      return False
    else:
      return True

def rnr.i2c.i2c.is_open

(

self

)

Test if I2C bus is open.

Returns

True or False.

Definition at line 160 of file i2c.py.

References rnr.i2c.i2c.is_open(), and rnr.i2c.i2c.m_fd.

  def is_open(self):
    if self.m_fd < 0:
      return False
    else:
      return True

def rnr.i2c.i2c.open	(		self,
			device
	)

Open a I2C bus device.

Raises I2CException on error.

Parameters

device

I2C device name (e.g. /dev/i2c-3).

Definition at line 130 of file i2c.py.

References rnr.i2c.i2c.m_device, and rnr.i2c.i2c.m_fd.

Referenced by rnr.i2c.i2c.open().

  def open(self, device):
    fd = i2ccore.i2ccore_open(device)
    if fd < 0:
      e = -fd
      raise I2CException("%s: open(): %s: (errno=%d)." % \
          (device, os.strerror(e), e))
    self.m_device = device
    self.m_fd = fd;

def rnr.i2c.i2c.open	(		self,
			device
	)

Open a I2C bus device.

Raises I2CException on error.

Parameters

device

I2C device name (e.g. /dev/i2c-3).

Definition at line 130 of file i2c.py.

References rnr.i2c.i2c.m_device, rnr.i2c.i2c.m_fd, and rnr.i2c.i2c.open().

  def open(self, device):
    fd = i2ccore.i2ccore_open(device)
    if fd < 0:
      e = -fd
      raise I2CException("%s: open(): %s: (errno=%d)." % \
          (device, os.strerror(e), e))
    self.m_device = device
    self.m_fd = fd;

def rnr.i2c.i2c.open	(		self,
			device
	)

Open a I2C bus device.

Raises I2CException on error.

Parameters

device

I2C device name (e.g. /dev/i2c-3).

Definition at line 130 of file i2c.py.

References rnr.i2c.i2c.m_device, rnr.i2c.i2c.m_fd, and rnr.i2c.i2c.open().

  def open(self, device):
    fd = i2ccore.i2ccore_open(device)
    if fd < 0:
      e = -fd
      raise I2CException("%s: open(): %s: (errno=%d)." % \
          (device, os.strerror(e), e))
    self.m_device = device
    self.m_fd = fd;

def rnr.i2c.i2c.read	(		self,
			addr,
			count
	)

Read data from an attached device connected to the open I2C bus.

Raises I2CException on error.

Parameters

addr	Attached device address.
count	Number of bytes to read.

Returns

List of bytes.

Definition at line 176 of file i2c.py.

References rnr.i2c.i2c.m_addr, rnr.i2c.i2c.m_device, and rnr.i2c.i2c.m_fd.

Referenced by rnr.i2c.i2c.read(), and rnr.i2c.i2c.write_read().

  def read(self, addr, count):
    try:
      rbuf = basetypes.ByteBuf(count)
    except AssertionError, inst:
      raise I2CException("%s: read(0x%02x, ...): %s" % \
          (self.m_device, addr, inst.message))
    n = i2ccore.i2ccore_read(self.m_fd, self.m_addr, addr,
                  rbuf.getSwigObj(), basetypes.sizeof(rbuf))
    if n < 0:
      e = -n
      raise I2CException("%s: read(0x%02x, ...): %s: (errno=%d)." % \
          (self.m_device, addr, os.strerror(e), e))
    self.m_addr = addr
    try:
      rbuf.copyFromSwigObj(n)
    except AssertionError, inst:
      raise I2CException("%s: read(0x%02x, ...): %s" % \
          (self.m_device, addr, inst.message))
    return rbuf.buf

def rnr.i2c.i2c.read	(		self,
			addr,
			count
	)

Read data from an attached device connected to the open I2C bus.

Raises I2CException on error.

Parameters

addr	Attached device address.
count	Number of bytes to read.

Returns

List of bytes.

Definition at line 176 of file i2c.py.

References rnr.i2c.i2c.m_addr, rnr.i2c.i2c.m_device, rnr.i2c.i2c.m_fd, and rnr.i2c.i2c.read().

  def read(self, addr, count):
    try:
      rbuf = basetypes.ByteBuf(count)
    except AssertionError, inst:
      raise I2CException("%s: read(0x%02x, ...): %s" % \
          (self.m_device, addr, inst.message))
    n = i2ccore.i2ccore_read(self.m_fd, self.m_addr, addr,
                  rbuf.getSwigObj(), basetypes.sizeof(rbuf))
    if n < 0:
      e = -n
      raise I2CException("%s: read(0x%02x, ...): %s: (errno=%d)." % \
          (self.m_device, addr, os.strerror(e), e))
    self.m_addr = addr
    try:
      rbuf.copyFromSwigObj(n)
    except AssertionError, inst:
      raise I2CException("%s: read(0x%02x, ...): %s" % \
          (self.m_device, addr, inst.message))
    return rbuf.buf

def rnr.i2c.i2c.read	(		self,
			addr,
			count
	)

Read data from an attached device connected to the open I2C bus.

Raises I2CException on error.

Parameters

addr	Attached device address.
count	Number of bytes to read.

Returns

List of bytes.

Definition at line 176 of file i2c.py.

References rnr.i2c.i2c.m_addr, rnr.i2c.i2c.m_device, rnr.i2c.i2c.m_fd, and rnr.i2c.i2c.read().

  def read(self, addr, count):
    try:
      rbuf = basetypes.ByteBuf(count)
    except AssertionError, inst:
      raise I2CException("%s: read(0x%02x, ...): %s" % \
          (self.m_device, addr, inst.message))
    n = i2ccore.i2ccore_read(self.m_fd, self.m_addr, addr,
                  rbuf.getSwigObj(), basetypes.sizeof(rbuf))
    if n < 0:
      e = -n
      raise I2CException("%s: read(0x%02x, ...): %s: (errno=%d)." % \
          (self.m_device, addr, os.strerror(e), e))
    self.m_addr = addr
    try:
      rbuf.copyFromSwigObj(n)
    except AssertionError, inst:
      raise I2CException("%s: read(0x%02x, ...): %s" % \
          (self.m_device, addr, inst.message))
    return rbuf.buf

def rnr.i2c.i2c.scan

(

self

)

Scan I2C bus for all attached devices.

Returns

List of addresses of found devices.

Definition at line 291 of file i2c.py.

References rnr.i2c.i2c.check(), and rnr.i2c.i2c.scan().

  def scan(self):
    found = [] 
    for addr in range(I2C_ADDR_LOW, I2C_ADDR_HIGH+1):
      if self.check(addr):
        found += [addr]
    return found

def rnr.i2c.i2c.scan

(

self

)

Scan I2C bus for all attached devices.

Returns

List of addresses of found devices.

Definition at line 291 of file i2c.py.

References rnr.i2c.i2c.check().

Referenced by rnr.i2c.i2c.scan().

  def scan(self):
    found = [] 
    for addr in range(I2C_ADDR_LOW, I2C_ADDR_HIGH+1):
      if self.check(addr):
        found += [addr]
    return found

def rnr.i2c.i2c.scan

(

self

)

Scan I2C bus for all attached devices.

Returns

List of addresses of found devices.

Definition at line 291 of file i2c.py.

References rnr.i2c.i2c.check(), and rnr.i2c.i2c.scan().

  def scan(self):
    found = [] 
    for addr in range(I2C_ADDR_LOW, I2C_ADDR_HIGH+1):
      if self.check(addr):
        found += [addr]
    return found

def rnr.i2c.i2c.transfer	(		self,
			addr,
			buf,
			count
	)

Transfer data to an attached device connected to the open I2C bus and receive response.

Note

Not all devices support optimize transfer. Use write_read() as an alternate is these cases.

Raises I2CException on error.

Parameters

addr	Attached device address.
buf	Buffer to transfer.
count	Number of bytes to read back.

Definition at line 232 of file i2c.py.

References rnr.i2c.i2c.m_addr, rnr.i2c.i2c.m_device, rnr.i2c.i2c.m_fd, and rnr.i2c.i2c.transfer().

  def transfer(self, addr, buf, count):
    try:
      wbuf = basetypes.ByteBuf.Clone(buf)
      wbuf.copyToSwigObj(len(wbuf))
      rbuf = basetypes.ByteBuf(count)
    except AssertionError, inst:
      raise I2CException("%s: transfer(0x%02x, ...): %s" % \
          (self.m_device, addr, inst.message))
    rc = i2ccore.i2ccore_transfer(self.m_fd, self.m_addr, addr,
                              wbuf.getSwigObj(), len(wbuf),
                              rbuf.getSwigObj(), basetypes.sizeof(rbuf))
    if rc < 0:
      e = -rc
      raise I2CException("%s: transfer(0x%02x, ...): %s: (errno=%d)." % \
          (self.m_device, addr, os.strerror(e), e))
    self.m_addr = addr
    try:
      rbuf.copyFromSwigObj(n)
    except AssertionError, inst:
      raise I2CException("%s: read(0x%02x, ...): %s" % \
          (self.m_device, addr, inst.message))
    return rbuf.buf

def rnr.i2c.i2c.transfer	(		self,
			addr,
			buf,
			count
	)

Transfer data to an attached device connected to the open I2C bus and receive response.

Note

Not all devices support optimize transfer. Use write_read() as an alternate is these cases.

Raises I2CException on error.

Parameters

addr	Attached device address.
buf	Buffer to transfer.
count	Number of bytes to read back.

Definition at line 232 of file i2c.py.

References rnr.i2c.i2c.m_addr, rnr.i2c.i2c.m_device, and rnr.i2c.i2c.m_fd.

Referenced by rnr.i2c.i2c.transfer().

  def transfer(self, addr, buf, count):
    try:
      wbuf = basetypes.ByteBuf.Clone(buf)
      wbuf.copyToSwigObj(len(wbuf))
      rbuf = basetypes.ByteBuf(count)
    except AssertionError, inst:
      raise I2CException("%s: transfer(0x%02x, ...): %s" % \
          (self.m_device, addr, inst.message))
    rc = i2ccore.i2ccore_transfer(self.m_fd, self.m_addr, addr,
                              wbuf.getSwigObj(), len(wbuf),
                              rbuf.getSwigObj(), basetypes.sizeof(rbuf))
    if rc < 0:
      e = -rc
      raise I2CException("%s: transfer(0x%02x, ...): %s: (errno=%d)." % \
          (self.m_device, addr, os.strerror(e), e))
    self.m_addr = addr
    try:
      rbuf.copyFromSwigObj(n)
    except AssertionError, inst:
      raise I2CException("%s: read(0x%02x, ...): %s" % \
          (self.m_device, addr, inst.message))
    return rbuf.buf

def rnr.i2c.i2c.transfer	(		self,
			addr,
			buf,
			count
	)

Transfer data to an attached device connected to the open I2C bus and receive response.

Note

Not all devices support optimize transfer. Use write_read() as an alternate is these cases.

Raises I2CException on error.

Parameters

addr	Attached device address.
buf	Buffer to transfer.
count	Number of bytes to read back.

Definition at line 232 of file i2c.py.

References rnr.i2c.i2c.m_addr, rnr.i2c.i2c.m_device, rnr.i2c.i2c.m_fd, and rnr.i2c.i2c.transfer().

  def transfer(self, addr, buf, count):
    try:
      wbuf = basetypes.ByteBuf.Clone(buf)
      wbuf.copyToSwigObj(len(wbuf))
      rbuf = basetypes.ByteBuf(count)
    except AssertionError, inst:
      raise I2CException("%s: transfer(0x%02x, ...): %s" % \
          (self.m_device, addr, inst.message))
    rc = i2ccore.i2ccore_transfer(self.m_fd, self.m_addr, addr,
                              wbuf.getSwigObj(), len(wbuf),
                              rbuf.getSwigObj(), basetypes.sizeof(rbuf))
    if rc < 0:
      e = -rc
      raise I2CException("%s: transfer(0x%02x, ...): %s: (errno=%d)." % \
          (self.m_device, addr, os.strerror(e), e))
    self.m_addr = addr
    try:
      rbuf.copyFromSwigObj(n)
    except AssertionError, inst:
      raise I2CException("%s: read(0x%02x, ...): %s" % \
          (self.m_device, addr, inst.message))
    return rbuf.buf

def rnr.i2c.i2c.write	(		self,
			addr,
			buf
	)

Write data to an attached device connected to the open I2C bus.

Raises I2CException on error.

Parameters

addr	Attached device address.
buf	Buffer to write.

Definition at line 204 of file i2c.py.

References rnr.i2c.i2c.m_addr, rnr.i2c.i2c.m_device, rnr.i2c.i2c.m_fd, and rnr.i2c.i2c.write().

  def write(self, addr, buf):
    try:
      wbuf = basetypes.ByteBuf.Clone(buf)
      wbuf.copyToSwigObj(len(wbuf))
    except AssertionError, inst:
      raise I2CException("%s: write(0x%02x, ...): %s" % \
          (self.m_device, addr, inst.message))
    n = i2ccore.i2ccore_write(self.m_fd, self.m_addr, addr,
                              wbuf.getSwigObj(), len(wbuf))
    if n < 0:
      e = -n
      raise I2CException("%s: write(0x%02x, ...): %s: (errno=%d)." % \
          (self.m_device, addr, os.strerror(e), e))
    self.m_addr = addr

def rnr.i2c.i2c.write	(		self,
			addr,
			buf
	)

Write data to an attached device connected to the open I2C bus.

Raises I2CException on error.

Parameters

addr	Attached device address.
buf	Buffer to write.

Definition at line 204 of file i2c.py.

References rnr.i2c.i2c.m_addr, rnr.i2c.i2c.m_device, rnr.i2c.i2c.m_fd, and rnr.i2c.i2c.write().

  def write(self, addr, buf):
    try:
      wbuf = basetypes.ByteBuf.Clone(buf)
      wbuf.copyToSwigObj(len(wbuf))
    except AssertionError, inst:
      raise I2CException("%s: write(0x%02x, ...): %s" % \
          (self.m_device, addr, inst.message))
    n = i2ccore.i2ccore_write(self.m_fd, self.m_addr, addr,
                              wbuf.getSwigObj(), len(wbuf))
    if n < 0:
      e = -n
      raise I2CException("%s: write(0x%02x, ...): %s: (errno=%d)." % \
          (self.m_device, addr, os.strerror(e), e))
    self.m_addr = addr

def rnr.i2c.i2c.write	(		self,
			addr,
			buf
	)

Write data to an attached device connected to the open I2C bus.

Raises I2CException on error.

Parameters

addr	Attached device address.
buf	Buffer to write.

Definition at line 204 of file i2c.py.

References rnr.i2c.i2c.m_addr, rnr.i2c.i2c.m_device, and rnr.i2c.i2c.m_fd.

Referenced by rnr.i2c.i2c.write(), and rnr.i2c.i2c.write_read().

  def write(self, addr, buf):
    try:
      wbuf = basetypes.ByteBuf.Clone(buf)
      wbuf.copyToSwigObj(len(wbuf))
    except AssertionError, inst:
      raise I2CException("%s: write(0x%02x, ...): %s" % \
          (self.m_device, addr, inst.message))
    n = i2ccore.i2ccore_write(self.m_fd, self.m_addr, addr,
                              wbuf.getSwigObj(), len(wbuf))
    if n < 0:
      e = -n
      raise I2CException("%s: write(0x%02x, ...): %s: (errno=%d)." % \
          (self.m_device, addr, os.strerror(e), e))
    self.m_addr = addr

def rnr.i2c.i2c.write_read	(		self,
			addr,
			buf,
			count
	)

Write/read data to/from an attached device connected to the open I2C bus.

Raises I2CException on error.

Parameters

addr	Attached device address.
buf	Buffer to transfer.
count	Number of bytes to read back.

Returns

List of bytes.

Definition at line 267 of file i2c.py.

References rnr.i2c.i2c.read(), rnr.i2c.i2c.write(), and rnr.i2c.i2c.write_read().

  def write_read(self, addr, buf, count):
    self.write(addr, buf)
    return self.read(addr, count)

def rnr.i2c.i2c.write_read	(		self,
			addr,
			buf,
			count
	)

Write/read data to/from an attached device connected to the open I2C bus.

Raises I2CException on error.

Parameters

addr	Attached device address.
buf	Buffer to transfer.
count	Number of bytes to read back.

Returns

List of bytes.

Definition at line 267 of file i2c.py.

References rnr.i2c.i2c.read(), rnr.i2c.i2c.write(), and rnr.i2c.i2c.write_read().

  def write_read(self, addr, buf, count):
    self.write(addr, buf)
    return self.read(addr, count)

def rnr.i2c.i2c.write_read	(		self,
			addr,
			buf,
			count
	)

Write/read data to/from an attached device connected to the open I2C bus.

Raises I2CException on error.

Parameters

addr	Attached device address.
buf	Buffer to transfer.
count	Number of bytes to read back.

Returns

List of bytes.

Definition at line 267 of file i2c.py.

References rnr.i2c.i2c.read(), and rnr.i2c.i2c.write().

Referenced by rnr.i2c.i2c.write_read().

  def write_read(self, addr, buf, count):
    self.write(addr, buf)
    return self.read(addr, count)

---

The documentation for this class was generated from the following file:

• pyModules/build.x86_64/lib.linux-x86_64-2.7/rnr/i2c.py

• rnr
• i2c
• i2c
• Generated on Fri Aug 10 2018 13:54:17 for i2c by 1.8.11
• ©2018 RoadNarrows LLC www.roadnarrows.com