Cisco WVC210 - Small Business Wireless-G PTZ Internet Video... User manual

Cisco Small Business
Network Camera Exported CGI Commands
Models WVC210, PVC2300, and WVC2300
REFERENCE GUIDE

© 2009 Cisco Systems, Inc. All rights reserved. OL-18006-01
Proprietary and Confidential Information: This document contains trade secrets
and information of a proprietary nature of Cisco or its licensors. All information
contained herein must be held in strict confidence and may only be used under
the terms of the license agreement between you and Cisco.
CCDE, CCSI, CCENT, Cisco Eos, Cisco HealthPresence, the Cisco logo, Cisco Lumin, Cisco Nexus, Cisco Nurse Connect, Cisco Stackpower, Cisco StadiumVision,
Cisco TelePresence, Cisco WebEx, DCE, and Welcome to the Human Network are trademarks; Changing the Way We Work, Live, Play, and Learn and Cisco Store are service marks;
and Access Registrar, Aironet, AsyncOS, Bringing the Meeting To You, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, CCVP, Cisco, the Cisco Certified Internetwork
Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Collaboration Without Limitation, EtherFast, EtherSwitch, Event
Center, Fast Step, Follow Me Browsing, FormShare, GigaDrive, HomeLink, Internet Quotient, IOS, iPhone, iQuick Study, IronPort, the IronPort logo, LightStream, Linksys,
MediaTone, MeetingPlace, MeetingPlace Chime Sound, MGX, Networkers, Networking Academy, Network Registrar, PCNow, PIX, PowerPanels, ProConnect, ScriptShare,
SenderBase, SMARTnet, Spectrum Expert, StackWise, The Fastest Way to Increase Your Internet Quotient, TransPath, WebEx, and the WebEx logo are registered trademarks of
Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries.
All other trademarks mentioned in this document or website are the property of their respective owners. The use of the word partner does not imply a partnership relationship between
Cisco and any other company. (0903R)

Contents
Cisco Small Business Network Camera Exported CGI Commands iii
Chapter 1: About This Document 1
CGI Command Style 1
Chapter 2: User-Level CGI Commands 3
Video and Image Commands 3
Streaming MPEG4 Video and Audio 3
Streaming Motion JPEG Video (No Audio) 4
HTML Page for the End User 4
Server Push Page for the Programmer 4
Mobile Device Snapshot 9
Snapshot 10
Session Description Protocol (SDP) 11
Audio Upload (Uploading Audio Streaming to the Camera) 12
RTP/RTSP (MPEG-4 video only, not for MJPEG video) 13
Player Commands 14
Query 14
P/T Commands—Operator (For P/T Models, WVC210 Only) 16
Move 16
Direct PT 17
Preset Commands 18
P/T Commands (For Supporting RS-485 Device
Models PVC2300 and WVC2300 Only) 19
Move 19
P/T Speed 20
Tilt Speed 20
Preset Position 21
Clear Preset Position 21
Move to the Preset Position 21
Get the Preset Lists 22
Set Home Position 22

Contents
Cisco Small Business Network Camera Exported CGI Commands iv
Move to Home Position 23
Set Patrol 23
Clear Patrol 23
Start Patrol 24
I/O Port Commands—Operator (For Supporting I/O Port
Models PVC2300 and WVC2300 Only) 24
Control I/O ports 24
Query I/O Port Status 25
Day/Night Switch (IR Filter) Commands—Operator (For Sup-
porting IR Filter Models PVC2300 and WVC2300 Only) 26
Control Day/Night Switch 26
Query Day/Night Switch Status 27
Chapter 3: Admin-Level CGI Commands 28
Query Firmware Version 28
Reboot 29
Restore to Factory Defaults 29
Get/Set Group Parameters 30
Get group parameters 30
Set group parameters 31
Get/Set System Date and Time 32
Upgrade Firmware 34
Upload/Download Configuration File 35
Download Configuration File 35
Upload Configuration File 35
Download Logs 36

