src/gas/mq3.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 MQ3 gas sensor
  33      *
  34      * The Grove MQ3 Gas Sensor module is useful for gas leakage detecting (in
  35      * home and industry). It can detect Alcohol Vapour and Benzine. It's
  36      * highly sensitive but has a long warmup time of about 1minute. It's
  37      * detect rate is of 0.04-4mg/L Alcohol.
  38      *
  39      * @snippet mq3-example.cxx Interesting
  40      * @image html grovegas.jpeg
  41      */
  42     class MQ3 : public Gas {
  43         public:
  44             /**
  45              * MQ3 constructor
  46              *
  47              * @param gasPin analog pin where sensor connected
  48              */
  49             MQ3 (int gasPin);
  50
  51             /**
  52              * MQ3 destructor
  53              */
  54             ~MQ3 ();
  55
  56             /**
  57              * Return name of the component
  58              */
  59             std::string name()
  60             {
  61                 return m_name;
  62             }
  63         private:
  64             std::string m_name;
  65     };
  66 }