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   /**
32    * @brief Spectra Symbol Flex Sensor library
33    * @defgroup flex libupm-flex
34    * @ingroup sparkfun analog flexfor
35    */
36 
37   /**
38    * @library flex
39    * @sensor flex
40    * @comname Flex Sensor
41    * @type flexfor
42    * @man sparkfun
43    * @web https://www.sparkfun.com/products/8606
44    * @con analog
45    *
46    * @brief API for the Spectra Symbol Flex Sensor
47    *
48    * A simple flex sensor. The resistance across the sensor increases when
49    * flexed. Patented technology by Spectra Symbol, these sensors were used in
50    * the original Nintendo* Power Glove.
51    *
52    * @image html flex.jpg
53    * <br><em>Flex Sensor image provided by SparkFun* under
54    * <a href=https://creativecommons.org/licenses/by-nc-sa/3.0/>
55    * CC BY-NC-SA-3.0</a>.</em>
56    *
57    * @snippet flex.cxx Interesting
58    */
59   class Flex {
60   public:
61     /**
62      * Flex sensor constructor
63      *
64      * @param pin Analog pin to use
65      */
66     Flex(int pin);
67     /**
68      * Flex sensor destructor
69      */
70     ~Flex();
71     /**
72      * @return Analog flex value
73      */
74     int value();
75 
76   private:
77     mraa_aio_context m_aio;
78   };
79 }
80 
81 
82