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

docs: updated library descriptions and sensor names for consistency

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2015-06-01 15:44:07 -07:00
parent 8965d56c93
commit 14f80e779e
97 changed files with 237 additions and 246 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/a110x/a110x.h
View File

@ -38,6 +38,7 @@ namespace upm {
* @sensor a110x
* @comname A110X Hall Effect Sensor
* @altname A1101, A1102, A1103, A1004, A1106
* @altname Grove Hall Sensor
* @type electric
* @man seeed
* @web http://www.allegromicro.com/en/Products/Magnetic-Digital-Position-Sensor-ICs/Hall-Effect-Unipolar-Switches/A1101-2-3-4-6.aspx

2
src/ad8232/ad8232.h
View File

@ -34,7 +34,7 @@
namespace upm {
/**
* @brief UPM support for the AD8232 Heart Rate Monitor
* @brief AD8232 heart rate monitor library
* @defgroup ad8232 libupm-ad8232
* @ingroup sparkfun gpio medical
*/

2
src/adafruitms1438/adafruitms1438.h
View File

@ -38,7 +38,7 @@
namespace upm {
/**
* @brief UPM module for the Adafruit Motor Shield 1438
* @brief Adafruit Motor Shield 1438 library
* @defgroup adafruitms1438 libupm-adafruitms1438
* @ingroup adafruit i2c motor
*/

3
src/adc121c021/adc121c021.h
View File

@ -49,7 +49,7 @@
namespace upm {
/**
* @brief ADC121C021 I2C Analog Digital Converter library
* @brief ADC121C021 I2C analog digital converter library
* @defgroup adc121c021 libupm-adc121c021
* @ingroup seeed i2c electric
*/
@ -73,6 +73,7 @@ namespace upm {
* @library adc121c021
* @sensor adc121c021
* @comname ADC121C021 Analog Digital Converter
* @altname Grove I2C ADC
* @type electric
* @man seeed
* @web http://www.seeedstudio.com/depot/Grove-I2C-ADC-p-1580.html

2
src/adis16448/adis16448.h
View File

@ -84,7 +84,7 @@
namespace upm {
/**
* @brief Adis16448
* @brief ADIS16448 accelerometer library
* @defgroup adis16448 libupm-adis16488
* @ingroup generic spi accelerometer
*/

1
src/adxl335/adxl335.h
View File

@ -44,6 +44,7 @@ namespace upm {
* @library adxl335
* @sensor adxl335
* @comname ADXL335 3-Axis Analog Accelerometer
* @altname Grove 3-Axis Analog Accelerometer
* @type accelerometer
* @man seeed
* @con analog

5
src/adxl345/adxl345.h
View File

@ -30,7 +30,7 @@
namespace upm {
/**
* @brief Adxl345 accelerometer library
* @brief ADXL345 accelerometer library
* @defgroup adxl345 libupm-adxl345
* @ingroup seeed i2c accelerometer
*/
@ -38,7 +38,8 @@ namespace upm {
/**
* @library adxl345
* @sensor adxl345
* @comname Adxl345 3-Axis Digital Accelerometer
* @comname ADXL345 3-Axis Digital Accelerometer
* @altname Grove 3-Axis Digital Accelerometer (16g)
* @type accelerometer
* @man seeed
* @con i2c

2
src/apds9002/apds9002.h
View File

@ -36,7 +36,7 @@ namespace upm {
/**
* @library apds9002
* @sensor apds9002
* @comname APDS-9002
* @comname APDS-9002 Luminance Sensor
* @altname Grove Luminance Sensor
* @type light
* @man seeed

5
src/at42qt1070/at42qt1070.h
View File

@ -35,7 +35,7 @@
namespace upm {
/**
* @brief UPM module for the Atmel AT42QT1070 QTouch sensor
* @brief Atmel AT42QT1070 QTouch sensor library
* @defgroup at42qt1070 libupm-at42qt1070
* @ingroup seeed i2c touch
*/
@ -43,7 +43,8 @@ namespace upm {
/**
* @library at42qt1070
* @sensor at42qt1070
* @comname Atmel AT42QT1070 QTouch Sensor
* @comname AT42QT1070 QTouch Sensor
* @altname Grove QTouch Sensor
* @type touch
* @man seeed
* @con i2c

3
src/biss0001/biss0001.h
View File

@ -36,7 +36,8 @@ namespace upm {
/**
* @library biss0001
* @sensor biss0001
* @comname PIR Motion Sensor
* @comname BISS0001 Motion Sensor
* @altname Grove PIR Motion Sensor
* @type light
* @man seeed
* @web http://www.seeedstudio.com/depot/Grove-PIR-Motion-Sensor-p-802.html

4
src/bmpx8x/bmpx8x.h
View File

@ -62,7 +62,7 @@
namespace upm {
/**
* @brief GY65/BPM085, and BMP180 atmospheric pressure sensor library
* @brief Bosch BPM & GY65 atmospheric pressure sensor library
* @defgroup bmpx8x libupm-bmpx8x
* @ingroup seeed adafruit sparkfun i2c pressure
*/
@ -70,7 +70,7 @@ namespace upm {
/**
* @library bmpx8x
* @sensor bmpx8x
* @comname Bosch BMP Atmospheric Pressure Sensor
* @comname BMP Atmospheric Pressure Sensor
* @altname GY65 BMP085 BMP180 BMP183
* @type pressure
* @man seeed adafruit sparkfun

6
src/ds1307/ds1307.h
View File

@ -43,7 +43,7 @@
namespace upm {
/**
* @brief DS1307 Real Time CLock library
* @brief DS1307 real-time clock library
* @defgroup ds1307 libupm-ds1307
* @ingroup seeed i2c time
*/
@ -51,8 +51,8 @@ namespace upm {
/**
* @library ds1307
* @sensor ds1307
* @comname Grove RTC (Real Time Clock)
* @altname DS1307
* @comname Grove RTC (Real-Time Clock)
* @altname DS1307 RTC
* @type time
* @man seeed
* @con i2c

4
src/enc03r/enc03r.h
View File

@ -37,8 +37,8 @@ namespace upm {
/**
* @library enc03r
* @sensor enc03r
* @comname Grove Single Axis Analog Gyro
* @altname ENC03R
* @comname ENC03R Single Axis Gyro
* @altname Grove Single Axis Analog Gyro
* @type compass
* @man seeed
* @con analog

4
src/flex/flex.h
View File

@ -29,7 +29,7 @@
namespace upm {
/**
* @brief UPM module for the Spectra Symbol Flex sensor
* @brief Spectra Symbol Flex sensor library
* @defgroup flex libupm-flex
* @ingroup sparkfun analog flexfor
*/
@ -37,7 +37,7 @@ namespace upm {
/**
* @library flex
* @sensor flex
* @comname Spectra Symbol Flex sensor
* @comname Flex Sensor
* @type flexfor
* @man sparkfun
* @con analog

2
src/gas/gas.h
View File

@ -35,7 +35,7 @@ struct thresholdContext {
namespace upm {
/**
* @brief Gas Sensor Library
* @brief Gas sensor library
*
* Sensor Library for air quality and gas detecting sensors. Base class Gas provides buffered
* sampling, threshold checking, a basic printing function and a standard read function.

4
src/gas/mq2.h
View File

@ -31,12 +31,12 @@ namespace upm {
/**
* @library gas
* @sensor mq2
* @comname Grove MQ2 gas sensor
* @comname Grove MQ2 Gas Sensor
* @type gaseous
* @man seeed
* @con analog
*
* @brief API for MQ2 gas sensor
* @brief API for MQ2 Gas Sensor
*
* The Grove - Gas Sensor (MQ2) module is useful for gas leakage detecting
* (in home and industry). It can detect LPG, i-butane, methane, alcohol,

4
src/gas/mq3.h
View File

@ -31,12 +31,12 @@ namespace upm {
/**
* @library gas
* @sensor mq3
* @comname Grove MQ3 gas sensor
* @comname Grove MQ3 Gas Sensor
* @type gaseous
* @man seeed
* @con analog
*
* @brief API for MQ3 gas sensor
* @brief API for MQ3 Gas Sensor
*
* The Grove MQ3 Gas Sensor module is useful for gas leakage detecting (in
* home and industry). It can detect Alcohol Vapour and Benzine. It's

4
src/gas/mq5.h
View File

@ -31,12 +31,12 @@ namespace upm {
/**
* @library gas
* @sensor mq5
* @comname Grove MQ5 gas sensor
* @comname Grove MQ5 Gas Sensor
* @type gaseous
* @man seeed
* @con analog
*
* @brief API for MQ5 gas sensor
* @brief API for MQ5 Gas Sensor
*
* The Grove - Gas Sensor (MQ5) module is useful for gas leakage detecting
* (in home and industry). It can detect LPG, natural gas, town gas and so

4
src/gas/mq9.h
View File

@ -31,12 +31,12 @@ namespace upm {
/**
* @library gas
* @sensor mq9
* @comname Grove MQ9 gas sensor
* @comname Grove MQ9 Gas Sensor
* @type gaseous
* @man seeed
* @con analog
*
* @brief API for MQ9 gas sensor
* @brief API for MQ9 Gas Sensor
*
* The Grove MQ9 Gas Sensor module is useful for gas leakage detecting (in
* home and industry). It can detect Carbon Monoxide, Coal Gas and

2
src/gas/tp401.h
View File

@ -32,7 +32,7 @@ namespace upm {
* @library gas
* @sensor tp401
* @comname Grove Air Quality Sensor
* @altname TP401
* @altname TP401 Gas Sensor
* @type gaseous
* @man seeed
* @con analog

5
src/gp2y0a/gp2y0a.h
View File

@ -29,7 +29,7 @@
namespace upm {
/**
* @brief UPM library for the GP2Y0A family of IR Proximity Sensors
* @brief GP2Y0A based IR proximity sensor library
* @defgroup gp2y0a libupm-gp2y0a
* @ingroup seeed analog light
*/
@ -37,7 +37,8 @@ namespace upm {
/**
* @library gp2y0a
* @sensor gp2y0a
* @comname GP2Y0A family of IR Proximity Sensors
* @comname GP2Y0A IR Proximity Sensor
* @altname Grove 80cm IR Proximity Sensor
* @type light
* @man seeed
* @con analog

2
src/grove/grovebutton.h
View File

@ -33,7 +33,7 @@
* @con gpio
* @kit gsk
*
* @brief API for Grove button
* @brief API for Grove Button
*
* Very basic UPM module for Grove button
*

2
src/grove/grovelight.h
View File

@ -32,7 +32,7 @@
* @con analog
* @kit gsk
*
* @brief API for Grove light sensor
* @brief API for Grove Light Sensor
*
* The Grove light sensor detects the intensity of the ambient light.
* As the light intensity of the environment increases, the resistance

1
src/grove/groverotary.h
View File

@ -27,6 +27,7 @@
* @library grove
* @sensor groverotary
* @comname Grove Rotary Angle Sensor
* @altname Rotary Potentiometer
* @type ainput
* @man seeed
* @con analog

2
src/grove/grovetemp.h
View File

@ -32,7 +32,7 @@
* @con analog
* @kit gsk
*
* @brief API for Grove temperature sensor
* @brief API for Grove Temperature Sensor
*
* Very basic UPM module for Grove temperature sensor on analog
*

2
src/grovecollision/grovecollision.h
View File

@ -27,7 +27,7 @@
namespace upm {
/**
* @brief UPM library for the Grove Collision Sensor
* @brief Grove Collision sensor library
* @defgroup grovecollision libupm-grovecollision
* @ingroup seeed gpio accelerometer
*/

2
src/groveeldriver/groveeldriver.h
View File

@ -30,7 +30,7 @@
namespace upm {
/**
* @brief UPM library for the Grove El Driver Module
* @brief Grove El Driver module library
* @defgroup groveeldriver libupm-groveeldriver
* @ingroup seeed gpio electric
*/

2
src/groveelectromagnet/groveelectromagnet.h
View File

@ -30,7 +30,7 @@
namespace upm {
/**
* @brief UPM library for the Grove Electromagnet
* @brief Grove Electromagnet library
* @defgroup groveelectromagnet libupm-groveelectromagnet
* @ingroup seeed gpio electric
*/

2
src/groveemg/groveemg.h
View File

@ -28,7 +28,7 @@
namespace upm {
/**
* @brief UPM library for the GroveEMG Muscle Signal reader sensor
* @brief GroveEMG Muscle Signal reader sensor library
* @defgroup groveemg libupm-groveemg
* @ingroup seeed analog electric
*/

2
src/grovegsr/grovegsr.h
View File

@ -28,7 +28,7 @@
namespace upm {
/**
* @brief UPM library for the GroveGSR Galvanic Skin Response Sensor
* @brief GroveGSR Galvanic Skin Response sensor library
* @defgroup grovegsr libupm-grovegsr
* @ingroup seeed analog electric
*/

2
src/grovelinefinder/grovelinefinder.h
View File

@ -28,7 +28,7 @@
namespace upm {
/**
* @brief UPM library for the Grove Line Finder
* @brief Grove Line Finder sensor library
* @defgroup grovelinefinder libupm-grovelinefinder
* @ingroup seeed gpio color
*/

2
src/groveloudness/groveloudness.h
View File

@ -28,7 +28,7 @@
namespace upm {
/**
* @brief UPM library for the Grove Loudness Sensor
* @brief Grove Loudness sensor library
* @defgroup groveloudness libupm-groveloudness
* @ingroup seeed analog sound
*/

2
src/grovemd/grovemd.h
View File

@ -34,7 +34,7 @@
namespace upm {
/**
* @brief UPM module for the Grove I2C Motor Driver
* @brief Grove I2C motor driver library
* @defgroup grovemd libupm-grovemd
* @ingroup seeed i2c motor
*/

2
src/grovemoisture/grovemoisture.h
View File

@ -28,7 +28,7 @@
namespace upm {
/**
* @brief UPM library for the Grove Moisture Sensor
* @brief Grove Moisture sensor library
* @defgroup grovemoisture libupm-grovemoisture
* @ingroup seeed analog liquid
*/

2
src/groveo2/groveo2.h
View File

@ -28,7 +28,7 @@
namespace upm {
/**
* @brief UPM module for the GroveO2 Oxygen Gas Sensor
* @brief GroveO2 Oxygen Gas Sensor library
* @defgroup groveo2 libupm-groveo2
* @ingroup seeed analog gaseous
*/

6
src/grovescam/grovescam.h
View File

@ -48,9 +48,9 @@
namespace upm {
/**
* @brief UPM library for the Grove Serial Camera
* @brief Grove Serial Camera library
* @defgroup grovescam libupm-grovescam
* @ingroup seeed serial
* @ingroup seeed serial
*/
/**
@ -131,7 +131,7 @@ namespace upm {
* setup the proper tty i/o modes and the baudrate. The default
* baud rate is 9600 (B9600) for this device.
*
* @param baud the desired baud rate.
* @param baud the desired baud rate.
* @return true if successful
*/
bool setupTty(speed_t baud=B115200);

2
src/grovespeaker/grovespeaker.h
View File

@ -33,7 +33,7 @@
namespace upm {
/**
* @brief UPM library for the Grove Speaker
* @brief Grove Speaker library
* @defgroup grovespeaker libupm-grovespeaker
* @ingroup seeed gpio sound
*/

2
src/grovevdiv/grovevdiv.h
View File

@ -36,7 +36,7 @@
namespace upm {
/**
* @brief UPM library for the Grove Voltage Divider
* @brief Grove Voltage Divider sensor library
* @defgroup grovevdiv libupm-grovevdiv
* @ingroup seeed analog electric
*/

2
src/grovewater/grovewater.h
View File

@ -28,7 +28,7 @@
namespace upm {
/**
* @brief UPM library for the Grove Water Sensor
* @brief Grove Water sensor library
* @defgroup grovewater libupm-grovewater
* @ingroup seeed gpio liquid
*/

2
src/grovewfs/grovewfs.h
View File

@ -31,7 +31,7 @@
namespace upm {
/**
* @brief UPM module for the Grove Water Flow sensor
* @brief Grove Water Flow sensor library
* @defgroup grovewfs libupm-grovewfs
* @ingroup seeed gpio liquid
*/

4
src/guvas12d/guvas12d.h
View File

@ -28,7 +28,7 @@
namespace upm {
/**
* @brief UPM library for the GUVA-S12D Sensor
* @brief GUVA-S12D UV sensor library
* @defgroup guvas12d libupm-guvas12d
* @ingroup seeed analog light
*/
@ -37,7 +37,7 @@ namespace upm {
* @library guvas12d
* @sensor guvas12d
* @comname Grove UV Sensor
* @altname GUVA-S12D
* @altname GUVA-S12D UV Sensor
* @type light
* @man seeed
* @con analog

10
src/h3lis331dl/h3lis331dl.h
View File

@ -32,7 +32,7 @@
namespace upm {
/**
* @brief Grove 3-axis I2C Accelerometer (400G)
* @brief H3LIS331DL I2C accelerometer (400g) library
* @defgroup h3lis331dl libupm-h3lis331dl
* @ingroup seeed i2c accelerometer
*/
@ -40,14 +40,16 @@ namespace upm {
/**
* @library h3lis331dl
* @sensor h3lis331dl
* @comname Grove 3-axis I2C Accelerometer (400G)
* @comname H3LIS331DL 3-Axis Digital Accelerometer
* @altname Grove 3-Axis Digital Accelerometer (400g)
* @type accelerometer
* @man seeed
* @web http://www.seeedstudio.com/depot/Grove-3Axis-Digital-Accelerometer400g-p-1897.html
* @con i2c
*
* @brief API for the H3LIS331DL based Grove 3-axis I2C Accelerometer
* (400G)
* @brief API for the H3LIS331DL based Grove 3-axis I2C (400G)
*
* This is a high performance, high range accelerometer for extreme applications.
*
* @image html h3lis331dl.jpg
* @snippet h3lis331dl.cxx Interesting

9
src/hm11/hm11.h
View File

@ -47,7 +47,7 @@
namespace upm {
/**
* @brief UPM library for the HM-11 Bluetooth 4.0 Low Energy Module
* @brief HM-11 Bluetooth 4.0 Low Energy module library
* @defgroup hm11 libupm-hm11
* @ingroup seeed serial wifi
*/
@ -55,8 +55,9 @@ namespace upm {
/**
* @library hm11
* @sensor hm11
* @comname HM-11 Bluetooth 4.0 Low Energy Module
* @comname HM-11 Bluetooth Low Energy
* @altname HM-10, HM-12
* @altname Grove BLE
* @category wifi
* @manufacturer seeed
* @connection uart
@ -73,7 +74,7 @@ namespace upm {
*
* It is connected via a UART at 9600 baud.
*
* @image html hm11.jpg
* @image html hm11.jpg
* @snippet hm11.cxx Interesting
*/
@ -125,7 +126,7 @@ namespace upm {
* setup the proper tty i/o modes and the baudrate. The default
* baud rate is 9600 (B9600) for this device.
*
* @param baud the desired baud rate.
* @param baud the desired baud rate.
* @return true if successful
*/
bool setupTty(speed_t baud=B9600);

3
src/hmc5883l/hmc5883l.h
View File

@ -39,7 +39,8 @@ namespace upm {
/**
* @library hmc5883l
* @sensor hmc5883l
* @comname Hmc5883l 3-Axis Digital Compass
* @comname HMC5883L 3-Axis Digital Compass
* @altname Grove 3-Axis Digital Compass
* @type compass
* @man seeed
* @con i2c

2
src/ht9170/ht9170.h
View File

@ -29,7 +29,7 @@
namespace upm {
/**
* @brief UPM library for the HT9170 DTMF Decoder
* @brief HT9170 DTMF decoder library
* @defgroup ht9170 libupm-ht9170
* @ingroup seeed gpio other
*/

2
src/hx711/hx711.h
View File

@ -37,7 +37,7 @@ namespace upm {
/**
* @library hx711
* @sensor hx711
* @comname HX711 24bit Analog-to-Digital Converter
* @comname HX711 Analog-to-Digital Converter
* @type electric
* @man generic
* @web http://www.dfrobot.com/image/data/SEN0160/hx711_english.pdf

4
src/ina132/ina132.h
View File

@ -28,7 +28,7 @@
namespace upm {
/**
* @brief UPM library for the INA132 Differential Amplifier Sensor
* @brief INA132 differential amplifier sensor library
* @defgroup ina132 libupm-ina132
* @ingroup seeed analog electric
*/
@ -36,7 +36,7 @@ namespace upm {
* @library ina132
* @sensor ina132
* @comname Grove Differential Amplifier
* @altname INA132
* @altname INA132
* @type electric
* @man seeed
* @con analog

5
src/isd1820/isd1820.h
View File

@ -29,7 +29,7 @@
namespace upm {
/**
* @brief UPM support for the ISD1820 based Grove Recorder
* @brief ISD1820 recorder module library
* @defgroup isd1820 libupm-isd1820
* @ingroup seeed gpio sound
*/
@ -37,7 +37,8 @@ namespace upm {
/**
* @library libupm-isd1820
* @sensor isd1820
* @comname Grove Recorder v1.0
* @comname Grove Recorder
* @altname ISD1820 Recorder
* @type sound
* @man seeed
* @con gpio

7
src/itg3200/itg3200.h
View File

@ -30,7 +30,7 @@
namespace upm {
/**
* @brief Itg3200 gyroscope library
* @brief ITG3200 gyroscope library
* @defgroup itg3200 libupm-itg3200
* @ingroup seeed i2c compass
*/
@ -38,12 +38,13 @@ namespace upm {
/**
* @library itg3200
* @sensor itg3200
* @comname Itg3200 3-Axis Digital Gyroscope
* @comname ITG3200 3-Axis Digital Gyroscope
* @altname Grove 3-Axis Digital Gyroscope
* @type compass
* @man seeed
* @con i2c
*
* @brief API for Itg3200 (3-axis digital gyroscope)
* @brief API for Itg3200 (3-Axis Digital Gyroscope)
*
* The InvenSense Itg3200 is a 3-axis digital gyroscope.
* (https://www.sparkfun.com/datasheets/Sensors/Gyro/PS-ITG-3200-00-01.4.pdf)

5
src/joystick12/joystick12.h
View File

@ -45,9 +45,10 @@ namespace upm {
*
* @brief API for Elecfreaks Joystick v 1.2-1.4 breakout
*
* This file defines the Joystick API and implemntation for X, Y
* This file defines the Joystick API and implementation for X, Y
* button could be treated as normal GPIO, this enables easier
* interrupt support
* interrupt support. This driver should be compatible with any
* 2 axis analog joystick.
*
* @image html joystick12.jpg
* @snippet joystick12-example.cxx Interesting

2
src/l298/l298.h
View File

@ -34,7 +34,7 @@
namespace upm {
/**
* @brief UPM library for the L298 Dual H-Bridge Motor Driver
* @brief L298 dual H-bridge motor driver library
* @defgroup l298 libupm-l298
* @ingroup seeed sparkfun gpio pwm motor
*/

2
src/lcd/i2clcd.h
View File

@ -76,7 +76,7 @@ const uint8_t LCD_RW = 0x02; // Read/Write bit
const uint8_t LCD_RS = 0x01; // Register select bit
/**
* @brief i2c LCD display library
* @brief I2C LCD display library
* @defgroup i2clcd libupm-i2clcd
* @ingroup seeed sparkfun adafruit i2c display gsk
*/

2
src/ldt0028/ldt0028.h
View File

@ -29,7 +29,7 @@
namespace upm {
/**
* @brief LDT0-028 Piezo Vibration sensor library
* @brief LDT0-028 piezo vibration sensor library
* @defgroup ldt0028 libupm-ldt0028
* @ingroup seeed analog flexfor
*/

2
src/lol/lol.h
View File

@ -49,7 +49,7 @@ namespace upm {
*
* @brief API for Olimex LoL array
*
* This file defines the LoL API and implemntation for a simple framebuffer
* This file defines the LoL API and implementation for a simple frame buffer.
*
* @snippet lol-example.cxx Interesting
*/

2
src/lsm303/lsm303.h
View File

@ -76,7 +76,7 @@ namespace upm {
* @web http://www.seeedstudio.com/wiki/Grove_-_6-Axis_Accelerometer%26Compass
* @con i2c
*
* @brief API for LSM303
* @brief API for LSM303 Accelerometer & Compass
*
* This file defines the LSM303DLH 3-axis magnetometer/3-axis accelerometer.
* This module was tested with the SeedStudio Grove [6-Axis Accelerometer&Compass]

6
src/max31723/max31723.h
View File

@ -34,19 +34,19 @@
namespace upm {
/**
* @brief max31723 temperature sensor library
* @brief MAX31723 temperature sensor library
* @defgroup max31723 libupm-max31723
* @ingroup maxim spi temperature
*/
/**
* @library max31723
* @sensor max31723
* @comname max31723 temperature sensor
* @comname MAX31723 Temperature Sensor
* @type temperature
* @man maxim
* @con spi
*
* @brief API for MAX31723 chip (Temperature sensor)
* @brief API for MAX31723 chip (Temperature Sensor)
*
* The Maxim Integrated
* [MAX31723](http://datasheets.maximintegrated.com/en/ds/MAX31722-MAX31723.pdf)

10
src/max31855/max31855.h
View File

@ -30,19 +30,19 @@
namespace upm {
/**
* @brief max31855 thermocouple library
* @brief MAX31855 thermocouple library
* @defgroup max31855 libupm-max31855
* @ingroup maxim spi other
* @ingroup maxim adafruit spi other
*/
/**
* @library max31855
* @sensor max31855
* @comname max31855 thermocouple library
* @comname MAX31855 Thermocouple Amplifier
* @type other
* @man maxim
* @man maxim adafruit
* @con spi
*
* @brief API for MAX31855
* @brief API for MAX31855 Thermocouple Amplifier
*
* The Maxim Integrated
* [MAX31855](http://datasheets.maximintegrated.com/en/ds/MAX31855.pdf)

4
src/max44000/max44000.h
View File

@ -53,14 +53,14 @@
namespace upm {
/**
* @brief max44000 proxmity sensor library
* @brief MAX44000 proximity sensor library
* @defgroup max44000 libupm-max44000
* @ingroup maxim i2c light
*/
/**
* @library max44000
* @sensor max44000
* @comname max44000 proximity sensor
* @comname MAX44000 Proximity Sensor
* @type light
* @man maxim
* @con i2c

14
src/max5487/max5487.h
View File

@ -34,19 +34,19 @@
namespace upm {
/**
* @brief max5847 digital potentiometer library
* @defgroup max5847 libupm-max5847
* @brief MAX5487 digital potentiometer library
* @defgroup max5487 libupm-max5487
* @ingroup maxim spi digipot
*/
/**
* @library max5847
* @sensor max5847
* @comname max5847 potentiometer sensor
* @library max5487
* @sensor max5487
* @comname MAX5487 Digital Potentiometer
* @type digipot
* @man maxim
* @con spi
*
* @brief API for MAX5487 chip (SPI digital potentionmeter)
* @brief API for MAX5487 chip (SPI digital potentiometer)
*
* The Maxim Integrated
* [MAX5487](http://datasheets.maximintegrated.com/en/ds/MAX5487-MAX5489.pdf)
@ -55,7 +55,7 @@ namespace upm {
* PMOD module](http://datasheets.maximintegrated.com/en/ds/MAX5487PMB1.pdf)
* from the analog PMOD kit.
*
* @snippet max5847.cxx Interesting
* @snippet max5487.cxx Interesting
*/
class MAX5487 {
public:

8
src/maxds3231m/maxds3231m.h
View File

@ -63,21 +63,21 @@ struct Time3231 {
};
/**
* @brief maxds3231m proximity sensor library
* @brief MAXDS3231M proximity sensor library
* @defgroup maxds3231m libupm-maxds3231m
* @ingroup maxim i2c light
*/
/**
* @library maxds3231m
* @sensor maxds3231m
* @comname maxds3231m proximity sensor
* @comname MAXDS3231M Real-Time Clock
* @type light
* @man maxim
* @con i2c
*
* @brief API for MAXDS3231M chip (Ambient and Infrared Proximity Sensor)
* @brief API for MAXDS3231M chip (I2C Real-Time Clock)
*
* This file defines the maxds3231m interface for maxds3231m
* This file defines the API for maxds3231m
*
* @snippet maxds3231m.cxx Interesting
*/

4
src/maxsonarez/maxsonarez.h
View File

@ -32,7 +32,7 @@
namespace upm {
/**
* @brief UPM library for the MaxSonar-EZ family of ultrasonic rangers
* @brief MaxSonar-EZ family of ultrasonic rangers library
* @defgroup maxsonarez libupm-maxsonarez
* @ingroup seeed analog sound
*/
@ -40,7 +40,7 @@ namespace upm {
/**
* @library maxsonarez
* @sensor maxsonarez
* @comname LV-MaxSonar-EZ family of ultrasonic rangers
* @comname LV-MaxSonar-EZ Ultrasonic Ranger
* @altname EZ1, EZ2, EZ3, EZ4
* @type sound
* @man sparkfun

11
src/mhz16/mhz16.h
View File

@ -55,8 +55,9 @@ namespace upm {
/**
* @library mhz16
* @sensor mhz16
* @comname Grove CO2 sensor
* @sensor mhz16
* @comname Grove CO2 Sensor
* @altname MHZ16 Serial CO2 Sensor
* @type gaseous
* @man seeed
* @con uart
@ -67,14 +68,14 @@ namespace upm {
*
* It's CO2 detection ranges from 0PPM to 2000PPM. It requires a
* 2-3 minute warm up time before reporting valid data.
*
*
* @image html mhz16.jpg
* @snippet mhz16.cxx Interesting
*/
class MHZ16 {
public:
/**
* MHZ16 module constructor
*
@ -120,7 +121,7 @@ namespace upm {
* setup the proper tty i/o modes and the baudrate. The default
* baud rate is 9600 (B9600).
*
* @param baud the desired baud rate.
* @param baud the desired baud rate.
* @return true if successful
*/
bool setupTty(speed_t baud=B9600);

3
src/mic/mic.h
View File

@ -36,7 +36,7 @@ struct thresholdContext {
namespace upm {
/**
* @brief Analog Microphone library
* @brief Analog microphone library
* @defgroup mic libupm-mic
* @ingroup seeed pwm sound gsk
*/
@ -44,6 +44,7 @@ namespace upm {
* @library mic
* @sensor mic
* @comname Analog Microphone
* @altname Grove Sound Sensor
* @type sound
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Sound_Sensors

4
src/mlx90614/mlx90614.h
View File

@ -53,14 +53,14 @@
namespace upm {
/**
* @brief mlx90614 temperature sensor library
* @brief MLX90614 temperature sensor library
* @defgroup mlx90614 libupm-mlx90614
* @ingroup generic i2c temperature
*/
/**
* @library mlx90614
* @sensor mlx90614
* @comname mlx90614 temperature sensor
* @comname MLX90614 Temperature Sensor
* @type temperature
* @man generic
* @con i2c

4
src/mma7455/mma7455.h
View File

@ -150,14 +150,14 @@ union accelData {
#define BIT(n) (1<<n)
/**
* @brief mma7455 accelerometer library
* @brief MMA7455 accelerometer library
* @defgroup mma7455 libupm-mma7455
* @ingroup generic i2c accelerometer
*/
/**
* @library mma7455
* @sensor mma7455
* @comname mma7455 accelerometer library
* @comname MMA7455 Accelerometer Sensor
* @type accelerometer
* @man generic
* @con i2c

7
src/mma7660/mma7660.h
View File

@ -35,14 +35,15 @@ namespace upm {
/**
* @brief MMA7660 I2C 3-axis digital accelerometer library
* @defgroup mma7660 libupm-mma7660
* @ingroup generic i2c gpio accelerometer
* @ingroup seeed i2c gpio accelerometer
*/
/**
* @library mma7660
* @sensor mma7660
* @comname mma7660 I2C 3-axis digital accelerometer
* @comname MMA7660 3-Axis Digital Accelerometer
* @altname Grove 3-Axis Digital Accelerometer (1.5g)
* @type accelerometer
* @man generic
* @man seeed
* @con i2c gpio
*
* @brief API for the MMA7660 I2C 3-axis digital accelerometer

4
src/mpl3115a2/mpl3115a2.h
View File

@ -56,14 +56,14 @@
namespace upm {
/**
* @brief mpl3115a2 Atmospheric Pressure library
* @brief MPL3115A2 atmospheric pressure library
* @defgroup mpl3115a2 libupm-mpl3115a2
* @ingroup freescale i2c pressure
*/
/**
* @library mpl3115a2
* @sensor mpl3115a2
* @comname mpl3115a2 Atmospheric Pressure
* @comname MPL3115A2 Atmospheric Pressure Sensor
* @type pressure
* @man freescale
* @web http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2

15
src/mpr121/mpr121.h
View File

@ -30,25 +30,16 @@
#define MPR121_DEFAULT_I2C_ADDR 0x5a
namespace upm {
/**
* @brief API for the MPR121 I2C touch sensor
*
* UPM module for the MPR121 touch sensor
*
* @ingroup i2c mpr121
* @snippet mpr121.cxx Interesting
*/
/**
* @brief mpr121 Touch Sensor library
* @brief MPR121 touch sensor library
* @defgroup mpr121 libupm-mpr121
* @ingroup seeed i2c touch
*/
/**
* @library mpr121
* @sensor mpr121
* @comname mpr121 touch sensor
* @comname MPR121 Touch Sensor
* @altname Grove I2C Touch Sensor
* @type touch
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_I2C_Touch_Sensor

5
src/mpu9150/mpu9150.h
View File

@ -109,14 +109,15 @@ struct AxisData {
};
/**
* @brief mpu9150 accelerometer library
* @brief MPU9150 accelerometer library
* @defgroup mpu9150 libupm-mpu9150
* @ingroup seeed i2c accelerometer compass
*/
/**
* @library mpu9150
* @sensor mpu9150
* @comname mpu9150 accelerometer library
* @comname MPU9150 Inertial Measurement Unit
* @altname Grove IMU 9DOF
* @type accelerometer compass
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_IMU_9DOF_v1.0

5
src/mq303a/mq303a.h
View File

@ -29,14 +29,15 @@
namespace upm {
/**
* @brief mq303a Alcohol Sensor library
* @brief MQ303A alcohol sensor library
* @defgroup mq303a libupm-mq303a
* @ingroup seeed analog gpio gaseous
*/
/**
* @library mq303a
* @sensor mq303a
* @comname mq303a Alcohol Sensor
* @comname MQ303A Alcohol Sensor
* @altname Grove Alcohol Sensor
* @type gaseous
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Alcohol_Sensor

7
src/my9221/my9221.h
View File

@ -38,20 +38,21 @@
namespace upm {
/**
* @brief my9221 led bar library
* @brief MY9221 led bar library
* @defgroup my9221 libupm-my9221
* @ingroup seeed display gpio
*/
/**
* @library my9221
* @sensor my9221
* @comname LED bar
* @comname Grove LED Bar
* @altname MY9221 LED Bar
* @type display
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_LED_Bar
* @con gpio
*
* @brief API for MY9221 led bar module
* @brief API for MY9221 based LED bars
*
* This file defines the MY9221 interface for libmy9221
*

10
src/nrf24l01/nrf24l01.h
View File

@ -151,20 +151,20 @@ typedef enum {
} power_t;
/**
* @brief nrf24l01 transceiver library
* @brief NRF24L01 transceiver library
* @defgroup nrf24l01 libupm-nrf24l01
* @ingroup seeed spi wifi
* @ingroup seeed sparkfun spi wifi
*/
/**
* @library nrf24l01
* @sensor nrf24l01
* @comname nrf24l01 transceiver library
* @comname NRF24L01 Transceiver
* @type wifi
* @man seeed
* @man seeed sparkfun
* @web http://www.seeedstudio.com/depot/nRF24L01Module-p-1394.html
* @con spi
*
* @brief API for NRF24l01 transceiver module
* @brief API for NRF24L01 transceiver module
*
* This file defines the NRF24l01 interface for libnrf24l01
*

4
src/nrf8001/nrf8001.h
View File

@ -23,14 +23,14 @@
*/
/**
* @brief nrf8001 Bluetooth Low Energy library
* @brief NRF8001 bluetooth low energy library
* @defgroup nrf8001 libupm-nrf8001
* @ingroup adafruit wifi analog gpio spi
*/
/**
* @library nrf8001
* @sensor nrf8001
* @comname Bluetooth Low Energy
* @comname NRF8001 Bluetooth Low Energy
* @type wifi
* @man adafruit
* @web https://learn.adafruit.com/getting-started-with-the-nrf8001-bluefruit-le-breakout/introduction

5
src/otp538u/otp538u.h
View File

@ -29,14 +29,15 @@
namespace upm {
/**
* @brief otp538u IR Temperature Sensor library
* @brief OTP538U IR Temperature Sensor library
* @defgroup otp538u libupm-otp538u
* @ingroup seeed analog light
*/
/**
* @library otp538u
* @sensor otp538u
* @comname IR Temperature Sensor
* @comname OTP538U IR Temperature Sensor
* @altname Grove IR Temperature Sensor
* @type light
* @man generic
* @con analog

4
src/pca9685/pca9685.h
View File

@ -39,14 +39,14 @@
namespace upm {
/**
* @brief 16 Channel, 12 bit pwm LED controller library
* @brief PCA9685 PWM controller library
* @defgroup pca9685 libupm-pca9685
* @ingroup adafruit i2c led motor
*/
/**
* @library pca9685
* @sensor pca9685
* @comname 16 Channel, 12 bit pwm LED controller
* @comname PCA9685 PWM Controller
* @type led motor
* @man adafruit
* @web http://www.adafruit.com/products/815

5
src/ppd42ns/ppd42ns.h
View File

@ -37,14 +37,15 @@ typedef struct
} dustData;
/**
* @brief Dust Sensor library
* @brief PPD42NS dust sensor library
* @defgroup ppd42ns libupm-ppd42ns
* @ingroup seeed gpio other
*/
/**
* @library ppd42ns
* @sensor ppd42ns
* @comname Dust Sensor
* @comname PPD42NS Dust Sensor
* @altname Grove Dust Sensor
* @type other
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Dust_Sensor

5
src/rfr359f/rfr359f.h
View File

@ -29,14 +29,15 @@
namespace upm {
/**
* @brief Grove Distance Interrupter library
* @brief RFR359 Distance Interrupter library
* @defgroup rfr359f libupm-rfr359f
* @ingroup seeed gpio light
*/
/**
* @library rfr359f
* @sensor rfr359f
* @comname Grove Distance Interrupter
* @comname RFR359F Distance Interrupter
* @altname Grove Distance Interrupter
* @type light
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_IR_Distance_Interrupt

5
src/rpr220/rpr220.h
View File

@ -29,14 +29,15 @@
namespace upm {
/**
* @brief RPR220 IR Reflective Sensor library
* @brief RPR220 IR reflective sensor library
* @defgroup rpr220 libupm-rpr220
* @ingroup seeed gpio light
*/
/**
* @library rpr220
* @sensor rpr220
* @comname rpr220 IR reflective sensor
* @comname RPR220 IR Reflective Sensor
* @altname Grove IR Reflective Sensor
* @type light
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Infrared_Reflective_Sensor

3
src/servo/es08a.h
View File

@ -31,7 +31,8 @@ namespace upm {
/**
* @library servo
* @sensor es08a
* @comname es0a servo
* @comname ES08A Servo
* @altname Grove Servo
* @type servos
* @man emax
* @web http://www.seeedstudio.com/wiki/Grove_-_Servo

2
src/servo/servo.h
View File

@ -38,7 +38,7 @@ namespace upm {
#define DEFAULT_WAIT_DISABLE_PWM 0
/**
* @brief C++ API for servo libraries
* @brief Servo library
*
* The base class Servo provides routines for setting the angle of the shaft
* as well as setting and getting the minimum and maximum pulse width and

2
src/si114x/si114x.h
View File

@ -37,7 +37,7 @@
namespace upm {
/**
* @brief SI1145 UV light sensor
* @brief SI1145 UV light sensor library
* @defgroup si114x libupm-si114x
* @ingroup adafruit i2c light
*/

2
src/sm130/sm130.h
View File

@ -48,7 +48,7 @@ namespace upm {
/**
* @library sm130
* @sensor sm130
* @comname SM130 RFID reader module sensor
* @comname SM130 RFID Reader
* @type rfid
* @man sparkfun
* @web https://www.sparkfun.com/products/10126

9
src/st7735/st7735.h
View File

@ -494,17 +494,14 @@ const unsigned char font[] = {
};
/**
* @brief API for the st7735 lcd display library
*
* This file defines the interface for ST7735 display library
*
* @brief ST7735 LCD display library
* @defgroup st7735 libupm-st7735
* @ingroup adafruit spi display
*/
/**
* @library st7735
* @sensor st7735
* @comname LCD display
* @comname ST7735 LCD display
* @type display
* @man adafruit
* @web http://www.adafruit.com/product/358
@ -520,7 +517,7 @@ const unsigned char font[] = {
class ST7735 : public GFX {
public:
/**
* Instanciates a ST7735 object
* Instantiates a ST7735 object
*
* @param csLCD LCD chip select pin
* @param cSD SD card chip select pin

26
src/stepmotor/stepmotor.h
View File

@ -41,25 +41,25 @@
namespace upm {
/**
* @brief API for the Stepper motor library
*
* This file defines the stepmotor interface
*
* @brief Stepper motor library
* @defgroup stepper libupm-stepper
* @ingroup seeed pwm gpio motor
* @ingroup seeed sparkfun pwm gpio motor
*/
/**
* @library stepper
* @sensor stepper
* @comname Stepper motor
* @comname Stepper Motor
* @altname EasyDriver Stepper Motor Driver
* @type motor
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_I2C_Motor_Driver_V1.3
* @man seeed sparkfun
* @web http://www.schmalzhaus.com/EasyDriver/index.html
* @con pwm gpio
*
* @brief API for the Stepper motor library
*
* This file defines the stepmotor interface
* This file defines the StepMotor interface. It is compatible with Stepper
* Motor Drivers that use 2 pins to control the motor, like the EasyDriver
* from Brian Schmalz.
*
* @image html stepmotor.jpg
* @snippet stepmotor.cxx Interesting
@ -67,10 +67,10 @@ namespace upm {
class StepMotor {
public:
/**
* Instanciates a StepMotor object
* Instantiates a StepMotor object
*
* @param dirPin direction GPIO pin
* @param stePin steper pulse PWM pin
* @param stePin stepper pulse PWM pin
*/
StepMotor (int dirPin, int stePin);
@ -89,14 +89,14 @@ class StepMotor {
/**
* Rotate motor forward
*
* @param ticks number of tickes the motor will move
* @param ticks number of ticks the motor will move
*/
mraa_result_t stepForward (int ticks);
/**
* Rotate motor backward
*
* @param ticks number of tickes the motor will move
* @param ticks number of ticks the motor will move
*/
mraa_result_t stepBackwards (int ticks);

5
src/sx6119/sx6119.h
View File

@ -29,7 +29,7 @@
namespace upm {
/**
* @brief UPM support for the SX6119 based FM Receiver
* @brief SX6119 based FM receiver library
* @defgroup sx6119 libupm-sx6119
* @ingroup seeed gpio sound
*/
@ -37,7 +37,8 @@ namespace upm {
/**
* @sensor sx6119
* @library sx6119
* @comname Grove FM Receiver v1.0
* @comname Grove FM Receiver
* @altname SX6119 FM Receiver
* @type sound
* @man seeed
* @con gpio

11
src/ta12200/ta12200.h
View File

@ -34,20 +34,15 @@
namespace upm {
/**
* @brief API for the TA12-200 current transformer
*
* UPM module for the TA12-200 current transformer, which is found,
* for instance, in the Grove Electricity Sensor.
* This module can measure AC current moving through a wire at up
* to 5A.
*
* @brief TA12-200 current transformer library
* @defgroup ta12200 libupm-ta12200
* @ingroup seeed analog electric
*/
/**
* @library ta12200
* @sensor ta12200
* @comname Current transformer
* @comname TA12-200 Current transformer
* @altname Grove Electricity Sensor
* @type electric
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Electricity_Sensor

8
src/tcs3414cs/tcs3414cs.h
View File

@ -105,17 +105,15 @@ typedef struct {
} tcs3414sc_rgb_t;
/**
* @brief API for TCS3414CS chip (Color sensor)
*
* his file defines the TCS3414CS interface for the color sensor
*
* @brief TCS3414CS color sensor library
* @defgroup tcs3414cs libupm-tcs3414cs
* @ingroup seeed i2c color
*/
/**
* @library tcs3414cs
* @sensor tcs3414cs
* @comname Color sensor
* @comname TCS3414CS Color Sensor
* @altname Grove Color Sensor
* @type color
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_I2C_Color_Sensor

10
src/th02/th02.h
View File

@ -45,17 +45,15 @@
namespace upm {
/**
* @brief API for th02 temperature & humidity sensor library
*
* This file defines the TH02 interface for libth02
*
* @brief TH02 temperature & humidity sensor library
* @defgroup th02 libupm-th02
* @ingroup seeed i2c temp
*/
/**
* @library th02
* @sensor th02
* @comname temperature and humidity sensor
* @comname TH02 Temperature & Humidity Sensor
* @altname Grove Temperature & Humidity Sensor (High Accuracy & Mini)
* @type temp
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Tempture%26Humidity_Sensor_(High-Accuracy_%26Mini)_v1.0
@ -65,7 +63,7 @@ namespace upm {
*
* This file defines the TH02 interface for libth02
*
* NOTE: For use on the Edison with the arduino breakout board, the
* NOTE: For use on the Edison with the Arduino breakout board, the
* Edison must be set to 3v rather than 5v.
*
* @image html th02.jpg

1
src/tm1637/tm1637.h
View File

@ -53,6 +53,7 @@ namespace upm
* @library tm1637
* @sensor tm1637
* @comname TM1637 7-Segment Display
* @altname Grove 4-Digit Display
* @type display
* @man seeed
* @con gpio

11
src/tsl2561/tsl2561.h
View File

@ -92,20 +92,15 @@ namespace upm {
#define LUX_M8C (0x0000) // 0.000 * 2^LUX_SCALE
/**
* @brief TSL2561 Digital Light Sensor library
*
* The LIGHT-TO-DIGITAL CONVERTER [TAOS-TSL2561]
* (http://www.adafruit.com/datasheets/TSL2561.pdf)
* The TSL2560 and TSL2561 are light-to-digital converters that transform
* light intensity to a digital signal output capable of direct I2C (TSL2561)
*
* @brief TSL2561 digital light sensor library
* @defgroup tsl2561 libupm-tsl2561
* @ingroup seeed i2c light
*/
/**
* @library tsl2561
* @sensor tsl2561
* @comname Light sensor
* @comname TSL2561 Light Sensor
* @altname Grove Digital Light Sensor
* @type light
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Digital_Light_Sensor

5
src/ttp223/ttp223.h
View File

@ -28,7 +28,7 @@
namespace upm {
/**
* @brief TTP223 Touch Detector sensor library
* @brief TTP223 touch detector sensor library
*
* This touch sensor detects when a finger is near the metallic pad
* by a change in capacitance. It can replace a more traditional push
@ -41,7 +41,8 @@ namespace upm {
/**
* @library ttp223
* @sensor ttp223
* @comname Touch sensor
* @comname TTP223 Touch Sensor
* @altname Grove Touch Sensor
* @type touch
* @man seeed
* @web http://www.seeedstudio.com/depot/Grove-Touch-Sensor-p-747.html

17
src/ublox6/ublox6.h
View File

@ -44,25 +44,24 @@ const int UBLOX6_DEFAULT_UART = 0;
namespace upm {
/**
* @brief API for the U-BLOX 6 GPS module
*
* UPM support for the U-BLOX 6 GPS Module
*
* @brief UBLOX6 & SIM28 GPS module library
* @defgroup ublox6 libupm-ublox6
* @ingroup seeed uart gps
*/
/**
* @library ublox6
* @sensor ublox6
* @comname GPS module
* @comname Grove GPS
* @altname U-BLOX6 SIM28
* @type gps
* @man seeed
* @web http://www.seeedstudio.com/depot/Grove-GPS-p-959.html
* @con uart
*
* @brief API for the U-BLOX 6 GPS module
*
* UPM support for the U-BLOX 6 GPS Module
* @brief API for the U-BLOX 6 and SIM28 GPS modules
*
* UPM support for the U-BLOX 6 GPS Module. It is also compatible with
* the SIM28 GPS Module.
*
* @image html ublox6.jpg
* @snippet ublox6.cxx Interesting
@ -113,7 +112,7 @@ namespace upm {
* setup the proper tty i/o modes and the baudrate. The default
* baud rate is 9600 (B9600).
*
* @param baud the desired baud rate.
* @param baud the desired baud rate.
* @return true if successful
*/
bool setupTty(speed_t baud=B9600);

4
src/uln200xa/uln200xa.h
View File

@ -32,7 +32,7 @@
namespace upm {
/**
* @brief UPM support for the ULN200XA series of Darlington Stepper drivers
* @brief ULN200XA stepper driver library
* @defgroup uln200xa libupm-uln200xa
* @ingroup seeed gpio motor
*/
@ -41,7 +41,7 @@ namespace upm {
* @library uln200xa
* @sensor uln200xa
* @comname ULN200XA Stepper Driver
* @altname uln2001a uln2002a uln2003a uln2004a
* @altname ULN2001A ULN2002A ULN2003A ULN2004A
* @type motor
* @man seeed
* @web http://www.seeedstudio.com/depot/Gear-Stepper-Motor-with-Driver-p-1685.html?cPath=39_40

11
src/waterlevel/waterlevel.h
View File

@ -27,19 +27,14 @@
namespace upm {
/**
* @brief API for the Water Level Sensor
*
* The Water Level Sensor senses the water level.
* When the level rises, a ball with a magnet floats up and causes a switch to open.
* When the level falls, the magnet also falls and the switch closes.
*
* @brief Water Level sensor library
* @defgroup waterlevel libupm-waterlevel
* @ingroup gpio waterlevel
* @ingroup seeed gpio liquid
*/
/**
* @library waterlevel
* @sensor waterlevel
* @comname waterlevel
* @comname Grove Water Level Sensor
* @type liquid
* @man seeed
* @con gpio

21
src/wt5001/wt5001.h
View File

@ -49,25 +49,22 @@ const uint8_t WT5001_END = 0x7e;
namespace upm {
/**
* @brief API for the WT5001 Serial MP3 module
*
* UPM support for the WT5001 Serial MP3 Module. This was tested
* specifically with the Grove Serial MP3 module.
*
* @brief WT5001 Serial MP3 module library
* @defgroup wt5001 libupm-wt5001
* @ingroup seeed uart sound
*/
/**
* @library wt5001
* @sensor wt5001
* @comname Serial MP3 Module
* @comname WT5001 Serial MP3 Module
* @altname Grove Serial MP3 Player
* @type sound
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_%E2%80%93_Serial_MP3_Player
* @con uart
*
* @brief API for the WT5001 Serial MP3 module
*
*
* UPM support for the WT5001 Serial MP3 Module. This was tested
* specifically with the Grove Serial MP3 module.
*
@ -108,20 +105,20 @@ namespace upm {
READ_DATE = 0xd1,
READ_TIME = 0xd2
} WT5001_OPCODE_T;
// play modes
typedef enum { NORMAL = 0x00,
SINGLE_REPEAT = 0x01,
ALL_REPEAT = 0x02,
RANDOM = 0x03
} WT5001_PLAYMODE_T;
// music source
typedef enum { SD,
SPI,
UDISK
} WT5001_PLAYSOURCE_T;
/**
* WT5001 Serial MP3 module constructor
*
@ -167,7 +164,7 @@ namespace upm {
* setup the proper tty i/o modes and the baudrate. The default
* baud rate is 9600 (B9600).
*
* @param baud the desired baud rate.
* @param baud the desired baud rate.
* @return true if successful
*/
bool setupTty(speed_t baud=B9600);
@ -179,7 +176,7 @@ namespace upm {
* @return true if successful
*/
bool checkResponse(WT5001_OPCODE_T opcode);
/**
* play a file, from a source
*

11
src/yg1006/yg1006.h
View File

@ -28,25 +28,22 @@
namespace upm {
/**
* @brief Library for the YG1006 flame sensor
*
* UPM module for the YG1006 flame sensor. It detects flame or any
* other light in the 760nm - 1100nm wavelength range.
*
* @brief YG1006 flame sensor library
* @defgroup yg1006 libupm-yg1006
* @ingroup seeed gpio light
*/
/**
* @library yg1006
* @sensor yg1006
* @comname flame sensor
* @comname YG1006 Flame Sensor
* @altname Grove Flame Sensor
* @type light
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Flame_Sensor
* @con gpio
*
* @brief API for the YG1006 flame sensor
*
*
* UPM module for the YG1006 flame sensor. It detects flame or any
* other light in the 760nm - 1100nm wavelength range.
*

4
src/zfm20/zfm20.h
View File

@ -59,7 +59,7 @@
namespace upm {
/**
* @brief UPM library for the ZFM-20 fingerprint sensor module
* @brief ZFM-20 fingerprint sensor module library
* @defgroup zfm20 libupm-zfm20
* @ingroup seeed uart touch
*/
@ -67,7 +67,7 @@ namespace upm {
/**
* @library zfm20
* @sensor zfm20
* @comname ZFM-20 Fingerprint Sensor Module
* @comname ZFM-20 Fingerprint Sensor
* @altname Grove Fingerprint Sensor
* @type touch
* @man seeed