diff options
Diffstat (limited to 'peripheral/libupm/src/flex/flex.h')
-rw-r--r-- | peripheral/libupm/src/flex/flex.h | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/peripheral/libupm/src/flex/flex.h b/peripheral/libupm/src/flex/flex.h new file mode 100644 index 0000000..7ac4ad1 --- /dev/null +++ b/peripheral/libupm/src/flex/flex.h @@ -0,0 +1,81 @@ +/* + * 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 Spectra Symbol Flex Sensor library + * @defgroup flex libupm-flex + * @ingroup sparkfun analog flexfor + */ + + /** + * @library flex + * @sensor flex + * @comname Flex Sensor + * @type flexfor + * @man sparkfun + * @web https://www.sparkfun.com/products/8606 + * @con analog + * + * @brief API for the Spectra Symbol Flex Sensor + * + * A simple flex sensor. The resistance across the sensor increases when + * flexed. Patented technology by Spectra Symbol, these sensors were used in + * the original Nintendo* Power Glove. + * + * @image html flex.jpg + * <br><em>Flex Sensor image provided by SparkFun* under + * <a href=https://creativecommons.org/licenses/by-nc-sa/3.0/> + * CC BY-NC-SA-3.0</a>.</em> + * + * @snippet flex.cxx Interesting + */ + class Flex { + public: + /** + * Flex sensor constructor + * + * @param pin Analog pin to use + */ + Flex(int pin); + /** + * Flex sensor destructor + */ + ~Flex(); + /** + * @return Analog flex value + */ + int value(); + + private: + mraa_aio_context m_aio; + }; +} + + |