alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-06-08 22:30:25 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

grovevdiv: header updated with new tags

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2015-04-10 14:35:50 -07:00
parent 1e45d8e712
commit a2e7609263
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/grovevdiv/grovevdiv.h
View File

@ -31,17 +31,28 @@
// ref voltage in millivolts
#define GROVEVDIV_VREF 4980
// default ADC resolution.
// default ADC resolution.
#define GROVEVDIV_ADC_RES 1024
namespace upm {
/**
* @brief UPM library for the Grove Voltage Divider
* @defgroup grovevdiv libupm-grovevdiv
* @ingroup seeed analog electric
*/
/**
* @library grovevdiv
* @sensor grovevdiv
* @comname Grove Voltage Divider
* @type electric
* @man seeed
* @con analog
*
* @brief C++ API for the Grove Voltage Divider Sensor
*
* UPM module for the Grove Voltage Divider Sensor
*
* @ingroup grove analog
* @snippet grovevdiv.cxx Interesting
*/
class GroveVDiv {
@ -76,12 +87,10 @@ namespace upm {
*
* @return the measured voltage
*/
float computedValue(uint8_t gain, uint16_t val, int vref=GROVEVDIV_VREF,
float computedValue(uint8_t gain, uint16_t val, int vref=GROVEVDIV_VREF,
int res=GROVEVDIV_ADC_RES);
private:
mraa_aio_context m_aio;
};
}