Dericam CGI, User Manual

Page 1: ...1 www dericam com Shenzhen Dericam Technology Co Ltd Dericam Camera CGI RTSP User Guide V1 0 2 ...

Page 2: ...ttr 15 getmobilesnapattr 15 setmobilesnapattr 16 getaencattr 16 setaencattr 16 getaudioinvolume 17 setaudioinvolume 17 getaudiooutvolume 18 setaudiooutvolume 18 getaudiooutvolume 18 setaudiooutvolume 19 requestifrm 19 2 IR Led control 19 getinfrared 19 setinfrared 20 3 Network 20 getnetattr 20 setnetattr 21 gethttpport 21 sethttpport 22 getrtspport 22 setrtspport 22 getrtspauth 23 setrtspauth 23 g...

Page 3: ... setmotorrange 34 getptzcomattr 34 setptzcomattr 35 ptzup cgi 36 ptzdown cgi 36 ptzleft cgi 36 ptzright cgi 37 ptzzoomin cgi 37 ptzzoomout cgi 37 getlightattr 37 setlightattr 38 7 Motion detection and I O alram 38 getmdattr 38 setmdattr 39 getioattr 40 setioattr 40 getaudioalarmattr 41 setaudioalarmattr 41 getmdalarm 42 setmdalarm 43 getrelayattr 44 setrelayattr 44 getmotorattr 45 setmotorattr 45 ...

Page 4: ...userattr 55 setuserattr 55 getsetupflag 56 getstreamflag 56 getptzflag 56 getuserinfo 57 11 Scheduled snapshot 57 getsnaptimerattrex 57 setsnaptimerattrex 58 12 FTP 59 getftpattr 59 setftpattr 59 testftp 60 13 SMTP 60 getsmtpattr 60 setsmtpattr 61 testsmtp 62 14 System setting 62 getserverinfo 62 getdevtype 63 getstreamnum 63 getservertime 63 setservertime 64 getntpattr 64 setntpattr 65 web tmpfs ...

Page 5: ... 1 Verify the authorization by client 68 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 Ver Auth Edit Date Remark 1 0 0 Dericam 2016 4 29 Baseline Version 1 0 1 Dericam 2016 5 5 Formatting edits ...

Page 6: ... name type hidden value access form Example for POST method form name form5 method post target retframe enctype multipart form data action cgi bin hi3510 upgrade cgi onSubmit return upgrade td colspan 3 input type file name setting_file input type submit value submit form CGI execute return information For the commands to get information from the IP camera such as the running status or configurati...

Page 7: ... cgi bin hi3510 param cgi cmd getvencattr chn 11 usr admin pwd admin http 192 168 1 6 cgi bin hi3510 param cgi cmd getwirelessattr usr admin pwd admin 1 Video Audio getvideoattr Function Get the properties of camera video such as resolution format and H 264 profile Privilege admin Usage cgi bin hi3510 param cgi cmd getvideoattr Param None Return videomode 31 720P_Q720P_QQ720P 32 720P_QQ720P_QQ720P...

Page 8: ...10 param cgi cmd getvideoattr setvideoattr Function Set the properties of camera video Privilege admin Usage cgi bin hi3510 param cgi cmd setvideoattr vinorm profile vide omode Param vinorm P 50Hz PAL N 60Hz NTSC profile 0 baseline 1 mainprofile videomode 31 720P_Q720P_QQ720P 32 720P_QQ720P_QQ720P 33 Q720P_Q720P_QQ720P 34 Q720P_QQ720P_QQ720P 41 1080P_Q720P_QQ720P 42 1080P_QQ720P_QQ720P 51 960P_VGA...

Page 9: ... param cgi cmd setvideoattr vinorm N profile 1 videomode 32 getvencattr Function Get encoding information for camera video Privilege admin user guest Usage cgi bin hi3510 param cgi cmd getvencattr chn Param chn Channel No 11 The first stream 12 The second stream Return bps_1 bps_2 Bit rate fps_1 fps_2 Frame rate gop_1 gop_2 Key frame interval brmode_1 brmode_2 Encode mode 0 CBR 1 VBR imagegrade_1 ...

