ecezo: initial implementation; C, C++; FTI + examples

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

examples/c++/CMakeLists.txt

@@ -323,6 +323,7 @@ add_example (dfrec)
 add_example (sht1x)
 add_example (ms5803)
 add_example (ims)
+add_example (ecezo)
 
 # These are special cases where you specify example binary, source file and module(s)
 include_directories (${PROJECT_SOURCE_DIR}/src)

examples/c++/ecezo.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 <signal.h>
+
+#include <upm_utilities.h>
+#include <ecezo.hpp>
+
+using namespace std;
+using namespace upm;
+
+bool shouldRun = true;
+
+void sig_handler(int signo)
+{
+  if (signo == SIGINT)
+    shouldRun = false;
+}
+
+int main()
+{
+    signal(SIGINT, sig_handler);
+
+    //! [Interesting]
+
+    // Instantiate a ECEZO sensor on uart 0 at 9600 baud.
+    upm::ECEZO *sensor = new upm::ECEZO(0, 9600, false);
+
+    // For I2C, assuming the device is configured for address 0x64 on
+    // I2C bus 0, you could use something like:
+    //
+    // upm::ECEZO *sensor = new upm::ECEZO(0, 0x64, true);
+
+    while (shouldRun)
+    {
+        // this will take about 1 second to complete
+        sensor->update();
+
+        cout << "EC "
+             << sensor->getEC()
+             << " uS/cm, TDS "
+             << sensor->getTDS()
+             << " mg/L, Salinity "
+             << sensor->getSalinity()
+             << " PSS-78, SG "
+             << sensor->getSG()
+             << endl;
+
+        upm_delay(5);
+    }
+
+    //! [Interesting]
+
+    cout << "Exiting..." << endl;
+
+    delete sensor;
+
+    return 0;
+}

examples/c/CMakeLists.txt

@@ -140,6 +140,7 @@ add_example (button_intr)
 add_example (my9221)
 add_example (ms5803)
 add_example (ims)
+add_example (ecezo)
 
 # Custom examples
 add_custom_example (nmea_gps_i2c-example-c nmea_gps_i2c.c nmea_gps)

examples/c/ecezo.c

@@ -0,0 +1,85 @@
+/*
+ * 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 <upm_utilities.h>
+#include <ecezo.h>
+
+bool shouldRun = true;
+
+void sig_handler(int signo)
+{
+  if (signo == SIGINT)
+    shouldRun = false;
+}
+
+int main()
+{
+    signal(SIGINT, sig_handler);
+
+    //! [Interesting]
+
+    // Instantiate a ECEZO sensor on uart 0 at 9600 baud.
+    ecezo_context sensor = ecezo_uart_init(0, 9600);
+
+    // For I2C, assuming the device is configured for address 0x64 on
+    // I2C bus 0, you could use something like:
+    //
+    // ecezo_context sensor = ecezo_i2c_init(0, 0x64);
+
+    if (!sensor)
+    {
+        printf("ecezo_init() failed.\n");
+        return 1;
+    }
+
+    while (shouldRun)
+    {
+        // this will take about 1 second to complete
+        if (ecezo_update(sensor))
+        {
+            printf("ecezo_update() failed\n");
+        }
+        else
+        {
+            printf("EC %f uS/cm, TDS %f mg/L, Salinity %f PSS-78, SG %f\n",
+                   ecezo_get_ec(sensor),
+                   ecezo_get_tds(sensor),
+                   ecezo_get_salinity(sensor),
+                   ecezo_get_sg(sensor));
+        }
+
+        upm_delay(5);
+    }
+
+    //! [Interesting]
+
+    printf("Exiting\n");
+
+    ecezo_close(sensor);
+
+    return 0;
+}

examples/java/CMakeLists.txt

@@ -157,6 +157,7 @@ add_example(DFRORP_Example dfrorp)
 add_example(DFREC_Example dfrec)
 add_example(SHT1X_Example sht1x)
 add_example(MS5803_Example ms5803)
+add_example(ECEZO_Example ecezo)
 
 add_example_with_path(Jhd1313m1_lcdSample lcd i2clcd)
 add_example_with_path(Jhd1313m1Sample lcd i2clcd)

examples/java/ECEZO_Example.java

@@ -0,0 +1,60 @@
+/*
+ * 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_ecezo.ECEZO;
+
+public class ECEZO_Example
+{
+    public static void main(String[] args) throws InterruptedException
+    {
+// ! [Interesting]
+
+         // Instantiate a ECEZO sensor on uart 0 at 9600 baud.
+        ECEZO sensor = new ECEZO(0, 9600, false);
+
+        // For I2C, assuming the device is configured for address 0x64 on
+        // I2C bus 0, you could use something like:
+        //
+        // ECEZO sensor = new ECEZO(0, 0x64, true);
+
+        while (true)
+            {
+                // update our values from the sensor
+                sensor.update();
+
+                System.out.println("EC "
+                                   + sensor.getEC()
+                                   + " uS/cm, TDS "
+                                   + sensor.getTDS()
+                                   + " mg/L, Salinity "
+                                   + sensor.getSalinity()
+                                   + " PSS-78, SG "
+                                   + sensor.getSG());
+
+                Thread.sleep(5000);
+            }
+
+// ! [Interesting]
+    }
+}

examples/javascript/ecezo.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_ecezo');
+
+// Instantiate a ECEZO sensor on uart 0 at 9600 baud.
+var sensor = new sensorObj.ECEZO(0, 9600, false);
+
+// For I2C, assuming the device is configured for address 0x64 on
+// I2C bus 0, you could use something like:
+//
+// var sensor = new sensorObj.ECEZO(0, 0x64, true);
+
+setInterval(function()
+{
+    // update our values from the sensor
+    sensor.update();
+
+    console.log("EC "
+                + sensor.getEC()
+                + " uS/cm, TDS "
+                + sensor.getTDS()
+                + " mg/L, Salinity "
+                + sensor.getSalinity()
+                + " PSS-78, SG "
+                + sensor.getSG());
+
+}, 5000);
+
+// exit on ^C
+process.on('SIGINT', function()
+{
+    sensor = null;
+    sensorObj.cleanUp();
+    sensorObj = null;
+    console.log("Exiting.");
+    process.exit(0);
+});

examples/python/ecezo.py

@@ -0,0 +1,66 @@
+#!/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.
+
+from __future__ import print_function
+import time, sys, signal, atexit
+from upm import pyupm_ecezo as sensorObj
+
+def main():
+    # Instantiate a ECEZO sensor on uart 0 at 9600 baud.
+    sensor = sensorObj.ECEZO(0, 9600, False);
+
+    # For I2C, assuming the device is configured for address 0x64 on
+    # I2C bus 0, you could use something like:
+    #
+    # sensor = sensorObj.ECEZO(0, 0x64, True);
+
+    ## 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)
+
+    while (1):
+        sensor.update()
+
+        print("EC "
+              + str(sensor.getEC())
+              + " uS/cm, TDS "
+              + str(sensor.getTDS())
+              + " mg/L, Salinity "
+              + str(sensor.getSalinity())
+              + " PSS-78, SG "
+              + str(sensor.getSG()));
+        time.sleep(5)
+
+if __name__ == '__main__':
+    main()