Moisture: Add C Src and Example

Changed from GroveMoisture.

Signed-off-by: Abhishek Malik <abhishek.malik@intel.com>

src/moisture/CMakeLists.txt

@@ -0,0 +1,9 @@
+upm_mixed_module_init (NAME moisture
+    DESCRIPTION "upm analog moisture module"
+    C_HDR moisture.h
+    C_SRC moisture.c
+    CPP_HDR moisture.hpp
+    CPP_SRC moisture.cxx
+    FTI_SRC moisture_fti.c
+    CPP_WRAPS_C
+    REQUIRES libmraa)

src/moisture/javaupm_moisture.i

@@ -0,0 +1,19 @@
+%module javaupm_moisture
+%include "../upm.i"
+
+%{
+    #include "moisture.hpp"
+%}
+
+%include "moisture.hpp"
+
+%pragma(java) jniclasscode=%{
+    static {
+        try {
+            System.loadLibrary("javaupm_moisture");
+        } catch (UnsatisfiedLinkError e) {
+            System.err.println("Native code library failed to load. \n" + e);
+            System.exit(1);
+        }
+    }
+%}

src/moisture/jsupm_moisture.i

@@ -0,0 +1,8 @@
+%module jsupm_moisture
+%include "../upm.i"
+
+%{
+    #include "moisture.hpp"
+%}
+
+%include "moisture.hpp"

src/moisture/moisture.c

@@ -0,0 +1,61 @@
+/*
+ * Author: Jon Trulson <jtrulson@ics.com>
+ *         Abhishek Malik <abhishek.malik@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 "moisture.h"
+
+moisture_context moisture_init(int pin) {
+    moisture_context dev =
+      (moisture_context) malloc(sizeof(struct _moisture_context));
+
+    if (dev == NULL) {
+        printf("Unable to allocate memory for device context\n");
+        return NULL;
+    }
+
+    dev->analog_pin = pin;
+    dev->aio = mraa_aio_init(dev->analog_pin);
+
+    if (dev->aio == NULL) {
+        printf("mraa_aio_init() failed.\n");
+        free(dev);
+
+        return NULL;
+    }
+
+    return dev;
+}
+
+void moisture_close(moisture_context dev) {
+    mraa_aio_close(dev->aio);
+    free(dev);
+}
+
+upm_result_t moisture_get_moisture(moisture_context dev,
+                                            int* moisture) {
+
+    *moisture = mraa_aio_read(dev->aio);
+
+    return UPM_SUCCESS;
+}

src/moisture/moisture.cxx

@@ -0,0 +1,48 @@
+/*
+ * Author: Jon Trulson <jtrulson@ics.com>
+ * 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 <iostream>
+#include <string>
+#include <stdexcept>
+
+#include "moisture.hpp"
+
+using namespace upm;
+
+Moisture::Moisture(int pin)
+{
+  if ( !(m_aio = mraa_aio_init(pin)) )
+    throw std::invalid_argument(std::string(__FUNCTION__) +
+                                ": mraa_aio_init() failed, invalid pin?");
+}
+
+Moisture::~Moisture()
+{
+  mraa_aio_close(m_aio);
+}
+
+int Moisture::value()
+{
+  return mraa_aio_read(m_aio);
+}

src/moisture/moisture.h

@@ -0,0 +1,74 @@
+/*
+ * Author: Jon Trulson <jtrulson@ics.com>
+ *         Abhishek Malik <abhishek.malik@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.
+ */
+
+#pragma once
+
+#include <stdlib.h>
+#include <unistd.h>
+#include <string.h>
+
+#include "upm.h"
+#include "mraa/aio.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * device context
+ */
+typedef struct _moisture_context {
+    mraa_aio_context    aio;
+    uint16_t            analog_pin;
+} *moisture_context;
+
+/**
+ * Init function
+ *
+ * @param pin analog pin number
+ * @return void* pointer to the sensor struct
+ */
+moisture_context moisture_init(int pin);
+
+/**
+ * Close function
+ *
+ * @param dev pointer to the sensor structure
+ */
+void moisture_close(moisture_context dev);
+
+/**
+ * Get Moisture function.
+ *
+ * @param dev pointer to the sensor struct
+ * @param moisture pointer that will be used to store the
+ * output value from the sensor
+ */
+upm_result_t moisture_get_moisture(moisture_context dev,
+                                        int* moisture);
+
+#ifdef __cplusplus
+}
+#endif

