Public Member Functions
	JQ8400_Serial (Stream &_Stream)
	Create JQ8400 object with a given serial object to communicate to the JQ8400. More...

void	play ()
	Start playing the current file, if paused the playing is resumed. More...

void	restart ()
	Restart the current track from the beginning.

void	pause ()
	Pause the current file. More...

void	stop ()
	Stop the current playing (if any).

void	fastForward (uint16_t seconds=5)
	Fast Forward by a number of seconds (default 5).

void	rewind (uint16_t seconds=5)
	Rewind by a number of seconds (default 5).

void	next ()
	Play the next file.

void	prev ()
	Play the previous file.

void	nextFolder ()
	Play the next folder.

void	prevFolder ()
	Play the previous folder.

void	playFileByIndexNumber (uint16_t fileNumber)
	Play a specific file based on it's FAT index number. More...

void	interjectFileByIndexNumber (uint16_t fileNumber)
	Interject the currently playing file (if any) with the given FAT index number file. More...

void	playFileNumberInFolderNumber (uint16_t folderNumber, uint16_t fileNumber)
	Play a specific file in a specific folder based on the name of those folder and file. More...

void	playInFolderNumber (uint16_t folderNumber)
	Play the first (?) file in a specific folder 00 to 99. More...

void	seekFileByIndexNumber (uint16_t fileNumber)
	Seek to a specific file based on it's FAT index number. More...

void	abLoopPlay (uint16_t secondsStart, uint16_t secondsEnd)
	A-B Loop for the file currently playing. More...

void	abLoopClear ()
	Use this to break a currently running A-B loop. More...

void	volumeUp ()
	Increase the volume by 1 (volume ranges 0 to 30). More...

void	volumeDn ()
	Decrease the volume by 1 (volume ranges 0 to 30). More...

void	setVolume (byte volumeFrom0To30)
	Set the volume to a specific level (0 to 30). More...

void	setEqualizer (byte equalizerMode)
	Set the equalizer to one of 6 preset modes. More...

void	setLoopMode (byte loopMode)
	Set the looping mode. More...

void	setSource (byte source)
	Set the source to read mp3 data from. More...

uint8_t	getSource ()
	Return the currently selected source. More...

uint8_t	sourceAvailable (uint8_t source)
	Return boolean indicating if the given source is available (can be selected using `setSource()`) More...

void	sleep ()
	Put the device to sleep. More...

void	reset ()
	Reset the device (softly). More...

byte	getStatus ()
	Get the status from the device. More...

uint8_t	busy ()
	Return if the device is busy (playing) or not. More...

byte	getVolume ()
	Get the current volume level. More...

byte	getEqualizer ()
	Get the equalizer mode. More...

byte	getLoopMode ()
	Get loop mode. More...

uint16_t	countFiles ()
	Count the number of files on the current media. More...

uint16_t	currentFileIndexNumber ()
	For the currently playing (or paused, or file that would be played next if stopped) file, return the file's FAT index number. More...

uint16_t	currentFilePositionInSeconds ()
	For the currently playing or paused file, return the current position in seconds. More...

uint16_t	currentFileLengthInSeconds ()
	For the currently playing or paused file, return the total length of the file in seconds. More...

void	currentFileName (char *buffer, uint16_t bufferLength)
	Get the name of the "current" file. More...

void	playSequenceByFileNumber (uint8_t playList[], uint8_t listLength)
	Play a sequence of files, which must all exist in a folder called "ZH" and be named 00.mp3 through 99.mp3. More...

void	playSequenceByFileName (const char *playList[], uint8_t listLength)
	Play a sequence of files, which must all exist in a folder called "ZH" and have 2 character names. More...

Protected Member Functions
void	sendCommandData (uint8_t command, uint8_t requestBuffer, uint8_t requestLength, uint8_t responseBuffer, uint8_t bufferLength)
	Send a command to the JQ8400 module,. More...

void	sendCommand (uint8_t command, uint8_t *responseBuffer=0, uint8_t bufferLength=0)
	Send a command with no arguments and no response. More...

void	sendCommand (uint8_t command, uint8_t arg, uint8_t *responseBuffer=0, uint8_t bufferLength=0)
	Send a command with a single 8 bit argument and no response. More...

void	sendCommand (uint8_t command, uint16_t arg, uint8_t *responseBuffer=0, uint8_t bufferLength=0)
	Send a command with a 16 bit integer argument. More...

