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 @param tags, added missing function descriptions, other minor changes

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
2017-04-10 16:59:39 -07:00
parent 39df7fd10f
commit 3aef2ea70e
94 changed files with 327 additions and 222 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/gas/mq2.hpp
View File

@ -38,9 +38,9 @@ namespace upm {
* @kit hak
* @web http://wiki.seeed.cc/Grove-Gas_Sensor-MQ2/
*
* @brief API for the Grove MQ2 Gas Sensor
* @brief API for the MQ2 Gas Sensor
*
* The Grove MQ2 Gas Sensor module is useful for gas leakage detection
* The 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 detection range of 300-10,000 ppm.

2
src/gas/mq3.hpp
View File

@ -39,7 +39,7 @@ namespace upm {
*
* @brief API for the MQ3 Gas Sensor
*
* The Grove MQ3 Gas Sensor module is useful for gas leakage detection (in
* The 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
* detection range is 0.04-4 mg/L Alcohol.

2
src/gas/mq4.hpp
View File

@ -37,7 +37,7 @@ namespace upm {
* @con analog
* @web https://www.dfrobot.com/index.php?route=product/product&product_id=683
*
* @brief API for the DFRobot MQ4 Gas Sensor
* @brief API for the MQ4 Gas Sensor
*
* The MQ4 Gas Sensor module is useful for detecting CH4 (Methane),
* and natural gas concentrations in the air. It has a

2
src/gas/mq5.hpp
View File

@ -40,7 +40,7 @@ namespace upm {
*
* @brief API for the MQ5 Gas Sensor
*
* The Grove MQ5 Gas Sensor module is useful for gas leakage detection
* The 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.

2
src/gas/mq6.hpp
View File

@ -37,7 +37,7 @@ namespace upm {
* @con analog
* @web https://www.dfrobot.com/wiki/index.php/LPG_Gas_Sensor(MQ6)_(SKU:SEN0131)
*
* @brief API for the DFRobot MQ6 LPG Gas Sensor
* @brief API for the MQ6 LPG Gas Sensor
*
* The MQ6 Gas Sensor module is useful for detecting LPG,
* iso-butane, propane, and LNG concentrations in the air. It has a

2
src/gas/mq7.hpp
View File

@ -37,7 +37,7 @@ namespace upm {
* @con analog
* @web https://www.dfrobot.com/wiki/index.php/Carbon_Monoxide_Gas_Sensor(MQ7)_(SKU:SEN0132)
*
* @brief API for the DFRobot MQ7 CO Gas Sensor
* @brief API for the MQ7 CO Gas Sensor
*
* The Grove MQ7 Gas Sensor module is useful for detecting Carbon
* Monoxide (CO) concentrations in the air. It has a detection

2
src/gas/mq8.hpp
View File

@ -37,7 +37,7 @@ namespace upm {
* @con analog
* @web https://www.dfrobot.com/wiki/index.php/Hydrogen_Gas_Sensor(MQ8)_(SKU:SEN0133)
*
* @brief API for the DFRobot MQ8 Hydrogen (H2) Gas Sensor
* @brief API for the MQ8 Hydrogen (H2) Gas Sensor
*
* The MQ8 Gas Sensor module is useful for detecting Hydrogen gas
* concentrations in the air. It has a detection range of 100-10000

8
src/gas/tp401.hpp
View File

@ -31,17 +31,17 @@ namespace upm {
/**
* @library gas
* @sensor tp401
* @comname Air Quality Sensor
* @altname TP401 Gas Sensor
* @comname TP401 Gas Sensor
* @altname Grove Air Quality Sensor
* @type gaseous
* @man seeed
* @con analog
* @web https://www.seeedstudio.com/Grove-Air-quality-sensor-p-1065.html
* @kit hak
*
* @brief API for the Grove TP401 Air Quality Sensor
* @brief API for the TP401 Gas Sensor
*
* The Grove TP401 Air Quality Sensor module is useful for monitoring air purity indoors.
* The TP401 Gas Sensor module is useful for monitoring air purity indoors.
* 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.