1 /*
2  * Author: Zion Orent <zorent@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 EMG Muscle Signal Reader library
32    * @defgroup groveemg libupm-groveemg
33    * @ingroup seeed analog electric
34    */
35 
36   /**
37    * @library groveemg
38    * @sensor groveemg
39    * @comname Grove EMG Sensor
40    * @type electric
41    * @man seeed
42    * @con analog
43    *
44    * @brief API for the Grove EMG Muscle Signal Reader
45    *
46    * Grove EMG muscle signal reader gathers small muscle signals,
47    * then processes them, and returns the result
48    *
49    * @image html groveemg.jpg
50    * @snippet groveemg.cxx Interesting
51    */
52   class GroveEMG {
53   public:
54     /**
55      * Grove EMG reader constructor
56      *
57      * @param pin Analog pin to use
58      */
59     GroveEMG(int pin);
60     /**
61      * GroveEMG destructor
62      */
63     ~GroveEMG();
64 
65     /**
66      * Calibrates the Grove EMG reader
67      */
68     void calibrate();
69 
70     /**
71      * Measures muscle signals from the reader
72      *
73      * @return Muscle output as analog voltage
74      */
75     int value();
76 
77   private:
78     mraa_aio_context m_aio;
79   };
80 }
81 
82 
83