hyld9767: Initial implementation

This driver was developed using the DFRobot Loudness sensor

http://www.dfrobot.com/index.php?route=product/product&product_id=83

Signed-off-by: Jon Trulson <jtrulson@ics.com>
Signed-off-by: Sisinty Sasmita Patra<sisinty.s.patra@intel.com>

src/hyld9767/CMakeLists.txt

@@ -0,0 +1,5 @@
+set (libname "hyld9767")
+set (libdescription "upm DFRobot loudness sensor")
+set (module_src ${libname}.cxx)
+set (module_h ${libname}.h)
+upm_module_init()

src/hyld9767/hyld9767.cxx

@@ -0,0 +1,48 @@
+/*
+ * Author: Jon Trulson <jtrulson@ics.com>
+ * 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
+ * "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 "hyld9767.h"
+
+using namespace std;
+using namespace upm;
+
+HYLD9767::HYLD9767(int pin, float aref) :
+  m_aio(pin)
+{
+  m_aRes = m_aio.getBit();
+  m_aref = aref;
+}
+
+HYLD9767::~HYLD9767()
+{
+}
+
+float HYLD9767::loudness()
+{
+  int val = m_aio.read();
+
+  return(val * (m_aref / float(1 << m_aRes)));
+}

src/hyld9767/hyld9767.h

@@ -0,0 +1,96 @@
+/*
+ * Author: Jon Trulson <jtrulson@ics.com>
+ * 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
+ * "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 <iostream>
+#include <string>
+#include <mraa/aio.hpp>
+
+// EZ series is volts/512
+#define HYLD9767_RES  512
+
+namespace upm {
+  /**
+   * @brief DFRobot Loudness Sensor V2
+   * @defgroup hyld9767 libupm-hyld9767
+   * @ingroup dfrobot analog sound
+   */
+
+  /**
+   * @library hyld9767
+   * @sensor hyld9767
+   * @comname DFRobot Loudness Sensor V2
+   * @altname HYLD9767
+   * @type sound
+   * @man dfrobot
+   * @web http://www.dfrobot.com/index.php?route=product/product&product_id=83
+   * @con analog
+   *
+   * @brief API for the DFRobot Loudness Sensor V2
+   *
+   * This sensor returns an analog voltage proportional to the
+   * loudness of the ambient environment.  It's output does not
+   * correspond to a particular sound level in decibels.
+   *
+   * This device uses an HYLD9767 electret microphone for sound input.
+   *
+   * This driver was developed using the DFRobot Loudness Sensor V2
+   *
+   * @snippet hyld9767.cxx Interesting
+   */
+
+  class HYLD9767 {
+  public:
+
+    /**
+     * HYLD9767 constructor
+     *
+     * @param pin Analog pin to use
+     * @param aref Analog reference voltage; default is 5.0 V
+     */
+    HYLD9767(int pin, float aref=5.0);
+
+    /**
+     * HYLD9767 destructor
+     */
+    ~HYLD9767();
+
+    /**
+     * Returns the voltage detected on the analog pin
+     *
+     * @return The detected voltage
+     */
+    float loudness();
+
+  protected:
+    mraa::Aio m_aio;
+
+  private:
+    float m_aref;
+    // ADC resolution
+    int m_aRes;
+  };
+}
+
+

src/hyld9767/javaupm_hyld9767.i

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

src/hyld9767/jsupm_hyld9767.i

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

src/hyld9767/pyupm_hyld9767.i

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

src/upm.h

@@ -278,6 +278,12 @@
  * @ingroup byman
  */
 
+/**
+ * @brief DFRobot
+ * @defgroup dfrobot DFRobot
+ * @ingroup byman
+ */
+
 /**
  * @brief EpicTinker
  * @defgroup epict EpicTinker
@@ -358,4 +364,4 @@
  * @brief Robotics Kit - Sensors for your robot
  * @defgroup robok Robotics Kit
  * @ingroup bykit
- */
+ */