Page 10: ... is 32 2048 kbps QVGA The range is 32 512 kbps QQVGA The range is 32 256 kbps fps Frame rate PAL The range is 1 25 NTSC The range is 1 30 brmode Encode mode value 0 CBR 1 VBR imagegrade Image quality value The range is 1 6 Note The smaller the value the better the image and the greater to affect the video bit rate gop Key frame interval value The range is 2 150 Return Success Success Fail Error No...

Page 11: ... for hue targety The value for target flip The value for flip status on enable off disable mirror The status for mirror on enable off disable night The status for night vision on enable off disable shutter The value for shutter wdr The status for WDR on enable off disable noise The status for denoise on enable off disable gc The value for gain control the range is 0 4294967295 imgmode The mode to ...

Page 12: ... ion contrast hue targety flip mirror noise imgmo de aemode display_mode Param brightness The value for brightness saturation The value for saturation contrast The value for contrast sharpness The value for sharpness hue The value for hue targety The value for target flip The value for flip status on enable off disable mirror The status for mirror on enable off disable night The status for night v...

Page 13: ...ram cgi cmd setimageattr brightness 1 saturatio n 1 contrast 1 hue 1 flip on mirror on noise on imgmode 0 aemode 0 display_mode 1 getldcattr Function Get the distortion value of lens Privilege admin Usage cgi bin hi3510 param cgi cmd getldcattr Param None Return ldc_ratio The value for distortion from 0 to 511 Note None Example cgi bin hi3510 param cgi cmd getldcattr setldcattr Function Set the di...

Page 14: ...aram cgi cmd setircutattr saradc_switch_value Param saradc_switch_value The value for IR_Cut switch from 1 to 1024 Return Success Success Fail Error Note None Example cgi bin hi3510 param cgi cmd setircutattr saradc_switch_value 700 getoverlayattr Function Get the imformation for OSD region Privilege admin Usage cgi bin hi3510 param cgi cmd getoverlayattr region Param region Region 0 OSD camera ti...

Page 15: ...n 16 characters Return Success Success Fail Error Note Note region_0 time OSD region do support to set name Example cgi bin hi3510 param cgi cmd setoverlayattr region 0 show 0 cgi bin hi3510 param cgi cmd setoverlayattr region 1 show 1 na me IPCam getmobilesnapattr Function Get image attributes for mobile phone Privilege admin Usage cgi bin hi3510 param cgi cmd getmobilesnapattr Param None Return ...

Page 16: ...obilesnapattr msize 1 getaencattr Function Get the encode attributes of audio Privilege admin Usage cgi bin hi3510 param cgi cmd getaencattr chn Param chn Channel No 11 The first stream 12 The second stream Return aeswitch_1 aeswitch_2 Whether to enable the switch for audio encode 0 Disable 1 Enable aeformat_1 aeformat_2 The format for audio encode g711a G711A bit rate is 64Kbps g726 G726 bit rate...

Page 17: ...wide Example cgi bin hi3510 param cgi cmd setaencattr chn 11 aeswitch 0 cgi bin hi3510 param cgi cmd setaencattr chn 12 aeswitch 1 a eformat g726 getaudioinvolume Function Get the volume of the input audio Privilege admin Usage cgi bin hi3510 param cgi cmd getaudioinvolume Param None Return volume The value of volumn the range is 1 100 Note None Example cgi bin hi3510 param cgi cmd getaudioinvolum...

Page 18: ... cmd getaudiooutvolume setaudiooutvolume Function Set the volume of the output audio Privilege admin Usage cgi bin hi3510 param cgi cmd setaudiooutvolume volume Param volume The value of volumn the range is 1 100 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 ...

Page 19: ...rm Function Request the key frame of next frame group Privilege admin Usage cgi bin hi3510 param cgi cmd requestifrm chn Param chn Channel No 11 The first stream 12 The second stream Return Success Success Fail Error Note None Example cgi bin hi3510 param cgi cmd requestifrm chn 11 2 IR Led control getinfrared Function Get the status of IR LED switch Privilege admin Usage cgi bin hi3510 param cgi ...

Page 20: ...stat IR Led status auto Automatical switch as the changing of outside light open Force to open permanently close Force to close permanently 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 setinfrared infraredstat auto 3 Network getnetattr Function Get the attributes of camera network Privilege admin Usage cgi...

