rover::RoverGY521 Class Reference

RoverGY521 is a class that is inherited from RoverSensor abstract class. RoverGY521 class contains member functions and variables to set up and read from GY521 accelerometer that is embedded on the rover. More...

#include <rover_gy521.hpp>

Inheritance diagram for rover::RoverGY521:

Public Member Functions
	RoverGY521 ()
	Default Constructor for the RoverGY521 class. More...
	RoverGY521 (const int custom_i2c_address)
	Assigning Constructor for the RoverGY521 class. More...
	~RoverGY521 ()
	Destructor for the RoverGY521 class. More...
void	initialize (void)
	Function to setup RoverGY521 sensor. More...
float	read (void)
	Non implemented function. More...
int8_t	getGyroX (void)
	Returns gyroscope output for X-axis. More...
int8_t	getGyroY (void)
	Returns gyroscope output for Y-axis. More...
int8_t	getGyroZ (void)
	Returns gyroscope output for Z-axis. More...
int8_t	getAccelX (void)
	Returns accelerometer output for X-axis. More...
int8_t	getAccelY (void)
	Returns accelerometer output for Y-axis. More...
int8_t	getAccelZ (void)
	Returns accelerometer output for Z-axis. More...
float	getAngleX (void)
	Returns angle in the X-axis. More...
float	getAngleY (void)
	Returns angle in the Y-axis. More...
float	getAngleZ (void)
	Returns angle in the Z-axis. More...
Public Member Functions inherited from rover::RoverSensor
virtual	~RoverSensor ()
	Destructor for the RoverSensor class. More...

Private Attributes
int	ROVERGY521_SETUP_
	Flag to hold if RoverGY521 is initialized or not. More...
int	i2CAddress
	I2C address for overriding. More...

Detailed Description

RoverGY521 is a class that is inherited from RoverSensor abstract class. RoverGY521 class contains member functions and variables to set up and read from GY521 accelerometer that is embedded on the rover.

Constructor & Destructor Documentation

rover::RoverGY521::RoverGY521 ( )

explicit

Default Constructor for the RoverGY521 class.

rover::RoverGY521::RoverGY521 ( const int  custom_i2c_address )

explicit

Assigning Constructor for the RoverGY521 class.

Parameters

custom_i2c_address

Custom I2C address to initialize RoverGY521 sensor with.

rover::RoverGY521::~RoverGY521

(

)

Destructor for the RoverGY521 class.

Member Function Documentation

int8_t rover::RoverGY521::getAccelX

(

void

)

Returns accelerometer output for X-axis.

Returns

accelerometer_x_output

int8_t rover::RoverGY521::getAccelY

(

void

)

Returns accelerometer output for Y-axis.

Returns

accelerometer_y_output

int8_t rover::RoverGY521::getAccelZ

(

void

)

Returns accelerometer output for Z-axis.

Returns

accelerometer_z_output

float rover::RoverGY521::getAngleX

(

void

)

Returns angle in the X-axis.

Returns

angle_x

float rover::RoverGY521::getAngleY

(

void

)

Returns angle in the Y-axis.

Returns

angle_y

float rover::RoverGY521::getAngleZ

(

void

)

Returns angle in the Z-axis.

Returns

angle_z

int8_t rover::RoverGY521::getGyroX

(

void

)

Returns gyroscope output for X-axis.

Returns

gyproscope_x_output

int8_t rover::RoverGY521::getGyroY

(

void

)

Returns gyroscope output for Y-axis.

Returns

gyproscope_y_output

int8_t rover::RoverGY521::getGyroZ

(

void

)

Returns gyroscope output for Z-axis.

Returns

gyproscope_z_output

void rover::RoverGY521::initialize ( void  )

virtual

Function to setup RoverGY521 sensor.

Returns

void

Implements rover::RoverSensor.

float rover::RoverGY521::read ( void  )

virtual

Non implemented function.

Implements rover::RoverSensor.

Member Data Documentation

int rover::RoverGY521::i2CAddress

private

I2C address for overriding.

int rover::RoverGY521::ROVERGY521_SETUP_

private

Flag to hold if RoverGY521 is initialized or not.

---

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

• /home/travis/build/app4mc-rover/rover-app/include/roverapi/rover_gy521.hpp
• /home/travis/build/app4mc-rover/rover-app/src/roverapi/rover_gy521.cpp