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: updated library descriptions and sensor names for consistency

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
2015-06-01 15:44:07 -07:00
parent 8965d56c93
commit 14f80e779e
97 changed files with 237 additions and 246 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/gas/gas.h
View File

@ -35,7 +35,7 @@ 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.

4
src/gas/mq2.h
View File

@ -31,12 +31,12 @@ namespace upm {
/**
* @library gas
* @sensor mq2
* @comname Grove MQ2 gas sensor
* @comname Grove MQ2 Gas Sensor
* @type gaseous
* @man seeed
* @con analog
*
* @brief API for MQ2 gas sensor
* @brief API for MQ2 Gas Sensor
*
* The Grove - Gas Sensor (MQ2) module is useful for gas leakage detecting
* (in home and industry). It can detect LPG, i-butane, methane, alcohol,

4
src/gas/mq3.h
View File

@ -31,12 +31,12 @@ namespace upm {
/**
* @library gas
* @sensor mq3
* @comname Grove MQ3 gas sensor
* @comname Grove MQ3 Gas Sensor
* @type gaseous
* @man seeed
* @con analog
*
* @brief API for MQ3 gas sensor
* @brief API for 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

4
src/gas/mq5.h
View File

@ -31,12 +31,12 @@ namespace upm {
/**
* @library gas
* @sensor mq5
* @comname Grove MQ5 gas sensor
* @comname Grove MQ5 Gas Sensor
* @type gaseous
* @man seeed
* @con analog
*
* @brief API for MQ5 gas sensor
* @brief API for 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

4
src/gas/mq9.h
View File

@ -31,12 +31,12 @@ namespace upm {
/**
* @library gas
* @sensor mq9
* @comname Grove MQ9 gas sensor
* @comname Grove MQ9 Gas Sensor
* @type gaseous
* @man seeed
* @con analog
*
* @brief API for MQ9 gas sensor
* @brief API for 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

2
src/gas/tp401.h
View File

@ -32,7 +32,7 @@ namespace upm {
* @library gas
* @sensor tp401
* @comname Grove Air Quality Sensor
* @altname TP401
* @altname TP401 Gas Sensor
* @type gaseous
* @man seeed
* @con analog