gp2y0a: renamed from gp2y0a21yk to indicate support for the gp2y0a family

Additionally, add some error checking in the constructor, and determine
the ADC resolution and use that in the voltage calculation rather than
a hardcoded 1024.0.

Signed-off-by: Jon Trulson <jtrulson@ics.com>
Signed-off-by: Zion Orent <zorent@ics.com>
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>

src/gp2y0a/CMakeLists.txt

@@ -0,0 +1,5 @@
+set (libname "gp2y0a")
+set (libdescription "upm gp2y0a family of IR distance detectors")
+set (module_src ${libname}.cxx)
+set (module_h ${libname}.h)
+upm_module_init()

src/gp2y0a/gp2y0a.cxx

@@ -1,6 +1,6 @@
 /*
  * Author: Jon Trulson <jtrulson@ics.com>
- * Copyright (c) 2014 Intel Corporation.
+ * Copyright (c) 2015 Intel Corporation.
  *
  * Permission is hereby granted, free of charge, to any person obtaining
  * a copy of this software and associated documentation files (the
@@ -24,23 +24,29 @@
 
 #include <iostream>
 
-#include "gp2y0a21yk.h"
+#include "gp2y0a.h"
 
+using namespace std;
 using namespace upm;
 
-GP2Y0A21YK::GP2Y0A21YK(int pin)
+GP2Y0A::GP2Y0A(int pin)
 {
-  mraa_init();
+  if (!(m_aio = mraa_aio_init(pin)))
+    {
+      cerr << __FUNCTION__ << "mraa_aio_init() failed." << endl;
+      return;
+    }
 
-  m_aio = mraa_aio_init(pin);
+  // get the ADC resolution
+  m_aRes = (1 << mraa_aio_get_bit(m_aio));
 }
 
-GP2Y0A21YK::~GP2Y0A21YK()
+GP2Y0A::~GP2Y0A()
 {
   mraa_aio_close(m_aio);
 }
 
-float GP2Y0A21YK::value(float aref, uint8_t samples)
+float GP2Y0A::value(float aref, uint8_t samples)
 {
   int val;
   int sum = 0;
@@ -52,7 +58,7 @@ float GP2Y0A21YK::value(float aref, uint8_t samples)
     }
 
   val = sum / samples;
-  float volts = (float)val * aref / 1024.0;
+  float volts = float(val) * aref / float(m_aRes);
 
   return volts;
 }

src/gp2y0a/gp2y0a.h

@@ -1,6 +1,6 @@
 /*
  * Author: Jon Trulson <jtrulson@ics.com>
- * Copyright (c) 2014 Intel Corporation.
+ * Copyright (c) 2015 Intel Corporation.
  *
  * Permission is hereby granted, free of charge, to any person obtaining
  * a copy of this software and associated documentation files (the
@@ -23,36 +23,49 @@
  */
 #pragma once
 
+#include <iostream>
 #include <string>
 #include <mraa/aio.h>
 
 namespace upm {
+  /**
+   * @brief UPM library for the GP2Y0A family of IR Proximity Sensors
+   * @defgroup gp2y0a libupm-gp2y0a
+   * @ingroup seeed analog light
+   */
 
   /**
-   * @brief C++ API for the GP2Y0A21YK 80cm IR Proximity Sensor
+   * @sensor gp2y0a
+   * @library gp2y0a
+   * @name GP2Y0A family of IR Proximity Sensors
+   * @category light
+   * @manufacturer seeed
+   * @connection analog
    *
-   * 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
+   * @brief C++ API for the GP2Y0A family of IR Proximity Sensors
+   *
+   * This sensor family returns an analog voltage corresponding to the distance 
+   * of an object from the sensor.  The voltage is lower when objects
    * are far away; the voltage increases as objects get closer
-   * to the sensor.
+   * to the sensor.  
    *
-   * @ingroup analog
-   * @snippet gp2y0a21yk.cxx Interesting
+   * @snippet gp2y0a.cxx Interesting
    */
-  class GP2Y0A21YK {
+  class GP2Y0A {
   public:
+
     /**
-     * GP2Y0A21YK sensor constructor
+     * GP2Y0A sensor constructor
      *
      * @param pin analog pin to use
      */
-    GP2Y0A21YK(int pin);
+    GP2Y0A(int pin);
+
     /**
-     * GP2Y0A21YK Destructor
+     * GP2Y0A Destructor
      */
-    ~GP2Y0A21YK();
+    ~GP2Y0A();
+
     /**
      * Get the averaged voltage value from the sensor
      *
@@ -64,6 +77,8 @@ namespace upm {
 
   private:
     mraa_aio_context m_aio;
+    // ADC resolution
+    int m_aRes;
   };
 }
 

src/gp2y0a/jsupm_gp2y0a.i

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

src/gp2y0a/pyupm_gp2y0a.i

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

src/gp2y0a21yk/CMakeLists.txt

@@ -1,5 +0,0 @@
-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/jsupm_gp2y0a21yk.i

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

src/gp2y0a21yk/pyupm_gp2y0a21yk.i

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