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

docs: updated library descriptions and sensor names for consistency

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
2015-06-01 15:44:07 -07:00
parent 8965d56c93
commit 14f80e779e
97 changed files with 237 additions and 246 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
src/wt5001/wt5001.h
View File

@ -49,25 +49,22 @@ const uint8_t WT5001_END = 0x7e;
namespace upm {
/**
* @brief API for the WT5001 Serial MP3 module
*
* UPM support for the WT5001 Serial MP3 Module. This was tested
* specifically with the Grove Serial MP3 module.
*
* @brief WT5001 Serial MP3 module library
* @defgroup wt5001 libupm-wt5001
* @ingroup seeed uart sound
*/
/**
* @library wt5001
* @sensor wt5001
* @comname Serial MP3 Module
* @comname WT5001 Serial MP3 Module
* @altname Grove Serial MP3 Player
* @type sound
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_%E2%80%93_Serial_MP3_Player
* @con uart
*
* @brief API for the WT5001 Serial MP3 module
*
*
* UPM support for the WT5001 Serial MP3 Module. This was tested
* specifically with the Grove Serial MP3 module.
*
@ -108,20 +105,20 @@ namespace upm {
READ_DATE = 0xd1,
READ_TIME = 0xd2
} WT5001_OPCODE_T;
// play modes
typedef enum { NORMAL = 0x00,
SINGLE_REPEAT = 0x01,
ALL_REPEAT = 0x02,
RANDOM = 0x03
} WT5001_PLAYMODE_T;
// music source
typedef enum { SD,
SPI,
UDISK
} WT5001_PLAYSOURCE_T;
/**
* WT5001 Serial MP3 module constructor
*
@ -167,7 +164,7 @@ namespace upm {
* setup the proper tty i/o modes and the baudrate. The default
* baud rate is 9600 (B9600).
*
* @param baud the desired baud rate.
* @param baud the desired baud rate.
* @return true if successful
*/
bool setupTty(speed_t baud=B9600);
@ -179,7 +176,7 @@ namespace upm {
* @return true if successful
*/
bool checkResponse(WT5001_OPCODE_T opcode);
/**
* play a file, from a source
*