Page 21: ... cgi bin hi3510 param cgi cmd setnetattr dhcp ipaddr netmask gateway dnsstat fdnsip sdnsip Param dhcp DHCP status On Enable Off Disable ipaddr IP address netmask Subnet mask gateway 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 ...

Page 22: ...ccess Fail Error Note The camera will reboot automatically after modify its HTTP port Example cgi bin hi3510 param cgi cmd sethttpport httpport 80 getrtspport Function Get the ports for RTSP and RTP Privilege admin Usage cgi bin hi3510 param cgi cmd getrtspport Param None Return rtspport RTSP port rtpport RTP port Note None Example cgi bin hi3510 param cgi cmd getrtspport setrtspport Function Set ...

Page 23: ...nable Note None Example cgi bin hi3510 param cgi cmd getrtspauth setrtspauth Function Set the status to verify authorization Privilege admin Usage cgi bin hi3510 param cgi cmd setrtspauth rtsp_aenable Param rtsp_aenable 0 Disable 1 Enable Return Success Success Fail Error Note The camera will reboot automatically after modify this status Example cgi bin hi3510 param cgi cmd setrtspauth rtsp_aenabl...

Page 24: ... param cgi cmd getupnpattr setupnpattr Function Set the status of UPNP enable Privilege admin Usage cgi bin hi3510 param cgi cmd setupnpattr upm_enable Param upm_enable 0 Disable 1 Enable Return Success Success Fail Error Note None Example cgi bin hi3510 param cgi cmd setupnpattr upm_enable 1 getonvifattr Function Get the attributes of Onvif Privilege admin Usage cgi bin hi3510 param cgi cmd geton...

Page 25: ... bin hi3510 param cgi cmd getonvifattr setonvifattr Function Set the attributes of Onvif Privilege admin Usage cgi bin hi3510 param cgi cmd setonvifattr ov_enable ov_port ov_authflag ov_forbitset Param ov_enable Onvif enable status 1 Enable 0 Disable ov_port Onvif port number ov_authflag Authorization check status 1 Enable 0 Disable ov_forbitset Enable status for onvif parameters 0 Enable to set t...

Page 26: ...ion Get the attributes of wireless Privilege admin Usage cgi bin hi3510 param cgi cmd getwirelessattr Param None Return wf_enable Wireless status 0 Disable 1 Enable wf_ssid SSID less then 32 characters wf_auth Security Mode 0 None 1 WEP 2 WPA PSK 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...

Page 27: ... 0 TKIP 1 AES wf_mode Connection mode 0 Router mode 1 Point to Point mode Return Success Success Fail Error Note None Example cgi bin hi3510 param cgi cmd setwirelessattr wf_ssid linksys wf_e nable 1 wf_auth 2 wf_key 1234567890 wf_enc 0 wf_mode 0 searchwireless Function Search wireless AP Privilege admin Usage cgi bin hi3510 param cgi cmd searchwireless Param None Return waccess_points AP counts w...

Page 28: ...Array var wnet new Array wchannel 0 6 wrssi 0 82 wessid 0 Fumax wireless wenc 0 AES wauth 0 WPA 2 PSK wnet 0 Infra wchannel 1 11 wrssi 1 62 wessid 1 linksys wenc 1 TKIP wauth 1 WPA 2 PSK wnet 1 Infra Note None Example cgi bin hi3510 param cgi cmd searchwireless chkwirelessattr Function Check wireless configuration is right or not Privilege admin Usage cgi bin hi3510 param cgi cmd chkwirelessattr w...

Page 29: ...0 getchkwireless Function Get the check result for wifi configurations Privilege admin Usage 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 Pr...

Page 30: ...t Privilege admin Usage cgi bin hi3510 param cgi cmd set3thddnsattr d3th_enable d3th_ service d3th_uname d3th_passwd d3th_domain Param d3th_enable The status for third party DDNS 0 Disable 1 Enable d3th_service The type of third party DDNS provider 0 dyndns org 1 322 org 2 dynddns us 3 No ip com d3th_uname Username d3th_passwd Password d3th_domain Domain Return Success Success Fail Error Note None...

