upm/src/grovegsr/grovegsr.h
Mihai Tudor Panu 687f0188ca grovegsr: header updated with new tags
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2015-04-09 16:58:11 -07:00

84 lines
2.3 KiB
C++

/*
* Author: Zion Orent <zorent@ics.com>
* Copyright (c) 2015 Intel Corporation.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#pragma once
#include <string>
#include <mraa/aio.h>
namespace upm {
/**
* @brief UPM library for the GroveGSR Galvanic Skin Response Sensor
* @defgroup grovegsr libupm-grovegsr
* @ingroup seeed analog electric
*/
/**
* @library grovegsr
* @sensor grovegsr
* @comname Grove GSR Sensor
* @type electric
* @man seeed
* @con analog
*
* @brief C++ API for the GroveGSR Galvanic Skin Response Sensor
*
* Measure the electrical conductance of skin in order
* to measure strong emotional reaction.
* In other words, it measures sweat on your fingers
* as an indicator of strong emotional reactions.
*
* @snippet grovegsr.cxx Interesting
*/
class GroveGSR {
public:
/**
* GroveGSR sensor constructor
*
* @param pin analog pin to use
*/
GroveGSR(int pin);
/**
* GroveGSR Destructor
*/
~GroveGSR();
/**
* Calibrate the GroveGSR Sensor
*/
void calibrate();
/**
* Measure the electrical conductance of the skin from the sensor
*
* @return the electrical conductance of the skin
*/
int value();
private:
mraa_aio_context m_aio;
};
}