From 317ad35180356655d48d80a1a24d350c9949280b Mon Sep 17 00:00:00 2001 From: Zion Orent Date: Thu, 12 Mar 2015 13:11:22 -0400 Subject: [PATCH] flex: initial implementation Implements the flex analog sensor. See http://bildr.org/2012/11/flex-sensor-arduino/ for wiring instructions. Signed-off-by: Zion Orent Signed-off-by: Jon Trulson Signed-off-by: John Van Drasek --- examples/c++/CMakeLists.txt | 3 ++ examples/c++/flex.cxx | 66 ++++++++++++++++++++++++++++++++++ examples/javascript/flex.js | 53 +++++++++++++++++++++++++++ src/flex/CMakeLists.txt | 5 +++ src/flex/flex.cxx | 49 +++++++++++++++++++++++++ src/flex/flex.h | 71 +++++++++++++++++++++++++++++++++++++ src/flex/jsupm_flex.i | 8 +++++ src/flex/pyupm_flex.i | 9 +++++ 8 files changed, 264 insertions(+) create mode 100644 examples/c++/flex.cxx create mode 100644 examples/javascript/flex.js create mode 100644 src/flex/CMakeLists.txt create mode 100644 src/flex/flex.cxx create mode 100644 src/flex/flex.h create mode 100644 src/flex/jsupm_flex.i create mode 100644 src/flex/pyupm_flex.i diff --git a/examples/c++/CMakeLists.txt b/examples/c++/CMakeLists.txt index e8f1f180..0f2bb4e0 100644 --- a/examples/c++/CMakeLists.txt +++ b/examples/c++/CMakeLists.txt @@ -103,6 +103,7 @@ add_executable (adafruitss-example adafruitss.cxx) add_executable (adafruitms1438-example adafruitms1438.cxx) add_executable (adafruitms1438-stepper-example adafruitms1438-stepper.cxx) add_executable (hx711-example hx711.cxx) +add_executable (flex-example flex.cxx) include_directories (${PROJECT_SOURCE_DIR}/src/hmc5883l) include_directories (${PROJECT_SOURCE_DIR}/src/grove) @@ -186,6 +187,7 @@ include_directories (${PROJECT_SOURCE_DIR}/src/groveeldriver) include_directories (${PROJECT_SOURCE_DIR}/src/adafruitss) include_directories (${PROJECT_SOURCE_DIR}/src/adafruitms1438) include_directories (${PROJECT_SOURCE_DIR}/src/hx711) +include_directories (${PROJECT_SOURCE_DIR}/src/flex) target_link_libraries (hmc5883l-example hmc5883l ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (groveled-example grove ${CMAKE_THREAD_LIBS_INIT}) @@ -290,3 +292,4 @@ target_link_libraries (adafruitss-example adafruitss ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (adafruitms1438-example adafruitms1438 ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (adafruitms1438-stepper-example adafruitms1438 ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (hx711-example hx711 ${CMAKE_THREAD_LIBS_INIT}) +target_link_libraries (flex-example flex ${CMAKE_THREAD_LIBS_INIT}) diff --git a/examples/c++/flex.cxx b/examples/c++/flex.cxx new file mode 100644 index 00000000..54773389 --- /dev/null +++ b/examples/c++/flex.cxx @@ -0,0 +1,66 @@ +/* + * Author: Zion Orent + * 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. + */ + +#include +#include +#include +#include "flex.h" + +using namespace std; + +bool shouldRun = true; + +void sig_handler(int signo) +{ + if (signo == SIGINT) + shouldRun = false; +} + +int main() +{ + signal(SIGINT, sig_handler); + +//! [Interesting] + // The was tested with a Spectra Symbol flex sensor. + // We attached a 22K resistor to a breadboard, + // with 1 end attached to GND and the other connected to + // both the flex sensor and A0. + // The flex sensor was connected on 1 pin to the 22K resistor and A0 + // and on the other pin to 5V. + + // Instantiate a Flex sensor on analog pin A0 + upm::Flex *flex = new upm::Flex(0); + + while (shouldRun) + { + cout << "Flex value: " << flex->value() << endl; + sleep(1); + } +//! [Interesting] + + cout << "Exiting" << endl; + + delete flex; + return 0; +} diff --git a/examples/javascript/flex.js b/examples/javascript/flex.js new file mode 100644 index 00000000..73c6ee09 --- /dev/null +++ b/examples/javascript/flex.js @@ -0,0 +1,53 @@ +/*jslint node:true, vars:true, bitwise:true, unparam:true */ +/*jshint unused:true */ +/* +* Author: Zion Orent +* 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. +*/ +var flexSensor_lib = require('jsupm_flex'); + +// The was tested with a Spectra Symbol flex sensor. +// We attached a 22K resistor to a breadboard, +// with 1 end attached to GND and the other connected to +// both the flex sensor and A0. +// The flex sensor was connected on 1 pin to the 22K resistor and A0 +// and on the other pin to 5V. + +// Instantiate a UV sensor on analog pin A0 +var myFlexSensor_obj = new flexSensor_lib.Flex(0); + +var myInterval = setInterval(function() +{ + var outputStr = "Flex value: " + myFlexSensor_obj.value(); + console.log(outputStr); +}, 1000); + +// Print message when exiting +process.on('SIGINT', function() +{ + clearInterval(myInterval); + myFlexSensor_obj = null; + flexSensor_lib.cleanUp(); + flexSensor_lib = null; + console.log("Exiting"); + process.exit(0); +}); diff --git a/src/flex/CMakeLists.txt b/src/flex/CMakeLists.txt new file mode 100644 index 00000000..57692812 --- /dev/null +++ b/src/flex/CMakeLists.txt @@ -0,0 +1,5 @@ +set (libname "flex") +set (libdescription "upm flex sensor module") +set (module_src ${libname}.cxx) +set (module_h ${libname}.h) +upm_module_init() diff --git a/src/flex/flex.cxx b/src/flex/flex.cxx new file mode 100644 index 00000000..fcf763a5 --- /dev/null +++ b/src/flex/flex.cxx @@ -0,0 +1,49 @@ +/* + * Author: Zion Orent + * 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. + */ + +#include + +#include "flex.h" + +using namespace upm; +using namespace std; + +Flex::Flex(int pin) +{ + if ( !(m_aio = mraa_aio_init(pin)) ) + { + cerr << __FUNCTION__ << ": mraa_aio_init() failed" << endl; + return; + } +} + +Flex::~Flex() +{ + mraa_aio_close(m_aio); +} + +int Flex::value() +{ + return mraa_aio_read(m_aio); +} diff --git a/src/flex/flex.h b/src/flex/flex.h new file mode 100644 index 00000000..b7d44220 --- /dev/null +++ b/src/flex/flex.h @@ -0,0 +1,71 @@ +/* + * Author: Zion Orent + * 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 +#include + +namespace upm { + + /** + * @brief UPM module for the Spectra Symbol Flex sensor + * @defgroup flex libupm-flex + * @ingroup sparkfun analog flex + */ + + /** + * @sensor flex + * @library flex + * @name Spectra Symbol Flex sensor + * @category flex + * @manufacturer sparkfun + * @connection analog + * + * @brief C++ API for the Spectra Symbol Flex sensor + * + * @snippet flex.cxx Interesting + */ + class Flex { + public: + /** + * Flex sensor constructor + * + * @param pin analog pin to use + */ + Flex(int pin); + /** + * Flex Destructor + */ + ~Flex(); + /** + * @return the analog flex value + */ + int value(); + + private: + mraa_aio_context m_aio; + }; +} + + diff --git a/src/flex/jsupm_flex.i b/src/flex/jsupm_flex.i new file mode 100644 index 00000000..12c45f3e --- /dev/null +++ b/src/flex/jsupm_flex.i @@ -0,0 +1,8 @@ +%module jsupm_flex +%include "../upm.i" + +%{ + #include "flex.h" +%} + +%include "flex.h" diff --git a/src/flex/pyupm_flex.i b/src/flex/pyupm_flex.i new file mode 100644 index 00000000..de1c0c72 --- /dev/null +++ b/src/flex/pyupm_flex.i @@ -0,0 +1,9 @@ +%module pyupm_flex +%include "../upm.i" + +%feature("autodoc", "3"); + +%include "flex.h" +%{ + #include "flex.h" +%}