AV Bridge USB and IP Streaming Device
Page 22
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.
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 following the VT100 terminal emulation
standard and utilizes an intuitive textual command nomenclature for ease of use. The API is supported on both
the RS-232 and Ethernet physical layers. All ASCII characters will be
echoed
to terminal program and appended
with VT100 string -
ESC[J
(HEX- 1B 5B 4A). Vaddio Command lines are terminated on carriage return. After the
carriage return, the VT100 appends with –
ESC[J
. Note that most terminal programs automatically strip the
VT100 string.
General format usage follows a get/set structure. Usage examples for each type are:
Set Example:
COMMAND: > audio mute set on
RESPONSE: >OK
Get Example:
COMMAND: > audio mute get
RESPONSE: > audio mute on
Syntax Error Example:
COMMAND: > audio mute on
RESPONSE: > Syntax error: Unknown or incomplete command
CTRL 5- Clears the current serial buffer on the device.
RS-232 Format
•
Start Bit: 1
•
Stop Bit: 1
•
Data: 8
•
Polarity: None
•
Flow Control: None
•
Baud Rate: User selectable between 9600, 19,200, 38,400
(Default is 38,400 bps)
Telnet Format:
The AV Bridge also supports the API over a network connection with
a Telnet session. Telnet sessions require you to log in as admin. The default Telnet
Port is 23. Command lines are terminated with carriage return. A complete list of API
commands supported by the AV Bridge is described in the next section.
Image: Scintillating
example of simulated
Telnet session
