mirror of
https://github.com/eclipse/upm.git
synced 2025-03-14 20:47:30 +03:00
doc: Scrubbed ALL sensor library descriptions
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
parent
7a5c8a6cb3
commit
283fce619e
@ -4,7 +4,7 @@ Writing sensor documentation {#documentation}
|
||||
It is highly encouraged to provide at least some basic documentation for the
|
||||
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.
|
||||
- Try to have no warnings in doxygen, this is generally fairly easy.
|
||||
- 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
|
||||
|
||||
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
|
||||
follow immediately after the library block. If you have multiple physical
|
||||
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>
|
||||
*
|
||||
* @brief Short class/sensor description
|
||||
*
|
||||
*
|
||||
* Then add a longer
|
||||
* 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
|
||||
available or relevant, use a unique descriptor that makes sense. Must match
|
||||
class name. *Mandatory*
|
||||
- `<component-name>` A short name for your sensor, try to avoid including the
|
||||
manufacturer's name here. *Mandatory*
|
||||
- `<component-name>` Title Case descriptive name for your sensor, try to avoid
|
||||
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
|
||||
include manufacturer's name. *Optional*
|
||||
- `<alt-id>` Alternative chip-ids that your sensor driver supports. *Optional*
|
||||
|
||||
BIN
docs/images/es9257.jpg
Normal file
BIN
docs/images/es9257.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
@ -1,5 +1,5 @@
|
||||
upm_mixed_module_init (NAME a110x
|
||||
DESCRIPTION "Hall effect sensor"
|
||||
DESCRIPTION "Hall Effect Sensor"
|
||||
C_HDR a110x.h
|
||||
C_SRC a110x.c
|
||||
CPP_HDR a110x.hpp
|
||||
|
||||
@ -36,7 +36,7 @@ namespace upm {
|
||||
/**
|
||||
* @library a110x
|
||||
* @sensor a110x
|
||||
* @comname A110X Hall Effect Sensor
|
||||
* @comname Hall Effect Sensor
|
||||
* @altname Grove Hall Sensor
|
||||
* @altid A1101, A1102, A1103, A1004, A1106
|
||||
* @type electric
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
upm_mixed_module_init (NAME ad8232
|
||||
DESCRIPTION "Single lead heart rate monitor"
|
||||
DESCRIPTION "Single Lead Heart Rate Monitor"
|
||||
C_HDR ad8232.h
|
||||
C_SRC ad8232.c
|
||||
CPP_HDR ad8232.hpp
|
||||
|
||||
@ -43,7 +43,7 @@ namespace upm {
|
||||
/**
|
||||
* @library ad8232
|
||||
* @sensor ad8232
|
||||
* @comname AD8232 Heart Rate Monitor
|
||||
* @comname Single Lead Heart Rate Monitor
|
||||
* @type medical
|
||||
* @man sparkfun
|
||||
* @web https://www.sparkfun.com/products/12650
|
||||
|
||||
@ -46,7 +46,7 @@ namespace upm {
|
||||
/**
|
||||
* @library adafruitms1438
|
||||
* @sensor adafruitms1438
|
||||
* @comname Adafruit Motor Shield
|
||||
* @comname Module for the Adafruit Motor Shield 1438
|
||||
* @type motor
|
||||
* @man adafruit
|
||||
* @web http://www.adafruit.com/products/1438
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
set (libname "adafruitss")
|
||||
set (libdescription "Adafruit pca9685 based 16-channel servo shield")
|
||||
set (libdescription "Adafruit Servo Shield")
|
||||
set (module_src ${libname}.cxx)
|
||||
set (module_hpp ${libname}.hpp)
|
||||
upm_module_init(mraa)
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
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_hpp ${libname}.hpp)
|
||||
upm_module_init(mraa)
|
||||
|
||||
@ -72,7 +72,7 @@ namespace upm {
|
||||
/**
|
||||
* @library adc121c021
|
||||
* @sensor adc121c021
|
||||
* @comname ADC121C021 Analog-to-Digital Converter
|
||||
* @comname I2C 12-bit Analog to Digital Converter with Alert Pin
|
||||
* @altname Grove I2C ADC
|
||||
* @type electric
|
||||
* @man seeed
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
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_hpp ${libname}.hpp)
|
||||
upm_module_init(mraa)
|
||||
|
||||
@ -92,7 +92,7 @@ namespace upm {
|
||||
/**
|
||||
* @library adis16448
|
||||
* @sensor adis16448
|
||||
* @comname ADIS16448 Accelerometer
|
||||
* @comname Industrial Grade Ten Degrees of Freedom Inertial Sensor
|
||||
* @type accelerometer
|
||||
* @man generic
|
||||
* @web http://www.analog.com/en/products/sensors/isensor-mems-inertial-measurement-units/adis16448.html
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
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_hpp ${libname}.hpp ads1115.hpp ads1015.hpp)
|
||||
upm_module_init(interfaces mraa)
|
||||
|
||||
@ -57,11 +57,11 @@ namespace upm {
|
||||
/**
|
||||
* @library ads1x15
|
||||
* @sensor ADS1015
|
||||
* @comname ADS1015 ADC
|
||||
* @comname 12-bit ADC with Integrated MUX, PGA, Comparator, Oscillator, and Reference
|
||||
* @type electric
|
||||
* @man ti adafruit
|
||||
* @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
|
||||
*
|
||||
|
||||
@ -57,7 +57,7 @@ namespace upm {
|
||||
/**
|
||||
* @library ads1x15
|
||||
* @sensor ADS1115
|
||||
* @comname ADS1115 ADC
|
||||
* @comname 16-bit ADC with Integrated MUX, PGA, Comparator, Oscillator, and Reference
|
||||
* @type electric
|
||||
* @man ti adafruit
|
||||
* @con i2c
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
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_hpp ${libname}.hpp)
|
||||
upm_module_init(mraa)
|
||||
|
||||
@ -43,11 +43,12 @@ namespace upm {
|
||||
/**
|
||||
* @library adxl335
|
||||
* @sensor adxl335
|
||||
* @comname ADXL335 3-Axis Analog Accelerometer
|
||||
* @comname Low-power, 3-axis +/- 3 g Accelerometer
|
||||
* @altname Grove 3-Axis Analog Accelerometer
|
||||
* @type accelerometer
|
||||
* @man seeed
|
||||
* @con analog
|
||||
* @web http://www.analog.com/en/products/mems/accelerometers/adxl335.html
|
||||
*
|
||||
* @brief API for the ADXL335 3-Axis Analog Accelerometer
|
||||
*
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
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_hpp ${libname}.hpp)
|
||||
upm_module_init(mraa)
|
||||
|
||||
@ -38,11 +38,12 @@ namespace upm {
|
||||
/**
|
||||
* @library 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)
|
||||
* @type accelerometer
|
||||
* @man seeed
|
||||
* @con i2c
|
||||
* @web http://www.analog.com/media/en/technical-documentation/data-sheets/ADXL345.pdf
|
||||
*
|
||||
* @brief API for the ADXL345 3-Axis Digital Accelerometer
|
||||
*
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
set (libname "adxrs610")
|
||||
set (libdescription "ADXRS610 gyroscope")
|
||||
set (libdescription "Gyro Breakout Board (300 Degrees/second)")
|
||||
set (module_src ${libname}.cxx)
|
||||
set (module_hpp ${libname}.hpp)
|
||||
upm_module_init(mraa)
|
||||
|
||||
@ -46,7 +46,7 @@ namespace upm {
|
||||
/**
|
||||
* @library adxrs610
|
||||
* @sensor adxrs610
|
||||
* @comname DFRobot ADXRS610 Gyro Breakout Board
|
||||
* @comname Gyro Breakout Board (300 Degrees/second)
|
||||
* @altname ADXRS610
|
||||
* @type compass
|
||||
* @man dfrobot
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
set (libname "am2315")
|
||||
set (libdescription "Humidity Sensor")
|
||||
set (libdescription "Digital Temperature and Humidity Sensor")
|
||||
set (module_src ${libname}.cpp)
|
||||
set (module_hpp ${libname}.hpp)
|
||||
upm_module_init(mraa)
|
||||
|
||||
@ -58,7 +58,7 @@ namespace upm {
|
||||
/**
|
||||
* @library am2315
|
||||
* @sensor am2315
|
||||
* @comname AM2315 Temperature & Humidity Sensor
|
||||
* @comname Digital Temperature and Humidity Sensor
|
||||
* @type temp
|
||||
* @man adafruit
|
||||
* @web http://www.adafruit.com/products/1293
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
upm_mixed_module_init (NAME apa102
|
||||
DESCRIPTION "RGB LED with integrated driver"
|
||||
DESCRIPTION "LED Strip"
|
||||
C_HDR apa102.h
|
||||
C_SRC apa102.c
|
||||
CPP_HDR apa102.hpp
|
||||
|
||||
@ -41,10 +41,11 @@ namespace upm
|
||||
/**
|
||||
* @library apa102
|
||||
* @sensor apa102
|
||||
* @comname APA102/DotStar LED Strip
|
||||
* @comname LED Strip
|
||||
* @type led
|
||||
* @man adafruit
|
||||
* @con spi
|
||||
* @web https://www.adafruit.com/product/2343
|
||||
*
|
||||
* @brief API for controlling APA102/DotStar RGB LED Strips
|
||||
*
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
set (libname "apds9002")
|
||||
set (libdescription "Apds9002 luminance module")
|
||||
set (libdescription "Ambient Light Photo Sensor")
|
||||
set (module_src ${libname}.cxx)
|
||||
set (module_hpp ${libname}.hpp)
|
||||
upm_module_init(mraa)
|
||||
|
||||
@ -26,22 +26,23 @@
|
||||
#include <string>
|
||||
#include <mraa/aio.h>
|
||||
|
||||
namespace upm {
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief APDS-9002 Luminance Sensor library
|
||||
* @defgroup apds9002 libupm-apds9002
|
||||
* @ingroup seeed analog light
|
||||
*/
|
||||
|
||||
*/
|
||||
|
||||
/**
|
||||
* @library apds9002
|
||||
* @sensor apds9002
|
||||
* @comname APDS-9002 Luminance Sensor
|
||||
* @comname Ambient Light Photo Sensor
|
||||
* @altname Grove Luminance Sensor
|
||||
* @type light
|
||||
* @man seeed
|
||||
* @con analog
|
||||
*
|
||||
* @web https://www.seeedstudio.com/Grove-Luminance-Sensor-p-1941.html
|
||||
*
|
||||
* @brief UPM module for the APDS-9002 Luminance Sensor
|
||||
*
|
||||
* This sensor transforms luminous intensity to output analog values.
|
||||
@ -50,7 +51,7 @@ namespace upm {
|
||||
* @image html apds9002.jpg
|
||||
* @snippet apds9002.cxx Interesting
|
||||
*/
|
||||
|
||||
|
||||
class APDS9002 {
|
||||
public:
|
||||
/**
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
set (libname "apds9930")
|
||||
set (libdescription "Apds9930 sensor module")
|
||||
set (libdescription "Digital Ambient Light and Proximity Sensor")
|
||||
set (module_src ${libname}.cxx)
|
||||
set (module_hpp ${libname}.hpp)
|
||||
upm_module_init(mraa)
|
||||
|
||||
@ -37,10 +37,11 @@ namespace upm
|
||||
/**
|
||||
* @library apds9930
|
||||
* @sensor apds9930
|
||||
* @comname APDS9930 Digital Proximity and Ambient Light Sensor
|
||||
* @comname Digital Ambient Light and Proximity Sensor
|
||||
* @type light proximity
|
||||
* @man Avago Technologies
|
||||
* @man avago
|
||||
* @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
|
||||
*
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
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_hpp ${libname}.hpp)
|
||||
upm_module_init(mraa)
|
||||
|
||||
@ -43,11 +43,12 @@ namespace upm
|
||||
/**
|
||||
* @library at42qt1070
|
||||
* @sensor at42qt1070
|
||||
* @comname AT42QT1070 QTouch Sensor
|
||||
* @comname Seven-channel QTouch Touch Sensor
|
||||
* @altname Grove QTouch Sensor
|
||||
* @type touch
|
||||
* @man seeed
|
||||
* @con i2c
|
||||
* @web http://wiki.seeed.cc/Grove-Q_Touch_Sensor/
|
||||
*
|
||||
* @brief API for the Atmel AT42QT1070 QTouch Sensor
|
||||
*
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
if (BACNET_FOUND)
|
||||
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_hpp ${libname}.hpp bacnetutil.hpp device.h)
|
||||
|
||||
|
||||
@ -59,7 +59,7 @@ namespace upm {
|
||||
/**
|
||||
* @library bacnetmstp
|
||||
* @sensor bacnetmstp
|
||||
* @comname UPM API for BACNET MS/TP communications
|
||||
* @comname UPM API for BACNET MS/TP Communications
|
||||
* @con uart
|
||||
* @web http://bacnet.sourceforge.net/
|
||||
* @brief UPM API for BACNETMSTP
|
||||
|
||||
@ -33,7 +33,7 @@ namespace upm {
|
||||
|
||||
/**
|
||||
* @library bacnetmstp
|
||||
* @comname UPM Utility API for BACnet
|
||||
* @comname Utility API for BACnet
|
||||
* @con uart
|
||||
*
|
||||
* @brief UPM Utility API for BACnet
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
upm_mixed_module_init (NAME bh1750
|
||||
DESCRIPTION "Digital light sensor"
|
||||
DESCRIPTION "Digital Light Sensor"
|
||||
C_HDR bh1750.h
|
||||
C_SRC bh1750.c
|
||||
CPP_HDR bh1750.hpp
|
||||
|
||||
@ -42,7 +42,7 @@ namespace upm {
|
||||
/**
|
||||
* @library bh1750
|
||||
* @sensor bh1750
|
||||
* @comname DFRobot Light Sensor
|
||||
* @comname Digital Light Sensor
|
||||
* @type light
|
||||
* @man dfrobot
|
||||
* @con i2c
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
upm_mixed_module_init (NAME biss0001
|
||||
DESCRIPTION "Passive Infrared (PIR) motion sensor"
|
||||
DESCRIPTION "Passive Infrared (PIR) Motion Sensor"
|
||||
C_HDR biss0001.h
|
||||
C_SRC biss0001.c
|
||||
CPP_HDR biss0001.hpp
|
||||
|
||||
@ -36,7 +36,7 @@ namespace upm {
|
||||
/**
|
||||
* @library biss0001
|
||||
* @sensor biss0001
|
||||
* @comname BISS0001 Motion Sensor
|
||||
* @comname Passive Infrared (PIR) Motion Sensor
|
||||
* @altname Grove PIR Motion Sensor
|
||||
* @type light
|
||||
* @man seeed
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
set (libname "bma220")
|
||||
set (libdescription "Accelerometer sensor based on bma220")
|
||||
set (libdescription "Digital Triaxial Acceleration Sensor")
|
||||
set (module_src ${libname}.cxx)
|
||||
set (module_hpp ${libname}.hpp)
|
||||
upm_module_init(mraa)
|
||||
|
||||
@ -42,7 +42,7 @@ namespace upm {
|
||||
/**
|
||||
* @library bma220
|
||||
* @sensor bma220
|
||||
* @comname BMA220 3-axis Accelerometer
|
||||
* @comname Digital Triaxial Acceleration Sensor
|
||||
* @type accelerometer
|
||||
* @man dfrobot
|
||||
* @con i2c gpio
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
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_SRC bmi160.c bosch_bmi160.c
|
||||
CPP_HDR bmi160.hpp
|
||||
|
||||
@ -40,12 +40,12 @@ namespace upm {
|
||||
/**
|
||||
* @library bmi160
|
||||
* @sensor bmi160
|
||||
* @comname BMI160 3-axis Accelerometer, Gyroscope
|
||||
* @comname Low-power IMU (triaxial Accelerometer and Triaxial Gyroscope)
|
||||
* and Magnetometer
|
||||
* @type accelerometer compass
|
||||
* @man mouser
|
||||
* @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
|
||||
* Magnetometer
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
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_hpp ${libname}.hpp bme280.hpp)
|
||||
upm_module_init(interfaces mraa)
|
||||
|
||||
@ -42,7 +42,7 @@ namespace upm {
|
||||
/**
|
||||
* @library bmp280
|
||||
* @sensor bme280
|
||||
* @comname BME280 Digital Humidity, Pressure, and Temperature Sensor
|
||||
* @comname Digital Humidity, Pressure, and Temperature Sensor
|
||||
* @type pressure humidity
|
||||
* @man adafruit
|
||||
* @con i2c spi gpio
|
||||
|
||||
@ -47,7 +47,7 @@ namespace upm {
|
||||
/**
|
||||
* @library bmp280
|
||||
* @sensor bmp280
|
||||
* @comname BMP280 Digital Pressure Sensor
|
||||
* @comname Digital Pressure Sensor
|
||||
* @type pressure
|
||||
* @man adafruit
|
||||
* @con i2c spi gpio
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
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_hpp ${libname}.hpp)
|
||||
upm_module_init(mraa interfaces)
|
||||
|
||||
@ -77,6 +77,9 @@ namespace upm {
|
||||
* @type pressure
|
||||
* @man seeed adafruit sparkfun
|
||||
* @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
|
||||
*
|
||||
|
||||
@ -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)
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
*
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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
|
||||
*
|
||||
|
||||
@ -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
|
||||
*
|
||||
|
||||
@ -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
|
||||
*
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
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_hpp ${libname}.hpp)
|
||||
upm_module_init(mraa)
|
||||
|
||||
@ -41,7 +41,7 @@ namespace upm {
|
||||
/**
|
||||
* @library bno055
|
||||
* @sensor bno055
|
||||
* @comname BNO055 Absolute Orientation 9DOF Fusion Hub
|
||||
* @comname Intelligent 9-axis Absolute Orientation Sensor
|
||||
* @type accelerometer compass
|
||||
* @man adafruit
|
||||
* @con i2c gpio
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
upm_mixed_module_init (NAME button
|
||||
DESCRIPTION "Momentary on/off button"
|
||||
DESCRIPTION "Button"
|
||||
C_HDR button.h
|
||||
C_SRC button.c
|
||||
CPP_HDR button.hpp
|
||||
|
||||
@ -41,7 +41,7 @@ namespace upm {
|
||||
/**
|
||||
* @library buzzer
|
||||
* @sensor buzzer
|
||||
* @comname Grove Buzzer
|
||||
* @comname Buzzer
|
||||
* @type sound
|
||||
* @man seeed
|
||||
* @con pwm
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
upm_mixed_module_init (NAME cjq4435
|
||||
DESCRIPTION "MOSFET module"
|
||||
DESCRIPTION "MOSFET"
|
||||
C_HDR cjq4435.h
|
||||
C_SRC cjq4435.c
|
||||
CPP_HDR cjq4435.hpp
|
||||
|
||||
@ -35,7 +35,7 @@ namespace upm {
|
||||
/**
|
||||
* @library cjq4435
|
||||
* @sensor cjq4435
|
||||
* @comname Grove MOSFET
|
||||
* @comname MOSFET
|
||||
* @altname CJQ4435
|
||||
* @type electric
|
||||
* @man seeed
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
upm_mixed_module_init (NAME collision
|
||||
DESCRIPTION "Collision sensor"
|
||||
DESCRIPTION "Collision Sensor"
|
||||
C_HDR collision.h
|
||||
C_SRC collision.c
|
||||
CPP_HDR collision.hpp
|
||||
|
||||
@ -4,7 +4,7 @@ include (CheckIncludeFiles)
|
||||
check_library_exists (${MRAA_LIBRARIES} mraa_firmata_init "" HAVE_FIRMATA)
|
||||
if (HAVE_FIRMATA)
|
||||
set (libname "curieimu")
|
||||
set (libdescription "Curie IMU via Firmata")
|
||||
set (libdescription "Curie IMU Sensor using Firmata")
|
||||
set (module_src ${libname}.cpp)
|
||||
set (module_hpp ${libname}.hpp)
|
||||
upm_module_init (mraa)
|
||||
|
||||
@ -58,7 +58,7 @@ struct IMUDataItem {
|
||||
/**
|
||||
* @library 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
|
||||
* @type accelerometer compass
|
||||
* @man bosch
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
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_hpp ${libname}.hpp)
|
||||
upm_module_init(mraa)
|
||||
|
||||
@ -41,7 +41,7 @@ namespace upm {
|
||||
/**
|
||||
* @library cwlsxxa
|
||||
* @sensor cwlsxxa
|
||||
* @comname Veris CWLSXXA CO2 Sensor Family
|
||||
* @comname CO2/temperature/humidity Transmitter
|
||||
* @type temp gaseous
|
||||
* @man veris
|
||||
* @con ainput
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
upm_mixed_module_init (NAME dfrec
|
||||
DESCRIPTION "DFRobot analog electrical conductivity (EC) sensor"
|
||||
DESCRIPTION "Analog Electrical Conductivity (EC) Sensor"
|
||||
C_HDR dfrec.h
|
||||
C_SRC dfrec.c
|
||||
CPP_HDR dfrec.hpp
|
||||
|
||||
@ -42,7 +42,7 @@ namespace upm {
|
||||
/**
|
||||
* @library dfrec
|
||||
* @sensor dfrec
|
||||
* @comname DFRobot EC Meter
|
||||
* @comname Analog Electrical Conductivity (EC) Sensor
|
||||
* @type liquid
|
||||
* @man dfrobot
|
||||
* @con ainput uart
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
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_SRC dfrorp.c
|
||||
CPP_HDR dfrorp.hpp
|
||||
|
||||
@ -43,7 +43,7 @@ namespace upm {
|
||||
/**
|
||||
* @library dfrorp
|
||||
* @sensor dfrorp
|
||||
* @comname DFRobot ORP (Oxidation/Reduction Potential) Sensor
|
||||
* @comname Analog Oxidation Reduction Potential (ORP) Sensor
|
||||
* @type liquid
|
||||
* @man dfrobot
|
||||
* @con ainput
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
upm_mixed_module_init (NAME dfrph
|
||||
DESCRIPTION "DFRobot pH sensor"
|
||||
DESCRIPTION "Analog pH Sensor"
|
||||
C_HDR dfrph.h
|
||||
C_SRC dfrph.c
|
||||
CPP_HDR dfrph.hpp
|
||||
|
||||
@ -38,7 +38,7 @@ namespace upm {
|
||||
/**
|
||||
* @library dfrph
|
||||
* @sensor dfrph
|
||||
* @comname DFRobot pH Sensors
|
||||
* @comname Analog pH Sensor
|
||||
* @type liquid
|
||||
* @man dfrobot
|
||||
* @web http://www.dfrobot.com/index.php?route=product/product&product_id=1110
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
set (libname "ds1307")
|
||||
set (libdescription "Real time clock (RTC) module")
|
||||
set (libdescription "Real Time Clock (RTC) Module")
|
||||
set (module_src ${libname}.cxx)
|
||||
set (module_hpp ${libname}.hpp)
|
||||
upm_module_init(mraa)
|
||||
|
||||
@ -51,11 +51,12 @@ namespace upm {
|
||||
/**
|
||||
* @library ds1307
|
||||
* @sensor ds1307
|
||||
* @comname Grove RTC (Real-Time Clock)
|
||||
* @comname Real Time Clock (RTC) Module
|
||||
* @altname DS1307 RTC
|
||||
* @type time
|
||||
* @man seeed
|
||||
* @con i2c
|
||||
* @web https://www.maximintegrated.com/en/products/digital/real-time-clocks/DS1307.html
|
||||
*
|
||||
* @brief API for the DS1307 Real-Time CLock
|
||||
*
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
set (libname "ds1808lc")
|
||||
set (libdescription "DS1808 lighting controller")
|
||||
set (libdescription "Lighting Controller")
|
||||
set (module_src ${libname}.cxx mraa-utils.cxx)
|
||||
set (module_hpp ${libname}.hpp)
|
||||
upm_module_init(interfaces mraa)
|
||||
|
||||
@ -43,7 +43,7 @@ namespace upm
|
||||
*
|
||||
* @library ds1808lc
|
||||
* @sensor ds1808lc
|
||||
* @comname Maxim DS1808 as lighting controller
|
||||
* @comname Lighting Controller
|
||||
* @altname DS1808LC
|
||||
* @type light
|
||||
* @man maxim
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
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_SRC ds18b20.c
|
||||
CPP_HDR ds18b20.hpp
|
||||
|
||||
@ -48,7 +48,7 @@ namespace upm {
|
||||
/**
|
||||
* @library ds18b20
|
||||
* @sensor ds18b20
|
||||
* @comname DS18B20 1-Wire Temperature Sensor
|
||||
* @comname Programmable Resolution 1-Wire Digital Thermometer
|
||||
* @type uart
|
||||
* @man maxim
|
||||
* @con uart
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
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_hpp ${libname}.hpp)
|
||||
upm_module_init(mraa)
|
||||
|
||||
@ -46,7 +46,7 @@ namespace upm {
|
||||
/**
|
||||
* @library ds2413
|
||||
* @sensor ds2413
|
||||
* @comname DS2413 1-Wire Dual Channel Addressable Switch
|
||||
* @comname 1-Wire Dual Channel Addressable Switch
|
||||
* @type gpio
|
||||
* @man maxim
|
||||
* @con uart
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
if (BACNET_FOUND)
|
||||
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_hpp ${libname}.hpp)
|
||||
|
||||
|
||||
@ -40,7 +40,7 @@ namespace upm {
|
||||
/**
|
||||
* @library e50hx
|
||||
* @sensor e50hx
|
||||
* @comname Veris E50HX Energy Meters
|
||||
* @comname Veris E50HX (E50H2/E50H5) Energy Meter Module
|
||||
* @type electic
|
||||
* @man veris
|
||||
* @con uart
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
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_SRC ecezo.c
|
||||
CPP_HDR ecezo.hpp
|
||||
|
||||
@ -41,7 +41,7 @@ namespace upm {
|
||||
/**
|
||||
* @library ecezo
|
||||
* @sensor ecezo
|
||||
* @comname EC-EZO EC Sensor
|
||||
* @comname Electrical Conductivity (EC) Circuit
|
||||
* @type liquid
|
||||
* @man sparkfun
|
||||
* @con uart i2c
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
set (libname "ecs1030")
|
||||
set (libdescription "Non-invasive current sensor")
|
||||
set (libdescription "Non-invasive Current Sensor")
|
||||
set (module_src ${libname}.cxx)
|
||||
set (module_hpp ${libname}.hpp)
|
||||
upm_module_init(mraa)
|
||||
|
||||
@ -50,7 +50,7 @@ namespace upm {
|
||||
/**
|
||||
* @library ecs1030
|
||||
* @sensor ecs1030
|
||||
* @comname ECS1030 Non-Invasive Current Sensor
|
||||
* @comname Non-invasive Current Sensor
|
||||
* @type electric
|
||||
* @man sparkfun
|
||||
* @web https://www.sparkfun.com/products/11005
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
upm_mixed_module_init (NAME ehr
|
||||
DESCRIPTION "Ear-clip heart rate sensor"
|
||||
DESCRIPTION "Ear-clip Heart Rate Sensor"
|
||||
CPP_HDR ehr.hpp
|
||||
CPP_SRC ehr.cxx
|
||||
REQUIRES mraa)
|
||||
|
||||
@ -38,7 +38,7 @@ namespace upm {
|
||||
/**
|
||||
* @library ehr
|
||||
* @sensor ehr
|
||||
* @comname Ear-clip Heart Rate Sensor
|
||||
* @comname Ear-clip Heart Rate Sensor
|
||||
* @type medical
|
||||
* @man seeed
|
||||
* @con gpio
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
upm_mixed_module_init (NAME eldriver
|
||||
DESCRIPTION "Electroluminescent wire (EL) driver"
|
||||
DESCRIPTION "Electroluminescent Wire (EL) Driver"
|
||||
CPP_HDR eldriver.hpp
|
||||
CPP_SRC eldriver.cxx
|
||||
REQUIRES mraa)
|
||||
|
||||
@ -38,7 +38,7 @@ namespace upm {
|
||||
/**
|
||||
* @library eldriver
|
||||
* @sensor eldriver
|
||||
* @comname EL Driver
|
||||
* @comname Electroluminescent Wire (EL) Driver
|
||||
* @type electric
|
||||
* @man seeed
|
||||
* @con gpio
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
upm_mixed_module_init (NAME electromagnet
|
||||
DESCRIPTION "Electromagnet sensor"
|
||||
DESCRIPTION "Electromagnet"
|
||||
CPP_HDR electromagnet.hpp
|
||||
CPP_SRC electromagnet.cxx
|
||||
REQUIRES mraa)
|
||||
|
||||
@ -38,7 +38,7 @@ namespace upm {
|
||||
/**
|
||||
* @library electromagnet
|
||||
* @sensor electromagnet
|
||||
* @comname Electromagnet
|
||||
* @comname Electromagnet
|
||||
* @type electric
|
||||
* @man seeed
|
||||
* @con gpio
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
upm_mixed_module_init (NAME emg
|
||||
DESCRIPTION "Electromyography (EMG) detector"
|
||||
DESCRIPTION "Electromyography (EMG) Sensor"
|
||||
C_HDR emg.h
|
||||
C_SRC emg.c
|
||||
CPP_HDR emg.hpp
|
||||
|
||||
@ -36,7 +36,7 @@ namespace upm {
|
||||
/**
|
||||
* @library emg
|
||||
* @sensor emg
|
||||
* @comname EMG Sensor
|
||||
* @comname Electromyography (EMG) Sensor
|
||||
* @altname Grove EMG Sensor
|
||||
* @type electric
|
||||
* @man seeed
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
upm_mixed_module_init (NAME enc03r
|
||||
DESCRIPTION "Single-axis Analog Gyroscope"
|
||||
DESCRIPTION "Single-axis Analog Gyro Module"
|
||||
C_HDR enc03r.h
|
||||
C_SRC enc03r.c
|
||||
CPP_HDR enc03r.hpp
|
||||
|
||||
@ -27,113 +27,112 @@
|
||||
#include "enc03r.h"
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief ENC03R Single Axis Gyro library
|
||||
* @defgroup enc03r libupm-enc03r
|
||||
* @ingroup seeed analog compass robok
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief ENC03R Single Axis Gyro library
|
||||
* @defgroup enc03r libupm-enc03r
|
||||
* @ingroup seeed analog compass robok
|
||||
*/
|
||||
|
||||
/**
|
||||
* @library enc03r
|
||||
* @sensor enc03r
|
||||
* @comname ENC03R Single Axis Gyro
|
||||
* @altname Grove Single Axis Analog Gyro
|
||||
* @type compass
|
||||
* @man seeed
|
||||
* @con analog
|
||||
* @kit robok
|
||||
*
|
||||
* @brief API for the ENC03R Single Axis Analog Gyro
|
||||
*
|
||||
* UPM module for the ENC03R single axis analog gyro.
|
||||
* This gyroscope measures x-axis angular velocity, that is
|
||||
* how fast the sensor is rotating around the x-axis.
|
||||
* Calibration of the sensor is necessary for accurate readings.
|
||||
*
|
||||
* @image html enc03r.jpg
|
||||
* @snippet enc03r.cxx Interesting
|
||||
*/
|
||||
class ENC03R {
|
||||
/**
|
||||
* @library enc03r
|
||||
* @sensor enc03r
|
||||
* @comname Single-axis Analog Gyro Module
|
||||
* @altname Grove Single Axis Analog Gyro
|
||||
* @type compass
|
||||
* @man seeed
|
||||
* @con analog
|
||||
* @kit robok
|
||||
* @web http://www.murata.com/en-us/products/productdetail?partno=ENC-03RC-R
|
||||
*
|
||||
* @brief API for the ENC03R Single Axis Analog Gyro
|
||||
*
|
||||
* UPM module for the ENC03R single axis analog gyro.
|
||||
* This gyroscope measures x-axis angular velocity, that is
|
||||
* how fast the sensor is rotating around the x-axis.
|
||||
* Calibration of the sensor is necessary for accurate readings.
|
||||
*
|
||||
* @image html enc03r.jpg
|
||||
* @snippet enc03r.cxx Interesting
|
||||
*/
|
||||
class ENC03R {
|
||||
public:
|
||||
|
||||
/**
|
||||
* ENC03R sensor constructor
|
||||
*
|
||||
* @param pin Analog pin to use
|
||||
* @param vref Reference voltage to use; default is 5.0 V
|
||||
*/
|
||||
* ENC03R sensor constructor
|
||||
*
|
||||
* @param pin Analog pin to use
|
||||
* @param vref Reference voltage to use; default is 5.0 V
|
||||
*/
|
||||
ENC03R(int pin, float aref=5.0);
|
||||
|
||||
/**
|
||||
* ENC03R destructor
|
||||
*/
|
||||
* ENC03R destructor
|
||||
*/
|
||||
~ENC03R();
|
||||
|
||||
/**
|
||||
* Calibrates the sensor by determining an analog reading over many
|
||||
* samples with no movement of the sensor. This must be done
|
||||
* before attempting to use the sensor.
|
||||
*
|
||||
* @param samples Number of samples to use for calibration
|
||||
*/
|
||||
* Calibrates the sensor by determining an analog reading over many
|
||||
* samples with no movement of the sensor. This must be done
|
||||
* before attempting to use the sensor.
|
||||
*
|
||||
* @param samples Number of samples to use for calibration
|
||||
*/
|
||||
void calibrate(unsigned int samples);
|
||||
|
||||
/**
|
||||
* Update the internal state with the current reading. This
|
||||
* function must be called prior to calling
|
||||
* angularVelocity().
|
||||
*
|
||||
* @param dev Device context
|
||||
*/
|
||||
* Update the internal state with the current reading. This
|
||||
* function must be called prior to calling
|
||||
* angularVelocity().
|
||||
*
|
||||
* @param dev Device context
|
||||
*/
|
||||
void update();
|
||||
|
||||
/**
|
||||
* Returns the currently stored calibration value
|
||||
*
|
||||
* @return Current calibration value
|
||||
*/
|
||||
* Returns the currently stored calibration value
|
||||
*
|
||||
* @return Current calibration value
|
||||
*/
|
||||
float calibrationValue() { return enc03r_calibration_value(m_enc03r); };
|
||||
|
||||
/**
|
||||
* Computes angular velocity based on the value and stored calibration
|
||||
* reference.
|
||||
*
|
||||
* @param val Value to use to compute angular velocity
|
||||
* @return Computed angular velocity
|
||||
*/
|
||||
* Computes angular velocity based on the value and stored calibration
|
||||
* reference.
|
||||
*
|
||||
* @param val Value to use to compute angular velocity
|
||||
* @return Computed angular velocity
|
||||
*/
|
||||
float angularVelocity();
|
||||
|
||||
/**
|
||||
* Set sensor offset. The offste is applied to the return value
|
||||
* before scaling. Default is 0.
|
||||
*
|
||||
* @param scale Scale to apply to value
|
||||
*/
|
||||
* Set sensor offset. The offste is applied to the return value
|
||||
* before scaling. Default is 0.
|
||||
*
|
||||
* @param scale Scale to apply to value
|
||||
*/
|
||||
void setOffset(float offset);
|
||||
|
||||
/**
|
||||
* Set sensor scale. The return value is scaled by this value
|
||||
* before the offset is applied. Default is 1.0.
|
||||
*
|
||||
* @param dev Device context
|
||||
* @param scale Offset to apply to value
|
||||
*/
|
||||
* Set sensor scale. The return value is scaled by this value
|
||||
* before the offset is applied. Default is 1.0.
|
||||
*
|
||||
* @param dev Device context
|
||||
* @param scale Offset to apply to value
|
||||
*/
|
||||
void setScale(float scale);
|
||||
|
||||
/**
|
||||
* Get a normalized ADC value from the sensor. The return
|
||||
* value will be between 0.0 (indicating no voltage) and 1.0
|
||||
* indicating max voltage (aref). update() must be called
|
||||
* prior to calling this function.
|
||||
*
|
||||
* @return The normalized reading from the ADC.
|
||||
*/
|
||||
* Get a normalized ADC value from the sensor. The return
|
||||
* value will be between 0.0 (indicating no voltage) and 1.0
|
||||
* indicating max voltage (aref). update() must be called
|
||||
* prior to calling this function.
|
||||
*
|
||||
* @return The normalized reading from the ADC.
|
||||
*/
|
||||
float getNormalized();
|
||||
|
||||
protected:
|
||||
enc03r_context m_enc03r;
|
||||
|
||||
private:
|
||||
};
|
||||
};
|
||||
}
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
upm_mixed_module_init (NAME flex
|
||||
DESCRIPTION "Resistive flex sensor"
|
||||
DESCRIPTION "Resistive Flex Sensor"
|
||||
C_HDR flex.h
|
||||
C_SRC flex.c
|
||||
CPP_HDR flex.hpp
|
||||
|
||||
@ -37,7 +37,7 @@ namespace upm {
|
||||
/**
|
||||
* @library flex
|
||||
* @sensor flex
|
||||
* @comname Flex Sensor
|
||||
* @comname Resistive Flex Sensor
|
||||
* @type flexfor
|
||||
* @man sparkfun
|
||||
* @web https://www.sparkfun.com/products/8606
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
upm_mixed_module_init (NAME gas
|
||||
DESCRIPTION "Generic gas detection sensor library"
|
||||
DESCRIPTION "Generic Gas Detection Sensor Library"
|
||||
C_HDR mqx.h
|
||||
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
|
||||
|
||||
@ -31,11 +31,12 @@ namespace upm {
|
||||
/**
|
||||
* @library gas
|
||||
* @sensor mq2
|
||||
* @comname Grove MQ2 Gas Sensor
|
||||
* @comname MQ2 Methane, Butane, Liquefied Petroleum Gas (LPG), and Smoke Sensor
|
||||
* @type gaseous
|
||||
* @man seeed
|
||||
* @con analog
|
||||
* @kit hak
|
||||
* @web http://wiki.seeed.cc/Grove-Gas_Sensor-MQ2/
|
||||
*
|
||||
* @brief API for the Grove MQ2 Gas Sensor
|
||||
*
|
||||
|
||||
@ -31,10 +31,11 @@ namespace upm {
|
||||
/**
|
||||
* @library gas
|
||||
* @sensor mq3
|
||||
* @comname Grove MQ3 Gas Sensor
|
||||
* @comname MQ3 Alcohol, Ethanol, Smoke Sensor
|
||||
* @type gaseous
|
||||
* @man seeed
|
||||
* @con analog
|
||||
* @web http://wiki.seeed.cc/Grove-Gas_Sensor-MQ3/
|
||||
*
|
||||
* @brief API for the MQ3 Gas Sensor
|
||||
*
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user