alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-05 11:21:12 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: Scrubbed ALL sensor library descriptions

Browse Source 
In an effort to clean-up and standardize UPM library
documentation, this commit updates (and in most cases,
unifies) the CMake description string AND CXX header
@comname string.

Strings were taken from datasheets when possible, spelling
mistakes were addressed, copy/paste errors where fixed,
Title Case was used, etc.

    * Tested/updated/added @web tags
    * Added/updated invalid sensor images
    * Added/updated @man tags, added missing manufacturers

Signed-off-by: Noel Eck <noel.eck@intel.com>
This commit is contained in:
Noel Eck
2016-12-15 15:15:21 -08:00
parent 7a5c8a6cb3
commit 283fce619e
416 changed files with 793 additions and 675 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/mpu9150/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "mpu9150")
set (libdescription "Gyro, acceleromter and magnometer sensor based on mpu9150")
set (libdescription "IMU Sensor Library Based On the Mpu9150")
set (module_src ${libname}.cxx ak8975.cxx mpu60x0.cxx mpu9250.cxx)
set (module_hpp ${libname}.hpp ak8975.hpp mpu60x0.hpp mpu9250.hpp)
upm_module_init(mraa)

19
src/mpu9150/ak8975.hpp
View File

@ -31,21 +31,22 @@
#define AK8975_DEFAULT_I2C_ADDR 0x0c
namespace upm {
/**
* @library mpu9150
* @sensor ak8975
* @comname AK8975 3-axis Magnetometer
* @comname 3-axis Magnetometer
* @altname AK9875
* @type compass
* @man seeed
* @con i2c
* @web http://www.akm.com/akm/en/file/datasheet/AK8975.pdf
*
* @brief API for the AK8975 magnetometer
*
* This is a 3-axis magnetometer, which can be used alone, or
* coupled with another device (such as the mcu9150 9-axis motion
* sensor).
* sensor).
*
* @snippet ak8975.cxx Interesting
*/
@ -90,14 +91,14 @@ namespace upm {
REG_ASAY = 0x11,
REG_ASAZ = 0x12
} AK8975_REG_T;
/**
* ST1 bits
*/
typedef enum {
ST1_DRDY = 0x01 // data ready bit
} ST1_BITS_T;
/**
* ST2 bits
*/
@ -105,7 +106,7 @@ namespace upm {
ST2_DERR = 0x04, // data error
ST2_HOFL = 0x08 // measurement overflow
} ST2_BITS_T;
/**
* CNTL register, operating mode values
*/
@ -115,7 +116,7 @@ namespace upm {
CNTL_SELFTEST = 0x08,
CNTL_FUSE_ACCESS = 0x0f // access fuse (coeff) registers
} CNTL_MODES_T;
/**
* ASTC (self test control) bits
*/
@ -135,7 +136,7 @@ namespace upm {
* AK8975 Destructor
*/
~AK8975();
/**
* set up initial values and start operation
*
@ -209,7 +210,7 @@ namespace upm {
* that was read and stored at init() time.
*
* @param value the raw axis value to compensate
* @param adj the adjustment coefficient
* @param adj the adjustment coefficient
* @return true if successful
*/
float adjustValue(float value, float adj);

33
src/mpu9150/mpu60x0.hpp
View File

@ -33,14 +33,15 @@
#define MPU60X0_DEFAULT_I2C_ADDR 0x68
namespace upm {
/**
* @library mpu9150
* @sensor mpu60x0
* @comname MPU60X0 3-axis Gyroscope and 3-axis Accelerometer
* @comname 3-axis Gyroscope and 3-axis Accelerometer
* @type accelerometer compass
* @man seeed
* @con i2c gpio
* @web https://www.invensense.com/products/motion-tracking/6-axis/mpu-6050/
*
* @brief API for the MPU60X0 3-axis Gyroscope and 3-axis Accelerometer
*
@ -206,7 +207,7 @@ namespace upm {
REG_WHO_AM_I = 0x75
} MPU60X0_REG_T;
/**
* CONFIG bits
*/
@ -402,7 +403,7 @@ namespace upm {
* MST_DLY is not enumerated in the register map. It configures
* the reduced access rate of i2c slaves relative to the sample
* rate. When a slave's access rate is decreased relative to the
* Sample Rate, the slave is accessed every
* Sample Rate, the slave is accessed every
* 1 / (1 + I2C_MST_DLY) samples
*/
typedef enum {
@ -433,7 +434,7 @@ namespace upm {
I2C_SLV4_DONE = 0x40,
PASS_THROUGH = 0x80
} I2C_MST_STATUS_BITS_T;
/**
* REG_INT_PIN_CFG bits
*/
@ -452,7 +453,7 @@ namespace upm {
INT_OPEN = 0x40,
INT_LEVEL = 0x80
} INT_PIN_CFG_BITS_T;
/**
* REG_INT_ENABLE bits
*/
@ -469,7 +470,7 @@ namespace upm {
MOT_EN = 0x40,
FF_EN = 0x80 // *freefall
} INT_ENABLE_BITS_T;
/**
* REG_INT_STATUS bits
*/
@ -486,7 +487,7 @@ namespace upm {
MOT_INT = 0x40,
FF_INT = 0x80 // *freefall
} INT_STATUS_BITS_T;
/**
* REG_MOT_DETECT_STATUS bits (mpu9150 only)
*/
@ -504,7 +505,7 @@ namespace upm {
MOT_XPOS = 0x40, // *
MOT_XNEG = 0x80, // *
} MOT_DETECT_STATUS_BITS_T;
/**
* REG_MST_DELAY_CTRL bits
*/
@ -519,7 +520,7 @@ namespace upm {
DELAY_ES_SHADOW = 0x80
} MST_DELAY_CTRL_BITS_T;
/**
* REG_SIGNAL_PATH_RESET bits
*/
@ -530,7 +531,7 @@ namespace upm {
// 0x08-0x80 reserved
} SIGNAL_PATH_RESET_BITS_T;
/**
* REG_MOT_DETECT_CTRL bits
*/
@ -551,7 +552,7 @@ namespace upm {
_ACCEL_ON_DELAY_MASK = 3
// 0x40,0x80 reserved
} MOT_DETECT_CTRL_BITS_T;
/**
* MOT_COUNT or FF_COUNT values (mpu9150 only)
*/
@ -588,7 +589,7 @@ namespace upm {
/// 0x80 reserved
} USER_CTRL_BITS_T;
/**
* REG_PWR_MGMT_1 bits
*/
@ -607,7 +608,7 @@ namespace upm {
PWR_SLEEP = 0x40,
DEVICE_RESET = 0x80
} PWR_MGMT_1_BITS_T;
/**
* CLKSEL values
*/
@ -638,7 +639,7 @@ namespace upm {
_LP_WAKE_CTRL_SHIFT = 6,
_LP_WAKE_CTRL_MASK = 3
} PWR_MGMT_2_BITS_T;
/**
* LP_WAKE_CTRL values
*/
@ -905,7 +906,7 @@ namespace upm {
* @return bitmask of INT_PIN_CFG_BITS_T values
*/
uint8_t getInterruptPinConfig();
/**
* install an interrupt handler.
*

2
src/mpu9150/mpu9150.hpp
View File

@ -42,7 +42,7 @@ namespace upm {
/**
* @library mpu9150
* @sensor mpu9150
* @comname MPU9150 Inertial Measurement Unit
* @comname Inertial Measurement Unit
* @altname Grove IMU 9DOF
* @type accelerometer compass
* @man seeed

2
src/mpu9150/mpu9250.hpp
View File

@ -35,7 +35,7 @@ namespace upm {
/**
* @library mpu9150
* @sensor mpu9250
* @comname MPU9250 Inertial Measurement Unit
* @comname Inertial Measurement Unit
* @altname Grove IMU 9DOF V2
* @type accelerometer compass
* @man seeed