grovevdiv: Initial implementation

This module implements support for the Grove Voltage Divider.
jrvandr: Removed unecessary mraa_init() from grovevdiv.cxx

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

@@ -61,6 +61,7 @@ add_executable (grovemoisture-example grovemoisture.cxx)
 add_executable (groveehr-example groveehr.cxx)
 add_executable (ta12200-example ta12200.cxx)
 add_executable (grovelinefinder-example grovelinefinder.cxx)
+add_executable (grovevdiv-example grovevdiv.cxx)
 
 include_directories (${PROJECT_SOURCE_DIR}/src/hmc5883l)
 include_directories (${PROJECT_SOURCE_DIR}/src/grove)
@@ -109,6 +110,7 @@ include_directories (${PROJECT_SOURCE_DIR}/src/grovemoisture)
 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)
 
 target_link_libraries (hmc5883l-example hmc5883l ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (groveled-example grove ${CMAKE_THREAD_LIBS_INIT})
@@ -173,3 +175,4 @@ target_link_libraries (grovemoisture-example grovemoisture ${CMAKE_THREAD_LIBS_I
 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})

examples/grovevdiv.cxx

@@ -0,0 +1,67 @@
+/*
+ * 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 "grovevdiv.h"
+
+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 Grove Voltage Divider sensor on analog pin A0
+  upm::GroveVDiv* vDiv = new upm::GroveVDiv(0);
+
+  // collect data and output measured voltage according to the setting
+  // of the scaling switch (3 or 10)
+  while (shouldRun)
+    {
+      unsigned int val = vDiv->value(100);
+      float gain3val = vDiv->computedValue(3, val);
+      float gain10val = vDiv->computedValue(10, val);
+      cout << "ADC value: " << val << " Gain 3: " << gain3val 
+           << "v Gain 10: " << gain10val << "v" << endl;
+
+      sleep(1);
+    }
+//! [Interesting]
+
+  cout << "Exiting..." << endl;
+
+  delete vDiv;
+  return 0;
+}

examples/javascript/grovevdiv.js

@@ -0,0 +1,50 @@
+/*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.
+*/
+
+var voltageDivider = require('jsupm_grovevdiv');
+// Instantiate a Grove Voltage Divider sensor on analog pin A0
+var myVoltageDivider = new voltageDivider.GroveVDiv(0);
+
+// collect data and output measured voltage according to the setting
+// of the scaling switch (3 or 10)
+function getVoltageInfo()
+{
+	var val = myVoltageDivider.value(100);
+	var gain3val = myVoltageDivider.computedValue(3, val);
+	var gain10val = myVoltageDivider.computedValue(10, val);
+	console.log("ADC value: " + val + " Gain 3: " + gain3val 
+				+ "v Gain 10: " + gain10val + "v");
+}
+
+setInterval(getVoltageInfo, 1000);
+
+// Print message when exiting
+process.on('SIGINT', function()
+{
+	console.log("Exiting...");
+	process.exit(0);
+});

src/grovevdiv/CMakeLists.txt

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

src/grovevdiv/grovevdiv.cxx

@@ -0,0 +1,64 @@
+/*
+ * 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 "grovevdiv.h"
+
+using namespace upm;
+using namespace std;
+
+GroveVDiv::GroveVDiv(int pin)
+{
+  if ( !(m_aio = mraa_aio_init(pin)) )
+    {
+      cerr << __FUNCTION__ << ": mraa_aio_init() failed" << endl;
+      return;
+    }
+}
+
+GroveVDiv::~GroveVDiv()
+{
+  mraa_aio_close(m_aio);
+}
+
+unsigned int GroveVDiv::value(unsigned int samples)
+{
+  unsigned int sum = 0;
+
+  for (int i=0; i<samples; i++)
+    {
+      sum += mraa_aio_read(m_aio);
+      usleep(2000);
+    }
+        
+  return (sum / samples);
+}
+
+float GroveVDiv::computedValue(uint8_t gain, uint16_t val, int vref, int res)
+{
+  return ((float(gain) * float(val) * float(vref) / float(res)) / 1000.0);
+
+}
+

src/grovevdiv/grovevdiv.h

@@ -0,0 +1,87 @@
+/*
+ * 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 <iostream>
+#include <stdint.h>
+#include <mraa/aio.h>
+
+// ref voltage in millivolts
+#define GROVEVDIV_VREF  4980
+
+// default ADC resolution. 
+#define GROVEVDIV_ADC_RES 1024
+
+namespace upm {
+
+  /**
+   * @brief C++ API for the Grove Voltage Divider Sensor
+   *
+   * UPM module for the Grove Voltage Divider Sensor
+   *
+   * @ingroup grove analog
+   * @snippet grovevdiv.cxx Interesting
+   */
+  class GroveVDiv {
+  public:
+    /**
+     * Grove Voltage Divider sensor constructor
+     *
+     * @param pin analog pin to use
+     */
+    GroveVDiv(int pin);
+
+    /**
+     * Grove Voltage Divider Destructor
+     */
+    ~GroveVDiv();
+
+    /**
+     * Get the conversion value from the sensor
+     *
+     * @param samples specifies how many samples to average over
+     * @return the averaged ADC conversion value
+     */
+    unsigned int value(unsigned int samples);
+
+    /**
+     * Compute the measured voltage
+     *
+     * @param gain gain switch, either 3 or 10 for grove
+     * @param val measured voltage (from value())
+     * @param vref reference voltage in millivolts
+     * @param res ADC resolution
+     *
+     * @return the measured voltage
+     */
+    float computedValue(uint8_t gain, uint16_t val, int vref=GROVEVDIV_VREF, 
+                        int res=GROVEVDIV_ADC_RES);
+
+  private:
+    mraa_aio_context m_aio;
+  };
+}
+
+

src/grovevdiv/jsupm_grovevdiv.i

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

src/grovevdiv/pyupm_grovevdiv.i

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