src/gas/mq9.h

   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      * @brief C++ API for MQ9 gas sensor
  33      *
  34      * The Grove MQ9 Gas Sensor module is useful for gas leakage detecting (in
  35      * home and industry). It can detect Carbon Monoxide, Coal Gas and
  36      * Liquefied Gas. It's sensitivty is 10-1000ppmCO 100-10000PPm Gas.
  37      *
  38      * @snippet mq9-example.cxx Interesting
  39      * @image html mq9.jpeg
  40      */
  41     class MQ9 : public Gas {
  42         public:
  43             /**
  44              * Jhd1313m1 constructor
  45              *
  46              * @param gasPin analog pin where sensor connected
  47              */
  48             MQ9 (int gasPin);
  49
  50             /**
  51              * MQ9 destructor
  52              */
  53             ~MQ9 ();
  54
  55             /**
  56              * Return name of the component
  57              */
  58             std::string name()
  59             {
  60                 return m_name;
  61             }
  62         private:
  63             std::string m_name;
  64     };
  65 }