INTELLINET ACTIVE NETWORKING 550710 ­ CGI Command Reference February 17 2004 CGI Command Reference V 1.3a for Network IP Camera This documentation explains the usage of CGI commands which are supported by Network IP Camera 550710. There are five different categories of CGI commands: 1) 2) 3) 4) 5) Still image request command Motion image request command GP_OUT Setting commands Setting Commands / Remote Programming Inquiry commands / Display of current settings & Alert State of Digital IO Connector This reference is based on Firmware Version 4.11 (Released: February 17 2004). You can get the latest firmware version here: http://www.intellinet-network.com/ipcamera http://www.intellinet-network.com/ipcamera 1 of 13 INTELLINET ACTIVE NETWORKING 550710 ­ CGI Command Reference 1. Still image request command Use this command when you need 1 data segment of JPEG file as a still image. The command returns a small HTML page which links to the JPG. Syntax 1. http://camera_ip/image.cgi?id=&passwd=&img_size= * It's necessary to place "&" between each = · id= Valid username (account must have viewing rights) · passwd= Valid password (account must have viewing rights) · img_size= It is possible to set the image size by setting "img_size" parameter. If not specified the image size currently programmed in the camera will be returned. Value VGA QVGA QCIF Image Size 640 * 480 320 * 240 160 * 120 Attention: This command does not return a JPG image, but a HTML page linking to the image. To get the JPG image only you can use the following SYNTAX: Syntax: http://camera_ip/jpg/image.jpg The "direct image access function" can be activated and configured in the camera´s system configuration. http://www.intellinet-network.com/ipcamera 2 of 13 INTELLINET ACTIVE NETWORKING 550710 ­ CGI Command Reference 2. Motion image request command Use this command to retrieve a motion image. This command offers two kinds of mode. One is Applet (JAVA), the other is ActiveX (Windows MSIE). It is possible to control "frame rate" and "image size", and to activate the "firewall option" and "timestamp option". Syntax 1. http://camera_ip/image.cgi?id=&passwd=&mode=&fr= &img_size=&bf=×tamp= · · · id= Valid username (account must have viewing rights) passwd= Valid password (account must have viewing rights) mode= Value activex applet · Details ActiveX motion image Applet motion image fr= Controls the frame rate (frames/second). Possible values are: 1, 2, 5, 10, 15 and 30. img_size= If not specified the image size currently programmed in the camera will be returned. Value VGA QVGA QCIF Image Size 640 * 480 320 * 240 160 * 120 · · bf= Controls the "behind firewall" parameter. Possible values are: 0 = behindfirewall = false (default value) 1 = behindfirewall = true If not specified the default value will be returned. timestamp= Controls the "timestamp" parameter to display the date/time information in the live image. Possible values are: off = no timestamp on = timestamp = on (default value) If not specified the default value will be returned. http://www.intellinet-network.com/ipcamera 3 of 13 · INTELLINET ACTIVE NETWORKING 550710 ­ CGI Command Reference 3. GP_OUT Setting commands These commands are to be used to control the GPIO (General Purpose I/O) output port of the camera. Syntax: http://camera_ip/gp_out.cgi?id=&passwd=&out=&interval= · · · · id= Valid username (account must have administrator rights) passwd= Valid password (account must have administrator rights) out= Activates the Output port by using the value "on". interval= Specifies the time in seconds the output port should be activated. Possible values are: 0 ­ 255 Example: http://camera_ip/gp_out.cgi?id=guest&passwd=guest&out=on&interval=20 Camera activates the GPIO output for a period of 20 seconds. http://www.intellinet-network.com/ipcamera 4 of 13 INTELLINET ACTIVE NETWORKING 550710 ­ CGI Command Reference 4. Setting Commands / Remote Programming These commands are to be used to set various settings for the WEBVIEW. It is possible to transmit several parameters at one time only when they belong to the same CGI name (*_set.cgi). Syntax: http://camera_ip/*_set.cgi?id=&passwd=¶meter= There are six different CGI Commands controlling different aspects: 1) Image setting command (image_set.cgi) Control Bightness, Contrast, Saturation and other image parameters. 2) Network setting command (network_set.cgi) Change the IP Address, Ports, SMTP Server, .... 3) Event setting command (event_set.cgi) Setup the Event Trigger Configuration remotely. 4) Time setting command (time_set.cgi) Define the time server, time zone, daylight saving time, ... 5) System setting command (system_set.cgi) Configuration of Camera Name, Location, Direct Image Access and more 6) PTZ Control command (ptz_webctl.cgi) Command set for the PTZ Version of Network IP Camera. · · Always enter User ID and Password of an Administrator Account. parameter= Refer to "CGI command list" below. http://www.intellinet-network.com/ipcamera 5 of 13 INTELLINET ACTIVE NETWORKING 550710 ­ CGI Command Reference 5. Inquiry commands / Display of current settings & Alert State of Digital IO Connector The INQUIRY.CGI command displays a HTML page with the current settings in Network IP Camera. There are different commands displaying different parameters. Syntax: http://camera_ip/inquiry.cgi?id=&passwd=&inq= · · id= Valid username (account must have administrator rights) passwd= Valid password (account must have administrator rights) inq= Use one of the following values: image = displays the current image settings network = displays the parameters of the Network Configuration user = displays the list users event = displays the parameters of the Event Trigger Configuration time = displays all time relevant settings system = displays parameters of System Configuration gpio = displays the alert state of Network IP Camera (see below) Query of Digital IO Alert State: You can query the alert state of the camera using the command below: Syntax: http://camera_ip/inquiry.cgi?id=&passwd=&inq= gpio This command returns: GPIO_IN : 1(open) GPIO_IN : 0(closed) http://www.intellinet-network.com/ipcamera 6 of 13 INTELLINET ACTIVE NETWORKING 550710 ­ CGI Command Reference CGI Command List 1. Image setting command (image_set.cgi) Parameter Comp_Rate Img_Size Vertical_Flip Horizontal_Flip Time_Stamp Value 1 ~ 10 vga/qvga/qcif on/off on/off on/off Inquiry Parameter image image image image inq/set Setting page Image Configuration Image Configuration Image Configuration Image Configuration Image Configuration Image Configuration Image Configuration Image Configuration Image Configuration Image Configuration Image Configuration Image Configuration Image Configuration Image Configuration Image Configuration Image Configuration Note 640*480 / 320*240 / 160*120 Bright_Value Contrast Hue Saturation Sharpness Exposure Exposure_Value Back_Light Exposure_Time In_Out Light_Fre 0 ~ 25 0 ~ 10 0 ~ 15 0 ~ 255 0~7 auto/manual 0 ~ 255 on /off yes/no indoor/outdoor 50hz/60hz image image image image image image image image image image image Example: Changing the Brightness of the live image Syntax: http://camera_ip/*image_set.cgi?id=&passwd=&Bright_Value=128 Sets the Brightness Value to 128 (Brightness Mode needs to be set to "manual" first). Example 2: Changing the Image Resolution of the live image Syntax: http://camera_ip/*image_set.cgi?id=&passwd=&Img_Size=vga Sets the image size to VGA (= 640 x 480 pixel). http://www.intellinet-network.com/ipcamera 7 of 13 INTELLINET ACTIVE NETWORKING 550710 ­ CGI Command Reference 2. Network Setting command (network_set.cgi) IP Addresses, Ports and DNS Parameter Ip_Assign_Method Ip Subnet Gateway Send_Email Email_Addr Web_Port Img_Port Upgrade_Port Ptz_Port Etsp_Port Dns1_Server Dns2_Server Value using_dhcp/manually on/off 80 ~ 1023 8000 ~ 65535 8000 ~ 65535 8000 ~ 65535 8000 ~ 65535 Inquiry Parameter network network network network network network network network network network network network network Setting CGI network_set.cgi network_set.cgi network_set.cgi network_set.cgi network_set.cgi network_set.cgi network_set.cgi network_set.cgi network_set.cgi network_set.cgi network_set.cgi network_set.cgi network_set.cgi Setting page Network Configuration Network Configuration Network Configuration Network Configuration Network Configuration Network Configuration Network Configuration Network Configuration Network Configuration Network Configuration Network Configuration Network Configuration Network Configuration SMTP / Email Settings Parameter Use_Smtp_Auth Smtp_Server Sender_Email_Addr Smtp_Auth_Method Smtp_Auth_Id Smtp_Auth_Passwd Smtp_Auth_Realm Value on/off digest_md5/login/plain Inquiry Parameter network network network network network network network Setting CGI network_set.cgi network_set.cgi network_set.cgi network_set.cgi network_set.cgi network_set.cgi network_set.cgi Setting page Network Configuration Network Configuration Network Configuration Network Configuration Network Configuration Network Configuration Network Configuration DDNS Settings Parameter Regist Ddns_Serv Regist_Id Regist_Pd Host_Name Manual_update Ddns_status Value enable/disable On/off Inquire Parameter network network network network network network network Setting CGI network_set.cgi network_set.cgi network_set.cgi network_set.cgi network_set.cgi network_set.cgi network_set.cgi Setting page Network Configuration Network Configuration Network Configuration Network Configuration Network Configuration Network Configuration Network Configuration http://www.intellinet-network.com/ipcamera 8 of 13 INTELLINET ACTIVE NETWORKING 550710 ­ CGI Command Reference 3. Event Trigger Configuration Setting command (event_set.cgi) Trigger Condition Parameter Digital_Option Di_From Di_To Motion_Option Md_From Md_To Motion_Sensitivity Period_Option Pe_Sec Pe_From Pe_To Value on/off 0 ~ 24 0 ~ 24 on/off 0 ~ 24 0 ~ 24 0~9 on/off 1 ~ 3600 0 ~ 24 0 ~ 24 Inquiry Parameter event event event event event event event event event event event Setting CGI event_set.cgi event_set.cgi event_set.cgi event_set.cgi event_set.cgi event_set.cgi event_set.cgi event_set.cgi event_set.cgi event_set.cgi event_set.cgi Setting page Event Configuration Event Configuration Event Configuration Event Configuration Event Configuration Event Configuration Event Configuration Event Configuration Event Configuration Event Configuration Event Configuration Image Capture Settings Parameter Before_Event After_Event Cap_Rate Img_Name Append_Ip Append_Date Append_Trigger Append_Sequence Value 0 ~ 21 0 ~ 21 1 /2 /3 /5 /7 /10 / 15 on / off on/off on/off on/off Inquire Parameter event event event event event event event event Setting CGI event_set.cgi event_set.cgi event_set.cgi event_set.cgi event_set.cgi event_set.cgi event_set.cgi event_set.cgi Setting page Event Configuration Event Configuration Event Configuration Event Configuration Event Configuration Event Configuration Event Configuration Event Configuration Trigger Output Settings Parameter Trg_Out Sup_Volt Send_Alm Trg_Send_Img Email_Addr Email_Title Trg_Send_Ftp Ftp_Serv Ftp_User Ftp_Passwd Ftp_Dir Value on/off 0 ~ 255 on/off on/off on/off Inquire Parameter event event event event event event event event event event event Setting CGI event_set.cgi event_set.cgi event_set.cgi event_set.cgi event_set.cgi event_set.cgi event_set.cgi event_set.cgi event_set.cgi event_set.cgi event_set.cgi Setting page Event Configuration Event Configuration Event Configuration Event Configuration Event Configuration Event Configuration Event Configuration Event Configuration Event Configuration Event Configuration Event Configuration http://www.intellinet-network.com/ipcamera 9 of 13 INTELLINET ACTIVE NETWORKING 550710 ­ CGI Command Reference 4. Time Configuration Setting command (time_set.cgi) Time Server & Update Settings Parameter Time_Ntp Time_Zone Update_Interval Ntp_Addr Td_Year Td_Month Td_Date Tc_Hour Tc_Min Tc_Sec Value sync_ntp/manually 1 ~ 68 0 ~ 65536 1000 ~ 9999 1 ~ 12 1 ~ 31 0 ~ 23 0 ~ 59 0 ~ 59 Inquiry Parameter time time time time time time time time time time Setting CGI time_set.cgi time_set.cgi time_set.cgi time_set.cgi time_set.cgi time_set.cgi time_set.cgi time_set.cgi time_set.cgi time_set.cgi Setting page ...