From 0ef81a3b1c8fd53c305c0533683969546a1a84bb Mon Sep 17 00:00:00 2001 From: Jon Trulson Date: Tue, 2 Dec 2014 16:45:40 -0700 Subject: [PATCH] grovemoisture: Initial UPM implementation Signed-off-by: Jon Trulson Signed-off-by: Zion Orent Signed-off-by: Sarah Knepper --- examples/CMakeLists.txt | 3 + examples/grovemoisture.cxx | 75 +++++++++++++++++++++++++ examples/javascript/grovemoisture.js | 57 +++++++++++++++++++ src/grovemoisture/CMakeLists.txt | 5 ++ src/grovemoisture/grovemoisture.cxx | 46 +++++++++++++++ src/grovemoisture/grovemoisture.h | 68 ++++++++++++++++++++++ src/grovemoisture/jsupm_grovemoisture.i | 8 +++ src/grovemoisture/pyupm_grovemoisture.i | 9 +++ 8 files changed, 271 insertions(+) create mode 100644 examples/grovemoisture.cxx create mode 100644 examples/javascript/grovemoisture.js create mode 100644 src/grovemoisture/CMakeLists.txt create mode 100644 src/grovemoisture/grovemoisture.cxx create mode 100644 src/grovemoisture/grovemoisture.h create mode 100644 src/grovemoisture/jsupm_grovemoisture.i create mode 100644 src/grovemoisture/pyupm_grovemoisture.i diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt index 07cc28ed..b1c91e28 100644 --- a/examples/CMakeLists.txt +++ b/examples/CMakeLists.txt @@ -57,6 +57,7 @@ add_executable (adc121c021-example adc121c021.cxx) add_executable (ds1307-example ds1307.cxx) add_executable (a110x-example a110x.cxx) add_executable (gp2y0a21yk-example gp2y0a21yk.cxx) +add_executable (grovemoisture-example grovemoisture.cxx) include_directories (${PROJECT_SOURCE_DIR}/src/hmc5883l) include_directories (${PROJECT_SOURCE_DIR}/src/grove) @@ -101,6 +102,7 @@ include_directories (${PROJECT_SOURCE_DIR}/src/adc121c021) include_directories (${PROJECT_SOURCE_DIR}/src/ds1307) include_directories (${PROJECT_SOURCE_DIR}/src/a110x) include_directories (${PROJECT_SOURCE_DIR}/src/gp2y0a21yk) +include_directories (${PROJECT_SOURCE_DIR}/src/grovemoisture) target_link_libraries (hmc5883l-example hmc5883l ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (groveled-example grove ${CMAKE_THREAD_LIBS_INIT}) @@ -161,3 +163,4 @@ target_link_libraries (adc121c021-example adc121c021 ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (ds1307-example ds1307 ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (a110x-example a110x ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (gp2y0a21yk-example gp2y0a21yk ${CMAKE_THREAD_LIBS_INIT}) +target_link_libraries (grovemoisture-example grovemoisture ${CMAKE_THREAD_LIBS_INIT}) diff --git a/examples/grovemoisture.cxx b/examples/grovemoisture.cxx new file mode 100644 index 00000000..1fee54cf --- /dev/null +++ b/examples/grovemoisture.cxx @@ -0,0 +1,75 @@ +/* + * 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 "grovemoisture.h" + +using namespace std; + +int shouldRun = true; + +void sig_handler(int signo) +{ + if (signo == SIGINT) + shouldRun = false; +} + + +int main () +{ + signal(SIGINT, sig_handler); + +//! [Interesting] + // Instantiate a Grove Moisture sensor on analog pin A0 + upm::GroveMoisture* moisture = new upm::GroveMoisture(0); + + // Values (approximate): + // 0-300, sensor in air or dry soil + // 300-600, sensor in humid soil + // 600+, sensor in wet soil or submerged in water. + // Read the value every second and print the corresponding moisture level + while (shouldRun) + { + int val = moisture->value(); + cout << "Moisture value: " << val << ", "; + if (val >= 0 && val < 300) + cout << "dry"; + else if (val >= 300 && val < 600) + cout << "moist"; + else + cout << "wet"; + + cout << endl; + + sleep(1); + } +//! [Interesting] + + cout << "Exiting" << endl; + + delete moisture; + return 0; +} diff --git a/examples/javascript/grovemoisture.js b/examples/javascript/grovemoisture.js new file mode 100644 index 00000000..3d3f7050 --- /dev/null +++ b/examples/javascript/grovemoisture.js @@ -0,0 +1,57 @@ +/*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. +*/ + +//Load Grove Moisture module +var grove_moisture = require('jsupm_grovemoisture'); + +// Instantiate a Grove Moisture sensor on analog pin A0 +var myMoistureObj = new grove_moisture.GroveMoisture(0); + +// Values (approximate): +// 0-300, sensor in air or dry soil +// 300-600, sensor in humid soil +// 600+, sensor in wet soil or submerged in water +// Read the value every second and print the corresponding moisture level +setInterval(function() +{ + var result; + var moisture_val = parseInt(myMoistureObj.value()); + if (moisture_val >= 0 && moisture_val < 300) + result = "Dry"; + else if (moisture_val >= 300 && moisture_val < 600) + result = "Moist"; + else + result = "Wet"; + console.log("Moisture value: " + moisture_val + ", " + result); +}, 1000); + +// Print message when exiting +process.on('SIGINT', function() +{ + console.log("Exiting..."); + process.exit(0); +}); diff --git a/src/grovemoisture/CMakeLists.txt b/src/grovemoisture/CMakeLists.txt new file mode 100644 index 00000000..a50d11e7 --- /dev/null +++ b/src/grovemoisture/CMakeLists.txt @@ -0,0 +1,5 @@ +set (libname "grovemoisture") +set (libdescription "upm grove moisture module") +set (module_src ${libname}.cxx) +set (module_h ${libname}.h) +upm_module_init() diff --git a/src/grovemoisture/grovemoisture.cxx b/src/grovemoisture/grovemoisture.cxx new file mode 100644 index 00000000..fdfb4511 --- /dev/null +++ b/src/grovemoisture/grovemoisture.cxx @@ -0,0 +1,46 @@ +/* + * 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 "grovemoisture.h" + +using namespace upm; + +GroveMoisture::GroveMoisture(int pin) +{ + mraa_init(); + + m_aio = mraa_aio_init(pin); +} + +GroveMoisture::~GroveMoisture() +{ + mraa_aio_close(m_aio); +} + +int GroveMoisture::value() +{ + return mraa_aio_read(m_aio); +} diff --git a/src/grovemoisture/grovemoisture.h b/src/grovemoisture/grovemoisture.h new file mode 100644 index 00000000..ac0a7027 --- /dev/null +++ b/src/grovemoisture/grovemoisture.h @@ -0,0 +1,68 @@ +/* + * 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. + */ +#pragma once + +#include +#include + +namespace upm { + + /** + * @brief C++ API for the Grove Moisture Sensor + * + * UPM module for the Grove Moisture Sensor. + * This sensor can be used to detect the moisture content + * of soil or whether there is water around the sensor. + * As the moisture content increases, so does the value that is read. + * Note that this sensor is not designed to be left in soil + * nor to be used outdoors. + * + * @ingroup grove analog + * @snippet grovemoisture.cxx Interesting + */ + class GroveMoisture { + public: + /** + * Grove analog moisture sensor constructor + * + * @param pin analog pin to use + */ + GroveMoisture(int pin); + /** + * GroveMoisture Destructor + */ + ~GroveMoisture(); + /** + * Get the moisture value from the sensor + * + * @return the moisture reading + */ + int value(); + + private: + mraa_aio_context m_aio; + }; +} + + diff --git a/src/grovemoisture/jsupm_grovemoisture.i b/src/grovemoisture/jsupm_grovemoisture.i new file mode 100644 index 00000000..e77e94bc --- /dev/null +++ b/src/grovemoisture/jsupm_grovemoisture.i @@ -0,0 +1,8 @@ +%module jsupm_grovemoisture +%include "../upm.i" + +%{ + #include "grovemoisture.h" +%} + +%include "grovemoisture.h" diff --git a/src/grovemoisture/pyupm_grovemoisture.i b/src/grovemoisture/pyupm_grovemoisture.i new file mode 100644 index 00000000..74cc1b7f --- /dev/null +++ b/src/grovemoisture/pyupm_grovemoisture.i @@ -0,0 +1,9 @@ +%module pyupm_grovemoisture +%include "../upm.i" + +%feature("autodoc", "3"); + +%include "grovemoisture.h" +%{ + #include "grovemoisture.h" +%}