Telnet Serial Command API
The Vaddio serial command protocol is a high-level, text-based command line interface supported via
Telnet session on the camera. The API is accessed by a telnet client on the Ethernet port; the default
Telnet port is 23. Telnet sessions require the administrator account login.
The command application protocol interface is intended to allow external device such as AMX or Crestron
to control the camera. The protocol is based upon ASCII format following the VT100 terminal emulation
standard and uses an intuitive text command nomenclature for ease of use.
General format usage follows a get/set structure. Usage
examples for each type are:
Set Example
COMMAND: >
camera zoom in
RESPONSE: >
OK
Get Example
COMMAND: >
camera ccu get iris
RESPONSE: >
iris 11
Syntax Error Example
COMMAND: >
camera preset 1
RESPONSE: >
Syntax error: Unknown or incomplete command
Using a question mark as a command parameter will bring up a list of available commands for the menu
you are in.
Things to know about control via Telnet session:
n
Command lines are terminated with a carriage return.
n
All ASCII characters (including carriage returns) are echoed to the terminal program and appended with
the VT100 string ESC[J (hex 1B 5B 4A), which most terminal programs automatically strip.
n
CTRL-5 Clears the current serial buffer on the device.
Typographical conventions:
n
{ x | y | z} – Choose x, y, or z.
n
<variable> – Substitute the desired value here.
n
< x - y > – Valid range of values is from x through y.
n
[optional] – Parameter is not required.
32
Integrator's Complete Guide to the DocCAM 20 HDBT Ceiling-Mounted Document Camera
