OE - Pi  1.1
 All Classes Namespaces Functions
OpenElectrons_LSM303.ACCEL Class Reference

ACCEL: this class provides functions for accelerometer of the LSM303 IC for read and write operations. More...

Inheritance diagram for OpenElectrons_LSM303.ACCEL:
OpenElectrons_i2c.OpenElectrons_i2c

Public Member Functions

def __init__
 Initialize the class with the i2c address of the Accelerometer. More...
 
def accl
 Interprets signed 12 bit accelerometer data from a list. More...
 
def readAcclX
 Interprets signed 12-bit accelerometer value along x-axis. More...
 
def readAcclY
 Interprets signed 12-bit accelerometer value along y-axis. More...
 
def readAcclZ
 Interprets signed 12-bit accelerometer value along z-axis. More...
 
def readAcclAll
 Reads the accelerometer. 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...
 

Static Public Attributes

tuple ACCEL_ADDRESS = (0x32)
 
int ACCEL_REG1 = 0x20
 
int ACCEL_REG4 = 0x23
 
int ACCEL_X_L = 0x28
 
int ACCEL_X_H = 0x29
 
int ACCEL_Y_L = 0x2A
 
int ACCEL_Y_H = 0x2B
 
int ACCEL_Z_L = 0x2C
 
int ACCEL_Z_H = 0x2D
 

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
 

Detailed Description

ACCEL: this class provides functions for accelerometer of the LSM303 IC for read and write operations.

Constructor & Destructor Documentation

def OpenElectrons_LSM303.ACCEL.__init__ (   self,
  accel_address = ACCEL_ADDRESS 
)

Initialize the class with the i2c address of the Accelerometer.

Parameters
selfThe object pointer.
i2c_addressAddress of your accelerometer.

Member Function Documentation

def OpenElectrons_LSM303.ACCEL.accl (   self,
  array,
  idx 
)

Interprets signed 12 bit accelerometer data from a list.

Parameters
selfThe object pointer.
arrayThe list of accelerometer data generated from the LSM303
idxThe location of the desired element in the list
def OpenElectrons_LSM303.ACCEL.readAcclAll (   self)

Reads the accelerometer.

Parameters
selfThe object pointer.
def OpenElectrons_LSM303.ACCEL.readAcclX (   self)

Interprets signed 12-bit accelerometer value along x-axis.

Parameters
selfThe object pointer.
def OpenElectrons_LSM303.ACCEL.readAcclY (   self)

Interprets signed 12-bit accelerometer value along y-axis.

Parameters
selfThe object pointer.
def OpenElectrons_LSM303.ACCEL.readAcclZ (   self)

Interprets signed 12-bit accelerometer value along z-axis.

Parameters
selfThe object pointer.

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