RemoteControllerInterfaceSpecifications E
RemoteControllerInterfaceSpecifications E
Version 2.10
April 10, 2020
Change History
Date Description Version
Mar. 27, 2014 Discriptions of AW-RP120 and AW-RP50 are separated 1.02
Collected descriptions of “Command sequence”, “Command details”, and “Error
Mar. 28, 2014 1.02
return” of AW-RP120
Mar. 28, 2014 Collected the descriptions of “Error return” for AW-RP50 1.02
May 30, 2014 Revised descriptions for preset memory playback command sequence 1.03
May 30, 2014 Revised descriptions for preset memory playback command sequence 1.03
Contents
1. Introduction .................................................................................................................... 4
2. Configuration outline...................................................................................................... 5
3. Connection formats ....................................................................................................... 6
4. Controller control ........................................................................................................... 7
4.1. Network connection ..................................................................................................................... 7
Command format .............................................................................................................. 7
Command sequence (In case of AW-RP120, AW-RP150 and AW-RP60)....................... 8
Command sequence (In case of AW-RP50)................................................................... 10
4.2. Serial connection ........................................................................................................................11
Command format .............................................................................................................11
Command sequence (Only supported by the AW-RP120) ..............................................11
5. Camera/pan-tilt head control ....................................................................................... 13
5.1. Serial connection (Only supported by the AW-RP120) ............................................................. 13
Command sequence ....................................................................................................... 13
6. Command details......................................................................................................... 14
6.1. Controller control........................................................................................................................ 14
Camera selection ............................................................................................................ 14
Preset memory (Only supported by the AW-RP120, AW-RP150 and AW-RP60).......... 16
Tracing memory (Only supported by the AW-RP120 and AW-RP150) .......................... 17
6.2. Camera/pan-tilt head control commands .................................................................................. 18
7. Error return .................................................................................................................. 20
7.1. In case of AW-RP120, AW-RP150 and AW-RP60..................................................................... 20
7.2. In case of AW-RP50................................................................................................................... 22
<Appendix>........................................................................................................................ 24
1. Introduction
This document sets forth the specifications for the external interface used when operations are
performed from a PC using an Ethernet or RS-232C serial interface for the remote camera controller
(hereafter “controller”).
Applicable models
・AW-RP50 series, AW-RP120 series, AW-RP150 series and AW-RP60 series
2. Configuration outline
Two formats for connecting the controller and PC are available: a network connection and an
RS-232C serial connection.
The two following types of control can be exercised with each of these connections.
① Controller control
Camera switching, group switching and other operations performed using the controls on the
panel of the controller are controlled.
A response is returned to the PC for the results of executing these operations using the controller.
This type of control can be exercised using a network connection and a serial connection.
3. Connection formats
When connecting the controller to the PC, either a network connection where connection is made to
the LAN connector on the rear panel of the controller or a serial connection where connection is
made to the REMOTE connector is available.
The method used to connect the controller with the camera/pan-tilt head is subject to restrictions
depending on the connection format used. The connection methods are described below.
[AW-RP120,AW-RP150,AW-RP60]
Network
Controller
control command
Network
[AW-RP50]
Controller
control command
Controller
control Camera/
command pan-tilt head
control
command
Camera/
pan-tilt head
control command
4. Controller control
The external interface used when controlling the controller from Ethernet is described below.
Command format
【Command format】
[Send]
http://[IP Address]/cgi-bin/aw_cam?cmd=[Command]&res=[Type]
where
※IP Address ······· IP address of controller at connection destination
※Command ········ Details given in “Command” column in the command tables below
※Type ················ Normally “1” (but “0” for the AWB[OWS] command and ABB[OAS] command)
[Receive]
200 OK “Command”
※Command ········ Response value of each command; set in the HTTP message body
<AW-RP120>
[Receive] The response is a text-format response as described below.
HTTP/1.1 200 OK
<AW-RP50>
[Receive] The response is an HTTP response.
200 OK “XCN:01:1”
As per the command format described on the previous page, the command sequence which is
followed when communication is performed is shown below.
For details of the sequence followed when an error has occurred in response to a command, refer to
“7. Error return”.
The controller switching is controlled from the PC, and [HTTP/1.1 200 OK] is returned as the
response from controllwe. See the command sequence below.
PC Controller
CONNECT
1 http://192.168.0.10/cgi-bin/aw_cam?cmd=XCN:01:1&res=1
2 HTTP/1.1 200 OK
CLOSE
When controller receives a command from the PC, the controller may sometime control the camera
as well. This involves the preset memory and tracing memory.
Preset play control is exercised from the PC, and [HTTP/1.1 200 OK] is returned as the response.
Given below is the command sequence.
PC Controller Camera
To receive preset playback completion notifications on the PC, connect directly to the camera and
receive update notifications.
(For details, refer to "4. Camera information update notification" in the HD Integrated Camera
Interface Specifications.)
※
1 If a command is not sent within 20 seconds after connection (CONNECT), connection will be
disconnected from the AW-RP120, AW-RP150 and AW-RP60.
※
2 If disconnection (CLOSE) is not executed within * seconds after the PC sends the command,
connection will be severed from the AW-RP120, AW-RP150 and AW-RP60.
The controller switching is controlled from the PC, and [200 OK “XCN:01:1”] is returned as the
response. Given below is the command sequence.
PC Controller
CONNECT
1 http://192.168.0.10/cgi-bin/aw_cam?cmd=XCN:01:1&res=1
200 OK “XCN:01:1”
2
CLOSE
※
1 If a command is not sent within 10 seconds after connection (CONNECT), connection will be
severed from the AW-RP50.
※
2 If disconnection (CLOSE) is not executed within * seconds after the PC sends the command,
connection will be severed from the AW-RP50.
Item Setting
Method Full duplex
Baud rate 9600bps
Data bit 8bit
Stop bit 1bit
Parity None
Flow control None
Command format
[Send/Receive]
[STX] [Command][ETX]
where
※STX················· 0x02
※ETX················· 0x03
※Command ········ Details given in “6. Command details”
The controller switching is controlled from the PC, and [200 OK “XCN:01:1”] is returned as the
response. Given below is the command sequence.
PC Controller
[STX][XCN:01:1][ETX]
[STX][XCN:01:1][ETX]
※If there is no response from the controller, wait at least 10 seconds before re-sending the
command.
When control has been received from the PC, the controller may sometimes exercise control over
the camera as well.
This involves the preset memory and tracing memory.
Preset play control is exercised from the PC, and a result is returned.
Given below is the command sequence.
PC Controller Camer
a
[STX][XPM:01:001][ETX] Preset No.1 play request
Command sequence
The camera/pan-tilt head are controlled through the controller.
The response from the camera/pan-tilt head is also returned to the PC.
PC Controller Camera
[STX][OGU:80][ETX] [STX][OGU:80][ETX]
[STX][OGU:80][ETX]
[STX][OGU:80][ETX]
6. Command details
Camera selection
These commands switch the camera selection by specifying the port numbers, camera numbers and
group numbers.
Table 6.1.1. Camera selection
Control method Data
Command name Category Command Setting Remarks
Serial IP value
Camera switching Control ○ ○ XPT:[Data] 1 Port1 Up to Port5 for
control command AW-RP50 and
~
Response ○ RP60:- XPT:[Data]
(specifying the port RP150:- 10 Port10 AW-RP60.
numbers) RP120:-
RP50:○
Group switching Control ○ ○ XGP:[Data] 1 Group1 Up to Group10
control command for AW-RP120.
~
Response ○ RP60:- XGP:[Data]
RP150:- 20 Group20
RP120:- Up to Group40
RP50:○ for AW-RP60.
Camera switching Control ○ ○ XCN:01:[Data] 1 CAM1 Up to CAM100
control command for AW-RP50
~
Response ○ RP60:- XCN:01:[Data]
(specifying the RP150:- 200 CAM200 and AW-RP120.
camera numbers) RP120:-
RP50:○
Camera switching Control ○ ○ XCN:02:[Data1] : [Data1] [Data1] Up to Port5 for
control command [Data2] 1 Group1 AW-RP50.
(specifying the group Response RP60:- XCN:02:[Data1] :
~
○ ~
or the port numbers) RP150:- [Data2] 20 Group20 Up to Group10
RP120:- [Data2] [Data2] for AW-RP120.
RP50:○ 1 Port1
~
10 Port10 Up to Group40
and Port1-5 for
AW-RP60.
Camera number Confirmation ○ ○ XQC:01 - -
confirmation
command Response ○ ○ XQC:01:[Data] 0 Unselected Up to CAM100
(inquiry selected 1 CAM1 for AW-RP50
camera number) and AW-RP120
~
200 CAM200
Camera Group/Port Confirmation ○ ○ XQC:02 - -
confirmation
command Response ○ ○ XQC:02:[Data1] [Data1] [Data1] Up to Port5 for
(inquiry selected :[Data2] 1 Group1 AW-RP50.
camera Group/Port
~
Example of use)
・Camera switching: CAM20
[Control] PC → AW-RP120
http://192.168.0.10/cgi-bin/aw_cam?cmd=XCN:01:20&res=1
[Response] AW-RP120 → PC
HTTP/1.1 200 OK
・Camera Group/Port confirmation: Port 5 and Group 10
[Control] PC → AW-RP120
http://192.168.0.10/cgi-bin/aw_cam?cmd=XQC:02&res=1
[Response] AW-RP120 → PC
HTTP/1.1 200 OK<CR><LF>
<CR><LF>
XQC:02:10:5<CR><LF>
<CR><LF>
This command specifies the preset number and plays the preset memory.
~
100 Preset No100 AW-RP150
and
AW-RP60.
Example of use)
・Preset memory play: Preset No1
[Control] PC → AW-RP120
http://192.168.0.10/cgi-bin/aw_cam?cmd=XPM:01:001&res=1
[Response] AW-RP120 → PC
HTTP/1.1 200 OK
These commands enable the tracing memory to be placed in the standby, play or stop status for the
camera/pan-tilt head selected.
~
○ -
10 TracingNo100
TMEM play Control ○ ○ XTM:01:[Data] 000 Play Only for AW-RP120
control command Response ○ - XTM:01:[Data] and AW-RP150.
TMEM stop Control ○ ○ XTM:00:[Data] 001 Stop Only for AW-RP120
control command and AW-RP150.
~
Response ○ - XTM:00:[Data]
010
Example of use)
・TMEM standby: TracingNo1
[Control] PC → AW-RP120
http://192.168.0.10/cgi-bin/aw_cam?cmd=XTM:02:001&res=1
[Response] AW-RP120 → PC
HTTP/1.1 200 OK
The controller supports the following commands in the “PROTOCOL of CONVERTIBLE CAMERA
and PAN/TILT SYSTEM”. (AW-RP120 only)
【Camera command 】
Command name Send command
GAIN UP OGU
GAIN SELECT OGS
T PEDESTAL OTP
T PEDESTAL OTD
R GAIN ORI
B GAIN OBI
R PEDESTAL ORP
B PEDESTAL OBP
AWC MODE OAW
AWB SET OWS
ABB SET OAS
SHUTTER OSH
SHUTTER MODE OSA:90
SHUTTER SPEED OSA:91
DETAIL ODT
TOTAL DTL LEVEL OSA:30
HE870 HD DETAIL OHD
HC1500 SD DETAIL OSE:0E
HC1500 SD DETAIL LVL OSE:00
SCENE FILE XSF
COLOR BAR/CAMERA DCB
PRESET SCOPE OSE:71
ND Control OFT
MENU OFF/ON DUS
MENU SW DPG
ITEM SW DIT
YES SW DUP
NO SW DDW
Auto Focus OAF
Auto Iris ORS
Push Auto Focus OSE:69
R GAIN ORG
B GAIN OBG
Contrast(Picture Level) OSD:48
【Pan-tilt command 】
Command name Send command
Speed With Zoom Pos #SWZ
Pan Preset Speed #UPVS
Tilt Preset Speed #UTVS
ND Control #D2
Lamp Control #D4
OPTION SW Control #D6
Defroster Control #D7
Wiper Control #D8
Heater/Fan Control #D9
Install Position #INS
Pan Speed Control #P
Tilt Speed Control #T
Focus Speed Control #F
Zoom Speed Control #Z
Iris Control #AXI
Auto Iris #D3
Pan/Tilt Speed #PTS
Power #O
Preset Recall #R
Preset Memory #M
Preset Delete #C
Limitation Setting #L
Limitation Setting #LC
Home Position #U
Pan/Tilt Absolute Position Control #APC
Auto Focus #D1
7. Error return
There are three kinds of errors — ER1, ER2 and ER3 as described below — which are generated in
response to the controller control commands in a network connection. In a serial connection, the
same command as the request is returned as the response to the control command.
PC Controller
http://192.168.0.10/cgi-bin/aw_cam?cmd= XF&res=1
PC Controller
http://192.168.0.10/cgi-bin/aw_cam?cmd= XPT:1&res=1
Group switching
in progress
PC Controller
http://192.168.0.10/cgi-bin/aw_cam?cmd=XPT:90&res=1
PC Controller
http://192.168.0.10/cgi-bin/aw_cam?cmd= XF&res=1
PC Controller
http://192.168.0.10/cgi-bin/aw_cam?cmd= XPT:1&res=1
Group switching
in progress
PC Controller
http://192.168.0.10/cgi-bin/aw_cam?cmd=XPT:90&res=1
<Appendix>
【In case of AW-RP120,AW-RP150 and AW-RP60】
The HTTP messages are described using the format for input to the address bar of the web browser as in
the example given below.
(Example: http://192.168.0.10/cgi-bin/aw_cam?cmd=%23XCN:01:1&res=1)
The actual HTTP messages are in compliance with the HTTP1.1 communication specifications, and have
the [Send] formats as given below.
[Send]
A command such as the ones listed below is sent after connection has been made to the specified port
(default: 80) which has been set for the controller.
Method: GET
GET /cgi-bin/aw_cam?cmd=XCN:01:1&res=1 HTTP/1.1[CR][LF] Request
Accept: image/gif, ... (omitted) ... , */*[CR][LF]
Referer: http://192.168.0.10/[CR][LF]
Accept-Language: en[CR][LF]
Accept-Encoding: gzip, deflate[CR][LF] Header
User-Agent: AW-Cam Controller[CR][LF]
Host: 192.168.0.10[CR][LF]
Connection: Keep-Alive[CR][LF]
[CR][LF] Blank line
[Receive]
A text-format message as shown below is received.
(Example: http://192.168.0.10/cgi-bin/aw_cam?cmd=%23XCN:01:1&res=1)
The actual HTTP messages are in compliance with the HTTP1.1 communication specifications, and have
the [Send] formats as given below.
[Send]
A command such as the ones listed below is sent after connection has been made to the specified port
(default: 80) which has been set for the controller.
Method: GET
GET /cgi-bin/aw_cam?cmd=XCN:01:1&res=1 HTTP/1.1[CR][LF] Request
Accept: image/gif, ... (omitted) ... , */*[CR][LF]
Referer: http://192.168.0.10/[CR][LF]
Accept-Language: en[CR][LF]
Accept-Encoding: gzip, deflate[CR][LF] Header
User-Agent: AW-Cam Controller[CR][LF]
Host: 192.168.0.10[CR][LF]
Connection: Keep-Alive[CR][LF]
[CR][LF] Blank line
[Receive]
A message with the command name and result value contained in the message body of the HTTP
response message is received.
In this manual, this message is given as [200 OK “XCN:01:1”], but in actual fact commands such as the
following ones are received..