alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-04 02:41:14 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

cpp_headers: Renamed C++ headers from .h -> .hpp

Browse Source 
To make room for UPM C and C++ sensor code to coexist, all UPM
C++ headers have been renamed from h -> hpp.  This commit contains
updates to documentation, includes, cmake collateral, examples, and
swig interface files.

    * Renamed all cxx/cpp header files which contain the string
    'copyright intel' from .h -> .hpp (if not already hpp).

    * Replaced all references to .h with .hpp in documentation,
    source files, cmake collateral, example code, and swig interface
    files.

    * Replaced cmake variable module_h with module_hpp.

    * Intentionally left upm.h since this file currently does not
    contain code (documentation only).

Signed-off-by: Noel Eck <noel.eck@intel.com>
This commit is contained in:
Noel Eck
2016-04-25 14:27:51 -07:00
parent b3a8fd7172
commit 922e0cc26b
1177 changed files with 1697 additions and 1699 deletions
Download Patch File Download Diff File Expand all files Collapse all files

108
src/mic/mic.h
View File

@ -1,108 +0,0 @@
/*
* 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 <mraa/gpio.h>
#include <mraa/aio.h>
struct thresholdContext {
long averageReading;
long runningAverage;
int averagedOver;
};
namespace upm {
/**
* @brief Analog Microphone library
* @defgroup mic libupm-mic
* @ingroup seeed pwm sound gsk
*/
/**
* @library mic
* @sensor microphone
* @comname Analog Microphone
* @altname Grove Sound Sensor
* @type sound
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Sound_Sensor
* @con pwm
* @kit gsk
*
* @brief API for the Analog Microphone
*
* This module defines the Analog Microphone sensor
*
* @image html mic.jpg
* @snippet mic.cxx Interesting
*/
class Microphone {
public:
/**
* Instantiates a Microphone object
*
* @param micPin Pin where the microphone is connected
*/
Microphone(int micPin);
/**
* Microphone object destructor
*/
~Microphone();
/**
* Gets samples from the microphone according to the provided window and
* number of samples
*
* @param freqMS Time between each sample (in microseconds)
* @param numberOfSamples Number of sample to sample for this window
* @param buffer Buffer with sampled data
*/
int getSampledWindow (unsigned int freqMS, int numberOfSamples, uint16_t * buffer);
/**
* Given the sampled buffer, this method returns TRUE/FALSE if threshold
* is reached
*
* @param ctx Threshold context
* @param threshold Sample threshold
* @param buffer Buffer with samples
* @param len Buffer length
*/
int findThreshold (thresholdContext* ctx, unsigned int threshold, uint16_t * buffer, int len);
/**
*
* Prints a running average of the threshold context
*
* @param ctx Threshold context
*/
void printGraph (thresholdContext* ctx);
private:
mraa_aio_context m_micCtx;
};
}