diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt index 50c0d70d..19bb5d80 100644 --- a/examples/CMakeLists.txt +++ b/examples/CMakeLists.txt @@ -70,6 +70,7 @@ add_executable (ublox6-example ublox6.cxx) add_executable (yg1006-example yg1006.cxx) add_executable (wt5001-example wt5001.cxx) add_executable (ppd42ns-example ppd42ns.cxx) +add_executable (mq303a-example mq303a.cxx) include_directories (${PROJECT_SOURCE_DIR}/src/hmc5883l) include_directories (${PROJECT_SOURCE_DIR}/src/grove) @@ -127,6 +128,7 @@ include_directories (${PROJECT_SOURCE_DIR}/src/ublox6) include_directories (${PROJECT_SOURCE_DIR}/src/yg1006) include_directories (${PROJECT_SOURCE_DIR}/src/wt5001) include_directories (${PROJECT_SOURCE_DIR}/src/ppd42ns) +include_directories (${PROJECT_SOURCE_DIR}/src/mq303a) target_link_libraries (hmc5883l-example hmc5883l ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (groveled-example grove ${CMAKE_THREAD_LIBS_INIT}) @@ -200,3 +202,4 @@ target_link_libraries (ublox6-example ublox6 ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (yg1006-example yg1006 ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (wt5001-example wt5001 ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (ppd42ns-example ppd42ns ${CMAKE_THREAD_LIBS_INIT}) +target_link_libraries (mq303a-example mq303a ${CMAKE_THREAD_LIBS_INIT}) diff --git a/examples/javascript/mq303a.js b/examples/javascript/mq303a.js new file mode 100644 index 00000000..8cce09c4 --- /dev/null +++ b/examples/javascript/mq303a.js @@ -0,0 +1,78 @@ +/*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 alcohol sensor module +var mq303a = require('jsupm_mq303a'); + +// Instantiate an mq303a sensor on analog pin A0 +// This device uses a heater powered from an analog I/O pin. +// If using A0 as the data pin, then you need to use A1, as the heater +// pin (if using a grove mq303a). For A1, we can use the D15 gpio, +// setup as an output, and drive it low to power the heater. +var myAlcoholObj = new mq303a.MQ303A(0, 15); + +console.log("Enabling heater and waiting 2 minutes for warmup."); + +// give time updates every 30 seconds until 2 minutes have passed +// for the alcohol sensor to warm up +statusMessage(1); +statusMessage(2); +statusMessage(3); + +function statusMessage(amt) +{ + setTimeout(function() + { + console.log((amt * 30) + " seconds have passed"); + }, 30000 * amt); +} + +// run the alcohol sensor in 2 minutes +setTimeout(runAlcoholSensor, 120000); + +function runAlcoholSensor() +{ + var notice = "This sensor may need to warm " + + "until the value drops below about 450." + console.log(notice); + + // Print the detected alcohol value every second + setInterval(function() + { + var val = myAlcoholObj.value(); + var msg = "Alcohol detected "; + msg += "(higher means stronger alcohol): "; + console.log(msg + val); + }, 1000); +} + +// Print message when exiting +process.on('SIGINT', function() +{ + console.log("Exiting..."); + process.exit(0); +}); diff --git a/examples/mq303a.cxx b/examples/mq303a.cxx new file mode 100644 index 00000000..4557de0a --- /dev/null +++ b/examples/mq303a.cxx @@ -0,0 +1,78 @@ +/* + * 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 "mq303a.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 an mq303a sensor on analog pin A0 + + // This device uses a heater powered from an analog I/O pin. + // If using A0 as the data pin, then you need to use A1, as the heater + // pin (if using a grove mq303a). For A1, we can use the D15 gpio, + // setup as an output, and drive it low to power the heater. + + upm::MQ303A *mq303a = new upm::MQ303A(0, 15); + + cout << "Enabling heater and waiting 2 minutes for warmup." << endl; + mq303a->heaterEnable(true); + sleep(120); + + cout << "This sensor may need to warm until the value drops below about 450." + << endl; + + // Print the detected alcohol value every second + while (shouldRun) + { + int val = mq303a->value(); + + cout << "Alcohol detected (higher means stronger alcohol): " + << val << endl; + + sleep(1); + } +//! [Interesting] + + cout << "Exiting" << endl; + mq303a->heaterEnable(false); + + delete mq303a; + return 0; +} diff --git a/src/mq303a/CMakeLists.txt b/src/mq303a/CMakeLists.txt new file mode 100644 index 00000000..aae1c759 --- /dev/null +++ b/src/mq303a/CMakeLists.txt @@ -0,0 +1,5 @@ +set (libname "mq303a") +set (libdescription "upm mq303a module") +set (module_src ${libname}.cxx) +set (module_h ${libname}.h) +upm_module_init() diff --git a/src/mq303a/jsupm_mq303a.i b/src/mq303a/jsupm_mq303a.i new file mode 100644 index 00000000..857b92ac --- /dev/null +++ b/src/mq303a/jsupm_mq303a.i @@ -0,0 +1,8 @@ +%module jsupm_mq303a +%include "../upm.i" + +%{ + #include "mq303a.h" +%} + +%include "mq303a.h" diff --git a/src/mq303a/mq303a.cxx b/src/mq303a/mq303a.cxx new file mode 100644 index 00000000..dda380e2 --- /dev/null +++ b/src/mq303a/mq303a.cxx @@ -0,0 +1,57 @@ +/* + * 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 "mq303a.h" + +using namespace upm; + +MQ303A::MQ303A(int pin, int heaterPin) +{ + m_aio = mraa_aio_init(pin); + + m_gpio = mraa_gpio_init(heaterPin); + mraa_gpio_dir(m_gpio, MRAA_GPIO_OUT); +} + +MQ303A::~MQ303A() +{ + heaterEnable(false); + mraa_aio_close(m_aio); + mraa_gpio_close(m_gpio); +} + +int MQ303A::value() +{ + return (1023 - mraa_aio_read(m_aio)); +} + +void MQ303A::heaterEnable(bool enable) +{ + if (enable) + mraa_gpio_write(m_gpio, 0); // 0 turns on the heater + else + mraa_gpio_write(m_gpio, 1); // 1 turns off the heater +} diff --git a/src/mq303a/mq303a.h b/src/mq303a/mq303a.h new file mode 100644 index 00000000..d886f687 --- /dev/null +++ b/src/mq303a/mq303a.h @@ -0,0 +1,79 @@ +/* + * 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 MQ303A Alcohol Sensor + * + * UPM module for the MQ303A Alcohol Sensor. + * This sensor needs to be warmed up before stable results are + * obtained. The higher the value returned from value(), + * the higher the amount of alcohol that was detected. + * + * @ingroup analog gas alcohol + * @snippet mq303a.cxx Interesting + */ + class MQ303A { + public: + /** + * MQ303A sensor constructor + * + * @param pin analog pin to use + * @param heaterPin digital pin mapped to analog pin to use + */ + MQ303A(int pin, int heaterPin); + + /** + * MQ303A Destructor + */ + ~MQ303A(); + + /** + * Get the alcohol detected from the sensor. + * The value read from the analog pin is inverted. + * A higher returned value means a higher amount of alcohol was detected. + * + * @return the alcohol reading + */ + int value(); + + /** + * Enable the heater. + * + * @param enable if true, enable the heater else disable + */ + void heaterEnable(bool enable); + + private: + mraa_aio_context m_aio; + mraa_gpio_context m_gpio; + }; +} + + diff --git a/src/mq303a/pyupm_mq303a.i b/src/mq303a/pyupm_mq303a.i new file mode 100644 index 00000000..e57340ab --- /dev/null +++ b/src/mq303a/pyupm_mq303a.i @@ -0,0 +1,9 @@ +%module pyupm_mq303a +%include "../upm.i" + +%feature("autodoc", "3"); + +%include "mq303a.h" +%{ + #include "mq303a.h" +%}