Contents
Cisco Small Business Network Camera Exported CGI Commands v
Motion Detection Commands 37
Get Motion Detection Settings 38
Set Motion Detection Settings 40
Motion Vector Data 41
Padding Data Format 42
Example: Base-64 Encoder/Decoder Sample Codes 44
Appendix A: Network Camera Configuration File Spec V1.03 49
Configuration File Format 49
[MANUFACTURE] Group 49
[SYSTEM] Group 50
[LOG] Group 52
[NETWORK] Group 53
[WIRELESS] Group 53
[DDNS] Group 57
[RTSP_RTP] Group 58
[UPNP] Group 58
[EMAIL] Group 59
[FTP] Group 61
[VIDEO] Group 62
[MPEG4] Group 64
[JPEG] Group 65
[MOBILE] Group 66
[AUDIO] Group 67
[USER] Group 68
[MOTION] Group 70
[EVENT] Group 71
[QOS] Group 72
[PTZ] Group 73
[SMBC] Group 74

Contents
Cisco Small Business Network Camera Exported CGI Commands vi
Time Zone List 75
Appendix B: Additional Information 79
Regulatory Compliance and Safety Information 79
Warranty 79
End User License Agreement (EULA) 79
Appendix C: Support Contacts 80

1
Cisco Small Business Network Camera Exported CGI Commands 1
About This Document
This document describes Common Gateway Interface (CGI) commands that are
used in the WVC210, PVC2300, and WVC2300 camera software. The CGI
commands are documented for advanced users who want to integrate camera
controls into complex software solutions. Such solutions could include third-party
web sites designed for security or home monitoring.
CGI Command Style
•Enter all CGI commands in lowercase.
•In CGI Commands, angle brackets indicate information that you need to
provide.
-Example: <IP> means enter your IP address.
•In CGI Responses, angle brackets can indicate formatting.
-Example: <cr> means “new line.”
•In CGI Responses, angle brackets can indicate data returned.
-Example: <SPD DATA> means “SPD data returned.”
•In CGI Responses, square brackets indicate one or more choices that can
be returned.
-Example: [on|off] means either on or off will be returned.

2
Cisco Small Business Network Camera Exported CGI Commands 3
User-Level CGI Commands
Video and Image Commands
Streaming MPEG4 Video and Audio
Method: GET
URL: http://<ip>/img/video.asf or http://<ip>/img/video.asx
(Vista OS)
Use: A “video.asf” file is returned through the HTTP protocol.
Return:
HTTP/1.0 200 OK\r\n
…
content-type: application/octet-stream\r\n
…
<MPEG-4 video data>

User-Level CGI Commands
Video and Image Commands
Cisco Small Business Network Camera Exported CGI Commands 4
2
Streaming Motion JPEG Video (No Audio)
HTML Page for the End User
Method: GET
URL: http://<ip>/img/mjpeg.htm
Use: When an IP camera is configured with MPEG4 resolution 160x120, MJPEG
640x480, this command outputs a 160x120 video in the VLC player.
Return:
HTTP/1.0 200 OK\r\n
…
content-type: text/html\r\n
…
<MJPEG video data>…
Server Push Page for the Programmer
Method: GET
URL:
http://<ip>/img/video.mjpeg[?size=value][&framerate=<value>]
(utility)
http://<ip>/img/mjpeg.cgi[?size=value][&framerate=<value>]
(OCX)
The http://<ip>/img/mjpeg.cgi command will become obsolete. Some
web browsers cache the first incoming JPEG image and do not refresh the
following incoming JPEG images. Please use the command
http://<ip>/img/mjpeg.htm to stream JPEG video instead.
Use:
The parameters (size and framerate) are for read-only reference. To configure
video resolution and framerate see “Network Camera Configuration File Spec
V1.03,” on page 49.

User-Level CGI Commands
Video and Image Commands
Cisco Small Business Network Camera Exported CGI Commands 5
2
If there is no parameter input, the camera returns the MJPEG streaming within the
current codec settings.
The camera checks the request parameters (
size or framerate ) within the current
codec settings. If the requested parameters matched the current setting, then the
camera returns the MJPEG stream by the Server Push method. If the requested
parameters do not match the current setting, then the camera returns an error.
The camera checks the request User-Agent parameter in the HTTP header to
identify the client type. The camera regards the client as Microsoft Internet
Explorer (MSIE) if the string “MSIE” is included. The camera regards the client as
Cisco Object Linking and Embedding (OLE) Custom Control (OCX) if the strings
“CameraActiveX,” “Cisco210Viewer,” or “Cisco210AlertCfg,” are included. All
others are regarded as PushServer.
Return (OK):
If the client is MSIE:
HTTP/1.0 200 OK\r\n
…
content-type: image/jpeg\r\n
…
<MJPEG data>
If the client is Cisco OCX:
HTTP/1.0 200 OK\r\n
…
<MJPEG video or AUDIO data>

