WT5001 Class Reference

C++ API for the WT5001 Serial MP3 module. More...

Detailed Description

• ID: wt5001
• Name: Serial MP3 Module
• Category: sound
• Manufacturer: seeed
• Link: http://www.seeedstudio.com/wiki/Grove_%E2%80%93_Serial_MP3_Player
• Connection: uart

UPM support for the WT5001 Serial MP3 Module. This was tested specifically with the Grove Serial MP3 module.

  // Instantiate a WT5001 serial MP3 player on uart 0.
  // This example was tested on the Grove Serial MP3 module.

  upm::WT5001* mp3 = new upm::WT5001(0);
  
  int cmd = -1;
  if (argc > 1)
    cmd = atoi(argv[1]);
  
  // make sure port is initialized properly.  9600 baud is the default.
  if (!mp3->setupTty(B9600))
    {
      cerr << "Failed to setup tty port parameters" << endl;
      return 1;
    }
  
  switch (cmd)
    {
    case 0:
      mp3->stop();
      break;
   
    case 1:
      mp3->play(upm::WT5001::SD, 1);
      break;
   
    case 2:
      mp3->pause();
      break;
   
    case 3:
      mp3->next();
      break;
   
    case 4:
      mp3->previous();
      break;

    default:
      // nothing, just output usage, and info below
      printUsage(argv[0]);
      break;
    }   

  // Example: set the date
  // mp3->setDate(2015, 1, 1);

  // Example: set the time
  // mp3->setTime(12, 30, 30);

  // print out some information
  uint8_t vol = 0;
  if (mp3->getVolume(&vol))
    cout << "The current volume is: " << int(vol) << endl;

  uint8_t ps = 0;
  if (mp3->getPlayState(&ps))
    cout << "The current play state is: " << int(ps) << endl;

  uint16_t numf = 0;
  if (mp3->getNumFiles(upm::WT5001::SD, &numf))
    cout << "The number of files on the SD card is: " << int(numf) << endl;

  uint16_t curf = 0;
  if (mp3->getCurrentFile(&curf))
    cout << "The current file is: " << int(curf) << endl;

  uint16_t year = 0;
  uint8_t month = 0, day = 0;
  if (mp3->getDate(&year, &month, &day))
    cout << "The device date is: " << int(month) << "/" << int(day) 
         << "/" << int(year) << endl;

  uint8_t hour = 0, minute = 0, second = 0;
  if (mp3->getTime(&hour, &minute, &second))
    cout << "The device time is: " << int(hour) << ":" << int(minute) 
         << ":" << int(second) << endl;

Public Types
enum	WT5001_OPCODE_T {   NONE = 0x00, PLAY_SD = 0xa0, PLAY_SPI = 0xa1, PLAY_UDISK = 0xa2,   PAUSE = 0xa3, STOP = 0xa4, NEXT = 0xa5, PREVIOUS = 0xa6,   SET_VOLUME = 0xa7, QUEUE = 0xa8, PLAY_MODE = 0xa9, COPY_SD2FLASH = 0xaa,   COPY_UDISK2FLASH = 0xab, INSERT_SONG = 0xac, SET_DATE = 0xb1, SET_TIME = 0xb2,   SET_ALARM = 0xb3, SET_ALARM_DUR = 0xb4, CLEAR_ALARM = 0xb5, CLEAR_ALARM_DUR = 0xb6,   READ_VOLUME = 0xc1, READ_PLAY_STATE = 0xc2, READ_SPI_NUMF = 0xc3, READ_SD_NUMF = 0xc4,   READ_UDISK_NUMF = 0xc5, READ_CUR_FNAME = 0xc6, READ_CF_CHAR = 0xc7, READ_DATE = 0xd1,   READ_TIME = 0xd2 }
enum	WT5001_PLAYMODE_T { NORMAL = 0x00, SINGLE_REPEAT = 0x01, ALL_REPEAT = 0x02, RANDOM = 0x03 }
enum	WT5001_PLAYSOURCE_T { SD, SPI, UDISK }

Public Member Functions
	WT5001 (int uart)
	~WT5001 ()
bool	dataAvailable (unsigned int millis)
int	readData (char *buffer, size_t len)
int	writeData (char *buffer, size_t len)
bool	setupTty (speed_t baud=B9600)
bool	checkResponse (WT5001_OPCODE_T opcode)
bool	play (WT5001_PLAYSOURCE_T psrc, uint16_t index)
bool	stop ()
bool	pause ()
bool	next ()
bool	previous ()
bool	setVolume (uint8_t vol)
bool	queue (uint16_t index)
bool	setPlayMode (WT5001_PLAYMODE_T pm)
bool	insert (uint16_t index)
bool	setDate (uint16_t year, uint8_t month, uint8_t day)
bool	setTime (uint8_t hour, uint8_t minute, uint8_t second)
bool	setAlarm (uint8_t hour, uint8_t minute, uint8_t second)
bool	clearAlarm ()
bool	getVolume (uint8_t *vol)
bool	getPlayState (uint8_t *ps)
bool	getNumFiles (WT5001_PLAYSOURCE_T psrc, uint16_t *numf)
bool	getCurrentFile (uint16_t *curf)
bool	getDate (uint16_t *year, uint8_t *month, uint8_t *day)
bool	getTime (uint8_t *hour, uint8_t *minute, uint8_t *second)