uint16_t	sendCommandWithUnsignedIntResponse (byte command)
	Send a command to the JQ8400 module, and get a 16 bit integer response. More...

uint8_t	sendCommandWithByteResponse (uint8_t command)
	Send a command to the JQ8400 module, and get an 8 bit integer response. More...

uint8_t	getAvailableSources ()
	Return a bitmask of the available sources. More...

int	waitUntilAvailable (uint16_t maxWaitTime=1000)
	Blocking wait with a timeout for serial input. More...

Protected Attributes
Stream *	_Serial
	Set in the constructor, the stream (eg HardwareSerial or SoftwareSerial object) that connects us to the device.

uint8_t	currentVolume = 20
	Record of current volume level (JQ8400 has no way to query)

uint8_t	currentEq = 0
	Record of current equalizer (JQ8400 has no way to query)

uint8_t	currentLoop = 2
	Record of current loop mode (JQ8400 has no way to query)

Static Protected Attributes
Command Byte Definitions
static const uint8_t	MP3_CMD_BEGIN = 0xAA

static const uint8_t	MP3_CMD_PLAY = 0x02

static const uint8_t	MP3_CMD_PAUSE = 0x03

static const uint8_t	MP3_CMD_FFWD = 0x23

static const uint8_t	MP3_CMD_RWND = 0x22

static const uint8_t	MP3_CMD_STOP = 0x10

static const uint8_t	MP3_CMD_NEXT = 0x06

static const uint8_t	MP3_CMD_PREV = 0x05

static const uint8_t	MP3_CMD_PLAY_IDX = 0x07

static const uint8_t	MP3_CMD_SEEK_IDX = 0x1F

static const uint8_t	MP3_CMD_INSERT_IDX = 0x16

static const uint8_t	MP3_CMD_AB_PLAY = 0x20

static const uint8_t	MP3_CMD_AB_PLAY_STOP = 0x21

static const uint8_t	MP3_CMD_NEXT_FOLDER = 0x0F

static const uint8_t	MP3_CMD_PREV_FOLDER = 0x0E

static const uint8_t	MP3_CMD_PLAY_FILE_FOLDER = 0x08

static const uint8_t	MP3_CMD_VOL_UP = 0x14

static const uint8_t	MP3_CMD_VOL_DN = 0x15

static const uint8_t	MP3_CMD_VOL_SET = 0x13

static const uint8_t	MP3_CMD_EQ_SET = 0x1A

static const uint8_t	MP3_CMD_LOOP_SET = 0x18

static const uint8_t	MP3_CMD_SOURCE_SET = 0x0B

static const uint8_t	MP3_CMD_SLEEP = 0x04

static const uint8_t	MP3_CMD_RESET = 0x04

static const uint8_t	MP3_CMD_STATUS = 0x01

static const uint8_t	MP3_CMD_GET_SOURCES = 0x09

static const uint8_t	MP3_CMD_GET_SOURCE = 0x0A

static const uint8_t	MP3_CMD_COUNT_FILES = 0x0C

static const uint8_t	MP3_CMD_COUNT_IN_FOLDER = 0x12

static const uint8_t	MP3_CMD_CURRENT_FILE_IDX = 0x0D

static const uint8_t	MP3_CMD_FIRST_FILE_IN_FOLDER_IDX = 0x11

static const uint8_t	MP3_CMD_CURRENT_FILE_LEN = 0x24

static const uint8_t	MP3_CMD_CURRENT_FILE_POS = 0x25

static const uint8_t	MP3_CMD_CURRENT_FILE_POS_STOP = 0x26

static const uint8_t	MP3_CMD_CURRENT_FILE_NAME = 0x1E

static const uint8_t	MP3_CMD_PLAYLIST = 0x1B

Constructor & Destructor Documentation

JQ8400_Serial::JQ8400_Serial ( Stream & _Stream )

inline

Create JQ8400 object with a given serial object to communicate to the JQ8400.

Example for software serial...

#include <SoftwareSerial.h>
SoftwareSerial  mySerial(8,9);

#include <JQ8400_Serial.h>
JQ8400_Serial   mp3(mySerial);

void setup()
{
  mySerial.begin(9600);
  mp3.reset();
}

Example over microcontroller's default hardware serial port...

#include <JQ8400_Serial.h>
JQ8400_Serial   mp3(Serial);

void setup()
{
  Serial.begin(9600);
  mp3.reset();
}

Example over microcontroller's other hardware serial port...

#include <JQ8400_Serial.h>
JQ8400_Serial   mp3(Serial2);

