groveehr: Initial implementation

This module implements support for the Grove Ear-clip heart rate
sensor.

Signed-off-by: Jon Trulson <jtrulson@ics.com>
Signed-off-by: Zion Orent <zorent@ics.com>
Signed-off-by: Sarah Knepper <sarah.knepper@intel.com>

src/groveehr/CMakeLists.txt

@@ -0,0 +1,5 @@
+set (libname "groveehr")
+set (libdescription "upm grove ear-clip heart rate sensor module")
+set (module_src ${libname}.cxx)
+set (module_h ${libname}.h)
+upm_module_init()

src/groveehr/groveehr.cxx

@@ -0,0 +1,129 @@
+/*
+ * 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 "groveehr.h"
+
+using namespace upm;
+using namespace std;
+
+GroveEHR::GroveEHR(int pin)
+{
+  mraa_init();
+
+  if ( !(m_gpio = mraa_gpio_init(pin)) )
+    {
+      cerr << __FUNCTION__ << ": mraa_gpio_init() failed" << endl;
+      return;
+    }
+
+  mraa_gpio_dir(m_gpio, MRAA_GPIO_IN);
+
+  initClock();
+  m_beatCounter = 0;
+}
+
+GroveEHR::~GroveEHR()
+{
+  mraa_gpio_close(m_gpio);
+}
+
+void GroveEHR::initClock()
+{
+  gettimeofday(&m_startTime, NULL);
+}
+
+uint32_t GroveEHR::getMillis()
+{
+  struct timeval elapsed, now;
+  uint32_t elapse;
+
+  // get current time
+  gettimeofday(&now, NULL);
+
+  // compute the delta since m_startTime
+  if( (elapsed.tv_usec = now.tv_usec - m_startTime.tv_usec) < 0 ) 
+    {
+      elapsed.tv_usec += 1000000;
+      elapsed.tv_sec = now.tv_sec - m_startTime.tv_sec - 1;
+    } 
+  else 
+    {
+      elapsed.tv_sec = now.tv_sec - m_startTime.tv_sec;
+    }
+
+  elapse = (uint32_t)((elapsed.tv_sec * 1000) + (elapsed.tv_usec / 1000));
+
+  // never return 0
+  if (elapse == 0)
+    elapse = 1;
+
+  return elapse;
+}
+
+void GroveEHR::clearBeatCounter()
+{
+  m_beatCounter = 0;
+}
+
+void GroveEHR::startBeatCounter()
+{
+  // install our interrupt handler
+  mraa_gpio_isr(m_gpio, MRAA_GPIO_EDGE_RISING, 
+                &beatISR, this);
+}
+
+void GroveEHR::stopBeatCounter()
+{
+  // remove the interrupt handler
+  mraa_gpio_isr_exit(m_gpio);
+}
+
+uint32_t GroveEHR::beatCounter()
+{
+  return m_beatCounter;
+}
+
+void GroveEHR::beatISR(void *ctx)
+{
+  upm::GroveEHR *This = (upm::GroveEHR *)ctx;
+  This->m_beatCounter++;
+}
+
+int GroveEHR::heartRate()
+{
+  uint32_t millis = getMillis();
+  uint32_t beats = beatCounter();
+  
+  float heartRate = 0;
+  // wait at least 5 seconds before attempting to compute the
+  // heart rate
+  if (millis > 5000)
+    {
+      heartRate = (float(beats) / (float(millis) / 1000.0)) * 60.0;
+    }
+
+  return int(heartRate);
+}

src/groveehr/groveehr.h

@@ -0,0 +1,114 @@
+/*
+ * 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 <stdint.h>
+#include <sys/time.h>
+#include <mraa/gpio.h>
+
+namespace upm {
+
+  /**
+   * @brief C++ API for the Grove Ear-clip Heart Rate sensor
+   *
+   * UPM module for the GroveEHR sensor.  It is used to measure your
+   * heartbeat.
+   *
+   * @ingroup gpio
+   * @snippet groveehr.cxx Interesting
+   */
+  class GroveEHR {
+  public:
+    /**
+     * GroveEHR constructor
+     *
+     * @param pin digital pin to use
+     */
+    GroveEHR(int pin);
+    /**
+     * GroveEHR Destructor
+     */
+    ~GroveEHR();
+    /**
+     * Return the number of milliseconds elapsed since initClock()
+     * was last called.
+     *
+     * @return elapsed milliseconds
+     */
+    uint32_t getMillis();
+
+    /**
+     * Reset the Clock
+     *
+     */
+    void initClock();
+
+    /**
+     * Reset the beat counter to 0.  The beat Counter should be
+     * stopped via stopBeatCounter() prior to calling this function.
+     *
+     */
+    void clearBeatCounter();
+
+    /**
+     * Start the beat counter
+     *
+     */
+    void startBeatCounter();
+
+    /**
+     * Stop the beat counter
+     *
+     */
+    void stopBeatCounter();
+
+    /**
+     * Get the beat Counter
+     *
+     * @return the beat counter
+     */
+    uint32_t beatCounter();
+
+    /**
+     * Beat Interrupt Service Routine
+     *
+     */
+    static void beatISR(void *ctx);
+
+    /**
+     * Compute the heart rate
+     *
+     * @return the computed heart rate
+     */
+    int heartRate();
+
+  private:
+    volatile uint32_t m_beatCounter;
+    struct timeval m_startTime;
+    mraa_gpio_context m_gpio;
+  };
+}
+
+

src/groveehr/jsupm_groveehr.i

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

src/groveehr/pyupm_groveehr.i

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