Rogue Module Settings

Overview

This page is a detailed list of all of the available settings for Rogue Robotics Modules (uMMC, uMP3, and rMP3). Please see the Settings Command for more details on how to change the settings.

(TL;DR: Just note that the uMMC uses the S command to change settings, while the uMP3 and the rMP3 use the ST command.)

File System Settings

Copy Progress Style

uMMC, uMP3, rMP3

Setting name: C

Default: 0 (no detail)

When using the Copy command, the response for the command is formatted differently depending on the value of this setting.

Range: 0 → 3

If the value is 0, then no response is given upon a successful copy.

If the value is 1 or 3, then a hash mark # is sent every 2048 bytes copied.

If the value is 2 or 3, upon completion of the copy process, a summary is provided (shown above).

Read/Write Line Ending

uMMC, uMP3, rMP3

Setting name: E

Default: 0 («cr»)

The Read Line command reads up to the terminator selected through this setting.

The Write Line command appends the appropriate EOL (End Of Line) terminator selected by this setting, and write the data to the file.

Range: 0 → 2

Write Time-out

uMMC, uMP3, rMP3

Setting name: T

Default: 0 (no time-out, waits indefinitely)

If this setting’s value is greater than 0 (zero), then if the time taken between sending bytes exceeds that value (in tens of milliseconds), the Write (Write Line) command will terminate, write the accepted bytes to the file, and return to the command prompt. No EOL terminator will be written. No error will be returned.

Range: 0 → 254

Directory Listing Style

uMMC, uMP3, rMP3

Setting name: L

Default: 0 (basic)

The response format for the List Directory command depends on the value of this setting.

Range: 0 or 1

L = 0 (basic):

«sp»D | ss..sss filename1«cr»
D | ss..sss filename2«cr»
...
D | ss..sss filenameN«cr»

where:

• D indicates a directory
• ss..sss is the size of the file
• filenameN is the filename or directory name

L = 1 (detailed):

«sp»DRHSA yyyy/mm/dd hh:mm:ss ss..sss filename1«cr»
DRHSA yyyy/mm/dd hh:mm:ss ss..sss filename2«cr»
...
DRHSA yyyy/mm/dd hh:mm:ss ss..sss filenameN«cr»

where:

• DRHSA are the attributes for the file. If the attribute is not set, the value is “-”. D indicates a directory.
• yyyy/mm/dd hh:mm:ss is the modification date of the file/directory.
• filenameN is the filename or directory name

Communication Settings

Serial Bitrate

uMMC, uMP3, rMP3

Setting name: D

Default: 0 (9600 bps)

Rogue modules communicate using asynchronous serial. This setting sets the rate at which the module communicates.

Range: 0 → 8

Example: Set serial bitrate to 57600 bps on a uMMC

Example: Set serial bitrate to 115200 bps on a uMP3 or rMP3

Prompt Character

uMMC, uMP3, rMP3

Setting name: P

Default: 62 (>)

This is the character that is returned when the module is ready to receive a new command. You can use this character to synchronize communications.

Range: 1 → 254

Type: ASCII character value.

Example: Set prompt to ‘%’ on uMMC

Example: Set prompt to ‘]’ on uMP3/rMP3

Response Delay

uMMC, uMP3, rMP3

Setting name: R

Default: 0 (no delay)

This is a delay that is introduced between when a command is received by the module and when the command begins processing. This is especially useful for controllers that need time to set up their serial input (e.g. Basic Stamp).

Range: 0 → 254

Type: Time in 10 millisecond increments (e.g. 5 = 50 ms).

Example: Set response delay to 50 ms on uMMC

Example: Set response delay to 120 ms on uMP3 or rMP3

Non-volatile Playback Settings

Volume

uMP3, rMP3

Setting name: V

Default: 16, 16 (-8 dB)

Sets the start-up volume for the rMP3. You can provide both the left and right volume settings.

Range: Left: 0 → 254, Right: 0 → 254

