alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-03-24 01:10:22 +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

41
src/grovespeaker/grovespeaker.h
View File

@ -32,25 +32,34 @@
#define LOW 0 #define LOW 0
namespace upm { namespace upm {
/**
* @brief UPM library for the Grove Speaker
* @defgroup grovespeaker libupm-grovespeaker
* @ingroup seeed gpio sound
*/
typedef struct typedef struct
{ {
int delayTimeLow; int delayTimeLow;
int delayTimeLowSharp; int delayTimeLowSharp;
int delayTimeMed; int delayTimeMed;
int delayTimeMedSharp; int delayTimeMedSharp;
int delayTimeHigh; int delayTimeHigh;
int delayTimeHighSharp; int delayTimeHighSharp;
} NoteData; } NoteData;
/** /**
* @library grovespeaker
* @sensor grovespeaker
* @comname Grove Speaker
* @type sound
* @man seeed
* @con gpio
*
* @brief C++ API for the GroveSpeaker speaker * @brief C++ API for the GroveSpeaker speaker
* *
* UPM module for the GroveSpeaker. * UPM module for the GroveSpeaker.
* This sensor can generate different tones and sounds depending on the * This sensor can generate different tones and sounds depending on the
* frequency of the input signal. * frequency of the input signal.
* *
* @ingroup gpio
* @snippet grovespeaker.cxx Interesting * @snippet grovespeaker.cxx Interesting
*/ */
class GroveSpeaker { class GroveSpeaker {
@ -69,26 +78,24 @@ typedef struct
* Play all alto notes (lowest notes) * Play all alto notes (lowest notes)
* *
*/ */
void playAll(); void playAll();
/** /**
* Play a sound and note whether it's sharp or not * Play a sound and note whether it's sharp or not
* *
* @param letter character name of note * @param letter character name of note
* ('a', 'b', 'c', 'd', 'e', 'f', or 'g') * ('a', 'b', 'c', 'd', 'e', 'f', or 'g')
* @param sharp if true, play sharp version of note; otherwise, do not * @param sharp if true, play sharp version of note; otherwise, do not
* @param vocalWeight string to determine whether to play low ("low"), * @param vocalWeight string to determine whether to play low ("low"),
* medium ("med"), or high ("high") note * 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: private:
mraa_gpio_context m_gpio; mraa_gpio_context m_gpio;
std::map <char, NoteData> m_note_list; std::map <char, NoteData> m_note_list;
void sound(int note_delay); void sound(int note_delay);
NoteData storeNote(int noteDelayLow, int noteDelayLowSharp, NoteData storeNote(int noteDelayLow, int noteDelayLowSharp,
int noteDelayMed, int noteDelayMedSharp, int noteDelayMed, int noteDelayMedSharp,
int noteDelayHigh, int noteDelayHighSharp); int noteDelayHigh, int noteDelayHighSharp);
}; };
} }