Home | History | Annotate | Download | only in guvas12d 
      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/aio.h>
     28 
     29 namespace upm {
     30   /**
     31    * @brief GUVA-S12D UV sensor library
     32    * @defgroup guvas12d libupm-guvas12d
     33    * @ingroup seeed analog light eak
     34    */
     35 
     36   /**
     37    * @library guvas12d
     38    * @sensor guvas12d
     39    * @comname Grove UV Sensor
     40    * @altname GUVA-S12D UV Sensor
     41    * @type light
     42    * @man seeed
     43    * @con analog
     44    * @kit eak
     45    *
     46    * @brief API for the GUVA-S12D UV Sensor
     47    *
     48    * UPM module for the GUVA-S12D UV sensor
     49    *
     50    * @image html guvas12d.jpg
     51    * @snippet guvas12d.cxx Interesting
     52    */
     53   class GUVAS12D {
     54   public:
     55     /**
     56      * GUVA-S12D UV sensor constructor
     57      *
     58      * @param pin Analog pin to use
     59      */
     60     GUVAS12D(int pin);
     61     /**
     62      * GUVAS12D destructor
     63      */
     64     ~GUVAS12D();
     65     /**
     66      * Gets the average voltage value from the sensor
     67      *
     68      * @param aref Reference voltage in use (usually 5.0 V or 3.3 V)
     69      * @param samples Number of samples to average over
     70      * @return Average voltage reading
     71      */
     72     float value(float aref, unsigned int samples);
     73 
     74   private:
     75     mraa_aio_context m_aio;
     76   };
     77 }
     78