From 4eb6c4e19dfc5a1ddcd4826baead90aba0ad6522 Mon Sep 17 00:00:00 2001 From: Kiveisha Yevgeniy Date: Tue, 26 Aug 2014 19:33:39 +0000 Subject: [PATCH] mq9:: added new sensor Signed-off-by: Kiveisha Yevgeniy --- examples/CMakeLists.txt | 3 ++ examples/mq9-example.cxx | 74 +++++++++++++++++++++++++++++++++ src/gas/CMakeLists.txt | 5 +++ src/gas/gas.cxx | 105 +++++++++++++++++++++++++++++++++++++++++++++++ src/gas/gas.h | 104 ++++++++++++++++++++++++++++++++++++++++++++++ src/gas/jsupm_gas.i | 9 ++++ src/gas/mq9.cxx | 33 +++++++++++++++ src/gas/mq9.h | 60 +++++++++++++++++++++++++++ src/gas/pyupm_gas.i | 12 ++++++ 9 files changed, 405 insertions(+) create mode 100644 examples/mq9-example.cxx create mode 100644 src/gas/CMakeLists.txt create mode 100644 src/gas/gas.cxx create mode 100644 src/gas/gas.h create mode 100644 src/gas/jsupm_gas.i create mode 100644 src/gas/mq9.cxx create mode 100644 src/gas/mq9.h create mode 100644 src/gas/pyupm_gas.i diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt index 718bf1b..2d165a2 100644 --- a/examples/CMakeLists.txt +++ b/examples/CMakeLists.txt @@ -29,6 +29,7 @@ add_executable (nrf8001-helloworld-example nrf8001_helloworld.cxx) add_executable (lpd8806-example lpd8806-example.cxx) add_executable (mlx90614-example mlx90614-example.cxx) add_executable (ecs1030-example ecs1030-example.cxx) +add_executable (mq9-example mq9-example.cxx) include_directories (${PROJECT_SOURCE_DIR}/src/hmc5883l) include_directories (${PROJECT_SOURCE_DIR}/src/grove) @@ -55,6 +56,7 @@ include_directories (${PROJECT_SOURCE_DIR}/src/nrf8001) include_directories (${PROJECT_SOURCE_DIR}/src/lpd8806) include_directories (${PROJECT_SOURCE_DIR}/src/mlx90614) include_directories (${PROJECT_SOURCE_DIR}/src/ecs1030) +include_directories (${PROJECT_SOURCE_DIR}/src/gas) target_link_libraries (compass hmc5883l ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (groveled grove ${CMAKE_THREAD_LIBS_INIT}) @@ -87,3 +89,4 @@ target_link_libraries (nrf8001-helloworld-example nrf8001 ${CMAKE_THREAD_LIBS_IN target_link_libraries (lpd8806-example lpd8806 ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (mlx90614-example mlx90614 ${CMAKE_THREAD_LIBS_INIT}) target_link_libraries (ecs1030-example ecs1030 ${CMAKE_THREAD_LIBS_INIT}) +target_link_libraries (mq9-example gas ${CMAKE_THREAD_LIBS_INIT}) diff --git a/examples/mq9-example.cxx b/examples/mq9-example.cxx new file mode 100644 index 0000000..b62dad3 --- /dev/null +++ b/examples/mq9-example.cxx @@ -0,0 +1,74 @@ +/* + * Author: Yevgeniy Kiveisha + * 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 "mq9.h" +#include +#include +#include + +int is_running = 0; +uint16_t buffer [128]; +upm::MQ9 *sensor = NULL; + +void +sig_handler(int signo) +{ + printf("got signal\n"); + if (signo == SIGINT) { + is_running = 1; + } +} + +//! [Interesting] +int +main(int argc, char **argv) +{ + sensor = new upm::MQ9(0); + signal(SIGINT, sig_handler); + + thresholdContext ctx; + ctx.averageReading = 0; + ctx.runningAverage = 0; + ctx.averagedOver = 2; + + while (!is_running) { + int len = sensor->getSampledWindow (2, 128, buffer); + if (len) { + int thresh = sensor->findThreshold (&ctx, 30, buffer, len); + sensor->printGraph(&ctx, 5); + if (thresh) { + // do something .... + } + } + } + + std::cout << "exiting application" << std::endl; + + delete sensor; + + return 0; +} +//! [Interesting] diff --git a/src/gas/CMakeLists.txt b/src/gas/CMakeLists.txt new file mode 100644 index 0000000..0131dd5 --- /dev/null +++ b/src/gas/CMakeLists.txt @@ -0,0 +1,5 @@ +set (libname "gas") +set (libdescription "Gas sensors") +set (module_src ${libname}.cxx mq9.cxx) +set (module_h ${libname}.h mq9.h) +upm_module_init() diff --git a/src/gas/gas.cxx b/src/gas/gas.cxx new file mode 100644 index 0000000..555bdf3 --- /dev/null +++ b/src/gas/gas.cxx @@ -0,0 +1,105 @@ +/* + * Author: Brendan Le Foll + * 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 +#include +#include "gas.h" + +using namespace upm; + +Gas::Gas(int gasPin) { + // initialise analog gas input + m_gasCtx = mraa_aio_init(gasPin); +} + +Gas::~Gas() { + // close analog input + mraa_result_t error; + error = mraa_aio_close(m_gasCtx); + if (error != MRAA_SUCCESS) { + mraa_result_print(error); + } +} + +int +Gas::getSampledWindow (unsigned int freqMS, unsigned int numberOfSamples, + uint16_t * buffer) { + int sampleIdx = 0; + + // must have freq + if (!freqMS) { + return 0; + } + + // too much samples + if (numberOfSamples > 0xFFFFFF) { + return 0; + } + + while (sampleIdx < numberOfSamples) { + buffer[sampleIdx++] = mraa_aio_read (m_gasCtx); + usleep(freqMS * 1000); + } + + return sampleIdx; +} + +int +Gas::findThreshold (thresholdContext* ctx, unsigned int threshold, + uint16_t * buffer, unsigned int len) { + long sum = 0; + for (unsigned int i = 0; i < len; i++) { + sum += buffer[i]; + } + + ctx->averageReading = sum / len; + ctx->runningAverage = (((ctx->averagedOver-1) * ctx->runningAverage) + ctx->averageReading) / ctx->averagedOver; + + if (ctx->runningAverage > threshold) { + return ctx->runningAverage; + } else { + return 0; + } +} + +int +Gas::getSampledData (thresholdContext* ctx) { + return ctx->runningAverage; +} + +int +Gas::getSample (thresholdContext* ctx) { + return mraa_aio_read (m_gasCtx); +} + +void +Gas::printGraph (thresholdContext* ctx, uint8_t resolution) { + std::cout << "(" << ctx->runningAverage << ") | "; + for (int i = 0; i < ctx->runningAverage / resolution; i++) + std::cout << "*"; + std::cout << std::endl; +} diff --git a/src/gas/gas.h b/src/gas/gas.h new file mode 100644 index 0000000..22453a4 --- /dev/null +++ b/src/gas/gas.h @@ -0,0 +1,104 @@ +/* + * Author: Brendan Le Foll + * 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 + +struct thresholdContext { + long averageReading; + long runningAverage; + int averagedOver; +}; + +namespace upm { + +/** + * @brief C++ API for Gas sensors + * + * This file defines the Gas Analog sensors + */ +class Gas { + public: + /** + * Instanciates a Gas object + * + * @param gasPin pin where gas is connected + */ + Gas(int gasPin); + + /** + * Gas object destructor + */ + ~Gas(); + + /** + * Get samples from gas sensor according to provided window and + * number of samples + * + * @param freqMS time between each sample (in microseconds) + * @param numberOfSamples number of sample to sample for this window + * @param buffer bufer with sampled data + */ + virtual int getSampledWindow (unsigned int freqMS, unsigned int numberOfSamples, uint16_t * buffer); + + /** + * Given sampled buffer this method will return TRUE/FALSE if threshold + * was reached + * + * @param ctx threshold context + * @param threshold sample threshold + * @param buffer buffer with samples + * @param len bufer len + */ + virtual int findThreshold (thresholdContext* ctx, unsigned int threshold, uint16_t * buffer, unsigned int len); + + /** + * Return avarage data for the sampled window + * + * @param ctx threshold context + */ + virtual int getSampledData (thresholdContext* ctx); + + /** + * Return one sample from the sensor + * + * @param ctx threshold context + */ + virtual int getSample (thresholdContext* ctx); + + /** + * + * Print running average of threshold context + * + * @param ctx threshold context + */ + virtual void printGraph (thresholdContext* ctx, uint8_t resolution); + + protected: + mraa_aio_context m_gasCtx; +}; + +} diff --git a/src/gas/jsupm_gas.i b/src/gas/jsupm_gas.i new file mode 100644 index 0000000..5009e88 --- /dev/null +++ b/src/gas/jsupm_gas.i @@ -0,0 +1,9 @@ +%module jsupm_gas +%include "../upm.i" +%include "../carrays_uint16_t.i" + +%{ + #include "gas.h" +%} + +%include "gas.h" diff --git a/src/gas/mq9.cxx b/src/gas/mq9.cxx new file mode 100644 index 0000000..f9ee171 --- /dev/null +++ b/src/gas/mq9.cxx @@ -0,0 +1,33 @@ +/* + * Author: Brendan Le Foll + * 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 "mq9.h" + +using namespace upm; + +MQ9::MQ9 (int gasPin) : Gas (gasPin) { +} + +MQ9::~MQ9 () { +} diff --git a/src/gas/mq9.h b/src/gas/mq9.h new file mode 100644 index 0000000..9017c5b --- /dev/null +++ b/src/gas/mq9.h @@ -0,0 +1,60 @@ +/* + * Author: Brendan Le Foll + * 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 MQ9 gas sensor + * + * @snippet mq9-example.cxx Interesting + */ + class MQ9 : public Gas { + public: + /** + * Jhd1313m1 constructor + * + * @param gasPin analog pin where sensor connected + */ + MQ9 (int gasPin); + + /** + * MQ9 destructor + */ + ~MQ9 (); + + /** + * Return name of the component + */ + std::string name() + { + return m_name; + } + private: + std::string m_name; + }; +} diff --git a/src/gas/pyupm_gas.i b/src/gas/pyupm_gas.i new file mode 100644 index 0000000..ee84d6b --- /dev/null +++ b/src/gas/pyupm_gas.i @@ -0,0 +1,12 @@ +%module pyupm_gas +%include "../upm.i" +%include "../carrays_uint16_t.i" + +%include "stdint.i" + +%feature("autodoc", "3"); + +%include "gas.h" +%{ + #include "gas.h" +%} -- 2.7.4