microphone: added new sensor

Signed-off-by: Kiveisha Yevgeniy <yevgeniy.kiveisha@intel.com>

examples/CMakeLists.txt

@@ -19,6 +19,7 @@ add_executable (max31855-example max31855.cxx)
 add_executable (gy65-example gy65.cxx)
 add_executable (stepmotor-example stepmotor.cxx)
 add_executable (pulsensor-example pulsensor.cxx)
+add_executable (mic-example mic-example.cxx)
 
 include_directories (${PROJECT_SOURCE_DIR}/src/hmc5883l)
 include_directories (${PROJECT_SOURCE_DIR}/src/grove)
@@ -36,6 +37,7 @@ include_directories (${PROJECT_SOURCE_DIR}/src/max31855)
 include_directories (${PROJECT_SOURCE_DIR}/src/gy65)
 include_directories (${PROJECT_SOURCE_DIR}/src/stepmotor)
 include_directories (${PROJECT_SOURCE_DIR}/src/pulsensor)
+include_directories (${PROJECT_SOURCE_DIR}/src/mic)
 
 target_link_libraries (compass hmc5883l ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (groveled grove ${CMAKE_THREAD_LIBS_INIT})
@@ -58,3 +60,4 @@ target_link_libraries (max31855-example max31855 ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (gy65-example gy65 ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (stepmotor-example stepmotor ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (pulsensor-example pulsensor ${CMAKE_THREAD_LIBS_INIT})
+target_link_libraries (mic-example mic ${CMAKE_THREAD_LIBS_INIT})

examples/mic-example.cxx

@@ -0,0 +1,74 @@
+/*
+ * Author: Yevgeniy Kiveisha <yevgeniy.kiveisha@intel.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 "mic.h"
+#include <signal.h>
+#include <stdlib.h>
+#include <sys/time.h>
+
+int is_running = 0;
+uint16_t buffer [128];
+upm::Microphone *sensor = NULL;
+
+void
+sig_handler(int signo)
+{
+    printf("got signal\n");
+    if (signo == SIGINT) {
+        is_running = 1;
+    }
+}
+
+//! [Interesting]
+int
+main(int argc, char **argv)
+{
+    sensor = new upm::Microphone(0);
+    signal(SIGINT, sig_handler);
+
+    thresholdContext ctx;
+    ctx.averageReading = 0;
+    ctx.runningAverage = 0;
+    ctx.averagedOver   = 2;
+
+    while (!is_running) {
+        int len = sensor->getSampledWindow (2, 128, buffer);
+        if (len) {
+            int thresh = sensor->findThreshold (&ctx, 30, buffer, len);
+            sensor->printGraph(&ctx);
+            if (thresh) {
+                // do something ....
+            }
+        }
+    }
+
+    std::cout << "exiting application" << std::endl;
+
+    delete sensor;
+
+    return 0;
+}
+//! [Interesting]

src/mic/CMakeLists.txt

@@ -0,0 +1,5 @@
+set (libname "mic")
+set (libdescription "Microphone simple API")
+set (module_src ${libname}.cxx)
+set (module_h ${libname}.h)
+upm_module_init()

src/mic/jsupm_mic.i

@@ -0,0 +1,7 @@
+%module jsupm_mic
+
+%{
+    #include "mic.h"
+%}
+
+%include "mic.h"

src/mic/mic.cxx

@@ -0,0 +1,96 @@
+/*
+ * Author: Brendan Le Foll <brendan.le.foll@intel.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 <unistd.h>
+#include <stdlib.h>
+#include <functional>
+#include <string.h>
+#include "mic.h"
+
+using namespace upm;
+
+Microphone::Microphone(int micPin) {
+    // initialise analog mic input
+    m_micCtx = maa_aio_init(micPin);
+
+
+}
+
+Microphone::~Microphone() {
+    // close analog input
+    maa_result_t error;
+    error = maa_aio_close(m_micCtx);
+    if (error != MAA_SUCCESS) {
+        maa_result_print(error);
+    }
+}
+
+int
+Microphone::getSampledWindow (unsigned int freqMS, unsigned int numberOfSamples,
+                            uint16_t * buffer) {
+    int sampleIdx = 0;
+
+    // must have freq
+    if (!freqMS) {
+        return 0;
+    }
+
+    // too much samples
+    if (numberOfSamples > 0xFFFFFF) {
+        return 0;
+    }
+
+    while (sampleIdx < numberOfSamples) {
+        buffer[sampleIdx++] = maa_aio_read (m_micCtx);
+        usleep(freqMS * 1000);
+    }
+
+    return sampleIdx;
+}
+
+int
+Microphone::findThreshold (thresholdContext* ctx, unsigned int threshold,
+                                uint16_t * buffer, unsigned int len) {
+    long sum = 0;
+    for (unsigned int i = 0; i < len; i++) {
+        sum += buffer[i];
+    }
+
+    ctx->averageReading = sum / len;
+    ctx->runningAverage = (((ctx->averagedOver-1) * ctx->runningAverage) + ctx->averageReading) / ctx->averagedOver;
+
+    if (ctx->runningAverage > threshold) {
+        return ctx->runningAverage;
+    } else {
+        return 0;
+    }
+}
+
+void
+Microphone::printGraph (thresholdContext* ctx) {
+    for (int i = 0; i < ctx->runningAverage; i++)
+        std::cout << ".";
+    std::cout << std::endl;
+}

src/mic/mic.h

@@ -0,0 +1,86 @@
+/*
+ * Author: Brendan Le Foll <brendan.le.foll@intel.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 <maa/gpio.h>
+#include <maa/aio.h>
+
+struct thresholdContext {
+    long averageReading;
+    long runningAverage;
+    int averagedOver;
+};
+
+namespace upm {
+
+/**
+ * @brief C++ API for Microphone
+ *
+ * This file defines the Microphone Analog sensor
+ *
+ * @snippet mic-example.cxx Interesting
+ *
+ */
+class Microphone {
+    public:
+        /**
+         * Instanciates a Microphone object
+         *
+         * @param micPin pin where microphone is connected
+         */
+        Microphone(int micPin);
+
+        /**
+         * MAX31723 object destructor
+         */
+        ~Microphone();
+
+        /**
+         * Get samples from microphone according to provided window and
+         * number of samples
+         *
+         * @return freqMS time between each sample (in microseconds)
+         * @return numberOfSamples number of sample to sample for this window
+         * @return buffer bufer with sampled data
+         */
+        int getSampledWindow (unsigned int freqMS, unsigned int numberOfSamples, uint16_t * buffer);
+
+        /**
+         * Given sampled buffer this method will return TRUE/FALSE if threshold
+         * was reached
+         *
+         * @return threshold sample threshold
+         * @return buffer buffer with samples
+         * @return len bufer len
+         */
+        int findThreshold (thresholdContext* ctx, unsigned int threshold, uint16_t * buffer, unsigned int len);
+
+        void printGraph (thresholdContext* ctx);
+
+    private:
+        maa_aio_context    m_micCtx;
+};
+
+}

src/mic/pyupm_mic.i

@@ -0,0 +1,10 @@
+%module pyupm_mic
+
+%include "stdint.i"
+
+%feature("autodoc", "3");
+
+%include "mic.h"
+%{
+    #include "mic.h"
+%}