OpenElectrons_i2c: this class provides i2c functions for read and write operations.
More...
OpenElectrons_i2c: this class provides i2c functions for read and write operations.
| def OpenElectrons_i2c.OpenElectrons_i2c.__init__ |
( |
|
self, |
|
|
|
i2c_address |
|
) |
| |
Initialize the class with the i2c address of your device.
- Parameters
-
| self | The object pointer. |
| i2c_address | Address of your device. |
| def OpenElectrons_i2c.OpenElectrons_i2c.errMsg |
( |
|
self | ) |
|
Prints an error message if a read error is detected.
- Parameters
-
| def OpenElectrons_i2c.OpenElectrons_i2c.GetDeviceId |
( |
|
self | ) |
|
Read the i2c device id.
- Parameters
-
| def OpenElectrons_i2c.OpenElectrons_i2c.GetFirmwareVersion |
( |
|
self | ) |
|
Read the firmware version of the i2c device.
- Parameters
-
| def OpenElectrons_i2c.OpenElectrons_i2c.GetVendorName |
( |
|
self | ) |
|
Read the vendor name of the i2c device.
- Parameters
-
| def OpenElectrons_i2c.OpenElectrons_i2c.readArray |
( |
|
self, |
|
|
|
reg, |
|
|
|
length |
|
) |
| |
Read a byte array from your i2c device starting at a given location.
- Parameters
-
| self | The object pointer. |
| reg | The first register in the array to read from. |
| length | The length of the array. |
| def OpenElectrons_i2c.OpenElectrons_i2c.readByte |
( |
|
self, |
|
|
|
reg |
|
) |
| |
Read an unsigned byte from your i2c device at a given location.
- Parameters
-
| self | The object pointer. |
| reg | The register to read from. |
| def OpenElectrons_i2c.OpenElectrons_i2c.readByteSigned |
( |
|
self, |
|
|
|
reg |
|
) |
| |
Read a signed byte from your i2c device at a given location.
- Parameters
-
| self | The object pointer. |
| reg | The register to read from. |
| def OpenElectrons_i2c.OpenElectrons_i2c.readInteger |
( |
|
self, |
|
|
|
reg |
|
) |
| |
Read an unsigned 16 bit integer from your i2c device from a given location.
little endian read integers.
- Parameters
-
| self | The object pointer. |
| reg | The first register of the first byte of the integer to read. |
| def OpenElectrons_i2c.OpenElectrons_i2c.readIntegerBE |
( |
|
self, |
|
|
|
reg |
|
) |
| |
Read an unsigned 16 bit integer from your i2c device from a given location.
Big-endian read integers .
- Parameters
-
| self | The object pointer. |
| reg | The first register of the first byte of the integer to read. |
| def OpenElectrons_i2c.OpenElectrons_i2c.readIntegerSigned |
( |
|
self, |
|
|
|
reg |
|
) |
| |
Read a signed 16 bit integer from your i2c device from a given location.
little endian read integers .
- Parameters
-
| self | The object pointer. |
| reg | The first register of the first byte of the integer to read. |
| def OpenElectrons_i2c.OpenElectrons_i2c.readIntegerSignedBE |
( |
|
self, |
|
|
|
reg |
|
) |
| |
Read a signed 16 bit integer from your i2c device from a given location.
Big endian read integers .
- Parameters
-
| self | The object pointer. |
| reg | The first register of the first byte of the integer to read. |
| def OpenElectrons_i2c.OpenElectrons_i2c.readLong |
( |
|
self, |
|
|
|
reg |
|
) |
| |
Read an unsigned 32bit integer from your i2c device from a given location.
little endian read integers.
- Parameters
-
| self | The object pointer. |
| reg | The first register of the first byte of the integer to read. |
| def OpenElectrons_i2c.OpenElectrons_i2c.readLongBE |
( |
|
self, |
|
|
|
reg |
|
) |
| |
Read an unsigned 32bit integer from your i2c device from a given location.
Big endian read integers.
- Parameters
-
| self | The object pointer. |
| reg | The first register of the first byte of the integer to read. |
| def OpenElectrons_i2c.OpenElectrons_i2c.readLongSigned |
( |
|
self, |
|
|
|
reg |
|
) |
| |
Read a signed 32bit integer from your i2c device from a given location.
little endian read integers .
- Parameters
-
| self | The object pointer. |
| reg | The first register of the first byte of the integer to read. |
| def OpenElectrons_i2c.OpenElectrons_i2c.readLongSignedBE |
( |
|
self, |
|
|
|
reg |
|
) |
| |
Read a signed 32bit integer from your i2c device from a given location.
Big endian read integers .
- Parameters
-
| self | The object pointer. |
| reg | The first register of the first byte of the integer to read. |
| def OpenElectrons_i2c.OpenElectrons_i2c.readString |
( |
|
self, |
|
|
|
reg, |
|
|
|
length |
|
) |
| |
Read a string from your i2c device starting at a given location.
- Parameters
-
| self | The object pointer. |
| reg | The first register of the string to read from. |
| length | The length of the string. |
| def OpenElectrons_i2c.OpenElectrons_i2c.simpleReadByte |
( |
|
self | ) |
|
Read an unsigned byte from your i2c device at a given location.
- Parameters
-
| def OpenElectrons_i2c.OpenElectrons_i2c.simpleWriteByte |
( |
|
self, |
|
|
|
value |
|
) |
| |
Write a byte to your i2c device at a given location.
- Parameters
-
| self | The object pointer. |
| value | Value to write. |
| def OpenElectrons_i2c.OpenElectrons_i2c.writeArray |
( |
|
self, |
|
|
|
reg, |
|
|
|
arr |
|
) |
| |
Write a byte array from your i2c device starting at a given location.
- Parameters
-
| self | The object pointer. |
| reg | The first register in the array to write to. |
| arr | The array to write. |
| def OpenElectrons_i2c.OpenElectrons_i2c.writeByte |
( |
|
self, |
|
|
|
reg, |
|
|
|
value |
|
) |
| |
Write a byte to your i2c device at a given location.
- Parameters
-
| self | The object pointer. |
| reg | The register to write value at. |
| value | Value to write. |
The documentation for this class was generated from the following file:
1.8.7 
