This class interfaces with AbsoluteIMU sensor attached to EVShield. More...

#include <EVs_AbsoluteIMU.h>

Inheritance diagram for EVs_AbsoluteIMU:

Public Member Functions
	EVs_AbsoluteIMU (uint8_t i2c_address=0x22)

uint8_t	issueCommand (char command)

void	readGyro (gyro &currGyro)

void	readCompass (cmps &currCompass)

void	readAccelerometer (accl &currAccelerometer)

void	readMagneticField (magnetic_field &currMagnetic_field)

bool	beginCompassCalibration ()

bool	endCompassCalibration ()

Public Member Functions inherited from EVShieldI2C
	EVShieldI2C (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=(uint8_t) NULL, uint8_t sdaPin=(uint8_t) 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 EVShieldI2C
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)

Detailed Description

This class interfaces with AbsoluteIMU sensor attached to EVShield.

Constructor & Destructor Documentation

§ EVs_AbsoluteIMU()

EVs_AbsoluteIMU::EVs_AbsoluteIMU ( uint8_t i2c_address = 0x22 )

constructor for the AbsoluteIMU; may supply an optional custom i2c address

Member Function Documentation

§ beginCompassCalibration()

bool EVs_AbsoluteIMU::beginCompassCalibration ( )

Start Compass calibration

Returns: boolean value for success or failure

§ endCompassCalibration()

bool EVs_AbsoluteIMU::endCompassCalibration ( )

End Compass calibration

Returns: boolean value for success or failure

§ issueCommand()

uint8_t EVs_AbsoluteIMU::issueCommand ( char command )

write a command byte at the command register of the device

§ readAccelerometer()

void EVs_AbsoluteIMU::readAccelerometer ( accl & currAccelerometer )

Get the Tilt and Accelerometer readings from the IMU

Parameters

accl structure

Returns: parameter is returned with values

§ readCompass()

void EVs_AbsoluteIMU::readCompass ( cmps & currCompass )

Get the Compass readings from the IMU

Parameters

cmps structure

Returns: parameter is returned with values

§ readGyro()

void EVs_AbsoluteIMU::readGyro ( gyro & currGyro )

Get the Gyro readings from the IMU

Parameters

gyro structure

Returns: parameter is returned with values

§ readMagneticField()

void EVs_AbsoluteIMU::readMagneticField ( magnetic_field & currMagnetic_field )

Get the Magnetometer readings from the IMU

Parameters

magnetic_field structure

Returns: parameter is returned with values

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

C:/Program Files (x86)/Arduino-1.6.12/libraries/EVShield/EVs_AbsoluteIMU.h
C:/Program Files (x86)/Arduino-1.6.12/libraries/EVShield/EVs_AbsoluteIMU.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

§ EVs_AbsoluteIMU()

Member Function Documentation

§ beginCompassCalibration()

§ endCompassCalibration()

§ issueCommand()

§ readAccelerometer()

§ readCompass()

§ readGyro()

§ readMagneticField()