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

docs: final batch of header files reviewed

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
VadimPopov
2015-08-10 18:53:31 +03:00
committed by Mihai Tudor Panu
parent 04edb9be04
commit 1fe9b9eb1d
53 changed files with 1182 additions and 1191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
src/ta12200/ta12200.h
View File

@ -34,26 +34,26 @@
namespace upm {
/**
* @brief TA12-200 current transformer library
* @brief TA12-200 Current Transformer library
* @defgroup ta12200 libupm-ta12200
* @ingroup seeed analog electric
*/
/**
* @library ta12200
* @sensor ta12200
* @comname TA12-200 Current transformer
* @comname TA12-200 Current Transformer
* @altname Grove Electricity Sensor
* @type electric
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Electricity_Sensor
* @con analog
*
* @brief API for the TA12-200 current transformer
* @brief API for the TA12-200 Current Transformer
*
* UPM module for the TA12-200 current transformer, which is found,
* UPM module for the TA12-200 current transformer found,
* for instance, in the Grove Electricity Sensor.
* This module can measure AC current moving through a wire at up
* to 5A.
* This module can measure AC moving through a wire at up
* to 5 A.
*
* @image html ta12200.jpg
* @snippet ta12200.cxx Interesting
@ -61,45 +61,45 @@ namespace upm {
class TA12200 {
public:
/**
* TA12200 sensor constructor
* TA12200 constructor
*
* @param pin analog pin to use
* @param pin Analog pin to use
*/
TA12200(int pin);
/**
* TA12200 Destructor
* TA12200 destructor
*/
~TA12200();
/**
* Return the number of milliseconds elapsed since initClock()
* Returns the number of milliseconds elapsed since initClock()
* was last called.
*
* @return elapsed milliseconds
* @return Elapsed milliseconds
*/
uint32_t getMillis();
/**
* Reset the Clock
* Resets the clock
*
*/
void initClock();
/**
* Get the conversion value from the sensor
* Gets the conversion value from the sensor
*
* @return the highest value obtained over 1 second of measuring
* @return Highest value obtained over 1 second of measuring
*/
unsigned int highestValue();
/**
* Compute the measured voltage
* Computes the measured voltage
*
* @param val value measured by highestValue()
* @param val Value measured by highestValue()
* @param res ADC resolution
*
* @return the measured current in milliamps
* @return Measured current in mA
*/
float milliAmps(unsigned int val, int res=TA12200_ADC_RES);