1 /*
2  * Author: Brendan Le Foll <brendan.le.foll@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 mq9
34    * @comname Grove MQ9 Gas Sensor
35    * @type gaseous
36    * @man seeed
37    * @con analog
38    *
39    * @brief API for the MQ9 Gas Sensor
40    *
41    * The Grove MQ9 Gas Sensor module is useful for gas leakage detection (in
42    * home and industry). It can detect carbon monoxide, coal gas, and
43    * liquefied gas. Its sensitivity is 10-1,000 ppm CO, and 100-10,000 ppm Gas.
44    *
45    * @image html mq3-9.jpeg
46    * @snippet mq9.cxx Interesting
47    */
48     class MQ9 : public Gas {
49         public:
50             /**
51              * MQ9 constructor
52              *
53              * @param gasPin Analog pin where the sensor is connected
54              */
55             MQ9 (int gasPin);
56 
57             /**
58              * MQ9 destructor
59              */
60             ~MQ9 ();
61 
62             /**
63              * Returns the name of the sensor
64              */
name()65             std::string name()
66             {
67                 return m_name;
68             }
69         private:
70             std::string m_name;
71     };
72 }
73