grovewater: Initial implementation

jrvandr: removing unecessary mraa_init()

This module implements support for the Grove Water sensor.

Signed-off-by: Jon Trulson <jtrulson@ics.com>
Signed-off-by: Zion Orent <zorent@ics.com>
Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>

examples/CMakeLists.txt

@@ -62,6 +62,7 @@ add_executable (groveehr-example groveehr.cxx)
 add_executable (ta12200-example ta12200.cxx)
 add_executable (grovelinefinder-example grovelinefinder.cxx)
 add_executable (grovevdiv-example grovevdiv.cxx)
+add_executable (grovewater-example grovewater.cxx)
 
 include_directories (${PROJECT_SOURCE_DIR}/src/hmc5883l)
 include_directories (${PROJECT_SOURCE_DIR}/src/grove)
@@ -111,6 +112,7 @@ include_directories (${PROJECT_SOURCE_DIR}/src/groveehr)
 include_directories (${PROJECT_SOURCE_DIR}/src/ta12200)
 include_directories (${PROJECT_SOURCE_DIR}/src/grovelinefinder)
 include_directories (${PROJECT_SOURCE_DIR}/src/grovevdiv)
+include_directories (${PROJECT_SOURCE_DIR}/src/grovewater)
 
 target_link_libraries (hmc5883l-example hmc5883l ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (groveled-example grove ${CMAKE_THREAD_LIBS_INIT})
@@ -176,3 +178,4 @@ target_link_libraries (groveehr-example groveehr ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (ta12200-example ta12200 ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (grovelinefinder-example grovelinefinder ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (grovevdiv-example grovevdiv ${CMAKE_THREAD_LIBS_INIT})
+target_link_libraries (grovewater-example grovewater ${CMAKE_THREAD_LIBS_INIT})

examples/grovewater.cxx

@@ -0,0 +1,65 @@
+/*
+ * 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 <unistd.h>
+#include <iostream>
+#include <signal.h>
+#include "grovewater.h"
+
+using namespace std;
+
+int shouldRun = true;
+
+void sig_handler(int signo)
+{
+  if (signo == SIGINT)
+    shouldRun = false;
+}
+
+
+int main ()
+{
+  signal(SIGINT, sig_handler);
+
+//! [Interesting]
+  // Instantiate a Grove Water sensor on digital pin D2
+  upm::GroveWater* water = new upm::GroveWater(2);
+  
+  while (shouldRun)
+    {
+      bool val = water->isWet();
+      if (val)
+        cout << "Sensor is wet." << endl;
+      else
+        cout << "Sensor is dry." << endl;
+
+      sleep(1);
+    }
+//! [Interesting]
+
+  cout << "Exiting..." << endl;
+
+  delete water;
+  return 0;
+}

examples/javascript/grovewater.js

@@ -0,0 +1,49 @@
+/*jslint node:true, vars:true, bitwise:true, unparam:true */
+/*jshint unused:true */
+/*global */
+/*
+ * Author: Zion Orent <zorent@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.
+ */
+
+// Load Grove module
+var waterSensor = require('jsupm_grovewater');
+
+// Instantiate a Grove Water sensor on digital pin D2
+var water = new waterSensor.GroveWater(2);
+
+// Read whether the sensor is wet/dry, waiting one second between readings
+function readWaterState()
+{
+	if (water.isWet())
+		console.log("Sensor is wet");
+	else
+		console.log("Sensor is dry");
+}
+setInterval(readWaterState, 1000);
+
+// Print message when exiting
+process.on('SIGINT', function()
+{
+	console.log("Exiting...");
+	process.exit(0);
+});

src/grovewater/CMakeLists.txt

@@ -0,0 +1,5 @@
+set (libname "grovewater")
+set (libdescription "upm grove water module")
+set (module_src ${libname}.cxx)
+set (module_h ${libname}.h)
+upm_module_init()

src/grovewater/grovewater.cxx

@@ -0,0 +1,51 @@
+/*
+ * 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 "grovewater.h"
+
+using namespace upm;
+using namespace std;
+
+GroveWater::GroveWater(int pin)
+{
+  if ( !(m_gpio = mraa_gpio_init(pin)) )
+    {
+      cerr << __FUNCTION__ << ": mraa_gpio_init() failed" << endl;
+      return;
+    }
+
+  mraa_gpio_dir(m_gpio, MRAA_GPIO_IN);
+}
+
+GroveWater::~GroveWater()
+{
+  mraa_gpio_close(m_gpio);
+}
+
+bool GroveWater::isWet()
+{
+  return (!mraa_gpio_read(m_gpio) ? true : false);
+}

src/grovewater/grovewater.h

@@ -0,0 +1,63 @@
+/*
+ * 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/gpio.h>
+
+namespace upm {
+
+  /**
+   * @brief C++ API for the Grove Water Sensor
+   *
+   * UPM module for the Grove Water Sensor
+   *
+   * @ingroup grove gpio
+   * @snippet grovewater.cxx Interesting
+   */
+  class GroveWater {
+  public:
+    /**
+     * Grove digital water sensor constructor
+     *
+     * @param pin digital pin to use
+     */
+    GroveWater(int pin);
+    /**
+     * GroveWater Destructor
+     */
+    ~GroveWater();
+    /**
+     * Get the water (wet/not wet) value from the sensor
+     *
+     * @return True if the sensor is wet, false otherwise
+     */
+    bool isWet();
+
+  private:
+    mraa_gpio_context m_gpio;
+  };
+}
+
+

src/grovewater/jsupm_grovewater.i

@@ -0,0 +1,8 @@
+%module jsupm_grovewater
+%include "../upm.i"
+
+%{
+    #include "grovewater.h"
+%}
+
+%include "grovewater.h"

src/grovewater/pyupm_grovewater.i

@@ -0,0 +1,9 @@
+%module pyupm_grovewater
+%include "../upm.i"
+
+%feature("autodoc", "3");
+
+%include "grovewater.h"
+%{
+    #include "grovewater.h"
+%}