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

26
src/mq303a/mq303a.h
View File

@ -29,7 +29,7 @@
namespace upm {
/**
* @brief MQ303A alcohol sensor library
* @brief MQ303A Alcohol Sensor library
* @defgroup mq303a libupm-mq303a
* @ingroup seeed analog gpio gaseous tsk
*/
@ -46,10 +46,10 @@ namespace upm {
*
* @brief API for the MQ303A Alcohol Sensor
*
* UPM module for the MQ303A Alcohol Sensor.
* UPM module for the MQ303A alcohol sensor.
* This sensor needs to be warmed up before stable results are
* obtained. The higher the value returned from value(),
* the higher the amount of alcohol that was detected.
* obtained. The higher the value returned from value(),
* the higher the amount of alcohol detected.
*
* @image html mq303a.jpg
* @snippet mq303a.cxx Interesting
@ -57,31 +57,31 @@ namespace upm {
class MQ303A {
public:
/**
* MQ303A sensor constructor
* MQ303A constructor
*
* @param pin analog pin to use
* @param heaterPin digital pin mapped to analog pin to use
* @param pin Analog pin to use
* @param heaterPin Digital pin mapped to the analog pin to use
*/
MQ303A(int pin, int heaterPin);
/**
* MQ303A Destructor
* MQ303A destructor
*/
~MQ303A();
/**
* Get the alcohol detected from the sensor.
* Gets the alcohol reading from the sensor.
* The value read from the analog pin is inverted.
* A higher returned value means a higher amount of alcohol was detected.
* A higher returned value means a higher amount of alcohol detected.
*
* @return the alcohol reading
* @return Alcohol reading
*/
int value();
/**
* Enable the heater.
* Enables the heater
*
* @param enable if true, enable the heater else disable
* @param enable Enables the heater if true; otherwise, disables it
*/
void heaterEnable(bool enable);