User-Level CGI Commands
Video and Image Commands
Cisco Small Business Network Camera Exported CGI Commands 6
2
Motion JPEG for OCX
To support the audio stream feature, there is an extra header at beginning of the
data stream (mjpeg/audio) to describe the frame information and sending status.
The extra header contains 48 bytes; the fields are shown in the following table:
Location Parameter Value and String
0-3 Magic String The string to identify the header. Must
be “MJPG.”
4-7 Frame Size The frame size in bytes.
8-9 Width The JPEG width.
10-11 Height The JPEG height.
12-15 Sent Size The size of the sent frame in bytes.
16-17 Slice Size The size of the slice in bytes.
18-21 Timestamp The time stamp of the frame. The time
stamp of the first frame is always 0.
22 Frame Type The frame type.
0x01 (01): JPEG
0x02 (02): G.726 Audio
23-24 Bit Rate The audio bit rate.
0x02 (02): G.726, 2 KBPS
25 Version The version number. 0x01
26-45 Time String The ASCII string to present the current
camera time. (Not used)
46-47 Reserved Reserved

User-Level CGI Commands
Video and Image Commands
Cisco Small Business Network Camera Exported CGI Commands 7
2
Example: A normal JPEG frame.
All other clients are regarded as the PushServer:
HTTP/1.0 200 OK\r\n
…
content-type: multipart/x-mixed-released;boundary=<xxx>\r\n
--<xxx>
content-type:image/jpeg\r\n
content-length: <image-size>\r\n\r\n
<jpeg image date>
--<xxx>
content-type:image/jpeg\r\n
content-length: <image-size>\r\n\r\n
<jpeg image date>
...
--<boundary>--

User-Level CGI Commands
Video and Image Commands
Cisco Small Business Network Camera Exported CGI Commands 8
2
Return (Error):
HTTP/1.0 400 Bad Request\r\n
…
content-type: text/plain\r\n
\r\n
current_ resolution=A\r\n
current_framerate=B\r\n
Where A is one of the following:
Image Resolution:
1: 160x120
2: 320x240
3: 640x480
Where Bis one of the following:
1-30 FPS

User-Level CGI Commands
Video and Image Commands
Cisco Small Business Network Camera Exported CGI Commands 9
2
Mobile Device Snapshot
Method: GET
URL: http://<ip>/img/mobile.cgi
Return: A 160x120 JPEG image (with video quality "very low") is returned to the
user.
HTTP/1.0 200 OK\r\n
…
content-type: image/jpeg\r\n
…
<JPEG image data>
Method: GET
URL: http://<ip>/img/mobile.htm
Return:
<html>
<head>
<title>Network Camera - Live Video</title>
<META HTTP-EQUIV="Pragma" CONTENT="no-cache">
<META HTTP-EQUIV="Cache-Control" CONTENT="no-cache">
<meta HTTP-EQUIV="Expires" CONTENT="Mon, 06 Jan 1990 00:00:01
GMT">
</head>
<body>
<IMG SRC="/img/mobile.cgi">
</body>
</html>

User-Level CGI Commands
Video and Image Commands
Cisco Small Business Network Camera Exported CGI Commands 10
2
Snapshot
Method: GET
URL:http://<ip>/img/snapshot.cgi?[size=<value>][&quality=<value>]
Where size is one of the following:
Image Resolution:
1: 160x120
2: 320x240
3: 640x480
Where quality is one of the following:
1: Ver y high
2: High
3: Normal
4: Low
5: Very low
Example 1:
To make a snapshot of a 640x480 high quality JPEG image from network camera
192.168.1.99:
http://192.168.1.99/img/snapshot.cgi?size=3&quality=1
Example 2:
To make a snapshot of a JPEG image from network camera 192.168.1.99 (with
current resolution and quality):
http://192.168.1.99/img/snapshot.cgi
Example 3:
To make a snapshot of a low quality JPEG image with current resolution from the
network camera 192.168.1.99:
http://192.168.1.99/img/snapshot.cgi?quality=4

