Alora Library
Library for using Alora shield
 All Classes Namespaces Files Functions Variables Macros Pages
Public Member Functions | List of all members
AloraIMUSensorBase Class Referenceabstract

Abstract class for IMU sensor adapter on Alora board. More...

#include <AloraIMUSensorInterface.h>

Inheritance diagram for AloraIMUSensorBase:
AloraIMULSM9DS1Adapter

Public Member Functions

virtual bool begin (uint8_t accAddress, uint8_t magAddress)=0
 
virtual float readAccelX ()=0
 Read X axis value from accelerometer. More...
 
virtual float readAccelY ()=0
 Read Y axis value from accelerometer. More...
 
virtual float readAccelZ ()=0
 Read Z axis value from accelerometer. More...
 
virtual float readGyroX ()=0
 Read X axis value from gyroscope. More...
 
virtual float readGyroY ()=0
 Read Y axis value from gyroscope. More...
 
virtual float readGyroZ ()=0
 Read Z axis value from gyroscope. More...
 
virtual float readMagX ()=0
 Read X axis value from magnetometer. More...
 
virtual float readMagY ()=0
 Read Y axis value from magnetometer. More...
 
virtual float readMagZ ()=0
 Read Z axis value from magnetometer. More...
 
virtual float readMagHeading ()=0
 Read heading value from magnetometer. More...
 

Detailed Description

Abstract class for IMU sensor adapter on Alora board.

Member Function Documentation

virtual bool AloraIMUSensorBase::begin ( uint8_t  accAddress,
uint8_t  magAddress 
)
pure virtual
Parameters
accAddressaccelerometer and gyroscope (if any) I2C address
magAddressmagnetometer I2C address
Returns
true if IMU sensor is initialized successfully
false if IMU sensor is not initialized

Implemented in AloraIMULSM9DS1Adapter.

virtual float AloraIMUSensorBase::readAccelX ( )
pure virtual

Read X axis value from accelerometer.

Returns
float X axis value

Implemented in AloraIMULSM9DS1Adapter.

virtual float AloraIMUSensorBase::readAccelY ( )
pure virtual

Read Y axis value from accelerometer.

Returns
float Y axis value

Implemented in AloraIMULSM9DS1Adapter.

virtual float AloraIMUSensorBase::readAccelZ ( )
pure virtual

Read Z axis value from accelerometer.

Returns
float Z axis value

Implemented in AloraIMULSM9DS1Adapter.

virtual float AloraIMUSensorBase::readGyroX ( )
pure virtual

Read X axis value from gyroscope.

Returns
float X axis value

Implemented in AloraIMULSM9DS1Adapter.

virtual float AloraIMUSensorBase::readGyroY ( )
pure virtual

Read Y axis value from gyroscope.

Returns
float Y axis value

Implemented in AloraIMULSM9DS1Adapter.

virtual float AloraIMUSensorBase::readGyroZ ( )
pure virtual

Read Z axis value from gyroscope.

Returns
float Z axis value

Implemented in AloraIMULSM9DS1Adapter.

virtual float AloraIMUSensorBase::readMagHeading ( )
pure virtual

Read heading value from magnetometer.

Returns
float heading in degree unit

Implemented in AloraIMULSM9DS1Adapter.

virtual float AloraIMUSensorBase::readMagX ( )
pure virtual

Read X axis value from magnetometer.

Returns
float X axis value

Implemented in AloraIMULSM9DS1Adapter.

virtual float AloraIMUSensorBase::readMagY ( )
pure virtual

Read Y axis value from magnetometer.

Returns
float Y axis value

Implemented in AloraIMULSM9DS1Adapter.

virtual float AloraIMUSensorBase::readMagZ ( )
pure virtual

Read Z axis value from magnetometer.

Returns
float Z axis value

Implemented in AloraIMULSM9DS1Adapter.


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