Page 31: ...nleft downright Go to upleft upright downleft downright home Back to center point zoomin Zoom in zoomout Zoom out hscan The curise of horizontal vscan The curise of vertical stop Stop speed Speed for motion the value is 1 63 Return Success Success Fail Error Note Different device types may have different parameters for PTZ please see Appendix I for reference Example cgi bin hi3510 param cgi cmd pt...

Page 32: ...tatus 1 number 1 getmotorattr Function Get the attributes for PTZ Privilege admin Usage cgi bin hi3510 param cgi cmd getmotorattr Param None Return panspeed Speed of Pan 0 Fast 1 Medium 2 Slow tiltspeed Speed of Tilt 0 Fast 1 Medium 2 Slow panscan The number for horizontal cruise tiltscan The number for vertical cruise movehome Back to center after self check on Enable off Disable ptzalarmmask Clo...

Page 33: ...r vertical cruise movehome 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 Return Success Success Fail Error Note 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 cu...

Page 34: ...Privilege admin Usage cgi bin hi3510 param cgi cmd setmotorrange motortype panrang e tiltrange Param motortype 0 Default include a travel switch 1 Do not have a travel switch panrange Step length for pan tiltrange Step length for Tilt Return 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...

Page 35: ... cmd getptzcomattr setptzcomattr Function Set the PTZ common attributes Privilege admin Usage cgi bin hi3510 param cgi cmd setptzcomattr protocal address baud databit stopbit check Param protocal Protocol type 0 PELCO D 1 PELCO P address Address code the range is 0 255 baud Baud rate 1200 2400 4800 9600 19200 38400 57600 databit Data bits 7 or 8 stopbit Stop bits 1 or 2 check The method to verify ...

Page 36: ...turn Success Success Fail Error Note None Example cgi bin hi3510 ptzup cgi ptzdown cgi Function Let the PT go to down used for the control on mobile phone Privilege admin user Usage cgi bin hi3510 ptzdown cgi Param None Return Success Success Fail Error 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 ...

Page 37: ...n Let the PTZ to zoom in used for the control on mobile phone Privilege admin user Usage cgi bin hi3510 ptzzoomin cgi Param None Return Success Success Fail Error Note None Example cgi bin hi3510 ptzzoomin cgi ptzzoomout cgi Function 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 Not...

Page 38: ... bin hi3510 param cgi cmd setlightattr Param None Return light_enable The status for indocator light on The LED always light off The LED always go out Note None Example cgi bin hi3510 param cgi cmd setlightattr light_enable on 7 Motion detection and I O alram getmdattr Function Get the attributes for motion detection Privilege admin Usage cgi bin hi3510 param cgi cmd getmdattr Param None Return m1...

Page 39: ...Enable m3_x X coordinate for area 3 m3_y Y coordinate for area 3 m3_w The width for area 3 m3_h The height for area 3 m3_sensitivity The sensitivity for area 3 m3_threshold Reserved m4_enable The status of motion detection of area 4 0 Disable 1 Enable m4_x X coordinate for area 4 m4_y Y coordinate for area 4 m4_w The width for area 4 m4_h The height for area 4 m4_sensitivity The sensitivity for ar...

Page 40: ...s Success Fail Error Note The width and height for the area is based on the max resolution of camera Example cgi bin hi3510 param cgi cmd setmdattr enable 1 s 50 name 1 x 0 y 0 w 60 h 60 getioattr Function Get the attributes for I O alarm Privilege admin Usage cgi bin hi3510 param cgi cmd getioattr Param None Return io_enable Whether to allow the I O alarm or not 0 Disable do not allow 1 Enable al...

Page 41: ...vilege admin Usage cgi bin hi3510 param cgi cmd getaudioalarmattr Param None Return 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 Note None Example cgi bin hi3510 param cgi cmd getaudioalarmattr setaudioalarmattr Function Set the attributes for audio alarm Privilege adm...

Page 42: ...ave 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 Return md_email_switch Whether to allow the email alarm on Enable allow off Disable do not allow md_emailsnap_switch Whether to allow the email alarm with snapshots on Enable allow off Disable do not allow md_snap_switch Whether to allow to...

