dfrec: Initial implementation

This module implements support for the DFRobot EC (Electrical
Conductivity) meter.  It relies on the use of the DS18B20 UPM C module
for temperature gathering.

It has a pretty complicated calibration procedure which is somewhat
documented on the DFRobot wiki.  Functions have been added to support
changing the various coefficients as desired.

Signed-off-by: Jon Trulson <jtrulson@ics.com>

examples/c++/CMakeLists.txt

@@ -278,6 +278,7 @@ add_example (mma7361)
 add_example (bh1750)
 add_example (hka5)
 add_example (dfrorp)
+add_example (dfrec)
 
 # These are special cases where you specify example binary, source file and module(s)
 include_directories (${PROJECT_SOURCE_DIR}/src)

examples/c++/dfrec.cxx

@@ -0,0 +1,81 @@
+/*
+ * Author: Jon Trulson <jtrulson@ics.com>
+ * Copyright (c) 2016 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 <signal.h>
+
+#include "dfrec.hpp"
+
+using namespace std;
+
+bool shouldRun = true;
+
+void sig_handler(int signo)
+{
+  if (signo == SIGINT)
+    shouldRun = false;
+}
+
+int main()
+{
+  signal(SIGINT, sig_handler);
+
+//! [Interesting]
+
+  // Instantiate a DFRobot EC sensor on analog pin A0, with a ds18b20
+  // temperature sensor connected to UART 0, and a device index (for
+  // the ds1820b uart bus) of 0, and an analog reference voltage of
+  // 5.0.
+  upm::DFREC *sensor = new upm::DFREC(0, 0, 0, 5.0);
+
+  // Every 2 seconds, update and print values
+  while (shouldRun)
+    {
+      sensor->update();
+
+      cout << "EC = "
+           << sensor->getEC()
+           << " ms/cm"
+           << endl;
+
+      cout << "Volts = "
+           << sensor->getVolts()
+           << ", Temperature = "
+           << sensor->getTemperature()
+           << " C"
+           << endl;
+
+      cout << endl;
+
+      sleep(2);
+    }
+
+//! [Interesting]
+
+  cout << "Exiting" << endl;
+
+  delete sensor;
+  return 0;
+}

examples/c/CMakeLists.txt

@@ -117,6 +117,7 @@ add_example (collision)
 add_example (moisture)
 add_example (led)
 add_example (ds18b20)
+add_example (dfrec)
 
 # Custom examples
 add_custom_example (nmea_gps_i2c-example-c nmea_gps_i2c.c nmea_gps)

examples/c/dfrec.c

@@ -0,0 +1,76 @@
+/*
+ * Author: Jon Trulson <jtrulson@ics.com>
+ * Copyright (c) 2016 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 <signal.h>
+
+#include "dfrec.h"
+
+bool shouldRun = true;
+
+void sig_handler(int signo)
+{
+  if (signo == SIGINT)
+    shouldRun = false;
+}
+
+int main()
+{
+  signal(SIGINT, sig_handler);
+
+//! [Interesting]
+
+  // Instantiate a DFRobot EC sensor on analog pin A0, with a ds18b20
+  // temperature sensor connected to UART 0, and a device index (for
+  // the ds1820b uart bus) of 0, and an analog reference voltage of
+  // 5.0.
+  dfrec_context sensor = dfrec_init(0, 0, 0, 5.0);
+
+  if (!sensor)
+    {
+      printf("dfrec_init() failed.\n");
+      return(1);
+    }
+
+  // Every 2 seconds, update and print values
+  while (shouldRun)
+    {
+      dfrec_update(sensor);
+
+      printf("EC = %f ms/cm\n", dfrec_get_ec(sensor));
+      printf("Volts = %f, Temperature = %f C\n",
+             dfrec_get_volts(sensor), dfrec_get_temperature(sensor));
+      printf("\n");
+
+      sleep(2);
+    }
+
+//! [Interesting]
+
+  printf("Exiting...\n");
+
+  dfrec_close(sensor);
+
+  return 0;
+}

examples/java/CMakeLists.txt

@@ -135,6 +135,7 @@ add_example(MMA7361_Example mma7361)
 add_example(BH1750_Example bh1750)
 add_example(HKA5_Example hka5)
 add_example(DFRORP_Example dfrorp)
+add_example(DFREC_Example dfrec)
 
 add_example_with_path(Jhd1313m1_lcdSample lcd i2clcd)
 add_example_with_path(Jhd1313m1Sample lcd i2clcd)

examples/java/DFREC_Example.java

@@ -0,0 +1,59 @@
+/*
+ * Author: Jon Trulson <jtrulson@ics.com>
+ * Copyright (c) 2016 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 upm_dfrec.DFREC;
+
+public class DFREC_Example
+{
+    public static void main(String[] args) throws InterruptedException
+    {
+// ! [Interesting]
+
+        // Instantiate a DFRobot EC sensor on analog pin A0, with a ds18b20
+        // temperature sensor connected to UART 0, and a device index (for
+        // the ds1820b uart bus) of 0, and an analog reference voltage of
+        // 5.0.
+        DFREC sensor = new DFREC(0, 0, 0, 5.0f);
+
+        // Every 2 seconds, update and print values
+        while (true)
+            {
+                sensor.update();
+
+                System.out.println("EC = "
+                                   + sensor.getEC()
+                                   + " ms/cm");
+                System.out.println("Volts = "
+                                   + sensor.getVolts()
+                                   + ", Temperature = "
+                                   + sensor.getTemperature()
+                                   + " C");
+
+                System.out.println();
+                Thread.sleep(2000);
+            }
+
+// ! [Interesting]
+    }
+}

examples/javascript/dfrec.js

@@ -0,0 +1,59 @@
+/*
+ * Author: Jon Trulson <jtrulson@ics.com>
+ * Copyright (c) 2016 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 sensorObj = require('jsupm_dfrec');
+
+// Instantiate a DFRobot EC sensor on analog pin A0, with a ds18b20
+// temperature sensor connected to UART 0, and a device index (for
+// the ds1820b uart bus) of 0, and an analog reference voltage of
+// 5.0.
+var sensor = new sensorObj.DFREC(0, 0, 0, 5.0);
+
+// Every 2 seconds, update and print values
+setInterval(function()
+{
+    sensor.update();
+
+    console.log("EC = "
+                + sensor.getEC()
+                + " ms/cm");
+    console.log("Volts = "
+                + sensor.getVolts()
+                + ", Temperature = "
+                + sensor.getTemperature()
+                + " C");
+
+    console.log();
+
+}, 2000);
+
+// exit on ^C
+process.on('SIGINT', function()
+{
+    sensor = null;
+    sensorObj.cleanUp();
+    sensorObj = null;
+    console.log("Exiting.");
+    process.exit(0);
+});

examples/python/dfrec.py

@@ -0,0 +1,56 @@
+#!/usr/bin/python
+# Author: Jon Trulson <jtrulson@ics.com>
+# Copyright (c) 2016 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_dfrec as sensorObj
+
+# Instantiate a DFRobot EC sensor on analog pin A0, with a ds18b20
+# temperature sensor connected to UART 0, and a device index (for
+# the ds1820b uart bus) of 0, and an analog reference voltage of
+# 5.0.
+sensor = sensorObj.DFREC(0, 0, 0, 5.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
+def exitHandler():
+	print "Exiting"
+	sys.exit(0)
+
+# Register exit handlers
+atexit.register(exitHandler)
+signal.signal(signal.SIGINT, SIGINTHandler)
+
+# Every 2 seconds, update and print values
+while (True):
+        sensor.update()
+
+        print "EC =", sensor.getEC(), "ms/cm"
+        print "Volts =", sensor.getVolts(),
+        print ", Temperature = ", sensor.getTemperature(), "C"
+        print
+
+	time.sleep(2)