Appendix 2: vaddio serial command api – Vaddio AV Bridge User Manual

Page 25

Advertising
background image

AV Bridge

Vaddio AV Bridge - Document Number 342-0518 Rev D. Software Version 2.1.0 Page 25 of 36

The DE-15 video port will accept either RGBHV or YPbPr video formats.









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 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 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 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 is
described in the next section heretofore.

Pin

RGBHV

YPbPr

1 Red

Pr

2 Green

Y

3 Blue

Pb

4 -

-

5 N/C

N/C

-

6

Red GND

Pr GND

7 Green

GND Y

GND

8

Blue GND

Pb GND

9 No

Pin

-

10 GND

GND

11 -

-

12 -

-

13 H-Sync

-

14 V-Sync

-

15 N/C

N/C

Image: Scintillating
example of simulated
Telnet session

Advertising