diff --git a/docs/images/tp401.jpeg b/docs/images/tp401.jpeg new file mode 100644 index 00000000..70feb425 Binary files /dev/null and b/docs/images/tp401.jpeg differ diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt index 85d8929e..b9e77baf 100644 --- a/examples/CMakeLists.txt +++ b/examples/CMakeLists.txt @@ -36,6 +36,7 @@ add_executable (mq2-example mq2.cxx) add_executable (mq3-example mq3.cxx) add_executable (mq5-example mq5.cxx) add_executable (mq9-example mq9.cxx) +add_executable (tp401-example tp401.cxx) add_executable (tcs3414cs-example tcs3414cs.cxx) add_executable (th02-example th02.cxx) add_executable (lsm303-example lsm303.cxx) @@ -121,6 +122,7 @@ target_link_libraries (mq2-example gas ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (mq3-example gas ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (mq5-example gas ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (mq9-example gas ${CMAKE_THREAD_LIBS_INIT}) +target_link_libraries (tp401-example gas ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (tcs3414cs-example tcs3414cs ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (th02-example th02 ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (lsm303-example lsm303 ${CMAKE_THREAD_LIBS_INIT}) diff --git a/examples/javascript/tp401.js b/examples/javascript/tp401.js new file mode 100644 index 00000000..af0198d0 --- /dev/null +++ b/examples/javascript/tp401.js @@ -0,0 +1,68 @@ +/* + * Author: Mihai Tudor Panu + * 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 upmTP401 = require('jsupm_gas'); +//var time = require('sleep'); + +//give a qualitative meaning to the value from the sensor +function airQuality(value) +{ + if(value < 50) return "Fresh Air"; + if(value < 200) return "Normal Indoor Air"; + if(value < 400) return "Low Pollution"; + if(value < 600) return "High Pollution - Action Recommended"; + return "Very High Pollution - Take Action Immediately"; +} + +function loop() +{ + //read values (consecutive reads might vary slightly) + var value = airSensor.getSample(); + var ppm = airSensor.getPPM(); + + //write the sensor values to the console + console.log("raw: " + value + " ppm: " + (" " + ppm.toFixed(2)).substring(-5, 5) + " " + airQuality(value)); + + //wait 2.5 s then call function again + setTimeout(loop, 2500); +} + +//setup sensor on Analog pin #0 (A0) +var airSensor = new upmTP401.TP401(0); + +//warm up sensor +console.log("Sensor is warming up for 3 minutes.."); +var i = 1; + +//print a message every passing minute +var waiting = setInterval(function() { + console.log(i++ + " minute(s) passed."); + if(i == 3) clearInterval(waiting); + }, 60000); + +//start loop in 3 minutes +setTimeout(function(){ + console.log("Sensor is ready!"); + loop(); + }, 180000); diff --git a/examples/python/tp401.py b/examples/python/tp401.py new file mode 100644 index 00000000..34fecdd5 --- /dev/null +++ b/examples/python/tp401.py @@ -0,0 +1,54 @@ +# Author: Mihai Tudor Panu +# 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. + +from time import sleep +import pyupm_gas as TP401 + +# Give a qualitative meaning to the value from the sensor +def airQuality(value): + if(value < 50): return "Fresh Air" + if(value < 200): return "Normal Indoor Air" + if(value < 400): return "Low Pollution" + if(value < 600): return "High Pollution - Action Recommended" + return "Very High Pollution - Take Action Immediately" + +# New Grove Air Quality Sensor on AIO pin 0 +airSensor = TP401.TP401(0) + +# Wait for sensor to warm up +print "Sensor is warming up for 3 minutes..." +for i in range (1, 4): + sleep(60) + print i, "minute(s) passed." +print "Sensor is ready!" + +# Loop indefinitely +while True: + + # Read values (consecutive reads might vary slightly) + value = airSensor.getSample() + ppm = airSensor.getPPM() + + print "raw: %4d" % value , " ppm: %5.2f " % ppm , airQuality(value) + + # Sleep for 2.5 s + sleep(2.5) diff --git a/examples/tp401.cxx b/examples/tp401.cxx new file mode 100644 index 00000000..82755b5c --- /dev/null +++ b/examples/tp401.cxx @@ -0,0 +1,70 @@ +/* + * Author: Mihai Tudor Panu + * 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 "tp401.h" + +using namespace std; + +//! [Interesting] +// Give a qualitative meaning to the value from the sensor +std::string +airQuality(uint16_t value) +{ + if(value < 50) return "Fresh Air"; + if(value < 200) return "Normal Indoor Air"; + if(value < 400) return "Low Pollution"; + if(value < 600) return "High Pollution - Action Recommended"; + return "Very High Pollution - Take Action Immediately"; +} + +int main () +{ + upm::TP401* airSensor = new upm::TP401(0); // Instantiate new grove air quality sensor on analog pin A0 + + cout << airSensor->name() << endl; + + fprintf(stdout, "Heating sensor for 3 minutes...\n"); + // wait 3 minutes for sensor to warm up + for(int i = 0; i < 3; i++) { + if(i) { + fprintf(stdout, "Please wait, %d minute(s) passed..\n", i); + } + sleep(60); + } + fprintf(stdout, "Sensor ready!\n"); + + while(true) { + uint16_t value = airSensor->getSample(); // Read raw value + float ppm = airSensor->getPPM(); // Read CO ppm (can vary slightly from previous read) + fprintf(stdout, "raw: %4d ppm: %5.2f %s\n", value, ppm, airQuality(value).c_str()); + usleep(2500000); // Sleep for 2.5s + } + + delete airSensor; + return 0; +} +//! [Interesting] diff --git a/src/gas/CMakeLists.txt b/src/gas/CMakeLists.txt index e8b52d82..1795d927 100644 --- a/src/gas/CMakeLists.txt +++ b/src/gas/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "gas") set (libdescription "Gas sensors") -set (module_src ${libname}.cxx mq2.cxx mq3.cxx mq5.cxx mq9.cxx) -set (module_h ${libname}.h mq2.h mq3.h mq5.h mq9.h) +set (module_src ${libname}.cxx mq2.cxx mq3.cxx mq5.cxx mq9.cxx tp401.cxx) +set (module_h ${libname}.h mq2.h mq3.h mq5.h mq9.h tp401.h) upm_module_init() diff --git a/src/gas/README.txt b/src/gas/README.txt index 4eeab52b..44f7f717 100644 --- a/src/gas/README.txt +++ b/src/gas/README.txt @@ -3,4 +3,6 @@ Grove - Gas Sensor(MQ-3)：Alcohol and Benzine [high sensitivity] Long warm-up Grove - Gas Sensor(MQ-5)：LPG, Natural Gas, Town Gas [high sensitivity] Grove - Gas Sensor(MQ-9)：LPG, CO, CH4 [low sensitivity] -Note - Gas sensors need to be heated, first minute the data is incorrect. +Note - Gas sensors need to be heated, first minute the data is incorrect. Air +Quality sensor needs 48h to stabilize + diff --git a/src/gas/jsupm_gas.i b/src/gas/jsupm_gas.i index 01a5e8c4..98216102 100644 --- a/src/gas/jsupm_gas.i +++ b/src/gas/jsupm_gas.i @@ -26,3 +26,8 @@ %{ #include "mq9.h" %} + +%include "tp401.h" +%{ + #include "tp401.h" +%} diff --git a/src/gas/pyupm_gas.i b/src/gas/pyupm_gas.i index aa4c61c2..5b419962 100644 --- a/src/gas/pyupm_gas.i +++ b/src/gas/pyupm_gas.i @@ -31,3 +31,7 @@ #include "mq9.h" %} +%include "tp401.h" +%{ + #include "tp401.h" +%} diff --git a/src/gas/tp401.cxx b/src/gas/tp401.cxx new file mode 100644 index 00000000..0cf0c174 --- /dev/null +++ b/src/gas/tp401.cxx @@ -0,0 +1,39 @@ +/* + * Author: Mihai Tudor Panu + * 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 "tp401.h" + +using namespace upm; + +TP401::TP401 (int gasPin) : Gas (gasPin) { + m_name = "Grove Air Quality Sensor"; +} + +TP401::~TP401 () { +} + +float +TP401::getPPM() { + return 25.0 * (float)TP401::getSample() / 1023.0; +} diff --git a/src/gas/tp401.h b/src/gas/tp401.h new file mode 100644 index 00000000..a1cc524e --- /dev/null +++ b/src/gas/tp401.h @@ -0,0 +1,81 @@ +/* + * Author: Mihai Tudor Panu + * 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 "gas.h" + +namespace upm { + /** + * @brief C++ API for Grove TP401 Air Quality Sensor + * + * The Grove TP401 Air Quality Sensor module is useful for monitoring air purity indoors. + * It can detect CO and a wide range of other harmful gases, but due to limited sensing + * range should be used only when qualitative results are needed. Example applications + * are air recirculation, ventilation systems, and refreshing sprayers. + * The sensor is linear and should be roughly sensitive to 0 ~ 20 ppm CO from 0 ~ 4V. + * Also note that the sensor requires 2-3 minutes to warm up initially and 48 hours of + * operation to stabilize completely. + * + * @ingroup gas analog + * @snippet tp401.cxx Interesting + * @image html tp401.jpeg + */ + class TP401 : public Gas { + public: + /** + * TP401 constructor + * + * @param gasPin analog pin where sensor was connected + */ + TP401 (int gasPin); + + /** + * TP401 destructor + */ + ~TP401 (); + + /** + * Return name of the component + * + * @return a string with the name of the sensor + */ + std::string name() + { + return m_name; + } + + /** + * Returns one sample in parts per million (ppm) of CO in the air based on + * the following sensor calibration: 0 ~ 4V is roughly 0 ~ 20 ppm CO + * + * @return a new sample converted to ppm CO + */ + float getPPM(); + + private: + std::string m_name; + }; +}