From 276ba67583f375ba2346e8cbb74b5c170747507f Mon Sep 17 00:00:00 2001 From: Zion Orent Date: Wed, 25 Feb 2015 15:57:48 -0500 Subject: [PATCH] grovegsr: initial implementation This module implements support for the Grove GSR (Galvanic Skin Response) sensor. Signed-off-by: Zion Orent Signed-off-by: Jon Trulson Signed-off-by: John Van Drasek --- examples/c++/CMakeLists.txt | 3 ++ examples/c++/grovegsr.cxx | 63 +++++++++++++++++++++++++++ examples/javascript/grovegsr.js | 51 ++++++++++++++++++++++ src/grovegsr/CMakeLists.txt | 5 +++ src/grovegsr/grovegsr.cxx | 65 ++++++++++++++++++++++++++++ src/grovegsr/grovegsr.h | 75 +++++++++++++++++++++++++++++++++ src/grovegsr/jsupm_grovegsr.i | 8 ++++ src/grovegsr/pyupm_grovegsr.i | 9 ++++ 8 files changed, 279 insertions(+) create mode 100644 examples/c++/grovegsr.cxx create mode 100644 examples/javascript/grovegsr.js create mode 100644 src/grovegsr/CMakeLists.txt create mode 100644 src/grovegsr/grovegsr.cxx create mode 100644 src/grovegsr/grovegsr.h create mode 100644 src/grovegsr/jsupm_grovegsr.i create mode 100644 src/grovegsr/pyupm_grovegsr.i diff --git a/examples/c++/CMakeLists.txt b/examples/c++/CMakeLists.txt index 8786c06d..04772283 100644 --- a/examples/c++/CMakeLists.txt +++ b/examples/c++/CMakeLists.txt @@ -92,6 +92,7 @@ add_executable (grovecollision-example grovecollision.cxx) add_executable (groveelectromagnet-example groveelectromagnet.cxx) add_executable (groveemg-example groveemg.cxx) add_executable (groveo2-example groveo2.cxx) +add_executable (grovegsr-example grovegsr.cxx) include_directories (${PROJECT_SOURCE_DIR}/src/hmc5883l) include_directories (${PROJECT_SOURCE_DIR}/src/grove) @@ -166,6 +167,7 @@ include_directories (${PROJECT_SOURCE_DIR}/src/grovecollision) include_directories (${PROJECT_SOURCE_DIR}/src/groveelectromagnet) include_directories (${PROJECT_SOURCE_DIR}/src/groveemg) include_directories (${PROJECT_SOURCE_DIR}/src/groveo2) +include_directories (${PROJECT_SOURCE_DIR}/src/grovegsr) target_link_libraries (hmc5883l-example hmc5883l ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (groveled-example grove ${CMAKE_THREAD_LIBS_INIT}) @@ -259,3 +261,4 @@ target_link_libraries (grovecollision-example grovecollision ${CMAKE_THREAD_LIBS target_link_libraries (groveelectromagnet-example groveelectromagnet ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (groveemg-example groveemg ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (groveo2-example groveo2 ${CMAKE_THREAD_LIBS_INIT}) +target_link_libraries (grovegsr-example grovegsr ${CMAKE_THREAD_LIBS_INIT}) diff --git a/examples/c++/grovegsr.cxx b/examples/c++/grovegsr.cxx new file mode 100644 index 00000000..549e7758 --- /dev/null +++ b/examples/c++/grovegsr.cxx @@ -0,0 +1,63 @@ +/* + * 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 "grovegsr.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 the GroveGSR Galvanic Skin Response Sensor module. + + // Instantiate a GroveGSR on analog pin A0 + upm::GroveGSR *gsr = new upm::GroveGSR(0); + cout << "Calibrating...." << endl; + gsr->calibrate(); + + while (shouldRun) + { + cout << gsr->value() << endl; + usleep(500000); + } +//! [Interesting] + + cout << "Exiting" << endl; + + delete gsr; + return 0; +} diff --git a/examples/javascript/grovegsr.js b/examples/javascript/grovegsr.js new file mode 100644 index 00000000..5217eee3 --- /dev/null +++ b/examples/javascript/grovegsr.js @@ -0,0 +1,51 @@ +/*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 grovegsr_lib = require("jsupm_grovegsr"); + +// The was tested with the GroveGSR Galvanic Skin Response Sensor module. + +// Instantiate a GroveGSR on analog pin A0 +var grovegsr_obj = new grovegsr_lib.GroveGSR(0); +console.log("Calibrating...."); +grovegsr_obj.calibrate(); + +var myInterval = setInterval(function() +{ + console.log(grovegsr_obj.value()); +}, 500); + + +// When exiting: clear interval, and print message +process.on('SIGINT', function() +{ + clearInterval(myInterval); + grovegsr_obj = null; + grovegsr_lib.cleanUp(); + grovegsr_lib = null; + console.log("Exiting..."); + process.exit(0); +}); diff --git a/src/grovegsr/CMakeLists.txt b/src/grovegsr/CMakeLists.txt new file mode 100644 index 00000000..051ad082 --- /dev/null +++ b/src/grovegsr/CMakeLists.txt @@ -0,0 +1,5 @@ +set (libname "grovegsr") +set (libdescription "upm grovegsr galvanic skin response sensor module") +set (module_src ${libname}.cxx) +set (module_h ${libname}.h) +upm_module_init() diff --git a/src/grovegsr/grovegsr.cxx b/src/grovegsr/grovegsr.cxx new file mode 100644 index 00000000..4a7ac940 --- /dev/null +++ b/src/grovegsr/grovegsr.cxx @@ -0,0 +1,65 @@ +/* + * 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 "grovegsr.h" + +using namespace upm; +using namespace std; + +GroveGSR::GroveGSR(int pin) +{ + if ( !(m_aio = mraa_aio_init(pin)) ) + { + cerr << __FUNCTION__ << ": mraa_aio_init() failed" << endl; + return; + } +} + +GroveGSR::~GroveGSR() +{ + mraa_aio_close(m_aio); +} + +void GroveGSR::calibrate() +{ + sleep(1); + int val, threshold, sum = 0; + + for(int i=0; i<500; i++) + { + val = mraa_aio_read(m_aio); + sum += val; + usleep(5000); + } + threshold = sum / 500; + cout << "Threshold = " << threshold << endl; +} + +int GroveGSR::value() +{ + int val = mraa_aio_read(m_aio); + return val; +} diff --git a/src/grovegsr/grovegsr.h b/src/grovegsr/grovegsr.h new file mode 100644 index 00000000..85d91de1 --- /dev/null +++ b/src/grovegsr/grovegsr.h @@ -0,0 +1,75 @@ +/* + * 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 GroveGSR Galvanic Skin Response Sensor + * @defgroup grovegsr libupm-grovegsr + */ + /** + * @brief C++ API for the GroveGSR Galvanic Skin Response Sensor + * + * Measure the electrical conductance of skin in order + * to measure strong emotional reaction. + * In other words, it measures sweat on your fingers + * as an indicator of strong emotional reactions. + * + * @ingroup analog grovegsr + * @snippet grovegsr.cxx Interesting + */ + class GroveGSR { + public: + /** + * GroveGSR sensor constructor + * + * @param pin analog pin to use + */ + GroveGSR(int pin); + /** + * GroveGSR Destructor + */ + ~GroveGSR(); + + /** + * Calibrate the GroveGSR Sensor + */ + void calibrate(); + + /** + * Measure the electrical conductance of the skin from the sensor + * + * @return the electrical conductance of the skin + */ + int value(); + + private: + mraa_aio_context m_aio; + }; +} + + diff --git a/src/grovegsr/jsupm_grovegsr.i b/src/grovegsr/jsupm_grovegsr.i new file mode 100644 index 00000000..d1ec0165 --- /dev/null +++ b/src/grovegsr/jsupm_grovegsr.i @@ -0,0 +1,8 @@ +%module jsupm_grovegsr +%include "../upm.i" + +%{ + #include "grovegsr.h" +%} + +%include "grovegsr.h" diff --git a/src/grovegsr/pyupm_grovegsr.i b/src/grovegsr/pyupm_grovegsr.i new file mode 100644 index 00000000..8472c78b --- /dev/null +++ b/src/grovegsr/pyupm_grovegsr.i @@ -0,0 +1,9 @@ +%module pyupm_grovegsr +%include "../upm.i" + +%feature("autodoc", "3"); + +%include "grovegsr.h" +%{ + #include "grovegsr.h" +%}