mq4: Initial implementation

Signed-off-by: Jon Trulson <jtrulson@ics.com>
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>

examples/c++/CMakeLists.txt

@@ -41,6 +41,7 @@ add_executable (mlx90614-example mlx90614.cxx)
 add_executable (ecs1030-example ecs1030.cxx)
 add_executable (mq2-example mq2.cxx)
 add_executable (mq3-example mq3.cxx)
+add_executable (mq4-example mq4.cxx)
 add_executable (mq5-example mq5.cxx)
 add_executable (mq7-example mq7.cxx)
 add_executable (mq8-example mq8.cxx)
@@ -298,6 +299,7 @@ target_link_libraries (mlx90614-example mlx90614 ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (ecs1030-example ecs1030 ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (mq2-example gas ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (mq3-example gas ${CMAKE_THREAD_LIBS_INIT})
+target_link_libraries (mq4-example gas ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (mq5-example gas ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (mq7-example gas ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (mq8-example gas ${CMAKE_THREAD_LIBS_INIT})

examples/c++/mq4.cxx

@@ -0,0 +1,81 @@
+/*
+ * Author: Jon Trulson <jtrulson@ics.com>
+ * Copyright (c) 2015 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 <unistd.h>
+#include <iostream>
+#include "mq4.h"
+#include <signal.h>
+#include <stdlib.h>
+#include <sys/time.h>
+
+bool shouldRun = true;
+
+using namespace std;
+
+void
+sig_handler(int signo)
+{
+  if (signo == SIGINT) 
+    {
+      shouldRun = false;
+    }
+}
+
+//! [Interesting]
+int main(int argc, char **argv)
+{
+  // Attach gas sensor to Analog A0
+  upm::MQ4 *sensor = new upm::MQ4(0);
+  signal(SIGINT, sig_handler);
+  
+  uint16_t buffer [128];
+
+  thresholdContext ctx;
+  ctx.averageReading = 0;
+  ctx.runningAverage = 0;
+  ctx.averagedOver   = 2;
+  
+  // Infinite loop, ends when script is cancelled
+  // Repeatedly, take a sample every 2 microseconds;
+  // find the average of 128 samples; and
+  // print a running graph of asteriskss as averages
+  while (shouldRun) 
+    {
+      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 ....
+        }
+      }
+    }
+  
+  cout << "Exiting" << endl;
+  
+  delete sensor;
+  
+  return 0;
+}
+//! [Interesting]

examples/javascript/mq4.js

@@ -0,0 +1,60 @@
+/*jslint node:true, vars:true, bitwise:true, unparam:true */
+/*jshint unused:true */
+/*
+ * Author: Jon Trulson <jtrulson@ics.com>
+ * Copyright (c) 2015 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 upmGAS = require("jsupm_gas");
+
+// Attach gas sensor to Analog A0
+var sensor = new upmGAS.MQ4(0);
+
+var threshContext = new upmGAS.thresholdContext;
+threshContext.averageReading = 0;
+threshContext.runningAverage = 0;
+threshContext.averagedOver = 2;
+
+// Infinite loop, ends when script is cancelled
+// Repeatedly, take a sample every 2 microseconds;
+// find the average of 128 samples; and
+// print a running graph of asteriskss as averages
+
+while(1)
+{
+    var buffer = new upmGAS.uint16Array(128);
+    var len = sensor.getSampledWindow(2, 128, buffer);
+    if (len)
+    {
+        var thresh = sensor.findThreshold(threshContext, 30, buffer, len);
+        sensor.printGraph(threshContext, 5);
+        //if (thresh)
+        //    console.log("Threshold is " + thresh);
+    }
+}
+
+// Print message when exiting
+process.on('SIGINT', function()
+{
+	console.log("Exiting...");
+	process.exit(0);
+});

examples/python/mq4.py

@@ -0,0 +1,62 @@
+#!/usr/bin/python
+# Author: Jon Trulson <jtrulson@ics.com>
+# Copyright (c) 2015 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.
+
+import time, sys, signal, atexit
+import pyupm_gas as upmGAS
+
+# Attach gas sensor to Analog A0
+sensor = upmGAS.MQ4(0)
+
+
+## Exit handlers ##
+# This function stops python from printing a stacktrace when you hit control-C
+def SIGINTHandler(signum, frame):
+	raise SystemExit
+
+# This function lets you run code on exit, including functions from sensor
+def exitHandler():
+	print "Exiting"
+	sys.exit(0)
+
+# Register exit handlers
+atexit.register(exitHandler)
+signal.signal(signal.SIGINT, SIGINTHandler)
+
+
+threshContext = upmGAS.thresholdContext()
+threshContext.averageReading = 0
+threshContext.runningAverage = 0
+threshContext.averagedOver = 2
+
+# Infinite loop, ends when script is cancelled
+# Repeatedly, take a sample every 2 microseconds;
+# find the average of 128 samples; and
+# print a running graph of asteriskss as averages
+mybuffer = upmGAS.uint16Array(128)
+while(1):
+	samplelen = sensor.getSampledWindow(2, 128, mybuffer)
+	if samplelen:
+		thresh = sensor.findThreshold(threshContext, 30, mybuffer, samplelen)
+		sensor.printGraph(threshContext, 5)
+#		if(thresh):
+#			print "Threshold is ", thresh

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 mq7.cxx mq8.cxx mq9.cxx tp401.cxx)
-set (module_h ${libname}.h mq2.h mq3.h mq5.h mq7.h mq8.h mq9.h tp401.h)
+set (module_src ${libname}.cxx mq2.cxx mq3.cxx mq4.cxx mq5.cxx mq7.cxx mq8.cxx mq9.cxx tp401.cxx)
+set (module_h ${libname}.h mq2.h mq3.h mq4.h mq5.h mq7.h mq8.h mq9.h tp401.h)
 upm_module_init()

src/gas/javaupm_gas.i

@@ -6,6 +6,7 @@
     #include "gas.h"
     #include "mq2.h"
     #include "mq3.h"
+    #include "mq4.h"
     #include "mq5.h"
     #include "mq7.h"
     #include "mq8.h"
@@ -46,6 +47,7 @@
 %include "gas.h"
 %include "mq2.h"
 %include "mq3.h"
+%include "mq4.h"
 %include "mq5.h"
 %include "mq7.h"
 %include "mq8.h"

src/gas/jsupm_gas.i

@@ -23,6 +23,11 @@
     #include "mq3.h"
 %}
 
+%include "mq4.h"
+%{
+    #include "mq4.h"
+%}
+
 %include "mq5.h"
 %{
     #include "mq5.h"

src/gas/mq4.cxx

@@ -0,0 +1,35 @@
+/*
+ * Author: Jon Trulson <jtrulson@ics.com>
+ * Copyright (c) 2015 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 "mq4.h"
+
+using namespace upm;
+
+MQ4::MQ4 (int gasPin) : Gas (gasPin)
+{
+}
+
+MQ4::~MQ4 ()
+{
+}

src/gas/mq4.h

@@ -0,0 +1,75 @@
+/*
+ * Author: Jon Trulson <jtrulson@ics.com>
+ * Copyright (c) 2015 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 <iostream>
+#include <string>
+#include "gas.h"
+
+namespace upm {
+  /**
+   * @library gas
+   * @sensor mq4
+   * @comname DFRobot MQ4 Gas Sensor
+   * @type gaseous
+   * @man dfrobot
+   * @con analog
+   *
+   * @brief API for the DFRobot MQ4 Gas Sensor
+   *
+   * The MQ4 Gas Sensor module is useful for detecting CH4 (Methane),
+   * and natural gas concentrations in the air.  It has a
+   * detection range of 100-10000 ppm.
+   *
+   * For optimum use, it requires calibration after a pre-heat time of
+   * at least 24 hours.  See the datasheet for details.
+   *
+   * @image html mq2-5.jpeg
+   * @snippet mq4.cxx Interesting
+   */
+    class MQ4 : public Gas {
+        public:
+            /**
+             * MQ4 constructor
+             *
+             * @param gasPin Analog pin where the sensor is connected
+             */
+            MQ4 (int gasPin);
+
+            /**
+             * MQ4 destructor
+             */
+            ~MQ4 ();
+
+            /**
+             * Returns the name of the sensor
+             */
+            std::string name()
+            {
+                return m_name;
+            }
+        private:
+            std::string m_name;
+    };
+}

src/gas/pyupm_gas.i

@@ -25,6 +25,11 @@
     #include "mq3.h"
 %}
 
+%include "mq4.h"
+%{
+    #include "mq4.h"
+%}
+
 %include "mq5.h"
 %{
     #include "mq5.h"