alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-05 03:11:15 +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

40
src/gas/gas.h
View File

@ -35,10 +35,10 @@ struct thresholdContext {
namespace upm {
/**
* @brief Gas sensor library
* @brief Gas Sensor library
*
* Sensor Library for air quality and gas detecting sensors. Base class Gas provides buffered
* sampling, threshold checking, a basic printing function and a standard read function.
* Library for air quality and gas detecting sensors. Base class Gas provides buffered
* sampling, threshold checking, basic printing function, and standard read function.
*
* @defgroup gas libupm-gas
* @ingroup seeed analog gaseous eak hak
@ -48,7 +48,7 @@ class Gas {
/**
* Instantiates a Gas object
*
* @param gasPin pin where gas is connected
* @param gasPin Pin where gas is connected
*/
Gas(int gasPin);
@ -58,45 +58,45 @@ class Gas {
~Gas();
/**
* Get samples from gas sensor according to provided window and
* Gets samples from the gas sensor according to the provided window and
* number of samples
*
* @param freqMS time between each sample (in milliseconds)
* @param numberOfSamples number of sample to sample for this window
* @param buffer buffer with sampled data
* @param freqMS Time between each sample (in milliseconds)
* @param numberOfSamples Number of sample to sample for this window
* @param buffer Buffer with sampled data
*/
virtual int getSampledWindow (unsigned int freqMS, unsigned int numberOfSamples, uint16_t * buffer);
/**
* Given sampled buffer this method will return TRUE/FALSE if threshold
* was reached
* Given the sampled buffer, this method returns TRUE/FALSE if the threshold
* is reached
*
* @param ctx threshold context
* @param threshold sample threshold
* @param buffer buffer with samples
* @param len buffer length
* @param ctx Threshold context
* @param threshold Sample threshold
* @param buffer Buffer with samples
* @param len Buffer length
*/
virtual int findThreshold (thresholdContext* ctx, unsigned int threshold, uint16_t * buffer, unsigned int len);
/**
* Return average data for the sampled window
* Returns average data for the sampled window
*
* @param ctx threshold context
* @param ctx Threshold context
*/
virtual int getSampledData (thresholdContext* ctx);
/**
* Return one sample from the sensor
* Returns one sample from the sensor
*
* @param ctx threshold context
* @param ctx Threshold context
*/
virtual int getSample ();
/**
*
* Print running average of threshold context
* Prints a running average of the threshold context
*
* @param ctx threshold context
* @param ctx Threshold context
*/
virtual void printGraph (thresholdContext* ctx, uint8_t resolution);

12
src/gas/mq2.h
View File

@ -37,12 +37,12 @@ namespace upm {
* @con analog
* @kit hak
*
* @brief API for MQ2 Gas Sensor
* @brief API for the Grove MQ2 Gas Sensor
*
* The Grove - Gas Sensor (MQ2) module is useful for gas leakage detecting
* The Grove MQ2 Gas Sensor module is useful for gas leakage detection
* (in home and industry). It can detect LPG, i-butane, methane, alcohol,
* Hydrogen, smoke and other combustible gases. It's a medium sensitivity
* sensor with a detect concentration of 300-10000 ppm.
* hydrogen, smoke, and other combustible gases. It's a medium-sensitivity
* sensor with a detection range of 300-10,000 ppm.
*
* @image html mq2-5.jpeg
* @snippet mq2.cxx Interesting
@ -52,7 +52,7 @@ namespace upm {
/**
* MQ2 constructor
*
* @param gasPin analog pin where sensor is connected
* @param gasPin Analog pin where the sensor is connected
*/
MQ2 (int gasPin);
@ -62,7 +62,7 @@ namespace upm {
~MQ2 ();
/**
* Return name of the component
* Returns the name of the sensor
*/
std::string name()
{

12
src/gas/mq3.h
View File

@ -36,12 +36,12 @@ namespace upm {
* @man seeed
* @con analog
*
* @brief API for MQ3 Gas Sensor
* @brief API for the MQ3 Gas Sensor
*
* The Grove MQ3 Gas Sensor module is useful for gas leakage detecting (in
* home and industry). It can detect Alcohol Vapour and Benzine. It's
* The Grove MQ3 Gas Sensor module is useful for gas leakage detection (in
* home and industry). It can detect alcohol vapors and benzine. It's
* highly sensitive but has a long warm-up time of about 1 minute. It's
* detect rate is of 0.04-4 mg/L Alcohol.
* detection range is 0.04-4 mg/L Alcohol.
*
* @image html mq3-9.jpeg
* @snippet mq3.cxx Interesting
@ -51,7 +51,7 @@ namespace upm {
/**
* MQ3 constructor
*
* @param gasPin analog pin where sensor is connected
* @param gasPin Analog pin where the sensor is connected
*/
MQ3 (int gasPin);
@ -61,7 +61,7 @@ namespace upm {
~MQ3 ();
/**
* Return name of the component
* Returns the name of the sensor
*/
std::string name()
{

14
src/gas/mq5.h
View File

@ -37,12 +37,12 @@ namespace upm {
* @con analog
* @kit eak
*
* @brief API for MQ5 Gas Sensor
* @brief API for the MQ5 Gas Sensor
*
* The Grove - Gas Sensor (MQ5) module is useful for gas leakage detecting
* (in home and industry). It can detect LPG, natural gas, town gas and so
* on. It is highly sensitive and has a detection concentration of
* 300-10000 ppm.
* The Grove MQ5 Gas Sensor module is useful for gas leakage detection
* (in home and industry). It can detect LPG, natural gas, town gas, and so
* on. It is highly sensitive and has a detection range of
* 300-10,000 ppm.
*
* @image html mq2-5.jpeg
* @snippet mq5.cxx Interesting
@ -52,7 +52,7 @@ namespace upm {
/**
* MQ5 constructor
*
* @param gasPin analog pin where sensor is connected
* @param gasPin Analog pin where the sensor is connected
*/
MQ5 (int gasPin);
@ -62,7 +62,7 @@ namespace upm {
~MQ5 ();
/**
* Return name of the component
* Returns the name of the sensor
*/
std::string name()
{

14
src/gas/mq9.h
View File

@ -36,11 +36,11 @@ namespace upm {
* @man seeed
* @con analog
*
* @brief API for MQ9 Gas Sensor
* @brief API for the MQ9 Gas Sensor
*
* The Grove MQ9 Gas Sensor module is useful for gas leakage detecting (in
* home and industry). It can detect Carbon Monoxide, Coal Gas and
* Liquefied Gas. It's sensitivity is 10-1000 ppm CO, 100-10000 ppm Gas.
* The Grove MQ9 Gas Sensor module is useful for gas leakage detection (in
* home and industry). It can detect carbon monoxide, coal gas, and
* liquefied gas. Its sensitivity is 10-1,000 ppm CO, and 100-10,000 ppm Gas.
*
* @image html mq3-9.jpeg
* @snippet mq9.cxx Interesting
@ -48,9 +48,9 @@ namespace upm {
class MQ9 : public Gas {
public:
/**
* Jhd1313m1 constructor
* MQ9 constructor
*
* @param gasPin analog pin where sensor is connected
* @param gasPin Analog pin where the sensor is connected
*/
MQ9 (int gasPin);
@ -60,7 +60,7 @@ namespace upm {
~MQ9 ();
/**
* Return name of the component
* Returns the name of the sensor
*/
std::string name()
{

20
src/gas/tp401.h
View File

@ -38,14 +38,14 @@ namespace upm {
* @con analog
* @kit hak
*
* @brief API for Grove TP401 Air Quality Sensor
* @brief API for the Grove TP401 Air Quality Sensor
*
* The Grove TP401 Air Quality Sensor module is useful for monitoring air purity indoors.
* It can detect CO and a wide range of other harmful gases, but due to limited sensing
* range should be used only when qualitative results are needed. Example applications
* It can detect CO and a wide range of other harmful gases, but, due to a limited detection
* range, it should be used only when qualitative results are needed. Example applications
* are air recirculation, ventilation systems, and refreshing sprayers.
* The sensor is linear and should be roughly sensitive to 0 ~ 20 ppm CO from 0 ~ 4V.
* Also note that the sensor requires 2-3 minutes to warm up initially and 48 hours of
* The sensor is linear and should be roughly sensitive to 0-20 ppm CO from 0-4 V.
* Note: the sensor requires 2-3 minutes to warm up initially and 48 hours of
* operation to stabilize completely.
*
* @image html tp401.jpeg
@ -56,7 +56,7 @@ namespace upm {
/**
* TP401 constructor
*
* @param gasPin analog pin where sensor was connected
* @param gasPin Analog pin where the sensor is connected
*/
TP401 (int gasPin);
@ -66,9 +66,9 @@ namespace upm {
~TP401 ();
/**
* Return name of the component
* Returns the name of the sensor
*
* @return a string with the name of the sensor
* @return Name of the sensor
*/
std::string name()
{
@ -77,9 +77,9 @@ namespace upm {
/**
* Returns one sample in parts per million (ppm) of CO in the air based on
* the following sensor calibration: 0 ~ 4V is roughly 0 ~ 20 ppm CO
* the following sensor calibration: 0-4 V is roughly 0-20 ppm CO
*
* @return a new sample converted to ppm CO
* @return New sample converted to ppm CO
*/
float getPPM();