ClearVIEW HD-20
SE
QUSB
S
YSTEM
ClearVIEW HD-20
SE
QUSB
S
YSTEM
,
Document Number 342-0936 Rev C
Page 38 of 46
Q
UICK
-C
ONNECT
USB
T
ELNET
S
ERIAL
C
OMMAND
API
The Vaddio Serial Command protocol is a high level text based command line interface supported via telnet session
on the Quick-Connect USB. The command application protocol interface is intended to allow external device such
as Crestron or AMX device to control the Quick-Connect USB and the camera attached. The protocol is based
upon ASCII format following the VT100 terminal emulation standard and uses an intuitive text command
nomenclature for ease of use. The API is accessed by a telnet client on the Ethernet port. 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:
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 includes:
CTRL 5
- Clears the current serial buffer on the device.
Notes:
Telnet sessions will require access verification and uses 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 a carriage return.
Telnet Command List
Camera Home
NAME
camera home - Move the camera to the home position
SYNOPSIS
camera
home
DESCRIPTION
Method used to move the camera to the home position
EXAMPLES
camera home - Moves the camera back to the home position
Camera Pan
NAME
camera pan - Pans the camera left or right
SYNOPSIS
camera pan {left|right|stop} [1-24]
DESCRIPTION
Method used to pan the camera
OPTIONS
left - Moves the camera left
right - Moves the camera right
stop - Stops the camera movement
speed - Optional integer from 1-24 that represents the speed (Default: 12)
EXAMPLES
camera pan left - Pans the camera left at the default speed
camera pan right 20 - Pans the camera right using a speed of 20
camera pan stop - Stops the pan movement of the camera
Image: Invigorating simulated Telnet session.