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 system. 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 pan right
RESPONSE: >
OK
Get Example
COMMAND: >
camera ccu get iris
RESPONSE: >
iris 11
Syntax Error Example
COMMAND: >
camera right pan
RESPONSE: >
ERROR
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.
About Controlling the Video Camera via Telnet
A Telnet session with the RoboTRAK IR camera does not provide communication to the video camera,
except in the case of commands that instruct the IR camera to send a command to the video camera. The
video camera can be controlled separately via Telnet; however, tracking should be disabled whenever you
control the video camera directly.
Refer to the video camera's manual for information about the commands available.
Commands to Avoid
Do not
send the following commands to the video camera while the IR camera is in tracking mode:
n
Camera pan or tilt commands – the video camera will only respond momentarily, as the IR camera may
send tracking coordinates several times per second.
n
Preset recall commands – turn off tracking on the IR camera, or invoke the preset from the IR camera
(
camera slave1 preset recall
command to go to a preset.
Note
Unless otherwise stated, the commands documented in this manual affect only the camera to which they
are directed. Many of them are specific to the IR camera and are not valid for video cameras.
52
Integrator's Complete Guide to the RoboTRAK Presenter Tracking System