Page 43: ...3510 param cgi cmd getmdalarm aname email cmd get mdalarm aname emailsnap cmd getmdalarm aname ftpsnap cm d getmdalarm aname snap cmd getmdalarm aname emailrec c md getmdalarm aname record cmd getmdalarm aname ftprec c md getmdalarm aname relay cmd getmdalarm aname server c md getmdalarm aname preset setmdalarm Function Set the attributes for alarm link actions Privilege admin Usage cgi bin hi3510...

Page 44: ...h off cmd setmdalarm aname server switch off cmd setmdalar m aname preset switch off getrelayattr Function Get the relay output time for alarm link action Privilege admin Usage cgi bin hi3510 param cgi cmd getrelayattr Param None Return time Output time the unit is second var time 10 Note None Example cgi bin hi3510 param cgi cmd getrelayattr setrelayattr Function Set the relay output time for ala...

Page 45: ... param cgi cmd setmotorattr alarmpresetindex Param alarmpresetindex Preset name or number the range is 1 8 Return Success Success Fail Error Note None Example cgi bin hi3510 param cgi cmd setmotorattr alarmpresetindex 2 getalarmsnapattr Function 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...

Page 46: ...m cgi cmd getscheduleex ename Param ename Schedule name md Schedule for motion detection Snap Schedule for planed snap Return week0 PPPPPPPP PPPPPPPPPPPPP PPPPPPPPPPPPP PPPPPPPPPPPPP P week1 PPPPPPPP PPPPPPPPPPPPP PPPPPPPPPPPPP PPPPPPPPPPPPP P week3 PPPPPPPP PPPPPPPPPPPPP PPPPPPPPPPPPP PPPPPPPPPPPPP P week4 PPPPPPPP PPPPPPPPPPPPP PPPPPPPPPPPPP PPPPPPPPPPPPP P week5 PPPPPPPP PPPPPPPPPPPPP PPPPPPPPP...

Page 47: ... motion alarm and scheduled snap Privilege admin Usage cgi bin hi3510 param cgi cmd setscheduleex ename week0 w eek1 week2 week3 week4 week5 week6 Param ename Schedule name md Schedule for motion detection Snap Schedule for planed snap week0 PPPPPPPPP PPPPPPPPPPPPP PPPPPPPPPPPPP PPPPPPPPPPPPP 48 characters in week0 week6 represent 24 hours for one day from 0 00 23 30 each character represents a ha...

Page 48: ...PPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPP PPPP getalarmsnapattr Function Get the attributes for snapshot Privilege admin Usage cgi bin hi3510 param cgi cmd getalarmsnapattr Param None Return 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 snap_timer_name File name for snapshot of planning snap Note None Example cgi bin hi3510 param cg...

Page 49: ...nable 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 Note None Example cgi bin hi3510 param cgi cmd getplanrecattr setplanrecattr Function Set the attributes for scheduled recording Privilege admin Usage cgi bin hi3510 param cgi cmd setplanrecattr planrec_enable pla nrec_time...

Page 50: ...s as_port Server port the range is 1 65535 as_username Username as_password Password Note None Example cgi bin hi3510 param cgi cmd getalarmserverattr setalarmserverattr Function Set the attributes for alarm server Privilege admin Usage cgi bin hi3510 param cgi cmd setalarmserverattr as_server as_ port as_username as_password Param as_server Server address as_port Server port the range is 1 65535 ...

Page 51: ...n Get the attributes for masking Privilege admin Usage cgi bin hi3510 param cgi cmd getcover Param None Return show_1 Whether to enable privacy masking for area 1 0 Disable 1 Enable color_1 The masking color for area 1 x_1 X coordinate for area 1 y_1 Y coordinate for area 1 w_1 The width for area 1 h_1 The heigth for area 1 show_2 Whether to enable privacy masking for area 2 0 Disable 1 Enable col...

Page 52: ...rea 4 y_4 Y coordinate for area 4 w_4 The width for area 4 h_4 The heigth for area 4 Note The coordinate width height are based on the max resolution of the camera Example cgi bin hi3510 param cgi cmd getcover setcover Function Set the attributes for masking Privilege admin Usage cgi bin hi3510 param cgi cmd setcover show region color x y w h Param show Whether to enable privacy masking 0 Disable ...

