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 mq2
34    * @comname Grove MQ2 Gas Sensor
35    * @type gaseous
36    * @man seeed
37    * @con analog
38    * @kit hak
39    *
40    * @brief API for the Grove MQ2 Gas Sensor
41    *
42    * The Grove MQ2 Gas Sensor module is useful for gas leakage detection
43    * (in home and industry). It can detect LPG, i-butane, methane, alcohol,
44    * hydrogen, smoke, and other combustible gases. It's a medium-sensitivity
45    * sensor with a detection range of 300-10,000 ppm.
46    *
47    * @image html mq2-5.jpeg
48    * @snippet mq2.cxx Interesting
49    */
50     class MQ2 : public Gas {
51         public:
52             /**
53              * MQ2 constructor
54              *
55              * @param gasPin Analog pin where the sensor is connected
56              */
57             MQ2 (int gasPin);
58 
59             /**
60              * MQ2 destructor
61              */
62             ~MQ2 ();
63 
64             /**
65              * Returns the name of the sensor
66              */
name()67             std::string name()
68             {
69                 return m_name;
70             }
71         private:
72             std::string m_name;
73     };
74 }
75