ims: Initial turnin of I2C Moisture Sensor

* Added C library
    * Added CXX library
    * Added C/CXX/java/js/python examples

Signed-off-by: Noel Eck <noel.eck@intel.com>

examples/c++/CMakeLists.txt

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

examples/c++/ims.cxx

@@ -0,0 +1,69 @@
+/*
+ * Author: Noel Eck <noel.eck@intel.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 "ims.hpp"
+
+using namespace upm;
+
+int shouldRun = true;
+
+void sig_handler(int signo)
+{
+    if (signo == SIGINT)
+        shouldRun = false;
+}
+
+int main(int argc, char **argv)
+{
+    signal(SIGINT, sig_handler);
+    //! [Interesting]
+
+    // Instantiate a IMS instance using i2c bus 0 and default address
+    upm::IMS sensor(0);
+
+    while (shouldRun)
+    {
+        std::cout << "Version: "
+            << sensor.get_version()
+            << " light: "
+            << sensor.get_light()
+            << " moisture: "
+            << sensor.get_moisture()
+            << " temp: "
+            << sensor.get_temperature()
+            << " C"
+            << std::endl;
+
+        sleep(1);
+    }
+    //! [Interesting]
+
+    std::cout << "Exiting..." << std::endl;
+
+    return 0;
+}

examples/c/CMakeLists.txt

@@ -23,7 +23,7 @@ macro(add_custom_example example_bin example_src example_module_list)
       set(found_all_modules FALSE)
     endif()
     if (MODULE_LIST)
-      list(FIND MODULE_LIST ${module}-c index)
+      list(FIND MODULE_LIST ${module} index)
       if (${index} EQUAL -1)
         set(found_all_modules FALSE)
       endif()
@@ -139,6 +139,7 @@ add_example (button)
 add_example (button_intr)
 add_example (my9221)
 add_example (ms5803)
+add_example (ims)
 
 # Custom examples
 add_custom_example (nmea_gps_i2c-example-c nmea_gps_i2c.c nmea_gps)

examples/c/ims.c

@@ -0,0 +1,75 @@
+/*
+ * Author: Noel Eck <noel.eck@intel.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 <stdio.h>
+#include <signal.h>
+
+#include "ims.h"
+#include "upm_utilities.h"
+
+bool shouldRun = true;
+
+void sig_handler(int signo)
+{
+    if (signo == SIGINT)
+        shouldRun = false;
+}
+
+int main()
+{
+    signal(SIGINT, sig_handler);
+
+    //! [Interesting]
+    ims_context* sensor = ims_init(0, IMS_ADDRESS_DEFAULT);
+
+    if (!sensor)
+    {
+        printf("ims_init() failed\n");
+        return 1;
+    }
+
+    // Every second, sample the sensor outputs
+    while (shouldRun)
+    {
+        uint16_t version, light, moisture, temp;
+
+        if (ims_get_version(sensor, &version) == UPM_SUCCESS &&
+            ims_get_light(sensor, &light) == UPM_SUCCESS &&
+            ims_get_moisture(sensor, &moisture) == UPM_SUCCESS &&
+            ims_get_temperature(sensor, &temp) == UPM_SUCCESS)
+            printf("Version: %d light: 0x%04x moisture: 0x%04x temp: %3.2f C\n",
+                    version, light, moisture, temp/10.0);
+        else
+            break;
+
+        upm_delay(1);
+    }
+
+    //! [Interesting]
+    printf("Exiting\n");
+    ims_close(sensor);
+
+    return 0;
+}

examples/java/IMS_Example.java

@@ -0,0 +1,53 @@
+/*
+ * 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_ims.IMS;
+
+public class IMS_Example
+{
+    public static void main(String[] args) throws InterruptedException
+    {
+        // ! [Interesting]
+
+        // Instantiate a IMS instance using bus 0 and default i2c address
+        IMS sensor = new IMS(0);
+
+        while (true)
+        {
+            System.out.println("Version: "
+                    + sensor.get_version()
+                    + " light: "
+                    + sensor.get_light()
+                    + " moisture: "
+                    + sensor.get_moisture()
+                    + " temp: "
+                    + sensor.get_temperature()
+                    + " C");
+
+            Thread.sleep(1000);
+        }
+
+        // ! [Interesting]
+    }
+}

examples/javascript/ims.js

@@ -0,0 +1,51 @@
+/*
+ * Author: Noel Eck <noel.eck@intel.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_ims');
+
+// Instantiate a IMS instance using bus 0 and default i2c address
+var sensor = new sensorObj.IMS(0);
+
+setInterval(function()
+{
+    console.log("Version: "
+                + sensor.get_version()
+                + " light: "
+                + sensor.get_light()
+                + " moisture: "
+                + sensor.get_moisture()
+                + " temp: "
+                + sensor.get_temperature().toFixed(2)
+                + " C");
+}, 1000);
+
+// exit on ^C
+process.on('SIGINT', function()
+{
+    sensor = null;
+    sensorObj.cleanUp();
+    sensorObj = null;
+    console.log("Exiting.");
+    process.exit(0);
+});

examples/python/ims.py

@@ -0,0 +1,44 @@
+#!/usr/bin/python
+# Author: Noel Eck <noel.eck@intel.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_ims
+
+def main():
+    # Create an instance of the I2C Moisture Sensor
+    # I2C bus 0, default address = 0x20
+    ims = pyupm_ims.IMS(0)
+
+    print ('I2C moisture sensor example...')
+    while (1):
+        try:
+            print ('Version: %d light: 0x%04x moisture: 0x%04x temp: %3.2f C' \
+                    % (ims.get_version(), ims.get_light(), ims.get_moisture(),
+                    ims.get_temperature()))
+            time.sleep(1)
+        except KeyboardInterrupt:
+            break
+
+if __name__ == '__main__':
+    main()