Vaddio AV Bridge CONFERENCE - Manual (Page 23)

AV Bridge CONFERENCE
Vaddio AV Bridge CONFERENCE - Document Number 342-0767 Rev A Page 23 of 32
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 CONFERENCE.
Format:
The AV Bridge CONFERENCE command application protocol interface is intended to allow external controllers
such as AMX or Crestron to control the device. The protocol is based upon ASCII format following the VT100
terminal emulation standard with an intuitive textual command nomenclature for ease of use. Again, 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 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
Additional programming controls associated with the terminal protocol includes:

CTRL 5- Clears the current serial buffer on the device.
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,200, 38,400 (Default is 38,400 bps)
Telnet Format:
The AV Bridge CONFERENCE also supports the API over a network connection
with Telnet. Telnet sessions will require access verification and uses the same
username and password associated with the Administrator account on the
embedded web server.
The Details:
 The default Telnet port is 23.
 Command lines are terminated with a carriage return. A complete list of API commands supported by the AV
Bridge CONFERENCE is described in the next section.
Image: Another fine example
of a simulated Telnet session