alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-02 09:51:14 +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/bmx055/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "bmx055")
set (libdescription "Bosch bmx055, bmi055, bma250e, bmc150, bmg160, bmm150")
set (libdescription "Bosch IMU Sensor Library")
set (module_src ${libname}.cxx bma250e.cxx bmg160.cxx bmm150.cxx bmc150.cxx bmi055.cxx)
set (module_hpp ${libname}.hpp bma250e.hpp bmg160.hpp bmm150.hpp bmc150.cxx bmi055.hpp)
upm_module_init(mraa)

5
src/bmx055/bma250e.hpp
View File

@ -38,12 +38,13 @@ namespace upm {
/**
* @library bmx050
* @sensor bma250e
* @comname BMA250E 10 bit Trixial Accelerometer
* @comname Digital Triaxial Acceleration Sensor
* @type accelerometer
* @man bosch
* @con i2c spi gpio
* @web https://www.bosch-sensortec.com/bst/products/all_products/bma250e
*
* @brief API for the BMA250E 10 bit Trixial Accelerometer
* @brief API for the BMA250E 10 bit Triaxial Accelerometer
*
* The BMA250E is a triaxial, low-g acceleration sensor with digital
* output for consumer applications. It allows measurements of

6
src/bmx055/bmc150.hpp
View File

@ -37,11 +37,11 @@ namespace upm {
/**
* @library bmx055
* @sensor bmc150
* @comname BMC150 6-axis eCompass
* @comname 6-axis Ecompass
* @type accelerometer compass
* @man mouser
* @man bosch
* @con i2c gpio spi
* @web http://www.mouser.com/ProductDetail/Bosch-Sensortec/0330SB0156/?qs=sGAEpiMZZMsrChSOYEGTCd8nwjostN1SWavW0HYOOXw%3d
* @web http://www.bosch-sensortec.com/en/bst/products/all_products/homepage_1_ohne_marginalspalte_52
*
* @brief API for the BMC150 6-axis eCompass
*

5
src/bmx055/bmg160.hpp
View File

@ -38,12 +38,13 @@ namespace upm {
/**
* @library bmx050
* @sensor bmg160
* @comname BMG160 16 bit Trixial Gyroscope
* @comname 3-axis Gyroscope Sensor
* @type gyro
* @man bosch
* @con i2c spi gpio
* @web https://www.bosch-sensortec.com/bst/products/all_products/bmg160
*
* @brief API for the BMG160 16 bit Trixial Gyroscope
* @brief API for the BMG160 16 bit Triaxial Gyroscope
*
* The BMG160 is a 3-axis angular rate sensor that is made of a
* surface micro machined sensing element and an evaluation ASIC.

6
src/bmx055/bmi055.hpp
View File

@ -33,11 +33,11 @@ namespace upm {
/**
* @library bmx055
* @sensor bmi055
* @comname BMI055 6-axis Sensor Module
* @comname 6DoF Sensor Module
* @type accelerometer compass
* @man mouser
* @man bosch
* @con i2c gpio spi
* @web http://www.mouser.com/ProductDetail/Bosch-Sensortec/0330SB0134/?qs=sGAEpiMZZMsrChSOYEGTCVIRbo47L7ys6GxSnxRPEhU%3d
* @web https://www.bosch-sensortec.com/bst/products/all_products/bmi055
*
* @brief API for the BMI055 6-axis Sensor Module
*

3
src/bmx055/bmm150.hpp
View File

@ -38,11 +38,12 @@ namespace upm {
/**
* @library bmx050
* @sensor bmm150
* @comname BMM150 3-Axis Geomagnetic Sensor
* @comname 3-axis Geomagnetic Sensor
* @altname bmm050
* @type compass
* @man bosch
* @con i2c spi gpio
* @web https://www.bosch-sensortec.com/bst/products/all_products/bmm150
*
* @brief API for the BMM150 3-Axis Geomagnetic Sensor
*

6
src/bmx055/bmx055.hpp
View File

@ -40,11 +40,11 @@ namespace upm {
/**
* @library bmx055
* @sensor bmx055
* @comname BMX055 9-axis Sensor Module
* @comname 9-axis Sensor Module
* @type accelerometer compass
* @man mouser
* @man bosch
* @con i2c gpio spi
* @web http://www.mouser.com/ProductDetail/Bosch-Sensortec/0330SB0179/?qs=sGAEpiMZZMsrChSOYEGTCZo8d3KRE6KPUk8gVuWS2Ho%3d
* @web https://www.bosch-sensortec.com/bst/products/all_products/bmx055
*
* @brief API for the BMX055 9-axis Sensor Module
*