diff --git a/examples/c++/CMakeLists.txt b/examples/c++/CMakeLists.txt index e8e82503..8786c06d 100644 --- a/examples/c++/CMakeLists.txt +++ b/examples/c++/CMakeLists.txt @@ -91,6 +91,7 @@ add_executable (otp538u-example otp538u.cxx) add_executable (grovecollision-example grovecollision.cxx) add_executable (groveelectromagnet-example groveelectromagnet.cxx) add_executable (groveemg-example groveemg.cxx) +add_executable (groveo2-example groveo2.cxx) include_directories (${PROJECT_SOURCE_DIR}/src/hmc5883l) include_directories (${PROJECT_SOURCE_DIR}/src/grove) @@ -164,6 +165,7 @@ include_directories (${PROJECT_SOURCE_DIR}/src/otp538u) 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) target_link_libraries (hmc5883l-example hmc5883l ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (groveled-example grove ${CMAKE_THREAD_LIBS_INIT}) @@ -256,3 +258,4 @@ target_link_libraries (otp538u-example otp538u ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (grovecollision-example grovecollision ${CMAKE_THREAD_LIBS_INIT}) 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}) diff --git a/examples/c++/groveo2.cxx b/examples/c++/groveo2.cxx new file mode 100644 index 00000000..cc1b2402 --- /dev/null +++ b/examples/c++/groveo2.cxx @@ -0,0 +1,57 @@ +/* +* 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 "groveo2.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 O2 Oxygen Concentration Sensor Module + // Instantiate a GroveO2 on analog pin A0 + upm::GroveO2 *O2 = new upm::GroveO2(0); + while (shouldRun) + { + cout << "The output voltage is: " << O2->voltageValue() << "mV" << endl; + usleep(100000); + } + +//! [Interesting] + cout << "Exiting" << endl; + delete O2; + return 0; +} diff --git a/examples/javascript/groveo2.js b/examples/javascript/groveo2.js new file mode 100644 index 00000000..14ac46fc --- /dev/null +++ b/examples/javascript/groveo2.js @@ -0,0 +1,52 @@ +/*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 groveO2_lib = require("jsupm_groveo2"); + +// The was tested with the O2 Oxygen Concentration Sensor Module +// Instantiate a GroveO2 on analog pin A0 +var groveO2_obj = new groveO2_lib.GroveO2(0); + +var myInterval = setInterval(function() +{ + console.log("The output voltage is: " + roundNum(groveO2_obj.voltageValue(), 5) + "mV"); +}, 100); + +function roundNum(num, decimalPlaces) +{ + var extraNum = (1 / (Math.pow(10, decimalPlaces) * 1000)); + return (Math.round((num + extraNum) * (Math.pow(10, decimalPlaces))) / Math.pow(10, decimalPlaces)); +} + +// When exiting: clear interval, and print message +process.on('SIGINT', function() +{ + clearInterval(myInterval); + groveO2_obj = null; + groveO2_lib.cleanUp(); + groveO2_lib = null; + console.log("Exiting..."); + process.exit(0); +}); diff --git a/src/groveo2/CMakeLists.txt b/src/groveo2/CMakeLists.txt new file mode 100644 index 00000000..a9edadb5 --- /dev/null +++ b/src/groveo2/CMakeLists.txt @@ -0,0 +1,5 @@ +set (libname "groveo2") +set (libdescription "upm groveO2 oxygen concentration sensor module") +set (module_src ${libname}.cxx) +set (module_h ${libname}.h) +upm_module_init() diff --git a/src/groveo2/groveo2.cxx b/src/groveo2/groveo2.cxx new file mode 100644 index 00000000..8b476ded --- /dev/null +++ b/src/groveo2/groveo2.cxx @@ -0,0 +1,52 @@ +/* + * 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 "groveo2.h" + +using namespace upm; +using namespace std; + +GroveO2::GroveO2(int pin) +{ + if ( !(m_aio = mraa_aio_init(pin)) ) + { + cerr << __FUNCTION__ << ": mraa_aio_init() failed" << endl; + return; + } +} + +GroveO2::~GroveO2() +{ + mraa_aio_close(m_aio); +} + +float GroveO2::voltageValue() +{ + int val = mraa_aio_read(m_aio); + float sensorVoltage = (val/1024.0) * 5.0; + sensorVoltage = (sensorVoltage/201.0) * 1000.0; + return sensorVoltage; +} diff --git a/src/groveo2/groveo2.h b/src/groveo2/groveo2.h new file mode 100644 index 00000000..a5117f3a --- /dev/null +++ b/src/groveo2/groveo2.h @@ -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. + */ +#pragma once + +#include +#include + +namespace upm { + /** + * @brief UPM module for the GroveO2 Oxygen Gas Sensor + * @defgroup groveo2 libupm-groveo2 + */ + /** + * @brief C++ API for the GroveO2 Oxygen Gas Sensor + * + * The Grove O2 sensor measures the oxygen concentration in the air + * + * @ingroup analog groveo2 + * @snippet groveo2.cxx Interesting + */ + class GroveO2 { + public: + /** + * GroveO2 sensor constructor + * + * @param pin analog pin to use + */ + GroveO2(int pin); + /** + * GroveO2 Destructor + */ + ~GroveO2(); + /** + * Measures O2 from the sensor + * + * @return the Oxygen concentration as voltage + */ + float voltageValue(); + + private: + mraa_aio_context m_aio; + }; +} + + diff --git a/src/groveo2/jsupm_groveo2.i b/src/groveo2/jsupm_groveo2.i new file mode 100644 index 00000000..8e3482e1 --- /dev/null +++ b/src/groveo2/jsupm_groveo2.i @@ -0,0 +1,8 @@ +%module jsupm_groveo2 +%include "../upm.i" + +%{ + #include "groveo2.h" +%} + +%include "groveo2.h" diff --git a/src/groveo2/pyupm_groveo2.i b/src/groveo2/pyupm_groveo2.i new file mode 100644 index 00000000..f682750e --- /dev/null +++ b/src/groveo2/pyupm_groveo2.i @@ -0,0 +1,9 @@ +%module pyupm_groveo2 +%include "../upm.i" + +%feature("autodoc", "3"); + +%include "groveo2.h" +%{ + #include "groveo2.h" +%}