Page 53: ...ser guest Usage cgi bin hi3510 param cgi cmd getdevices Param None Return d_host 0 d_alias 0 d_port 0 80 d_username 0 d_password 0 d_host 1 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 Camera IP address for screen x Camera name for screen x Camera HTTP port for screen x Camera usern...

Page 54: ...alias 7 d_port 7 80 d_username 7 d_password 7 Note None Example cgi bin hi3510 param cgi cmd getdevices setdevices Function Set the attributes for multi screen Privilege admin Usage cgi bin hi3510 param cgi cmd setdevices d_number d_alias d_host d_port d_username d_password Param d_number Screen number the range is 0 8 d_host The IP address of camera d_alias Camera name d_port The HTTP port for ca...

Page 55: ...ame The username of camera at_password The password of camera Note This command will return all user information such as username and password var at_name0 admin var at_password0 admin var at_name1 user var at_password1 user var at_name2 guest var at_password2 guest Example cgi bin hi3510 param cgi cmd getuserattr setuserattr Function Set the attributes of users Privilege admin Usage cgi bin hi351...

Page 56: ...pflag Param None Return name0 Username password0 Password authLevel0 Reserved Note None Example cgi bin hi3510 param cgi cmd getsetupflag getstreamflag Function 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 getptzfl...

Page 57: ...erinfo Param None Return name Username password Password authLevel The authorization level 15 admin 3 user 1 guest Note None Example cgi bin hi3510 param cgi cmd getuserinfo 11 Scheduled snapshot getsnaptimerattrex Function Get the attributes for scheduled snapshot Privilege admin Usage cgi bin hi3510 param cgi cmd getsnaptimerattrex Param None Return as_snap_enable as_snap_interval Whether to sav...

Page 58: ...d getsnaptimerattrex setsnaptimerattrex Function Set the attributes for scheduled snapshot Privilege admin Usage cgi bin hi3510 param cgi cmd setsnaptimerattrex as_enable as _interval as_type Param as_enable Whether to enable the scheduled snapshot 0 Disable 1 Enable as_interval Time interval for snap the range is 5 86400 seconds as_type Link actions snap Save snapshots to SD card email Send snaps...

Page 59: ...e Whether to enable the passive mode 0 Diasble 1 Enable Note None Example cgi bin hi3510 param cgi cmd getftpattr setftpattr Function Set the attributes of FTP setting Privilege admin Usage cgi bin hi3510 param cgi cmd getftpattr ft_server ft_port ft_ username ft_password ft_dirname ft_mode Param ft_server Server address ft_port Server port ft_username Username ft_password Password ft_dirname Stor...

Page 60: ...Param None Return result Return value 0 Success 1 Unknow error 2 Can not connect the FTP server 3 Username and password do not match 4 The storage path is error Note None Example cgi bin hi3510 param cgi cmd testftp 13 SMTP getsmtpattr Function Get the SMTP setting Privilege admin Usage cgi bin hi3510 param cgi cmd getsmtpattr Param None Return ma_server SMTP server address ma_port Server port ma_...

Page 61: ...d setsmtpattr ma_server ma_port ma_ssl ma_logintype ma_username ma_password ma_ from ma_to ma_subject ma_text Param ma_server SMTP server address ma_port Server port ma_ssl Authentication link 0 None 1 SSL 2 TLS 3 STARTTLS ma_logintype Whether to enable the check of authentication 1 Enable 3 Disable ma_username Username ma_password Password ma_from The email address of sender ma_to The email addre...

Page 62: ...value 0 Success 1 Unknow error 2 SSL error 3 None can not to connect the server 4 The username and password do not match Note None Example cgi bin hi3510 param cgi cmd testsmtp 14 System setting getserverinfo Function Get the attributes of camera Privilege admin Usage cgi bin hi3510 param cgi cmd getserverinfo Param None Return model Model SN number of camera hardVersion Hardware version softVersi...

Page 63: ...etdevtype Function Get the device type of camera Privilege admin Usage cgi bin hi3510 param cgi cmd getdevtype Param None Return devtype Device type Note See appendix I for reference Example cgi bin hi3510 param cgi cmd getdevtype getstreamnum Function Get the count of users online Privilege admin Usage cgi bin hi3510 param cgi cmd getstreamnum Param None Return stream_num Count for users var stre...