Protected Member Functions
int	ttyFd ()
int	setTtyFd (int fd)

Constructor & Destructor Documentation

WT5001

(

int

uart

)

WT5001 Serial MP3 module constructor

Parameters

uart	default uart to use (0 or 1)

~WT5001

(

)

WT5001 Serial MP3 module Destructor

Member Function Documentation

bool dataAvailable

(

unsigned int

millis

)

Check to see if there is data available for reading

Parameters

millis

number of milliseconds to wait, 0 means no wait.

Returns

true if there is data available to be read

int readData	(	char *	buffer,
		size_t	len
	)

read any available data into a user-supplied buffer. Note, the call will block until data is available to be read. Use dataAvailable() to determine whether there is data available beforehand, to avoid blocking.

Parameters

buffer	the buffer to hold the data read
len	the length of the buffer

Returns

the number of bytes read

int writeData	(	char *	buffer,
		size_t	len
	)

write the data in buffer to the device

Parameters

buffer	the buffer to hold the data read
len	the length of the buffer

Returns

the number of bytes written

bool setupTty

(

speed_t

baud = B9600

)

setup the proper tty i/o modes and the baudrate. The default baud rate is 9600 (B9600).

Parameters

baud	the desired baud rate.

Returns

true if successful

bool checkResponse

(

WT5001_OPCODE_T

opcode

)

Get a command response and return it's validity

Parameters

index

opcode to verify

Returns

true if successful

bool play	(	WT5001_PLAYSOURCE_T	psrc,
		uint16_t	index
	)

play a file, from a source

Parameters

psrc	the play source (SD, UDISK, SPI)
index	file number to play

Returns

true if successful

bool stop

(

)

stop playing

Returns

true if successful

bool pause

(

)

pause playback, or resume playback if already paused

Returns

true if successful

bool next

(

)

go to next track

Returns

true if successful

bool previous

(

)

go to previous track

Returns

true if successful

bool setVolume

(

uint8_t

vol

)

set the volume. Range is between 0-31. 0 means mute.

Returns

true if successful

bool queue

(

uint16_t

index

)

queue a track to play next, when current song is finished

Parameters

index

file number to queue

Returns

true if successful

bool setPlayMode

(

WT5001_PLAYMODE_T

pm

)

set the playback mode

Parameters

pm	play mode to enable

Returns

true if successful

bool insert

(

uint16_t

index

)

insert a track to play immediately, interrupting the current track. When the inserted track is finished playing, the interrupted track will resume where it was interrupted.

Parameters

index

file number to insert

Returns

true if successful

bool setDate	(	uint16_t	year,
		uint8_t	month,
		uint8_t	day
	)

set the date of the internal clock

Parameters

year	4 digit year
month	the month
day	the day

Returns

true if successful

bool setTime	(	uint8_t	hour,
		uint8_t	minute,
		uint8_t	second
	)

set the time of the internal clock

Parameters

hour	hour
minute	minute
second	second

Returns

true if successful

bool setAlarm	(	uint8_t	hour,
		uint8_t	minute,
		uint8_t	second
	)

set the alarm

Parameters

hour	hour
minute	minute
second	second

Returns

true if successful

bool clearAlarm

(

)

clear any alarm that has been set

Returns

true if successful

bool getVolume

(

uint8_t *

vol

)

get the current volume

Parameters

vol	the returned volume

Returns

true if successful

bool getPlayState

(

uint8_t *

ps

)

get the current play state. 1 = playing, 2 = stopped, 3 = paused

Parameters

ps	the returned play state

Returns

true if successful

bool getNumFiles	(	WT5001_PLAYSOURCE_T	psrc,
		uint16_t *	numf
	)

get the number of files present on the source device

Parameters

psrc	the storage source
numf	the returned number of files

Returns

true if successful

bool getCurrentFile

(

uint16_t *

curf

)

get the index of the current file

Parameters

curf	the index of the current file

Returns

true if successful

bool getDate	(	uint16_t *	year,
		uint8_t *	month,
		uint8_t *	day
	)

get the device date

Parameters

year	returned 4 digit year
month	returned month
day	returned day

Returns

true if successful

bool getTime	(	uint8_t *	hour,
		uint8_t *	minute,
		uint8_t *	second
	)

get the device time

Parameters

hour	returned hour
minute	returned minute
second	returned second

Returns

true if successful

---

The documentation for this class was generated from the following files:

• /var/lib/jenkins/workspace/upm-doc-stable/src/wt5001/wt5001.h
• /var/lib/jenkins/workspace/upm-doc-stable/src/wt5001/wt5001.cxx