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

doc: Scrubbed ALL sensor library descriptions

Browse Source 
In an effort to clean-up and standardize UPM library
documentation, this commit updates (and in most cases,
unifies) the CMake description string AND CXX header
@comname string.

Strings were taken from datasheets when possible, spelling
mistakes were addressed, copy/paste errors where fixed,
Title Case was used, etc.

    * Tested/updated/added @web tags
    * Added/updated invalid sensor images
    * Added/updated @man tags, added missing manufacturers

Signed-off-by: Noel Eck <noel.eck@intel.com>
This commit is contained in:
Noel Eck
2016-12-15 15:15:21 -08:00
parent 7a5c8a6cb3
commit 283fce619e
416 changed files with 793 additions and 675 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/gas/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME gas
DESCRIPTION "Generic gas detection sensor library"
DESCRIPTION "Generic Gas Detection Sensor Library"
C_HDR mqx.h
C_SRC mqx.c
CPP_HDR gas.hpp mq2.hpp mq3.hpp mq4.hpp mq5.hpp mq6.hpp mq7.hpp mq8.hpp mq9.hpp tp401.hpp

3
src/gas/mq2.hpp
View File

@ -31,11 +31,12 @@ namespace upm {
/**
* @library gas
* @sensor mq2
* @comname Grove MQ2 Gas Sensor
* @comname MQ2 Methane, Butane, Liquefied Petroleum Gas (LPG), and Smoke Sensor
* @type gaseous
* @man seeed
* @con analog
* @kit hak
* @web http://wiki.seeed.cc/Grove-Gas_Sensor-MQ2/
*
* @brief API for the Grove MQ2 Gas Sensor
*

3
src/gas/mq3.hpp
View File

@ -31,10 +31,11 @@ namespace upm {
/**
* @library gas
* @sensor mq3
* @comname Grove MQ3 Gas Sensor
* @comname MQ3 Alcohol, Ethanol, Smoke Sensor
* @type gaseous
* @man seeed
* @con analog
* @web http://wiki.seeed.cc/Grove-Gas_Sensor-MQ3/
*
* @brief API for the MQ3 Gas Sensor
*

3
src/gas/mq4.hpp
View File

@ -31,10 +31,11 @@ namespace upm {
/**
* @library gas
* @sensor mq4
* @comname DFRobot MQ4 Gas Sensor
* @comname MQ4 Methane and Connecticut Natural Gas (CNG) Sensor
* @type gaseous
* @man dfrobot
* @con analog
* @web https://www.dfrobot.com/index.php?route=product/product&product_id=683
*
* @brief API for the DFRobot MQ4 Gas Sensor
*

3
src/gas/mq5.hpp
View File

@ -31,10 +31,11 @@ namespace upm {
/**
* @library gas
* @sensor mq5
* @comname Grove MQ5 Gas Sensor
* @comname MQ5 Natural Gas and Liquefied Petroleum Gas (LPG) Sensor
* @type gaseous
* @man seeed
* @con analog
* @web http://wiki.seeed.cc/Grove-Gas_Sensor-MQ5/
* @kit eak
*
* @brief API for the MQ5 Gas Sensor

3
src/gas/mq6.hpp
View File

@ -31,10 +31,11 @@ namespace upm {
/**
* @library gas
* @sensor mq6
* @comname DFRobot MQ6 LPG Gas Sensor
* @comname MQ6 Liquefied Petroleum Gas (LPG) and Butane Sensor
* @type gaseous
* @man dfrobot
* @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
*

3
src/gas/mq7.hpp
View File

@ -31,10 +31,11 @@ namespace upm {
/**
* @library gas
* @sensor mq7
* @comname DFRobot MQ7 CO Gas Sensor
* @comname MQ7 Carbon Monoxide Sensor
* @type gaseous
* @man dfrobot
* @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
*

3
src/gas/mq8.hpp
View File

@ -31,10 +31,11 @@ namespace upm {
/**
* @library gas
* @sensor mq8
* @comname DFRobot MQ8 CO Gas Sensor
* @comname MQ8 Flammable (Hydrogen) Gas Sensor
* @type gaseous
* @man dfrobot
* @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
*

3
src/gas/mq9.hpp
View File

@ -31,10 +31,11 @@ namespace upm {
/**
* @library gas
* @sensor mq9
* @comname Grove MQ9 Gas Sensor
* @comname MQ9 Carbon Monoxide (CO) and Flammable Gas Sensor
* @type gaseous
* @man seeed
* @con analog
* @web http://wiki.seeed.cc/Grove-Gas_Sensor-MQ9/
*
* @brief API for the MQ9 Gas Sensor
*

3
src/gas/tp401.hpp
View File

@ -31,11 +31,12 @@ namespace upm {
/**
* @library gas
* @sensor tp401
* @comname Grove Air Quality Sensor
* @comname Air Quality Sensor
* @altname TP401 Gas 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