VPort 351 CGI Command User`s Manual
Contents
1. VPort 351 CGI Commands User s Manual videolosssch disch Item Action Value Description all G S 1 Event Alarms are active all the Time period of video loss time event alarm action 0 Event Alarms are active based on weekly schedule sunenable G S 0 disable Enable Disable video loss monenable 1 enable event alarm action from tueenable Sunday to Saturday wenenable thuenable frienable satenable sunbegin monbegin G S hh mm Begin time of video loss tuebegin wenbegin event alarm action from thubegin fribegin Sunday to Saturday satbegin sunend monend G S hh mm Duration of video loss tueend wenend event alarm action from thuend friend Sunday to Saturday satend Item Action Value Description all G S 1 Event Alarms are active all the Time period of DI event time alarm action 0 Event Alarms are active based on weekly schedule sunenable G S 0 disable Enable Disable DI event monenable 1 enable alarm action from Sunday tueenable to Saturday wenenable thuenable frienable satenable sunbegin monbegin G S hh mm Begin time of DI event tuebegin wenbegin alarm action from Sunday thubegin fribegin to Saturday satbegin sunend monend G S hh mm Duration of DI event alarm tueend wenend thuend friend satend action from Sunday to Saturday VPort 351 CGI Commands User s Manual motionsch2. sequentialsch Item Action Value Description all G S 1 Event Alarms are active all the Time period of motion time detection event alarm 0 Event Alarms are active based action on weekly schedule sunenable G S 0 disable Enable Disable motion monenable 1 enable detection event alarm tueenable action from Sunday to wenenable Saturday thuenable frienable satenable sunbegin monbegin G S hh mm Begin time of motion tuebegin wenbegin detection event alarm thubegin fribegin action from Sunday to satbegin Saturday sunend monend G S hh mm Duration of motion tueend wenend detection event alarm thuend friend action from Sunday to satend Saturday Item Action Value Description all G S 1 Event Alarms are active all the Time period of sequential time snapshot action 0 Event Alarms are active based on weekly schedule sunenable G S 0 disable Enable Disable sequential monenable 1 enable snapshot action from tueenable Sunday to Saturday wenenable thuenable frienable satenable sunbegin monbegin G S hh mm Begin time of sequential tuebegin wenbegin snapshot action from thubegin fribegin Sunday to Saturday satbegin sunend monend G S hh mm Duration of sequential tueend wenend thuend friend satend snapshot action from Sunday to Saturday VPort 351 CGI Commands User s Manual alarm Item Action Value Descr
3. updateinterval G S 3600 One hour Sync interval with NTP 86400 One day Server 604800 One week 259200 One month firmwareversion G XX yy ZZ Firmware version firmwarebuildtime G yymmddhh Firmware build time do01 G S 0 Close DO Status 1 Open do02 G S 0 Close DO2 Status 1 Open serialnumber G XXXXX Product serial number macaddress G aa bb cc dd ee ff Mac address modelname G VPort 351 Model name Example Change Server Time http videoserver moxanet net moxa cgi setParam cgi system_timemethod 3 amp date yyyy mm dd amp time hh mm ss Set NTP http videoserver moxanet net moxa cgi setParam cgi system_timemethod 4 amp ntpserver bitsy mi t edu amp timezone 8 amp updateinterval 3600 VPort 351 CGI Commands User s Manual systemio Item Action Value Description do01 G S 0 Close DO1 Status 1 Open do02 G S 0 Close DO2 Status 1 Open security Item Action Value Description username0 1 G admin Administrator account userpass01l G S Max 14 char Administrator password userattrO I G talklcamctrlldo1ldo2Iconf Administrator privileges talk Audio Output camctrl PTZ Control dol DO Control do2 DO2 Control conf Configuration username02 to G S Max 16 char User1 to User 10 account username I userpass02 to G S Max 14 char Userl to User10 password userpass11 userattr 02 to G S Camctrlldo 11do2 User1 to User 10 privilege
4. 4 15 NTSC 12 PAL 5 30 NTSC 25 PAL keyinterval G S 5 13 30 60 90 Key frame interval bitrate G S 20 600 Kbps 40 1200 Kbps Video bit rate 60 1800 Kbps 80 2400 Kbps 100 3000 Kbps 120 3600 Kbps 140 4200 Kbps 160 4800 Kbps 180 5400 Kbps quant G S 13 Medium Video quality 11 Standard 8 Good 6 Detailed 4 Excellent quality G S 1 Fixed bit rate Video quality 2 Fixed quality modulation G S 0 Auto auto detection Select video input 1 NTSC modulation format 2 PAL actualmodulation G 1 NTSC The auto detection result of 2 PAL video input Modulation format VPort 351 CGI Commands User s Manual image Item Action Value Description mode S save Save the adjusted image setting into server brightness G S 5 to 5 Video brightness adjustment contrast G S 5 to 5 Video contrast adjustment hue G S 5 to 5 Video hue adjustment saturation G S 5 to 5 Video saturation adjustment audio Item Action Value Description source G S 1 Line in Audio input type 2 Microphone upnp Item Action Value Description enable G S 0 disable UPnP Enable disable UPnP 1 enable UPnP function multicast Item Action Value Description ipaddress G S XXX yYyy ZZZ WWW Media multicast IP address videoport G S 1 to 65535 Video Port amp audio Video multicast port Port Must distance 2 number audioport G S 1 to 65535 Video Port a
5. PA oes Seabee Mees Bea dudes cutis diia birds cure ashes 16 Weft Rights es 16 ZOOMS PCO sniker Sagan sind ideen skeis tiara 16 Home sethome ZOut ZIn FocusNear FocusFar AutoFocus StOP oooooonccncccnocnconcconacancnnccanocnnos 16 NN 16 ACAPLESE A EE E E EET 16 clearpreset addpreset GoPreset ucoriocoonocosinonacosinno condeno see sbouscesunece CREER RARA nera 16 VPort 351 CGI Commands User s Manual Overview This document describes the CGI commands that are used for the MOXA VPort 351 video encoder Commands are included for set get configuration parameters and PTZ control General CGI URL Syntax and Parameters The CGIs are organized in function related directories under the moxa cgi directory and are followed by one of two actions setParam or getParam The file extension of the CGI is required Parameters are written in lower case and composed by section and item parts When the CGI request includes parameters the parameters must be written exactly as shown in this document Syntax http lt servername gt moxa cgi lt action gt cgi lt section gt _ lt item gt lt value gt amp lt section gt _ lt item gt lt value gt Example http videoserver moxanet net moxa cgi setParam cgi http_httpport 80 amp rtsp_rtspport 554 Method GET POST Response HTTP 1 0 200 OK r n Content Type text plain n n lt parameter pair gt where lt parameter palr gt is lt section gt _ lt item gt lt v
6. S 0 10 20 30 40 50 60 70 80 90 Ratio of pre recorded 100 video size to total recorded video size in percentage VPort 351 CGI Commands User s Manual dialarm Item Action Value Description enable G S 0 disable DI alarm Enable disable DI alarm 1 enable DI alarm triggercondO01 G S 0 High DI 01 02 trigger triggercond02 1 Low condition 2 Rising 3 Falling triggerdol 01 G S 0 disable DO1 alarm Enable disable DI 01 02 triggerdol 02 1 enable DO1 alarm trigger DO1 alarm triggerdo2 01 G S 0 disable DO2 alarm Enable disable DI 01 02 triggerdo2 02 1 enable DO2 alarm trigger DO alarm sendviaemail01 G S 0 disable sending snapshot image Enable disable DI 01 02 sendviaemail02 by email trigger to send snapshot 1 enable sending snapshot image images by email by email sendviaftp01 G S 0 disable sending snapshot images Enable disable DI 01 02 sendviaftp02 by ftp trigger to send snapshot 1 enable sending snapshot images images by ftp by ftp motiondetect Item Action Value Description enable G S 0 disable Video Motion Detection Enable disable Video alarm Motion Detection alarm 1 enable Video Motion Detection alarm showalert G S 0 disable show alert on the image Enable disable Show alert when VMD is triggered on the image when VMD 1 enable show alert on the image __ is triggered when VMD is triggered trig
7. VPort 351 CGI Commands User s Manual alarmbasic Item Action Value Description delaysec G S 10 to 99 Alarm tine interval enablebefore G S 0 disable pre alarm snapshot Enable disable pre alarm 1 enable pre alarm snapshot snapshot beforesec G S 1to6 Time before alarm that pre alarm snapshots are active enableafter G S 0 disable post alarm snapshot Enable disable post alarm 1 enable post alarm snapshot snapshot aftersec G S 1 to 999 Time after alarm that post alarm snapshots are active attachdate G S 0 don t suffix date time suffix date time information in snapshot file name information in snapshot 1 suffix date time information in file name snapshot file name enablecustword G S 0 don t suffix customized words in suffix customized words in snapshot file name snapshot file name 1 suffix customized words in snapshot file name customerword G S Max 60 char customized words to append to snapshot file name overriderelay01 G S 0 disable override Relay1 or Enable disable override overriderelay02 Relay2 warning setting Relay1 or Relay2 warning 1 enable override Relay1 or setting Relay2 warning setting sendvideo G S 1 Digital Input 1 Select the event to trigger 2 Digital Input 2 for video recording 3 Motion Detection Area I 4 Motion Detection Area 2 5 Motion Detection Area 3 6 Video Loss maxrecordsize G S 1 2 3 4 5 6 7 8 9 Maximum size of recorded video in MB prerecordsize G
8. VPort 351 CGI Commands User s Manual First Edition February 2007 www moxa com product Moxa Networking Co Ltd Tel 886 2 8919 1711 Fax 886 2 8919 1722 Web www moxa com MOXA Technical Support Worldwide support moxa com The Americas support usa moxa com VPort 351 CGI Commands User s Manual The software described in this manual is furnished under a license agreement and may be used only in accordance with the terms of that agreement Copyright Notice Copyright O 2007 Moxa Networking Co Ltd All rights reserved Reproduction without permission is prohibited Trademarks MOXA is a registered trademark of The Moxa Group All other trademarks or registered marks in this manual belong to their respective manufacturers Disclaimer Information in this document is subject to change without notice and does not represent a commitment on the part of MOXA MOXA provides this document as is without warranty of any kind either expressed or implied including but not limited to its particular purpose MOXA reserves the right to make improvements and or changes to this manual or to the products and or the programs described in this manual at any time Information provided in this manual is intended to be accurate and reliable However Moxa Systems assumes no responsibility for its use or for any infringements on the rights of third parties that may result from its use This product might include unintentional t
9. alue gt n lt parameter pair gt When the action of the CGI command is setParam lt parameter pair gt will not be returned If the CGI command of getParam includes an invalid parameter name the server will not return the value of the invalid parameter When the CGI command of setParam includes an invalid parameter name the server will not return the value of the invalid parameter Example HTTP 1 0 200 OK r n Content Type text plain n n http_httpport 80 n rtsp_rtspport 554 n VPort 351 CGI Commands User s Manual Set Get Configuration Parameter These parameters are used for different VPort 351 function sections The paramers include system information security network video audio and alarm Every section has one or many items The detailed information about sections and items are shown in the following table e Section names are typed in bold face at the top of each table e g system e Paramteres are case sensitive G getParam available S setParam available system Item Action Value Description hostname G S Max 40 char Server name timezone G S 12 to 12 Time zone setting for NTP usage date G S yyyy mm dd date in server time G S hh mm ss time in server timemethod G S 1 Keep current date and time Server time adjustment 2 Sync with computer time method 3 Manual 4 Automatic NTP ntpserver G S Char or IP max length 40 NTP server IP or URL
10. e file extension of the CGI is required The first parameter is move It indicates the command of this request The next parameter is item note that item must be written exactly the same as shown in this document Syntax http lt servername gt moxa cgi lt action gt cgi move lt value gt amp lt item gt lt value gt amp lt item gt lt value gt Example http videoserver moxanet net moxa cgi setPreset cgi move clearPreset amp PresetIndex 6 Method GET POST Response HTTP 1 0 200 OK r n Content Type text plain n n If the parameter of the CGI command includes an invalid value the server will modify the invalid setting to a reasonable value setPTZCtrl This function is used to control the PTZ movement PTZ movement includes Up Down Left Right Home sethome set current position as home tag ZoomSpeed ZOut ZIn FocusNear FocusFar AutoFocu and Stop For different movements the value of move and validate parameters are different The detailed description is classified by the move value and is listed as follows 15 VPort 351 CGI Commands User s Manual Example http videoserver moxanet net moxa cgi setPTZCtrl cgi move Up amp speedtilt 3 Up Down Item Value Description speedtilt 5 to 5 Increase or decrease the tilt speed of PTZ device Left Right Item Value Description speedpan 5 to 5 Increase or decreas
11. e the pan speed of PTZ device ZoomSpeed Item Value Description Speedzoom 5 to 5 Increase or decrease the zoom speed of PTZ device Home sethome ZOut ZIn FocusNear FocusFar AutoFocus Stop These move values do not have item parameters setPreset This function is used to control the preset tag of the PTZ movement There are three move values clearpreset addpreset and GoPreset addpreset is used to add the current PTZ position to a preset tag clearpreset is used to remove a preset tag GoPreset is used to move the PTZ device to a preset position Example http videoserver moxanet net moxa cgi setPreset cgi move GoPreset amp PresetIndex 3 addpreset Item Value Description PresetIndex 1 to 20 Preset position index name Max 15 char Name of preset clearpreset addpreset GoPreset 16 Item Value Description PresetIndex 1 to 20 Preset position index
12. echnical or typographical errors Changes are periodically made to the information herein to correct such errors and these changes are incorporated into new editions of the publication Table of Contents OVE NVI GW seriicccensscncacaacasvanscanacaninanceedh avai satenentacenineaces arain sai aaiTanwa iiasdePiaciaantususeseeadgenadtentanaeeianeea 1 General CGI URL Syntax and Parameters rnvnnnnnnnnvnnnnnnnnnnnnnnnnnnnnnnnnnnvnnennnnnennnnnnnvnnnnnnnnenenn 1 Set Get Configuration Parameter rrrnnnnnnvnnnnnnnnvnnnnnnnnvnnnnnnnvnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnn 2 SM duken ene RUSET 2 SISMO in eee RAR ards BR SoG A fe Bee 3 SCCULILY 352 css hi Seesisese aod ieee dete irene tees Read agin SANN nna N ESE rede Ma AL ets 3 DEW in senere 3 MP AO rai 3 ED ee ea r 4 Sm uden is 4 PtP shee ee ati deren tania a R 4 SR RO 5 VIde0 iii dada dei 5 A NN 6 NN 6 O NN 6 TU A te 6 A NN 7 CUCA os 7 CUSCO Md iii 7 powertatlschy 25 ia Rad 8 TE CWOrk Ren Ke a sii dt ida dd detritos 8 A ROO 9 Ma iia 9 MMOUTONSCH NC TR 10 Sequentlalseh sisi a pi 10 AAPM A ea 11 Sequence canny ansbiess taster E ER R E RARR 11 l rmb ste iia Adige 12 EN NN 13 Dodd tii erir eee E iE E EE RE ee EEE EE EK AER het ESS EE riS EIET Ra a raas 13 Camp ean a o aE rad 14 eventuelt 15 PTZ Control CGI URL syntax and parameterS mrrsevnnnnnnnnvnnnnnnnnvnnnnnnnnnnnnnnnnvnnnnnnnnvnnnnnnnnnen 15 SOUP EZ triks kuna sia oli da 15 Up DOWD tie aske ii Sete eae A
13. gerdo1_01 G S 0 disable trigger Relay I Enable disable VMD 1 2 triggerdol 02 1 enable trigger Relay1 3 trigger Relay alarm triggerdo1 03 triggerdo2 01 G S 0 disable trigger Relay2 Enable disable VMD 1 2 triggerdo2 02 1 enable trigger Relay2 3 trigger Relay2 alarm triggerdo2 03 sendviaemail01 G S 0 disable sending snapshot image Enable disable VMD 1 2 sendviaemail02 by email 3 trigger to send snapshot sendviaemail03 1 enable sending snapshot image images by email by email sendviaftp01 G S 0 disable sending snapshot images Enable disable VMD 1 2 sendviaftp02 by ftp 3 trigger to send snapshot sendviaftp03 1 enable sending snapshot images images by ftp by ftp 13 VPort 351 CGI Commands User s Manual camctrl 14 Item Action Value Description winenableO01 G S 0 disable VMD 1 2 3 Enable disable VMD 1 2 winenable02 1 enable VMD 1 2 3 3 working winenable03 winname01 G S Max 15 char Name of VMD 1 2 3 winname02 winname03 winleftO1 G S Range of values is limited by the The x coordinate of the winleft02 video size left top point of VMD 1 winleft03 2 3 window wintop01 G S Range of values is limited by the The y coordinate of the wintop02 video size left top point of VMD 1 wintop03 2 3 window winwidthO1 G S Range of values is limited by the The width of VMD 1 2 winwidth02 video size and coordina
14. iption enablepowerfail G S 0 disable power fail alarm Enable disable power 1 enable power fail alarm failure alarm triggerpower01 G S 0 disable power failure trigger Enable Disable power 01 triggerpower02 relay alarm 02 failure to trigger relay 1 enable power failure trigger alarm relay alarm poweraction01 G S 1 Relay1 power 01 02 failure poweraction02 2 Relay2 triggers relayl or relay2 alarm powerfailsendemail0 G S 0 disable power failure from Enable Disable power 01 1 triggering alarm by sending mail 02 failure to trigger powerfailsendemail0 1 enable power failure to trigger sending warning mail 2 alarm by sending mail enablenetworkfail G S 0 disable network from Enable disable network to disconnecting alarm disconnect alarm 1 enable network to disconnect alarm triggernetworkfail01 G S 0 disable network disconnect from Enable Disable network triggering relay alarm disconnect to trigger relay 1 enable network disconnect to alarm trigger relay alarm networkfailaction01 G S 1 Relay1 Network disconnect 2 Relay2 triggers relay or relay2 alarm sequential Item Action Value Description enable G S 0 disable sequential snapshot Enable disable sequential 1 enable sequential snapshot snapshot snapshotsec G S 1 to 99999 Sequential snapshot time interval in second sendsnapaction G S 1 Send snapshot image via E mail Snapshot image sent by 2 Send snapshot image via FTP E mail or FTP 11
15. kemd10 instruction VPort 351 CGI Commands User s Manual powerfailsch networkfailsch Item Action Value Description all G S 1 Event Alarms are active all the Time period of Power fail time event alarm action 0 Event Alarms are active based on weekly schedule sunenable G S 0 disable Enable Disable Power fail monenable 1 enable event alarm action from tueenable Sunday to Saturday wenenable thuenable frienable satenable sunbegin monbegin G S hh mm Begin time of Power fail tuebegin wenbegin event alarm action from thubegin fribegin Sunday to Saturday satbegin sunend monend G S hh mm Duration of Power fail tueend wenend event alarm action from thuend friend Sunday to Saturday satend Item Action Value Description all G S 1 Event Alarms are active all the Time period of network time fail event alarm action 0 Event Alarms are active based on weekly schedule sunenable G S 0 disable Enable Disable network monenable 1 enable fail event alarm action tueenable from Sunday to Saturday wenenable thuenable frienable satenable sunbegin monbegin G S hh mm Begin time of network fail tuebegin wenbegin event alarm action from thubegin fribegin Sunday to Saturday satbegin sunend monend G S hh mm Duration of network fail tueend wenend thuend friend satend event alarm action from Sunday to Saturday
16. mp audio Audio multicast port Port Must distance 2 number ttl G S 1 to 255 TTL value of multicast packet VPort 351 CGI Commands User s Manual serial Item Action Value Description camid G S 0 to 255 Camera ID uartmode G S 0 RS232 Uart mode 1 RS485 RS422 baudrate G S 110 300 600 1200 2400 3600 Baudrate bps 4800 7200 9600 19200 38400 57600 databit G S 5 to 8 Data bit stopbit G S 1 1 5 2 Stop bit paritybit G S 0 None Parity bit 1 Odd 2 Even ptzdriver G S 0 None PTZ camera selection 1 Custom Camera 2 Pelco D custcam Item Action Value Description customcmd01 G S Max 60 char Custom Up command customemdO2 G S Max 60 char Custom Down command customemdO3 G S Max 60 char Custom Left command customemdO4 G S Max 60 char Custom Right command customcmd05 G S Max 60 char Custom Zoom in command customcmd06 G S Max 60 char Custom Zoom out command customcmd07 G S Max 60 char Custom Focus near command customcmd08 G S Max 60 char Custom Focus far command customcmd09 G S Max 60 char Custom Home command customemd10 G S Max 60 char Custom Stop command custcommand Item Action Value Description speedlinkname01 to G S Max 8 char User defined command speedlinkname10 name speedlinkcmd01 to G S Max 60 char User defined command speedlin
17. rverip01 G S Max 40 char First and second FTP serverip02 server IP or URL port01 port02 G S 1 to 65535 Port Number of first and second FTP server username01 G S Max 63 char Username of first and username02 second FTP server password01 G S Max 15 char Password of first and password02 second FTP server folder01 folder02 G S Max 40 char Folder path of first and second FTP server pasvmode01 G S 1 enable passive mode Passive mode of first and pasvmode02 0 disable passive mode second SMTP server VPort 351 CGI Commands User s Manual ipfilter video Item Action Value Description allowip01 to G S XXX Yyy ZZZ WWW IP address of Accessible IP allowip10 List 01 to 10 allowmask01 to G S XXX Yyy ZZZ WWW Subnet mask of Accessible allowmask10 IP List O1 to 10 enable G S 1 enable Accessible IP Enable or disable list function Accessible IP list 0 disable Accessible IP list function function Item Action Value Description text G S Max 14 char Information about the video imprinttimestamp G S 0 Not Shown The location of shown 1 Shown on the caption video information 2 Shown on the image size G S 1 720x480 NTSC 720x576 PAL Video resolution 2 640x480 NTSC 640x576 PAL 3 352x240 NTSC 352x288 PAL 4 320x240 NTSC 320x288 PAL maxframe G S 1 I NTSC 1 PAL Maximum frame rate per 2 3 NTSC 3 PAL second 3 LO NTSC 8 PAL
18. s userattr11 Camctrl PTZ Control of PTZ DO1 and DO2 dol DO1 Control control right do2 DO2 Control network Item Action Value Description networktype G S 1 Get IP address automatically Method used to get the IP 2 Use fixed IP address address ipaddress G S XXX VYYy ZZZ WWW IP address subnet G S XXX YYyy ZZZ WWW Subnet mask router G S XXX YVY ZZZ WWW Router IP address dns01 G S XXX YYy ZZZ WWW First DNS IP address dns02 G S XXX YYyy ZZZ WWW Second DNS IP address http Item Action Value Description httpport G S 1 to 65535 http server port number VPort 351 CGI Commands User s Manual rtsp smtp ftp Item Action Value Description rtspport G S 1 to 65535 rtsp server port number udpaccessname G udpStream Rtsp unicast access name multicastaccessname G multicastStream Rtsp multicast access name httpaccessname G udpStream http unicast access name Item Action Value Description serverip01 G S Max 40 char First and second SMTP IP serverip02 or URL username01 G S Max 63 char Username of first and username02 second SMTP server password01 G S Max 15 char Password of first and password02 second SMTP server returnemail01 G S Max 80 char Sender s email address of returnemail02 first and second SMTP server mailto01 mailto02 G S Max 80 char First and second recipient s email address Item Action Value Description se
19. tes of upper 3 window winwidth03 left point of motion window winheight01 G S Range of values is limited by the The height of VMD 1 2 winheight02 video size and coordinates of upper 3 window winheight03 left point of motion window winobjsize01 G S 1 to 100 Threshold to judge the winobjsize02 motion of VMD 1 2 3 winobjsize03 window in percentage winsensitivity G S 1to5 Sensitivity to judge the motion of VMD 1 2 3 window in 5 degrees Item Action Value Description presetname01 to G Max 60 char Name of preset camera presetname20 control position drivers01 to G Max 60 char Name of camera control drivers10 driver VPort 351 CGI Commands User s Manual event Item Action Value Description diO1 status G 0 High Status of di01 and di02 di02status 1 Low do01status G 0 Close Status of do01 and do02 do02status 1 Open powerstatus01 G 0 Disconnected Status of power01 and powerstatus02 1 Connected power02 videostatus G 0 Disconnected Video input connection 1 Connected SALUS audiostatus G 0 Off Audio test switch status 1 On faultstatus G 0 Off Fault LED status 1 On PTZ Control CGI URL syntax and parameters PTZ Control CGIs are used to control the PTZ action of cameras or devices The CGIs are organized in function related directories under the moxa cgi directory and followed by one of two actions set PTZCtrl and setPreset Th
Download Pdf Manuals
Related Search