 |
NXShield
v1.07
NXShield Library Reference by OpenElectrons.com
|
This class interfaces with ACCL-Nx attached to NXShield. More...
#include <ACCLNx.h>
Public Member Functions | |
| ACCLNx (uint8_t i2c_address=0x02) | |
| uint8_t | issueCommand (char command) |
| bool | aquireXpointCalibration () |
| bool | aquireXpointCalibrationEnd () |
| bool | aquireYpointCalibration () |
| bool | aquireYpointCalibrationEnd () |
| bool | aquireZpointCalibration () |
| bool | aquireZpointCalibrationEnd () |
| bool | resetFactory () |
| short | getXTilt () |
| short | getYTilt () |
| short | getZTilt () |
| int | getXAccl () |
| int | getYAccl () |
| int | getZAccl () |
| short | getSens () |
 Public Member Functions inherited from NXShieldI2C | |
| NXShieldI2C (uint8_t i2c_address) | |
| void | init (void *shield, SH_BankPort bp) |
| uint8_t | readByte (uint8_t location) |
| uint16_t | readInteger (uint8_t location) |
| uint32_t | readLong (uint8_t location) |
| uint8_t * | readRegisters (uint8_t start_register, uint8_t bytes, uint8_t *buf) |
| char * | readString (uint8_t location, uint8_t bytes_to_read, uint8_t *buffer=0, uint8_t buffer_length=0) |
| bool | writeRegisters (uint8_t start_register, uint8_t bytes_to_write, uint8_t *buffer=0) |
| bool | writeByte (uint8_t location, uint8_t data) |
| bool | writeInteger (uint8_t location, uint16_t data) |
| bool | writeLong (uint8_t location, uint32_t data) |
| char * | getFirmwareVersion () |
| char * | getVendorID () |
| char * | getDeviceID () |
| char * | getFeatureSet () |
| uint8_t | getErrorCode () |
| bool | checkAddress () |
| bool | setAddress (uint8_t address) |
| Public Member Functions inherited from BaseI2CDevice | |
| BaseI2CDevice (uint8_t i2c_address) | |
| void | initProtocol () |
| uint8_t * | readRegisters (uint8_t start_register, uint8_t bytes_to_read, uint8_t *buffer=0, uint8_t buffer_length=0, bool clear_buffer=false) |
| uint8_t | readByte (uint8_t location) |
| int16_t | readInteger (uint8_t location) |
| uint32_t | readLong (uint8_t location) |
| char * | readString (uint8_t location, uint8_t bytes_to_read, uint8_t *buffer=0, uint8_t buffer_length=0) |
| bool | writeRegisters (uint8_t start_register, uint8_t bytes_to_write, uint8_t *buffer=0) |
| bool | writeByte (uint8_t location, uint8_t data) |
| bool | writeInteger (uint8_t location, uint16_t data) |
| bool | writeLong (uint8_t location, uint32_t data) |
| bool | checkAddress () |
| bool | setAddress (uint8_t i2c_address) |
| uint8_t | getAddress () |
| uint8_t | getWriteErrorCode () |
| char * | getFirmwareVersion () |
| char * | getVendorID () |
| char * | getDeviceID () |
| char * | getFeatureSet () |
| Public Member Functions inherited from SoftI2cMaster | |
| uint8_t | start (uint8_t addressRW) |
| void | stop (void) |
| uint8_t | restart (uint8_t addressRW) |
| uint8_t | write (uint8_t b) |
| uint8_t | read (uint8_t last) |
| SoftI2cMaster (uint8_t devAddr) | |
| void | initProtocol (uint8_t sclPin=NULL, uint8_t sdaPin=NULL) |
| uint8_t * | readRegisters (uint8_t startRegister, uint8_t bytes, uint8_t *buf=NULL) |
| bool | writeRegistersWithLocation (int bytes, uint8_t *buf) |
| bool | writeRegisters (uint8_t location, uint8_t bytes_to_write, uint8_t *buffer=0) |
| bool | writeByte (uint8_t location, uint8_t data) |
| bool | writeInteger (uint8_t location, uint16_t data) |
| bool | writeLong (uint8_t location, uint32_t data) |
| char * | readString (uint8_t startRegister, uint8_t bytes, uint8_t *buf=NULL, uint8_t len=0) |
| uint8_t | readByte (uint8_t location) |
| int16_t | readInteger (uint8_t location) |
| uint32_t | readLong (uint8_t location) |
| char * | getFirmwareVersion () |
| char * | getVendorID () |
| char * | getDeviceID () |
| uint8_t | getWriteErrorCode () |
| bool | checkAddress () |
| bool | setAddress (uint8_t address) |
Additional Inherited Members | |
| Public Attributes inherited from NXShieldI2C | |
| void * | mp_shield |
| uint8_t * | _i2c_buffer |
| uint8_t | m_protocol |
| Public Attributes inherited from SoftI2cMaster | |
| uint8_t * | _so_buffer |
| Static Public Attributes inherited from BaseI2CDevice | |
| static uint8_t * | _buffer = 0 |
| static bool | b_initialized = false |
| Protected Member Functions inherited from BaseI2CDevice | |
| void | setWriteErrorCode (uint8_t code) |
This class interfaces with ACCL-Nx attached to NXShield.
| ACCLNx::ACCLNx | ( | uint8_t | i2c_address = 0x02 | ) |
constructor for the ACCLNx class; may supply an optional custom i2c address
| bool ACCLNx::aquireXpointCalibration | ( | ) |
begin acquisition of X axis calibration information from sensor's environment
| bool ACCLNx::aquireXpointCalibrationEnd | ( | ) |
end acquisition of X axis calibration information
| bool ACCLNx::aquireYpointCalibration | ( | ) |
begin acquisition of Y axis calibration information from sensor's environment
| bool ACCLNx::aquireYpointCalibrationEnd | ( | ) |
end acquisition of Y axis calibration information
| bool ACCLNx::aquireZpointCalibration | ( | ) |
begin acquisition of Z axis calibration information from sensor's environment
| bool ACCLNx::aquireZpointCalibrationEnd | ( | ) |
end acquisition of Z axis calibration information
| short ACCLNx::getSens | ( | ) |
Get currently configured sensitivity
| int ACCLNx::getXAccl | ( | ) |
get the acceleration in the x-axis direction
| short ACCLNx::getXTilt | ( | ) |
get the tilt in the x-axis direction
| int ACCLNx::getYAccl | ( | ) |
get the acceleration in the y-axis direction
| short ACCLNx::getYTilt | ( | ) |
get the tilt in the y-axis direction
| int ACCLNx::getZAccl | ( | ) |
get the acceleration in the z-axis direction
| short ACCLNx::getZTilt | ( | ) |
get the tilt in the z-axis direction
| uint8_t ACCLNx::issueCommand | ( | char | command | ) |
write a command byte at the command register of the device
| bool ACCLNx::resetFactory | ( | ) |
reset device to factory default calibration settings
1.8.5 
