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

grove: add documentation for grove module

Browse Source 
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
Brendan Le Foll
2014-08-11 14:12:23 +01:00
parent c99821ad26
commit 00114f69d2
3 changed files with 45 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
src/grove/grove.h
View File

@ -40,6 +40,13 @@ class Grove {
std::string m_name;
};
/**
* @brief C++ API for Grove LED
*
* Very basic UPM module for grove LED, or any LED for that matter
*
* @snippet groveled.cxx Interesting
*/
class GroveLed: public Grove {
public:
GroveLed(int pin);
@ -51,21 +58,55 @@ class GroveLed: public Grove {
mraa_gpio_context m_gpio;
};
/**
* @brief C++ API for Grove Temperature sensor
*
* Very basic UPM module for grove temperature sensor on analog
*
* @snippet grovetemp.cxx Interesting
*/
class GroveTemp: public Grove {
public:
GroveTemp(unsigned int pin);
~GroveTemp();
/**
* Get raw value from AIO pin
*
* @return the raw value from the ADC
*/
float raw_value();
/**
* Get the temperature from the sensor
*
* @return the normalised temperature
*/
int value();
private:
mraa_aio_context m_aio;
};
/**
* @brief C++ API for Grove light sensor
*
* Very basic UPM module for grove Light sensor on analog
*
* @snippet grovelight.cxx Interesting
*/
class GroveLight: public Grove {
public:
GroveLight(unsigned int pin);
~GroveLight();
/**
* Get raw value from AIO pin
*
* @return the raw value from the ADC
*/
float raw_value();
/**
* Get the light value from the sensor
*
* @return the normalised light reading
*/
int value();
private:
mraa_aio_context m_aio;