1 /*
2  * Author: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
3  * Copyright (c) 2014 Intel Corporation.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining
6  * a copy of this software and associated documentation files (the
7  * "Software"), to deal in the Software without restriction, including
8  * without limitation the rights to use, copy, modify, merge, publish,
9  * distribute, sublicense, and/or sell copies of the Software, and to
10  * permit persons to whom the Software is furnished to do so, subject to
11  * the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 #pragma once
25 
26 #include <iostream>
27 #include <string>
28 #include "gas.h"
29 
30 namespace upm {
31   /**
32    * @library gas
33    * @sensor tp401
34    * @comname Grove Air Quality Sensor
35    * @altname TP401 Gas Sensor
36    * @type gaseous
37    * @man seeed
38    * @con analog
39    * @kit hak
40    *
41    * @brief API for the Grove TP401 Air Quality Sensor
42    *
43    * The Grove TP401 Air Quality Sensor module is useful for monitoring air purity indoors.
44    * It can detect CO and a wide range of other harmful gases, but, due to a limited detection
45    * range, it should be used only when qualitative results are needed. Example applications
46    * are air recirculation, ventilation systems, and refreshing sprayers.
47    * The sensor is linear and should be roughly sensitive to 0-20 ppm CO from 0-4 V.
48    * Note: the sensor requires 2-3 minutes to warm up initially and 48 hours of
49    * operation to stabilize completely.
50    *
51    * @image html tp401.jpeg
52    * @snippet tp401.cxx Interesting
53    */
54     class TP401 : public Gas {
55         public:
56             /**
57              * TP401 constructor
58              *
59              * @param gasPin Analog pin where the sensor is connected
60              */
61             TP401 (int gasPin);
62 
63             /**
64              * TP401 destructor
65              */
66             ~TP401 ();
67 
68             /**
69              * Returns the name of the sensor
70              *
71              * @return Name of the sensor
72              */
name()73             std::string name()
74             {
75                 return m_name;
76             }
77 
78             /**
79              * Returns one sample in parts per million (ppm) of CO in the air based on
80              * the following sensor calibration: 0-4 V is roughly 0-20 ppm CO
81              *
82              * @return  New sample converted to ppm CO
83              */
84             float getPPM();
85 
86         private:
87             std::string m_name;
88     };
89 }
90