Revision History Version Release Date Description May.14 2009 Initial version Jun.08.2009 Rename some CGIs and Params. Add stream descriptions. Jun.18.2009 Streams Dependency Revision Jun.26.2009 Add “listgroup” action of param.cgi Aug.06.2009 Add “motioninfo” CGI command Add “HTTPS” parameter group Add “Bonjour”, “UPnP” in Network parameter group.
Page 5
1.1.1 Jun.29.2010 Add how to get input and output status (section 1.16), set output status (section 2.10) by new firmware, TCP payload message of event (section 2.7) Nov.1.2010 Add fe.cgi (section 1.17) which controls the fish eye function. Jan.13.2011 Add query and preset point function to fe.cgi.
1 CGI Commands This CGI Command document specifies the method of communication with the Network Camera or Server for controlling camera functions as well as for getting and setting internal parameter values, which helps the application integrators develop software applications more easily.
Page 7
Add = create the new parameter. Update = change the parameter value. Remove = delete the parameter. List = list the value of specified parameter or all the values if no any specified parameter. Listgroup= list the values of specified parameter group, e.g. “Network”.
Page 8
Method: GET http://192.168.0.200/cgi-bin/admin/param.cgi?actions=remove&EventServers.TCP.T00 (4) List a parameter: Method: GET http://192.168.0.200/cgi-bin/admin/param.cgi?actions=list&Network.IPAddress Return : 192.168.1.83 Network.IPAddress= Other example Method: GET http://192.168.0.200/cgi-bin/admin/param.cgi?actions=list&Network.MACAddress Method: GET http://192.168.0.200/cgi-bin/admin/param.cgi?actions=list&Brand.Brand Method: GET http://192.168.0.200/cgi-bin/admin/param.cgi?actions=list&Brand.ProdModel (5) List all parameter: Method: GET http://192.168.0.200/cgi-bin/admin/param.cgi?actions=list Return: Audio.A00.AlarmLevel=2 Audio.A00.Enabled=yes Audio.NbrOfAudios=1 AudioSource.A00.BitRate=64000...
Page 9
AudioSource.A00.Encoder=g711u AudioSource.A00.InputGain=26 AudioSource.A00.InputPreGain=32 AudioSource.A00.InputType= AudioSource.A00.SampleRate=16000 Brand.Brand= Brand.ProdFullName= Brand.ProdNbr=P600DN Brand.ProdShortName= Brand.ProdType= Brand.WebURL= Wireless.SubnetMask= Wireless.WEPEncryption=64 Wireless.WPAEncryption= Wireless.WPAKey= (6) List a group of parameters: Method: GET http://192.168.0.200/cgi-bin/admin/param.cgi?actions=listgroup&Motion Return: Motion.M00.Bottom=159 Motion.M00.Color=FF0000 Motion.M00.History=0 Motion.M00.ImageSource=0 Motion.M00.Left=57 Motion.M00.Name=M1 Motion.M00.Right=201 Motion.M00.Sensitivity=0 Motion.M00.Top=40 Motion.M00.Trigger=0 Motion.M00.WindowType=include Motion.M01.Bottom=199...
1.2 pwdgrp.cgi Add, modify and delete users Description: Add a new user with password and group membership, modify the information and remove a user. Method: GET Syntax: http://<servername>/cgi-bin/admin/pwdgrp.cgi?<parameter>=<value>[&<parameter>=<value >...] Parameter Value Description actions add, update , remove , list add = create a new user account. Update = change account information of specified parameters if the account...
Page 12
Example: E- Create a new administrator account: http://192.168.0.200/cgi-bin/admin/pwdgrp.cgi?actions=add&user=test&pwd=test&grp=pxad (2) Modify the password of the administrator account. http://192.168.0.200/cgi-bin/admin/pwdgrp.cgi?actions=update&user=test&pwd=t1&grp=pxad (3) Delete a user: http://192.168.0.200/cgi-bin/admin/pwdgrp.cgi?actions=remove&user=test (4) List all of the users: http://192.168.0.200/cgi-bin/admin/pwdgrp.cgi?actions=list Return List : root= pxadmin=admin pxoperator=user1,user2 pxview=user1,user2...
1.3 ptz.cgi PTZ commands Description: To control the Pan, Tilt and Zoom behavior of a PTZ unit, the following PTZ control URL is used. Method: GET Syntax: http://<servername>/cgi-bin/admin/ptz.cgi?<parameter>=<value>[&<parameter>=<value>...] Parameter Value Description action ptz_play Specifies the action to take. The number of channel. e.g.
Page 14
Example: (1) Stop the PTZ: http://192.168.0.200/cgi-bin/admin/ptz.cgi?action=ptz_play&ch=0&cmd=stop (2) Go to preset position 1: http://192.168.0.200/cgi-bin/admin/ptz.cgi?action=ptz_play&ch=0&cmd=go_preset&point=1...
1.4 file.cgi Description: Upgrade the firmware version, upload a unit specific backup previously created by the backup_config.cgi, or add/delete the language file. Method: POST Enctype: multipart/form-data Parameter Value Description actions Specifies the action to take. upgrade, restore, ddling, dellang Upgrade = Upgrade the firmware version. Restore = Upload a unit specific backup previously created by the backup_config.cgi.
Page 16
nl = Nederlands pt = Português da = Dansk no = Norsk(Bokmål) lt = Lietuvių es = Español hr = Hrvatski iw = עברית el = Ελληνικά lv = Latviešu ا ar = bg = Български uk = Українська cs = Čeština sl = Slovenščina sr = Српски...
1.5 backup_config.cgi Description: Download a unit specific backup of all files in the folder /etc in tgz format. Method: POST Example: <form name=”form_export” method=”post” action=”/cgi-bin/admin/backup_config.cgi”> <input name=”Submit” type=”submit” value=”Backup” > </form> 1.6 restart.cgi Description: Restart server. Method: GET Syntax: http://<servername>/cgi-bin/admin/restart.cgi 1.7 factorydefault.cgi Description: Reload factory default.
1.9 serverreport.cgi Description: This CGI request generates and returns a server report. This report is useful as an input when requesting support. The report includes product information, parameter settings and system logs. Method: GET Syntax: http://<servername>/cgi-bin/admin/serverreport.cgi 1.10 wireless_setting.cgi Description: Get status of Wireless Network. Method: GET Syntax: http://<servername>/cgi-bin/admin/wireless_setting.cgi...
1.12 snapshot.cgi Description: Request a JPEG image (snapshot) with specified properties. Method: GET Syntax: http://<servername>/cgi-bin/admin/snapshot.cgi 1.13 trigger.cgi Description: Trigger events manually. Method: GET Syntax: http://<servername>/cgi-bin/admin/trigger.cgi Example: http://192.168.0.200/cgi-bin/admin/trigger.cgi 1.14 audio Description: Push audio from PC to IP Camera. Audio type: uLaw 8K Method: GET Syntax: http://<servername>/cgi-bin/admin/audio?<parameter>=<value>...
1.15 Motion Description: Retrieves the current motion detection level from all or specific motion detection including windows. A motion detection window is defined by a dynamic parameter group Motion.M<group number>. Method: GET Syntax: http://<servername>/cgi-bin/admin/motioninfo Return: HTTP Code: 200 OK Content-Type: multipart/x-mixed-replace; boundary=<boundary> Body: --<boundary>...
1.17 fe.cgi Description: To configure Fish Eye functions. Method: GET 1. Query the information of Fish Eye IP Camera. Query function is used to query the information of the Fish Eye IP Camera. A. Query the camera setup: User can pass camera_info command to query the display mode, mounting type and saved preset points information of IP Camera.
Page 25
Query the camera setup (double mode doesn’t support preset points): http://192.168.0.200/cgi-bin/admin/fe.cgi?action=query&cmd=camera_info Return: HTTP Code: 200 OK Line-based text data: text/plain MountType=ceiling&DisplayMode=double&PresetPoints=-1 Query the Pan, Tilt, and Zoom information of the IP Camera: User can pass ptz_info command to query the PTZ information of IP Camera by channel and the value of Pan, Tilt and Zoom are returned.
Page 26
http://192.168.0.200/cgi-bin/admin/fe.cgi?action=query&cmd=ptz_info&ch=2 Return: HTTP Code: 200 OK Line-based text data: text/plain Ch1=135,-1,-1 C. Query the preset point information of the IP Camera: User can pass preset_info command to query the preset point information of the IP Camera. By now, only quad and quad_source modes in ceiling mount support preset point function.
Page 27
Change the mounting type of fisheye IP Camera: Each mounting type has a default display mode, the default display mode of ceiling mount is quad, of wall mount is quad_source, and of table mount is double. If CGI executes successfully, the current mount type, current display mode and saved preset points are returned.
Page 28
quad, Available display mode in Ceiling mount: quad_source, quad = 360° quad view double, original, quad_source = 360° 3 PTZ view with source panorama, double = 360° double broad view original = source image panorama = 360° broad view Example: ceiling mount, set IP Camera display mode to quad: http://192.168.0.200/cgi-bin/admin/fe.cgi?action=display_mode&cmd=quad...
Page 29
By now, no mode in table mount supports preset point function, so PresetPoints always return -1. Parameter Value Description action display_mode Specify the Fish Eye display mode. double, Available display mode in Table mount: original double = double 360° broad view (video conference mode) original = source image Example: table...
Page 30
0, 1, 2, 3 Support channel in different display modes: quad: 0, 1, 2, 3 quad_source: 1, 2, 3 double: 0, 1 panorama: 0 Pan offset Support display modes: quad, quad_source, double, panorama. +pan: pan right -pan: pan left tilt Tilt offset Support display modes: quad, quad_source.
Page 31
Parameter Value Description action eptz Specify the Fish Eye display mode. save_preset, save_preset: save the current ePTZ setting (all channels) and go_preset, return all saved preset points delete_preset go_preset: change the ePTZ setting, and return PTZ settings of all channels, display mode and mounting type delete_preset: delete the ePTZ setting and return all saved preset points point...
2 Parameter Groups 2.1 ImageSource Description: Parameters for each CCD/CMOS image source. This parameter group is product dependent and only available in network cameras. Check the product specification for supported parameters, default values and valid values. CGI: param.cgi Primary group name: ImageSource Primary group value: I00 =>...
Page 33
MaxGain 0~4 (Default 0) Decides how much gain the exposure control algorithm is allowed to use. ( 36, 31, 25, 19, 13 dB) Mirror.Hori yes, no Enabled of mirror vertically. Mirror.Vert yes, no Enabled of mirror horizontally. WhiteLightLED auto, alwayson, alwaysoff White LED control.
2.2 Image Description: Common image parameters used for all image configurations. CGI: param.cgi Primary group name: Image Primary group value: I00~I02 => Stream ID (Stream 1 ~ Stream 3) Secondary group value: G00 => Image Source [Image.I00.G00. ] Parameter Value Description ImageSource Video channel Source.
Page 35
Appearance.Compres best, good, standard Quality Level, for MJPEG or VBR mode. sion Stream.FPS 5~30 Frames per second. (1600x1200 : 5~15, others :5~30 ) Stream.Priority quality, efficiency Whether the rate controller should prioritize quality or efficiency. 64~10000 The target bit rate, in kbit/s, for CBR mode. RateControl.TargetBi trate Stream.SessionPath...
2.3 OSD Description: Image text overlay parameters for each image configuration. CGI: param.cgi Primary group name: Image Primary group value: I00 => Steam ID Secondary group name: Text [Image.I00.Text. ] Parameter Value Description Enabled yes, no OSD Enabled or not. TextEnabled yes, no Enable inclusion of camera name in th image.
2.4 Audio Description: Audio configuration. The name of the audio configuration, which audio source it is connected to and whether it should be enabled or not. CGI: param.cgi Primary group name: Audio Primary group value: A00 [Audio. ] [Audio.A00. ] Parameter Value Description...
2.6 EventServers FTP Server Description: This group defines an FTP server that can be used by an event to upload files to. CGI: param.cgi Primary group name: EventServers Secondary group name: FTP Secondary group value: F00~ F [EventServers.FTP. ] [EventServers.FTP.F00. ] Parameter Value Description...
or send notification messages to. CGI: param.cgi Primary group name: EventServers Secondary group name: HTTP Secondary group value: H00~ [EventServers.HTTP. ] [EventServers.HTTP.H00. ] Parameter Value Description NbrOfServers The number of HTTP server. Name <String> A descriptive HTTP server name. Address <URL>...
[EventServers.TCP. ] [EventServers.TCP.T00. ] Parameter Value Description NbrOfServers The number of TCP server. Name <String> A descriptive TCP server name. Address <IP address or host name> IP address or host name of the TCP server. Port 0~65535 TCP port number to use. 2.7 Event Configuration Description: This group defines an event, which is a set of parameters describing how and when the product performs certain actions.
Page 41
Type S, T Scheduled or Triggered event. Name <String> A descriptive event name. Priority 0, 1, 2 Execution priority: 0 = low. 1 = normal. 2 = high. Active yes, no If the event is currently triggered. MinimumTriggerInterval 00:00:00~ Time interval between triggers in format 23:59:59 “hours:minutes:seconds”, any triggers that occur during the interval are ignored.
Page 42
SWInput IO5:/, M1:/, Software input trigger pattern. BOOT:/, log Virtual Input (manual): IO<no>:<trigger> where the number can be an integer starting from 5, (Trigger by: and the trigger can be “/” or “H” for activated and Input ports: ”” “\” or “L” for inactivated. Manual Example 1: “IO5:H”...
Page 43
A00.Type Type of action. U = Upload. A00.Protocol FTP ,HTTP , Protocol. SMTP A00.Order Execution order. If this event has multiple actions, this parameter determines when this action should be executed. Actions with Order=0 will be executed in parallel (asynchronously). Other actions will be executed synchronously, i.e.
Page 44
A01.Order Execution order. If this event has multiple actions, this parameter determines when this action should be executed. Actions with Order=0 will be executed in parallel (asynchronously). Other actions will be executed synchronously, i.e. one action must finish before next action is executed, in rising order, i.e. first Order=1, then Order=2.
Page 45
Possible to use dynamic event notification: #e = The event name. #E = The event description. Specified in the file /etc/event_desc.list located in the product’s file system. #w = The motion detection window. #t = The trigger type and value. Also other format codes such as file naming and date/time formats can be used.
Page 46
A03.Server H0 ... Hn (n = HTTP server ID. Refers to a parameter group under number of root.EventServers.HTTP. HTTP event Example: “H0” refers to the parameter group servers -1) root.EventServers.HTTP.H0. A03.CustomParams <String> Custom parameters to add to URL. Example: “foo=bar”. Spaces are not allowed in this field and all text must be URI-encoded (RFC2396).
2.8 Motion Detection Description: Contain dynamic parameters, which define the properties of a Motion Detection window. CGI: param.cgi Primary group name: Motion Primary group value: M00~ [Motion.] [Motion.M00. ] Parameter Value Description NbrOfMotions The number of Motion Detection. Name <String> A user's window identification, e.g.
Trigger 0~100 Trigger level of Motion detection. Sensitivity 0~100 Sensitivity of Motion detection. ( Sensitivity value:0~100[low~High],set more for more sensitive. ) Color 0000~FFFF The color of Window area. 2.9 Input Port Description: Parameters for hardware input(s). CGI: param.cgi Primary group name: Input Primary group value: I00~ [Input.] [Input.I00.] Parameter...
2.10 Output Port Description: Parameters for hardware output(s). CGI: param.cgi Primary group name: Output Primary group value: O00~ [Output .] [Output .O00.] Parameter Value Description NbrOfOutputs The number of output. Name <String> The name of the output. (read only) Active open, close Determines when to trig.
Enabled yes, no Enable of ARP Ping IPAddress. IPAddress <String> IP Address. SubnetMask <String> Subnet mask. DefaultRouter <String> Default router/gateway used for connecting devices attached to different networks and network segments. DNSServer1 <String> Primary DNS server address. DNSServer2 <String> Secondary DNS server address. BootProto dhcp, none none = user assigned IP address.
HostName <String> The name of the device on the network, usually the same as the DNS name. FTP.Enabled yes, no Enable the FTP server. Primary group name: Time [ Time .] Parameter Value Description ObtainFromDHCP yes, no DHCP servers may provide names/IP addresses for local/remote NTP servers.
Page 52
Parameter Value Description MailServer1 <String> Primary mail server. MailServerPort1 0~65535 The port number for the primary mail server. FromEmail <String> E-mail address of the individual or device from which the e-mail is sent. TestEmail <String> E-mail address of the individual or device to test. Enabled yes, no Enable/disable authentication.
2.14 DDNS Description: Parameters for the DDNS servers. CGI: param.cgi Primary group name: Network Secondary group name: DDNS Secondary group value: D00~ D01 [ Network.DDNS.D00 ] Parameter Value Description Enabled yes, no Enable of DynDNS service. ServerAddress <String> Specifiy the DDNS server IP address. Could use domain name.
2.15 PPPoE Description: Parameters for the PPPoE servers. CGI: param.cgi Primary group name: Network Secondary group name: PPPoE [ Network.PPPoE. ] Parameter Value Description Enabled yes, no Enable / Disable PPPoE server. UserName <String> The user name for the PPPoE server. Password <String>...
2.17 UPnP Description: Parameters for the UPnP function. CGI: param.cgi Primary group name: Network Secondary group name: UPnP [ Network.UPnP. ] Parameter Value Description Enabled yes, no Enable / Disable UPnP service NATTraversal.Enabled yes, no Enable / Disable sending port mapping message to UPnP gateway NATTraversal.HTTPPort 1024 ~ 65535 The gateway port to map to the IP Camera HTTP...
2.18 HTTPS Description: Parameters for HTTPS setting. CGI: param.cgi Primary group name: HTTPS [HTTPS. ] Parameter Value Description Enabled yes, no https service enabled or not Port 1024 ~ 65535 Port used by https service. Default value is 443 2.19 Wireless Description: Parameters for the Wireless settings.
2.20 Anonymous login Description: Enable/disable anonymous login. CGI: param.cgi Primary group name: System [ System. ] Parameter Value Description WebProtViewer anonymous, password Enable anonymous login. (no user name or password required.) 2.21 Date & Time Description: Common time information which tell the time zone, how date and time is synchronized and the offset related to the chosen time zone and Coordinated Universal Time, UTC.
Page 59
TimeZone GMT-12, Time zone. GMT-1, GMT, GMT+1, GMT+12 (Default GMT) TimeZone List Value Zone GMT-12 GMT-12 (Eniwetok, Kwajalein) GMT-11 GMT-11 (Midway Isl., Samoa) GMT-10 GMT-10 (Hawaii) GMT-9 GMT-09 (Alaska) GMT-8 GMT-08 (Las Vegas, San Francisco, Vancouver) GMT-7 GMT-07 (Calgary, Denver, Salt Lake City) GMT-6 GMT-06 (Chicago, Dallas, Mexico City, New Orleans) Cuba...
2.22 Language Description: Current language setting. CGI: param.cgi Primary group name: Layout [ Layout. ] Parameter Value Description Language en, tw, cn Current language. en = English tw = 繁體中文 cn = 简体中文 2.23 Log Configuration Description: Parameters for selecting log levels for the product, for log levels to send as e-mail. CGI: param.cgi Primary group name: LogLevels [ LogLevels.
Parameter Value Description LogSendLevel Which messages that are sent with e-mail: 0 = None. 1 = Critical. 2 = Critical and Warning. 3 = Critical, Warning and Information. 2.24 PTZ Description: Parameters for PTZ control. CGI: param.cgi Primary group name: PTZ Primary group value: C00 Secondary group name: Serial [PTZ.C00.
19200, 38400, 57600, 115200 DataBits 7, 8 The number of data bits. StopBits 1, 2 The number of stop bits. Parity None, Even, Odd The parity. Device /dev/ttyS0, The serial device to use.( Default: /dev/ttyS2) /dev/ttyS1, This parameter is read only. /dev/ttyS2, /dev/ttyS3 (hardware specific)
Page 65
blue, teal, aqua OwnTextColorEnabled yes, no Use own text color. Description: The properties for custom links at the bottom of the live view page. Primary group name: Layout Secondary group name: CustomLink Secondary group value: C00~C03 [Layout.CustomLink.C00.] Parameter Value Description Enabled yes, no Use custom link #.
Page 66
[Layout.Logo.] Parameter Value Description Address <URL> (Default http:// ) If Layout.Logo.Source = external, get image from this address. Link none, default, own Use the logo as a link. none = no logo link. default = use the default link. own = logo link from Layout.Logo.LinkURL. LinkURL <URL>...
Secondary group name: Description [Layout.Description.] Parameter Value Description Source none, default, own Show description text below image. none = no description. default = use the default description. own = description from Layout.OwnDescription .String. String <String> (Default Description ) Description text below image. 2.26 External Video Description: Parameters that define the properties of an external video source.
3 Server Side Include Commands Server Side Include SSI variables allowed information to be inserted into HTML documents that the server sends to the client. 3.1 Pinit Description: It should be placed once before the Pget SSI command. Syntax: <% Pinit(); %> Example: <html>...
B. Streams Dependency Description: Stream configurations dependency details Streams’ Availabilities 1. Each stream can be switched to either H.264 or MJPEG mode, except stream 3; it is fixed in H.264 mode only. 2. Each steam can be configured to either CBR or VBR mode. 3.
C. HTTP status codes 200 OK The request has succeeded. The information returned with the response is dependent on the method used in the request, for example: GET an entity corresponding to the requested resource is sent in the response; HEAD the entity-header fields corresponding to the requested resource are sent in the response without any message-body;...
Page 78
401 Unauthorized The request requires user authentication. The response MUST include a WWW-Authenticate header field containing a challenge applicable to the requested resource. The client MAY repeat the request with a suitable Authorization header field. If the request already included Authorization credentials, then the 401 response indicates that authorization has been refused for those credentials.
Page 79
502 Bad Gateway The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request. 503 Service Unavailable The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.
Need help?
Do you have a question about the H.264 Series and is the answer not in the manual?
Questions and answers