AV Bridge
Vaddio AV Bridge - Document Number 342-0518 Rev A Page 22 of 28
Appendix 2- Vaddio Serial Command API
The Vaddio Serial Command protocol is a high level text based command line interface supported on the RS-232
port or via telnet session on the AV Bridge.
Format
The AV Bridge command application protocol interface is intended to allow external device such as AMX and
Crestron to control the device. The protocol is based upon ASCII format and utilizes an intuitive textual command
nomenclature for ease of use. The API is supported on both the RS-232 and Ethernet physical layers.
RS-232 Format:
The RS-232 command format is based communication interface of:
Start Bit: 1
Stop Bit: 1
Data:
8
Polarity:
None
Flow Control: None
Baud Rate: User selectable between 9600, 19.2, 38.4
Command lines are terminated on carriage return.
Telnet Format:
The AV Bridge also supports the API over a network connection with a Telnet sessions. Telnet
sessions will require access verification and utilizes the same username and password associated with the
Administrator account on the embedded web server. The default Telnet Port is 23. Command lines are
terminated with carriage return.
A complete list of API commands supported by the AV Bridge are described in the next section
Command List
EXIT
NAME
exit - ends the current API command session
SYNOPSIS
exit
DESCRIPTION
Ends the current API command session. If the session is over telnet, the session is ended and the socket is
closed. If the session is over serial, a new session is started.
HELP
NAME
help - display an overview of the CLI syntax
SYNOPSIS
help
DESCRIPTION
Display an overview of the command line syntax
HISTORY
NAME
history - command history
SYNOPSIS
history [
limit
]
DESCRIPTION