Page 1
REFERENCE GUIDE Cisco Small Business Network Camera Exported CGI Commands Models WVC210, PVC2300, and WVC2300...
Page 2
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...
Session Description Protocol (SDP) Audio Upload (Uploading Audio Streaming to the Camera) RTP/RTSP (MPEG-4 video only, not for MJPEG video) Player Commands Query P/T Commands—Operator (For P/T Models, WVC210 Only) Move Direct PT Preset Commands P/T Commands (For Supporting RS-485 Device...
Page 4
Reboot Restore to Factory Defaults Get/Set Group Parameters Get group parameters Set group parameters Get/Set System Date and Time Upgrade Firmware Upload/Download Configuration File Download Configuration File Upload Configuration File Download Logs Cisco Small Business Network Camera Exported CGI Commands...
Page 5
[DDNS] Group [RTSP_RTP] Group [UPNP] Group [EMAIL] Group [FTP] Group [VIDEO] Group [MPEG4] Group [JPEG] Group [MOBILE] Group [AUDIO] Group [USER] Group [MOTION] Group [EVENT] Group [QOS] Group [PTZ] Group [SMBC] Group Cisco Small Business Network Camera Exported CGI Commands...
Page 6
Contents Time Zone List Appendix B: Additional Information Regulatory Compliance and Safety Information Warranty End User License Agreement (EULA) Appendix C: Support Contacts Cisco Small Business Network Camera Exported CGI Commands...
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.
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> Cisco Small Business Network Camera Exported CGI Commands...
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 Cisco Small Business Network Camera Exported CGI Commands...
Page 10
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.
Page 11
Bit Rate The audio bit rate. 0x02 (02): G.726, 2 KBPS Version The version number. 0x01 26-45 Time String The ASCII string to present the current camera time. (Not used) 46-47 Reserved Reserved Cisco Small Business Network Camera Exported CGI Commands...
Page 12
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>-- Cisco Small Business Network Camera Exported CGI Commands...
Page 13
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 B is one of the following: 1-30 FPS Cisco Small Business Network Camera Exported CGI Commands...
To make a snapshot of a JPEG image from network camera 192. 1 68. 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. 1 68. 1 .99: http://192.168.1.99/img/snapshot.cgi?quality=4 Cisco Small Business Network Camera Exported CGI Commands...
<JPEG image data> Session Description Protocol (SDP) MPEG-4 video only, not for MJPEG video NOTE 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> Cisco Small Business Network Camera Exported CGI Commands...
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. Cisco Small Business Network Camera Exported CGI Commands...
Page 20
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 Cisco Small Business Network Camera Exported CGI Commands...
User-Level CGI Commands P/T Commands—Operator (For P/T Models, WVC210 Only) Preset Commands Method: GET URL: http://<ip>/pt/ptctrl.cgi?preset=<cmd>,<para_1> Provides up to 9 preset positions. And the preset position name is up to 16 ASCII characters. Parameters para_1 Comments Command Get all preset names.
The P/T will stop after 1 second of the move action. speed Move Speed (Optional) 1-10 10 is the fastest speed. Return: A 200 OK is returned to the web browser when this command is received. Cisco Small Business Network Camera Exported CGI Commands...
Set the tilt direction speed. Method: GET URL: http://<IP>/pt/ptctrl.cgi?cmd=set_tilt_speed,<speed> Parameters: speed Move Speed 1-10 10 is the fastest speed. Return: A 200 OK is returned to the web browser when this command is received. Cisco Small Business Network Camera Exported CGI Commands...
Move the P/T device to a specific preset position (by the preset name). Method: GET URL: http://<IP>/pt/ptctrl.cgi?cmd=goto_preset,<name> Parameters: name Preset name (16 characters). Return: A 200 OK is returned to the web browser when this command is received. Cisco Small Business Network Camera Exported CGI Commands...
PT9=<name9>\r\n \r\n Set Home Position Set current position as the user-defined home position. Method: GET URL: http://<IP>/pt/ptctrl.cgi?cmd=set_home Return: A 200 OK is returned to the web browser when this command is received. Cisco Small Business Network Camera Exported CGI Commands...
Return: A 200 OK is returned to the web browser when this command is received. Clear Patrol Clear the patrol configuration. Method: GET URL: http://<IP>/pt/ptctrl.cgi?cmd=clr_patrol Return: A 200 OK is returned to the web browser when this command is received. Cisco Small Business Network Camera Exported CGI Commands...
The On state and Off state are defined in the configuration file. output_2 Output port 2 The On state and Off state are defined in the configuration file. Return: A 200 OK is returned to the web browser when this command is received. Cisco Small Business Network Camera Exported CGI Commands...
Switch the filter to the desired mode. Day Mode Night Mode Return: The network camera returns a web page that contains the following messages. HTTP/1.0 200 OK\r\n … content-type: text/plain\r\n Return-Value: OK\r\n \r\n Cisco Small Business Network Camera Exported CGI Commands...
Method: GET URL: http://<ip>/io/query_filter.cgi Return: The network camera returns a web page that contains the following messages. HTTP/1.0 200 OK \r\n … content-type: text/plain\r\n \r\n filter=[0|1]\r\n <- 0= Day; 1= Night \r\n Cisco Small Business Network Camera Exported CGI Commands...
Query Firmware Version Method: GET URL: http://<ip>/adm/sysinfo.cgi Return: The camera returns a Web page that contains the following messages. HTTP/1.0 200 OK \r\n … content-type: text/plain\r\n \r\n Firmware Version: V1.0.0R01\r\n Serial Number: SQJ00G100001\r\n Cisco Small Business Network Camera Exported CGI Commands...
Method: GET URL: http://<ip>/adm/reboot.cgi Return: HTTP/1.0 200 OK \r\n … content-type: text/plain\r\n \r\n OK\r\n Restore to Factory Defaults Method: GET URL: http://<ip>/adm/reset_to_default.cgi Return: HTTP/1.0 200 OK \r\n … content-type: text/plain\r\n \r\n OK\r\n Cisco Small Business Network Camera Exported CGI Commands...
“Network Camera Configuration File Spec V1.03,” on page Return: Group settings are returned as below. HTTP/1.0 200 OK\r\n … content-type: text/plain\r\n \r\n <parameter pair>\r\n <parameter pair>\r\n ...\r\n Where <parameter pair> is <parameter_name>=<parameter_value>. Cisco Small Business Network Camera Exported CGI Commands...
Group name is specified here. (The group name is case Group insensitive.) Return: Successful request returns all group parameters or the specified parameters as below. HTTP/1.0 200 OK\r\n … content-type: text/plain\r\n \r\n OK\r\n <parameter pair>\r\n <parameter pair>\r\n ...\r\n Cisco Small Business Network Camera Exported CGI Commands...
The index value in the time zone table (read-only). Refer to “Network Camera Configuration File Spec V1.03,” on page year Year (2005~2037) month Month (1~12) Day (1~31) hour Hour (0~23) minute Minute (0~59) second Second (0~59) Cisco Small Business Network Camera Exported CGI Commands...
Page 38
Admin-Level CGI Commands Get/Set System Date and Time Return: Successful request returns all group parameters or the specified parameters as below. HTTP/1.0 200 OK\r\n … content-type: text/plain\r\n \r\n OK\r\n <parameter pair>\r\n <parameter pair>\r\n ...\r\n Cisco Small Business Network Camera Exported CGI Commands...
… <FW binary data encoded in base64 format> The client must wait as least 5 minutes to make sure all flashes have been programmed. Return: A firmware upgrade progress window is returned. Cisco Small Business Network Camera Exported CGI Commands...
Message body: … <boundary=...> <configuration file encoded in Base64 fvormat> All data in the configuration file are encoded in a Base64 format. Please refer to “Example: Base-64 Encoder/Decoder Sample Codes,” on page Cisco Small Business Network Camera Exported CGI Commands...
The camera is automatically rebooted after receiving the configuration file. Return: HTTP/1.0 200 OK \r\n … content-type: text/plain\r\n \r\n OK\r\n Download Logs Method: GET URL: http://<ip>/adm/log.cgi Return: HTTP/1.0 200 OK \r\n … content-type: text/plain\r\n\r\n … <log data> Cisco Small Business Network Camera Exported CGI Commands...
The horizontal position, x, is expressed as an integer value from 0 to 639 and ascends from left to right. • The vertical position, y, is expressed as an integer value from 0 to 479 and ascends from top to bottom. Cisco Small Business Network Camera Exported CGI Commands...
URL: http://<IP>/adm/get_group.cgi?group=MOTION Please refer to “Get group parameters,” on page Parameter: Parameter Description This is a required parameter & value to let the CGI know the Group request is for “motion detection” group. Cisco Small Business Network Camera Exported CGI Commands...
X is from 0 to 639. The range of Y is from 0 to 479. md_window4 md_threshold1 Set the threshold of motion detection window N. The range is from 0 to 255. md_threshold4 Cisco Small Business Network Camera Exported CGI Commands...
The data is located in the padding bytes of the streaming data. For more information about the data format in the streaming packet, refer to the next section. Cisco Small Business Network Camera Exported CGI Commands...
B. 0xC0 - 0xDF — The length field is in “2 bytes.” • C. 0xE0 - 0xFF — The length field is in “4 bytes.” The last two bytes are the Padding End (0xBF00) command. It equals command=END + length=0. Cisco Small Business Network Camera Exported CGI Commands...
Page 48
The padding contains motion detection data only: Length Indicator Threshold Window On/Off Length On/Off 0x000x000x000x150x01 0x0D 129 0 128 128 128 128 1 0xBF0x00 0x15 = 21 (total length = 21 bytes) Cisco Small Business Network Camera Exported CGI Commands...
Description: Encrypt the input data with the base64 Input: char i_buf[]- input buffer Output: char o_buf[]- output buffer Return: encrypted string length //-------------------------------------------------------- int encode64(char i_buf[], char o_buf[]) char chr1 = (char)0; Cisco Small Business Network Camera Exported CGI Commands...
Page 51
{ //These are the 3 bytes to be encoded char chr1 = (char)0; char chr2 = (char)0; char chr3 = (char)0; //These are the 4 encoded bytes Cisco Small Business Network Camera Exported CGI Commands...
Page 52
= ((enc2 & 15) << 4) | (enc3 >> 2); chr3 = ((enc3 & 3) << 6) | enc4; o_buf[j++] = (char)chr1; if (enc3 != 64) { o_buf[j++] = (char)chr2; if (enc4 != 64) { o_buf[j++] = (char)chr3; Cisco Small Business Network Camera Exported CGI Commands...
Page 53
= (char)0; chr3 = (char)0; enc1 = 0; enc2 = 0; enc3 = 0; enc4 = 0; } while (i < strlen(i_buf)); //finish off the loop //Now return the decoded values. return j; Cisco Small Business Network Camera Exported CGI Commands...
Firmware release date (for internal use only; value cannot be modified). def_name Default device (host) name. default_ip Default IP address (xxx.xxx.xxx.xxx/ yyy.yyy.yyy.yyy) Where xxx.xxx.xxx.xxx is the IP address; yyy.yyy.yyy.yyy is the default gateway IP address. Cisco Small Business Network Camera Exported CGI Commands...
Device ID field on the web interface of the camera. comment Set the camera description. It can include up to 32 ASCII and space characters. time_format Set the time format. The choices are: • 24-hour • 12-hour (AM/PM) (reserved) Cisco Small Business Network Camera Exported CGI Commands...
Page 56
0 — Off • 1 — On ntp_server Set the NTP server address (up to 64 characters). led_mode Set LED operation. The choices are: • 0 — Off • 1 — On Cisco Small Business Network Camera Exported CGI Commands...
Value and Description Parameter syslog_mode Set the SYSLOG feature. The choices are: • 0 — Off • 1 — On syslog_server Set the SYSLOG server address. It can include up to 64 characters. Cisco Small Business Network Camera Exported CGI Commands...
Set the wireless network type. The choices are: • 0 — Ad hoc 1 • 1— infrastructure wlan_essid Set the wireless SSID. It can include up to 32 ASCII characters and is case sensitive. Cisco Small Business Network Camera Exported CGI Commands...
Page 59
• 8 — WPA PSK • 9 — WPA2 PSK wep_authtype Set the WEP authentication type. The choices are: • 1 — Open system • 2 — Shared key (WEP mode only) Cisco Small Business Network Camera Exported CGI Commands...
Page 60
Ethernet or not. • 3 — The device enters WPS PIN code mode over wireless whether a connection is available over the Ethernet or not. Cisco Small Business Network Camera Exported CGI Commands...
Page 61
Set the EAP-TTLS User name. It can include up to 64 ASCII characters. wpa_ttls_pass Set the EAP-TTLS user password. It can include up to 64 ASCII characters. wpa_ttls_anony_name Set the EAP-TTLS/EAP-TLS anonymous name. It can include up to 64 ASCII characters. Cisco Small Business Network Camera Exported CGI Commands...
Set the scheduling update unit. • 1 — Minute • 2 — Hour • 3 — Day (Default) ddns_update_period Set the scheduling update interval (> 0). The default value is 1 day. Cisco Small Business Network Camera Exported CGI Commands...
Allowed values are ASCII characters and space characters. The default name is WVC210. [UPNP] Group Value and Description Parameter upnp_mode Set the uPnP feature. The choices are: • 0 — Off • 1 — On (Default) Cisco Small Business Network Camera Exported CGI Commands...
Set the SMTP 2 port number. The range is from 0 to 65535. The default is 25. smtp2_auth Set the SMTP2 Authentication method. The choices are: • 0 — None • 1 — SMTP Cisco Small Business Network Camera Exported CGI Commands...
Page 65
0 — No • 1 — Yes C — Send to address 3 • 0 — No • 1 — Yes subject Set the E-mail subject. It can include up to 48 ASCII characters. Cisco Small Business Network Camera Exported CGI Commands...
Set the FTP login name. It can include up to 32 characters. ftp2_passwd Set the FTP server login password. It can include up to16 characters. ftp2_path Set the FTP server login default path. It can include up to 64 characters. Cisco Small Business Network Camera Exported CGI Commands...
Set the color balance. The choices are: • 0 — Auto • 1 — Indoor • 2 — White light • 3 — Yellow light • 4 — Outdoor • 5 — Black & white Cisco Small Business Network Camera Exported CGI Commands...
Page 68
Flip (rotate) the image: The choices are: • 0 — Off • 1 — On mirror Mirror the image. The choices are: • 0 — Off • 1 — On Cisco Small Business Network Camera Exported CGI Commands...
• 6 — 512K • 7— 768K • 8 — 1Mb/s • 9— 1.2 Mb/s frame_rate Set the framerate. The range is from 1 to 30 FPS. The default value is 30. Cisco Small Business Network Camera Exported CGI Commands...
1 — Very low • 2 — Low • 3 — Normal • 4 — High • 5 — Very high frame_rate Set the frame rate. The range is from 1 to 30 FPS. Cisco Small Business Network Camera Exported CGI Commands...
3 — 128K • 4 — 256K frame_rate Set the frame rate. Can be from 1 to 15 FPS. The default value is 15. mobile_access Set the access code for mobile access. Cisco Small Business Network Camera Exported CGI Commands...
Set audio in control (MIC-in). The choices are: • 0 — No • 1 — Yes Example: 1,0,1,0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0 Out of 20 users, users 1, 3, and 5 have audio-in access rights. Cisco Small Business Network Camera Exported CGI Commands...
Page 74
Out of 20 users, users 1, 3, and 6 have pan & tilt access rights. adm_ctrl Set administrator access. The choices are: • 0 — No • 1 — Yes Example: 1,0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,0 Out of 20 users, users 1, 3, and 19 can control I/O ports. Cisco Small Business Network Camera Exported CGI Commands...
X is: 0 to 639. The range of Y is 0 to 479. See “Motion Detection Commands,” on page 37 for more md_window4 information. md_threshold1 Set the threshold of the motion detection window N. The range is from 0 to 255. … md_threshold4 Cisco Small Business Network Camera Exported CGI Commands...
B — FTP upload 0 — No 1 — Yes • C — Reserved • D — Reserved event_attach Set the image type. The choices are: • 0 — MPEG-4 • 1 — JPEG Cisco Small Business Network Camera Exported CGI Commands...
Set the QoS mode. The choices are: • 0 — Disable • 1 — Enable qos_dscp Set the QoS DSCP value. The range is 0 to 63. The default is 12. Cisco Small Business Network Camera Exported CGI Commands...
<preset position#>,<time in seconds>; <preset position#>,<time in seconds>;... For preset position, use the pt_position name. For time in seconds, the range if from 5 to 60 seconds. PredefineHome Set the user defined HOME position (x,y). Cisco Small Business Network Camera Exported CGI Commands...
• 1 — Record by the multiple files, and named by timestamp. smbc_rec_account Set the user name to access the SMB server for regular recording. It can include up to 64 characters. Cisco Small Business Network Camera Exported CGI Commands...
*(GMT-06:00) Central Time (US & Canada) *(GMT-06:00) Guadalajara, Mexico City, Monterrey (GMT-06:00) Saskatchewan (GMT-05:00) Bogota, Lima, Quito *(GMT-05:00) Eastern Time (US & Canada) (GMT-05:00) Indiana (East) *(GMT-04:00) Atlantic Time (Canada) (GMT-04:00) La Paz Cisco Small Business Network Camera Exported CGI Commands...
Page 81
*(GMT+01:00) Sarajevo, Skopje, Warsaw, Zagreb (GMT+01:00) West Central Africa *(GMT+02:00) Athens, Istanbul, Minsk *(GMT+02:00) Bucharest *(GMT+02:00) Cairo (GMT+02:00) Harare, Pretoria *(GMT+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius (GMT+02:00) Jerusalem *(GMT+03:00) Baghdad (GMT+03:00) Kuwait, Riyadh Cisco Small Business Network Camera Exported CGI Commands...
Page 82
(GMT+07:00) Bangkok, Hanoi, Jakarta *(GMT+07:00) Krasnoyarsk (GMT+08:00) Beijing, Chongqing, Hong Kong, Urumqi *(GMT+08:00) Irkutsk, Ulaan Bataar (GMT+08:00) Kuala Lumpur, Singapore (GMT+08:00) Perth (GMT+08:00) Taipei (GMT+09:00) Osaka, Sapporo, Tokyo (GMT+09:00) Seoul *(GMT+09:00) Yakutsk *(GMT+09:30) Adelaide Cisco Small Business Network Camera Exported CGI Commands...
Page 83
(GMT+10:00) Brisbane *(GMT+10:00) Canberra, Melbourne, Sydney (GMT+10:00) Guam, Port Moresby *(GMT+10:00) Hobart *(GMT+10:00) Vladivostok (GMT+11:00) Magadan, Solomon Is., New Caledonia *(GMT+12:00) Auckland, Wellington (GMT+12:00) Fiji, Kamchatka, Marshall Is. (GMT+13:00) Nuku'alofa (GMT-04:30) Caracas, Cisco Small Business Network Camera Exported CGI Commands...
Regulatory Compliance and Safety Information for this product is available on Cisco.com at the following location: www.cisco.com/go/smallbusiness Warranty Warranty information that applies to this product is available on Cisco.com at the following location: www.cisco.com/go/warranty End User License Agreement (EULA) Licensing information that applies to this product is available on Cisco.com at the following location: www.cisco.com/go/warranty...
Support Contacts Support contact information for this product is available on Cisco.com at the following location: www.cisco.com/go/smallbusiness http://www.cisco.com/en/US/support/ tsd_cisco_small_business_support_center_contacts.html Cisco Small Business Network Camera Exported CGI Commands...
Need help?
Do you have a question about the WVC210 and is the answer not in the manual?
Questions and answers