IP Camera CGI User Manual
Contents
1. m2_enable The second motion detection region 0 KA 1 JAF m2 x Region 2 abscissa m2_y Region 2 Ordinate m2 w Region 2 width m2_h Region 2 height m2_sensitivity Region 2 sensitivity m2_threshold Reserved unused m3_enable The third motion detection region 0 disable 1 enable m3_x Region 3 abscissa m3_y Region 3 Ordinate m3_w Region 3 width www foscam com 28 FOSCAM ShenZhen Foscam Intelligent Technology Co Limited m3 h Region 3 height m3_sensitivity Region 3 sensitivity m3_ threshold Reserved unused m4_enable The fourth motion detection region 0 disable 1 enable 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 Note The region coordinate width and height are based the max resolution of this device Example cgi bin hi3510 param cgi cmd getmdattr param cgi cmd setmdattr Function To set motion detection parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd setmdattr amp enable amp s amp name amp x amp y amp w amp h parameters enable motion detection function 0 disable 1 enable s sensitivity range 0 100 name Alarm region range 1 4 D motion detection region abscissa y motion detection region Ordinate w motion detection region widt2. Function To get SMTP parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd getsmtpattr parameters None Return Value ma_server SMTP server address ma_port Server port ma gel Use SSL 0 disable 1 enable ma_logintype authentication 1 enable 3 disable ma_username username ma_password password ma_from Sender address ma_to Delivery Address ma_subject Mail subject ma_text Mail text Note None Example cgi bin hi35 10 param cgi cmd getsmtpattr param cgi cmd setsmtpattr Function To set SMTP parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd setsmtpattr amp ma_server amp ma_port amp ma _ssl amp ma_logintype amp ma_username amp ma_password amp ma_from amp m a_to amp ma_subject amp ma_text parameters ma_server SMTP server address ma_port Server port ma_ssl Use SSL 0 disable 1 enable www foscam com 40 FH OSCAM ShenZhen Foscam Intelligent Technology Co Limited ma_logintype authentication 1 enable 3 disable ma_username username ma_password password ma_from Sender address ma_to Delivery Address ma_subject Mail subject ma_text Mail text Return Value Success contain Success Failure contain Error Note None Example cgi bin hi35 10 param cgi cmd setsmtpattr amp ma_server stmp sdf com amp m a_from sd1 sdf com amp ma_to al sdf com am
3. lt input type file name setting_file gt lt input type submit value restore gt lt form gt upgrade cgi Function To upgrade system firmware Caution it may damage system Authority admin Syntax cgi bin hi3510 upgrade cgi filename parameters filename Upgrade file name Return Value None Note This CGI only support post method send new firmware to ipcamera Example lt form name form5 method post target retframe enctype multipart form data action cgi bin hi35 10 upgrade cgi gt lt input type file name setting_file gt lt input type submit value upgrade gt lt form gt www foscam com 46 FOSCAM ShenZhen Foscam Intelligent Technology Co Limited 14 LOG logsync cgi Function To get log information Authority admin Syntax cgi bin hi3510 logsync cgi parameters None Return Value None Note Thise CGI refresh the log visit log accesslog txt to view log file text Attention Restart will clear all log file text Example cgi bin hi3510 logsync cgi log accesslog txt cleanlog cgi Function To clear log Authority admin Syntax cgi bin hi3510 cleanlog cgi name parameters name Clear log command access log name Return Value None Note Use this CGI command to clear log when it has too much content Example cgi bin hi35 10 cleanlog cgi name access 15 Appendix
4. 1 Appendix I Used to identify the device type ACSI 32 bytes 2bytes every one field The first byte is the tota type of the field the second byte is the sub type Definition of device type different device has different function of the field field3 field4 LEN P er WA 3 Len field S www foscam com 47 FOSCAM For example ShenZhen Foscam Intelligent Technology Co Limited 0 CMOS VGA QQVGA sub stream QVGA QQVGA Brightness contrast saturation color indoor outdoor IR LED switch flip mirror main stream VGA QVGA 2 CCDD1 Brightness contrast saturation color main stream D1 CIF QCIF sub stream CIF QCIF T CMOS 720P Brightness contrast 1 7 saturation flip mirror QQ720P mobile image size does not support change main stream 720P Q720P QQ720P sub stream Q720P 4 PTZ field Z For example 0 Custom PTZ support PTZ speed up down left right vscan hscan home preset max 8 position does not support setting by serial port does not P 485PTZ can set 485 Property Up down left right zoom in zoom out go presetposition Appendix II Timezone Time zone field Description Etc GMT 12 GMT 12 00 date line west Pacific Apia GMT 11 00 Midway Samoan Islands Pacific Honolulu GMT 10 00 Hawaii America Anchorag
5. can not exceed 16 characters Return Value Success contain Success Failure contain Error Note Attention region_0 time OSD region does not support set name parameters Example cgi bin hi3510 param cgi cmd setoverlayattr amp region 0 amp show 0 cgi bin hi3510 param cgi cmd setoverlayattr amp region 1 amp show 1 amp name IPCam param cgi cmd getmobilesnapattr Function To get mobile snapshot attributes parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd getmobilesnapattr parameters None Return Value msize 1 sub stream max resolution 2 sub stream min resolution Note Some device does not support to change these attributes reference to Appendix I Definition of device type Example cgi bin hi35 10 param cgi cmd getmobilesnapattr param cgi cmd setmobilesnapattr Function To set mobile snapshot attributes parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd setmobilesnapattr amp msize parameters msize 1 sub stream max resolution www foscam com 12 H OSCAM ShenZhen Foscam Intelligent Technology Co Limited 2 sub stream min resolution Return Value 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 setmobi
6. start minute number end time end hour 4 end minute number 1 One minute is split to four time period O number is 0 15 number is 1 30 number is 2 and 45 number is 3 For example If specify a start time of 8 30 then start time 8 4 2 34 If specify a end time of 8 30 then end time 8 4 2 1 33 Note Example cgi bin hi3510 param cgi cmd setschedule amp type event amp ename md amp etm 1 amp workday 0 33 amp weekend none cgi bin hi3510 param cgi cmd setschedule amp type event amp ename md amp etm 2 param cgi cmd getalarmserverattr Function To get alarm server parameters Authority admin Syntax cgi bin hi35 10 param cgil cmd getalarmserverattr parameters None Return Value as_server Server address as_port Server port 1 65535 as_username username as_password password Note None Example cgi bin hi3510 param cgi cmd getalarmserverattr 8 User Management param cgi cmd getuserattr Function To get all user information Authority admin www foscam com 35 FOSCAM ShenZhen Foscam Intelligent Technology Co Limited Syntax cgi bin hi35 10 param cgi cmd getuserattr parameters None Return Value at_name User name at_password password Note This CGI command will return all user infomation for example var at_nameQ admin var at_password0 admin var at _namel us
7. Success contain Success Failure contain Error Note Different device type support different preset number parameters reference to Appendix I Definition of device type Example cgi bin hi35 10 preset cgi act goto amp number 1 cgi bin hi3510 preset cgi act set amp status 1 amp number 1 www foscam com 24 FOSCAM ShenZhen Foscam Intelligent Technology Co Limited param cgi cmd getptzcomattr Function To get PTZ parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd getptzcomattr parameters None Return Value protocal Protocol type 0 PELCO D 1 PELCO P address Address code 0 255 baud Baud rate databit Data width stopbit Stop bit check Parity 0 None 1 odd parity 2 even parity 3 mark 4 space Note Some device does not support this attribute reference to Appendix I Definition of device type Example cgi bin hi3510 param cgi cmd getptzcomattr param cgi cmd setptzcomattr Function To set PTZ parameters Authority admin Syntax egi bin hi35 10 param cgi cmd setptzcomattr amp protocal amp address amp baud amp databit amp stopbit amp check parameters protocal Protocol type 0 PELCO D 1 PELCO P address Address code 0 255 baud Baud rate 1200 2400 4800 9600 19200 38400 57600 databit Data width 7 or 8 www foscam com 25 H OSCAM ShenZhen Foscam Intel
8. 10 param cgi cmd setvencattr amp chn 11 amp bps 1536 amp fps 25 amp brmode 1 amp imagegrade 1 amp gop 50 cgi bin hi35 10 param cgi cmd setvencattr amp chn 12 amp bps 1536 amp fps 25 amp brmode 1 amp imagegrade 1 amp gop 50 www foscam com FOSCAM ShenZhen Foscam Intelligent Technology Co Limited cgi bin hi35 10 param cgi cmd setvencattr amp chn 11 amp bps 1536 amp fps 25 param cgi cmd getimageattr Function To get image parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd getimageattr parameters None Return Value brightness Brightness saturation Saturation contrast Contrast hue Color scene White Balance auto indoor outdoor flip Image flip on off mirror Image mirror on off Note Different device type has different image parameters reference toAppendix I Definition of device type Example cgi bin hi35 10 param cgi cmd getimageattr param cgi cmd setimageatir Function To set image parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd setimageattr amp brightness amp saturation amp c ontrast amp hue amp flip amp mirror amp scene parameters brightness Brightness 0 255 saturation Saturation 0 255 contrast Contrast 0 255 hue Color 0 127 scene White Balance www foscam com FOSCAM ShenZhen Foscam Intelligent Technology Co Limited
9. 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 IP camera support two specific authorization Basic authorization in http protocol Additional parameters directly in the cgi user name and password Cgi methods to access In this article cgi only support get and post method upgrade cgi and restore cgi only support post method Get Example lt form name form2 method get action cgi bin hi35 10 cleanlog cgi gt lt input name cururl type hidden gt lt input name name type hidden value access gt lt form gt Post Example lt form name form5 method post target retframe enctype multipart form data action cgi bin hi35 10 upgrade cgi onSubmit return upgrade gt lt td colspan 3 gt lt input type file name setting_file gt lt input type submit value submit gt lt form gt Value of CGI returned CGI can be divided into two types according to the return value v To get the device status and parameters return the text of device status and parameter if CGI is executed successfully The format of return text is the same as javascript variable defi
10. Casablanca GMT Casablanca Monrovia Reykjavik Europe Amsterdam GMT 01 00 Amsterdam Berlin Bern Rome Stockholm Vienna Europe Belgrade GMT 01 00 Belgrade Bratislava Budapest Ljubljana Prague Europe Brussels GMT 01 00 Brussels Copenhagen Madrid Paris Europe Warsaw GMT 01 00 Sarajevo Skopje Warsaw Zagreb Africa Lagos GMT 01 00 West Central Europe Athens GMT 02 00 Athens Istanbul Minsk Europe Bucharest GMT 02 00 Bucharest Africa Cairo GMT 02 00 Cairo Africa Harare GMT 02 00 Harare Pretoria Europe Helsinki GMT 02 00 Helsinki Kiev Riga Sofia Tallinn Vilnius Asia Jerusalem GMT 02 00 Jerusalem Asia Baghdad GMT 03 00 Baghdad Asia Kuwait GMT 03 00 Kuwait Riyadh Europe Moscow GMT 03 00 Moscow St Petersburg Volgograd Africa Nairobi GMT 03 00 Nairobi Asia Tehran GMT 03 30 Tehran Asia Dubai GMT 04 00 Abu Dhabi Muscat Asia Baku GMT 04 00 Baku Tbilisi Yerevan Asia Kabul GMT 04 30 Kabul Asia Yekaterinburg GMT 05 00 Ekaterinburg Asia Karachi GMT 05 00 Islamabad Karachi Tashkent Asia Calcutta GMT 05 30 Madras Calcutta Mumbai New Delhi Asia Katmandu GMT 05 45 Kathmandu Asia Almaty GMT 06 00 Almaty Novosibirsk Asia Dhaka GMT 06 00 Astana Dhaka Asia Colombo GMT 06 00 Colombo Asia Rangoon GMT 06 30 Rangoon Asia Bangkok GMT 07 00 Bangkok Hanoi Jakarta Asia Krasnoyarsk GMT 07 00 Krasnoyarsk Asia Hong_Kong GMT 0
11. N 60Hz NTSC Return Value Success contain Success Failure contain Error Note Attention Type of CCD Dldevice vinorm setting invalid Attention can identify PAL or NTSC automatically www foscam com FOSCAM ShenZhen Foscam Intelligent Technology Co Limited IVGA resolutionis 640x480 JOVGA resolutionis 320x240 1QQVGA resolutionis 160x112 1D1 resolution is PAL 704x576 NTSC 704x480 1CIF resolution is PAL 352x288 NTSC 352x240 1QCIF resolution is PAL 176x144 NTSC 176x112 1QVGA_ resolution is 320x240 1QQVGA resolutionis 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 Attention Return Value Time consuming operation Example cgi bin hi3510 param cgi cmd setvideoattr amp videomode 3 amp vinorm P cgi bin hi35 10 param cgi cmd setvideoattr amp videomode 33 cgi bin hi3510 param cgi cmd setvideoattr amp vinorm N param cgi cmd getvencattr Function To get video codec parameters Authority admin Syntax cgi bin hi35 10 getvencattr cgi chn parameters chn Stream Number 11 main stream 12 sub stream Return Value bps_1 or bps_2 Bit rate fps_1 or fps_2 Frame rate gop
12. ShenZhen Foscam Intelligent Technology Co Limited 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 amp wf_ssid linksys amp wf_auth 2 amp wf_key 1234567890 amp wf_enc 0 amp wf_mode 0 5 DDNS param cgi cmd get3thddnsattr Function To get DDNS parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd get3thddnsattr parameters None Return Value d3th_enable DDNS 0 disable 1 enable d3th_service DDNS Service providers 0 dyndns org 1 322 0rg 2 dynddns us d3th_uname User name d3th_passwd password d3th_domain Domain name Note None Example cgi bin hi3510 param cgi cmd get3thddnsattr www foscam com 22 FOSCAM ShenZhen Foscam Intelligent Technology Co Limited param cgi cmd set3thddnsatir Function To set DDNS parameters Authority admin Syntax cgi bin hi3510 param cgi cmd set3thddnsattr d3th_enable amp d3th_service amp d3th_uname amp d3th_passwd amp d3th_domain parameters d3th_enable DDNS 0 disable 1 enable d3th_service DDNS Service providers 0 dyndns org 1 322 0rg 2 dynddns us d3th_uname User name d3th_passwd p
13. ShenZhen Foscam Intelligent Technology Co Limited 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 Return Value md_email_switch E mail alarm function on enable off disable md_emailsnap_switch E mail alarm and send image function on enable off disable md_snap_switch Save snapshot to SD card on enable off disable md_record_switch save video to SD card on enable off disable md_ftprec_switch Upload video to FTP server on enable off disable md_relay_switch Relay output on enable off disable Note None Example cgi bin hi3510 param cgi cmd getmdalarm amp aname email amp cmd getmdalar md amp aname emailsnap amp cmd getmdalarm amp aname snap amp cmd getmdalarm amp cmd getmdalarm amp aname record amp cmd getmdalarm amp aname ftprec amp cmd getmdalarm amp aname relay param cgi cmd setmdalarm Function To set alarm linkage parameters Authority admin Syntax cgi bin hi3510 param cgi cmd setmdalarm amp aname amp switch parameters aname Alarm linkage option email E mail alarm emailsnap E mail alarm and send snapshot www foscam com 31 FOSCAM ShenZhen Foscam Intelligent Technology Co Limited snap save snapshot to SD card recor
14. amp dnsstat 0 amp fdnsip 192 168 1 1 amp sdnsip www foscam com FOSCAM ShenZhen Foscam Intelligent Technology Co Limited param cgi cmd gethttpport Function To get HTTP port Authority admin Syntax cgi bin hi35 10 param cgi cmd gethttpport parameters None Return Value httpport HTTP port Note None Example cgi bin hi35 10 param cgi cmd gethttpport param cgi cmd sethttpport Function To config HTTP port Authority admin Syntax cgi bin hi35 10 param cgi cmd sethttpport amp httpport parameters httpport HTTP port range 80 49151 Return Value Success contain Success Failure contain Error Note Device will automatically restart when the configuration is successful Example egi bin hi35 10 param cgi cmd sethttpport amp httpport 80 param cgi cmdz getrtspport Function To get rtsp port Authority admin Syntax cgi bin hi35 10 param cgi cmd getrtspport parameters None Return Value rtspport RTSP port Note None Example cgi bin hi35 10 param cgi cmd getrtspport param cgi cmd setrtspport Function To config RTSP port Authority admin Syntax cgi bin hi3510 param cgi cmd setrtspport amp rtspport www foscam com FOSCAM ShenZhen Foscam Intelligent Technology Co Limited parameters Rtsp port RTSP port range 80 49151 Return Value Success
15. 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 hi35 10 param cgi cmd setimageattr amp brightness 1 amp saturation 1 amp contrast 1 amp hue 1 amp flip on amp mirror on amp scene indoor amp param cgi cmd getoverlayattr Function To get OSDparameters Authority admin Syntax cgi bin hi35 10 param cgi cmd getoverlayattr amp region parameters region region 0 OSD time region 1 OSD name region Return Value x_ region OSD region x Coordinate y_ region OSD region y Coordinate w region OSD region width h_ region OSD region height show_ region OSD show hide 0 hide 1 show name region OSD name Note None Example cgi bin hi35 10 param cgi cmd getoverlayattr amp region 0 www foscam com FOSCAM ShenZhen Foscam Intelligent Technology Co Limited param cgi cmd setoverlayattr Function To set OSD parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd setoverlayattr amp region amp show amp 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 Length
16. scan Wi Fi network Authority admin Syntax cgi bin hi35 10 param cgi cmd searchwireless parameters None Return Value waccess_points Number of Access Point wchannel Channel wrssi Signal strength wessid SSID wenc Encryption wauth Authentication www foscam com 20 FOSCAM ShenZhen Foscam Intelligent Technology Co Limited wnet Connection mode Route mode or peer to peer mode Attention If there are several Access Point waccess points gt 1 This CGI command will return field value of wchannel to wnet except access_points for examples var waccess_points 2 var wchannel new Array var wrssi new Array var wessid new Array var wenc new Array var wauth new Array var wnet new Array wchannel 0 6 wrssi O 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 param cgi cmd chkwirelessattr Function To check Wi Fi parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd chkwirelessattr amp wf_ssid amp wf_auth amp wf _key amp wf_enc amp wf_mode wf_ssid SSID Max 32 english characters wf_auth Encryption 0 None 1 WEP 2 WPA PSK www foscam com 21 FOSCAM
17. 720P 36 IHDQQ720P_1HDQQ720P vinorm P 50Hz PAL N 60Hz NTSC Note Attention 1VGA resolution is 640x480 1QVGA resolution is 320x240 1QQVGA resolutionis 160x112 1D1 resolution is PAL 704x576 NTSC 704x480 www foscam com 6 FOSCAM ShenZhen Foscam Intelligent Technology Co Limited 1CIF resolution is PAL 352x288 NTSC 352x240 1QCIF resolution is PAL 176x144 NTSC 176x112 320x240 160x112 1HD720P resolution is 1280x720 1HDQ720P resolution is 640x352 1HDQQ720P resolution is 320x176 1QVGA resolution is 1QQVGA resolution is 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 hi35 10 param cgi cmd getvideoattr param cgi cmd setvideoattr Function To set video properties main stream sub stream resolution and video format Authority admin Syntax cgi bin hi35 10 param cgi cmd setvideoattr amp videomode amp vinorm parameters videomode 18 1VGA_1QVGA or 1D1_1CIF 19 21 22 24 25 31 32 33 34 35 36 1VGA_1QQVGA or 1D1_1QCIF 1QVGA_1QVGA or 1CIF_1CIF 1QVGA_1QQVGA or 1CIF_1QCIF 1QQVGA_1QVGA or 1QCIF_1CIF 1QQVGA_1QQVGA or 1QCIF_1QCIF 1HD720P_1HDQ720P 1HD720P_1HDQQ720P 1HDQ720P_1HDQ720P 1HDQ720P_1HDQQ720P 1HDQQ720P_1HDQ720P 1HDQQ720P_1HDQQ720P vinorm P 50Hz PAL
18. 8 00 Beijing Chongqing Hong Kong Urumqi Asia Irkutsk GMT 08 00 Irkutsk Ulaanbaatar map Asia Kuala_Lumpur GMT 08 00 Kuala Lumpur Singapore Australia Perth GMT 08 00 Perth www foscam com 49 FOSCAM ShenZhen Foscam Intelligent Technology Co Limited 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 Sydney GMT 10 00 Canberra Melbourne Sydney Pacific Guam GMT 10 00 Guam Port Moresby Australia Hobart GMT 10 00 Hobart Asia Vladivostok GMT 10 00 Vladivostok Asia Magadan GMT 11 00 Majia Disi Qin Solomon Islands New Caledonia Pacific Auckland GMT 12 00 Auckland Wellington Pacific Fiji GMT 12 00 Fiji Kamchatka Marshall Islands Pacific Tongatapu GMT 13 00 Nuku alofa www foscam com 50
19. CAM ShenZhen Foscam Intelligent Technology Co Limited Note None Ezample cgi bin hi3510 param cgi cmd setrelayattr amp time 10 param cgi cmd getschedule Function To get alarm and arming schedule table Authority admin Syntax cgi bin hi3510 param cgi cmd getschedule amp type amp ename parameters type Arming type event ename Alarm type md motion dection Return Value etm Arming time mode 0 All week mode 1 working days rest days mode 2 All time mode workday Arming time period of working days using in working days rest days mode weekend Arming time period of rest days using in working days rest days mode week Every day arming time period in All week mode md_interval Arm time interval Attention There are more groups of alarm schedule table in return value For example var etm 0 var workday 0 95 var weekend 0 95 var week new Array week week 1 0 95 week 2 0 95 week 3 week 4 0 95 week 5 0 95 week 6 var md_interval 0 0 95 Note None Example cgi bin hi3510 param cgi cmd getschedule amp type event amp ename md www foscam com 33 H OSCAM ShenZhen Foscam Intelligent Technology Co Limited param cgi cmd setschedule Function To set alarm and arming schedule table Authority admin Syntax cgi bin hi35 10 param cgi cmd setsched
20. IP Camera CGI User Manual H OSCAM ShenZhen Foscam Intelligent Technology Co Limited TABLE OF CONTENTS Version Release Notes i det EEN e 4 IP ere TEE anced ra e aa e aa E a e 5 T AUCIO VIGO EE 6 param cgi cmd getvideoattr oe eeeceeeeseeeeseeeeseeeeeeseeeeaeeeeseeeeeeseeecseeeseeeeeeeeeesaeeesaeeeeees 6 param cgi cmd setvideoattr ssrin a 7 Tele LE ue Ee NET EE 8 PArAaM COI CMA SETVEN CAL ee eeeeeeeeseeeeceneeeeseeeeseseeseseseeseeesseseeceseeecseeeeaeeesenseesseeeeaeeeeees 9 D tam CO Zemd Oeiimageattt ee eeeecececeseeeeceeeeeeseeeescseeceseeeeseseeaeseeeeseeesaceeeaeeeeeaeeeeaces 10 param cgi cmd setimageattr ue 10 param cgi cmd getoverlayattr eecsceeseeeeeeeeeeseeeeseeeeseeeecseeeeseeeeeeseeeeaeeeeaeeeeeeeeeeeaces 11 param cgi cmd setoverlayattt ce ecesceeseeeeseteeeeteeeeseeeeseeeeeseeeeseeeseseeeeseeeeseeeeeeseeeeaees 12 param cgi cmd getmobilesnapattt oo cee eeseeceseeeeseeseseseeeeseeeseseeeeeeeeeaceeeaeeeeeeaeeeeaces 12 param cgi cmd setmobilesnapattr ce kukawa kaa mukanda wak 12 ParaM cOiP CMA Getaencalltte ue 13 param cgi cmd setaencattr oo ee eeeceeeeteeceseeeeseteeeeseeeeseeeeeceeeeeseeeeaeeeeeeseeeeaeeeeaeteeeaeeeeaees 13 param cgi cmd getaudioiNvolUme mimi iia 14 ParamM cGi CMA SEtAUCIOINVOIUMG w wmwwewumammmamamammammam maimam mimea 14 2 Infrared LED Control IAA Ue ee EES 14 param cgi cmd getinfrared ue 14 param cgi cmd setinfrared eee eeeeeeeecesceceseeeeceseeeescec
21. _1 or gop_2 Main frame interval brmode_1 or brmode_2 Video coding control 0 Fixed rate 1 Variable bit rate imagegrade_1 or imagegrade_2 video encoding quality width_1 or width 2 Video width height_1 or height_2 Video height www foscam com H OSCAM ShenZhen Foscam Intelligent Technology Co Limited Note Attention Suffix _1 is main stream parameters Suffix _2 is sub stream parameters Example cgi bin hi35 10 getvencattr cgi chn 11 param cgi cmd setvencatir Function To config video codec parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd setvencattr amp chn amp bps amp fps amp brmode amp imagegrade amp gop parameters chn Channel number 11 main stream 12 sub stream bps Bit Rate 720P range 1024 6144 kbps D1 range 32 2048 kbps CIF range 32 512 kbps QCIF range 32 256 kbps QVGA range 32 512 kbps VGA range 32 2048 kbps OOVGA range 32 256 kbps fps Frame rate PAL range 1 25 NTSC range 1 30 brmode Video coding control 0 Fixed rate 1 Variable bit rate imagegrade video encoding quality range 1 6 AttentionThe smaller the value the better the image quality the larger the stream control gop Main frame interval range 2 150 Return Value Success contain Success Failure contain Error Note None Example cgi bin hi35
22. as_enable 1 amp as_interval 60 amp as_type 5 10 FTP param cgi cmdz getftpattr Function To get FTP parameters Authority admin www foscam com 38 FOSCAM ShenZhen Foscam Intelligent Technology Co Limited 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 hi35 10 param cgi cmd getftpattr param cgi cmdz setftpattr Function To set FTP parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd getftpattr amp ft_server amp ft_port amp ft_user name amp ft_password amp ft_mode parameters 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 path is Return Value Success contain Success Failure contain Error Note None Example cgi bin hi35 10 param cgi cmd setftpattr amp ft_server 220 112 14 173 amp ft_ port 2 amp ft_username FTPUsername amp ft_password FTPPassword amp ft_mod e 1 amp ft_dirname abc www foscam com 39 FOSCAM ShenZhen Foscam Intelligent Technology Co Limited 11 SMTP param cgi cmd getsmtpattr
23. assword d3th_domain Domain name Return Value Success contain Success Failure contain Error Note None Example cgi bin hi3510 param cgi cmd set3thddnsattr amp d3th_enable 1 amp d3th_servic e 1 amp d3th_uname sample amp d3th_passwd 1234 amp d3th_domain sample dyn dns org 6 PTZ ptzctrl cgi Function To control PTZ Authority admin and user Syntax cgi bin hi35 10 ptzctrl cgi step amp act amp speed parameters step Step Mode 0 After step run PTZ needs new CGI command to stop 1 After step run PTZ stop automatically act Control command string for example left www foscam com 23 FOSCAM ShenZhen Foscam Intelligent Technology Co Limited right up down home zoom in zoom out hscan vscan stop speed PTZ speed range 1 63 Return Value 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 hi35 10 ptzctrl cgi step 0 amp act left amp speed 45 preset cgi Function To preset PTZ Authority Admin and user Syntax cgi bin hi3510 preset cgi act amp status amp number parameters act Command goto go to preset position set set preset position status Preset command 0 clear 1 save number Preset position number Return Value
24. cmd getdevtype Function To get device type information Authority admin Syntax cgi bin hi35 10 param cgil cmd getdevtype parameters None Return Value devtype Note reference to Appendix I Definition of device type Example cgi bin hi35 10 param cgi cmd getdevtype www foscam com 42 FOSCAM ShenZhen Foscam Intelligent Technology Co Limited param cgi cmd getstreamnum Function To get online user number Authority admin Syntax cgi bin hi35 10 param cgi cmd getstreamnum parameters None Return Value user_num online user number for example var stream_num 1 Note None Example cgi bin hi35 10 param cgi cmd getstreamnum param cgi cmd getservertime Function To get system time Authority admin Syntax cgi bin hi35 10 param cgi cmd getservertime parameters None Return Value time Current date and time yyyy mm dd hh mm ss time 20110802182638 timeZone Time zone timeZone Asia Hong_Kong dstmode Daylight saving adjust on enable off disable Note None Example cgi bin hi35 10 param cgi cmd getservertime param cgi cmd setservertime Function To set system time Authority admin Syntax cgi bin hi35 10 param cgi cmd setservertime amp time amp timezone amp dstmod e parameters stime Current date and time yyyy mm dd hh mm ss 2011 08 23 10 35 08 timezon
25. contain Success Failure contain Error Note Device will automatically restart when the configuration is successful Example cgi bin hi35 10 param cgi cmd setrtspport amp rtspport 554 param cgi cmdz getinternetip Function To inquiry the Internet IP address of this device Authority admin Syntax cgi bin hi35 10 param cgi cmd getinternetip parameters None Return Value internetip Web IP address for example var internetip 220 112 14 173 Note None Example cgi bin hi35 10 param cgi cmd getinternetip param cgi cmd getupnpattr Function To get UPNP parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd getupnpattr parameters None Return Value upm_enable UPNP port map 0 disable 1 enable Note None Example cgi bin hi35 10 param cgi cmd getupnpattr param cgi cmd setupnpattr Function To set UPNP parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd setupnpattr amp upm_enable parameters upm_enable UPNP port map 0 disable 1 enable www foscam com FOSCAM ShenZhen Foscam Intelligent Technology Co Limited Return Value Success contain Success Failure contain Error Note None Ezample cgi bin hi3510 param cgi cmd setupnpattr amp upm_enable 1 4 Wi Fi setting param cgi cmd getwirelessattr Function To get wif
26. d 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 Please be sure to insert SD card enable save snapshot and save video in order to upload video to FTP server Example cgi bin hi3510 param cgi cmd setmdalarm amp aname email amp switch off amp cm d setmdalarm amp aname emailsnap amp switch off amp cmd setmdalarm amp aname ftprec amp switch off amp cmd setmdalarm amp aname snap amp switch off amp cmd set mdalarm amp aname record amp switch off amp cmd setmdalarm amp aname relay amp s witch off param cgi cmdz getrelayattr Function To get alarm linkage relay output time Authority admin Syntax cgi bin hi35 10 param cgi cmd getrelayattr parameters None Return Value time Output time s for examplevar time 10 Note None Example cgi bin hi35 10 param cgi cmd getrelayattr param cgi cmd setrelayattr Function To set alarm linkage relay output time Authority admin Syntax cgi bin hi35 10 param cgi cmd setrelayattr amp time parameters time Output time s range 5 10 20 30 Return Value Success contain Success Failure contain Error www foscam com 32 FOS
27. e GMT 09 00 Alaska America Los_Angeles GMT 08 00 Pacific Time US and Canada America Denver GMT 07 00 Mountain Time US and Canada America Tegucigalpa GMT 07 00 Chihuahua La Paz Mazatlan America Phoenix GMT 07 00 Arizona 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 and Canada America Bogota GMT 05 00 Bogota Lima Rio Branco America Santiago GMT 04 00 Santiago America Caracas GMT 04 00 La Paz America Montreal GMT 04 00 Atlantic Time Canada America St_Johns GMT 03 30 Newfoundland America Thule GMT 03 00 Greenland www foscam com 48 H OSCAM ShenZhen Foscam Intelligent Technology Co Limited America Buenos_Aires GMT 03 00 Buenos Aires 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 Europe Dublin GMT Greenwich Mean Time Dublin Edinburgh London Lisbon Africa
28. e Time zone timeZone Asia Hong_Kong www foscam com 43 FOSCAM ShenZhen Foscam Intelligent Technology Co Limited Attention Please reference to Appendix I Time zone about time zone dstmode Daylight saving adjust on enable off disable Return Value Success contain Success Failure contain Error Note Not all time zone can adjust time automaticly in daylight saving time Example cgi bin hi35 10 param cgi cmd setservertime amp time 2011 08 23 10 35 08 amp t imezone Asia 2FHong_Kong amp dstmode off param cgi cmd getntpattr Function To get NTP parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd getntpattr parameters None Return Value ntpenable NTP 1 enable 0 disable ntpserver NTP server time nist gov time kriss re kr time windows com time nuri net ntpinterval Synchronized interval Note None Example cgi bin hi35 10 param cgi cmd getntpattr param cgi cmd setntpattr Function To set NTP parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd setntpattr amp ntpenable amp ntpserver amp ntpint erval ntpenable NTP www foscam com 44 FOSCAM ShenZhen Foscam Intelligent Technology Co Limited 1 enable 0 disable parameters ntpserver NTP server time nist gov time kriss re kr time windows com time nuri net ntpi
29. ec eeseeseseeeecesseeeseeeeseeeeeeseeeeaeeeeeseeeeseeeeaeeeeeseeeeaees 37 param cgi cmd setsnaptimeratt ee eeceeeseseeseseeeeseeeeseeeecseeeaeseeeeeeeeeaceesaeeeeeeeeeeaees 38 OF UE 38 param cgi cmd getftpattr oo eeeeeeeeeeceseeeeeeteeeeseeeeseeeeceeeecseeeeseeeeeseeeeaceeeaeeeseeeeeeeaees 38 Param cgi cma Setttpatt EE 39 LOS RRE 40 Param cgi CMA GetsSMtpalte scierie e e 40 param cgi20MdESHS MPA EE 40 12 SD Card ITT e Ha eienen ese 41 SA AA aa 41 Ee tele Ee cccivensassisntuescevascenssescansavetaycusevaacesesusdveasesatesse dacestusnarepiventmand wakikaa 41 13 System parameter settnge sii 42 param cgi cmd getserverinfo zi 42 D tam CO Zemd Oetdevivpe eee eeeecceeeccsseceseeeeseseeecseeeescseeeesesecscseeacseseeseeeaceeeaeeeeeeaseeaees 42 D tam CO Zemd Oetstreamnmum misi sia 43 param cgi cmd getservertime EEN 43 param cgi cmd setservertime eeeceeeecesceceseeeeseeeeeeseeeseseeceseseeseseeaeseeeeseeeaceeeaeeeeeeseeeeaees 43 param cgi cmd getntpattr oe ee ecececseeceseeeeeeeeeeeeeeeseeeeeeeeecseeeeaeeeeeeeeeeeaceeeaeeeeeeeeeeaees 44 Ell e Ree ue Eu EE 44 www foscam com 3 FOSCAM ShenZhen Foscam Intelligent Technology Co Limited Kaye SAA E e ie Be EE Ee Eu EE Appendix II Time zone Version Release Notes Version Author Date Modified 1 0 Himmy Ho 2011 07 30 The first version 1 1 Franck Zhao 2011 09 08 Revised www foscam com H OSCAM ShenZhen Foscam Intelligent Technology Co Limited IP
30. er var at_password1 user var at_name2 guest var at_password2 guest Example cgi bin hi35 10 param cgi cmd getuserattr param cgi cmd setuseratir Function To set user management parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd setuserattr amp at_username amp at_password parameters at_username username parameters must be admin user guest at_password password parameters max length must be less then 16 Return Value Success contain Success Failure contain Error Note None Example cgi bin hi3510 param cgi cmd setuserattr amp at_username admin amp at_passwo rd admin getsetupflag cgi Function To get admin parameters Authority admin Syntax cgi bin hi35 10 getsetupflag cgi parameters None Return Value nameO name password0O password authLevel0 reversed www foscam com 36 FOSCAM ShenZhen Foscam Intelligent Technology Co Limited Note None Ezample cgi bin hi35 10 getsetupflag cgi getstreamflag cgi Function To get guest parameters Authority guest Syntax cgi bin hi3510 getstreamflag cgi parameters None Return Value name2 name password2 password authLevel2 reversed Note None Example cgi bin hi3510 getstreamflag cgi getptzflag cgi Function To get user parameters Authority
31. escseeceseecseseeaeseeeeaeeeeaceeeaeseseeeeeeeaces 15 ENKEN 15 Paral LE Ee Ein EE 15 Param cgi cma Setnetatt EEN 16 param cgi cmd gethttpport ee eeeeeececseeceseeeeeeeeeeeseeeeseeeeeseeecseeeacseeeeeeeeeaceeeaeeeeeaeeeeaees 17 Paramicgi cMaA Sethttpport edd emacs cedar 17 param cgi cmd getrtSpport 0 eee eeeeceeecesceeeseeeeceseeeeseeeescseeceseeecsesesaeseeeeaceesaceeeaeeeeeeaeeeeaces 17 PArAM COI CMA SEttSPPOIT sue 17 param cgi cmd getinternetip 0 eeeesceceseeeeceeeeeeeeeeseeeeseeeecseeeseeeeeeeeeeaceesaeeeseeaeeeeaees 18 param cgi cmd get pnpattr siise iiini ia 18 Dram G CMA SetUPN PAU Estelle 18 TEE ul BE 19 param cgi cMd Getwirelessatt oo eeeeseeseeeeeceseeeeseeeeseseeeeseeeseeseeseeeeaceeeaeeeeeeeeeeeaees 19 param cgi Zemd setwirelessaitr mimi nii 19 D tam CO ZCmd searchwireless A 20 Pparam cgi CMA ChkwireleSSatt ee ecceeseeseeeeeeeseeeeseeeeceeeeeseeeeaeeeeeeseeeeseeeeseeeeeeeeeeaees 21 a BB LE 22 param cgi cmd get3thddnsattr sessioissa 22 param cgi cmd setsthddns attr EE 23 CN EE 23 EZ CU e EE 23 Preset CON cic ccccti seatctacpiacscunsasgersoncteeleeda saline E e S Ea ENEE Si Saale ial eee eas 24 param cgi cmd getptzcomattr oe eecececsseeeeceeeeeeeeeeseeeseseeecseeeaceeeeseeesaceeeaeeeeeeeeeeeaees 25 param cgi cmd setptzoomattr on eeceececeseeeeceteeeeseeeesceeeeeseeeeseeeeaeeeeeseeesaeeeeseeeeeeeeeeeaees 25 www foscam com 2 H OSCAM ShenZhen Foscam Intelligent Technology Co Limited 0 P74 oF o
32. h h motion detection region height Return Value Success contain Success Failure contain Error Note The region coordinate width and height are based the max resolution of this device Example cgi bin hi35 10 param cgi cmd setmdattr amp enable 1 amp s 50 amp name 1 amp x 0 amp y 0 amp w 60 amp h 60 www foscam com 29 FOSCAM ShenZhen Foscam Intelligent Technology Co Limited param cgi cmd getioattr Function To get alarm IO parameters Authority admin Syntax cgi bin hi35 10 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 hi35 10 param cgi cmd getioattr param cgi cmdz setioattr Function To set alarm IO parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd setioattr amp io_enable amp io_flag parameters i0_enable Alarm IO 0 disable 1 enable io_flag Alarm IO mode 0 NC 1 NO Return Value Success contain Success Failure contain Error Note None Example cgi bin hi35 10 param cgi cmd setioattr amp io_enable 0 amp io_flag 1 param cgi cmd getmdalarm Function To get alarm linkage parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd getmdalarm amp aname parameters aname option www foscam com 30 FOSCAM
33. i parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd getwirelessattr parameters None Return Value wf_enable Wifi Switch 0 Turn off 1 Turn on wf_ssid SSID Max 32 english characters wf_auth Encryption 0 None 1 WEP 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 Note None Ezample cgi bin hi3510 param cgi cmd getwirelessattr param cgi cmd setwirelessattr Function To set Wi Fi parameters Authority admin www foscam com 19 FOSCAM ShenZhen Foscam Intelligent Technology Co Limited Syntax cgi bin hi3510 param cgi cmd setwirelessattr amp wf_enable amp wf_ssid amp w f_auth amp wf_key amp wf_enc amp wf_mode parameters Return Value wf_enable Wifi Switch 0 Turn off 1 Turn on wf_ssid SSID Max 32 english characters wf_auth Encryption 0 None 1 WEP 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 Success contain Success Failure contain Error Note None Ezample cgi bin hi3510 param cgi cmd setwirelessattr amp wf_ssid linksys amp wf_enable 1 amp wf_auth 2 amp wf_key 1234567890 amp wf_enc 0 amp wf_mode 0 param cgi cmd searchwireless Function To
34. lesnapattr amp msize 1 param cgi cmd getaencattr Function To get audio codec parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd getaencattr amp chn parameters chn Channel number 11 main stream 12 sub stream Return Value Audio Codec Switch 0 dissable aeswitch_1 or aeswitch_2 1 enable Audio Codec Format g71la G711 g726 G726 16Kbps aeformat 1 or aeformat_2 a law 64Kbps Note _1 is main stream _2 is sub stream Audio Sampling rate 8K Mono 16 bit Example cgi bin hi35 10 param cgi cmd getaencattr amp chn 1 1 param cgi cmd setaencattr Function To set audio codec parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd setaencattr amp chn parameters chn Channel number 11 main stream 12 sub stream aeswitch Audio Codec Switch 0 dissable 1 enable aeformat Audio Codec Format www foscam com FOSCAM ShenZhen Foscam Intelligent Technology Co Limited g7lla 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 amp chn 1 1 amp aeswitch 0 cgi bin hi3510 param cgi cmd setaencattr amp chn 12 amp aeswitch 1 amp aeform at g726 param cgi cmd getaudioinvolume Functi
35. ligent Technology Co Limited stopbit Stop bit lor 2 check Parity 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 hi35 10 param cgi cmd setptzcomattr amp protocal 0 amp address 1 amp bau d 9600 amp databit 8 amp stopbit 1 amp check 0 ptzup cgi Function To control PTZ upward movement for mobile Authority admin and user Syntax cgi bin hi35 10 ptzup cgi parameters None Return Value Success contain Success Failure contain Error Note None Example cgi bin hi35 10 ptzup cgi ptzdown cgi Function To control PTZ downward movement for mobile Authority admin and user Syntax cgi bin hi3510 ptzdown cgi parameters None Return Value Success contain Success Failure contain Error Note None Example cgi bin hi3510 ptzdown cgi ptzleft cgi Function To control PTZ left movement for mobile www foscam com 26 H OSCAM ShenZhen Foscam Intelligent Technology Co Limited Authority admin and user Syntax cgi bin hi35 10 ptzleft cgi parameters None Return Value Success contain Success Failure contain Error Note None Example cgi bin hi35 10 ptzlef
36. nce to Appendix I Definition of device type Example cgi bin hi35 10 param cgi cmd setinfrared amp infraredstat auto 3 Network param cgi cmdz getnetattr Function To get network parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd getnetattr parameters None Return Value dhcpflag DHCP on enable off disable ip IP address netmask XXX XXX XXX XXX gateway XXX XXX XXX XXX www foscam com FOSCAM ShenZhen Foscam Intelligent Technology Co Limited dnsstat DNS status 0 manual 1 auto fdnsip Primary DNS sdnsip The second DNS macaddress MAC address networktype Network type LAN WiFi Note None Example cgi bin hi35 10 param cgi cmd getnetattr param cgi cmd setnetattr Function To config LAN parameters of device Authority Admin Syntax cgi bin hi35 10 param cgi cmd setnetattr amp dhcp amp ipaddr amp netmask amp g ateway amp dnsstat amp fdnsip amp sdnsip parameters dhcp DHCP on enable off disable ipaddr IP address netmask XXX XXX XXX XXX gateway XXX XXX XXX XXX dnsstat DNS status 0 manual 1 auto fdnsip Primary DNS sdnsip The second DNS Return Value Success contain Success Failure contain Error Note None Example cgi bin hi35 10 param cgi cmd setnetattr amp dhcp off amp ipaddr 192 168 1 88 amp netmask 255 255 255 0 amp gateway 192 168 1 1
37. nition For example r bps_1 2048 r fps 12725 r gop 12750 var brmode 1271 r imagegrade 1 1 r width_1 704 r height_1 576 www foscam com 5 FOSCAM ShenZhen Foscam Intelligent Technology Co Limited Return error message if failed for example Error Get video attribution error errcode is 0xal0e6008 v 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 v You could put the CGI string into Web Browser to test the CGI such as http 192 168 1 88 cgi bin hi35 10 param cgi cmd getvencattr amp chn 11 http 192 168 1 6 cgi bin hi35 10 param cgi cmd setvencattr amp chn 11 amp fps 15 http 192 168 1 6 cgi bin getwifi cgi 1 Audio Video param cgi cmd getvideoattr Function To get video properties main stream sub stream resolution and video format Authority admin Syntax cgi bin hi3510 param cgi cmd getvideoattr parameters none Return Value videomode 18 1VGA_1QVGA or 1D1_1CIF 19 1VGA_1QQVGA or 1D1_1QCIF 21 1QVGA_1QVGA or 1CIF_1CIF 22 1QVGA_1QQVGA or 1CIF_1QCIF 24 1QQVGA_1QVGA or 1QCIF_1CIF 25 1QQVGA_1QQVGA or 1QCIF_1QCIF 31 1HD720P_1HDQ720P 32 1HD720P_1HDQQ720P 33 1HDQ720P_1HDQ720P 34 1HDQ720P_1HDQQ720P 35 IHDQQ720P_1HDQ
38. nterval Synchronized interval range 1 24 hour Return Value Success contain Success Failure contain Error Note None Example cgi bin hi35 10 param cgi cmd setntpattr amp ntpenable 1 amp ntpinterval 2 amp ntp server time nuri net sysreset cgi Function To restore factory default Authority admin Syntax cgi bin hi35 10 sysreset cgi parameters None Return Value None Note None Example cgi bin hi35 10 sysreset cgi sysreboot cgi Function To restart system Authority admin Syntax cgi bin hi35 10 sysreboot cgi parameters None Return Value None Note None Example cgi bin hi35 10 sysreboot cgi backup cgi Function To backup configuration data www foscam com 45 H OSCAM ShenZhen Foscam Intelligent Technology Co Limited Authority admin Syntax cgi bin hi35 10 backup cgi parameters None Return Value None Note None Example cgi bin hi35 10 backup cgi restore cgi Function To restore configuration data Authority admin Syntax cgi bin hi35 10 restore cgi setting_file parameters setting file System config file Return Value None Note Example This CGI only support post method send backup config file to ipcamera lt form name form6 method post enctype multipart form data action cgi bin hi35 10 restore cgi gt
39. o Preece weer ree rer per teeter ete PTT Pe Carpe ery reece rene rer ureter re ter were erp re Terre E 26 PZdOWN seinen ch eaten iii en seeks ene oneal aan esis 26 DEE 26 ous ld ese cieckcacesecinesdeaatiatercaatece E ite tetaeanielaaread 27 PIZZOOMUMCO LEE 27 PIZZOOMOUL COlii E 27 7 Motion detection and I O Alarm eeeesecesseseeesesesseeeseeeesceeescseeeeseesacsesacseeseaeeeeaceeaeeeeeatees 28 Tue Ee ue De Eu un E 28 patam egi 20 Mda EE 29 param cgi cmd getioatti siessen i a i e 30 param cgi cmd Setioattr lt ww w w wmwowemmmammnmamamamu mwm m maimam mmi 30 ParAaM cOi CMA GeEtMAAlarM aa Wawaasa 30 param cgi cmd setmdalarm mwm 31 param cgi cmd getrelayattr oe eeesceceseeseceteseeeeeeseeeeseeeecseeeeseeeeseseeeeseeeeseeeeeeeeeeeaees 32 param cgi cmd setrelayattr 2 ee eeeceesceceseeeeceeeeeeseeeeseseeseeeseeseeeeaeeeeeaeeeeaceeeaeeeseeeeeeeaees 32 Param cgi CMA GetSChedule eceeccsesesesecesseceseececcececcseeeesceceaeseeessceeeeceeeaeeeesseeetaees 33 Paraln Cgii CMA SeEtSCHECU EE 34 param cgi cmd GetalarMServer Alt eecceecseeceteeeeseeeeeceeeeeseeeesceeeeeseeeeseeeeaeeeeeeeeeeaees 35 8 User Management EEN EEN 35 pa aram cgi cmd get serattr iets cessseseassduaaren tate tastier divsinen ciated qeieredateness 35 param cgi cmd setuserattr ww w wmmwowemumammawamamamumm mmama 36 E lee Re LE 36 EE unt Le Bee EE 37 e tee D E 37 O TIMO SMa hO EE 37 param cgi cmd getsnaptimMeratt oe
40. on To get volume value Authority admin Syntax cgi bin hi35 10 param cgi cmd getaudioinvolume parameters None Return Value volume Range 1 127 Note None Example cgi bin hi35 10 param cgi cmd getaudioinvolume param cgi cmd setaudioinvolume Function To set volume value Authority admin Syntax cgi bin hi35 10 param cgil cmd setaudioinvolume amp volume parameters volume Range 1 127 Return Value Success contain Success Failure contain Error Note None Example cgi bin hi35 10 param cgi cmd setaudioinvolume amp volume 100 2 Infrared LED Control param cgi cmdz getinfrared Function To get Infrared LED parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd getinfrared www foscam com FOSCAM ShenZhen Foscam Intelligent Technology Co Limited parameters None Return Value infraredstat 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 hi35 10 param cgi cmd getinfrared param cgi cmd setinfrared Function To set Infrared LED parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd setinfrared parameters None Return Value infraredstat Infrared LED Status auto open close Note Some device does not support to change these attributes refere
41. p ma_subject demosubject amp ma_text demotext amp ma_logintype 1 amp ma_username demo amp ma_passwor d 123456 amp ma_port 25 amp ma_ssl 0 12 SD Card manipulation sdfrmt cgi Function To format SD card to FAT32file system Authority admin Syntax cgi bin hi3510 sdfrmt cgi parameters None Return Value Format SD Card Success Note Please wait for a long time Example cgi bin hi3510 sdfrmt cgi sdstop cgi Function To stop use SD card Authority admin Syntax cgi bin hi3510 sdstop cgi parameters None Reuni Value Stop SD Card Success www foscam com 41 H OSCAM ShenZhen Foscam Intelligent Technology Co Limited 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 hi35 10 param cgi cmd getserverinfo parameters None Return Value model Device serial number hardVersion H W version softVersion S W version name Device name startdate System start time runtimes Reversed sdstatus SD card status out NoneSD Ready ready to use Readonly SD card only support to read sdfreespace SD card free space KB sdtotalspace SD card total capacity KB Note None Example cgi bin hi35 10 param cgi cmd getserverinfo param cgi
42. t cgi ptzright cgi Function To control PTZ right movement for mobile Authority admin and user Syntax cgi bin hi35 10 ptzright cgi parameters None Return Value Success contain Success Failure contain Error Note None Example egi bin hi35 10 ptzright cgi ptzzoomin cgi Function To zoom in for mobile Authority admin and user Syntax cgi bin hi3510 ptzzoomin cgi parameters None Return Value Success contain Success Failure contain Error Note None Example cgi bin hi3510 ptzzoomin cgi ptzzoomout cgi Function To zoom out for mobile Authority admin and user Syntax cgi bin hi35 10 ptzzoomout cgi parameters None Return Value Success contain Success www foscam com 27 FOSCAM ShenZhen Foscam Intelligent Technology Co Limited Failure contain Error Note None Ezample cgi bin hi35 10 ptzzoomout cgi 7 Motion detection and I O Alarm param cgi cmd getmdattir Function To get motion detection parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd getmdattr parameters None Return Value ml enable The first motion detection region 0 disable 1 enable ml_x Region 1 abscissa ml_y Region 1 Ordinate ml_w Region 1 width ml h Region height m1_sensitivity Region 1 sensitivity m1_threshold Reserved unused
43. ule amp type amp ename amp etm amp wor kday amp weekend amp week0 amp week1 amp week2 amp week3 amp week4 amp we ek5 amp week6 parameters type Arming type event ename Alarm type md motion dection etm Arming time mode 0 All week mode 1 working days rest days mode 2 All time mode workday Arming time period of working days Format start time end time weekend Arming time period of rest days Format start time end time week0 Arming time period on Monday Format start time end time week1 Arming time period on Tuesday Format start time end time week2 Arming time period on Wednesday Format start time end time week3 Arming time period on Thursday Format start time end time week4 Arming time period on Friday Format start time end time week5 Arming time period on Saturday Format start time end time week6 Arming time period on Sunday Format start time end time 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 www foscam com 34 H OSCAM ShenZhen Foscam Intelligent Technology Co Limited The calculation method of these start and end time field are If time is 0 hour 0 miniute it will be set to none Other cases according to the following formula strart time start hour 4
44. user Syntax cgi bin hi35 10 getptzflag cgi parameters None Return Value namel name password password authLevel1 reversed Note None Example cgi bin hi35 10 getptzflag cgi 9 Time Snapshot param cgi cmd getsnaptimerattr Function To get time snapshot parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd getsnaptimerattr parameters None Return Value as_enable Time Snapshot www foscam com 37 FOSCAM ShenZhen Foscam Intelligent Technology Co Limited 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 Note None Example cgi bin hi35 10 param cgi cmd getsnaptimerattr param cgi cmd setsnaptimerattr Function To set time snapshot parameters Authority admin Syntax cgi bin hi35 10 param cgi cmd setsnaptimerattr amp as_enable amp as_interval amp as_type parameters 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 Return Value Success contain Success Failure contain Error Note 3 parameters must be used together Example cgi bin hi35 10 param cgi cmd setsnaptimerattr amp
Download Pdf Manuals
Related Search