OE - Pi
1.1
|
MAG: this class provides functions for magnetometer of the LSM303 IC for read and write operations. More...
Public Member Functions | |
def | __init__ |
Initialize the class with the i2c address of the Magnetometer. More... | |
def | readMagX |
Interprets signed 16 bit magnetometer value along x-axis. More... | |
def | readMagY |
Interprets signed 16 bit magnetometer value along y-axis. More... | |
def | readMagZ |
Interprets signed 16 bit magnetometer value along z-axis. More... | |
def | readMagAll |
Reads the magnetometer. More... | |
def | setMagnetGain |
Writes a desired gain value for the magnetometer. More... | |
Public Member Functions inherited from OpenElectrons_i2c.OpenElectrons_i2c | |
def | __init__ |
Initialize the class with the i2c address of your device. More... | |
def | errMsg |
Prints an error message if a read error is detected. More... | |
def | writeByte |
Write a byte to your i2c device at a given location. More... | |
def | readByte |
Read an unsigned byte from your i2c device at a given location. More... | |
def | simpleWriteByte |
Write a byte to your i2c device at a given location. More... | |
def | simpleReadByte |
Read an unsigned byte from your i2c device at a given location. More... | |
def | readByteSigned |
Read a signed byte from your i2c device at a given location. More... | |
def | readArray |
Read a byte array from your i2c device starting at a given location. More... | |
def | writeArray |
Write a byte array from your i2c device starting at a given location. More... | |
def | readString |
Read a string from your i2c device starting at a given location. More... | |
def | readIntegerBE |
Read an unsigned 16 bit integer from your i2c device from a given location. More... | |
def | readInteger |
Read an unsigned 16 bit integer from your i2c device from a given location. More... | |
def | readIntegerSignedBE |
Read a signed 16 bit integer from your i2c device from a given location. More... | |
def | readIntegerSigned |
Read a signed 16 bit integer from your i2c device from a given location. More... | |
def | readLongBE |
Read an unsigned 32bit integer from your i2c device from a given location. More... | |
def | readLong |
Read an unsigned 32bit integer from your i2c device from a given location. More... | |
def | readLongSignedBE |
Read a signed 32bit integer from your i2c device from a given location. More... | |
def | readLongSigned |
Read a signed 32bit integer from your i2c device from a given location. More... | |
def | GetFirmwareVersion |
Read the firmware version of the i2c device. More... | |
def | GetVendorName |
Read the vendor name of the i2c device. More... | |
def | GetDeviceId |
Read the i2c device id. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from OpenElectrons_i2c.OpenElectrons_i2c | |
def | pi_rev |
def | which_bus |
Public Attributes inherited from OpenElectrons_i2c.OpenElectrons_i2c | |
address | |
bus | |
MAG: this class provides functions for magnetometer of the LSM303 IC for read and write operations.
def OpenElectrons_LSM303.MAG.__init__ | ( | self, | |
mag_address = MAG_ADDRESS |
|||
) |
Initialize the class with the i2c address of the Magnetometer.
self | The object pointer. |
i2c_address | Address of your magnetometer. |
def OpenElectrons_LSM303.MAG.readMagAll | ( | self | ) |
Reads the magnetometer.
self | The object pointer. |
def OpenElectrons_LSM303.MAG.readMagX | ( | self | ) |
Interprets signed 16 bit magnetometer value along x-axis.
self | The object pointer. |
def OpenElectrons_LSM303.MAG.readMagY | ( | self | ) |
Interprets signed 16 bit magnetometer value along y-axis.
self | The object pointer. |
def OpenElectrons_LSM303.MAG.readMagZ | ( | self | ) |
Interprets signed 16 bit magnetometer value along z-axis.
self | The object pointer. |
def OpenElectrons_LSM303.MAG.setMagnetGain | ( | gain = MAG_G13 | ) |
Writes a desired gain value for the magnetometer.
gain | Gain value to write to the magnetometer |