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

docs: more header files edited

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
VadimPopov
2015-08-09 22:51:25 +03:00
committed by Mihai Tudor Panu
parent 55e8076988
commit 04edb9be04
68 changed files with 1172 additions and 1172 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
src/grovevdiv/grovevdiv.h
View File

@ -28,15 +28,15 @@
#include <stdint.h>
#include <mraa/aio.h>
// ref voltage in millivolts
// reference voltage in millivolts
#define GROVEVDIV_VREF 4980
// default ADC resolution.
// default ADC resolution
#define GROVEVDIV_ADC_RES 1024
namespace upm {
/**
* @brief Grove Voltage Divider sensor library
* @brief Grove Voltage Divider Sensor library
* @defgroup grovevdiv libupm-grovevdiv
* @ingroup seeed analog electric robok
*/
@ -52,7 +52,7 @@ namespace upm {
*
* @brief API for the Grove Voltage Divider Sensor
*
* UPM module for the Grove Voltage Divider Sensor
* UPM module for the Grove Voltage Divider sensor
*
* @image html grovevdiv.jpg
* @snippet grovevdiv.cxx Interesting
@ -62,32 +62,32 @@ namespace upm {
/**
* Grove Voltage Divider sensor constructor
*
* @param pin analog pin to use
* @param pin Analog pin to use
*/
GroveVDiv(int pin);
/**
* Grove Voltage Divider Destructor
* Grove Voltage Divider destructor
*/
~GroveVDiv();
/**
* Get the conversion value from the sensor
* Gets the conversion value from the sensor
*
* @param samples specifies how many samples to average over
* @return the averaged ADC conversion value
* @param samples Specifies how many samples to average over
* @return Average ADC conversion value
*/
unsigned int value(unsigned int samples);
/**
* Compute the measured voltage
* Computes the measured voltage
*
* @param gain gain switch, either 3 or 10 for grove
* @param val measured voltage (from value())
* @param vref reference voltage in millivolts
* @param gain Gain switch, either 3 or 10 for Grove
* @param val Measured voltage (from value())
* @param vref Reference voltage in millivolts
* @param res ADC resolution
*
* @return the measured voltage
* @return Measured voltage
*/
float computedValue(uint8_t gain, uint16_t val, int vref=GROVEVDIV_VREF,
int res=GROVEVDIV_ADC_RES);