upm/src/groveemg/groveemg.hpp
Serban Waltter b0df70ca03 Added getVolts() to iEMG interface and its sensors.
Signed-off-by: Serban Waltter <serban.waltter@rinftech.com>
2018-10-11 17:54:55 +03:00

92 lines
2.6 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>
#include "interfaces/iEmg.hpp"
namespace upm {
/**
* @deprecated This library is being replaced by libupm-emg
* @brief Grove EMG Muscle Signal Reader
* @defgroup groveemg libupm-groveemg
* @ingroup seeed analog electric
*/
/**
* @deprecated This class is being replaced by EMG
* @library groveemg
* @sensor groveemg
* @comname Electromyography (EMG) Sensor
* @type electric
* @man seeed
* @con analog
*
* @brief API for the Grove EMG Muscle Signal Reader
*
* Grove EMG muscle signal reader gathers small muscle signals,
* then processes them, and returns the result
*
* @image html emg.jpg
* @snippet groveemg.cxx Interesting
*/
class GroveEMG : virtual public iEmg {
public:
/**
* Grove EMG reader constructor
*
* @param pin Analog pin to use
*/
GroveEMG(int pin);
/**
* GroveEMG destructor
*/
~GroveEMG();
/**
* Calibrates the Grove EMG reader
*/
virtual void calibrate();
/**
* Measures muscle signals from the reader
*
* @return Muscle output as analog voltage
*/
virtual int value();
virtual float getVolts();
private:
mraa_aio_context m_aio;
/* Analog voltage reference */
float m_aRef = 5.0;
/* Scale */
float m_scale = 1.0;
/* Offset in sensor units */
float m_offset = 0.0;
};
}