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

grovespeaker: header updated with new tags

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2015-04-10 14:33:34 -07:00
parent d932fa606f
commit 1e45d8e712
1 changed files with 24 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
src/grovespeaker/grovespeaker.h
View File

@ -32,25 +32,34 @@
#define LOW 0
namespace upm {
/**
* @brief UPM library for the Grove Speaker
* @defgroup grovespeaker libupm-grovespeaker
* @ingroup seeed gpio sound
*/
typedef struct
{
int delayTimeLow;
int delayTimeLowSharp;
int delayTimeMed;
int delayTimeMedSharp;
int delayTimeHigh;
int delayTimeHighSharp;
int delayTimeLow;
int delayTimeLowSharp;
int delayTimeMed;
int delayTimeMedSharp;
int delayTimeHigh;
int delayTimeHighSharp;
} NoteData;
/**
* @library grovespeaker
* @sensor grovespeaker
* @comname Grove Speaker
* @type sound
* @man seeed
* @con gpio
*
* @brief C++ API for the GroveSpeaker speaker
*
* UPM module for the GroveSpeaker.
* This sensor can generate different tones and sounds depending on the
* frequency of the input signal.
*
* @ingroup gpio
* @snippet grovespeaker.cxx Interesting
*/
class GroveSpeaker {
@ -69,7 +78,7 @@ typedef struct
* Play all alto notes (lowest notes)
*
*/
void playAll();
void playAll();
/**
* Play a sound and note whether it's sharp or not
*
@ -79,7 +88,7 @@ typedef struct
* @param vocalWeight string to determine whether to play low ("low"),
* medium ("med"), or high ("high") note
*/
void playSound(char letter, bool sharp, std::string vocalWeight);
void playSound(char letter, bool sharp, std::string vocalWeight);
private:
mraa_gpio_context m_gpio;
@ -90,5 +99,3 @@ typedef struct
int noteDelayHigh, int noteDelayHighSharp);
};
}