AV Bridge MATRIX PRO
AV Bridge Matrix Pro Manual - Document Number 342-0915 Rev C
Page 53 of 68
Appendix 2: API for External Control
The AV Bridge MATRIX PRO command application protocol interface is intended to allow external controllers
such as AMX or Crestron to control the device using a high-level text-based command line interface.
The API is supported on the RS-232 external control port and via Telnet session. The default Telnet port is 23.
Things to know about using the serial command API:
•
Unlike Vaddio cameras, the MATRIX PRO has a single serial command set which is used either
via RS-232 or Telnet session.
•
Admin login is required.
•
Commands are case-sensitive.
•
All commands must be followed by a carriage return.
•
Idle sessions may time out after a few minutes.
About the Vaddio Serial Command API
Format:
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. Command lines are terminated on carriage return. All ASCII characters will be echoed to terminal program
and appended with VT100 string -
ESC[J
(HEX- 1B 5B 4A) following the carriage return. (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: > camera pan right
RESPONSE: > OK
Get Example
COMMAND: > camera home get
RESPONSE: > OK
Syntax Error Example
COMMAND: > camera right pan
RESPONSE: > ERROR
Additional programming controls associated with the terminal protocol include:
•
CTRL 5
- Clears the current serial buffer on the device.
•
In Telnet sessions, commands and their subcommands and options are also available by entering a “?”
