alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-02 01:41:12 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

ads1x15: updated doxygen tags to match existing groups

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
2015-12-23 17:03:33 -08:00
parent 4259aeab7b
commit 40be9b68a5
5 changed files with 32 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
src/ads1x15/ads1015.h
View File

@ -54,19 +54,20 @@
namespace upm {
/**
* @library ADS1115
* @sensor ADS1115
* @comname ADS1115
* @type adc
* @man adafruit
* @library ads1x15
* @sensor ADS1115
* @comname ADS1115 ADC
* @type electric
* @man ti adafruit
* @con i2c
* @web web http://www.ti.com/lit/ds/symlink/ads1015.pdf
*
* @brief API for ADS1015
*
* The ADS1013, ADS1014, and ADS1015 are precision analog-to-digital converters (ADCs) with 12 bits of resolution
* offered in an ultra-small, leadless QFN-10 package or an MSOP-10 package. The ADS1013/4/5 are designed with
* precision, power, and ease of implementation in mind. The ADS1013/4/5 feature an onboard reference and oscillator.
* Data are transferred via an I2C-compatible serial interface; four I2C slave addresses can be selected. The ADS1013/4/5
* Data is transferred via an I2C-compatible serial interface; four I2C slave addresses can be selected. The ADS1013/4/5
* operate from a single power supply ranging from 2.0V to 5.5V.
* The ADS1013/4/5 can perform conversions at rates up to 3300 samples per second (SPS). An onboard PGA is available
* on the ADS1014 and ADS1015 that offers input ranges from the supply to as low as <20>256mV, allowing both large and small
@ -76,13 +77,10 @@ namespace upm {
* after a conversion and greatly reduces current consumption during idle periods. The ADS1013/4/5 are specified from
* <20>40<34>C to +125<32>C.
*
* web https://www.adafruit.com/products/1083
* web http://www.ti.com/lit/ds/symlink/ads1015.pdf
* Tested with Adafriut ADS1015 board: https://www.adafruit.com/products/1083
*
* Tested with Adafriut ADS1015 board.
*
* @image html ADS1015.jpg
* @snippet ADS1015.cxx Interesting
* @image html ads1015.jpg
* @snippet ads1x15.cxx Interesting
*/
class ADS1015 : public ADS1X15 {

40
src/ads1x15/ads1115.h
View File

@ -55,34 +55,32 @@
namespace upm {
/**
* @library ADS1115
* @sensor ADS1115
* @comname ADS1115
* @type adc
* @man adafruit
* @library ads1x15
* @sensor ADS1115
* @comname ADS1115 ADC
* @type electric
* @man ti adafruit
* @con i2c
* web https://www.adafruit.com/products/1085
* web http://www.ti.com/lit/ds/symlink/ads1115.pdf
*
* @web http://www.ti.com/lit/ds/symlink/ads1115.pdf
*
* @brief API for ADS1115
*
* The ADS1113, ADS1114, and ADS1115 are precision analog-to-digital converters (ADCs) with 16 bits of resolution offered
* in an ultra-small, leadless QFN-10 package or an MSOP-10 package. The ADS1113/4/5 are designed with precision, power,
* and ease of implementation in mind. The ADS1113/4/5 feature an onboard reference and oscillator. Data are transferred via
* an I2C-compatible serial interface; four I2C slave addresses can be selected. The ADS1113/4/5 operate from a single power
* supply ranging from 2.0V to 5.5V.
* The ADS1113/4/5 can perform conversions at rates up to 860 samples per second (SPS). An onboard PGA is available on
* the ADS1114 and ADS1115 that offers input ranges from the supply to as low as <20>256mV, allowing both large and small
* signals to be measured with high resolution. The ADS1115 also features an input multiplexer (MUX) that provides two
* differential or four single-ended inputs.
* The ADS1113/4/5 operate either in continuous conversion mode or a single-shot mode that automatically powers down after
* a conversion and greatly reduces current consumption during idle periods. The ADS1113/4/5 are specified from <20>40<34>C to +125<32>C.
* in an ultra-small, leadless QFN-10 package or an MSOP-10 package. The ADS1113/4/5 are designed with precision, power,
* and ease of implementation in mind. The ADS1113/4/5 feature an onboard reference and oscillator. Data is transferred via
* an I2C-compatible serial interface; four I2C slave addresses can be selected. The ADS1113/4/5 operate from a single power
* supply ranging from 2.0V to 5.5V.
* The ADS1113/4/5 can perform conversions at rates up to 860 samples per second (SPS). An onboard PGA is available on
* the ADS1114 and ADS1115 that offers input ranges from the supply to as low as <20>256mV, allowing both large and small
* signals to be measured with high resolution. The ADS1115 also features an input multiplexer (MUX) that provides two
* differential or four single-ended inputs.
* The ADS1113/4/5 operate either in continuous conversion mode or a single-shot mode that automatically powers down after
* a conversion and greatly reduces current consumption during idle periods. The ADS1113/4/5 are specified from <20>40<34>C to +125<32>C.
*
* Tested with DIYMall ADS1115 board.
* Tested with DIYMall ADS1115 board. Also available from Adafruit: https://www.adafruit.com/products/1085
*
* @image html ADS1115.jpg
* @snippet ADS1015.cxx Interesting
* @image html ads1115.jpg
* @snippet ads1x15.cxx Interesting
*/
class ADS1115 : public ADS1X15 {

2
src/ads1x15/ads1x15.h
View File

@ -107,6 +107,8 @@ namespace upm {
* Library for TI analog to digital converter ic. Base clase fro ADS1X15 provides all the functionality that
* ADS1115 and ADS1015 ics have in common.
*
* @defgroup ads1x15 libupm-ads1x15
* @ingroup ti adafruit i2c electric
*/
class ADS1X15 {