From ae10518a0f763068ada1e2106f332b2480f34138 Mon Sep 17 00:00:00 2001 From: Zion Orent Date: Wed, 25 Feb 2015 16:49:37 -0500 Subject: [PATCH] grovecollision: initial implementation This implements support for the Grove Collision Sensor. Signed-off-by: Zion Orent Signed-off-by: Jon Trulson Signed-off-by: John Van Drasek --- examples/c++/CMakeLists.txt | 3 + examples/c++/grovecollision.cxx | 69 +++++++++++++++++++++++ examples/javascript/grovecollision.js | 62 ++++++++++++++++++++ src/grovecollision/CMakeLists.txt | 5 ++ src/grovecollision/grovecollision.cxx | 44 +++++++++++++++ src/grovecollision/grovecollision.h | 63 +++++++++++++++++++++ src/grovecollision/jsupm_grovecollision.i | 8 +++ src/grovecollision/pyupm_grovecollision.i | 9 +++ 8 files changed, 263 insertions(+) create mode 100644 examples/c++/grovecollision.cxx create mode 100644 examples/javascript/grovecollision.js create mode 100644 src/grovecollision/CMakeLists.txt create mode 100644 src/grovecollision/grovecollision.cxx create mode 100644 src/grovecollision/grovecollision.h create mode 100644 src/grovecollision/jsupm_grovecollision.i create mode 100644 src/grovecollision/pyupm_grovecollision.i diff --git a/examples/c++/CMakeLists.txt b/examples/c++/CMakeLists.txt index e0e2bf06..eaf7cf94 100644 --- a/examples/c++/CMakeLists.txt +++ b/examples/c++/CMakeLists.txt @@ -88,6 +88,7 @@ add_executable (adxl335-example adxl335.cxx) add_executable (hmtrp-example hmtrp.cxx) add_executable (nunchuck-example nunchuck.cxx) add_executable (otp538u-example otp538u.cxx) +add_executable (grovecollision-example grovecollision.cxx) include_directories (${PROJECT_SOURCE_DIR}/src/hmc5883l) include_directories (${PROJECT_SOURCE_DIR}/src/grove) @@ -158,6 +159,7 @@ include_directories (${PROJECT_SOURCE_DIR}/src/adxl335) include_directories (${PROJECT_SOURCE_DIR}/src/hmtrp) include_directories (${PROJECT_SOURCE_DIR}/src/nunchuck) include_directories (${PROJECT_SOURCE_DIR}/src/otp538u) +include_directories (${PROJECT_SOURCE_DIR}/src/grovecollision) target_link_libraries (hmc5883l-example hmc5883l ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (groveled-example grove ${CMAKE_THREAD_LIBS_INIT}) @@ -247,3 +249,4 @@ target_link_libraries (adxl335-example adxl335 ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (hmtrp-example hmtrp ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (nunchuck-example nunchuck ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (otp538u-example otp538u ${CMAKE_THREAD_LIBS_INIT}) +target_link_libraries (grovecollision-example grovecollision ${CMAKE_THREAD_LIBS_INIT}) diff --git a/examples/c++/grovecollision.cxx b/examples/c++/grovecollision.cxx new file mode 100644 index 00000000..2de76096 --- /dev/null +++ b/examples/c++/grovecollision.cxx @@ -0,0 +1,69 @@ +/* +* 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 "grovecollision.h" + +using namespace std; + +int shouldRun = true; + +void sig_handler(int signo) +{ + if (signo == SIGINT) + shouldRun = false; +} + +int main(int argc, char **argv) +{ + signal(SIGINT, sig_handler); + +//! [Interesting] + // The was tested with the Grove Collision Sensor + // Instantiate a Grove Collision on digital pin D2 + upm::GroveCollision* collision = new upm::GroveCollision(2); + + bool collisionState = false; + cout << "No collision" << endl; + while (shouldRun) + { + if (collision->isColliding() && !collisionState) + { + cout << "Collision!" << endl; + collisionState = true; + } + else if (collisionState) + { + cout << "No collision" << endl; + collisionState = false; + } + } + +//! [Interesting] + cout << "Exiting" << endl; + + delete collision; + return 0; +} diff --git a/examples/javascript/grovecollision.js b/examples/javascript/grovecollision.js new file mode 100644 index 00000000..71774a17 --- /dev/null +++ b/examples/javascript/grovecollision.js @@ -0,0 +1,62 @@ +/*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 collision_lib = require("jsupm_grovecollision"); + +// The was tested with the Grove Collision Sensor +// Instantiate a Grove Collision on digital pin D2 +var collision_obj = new collision_lib.GroveCollision(2); + +var collisionState = false; +console.log("No collision"); + +// Having an infinate loop prevents nodeJS from catching Cntl-C +// We need to catch Cntl-C to clean up memory +// Instead, we check the collision sensor every millisecond +var myInterval = setInterval(function() +{ + if (collision_obj.isColliding() && !collisionState) + { + console.log("Collision!"); + collisionState = true; + } + else if (collisionState) + { + console.log("No collision"); + collisionState = false; + } +}, 1); + +// When exiting: clear interval, clean up memory, and print message +process.on('SIGINT', function() +{ + clearInterval(myInterval); + collision_obj = null; + collision_lib.cleanUp(); + collision_lib = null; + console.log("Exiting..."); + process.exit(0); +}); diff --git a/src/grovecollision/CMakeLists.txt b/src/grovecollision/CMakeLists.txt new file mode 100644 index 00000000..0bdce67b --- /dev/null +++ b/src/grovecollision/CMakeLists.txt @@ -0,0 +1,5 @@ +set (libname "grovecollision") +set (libdescription "upm grovecollision sensor module") +set (module_src ${libname}.cxx) +set (module_h ${libname}.h) +upm_module_init("-lrt") diff --git a/src/grovecollision/grovecollision.cxx b/src/grovecollision/grovecollision.cxx new file mode 100644 index 00000000..ccc1fd4f --- /dev/null +++ b/src/grovecollision/grovecollision.cxx @@ -0,0 +1,44 @@ +/* + * 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 "grovecollision.h" + +using namespace upm; + +GroveCollision::GroveCollision(int pin) +{ + m_gpio = mraa_gpio_init(pin); + mraa_gpio_dir(m_gpio, MRAA_GPIO_IN); +} + +GroveCollision::~GroveCollision() +{ + mraa_gpio_close(m_gpio); +} + +bool GroveCollision::isColliding() +{ + // Collisions cause 0; no collision is 1 + return (!(bool)mraa_gpio_read(m_gpio)); +} diff --git a/src/grovecollision/grovecollision.h b/src/grovecollision/grovecollision.h new file mode 100644 index 00000000..a904c1f2 --- /dev/null +++ b/src/grovecollision/grovecollision.h @@ -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. + */ +#pragma once + +#include + +namespace upm { + /** + * @brief UPM module for the Grove Collision + * @defgroup grovecollision libupm-grovecollision + */ + /** + * @brief C++ API for the Grove Collision + * + * The Grove Collision Sensor can detect whether any + * collision movement or vibration happens. + * It will output a low pulse signal when vibration is detected. + * + * @ingroup gpio grovecollision + * @snippet grovecollision.cxx Interesting + */ + class GroveCollision { + public: + /** + * Grove Collision Constructor + * + * @param pin digital pin to use + */ + GroveCollision(int pin); + /** + * Grove Collision Destructor + */ + ~GroveCollision(); + /** + * @return bool returns whether something is colliding with sensor + */ + bool isColliding(); + + private: + mraa_gpio_context m_gpio; + }; +} diff --git a/src/grovecollision/jsupm_grovecollision.i b/src/grovecollision/jsupm_grovecollision.i new file mode 100644 index 00000000..5164b3e2 --- /dev/null +++ b/src/grovecollision/jsupm_grovecollision.i @@ -0,0 +1,8 @@ +%module jsupm_grovecollision +%include "../upm.i" + +%{ + #include "grovecollision.h" +%} + +%include "grovecollision.h" diff --git a/src/grovecollision/pyupm_grovecollision.i b/src/grovecollision/pyupm_grovecollision.i new file mode 100644 index 00000000..e37a14fe --- /dev/null +++ b/src/grovecollision/pyupm_grovecollision.i @@ -0,0 +1,9 @@ +%module pyupm_grovecollision +%include "../upm.i" + +%feature("autodoc", "3"); + +%include "grovecollision.h" +%{ + #include "grovecollision.h" +%}