Type: Volume attenuation in -0.5 dB increments (e.g. 16 = -8 dB).

Example: Set volume to L:0 dB, R: -4 dB on uMP3 or rMP3

Loop Count

uMP3, rMP3

Setting name: O

Default: 1 (play once)

Sets the default loop count for playback. This is the number of times a file is repeated.

Range: 0 → 254

Type: Number of repeats.

Note: 0 means infinite repeat - continuous looping of playback. A value of 1 means to play the file once.

Example: Set default loop count to 2 on uMP3 or rMP3

Boost

uMP3, rMP3

Setting name: B

Default: 0 (no boost)

Sets the default Boost value. This is an audio enhancement provided by the decoder which boosts the bass and/or treble response.

• Treble boost can be set from -12 to +10.5 dB boost (in 1.5 dB steps) at and above frequencies ranging from 1000 to 15000 Hz (in 1000 Hz steps).
• Bass boost can be set from 0 to 15 dB boost (in 1 dB steps) below frequencies ranging from 20 to 150 Hz (in 10 Hz steps).

The Boost value is calculated as follows:

• treble boost = (treble amplitude[see table below] * 16) + treble frequency/1000
• bass boost = ((bass amplitude * 16) + (bass frequency/10)
• boost = treble boost * 256 + bass boost

A value of 0 will turn off the audio enhancement.

Range: 0 → 65536

Note: Treble amplitude is a twos-complement value for the amplitude.

Type: Boost encoded value.

Example:

Treble boost frequency: 10 kHz (and above)
Treble boost amplitude: +10.5 dB
Bass boost frequency: 60 Hz (and below)
Bass boost amplitude: +15 dB

treble boost = (7 * 16) + 10000/1000
             = 112 + 10 = 122
bass boost   = (15 * 16) + 60/10
             = 240 + 6 = 246
Boost value  = 122 * 256 + 246
             = 31478

Input/Output Interface Settings

Input Style

uMP3, rMP3

Setting name: S

Default: 0 (no input style)

Sets the input interface style. See the Input Interface section for more information.

Range: 0 → 2

Example: Set input style to 7 Bit plus Trigger (2)

Hardware Busy Indicator

uMP3, rMP3

Setting name: H

Default: 0 (off)

Sets the “D” pin to be a hardware busy logic output (high when playing).

Range: 0 or 1

Type: Switch.

Example: Turn on Hardware Busy Indicator

Input File Number Offset

uMP3, rMP3

Setting name: N

Default: 0

Sets the offset for the filenames used for the input interface. For example, if the Button/Switch interface is being used, and the Input File Number Offset is set to 200, then all filenames will be offset by 200. i.e. The filename for Button/Switch 2 will be B0202.MP3.

Range: 0 → 9872

Type: Offset.

Example: Set offset to 100

Input Non-stop Control

uMP3, rMP3

Setting name: U

Default: 0 (all inputs interruptable)

In 8 Button/Switch mode, this 8 bit mask indicates which buttons will be considered non-stop (a 1 in the mask indicates non-stop). In 7 Bit mode, anything > 0 will indicate non-stop playback.

Range: 0 → 255

Type: 8 bit mask.

Example:

Set input pins 0 and 5 as non-stop (“uninterruptible”):

Input Polarity Control

uMP3, rMP3

Setting name: A

Default: 0 (negative edge triggering - i.e. when an input goes low, playback is triggered)

Used only in 8 Button/Switch mode, this 8 bit mask indicates the polarity of input for each individual input pin (a 1 in the mask indicates positive edge triggering).

Range: 0 → 255

Type: 8 bit mask.

Example:

Set input pins 0 and 6 as positive edge triggered (the rest are negative edge triggered):

Switch Input Debounce Mode

uMP3, rMP3

Setting name: M

Default: 0 (no debouce)

Used only in 8 Button/Switch mode, this setting will turn on a simple 40 ms debounce algorithm for the inputs.

Range: 0 or 1

Type: Switch.

Example: Turn on debounce algorithm