Serial Wombat 4A and 4B Firmware
ProtocolAsciiCommands

ASCII Echo

This command simply sends back what was sent and takes no action. Echos back response unless error.

BYTE 0 BYTE 1 BYTE 2 BYTE 3 BYTE 4 BYTE 5 BYTE 6 BYTE 7
'!' AnyByte AnyByte AnyByte AnyByte AnyByte AnyByte AnyByte

Examples:

!1234567

Will respond !1234567


ASCII Enable / Disable Line Breaks

This command causes the Serial Wombat to echo back input and add a carraige return / line feed before and after every returned message.

This command is only valid on UART based Serial Wombats.

This is very useful when you're typing commands in a terminal, but will cause problems if you are talking to the Serial Wombat with a program, particularly if you are using Binary commands.

This command is not supported on the Serial Wombat 4B.

BYTE 0 BYTE 1 BYTE 2 BYTE 3 BYTE 4 BYTE 5 BYTE 6 BYTE 7
'^' 'L' 'I' 'N' 'E' 'B' 'K' '0' or '1'

Examples:

^LINEBK1

Enables Line Breaks.

^LINEBK0

Disables Line Breaks (default).


Jump to Bootloader

This command causes the Serial Wombat to cease all operation immediately and reset. After reset it remains in the UART bootloader. Standard Serial Wombat commands do not work when in the bootloader. A power cycle is necessary to leave the bootloader.

BYTE 0 BYTE 1 BYTE 2 BYTE 3 BYTE 4 BYTE 5 BYTE 6 BYTE 7
'B' 'o' 'O' 't' 'L' 'o' 'A' 'd'

Examples:

^LINEBK1

Enables Line Breaks.

^LINEBK0

Disables Line Breaks (default).


ASCII Set Public Data

This command allows the public data of a pin to be set. Maximum allowable data value is 65535 . Value is represented in decimal. Echos back response unless error.

This command is not supported on the Serial Wombat 4B.

BYTE 0 BYTE 1 BYTE 2 BYTE 3 BYTE 4 BYTE 5 BYTE 6 BYTE 7
'D' Pin X 10's Pin X 1's Public Data 10000's Public Data 1000's Public Data 100's Public Data 10's Public Data 1's

Examples:

D0213143

Sets pin 2 Public Data to 13143.


ASCII Get Public Data

This command allows the public data of a pin to be set. Maximum allowable data value is 65535 . Value is represented in decimal. Echos back response unless error.

This command is not supported on the Serial Wombat 4B.

BYTE 0 BYTE 1 BYTE 2 BYTE 3 BYTE 4 BYTE 5 BYTE 6 BYTE 7
'G' Pin X 10's Pin X 1's 'U'* 'U'* 'U'* 'U'* 'U'*

'U' is recommended, but any byte is acceptable

Examples:

G02UUUUU

Gets pin 2 Public Data In Ascii Sample Response:

G0226132

Public data for Pin 2 is 26132.


ASCII Set Pin Command

This command allows the digital state of up to 5 consecutive pins to be set.

This command is not supported on the Serial Wombat 4B.

BYTE 0 BYTE 1 BYTE 2 BYTE 3 BYTE 4 BYTE 5 BYTE 6 BYTE 7
'P' Pin X 10's Pin X 1's Pin X Setting Pin X+1 Setting Pin X+2 Setting Pin X+3 Setting Pin X+4 Setting

Possible Pin Settings:

Examples:

P021xxxx

Sets pin 2 high, and doesn't change any other pins

P0910xii

Sets pin 9 High, pin 10 Low, doesn't change pin 11, and sets pins 12 and 13 to inputs


ASCII Reset Command

This command causes an internal reset of the Serial Wombat, similar to one caused by pulling the reset pin low.

BYTE 0 BYTE 1 BYTE 2 BYTE 3 BYTE 4 BYTE 5 BYTE 6 BYTE 7
'R' 'e' 'S' 'e' 'T' '!' '#' '*'

No response, as Wombat enters reset upon receipt. Example:

ReSeT!#*


ASCII Sleep Command

This command causes the Serial Wombat to go in a low power mode. Most Serial Wombat functions and pin modes stop. The host should ensure all pins are in a desired state before sleep.

Receipt of another byte will wake up the Serial Wombat. Suggested wakeup sequence for UART is 16 consecutive 0x55 bytes.

BYTE 0 BYTE 1 BYTE 2 BYTE 3 BYTE 4 BYTE 5 BYTE 6 BYTE 7
'S' 'l' 'E' 'e' 'P' '!' '#' '*'

Example:

SlEeP!#*

Command is echoed back before sleeping.


ASCII Version Command

Sends back V followed by 7 characters indicating the firmware version number

BYTE 0 BYTE 1 BYTE 2 BYTE 3 BYTE 4 BYTE 5 BYTE 6 BYTE 7
'V' 'U'* 'U'* 'U'* 'U'* 'U'* 'U'* 'U'*

'U' is recommended, but any byte is acceptable

Examples:

VUUUUUUU

Will respond

VS04B202

Or similar based on Model and Firmware version

V = Version Command

S = Serial Wombat

04B or similar = Model

202 or similar = Firmware Revision