WideSHOT QUSB System
WideSHOT QUSB System - Document Number 342-0696 Rev. D
Page 36 of 44
A
PPENDIX
3
-
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. Camera control commands supported on the Quick-Connect USB includes ClearVIEW
HD-18, HD-19 and HD-20, PowerVIEW HD-22, HD-30, ZoomSHOT and WideSHOT. 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. 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: > stream mode get
RESPONSE: > streaming mode usb
Syntax Error Example
COMMAND: > camera pan right
RESPONSE: > ERROR
Additional programming controls associated with the terminal protocol includes:
CTRL 5
- Clears the current serial buffer on the device.
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.
NOTE:
The WideSHOT camera will not respond to pan, tilt or zoom commands.
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
Move the
camera
back to the
home
position
Camera
Pan
(not used with ZoomSHOT or WideSHOT cameras)
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
Move the
camera
left
right
Move the
camera
right
stop
Stop 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: Exciting simulated Telnet session.