Home | History | Annotate | Download | only in yg1006 
      1 /*
      2  * Author: Jon Trulson <jtrulson (at) ics.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 <string>
     27 #include <mraa/gpio.h>
     28 
     29 namespace upm {
     30     /**
     31      * @brief YG1006 Flame Sensor library
     32      * @defgroup yg1006 libupm-yg1006
     33      * @ingroup seeed gpio light hak
     34      */
     35     /**
     36      * @library yg1006
     37      * @sensor yg1006
     38      * @comname YG1006 Flame Sensor
     39      * @altname Grove Flame Sensor
     40      * @type light
     41      * @man seeed
     42      * @web http://www.seeedstudio.com/wiki/Grove_-_Flame_Sensor
     43      * @con gpio
     44      * @kit hak
     45      *
     46      * @brief API for the YG1006 Flame Sensor
     47      *
     48      *   UPM module for the YG1006 flame sensor. It detects a flame or any
     49      *   other light source in the 760-1,100 nm wavelength range.
     50      *
     51      * @image html yg1006.jpg
     52      * @snippet yg1006.cxx Interesting
     53      */
     54   class YG1006 {
     55   public:
     56     /**
     57      * YG1006 constructor
     58      *
     59      * @param pin Digital pin to use
     60      */
     61     YG1006(int pin);
     62     /**
     63      * YG1006 destructor
     64      */
     65     ~YG1006();
     66     /**
     67      * Determines whether a flame has been detected
     68      *
     69      * @return True if a flame or another comparable light source has been detected
     70      */
     71     bool flameDetected();
     72 
     73   private:
     74     mraa_gpio_context m_gpio;
     75   };
     76 }
     77 
     78 
     79