void setup()
{
  Serial2.begin(9600);
  mp3.reset();
}

Example wiring for a 5v Arduino with SoftwareSerial on Pins 8 (RX) and 9 (TX):

TX on JQ8400 connects to D8 (SoftwareSerial RX) on the Arduino
RX on JQ8400 connects to one end of a 1k resistor, other end of resistor connects to D9 (SoftwareSerial TX) on the Arduino

Example wiring for a 3v3 Arduino with SoftwareSerial on Pins 8 (RX) and 9 (TX):

TX on JQ8400 connects to D8 (SoftwareSerial RX) on the Arduino
RX on JQ8400 connects to D9 (SoftwareSerial TX) on the Arduino

Example wiring for an ESP32 Arduino using Serial2 connections...

TX on JQ8400 connects to GPIO16 (Serial2 RX) on the ESP32
RX on JQ8400 connects to GPIO17 (Serial2 TX) on the ESP32

Of course, power and ground are also required, VCC on JQ8400 is 5v tolerant (but RX isn't totally, hence the resistor above). *

The TX voltage from the JQ8400 is 3.3v, you do not need to level-shift this as 3.3v will still read as high for a 5v Arduino (and is safe for a 3.3v one).

Member Function Documentation

void JQ8400_Serial::abLoopClear ( )

Use this to break a currently running A-B loop.

Pause, stop, play will also break the A-B loop, this will do it without requiring any break the play will just continue through the previously set end marker without looping.

void JQ8400_Serial::abLoopPlay	(	uint16_t	secondsStart,
		uint16_t	secondsEnd
	)

A-B Loop for the file currently playing.

For the track that is already playing (and not paused) loop play between two marks defined by a start and end second.

If you want to start a file in an ab loop, start it playing and immediately issue the abLoopPlay.

mp3.playFileByIndexNumber(1);
mp3.abLoopPlay(25,50);

will work, similarly if you want to resume from a pause into an ab loop

mp3.play(); mp3.abLoopPlay(25,50);

if you pause in an abLoop when you play again the abLoop is terminated.

There seems to be some sort of odd granularity with this function of the device, the first time through the ab-loop the start point is sometimes different to subsequent loops through, perhaps a second "out", that is if you specify start at 25 seconds, the first loop might start at 24, and subsequent ones at 25 (or vice-versa). In short, experimentation might be needed here.

Parameters

secondsStart	Second to set as start marker.
secondsEnd	Second to set as end marker.

uint8_t JQ8400_Serial::busy ( )

inline

Return if the device is busy (playing) or not.

Just a convenience test, equivalent to getStatus() == MP3_STATUS_PLAYING

Returns: bool

uint16_t JQ8400_Serial::countFiles ( )

Count the number of files on the current media.

Returns: Number of files present on that media.

uint16_t JQ8400_Serial::currentFileIndexNumber ( )

For the currently playing (or paused, or file that would be played next if stopped) file, return the file's FAT index number.

This number can be used with playFileByIndexNumber();

About The FAT Index Number

Note that the index number has nothing to do with the file name (except if you uploaded/copied them to the media in order of file name).

It is the index of the file in the drive's File Allocation Table (FAT), loosely this is usually the order in which you copied the files across, but due to operating systems that's not entirely assured.

To sort the FAT (after copying files), or view the FAT order, search for a FAT sorting utility for your operating system.

Specifically on Linux fatsort is the tool you want, but be sure to get a recent version which supports FAT-12, older ones do not.

Returns: FAT index number of file.

uint16_t JQ8400_Serial::currentFileLengthInSeconds ( )

For the currently playing or paused file, return the total length of the file in seconds.

Returns: Length of audio file in seconds.

void JQ8400_Serial::currentFileName	(	char *	buffer,
		uint16_t	bufferLength
	)

Get the name of the "current" file.

The name returned is shortened significantly to 8+3 format without a dot, all caps... in other words, this isn't very useful probably.

The current file is the one that is playing, paused, or if stopped then could be next to play or last played, uncertain.

Example

char buf[12];
mp3.currentFileName(buf, sizeof(buf));
Serial.println(buf);

Parameters

buffer	character buffer of 12 bytes or more (eg `char buf[12]`)
bufferLength	length of the buffer (eg 12)

uint16_t JQ8400_Serial::currentFilePositionInSeconds ( )

For the currently playing or paused file, return the current position in seconds.

Returns: Number of seconds into the file currently played.

uint8_t JQ8400_Serial::getAvailableSources ( )

protected

Return a bitmask of the available sources.

Returns: Bitmask indicating which sources are connected to the module.

bit 0 = USB bit 1 = SD bit 2 = FLASH

byte JQ8400_Serial::getEqualizer ( )

Get the equalizer mode.

Returns: One of the following,

MP3_EQ_NORMAL
MP3_EQ_POP
MP3_EQ_ROCK
MP3_EQ_JAZZ
MP3_EQ_CLASSIC
MP3_EQ_BASS

byte JQ8400_Serial::getLoopMode ( )

Get loop mode.

Returns: One of the loop modes as follows...

MP3_LOOP_NONE - No loop, just play one file and then stop. (aka MP3_LOOP_ONE_STOP)
MP3_LOOP_ONE - Loop one file over and over and over again.
MP3_LOOP_ALL - Play through all files and repeat.
MP3_LOOP_ALL_STOP - Play through all files and stop.
MP3_LOOP_ALL_RANDOM - Play all files randomly (continuously)
MP3_LOOP_FOLDER - Play through all files in the same folder and repeat.
MP3_LOOP_FOLDER_STOP - Play through all files in the same folder and stop
MP3_LOOP_FOLDER_RANDOM - Play through all files in the same folder randomly (continuously)

uint8_t JQ8400_Serial::getSource ( )

Return the currently selected source.

Returns: One of the following...

MP3_SRC_BUILTIN - Files read from the on-board flash memory
MP3_SRC_SDCARD - Files read from the SD Card
MP3_SRC_USB - Files from a connected USB device? I have not seen modules capable of this, but possible?

byte JQ8400_Serial::getStatus ( )

Get the status from the device.

Returns: One of MP3_STATUS_PAUSED, MP3_STATUS_PLAYING and MP3_STATUS_STOPPED

byte JQ8400_Serial::getVolume ( )

Get the current volume level.

Returns: Value between 0 and 30

void JQ8400_Serial::interjectFileByIndexNumber ( uint16_t fileNumber )

Interject the currently playing file (if any) with the given FAT index number file.

Like a special announcement comes over, it interrupts the music playing, when the announcement finishes, the music continues.

About The FAT Index Number

Note that the index number has nothing to do with the file name (except if you uploaded/copied them to the media in order of file name).

It is the index of the file in the drive's File Allocation Table (FAT), loosely this is usually the order in which you copied the files across, but due to operating systems that's not entirely assured.

To sort the FAT (after copying files), or view the FAT order, search for a FAT sorting utility for your operating system.

Specifically on Linux fatsort is the tool you want, but be sure to get a recent version which supports FAT-12, older ones do not.

Parameters

fileNumber FAT index of the file to interject.

void JQ8400_Serial::pause ( )

Pause the current file.

To unpause, use play(), to unpause and go back to beginning of track use restart()

void JQ8400_Serial::play ( )

Start playing the current file, if paused the playing is resumed.

If stopped or playing the playing is started from beginning.

void JQ8400_Serial::playFileByIndexNumber ( uint16_t fileNumber )

Play a specific file based on it's FAT index number.

About The FAT Index Number

Note that the index number has nothing to do with the file name (except if you uploaded/copied them to the media in order of file name).

It is the index of the file in the drive's File Allocation Table (FAT), loosely this is usually the order in which you copied the files across, but due to operating systems that's not entirely assured.

To sort the FAT (after copying files), or view the FAT order, search for a FAT sorting utility for your operating system.

Specifically on Linux fatsort is the tool you want, but be sure to get a recent version which supports FAT-12, older ones do not.

Parameters

fileNumber FAT index of the file to play next.

void JQ8400_Serial::playFileNumberInFolderNumber	(	uint16_t	folderNumber,
		uint16_t	fileNumber
	)

Play a specific file in a specific folder based on the name of those folder and file.

To use this function, folders must be named from 00 to 99, and the files in those folders must be named from 000.mp3 to 999.mp3

Example

The device contains the file...

/03/006.mp3

then the following code will play that file...

mp3.playFileNumberInFolderNumber(3, 6);

Note that zero padding of your folder and file names is required - "01/002.mp3" good, "1/2.mp3" bad.

Parameters

folderNumber	0 to 99
fileNumber	0 to 999

void JQ8400_Serial::playInFolderNumber ( uint16_t folderNumber )

Play the first (?) file in a specific folder 00 to 99.

To use this function, folders must be named from 00 to 99.

So to play the folder "/03" use mp3.playInFolderNumber(3);

Note that zero padding of your folder and file required - "01/002.mp3" good, "1/2.mp3" bad.

Parameters

folderNumber 0 to 99

void JQ8400_Serial::playSequenceByFileName	(	const char *	playList[],
		uint8_t	listLength
	)

Play a sequence of files, which must all exist in a folder called "ZH" and have 2 character names.

Don't ask me why the folder must be called "ZH", that's what the JQ8400 wants.

Example

Given that the JQ8400 contains the files...

/ZH/A1.mp3
/ZH/1B.mp3
/ZH/AZ.mp3

then the following code will play them in the order 1B.mp3, A1.mp3, AZ.mp3

const char * playList[] = { "1B", "A1", "AZ" };
mp3.playSequenceByFileName(playList, sizeof(playList)/sizeof(char *));

Parameters

playList	An array of the two character names (as strings).
listLength	Number of filenames in the list.

void JQ8400_Serial::playSequenceByFileNumber	(	uint8_t	playList[],
		uint8_t	listLength
	)

Play a sequence of files, which must all exist in a folder called "ZH" and be named 00.mp3 through 99.mp3.

Don't ask me why the folder must be called "ZH", that's what the JQ8400 wants.

Example

Given that the JQ8400 contains the files...

/ZH/01.mp3
/ZH/02.mp3
/ZH/03.mp3

then the following code will play them in the order 03.mp3, 01.mp3, 02.mp3

uint8_t playList[] = { 3, 1, 2 };
mp3.playSequenceByFileNumber(playList, sizeof(playList));

pay attention that the file names are 2 digits, "`1.mp3`" is not valid.

Parameters

playList	An array of the numbers of files in the "ZH" folder.
listLength	Number of filenames in the list.

void JQ8400_Serial::reset ( )

Reset the device (softly).

It may be necessary in practice to actually power-cycle the device in case it gets confused or something.

So if designing a PCB/circuit including JQ8400 modules it might be worth while to include such ability (ie, power the device through a MOSFET which you can turn on/off at will).

void JQ8400_Serial::seekFileByIndexNumber ( uint16_t fileNumber )

Seek to a specific file based on it's FAT index number.

The file will not start playing until you issue play()

Note that any currently playing file will stop immediately.

It seems (undocumented) that seeking to a track will wake up the device's output and keep it awake until you play or stop (or it stops after playing), you may wish to issue a sleep() after seeking.

About The FAT Index Number

Note that the index number has nothing to do with the file name (except if you uploaded/copied them to the media in order of file name).

It is the index of the file in the drive's File Allocation Table (FAT), loosely this is usually the order in which you copied the files across, but due to operating systems that's not entirely assured.

To sort the FAT (after copying files), or view the FAT order, search for a FAT sorting utility for your operating system.

Specifically on Linux fatsort is the tool you want, but be sure to get a recent version which supports FAT-12, older ones do not.

Parameters

fileNumber FAT index of the file to play next.

void JQ8400_Serial::sendCommand	(	uint8_t	command,
		uint8_t *	responseBuffer = `0`,
		uint8_t	bufferLength = `0`
	)

inlineprotected

Send a command with no arguments and no response.

Parameters

command Byte value of to send as from the datasheet.

void JQ8400_Serial::sendCommand	(	uint8_t	command,
		uint8_t	arg,
		uint8_t *	responseBuffer = `0`,
		uint8_t	bufferLength = `0`
	)

inlineprotected

Send a command with a single 8 bit argument and no response.

Parameters

command	Byte value of to send as from the datasheet.
arg	Single byte of data

void JQ8400_Serial::sendCommand	(	uint8_t	command,
		uint16_t	arg,
		uint8_t *	responseBuffer = `0`,
		uint8_t	bufferLength = `0`
	)

inlineprotected

Send a command with a 16 bit integer argument.

Parameters

command Byte value of to send as from the datasheet.

arg 16 bit uint16_teger data

void JQ8400_Serial::sendCommandData	(	uint8_t	command,
		uint8_t *	requestBuffer,
		uint8_t	requestLength,
		uint8_t *	responseBuffer,
		uint8_t	bufferLength
	)

protected

Send a command to the JQ8400 module,.

Parameters

command	Byte value of to send as from the datasheet.
requestBuffer	Pointer to (or NULL) request data bytes.
requestLength	Number of bytes in the request buffer.
responseBuffer	Buffer to store a single line of response, if NULL, no response is read. Note that the response is NOT a null-terminated string, if you want that, do it yourself (and specify length-1).
buffLength	Length of response buffer.

uint8_t JQ8400_Serial::sendCommandWithByteResponse ( uint8_t command )

protected

Send a command to the JQ8400 module, and get an 8 bit integer response.

Parameters

command Byte value of to send as from the datasheet.

Returns: Response from module.

uint16_t JQ8400_Serial::sendCommandWithUnsignedIntResponse ( byte command )

protected

Send a command to the JQ8400 module, and get a 16 bit integer response.

Parameters

command Byte value of to send as from the datasheet.

Returns: Response from module.

void JQ8400_Serial::setEqualizer ( byte equalizerMode )

Set the equalizer to one of 6 preset modes.

Parameters

equalizerMode One of the following,

MP3_EQ_NORMAL
MP3_EQ_POP
MP3_EQ_ROCK
MP3_EQ_JAZZ
MP3_EQ_CLASSIC

void JQ8400_Serial::setLoopMode ( byte loopMode )

Set the looping mode.

Parameters

loopMode One of the following,

MP3_LOOP_NONE - No loop, just play one file and then stop. (aka MP3_LOOP_ONE_STOP)
MP3_LOOP_ONE - Loop one file over and over and over again.
MP3_LOOP_ALL - Play through all files and repeat.
MP3_LOOP_ALL_STOP - Play through all files and stop.
MP3_LOOP_ALL_RANDOM - Play all files randomly (continuously)
MP3_LOOP_FOLDER - Play through all files in the same folder and repeat.
MP3_LOOP_FOLDER_STOP - Play through all files in the same folder and stop
MP3_LOOP_FOLDER_RANDOM - Play through all files in the same folder randomly (continuously)

Note that the random options are perhaps not that optimal especially with low file counts, a track playing twice back to back is not unusual, and the randomness does not anecdotally seem all that random. (NB: These random options are implemented inside the JQ8400 device itself, not in code, you could make your own randomiser and just use play by index etc...)

void JQ8400_Serial::setSource ( byte source )

Set the source to read mp3 data from.

Note that the datasheet calls this "drive".

Parameters

source One of the following...

MP3_SRC_BUILTIN - Files read from the on-board flash memory
MP3_SRC_SDCARD - Files read from the SD Card
MP3_SRC_USB - Files from a connected USB device? I have not seen modules capable of this, but possible?

void JQ8400_Serial::setVolume ( byte volumeFrom0To30 )

Set the volume to a specific level (0 to 30).

Parameters

volumeFrom0To30 Level of volume to set from 0 to 30

void JQ8400_Serial::sleep ( )

Put the device to sleep.

This will stop all playing. When you play() again it will be from the beginning of the current track.

Note that the JQ8400 seems to automatically sleep when it stops playing except when you seek to a track (or pause).

uint8_t JQ8400_Serial::sourceAvailable ( uint8_t source )

inline

Return boolean indicating if the given source is available (can be selected using setSource())

Parameters

source

One of the following

MP3_SRC_BUILTIN - Files read from the on-board flash memory
MP3_SRC_SDCARD - Files read from the SD Card
MP3_SRC_USB - Files from a connected USB device? I have not seen modules capable of this, but possible?

Returns: bool

void JQ8400_Serial::volumeDn ( )

Decrease the volume by 1 (volume ranges 0 to 30).

void JQ8400_Serial::volumeUp ( )

Increase the volume by 1 (volume ranges 0 to 30).

int JQ8400_Serial::waitUntilAvailable ( uint16_t maxWaitTime = 1000 )

protected

Blocking wait with a timeout for serial input.

Parameters

maxWaitTime Milliseconds

Returns: bool Available (True) / Timed Out (False)

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

/bigdrive/home/boffin/Arduino-1.6/libraries/JQ8400_Serial/src/JQ8400_Serial.h
/bigdrive/home/boffin/Arduino-1.6/libraries/JQ8400_Serial/src/JQ8400_Serial.cpp

command	Byte value of to send as from the datasheet.
arg	16 bit uint16_teger data

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

Example for software serial...

Example over microcontroller's default hardware serial port...

Example over microcontroller's other hardware serial port...

Example wiring for a 5v Arduino with SoftwareSerial on Pins 8 (RX) and 9 (TX):

Example wiring for a 3v3 Arduino with SoftwareSerial on Pins 8 (RX) and 9 (TX):

Example wiring for an ESP32 Arduino using Serial2 connections...

Member Function Documentation