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

ecs1030: header update

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2015-04-09 12:31:10 -07:00
parent 9b3befd6f2
commit dec2e8eacc
1 changed files with 24 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
src/ecs1030/ecs1030.h
View File

@ -41,18 +41,31 @@ namespace upm {
#define TRUE HIGH
#define FALSE LOW
/**
* @brief ECS1030 electricity sensor library
* @defgroup ecs1030 libupm-ecs1030
*/
/**
* @brief C++ API for ECS1030 (electricity sensor)
*
* @ingroup ecs1030 analog
* @snippet ecs1030.cxx Interesting
*/
/**
* @brief ECS1030 Electricity Sensor library
* @defgroup ecs1030 libupm-ecs1030
* @ingroup sparkfun analog electric
*/
/**
* @library ecs1030
* @sensor ecs1030
* @comname ECS1030 Non-Invasive Current Sensor
* @type electric
* @man sparkfun
* @con analog
*
* @brief C++ 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
* does this by acting as an inductor and responding to the magnetic field
* around a current-carrying conductor. This particular current sensor will
* measure a load up to 30 Amps which makes it great for building your own
* energy monitors.
*
* @snippet ecs1030.cxx Interesting
*/
class ECS1030 {
public:
static const uint8_t DELAY_MS = 20000 / NUMBER_OF_SAMPLES; /* 1/50Hz is 20ms period */