Page 64: ...ion Set the time of camera system Privilege admin Usage cgi bin hi3510 param cgi cmd setservertime time timezone ds tmode Param stime Current time yyyy mm dd hh mm ss For example 2011 08 23 10 35 08 timezone Time zone like timeZone Asia Hong_Kong Please see appendix II for reference dstmode Whether to enable the DST on Enable off Disable Return Success Success Fail Error Note The DST is not used f...

Page 65: ... hi3510 param cgi cmd getntpattr setntpattr Function Set the attributes of NTP Privilege admin Usage cgi bin hi3510 param cgi cmd setntpattr ntpenable ntpserver ntpinterval Param ntpenable 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 ...

Page 66: ...reset cgi Function Restore the camera settings to default values Privilege admin Usage cgi bin hi3510 sysreset cgi Param None Return Success Success Fail Error Note None Example cgi bin hi3510 sysreset cgi Sysreboot cgi Function Reboot the camera system Privilege admin Usage cgi bin hi3510 sysreboot cgi Param None Return Success Success Fail Error Note None Example cgi bin hi3510 sysreboot cgi bac...

Page 67: ...d should use the POST HTTP method Example form name form6 method post enctype multipart form data action cgi bin hi3510 restore cgi input type file name setting_file input type submit value restore form logsync Function Get the log of system running Privilege admin Usage cgi bin hi3510 param cgi cmd logsync Param None Return None Note 1 This command will read the log from log syslog txt 2 The log ...

Page 68: ...is 554 For example rtsp 192 168 1 108 444 11 2 Include the authorization in the URL rtsp username password IP address port 11 or 12 or 13 For example rtsp admin admin 192 168 1 108 444 11 16 Appendix Appendix I Defines for device type 1 The device type is a 32 bytes ACSII code which is used to distinguish between different devices with different features 2 Each field has 2 bytes The first byte rep...

Page 69: ...080P CMOS 720P Brightness 0 100 Saturation 0 255 Contrast 0 100 Hue 0 100 Sharpness 0 100 Shutter 0 65535 Flip Mirror WDR Night vision mode 1080P The first stream 1080P The second stream Q720P QQ720P The third stream QQ720P Snapshots for mobile phone Q720P QQ720P 720P The first stream 720P The second stream Q720P QQ720P The third stream QQ720P Snapshots for mobile phone Q720P QQ720P h CMOS 720P WD...

Page 70: ... The third stream QQ720P Snapshots for mobile phone Q720P QQ720P k D1 Brightness 0 100 Saturation 0 255 Contrast 0 100 Hue 0 100 Sharpness 0 100 Shutter 0 65535 Flip Mirror Night vision mode The first stream D1 CIF The second stream CIF The third stream CIF Snapshots for mobile phone D1 4 The field for PTZ Z 0 User defined PTZ Up Down Left Right Horizontal Curise Vertical Curise Back to center poi...

Page 71: ...es Georgetown America Sao_Paulo GMT 03 00 Brasilia Atlantic South_Georgia GMT 02 00 Mid Atlantic Atlantic Cape_Verde GMT 01 00 Cape Verde Islands Atlantic Azores GMT 01 00 Azores Islands Europe Dublin GMT Greenwich Mean Time Dublin Edinburgh London Lisbon Africa Casablanca GMT Dj TK Remix Monrovia Reykjavik Europe Amsterdam GMT 01 00 Amsterdam Berlin Berne Roman Stockholm Vienna Europe Belgrade GM...

Page 72: ...Asia Hong_Kong GMT 08 00 Beijing Chongqing Hong Kong Urumchi Asia Irkutsk GMT 08 00 Irkutsk Ulan Bator Asia Kuala_Lumpur GMT 08 00 Kuala Lumpur Singapore Australia Perth GMT 08 00 Perth Asia Taipei GMT 08 00 Taipei Asia Tokyo GMT 09 00 Osaka Sapporo Tokyo Asia Seoul GMT 09 00 Seoul Asia Yakutsk GMT 09 00 Yakutsk Australia Adelaide GMT 09 30 Adelaide Australia Brisbane GMT 10 00 Brisbane Australia ...