src/moisture/moisture.hpp

@@ -0,0 +1,82 @@
+/*
+ * Author: Jon Trulson <jtrulson@ics.com>
+ * 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 <string>
+#include <mraa/aio.h>
+
+namespace upm {
+  /**
+   * @brief Moisture Sensor library
+   * @defgroup grovemoisture libupm-grovemoisture
+   * @ingroup seeed analog liquid eak hak
+   */
+
+  /**
+   * @library moisture
+   * @sensor moisture
+   * @comname Moisture Sensor
+   * @altname Grove Moisture Sensor
+   * @type liquid
+   * @man seeed
+   * @con analog
+   * @kit eak hak
+   *
+   * @brief API for the Moisture Sensor
+   *
+   * UPM module for the Moisture Sensor.
+   * This sensor can be used to detect the moisture content
+   * of soil or whether there is water around the sensor.
+   * As the moisture content increases, so does the value that is read.
+   * Note: this sensor is not designed to be left in soil
+   * nor to be used outdoors.
+   *
+   * @image html grovemoisture.jpg
+   * @snippet moisture.cxx Interesting
+   */
+  class Moisture {
+  public:
+    /**
+     * Analog moisture sensor constructor
+     *
+     * @param pin Analog pin to use
+     */
+    Moisture(int pin);
+    /**
+     * Moisture destructor
+     */
+    ~Moisture();
+    /**
+     * Gets the moisture value from the sensor
+     *
+     * @return Moisture reading
+     */
+    int value();
+
+  private:
+    mraa_aio_context m_aio;
+  };
+}
+
+

src/moisture/moisture_fti.c

@@ -0,0 +1,88 @@
+/*
+ * Author: Jon Trulson <jtrulson@ics.com>
+ *         Abhishek Malik <abhishek.malik@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 "moisture.h"
+#include "upm_fti.h"
+
+/**
+ * This file implements the Function Table Interface (FTI) for this sensor
+ */
+
+const char upm_moisture_name[] = "Moisture";
+const char upm_moisture_description[] = "Analog Moisture Sensor";
+const upm_protocol_t upm_moisture_protocol[] = {UPM_ANALOG};
+const upm_sensor_t upm_moisture_category[] = {UPM_MOISTURE};
+
+// forward declarations
+const void* upm_moisture_get_ft(upm_sensor_t sensor_type);
+void* upm_moisture_init_name();
+void upm_moisture_close(void* dev);
+upm_result_t upm_moisture_get_moisture(void* dev, int* moisture);
+
+
+const upm_sensor_descriptor_t upm_moisture_get_descriptor (){
+    upm_sensor_descriptor_t usd;
+    usd.name = upm_moisture_name;
+    usd.description = upm_moisture_description;
+    usd.protocol_size = 1;
+    usd.protocol = upm_moisture_protocol;
+    usd.category_size = 1;
+    usd.category = upm_moisture_category;
+    return usd;
+}
+
+static const upm_sensor_ft ft =
+{
+    .upm_sensor_init_name = &upm_moisture_init_name,
+    .upm_sensor_close = &upm_moisture_close,
+    .upm_sensor_get_descriptor = &upm_moisture_get_descriptor
+};
+
+static const upm_moisture_ft mft =
+{
+    .upm_moisture_sensor_get_moisture = &upm_moisture_get_moisture
+};
+
+const void* upm_moisture_get_ft(upm_sensor_t sensor_type){
+    if(sensor_type == UPM_MOISTURE){
+        return &mft;
+    }
+    if(sensor_type == UPM_SENSOR){
+        return &ft;
+    }
+    return NULL;
+}
+
+void* upm_moisture_init_name(){
+    return NULL;
+}
+
+void upm_moisture_close(void* dev){
+    moisture_close((moisture_context)dev);
+}
+
+upm_result_t upm_moisture_get_moisture(void* dev, int* moisture){
+    return moisture_get_moisture((moisture_context)dev, moisture);
+}

src/moisture/pyupm_moisture.i

@@ -0,0 +1,11 @@
+// Include doxygen-generated documentation
+%include "pyupm_doxy2swig.i"
+%module pyupm_moisture
+%include "../upm.i"
+
+%feature("autodoc", "3");
+
+%include "moisture.hpp"
+%{
+    #include "moisture.hpp"
+%}