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: 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

22
src/ecs1030/ecs1030.h
View File

@ -61,12 +61,12 @@ namespace upm {
* 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
* around a current-carrying conductor. This particular current sensor
* measures a load up to 30 A, which makes it great for building your own
* energy monitors.
*
* @image html ecs1030.jpg
* <br><em>ECS1030 Sensor image provided by Sparkfun under
* <br><em>ECS1030 Sensor image provided by SparkFun* under
* <a href=https://creativecommons.org/licenses/by-nc-sa/3.0/>
* CC BY-NC-SA-3.0</a>.</em>
*
@ -79,39 +79,39 @@ class ECS1030 {
static const uint8_t R_LOAD = 2000.0 / CURRENT_RATIO;
/**
* Instanciates a ECS1030 (current sensor) object
* Instantiates an ECS1030 object
*
* @param pinNumber number of the data pin
* @param pinNumber Number of the data pin
*/
ECS1030 (uint8_t pinNumber);
/**
* ECS1030 object destructor, basicaly it close the GPIO.
* ECS1030 object destructor; basicaly, it closes the GPIO.
*/
~ECS1030 ();
/**
* Return currency data for the sampled period
* Returns electric current data for a sampled period
*/
double getCurrency_A ();
/**
* Return power data for the sampled period
* Returns power data for a sampled period
*/
double getPower_A ();
/**
* Return currency data for the sampled period
* Returns electric current data for a sampled period
*/
double getCurrency_B ();
/**
* Return power data for the sampled period
* Returns power data for a sampled period
*/
double getPower_B ();
/**
* Return name of the component
* Returns the name of the component
*/
std::string name() {
return m_name;