loudness: merge groveloudness and hyld9767 into a single driver

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

src/groveloudness/CMakeLists.txt

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

src/groveloudness/groveloudness.h

@@ -1,77 +0,0 @@
-/*
- * 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 Grove Loudness sensor library
-   * @defgroup groveloudness libupm-groveloudness
-   * @ingroup seeed analog sound
-   */
-
-  /**
-   * @library groveloudness
-   * @sensor groveloudness
-   * @comname Grove Loudness Sensor
-   * @type sound
-   * @man seeed
-   * @con analog
-   *
-   * @brief API for the Grove Loudness Sensor
-   *
-   * UPM module for the Grove Loudness Sensor. This sensor
-   * detects how loud the surrounding environment is.
-   * The higher the output analog value, the louder the sound.
-   *
-   * @image html groveloudness.jpg
-   * @snippet groveloudness.cxx Interesting
-   */
-  class GroveLoudness {
-  public:
-    /**
-     * Grove analog loudness sensor constructor
-     *
-     * @param pin Analog pin to use
-     */
-    GroveLoudness(int pin);
-    /**
-     * GroveLoudness destructor
-     */
-    ~GroveLoudness();
-    /**
-     * Gets the loudness value from the sensor
-     *
-     * @return Loudness reading
-     */
-    int value();
-
-  private:
-    mraa_aio_context m_aio;
-  };
-}
-
-

src/groveloudness/javaupm_groveloudness.i

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

src/groveloudness/jsupm_groveloudness.i

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

src/groveloudness/pyupm_groveloudness.i

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

src/hyld9767/javaupm_hyld9767.i

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

src/hyld9767/jsupm_hyld9767.i

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

src/hyld9767/pyupm_hyld9767.i

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

src/loudness/CMakeLists.txt

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

src/loudness/javaupm_loudness.i

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

src/loudness/jsupm_loudness.i

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

src/loudness/loudness.cxx

@@ -24,23 +24,23 @@
 
 #include <iostream>
 
-#include "hyld9767.h"
+#include "loudness.h"
 
 using namespace std;
 using namespace upm;
 
-HYLD9767::HYLD9767(int pin, float aref) :
+Loudness::Loudness(int pin, float aref) :
   m_aio(pin)
 {
   m_aRes = m_aio.getBit();
   m_aref = aref;
 }
 
-HYLD9767::~HYLD9767()
+Loudness::~Loudness()
 {
 }
 
-float HYLD9767::loudness()
+float Loudness::loudness()
 {
   int val = m_aio.read();
 

src/loudness/loudness.h

@@ -27,54 +27,54 @@
 #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
+   * @brief Generic loudness sensors
+   * @defgroup loudness libupm-loudness
+   * @ingroup dfrobot seeed analog sound
    */
 
   /**
-   * @library hyld9767
-   * @sensor hyld9767
-   * @comname DFRobot Loudness Sensor V2
-   * @altname HYLD9767
+   * @library loudness
+   * @sensor loudness
+   * @comname Loudness Sensor
+   * @altname Grove loudness hyld9767
    * @type sound
-   * @man dfrobot
+   * @man dfrobot seeed
    * @web http://www.dfrobot.com/index.php?route=product/product&product_id=83
    * @con analog
    *
-   * @brief API for the DFRobot Loudness Sensor V2
+   * @brief API for the Loudness Sensor
    *
-   * This sensor returns an analog voltage proportional to the
+   * This sensor family 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.
+   * correspond to a particular sound level in decibels.  The higher
+   * the output voltage, the louder the ambient noise level.
    *
-   * This device uses an HYLD9767 electret microphone for sound input.
+   * This device uses an electret microphone for sound input.
    *
    * This driver was developed using the DFRobot Loudness Sensor V2
+   * and the Grove Loudness sensor.
    *
-   * @snippet hyld9767.cxx Interesting
+   * @image html groveloudness.jpg
+   * @snippet loudness.cxx Interesting
    */
 
-  class HYLD9767 {
+  class Loudness {
   public:
 
     /**
-     * HYLD9767 constructor
+     * Loudness constructor
      *
      * @param pin Analog pin to use
      * @param aref Analog reference voltage; default is 5.0 V
      */
-    HYLD9767(int pin, float aref=5.0);
+    Loudness(int pin, float aref=5.0);
 
     /**
-     * HYLD9767 destructor
+     * Loudness destructor
      */
-    ~HYLD9767();
+    ~Loudness();
 
     /**
      * Returns the voltage detected on the analog pin

src/loudness/pyupm_loudness.i

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