User-Level CGI Commands
Video and Image Commands
Cisco Small Business Network Camera Exported CGI Commands 11
2
Return:
A JPEG image is returned to the client with user-specified resolution and quality.
HTTP/1.0 200 OK\r\n
…
content-type: image/jpeg\r\n
…
<JPEG image data>
Session Description Protocol (SDP)
NOTE MPEG-4 video only, not for MJPEG video
Method: GET
URL: http://<ip>/img/media.sdp
Return: A Session Description Protocol (SDP) file is returned.
HTTP/1.0 200 OK\r\n
…
<SDP data>

User-Level CGI Commands
Video and Image Commands
Cisco Small Business Network Camera Exported CGI Commands 12
2
Audio Upload (Uploading Audio Streaming to the Camera)
Method: POST
URL: http://<ip>/img/g726.cgi G.726 audio stream (16Kbps)
URL: http://<ip>/img/g711a.cgi G.711 a-law audio stream
URL: http://<ip>/img/g711u.cgi G.711 u-law audio stream
Example (client side):
POST http://192.168.1.99/img726.cgi HTTP/1.0\r\n
Authorization: Basic YWRtaW46YWRtaW4= \r\n
\r\n
Return (OK):
HTTP/1.0 200 OK\r\n
Client starts to upload the audio stream.
Return (Unauthorized):
HTTP/1.0 401 Unauthorized\r\n

User-Level CGI Commands
Video and Image Commands
Cisco Small Business Network Camera Exported CGI Commands 13
2
RTP/RTSP (MPEG-4 video only, not for MJPEG video)
A user can stream video and audio through the following URLs:
Video and audio: rtsp://<ip>/img/media.sav
Video only: rtsp://<ip>/img/video.sav
Audio only: rtsp://<ip>/img/audio.sav
The user needs to specify one of the supported RTP protocols:
•Unicast RTP
•Multicast RTP
•RTP over RTSP (RTP over TCP)
•RTP over RTSP over HTTP (HTTP tunnel)
Specifying an RTP protocol depends on the configuration of your specific media
player. Refer to the instructions contained within your media player.
Return: Video and/or audio is returned.

User-Level CGI Commands
Player Commands
Cisco Small Business Network Camera Exported CGI Commands 14
2
Player Commands
Query
Method: GET
URL: http://<ip>/util/query.cgi
This command shows all camera hardware capabilities; for example if the camera
has an I/O port or if it has speakers.
Return:
HTTP/1.0 200 OK \r\n
…
content-type: text/plain\r\n
\r\n
hostname= WVC210 \r\n
description=description string\r\n
defname= WVC210 \r\n
mac=00C002123456\r\n
resolutions=640*480,320*240,160*120\r\n
mpeg4_resolution=[640|320|160]\r\n
mjpeg_resolution=[640|320|160]\r\n
mic_in=[on|off]r\n
speaker_out=[on|off]\r\n
ptctrl=[on|off]\r\n
ioctrl=[on|off]\r\n
serial=[off|pelco]\r\n
privacy_button=[on|off]\r\n
pir_sensor=[on|off]\r\n
wlled=[on|off]\r\n
wps_pin_code=00000048\r\n
company_name= Cisco \r\n
model_number= WVC210 \r\n

User-Level CGI Commands
Player Commands
Cisco Small Business Network Camera Exported CGI Commands 15
2
URL:http://<ip>/img/query.cgi
This command shows hardware capabilities specific to users and their privileges.
For example, a particular user may be able to use Speaker Out, but cannot control
the I/O ports.
Return:
HTTP/1.0 200 OK \r\n
…
content-type: text/plain\r\n
\r\n
mic_in=[on|off]r\n
speaker_out=[on|off]\r\n
ptctrl=[on|off]\r\n
ioctrl=[on|off]\r\n