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

docs: final batch of header files reviewed

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
VadimPopov
2015-08-10 18:53:31 +03:00
committed by Mihai Tudor Panu
parent 04edb9be04
commit 1fe9b9eb1d
53 changed files with 1182 additions and 1191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
src/mic/mic.h
View File

@ -36,7 +36,7 @@ struct thresholdContext {
namespace upm {
/**
* @brief Analog microphone library
* @brief Analog Microphone library
* @defgroup mic libupm-mic
* @ingroup seeed pwm sound gsk
*/
@ -51,9 +51,9 @@ namespace upm {
* @con pwm
* @kit gsk
*
* @brief API for Microphone
* @brief API for the Analog Microphone
*
* This file defines the Microphone Analog sensor
* This file defines the Analog Microphone sensor
*
* @image html mic.jpg
* @snippet mic.cxx Interesting
@ -61,43 +61,43 @@ namespace upm {
class Microphone {
public:
/**
* Instanciates a Microphone object
* Instantiates a Microphone object
*
* @param micPin pin where microphone is connected
* @param micPin Pin where the microphone is connected
*/
Microphone(int micPin);
/**
* MAX31723 object destructor
* Microphone object destructor
*/
~Microphone();
/**
* Get samples from microphone according to provided window and
* 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 bufer with sampled data
* @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, unsigned int numberOfSamples, uint16_t * buffer);
/**
* Given sampled buffer this method will return TRUE/FALSE if threshold
* was reached
* 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 bufer len
* @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, unsigned int len);
/**
*
* Print running average of threshold context
* Prints a running average of the threshold context
*
* @param ctx threshold context
* @param ctx Threshold context
*/
void printGraph (thresholdContext* ctx);