Page 5
2. Include the authorization in the URL................68 16. Appendix ..........................68 Appendix I Defines for device type ..................68 Appendix II Time zone list ....................70 History Auth Edit Date Remark 1.0.0 Dericam 2016-4-29 Baseline Version 1.0.1 Dericam 2016-5-5 Formatting edits www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Introduction All CGI commands listed in this document are based on the HTTP protocol, which can be executed in a web browser or software client. Authentication All cgi commands need authentication before they can be executed. There are 3...
“[Error][Data-Length:91] unrecongnized or incomplete command line.” CGI can be executed in the URL of web bowser, which are as follows: http://192.168.1.88/cgi-bin/hi3510/param.cgi?cmd=getvencattr&-chn=11 http://192.168.1.6/cgi-bin/hi3510/param.cgi?cmd=setvencattr&-chn=11&-fps=15 http://192.168.1.6/cgi-bin/hi3510/param.cgi?cmd=getwirelessattr Or you can include the username/password of the IP camera directly: http://192.168.1.88/cgi-bin/hi3510/param.cgi?cmd=getvencattr&-chn=11&-usr=admin...
1: VBR imagegrade_1 Image quality. imagegrade_2 width_1, width_2 The width of the video. height_1, height_2 The hight of the video. Note: “_1” is for the first stream, “_2” is for the second stream. Note Example /cgi-bin/hi3510/param.cgi?cmd=getvencattr&-chn=11 www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Note: The smaller the value, the better the image, and the greater to affect the video bit rate. Key frame interval value: The range is [2 ~ 150] Return Success: Success Fail: Error Note None Example /cgi-bin/hi3510/param.cgi?cmd=setvencattr&-chn=11&-bps=1536&-f ps=25&-brmode=1&-imagegrade=1&-gop=50 /cgi-bin/hi3510/param.cgi?cmd=setvencattr&-chn=12&-bps=1536&-f ps=25&-brmode=1&-imagegrade=1&-gop=50 /cgi-bin/hi3510/param.cgi?cmd=setvencattr&-chn=11&-bps=1536&-f www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
The value for gain control, the range is [0-4294967295] imgmode The mode to improve the video: 0: Improve the video frame rate first. 1: Improve the image light first. aemode The value for AE control mode: 0: Auto, 1: Indoor, 2: Outdoor. www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
The value for shutter. The status for WDR: on: enable. off: disable noise The status for denoise: on: enable. off: disable The value for gain control, the range is [0-4294967295] www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
The value for distortion, from 0 to 511. Note None Example /cgi-bin/hi3510/param.cgi?cmd=getldcattr setldcattr Function Set the distortion value of lens. Privilege admin Usage /cgi-bin/hi3510/param.cgi[?cmd=setldcattr&- ldc_ratio =] Param. ldc_ratio The value for distortion, from 0 to 511. Return Success: Success. Fail: Error. Note None Example /cgi-bin/hi3510/param.cgi?cmd=setldcattr&- ldc_ratio=1 www.dericam.com...
The x-coordinate for OSD region. y_[region] The y-coordinate for OSD region. w_[region] The width for OSD region. h_[region] The height for OSD region. show_[region] Whether to display the OSD region 0: Hidden 1: Diaplay www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
1: The max. resolution for the second stream. 2: The min. resolution for the second stream. Note Some kinds of devices do not support to set this attributes, please see Appendix I for reference. Example /cgi-bin/hi3510/param.cgi?cmd=getmobilesnapattr www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
1. _1 represents the first stream, _2 represents the second stream. 2. The sampling rate for audio is 8K, single track, 16 bit wide. Example /cgi-bin/hi3510/param.cgi?cmd=getaencattr&-chn=11 setaencattr Function Set the encode attributes of audio. Privilege admin www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
The value of volumn, the range is [1-100] Note None Example /cgi-bin/hi3510/param.cgi?cmd=getaudioinvolume setaudioinvolume Function Set the volume of the input audio. Privilege admin Usage /cgi-bin/hi3510/param.cgi[?cmd=setaudioinvolume&-volume=] Param. volume The value of volumn, the range is [1-100] Return Success: Success. Fail: Error. Note None www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Return Success: Success. Fail: Error. Note None Example /cgi-bin/hi3510/param.cgi?cmd=setaudiooutvolume&-volume=80 getaudiooutvolume Function Get the input type for audio. Privilege admin Usage /cgi-bin/hi3510/param.cgi[?cmd=getaudiooutvolume] Param. None Return volin_type 0: Line in 1: Mac in Note None Example /cgi-bin/hi3510/param.cgi?cmd=getaudiooutvolume www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
2. IR Led control getinfrared Function Get the status of IR LED switch. Privilege admin Usage /cgi-bin/hi3510/param.cgi[?cmd=getinfrared] Param. None infraredstat Return IR Led status: auto: Automatical switch as the changing of outside light. open: Force to open permanently. www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Function Get the attributes of camera network. Privilege admin Usage /cgi-bin/hi3510/param.cgi[?cmd=getnetattr] Param. None Return dhcpflag DHCP status: On: Enable Off: Disable IP address netmask Subnet mask gateway Gatway dnsstat DNS Status: 0: Set manually. www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Gatway dnsstat DNS Status: 0: Set manually. 1: Obtain automatically. fdnsip First DNS sdnsip Reserve DNS Return Success: Success. Fail: Error. Note None Example /cgi-bin/hi3510/param.cgi?cmd=setnetattr&-dhcp=off&-ipaddr=192.168. 1.88&-netmask=255.255.255.0&-gateway=192.168.1.1&-dnsstat=0&-fd nsip=192.168.1.1&-sdnsip= gethttpport Function Get the port of HTTP. www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
RTP port Note None Example /cgi-bin/hi3510/param.cgi?cmd=getrtspport setrtspport Function Set the ports for RTSP and RTP. Privilege admin Usage /cgi-bin/hi3510/param.cgi[?cmd=setrtspport&-rtspport=&-rtpport=] Param. rtspport RTSP port number, the range is [80~65535] rtpport RTP port number, the range is [5000~8000] www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
The camera will reboot automatically after modify this status. Example /cgi-bin/hi3510/param.cgi?cmd=setrtspauth&-rtsp_aenable=1 getinterip Function Get the internet IP address of the camera network. Privilege admin Usage / cgi-bin/param.cgi?cmd=getinterip Param. None Return interip Internet IP, such as interip = "220.112.14.173" www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
0: Enable to set time zone, enable to set image parameters. 1: Disable to set time zone, enable to set image parameters. 2: Enable to set time zone, Disable to set image parameters. 3: Disable to set time zone, Disable to set image parameters. www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
3: WPA2-PSK wf_key Password wf_enc WPA Algorithm 0: TKIP 1: AES wf_mode Connection mode: 0: Router mode 1: Point to Point mode Note None Example /cgi-bin/hi3510/param.cgi?cmd=getwirelessattr setwirelessattr Function Set the attributes of wireless. Privilege admin www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
/cgi-bin/hi3510/param.cgi[?cmd=getchkwireless] Param. None Return chkres The status for wifi connection: 0: Fail 1: Success Note Please run chkwirelessattr command first before use this cgi. Example /cgi-bin/hi3510/param.cgi?cmd=getchkwireless 5. DDNS get3thddnsattr Function Get the DDNS attributes of third paryt. Privilege admin Usage /cgi-bin/hi3510/param.cgi[?cmd=get3thddnsattr]...
Different device types may have different parameters for PTZ, please see Appendix I for reference. Example /cgi-bin/hi3510/param.cgi?cmd=ptzctrl&-step=0&-act=left&-speed=45 preset Function Set the attributes for preset. Privilege admin, user Usage /cgi-bin/hi3510/param.cgi?cmd=preset[&-act=&-status=&-number=] Param. Command strings: goto: Call and go to the preset point. www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Back to center after self-check: on: Enable off: Disable ptzalarmmask Close the motion alarm while PTZ is moving. on: Enable off: Disable alarmpresetindex Alarm link action for going to preset, the preset number is [1-8]. Note None Example /cgi-bin/hi3510/param.cgi?cmd=getmotorattr www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
They must be the same for the speed of Pan and Tilt. And they must be the same for the number of horizontal and vertical curise. Example /cgi-bin/hi3510/param.cgi?cmd=setmotorattr&-panspeed=1&-tiltspeed= 1&-panscan=1&-tiltscan=1&-movehome=on&-ptzalarmmask=on&-alar mpresetindex=1 getmotorrange Function Get the attributes of PTZ motor type. www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Success: Success. Fail: Error. Note None Example /cgi-bin/hi3510/param.cgi?cmd=setmotorrange&-motortype=0&-panran ge=580&-tiltrange=150 getptzcomattr Function Get the PTZ common attributes. Privilege admin, user Usage /cgi-bin/hi3510/param.cgi[?cmd=getptzcomattr] Param. None Return protocal Protocol type: 0:PELCO-D 1:PELCO-P address Address code, the range is [0~255]. www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
The method to verify: 0: None 1: Odd parity check. 2: Even parity check. 3: Mark 4: Blank space. Return Success: Success. Fail: Error. Note Some kinds of device do not support this attribute, please see Appendix www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Note None Example /cgi-bin/hi3510/ptzdown.cgi ptzleft.cgi Function Let the PT go to left, used for the control on mobile phone. Privilege admin, user Usage /cgi-bin/hi3510/ptzleft.cgi Param. None Return Success: Success. Fail: Error. Note None Example /cgi-bin/hi3510/ptzleft.cgi www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Let the PTZ to zoom out, used for the control on mobile phone. Privilege admin, user Usage /cgi-bin/hi3510/ptzzoomout.cgi Param. None Return Success: Success. Fail: Error. Note None Example /cgi-bin/hi3510/ptzzoomout.cgi getlightattr Function Get the status for indicator light LED. www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
The status of motion detection of area 1: 0: Disable 1: Enable m1_x X-coordinate for area 1. m1_y Y-coordinate for area 1. m1_w The width for area 1. m1_h The height for area 1. www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
The sensitivity for area 4. m4_threshold Reserved Note The width and height for the area is based on the max. resolution of camera. Example /cgi-bin/hi3510/param.cgi?cmd=getmdattr setmdattr Function Set the attributes for motion detection. Privilege admin www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
0: Disable, do not allow. 1: Enable, allow. io_flag The trigger mode for I/O alarm: 0: Always close. 1: Always open. Note None Example /cgi-bin/hi3510/param.cgi?cmd=getioattr setioattr Function Set the attributes for I/O alarm. Privilege admin www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Usage /cgi-bin/hi3510/param.cgi[?cmd=setaudioalarmattr&-aa_enable=&-aa_v alue=] Param. aa_enable Whether to allow the audio alarm or not: 0: Disable, do not allow. 1: Enable, allow. aa_value Sensitivity value, the range is [1-100]. Much bigger will be much more sensitivity. www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Disable, do not allow. md_ ftpsnap _switch Whether to allow to save snapshots to FTP server: on: Enable, allow. off: Disable, do not allow. md_record_switch Whether to allow to save video to SD card: www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Snap: Save snapshots to SD card. Ftpsnap: Save snapshots to FTP server. record: Save video to SD card. ftprec: Save video to FTP server. relay: Relay output. server: Alarm server. preset: Actions for preset of PT. www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Set the relay output time for alarm link action. Privilege admin Usage /cgi-bin/hi3510/param.cgi[?cmd=setrelayattr&-time=] Param. time Output time, the unit is second , include [5, 10, 20, 30] Return Success: Success. Fail: Error. Note None Example /cgi-bin/hi3510/param.cgi?cmd=setrelayattr&-time=10 www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Get the count for alarm snapshots. Privilege admin Usage /cgi-bin/hi3510/param.cgi[?cmd=getalarmsnapattr] Param. None Return snap_count The count for snapshots of alarm. Note None Example /cgi-bin/hi3510/param.cgi?cmd=getalarmsnapattr setalarmsnapattr Function Set the count for alarm snapshots. Privilege admin Usage /cgi-bin/hi3510/param.cgi[?cmd=setalarmsnapattr&-snap_count=] www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Function Set the attributes for snapshot. Privilege admin Usage /cgi-bin/hi3510/param.cgi[?cmd=setalarmsnapattr&-snap_name_mode =&-snap_alarm_name=&-snap_timer_name=] Param. snap_name_mode How to name the snapshot? 0 : Name by date. 1: A fixed name. snap_alarm_name File name for snapshot of alarm. www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Param. Whether to enable the recording: 0: Disable 1: Enable planrec_time Time length for recoding, the range is [15-900] seconds. planrec_chn The stream channel for recording, 11, 12, 13 Return Success: Success. Fail: Error. www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Set the attributes for alarm server. Privilege admin Usage /cgi-bin/hi3510/param.cgi[?cmd=setalarmserverattr&-as_server=&- port=&-as_username=&-as_password= Param. as_server Server address. as_port Server port, the range is [1-65535] as_username Username as_password Password Return Success: Success. Fail: Error. Note None Example /cgi-bin/hi3510/param.cgi?cmd=setalarmserverattr&-as_server=alarm.n et&-as_port=8990&-as_username=asdf&-as_password=1234 www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Whether to enable privacy masking for area 2: 0: Disable 1: Enable color_2 The masking color for area 2. X-coordinate for area 2. Y-coordinate for area 2. The width for area 2. The heigth for area 2. www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Whether to enable privacy masking: 0: Disable 1: Enable region Area number for maksing, [1 ~ 4] color Masking color. X-coordinate for masking. Y-coordinate for masking. The width for masking. The heigth for masking. Return Success: Success. Fail: Error. www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Camera username for screen-x. d_password[0]="" Camera password for screen-x. X should be 1-9 which represents the screen d_host[1]="" from channel 1 to channel 9. d_alias[1]="" d_port[1]="80" d_username[1]="" d_password[1]="" d_host[2]="" d_alias[2]="" d_port[2]="80" d_username[2]="" d_password[2]="" d_host[3]="" d_alias[3]="" d_port[3]="80" d_username[3]="" d_password[3]="" www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
&- =&- =&- =&- d_number Param. Screen number, the range is 0-8. d_host The IP address of camera. d_alias Camera name. d_port The HTTP port for camera. d_username The username of camera. www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Set the attributes of users. Privilege admin Usage /cgi-bin/hi3510/param.cgi[?cmd= setuserattr&-at_username=&-at_new name= &-at_password = Param. at_username The current username, less then 16 characters. at_newname The new username, less then 16 characters. at_password The password, less then 16 characters. www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Get the attributes of guest user. Privilege guest Usage /cgi-bin/hi3510/ param.cgi?cmd=getstreamflag Param. None Return name2 Username password2 Password authLevel2 Reserved Note None Example /cgi-bin/hi3510/param.cgi?cmd=getstreamflag getptzflag Function Get the attributes of user account. Privilege user Usage /cgi-bin/hi3510/param.cgi?cmd=getptzflag Param. None www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Get the attributes for scheduled snapshot. Privilege admin Usage /cgi-bin/hi3510/param.cgi[?cmd= getsnaptimerattrex Param. None as_snap_enable Return Whether to save snapshots to SD card: 0: Disable 1: Enable as_snap_interval Time interval, the unit is second, the range is [5~86400]. www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Time interval for snap, the range is [5~86400] seconds. as_type Link actions: snap: Save snapshots to SD card. email: Send snapshots to E-mail. ftp: Upload snapshots to FTP server. Return Success: Success. Fail: Error. None Note /cgi-bin/hi3510/param.cgi?cmd=setsnaptimerattrex&-as_enable=1&- Example as_interval=60&-as_type=snap www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Usage /cgi-bin/hi3510/param.cgi[?cmd=getserverinfo] Param. None Return model Model SN number of camera. hardVersion Hardware version. softVersion Software version. webVersion Web version. name Camera name. startdate The start date of system running. upnpstatus Ok: Success off: Disable www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Get the count of users online. Privilege admin Usage /cgi-bin/hi3510/param.cgi[?cmd=getstreamnum] Param. None stream_num var stream_num = "1" ; Return Count for users, Note None Example /cgi-bin/hi3510/param.cgi?cmd=getstreamnum getservertime Function Get the start time of system running. www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Whether to enable the DST: on: Enable off: Disable Return Success: Success. Fail: Error. Note The DST is not used for all time zone. Example /cgi-bin/hi3510/param.cgi?cmd=setservertime&-time=2011.08.23.10.35. 08&-timezone=Asia%2FHong_Kong&-dstmode=off getntpattr Function Get the attributes of NTP. Privilege admin www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Whether to enable the NTP: 1: Enable 0: Disable ntpserver NTP Server name: time.nist.gov time.kriss.re.kr time.windows.com time.nuri.net ntpinterval The interval for NTP time synchronization, the range is [1-24] hours. Return Success: Success. Fail: Error. Note None Example /cgi-bin/hi3510/param.cgi?cmd=setntpattr&-ntpenable=1&-ntpinterval=2 &-ntpserver=time.nuri.net www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
None Return None Note 1. This command will read the log from /log/syslog.txt. 2. The log will be cleared automatically after reboot. Example /cgi-bin/hi3510/param.cgi?cmd=logsync /log/syslog.txt cleanlog Function Clear the log of system running. Privilege admin www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
2. Each field has 2 bytes. The first byte represents the general type and the second byte represends the sub type. Field 3 Field 4 Lens ‘S’ ‘Z’ 3. The field for lens ‘S’ ‘e’ CMOS 720P Brightness [0-100], Saturation [0-255], Contrast [0-100], Hue [0-100], Sharpness [0-100], Shutter [0-65535], www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Page 69
The third stream: QQ720P. Snapshots for mobile phone: Q720P, QQ720P. ‘I’ CMOS 1080P Brightness [0-100], Saturation [0-255], Contrast [0-100], CMOS 720P Hue [0-100], Sharpness [0-100], Shutter [0-65535], Flip, Mirror, WDR, Night vision mode. 1080P: The first stream: 1080P. www.dericam.com Shenzhen Dericam Technology Co,.Ltd...
Up, Down, Left, Right, Zoom in, Zoom out, Call preset points. Supports to set 485 attributes. Appendix II Time zone list Time zone Descriptions Etc/GMT-12 (GMT-12:00) Date line in the west Pacific/Apia (GMT-11:00) Midway Islands, Samoan Islands Pacific/Honolulu (GMT-10:00) Hawaii America/Anchorage (GMT-09:00) Alaska www.dericam.com Shenzhen Dericam Technology Co,.Ltd...