alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-03-15 04:57:30 +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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/documentation.md
View File

@ -4,7 +4,7 @@ Writing sensor documentation {#documentation}
It is highly encouraged to provide at least some basic documentation for the It is highly encouraged to provide at least some basic documentation for the
sensors that you want to add to UPM: sensors that you want to add to UPM:
- If you don't add documentation, the code review will take very long and - If you don't add documentation, the code review will take very long and
your contribution could be rejected. your contribution could be rejected.
- Try to have no warnings in doxygen, this is generally fairly easy. - Try to have no warnings in doxygen, this is generally fairly easy.
- Have the specific sensor manufacturer/model & version that you used, if you - Have the specific sensor manufacturer/model & version that you used, if you
@ -15,7 +15,7 @@ sensors that you want to add to UPM:
####The sensor block ####The sensor block
This is added just before the class declaration in your header(.h) file and has This is added just before the class declaration in your header(.h) file and has
mandatory fields. For single sensor libraries, this block will actually mandatory fields. For single sensor libraries, this block will actually
follow immediately after the library block. If you have multiple physical follow immediately after the library block. If you have multiple physical
sensors, add this to every one. sensors, add this to every one.
@ -36,7 +36,7 @@ Here's an example (disregard the "@verbatim" tags in your actual code):
* @kit <component-kit> * @kit <component-kit>
* *
* @brief Short class/sensor description * @brief Short class/sensor description
* *
* Then add a longer * Then add a longer
* description here. * description here.
* *
@ -52,8 +52,9 @@ Here's an example (disregard the "@verbatim" tags in your actual code):
- `<chip-id>` Usually the chip number used by the sensor. When this is not - `<chip-id>` Usually the chip number used by the sensor. When this is not
available or relevant, use a unique descriptor that makes sense. Must match available or relevant, use a unique descriptor that makes sense. Must match
class name. *Mandatory* class name. *Mandatory*
- `<component-name>` A short name for your sensor, try to avoid including the - `<component-name>` Title Case descriptive name for your sensor, try to avoid
manufacturer's name here. *Mandatory* including the manufacturer's name here. Examples: Digital Pressure Sensor,
Serial MP3 Module, etc... *Mandatory*
- `<alt-name>` Alternative names that your sensor driver might have. This may - `<alt-name>` Alternative names that your sensor driver might have. This may
include manufacturer's name. *Optional* include manufacturer's name. *Optional*
- `<alt-id>` Alternative chip-ids that your sensor driver supports. *Optional* - `<alt-id>` Alternative chip-ids that your sensor driver supports. *Optional*

BIN
docs/images/es9257.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 25 KiB

2
src/a110x/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME a110x upm_mixed_module_init (NAME a110x
DESCRIPTION "Hall effect sensor" DESCRIPTION "Hall Effect Sensor"
C_HDR a110x.h C_HDR a110x.h
C_SRC a110x.c C_SRC a110x.c
CPP_HDR a110x.hpp CPP_HDR a110x.hpp

2
src/a110x/a110x.hpp
View File

@ -36,7 +36,7 @@ namespace upm {
/** /**
* @library a110x * @library a110x
* @sensor a110x * @sensor a110x
* @comname A110X Hall Effect Sensor * @comname Hall Effect Sensor
* @altname Grove Hall Sensor * @altname Grove Hall Sensor
* @altid A1101, A1102, A1103, A1004, A1106 * @altid A1101, A1102, A1103, A1004, A1106
* @type electric * @type electric

2
src/ad8232/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME ad8232 upm_mixed_module_init (NAME ad8232
DESCRIPTION "Single lead heart rate monitor" DESCRIPTION "Single Lead Heart Rate Monitor"
C_HDR ad8232.h C_HDR ad8232.h
C_SRC ad8232.c C_SRC ad8232.c
CPP_HDR ad8232.hpp CPP_HDR ad8232.hpp

2
src/ad8232/ad8232.hpp
View File

@ -43,7 +43,7 @@ namespace upm {
/** /**
* @library ad8232 * @library ad8232
* @sensor ad8232 * @sensor ad8232
* @comname AD8232 Heart Rate Monitor * @comname Single Lead Heart Rate Monitor
* @type medical * @type medical
* @man sparkfun * @man sparkfun
* @web https://www.sparkfun.com/products/12650 * @web https://www.sparkfun.com/products/12650

2
src/adafruitms1438/adafruitms1438.hpp
View File

@ -46,7 +46,7 @@ namespace upm {
/** /**
* @library adafruitms1438 * @library adafruitms1438
* @sensor adafruitms1438 * @sensor adafruitms1438
* @comname Adafruit Motor Shield * @comname Module for the Adafruit Motor Shield 1438
* @type motor * @type motor
* @man adafruit * @man adafruit
* @web http://www.adafruit.com/products/1438 * @web http://www.adafruit.com/products/1438

2
src/adafruitss/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "adafruitss") set (libname "adafruitss")
set (libdescription "Adafruit pca9685 based 16-channel servo shield") set (libdescription "Adafruit Servo Shield")
set (module_src ${libname}.cxx) set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp) set (module_hpp ${libname}.hpp)
upm_module_init(mraa) upm_module_init(mraa)

2
src/adc121c021/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "adc121c021") set (libname "adc121c021")
set (libdescription "Adc121c021 I2C ADC converter module") set (libdescription "I2C 12-bit Analog to Digital Converter with Alert Pin")
set (module_src ${libname}.cxx) set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp) set (module_hpp ${libname}.hpp)
upm_module_init(mraa) upm_module_init(mraa)

2
src/adc121c021/adc121c021.hpp
View File

@ -72,7 +72,7 @@ namespace upm {
/** /**
* @library adc121c021 * @library adc121c021
* @sensor adc121c021 * @sensor adc121c021
* @comname ADC121C021 Analog-to-Digital Converter * @comname I2C 12-bit Analog to Digital Converter with Alert Pin
* @altname Grove I2C ADC * @altname Grove I2C ADC
* @type electric * @type electric
* @man seeed * @man seeed

2
src/adis16448/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "adis16448") set (libname "adis16448")
set (libdescription "High-Precision IMU") set (libdescription "Industrial Grade Ten Degrees of Freedom Inertial Sensor")
set (module_src ${libname}.cxx) set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp) set (module_hpp ${libname}.hpp)
upm_module_init(mraa) upm_module_init(mraa)

2
src/adis16448/adis16448.hpp
View File

@ -92,7 +92,7 @@ namespace upm {
/** /**
* @library adis16448 * @library adis16448
* @sensor adis16448 * @sensor adis16448
* @comname ADIS16448 Accelerometer * @comname Industrial Grade Ten Degrees of Freedom Inertial Sensor
* @type accelerometer * @type accelerometer
* @man generic * @man generic
* @web http://www.analog.com/en/products/sensors/isensor-mems-inertial-measurement-units/adis16448.html * @web http://www.analog.com/en/products/sensors/isensor-mems-inertial-measurement-units/adis16448.html

2
src/ads1x15/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "ads1x15") set (libname "ads1x15")
set (libdescription "Analog to digital converter") set (libdescription "Texas Instruments I2C ADC Library")
set (module_src ${libname}.cxx ads1115.cxx ads1015.cxx) set (module_src ${libname}.cxx ads1115.cxx ads1015.cxx)
set (module_hpp ${libname}.hpp ads1115.hpp ads1015.hpp) set (module_hpp ${libname}.hpp ads1115.hpp ads1015.hpp)
upm_module_init(interfaces mraa) upm_module_init(interfaces mraa)

4
src/ads1x15/ads1015.hpp
View File

@ -57,11 +57,11 @@ namespace upm {
/** /**
* @library ads1x15 * @library ads1x15
* @sensor ADS1015 * @sensor ADS1015
* @comname ADS1015 ADC * @comname 12-bit ADC with Integrated MUX, PGA, Comparator, Oscillator, and Reference
* @type electric * @type electric
* @man ti adafruit * @man ti adafruit
* @con i2c * @con i2c
* @web web http://www.ti.com/lit/ds/symlink/ads1015.pdf * @web http://www.ti.com/lit/ds/symlink/ads1015.pdf
* *
* @brief API for ADS1015 * @brief API for ADS1015
* *

2
src/ads1x15/ads1115.hpp
View File

@ -57,7 +57,7 @@ namespace upm {
/** /**
* @library ads1x15 * @library ads1x15
* @sensor ADS1115 * @sensor ADS1115
* @comname ADS1115 ADC * @comname 16-bit ADC with Integrated MUX, PGA, Comparator, Oscillator, and Reference
* @type electric * @type electric
* @man ti adafruit * @man ti adafruit
* @con i2c * @con i2c

2
src/adxl335/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "adxl335") set (libname "adxl335")
set (libdescription "Adxl335 grove 3-axis anaolog accelerometer") set (libdescription "Low-power, 3-axis +/- 3 g Accelerometer")
set (module_src ${libname}.cxx) set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp) set (module_hpp ${libname}.hpp)
upm_module_init(mraa) upm_module_init(mraa)

3
src/adxl335/adxl335.hpp
View File

@ -43,11 +43,12 @@ namespace upm {
/** /**
* @library adxl335 * @library adxl335
* @sensor adxl335 * @sensor adxl335
* @comname ADXL335 3-Axis Analog Accelerometer * @comname Low-power, 3-axis +/- 3 g Accelerometer
* @altname Grove 3-Axis Analog Accelerometer * @altname Grove 3-Axis Analog Accelerometer
* @type accelerometer * @type accelerometer
* @man seeed * @man seeed
* @con analog * @con analog
* @web http://www.analog.com/en/products/mems/accelerometers/adxl335.html
* *
* @brief API for the ADXL335 3-Axis Analog Accelerometer * @brief API for the ADXL335 3-Axis Analog Accelerometer
* *

2
src/adxl345/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "adxl345") set (libname "adxl345")
set (libdescription "Digital Accelerometer") set (libdescription "3-axis, +/- 2/4/8/16 g Digital Accelerometer")
set (module_src ${libname}.cxx) set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp) set (module_hpp ${libname}.hpp)
upm_module_init(mraa) upm_module_init(mraa)

3
src/adxl345/adxl345.hpp
View File

@ -38,11 +38,12 @@ namespace upm {
/** /**
* @library adxl345 * @library adxl345
* @sensor adxl345 * @sensor adxl345
* @comname ADXL345 3-Axis Digital Accelerometer * @comname 3-axis, +/- 2/4/8/16 g Digital Accelerometer
* @altname Grove 3-Axis Digital Accelerometer (16g) * @altname Grove 3-Axis Digital Accelerometer (16g)
* @type accelerometer * @type accelerometer
* @man seeed * @man seeed
* @con i2c * @con i2c
* @web http://www.analog.com/media/en/technical-documentation/data-sheets/ADXL345.pdf
* *
* @brief API for the ADXL345 3-Axis Digital Accelerometer * @brief API for the ADXL345 3-Axis Digital Accelerometer
* *

2
src/adxrs610/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "adxrs610") set (libname "adxrs610")
set (libdescription "ADXRS610 gyroscope") set (libdescription "Gyro Breakout Board (300 Degrees/second)")
set (module_src ${libname}.cxx) set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp) set (module_hpp ${libname}.hpp)
upm_module_init(mraa) upm_module_init(mraa)

2
src/adxrs610/adxrs610.hpp
View File

@ -46,7 +46,7 @@ namespace upm {
/** /**
* @library adxrs610 * @library adxrs610
* @sensor adxrs610 * @sensor adxrs610
* @comname DFRobot ADXRS610 Gyro Breakout Board * @comname Gyro Breakout Board (300 Degrees/second)
* @altname ADXRS610 * @altname ADXRS610
* @type compass * @type compass
* @man dfrobot * @man dfrobot

2
src/am2315/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "am2315") set (libname "am2315")
set (libdescription "Humidity Sensor") set (libdescription "Digital Temperature and Humidity Sensor")
set (module_src ${libname}.cpp) set (module_src ${libname}.cpp)
set (module_hpp ${libname}.hpp) set (module_hpp ${libname}.hpp)
upm_module_init(mraa) upm_module_init(mraa)

2
src/am2315/am2315.hpp
View File

@ -58,7 +58,7 @@ namespace upm {
/** /**
* @library am2315 * @library am2315
* @sensor am2315 * @sensor am2315
* @comname AM2315 Temperature & Humidity Sensor * @comname Digital Temperature and Humidity Sensor
* @type temp * @type temp
* @man adafruit * @man adafruit
* @web http://www.adafruit.com/products/1293 * @web http://www.adafruit.com/products/1293

2
src/apa102/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME apa102 upm_mixed_module_init (NAME apa102
DESCRIPTION "RGB LED with integrated driver" DESCRIPTION "LED Strip"
C_HDR apa102.h C_HDR apa102.h
C_SRC apa102.c C_SRC apa102.c
CPP_HDR apa102.hpp CPP_HDR apa102.hpp

3
src/apa102/apa102.hpp
View File

@ -41,10 +41,11 @@ namespace upm
/** /**
* @library apa102 * @library apa102
* @sensor apa102 * @sensor apa102
* @comname APA102/DotStar LED Strip * @comname LED Strip
* @type led * @type led
* @man adafruit * @man adafruit
* @con spi * @con spi
* @web https://www.adafruit.com/product/2343
* *
* @brief API for controlling APA102/DotStar RGB LED Strips * @brief API for controlling APA102/DotStar RGB LED Strips
* *

2
src/apds9002/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "apds9002") set (libname "apds9002")
set (libdescription "Apds9002 luminance module") set (libdescription "Ambient Light Photo Sensor")
set (module_src ${libname}.cxx) set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp) set (module_hpp ${libname}.hpp)
upm_module_init(mraa) upm_module_init(mraa)

13
src/apds9002/apds9002.hpp
View File

@ -26,22 +26,23 @@
#include <string> #include <string>
#include <mraa/aio.h> #include <mraa/aio.h>
namespace upm { namespace upm {
/** /**
* @brief APDS-9002 Luminance Sensor library * @brief APDS-9002 Luminance Sensor library
* @defgroup apds9002 libupm-apds9002 * @defgroup apds9002 libupm-apds9002
* @ingroup seeed analog light * @ingroup seeed analog light
*/ */
/** /**
* @library apds9002 * @library apds9002
* @sensor apds9002 * @sensor apds9002
* @comname APDS-9002 Luminance Sensor * @comname Ambient Light Photo Sensor
* @altname Grove Luminance Sensor * @altname Grove Luminance Sensor
* @type light * @type light
* @man seeed * @man seeed
* @con analog * @con analog
* * @web https://www.seeedstudio.com/Grove-Luminance-Sensor-p-1941.html
*
* @brief UPM module for the APDS-9002 Luminance Sensor * @brief UPM module for the APDS-9002 Luminance Sensor
* *
* This sensor transforms luminous intensity to output analog values. * This sensor transforms luminous intensity to output analog values.
@ -50,7 +51,7 @@ namespace upm {
* @image html apds9002.jpg * @image html apds9002.jpg
* @snippet apds9002.cxx Interesting * @snippet apds9002.cxx Interesting
*/ */
class APDS9002 { class APDS9002 {
public: public:
/** /**

2
src/apds9930/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "apds9930") set (libname "apds9930")
set (libdescription "Apds9930 sensor module") set (libdescription "Digital Ambient Light and Proximity Sensor")
set (module_src ${libname}.cxx) set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp) set (module_hpp ${libname}.hpp)
upm_module_init(mraa) upm_module_init(mraa)

5
src/apds9930/apds9930.hpp
View File

@ -37,10 +37,11 @@ namespace upm
/** /**
* @library apds9930 * @library apds9930
* @sensor apds9930 * @sensor apds9930
* @comname APDS9930 Digital Proximity and Ambient Light Sensor * @comname Digital Ambient Light and Proximity Sensor
* @type light proximity * @type light proximity
* @man Avago Technologies * @man avago
* @con iio i2c * @con iio i2c
* @web https://www.broadcom.com/products/optical-sensors/integrated-ambient-light-proximity-sensors/apds-9930
* *
* @brief APDS9930 Digital Proximity and Ambient Light Sensor * @brief APDS9930 Digital Proximity and Ambient Light Sensor
* *

2
src/at42qt1070/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "at42qt1070") set (libname "at42qt1070")
set (libdescription "Module for the Atmel AT42QT1070 QTouch sensor") set (libdescription "Seven-channel QTouch Touch Sensor")
set (module_src ${libname}.cxx) set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp) set (module_hpp ${libname}.hpp)
upm_module_init(mraa) upm_module_init(mraa)

3
src/at42qt1070/at42qt1070.hpp
View File

@ -43,11 +43,12 @@ namespace upm
/** /**
* @library at42qt1070 * @library at42qt1070
* @sensor at42qt1070 * @sensor at42qt1070
* @comname AT42QT1070 QTouch Sensor * @comname Seven-channel QTouch Touch Sensor
* @altname Grove QTouch Sensor * @altname Grove QTouch Sensor
* @type touch * @type touch
* @man seeed * @man seeed
* @con i2c * @con i2c
* @web http://wiki.seeed.cc/Grove-Q_Touch_Sensor/
* *
* @brief API for the Atmel AT42QT1070 QTouch Sensor * @brief API for the Atmel AT42QT1070 QTouch Sensor
* *

2
src/bacnetmstp/CMakeLists.txt
View File

@ -1,6 +1,6 @@
if (BACNET_FOUND) if (BACNET_FOUND)
set (libname "bacnetmstp") set (libname "bacnetmstp")
set (libdescription "Driver module for BACnet MS/TP devices") set (libdescription "Driver Module for BACnet MS/TP Devices")
set (module_src ${libname}.cxx device-client.c bacnetutil.cxx) set (module_src ${libname}.cxx device-client.c bacnetutil.cxx)
set (module_hpp ${libname}.hpp bacnetutil.hpp device.h) set (module_hpp ${libname}.hpp bacnetutil.hpp device.h)

2
src/bacnetmstp/bacnetmstp.hpp
View File

@ -59,7 +59,7 @@ namespace upm {
/** /**
* @library bacnetmstp * @library bacnetmstp
* @sensor bacnetmstp * @sensor bacnetmstp
* @comname UPM API for BACNET MS/TP communications * @comname UPM API for BACNET MS/TP Communications
* @con uart * @con uart
* @web http://bacnet.sourceforge.net/ * @web http://bacnet.sourceforge.net/
* @brief UPM API for BACNETMSTP * @brief UPM API for BACNETMSTP

2
src/bacnetmstp/bacnetutil.hpp
View File

@ -33,7 +33,7 @@ namespace upm {
/** /**
* @library bacnetmstp * @library bacnetmstp
* @comname UPM Utility API for BACnet * @comname Utility API for BACnet
* @con uart * @con uart
* *
* @brief UPM Utility API for BACnet * @brief UPM Utility API for BACnet

2
src/bh1750/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME bh1750 upm_mixed_module_init (NAME bh1750
DESCRIPTION "Digital light sensor" DESCRIPTION "Digital Light Sensor"
C_HDR bh1750.h C_HDR bh1750.h
C_SRC bh1750.c C_SRC bh1750.c
CPP_HDR bh1750.hpp CPP_HDR bh1750.hpp

2
src/bh1750/bh1750.hpp
View File

@ -42,7 +42,7 @@ namespace upm {
/** /**
* @library bh1750 * @library bh1750
* @sensor bh1750 * @sensor bh1750
* @comname DFRobot Light Sensor * @comname Digital Light Sensor
* @type light * @type light
* @man dfrobot * @man dfrobot
* @con i2c * @con i2c

2
src/biss0001/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME biss0001 upm_mixed_module_init (NAME biss0001
DESCRIPTION "Passive Infrared (PIR) motion sensor" DESCRIPTION "Passive Infrared (PIR) Motion Sensor"
C_HDR biss0001.h C_HDR biss0001.h
C_SRC biss0001.c C_SRC biss0001.c
CPP_HDR biss0001.hpp CPP_HDR biss0001.hpp

2
src/biss0001/biss0001.hpp
View File

@ -36,7 +36,7 @@ namespace upm {
/** /**
* @library biss0001 * @library biss0001
* @sensor biss0001 * @sensor biss0001
* @comname BISS0001 Motion Sensor * @comname Passive Infrared (PIR) Motion Sensor
* @altname Grove PIR Motion Sensor * @altname Grove PIR Motion Sensor
* @type light * @type light
* @man seeed * @man seeed

2
src/bma220/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "bma220") set (libname "bma220")
set (libdescription "Accelerometer sensor based on bma220") set (libdescription "Digital Triaxial Acceleration Sensor")
set (module_src ${libname}.cxx) set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp) set (module_hpp ${libname}.hpp)
upm_module_init(mraa) upm_module_init(mraa)

2
src/bma220/bma220.hpp
View File

@ -42,7 +42,7 @@ namespace upm {
/** /**
* @library bma220 * @library bma220
* @sensor bma220 * @sensor bma220
* @comname BMA220 3-axis Accelerometer * @comname Digital Triaxial Acceleration Sensor
* @type accelerometer * @type accelerometer
* @man dfrobot * @man dfrobot
* @con i2c gpio * @con i2c gpio

2
src/bmi160/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME bmi160 upm_mixed_module_init (NAME bmi160
DESCRIPTION "Bosch Sensortec IMU (triaxial accelerometer, triaxial gyroscope and magnetometer interface)" DESCRIPTION "Bosch Sensortec IMU (triaxial Accelerometer, Triaxial Gyroscope and Magnetometer Interface)"
C_HDR bmi160.h bosch_bmi160.h C_HDR bmi160.h bosch_bmi160.h
C_SRC bmi160.c bosch_bmi160.c C_SRC bmi160.c bosch_bmi160.c
CPP_HDR bmi160.hpp CPP_HDR bmi160.hpp

4
src/bmi160/bmi160.hpp
View File

@ -40,12 +40,12 @@ namespace upm {
/** /**
* @library bmi160 * @library bmi160
* @sensor bmi160 * @sensor bmi160
* @comname BMI160 3-axis Accelerometer, Gyroscope * @comname Low-power IMU (triaxial Accelerometer and Triaxial Gyroscope)
* and Magnetometer * and Magnetometer
* @type accelerometer compass * @type accelerometer compass
* @man mouser * @man mouser
* @con i2c * @con i2c
* @web http://www.mouser.com/ProductDetail/Bosch-Sensortec/0330SB2187/?qs=sGAEpiMZZMvi6wO7nhr1L9JELKA6cYRX60mAGNTn0fQ%3d * @web https://www.bosch-sensortec.com/bst/products/all_products/bmi160
* *
* @brief UPM API for the BMI160 3-axis Accelerometer, Gyroscope and * @brief UPM API for the BMI160 3-axis Accelerometer, Gyroscope and
* Magnetometer * Magnetometer

2
src/bmp280/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "bmp280") set (libname "bmp280")
set (libdescription "Bosch bmp280 Pressure sensor and bme280 humidity sensor") set (libdescription "Bosch Atmospheric Sensor Library (bmp280 and Bme280)")
set (module_src ${libname}.cxx bme280.cxx) set (module_src ${libname}.cxx bme280.cxx)
set (module_hpp ${libname}.hpp bme280.hpp) set (module_hpp ${libname}.hpp bme280.hpp)
upm_module_init(interfaces mraa) upm_module_init(interfaces mraa)

2
src/bmp280/bme280.hpp
View File

@ -42,7 +42,7 @@ namespace upm {
/** /**
* @library bmp280 * @library bmp280
* @sensor bme280 * @sensor bme280
* @comname BME280 Digital Humidity, Pressure, and Temperature Sensor * @comname Digital Humidity, Pressure, and Temperature Sensor
* @type pressure humidity * @type pressure humidity
* @man adafruit * @man adafruit
* @con i2c spi gpio * @con i2c spi gpio

2
src/bmp280/bmp280.hpp
View File

@ -47,7 +47,7 @@ namespace upm {
/** /**
* @library bmp280 * @library bmp280
* @sensor bmp280 * @sensor bmp280
* @comname BMP280 Digital Pressure Sensor * @comname Digital Pressure Sensor
* @type pressure * @type pressure
* @man adafruit * @man adafruit
* @con i2c spi gpio * @con i2c spi gpio

2
src/bmpx8x/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "bmpx8x") set (libname "bmpx8x")
set (libdescription "Bosch BMP & GY65 atmospheric pressure sensor library") set (libdescription "Bosch BMP & GY65 Atmospheric Pressure Sensor Library")
set (module_src ${libname}.cxx) set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp) set (module_hpp ${libname}.hpp)
upm_module_init(mraa interfaces) upm_module_init(mraa interfaces)

3
src/bmpx8x/bmpx8x.hpp
View File

@ -77,6 +77,9 @@ namespace upm {
* @type pressure * @type pressure
* @man seeed adafruit sparkfun * @man seeed adafruit sparkfun
* @con i2c * @con i2c
* @web https://www.sparkfun.com/datasheets/Components/General/BST-BMP085-DS000-05.pdf
* @web https://www.bosch-sensortec.com/bst/products/all_products/bmp180
* @web https://cdn-shop.adafruit.com/datasheets/1900_BMP183.pdf
* *
* @brief API for the GY65/BMP085 and BMP180 Atmospheric Pressure Sensors * @brief API for the GY65/BMP085 and BMP180 Atmospheric Pressure Sensors
* *

2
src/bmx055/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "bmx055") 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_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) set (module_hpp ${libname}.hpp bma250e.hpp bmg160.hpp bmm150.hpp bmc150.cxx bmi055.hpp)
upm_module_init(mraa) upm_module_init(mraa)

5
src/bmx055/bma250e.hpp
View File

@ -38,12 +38,13 @@ namespace upm {
/** /**
* @library bmx050 * @library bmx050
* @sensor bma250e * @sensor bma250e
* @comname BMA250E 10 bit Trixial Accelerometer * @comname Digital Triaxial Acceleration Sensor
* @type accelerometer * @type accelerometer
* @man bosch * @man bosch
* @con i2c spi gpio * @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 * The BMA250E is a triaxial, low-g acceleration sensor with digital
* output for consumer applications. It allows measurements of * output for consumer applications. It allows measurements of

6
src/bmx055/bmc150.hpp
View File

@ -37,11 +37,11 @@ namespace upm {
/** /**
* @library bmx055 * @library bmx055
* @sensor bmc150 * @sensor bmc150
* @comname BMC150 6-axis eCompass * @comname 6-axis Ecompass
* @type accelerometer compass * @type accelerometer compass
* @man mouser * @man bosch
* @con i2c gpio spi * @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 * @brief API for the BMC150 6-axis eCompass
* *

5
src/bmx055/bmg160.hpp
View File

@ -38,12 +38,13 @@ namespace upm {
/** /**
* @library bmx050 * @library bmx050
* @sensor bmg160 * @sensor bmg160
* @comname BMG160 16 bit Trixial Gyroscope * @comname 3-axis Gyroscope Sensor
* @type gyro * @type gyro
* @man bosch * @man bosch
* @con i2c spi gpio * @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 * The BMG160 is a 3-axis angular rate sensor that is made of a
* surface micro machined sensing element and an evaluation ASIC. * surface micro machined sensing element and an evaluation ASIC.

6
src/bmx055/bmi055.hpp
View File

@ -33,11 +33,11 @@ namespace upm {
/** /**
* @library bmx055 * @library bmx055
* @sensor bmi055 * @sensor bmi055
* @comname BMI055 6-axis Sensor Module * @comname 6DoF Sensor Module
* @type accelerometer compass * @type accelerometer compass
* @man mouser * @man bosch
* @con i2c gpio spi * @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 * @brief API for the BMI055 6-axis Sensor Module
* *

3
src/bmx055/bmm150.hpp
View File

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

6
src/bmx055/bmx055.hpp
View File

@ -40,11 +40,11 @@ namespace upm {
/** /**
* @library bmx055 * @library bmx055
* @sensor bmx055 * @sensor bmx055
* @comname BMX055 9-axis Sensor Module * @comname 9-axis Sensor Module
* @type accelerometer compass * @type accelerometer compass
* @man mouser * @man bosch
* @con i2c gpio spi * @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 * @brief API for the BMX055 9-axis Sensor Module
* *

2
src/bno055/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "bno055") set (libname "bno055")
set (libdescription "Bosch bno055 intelligent orientation sensor 9dof fusion") set (libdescription "Intelligent 9-axis Absolute Orientation Sensor")
set (module_src ${libname}.cxx) set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp) set (module_hpp ${libname}.hpp)
upm_module_init(mraa) upm_module_init(mraa)

2
src/bno055/bno055.hpp
View File

@ -41,7 +41,7 @@ namespace upm {
/** /**
* @library bno055 * @library bno055
* @sensor bno055 * @sensor bno055
* @comname BNO055 Absolute Orientation 9DOF Fusion Hub * @comname Intelligent 9-axis Absolute Orientation Sensor
* @type accelerometer compass * @type accelerometer compass
* @man adafruit * @man adafruit
* @con i2c gpio * @con i2c gpio

2
src/button/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME button upm_mixed_module_init (NAME button
DESCRIPTION "Momentary on/off button" DESCRIPTION "Button"
C_HDR button.h C_HDR button.h
C_SRC button.c C_SRC button.c
CPP_HDR button.hpp CPP_HDR button.hpp

2
src/buzzer/buzzer.hpp
View File

@ -41,7 +41,7 @@ namespace upm {
/** /**
* @library buzzer * @library buzzer
* @sensor buzzer * @sensor buzzer
* @comname Grove Buzzer * @comname Buzzer
* @type sound * @type sound
* @man seeed * @man seeed
* @con pwm * @con pwm

2
src/cjq4435/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME cjq4435 upm_mixed_module_init (NAME cjq4435
DESCRIPTION "MOSFET module" DESCRIPTION "MOSFET"
C_HDR cjq4435.h C_HDR cjq4435.h
C_SRC cjq4435.c C_SRC cjq4435.c
CPP_HDR cjq4435.hpp CPP_HDR cjq4435.hpp

2
src/cjq4435/cjq4435.hpp
View File

@ -35,7 +35,7 @@ namespace upm {
/** /**
* @library cjq4435 * @library cjq4435
* @sensor cjq4435 * @sensor cjq4435
* @comname Grove MOSFET * @comname MOSFET
* @altname CJQ4435 * @altname CJQ4435
* @type electric * @type electric
* @man seeed * @man seeed

2
src/collision/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME collision upm_mixed_module_init (NAME collision
DESCRIPTION "Collision sensor" DESCRIPTION "Collision Sensor"
C_HDR collision.h C_HDR collision.h
C_SRC collision.c C_SRC collision.c
CPP_HDR collision.hpp CPP_HDR collision.hpp

2
src/curieimu/CMakeLists.txt
View File

@ -4,7 +4,7 @@ include (CheckIncludeFiles)
check_library_exists (${MRAA_LIBRARIES} mraa_firmata_init "" HAVE_FIRMATA) check_library_exists (${MRAA_LIBRARIES} mraa_firmata_init "" HAVE_FIRMATA)
if (HAVE_FIRMATA) if (HAVE_FIRMATA)
set (libname "curieimu") set (libname "curieimu")
set (libdescription "Curie IMU via Firmata") set (libdescription "Curie IMU Sensor using Firmata")
set (module_src ${libname}.cpp) set (module_src ${libname}.cpp)
set (module_hpp ${libname}.hpp) set (module_hpp ${libname}.hpp)
upm_module_init (mraa) upm_module_init (mraa)

2
src/curieimu/curieimu.hpp
View File

@ -58,7 +58,7 @@ struct IMUDataItem {
/** /**
* @library curieimu * @library curieimu
* @sensor curieimu * @sensor curieimu
* @comname Curie IMU Sensor with Firmata * @comname Curie IMU Sensor using Firmata
* @altname Curie IMU Sensor for Arduino/Genuino 101 running Firmata * @altname Curie IMU Sensor for Arduino/Genuino 101 running Firmata
* @type accelerometer compass * @type accelerometer compass
* @man bosch * @man bosch

2
src/cwlsxxa/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "cwlsxxa") set (libname "cwlsxxa")
set (libdescription "Veris CWLSXXA CO2/Temperature/Humidity transmitter") set (libdescription "Veris CWLSXXA CO2/Temperature/Humidity Transmitter")
set (module_src ${libname}.cxx) set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp) set (module_hpp ${libname}.hpp)
upm_module_init(mraa) upm_module_init(mraa)

2
src/cwlsxxa/cwlsxxa.hpp
View File

@ -41,7 +41,7 @@ namespace upm {
/** /**
* @library cwlsxxa * @library cwlsxxa
* @sensor cwlsxxa * @sensor cwlsxxa
* @comname Veris CWLSXXA CO2 Sensor Family * @comname CO2/temperature/humidity Transmitter
* @type temp gaseous * @type temp gaseous
* @man veris * @man veris
* @con ainput * @con ainput

2
src/dfrec/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME dfrec upm_mixed_module_init (NAME dfrec
DESCRIPTION "DFRobot analog electrical conductivity (EC) sensor" DESCRIPTION "Analog Electrical Conductivity (EC) Sensor"
C_HDR dfrec.h C_HDR dfrec.h
C_SRC dfrec.c C_SRC dfrec.c
CPP_HDR dfrec.hpp CPP_HDR dfrec.hpp

2
src/dfrec/dfrec.hpp
View File

@ -42,7 +42,7 @@ namespace upm {
/** /**
* @library dfrec * @library dfrec
* @sensor dfrec * @sensor dfrec
* @comname DFRobot EC Meter * @comname Analog Electrical Conductivity (EC) Sensor
* @type liquid * @type liquid
* @man dfrobot * @man dfrobot
* @con ainput uart * @con ainput uart

2
src/dfrorp/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME dfrorp upm_mixed_module_init (NAME dfrorp
DESCRIPTION "DFRobot analog oxidation reduction potential (ORP) sensor" DESCRIPTION "Analog Oxidation Reduction Potential (ORP) Sensor"
C_HDR dfrorp.h C_HDR dfrorp.h
C_SRC dfrorp.c C_SRC dfrorp.c
CPP_HDR dfrorp.hpp CPP_HDR dfrorp.hpp

2
src/dfrorp/dfrorp.hpp
View File

@ -43,7 +43,7 @@ namespace upm {
/** /**
* @library dfrorp * @library dfrorp
* @sensor dfrorp * @sensor dfrorp
* @comname DFRobot ORP (Oxidation/Reduction Potential) Sensor * @comname Analog Oxidation Reduction Potential (ORP) Sensor
* @type liquid * @type liquid
* @man dfrobot * @man dfrobot
* @con ainput * @con ainput

2
src/dfrph/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME dfrph upm_mixed_module_init (NAME dfrph
DESCRIPTION "DFRobot pH sensor" DESCRIPTION "Analog pH Sensor"
C_HDR dfrph.h C_HDR dfrph.h
C_SRC dfrph.c C_SRC dfrph.c
CPP_HDR dfrph.hpp CPP_HDR dfrph.hpp

2
src/dfrph/dfrph.hpp
View File

@ -38,7 +38,7 @@ namespace upm {
/** /**
* @library dfrph * @library dfrph
* @sensor dfrph * @sensor dfrph
* @comname DFRobot pH Sensors * @comname Analog pH Sensor
* @type liquid * @type liquid
* @man dfrobot * @man dfrobot
* @web http://www.dfrobot.com/index.php?route=product/product&product_id=1110 * @web http://www.dfrobot.com/index.php?route=product/product&product_id=1110

2
src/ds1307/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "ds1307") set (libname "ds1307")
set (libdescription "Real time clock (RTC) module") set (libdescription "Real Time Clock (RTC) Module")
set (module_src ${libname}.cxx) set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp) set (module_hpp ${libname}.hpp)
upm_module_init(mraa) upm_module_init(mraa)

3
src/ds1307/ds1307.hpp
View File

@ -51,11 +51,12 @@ namespace upm {
/** /**
* @library ds1307 * @library ds1307
* @sensor ds1307 * @sensor ds1307
* @comname Grove RTC (Real-Time Clock) * @comname Real Time Clock (RTC) Module
* @altname DS1307 RTC * @altname DS1307 RTC
* @type time * @type time
* @man seeed * @man seeed
* @con i2c * @con i2c
* @web https://www.maximintegrated.com/en/products/digital/real-time-clocks/DS1307.html
* *
* @brief API for the DS1307 Real-Time CLock * @brief API for the DS1307 Real-Time CLock
* *

2
src/ds1808lc/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "ds1808lc") set (libname "ds1808lc")
set (libdescription "DS1808 lighting controller") set (libdescription "Lighting Controller")
set (module_src ${libname}.cxx mraa-utils.cxx) set (module_src ${libname}.cxx mraa-utils.cxx)
set (module_hpp ${libname}.hpp) set (module_hpp ${libname}.hpp)
upm_module_init(interfaces mraa) upm_module_init(interfaces mraa)

2
src/ds1808lc/ds1808lc.hpp
View File

@ -43,7 +43,7 @@ namespace upm
* *
* @library ds1808lc * @library ds1808lc
* @sensor ds1808lc * @sensor ds1808lc
* @comname Maxim DS1808 as lighting controller * @comname Lighting Controller
* @altname DS1808LC * @altname DS1808LC
* @type light * @type light
* @man maxim * @man maxim

2
src/ds18b20/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME ds18b20 upm_mixed_module_init (NAME ds18b20
DESCRIPTION "Programmable resolution DS 1-wire digital thermometer" DESCRIPTION "Programmable Resolution 1-Wire Digital Thermometer"
C_HDR ds18b20.h ds18b20_defs.h C_HDR ds18b20.h ds18b20_defs.h
C_SRC ds18b20.c C_SRC ds18b20.c
CPP_HDR ds18b20.hpp CPP_HDR ds18b20.hpp

2
src/ds18b20/ds18b20.hpp
View File

@ -48,7 +48,7 @@ namespace upm {
/** /**
* @library ds18b20 * @library ds18b20
* @sensor ds18b20 * @sensor ds18b20
* @comname DS18B20 1-Wire Temperature Sensor * @comname Programmable Resolution 1-Wire Digital Thermometer
* @type uart * @type uart
* @man maxim * @man maxim
* @con uart * @con uart

2
src/ds2413/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "ds2413") set (libname "ds2413")
set (libdescription "DS2413 1-wire Dual Channel Addressable Switch module") set (libdescription "1-Wire Dual Channel Addressable Switch")
set (module_src ${libname}.cxx) set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp) set (module_hpp ${libname}.hpp)
upm_module_init(mraa) upm_module_init(mraa)

2
src/ds2413/ds2413.hpp
View File

@ -46,7 +46,7 @@ namespace upm {
/** /**
* @library ds2413 * @library ds2413
* @sensor ds2413 * @sensor ds2413
* @comname DS2413 1-Wire Dual Channel Addressable Switch * @comname 1-Wire Dual Channel Addressable Switch
* @type gpio * @type gpio
* @man maxim * @man maxim
* @con uart * @con uart

2
src/e50hx/CMakeLists.txt
View File

@ -1,6 +1,6 @@
if (BACNET_FOUND) if (BACNET_FOUND)
set (libname "e50hx") set (libname "e50hx")
set (libdescription "Module for the Veris E50HX (E50H2/E50H5)Energy Meters") set (libdescription "Veris E50HX (E50H2/E50H5) Energy Meter Module")
set (module_src ${libname}.cxx) set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp) set (module_hpp ${libname}.hpp)

2
src/e50hx/e50hx.hpp
View File

@ -40,7 +40,7 @@ namespace upm {
/** /**
* @library e50hx * @library e50hx
* @sensor e50hx * @sensor e50hx
* @comname Veris E50HX Energy Meters * @comname Veris E50HX (E50H2/E50H5) Energy Meter Module
* @type electic * @type electic
* @man veris * @man veris
* @con uart * @con uart

2
src/ecezo/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME ecezo upm_mixed_module_init (NAME ecezo
DESCRIPTION "EC EZO Atlas Scientific EC circuit" DESCRIPTION "Electrical Conductivity (EC) Circuit"
C_HDR ecezo.h ecezo_defs.h C_HDR ecezo.h ecezo_defs.h
C_SRC ecezo.c C_SRC ecezo.c
CPP_HDR ecezo.hpp CPP_HDR ecezo.hpp

2
src/ecezo/ecezo.hpp
View File

@ -41,7 +41,7 @@ namespace upm {
/** /**
* @library ecezo * @library ecezo
* @sensor ecezo * @sensor ecezo
* @comname EC-EZO EC Sensor * @comname Electrical Conductivity (EC) Circuit
* @type liquid * @type liquid
* @man sparkfun * @man sparkfun
* @con uart i2c * @con uart i2c

2
src/ecs1030/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "ecs1030") set (libname "ecs1030")
set (libdescription "Non-invasive current sensor") set (libdescription "Non-invasive Current Sensor")
set (module_src ${libname}.cxx) set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp) set (module_hpp ${libname}.hpp)
upm_module_init(mraa) upm_module_init(mraa)

2
src/ecs1030/ecs1030.hpp
View File

@ -50,7 +50,7 @@ namespace upm {
/** /**
* @library ecs1030 * @library ecs1030
* @sensor ecs1030 * @sensor ecs1030
* @comname ECS1030 Non-Invasive Current Sensor * @comname Non-invasive Current Sensor
* @type electric * @type electric
* @man sparkfun * @man sparkfun
* @web https://www.sparkfun.com/products/11005 * @web https://www.sparkfun.com/products/11005

2
src/ehr/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME ehr upm_mixed_module_init (NAME ehr
DESCRIPTION "Ear-clip heart rate sensor" DESCRIPTION "Ear-clip Heart Rate Sensor"
CPP_HDR ehr.hpp CPP_HDR ehr.hpp
CPP_SRC ehr.cxx CPP_SRC ehr.cxx
REQUIRES mraa) REQUIRES mraa)

2
src/ehr/ehr.hpp
View File

@ -38,7 +38,7 @@ namespace upm {
/** /**
* @library ehr * @library ehr
* @sensor ehr * @sensor ehr
* @comname Ear-clip Heart Rate Sensor * @comname Ear-clip Heart Rate Sensor
* @type medical * @type medical
* @man seeed * @man seeed
* @con gpio * @con gpio

2
src/eldriver/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME eldriver upm_mixed_module_init (NAME eldriver
DESCRIPTION "Electroluminescent wire (EL) driver" DESCRIPTION "Electroluminescent Wire (EL) Driver"
CPP_HDR eldriver.hpp CPP_HDR eldriver.hpp
CPP_SRC eldriver.cxx CPP_SRC eldriver.cxx
REQUIRES mraa) REQUIRES mraa)

2
src/eldriver/eldriver.hpp
View File

@ -38,7 +38,7 @@ namespace upm {
/** /**
* @library eldriver * @library eldriver
* @sensor eldriver * @sensor eldriver
* @comname EL Driver * @comname Electroluminescent Wire (EL) Driver
* @type electric * @type electric
* @man seeed * @man seeed
* @con gpio * @con gpio

2
src/electromagnet/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME electromagnet upm_mixed_module_init (NAME electromagnet
DESCRIPTION "Electromagnet sensor" DESCRIPTION "Electromagnet"
CPP_HDR electromagnet.hpp CPP_HDR electromagnet.hpp
CPP_SRC electromagnet.cxx CPP_SRC electromagnet.cxx
REQUIRES mraa) REQUIRES mraa)

2
src/electromagnet/electromagnet.hpp
View File

@ -38,7 +38,7 @@ namespace upm {
/** /**
* @library electromagnet * @library electromagnet
* @sensor electromagnet * @sensor electromagnet
* @comname Electromagnet * @comname Electromagnet
* @type electric * @type electric
* @man seeed * @man seeed
* @con gpio * @con gpio

2
src/emg/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME emg upm_mixed_module_init (NAME emg
DESCRIPTION "Electromyography (EMG) detector" DESCRIPTION "Electromyography (EMG) Sensor"
C_HDR emg.h C_HDR emg.h
C_SRC emg.c C_SRC emg.c
CPP_HDR emg.hpp CPP_HDR emg.hpp

2
src/emg/emg.hpp
View File

@ -36,7 +36,7 @@ namespace upm {
/** /**
* @library emg * @library emg
* @sensor emg * @sensor emg
* @comname EMG Sensor * @comname Electromyography (EMG) Sensor
* @altname Grove EMG Sensor * @altname Grove EMG Sensor
* @type electric * @type electric
* @man seeed * @man seeed

2
src/enc03r/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME enc03r upm_mixed_module_init (NAME enc03r
DESCRIPTION "Single-axis Analog Gyroscope" DESCRIPTION "Single-axis Analog Gyro Module"
C_HDR enc03r.h C_HDR enc03r.h
C_SRC enc03r.c C_SRC enc03r.c
CPP_HDR enc03r.hpp CPP_HDR enc03r.hpp

151
src/enc03r/enc03r.hpp
View File

@ -27,113 +27,112 @@
#include "enc03r.h" #include "enc03r.h"
namespace upm { namespace upm {
/**
* @brief ENC03R Single Axis Gyro library
* @defgroup enc03r libupm-enc03r
* @ingroup seeed analog compass robok
*/
/** /**
* @brief ENC03R Single Axis Gyro library * @library enc03r
* @defgroup enc03r libupm-enc03r * @sensor enc03r
* @ingroup seeed analog compass robok * @comname Single-axis Analog Gyro Module
*/ * @altname Grove Single Axis Analog Gyro
* @type compass
/** * @man seeed
* @library enc03r * @con analog
* @sensor enc03r * @kit robok
* @comname ENC03R Single Axis Gyro * @web http://www.murata.com/en-us/products/productdetail?partno=ENC-03RC-R
* @altname Grove Single Axis Analog Gyro *
* @type compass * @brief API for the ENC03R Single Axis Analog Gyro
* @man seeed *
* @con analog * UPM module for the ENC03R single axis analog gyro.
* @kit robok * This gyroscope measures x-axis angular velocity, that is
* * how fast the sensor is rotating around the x-axis.
* @brief API for the ENC03R Single Axis Analog Gyro * Calibration of the sensor is necessary for accurate readings.
* *
* UPM module for the ENC03R single axis analog gyro. * @image html enc03r.jpg
* This gyroscope measures x-axis angular velocity, that is * @snippet enc03r.cxx Interesting
* how fast the sensor is rotating around the x-axis. */
* Calibration of the sensor is necessary for accurate readings. class ENC03R {
*
* @image html enc03r.jpg
* @snippet enc03r.cxx Interesting
*/
class ENC03R {
public: public:
/** /**
* ENC03R sensor constructor * ENC03R sensor constructor
* *
* @param pin Analog pin to use * @param pin Analog pin to use
* @param vref Reference voltage to use; default is 5.0 V * @param vref Reference voltage to use; default is 5.0 V
*/ */
ENC03R(int pin, float aref=5.0); ENC03R(int pin, float aref=5.0);
/** /**
* ENC03R destructor * ENC03R destructor
*/ */
~ENC03R(); ~ENC03R();
/** /**
* Calibrates the sensor by determining an analog reading over many * Calibrates the sensor by determining an analog reading over many
* samples with no movement of the sensor. This must be done * samples with no movement of the sensor. This must be done
* before attempting to use the sensor. * before attempting to use the sensor.
* *
* @param samples Number of samples to use for calibration * @param samples Number of samples to use for calibration
*/ */
void calibrate(unsigned int samples); void calibrate(unsigned int samples);
/** /**
* Update the internal state with the current reading. This * Update the internal state with the current reading. This
* function must be called prior to calling * function must be called prior to calling
* angularVelocity(). * angularVelocity().
* *
* @param dev Device context * @param dev Device context
*/ */
void update(); void update();
/** /**
* Returns the currently stored calibration value * Returns the currently stored calibration value
* *
* @return Current calibration value * @return Current calibration value
*/ */
float calibrationValue() { return enc03r_calibration_value(m_enc03r); }; float calibrationValue() { return enc03r_calibration_value(m_enc03r); };
/** /**
* Computes angular velocity based on the value and stored calibration * Computes angular velocity based on the value and stored calibration
* reference. * reference.
* *
* @param val Value to use to compute angular velocity * @param val Value to use to compute angular velocity
* @return Computed angular velocity * @return Computed angular velocity
*/ */
float angularVelocity(); float angularVelocity();
/** /**
* Set sensor offset. The offste is applied to the return value * Set sensor offset. The offste is applied to the return value
* before scaling. Default is 0. * before scaling. Default is 0.
* *
* @param scale Scale to apply to value * @param scale Scale to apply to value
*/ */
void setOffset(float offset); void setOffset(float offset);
/** /**
* Set sensor scale. The return value is scaled by this value * Set sensor scale. The return value is scaled by this value
* before the offset is applied. Default is 1.0. * before the offset is applied. Default is 1.0.
* *
* @param dev Device context * @param dev Device context
* @param scale Offset to apply to value * @param scale Offset to apply to value
*/ */
void setScale(float scale); void setScale(float scale);
/** /**
* Get a normalized ADC value from the sensor. The return * Get a normalized ADC value from the sensor. The return
* value will be between 0.0 (indicating no voltage) and 1.0 * value will be between 0.0 (indicating no voltage) and 1.0
* indicating max voltage (aref). update() must be called * indicating max voltage (aref). update() must be called
* prior to calling this function. * prior to calling this function.
* *
* @return The normalized reading from the ADC. * @return The normalized reading from the ADC.
*/ */
float getNormalized(); float getNormalized();
protected: protected:
enc03r_context m_enc03r; enc03r_context m_enc03r;
private: private:
}; };
} }

2
src/flex/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME flex upm_mixed_module_init (NAME flex
DESCRIPTION "Resistive flex sensor" DESCRIPTION "Resistive Flex Sensor"
C_HDR flex.h C_HDR flex.h
C_SRC flex.c C_SRC flex.c
CPP_HDR flex.hpp CPP_HDR flex.hpp

2
src/flex/flex.hpp
View File

@ -37,7 +37,7 @@ namespace upm {
/** /**
* @library flex * @library flex
* @sensor flex * @sensor flex
* @comname Flex Sensor * @comname Resistive Flex Sensor
* @type flexfor * @type flexfor
* @man sparkfun * @man sparkfun
* @web https://www.sparkfun.com/products/8606 * @web https://www.sparkfun.com/products/8606

2
src/gas/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME gas upm_mixed_module_init (NAME gas
DESCRIPTION "Generic gas detection sensor library" DESCRIPTION "Generic Gas Detection Sensor Library"
C_HDR mqx.h C_HDR mqx.h
C_SRC mqx.c C_SRC mqx.c
CPP_HDR gas.hpp mq2.hpp mq3.hpp mq4.hpp mq5.hpp mq6.hpp mq7.hpp mq8.hpp mq9.hpp tp401.hpp CPP_HDR gas.hpp mq2.hpp mq3.hpp mq4.hpp mq5.hpp mq6.hpp mq7.hpp mq8.hpp mq9.hpp tp401.hpp

3
src/gas/mq2.hpp
View File

@ -31,11 +31,12 @@ namespace upm {
/** /**
* @library gas * @library gas
* @sensor mq2 * @sensor mq2
* @comname Grove MQ2 Gas Sensor * @comname MQ2 Methane, Butane, Liquefied Petroleum Gas (LPG), and Smoke Sensor
* @type gaseous * @type gaseous
* @man seeed * @man seeed
* @con analog * @con analog
* @kit hak * @kit hak
* @web http://wiki.seeed.cc/Grove-Gas_Sensor-MQ2/
* *
* @brief API for the Grove MQ2 Gas Sensor * @brief API for the Grove MQ2 Gas Sensor
* *

3
src/gas/mq3.hpp
View File

@ -31,10 +31,11 @@ namespace upm {
/** /**
* @library gas * @library gas
* @sensor mq3 * @sensor mq3
* @comname Grove MQ3 Gas Sensor * @comname MQ3 Alcohol, Ethanol, Smoke Sensor
* @type gaseous * @type gaseous
* @man seeed * @man seeed
* @con analog * @con analog
* @web http://wiki.seeed.cc/Grove-Gas_Sensor-MQ3/
* *
* @brief API for the MQ3 Gas Sensor * @brief API for the MQ3 Gas Sensor
* *

Some files were not shown because too many files have changed in this diff Show More