gp2y0a21yk: Initial implementation of the gp2y0a21yk 80cm IR proximity 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>

examples/CMakeLists.txt

@@ -56,6 +56,7 @@ add_executable (enc03r-example enc03r.cxx)
 add_executable (adc121c021-example adc121c021.cxx)
 add_executable (ds1307-example ds1307.cxx)
 add_executable (a110x-example a110x.cxx)
+add_executable (gp2y0a21yk-example gp2y0a21yk.cxx)
 
 include_directories (${PROJECT_SOURCE_DIR}/src/hmc5883l)
 include_directories (${PROJECT_SOURCE_DIR}/src/grove)
@@ -99,6 +100,7 @@ include_directories (${PROJECT_SOURCE_DIR}/src/enc03r)
 include_directories (${PROJECT_SOURCE_DIR}/src/adc121c021)
 include_directories (${PROJECT_SOURCE_DIR}/src/ds1307)
 include_directories (${PROJECT_SOURCE_DIR}/src/a110x)
+include_directories (${PROJECT_SOURCE_DIR}/src/gp2y0a21yk)
 
 target_link_libraries (hmc5883l-example hmc5883l ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (groveled-example grove ${CMAKE_THREAD_LIBS_INIT})
@@ -158,3 +160,4 @@ target_link_libraries (enc03r-example enc03r ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (adc121c021-example adc121c021 ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (ds1307-example ds1307 ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (a110x-example a110x ${CMAKE_THREAD_LIBS_INIT})
+target_link_libraries (gp2y0a21yk-example gp2y0a21yk ${CMAKE_THREAD_LIBS_INIT})

examples/gp2y0a21yk.cxx

@@ -0,0 +1,73 @@
+/*
+ * 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 "gp2y0a21yk.h"
+
+using namespace std;
+
+bool shouldRun = true;
+
+// analog voltage, usually 3.3 or 5.0
+#define GP2Y0A21YK_AREF   5.0
+#define SAMPLES_PER_QUERY 20
+
+void sig_handler(int signo)
+{
+  if (signo == SIGINT)
+    shouldRun = false;
+}
+
+int main()
+{
+  signal(SIGINT, sig_handler);
+
+//! [Interesting]
+  // Note, for the Grove version of this sensor, due to the way it is wired,
+  // you need to plug this into the A0 port, where it will use the available
+  // A1 pin for data.
+
+  // Instantiate a GP2Y0A21YK on analog pin A1
+  upm::GP2Y0A21YK *volts = new upm::GP2Y0A21YK(1);
+  
+  // The higher the voltage (closer to AREF) the closer the object is.  NOTE:
+  // the measured voltage will probably not exceed 3.3 volts.
+  // Every second, print the averaged voltage value (averaged over 20 samples).
+  while (shouldRun)
+    {
+      cout << "AREF: " << GP2Y0A21YK_AREF 
+           << ", Voltage value (higher means closer): " 
+           << volts->value(GP2Y0A21YK_AREF, SAMPLES_PER_QUERY) << endl;
+      
+      sleep(1);
+    }
+//! [Interesting]
+
+  cout << "Exiting" << endl;
+
+  delete volts;
+  return 0;
+}

examples/javascript/gp2y0a21yk.js

@@ -0,0 +1,56 @@
+/*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.
+*/
+// JavaScript file for GP2Y0A21YK 80cm IR Proximity Sensor
+
+// analog voltage, usually 3.3 or 5.0
+var GP2Y0A21YK_AREF = 5.0;
+var SAMPLES_PER_QUERY = 20;
+
+var IRProximity = require('jsupm_gp2y0a21yk');
+
+// Note, for the Grove version of this sensor, due to the way it is wired,
+// you need to plug this into the A0 port, where it will use the available
+// A1 pin for data.
+// Instantiate a GP2Y0A21YK on analog pin A1
+var myVolts = new IRProximity.GP2Y0A21YK(1);
+
+// The higher the voltage (closer to AREF) the closer the object is.
+// NOTE: The measured voltage will probably not exceed 3.3 volts.
+// Every second, print the averaged voltage value (averaged over 20 samples).
+setInterval(function()
+{
+	console.log("AREF: " + GP2Y0A21YK_AREF + 
+                ", Voltage value (higher means closer): " + 
+                myVolts.value(GP2Y0A21YK_AREF, SAMPLES_PER_QUERY));
+}, 1000);
+
+// Print message when exiting
+process.on('SIGINT', function()
+{
+	console.log("Exiting...");
+	process.exit(0);
+});

src/gp2y0a21yk/CMakeLists.txt

@@ -0,0 +1,5 @@
+set (libname "gp2y0a21yk")
+set (libdescription "upm gp2y0a21yk 80cm IR proximity sensor module")
+set (module_src ${libname}.cxx)
+set (module_h ${libname}.h)
+upm_module_init()

src/gp2y0a21yk/gp2y0a21yk.cxx

@@ -0,0 +1,58 @@
+/*
+ * 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 "gp2y0a21yk.h"
+
+using namespace upm;
+
+GP2Y0A21YK::GP2Y0A21YK(int pin)
+{
+  mraa_init();
+
+  m_aio = mraa_aio_init(pin);
+}
+
+GP2Y0A21YK::~GP2Y0A21YK()
+{
+  mraa_aio_close(m_aio);
+}
+
+float GP2Y0A21YK::value(float aref, uint8_t samples)
+{
+  int val;
+  int sum = 0;
+
+  for (int i=0; i<samples; i++)
+    {
+      val = mraa_aio_read(m_aio);
+      sum += val;
+    }
+
+  val = sum / samples;
+  float volts = (float)val * aref / 1024.0;
+
+  return volts;
+}

src/gp2y0a21yk/gp2y0a21yk.h

@@ -0,0 +1,70 @@
+/*
+ * 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 C++ API for the GP2Y0A21YK 80cm IR Proximity Sensor
+   *
+   * UPM module for the GP2Y0A21YK 80cm IR Proximity Sensor.
+   * This sensor returns an analog voltage corresponding to the distance 
+   * of an object from the sensor.  The object may be 10 cm (4 inches)
+   * to 80 cm (30 inches) away.  The voltage is low when objects
+   * are far away; the voltage increases as objects get closer
+   * to the sensor.
+   *
+   * @ingroup analog
+   * @snippet gp2y0a21yk.cxx Interesting
+   */
+  class GP2Y0A21YK {
+  public:
+    /**
+     * GP2Y0A21YK sensor constructor
+     *
+     * @param pin analog pin to use
+     */
+    GP2Y0A21YK(int pin);
+    /**
+     * GP2Y0A21YK Destructor
+     */
+    ~GP2Y0A21YK();
+    /**
+     * Get the averaged voltage value from the sensor
+     *
+     * @param aref the reference voltage in use (5.0 or 3.3 usually)
+     * @param samples number of samples to average over
+     * @return the averaged voltage reading
+     */
+    float value(float aref, uint8_t samples);
+
+  private:
+    mraa_aio_context m_aio;
+  };
+}
+
+

src/gp2y0a21yk/jsupm_gp2y0a21yk.i

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

src/gp2y0a21yk/pyupm_gp2y0a21yk.i

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