mirror of
https://github.com/eclipse/upm.git
synced 2025-03-14 20:47:30 +03:00
doxygen: updated library brief description tags
Touched on all library brief descriptions for better integration with ISS and fixed a few typos and connection tags in the process. Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
parent
a12baf379f
commit
4a1eb99d6d
@ -28,7 +28,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief A110X Hall Effect library
|
||||
* @brief A110X Hall Effect Sensors
|
||||
* @defgroup a110x libupm-a110x
|
||||
* @ingroup seeed gpio electric robok
|
||||
*/
|
||||
|
@ -28,6 +28,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief Honeywell ABP Pressure Sensors
|
||||
* @defgroup abp libupm-abp
|
||||
* @ingroup honeywell i2c
|
||||
*/
|
||||
|
@ -35,9 +35,9 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief AD8232 Heart Rate Monitor library
|
||||
* @brief AD8232 Heart Rate Monitor
|
||||
* @defgroup ad8232 libupm-ad8232
|
||||
* @ingroup sparkfun gpio medical
|
||||
* @ingroup sparkfun gpio analog medical
|
||||
*/
|
||||
|
||||
/**
|
||||
@ -47,7 +47,7 @@ namespace upm {
|
||||
* @type medical
|
||||
* @man sparkfun
|
||||
* @web https://www.sparkfun.com/products/12650
|
||||
* @con gpio aio
|
||||
* @con gpio analog
|
||||
*
|
||||
* @brief UPM module for the AD8232 Heart Rate Monitor
|
||||
*
|
||||
|
@ -38,7 +38,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief Adafruit Motor Shield 1438 library
|
||||
* @brief Adafruit Motor Shield
|
||||
* @defgroup adafruitms1438 libupm-adafruitms1438
|
||||
* @ingroup adafruit i2c motor
|
||||
*/
|
||||
|
@ -55,7 +55,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief Adafruit PCA9685-based Servo Shield library
|
||||
* @brief Adafruit PCA9685-based Servo Shield
|
||||
* @defgroup adafruitss libupm-adafruitss
|
||||
* @ingroup adafruit i2c servos
|
||||
*/
|
||||
|
@ -49,7 +49,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief ADC121C021 I2C Analog-to-Digital Converter library
|
||||
* @brief ADC121C021 Analog-to-Digital Converter
|
||||
* @defgroup adc121c021 libupm-adc121c021
|
||||
* @ingroup seeed i2c electric
|
||||
*/
|
||||
|
@ -84,7 +84,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief ADIS16448 Accelerometer library
|
||||
* @brief ADIS16448 Accelerometer
|
||||
* @defgroup adis16448 libupm-adis16448
|
||||
* @ingroup generic spi accelerometer
|
||||
*/
|
||||
|
@ -102,7 +102,7 @@ namespace mraa {class I2c;}
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief ADS1X15 family adc library
|
||||
* @brief ADS1X15 Family ADC Library
|
||||
*
|
||||
* Library for TI analog to digital converter ic. Base clase fro ADS1X15 provides all the functionality that
|
||||
* ADS1115 and ADS1015 ics have in common.
|
||||
|
@ -36,7 +36,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief ADXL335 Accelerometer library
|
||||
* @brief ADXL335 Accelerometer
|
||||
* @defgroup adxl335 libupm-adxl335
|
||||
* @ingroup seeed analog accelerometer
|
||||
*/
|
||||
|
@ -30,7 +30,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief ADXL345 Accelerometer library
|
||||
* @brief ADXL345 Accelerometer
|
||||
* @defgroup adxl345 libupm-adxl345
|
||||
* @ingroup seeed i2c accelerometer
|
||||
*/
|
||||
|
@ -38,7 +38,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief DFRobot ADXRS610 Gyro Breakout Board
|
||||
* @brief ADXRS610 Gyroscope
|
||||
* @defgroup adxrs610 libupm-adxrs610
|
||||
* @ingroup dfrobot analog compass
|
||||
*/
|
||||
@ -53,7 +53,7 @@ namespace upm {
|
||||
* @web http://www.dfrobot.com/index.php?route=product/product&product_id=642
|
||||
* @con analog
|
||||
*
|
||||
* @brief DFRobot ADXRS610 Gyro Beakout board
|
||||
* @brief DFRobot ADXRS610 Gyro Breakout board
|
||||
*
|
||||
* The ADXRS610 is a MEMS based single axis gyroscope with a range
|
||||
* of +/- 300 degrees/sec. It also incorporates a temperature
|
||||
@ -63,7 +63,7 @@ namespace upm {
|
||||
* rotation about the Z-axis in degrees/sec. The temperature
|
||||
* component returns a proportional analog values in degrees C.
|
||||
*
|
||||
* This driver was developed using the DFRobot ADXRS610 Gyro Beakout board.
|
||||
* This driver was developed using the DFRobot ADXRS610 Gyro Breakout board.
|
||||
*
|
||||
* @image html adxrs610.jpg
|
||||
* @snippet adxrs610.cxx Interesting
|
||||
|
@ -50,7 +50,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief AM2315 Temperature & Humidity Sensor library
|
||||
* @brief AM2315 Temperature & Humidity Sensor
|
||||
* @defgroup am2315 libupm-am2315
|
||||
* @ingroup adafruit i2c temp
|
||||
*/
|
||||
|
@ -33,7 +33,7 @@
|
||||
namespace upm
|
||||
{
|
||||
/**
|
||||
* @brief APA102 RGB LED Strip driver library
|
||||
* @brief APA102 RGB LED Strip
|
||||
* @defgroup apa102 libupm-apa102
|
||||
* @ingroup spi led
|
||||
*/
|
||||
|
@ -28,7 +28,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief APDS-9002 Luminance Sensor library
|
||||
* @brief APDS-9002 Luminance Sensor
|
||||
* @defgroup apds9002 libupm-apds9002
|
||||
* @ingroup seeed analog light
|
||||
*/
|
||||
|
@ -29,7 +29,7 @@
|
||||
namespace upm
|
||||
{
|
||||
/**
|
||||
* @brief APDS9930 Digital Proximity and Ambient Light Sensor library
|
||||
* @brief APDS9930 Digital Proximity and Ambient Light Sensor
|
||||
* @defgroup apds9930 libupm-apds9930
|
||||
* @ingroup Avago Technologies iio i2c proximity and ambient light sensor
|
||||
*/
|
||||
|
@ -35,7 +35,7 @@
|
||||
namespace upm
|
||||
{
|
||||
/**
|
||||
* @brief Atmel* AT42QT1070 QTouch* Sensor library
|
||||
* @brief Atmel AT42QT1070 QTouch Sensor
|
||||
* @defgroup at42qt1070 libupm-at42qt1070
|
||||
* @ingroup seeed i2c touch
|
||||
*/
|
||||
|
@ -51,7 +51,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief BACNETMSTP base class
|
||||
* @brief BACNETMSTP Library
|
||||
* @defgroup bacnetmstp libupm-bacnetmstp
|
||||
* @ingroup uart
|
||||
*/
|
||||
|
@ -34,7 +34,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief DFRobot Light Sensor (BH1750)
|
||||
* @brief BH1750 Light Sensor
|
||||
* @defgroup bh1750 libupm-bh1750
|
||||
* @ingroup dfrobot i2c
|
||||
*/
|
||||
|
@ -28,7 +28,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief BISS0001 Motion Sensor library
|
||||
* @brief BISS0001 Motion Sensor
|
||||
* @defgroup biss0001 libupm-biss0001
|
||||
* @ingroup seeed gpio light tsk
|
||||
*/
|
||||
|
@ -35,7 +35,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief BMA220 Accelerometer library
|
||||
* @brief BMA220 Accelerometer
|
||||
* @defgroup bma220 libupm-bma220
|
||||
* @ingroup i2c gpio accelerometer bosch dfrobot
|
||||
*/
|
||||
|
@ -34,7 +34,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief Bosch 3-axis Accelerometer
|
||||
* @brief BMA250E 3-axis Accelerometer
|
||||
* @defgroup bma250e libupm-bma250e
|
||||
* @ingroup i2c spi gpio bosch accelerometer
|
||||
*/
|
||||
|
@ -34,7 +34,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief Bosch 3-axis Gyroscope
|
||||
* @brief BMG160 3-axis Gyroscope
|
||||
* @defgroup bmg160 libupm-bmg160
|
||||
* @ingroup i2c spi gpio bosch gyro
|
||||
*/
|
||||
|
@ -31,7 +31,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief BMI160 3-axis Accelerometer, Gyroscope and Magnetometer
|
||||
* @brief BMI160 Inertial Measurement Unit
|
||||
* @defgroup bmi160 libupm-bmi160
|
||||
* @ingroup i2c accelerometer compass bosch mouser
|
||||
*/
|
||||
|
@ -34,13 +34,13 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief Bosch 3-axis Magnetometer
|
||||
* @brief BMM150 3-axis Magnetometer
|
||||
* @defgroup bmm150 libupm-bmm150
|
||||
* @ingroup i2c spi gpio bosch compass
|
||||
*/
|
||||
|
||||
/**
|
||||
* @library bmx050
|
||||
* @library bmm150
|
||||
* @sensor bmm150
|
||||
* @comname 3-axis Geomagnetic Sensor
|
||||
* @altname bmm050
|
||||
|
@ -34,7 +34,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief BMP280 Digital Pressure Sensor
|
||||
* @brief BMP280/BME280 Digital Pressure Sensors
|
||||
* @defgroup bmp280 libupm-bmp280
|
||||
* @ingroup i2c spi gpio pressure bosch adafruit
|
||||
*/
|
||||
|
@ -38,7 +38,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief Bosch BMP & GY65 Atmospheric Pressure Sensor library
|
||||
* @brief BMP & GY65 Atmospheric Pressure Sensors
|
||||
* @defgroup bmpx8x libupm-bmpx8x
|
||||
* @ingroup bosch seeed adafruit sparkfun i2c
|
||||
* pressure
|
||||
|
@ -59,7 +59,7 @@ namespace upm {
|
||||
|
||||
* The BMC150 is essentially 2 separate devices in one: the BMA250E
|
||||
* Accelerometer and the BMM150 Magnetometer. They are completely
|
||||
* independant of each other.
|
||||
* independent of each other.
|
||||
*
|
||||
* This driver provides a very simple interface to these 2 devices.
|
||||
* If finer control is desired, you should just use the separate
|
||||
|
@ -53,7 +53,7 @@ namespace upm {
|
||||
*
|
||||
* The BMI055 is essentially 2 separate devices in one: the BMA250E
|
||||
* Accelerometer and the BMG160 Gyroscope. They are completely
|
||||
* independant of each other.
|
||||
* independent of each other.
|
||||
*
|
||||
* This driver provides a very simple interface to these two devices.
|
||||
* If finer control is desired, you should just use the separate
|
||||
|
@ -37,7 +37,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief BMX055 9-axis Sensor Module
|
||||
* @brief BMX055/BMI055/BMC150 Sensor Modules
|
||||
* @defgroup bmx055 libupm-bmx055
|
||||
* @ingroup i2c spi accelerometer compass
|
||||
*/
|
||||
@ -65,11 +65,11 @@ namespace upm {
|
||||
*
|
||||
* The BMX055 is essentially 3 separate devices in one: the BMA250E
|
||||
* Accelerometer, the BMG160 Gyroscope, and the BMM150 Magnetometer.
|
||||
* They are completely independant of each other.
|
||||
* They are completely independent of each other.
|
||||
*
|
||||
* This driver provides a very simple interface to these 3 devices.
|
||||
* If finer control is desired, you should just use the separate
|
||||
* BMA25E, BMG160, and BMM150 device classes directly. This driver
|
||||
* BMA250E, BMG160, and BMM150 device classes directly. This driver
|
||||
* simply initializes all three devices, and provides a mechanism to
|
||||
* read accelerometer, gyroscope and magnetometer data from them.
|
||||
*
|
||||
|
@ -31,7 +31,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief BNO055 Absolute Orientation 9DOF Fusion Hub
|
||||
* @brief BNO055 9DOF Fusion Hub
|
||||
* @defgroup bno055 libupm-bno055
|
||||
* @ingroup i2c gpio accelerometer compass bosch adafruit
|
||||
*/
|
||||
|
@ -32,7 +32,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief Button library
|
||||
* @brief Button/Switch Library
|
||||
* @defgroup buttonlib libupm-button
|
||||
* @ingroup seeed gpio button gsk
|
||||
*/
|
||||
|
@ -33,7 +33,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief Buzzer library
|
||||
* @brief Piezoelectric Buzzers Library
|
||||
* @defgroup buzzer libupm-buzzer
|
||||
* @ingroup seeed pwm sound gsk
|
||||
*/
|
||||
|
@ -27,7 +27,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief CJQ4435 MOSFET library
|
||||
* @brief CJQ4435 MOSFET
|
||||
* @defgroup cjq4435 libupm-cjq4435
|
||||
* @ingroup seeed gpio pwm electric robok
|
||||
*/
|
||||
|
@ -27,7 +27,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief Collision Sensor library
|
||||
* @brief Collision Sensor
|
||||
* @defgroup collision libupm-collision
|
||||
* @ingroup seeed gpio accelerometer
|
||||
*/
|
||||
|
@ -46,9 +46,9 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief CurieIMU sensor for Arduino/Genuino 101 running Firmata
|
||||
* @brief CurieIMU Library for Arduino/Genuino 101 Running Firmata
|
||||
* @defgroup curieimu libupm-curieimu
|
||||
* @ingroup firmata accelerometer compass bosch
|
||||
* @ingroup uart serial accelerometer compass bosch
|
||||
*/
|
||||
|
||||
struct IMUDataItem {
|
||||
@ -61,9 +61,9 @@ struct IMUDataItem {
|
||||
* @sensor curieimu
|
||||
* @comname Curie IMU Sensor using Firmata
|
||||
* @altname Curie IMU Sensor for Arduino/Genuino 101 running Firmata
|
||||
* @type accelerometer compass
|
||||
* @type serial accelerometer compass
|
||||
* @man bosch
|
||||
* @con firmata
|
||||
* @con uart
|
||||
*
|
||||
* @brief API for the Curie IMU via Firmata
|
||||
*
|
||||
|
@ -33,9 +33,9 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief Veris CWLSXXA CO2 Sensor
|
||||
* @brief Veris CWLSXXA CO2 Sensors
|
||||
* @defgroup cwlsxxa libupm-cwlsxxa
|
||||
* @ingroup veris ainput temp gaseous
|
||||
* @ingroup veris analog temp gaseous
|
||||
*/
|
||||
|
||||
/**
|
||||
@ -44,7 +44,7 @@ namespace upm {
|
||||
* @comname CO2/temperature/humidity Transmitter
|
||||
* @type temp gaseous
|
||||
* @man veris
|
||||
* @con ainput
|
||||
* @con analog
|
||||
* @web http://www.veris.com/Item/CWLSHTA.aspx
|
||||
*
|
||||
* @brief API for the Veris CWLSXXA CO2 Sensor Family
|
||||
|
@ -36,7 +36,7 @@ namespace upm {
|
||||
/**
|
||||
* @brief DFRobot EC Meter
|
||||
* @defgroup dfrec libupm-dfrec
|
||||
* @ingroup dfrobot ainput uart liquid
|
||||
* @ingroup dfrobot analog uart liquid
|
||||
*/
|
||||
|
||||
/**
|
||||
@ -45,7 +45,7 @@ namespace upm {
|
||||
* @comname Analog Electrical Conductivity (EC) Sensor
|
||||
* @type liquid
|
||||
* @man dfrobot
|
||||
* @con ainput uart
|
||||
* @con analog uart
|
||||
* @web https://www.dfrobot.com/index.php?route=product/product&product_id=1123&search=DFR0300&description=true#.Vx49p-_n-M8
|
||||
*
|
||||
* @brief DFRobot EC Meter
|
||||
|
@ -34,10 +34,9 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief UPM C++ API for the DFRobot ORP (Oxidation/Reduction
|
||||
* Potential) Sensor
|
||||
* @brief DFRobot ORP (Oxidation/Reduction Potential) Sensor
|
||||
* @defgroup dfrorp libupm-dfrorp
|
||||
* @ingroup dfrobot ainput liquid
|
||||
* @ingroup dfrobot analog liquid
|
||||
*/
|
||||
|
||||
/**
|
||||
|
@ -30,7 +30,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief DFRobot pH sensors
|
||||
* @brief DFRobot pH Sensors
|
||||
* @defgroup dfrph libupm-dfrph
|
||||
* @ingroup dfrobot liquid analog
|
||||
*/
|
||||
|
@ -43,7 +43,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief DS1307 Real-Time Clock library
|
||||
* @brief DS1307 Real-Time Clock
|
||||
* @defgroup ds1307 libupm-ds1307
|
||||
* @ingroup seeed i2c time
|
||||
*/
|
||||
|
@ -28,7 +28,7 @@
|
||||
namespace upm
|
||||
{
|
||||
/**
|
||||
* @brief DS1808LC lighting controller library
|
||||
* @brief DS1808LC Lighting Controller
|
||||
* @defgroup DS1808LC libupm-ds1808lc
|
||||
* @ingroup ds1808lc i2c maxim light ilightcontroller
|
||||
*/
|
||||
|
@ -38,7 +38,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief DS2413 modules
|
||||
* @brief DS2413 Modules Library
|
||||
* @defgroup ds2413 libupm-ds2413
|
||||
* @ingroup maxim uart gpio
|
||||
*/
|
||||
|
@ -33,7 +33,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief API for the EC-EZO EC Sensor
|
||||
* @brief EC-EZO Sensor
|
||||
* @defgroup ecezo libupm-ecezo
|
||||
* @ingroup uart i2c liquid
|
||||
*/
|
||||
|
@ -42,7 +42,7 @@ namespace upm {
|
||||
#define FALSE LOW
|
||||
|
||||
/**
|
||||
* @brief ECS1030 Electricity Sensor library
|
||||
* @brief ECS1030 Electricity Sensor
|
||||
* @defgroup ecs1030 libupm-ecs1030
|
||||
* @ingroup sparkfun analog electric
|
||||
*/
|
||||
|
@ -30,7 +30,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief Ear-clip Heart Rate Sensor library
|
||||
* @brief Ear-clip Heart Rate Sensor
|
||||
* @defgroup ehr libupm-ehr
|
||||
* @ingroup seeed gpio medical
|
||||
*/
|
||||
|
@ -30,7 +30,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief EL Driver Module library
|
||||
* @brief EL Driver Module
|
||||
* @defgroup eldriver libupm-eldriver
|
||||
* @ingroup seeed gpio electric
|
||||
*/
|
||||
|
@ -30,7 +30,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief Electromagnet library
|
||||
* @brief Electromagnet Library
|
||||
* @defgroup electromagnet libupm-electromagnet
|
||||
* @ingroup seeed gpio electric
|
||||
*/
|
||||
|
@ -28,7 +28,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief Grove EMG Muscle Signal Reader library
|
||||
* @brief EMG Muscle Signal Reader
|
||||
* @defgroup emg libupm-emg
|
||||
* @ingroup seeed analog electric
|
||||
*/
|
||||
|
@ -28,7 +28,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief ENC03R Single Axis Gyro library
|
||||
* @brief ENC03R Single Axis Gyro
|
||||
* @defgroup enc03r libupm-enc03r
|
||||
* @ingroup seeed analog compass robok
|
||||
*/
|
||||
|
@ -29,7 +29,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief Spectra Symbol Flex Sensor library
|
||||
* @brief Spectra Symbol Flex Sensor
|
||||
* @defgroup flex libupm-flex
|
||||
* @ingroup sparkfun analog flexfor
|
||||
*/
|
||||
|
@ -34,7 +34,7 @@ struct thresholdContext {
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief Gas Sensor library
|
||||
* @brief Gas Sensors Library
|
||||
*
|
||||
* Library for air quality and gas detecting sensors. Base class Gas provides buffered
|
||||
* sampling, threshold checking, basic printing function, and standard read function.
|
||||
|
@ -29,7 +29,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief GP2Y0A-based IR Proximity Sensor library
|
||||
* @brief GP2Y0A-based IR Proximity Sensors
|
||||
* @defgroup gp2y0a libupm-gp2y0a
|
||||
* @ingroup seeed analog light
|
||||
*/
|
||||
|
@ -40,7 +40,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief GPRS Module library
|
||||
* @brief GPRS Modules Library
|
||||
* @defgroup gprs libupm-gprs
|
||||
* @ingroup seeed uart wifi
|
||||
*/
|
||||
|
@ -159,6 +159,11 @@ and is not meant to be installed anywhere.
|
||||
@brief Wireless sensors using RFID tags
|
||||
|
||||
|
||||
@defgroup serial Serial
|
||||
@ingroup bycat
|
||||
@brief Sensors using serial communication
|
||||
|
||||
|
||||
@defgroup servos Servo
|
||||
@ingroup bycat
|
||||
@brief Various servo motors & controllers
|
||||
@ -174,11 +179,6 @@ and is not meant to be installed anywhere.
|
||||
@brief Measure temperature & humidity
|
||||
|
||||
|
||||
@defgroup serial Serial
|
||||
@ingroup bycat
|
||||
@brief Sensors using serial communication
|
||||
|
||||
|
||||
@defgroup time Time
|
||||
@ingroup bycat
|
||||
@brief Real time clocks & time measurement
|
||||
|
@ -32,7 +32,7 @@ namespace upm {
|
||||
/**
|
||||
* @deprecated This library is now deprecated and replaced by individual
|
||||
* libraries for every sensor.
|
||||
* @brief Generic library for basic Grove sensors
|
||||
* @brief Generic Library for Basic Grove Sensors
|
||||
* @defgroup grove libupm-grove
|
||||
* @ingroup seeed gpio pwm ainput button led light relay temp touch gsk eak hak
|
||||
*/
|
||||
|
@ -28,7 +28,7 @@
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-collision
|
||||
* @brief Grove Collision Sensor library
|
||||
* @brief Grove Collision Sensor
|
||||
* @defgroup grovecollision libupm-grovecollision
|
||||
* @ingroup seeed gpio accelerometer
|
||||
*/
|
||||
|
@ -31,7 +31,7 @@
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-ehr
|
||||
* @brief Grove Ear-clip Heart Rate Sensor library
|
||||
* @brief Grove Ear-clip Heart Rate Sensor
|
||||
* @defgroup groveehr libupm-groveehr
|
||||
* @ingroup seeed gpio medical
|
||||
*/
|
||||
|
@ -31,7 +31,7 @@
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-eldriver
|
||||
* @brief Grove EL Driver Module library
|
||||
* @brief Grove EL Driver Module
|
||||
* @defgroup groveeldriver libupm-groveeldriver
|
||||
* @ingroup seeed gpio electric
|
||||
*/
|
||||
|
@ -31,7 +31,7 @@
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-electromagnet
|
||||
* @brief Grove Electromagnet library
|
||||
* @brief Grove Electromagnet Library
|
||||
* @defgroup groveelectromagnet libupm-groveelectromagnet
|
||||
* @ingroup seeed gpio electric
|
||||
*/
|
||||
|
@ -29,7 +29,7 @@
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-emg
|
||||
* @brief Grove EMG Muscle Signal Reader library
|
||||
* @brief Grove EMG Muscle Signal Reader
|
||||
* @defgroup groveemg libupm-groveemg
|
||||
* @ingroup seeed analog electric
|
||||
*/
|
||||
|
@ -41,7 +41,7 @@
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-gprs
|
||||
* @brief Grove GPRS Module library
|
||||
* @brief Grove GPRS Module
|
||||
* @defgroup grovegprs libupm-grovegprs
|
||||
* @ingroup seeed uart wifi
|
||||
*/
|
||||
|
@ -29,7 +29,7 @@
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-gsr
|
||||
* @brief Grove GSR Galvanic Skin Response Sensor library
|
||||
* @brief Grove GSR Galvanic Skin Response Sensor
|
||||
* @defgroup grovegsr libupm-grovegsr
|
||||
* @ingroup seeed analog electric
|
||||
*/
|
||||
|
@ -29,7 +29,7 @@
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-linefinder
|
||||
* @brief Grove Line Finder Sensor library
|
||||
* @brief Grove Line Finder Sensor
|
||||
* @defgroup grovelinefinder libupm-grovelinefinder
|
||||
* @ingroup seeed gpio color robok
|
||||
*/
|
||||
|
@ -35,7 +35,7 @@
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-md
|
||||
* @brief Grove I2C Motor Driver library
|
||||
* @brief Grove I2C Motor Driver
|
||||
* @defgroup grovemd libupm-grovemd
|
||||
* @ingroup seeed i2c motor robok
|
||||
*/
|
||||
|
@ -29,7 +29,7 @@
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-moisture
|
||||
* @brief Grove Moisture Sensor library
|
||||
* @brief Grove Moisture Sensor
|
||||
* @defgroup grovemoisture libupm-grovemoisture
|
||||
* @ingroup seeed analog liquid eak hak
|
||||
*/
|
||||
|
@ -29,7 +29,7 @@
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-o2
|
||||
* @brief Grove O2 Oxygen Gas Sensor library
|
||||
* @brief Grove O2 Oxygen Gas Sensor
|
||||
* @defgroup groveo2 libupm-groveo2
|
||||
* @ingroup seeed analog gaseous
|
||||
*/
|
||||
|
@ -49,7 +49,7 @@
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-scam
|
||||
* @brief Grove Serial Camera library
|
||||
* @brief Grove Serial Camera
|
||||
* @defgroup grovescam libupm-grovescam
|
||||
* @ingroup seeed uart other
|
||||
*/
|
||||
|
@ -34,7 +34,7 @@
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-speaker
|
||||
* @brief Grove Speaker library
|
||||
* @brief Grove Speaker
|
||||
* @defgroup grovespeaker libupm-grovespeaker
|
||||
* @ingroup seeed gpio sound hak
|
||||
*/
|
||||
|
@ -37,7 +37,7 @@ namespace upm {
|
||||
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-ultrasonic
|
||||
* @brief Grove ultrasonic sensor library
|
||||
* @brief Grove Ultrasonic Sensor
|
||||
* @defgroup groveultrasonic libupm-groveultrasonic
|
||||
* @ingroup seeed gpio sound
|
||||
*/
|
||||
|
@ -37,7 +37,7 @@
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-vdiv
|
||||
* @brief Grove Voltage Divider Sensor library
|
||||
* @brief Grove Voltage Divider Sensor
|
||||
* @defgroup grovevdiv libupm-grovevdiv
|
||||
* @ingroup seeed analog electric robok
|
||||
*/
|
||||
|
@ -29,7 +29,7 @@
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-water
|
||||
* @brief Grove Water Sensor library
|
||||
* @brief Grove Water Sensor
|
||||
* @defgroup grovewater libupm-grovewater
|
||||
* @ingroup seeed gpio liquid eak
|
||||
*/
|
||||
|
@ -32,7 +32,7 @@ namespace upm {
|
||||
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-wfs
|
||||
* @brief Grove Water Flow Sensor library
|
||||
* @brief Grove Water Flow Sensor
|
||||
* @defgroup grovewfs libupm-grovewfs
|
||||
* @ingroup seeed gpio liquid eak
|
||||
*/
|
||||
|
@ -28,7 +28,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief Grove GSR Galvanic Skin Response Sensor library
|
||||
* @brief Grove GSR Galvanic Skin Response Sensor
|
||||
* @defgroup gsr libupm-gsr
|
||||
* @ingroup seeed analog electric
|
||||
*/
|
||||
|
@ -27,7 +27,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief GUVA-S12D UV sensor library
|
||||
* @brief GUVA-S12D UV Sensors
|
||||
* @defgroup guvas12d libupm-guvas12d
|
||||
* @ingroup seeed analog light eak
|
||||
*/
|
||||
|
@ -34,7 +34,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief H3LIS331DL I2C Accelerometer (400g) library
|
||||
* @brief H3LIS331DL 400g Accelerometer
|
||||
* @defgroup h3lis331dl libupm-h3lis331dl
|
||||
* @ingroup seeed stmicro i2c accelerometer
|
||||
*/
|
||||
|
@ -28,7 +28,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief HC-SR04 Ultrasonic Sensor library
|
||||
* @brief HC-SR04 Ultrasonic Sensor
|
||||
* @defgroup hcsr04 libupm-hcsr04
|
||||
* @ingroup generic gpio sound
|
||||
*/
|
||||
|
@ -33,9 +33,9 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief Veris HDXXVXTA Humidity Transmitter
|
||||
* @brief Veris HDXXVXTA Humidity Transmitters
|
||||
* @defgroup hdxxvxta libupm-hdxxvxta
|
||||
* @ingroup veris ainput temp
|
||||
* @ingroup veris analog temp
|
||||
*/
|
||||
|
||||
/**
|
||||
@ -44,7 +44,7 @@ namespace upm {
|
||||
* @comname Veris HDXXVXTA Temperature/humidity Transmitter
|
||||
* @type temp
|
||||
* @man veris
|
||||
* @con ainput
|
||||
* @con analog
|
||||
* @web http://www.veris.com/Item/HD2NVSTA1.aspx
|
||||
*
|
||||
* @brief API for the Veris HDXXVXTA Humidity Transmitter
|
||||
|
@ -33,7 +33,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief UPM C++ API for the DFRobot Laser PM2.5 Sensor
|
||||
* @brief HKA5 Laser PM2.5 Sensor
|
||||
* @defgroup hka5 libupm-hka5
|
||||
* @ingroup uart gpio gaseous
|
||||
*/
|
||||
|
@ -30,7 +30,7 @@ namespace upm
|
||||
{
|
||||
|
||||
/**
|
||||
* @brief Meanwell HLG150H Lighting power supply controller library
|
||||
* @brief Meanwell HLG150H Lighting Power Supply Controller
|
||||
* @defgroup hlg150h libupm-hlg150h
|
||||
* @ingroup pwm light ilightcontroller
|
||||
*/
|
||||
|
@ -47,7 +47,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief HM-11 Bluetooth 4.0 Low Energy Module library
|
||||
* @brief HM-11 Bluetooth 4.0 Low Energy Module
|
||||
* @defgroup hm11 libupm-hm11
|
||||
* @ingroup seeed uart wifi
|
||||
*/
|
||||
|
@ -33,7 +33,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief HMC5883L Magnetometer library
|
||||
* @brief HMC5883L Magnetometer
|
||||
* @defgroup hmc5883l libupm-hmc5883l
|
||||
* @ingroup seeed i2c compass robok
|
||||
*/
|
||||
|
@ -44,7 +44,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief HMTRP Serial RF Pro library
|
||||
* @brief HMTRP Serial RF Pro
|
||||
* @defgroup hmtrp libupm-hmtrp
|
||||
* @ingroup seeed uart wifi
|
||||
*/
|
||||
|
@ -33,7 +33,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief HP20X I2C Barometer (High-Accuracy) library
|
||||
* @brief HP20X I2C Barometer (High-Accuracy)
|
||||
* @defgroup hp20x libupm-hp20x
|
||||
* @ingroup seeed i2c pressure
|
||||
*/
|
||||
|
@ -29,7 +29,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief HT9170 DTMF Decoder library
|
||||
* @brief HT9170 DTMF Decoder
|
||||
* @defgroup ht9170 libupm-ht9170
|
||||
* @ingroup seeed gpio other
|
||||
*/
|
||||
|
@ -49,7 +49,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief HTU21D Humidity Sensor library
|
||||
* @brief HTU21D Humidity Sensor
|
||||
* @defgroup htu21d libupm-htu21d
|
||||
* @ingroup seeed adafruit sparkfun i2c temp
|
||||
*/
|
||||
|
@ -29,7 +29,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief HX711 24-bit ADC library
|
||||
* @brief HX711 24-bit ADC
|
||||
* @defgroup hx711 libupm-hx711
|
||||
* @ingroup generic gpio electric
|
||||
*/
|
||||
|
@ -129,7 +129,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief ILI9341 LCD library
|
||||
* @brief ILI9341 LCD Display
|
||||
* @defgroup ili9341 libupm-ili9341
|
||||
* @ingroup adafruit spi display
|
||||
*/
|
||||
@ -142,7 +142,7 @@ namespace upm {
|
||||
* @web http://www.adafruit.com/product/2090
|
||||
* @con spi
|
||||
*
|
||||
* @brief API for the ILI9342 LCd
|
||||
* @brief API for the ILI9342 LCD
|
||||
*
|
||||
* This module defines the interface for the ILI9341 display library
|
||||
*
|
||||
|
@ -28,7 +28,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief Catnip Electronics I2C moisture sensor
|
||||
* @brief Catnip Electronics I2C Moisture Sensor
|
||||
* @defgroup ims libupm-ims
|
||||
* @ingroup catnip i2c liquid light temp
|
||||
*/
|
||||
|
@ -28,7 +28,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief INA132 Differential Amplifier Sensor library
|
||||
* @brief INA132 Differential Amplifier Sensor
|
||||
* @defgroup ina132 libupm-ina132
|
||||
* @ingroup seeed analog electric
|
||||
*/
|
||||
|
@ -29,7 +29,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief ISD1820 Voice Recorder Module library
|
||||
* @brief ISD1820 Voice Recorder Module
|
||||
* @defgroup isd1820 libupm-isd1820
|
||||
* @ingroup seeed gpio sound
|
||||
*/
|
||||
|
@ -30,7 +30,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief ITG-3200 Gyroscope library
|
||||
* @brief ITG3200 Gyroscope
|
||||
* @defgroup itg3200 libupm-itg3200
|
||||
* @ingroup seeed i2c compass
|
||||
*/
|
||||
|
@ -40,7 +40,7 @@
|
||||
namespace upm
|
||||
{
|
||||
/**
|
||||
* @brief JHD1313M1 Display library
|
||||
* @brief JHD1313M1 Display Controller
|
||||
* @defgroup jhd1313m1 libupm-jhd1313m1
|
||||
* @ingroup seeed i2c display gsk
|
||||
*/
|
||||
|
@ -30,7 +30,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief Analog Joystick library
|
||||
* @brief Analog Joystick Library
|
||||
* @defgroup joystick12 libupm-joystick12
|
||||
* @ingroup generic analog ainput robok
|
||||
*/
|
||||
|
@ -34,7 +34,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief L298 Dual H-Bridge Motor Driver library
|
||||
* @brief L298 Dual H-Bridge Motor Driver
|
||||
* @defgroup l298 libupm-l298
|
||||
* @ingroup seeed sparkfun gpio pwm motor
|
||||
*/
|
||||
|
@ -30,7 +30,7 @@
|
||||
namespace upm
|
||||
{
|
||||
/**
|
||||
* @brief I2C LCD Display library
|
||||
* @brief I2C LCD Displays Library
|
||||
* @defgroup lcd libupm-lcd
|
||||
* @ingroup dfrobot sainsmart seeed sparkfun adafruit i2c gpio display gsk
|
||||
*/
|
||||
|
@ -42,7 +42,7 @@
|
||||
namespace upm
|
||||
{
|
||||
/**
|
||||
* @brief LCDKS (LCD Keypad Shield) Display library
|
||||
* @brief LCD Keypad Shield
|
||||
* @defgroup lcdks libupm-lcdks
|
||||
* @ingroup dfrobot sainsmart display
|
||||
*/
|
||||
|
@ -40,7 +40,7 @@
|
||||
namespace upm
|
||||
{
|
||||
/**
|
||||
* @brief LCM1602 Display library
|
||||
* @brief LCM1602 Display Controller
|
||||
* @defgroup lcm1602 libupm-lcm1602
|
||||
* @ingroup dfrobot sainsmart seeed sparkfun adafruit i2c gpio display
|
||||
*/
|
||||
|
@ -29,7 +29,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief LDT0-028 Piezo Vibration Sensor library
|
||||
* @brief LDT0-028 Piezo Vibration Sensor
|
||||
* @defgroup ldt0028 libupm-ldt0028
|
||||
* @ingroup seeed analog flexfor
|
||||
*/
|
||||
|
@ -31,7 +31,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @brief LED library
|
||||
* @brief LED Library
|
||||
* @defgroup ledlib libupm-led
|
||||
* @ingroup seeed gpio led gsk
|
||||
*/
|
||||
|
@ -65,7 +65,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @brief LIDARLITEV3 Optical Distance Measurement Sensor library
|
||||
* @brief LIDARLITEV3 Optical Distance Measurement Sensor
|
||||
* @defgroup lidarlitev3 libupm-lidarlitev3
|
||||
* @ingroup garmin i2c light
|
||||
*/
|
||||
|
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