IP Camera CGI User Manual H.
Shenzhen Dericam Technology Co.,Limited www.dericam.net TABLE OF CONTENTS Version Release Notes.................................................................................................................. 4 IP Camera CGI Summary............................................................................................................. 5 1 Audio/Video.................................................................................................................................. 6 param.
Shenzhen Dericam Technology Co.,Limited www.dericam.net ptzup.cgi.................................................................................................................................26 ptzdown.cgi............................................................................................................................26 ptzleft.cgi................................................................................................................................ 26 ptzright.cgi....................
Shenzhen Dericam Technology Co.,Limited www.dericam.net sysreset.cgi............................................................................................................................45 sysreboot.cgi......................................................................................................................... 45 backup.cgi..............................................................................................................................45 restore.cgi...........................
Shenzhen Dericam Technology Co.,Limited www.dericam.net IP Camera CGI Summary All the CGI APIs is based http protocol, IP camera could be manipulated by CGI command in client or other web application . � CGI authorization: The CGI listed below is required for authorization when it be used , and different CGI is not the same authority needed. A total of three authorizations: visitor,operator and Administrator . Authority set by the user on the device .
Shenzhen Dericam Technology Co.,Limited Return error message if is 0xa10e6008” . www.dericam.net failed,for example:[Error]Get video attribution error! errcode � To setup or manipulate device: This type of CGI will be return the reuslut text, If CGI is executed successfully ,”HTTP/1.0 200 OK” will be returned ； otherise , for example: ”[Error][Data-Length:91] unrecongnized or incomplete command line.” it tells us the CGI parameter error.
Shenzhen Dericam Technology Co.,Limited www.dericam.net 1QCIF resolution is PAL: 176x144, NTSC: 176x112 1QVGA resolution is 1QQVGA resolution is 320x240 160x112 1HD720P resolution is 1280x720 1HDQ720P resolution is 640x352 1HDQQ720P resolution is 320x176 Attention: It is main-stream resolution in front of “_” ,followed by sub-stream resolution 1HD720P_1HDQ720P: main-stream resolution is 720P , sub-stream resolution is Q720P Example /cgi-bin/hi3510/param.cgi?cmd=getvideoattr etvideoattr param.
Shenzhen Dericam Technology Co.,Limited 1VGA resolution is www.dericam.
Shenzhen Dericam Technology Co.,Limited Note www.dericam.net Attention: Suffix”_1” is main-stream parameters , Suffix “_2” is sub-stream parameters . Example /cgi-bin/hi3510/getvencattr.cgi?-chn=11 setvencattr param.cgi?cmd= param.cgi?cmd=setvencattr Function To config video codec parameters Authority admin Syntax /cgi-bin/hi3510/param.
Shenzhen Dericam Technology Co.,Limited www.dericam.net /cgi-bin/hi3510/param.cgi?cmd=setvencattr&-chn=11&-bps=1536&-fps=25 param.cgi?cmd=getimage attr param.cgi?cmd=getimageattr Function To get image parameters Authority admin Syntax /cgi-bin/hi3510/param.
Shenzhen Dericam Technology Co.,Limited www.dericam.net auto indoor outdoor flip Image flip: on off mirror Image mirror: on off Return Value Success: contain Success Failure: contain Error Note Different device type supports different image parameters, reference to Appendix I: Definition of device type Example /cgi-bin/hi3510/param.cgi?cmd=setimageattr&-brightness=1&-saturation=1&contrast=1&-hue=1&-flip=on&-mirror=on&-scene=indoor& get overlay attr param.cgi?cmd= param.
Shenzhen Dericam Technology Co.,Limited www.dericam.net param.cgi?cmd=s et overlay attr param.cgi?cmd=set etoverlay overlayattr Function To set OSD parameters Authority admin Syntax /cgi-bin/hi3510/param.cgi[?cmd=setoverlayattr&-region=&show=&name=] parameters region region 0: OSD time region 1: OSD name region show OSD show/hide 0: hide 1: show name OSD name , Support English characters only.
Shenzhen Dericam Technology Co.,Limited parameters Return Value msize www.dericam.net 1: sub-stream max resolution 2: sub-stream min resolution Success: contain Success Failure: contain Error Note Some device does not support to change these attributes , reference to Appendix I: Definition of device type Example /cgi-bin/hi3510/param.cgi?cmd=setmobilesnapattr&-msize=1 getaencattr param.cgi?cmd= param.
Shenzhen Dericam Technology Co.,Limited aeformat www.dericam.net Audio Codec Format g711a: G711 a-law 64Kbps g726: G726 16Kbps Return Value Success: contain Success Failure: contain Error Note Audio Sampling rate: 8K, Mono, 16 bit Example /cgi-bin/hi3510/param.cgi?cmd=setaencattr&-chn=11&-aeswitch=0 /cgi-bin/hi3510/param.cgi?cmd=setaencattr&-chn=12&-aeswitch=1&-aeform at=g726 getaudioinvolume param.cgi?cmd= param.
Shenzhen Dericam Technology Co.,Limited Syntax /cgi-bin/hi3510/param.cgi[?cmd=getinfrared] parameters None Return Value infraredstat www.dericam.net Infrared LED Status: auto open close Note Some device does not support to change these attributes , reference to Appendix I: Definition of device type Example /cgi-bin/hi3510/param.cgi?cmd=getinfrared etinfrared param.cgi?cmd=s param.cgi?cmd=setinfrared Function To set Infrared LED parameters Authority admin Syntax /cgi-bin/hi3510/param.
Shenzhen Dericam Technology Co.,Limited gateway xxx.xxx.xxx.xxx dnsstat DNS status: www.dericam.net 0: manual 1: auto fdnsip Primary DNS sdnsip The second DNS macaddress MAC address networktype Network type: LAN WiFi Note None Example /cgi-bin/hi3510/param.cgi?cmd=getnetattr setnet attr param.cgi?cmd= param.cgi?cmd=s etnetattr Function To config LAN parameters of device Authority Admin Syntax /cgi-bin/hi3510/param.
Shenzhen Dericam Technology Co.,Limited www.dericam.net param.cgi?cmd= gethttpport param.cgi?cmd=g Function To get HTTP port Authority admin Syntax /cgi-bin/hi3510/param.cgi[?cmd=gethttpport] parameters None Return Value httpport Note None Example /cgi-bin/hi3510/param.cgi?cmd=gethttpport HTTP port param.cgi?cmd=sethttpport Function To config HTTP port Authority admin Syntax /cgi-bin/hi3510/param.
Shenzhen Dericam Technology Co.,Limited parameters Rtsp port Return Value Success: contain Success www.dericam.net RTSP port range: [80~49151] Failure: contain Error Note Device will automatically restart when the configuration is successful Example /cgi-bin/hi3510/param.cgi?cmd=setrtspport&-rtspport=554 getinter net ip param.cgi?cmd= param.cgi?cmd=g etinternet netip Function To inquiry the Internet IP address of this device Authority admin Syntax /cgi-bin/hi3510/param.
Shenzhen Dericam Technology Co.,Limited Return Value www.dericam.net Success: contain Success Failure: contain Error Note None Example /cgi-bin/hi3510/param.cgi?cmd=setupnpattr&-upm_enable=1 4 Wi-Fi setting get wireless attr param.cgi?cmd= param.cgi?cmd=get getwireless wirelessattr Function To get wifi parameters Authority admin Syntax /cgi-bin/hi3510/param.
Shenzhen Dericam Technology Co.,Limited Syntax www.dericam.net /cgi-bin/hi3510/param.
Shenzhen Dericam Technology Co.,Limited wnet www.dericam.
Shenzhen Dericam Technology Co.,Limited www.dericam.net 2: WPA-PSK 3: WPA2-PSK wf_key Wi-Fi Key wf_enc Key type 0: TKIP 1: AES wf_mode Connection mode: 0: Route mode 1: Peer to peer mode Return Value wf_result WIFI check Return Value 0: failure 1: success Note None Example /cgi-bin/hi3510/param.cgi?cmd=chkwirelessattr&-wf_ssid=linksys&-wf_auth= 2&-wf_key=1234567890&-wf_enc=0&-wf_mode=0 5 DDNS get 3th ddnsattr param.cgi?cmd= aram.
Shenzhen Dericam Technology Co.,Limited www.dericam.net param.cgi?cmd= set 3th ddnsattr aram.cgi?cmd=s et3th 3thddnsattr Function To set DDNS parameters Authority admin Syntax /cgi-bin/hi3510/param.cgi?cmd=set3thddnsattr.[?-d3th_enable=&-d3th_service =&-d3th_uname=&-d3th_passwd=&-d3th_domain=] parameters d3th_enable DDNS: 0: disable 1: enable d3th_service DDNS Service providers : 0: dyndns.org 1: 322.org 2: dynddns.
Shenzhen Dericam Technology Co.,Limited www.dericam.net right up down home zoom in zoom out hscan vscan stop speed Return Value PTZ speed , range 1~63 . Success: contain Success Failure: contain Error Note Different device type support different PTZ parameters, reference to Appendix I: Definition of device type Example /cgi-bin/hi3510/ptzctrl.cgi?-step=0&-act=left&-speed=45 preset.cgi Function To preset PTZ Authority Admin and user Syntax /cgi-bin/hi3510/preset.
Shenzhen Dericam Technology Co.,Limited www.dericam.net param.cgi?cmd=g etptzcomattr param.cgi?cmd=getptzcomattr Function To get PTZ parameters Authority admin Syntax /cgi-bin/hi3510/param.
Shenzhen Dericam Technology Co.,Limited stopbit Stop bit: 1or 2 check Parity: www.dericam.net 0: None 1: odd parity 2: even parity Return Value Success: contain Success Failure: contain Error Note Some device does not support this attribute , reference to Appendix I: Definition of device type Example /cgi-bin/hi3510/param.cgi?cmd=setptzcomattr&-protocal=0&-address=1&-bau d=9600&-databit=8&-stopbit=1&-check=0 ptzup.
Shenzhen Dericam Technology Co.,Limited Authority admin and user Syntax /cgi-bin/hi3510/ptzleft.cgi parameters None Return Value Success: contain Success www.dericam.net Failure: contain Error Note None Example /cgi-bin/hi3510/ptzleft.cgi ptzright.cgi Function To control PTZ right movement for mobile Authority admin and user Syntax /cgi-bin/hi3510/ptzright.cgi parameters None Return Value Success: contain Success Failure: contain Error Note None Example /cgi-bin/hi3510/ptzright.
Shenzhen Dericam Technology Co.,Limited www.dericam.net Failure: contain Error Note None Example /cgi-bin/hi3510/ptzzoomout.cgi 7 Motion detection and I/O Alarm param.cgi?cmd=getmdattr Function To get motion detection parameters Authority admin Syntax cgi-bin/hi3510/param.
Shenzhen Dericam Technology Co.,Limited m3_h Region 3 height m3_sensitivity Region 3 sensitivity m3_threshold Reserved, unused m4_enable The fourth motion detection region: www.dericam.net 0: disable 1: enable Note m4_x Region 4 abscissa m4_y Region 4 Ordinate m4_w Region 4 width m4_h Region 4 height m4_sensitivity Region 4 sensitivity m4_threshold Reserved, unused The region coordinate, width and height are based the max resolution of this device. Example /cgi-bin/hi3510/param.
Shenzhen Dericam Technology Co.,Limited www.dericam.net param.cgi?cmd=ge tio attr param.cgi?cmd=getio tioattr Function To get alarm IO parameters Authority admin Syntax /cgi-bin/hi3510/param.cgi[?cmd=getioattr] parameters None Return Value io_enable Alarm IO: 0: disable 1: enable io_flag Alarm IO mode: 0: NC 1: NO Note None Example /cgi-bin/hi3510/param.cgi?cmd=getioattr io attr param.cgi?cmd=set param.
Shenzhen Dericam Technology Co.,Limited parameters aname www.dericam.
Shenzhen Dericam Technology Co.,Limited www.dericam.net email: E-mail alarm emailsnap: E-mail alarm and send snapshot snap: save snapshot to SD card record: save video to SD card ftprec: upload video to FTP server relay: relay output switch alarm linkage value: on: enable off: disable Return Value Success: contain Success Failure: contain Error Note Attention:Before upload video to FTP serve,you must enable save video to SD card.
Shenzhen Dericam Technology Co.,Limited Return Value www.dericam.net Success: contain Success Failure: contain Error Note None Example /cgi-bin/hi3510/param.cgi?cmd=setrelayattr&-time=10 getschedule param.cgi?cmd= param.cgi?cmd=g Function To get alarm and arming schedule table Authority admin Syntax /cgi-bin/hi3510/param.
Shenzhen Dericam Technology Co.,Limited www.dericam.net var md_interval="0"; Note None Example /cgi-bin/hi3510/param.cgi?cmd=getschedule&-type=event&-ename=md param.cgi?cmd=setschedule Function To set alarm and arming schedule table Authority admin Syntax /cgi-bin/hi3510/param.
Shenzhen Dericam Technology Co.,Limited www.dericam.net Attention: workday and weekend field only used in working days rest days mode, week0 ~ week6 field only used in all week mode,and start time must be less then end time .
Shenzhen Dericam Technology Co.,Limited www.dericam.net 8 User Management param.cgi?cmd=getuserattr Function To get all user information Authority admin Syntax /cgi-bin/hi3510/param.
Shenzhen Dericam Technology Co.,Limited Authority admin Syntax /cgi-bin/hi3510/getsetupflag.cgi parameters None Return Value name0 name password0 password authLevel0 reversed Note None Example /cgi-bin/hi3510/getsetupflag.cgi www.dericam.net getstreamflag.cgi Function To get guest parameters Authority guest Syntax /cgi-bin/hi3510/getstreamflag.
Shenzhen Dericam Technology Co.,Limited www.dericam.net 9 Time Snapshot param.cgi?cmd=getsnaptimerattr Function To get time snapshot parameters Authority admin Syntax /cgi-bin/hi3510/param.cgi[?cmd=getsnaptimerattr] parameters None Return Value as_enable Time Snapshot : 0: disable 1: enable as_interval Time interval , minute（range: 1~1440） as_type Linkage type 1: save snapshot to SD card . 4: send E-mail 5: save snapshot to SD card and send E-mail.
Shenzhen Dericam Technology Co.,Limited www.dericam.net =60&-as_type=5 10 FTP getftpattr param.cgi?cmd= param.cgi?cmd=getftpattr Function To get FTP parameters Authority admin Syntax /cgi-bin/hi3510/param.cgi[?cmd=getftpattr] parameters None Return Value ft_server FTP server address ft_port Server port ft_username username ft_password password ft_mode Passive mode: 0: disable 1: enable ft_dirname Path Note None Example /cgi-bin/hi3510/param.cgi?cmd=getftpattr etftpattr param.
Shenzhen Dericam Technology Co.,Limited www.dericam.net Failure: contain Error Note None Example /cgi-bin/hi3510/param.cgi?cmd=setftpattr&-ft_server=220.112.14.173&-ft_ port=21&-ft_username=FTPUsername&-ft_password=FTPPassword&-ft_mod e=1&-ft_dirname=abc 11 SMTP attr param.cgi?cmd=getsmtp param.cgi?cmd=getsmtpattr Function To get SMTP parameters Authority admin Syntax /cgi-bin/hi3510/param.
Shenzhen Dericam Technology Co.,Limited www.dericam.
Shenzhen Dericam Technology Co.,Limited www.dericam.net sdstop.cgi Function To stop use SD card Authority admin Syntax /cgi-bin/hi3510/sdstop.cgi parameters None Return Value Stop SD Card Success Note Please wait for a long time Example /cgi-bin/hi3510/sdstop.cgi 13 System parameter settings param.cgi?cmd=getserverinfo Function To get device system information Authority admin Syntax /cgi-bin/hi3510/param.
Shenzhen Dericam Technology Co.,Limited www.dericam.net param.cgi?cmd=get devtype param.cgi?cmd=getdevtype Function To get device type information Authority admin Syntax /cgi-bin/hi3510/param.cgi[?cmd=getdevtype] parameters None Return Value devtype Note reference to Appendix I: Definition of device type Example /cgi-bin/hi3510/param.cgi?cmd=getdevtype stream num param.cgi?cmd=get param.
Shenzhen Dericam Technology Co.,Limited www.dericam.net param.cgi?cmd=setservertime Function To set system time Authority admin Syntax /cgi-bin/hi3510/param.cgi[?cmd=setservertime&-time=&-timezone=&-dstmod e=] parameters stime Current date and time [yyyy].[mm].[dd].[hh].[mm].[ss] 2011.08.23.10.35.
Shenzhen Dericam Technology Co.,Limited Note None Example /cgi-bin/hi3510/param.cgi?cmd=getntpattr www.dericam.net attr param.cgi?cmd=setntp param.cgi?cmd=setntpattr Function To set NTP parameters Authority admin Syntax /cgi-bin/hi3510/param.cgi[?cmd=setntpattr&-ntpenable=&-ntpserver=&-ntpint erval=] ntpenable NTP: 1: enable 0: disable parameters ntpserver NTP server: time.nist.gov time.kriss.re.kr time.windows.com time.nuri.
Shenzhen Dericam Technology Co.,Limited Authority admin Syntax /cgi-bin/hi3510/sysreboot.cgi parameters None Return Value None Note None Example /cgi-bin/hi3510/sysreboot.cgi www.dericam.net backup.cgi Function To backup configuration data Authority admin Syntax /cgi-bin/hi3510/backup.cgi parameters None Return Value None Note None Example /cgi-bin/hi3510/backup.cgi restore.cgi Function To restore configuration data Authority admin Syntax /cgi-bin/hi3510/restore.
Shenzhen Dericam Technology Co.,Limited www.dericam.net Return Value None Note This CGI only support post method , send new firmware to ipcamera. Example
14 LOG logsync.cgi Function To get log information Authority admin Syntax /cgi-bin/hi3510/logsync.Shenzhen Dericam Technology Co.,Limited www.dericam.net 15 Appendix 1. Appendix I Definition of device type Used to identify the device type, different device has different function . ACSII , 32 bytes. 2bytes every one field. The first byte is the tota- type of the field, the second byte is the sub-type of the field field3 field4 LEN P ‘S’ ‘Z’ 3). Len field ‘S’ For example: ‘0’ CMOS VGA Brightness, contrast, saturation, color, indoor, outdoor, IR LED switch, flip, mirror.
Shenzhen Dericam Technology Co.,Limited www.dericam.net America/Winnipeg (GMT-06:00) Saskatchewan America/Mexico_City (GMT-06:00) Guadalajara, Mexico City, Monterrey America/Chicago (GMT-06:00) Central Time （US and Canada） America/Costa_Rica (GMT-06:00) Central America America/Indianapolis (GMT-05:00) Indiana (East) America/New_York (GMT-05: 00) Eastern Time (U.S.
Shenzhen Dericam Technology Co.,Limited www.dericam.
