1 /*
2  * Author: Jon Trulson <jtrulson@ics.com>
3  * Copyright (c) 2015 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 mq8
34    * @comname DFRobot MQ8 CO Gas Sensor
35    * @type gaseous
36    * @man dfrobot
37    * @con analog
38    *
39    * @brief API for the DFRobot MQ8 Hydrogen (H2) Gas Sensor
40    *
41    * The MQ8 Gas Sensor module is useful for detecting Hydrogen gas
42    * concentrations in the air.  It has a detection range of 100-10000
43    * ppm.
44    *
45    * For optimum use, it requires calibration after a pre-heat time of
46    * at least 24 hours.  See the datasheet for details.
47    *
48    * @image html mq2-5.jpeg
49    * @snippet mq8.cxx Interesting
50    */
51     class MQ8 : public Gas {
52         public:
53             /**
54              * MQ8 constructor
55              *
56              * @param gasPin Analog pin where the sensor is connected
57              */
58             MQ8 (int gasPin);
59 
60             /**
61              * MQ8 destructor
62              */
63             ~MQ8 ();
64 
65             /**
66              * Returns the name of the sensor
67              */
name()68             std::string name()
69             {
70                 return m_name;
71             }
72         private:
73             std::string m_name;
74     };
75 }
76