Serial Command API
The Vaddio serial command API allows an external device such as an AMX or Crestron presentation
system to control Vaddio products. It is also used for writing macros.
n
EasyIP host devices and cameras can be controlled using this API via Telnet.
n
Host devices with RS-232 ports can also be controlled using this API via direct RS-232 connection.
n
A separate VISCA-compatible command API is available for EasyIP cameras with RS-232 ports. It is
available via direct RS-232 serial connection. See
RS-232 Serial Commands for EasyIP 20 Cameras
.
By default, Telnet access is disabled on new Vaddio devices. Telnet access must be enabled on the
device. Network connectivity and a Telnet client are also required. Telnet port 23 is used.
In addition to the device-related commands, Telnet session management commands are available – help,
history, and exit.
Notes
By default, Telnet access is disabled. Enable it on the Security page
of the web interface.
When you use this API, you must log in using the admin account.
Usage notes:
n
The
>
character is the command prompt.
n
CTRL-5 clears the current serial buffer on the device.
n
Using a question mark as a command or command parameter will bring up a list of available
commands, subcommands, or command parameters. For example,
?
returns all top-level commands;
system ?
returns the valid subcommands for the
system
command; and
system reboot ?
returns the parameter available for the
system reboot
command.
Firmware updates sometimes implement new command parameters. We do not update the manuals for
every firmware update. Querying will help you discover the command parameters that have been added
since the last update.
Typographical conventions:
n
n { x | y | z} – Choose x, y, or z.
n
n <variable> – Substitute the desired value here.
n
n < x - y > – Valid range of values is from x through y.
n
n [optional] – Parameter is not required.
109
Complete Manual for EasyIP Systems
