alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-26 13:41:16 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: more header files edited

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
VadimPopov
2015-08-09 22:51:25 +03:00
committed by Mihai Tudor Panu
parent 55e8076988
commit 04edb9be04
68 changed files with 1172 additions and 1172 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
src/lsm303/lsm303.h
View File

@ -61,7 +61,7 @@ namespace upm {
#define Z 2
/**
* @brief LSM303 accelerometer/compass library
* @brief LSM303 Accelerometer/Compass library
* @defgroup lsm303 libupm-lsm303
* @ingroup seeed adafruit i2c accelerometer compass
*/
@ -76,12 +76,12 @@ namespace upm {
* @web http://www.seeedstudio.com/wiki/Grove_-_6-Axis_Accelerometer%26Compass
* @con i2c
*
* @brief API for LSM303 Accelerometer & Compass
* @brief API for the LSM303 Accelerometer & Compass
*
* This file defines the LSM303DLH 3-axis magnetometer/3-axis accelerometer.
* This module was tested with the SeedStudio Grove [6-Axis Accelerometer&Compass]
* module that is used over i2c. The magnometer and acceleromter are accessed
* at two seperate i2c addresses.
* This module was tested with the Seeed Studio* Grove 6-Axis Accelerometer & Compass
* module used over I2C. The magnometer and acceleromter are accessed
* at two seperate I2C addresses.
*
* @image html lsm303.jpeg
* @snippet lsm303.cxx Interesting
@ -89,11 +89,11 @@ namespace upm {
class LSM303 {
public:
/**
* Instanciates a LSM303 object
* Instantiates an LSM303 object
*
* @param i2c bus
* @param addr magometer
* @param addr accelerometer
* @param addr Magnetometer
* @param addr Accelerometer
*/
LSM303 (int bus,
int addrMag=LSM303_MAG,
@ -106,60 +106,60 @@ class LSM303 {
~LSM303 ();
/**
* Get Current Heading, headings <0 indicate an error occured
* Gets the current heading; headings <0 indicate an error has occurred
*
* @return float
*/
float getHeading();
/**
* Get the coordinates in XYZ order
* Gets the coordinates in the XYZ order
*/
mraa_result_t getCoordinates();
/**
* Get accelerometer values
* Call before calling other "get" functions for acceleration
* Gets accelerometer values
* Should be called before other "get" functions for acceleration
*/
mraa_result_t getAcceleration();
/**
* Get the raw coordinate data, this will get updated when getCoordinates() is called
* Gets raw coordinate data; it is updated when getCoordinates() is called
*/
int16_t* getRawCoorData();
/**
* Just get the X component of the coordinate data
* Gets the X component of the coordinates data
*/
int16_t getCoorX();
/**
* Just get the Y component of the coordinate data
* Gets the Y component of the coordinates data
*/
int16_t getCoorY();
/**
* Just get the Z component of the coordinate data
* Gets the Z component of the coordinates data
*/
int16_t getCoorZ();
/**
* Get the raw accelerometer data, this will get updated when getAcceleration() is called
* Gets raw accelerometer data; it is updated when getAcceleration() is called
*/
int16_t* getRawAccelData();
/**
* Just get the X component of the acceleration
* Gets the X component of the acceleration data
*/
int16_t getAccelX();
/**
* Just get the Y component of the acceleration
* Gets the Y component of the acceleration data
*/
int16_t getAccelY();
/**
* Just get the Z component of the acceleration
* Gets the Z component of the acceleration data
*/
int16_t getAccelZ();