diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt index 874b14c3..04466943 100644 --- a/examples/CMakeLists.txt +++ b/examples/CMakeLists.txt @@ -61,6 +61,7 @@ add_executable (grovemoisture-example grovemoisture.cxx) add_executable (groveehr-example groveehr.cxx) add_executable (ta12200-example ta12200.cxx) add_executable (grovelinefinder-example grovelinefinder.cxx) +add_executable (grovevdiv-example grovevdiv.cxx) include_directories (${PROJECT_SOURCE_DIR}/src/hmc5883l) include_directories (${PROJECT_SOURCE_DIR}/src/grove) @@ -109,6 +110,7 @@ include_directories (${PROJECT_SOURCE_DIR}/src/grovemoisture) include_directories (${PROJECT_SOURCE_DIR}/src/groveehr) include_directories (${PROJECT_SOURCE_DIR}/src/ta12200) include_directories (${PROJECT_SOURCE_DIR}/src/grovelinefinder) +include_directories (${PROJECT_SOURCE_DIR}/src/grovevdiv) target_link_libraries (hmc5883l-example hmc5883l ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (groveled-example grove ${CMAKE_THREAD_LIBS_INIT}) @@ -173,3 +175,4 @@ target_link_libraries (grovemoisture-example grovemoisture ${CMAKE_THREAD_LIBS_I target_link_libraries (groveehr-example groveehr ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (ta12200-example ta12200 ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (grovelinefinder-example grovelinefinder ${CMAKE_THREAD_LIBS_INIT}) +target_link_libraries (grovevdiv-example grovevdiv ${CMAKE_THREAD_LIBS_INIT}) diff --git a/examples/grovevdiv.cxx b/examples/grovevdiv.cxx new file mode 100644 index 00000000..40be66c0 --- /dev/null +++ b/examples/grovevdiv.cxx @@ -0,0 +1,67 @@ +/* + * Author: Jon Trulson + * Copyright (c) 2014 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 "grovevdiv.h" + +using namespace std; + +bool shouldRun = true; + +void sig_handler(int signo) +{ + if (signo == SIGINT) + shouldRun = false; +} + + +int main () +{ + signal(SIGINT, sig_handler); + +//! [Interesting] + // Instantiate a Grove Voltage Divider sensor on analog pin A0 + upm::GroveVDiv* vDiv = new upm::GroveVDiv(0); + + // collect data and output measured voltage according to the setting + // of the scaling switch (3 or 10) + while (shouldRun) + { + unsigned int val = vDiv->value(100); + float gain3val = vDiv->computedValue(3, val); + float gain10val = vDiv->computedValue(10, val); + cout << "ADC value: " << val << " Gain 3: " << gain3val + << "v Gain 10: " << gain10val << "v" << endl; + + sleep(1); + } +//! [Interesting] + + cout << "Exiting..." << endl; + + delete vDiv; + return 0; +} diff --git a/examples/javascript/grovevdiv.js b/examples/javascript/grovevdiv.js new file mode 100644 index 00000000..b85e374d --- /dev/null +++ b/examples/javascript/grovevdiv.js @@ -0,0 +1,50 @@ +/*jslint node:true, vars:true, bitwise:true, unparam:true */ +/*jshint unused:true */ +/*global */ +/* +* Author: Zion Orent +* Copyright (c) 2014 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 voltageDivider = require('jsupm_grovevdiv'); +// Instantiate a Grove Voltage Divider sensor on analog pin A0 +var myVoltageDivider = new voltageDivider.GroveVDiv(0); + +// collect data and output measured voltage according to the setting +// of the scaling switch (3 or 10) +function getVoltageInfo() +{ + var val = myVoltageDivider.value(100); + var gain3val = myVoltageDivider.computedValue(3, val); + var gain10val = myVoltageDivider.computedValue(10, val); + console.log("ADC value: " + val + " Gain 3: " + gain3val + + "v Gain 10: " + gain10val + "v"); +} + +setInterval(getVoltageInfo, 1000); + +// Print message when exiting +process.on('SIGINT', function() +{ + console.log("Exiting..."); + process.exit(0); +}); diff --git a/src/grovevdiv/CMakeLists.txt b/src/grovevdiv/CMakeLists.txt new file mode 100644 index 00000000..ec612c07 --- /dev/null +++ b/src/grovevdiv/CMakeLists.txt @@ -0,0 +1,5 @@ +set (libname "grovevdiv") +set (libdescription "upm grove voltage divider module") +set (module_src ${libname}.cxx) +set (module_h ${libname}.h) +upm_module_init() diff --git a/src/grovevdiv/grovevdiv.cxx b/src/grovevdiv/grovevdiv.cxx new file mode 100644 index 00000000..1c21f629 --- /dev/null +++ b/src/grovevdiv/grovevdiv.cxx @@ -0,0 +1,64 @@ +/* + * Author: Jon Trulson + * Copyright (c) 2014 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 "grovevdiv.h" + +using namespace upm; +using namespace std; + +GroveVDiv::GroveVDiv(int pin) +{ + if ( !(m_aio = mraa_aio_init(pin)) ) + { + cerr << __FUNCTION__ << ": mraa_aio_init() failed" << endl; + return; + } +} + +GroveVDiv::~GroveVDiv() +{ + mraa_aio_close(m_aio); +} + +unsigned int GroveVDiv::value(unsigned int samples) +{ + unsigned int sum = 0; + + for (int i=0; i + * Copyright (c) 2014 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 +#include +#include + +// ref voltage in millivolts +#define GROVEVDIV_VREF 4980 + +// default ADC resolution. +#define GROVEVDIV_ADC_RES 1024 + +namespace upm { + + /** + * @brief C++ API for the Grove Voltage Divider Sensor + * + * UPM module for the Grove Voltage Divider Sensor + * + * @ingroup grove analog + * @snippet grovevdiv.cxx Interesting + */ + class GroveVDiv { + public: + /** + * Grove Voltage Divider sensor constructor + * + * @param pin analog pin to use + */ + GroveVDiv(int pin); + + /** + * Grove Voltage Divider Destructor + */ + ~GroveVDiv(); + + /** + * Get the conversion value from the sensor + * + * @param samples specifies how many samples to average over + * @return the averaged ADC conversion value + */ + unsigned int value(unsigned int samples); + + /** + * Compute the measured voltage + * + * @param gain gain switch, either 3 or 10 for grove + * @param val measured voltage (from value()) + * @param vref reference voltage in millivolts + * @param res ADC resolution + * + * @return the measured voltage + */ + float computedValue(uint8_t gain, uint16_t val, int vref=GROVEVDIV_VREF, + int res=GROVEVDIV_ADC_RES); + + private: + mraa_aio_context m_aio; + }; +} + + diff --git a/src/grovevdiv/jsupm_grovevdiv.i b/src/grovevdiv/jsupm_grovevdiv.i new file mode 100644 index 00000000..35c3bd46 --- /dev/null +++ b/src/grovevdiv/jsupm_grovevdiv.i @@ -0,0 +1,8 @@ +%module jsupm_grovevdiv +%include "../upm.i" + +%{ + #include "grovevdiv.h" +%} + +%include "grovevdiv.h" diff --git a/src/grovevdiv/pyupm_grovevdiv.i b/src/grovevdiv/pyupm_grovevdiv.i new file mode 100644 index 00000000..a2e3fc99 --- /dev/null +++ b/src/grovevdiv/pyupm_grovevdiv.i @@ -0,0 +1,9 @@ +%module pyupm_grovevdiv +%include "../upm.i" + +%feature("autodoc", "3"); + +%include "grovevdiv.h" +%{ + #include "grovevdiv.h" +%}