Home | History | Annotate | Download | only in grovegsr 
      1 /*
      2  * Author: Zion Orent <zorent (at) 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 <string>
     27 #include <mraa/aio.h>
     28 
     29 namespace upm {
     30   /**
     31    * @brief Grove GSR Galvanic Skin Response Sensor library
     32    * @defgroup grovegsr libupm-grovegsr
     33    * @ingroup seeed analog electric
     34    */
     35 
     36   /**
     37    * @library grovegsr
     38    * @sensor grovegsr
     39    * @comname Grove GSR Sensor
     40    * @type electric
     41    * @man seeed
     42    * @con analog
     43    *
     44    * @brief API for the Grove GSR Galvanic Skin Response Sensor
     45    *
     46    * Measures the electrical conductance of skin
     47    * to measure strong emotional reactions.
     48    * In other words, it measures sweat on your fingers
     49    * as an indicator of strong emotional reactions.
     50    *
     51    * @image html grovegsr.jpg
     52    * @snippet grovegsr.cxx Interesting
     53    */
     54   class GroveGSR {
     55   public:
     56     /**
     57      * Grove GSR sensor constructor
     58      *
     59      * @param pin Analog pin to use
     60      */
     61     GroveGSR(int pin);
     62     /**
     63      * GroveGSR destructor
     64      */
     65     ~GroveGSR();
     66 
     67     /**
     68      * Calibrates the Grove GSR sensor
     69      */
     70     void calibrate();
     71 
     72     /**
     73      * Gets the electrical conductance of the skin from the sensor
     74      *
     75      * @return Electrical conductance of the skin
     76      */
     77     int value();
     78 
     79   private:
     80     mraa_aio_context m_aio;
     81   };
     82 }
     83 
     84 
     85