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: removed C++ references from documentation to make API language agnostic

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2015-06-01 10:56:03 -07:00
parent 4390c30be8
commit 8614cb322a
109 changed files with 142 additions and 142 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/a110x/a110x.h
View File

@ -43,7 +43,7 @@ namespace upm {
* @web http://www.allegromicro.com/en/Products/Magnetic-Digital-Position-Sensor-ICs/Hall-Effect-Unipolar-Switches/A1101-2-3-4-6.aspx
* @con gpio
*
* @brief C++ API for the A110X Hall Effect sensors
* @brief API for the A110X Hall Effect sensors
*
* UPM module for the A110X (A1101, A1102, A1103, A1104, and A1106)
* Hall Effect sensors. It outputs a digital signal indicating

2
src/adafruitms1438/adafruitms1438.h
View File

@ -52,7 +52,7 @@ namespace upm {
* @web http://www.adafruit.com/products/1438
* @con i2c
*
* @brief C++ API for the ADAFRUITMS1438 motor shield
* @brief API for the ADAFRUITMS1438 motor shield
*
* This class implements support for the stepper and DC motors that
* can be connected to this Motor Shield.

2
src/adafruitss/adafruitss.h
View File

@ -70,7 +70,7 @@ namespace upm {
* @web http://www.adafruit.com/product/1411
* @con i2c
*
* @brief C++ API for Adafruit Servo Shield
* @brief API for Adafruit Servo Shield
*
* UPM library for the PCA9685 based Adafruit 16-channel servo shield. When 3
* or more GWS servos attached results unpredictable. Adafruit do recommend a

2
src/adc121c021/adc121c021.h
View File

@ -78,7 +78,7 @@ namespace upm {
* @web http://www.seeedstudio.com/depot/Grove-I2C-ADC-p-1580.html
* @con i2c
*
* @brief C++ API for the ADC121C021 I2C ADC
* @brief API for the ADC121C021 I2C ADC
*
* UPM module for the ADC121C021 12 bit Analog to Digital (ADC) converter.
* By providing a constant reference voltage, this sensor helps

2
src/adis16448/adis16448.h
View File

@ -98,7 +98,7 @@ namespace upm {
* @web http://www.analog.com/en/products/sensors/isensor-mems-inertial-measurement-units/adis16448.html
* @con spi
*
* @brief C++ API for Analog Devices ADIS16448
* @brief API for Analog Devices ADIS16448
*
* This is an industrial grade accelerometer by Analog Devices.
*

2
src/adxl335/adxl335.h
View File

@ -48,7 +48,7 @@ namespace upm {
* @man seeed
* @con analog
*
* @brief C++ API for the ADXL335 3-axis Analog Accelerometer
* @brief API for the ADXL335 3-axis Analog Accelerometer
*
* UPM module for the ADXL335 3-axis analog accelerometer. This
* was tested on a Grove 3-axis Analog Accelerometer. It uses 3

2
src/adxl345/adxl345.h
View File

@ -43,7 +43,7 @@ namespace upm {
* @man seeed
* @con i2c
*
* @brief C++ API for Adxl345 (3-axis digital accelerometer)
* @brief API for Adxl345 (3-axis digital accelerometer)
*
* The Adxl345 is a 3-axis digital accelerometer.
* (http://www.seeedstudio.com/wiki/images/2/2c/ADXL345_datasheet.pdf)

2
src/am2315/am2315.h
View File

@ -64,7 +64,7 @@ namespace upm {
* @web http://www.adafruit.com/products/1293
* @con i2c
*
* @brief C++ API for AM2315 chip (Temperature & Humidity Sensor)
* @brief API for AM2315 chip (Temperature & Humidity Sensor)
*
* Measurement Specialties [AM2315]
* (http://www.aosong.com/asp_bin/Products/en/AM2315.pdf)

2
src/at42qt1070/at42qt1070.h
View File

@ -48,7 +48,7 @@ namespace upm {
* @man seeed
* @con i2c
*
* @brief C++ API for the Atmel AT42QT1070 QTouch sensor
* @brief API for the Atmel AT42QT1070 QTouch sensor
*
* This class implements support for the Atmel AT42QT1070 QTouch
* sensor, which supports 7 capacitive buttons.

2
src/biss0001/biss0001.h
View File

@ -42,7 +42,7 @@ namespace upm {
* @web http://www.seeedstudio.com/depot/Grove-PIR-Motion-Sensor-p-802.html
* @con gpio
*
* @brief C++ API for the BISS0001 Motion Sensor
* @brief API for the BISS0001 Motion Sensor
*
* UPM module for the BISS0001 Motion Sensor
*

2
src/bmpx8x/bmpx8x.h
View File

@ -76,7 +76,7 @@ namespace upm {
* @man seeed adafruit sparkfun
* @con i2c
*
* @brief C++ API for GY65/BMP085 and BMP180 chips (Atmospheric Pressure Sensor)
* @brief API for GY65/BMP085 and BMP180 chips (Atmospheric Pressure Sensor)
*
* The Bosch GY65/BMP085 and BMP180 are high precision, ultra-low
* power consumption pressure sensors. They have a range of between

4
src/buzzer/buzzer.h
View File

@ -51,9 +51,9 @@ namespace upm {
* @con pwm
* @kit gsk
*
* @brief C++ API for Buzzer component
* @brief API for Buzzer component
*
* This file defines the Buzzer C++ interface for libbuzzer.
* This file defines the Buzzer interface for libbuzzer.
* This sensor can make different tones when connected to
* a pin capable of analog pulse-width modulation. It emits
* sound using a piezoelectric material that vibrates at different

2
src/cjq4435/cjq4435.h
View File

@ -41,7 +41,7 @@ namespace upm {
* @man seeed
* @con gpio pwm
*
* @brief C++ API for the CJQ4435 MOSFET
* @brief API for the CJQ4435 MOSFET
*
* UPM module for the CJQ4435 MOSFET. It was developed using the
* Grove MOSFET module. A MOSFET is like a switch, but it can

2
src/ds1307/ds1307.h
View File

@ -57,7 +57,7 @@ namespace upm {
* @man seeed
* @con i2c
*
* @brief C++ API for the DS1307 Real Time CLock
* @brief API for the DS1307 Real Time CLock
*
* UPM module for the DS1307 based RTC. The clock can provide information
* about the seconds, minutes, hours, day of the week, day of the month,

2
src/ecs1030/ecs1030.h
View File

@ -55,7 +55,7 @@ namespace upm {
* @man sparkfun
* @con analog
*
* @brief C++ API for the ECS1030 Non-Invasive Current/Electricity Sensor
* @brief API for the ECS1030 Non-Invasive Current/Electricity Sensor
*
* This non-invasive current sensor can be clamped around the supply line of
* an electrical load to tell you how much current is passing through it. It

2
src/enc03r/enc03r.h
View File

@ -43,7 +43,7 @@ namespace upm {
* @man seeed
* @con analog
*
* @brief C++ API for the ENC03R Single Axis Analog Gyro
* @brief API for the ENC03R Single Axis Analog Gyro
*
* UPM module for the ENC03R Single Axis Analog Gyro.
* This gyroscope measures the x-axis angular velocity; that is,

2
src/flex/flex.h
View File

@ -42,7 +42,7 @@ namespace upm {
* @man sparkfun
* @con analog
*
* @brief C++ API for the Spectra Symbol Flex sensor
* @brief API for the Spectra Symbol Flex sensor
*
* A simple flex sensor, the resistance across the sensor increases when
* bent. Patented technology by Spectra Symbol, these sensors were used in

2
src/gas/mq2.h
View File

@ -36,7 +36,7 @@ namespace upm {
* @man seeed
* @con analog
*
* @brief C++ 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,

2
src/gas/mq3.h
View File

@ -36,7 +36,7 @@ namespace upm {
* @man seeed
* @con analog
*
* @brief C++ 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

2
src/gas/mq5.h
View File

@ -36,7 +36,7 @@ namespace upm {
* @man seeed
* @con analog
*
* @brief C++ 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

2
src/gas/mq9.h
View File

@ -36,7 +36,7 @@ namespace upm {
* @man seeed
* @con analog
*
* @brief C++ 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

@ -37,7 +37,7 @@ namespace upm {
* @man seeed
* @con analog
*
* @brief C++ API for Grove TP401 Air Quality Sensor
* @brief API for Grove TP401 Air Quality Sensor
*
* The Grove TP401 Air Quality Sensor module is useful for monitoring air purity indoors.
* It can detect CO and a wide range of other harmful gases, but due to limited sensing

2
src/gp2y0a/gp2y0a.h
View File

@ -42,7 +42,7 @@ namespace upm {
* @man seeed
* @con analog
*
* @brief C++ API for the GP2Y0A family of IR Proximity Sensors
* @brief API for the GP2Y0A family of IR Proximity Sensors
*
* This sensor family returns an analog voltage corresponding to the distance
* of an object from the sensor. The voltage is lower when objects

14
src/grove/grove.h
View File

@ -48,7 +48,7 @@ class Grove {
};
/**
* @brief C++ API for Grove LED
* @brief API for Grove LED
*
* UPM module for Grove LED (or other similar light-emitting diode).
* An LED is a small lightbulb that will emit light (turn on) in
@ -102,7 +102,7 @@ class GroveLed: public Grove {
};
/**
* @brief C++ API for Grove Relay
* @brief API for Grove Relay
*
* UPM module for Grove relay switch. The Grove relay is a
* digital normally-open switch that uses low voltage or current to
@ -155,7 +155,7 @@ class GroveRelay: public Grove {
};
/**
* @brief C++ API for Grove temperature sensor
* @brief API for Grove temperature sensor
*
* Very basic UPM module for Grove temperature sensor on analog
*
@ -191,7 +191,7 @@ class GroveTemp: public Grove {
};
/**
* @brief C++ 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
@ -231,7 +231,7 @@ class GroveLight: public Grove {
};
/**
* @brief C++ API for Grove Rotary Angle Sensor (Knob)
* @brief API for Grove Rotary Angle Sensor (Knob)
*
* Very basic UPM module for Grove rotary angle sensor (knob) on analog. Provides
* a set of functions to read the absolute pin value, degrees or radians and another
@ -295,7 +295,7 @@ class GroveRotary: public Grove {
};
/**
* @brief C++ API for Grove Slide Potentiometer
* @brief API for Grove Slide Potentiometer
*
* Very basic UPM module for Grove slide potentiometer on analog,
* returns either raw value or scaled voltage value.
@ -342,7 +342,7 @@ class GroveSlide: public Grove {
};
/**
* @brief C++ API for Grove button
* @brief API for Grove button
*
* Very basic UPM module for Grove button
*

2
src/grove/grovebutton.h
View File

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

2
src/grove/groveled.h
View File

@ -32,7 +32,7 @@
* @con gpio
* @kit gsk
*
* @brief C++ API for Grove LED
* @brief API for Grove LED
*
* UPM module for Grove LED (or other similar light-emitting diode).
* An LED is a small lightbulb that will emit light (turn on) in

2
src/grove/grovelight.h
View File

@ -32,7 +32,7 @@
* @con analog
* @kit gsk
*
* @brief C++ 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

2
src/grove/groverelay.h
View File

@ -32,7 +32,7 @@
* @con gpio
* @kit gsk
*
* @brief C++ API for Grove Relay
* @brief API for Grove Relay
*
* UPM module for Grove relay switch. The Grove relay is a
* digital normally-open switch that uses low voltage or current to

2
src/grove/groverotary.h
View File

@ -31,7 +31,7 @@
* @man seeed
* @con analog
*
* @brief C++ API for Grove Rotary Angle Sensor (Knob)
* @brief API for Grove Rotary Angle Sensor (Knob)
*
* Very basic UPM module for Grove rotary angle sensor (knob) on analog. Provides
* a set of functions to read the absolute pin value, degrees or radians and another

2
src/grove/groveslide.h
View File

@ -31,7 +31,7 @@
* @man seeed
* @con analog
*
* @brief C++ API for Grove Slide Potentiometer
* @brief API for Grove Slide Potentiometer
*
* Very basic UPM module for Grove slide potentiometer on analog,
* returns either raw value or scaled voltage value.

2
src/grove/grovetemp.h
View File

@ -32,7 +32,7 @@
* @con analog
* @kit gsk
*
* @brief C++ 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

@ -40,7 +40,7 @@ namespace upm {
* @man seeed
* @con gpio
*
* @brief C++ API for the Grove Collision Sensor
* @brief API for the Grove Collision Sensor
*
* The Grove Collision Sensor can detect whether any
* collision movement or vibration happens.

2
src/groveehr/groveehr.h
View File

@ -43,7 +43,7 @@ namespace upm {
* @man seeed
* @con gpio
*
* @brief C++ API for the Grove Ear-clip Heart Rate sensor
* @brief API for the Grove Ear-clip Heart Rate sensor
*
* UPM module for the GroveEHR sensor. It is used to measure your
* heartbeat.

2
src/groveeldriver/groveeldriver.h
View File

@ -43,7 +43,7 @@ namespace upm {
* @man seeed
* @con gpio
*
* @brief C++ API for the Grove El Driver Module
* @brief API for the Grove El Driver Module
*
* The Grove EL Driver allows you to easily light up an
* EL Wire with just one single Grove cable.

2
src/groveelectromagnet/groveelectromagnet.h
View File

@ -43,7 +43,7 @@ namespace upm {
* @man seeed
* @con gpio
*
* @brief C++ API for the Grove Electromagnet
* @brief API for the Grove Electromagnet
*
* The Grove Electromagnet can hold up to 1 KG (approximately 2.2 lbs)
*

2
src/groveemg/groveemg.h
View File

@ -41,7 +41,7 @@ namespace upm {
* @man seeed
* @con analog
*
* @brief C++ API for the GroveEMG Muscle Signal Reader Sensor
* @brief API for the GroveEMG Muscle Signal Reader Sensor
*
* GroveEMG Muscle Signal reader gathers small muscle signals,
* then processes and returns the result

2
src/grovegsr/grovegsr.h
View File

@ -41,7 +41,7 @@ namespace upm {
* @man seeed
* @con analog
*
* @brief C++ API for the GroveGSR Galvanic Skin Response Sensor
* @brief API for the GroveGSR Galvanic Skin Response Sensor
*
* Measure the electrical conductance of skin in order
* to measure strong emotional reaction.

2
src/grovelinefinder/grovelinefinder.h
View File

@ -41,7 +41,7 @@ namespace upm {
* @man seeed
* @con gpio
*
* @brief C++ API for the Grove Line Finder sensor
* @brief API for the Grove Line Finder sensor
*
* UPM module for the Grove Line Finder sensor. It outputs a
* digital signal indicating whether it is detecting black on a

2
src/groveloudness/groveloudness.h
View File

@ -41,7 +41,7 @@ namespace upm {
* @man seeed
* @con analog
*
* @brief C++ API for the Grove Loudness Sensor
* @brief API for the Grove Loudness Sensor
*
* UPM module for the Grove Loudness Sensor. This sensor
* detects how loud the surrounding environment is.

2
src/grovemd/grovemd.h
View File

@ -47,7 +47,7 @@ namespace upm {
* @man seeed
* @con i2c
*
* @brief C++ API for the Grove I2C Motor Driver
* @brief API for the Grove I2C Motor Driver
*
* This class implements support for the Grove I2C Motor Driver.
* This device can support a single 4-wire stepper motor, OR two

2
src/grovemoisture/grovemoisture.h
View File

@ -41,7 +41,7 @@ namespace upm {
* @man seeed
* @con analog
*
* @brief C++ API for the Grove Moisture Sensor
* @brief API for the Grove Moisture Sensor
*
* UPM module for the Grove Moisture Sensor.
* This sensor can be used to detect the moisture content

2
src/groveo2/groveo2.h
View File

@ -41,7 +41,7 @@ namespace upm {
* @man seeed
* @con analog
*
* @brief C++ API for the GroveO2 Oxygen Gas Sensor
* @brief API for the GroveO2 Oxygen Gas Sensor
*
* The Grove O2 sensor measures the oxygen concentration in the air
*

2
src/grovescam/grovescam.h
View File

@ -62,7 +62,7 @@ namespace upm {
* @connection uart
* @web http://www.seeedstudio.com/wiki/Grove_-_Serial_Camera_Kit
*
* @brief C++ API for the Grove Serial Camera
* @brief API for the Grove Serial Camera
*
* The driver was tested with the Grove Serial Camera. There is
* no protocol documentation currently available, so this module

2
src/grovespeaker/grovespeaker.h
View File

@ -54,7 +54,7 @@ typedef struct
* @man seeed
* @con gpio
*
* @brief C++ API for the GroveSpeaker speaker
* @brief API for the GroveSpeaker speaker
*
* UPM module for the GroveSpeaker.
* This sensor can generate different tones and sounds depending on the

2
src/grovevdiv/grovevdiv.h
View File

@ -49,7 +49,7 @@ namespace upm {
* @man seeed
* @con analog
*
* @brief C++ API for the Grove Voltage Divider Sensor
* @brief API for the Grove Voltage Divider Sensor
*
* UPM module for the Grove Voltage Divider Sensor
*

2
src/grovewater/grovewater.h
View File

@ -41,7 +41,7 @@ namespace upm {
* @man seeed
* @con gpio
*
* @brief C++ API for the Grove Water Sensor
* @brief API for the Grove Water Sensor
*
* UPM module for the Grove Water Sensor
*

2
src/grovewfs/grovewfs.h
View File

@ -45,7 +45,7 @@ namespace upm {
* @web http://www.seeedstudio.com/wiki/index.php?title=G1/2_Water_Flow_sensor
* @con gpio
* @brief C++ API for the Grove Water Flow Sensor
* @brief API for the Grove Water Flow Sensor
*
* This sensor is used to measure water flow, in LPM (Liters Per
* Minute). It incorporates a Hall Effect Sensor. The UPM module

2
src/guvas12d/guvas12d.h
View File

@ -42,7 +42,7 @@ namespace upm {
* @man seeed
* @con analog
*
* @brief C++ API for the GUVAS12D UV sensor module
* @brief API for the GUVAS12D UV sensor module
*
* UPM module for the GUVAS12D UV Sensor
*

2
src/h3lis331dl/h3lis331dl.h
View File

@ -46,7 +46,7 @@ namespace upm {
* @web http://www.seeedstudio.com/depot/Grove-3Axis-Digital-Accelerometer400g-p-1897.html
* @con i2c
*
* @brief C++ API for the H3LIS331DL based Grove 3-axis I2C Accelerometer
* @brief API for the H3LIS331DL based Grove 3-axis I2C Accelerometer
* (400G)
*
* @image html h3lis331dl.jpg

4
src/hcsr04/hcsr04.h
View File

@ -50,9 +50,9 @@ namespace upm {
* @man generic
* @con gpio
*
* @brief C++ API for HCSR04 (ultrasonic ranging module) component
* @brief API for HCSR04 (ultrasonic ranging module) component
*
* This file defines the HCSR04 C++ interface for libhcsr04
* This file defines the HCSR04 interface for libhcsr04
*
* @snippet hcsr04.cxx Interesting
*/

2
src/hm11/hm11.h
View File

@ -62,7 +62,7 @@ namespace upm {
* @connection uart
* @web http://www.seeedstudio.com/wiki/images/c/cd/Bluetooth4_en.pdf
*
* @brief C++ API HM-11 4.0 Bluetooth Low Energy Module
* @brief API HM-11 4.0 Bluetooth Low Energy Module
*
* The driver was tested with the Grove BLE module. Its an HM-11
* BLE 4.0 module based on a TI CC2541 chip. It operates using a

2
src/hmc5883l/hmc5883l.h
View File

@ -44,7 +44,7 @@ namespace upm {
* @man seeed
* @con i2c
*
* @brief C++ API for Hmc5883l (3-axis digital compass)
* @brief API for Hmc5883l (3-axis digital compass)
*
* The Honeywell [HMC5883L]
* (http://www.adafruit.com/datasheets/HMC5883L_3-Axis_Digital_Compass_IC.pdf)

2
src/hmtrp/hmtrp.h
View File

@ -58,7 +58,7 @@ namespace upm {
* @man seeed
* @con uart
*
* @brief C++ API for the HMTRP Serial RF Pro
* @brief API for the HMTRP Serial RF Pro
*
* UPM support for the HMTRP Serial RF Pro. This was tested
* specifically with the Grove Serial RF Pro module. In theory,

2
src/ht9170/ht9170.h
View File

@ -44,7 +44,7 @@ namespace upm {
* @web http://www.seeedstudio.com/depot/DTMFDual-Tone-Multi-Frequency-Shield-p-1839.html
* @con gpio
*
* @brief C++ API for the HT9170 DTMF Decoder
* @brief API for the HT9170 DTMF Decoder
*
* This driver was developed using the Seeed DTMF (Dual Tone
* Multi-Frequency) Shield. It can decode DTMF signals presented at

2
src/htu21d/htu21d.h
View File

@ -63,7 +63,7 @@ namespace upm {
* @web http://www.meas-spec.com/downloads/HTU21D.pdf
* @con i2c
*
* @brief C++ API for HTU21D chip (Atmospheric Pressure Sensor)
* @brief API for HTU21D chip (Atmospheric Pressure Sensor)
*
* Measurement Specialties [HTU21D] is a digital humidity sensor with
* temperature output.

2
src/hx711/hx711.h
View File

@ -43,7 +43,7 @@ namespace upm {
* @web http://www.dfrobot.com/image/data/SEN0160/hx711_english.pdf
* @con gpio
*
* @brief C++ API for HX711
* @brief API for HX711
*
* The HX711 is a precision 24-bit analog-to-digital converter (ADC)
* designed for weigh scales and industrial control applications to

2
src/ina132/ina132.h
View File

@ -41,7 +41,7 @@ namespace upm {
* @man seeed
* @con analog
*
* @brief C++ API for the INA132 Differential Amplifier Sensor
* @brief API for the INA132 Differential Amplifier Sensor
*
* The INA132 Differential Amplifier Sensor is designed
* for precise differential-input amplification.

2
src/isd1820/isd1820.h
View File

@ -42,7 +42,7 @@ namespace upm {
* @man seeed
* @con gpio
*
* @brief C++ API support for the ISD1820 based Grove Recorder
* @brief API support for the ISD1820 based Grove Recorder
*
* This class implements support for the Grove Recorder. There
* are two digital pins, one that enables recording, and the other

2
src/itg3200/itg3200.h
View File

@ -43,7 +43,7 @@ namespace upm {
* @man seeed
* @con i2c
*
* @brief C++ 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)

2
src/joystick12/joystick12.h
View File

@ -43,7 +43,7 @@ namespace upm {
* @man generic
* @con analog
*
* @brief C++ API for Elecfreaks Joystick v 1.2-1.4 breakout
* @brief API for Elecfreaks Joystick v 1.2-1.4 breakout
*
* This file defines the Joystick API and implemntation for X, Y
* button could be treated as normal GPIO, this enables easier

2
src/l298/l298.h
View File

@ -47,7 +47,7 @@ namespace upm {
* @man seeed sparkfun
* @con gpio pwm
*
* @brief C++ API for the L298 Dual H-Bridge module
* @brief API for the L298 Dual H-Bridge module
*
* It was developed using the RobotBase Dual H-Bridge module.
*

2
src/lcd/jhd1313m1.h
View File

@ -39,7 +39,7 @@ namespace upm
* @con i2c
* @kit gsk
*
* @brief C++ API for Jhd1313m1 i2c controller for HD44780 based displays with
* @brief API for Jhd1313m1 i2c controller for HD44780 based displays with
* an RGB backlight such as the Grove RGB i2c LCD display
*
* The Jhd1313m1 has two i2c addreses, one belongs to a controller very similar

2
src/lcd/lcm1602.h
View File

@ -41,7 +41,7 @@ namespace upm
* @web https://www.adafruit.com/datasheets/TC1602A-01T.pdf
* @con i2c
*
* @brief C++ API for LCM1602 i2c controller for HD44780 based displays
* @brief API for LCM1602 i2c controller for HD44780 based displays
*
* This supports all sizes of HD44780 displays from 16x2 to 4x20, the
* controller has no idea of the actual display hardware so will let you write

2
src/lcd/ssd1308.h
View File

@ -43,7 +43,7 @@ const uint8_t DISPLAY_CMD_SET_NORMAL_1308 = 0xA6;
* @web http://www.seeedstudio.com/wiki/Grove_-_OLED_Display_0.96%22
* @con i2c
*
* @brief C++ API for SSD1308 i2c controlled OLED displays
* @brief API for SSD1308 i2c controlled OLED displays
*
* The SSD1308 is a 128x64 Dot matrix OLED/PLED segment driver with
* controller. This implementation was tested using the Grove LED 128×64

2
src/lcd/ssd1327.h
View File

@ -43,7 +43,7 @@ const uint8_t DISPLAY_CMD_SET_NORMAL = 0xA4;
* @web http://www.seeedstudio.com/wiki/Grove_-_OLED_Display_1.12%22
* @con i2c
*
* @brief C++ API for SSD1327 i2c controlled OLED displays
* @brief API for SSD1327 i2c controlled OLED displays
*
* The SSD1327 is a 96x96 Dot matrix OLED/PLED segment driver with controller.
* This implementation was tested using the Grove LED 96×96 Display module

4
src/ldt0028/ldt0028.h
View File

@ -43,10 +43,10 @@ namespace upm {
* @man seeed
* @con analog
*
* @brief C++ API for LDT0-028 PZT film-based sensors,
* @brief API for LDT0-028 PZT film-based sensors,
* such as the Grove Piezo Vibration sensor
*
* This file defines the LDT0028 C++ interface for libupm-ldt0028
* This file defines the LDT0028 interface for libupm-ldt0028
*
* @image html ldt0028.jpg
* @snippet ldt0028.cxx Interesting

2
src/lol/lol.h
View File

@ -47,7 +47,7 @@ namespace upm {
* @man adafruit
* @con gpio
*
* @brief C++ API for Olimex LoL array
* @brief API for Olimex LoL array
*
* This file defines the LoL API and implemntation for a simple framebuffer
*

2
src/lpd8806/lpd8806.h
View File

@ -47,7 +47,7 @@ namespace upm {
* @man adafruit
* @con spi
*
* @brief C++ API for LPD8806
* @brief API for LPD8806
*
* The FastPixel lpd8806 is an RGB led strip controller.
*

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 C++ API for LSM303
* @brief API for LSM303
*
* This file defines the LSM303DLH 3-axis magnetometer/3-axis accelerometer.
* This module was tested with the SeedStudio Grove [6-Axis Accelerometer&Compass]

2
src/max31723/max31723.h
View File

@ -46,7 +46,7 @@ namespace upm {
* @man maxim
* @con spi
*
* @brief C++ 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)

2
src/max31855/max31855.h
View File

@ -42,7 +42,7 @@ namespace upm {
* @man maxim
* @con spi
*
* @brief C++ API for MAX31855
* @brief API for MAX31855
*
* The Maxim Integrated
* [MAX31855](http://datasheets.maximintegrated.com/en/ds/MAX31855.pdf)

2
src/max44000/max44000.h
View File

@ -65,7 +65,7 @@ namespace upm {
* @man maxim
* @con i2c
*
* @brief C++ API for MAX44000 chip (Ambient and Infrared Proximity Sensor)
* @brief API for MAX44000 chip (Ambient and Infrared Proximity Sensor)
*
* The Maxim Integrated
* [MAX44000](http://datasheets.maximintegrated.com/en/ds/MAX44000.pdf)

2
src/max5487/max5487.h
View File

@ -46,7 +46,7 @@ namespace upm {
* @man maxim
* @con spi
*
* @brief C++ API for MAX5487 chip (SPI digital potentionmeter)
* @brief API for MAX5487 chip (SPI digital potentionmeter)
*
* The Maxim Integrated
* [MAX5487](http://datasheets.maximintegrated.com/en/ds/MAX5487-MAX5489.pdf)

4
src/maxds3231m/maxds3231m.h
View File

@ -75,9 +75,9 @@ struct Time3231 {
* @man maxim
* @con i2c
*
* @brief C++ API for MAXDS3231M chip (Ambient and Infrared Proximity Sensor)
* @brief API for MAXDS3231M chip (Ambient and Infrared Proximity Sensor)
*
* This file defines the maxds3231m C++ interface for maxds3231m
* This file defines the maxds3231m interface for maxds3231m
*
* @snippet maxds3231m.cxx Interesting
*/

2
src/maxsonarez/maxsonarez.h
View File

@ -46,7 +46,7 @@ namespace upm {
* @man sparkfun
* @con analog
*
* @brief C++ API for the LV-MaxSonar-EZ family of ultrasonic rangers
* @brief API for the LV-MaxSonar-EZ family of ultrasonic rangers
*
* This sensor family returns an analog voltage corresponding to the
* distance of an object from the sensor in inches. It has a

2
src/mhz16/mhz16.h
View File

@ -61,7 +61,7 @@ namespace upm {
* @man seeed
* @con uart
*
* @brief C++ API support for the Grove CO2 sensor
* @brief API support for the Grove CO2 sensor
*
* This class implements support for the Grove CO2 sensor.
*

2
src/mic/mic.h
View File

@ -50,7 +50,7 @@ namespace upm {
* @con pwm
* @kit gsk
*
* @brief C++ API for Microphone
* @brief API for Microphone
*
* This file defines the Microphone Analog sensor
*

4
src/mlx90614/mlx90614.h
View File

@ -65,9 +65,9 @@ namespace upm {
* @man generic
* @con i2c
*
* @brief C++ API for MLX90614
* @brief API for MLX90614
*
* This file defines the MLX90614 C++ interface for libmlx90614
* This file defines the MLX90614 interface for libmlx90614
*
* @image html mlx90614.jpg
* @snippet mlx90614.cxx Interesting

4
src/mma7455/mma7455.h
View File

@ -162,9 +162,9 @@ union accelData {
* @man generic
* @con i2c
*
* @brief C++ API for MMA7455 chip (accelerometer)
* @brief API for MMA7455 chip (accelerometer)
*
* This file defines the MMA7455 C++ interface for libmma7455
* This file defines the MMA7455 interface for libmma7455
*
* @image html mma7455.jpg
* @snippet mma7455.cxx Interesting

2
src/mma7660/mma7660.h
View File

@ -45,7 +45,7 @@ namespace upm {
* @man generic
* @con i2c gpio
*
* @brief C++ API for the MMA7660 I2C 3-axis digital accelerometer
* @brief API for the MMA7660 I2C 3-axis digital accelerometer
*
* UPM module for the MMA7660 I2C 3-axis digital accelerometer.
* This device supports a variety of capabilities, including the

2
src/mpl3115a2/mpl3115a2.h
View File

@ -69,7 +69,7 @@ namespace upm {
* @web http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2
* @con i2c
*
* @brief C++ API for MPL3115A2 chip (Atmospheric Pressure Sensor)
* @brief API for MPL3115A2 chip (Atmospheric Pressure Sensor)
*
* Freescale [MPL3115A2]
* (http://cache.freescale.com/files/sensors/doc/data_sheet/MPL3115A2.pdf)

4
src/mpr121/mpr121.h
View File

@ -32,7 +32,7 @@
namespace upm {
/**
* @brief C++ API for the MPR121 I2C touch sensor
* @brief API for the MPR121 I2C touch sensor
*
* UPM module for the MPR121 touch sensor
*
@ -54,7 +54,7 @@ namespace upm {
* @web http://www.seeedstudio.com/wiki/Grove_-_I2C_Touch_Sensor
* @con i2c
*
* @brief C++ API for the MPR121 I2C touch sensor
* @brief API for the MPR121 I2C touch sensor
*
* UPM module for the MPR121 touch sensor
*

4
src/mpu9150/mpu9150.h
View File

@ -122,9 +122,9 @@ struct AxisData {
* @web http://www.seeedstudio.com/wiki/Grove_-_IMU_9DOF_v1.0
* @con i2c
*
* @brief C++ API for MPU9150 chip (Accelerometer, Gyro and Magnometer Sensor)
* @brief API for MPU9150 chip (Accelerometer, Gyro and Magnometer Sensor)
*
* This file defines the MPU9150 C++ interface for libmpu9150
* This file defines the MPU9150 interface for libmpu9150
*
* @image html mpu9150.jpg
* @snippet mpu9150.cxx Interesting

2
src/mq303a/mq303a.h
View File

@ -42,7 +42,7 @@ namespace upm {
* @web http://www.seeedstudio.com/wiki/Grove_-_Alcohol_Sensor
* @con analog gpio
*
* @brief C++ API for the MQ303A Alcohol Sensor
* @brief API for the MQ303A Alcohol Sensor
*
* UPM module for the MQ303A Alcohol Sensor.
* This sensor needs to be warmed up before stable results are

4
src/my9221/my9221.h
View File

@ -51,9 +51,9 @@ namespace upm {
* @web http://www.seeedstudio.com/wiki/Grove_-_LED_Bar
* @con gpio
*
* @brief C++ API for MY9221 led bar module
* @brief API for MY9221 led bar module
*
* This file defines the MY9221 C++ interface for libmy9221
* This file defines the MY9221 interface for libmy9221
*
* @image html my9221.jpg
* @snippet my9221-ledbar.cxx Interesting

4
src/nrf24l01/nrf24l01.h
View File

@ -164,9 +164,9 @@ typedef enum {
* @web http://www.seeedstudio.com/depot/nRF24L01Module-p-1394.html
* @con spi
*
* @brief C++ API for NRF24l01 transceiver module
* @brief API for NRF24l01 transceiver module
*
* This file defines the NRF24l01 C++ interface for libnrf24l01
* This file defines the NRF24l01 interface for libnrf24l01
*
* @image html nrf24l01.jpg
* @snippet nrf24l01-receiver.cxx Interesting

2
src/nrf8001/nrf8001.h
View File

@ -38,7 +38,7 @@
*
* @brief nrf8001 Bluetooth Low Energy library
*
* These files define the NRF8001 C++ interface for lib-nrf8001. Interaction
* These files define the NRF8001 interface for lib-nrf8001. Interaction
* with this device is done through the ACI routines included with the library.
* You can use the nRF UART app in the Apple iOS app store and Google Play for
* Android 4.3 for Samsung Galaxy S4 to interact with a microcontroller running

2
src/nunchuck/nunchuck.h
View File

@ -44,7 +44,7 @@ namespace upm {
* @web http://wiibrew.org/wiki/Wiimote/Extension_Controllers
* @con i2c
*
* @brief C++ API for the Wii Nunchuck
* @brief API for the Wii Nunchuck
*
* UPM module for the Wii Nunchuck. This module was tested with the
* Wii Nunchuck connected to I2C via a Grove Wii Nunchuck adapter.

2
src/otp538u/otp538u.h
View File

@ -41,7 +41,7 @@ namespace upm {
* @man generic
* @con analog
*
* @brief C++ API for the OTP538U IR Temperature Sensor
* @brief API for the OTP538U IR Temperature Sensor
*
* UPM module for the OTP538U IR Temperature Sensor
*

2
src/pca9685/pca9685.h
View File

@ -52,7 +52,7 @@ namespace upm {
* @web http://www.adafruit.com/products/815
* @con i2c
*
* @brief C++ API for the PCA9685 16 channel, 12 bit pwm LED controller
* @brief API for the PCA9685 16 channel, 12 bit pwm LED controller
*
* This controller is also used on the Adafruit Motor Shield v2.3
* board to control up to 4 DC motors, 2 step motors and 2 servo

2
src/ppd42ns/ppd42ns.h
View File

@ -50,7 +50,7 @@ typedef struct
* @web http://www.seeedstudio.com/wiki/Grove_-_Dust_Sensor
* @con gpio
*
* @brief C++ API for the Dust Sensor
* @brief API for the Dust Sensor
*
* UPM module for the Dust Sensor
*

2
src/rfr359f/rfr359f.h
View File

@ -42,7 +42,7 @@ namespace upm {
* @web http://www.seeedstudio.com/wiki/Grove_-_IR_Distance_Interrupt
* @con gpio
*
* @brief C++ API for the RFR359F based Grove Distance Interrupter.
* @brief API for the RFR359F based Grove Distance Interrupter.
*
* UPM module for the Grove Distance Interrupter. The sensitivity
* can be adjusted with the potentiometer on the sensor module. It

2
src/rotaryencoder/rotaryencoder.h
View File

@ -45,7 +45,7 @@ namespace upm {
* @con gpio
* @kit gsk
*
* @brief C++ API for the Grove Rotary Encoder
* @brief API for the Grove Rotary Encoder
*
* UPM module for the Grove Rotary Encoder. A Rotary Encoder
* encodes a rotation signal into electronic pulses that can be used

2
src/rpr220/rpr220.h
View File

@ -42,7 +42,7 @@ namespace upm {
* @web http://www.seeedstudio.com/wiki/Grove_-_Infrared_Reflective_Sensor
* @con gpio
*
* @brief C++ API for the RPR220 based Grove IR Reflective Sensor
* @brief API for the RPR220 based Grove IR Reflective Sensor
*
* UPM module for the Grove IR Reflective Sensor. The sensitivity
* can be adjusted with the potentiometer on the sensor module. It

4
src/servo/es08a.h
View File

@ -38,9 +38,9 @@ namespace upm {
* @con pwm
* @kit gsk
*
* @brief C++ API for ES08A servo component
* @brief API for ES08A servo component
*
* This file defines the ES08A C++ interface for ES08A servos.
* This file defines the ES08A interface for ES08A servos.
* Like other servos, the ES08A servo has a shaft that can be controlled
* by setting the desired angle. There are also routines for setting
* and getting the minimum and maximum pulse width as well as the

2
src/si114x/si114x.h
View File

@ -52,7 +52,7 @@ namespace upm {
* @web https://www.adafruit.com/products/1777
* @con i2c
*
* @brief C++ API for the SI1145 UV light sensor
* @brief API for the SI1145 UV light sensor
*
* This module was tested with the Adafruit UV Sensor
*

4
src/sm130/sm130.h
View File

@ -54,9 +54,9 @@ namespace upm {
* @web https://www.sparkfun.com/products/10126
* @con gpio
*
* @brief C++ API for SM130 RFID reader module
* @brief API for SM130 RFID reader module
*
* This file defines the C++ interface for sm130 RFID library
* This file defines the interface for sm130 RFID library
*
* @snippet sm130.cxx Interesting
*/

8
src/st7735/st7735.h
View File

@ -494,9 +494,9 @@ const unsigned char font[] = {
};
/**
* @brief C++ API for the st7735 lcd display library
* @brief API for the st7735 lcd display library
*
* This file defines the C++ interface for ST7735 display library
* This file defines the interface for ST7735 display library
*
* @defgroup st7735 libupm-st7735
* @ingroup adafruit spi display
@ -510,9 +510,9 @@ const unsigned char font[] = {
* @web http://www.adafruit.com/product/358
* @con spi
*
* @brief C++ API for the st7735 lcd display library
* @brief API for the st7735 lcd display library
*
* This file defines the C++ interface for ST7735 display library
* This file defines the interface for ST7735 display library
*
* @image html st7735.jpg
* @snippet st7735.cxx Interesting

8
src/stepmotor/stepmotor.h
View File

@ -41,9 +41,9 @@
namespace upm {
/**
* @brief C++ API for the Stepper motor library
* @brief API for the Stepper motor library
*
* This file defines the stepmotor C++ interface
* This file defines the stepmotor interface
*
* @defgroup stepper libupm-stepper
* @ingroup seeed pwm gpio motor
@ -57,9 +57,9 @@ namespace upm {
* @web http://www.seeedstudio.com/wiki/Grove_-_I2C_Motor_Driver_V1.3
* @con pwm gpio
*
* @brief C++ API for the Stepper motor library
* @brief API for the Stepper motor library
*
* This file defines the stepmotor C++ interface
* This file defines the stepmotor interface
*
* @image html stepmotor.jpg
* @snippet stepmotor.cxx Interesting

2
src/sx6119/sx6119.h
View File

@ -42,7 +42,7 @@ namespace upm {
* @man seeed
* @con gpio
*
* @brief C++ API support for the SX6119 based Grove FM Receiver
* @brief API support for the SX6119 based Grove FM Receiver
*
* This class implements support for the FM Receiver. There are
* two digital pins, one that toggles power on/off, and one that

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