Vaddio RoboSHOT 30 HDMI User Guide - Page 31

Camera Home, Camera Pan

Page 31 highlights

RoboSHOT HDMI Series Cameras TELNET SERIAL COMMAND API The Vaddio Serial Command protocol is a high level text based command line interface supported via telnet session on the RoboSHOT. 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: > 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. 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 Move the camera back to the home position Camera Pan  NAME Image: Invigorating simulated Telnet session. camera pan - Pans the camera left or right  SYNOPSIS camera pan { left [] | right [] | stop }  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 RoboSHOT HDMI Series Camera Manual - Document Number 342-1001 Rev A Page 31 of 40

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40

RoboSHOT HDMI Series Cameras
RoboSHOT HDMI Series Camera Manual - Document Number 342-1001 Rev A
Page 31 of 40
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 RoboSHOT. 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:
> 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.
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
Move the
camera
back to the
home
position
Camera Pan
NAME
camera pan
- Pans the camera left or right
SYNOPSIS
camera
pan
{
left
[<speed>] |
right
[<speed>] |
stop
}
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
Image:
Invigorating simulated Telnet session.