Page 1
Sharx Security
HTNC Series PoE IP Camera
API Reference Manual
2018 Version
Page 2
-2-
Introduction
This reference guide is for programmers wishing to send commands directly to a Sharx Security
HTNC series PoE IP camera.
Some commands also return detailed status information from the camera.
To use this reference guide you’d need to have administrator login access to an HTNC series camera
that is already set up for your network (or accessible to you remotely). It is also assumed that you
know the basics of writing a program or a script to send commands via HTTP.
Many commands can be tested easily by copying and pasting the example into a brower, while of
course substituting your own camera’s IP address for the parameter shown as ”camera ipaddress”
For example, let’s assume your camera is set up on 192.168.0.54, and you wish to obtain the current
settings for the camera’s time, then change the time zone, and then verify that the change took effect.
Then, according to the section on setting time parameters on page 158 of this user’s guide, you
would construct the query string as follows, and you could test it by pasting into your browser:
http://192.168.0.54/system/time.php?app=get
Then once you provide the proper login credentials to the camera, you’d get a long result string
starting with the following:
res=200&tsyncmode=2&dt=2018-07-29&tm=10:03:40&tzone=13&dst_enable=1
The res=200 means you got a valid result, and the rest of the response is explained on page 158
Should you wish to change a setting, such as setting time zone to Pacific Time, you’ll find in the
table that Pacific Time has the time zone code 4, and you’d set that with a command such as the
following:
http://192.168.0.54/system/time.php?app=set&tzone=4
Again you’d be looking for a valid response as designated with the result code 200, and you can
then double check that it took effect by issuing the query again:
http://192.168.0.54/system/time.php?app=get
And now the result is:
res=200&tsyncmode=2&dt=2018-07-29&tm=07:11:05&tzone=4&dst_enable=1
At times this manual refers to the Sony chipset name that is used in our cameras.
Xarina, also known as X2, is the chipset used in our HTNC4400 series of full HD 60 fps cameras
while Xarina Pro, also known as X4, is used in our HTNC4500 series of 5 MP cameras.
Page 3
-3-
Stream path summary
Quite often the most important piece of information that a programmer is looking for is the spelling
of the camera’s stream paths, so we summarized it up front.
Primary H264 RTSP stream: /1/stream1
MJPEG RTSP stream: /1/stream2
Third stream (H264 RTSP): /1/stream3
JPEG snapshot: /snapshot/1/snapshot.jpg
MJPEG HTTP stream: /jpeg/1/jpeg.php
You can test the RTSP paths by entering rtsp:// followed by the IP address of the camera and the path
above into the VLC media player from www.videolan.org
, as in the example below:
You can test the snapshot by adding http:// and the IP address and the JPEG path above into any
browser. For testing the HTTP MJPEG path you need a browser that supports MJPEG, such as
Chrome. Or you can also use VLC for this. Internet Explorer does not support MJPEG.
Page 4
-4-
Table of Contents
Stream path summary ...................................................................................................................... 3
Table of Contents .............................................................................................................................. 4
Audio ................................................................................................................................................ 27
Revision History ......................................................................................................................... 27
Introduction ................................................................................................................................ 27
Audio URI .................................................................................................................................. 27
Back Channel Audio URI ........................................................................................................... 27
Audio Parameter ......................................................................................................................... 27
Back Channel Audio Parameter.................................................................................................. 28
Examples .................................................................................................................................... 28
1) get the current setting ......................................................................................................... 28
2) Audio Enable setup............................................................................................................. 28
3) Audio Codec setup ............................................................................................................. 28
4) Audio Bitrate setup ............................................................................................................. 28
5) Audio Sampling Rate setup ................................................................................................ 28
6) Audio Input setup ............................................................................................................... 28
7) Audio Input Volume setup ................................................................................................. 28
8) Audio Input Mute setup ...................................................................................................... 29
9) Back Channel Audio Enable setup ..................................................................................... 29
10) Back Channel Audio Volume setup ................................................................................. 29
11) Back Channel Audio Mute setup ...................................................................................... 29
12) Audio Input Auto Enable setup ........................................................................................ 29
Caution........................................................................................................................................ 29
Config.txt ......................................................................................................................................... 31
Revision History ......................................................................................................................... 31
Introduction ................................................................................................................................ 31
Config.txt URI ............................................................................................................................ 31
Config.txt Parameters ................................................................................................................. 31
1) Parameters .......................................................................................................................... 31
2) Motorized options ............................................................................................................... 33
3) RS-485 options ................................................................................................................... 33
4) PTZ options ........................................................................................................................ 33
5) VCA options ....................................................................................................................... 34
6) Options ............................................................................................................................... 34
Example ...................................................................................................................................... 36
1) get the current setting ......................................................................................................... 36
Dome Configuration ....................................................................................................................... 37
Dome – Home Function: .............................................................................................................. 37
Revision History ......................................................................................................................... 37
Introduction ................................................................................................................................ 37
Home Function URI ................................................................................................................... 37
Home Function Parameter .......................................................................................................... 37
Examples .................................................................................................................................... 38
1) get the current setting ......................................................................................................... 38
2) Home Function setup .......................................................................................................... 38
3) Home Function Waiting Time setup .................................................................................. 38
Page 5
-5-
4) Home Function Type setup ............................................................................................................. 38
5) Home Function number setup ......................................................................................................... 38
6) Home Function number set setup ....................................................................................... 38
Caution........................................................................................................................................ 38
Dome – Motor Setup: ................................................................................................................... 40
Revision History ......................................................................................................................... 40
Introduction ................................................................................................................................ 40
Motor Setup URI ........................................................................................................................ 40
Motor Setup Parameter ............................................................................................................... 40
Examples .................................................................................................................................... 40
1) get the current setting ......................................................................................................... 40
2) Motor Setup Propotional setup ........................................................................................... 40
3) Motor Setup Max Pan Speed setup..................................................................................... 40
4) Motor Setup Max Tilt Speed setup ..................................................................................... 41
Caution........................................................................................................................................ 41
Dome – Preset: ............................................................................................................................. 42
Revision History ......................................................................................................................... 42
Introduction ................................................................................................................................ 42
Preset URI................................................................................................................................... 42
Preset Parameter ......................................................................................................................... 42
Examples .................................................................................................................................... 43
1) get configurable Preset value .............................................................................................. 43
2) get the current setting ......................................................................................................... 43
3) Preset creation .................................................................................................................... 43
4) Preset deletion .................................................................................................................... 43
5) Preset modification ............................................................................................................. 43
6) Preset movement ................................................................................................................ 44
Caution........................................................................................................................................ 44
Dome – Privacy Zone:.................................................................................................................. 45
Revision History ......................................................................................................................... 45
Introduction ................................................................................................................................ 45
Privacy Zone URI ....................................................................................................................... 45
Privacy Zone Parameter .............................................................................................................. 45
Examples .................................................................................................................................... 45
1) get configurable privacy Zone List ..................................................................................... 45
2) Privacy Zone creation ......................................................................................................... 46
3) Privacy Zone modification ................................................................................................. 46
4) Privacy Zone deletion ......................................................................................................... 46
5) PTZ movement ................................................................................................................... 46
Caution........................................................................................................................................ 46
Dome – RS485: ............................................................................................................................ 47
Revision History ......................................................................................................................... 47
Introduction ................................................................................................................................ 47
RS485 URI ................................................................................................................................. 47
RS485 Parameter ........................................................................................................................ 47
Examples .................................................................................................................................... 47
1) get the current setting ......................................................................................................... 47
2) DOME ID setup .................................................................................................................. 47
3) Protocol setup ..................................................................................................................... 47
4) Baudrate setup .................................................................................................................... 47
5) Parity setup ......................................................................................................................... 48
Page 6
-6-
6) Dome Answer setup........................................................................................................................ 48
Caution ................................................................................................................................................ 48
Dome – System Menu: ................................................................................................................. 49
Revision History ......................................................................................................................... 49
Introduction ................................................................................................................................ 49
System Menu URI ...................................................................................................................... 49
System Menu Parameter ............................................................................................................. 49
Examples .................................................................................................................................... 50
1) Get the current PTZ Camera information and settings ....................................................... 50
2) Check current Origin Check function status ....................................................................... 50
3) Calibration setup ................................................................................................................. 50
4) Origin Check start............................................................................................................... 50
5) Enable Schedule Origin Check setup ................................................................................. 50
6) Schedule Origin Check setup ............................................................................................. 50
7) FA Module F/W Upgrade ................................................................................................... 51
F/W Upload ................................................................................................................................ 51
Caution........................................................................................................................................ 52
Dome – Tour: ............................................................................................................................... 53
Revision History ......................................................................................................................... 53
Introduction ................................................................................................................................ 53
Tour URI..................................................................................................................................... 53
Tour Parameter ........................................................................................................................... 53
Examples .................................................................................................................................... 54
1) get configurable Tour value ................................................................................................ 54
2) get configured Preset List ................................................................................................... 54
3) get configured Tour List ..................................................................................................... 54
4) get specific configured Tour List ....................................................................................... 54
5) Tour creation ...................................................................................................................... 54
6) Tour deletion ...................................................................................................................... 56
7) Tour modification ............................................................................................................... 56
8) Tour movement .................................................................................................................. 56
Caution........................................................................................................................................ 56
Dome – View Angle: ................................................................................................................... 57
Revision History ......................................................................................................................... 57
Introduction ................................................................................................................................ 57
View Angle URI ......................................................................................................................... 57
View Angle Parameter ................................................................................................................ 57
Examples .................................................................................................................................... 58
1) get the current setting ......................................................................................................... 58
2) Tilt Angle Limit setup ........................................................................................................ 58
3) Flip setup ............................................................................................................................ 58
Caution........................................................................................................................................ 58
Event ................................................................................................................................................ 59
Event – AIHM: ............................................................................................................................. 59
Revision History ......................................................................................................................... 59
Introduction ................................................................................................................................ 59
AIHM URI .................................................................................................................................. 59
AIHM Parameter ........................................................................................................................ 59
Examples .................................................................................................................................... 59
1) get the current setting ......................................................................................................... 59
Page 7
-7-
2) AIHM setup .................................................................................................................................... 59
3) AIHM record status check setup..................................................................................................... 59
4) AIHM format event setup ................................................................................................... 59
5) AIHM server setup ............................................................................................................. 59
6) AIHM dwell time setup ...................................................................................................... 60
Caution........................................................................................................................................ 60
Event – A larm In : ......................................................................................................................... 61
Revision History ......................................................................................................................... 61
Introduction ................................................................................................................................ 61
Alarm In URI .............................................................................................................................. 61
Alarm In Parameter .................................................................................................................... 61
Examples .................................................................................................................................... 61
1) get the current setting ......................................................................................................... 61
2) Alarm In setup .................................................................................................................... 61
3) Alarm In type setup ............................................................................................................ 61
4) Alarm In dwell time setup .................................................................................................. 61
Caution........................................................................................................................................ 61
Event – Alarm Out: ...................................................................................................................... 62
Revision History ......................................................................................................................... 62
Introduction ................................................................................................................................ 62
Alarm Out URI ........................................................................................................................... 62
Alarm Out Parameter .................................................................................................................. 62
Examples .................................................................................................................................... 62
1) get the current setting ......................................................................................................... 62
2) Alarm Out setup ................................................................................................................. 62
3) Alarm Out type setup.......................................................................................................... 62
Caution........................................................................................................................................ 62
Event – Audio Alert: .................................................................................................................... 63
Revision History ......................................................................................................................... 63
Introduction ................................................................................................................................ 63
Audio Alert URI ......................................................................................................................... 63
Audio Alert Parameter ................................................................................................................ 63
Examples .................................................................................................................................... 63
1) get the current setting ......................................................................................................... 63
2) Audio Alert setup ............................................................................................................... 63
3) Audio file remove ............................................................................................................... 63
4) Audio Alert Test method .................................................................................................... 63
Caution........................................................................................................................................ 63
1) Reminder for the Audio Alert file upload .......................................................................... 64
Event – Audio detection: .............................................................................................................. 65
Revision History ......................................................................................................................... 65
Introduction ................................................................................................................................ 65
Audio detection URI ................................................................................................................... 65
Audio detection Parameter ......................................................................................................... 65
Examples .................................................................................................................................... 65
1) get the current setting ......................................................................................................... 65
2) Audio detection setup ......................................................................................................... 65
3) Audio detection level setup ................................................................................................ 65
4) Audio detection Dwell time setup ...................................................................................... 65
Caution........................................................................................................................................ 65
Event – Boost: .............................................................................................................................. 67
Page 8
-8-
Revision History ................................................................................................................................. 67
Introduction ......................................................................................................................................... 67
Boost URI ................................................................................................................................... 67
Boost Parameter .......................................................................................................................... 67
Examples .................................................................................................................................... 67
1) get the current setting ......................................................................................................... 67
2) Boost setup ......................................................................................................................... 67
3) Boost stream setup .............................................................................................................. 67
4) Boost stream1 Normal Condition setup.............................................................................. 67
5) Boost stream2 Normal Condition setup.............................................................................. 68
6) Boost stream3 Normal Condition setup.............................................................................. 68
7) Boost Condition setup ........................................................................................................ 69
Caution........................................................................................................................................ 69
1) You must check the following values in the response to http://”camera
ipaddress”/config.txt.......................................................................................................... 69
2) Explanation on “ch#¹_strm#²_○○○” ................................................................................ 70
3) When you setup Boost stream Normal Condition, boost_enable value must be equal to 1.
........................................................................................................................................... 70
Event – Map: ................................................................................................................................ 71
Revision History ......................................................................................................................... 71
Introduction ................................................................................................................................ 71
Event – Map................................................................................................................................ 71
Video & Image – Image Parameter ............................................................................................ 71
Event In ID ................................................................................................................................. 72
Examples .................................................................................................................................... 73
1) get the current setting ......................................................................................................... 73
2) Method setup ...................................................................................................................... 73
3) Event name setup ................................................................................................................ 73
4) Event out SMTP setup ........................................................................................................ 73
5) Event out alarm setup ......................................................................................................... 73
6) Event out FTP setup ........................................................................................................... 74
7) Event out FTP Server setup ................................................................................................ 74
8) Event out HTTP notification setup ..................................................................................... 74
9) Event out audio alert setup ................................................................................................. 74
10) Event out preset setup ....................................................................................................... 75
11) Event out record setup ...................................................................................................... 75
12) Event out event push setup ............................................................................................... 75
13) Event out light setup ......................................................................................................... 75
14) Event out event notification setup .................................................................................... 75
15) Event out boost setup........................................................................................................ 75
16) setup all Maps at once (in case of Error on individual Map setup) .................................. 75
Caution........................................................................................................................................ 76
Event – Event Push: ..................................................................................................................... 77
Revision History ......................................................................................................................... 77
Introduction ................................................................................................................................ 77
Event Push URI .......................................................................................................................... 77
Event Push Parameter ................................................................................................................. 77
Examples .................................................................................................................................... 77
1) Get the current setting ........................................................................................................ 77
2) Event Push setup ................................................................................................................ 77
3) Event Push Stream Type setup ........................................................................................... 77
Page 9
-9-
4) Event Push Pre-event setup ............................................................................................................ 78
5) Event Push Post-event setup ........................................................................................................... 78
6) Event Push URL setup........................................................................................................ 78
7) Event Push Port setup ......................................................................................................... 78
8) Event Push User name setup .............................................................................................. 78
9) Event Push Password setup ................................................................................................ 78
Caution........................................................................................................................................ 78
Event – Face Detector: ................................................................................................................. 79
Revision History ......................................................................................................................... 79
Introduction ................................................................................................................................ 79
Face Detector URI ...................................................................................................................... 79
Face Detector Parameter ............................................................................................................. 79
Examples .................................................................................................................................... 79
1) get the current setting ......................................................................................................... 79
2) face detector enable setup ................................................................................................... 79
3) threshold setup .................................................................................................................... 79
4) setup face detector at once .................................................................................................. 79
Event – FTP & JPEG: .................................................................................................................. 80
Revision History ......................................................................................................................... 80
Introduction ................................................................................................................................ 80
FTP & JPEG URI ....................................................................................................................... 80
FTP & JPEG Parameter .............................................................................................................. 80
Examples .................................................................................................................................... 81
1) Get the current setting ........................................................................................................ 81
2) FTP & JPEG setup ............................................................................................................. 81
3) FTP Server usage setup ...................................................................................................... 81
4) FTP & JPEG Server address setup ..................................................................................... 81
5) FTP & JPEG Port setup ...................................................................................................... 82
6) FTP & JPEG Passive mode setup ....................................................................................... 82
7) FTP & JPEG User name setup ........................................................................................... 82
8) FTP & JPEG Password setup ............................................................................................. 82
9) FTP & JPEG Anonymous login setup ................................................................................ 82
10) FTP & JPEG Remote directory setup ............................................................................... 82
11) FTP & JPEG Time folder setup ........................................................................................ 83
12) FTP & JPEG JPEG Time folder type setup ...................................................................... 83
13) FTP & JPEG JPEG Pre-event time setup ......................................................................... 83
14) FTP & JPEG JPEG Pre-event FPS setup.......................................................................... 83
15) FTP & JPEG JPEG Event FPS setup ............................................................................... 83
16) FTP & JPEG JPEG Post-event time setup........................................................................ 84
17) FTP & JPEG JPEG Post-event FPS setup ........................................................................ 84
18) FTP & JPEG JPEG Prefix file name setup ....................................................................... 84
19) FTP & JPEG JPEG Additional suffix setup ..................................................................... 84
Caution........................................................................................................................................ 84
Event – Light: ............................................................................................................................... 85
Revision History ......................................................................................................................... 85
Introduction ................................................................................................................................ 85
Light URI .................................................................................................................................... 85
Light Parameter .......................................................................................................................... 85
Examples .................................................................................................................................... 85
1) get the current setting ......................................................................................................... 85
2) Light setup .......................................................................................................................... 85
Page 10
-10-
3) Light brightness setup ..................................................................................................................... 85
4) Light mode & Light time setup ...................................................................................................... 85
5) Operates only at night mode setup ..................................................................................... 86
6) Inactivate setup ................................................................................................................... 86
Caution........................................................................................................................................ 86
Event – Manual Trigger: .............................................................................................................. 87
Revision History ......................................................................................................................... 87
Introduction ................................................................................................................................ 87
Manual Trigger Setup & Operation URI .................................................................................... 87
Manual Trigger Setup Parameter ................................................................................................ 87
Manual Trigger Operation Parameter ......................................................................................... 87
Example ...................................................................................................................................... 87
1) Manual Trigger setup ......................................................................................................... 87
Caution........................................................................................................................................ 87
Event – Motion: ............................................................................................................................ 89
Revision History ......................................................................................................................... 89
Introduction ................................................................................................................................ 89
Event – Motion URI ................................................................................................................... 89
Event – Motion Parameter .......................................................................................................... 89
Examples (latest F/W) ................................................................................................................ 90
1) get the current setting ......................................................................................................... 90
2) Motion setup ....................................................................................................................... 90
3) Motion Day & Night setup ................................................................................................. 90
4) Motion Region create ......................................................................................................... 90
5) Motion Region Parameter modify ...................................................................................... 91
6) Motion Region remove ....................................................................................................... 93
Examples (old F/W) .................................................................................................................... 94
1) get the current setting ......................................................................................................... 94
2) Motion setup ....................................................................................................................... 94
3) Motion Day & Night setup ................................................................................................. 94
4) Motion Region create ......................................................................................................... 94
5) Motion Region modify ....................................................................................................... 94
6) Motion Region remove ....................................................................................................... 94
7) Motion modify all ............................................................................................................... 94
Event – Network Loss: ................................................................................................................. 96
Revision History ......................................................................................................................... 96
Introduction ................................................................................................................................ 96
Network Loss URI ...................................................................................................................... 96
Network Loss Parameter............................................................................................................. 96
Examples .................................................................................................................................... 96
1) Get the current setting ........................................................................................................ 96
2) Network Loss setup ............................................................................................................ 96
3) Network Loss dwell time setup .......................................................................................... 96
Caution........................................................................................................................................ 96
Event –Notification Server: .......................................................................................................... 97
Revision History ......................................................................................................................... 97
Introduction ................................................................................................................................ 97
Notification Server Parameter .................................................................................................... 97
Examples .................................................................................................................................... 97
1) get the current setting ......................................................................................................... 97
2) Notification Server setup .................................................................................................... 97
Page 11
-11-
3) Notification Server Type setup ....................................................................................................... 97
4) Notification Server Method setup ................................................................................................... 98
5) Notification Server URL setup ........................................................................................... 98
6) Notification Server Port setup ............................................................................................ 98
7) Notification Server user setup ............................................................................................ 98
8) Notification Server password setup .................................................................................... 98
7) Notification Server Test ..................................................................................................... 98
Caution........................................................................................................................................ 98
Event – On Boot: .......................................................................................................................... 99
Revision History ......................................................................................................................... 99
Introduction ................................................................................................................................ 99
On Boot URI ............................................................................................................................... 99
On Boot Parameter ..................................................................................................................... 99
Examples .................................................................................................................................... 99
1) get the current setting ......................................................................................................... 99
2) On Boot setup ..................................................................................................................... 99
3) On Boot dwell time setup ................................................................................................... 99
Caution........................................................................................................................................ 99
Event – PIR: ............................................................................................................................... 100
Revision History ....................................................................................................................... 100
Introduction .............................................................................................................................. 100
PIR URI .................................................................................................................................... 100
PIR Parameter ........................................................................................................................... 100
Examples .................................................................................................................................. 100
1) Get the current setting ...................................................................................................... 100
2) PIR setup .......................................................................................................................... 100
3) PIR sensitivity level setup ................................................................................................ 100
4) PIR dwell time setup ........................................................................................................ 100
Caution...................................................................................................................................... 100
Event – PTZ Preset: ................................................................................................................... 101
Revision History ....................................................................................................................... 101
Introduction .............................................................................................................................. 101
PTZ Preset URI ........................................................................................................................ 101
PTZ Preset Parameter ............................................................................................................... 101
Examples .................................................................................................................................. 101
1) get the current setting ....................................................................................................... 101
2) PTZ Preset setup ............................................................................................................... 101
3) PTZ Preset Home position setup ...................................................................................... 101
Caution...................................................................................................................................... 101
Event – Record: .......................................................................................................................... 102
Revision History ....................................................................................................................... 102
Introduction .............................................................................................................................. 102
Record URI ............................................................................................................................... 102
Record Parameter ..................................................................................................................... 102
Examples .................................................................................................................................. 103
1) get the current setting ....................................................................................................... 103
2) record enable setup ........................................................................................................... 103
3) record overwrite setup ...................................................................................................... 103
4) record stream setup ........................................................................................................... 104
5) record pre time setup ........................................................................................................ 104
6) record post time setup ....................................................................................................... 104
Page 12
-12-
7) record audio setup ......................................................................................................................... 104
8) record schedule setup .................................................................................................................... 104
9) record device type setup ................................................................................................... 105
10) record address setup ....................................................................................................... 105
11) record remote directory setup ......................................................................................... 105
12) record capacity setup ...................................................................................................... 105
13) record ID setup ............................................................................................................... 105
13) record password setup .................................................................................................... 105
14) record device remove setup ............................................................................................ 105
15) record device check setup ............................................................................................... 105
16) How to setup record at once ........................................................................................... 105
Event – SMTP: ........................................................................................................................... 106
Revision History ....................................................................................................................... 106
Introduction .............................................................................................................................. 106
SMTP URI ................................................................................................................................ 106
SMTP Parameter ....................................................................................................................... 106
Examples .................................................................................................................................. 107
1) Get the current setting ...................................................................................................... 107
2) SMTP setup ...................................................................................................................... 107
3) Sender’s Mail address setup ............................................................................................. 107
4) Interval setup .................................................................................................................... 107
5) Aggregate events setup ..................................................................................................... 107
6) Image attachment setup .................................................................................................... 107
7) Mail server usage setup .................................................................................................... 107
8) Mail server address setup ................................................................................................. 107
9) Mail server Port setup ....................................................................................................... 107
10) Connection security setup............................................................................................... 107
11) Mail server’s User name setup ....................................................................................... 107
12) Mail server’s Password setup ......................................................................................... 107
13) Mail server’s Login method setup .................................................................................. 107
14) Receiver address setup ................................................................................................... 108
15) SMTP Test method ......................................................................................................... 108
Caution...................................................................................................................................... 108
Event – Tampering: .................................................................................................................... 109
Revision History ....................................................................................................................... 109
Introduction .............................................................................................................................. 109
Tampering URI ......................................................................................................................... 109
Tampering Parameter ............................................................................................................... 109
Examples .................................................................................................................................. 109
1) Get the current setting ...................................................................................................... 109
2) Tampering enable setup .................................................................................................... 109
3) Dwell time setup ............................................................................................................... 109
4) Area rate setup .................................................................................................................. 110
5) Setup tampering at once ................................................................................................... 110
Event – Time Trigger: ................................................................................................................ 111
Revision History ....................................................................................................................... 111
Introduction .............................................................................................................................. 111
Time Trigger URI ..................................................................................................................... 111
Time Trigger Parameter ............................................................................................................ 111
Examples .................................................................................................................................. 112
1) get the current setting ....................................................................................................... 112
Page 13
-13-
2) Time Trigger usage setup ............................................................................................................. 112
3) Time Trigger # usage setup .......................................................................................................... 112
4) Time Trigger # Specific Time usage setup ....................................................................... 112
5) Time Trigger # Day usage setup ...................................................................................... 112
6) Time Trigger # Day Of Week usage setup ....................................................................... 112
7) Time Trigger # Month usage setup................................................................................... 112
8) setup Date in Time Trigger # Specific Time .................................................................... 112
9) setup Time in Time Trigger # Specific Time ................................................................... 113
10) setup Time in Time Trigger # Day ................................................................................. 113
11) setup Day in Time Trigger # Day Of Week ................................................................... 113
12) setup Date in Time Trigger # Day Of Week .................................................................. 113
13) setup Date in Time Trigger # Month .............................................................................. 113
14) setup Time in Time Trigger # Month ............................................................................. 113
Caution...................................................................................................................................... 113
Event – VCA: ............................................................................................................................. 114
Revision History ....................................................................................................................... 114
VCA URI .................................................................................................................................. 114
VCA Parameter ......................................................................................................................... 114
Examples .................................................................................................................................. 115
1) get the current setting of Fixed camera ............................................................................ 115
2) get the current setting of PTZ camera .............................................................................. 115
3) set Fixed camera rule number 1 to line detector ............................................................... 116
4) set PTZ camera “PRESET-1” rule number 1 to line detector .......................................... 116
5) set Fixed camera rule number 2 to field detector ............................................................. 116
6) set PTZ camera “PRSET-1’ rule number 2 to field detector ............................................ 116
7) set Fixed camera rule number 3 to absent ........................................................................ 117
8) set PTZ camera “PRESET-1” rule number 3 to absent .................................................... 117
9) reset counter of line detector rule number 1 ..................................................................... 117
10) reset counter of line detector rule number 2 ................................................................... 117
Caution...................................................................................................................................... 117
Event – Video Loss: ................................................................................................................... 119
Revision History ....................................................................................................................... 119
Introduction .............................................................................................................................. 119
Video Loss URI ........................................................................................................................ 119
Video Loss Parameters ............................................................................................................. 119
Examples .................................................................................................................................. 119
1) get the current setting ....................................................................................................... 119
2) Video Loss setup .............................................................................................................. 119
3) Video Loss dwell time setup ............................................................................................ 119
Caution...................................................................................................................................... 119
Event – XML Notification: .......................................................................................................... 120
Revision History ....................................................................................................................... 120
Introduction .............................................................................................................................. 120
XML Notification URI ............................................................................................................. 120
XML Notification Parameter .................................................................................................... 120
Examples .................................................................................................................................. 120
1) Get the current setting ...................................................................................................... 120
2) XML Notification setup ................................................................................................... 120
3) XML Notification server URL setup ................................................................................ 120
4) XML Notificat io n Po rt setup ............................................................................................ 120
Caution...................................................................................................................................... 120
Page 14
-14-
Event Stream ................................................................................................................................... 121
Revision History ............................................................................................................................... 121
Introduction .............................................................................................................................. 121
Event Stream URI ..................................................................................................................... 121
Event Stream Format ................................................................................................................ 121
1) HTTP GET REQUEST .................................................................................................... 121
2) HTTP POST REQUEST .................................................................................................. 121
3) HTTP CONTINUES RESPONSE ................................................................................... 122
Event Stream Request Parameter .............................................................................................. 122
Table 1. REQUEST PARAMETER ..................................................................................... 122
Event Stream Response Parameter ........................................................................................... 123
Table 2. BASIC RESPONSE PARAMETER ...................................................................... 123
Table 3. NORMAL FULLTEXT RESPONSE PARAMTER .............................................. 123
Table 4. MOTION FULLTEXT RESPONSE PARAMETER ............................................. 123
Table 5. VIDEO LOSS FULLTEXT RESPONSE PARAMETER ...................................... 124
Table 6. RECORD FULLTEXT RESPONSE PARAMETER ............................................. 124
Table 7. VCA EVENT FULLTEXT RESPONSE PARAMETER....................................... 124
Table 8. VCA OBJECT FULLTEXT RESPONSE PARAMETER ..................................... 125
Table 9. VCA RULE FULLTEXT RESPONSE PARAMETER ......................................... 125
Examples .................................................................................................................................. 126
1) BASIC EVENT STREAM REQUEST ............................................................................ 126
2) BASIC EVENT STREAM RESPONSE .......................................................................... 126
3) BASIC EVENT STREAM REQUEST WITH ALARMIN FILTER ............................... 127
4). BASIC EVENT STREAM RESPONSE WITH ALARMIN FILTER ............................ 127
5) EVENT STREAM REQUEST WITH MOTION FILTER .............................................. 127
6) EVENT STREAM RESPONSE WITH MOTION FILTER ............................................ 127
7) EVENT STREAM REQUEST WITH VCA FILTER ..................................................... 128
8) EVENT STREAM RESPONSE WITH VCA FILTER.................................................... 128
JPEG Push..................................................................................................................................... 131
Revision History ....................................................................................................................... 131
Introduction .............................................................................................................................. 131
JPEG Push URI ........................................................................................................................ 131
JPEG Push Parameter ............................................................................................................... 131
Example .................................................................................................................................... 131
1) View JPEG Push .............................................................................................................. 131
Caution...................................................................................................................................... 131
Live ................................................................................................................................................. 132
Live – Motor, Smart Focus Control API .................................................................................... 132
Revision History ....................................................................................................................... 132
Motor Control: ........................................................................................................................... 132
Introduction .............................................................................................................................. 132
Motor Control URI ................................................................................................................... 132
Motor Control Parameter .......................................................................................................... 132
Examples .................................................................................................................................. 132
1) zoom Control : .................................................................................................................. 132
2) focus Control : .................................................................................................................. 132
3) move Control : .................................................................................................................. 132
Caution...................................................................................................................................... 132
Live – Smart Focus: ................................................................................................................... 134
Revision History ....................................................................................................................... 134
Page 15
-15-
Introduction ....................................................................................................................................... 134
Smart Focus URI .............................................................................................................................. 134
Smart Focus Parameter ............................................................................................................. 134
Example .................................................................................................................................... 134
Caution...................................................................................................................................... 134
Live – Light Control: ................................................................................................................. 135
Revision History ....................................................................................................................... 135
Introduction .............................................................................................................................. 135
Light Control URI .................................................................................................................... 135
Light Control Parameter ........................................................................................................... 135
Examples .................................................................................................................................. 135
1) get the current setting ....................................................................................................... 135
2) Light Control setup ........................................................................................................... 135
3) Light Level setup .............................................................................................................. 135
Caution...................................................................................................................................... 135
Live – PTZ Control: ................................................................................................................... 136
Revision History ....................................................................................................................... 136
Introduction .............................................................................................................................. 136
PTZ Control URI ...................................................................................................................... 136
1) PTZ Control UI Open ....................................................................................................... 136
2) PTZ Control API URL ..................................................................................................... 136
PTZ Control Parameter ............................................................................................................. 136
Example .................................................................................................................................... 137
1) PTZ Control UI load ......................................................................................................... 137
2) Pan, Tilt Control ............................................................................................................... 137
3) Pan, Tilt Speed Control .................................................................................................... 137
4) IRIS Control ..................................................................................................................... 137
5) ZOOM Control ................................................................................................................. 137
6) ZOOM Speed Control ...................................................................................................... 137
7) FOCUS Control ................................................................................................................ 137
8) Preset Save ....................................................................................................................... 138
9) Preset Control ................................................................................................................... 138
10) Tour Control ................................................................................................................... 138
11) Pattern Control ............................................................................................................... 138
12) Position Control .............................................................................................................. 138
13) Position Speed Control ................................................................................................... 138
14) Device menu ................................................................................................................... 138
15) Preset menu .................................................................................................................... 138
16) Scan menu ...................................................................................................................... 138
17) Tour menu ...................................................................................................................... 138
18) Pattern menu ................................................................................................................... 138
19) Esc menu ........................................................................................................................ 139
20) Stop menu ....................................................................................................................... 139
21) Up menu ......................................................................................................................... 139
22) Down menu .................................................................................................................... 139
23) Left menu ....................................................................................................................... 139
24) Right menu ..................................................................................................................... 139
25) Enter menu ..................................................................................................................... 139
26) Ctrl control ..................................................................................................................... 139
27) shortcut on control .......................................................................................................... 139
28) shortcut off control ......................................................................................................... 139
Page 16
-16-
Caution .............................................................................................................................................. 139
Live – X1 Dome Configuration – Position: ...................................................................................... 140
Revision History ....................................................................................................................... 140
Introduction .............................................................................................................................. 140
PTZ Position URI ..................................................................................................................... 140
PTZ Position Parameter ............................................................................................................ 140
Examples .................................................................................................................................. 140
1) Get the current setting ...................................................................................................... 140
2) PTZ Position setup ........................................................................................................... 140
3) PTZ Position setup (Degree) ............................................................................................ 141
4) Check whether the current PTZ Position is a Pr eset position or not. ............................... 141
Live View ....................................................................................................................................... 142
Revision History ....................................................................................................................... 142
Introduction .............................................................................................................................. 142
Live View URI ......................................................................................................................... 142
LIVE View Parameter .............................................................................................................. 142
Example .................................................................................................................................... 142
1) get the current setting ....................................................................................................... 142
2) Video mode setup ............................................................................................................. 142
3) Check response value after setup ..................................................................................... 142
Caution...................................................................................................................................... 142
Playback ........................................................................................................................................ 143
Revision History ....................................................................................................................... 143
Introduction .............................................................................................................................. 143
Playback Parameter .................................................................................................................. 143
Examples .................................................................................................................................. 145
1) get entire calendar information ......................................................................................... 145
2) get month information ...................................................................................................... 145
3) get day information........................................................................................................... 145
4) get hour information ......................................................................................................... 145
5) get minute information .................................................................................................... 146
6) get the first information of recording data ........................................................................ 146
7) get the last information of recording data ......................................................................... 146
8) get event list ...................................................................................................................... 146
9) get event information ........................................................................................................ 146
10) get clipcopy .................................................................................................................... 146
11) Number of connected Client ........................................................................................... 146
Playback-Replay Control(RTSP) .............................................................................................. 146
1) Forward Step Play ............................................................................................................ 147
2) Forward Step Forward ...................................................................................................... 147
3) Forward Normal Play ....................................................................................................... 147
4) Forward Double Speed Play ............................................................................................. 148
5) Forward Triple Speed Play ............................................................................................... 148
6) Forward Quadruple Speed Play ........................................................................................ 148
7) Forward play stop ............................................................................................................. 149
8) Backward Step Play .......................................................................................................... 149
9) Backward Step Backward................................................................................................. 149
10) Backward Normal Play................................................................................................... 149
11) Backward Double Speed Play ........................................................................................ 150
12) Backward Triple Speed Play .......................................................................................... 150
Page 17
-17-
13) Backward Quadruple Speed Play ............................................................................................... 150
14) Backward play stop .................................................................................................................... 150
15) Clipcopy ......................................................................................................................... 151
16) Only I Frame with interval 1 Sec(record time line) ........................................................ 151
Caution...................................................................................................................................... 151
Snapshot ........................................................................................................................................ 152
Revision History ....................................................................................................................... 152
Introduction .............................................................................................................................. 152
Snapshot URI ............................................................................................................................ 152
Snapshot Parameter .................................................................................................................. 152
Example ................................................................................................................................ 152
1) View Snapshot .................................................................................................................. 152
System ............................................................................................................................................ 153
System – Bonjour: ...................................................................................................................... 153
Revision History ....................................................................................................................... 153
Introduction .............................................................................................................................. 153
Bonjour URI ............................................................................................................................. 153
Bonjour Parameter .................................................................................................................... 153
Example .................................................................................................................................... 153
1) get the current setting ....................................................................................................... 153
2) Bonjour setup ................................................................................................................... 153
3) Friendly name setup ......................................................................................................... 153
Caution...................................................................................................................................... 153
System – Date&Time: ................................................................................................................ 154
Revision History ....................................................................................................................... 154
Introduction .............................................................................................................................. 154
Date&Time URI ....................................................................................................................... 154
Date&Time Parameter .............................................................................................................. 154
Example .................................................................................................................................... 155
1) get the current setting ....................................................................................................... 155
2) datetime mode setup ......................................................................................................... 155
3) timezone setup .................................................................................................................. 155
4) timezone daylight saving setup ........................................................................................ 155
5) timezone daylight saving user setup ................................................................................. 155
6) timezone daylight saving start month setup ..................................................................... 155
7) timezone daylight saving start week setup ....................................................................... 155
8) timezone daylight saving start dayofweek setup .............................................................. 155
9) timezonedaylight saving start time setup.......................................................................... 155
10) timezone daylight saving end month setup..................................................................... 155
11) timezone daylight saving end week setup ...................................................................... 156
12) timezone daylight saving end dayofweek setup ............................................................. 156
13) timezone daylight saving end time setup ........................................................................ 156
14) timezone daylight saving time gap setup ........................................................................ 156
15) Date&Time setup............................................................................................................ 156
16) ntp server setup ............................................................................................................... 156
17) ntp interval setup ............................................................................................................ 156
18) date format setup ............................................................................................................ 156
19) time format setup ............................................................................................................ 156
20) How to setup date&time at once .................................................................................... 156
Caution...................................................................................................................................... 157
Page 18
-18-
System – DDNS: ............................................................................................................................... 160
Revision History ............................................................................................................................... 160
Introduction .............................................................................................................................. 160
DDNS URI ............................................................................................................................... 160
DDNS Parameter ...................................................................................................................... 160
Examples .................................................................................................................................. 160
1) get the current setting ....................................................................................................... 160
2) DDNS setup ...................................................................................................................... 160
3) DDNS server URL setup .................................................................................................. 160
4) DDNS Host name setup.................................................................................................... 160
5) DDNS User name setup.................................................................................................... 160
6) DDNS Password setup ..................................................................................................... 161
7) DDNS Confirm Password setup ....................................................................................... 161
8) DDNS Interval setup ........................................................................................................ 161
9) DDNS Local setup ............................................................................................................ 161
Caution...................................................................................................................................... 161
System – H/W check: ................................................................................................................. 162
Revision History ....................................................................................................................... 162
Introduction .............................................................................................................................. 162
Hardware Check URI ............................................................................................................... 162
Hardware Check Parameter ...................................................................................................... 162
Examples .................................................................................................................................. 162
1) get the current setting ....................................................................................................... 162
2) LED light Test .................................................................................................................. 162
3) PIR Sensor Test ................................................................................................................ 162
4) Speaker Test ..................................................................................................................... 162
Caution...................................................................................................................................... 162
1) Speaker Test ..................................................................................................................... 162
System – HTTPS: ....................................................................................................................... 163
Revision History ....................................................................................................................... 163
Introduction .............................................................................................................................. 163
HTTPS URI .............................................................................................................................. 163
HTTPS Parameter ..................................................................................................................... 163
Authentication key Upload ....................................................................................................... 163
Examples .................................................................................................................................. 163
1) get the current setting ....................................................................................................... 163
2) HTTPS Mode setup .......................................................................................................... 163
Caution...................................................................................................................................... 164
System – Information: ................................................................................................................ 165
Revision History ....................................................................................................................... 165
Introduction .............................................................................................................................. 165
Information URI ....................................................................................................................... 165
Information Parameter .............................................................................................................. 165
Examples .................................................................................................................................. 165
1) get the current setting ....................................................................................................... 165
2) Device name setup ............................................................................................................ 165
3) Location setup .................................................................................................................. 165
System – IP Filtering: ................................................................................................................. 166
Revision History ....................................................................................................................... 166
Introduction .............................................................................................................................. 166
IP Filtering URI ........................................................................................................................ 166
Page 19
-19-
IP Filtering Parameter ....................................................................................................................... 166
Examples ........................................................................................................................................... 166
1) get the current setting ....................................................................................................... 166
2) IP Filtering setup .............................................................................................................. 166
3) IP Filtering Priority 1........................................................................................................ 166
4) IP Filtering Priority 2........................................................................................................ 167
5) IP Filtering Priority 3........................................................................................................ 167
6) IP Filtering Priority 4........................................................................................................ 167
7) IP Filtering Priority 5........................................................................................................ 167
Caution...................................................................................................................................... 168
System – Language: ................................................................................................................... 169
Revision History ....................................................................................................................... 169
Introduction .............................................................................................................................. 169
Language URI ........................................................................................................................... 169
Language Parameter ................................................................................................................. 169
Examples .................................................................................................................................. 169
1) get the current setting ....................................................................................................... 169
2) Language setup ................................................................................................................. 169
System – Live Push: ................................................................................................................... 170
Revision History ....................................................................................................................... 170
Introduction .............................................................................................................................. 170
Live Push URI .......................................................................................................................... 170
Live Push Parameter ................................................................................................................. 170
Examples .................................................................................................................................. 170
1) get the current setting ....................................................................................................... 170
2) Live Push 1 ....................................................................................................................... 170
3) Live Push 2 ....................................................................................................................... 170
4) Live Push 3 ....................................................................................................................... 171
Caution...................................................................................................................................... 171
System – Log: ............................................................................................................................ 172
Revision History ....................................................................................................................... 172
Introduction .............................................................................................................................. 172
Log URI .................................................................................................................................... 172
Log Parameter ........................................................................................................................... 172
Examples .................................................................................................................................. 172
1) Type .................................................................................................................................. 172
2) Start time .......................................................................................................................... 172
3) End time ........................................................................................................................... 173
4) Start time, End time .......................................................................................................... 173
5) Start date ........................................................................................................................... 173
6) End date ............................................................................................................................ 173
7) Start date, End date ........................................................................................................... 173
8) Start date, Start time, End date, End time ......................................................................... 173
9) Type, Start date, Start time, End date, End time .............................................................. 173
Caution...................................................................................................................................... 173
System – Maintenance: .............................................................................................................. 174
Revision History ....................................................................................................................... 174
Introduction .............................................................................................................................. 174
Maintenance URI ...................................................................................................................... 174
1) Restart ............................................................................................................................... 174
2) Reset ................................................................................................................................. 174
Page 20
-20-
3) Default .......................................................................................................................................... 174
4) Upgrade ........................................................................................................................................ 174
5) VCA Upgrade ................................................................................................................... 174
6) Backup .............................................................................................................................. 174
7) Restore .............................................................................................................................. 174
8) Calibrate ........................................................................................................................... 174
Examples .................................................................................................................................. 174
1) Restart ............................................................................................................................... 174
2) Reset ................................................................................................................................. 174
3) Default .............................................................................................................................. 175
4) Upgrade ............................................................................................................................ 175
5) VCA Upgrade ................................................................................................................... 175
6) Backup .............................................................................................................................. 175
7) Restore .............................................................................................................................. 175
8) Calibrate ........................................................................................................................... 175
Caution...................................................................................................................................... 175
System – Media check: .............................................................................................................. 177
Revision History ....................................................................................................................... 177
Introduction .............................................................................................................................. 177
Media Check URI ..................................................................................................................... 177
Media Check Parameter ............................................................................................................ 177
Caution...................................................................................................................................... 177
1) Parameter - “media_a_snd#³_enable” .............................................................................. 177
2) Parameter - “media_a_snd#³_in_gain” ............................................................................. 177
System – NAT: ........................................................................................................................... 178
Revision History ....................................................................................................................... 178
Introduction .............................................................................................................................. 178
NAT URI .................................................................................................................................. 178
NAT Parameter ......................................................................................................................... 178
Examples .................................................................................................................................. 178
1) get the current setting ....................................................................................................... 178
2) Wire NAT traversal setup ................................................................................................. 178
3) External wire HTTP port setup ......................................................................................... 178
4) External wire RTSP port setup ......................................................................................... 178
5) Wireless NAT traversal setup ........................................................................................... 178
6) External wireless H T TP port setup ................................................................................... 178
7) External wireless RTSP port setup ................................................................................... 179
8) Response wire HTTP&RTSP URL .................................................................................. 179
9) Response wireless HTTP&RTSP URL ............................................................................ 179
10) Response Error Code ...................................................................................................... 179
Caution...................................................................................................................................... 179
System – Network: ..................................................................................................................... 180
Revision History ....................................................................................................................... 180
Introduction .............................................................................................................................. 180
System – Network URI ............................................................................................................. 180
System – Network Parameter ................................................................................................... 180
Examples .................................................................................................................................. 181
1) get the current information ............................................................................................... 181
2) IP address assign method setup ........................................................................................ 181
3) fixed IP address setup ....................................................................................................... 181
4) fixed Subnet Mask setup .................................................................................................. 181
Page 21
-21-
5) fixed Gateway Address setup ....................................................................................................... 181
6) IPv6 setup ..................................................................................................................................... 181
7) DNS Address assign method setup ................................................................................... 181
8) fixed DNS Server Domain Name setup ............................................................................ 181
9) fixed Primary DNS Server Address setup ........................................................................ 181
10) fixed Secondary DNS Server Address setup .................................................................. 181
11) Host Name setup ............................................................................................................ 181
12) HTTP Port setup ............................................................................................................. 181
13) HTTPS Port setup ........................................................................................................... 181
14) RTSP Port setup ............................................................................................................. 181
15) LAN Interface setup ....................................................................................................... 181
16) Link Speed setup ............................................................................................................ 182
Caution...................................................................................................................................... 182
System – Network check: ........................................................................................................... 183
Revision History ....................................................................................................................... 183
Introduction .............................................................................................................................. 183
Network Check URI ................................................................................................................. 183
Network Check Parameter ........................................................................................................ 183
OpenVPN: .................................................................................................................................. 185
Revision History ....................................................................................................................... 185
Introduction .............................................................................................................................. 185
OpenVPN URI .......................................................................................................................... 185
OpenVPN Parameter ................................................................................................................ 185
Example .................................................................................................................................... 186
1) get the current setting ....................................................................................................... 186
2) openvpn enable setup ....................................................................................................... 186
3) openvpn mode setup ......................................................................................................... 186
4) openvpn server protocol setup .......................................................................................... 186
5) openvpn server port setup ................................................................................................. 186
6) openvpn server reneg setup .............................................................................................. 186
7) openvpn server lzo setup .................................................................................................. 186
8) openvpn client protocol setup ........................................................................................... 186
9) openvpn client port setup.................................................................................................. 186
10) openvpn client lzo setup ................................................................................................. 186
11) openvpn client reneg setup ............................................................................................. 186
12) openvpn_user_authentication_mode setup ..................................................................... 187
13) openvpn_user_authentication_id setup .......................................................................... 187
14) openvpn_user_authentication_passwd setup .................................................................. 187
15) openvpn_server_ipaddr setup ......................................................................................... 187
16) How to setup openvpn at once ........................................................................................ 187
Caution...................................................................................................................................... 187
1. Server’s authentication time is longer than Client time .................................................... 187
2. Server’s authentication time is shorter Client time ........................................................... 187
3. Server’s authentication time is 0 , Client time is not 0 ..................................................... 187
4. Server’s authentication time is not 0 , Client time is 0 .................................................... 187
System – QoS: ............................................................................................................................ 188
Revision History ....................................................................................................................... 188
Introduction .............................................................................................................................. 188
QoS Parameter .......................................................................................................................... 188
Example .................................................................................................................................... 188
1) get the current setting ....................................................................................................... 188
Page 22
-22-
2) DSCP Setting ................................................................................................................................ 188
3) Automatic Traffic Control ............................................................................................................ 188
System – RTP: ............................................................................................................................ 190
Revision History ....................................................................................................................... 190
Introduction .............................................................................................................................. 190
RTP Parameter .......................................................................................................................... 190
Example .................................................................................................................................... 190
1) get the current setting ....................................................................................................... 190
2) RTP Port Range ................................................................................................................ 191
3) Multicast (Stream 1) ......................................................................................................... 191
4) Multicast (Stream 2) ......................................................................................................... 191
5) Multicast (Stream 3) ......................................................................................................... 191
6) Multicast (Audio) ............................................................................................................. 191
7) Multicast (Meta) ............................................................................................................... 192
Caution...................................................................................................................................... 192
System – System check: ............................................................................................................. 193
Revision History ....................................................................................................................... 193
Introduction .............................................................................................................................. 193
System Check URI ................................................................................................................... 193
System Check Parameter .......................................................................................................... 193
Caution...................................................................................................................................... 193
System – UpnP: .......................................................................................................................... 194
Revision History ....................................................................................................................... 194
Introduction .............................................................................................................................. 194
UPnP URI ................................................................................................................................. 194
UPnP Parameter ........................................................................................................................ 194
Examples .................................................................................................................................. 194
1) get the current setting ....................................................................................................... 194
2) UPnP setup ....................................................................................................................... 194
3) Friendly name setup ......................................................................................................... 194
Caution...................................................................................................................................... 194
System – Users: .......................................................................................................................... 195
Revision History ....................................................................................................................... 195
Introduction .............................................................................................................................. 195
Users URI ................................................................................................................................. 195
Users Parameter ........................................................................................................................ 195
Example .................................................................................................................................... 196
1) get the current setting ....................................................................................................... 196
2) add User ............................................................................................................................ 196
3) modify User ...................................................................................................................... 197
4) delete User ........................................................................................................................ 197
5) Anonymous login setup .................................................................................................... 197
Caution...................................................................................................................................... 197
Security – VPM: ......................................................................................................................... 198
Revision History ....................................................................................................................... 198
Introduction .............................................................................................................................. 198
VPM URI .................................................................................................................................. 198
VPM Parameter ........................................................................................................................ 198
Example .................................................................................................................................... 199
1) get the current setting ....................................................................................................... 199
2) VPM setup ........................................................................................................................ 199
Page 23
-23-
3) add Server ..................................................................................................................................... 199
4) modify Server ............................................................................................................................... 199
5) remove Server ................................................................................................................... 199
Caution...................................................................................................................................... 199
System – Network – Wireless: ................................................................................................... 200
Revision History ....................................................................................................................... 200
Introduction .............................................................................................................................. 200
Wireless URI ............................................................................................................................ 200
1) Wireless Network URI ..................................................................................................... 200
2) Wireless Setup NRI .......................................................................................................... 200
Wireless Parameter ................................................................................................................... 200
1) Wireless Network ............................................................................................................. 200
2) Wileress AP Setup ............................................................................................................ 200
Example .................................................................................................................................... 201
1) get the current Wireless Network value ........................................................................... 201
2) get the current Wireless AP value .................................................................................... 201
3) Wireless Network setup .................................................................................................... 201
4) Wireless Network DHCP setup ........................................................................................ 201
5) Wireless Network IP setup ............................................................................................... 201
6) Wireless Network Mask setup .......................................................................................... 201
7) Wireless Network GateWay setup .................................................................................... 201
8) Wireless Network DNS setup ........................................................................................... 201
9) Wireless AP Connect setup .............................................................................................. 201
10) Wireless AP Disconnect setup ........................................................................................ 201
11) Wireless AP Delete setup ............................................................................................... 202
System – Zeroconf: .................................................................................................................... 203
Revision History ....................................................................................................................... 203
Introduction .............................................................................................................................. 203
Zeroconf URI ............................................................................................................................ 203
Zeroconf Parameter .................................................................................................................. 203
Example .................................................................................................................................... 203
1) get the current setting ....................................................................................................... 203
2) Zeroconf setup .................................................................................................................. 203
3) Zeroconf IP address confirm ............................................................................................ 203
Caution...................................................................................................................................... 203
Video & Image .............................................................................................................................. 204
Video & Image – Camera Setup: ............................................................................................... 204
Revision History ....................................................................................................................... 204
Introduction .............................................................................................................................. 204
Video & Image – Camera Setup URI ....................................................................................... 204
Video & Image – Camera Setup Parameter .............................................................................. 204
Example .................................................................................................................................... 208
1) get the current setting ....................................................................................................... 208
2) Brightness setup ............................................................................................................... 209
3) Contrast setup ................................................................................................................... 209
4) Saturation setup ................................................................................................................ 209
5) Hue setup .......................................................................................................................... 209
6) Sharpness setup ................................................................................................................ 209
7) Flip setup .......................................................................................................................... 209
8) Mirror setup ...................................................................................................................... 209
Page 24
-24-
9) Noise Reduction setup .................................................................................................................. 209
10) Noise Reduction Level setup ...................................................................................................... 209
11) WDR setup ..................................................................................................................... 209
12) WDR Level setup ........................................................................................................... 209
13) Defog setup ..................................................................................................................... 209
14) Defog Strength setup ...................................................................................................... 210
15) IRIS setup ....................................................................................................................... 210
16) Backlight Compensation setup ....................................................................................... 210
17) IR setup ........................................................................................................................... 210
18) Max Strength Value setup .............................................................................................. 210
19) Smart Focus setup........................................................................................................... 210
20) Digital Zoom setup ......................................................................................................... 210
21) High Sensitivity setup..................................................................................................... 210
22) White Balance Mode setup ............................................................................................. 210
23) Blue Gain setup .............................................................................................................. 210
24) Red Gain setup ............................................................................................................... 210
25) Day & Night Mode setup ............................................................................................... 211
26) Day & Night Threshold setup ......................................................................................... 211
27) Exposure Value setup ..................................................................................................... 211
28) Exposure Mode setup ..................................................................................................... 211
29) Camera Max Gain setup ................................................................................................. 211
30) Camera Shutter Mode setup ........................................................................................... 211
31) Camera Shutter Value setup ........................................................................................... 211
32) Camera Iris Mode setup.................................................................................................. 211
33) Camera Iris Value setup ................................................................................................. 212
34) Camera Iris Value setup ................................................................................................. 212
35) Camera Manual Gain setup ............................................................................................ 212
36) IR Mode setup ................................................................................................................ 212
37) IR On Level setup ........................................................................................................... 212
38) IR Off Level setup .......................................................................................................... 212
39) Fixed IR Bright setup ..................................................................................................... 212
40) Moving IR Bright setup .................................................................................................. 212
41) Fixed IR Level setup ...................................................................................................... 212
42) Moving IR Level setup ................................................................................................... 212
43) Delay Time setup ............................................................................................................ 212
44) Moving IR Mode setup ................................................................................................... 212
45) Long Exposure setup ...................................................................................................... 213
46) Max Shutter Value setup ................................................................................................ 213
47) Flicker Free setup ........................................................................................................... 213
48) Flicker Mode setup ......................................................................................................... 213
49) AGC DB setup ................................................................................................................ 213
50) IRIS Type setup .............................................................................................................. 213
51) Aisle setup ...................................................................................................................... 213
52) Aisle Degree setup .......................................................................................................... 213
53) Digital Image Stabilization setup ................................................................................... 213
54) Digital Image Stabilization Level setup ......................................................................... 213
55) High Light Compensation setup ..................................................................................... 213
56) High Light Compensation Level setup ........................................................................... 214
57) ANPR Multi Shutter setup .............................................................................................. 214
58) ANPR Multi Shutter Value setup ................................................................................... 214
59) High Light Compensation Level setup ........................................................................... 214
Page 25
-25-
60) Dark Buster setup ....................................................................................................................... 214
61) Dark Buster Level setup ............................................................................................................. 214
Caution...................................................................................................................................... 214
Video & Image – OSD: .............................................................................................................. 216
Revision History ....................................................................................................................... 216
Introduction .............................................................................................................................. 216
OSD URI .................................................................................................................................. 216
OSD Parameter ......................................................................................................................... 216
Example .................................................................................................................................... 217
1) get the current setting ....................................................................................................... 217
2) OSD setup for each stream ............................................................................................... 217
3) OSD transparency setup ................................................................................................... 217
4) OSD title setup ................................................................................................................. 217
5) OSD title text setup .......................................................................................................... 217
6) OSD subtitle text setup ..................................................................................................... 217
7) OSD title coordinate setup................................................................................................ 217
8) OSD date&time setup ....................................................................................................... 217
9) OSD date&time coordinate setup ..................................................................................... 217
10) OSD background setup ................................................................................................... 217
Caution...................................................................................................................................... 217
Video & Image – Privacy Masking: ........................................................................................... 219
Revision History ....................................................................................................................... 219
Introduction .............................................................................................................................. 219
Video&Image – Privacy Masking URI .................................................................................... 219
Video&Image – Privacy Masking Parameter ........................................................................... 219
Example (Latest F/W) .............................................................................................................. 220
1) get the current information ............................................................................................... 220
2) Privacy Masking setup ..................................................................................................... 220
3) Privacy Masking Region setup ......................................................................................... 220
4) Privacy Masking Region Parameter modify ..................................................................... 221
5) Privacy Masking Region remove ..................................................................................... 222
Example (Old F/W) .............................................................................................................. 222
1) get the current information ............................................................................................... 222
2) Privacy Masking setup ..................................................................................................... 222
3) Privacy Masking Region create ........................................................................................ 222
4) Privacy Masking Region modify ...................................................................................... 222
5) Privacy Masking Region remove ..................................................................................... 223
6) Privacy Masking all .......................................................................................................... 223
Caution...................................................................................................................................... 223
Video & Image – Basic: ............................................................................................................. 224
Revision History ....................................................................................................................... 224
Introduction .............................................................................................................................. 224
Video & Image – Basic URI ..................................................................................................... 224
Video & Image – Basic Parameter ........................................................................................... 224
Example .................................................................................................................................... 225
1) get the current setting ....................................................................................................... 225
2) Capture Resolution setup .................................................................................................. 226
3) Codec setup for each Stream ............................................................................................ 226
4) Resolution setup for each Stream ..................................................................................... 226
5) Frame per Second setup.................................................................................................... 227
6) Bitrate Control setup......................................................................................................... 227
Page 26
-26-
7) Bitrate setup .................................................................................................................................. 227
8) Quality setup ................................................................................................................................. 227
9) GOP (Group of Picture) setup .......................................................................................... 228
Caution...................................................................................................................................... 228
Page 27
-27-
Audio
Version
Date
Comment
1.00
2014-10-01
Initial version
1.01
2015-05-22
Added changes related to Xarina Entry
1.01e
2015-05-22
English Trans la tio n
1.02
2016-01-28
Add Xarina Entry Audio Codec AAC
Case G711- 64
Case AAC - 32, 48, 64, 96
Case G711- 8000: 8KHz
Case AAC - 48000: 48KHz
12, 9, 6, 3, 0, -3, -6, -9, -12 : Input Decibel
1, 2, 3, 4, 5, 6, 7, 8, 9, 10 : Input Value
9, 6, 3, 0, -3, -6, -9, -12, -15, -18, -24 : Output Decibel
1, 2, 3, 4, 5, 6, 7, 8, 9, 10 : Output Value
Date: 2016. 12. 13
Revision History
Introduction
This Chapter defines the detailed setup procedure for the Audio and Back Channel Audio.
Audio URI
http://”camera ipaddress”/audio/audio.php
Back Channel Audio URI
http://”camera ipaddress”/audio/back_channel_audio.php
Audio Parameter
Parameter Type Value
Version: 1.02
total_snd_ch integer (ro) Number of available channels being set
snd#_enable boolean 0 : Off, 1 : On
snd#_codec string G711A, G711U, AAC
snd#_bitrate integer
snd#_samplerate integer
snd#_in integer 0 : Internal AMP, 1 : External AMP
snd#_in_gain float
snd#_in_mute boolean 0 : Off, 1 : On
snd#_out_gain float
snd#_out_mute boolean 0 : Off, 1 : On
snd#_2way boolean 0 : Off, 1 : On
snd#_2way_use boolean (ro) 0 : Free, 1 : Occupied
snd#_in_auto boolean 0 : Off, 1 : On
* ‘#’ : Audio Channel number
Page 28
-28-
Back Channel Audio Parameter
snd#_back_channel_audio_statu
s
Parameter Type Value
integer 0 : Free, 1 : Occupied
* ‘#’ : Audio Channel number
Examples
1) get the current setting
get the Audio setting
• http://”camera ipaddress”/audio/audio.php?app=get
get the Back Channel Audio setting
• http://”camera ipaddress”/audio/back_channel_audio.php?app=get
2) Audio Enable setup
http://”camera ipaddress”/audio/audio.php?app=set&snd1_enable=0
http://”camera ipaddress”/audio/audio.php?app=set&snd1_enable=1
3) Audio Codec setup
Case G711
http://”camera ipaddress”/audio/audio.php?app=set&snd1_codec=G711A
http://”camera ipaddress”/audio/audio.php?app=set&snd1_codec=G711U
Case AAC
http://”camera ipaddress”/audio/audio.php?app=set&snd1_codec=AAC
4) Audio Bitrate setup
Case G711
http://”camera ipaddress”/audio/audio.php?app=set&snd1_bitrate=64
Case AAC
http://”camera ipaddress”/audio/audio.php?app=set&snd1_bitrate=32
http://”camera ipaddress”/audio/audio.php?app=set&snd1_bitrate=48
http://”camera ipaddress”/audio/audio.php?app=set&snd1_bitrate=64
http://”camera ipaddress”/audio/audio.php?app=set&snd1_bitrate=96
5) Audio Sampling Rate setup
Case G711
http://”camera ipaddress”/audio/audio.php?app=set&snd1_samplerate=8000
Case AAC
http://”camera ipaddress”/audio/audio.php?app=set&snd1_samplerate=48000
6) Audio Input setup
http://”camera ipaddress”/audio/audio.php?app=set&snd1_in=0
http://”camera ipaddress”/audio/audio.php?app=set&snd1_in=1
7) Audio Input Volume setup
a. Input Decibel setup
Page 29
-29-
INPUT_GAIN_DECIB
EL
OUTPUT_GAIN_DECI
BEL
INPUT_GAIN_VALU
E
http://”camera ipaddress”/audio/audio.php?app=set&snd1_in_gain=12.0
http://”camera ipaddress”/audio/audio.php?app=set&snd1_in_gain=-12
b. Input Value setup
http://”camera ipaddress”/audio/audio.php?app=set&snd1_in_gain=10
http://”camera ipaddress”/audio/audio.php?app=set&snd1_in_gain=1
* Please refer to Caution
8) Audio Input Mute setup
http://”camera ipaddress”/audio/audio.php?app=set&snd1_in_mute=0
http://”camera ipaddress”/audio/audio.php?app=set&snd1_in_mute=1
9) Back Channel Audio Enable setup
http://”camera ipaddress”/audio/audio.php?app=set&snd1_2way=0
http://”camera ipaddress”/audio/audio.php?app=set&snd1_2way=1
10) Back Channel Audio Volume setup
a. Output Decibel setup
http://”camera ipaddress”/audio/audio.php?app=set&snd1_out_gain=9.0
http://”camera ipaddress”/audio/audio.php?app=set&snd1_out_gain=-9
b. Output Value setup
http://”camera ipaddress”/audio/audio.php?app=set&snd1_out_gain=10
http://”camera ipaddress”/audio/audio.php?app=set&snd1_out_gain=1
* Please refer to Caution
11) Back Channel Audio Mute setup
http://”camera ipaddress”/audio/audio.php?app=set&snd1_out_mute=0
http://”camera ipaddress”/audio/audio.php?app=set&snd1_out_mute=1
12) Audio Input Auto Enable setup
http://”camera ipaddress”/audio/audio.php?app=set&snd1_in_auto=0
http://”camera ipaddress”/audio/audio.php?app=set&snd1_in_auto=1
.
.
Caution
You can check the current setting by refering to following items in the response to http://”camera
ipaddress”/config.txt.
Item Value Description
aud_option
INNER_AMP • snd#_in can be set to Internal AMP
EXTERNAL_AMP • snd#_in can be set to External AMP
• snd#_in_gain can be set Input Decibel
• snd#_out_gain can be set Output Decibel
• snd#_in_gain can be set Input Value
Page 30
-30-
OUTPUT_GAIN_VAL
UE
• snd#_out_gain can be set Output Value
G711U, G711A • snd#_codec can be set G711 Audio Codec
AAC • snd#_codec can be set AAC Audio Codec
• snd#_enable, snd#_codec, snd#_bitrate,
AUD
snd#_samplerate, snd#_in, snd#_in_gain,
snd#_in_mute items can be checked and set.
option
• snd#_2way_use value can be check
AUD_OUT
INNER_AUD • snd#_in_auto item can be checked and set
• snd#_out_gain, snd#_out_mute, snd#_2way
items can be checked and set
Page 31
-31-
Config.txt
Version
Date
Comment
1.00
2015-01-16
Initial version
1.00e
2015-01-22
English Trans la tio n
1.01
2015-02-12
Add Manual White Balance
1.01e
2015-02-15
Apply Additional
Add AF Module, PT Module F / W information
Added HLC and SLDC
Add VPM, LOG information
AIHM adds Time Trigger information
1.05e
2015-07-24
Origin Check information added
Camera Series information added,
Fisheye Model Code information added
Parameter
Type
Value
ver
integer
Config.txt file version
Camera series
X4 : Sharx Security HTNC45xx series camera
name
string
Host name
ipv4
string
Camera IP ver. 4 address
ipv6
string
Camera IP ver. 6 address
device_name
string
Device name
input
string
Max resolution, ex) 704x576
firmware
string
Firmware version
model
string
Internal project name, not customer visible
customer
string
Manufacturer name as shown on customer packaging
model_customer
string
Model name as shown on customer packaging
mac
string
Camera MAC address
rtsp_port
integer
RTSP port number
http_port
integer
HTTP port number
HTTP(S) mode,
2 : HTTP & HTTPS
tv_mode
string
TV out mode
Date: 2015. 12. 17
Revision History
1.03e 2015-06-15
1.04e 2015-07-20
1.06e 2015-12-17
Introduction
This chapter describes the overview of Config.txt and the meanings of the Parameters.
Config.txt URI
http://”camera ipaddress”/config.txt
Config.txt Parameters
1) Parameters
Version: 1.06e
series string
https_mode integer
X2 : Sharx Security HTNC44xx series camera
0 : HTTP
1 : HTTPS
Page 32
-32-
ntsc : NTSC
pal : PAL
total_ch
integer
Number of video channels
total_strm
integer
Number of video streams
ch#_strm#_uri
string
RTSP stream URI
ch#_strm#_codec string
RTSP video stream codec name
MJPEG : Motion JPEG
ch#_strm#_res
integer
RTSP video stream resolution
ch#_strm#_fps
integer
RTSP video stream framerate
ch#_strm#_bitrate
integer
RTSP video stream bitrate
RTSP video stream bitrate-control
cbr : CBR
ch#_strm#_gop
integer
RTSP video stream GOP size
total_snd_ch
integer
Number of audio channels
Audio codec name
G711U : G.711 U-law
snd#_bitrate
string
Audio bitrate
snd#_samplerate
string
Audio sampling rate
snd#_2way_use
boolean
Back channel audio availability
alarm_in
integer
Number of alarm in
alarm_out
integer
Number of alarm out
total_manual_trigger
integer
Number of manual trigger
onvif_service_uri
string
ONVIF service URI
mobile-stream
string
MJPEG stream for mobile streaming
Motorized function support description
Description types are in 2) Motorized option
DHCP IP address usage in Wired network
off : not use
recored_ver
string
Playback API version
DHCP IP address usag e in Wireless netw o rk
off : not use
openvpn_ip
string
OpenVPN IP address
total_preset
integer
Number of presets
total_tour
integer
Number of tours
total_auto_scan
integer
Number of autoscans
total_pattern
integer
Number of patterns
total_privacy_zone
integer
Number of privacy zone
H264BP : H.264 Baseline Profile
H264MP : H.264 Main Profile
H264HP : H.264 High Profile
MPEG4SP : MPEG4 Simple Profile
MPEG4ASP : MPEG4 Advanced Simple
Profile
ch#_strm#_ratecontrol string
snd#_codec string
m_ptz_option string
wire_dhcp string
vbr : VBR,
G726 : G.726
G711A : G.711 A-law
on : use
wireless_dhcp string
on : use
Page 33
-33-
ptz_option string
RS-485 support description,
Description types are in 3) RS-485 option
function support description of PTZ camera,
Description types are in 4) PTZ option
VCA function support description,
Description types are in 5) VCA option
vca_sw_ver
string
VCA software version
vca_hw_ver
string
VCA hardware version
camera_mod_sw_ver
string
AF Module Software Version
ptz_mod_sw_ver
string
PT Module Software Version
Fisheye Camera’s lens model description
L1028KDRW
Fisheye Camera’s lens model code description
L1028KDRW : 2
Camera function support description,
Description types are in 6) Option
Option
Description
ZOOM
Zoom in/out support
FOCUS
Focus control support
ZOOM_TRACKING
Zoom tracking support
PAN
Pan move support
TILT
Tilt move support
STOP
Move stop support
PRESET_GO
Preset go support
TOUR_GO
Tour go support
PRESET_SAVE
Preset save support
Option
Description
RS485_IN
RS485 Input support
RS485_OUT
RS485 Output support
PRESET_GO
preset go support via RS485
PRESET_SAVE
preset save support via RS485
TOUR_GO
tour go support via RS485
AUTO_SCAN_GO
auto scan go support via RS485
PATTERN_GO
pattern save support via RS485
PTZ_POSITION
PTZ position Get/Set support via RS485
Option
Descrition
builtin_ptz_option string
vca_option string
fisheye_lens_model string
fisheye_lens_model_code
options string
integer
2) Motorized options
3) RS-485 options
IMV1-1/3
IMV1-1/3 : 1
4) PTZ options
RS485_IN RS485 Input support
Page 34
-34-
RS485_OUT RS485 Output support
PRESET_GO
preset go support
PRESET_SAVE
preset save support
PRESET_CTRL
preset control support
TOUR_GO
tour go support
TOUR_CTRL
tour modify support
AUTO_SCAN_GO
auto scan go support
AUTO_SCAN_CTRL
auto scan modify support
PATTERN_GO
pattern go support
PATTERN_CTRL
pattern modify support
PTZ_POSITION
PTZ position Get/Set support
Option
Descrition
ABSENT
Absent support
UPDATE
VCA software update support
Option
Descrition
5) VCA options
LINE_DETECTOR Line detector support
FIELD_DETECTOR Filed detector support
6) Options
BNC BNC connector video output existence
ALARM_IN Alarm in support
ALARM_OUT Alarm out support
RELAY_OUTPUT Alarm out 의 relay output support
HW_RESET Camera 에 factory default button existence
LED Status LED existence
LED_CTRL Status LED control support
AEAWB AE, AWB support
DAY_NIGHT Day & Night Mode support
BRIGHTNESS Brightness control support
CONTRAST Contrast control support
SATURATION Saturation control support
HUE Hue control support
SHARPNESS Sharpness control support
FLIP Flip control support
MIRROR Mirror control support
NR Noise reduction support
WDR Wide dynamic range support
Page 35
-35-
DEFOG Defog support
VMD Video motion detection support
PTZ PTZ control support via RS485
BUILTIN_PTZ PTZ control support for Built-in PTZ camera
OSD_CTRL on screen display control support at Video out
OSD_DISPLAY_CTRL on screen display control support in Video stream
FTP FTP&JPEG support at Event In
SMTP SMTP support at Event In
MULTI_STREAM multiple video stream support
MULTI_CODEC Multiple video codec support
SSL SSL support
MANUAL_TRIGGER Manu a l Trigger support at Event In
IP_FILTER IP filter support
DDNS DDNS support
UPNP UPNP support
ZEROCONF Zero configuration IP support
BONJOUR Bonjour support
ONBOOT on boot support at Event In
VIDEO_LOSS video loss support at Event In
INNER_AUD audio support using Internal audio chip
AUD audio support using External audio chip
AUD_OUT Back channel audio support
INNER_MIC Mic is internal or attached to the camera
AUD_ALERT audio alert support in Event out
ONVIF ONVIF support
RECORD Event out record support
RECORD_SCHEDULE Record record schedule support
HTTP_NOTIFY Event out HTTP notification support
NETWORK_LOSS network loss support at Event in
M_PTZ Motorized function support
SMART_FOCUS Smart focus support
IR IR support
VMODE_CTRL NTSC, PAL interchangeable
CAPTURE_CTRL resolution change support for Sensor ISP
AUD_DETECTION audio detection support at Event in
Page 36
-36-
TAMPERING tampering support at Eve n t in
PTZ_MOD_UPDATE
PTZ Module firmware update support
PRIVACY_ZONE
Privacy zone support
VMD_UNI_SENSITIVITY
sensitivity setup support for entire Motion detection area
MWB
Manual WB support
HLC
Support HLC function
SLDC
Support SLDC function
VPM
VPM support
LOG
Log support
AIHM
AIHM support
TIME_TRIGGER
Time trigger support
ORIGIN_CHECK
Schedule Origin check support
options
PTZ
RS485 available
LIGHT light support at Event out
PIR PIR support at Event in
WIRELESS Wireless network support
LIVE_PUSH Live push support
EVENT_PUSH Event push support
VSAAS VSAAS support
EVENT_NOTI XML notification support at Event out
BOOST Boost support at Event out
NOTIFY_SERVER Notification server support at Event out
FISHEYE Fish-eye camera
FACE_DETECT Face detector support
VCA Video content analysis support, refer to VCA option for details
MASK Privacy mask support
AISLE Aisle support
PMASK_TYPE masking type selectable for Privacy mask
CAM_MOD_UPDATE AF Module firmware update support
Example
1) get the current setting
http://”camera ipaddress”/config.txt
Page 37
-37-
Dome Configuration
Version
Date
Comment
1.00
2014-09-26
Initial version
0 : Preset, Tour Position Disable
1 : Preset, Tour position Enable
[Preset]
1 ~ 8 : Xarina2 PTZ Camera
0|1|2
2 : Tour
Dome – Home Function:
Revision History
Introduction
This Chapter defines the detailed setup procedure for the Home Function.
Home Function URI
http://”camera ipaddress”/ptz/home_function.php
Home Funct ion Parameter
Parameter Type Value
method string get_list
home_function integer 0 : None, 1 : Preset, 2 : Tour
Version : 1.00
Date : 2014. 09. 26
home_number_list string (ro) configured Preset number or Tour number
preset_home_number integer (ro) 0 : Preset Home position number
home_number_set boolean
0 ~ 16 : Xarina2 Box Camera
home_number integer
home_wating_time integer 10 ~ 600
home_function_use boolean 0 : Home Function Off, 1 : Home Function On
home_function_list string (ro) none|preset|tour
home_function_val_list string (ro)
def_home_wating_time integer (ro) 60
min_home_wating_time integer (ro) 10
0 ~ 240 : Xarina2 PTZ Camera
[Tour]
0 : None
1 : Preset
max_home_wating_time integer (ro) 600
Page 38
-38-
number of configurable Preset
241 : Xarina2 PTZ Camera
number of configurable Tour
8 : Xarina2 PTZ Camera
Examples
1) get the current setting
http://”camera ipaddress”/ptz/home_function.php?app=get
http://”camera ipaddress”/ptz/home_function.php?app=get&method=get_list
2) Home Function setup
http://”camera ipaddress”/ptz/home_function.php?app=set&home_function_use=0
http://”camera ipaddress”/ptz/home_function.php?app=set&home_function_use=1
3) Home Function Waiting Time setup
http://”camera ipaddress”/ptz/home_function.php?app=set&home_waiting_time=10
http://”camera ipaddress”/ptz/home_function.php?app=set&home_waiting_time=60
4) Home Function Type setup
http://”camera ipaddress”/ptz/home_function.php?app=set&home_function=0
http://”camera ipaddress”/ptz/home_function.php?app=set&home_function=1
http://”camera ipaddress”/ptz/home_function.php?app=set&home_function=2
5) Home Function number setup
“home_function” parameter 1 (Preset)…
http://”camera ipaddress”/ptz/home_function.php?app=set&home_number=0
http://”camera ipaddress”/ptz/home_function.php?app=set&home_number=110
“home_function” parameter = 2 (Tour)…
http://”camera ipaddress”/ptz/home_function.php?app=set&home_number=1
http://”camera ipaddress”/ptz/home_function.php?app=set&home_number=8
* if the “home_function” parameter is 1 (Preset) , the configurable minimum “home_number”
parameter is 0 and,
* If the “home_function” parameter is 2 (Tour) , the configurable minimum
“home_number”param ete r is 1
6) Home Function number set setup
http://”camera ipaddress”/ptz/home_function.php?app=set&home_number_set=0
http://”camera ipaddress”/ptz/home_function.php?app=set&home_number_set=1
Caution
You must check the following values in the response to http://”camera ipaddress”/config.txt
Item Value Explanation
option BUILTIN_PTZ Home Function setup available
total_preset 0, 16, 241
total_tour 0, 8
0 : None PTZ
16 : Xarina2 Box Camera
0 : None PTZ
Page 39
-39-
Page 40
-40-
Dome – Motor Setup:
Version
Date
Comment
1.00
2014-09-29
Initial version
Revision History
Introduction
This Chapter defines the detailed setup procedure for the Motor Setup
Motor Setup URI
http://”camera ipaddress”/ptz/motor.php
Motor Setup Parameter
Parameter Type Value
http_port integer (ro) HTTP port
https_port integer (ro) HTTPS port
propotional boolean 0 : Not support, 1 : Support
Version : 1.00
Date : 2014. 09. 29
def_propotional integer 0 : Off, 1 : On
max_pan_speed integer 1 ~ 38 : configured Max Pan Speed
min_max_pan_speed integer (ro) 1 : configurable minimum Max Pan Speed
max_max_pan_speed integer (ro) 38 : configurable maximum Max Pan Speed
def_max_pan_speed integer (ro) 9 : Default Max Pan Speed
max_tilt_speed integer 1 ~ 30 : configured Max Tilt Speed
min_max_tilt_speed integer (ro) 1 : configured Minimum Max Tilt Speed
max_max_tilt_speed integer (ro) 30 : configured Mazimum Max Tilt Speed
def_max_tilt_speed integer (ro) 9 : Default Max Tilt Speed
Examples
1) get the current setting
http://”camera ipaddress”/ptz/motor.php?app=get
2) Motor Setup Propotional setup
http://”camera ipaddress”/ptz/motor.php?app=set&propotional=0
http://”camera ipaddress”/ptz/motor.php?app=set&propotional=1
3) Motor Setup Max Pan Speed setup
http://”camera ipaddress”/ptz/motor.php?app=set&max_pan_speed=10
Page 41
-41-
4) Motor Setup Max Tilt Speed setup
http://”camera ipaddress”/ptz/motor.php?app=set&max_tilt_speed=10
Caution
You must check the following values in the response to http://”camera ipaddress”/config.txt
Item Value Explanation
option BUILTIN_PTZ Motor Setup available
Page 42
-42-
Dome – Preset:
Version
Date
Comment
1.00
2014-09-18
Initial version
get_num : check setting value
preset_go : selected Preset working
Setable maximum Preset number
240 : Xarina2 FASTRAX, MINITRAX Camera
Auto : Auto Focusing mode
Auto|Manual : two mode selectable
Revision History
Introduction
This Chapter defines the detailed setup procedure for the Preset.
Preset URI
http://”camera ipaddress”/ptz/preset.php
Preset Parameter
Parameter Type Value
Version : 1.00
Date : 2014. 09. 18
method string
preset_number integer 0 ~ 241
preset_title string Prese t ti tle
preset_af_mode integer 0 : Auto, 1 : Manual
preset_speed integer 1 ~ 8 (Only available for FASTRAX5)
http_port integer (ro) HTTP port number
https_port integer (ro) HTTPS port number
min_preset_number integer (ro) 0 : configurable minimum Preset number
max_preset_number integer (ro)
preset_home integer (ro) 0 : Preset Home Position number
preset_af_mode_list string (ro)
preset_af_mode_val_list string (ro) 0 : Auto, 1 : Manual
create : Preset creation and modification
delete : Preset deletion
16 : Xarina2 Box Camera
Manual : Manual Focusing mode
def_preset_af_mode integer (ro) Default Focusing mode value
def_preset_speed integer (ro) preset default speed
min_preset_speed integer (ro) preset min speed
max_preset_speed integer (ro) preset max speed
preset_list integer (ro) Preset number list
Page 43
-43-
Examples
1) get configurable Preset value
http://”camera ipaddress”/ptz/preset.php?app=get
http://”camera ipaddress”/ptz/preset.php?app=get&method=get_num
2) get the current setting
http://”camera ipaddress”/ptz/preset.php?app=get&preset_number=1
http://”camera ipaddress”/ptz/preset.php?app=get&method=get_num&preset_number=1
3) Preset creation
create a Preset by using the “method=create” parameter
http://”camera ipaddress”/ptz/preset.php?app=set&method=create
• preset_number is configurable minimum number,
preset_title “PRESET ‘pres et_number’”,
preset_af_mode is 0 (Auto : default),
preset_speed is 4 (default)
create a Preset by assigning a specific Preset Number
http://”camera ipaddress”/ptz/preset.php?app=set&method=create&preset_number=3
• preset_title is “PRESET ‘preset_number’”,
preset_af_mode is 0 (Auto : default),
preset_speed is 4 (default)
create a Preset by assigning a specific Preset title
http://”camera ipaddress”/ptz/preset.php?app=set&method=create&preset_title=BASIC_PRESET
• preset_number is configurable minimum number
preset_af_mode is 0 (Auto : default),
preset_speed is 4 (default)
create a Preset by assigning a preset_af_mode
http://”camera ipaddress”/ptz/preset.php?app=set&method=create&preset_af_mode=0
http://”camera ipaddress”/ptz/preset.php?app=set&method=create&preset_af_mode=1
• preset_number is configurable e minimum number,
preset_title is “PRESET ‘preset_number’”,
preset_speed is 4 (default)
create a Preset by assigning a preset_speed
http://”camera ipaddress”/ptz/preset.php?app=set&method=create&preset_speed=8
• preset_number is configurable minimum number
preset_title is “PRESET ‘preset_number’”,
preset_af_mode is 0 (Auto : default).
4) Preset deletion
http://”camera ipaddress”/ptz/preset.php?app=set&method=delete&preset_number=2
* the “preset_number” parameter should be included when deleting a preset
5) Preset modification
http://”camera
ipaddress”/ptz/preset.php?app=set&method=create&preset_number=1&preset_title=MODIFY_P
RESET1&preset_af_mode=1
Page 44
** the “preset_number” parameter should be included when modifying a preset, pre-configured
max_preset_number
value
value also should be included .
6) Preset movement
http://”camera ipaddress”/ptz/preset.php?app=set&method=preset_go&preset_number=3
http://”camera ipaddress”/ptz/preset.php?app=set&method=preset_go&preset_number=4
* the “preset_number” parameter should be included when deleting a preset
Caution
You must check the following values in the response to http://”camera ipaddress”/config.txt
item Value Explanation
option BUILTIN_PTZ Preset setup available
total_preset
* The setup and test of the “preset_speed” parameters are only available in FASTRAX5 product.
The maximum number of configurable Preset
Page 45
-45-
Dome – Privacy Zone:
Version
Date
Comment
1.00
2014-10-06
Initial version
create : Privacy Zone creation
move : move to Privacy Zone
Revision History
Introduction
This Chapter defines the detailed setup procedure for the Privacy Zone.
Privacy Zone URI
http://”camera ipaddress”/ptz/privacy_zone.php
Privacy Zone Parameter
Parameter Type Value
http_port integer (ro) HTTP Port number
https_port integer (ro) HTTPS Port number
privacy_num_max integer (ro) configurable number of Privacy Zone
masking#_title string (ro) Privacy Zone title
Version : 1.00
Date : 2014. 10. 06
masking#_set boolean (ro)
masking#_enable boolean (ro)
method string
masking_number integer Preferred Privacy Zone number
masking_title string Preferred Privacy Zone title
masking_enable Boolean
masking_set boolean (ro)
* ‘#’ means Privacy Zone List number(1~8).
0 : configured Privacy Zone “Off”
1 : configured Privacy Zone “On”
0 : configured Privacy Zone- Masking Zone “Off”
1 : configured Privacy Zone- Masking Zone “On”
modify : Privacy Zone modification
delete : Privacy Zone deletion
0 : Privacy Zone Off
1 : Privacy Zone On
0 : Privacy Zone Setting Off
1 : Privacy Zone Setting On
Examples
1) get configurable privacy Zone List
http://”camera ipaddress”/ptz/privacy_zone.php?app=get
Page 46
2) Privacy Zone creation
http://”camera ipaddress”/ptz/privacy_zone.php?app=set&method=create&masking_number=1
* the parameter for the creation of Privacy Zone are only “method” and “masking_number” .
* if Privacy Zone has been created, “masking_title”, “masking_enable”, “masking_set” parameter
values will be automatically set and you will see a response like the one below
res=200&masking_number=1&masking_title=MASK-1&masking_enable=1&masking_set=1
3) Privacy Zone modification
http://”camera
ipaddress”/ptz/privacy_zone.php?app=set&method=modify&masking_number=1&masking_tit
le=Zone1&masking_enable=0
* the parameters for the modification of Privacy Zone are only “method”, “masking_number”,
“masking_title”, “masking_enable”
* when modifying the Privacy Zone, “masking_number” info should be included and it must be
exsisting number.
* when modifying “masking_title”, you can input maximum 12 letter in alphabet or number
4) Privacy Zone deletion
http://”camera ipaddress”/ptz/privacy_zone.php?app=set&method=delete&masking_number=1
* the parameter for deleting Privacy Zone are only “method” and “masking_number”.
* if Privacy Zone has been deleted, “masking_title”, “masking_enable”, “masking_set” parameter
values will be automatically set and you will see a response like the one below
res=200&masking_number=1&masking_title=MASK-1&masking_enable=0&masking_set=0
5) PTZ movement
http://”camera ipaddress”/ptz/privacy_zone.php?app=set&method=move&masking_number=1
* PTZ will move to the pointed position by the combination of “method=move” and configured
“masking_number” parameter
Caution
You must check the following value in the response to http://”camera ipaddress”/config.txt
item Value Explanation
option BUILTIN_PTZ Privacy Zone setup available
Page 47
-47-
Dome – RS485:
Version
Date
Comment
1.00
2014-10-01
Initial version
0 : Auto
2 : PELCOPD
0 : 2400
4 : 38400
0 : None
2 : Even
0 : Answer sending Off
1 : Answer sending On
Revision History
Introduction
This Chapter defines the detailed setup of the RS485.
RS485 URI
http://”camera ipaddress”/ptz/comm.php
RS485 Parameter
Parameter Type Value
min_comm_id integer (ro) 1
max_comm_id integer (ro) 3999
comm_id integer 1 ~ 3999
Version : 1.00
Date : 2014. 10. 01
comm_protocol integer
1 : 4800
comm_baud integer
comm_parity integer
comm_dome_answer boolean
2 : 9600
3 : 19200
1 : Odd
Examples
1) get the current setting
http://”camera ipaddress”/ptz/comm.php?app=get
2) DOME ID setup
http://”camera ipaddress”/ptz/comm.php?app=set&comm_id=1
3) Protocol setup
http://”camera ipaddress”/ptz/comm.php?app=set&comm_protocol=0
http://”camera ipaddress”/ptz/comm.php?app=set&comm_protocol=2
4) Baudrate setup
http://”camera ipaddress”/ptz/comm.php?app=set&comm_baud=0
Page 48
-48-
http://”camera ipaddress”/ptz/comm.php?app=set&comm_baud=1
http://”camera ipaddress”/ptz/comm.php?app=set&comm_baud=2
http://”camera ipaddress”/ptz/comm.php?app=set&comm_baud=3
http://”camera ipaddress”/ptz/comm.php?app=set&comm_baud=4
5) Parity setup
http://”camera ipaddress”/ptz/comm.php?app=set&comm_parity=0
http://”camera ipaddress”/ptz/comm.php?app=set&comm_parity=1
http://”camera ipaddress”/ptz/comm.php?app=set&comm_parity=2
6) Dome Answer setup
http://”camera ipaddress”/ptz/comm.php?app=set&comm_dome_answer=0
http://”camera ipaddress”/ptz/comm.php?app=set&comm_dome_answer=1
Caution
You must check the following values in the response to http://”camera ipaddress”/config.txt
item Value Explanation
option BUILTIN_PTZ, PTZ RS485 setup available (only for FASTRAX3 )
Page 49
-49-
Dome – System Menu:
Version
Date
Comment
1.00
2014-10-02
Initial version
1.01
2015-07-22
Add Schedule Origin Check
1.01e
2015-07-24
English Trans la tio n
Parameter
Type
Value
status
string (wo)
“origin_check” : Origin Check status
0, 1, 2, 3
3 : STATUS_DONE - Origin Check completed
Revision History
Introduction
This Chapter defines the detailed setup procedure for the System Menu.
System Menu URI
http://”camera ipaddress”/ptz/system_menu.php
System Menu Parameter
0 : STATUS_ERROR - error
origin_check integer (ro)
1 : STATUS_IDLE - Origin Check idle
2 : STATUS_RUNNING - Origin Check running
Version: 1.01e
Date: 2015. 07. 24
method string (wo)
filename string (wo) HEXA file name for Upgrade
wait_time integer (ro) 420(unit : second)
camera_type string (ro) PTZ Camera type
hw_ver string (ro) H/W version
sw_ver string (ro) S/W version
sys_calibration boolean 0 : Not Support, 1 : Support
enable_origin_check boolean (ro) 0 : Off, 1 : On
enable_camera_update boolean (ro) 0 : Not Support, 1 : Support
enable_dome_update boolean (ro) 0 : Not Support, 1 : Support
sys_enable_schedule boolean 0 : Off, 1 : On
sys_enable_monthly boolean 0 : Off, 1 : On
sys_enable_weekly boolean 0 : Off, 1 : On
sys_enable_daily boolean 0 : Off, 1 : On
“origin_check” : Origin Check start
“update_camera” : upgrade AF Module
sys_monthly_day integer Monthly day ( 1 ~ 31 )
Page 50
-50-
sys_weekly_dayofwee
k
integer
Weekly day of week ( 0 ~ 6 )
0 : Sun, 1 : Mon, 2 : Tue, 3 : Wed, 4 : Thu, 5 : Fri, 6 : Sat
sys_monthly_time string Monthly time ( HH:MM:SS )
sys_weekly_time string Weekly time ( HH:MM:SS )
sys_daily_time string Daily time ( HH:MM:SS )
* In Type column, “ro” means Read-Only and “wo” means Write-Only.
* In “app=get” Query transmission, if the “status” parameter is presents, you must use
“origin_check” for the status param eter.
* In “app=get” Query transmission, if the “status” parameter is not included, you can check the
following parameters.
“camera_type”, “enable_origin_check”, “enable_camera_update”, “enable_dome_update”,
“hw_ver”, “sw_ver”, “sys_calibration”
* In “app=set” Query trsnamission, if the “method” parameter is presents, Origin Check or Upgrade
function can only be used.
* In “app=set” Query transmission, if the “method” parameter is not included, you can setup
“sys_calibration” parameter.
Examples
1) Get the current PTZ Camera information and settings
http://”camera ipaddress”/ptz/system_menu.php?app=get
2) Check current Origin Check function status
http://”camera ipaddress”/ptz/system_menu.php?app=get&status=origin_check
3) Calibration setup
http://”camera ipaddress”/ptz/system_menu.php?app=set&sys_calibration=0
http://”camera ipaddress”/ptz/system_menu.php?app=set&sys_calibration=1
4) Origin Check start
http://”camera ipaddress”/ptz/system_menu.php?app=set&method=origin_check
5) Enable Schedule Origin Check setup
http://”camera ipaddress”/ptz/system_menu.php?app=set&sys_enable_schedule=0
http://”camera ipaddress”/ptz/system_menu.php?app=set&sys_enable_schedule=1
6) Schedule Origin Check setup
a. Enable Schedule Origin Check setup
http://”camera ipaddress”/ptz/system_menu.php?app=set&sys_enable_schedule=0
http://”camera ipaddress”/ptz/system_menu.php?app=set&sys_enable_schedule=1
b. Enable Monthly setup
http://”camera ipaddress”/ptz/system_menu.php?app=set&sys_enable_monthly=0
http://”camera ipaddress”/ptz/system_menu.php?app=set&sys_enable_monthly=1
c. Enable Weekly setup
http://”camera ipaddress”/ptz/system_menu.php?app=set&sys_enable_weekly=0
Page 51
http://”camera ipaddress”/ptz/system_menu.php?app=set&sys_enable_weekly=1
d. Enable Daily setup
http://”camera ipaddress”/ptz/system_menu.php?app=set&sys_enable_daily=0
http://”camera ipaddress”/ptz/system_menu.php?app=set&sys_enable_daily=1
e. Monthly Day setup
http://”camera ipaddress”/ptz/system_menu.php?app=set&sys_monthly_day=20
f. Weekly Day of week setup
http://”camera ipaddress”/ptz/system_menu.php?app=set&sys_weekly_dayofweek=3
g. Monthly Time setup
http://”camera ipaddress”/ptz/system_menu.php?app=set&sys_monthly_time=23:50:00
h. Weekly Time setup
http://”camera ipaddress”/ptz/system_menu.php?app=set&sys_weekly_time=01:20:00
i. Daily Time setup
http://”camera ipaddress”/ptz/system_menu.php?app=set&sys_daily_time=05:31:00
7) FA Module F/W Upgrade
http://”camera
ipaddress”/ptz/system_menu.php?app=set&method=update_camera&f ile name=”F/W file
name”
* If you use the “method=update_camera” parameter, you must include the “filename” parameter.
* Please refer to “F/W Upload” for F/W Upload.
F/W Upload
File upload uses HTML POST method, specifically multipart/form-data type of MIME protocol for
file transmission.
a. The following items must be defined in HTML POST type message.
Request URL
http://”camera
ipaddress”/ptz/system_menu.php?app=set& m ethod =up date_ camera&filename=”F/W file
name”
Encoded Login account
Content-Type : multipart/form-data; boundary=-----------“separator”
* boundary is a separator marking the start and end when uploading multiple files '-' in the
above.
Content-Length : “uploading file size”
* Please refer to the following URL for further details of POST type.
POST message : <http://tools.ietf.org/html/rfc2616>
b. The following items must be defined in the MIME Protocol message for file transmission.
Content-Disposition : form-data; name=file_camera_upgrade; filename="uploading file path"
Content-Type : application/octet-stream
Page 52
c. For further information about multipart/form-data, please refer to the following URL’s.
multipart/form-data : <http://www.w3.org/TR/html401/interact/forms.html>
multipart/form-data RFC : <http://www.ietf.org/rfc/rfc2045.txt>
Caution
You can check current settings by referring to the following values in the response to http://”camera
ipaddress”/config.txt.
Item Value Description
BUILTIN_PTZ System Menu setup available
options
ORIGIN_CHECK Schedule Origin Check setup available
Page 53
-53-
Dome – Tour:
Version
Date
Comment
1.00
2014-09-25
Initial version
Parameter
Type
Value
get_num : check configured value
preset_go : Preset movement
configured Tour List
Revision History
Introduction
This Chapter defines the detailed setup procedure for the Tour
Tour URI
http://”camera ipaddress”/ptz/tour.php
Tour Parameter
get_preset : Preset creation and modification
method string
tour_number integer 1 ~ 8 : configurable Tour number
get_tour : deletion of configured Preset
create : Tour creation
delete : Tour dele tion
Version : 1.00
Date : 2014. 09. 25
tour_title string Tour tile
tour_repeat_time integer
tour_sequence integer
tour_tourlist string
http_port integer (ro) HTTP port number
https_port integer (ro) HTTPS port number
min_tour_number integer (ro) 1 : configurable minimum Tour number
max_tour_number integer (ro) 8 : configurable maximum Tour number
0 : Tour continuous movement
1 ~ 90 : Tour number
0 : Tour in Forward direction
1 : Tour in Reverse direction
enable : ‘0’ Non preset, ‘1’ Set preset
index : ‘0’ ~ ‘241’ Preset index
dwell : ‘0’ ~ ‘99’ dwell t im e
pan speed : ‘1’ ~ ‘32’
tilt speed : ‘1’ ~ ‘32’
zoom speed : ‘1’ ~ ‘8’
def_dwell integer (ro) 3 : Defaut Dwell Time
Page 54
-54-
dwell_min integer (ro) 0 : configurable minimum Dwell T ime
Default Pan/Tilt speed
8 : Xarina2 PTZ Camera(FASTRAX5 )
dwell_max integer (ro) 99 : configurable maximum Dwell Time
def_pt_speed integer (ro)
pt_speed_min integer (ro) 1 : configurable minimum Pan/Tilt speed
pt_speed_max integer (ro) 8 : configurable maximum Pan/Tilt speed
def_z_speed integer (ro) 7 : default Zoom speed
z_speed_min integer (ro) 1 : configurable minimum Zoom speed
z_speed_max integer (ro) 8 : configurable maximum Zoom speed
tour_tourlist_max integer (ro) 100 : Tour List number
def_tour_repeat_time integer (ro) 0 : default Tour Repeat time
tour_repeat_time_max integer (ro) 90 : maximum Tour Repeat time
def_tour_sequence integer (ro) 1 : default Tour movement(Forward)
tour_list string (ro) usable Tour number list
preset_list string (ro) Preset number list available
5 : Xarina2 FASTRAX5
Examples
1) get configurable Tour value
http://”camera ipaddress”/ptz/tour.php?app=get
http://”camera ipaddress”/ptz/tour.php?app=get&method=get_num
2) get configured Preset List
http://”camera ipaddress”/ptz/tour.php?app=get&method=get_preset
3) get configured Tour List
http://”camera ipaddress”/ptz/tour.php?app=get&method=get_tour
4) get specific configured Tour List
http://”camera ipaddress”/ptz/tour.php?app=get&method=get_num&tour_number=1
http://”camera ipaddress”/ptz/tour.php?app=get&method=get_num&tour_number=2
5) Tour creation
Tour creation by assigning specific Tour Number
http://”camera ipaddress”/ptz/tour.php?app=set&method=create&tour_number=2
• tour_title “TOUR ‘tour_number’”,
tour_repeat_time is 0 (Continuous : default)
tour_sequence is 0 (Forward : default).
tour_tourlist should be configured separately.
Page 55
-55-
Tour creation by assigning specific Tour Title
http://”camera
ipaddress”/ptz/tour.php?app=set&method=create&tour_number=1&tour_title=BASIC_TOUR
• tour_repeat_time is 0 (Continuous : default),
tour_sequence is 0 (Forward : default)
tour_tourlist should be configured separately
* “tour_number” parameter should be stated when creating the Tour
Tour creation by assigning specific tour_repeat_time
http://”camera
ipaddress”/ptz/tour.php?app=set&method=create&tour_number=3&tour_repeat_time=5
• tour_title “TOUR ‘tour_number’”,
tour_sequence is 0 (Forward : default).
tour_tourlist should be configured separately.
* “tour_number” parameter should be stated when creating the Tour.
Tour creation by assigning specific tour_sequence
http://”camera
ipaddress”/ptz/tour.php?app=set&method=create&tour_number=4&tour_sequence=1
• tour_title “TOUR ‘tour_number’”,
tour_repeat_time is 0 (Continuous : default).
tour_tourlist should be configured separately ..
“tour_number” parameter should be stated when creating the Tour.
Tour creation by assigning specific tour_tourlist
• Preset “Home” position,
http://”camera
ipaddress”/ptz/tour.php?app=set&method=create&tour_number=5&tour_tourlist=1|0|5|32|32
|7
tour_title = “TOUR ‘tour_number’”,
tour_repeat_time is 0 (Continuous : default),
tour_sequence is 0 (Forward : default).
* “tour_number” parameter parameter should be stated when creating the Tour.
• specific Preset position
http://”camera
ipaddress”/ptz/tour.php?app=set&method=create&tour_number=5&tour_tourlist=1|1|5|32|32
|7
tour_title = “TOUR ‘tour_number’”,
tour_repeat_time is 0 (Continuous : default),
tour_sequence is 0 (Forward : default)
* Preset position should be pre-configured to check proper tour functionality
* “tour_number” parameter should be stated when creating the Tour..
• multiple Preset position
http://”camera
ipaddress”/ptz/tour.php?app=set&method=create&tour_number=5&tour_tourlist=1|1|5|32|
32|7,1|0|5|32|32|7,1|2|5|32|32|7
tour_title “TOUR ‘tour_number’”,
Page 56
tour_repeat_time is 0 (Continuous : default),
tour_sequence is (Forward : default)
* Preset position should be pre-configured to check proper tour functionality
* “tour_number” parameter should be stated when creating the Tour.
6) Tour deletion
http://”camera ipaddress”/ptz/tour.php?app=set&method=delete&tour_number=1
* the “tour_number” parameter should be included when deleting the Tour.
7) Tour modification
http://”camera
ipaddress”/ptz/tour.php?app=set&method=create&tour_number=1&tour_title=MODIFY_TOU
R1&tour_sequence=2&tour_repeat_time=1&tour_tourlist=1|0|3|32|32|7,1|1|3|32|32|7
* the “tour_number” parameter should be included when modifying the Tour..
8) Tour movement
http://”camera ipaddress”/ptz/control.php?tour=1
http://”camera ipaddress”/ptz/control.php?tour=2
* Tour can be controlled with ptz/control.php.
Caution
You must check the following values in the response to http://”camera ipaddress”/config.txt
item Value Explanation
option BUILTIN_PTZ Tour setup available
total_tour max_tour_number value Maximum number of configurable Tour
Page 57
-57-
Dome – View Angle:
Version
Date
Comment
1.00
2014-10-02
Initial version
FASTRAX5
FASTRAX3,
Maximum number of Supported PTZ Flip 1 :
5 : FASTRAX3, MINITRAX3
Default number of Supported PTZ Flip
2 : FASTRAX3, MINITRAX3
Supported PTZ Flip List
FASTRAX3 : "Off,Auto,90,100,110,120"
Date : 2014. 10. 02
Revision History
Introduction
This Chapter defines the detailed setup procedure for the View Angle.
View Angle URI
http://”camera ipaddress”/ptz/view_angle.php
View Angle Parameter
Parameter Type Value
http_port integer (ro) HTTP port number
https_port integer (ro) HTTPS port number
tiltoverangle integer -10 ~ 10 : configurable Tilt angle
min_tiltoverangle integer (ro) -10 : Minimum angle of Supported Tilt
Version : 1.00
max_tiltoverangle integer (ro) 10 : Maximum angle of Supported Tilt angle
def_tiltoverangle integer (ro) 0 : Default angle of Supported Tilt
0 ~ 5 : Supported PTZ Flip number
0 : Off
1 : Auto
ptz_flip integer
min_ptz_flip integer (ro) 0 : Minimum number of Supported PTZ Flip
max_ptz_flip integer (ro)
def_ptz_flip integer (ro)
ptz_flip_label string (ro)
FASTRAX5
1 : FASTRAX5
FASTRAX5 : “Off,Auto”
MINITRAX3
0 : Off
1 : Auto
2 : 90°
3 : 100°
4 : 110°
5 : 120°
Page 58
-58-
MINITRAX3 : "Off,Auto,90,100,110,120"
Examples
1) get the current setting
http://”camera ipaddress”/ptz/view_angle.php?app=get
2) Tilt Angle Limit setup
http://”camera ipaddress”/ptz/view_angle.php?app=set&tiltoverangle=10
http://”camera ipaddress”/ptz/view_angle.php?app=set&tiltoverangle=-10
3) Flip setup
http://”camera ipaddress”/ptz/view_angle.php?app=set&ptz_flip=0
http://”camera ipaddress”/ptz/view_angle.php?app=set&ptz_flip=1
http://”camera ipaddress”/ptz/view_angle.php?app=set&ptz_flip=2
* In case of FASTRAX5, only 0 or 1 value is allowed for “ptz_flip” parameter
Caution
You must check the following values in the response to http://”camera ipaddress”/config.txt
Item Value Explanation
option BUILTIN_PTZ View Angle setup available
Page 59
-59-
Event
Version
Date
Comment
1.00
2015-09-06
Initial version
1.00e
2015-09-06
English Trans la tio n
1.01
2016-12-16
Added Dwell Time, AIHM Server API
Parameter
Type
Value
aihm_time
integer
1 ~ 180
Event – AIHM:
Revision History
Introduction
This Chapter defines the detailed setup procedure for the AIHM.
AIHM URI
http://”camera ipaddress”/event/aihm.php
AIHM Parameter
aihm_enable boolean 0 : Disable, 1 : Enable
Version: 1.01e
Date: 2016. 12. 16
record_status_check boolean 0 : Disable, 1 : Enable
format_event boolean 0 : Disable, 1 : Enable
aihm_server_enable boolean 0 : Disable, 1 : Enable
Examples
1) get the current setting
http://”camera ipaddress”/event/aihm.php?app=get
2) AIHM setup
http://”camera ipaddress”/event/aihm.php?app=set&aihm_enable=0
http://”camera ipaddress”/event/aihm.php?app=set&aihm_enable=1
3) AIHM record status check setup
http://”camera ipaddress”/event/aihm.php?app=set&record_status_check=0
http://”camera ipaddress”/event/aihm.php?app=set&record_status_check=1
4) AIHM format event setup
http://”camera ipaddress”/event/aihm.php?app=set&format_event=0
http://”camera ipaddress”/event/aihm.php?app=set&format_event=1
5) AIHM server setup
http://”camera ipaddress”/event/aihm.php?app=set&aihm_server_enable=0
http://”camera ipaddress”/event/aihm.php?app=set&aihm_server_enable=1
Page 60
6) AIHM dwell time setup
Item
Value
Explanation
options
AIHM
AIHM function available
http://”camera ipaddress”/event/aihm.php?app=set&aihm_time=1
http://”camera ipaddress”/event/aihm.php?app=set&aihm_time=180
Caution
You must check the following values in the response to http: //”camera ipaddress”/config.txt
Page 61
-61-
Event – Alarm In:
Version
Date
Comment
1.00
2014-01-23
Initial version
1.00e
2014-03-03
English Trans la tio n
Parameter
Type
Value
alarm_in_#_enable
boolean
0 : Disable, 1 : Enable
alarm_in_#_type
string
NO : Normal Open, NC : Normal Close
alarm_in_#_time
integer
1 ~ 180
Item
Value
Explanation
alarm_in
0 or 1 or 2 or ……
Number of Alarm In ports available
options
ALARM_IN
Alarm In available
Version: 1.00e
Date: 2014. 03. 03
Revision History
Introduction
This Chapter defines the detailed setup procedure for the Alarm In.
Alarm In URI
http://”camera ipaddress”/event/alarm_in.php
Alarm In Parameter
alarm_in_count integer(ro) Number of alarm in available
Examples
1) get the current setting
http://”camera ipaddress”/event/alarm_in.php?app=get
2) Alarm In setup
http://”camera ipaddress”/event/alarm_in.php?app=set&alarm_in_1_enable=0
http://”camera ipaddress”/event/alarm_in.php?app=set&alarm_in_1_enable=1
3) Alarm In type setup
http://”camera ipaddress”/event/alarm_in.php?app=set&alarm_in_1_type=NO
http://”camera ipaddress”/event/alarm_in.php?app=set&alarm_in_1_type=NC
4) Alarm In dwell time setup
http://”camera ipaddress”/event/alarm_in.php?app=set&alarm_in_1_time=1
http://”camera ipaddress”/event/alarm_in.php?app=set&alarm_in_1_time=180
Caution
You must check the following values in the response to http://”camera ipaddress”/config.txt.
Page 62
-62-
Event – Alarm Out:
Version
Date
Comment
1.00
2014-01-24
Initial version
1.00e
2014-03-03
English Trans la tio n
Parameter
Type
Value
alarm_out_enable
boolean
0 : Disable, 1 : Enable
alarm_out_type
string
NO : Normal Open, NC : Normal Close
Item
Value
Explanation
alarm_out
0 or 1 or 2 or ……
Number of Alarm Out ports available
options
ALARM_OUT
Alarm Out available
Version: 1.00e
Date: 2014. 03. 03
Revision History
Introduction
This Chapter defines the detailed setup procedure for the Alarm Out.
Alarm Out URI
http://”camera ipaddress”/event/alarm_out.php
Alarm Out Parameter
Examples
1) get the current setting
http://”camera ipaddress”/event/alarm_out.php?app=get
2) Alarm Out setup
http://”camera ipaddress”/event/alarm_out.php?app=set&alarm_out_enable=0
http://”camera ipaddress”/event/alarm_out.php?app=set&alarm_out_enable=1
3) Alarm Out type setup
http://”camera ipaddress”/event/alarm_out.php?app=set&alarm_out_type=NO
http://”camera ipaddress”/event/alarm_out.php?app=set&alarm_out_type=NC
Caution
You must check the following values in the response to http://”camera ipaddress”/config.tx
Page 63
-63-
Event – Audio Alert:
Version
Date
Comment
1.00
2014-02-13
Initial version
1.00e
2014-03-17
English Trans la tio n
audio_alert_time#
integer (ro)
play time
audio_alert_bitrate#
integer (ro)
bitrate (kbps)
Item
Value
Explanation
Revision History
Introduction
This Chapter defines the detailed setup procedure for the Audio Alert.
Audio Alert URI
http://”camera ipaddress”/event/audio_alert.php
Audio Alert Parameter
Parameter Type Value
method string sav e, test, rem o v e
audio_alert_enable boolean 0 : Off, 1 : On
audio_alert_index integer 1, 2, 3
audio_alert_file# string (ro) file name
Version: 1.00e
Date: 2014. 03. 17
audio_alert_size# integer (ro) file size (max : 512KB)
* ‘#’ in Parameters “audio_alert_XXX#” means the index number (1,2,3) of audio alert file.
Examples
1) get the current setting
http://”camera ipaddress”/event/audio_alert.php?app=get
2) Audio Alert setup
http://”camera ipaddress”/event/audio_alert.php?app=set&method=save&audio_alert_enable=1
http://”camera ipaddress”/event/audio_alert.php?app=set&method=save&audio_alert_enable=0
3) Audio file remove
http://”camera ipaddress”/event/audio_alert.php?app=set&method=remove&audio_alert_index=1
http://”camera ipaddress”/event/audio_alert.php?app=set&method=remove&audio_alert_index=2
http://”camera
ipaddress”/event/audio_alert.php?app=set&method=remove&audio_alert_index=3
4) Audio Alert Test method
http://”camera ipaddress”/event/audio_alert.php?app=set&method=test&audio_alert_index=1
Caution
You must check the following values in the respon se to http://”camera ipaddress”/config.txt
Page 64
-64-
options
AUD_ALERT
Audio Alert function available
* In order to use Audio Alert, both “Audio” and “bidirectional Audio” should be enabled.
1) Reminder for the Audio Alert file upload
a. File upload uses multipart/form-data of MIME protocol HTML tag. A prior knowledge of the
file name is needed for uploading.
b. Be sure to review HTML “FORM” tag transmission for File upload. Please refer to the
following URL for “FORM” tag.
FORM tag : <http://www.w3.org/TR/html401/interact/forms.html>
c. Figure 1 shows how to apply the multipart/form-data on HTML “FORM” tag.
[Figure 1]
d. Figure 2 shows how to apply the upload filename.
[Figure 2]
* filename should include the extension.
e. HTTP message should be transmitted via POST form, and message example is Figure 3.
[Figure 3]
* “audio_alert_index” is an index number, and Figure 3 shows upload by index.
f. For more information about multipart/form-data, please refer the following URL.
multipart/form-data : <http://www.w3.org/TR/html401/interact/forms.html>
multipart/form-data RFC : <http://www.ietf.org/rfc/rfc2045.txt>
Page 65
-65-
Event – Audio detection:
Version
Date
Comment
1.00
2014-01-23
Initial version
1.00e
2014-03-17
English Trans la tio n
Parameter
Type
Value
boolean
integer
integer
Revision History
Introduction
This Chapter defines the detailed setup procedure for the Audio detection.
Audio detection URI
http://”camera ipaddress”/event/audio_detection.php
Audio detection Parameter
Version: 1.00e
Date: 2014. 03. 17
audio_detection_enable
audio_detection_level
audio_detection_time
0 : Off, 1 : On
1 : Low, 2 : Middle, 3 : High
1 ~ 180
Examples
1) get the current setting
http://”camera ipaddress”/event/audio_detection.php?app=get
2) Audio detection setup
http://”camera ipaddress”/event/audio_detection.php?app=set&audio_detection_enable=1
http://”camera ipaddress”/event/audio_detection.php?app=set&audio_detection_enable=0
3) Audio detection level setup
http://”camera ipaddress”/event/audio_detection.php?app=set&audio_detection_level=1
http://”camera ipaddress”/event/audio_detection.php?app=set&audio_detection_level=2
http://”camera ipaddress”/event/audio_detection.php?app=set&audio_detection_level=3
4) Audio detection Dwell time setup
http://”camera ipaddress”/event/audio_detection.php?app=set&audio_detection_time=3
http://”camera ipaddress”/event/audio_detection.php?app=set&audio_detection_time=0
If the audio_detection_time is assigned to a value less than 1, the value is set to the minimum
value (1).
http://”camera ipaddress”/event/audio_detection.php?app=set&audio_detection_time=183
* If audio_detection_time is assigned to a value bigger than 180, the value is set to the maximum
value (180).
Caution
You must check the following v alues in the response to http://”camera ipaddress”/config.txt
Page 66
-66-
Item
Value
Explanation
options
AUD_DETECTIO
N
Audio Detection function available
Page 67
-67-
Event – Boost:
Version
Date
Comment
1.00
2014-02-26
Initial version
1.00e
2014-03-17
English Trans la tio n
Parameter
Type
Value
boost_enable
boolean
0 : Off, 1 : On
boost_stream
integer
1 : stream1, 2 : stream2, 3 : stream3
boost_framerate
integer
1 ~ 30
boost_bitrate
integer
100 ~ 8000 (unit : 100Kbps)
boost_quality
integer
1 ~ 100
ch#¹_strm#²_maxfps
integer (ro)
Max selectable Framerate value
ch#¹_strm#²_fps
integer
1 ~ ch#¹_strm#²_maxfps
ch#¹_strm#²_maxbr
integer (ro)
Max selectable Bitrate value
ch#¹_strm#²_bitrate
integer
100 ~ ch#¹_strm#²_maxbr
ch#¹_strm#²_ratecontrol
string
cbr : CBR, vbr : VBR
ch#¹_strm#²_quality
integer
1 ~ 100
Revision History
Introduction
This Chapter defines the detailed setup procedure for the Boost.
Boost URI
http://”camera ipaddress”/event/boost.php
Boost Parameter
Version: 1.00e
Date: 2014. 03. 17
* Parameters with the prefix “boost” are for user setup, and Parameters with prefix “ch#¹_strm#²”
are current setting.
* ‘#¹’ and ‘#²’ are explained in “Caution”
Examples
1) get the current setting
http://”camera ipaddress”/event/boost.php?app=get
2) Boost setup
http://”camera ipaddress”/event/boost.php?app=set&boost_enable=0
http://”camera ipaddress”/event/boost.php?app=set&boost_enable=1
3) Boost stream setup
http://”camera ipaddress”/event/boost.php?app=set&boost_stream=3
4) Boost stream1 Normal Condition setup
a. Framerate setup
http://”camera
ipaddress”/event/boost.php?app=set&boost_enable=1&boost_stream=1&ch1_strm1_fps=25
Page 68
* If URI includes boost_stream, the value of boost_stream must match the number at the end of
“ch1_strm” for proper operation.
http://”camera ipaddress”/event/boost.php?app=set&boost_enable=1&ch1_strm1_fps=5
* If URI does not include boost_stream, the current stream number must match the number at the
end of “ch1_strm” for proper operation.
b. Bitrate control setup
http://”camera
ipaddress”/event/boost.php?app=set&boost_enable=1&boost_stream=1&ch1_strm1_ratecontr
ol=cbr
* If URI includes boost_stream, the value of boost_stream must match the number at the end of
“ch1_strm” for proper operation.
http://”camera
ipaddress”/event/boost.php?app=set&boost_enable=1&ch1_strm1_ratecontrol=vbr
* If URI does not include boost_stream, the current stream number must match the number at the
end of “ch1_strm” for proper operation.
c. Bitrate setup
http://”camera
ipaddress”/event/boost.php?app=set&boost_enable=1&boost_stream=1&ch1_strm1_bitrate=4
000
* If URI includes boost_stream, the value of boost_stream must match the number at the end of
“ch1_strm” for proper operation.
* ch1_strm1_bitrate should be set in order of 100.
http://”camera ipaddress”/event/boost.php?app=set&boost_enable=1&ch1_strm1_bitrate=4000
* If URI does not include boost_stream, the current stream number must match the number at the
end of “ch1_strm” for proper operation.
5) Boost stream2 Normal Condition setup
a. Framerate setup
http://”camera
ipaddress”/event/boost.php?app=set&boost_enable=1&boost_stream=2&ch1_strm2_fps=25
* If URI includes boost_stream, the value of boost_stream must match the number at the end of
“ch1_strm” for proper operation.
http://”camera ipaddress”/event/boost.php?app=set&boost_enable=1&ch1_strm2_fps=25
* If URI does not include boost_stream, the current stream number must match the number at the
end of “ch1_strm” for proper operation.
b. Quality setup
http://”camera
ipaddress”/event/boost.php?app=set&boost_enable=1&boost_stream=2&ch1_strm2_quality=
30
* If URI includes boost_stream, the value of boost_stream must match the number at the end of
“ch1_strm” for proper operation.
http://”camera ipaddress”/event/boost.php?app=set&boost_enable=1&ch1_strm2_quality=50
* If URI does not include boost_stream, the current stream number must match the number at the
end of “ch1_strm” for proper operation.
6) Boost stream3 Normal Condition setup
a. Framerate setup
Page 69
http://”camera
Item
Value
Explanation
options
BOOST
Boost function available
total_ch
1 or 2 or 3 or …
Total number of channels
Total number of streams (1 ~
total_strm)
ch#¹_strm#²_fps
1 ~ ch#¹_strm#²_maxfps
current framerate setting
ipaddress”/event/boost.php?app=set&boost_enable=1&boost_stream=3&ch1_strm3_fps=25
* If URI includes boost_stream, the value of boost_stream must match the number at the end of
“ch1_strm” for proper operation.
http://”camera ipaddress”/event/boost.php?app=set&boost_enable=1&ch1_strm3_fps=5
* If URI does not include boost_stream, the current stream number must match the number at the
end of “ch1_strm” for proper operation.
b. Bitrate control setup
http://”camera
ipaddress”/event/boost.php?app=set&boost_enable=1&boost_stream=3&ch1_strm3_ratecontr
ol=cbr
* If URI includes boost_stream, the value of boost_stream must match the number at the end of
“ch1_strm” for proper operation.
http://”camera
ipaddress”/event/boost.php?app=set&boost_enable=1&ch1_strm3_ratecontrol=vbr
* If URI does not include boost_stream, the current stream number must match the number at the
end of “ch1_strm” for proper operation.
c. Bitrate setup
http://”camera
ipaddress”/event/boost.php?app=set&boost_enable=1&boost_stream=3&ch1_strm3_bitrate=0
0
* If URI includes boost_stream, the value of boost_stream must match the number at the end of
“ch1_strm” for proper operation.
* ch1_strm3_bitrate should be set in order of 100.
http://”camera ipaddress”/event/boost.php?app=set&boost_enable=1&ch1_strm3_bitrate=2000
* If URI does not include boost_stream, the current stream number must match the number at the
end of “ch1_strm” for proper operation.
7) Boost Condition setup
a. Framerate setup
http://”camera ipaddress”/event/boost.php?app=set&boost_framerate=20
b. Bitrate setup
http://”camera ipaddress”/event/boost.php?app=set&boost_bitrate=200
* boost_bitrate should be set in order of 100.
c. Quality setup
http://”camera ipaddress”/event/boost.php?app=set&boost_quality=80
Caution
1) You must check the following values in the respo nse to http://”camera ipaddress”/config.txt
total_strm 1 or 2 or 3 or …
Page 70
-70-
* ch#¹_strm#²_maxfps is explained
below
ch#¹_strm#²_bitrate 1 ~ ch#¹_strm#²_maxbr
current bitrate setting
below
ch#¹_strm#²_ratecontrol
cbr or vbr
current bitrate control setting
ch#¹_strm#²_quality
1 ~ 100
current Quality setting
○○○”
* ch#¹_strm#²_maxbr is explained
2) Explanation on “ch#¹_strm#²_
in Parameter column of table in “3. Boost Paramet er”
a. #¹ is the channel number between 1 and total_ch.
b. #² is the stream number between 1 and total_strm.
c. ○○○ can be fps, maxfps, bitrate, maxbr, ratecontrol, or quality, and used in combination with
valid “#¹” and “#²”. The followings are usage examples.
• ch#¹_strm#²_fps,
ch#¹_strm#²_maxfps,
ch#¹_strm#²_bitrate,
ch#¹_strm#²_maxbr,
ch#¹_strm#²_ratecontrol,
ch#¹_strm#²_quality
* You can check ch#¹_strm#²_maxfps via “4. Example” “1) get the current setting only if
ch#¹_strm#²_fps item exists in config.txt response.
* You can check ch#¹_strm#²_maxbr via “4. Example” “1) get the current setting only if
ch#¹_strm#²_bitrate item exists in config.txt response.
3) When you setup Boost stream Normal Condition, boost_enable value must be equal to 1.
If you change Normal Condition setting, Setup - Video & Image – Basic settings will be changed
accordingly.
Page 71
-71-
Event – Map:
Version
Date
Comment
1.00
2013-12-11
Initial version
1.00e
2014-03-18
English Trans la tio n
1.01e
2015-05-21
Event Map Renewal
1.02e
2015-07-20
AIHM, Time Trigger Update
Parameter
Type
Value
event_in_cnt
integer(ro)
Number of currently stored event
event_max_cnt
integer(ro)
Event of the maximum that can be stored
event_list
string
Event In ID|Name|Event In|Event Out
method
string
add, modify, remove
event_name
string
Event name
event_in_id
integer(ro)
Please refer to Event In ID
event_in_name
string
Event In name
event_out_smtp
boolean
0(Disable), 1(Enable)
event_out_smtp_en#
boolean
0(Disable), 1(Enable)
event_out_smtp_list#
string(ro)
E-Mail Address for Event Out
event_out_smtp_title
string
E-Mail Title for tha t Ev en t
event_out_smtp_msg
string
E-Mail Message for that Event
event_out_alarm
boolean
0(Disable), 1(Enable)
event_out_ftp
boolean
0(Disable), 1(Enable)
integer(ro)
boolean
event_out_http
boolean
0(Disable), 1(Enable)
Revision History
Introduction
This Chapter defines the detailed setup procedure for the Event Map.
Event Map setup is divided into List retrieve, List add, List remove, and List modify.
Event – Map
http://”camera ipaddress”/event/map.php
http://”camera ipaddress”/event/event_pop.php
* In some F/W versions, map.php may cause an Error.
Video & Ima ge – Image Parameter
Version: 1.02e
Date: 2015. 07. 20
event_out_ftp_count
event_out_ftp_server#
Number of FTP server
0(Disable), 1(Enable)
Page 72
-72-
event_out_http_msg
string
Message String for HTTP Notification
event_out_audio boolean 0(Disable), 1(Enable)
event_out_audio_file
integer
1 ~ 3
event_out_preset
boolean
0(Disable), 1(Enable)
event_out_preset_num
integer
1 ~ 255
event_out_preset_home
boolean
0(false), 1(true)
event_out_record
boolean
0(false), 1(true)
event_out_event_push
boolean
0(false), 1(true)
event_out_light
boolean
0(false), 1(true)
event_out_event_noti
boolean
0(false), 1(true)
event_out_boost
boolean
0(false), 1(true)
02
03
Event In ID
A B Description C D Description
00
01
05
06
08
09
10
Motion Channel 1
Motion Channel 2
Motion Channel 3
Motion Channel 4
Alarm Input
Manual Trigger
On Boot
Video Loss
Network Loss
00 ~ 07
00
01
00
01
02
03
00
00 ~ 04
00
00
01
Motion Region ID
Alarm Input 1
Alarm Input 2
Manual Trigger 1
Manual Trigger 2
Manual Trigger 3
Manual Trigger 4
N/A
Video Channel
N/A
Motion
Tracking
11
Analytic
02
03
04
05
Cross
Abandon
Removal
Enter
Page 73
-73-
12
13
Audio Detection
00
N/A
17
AIHM
00
N/A
18
Time Trigger
00
Time Trigger 1
01
Time Trigger 2
02
Time Trigger 3
03
Time Trigger 4
PIR
00
Examples
1) get the current setting
http://”camera ipaddress”/event/map.php?app=get
2) Method setup
add : http://”camera
ipaddress”/event/event_pop.php?app=set&method=add&event_in_id=1000&event_name=test
&event_out_alarm=1
modify : http://”camera
ipaddress”/event/event_pop.php?app=set&method=modify&event_in_id=1000&event_name=t
est2
remove : http://”camera
ipaddress”/event/event_pop.php?app=set&method=remove&event_in_id=1000
3) Event name setup
http://”camera
ipaddress”/event/event_pop.php?app=set&method=add&event_in_id=1000&event_name=test
&event_out_alarm=1
http://”camera
ipaddress”/event/event_pop.php?app=set&method=modify&event_in_id=1000&event_name=t
est2
4) Event out SMTP setup
http://”camera
ipaddress”/event/event_pop.php?app=set&method=add&event_in_id=0500&event_name=test
&event_out_smtp=1&event_out_smtp_en1=1&event_out_smtp_en2=1&event_out_smtp_title=
test&event_out_smtp_msg=testmsg
http://”camera
ipaddress”/event/event_pop.php?app=set&method=modify&event_in_id=0500&event_name=t
est&event_out_smtp=1&event_out_smtp_en1=1&event_out_smtp_en2=1&event_out_smtp_tit
le=test&event_out_smtp_msg=testmsg
5) Event out alarm setup
http://”camera
ipaddress”/event/event_pop.php?app=set&method=add&event_in_id=0500&event_name=test
&event_out_alarm=1
http://”camera
ipaddress”/event/event_pop.php?app=set&method=modify&event_in_id=0500&event_name=t
est&event_out_alarm=1
N/A
Page 74
6) Event out FTP setup
http://”camera
ipaddress”/event/event_pop.php?app=set&method=add&event_in_id=0500&event_name=test
&event_out_ftp=1
http://”camera
ipaddress”/event/event_pop.php?app=set&method=modify&event_in_id=0500&event_name=t
est&event_out_ftp=1
* If event_out_ftp is 1 and the camera is T-series, only event_out_ftp is set instead of
event_out_ftp_server1.
7) Event out FTP Server setup
http://”camera
ipaddress”/event/event_pop.php?app=set&method=add&event_in_id=0500&event_name=test
&event_out_ftp_server1=1
http://”camera
ipaddress”/event/event_pop.php?app=set&method=modify&event_in_id=0500&event_name=t
est&event_out_ftp_server1=1
http://”camera
ipaddress”/event/event_pop.php?app=set&method=add&event_in_id=0500&event_name=test
&event_out_ftp_server2=1
http://”camera
ipaddress”/event/event_pop.php?app=set&method=modify&event_in_id=0500&event_name=t
est&event_out_ftp_server2=1
http://”camera
ipaddress”/event/event_pop.php?app=set&method=add&event_in_id=0500&event_name=test
&event_out_ftp_server3=1
http://”camera
ipaddress”/event/event_pop.php?app=set&method=modify&event_in_id=0500&event_name=t
est&event_out_ftp_server3=1
http://”camera
ipaddress”/event/event_pop.php?app=set&method=add&event_in_id=0500&event_name=test
&event_out_ftp_server4=1
http://”camera
ipaddress”/event/event_pop.php?app=set&method=modify&event_in_id=0500&event_name=t
est&event_out_ftp_server4=1
8) Event out HTTP notification setup
http://”camera
ipadderss”/event/event_pop.php?app=set&method=add&event_in_id=0500&event_name=test
&event_out_http=1&event_out_http_msg=test
http://”camera
ipadderss”/event/event_pop.php?app=set&method=modify&event_in_id=0500&event_name=t
est&event_out_http=1&event_out_http_msg=test
9) Event out audio alert setup
http://”camera
ipaddress/event/event_pop.php?app=set&method=add&event_in_id=0500&event_name=test&
event_out_audio=1&event_out_audio_file=1
http://”camera
ipaddress/event/event_pop.php?app=set&method=modify&event_in_id=0500&event_name=te
st&event_out_audio=1&event_out_audio_file=2
Page 75
-75-
10) Event out preset setup
http://”camera
ipaddress”/event/event_pop.php?app=set&method=add&event_in_id=0500&event_name=test
&event_out_preset=1&event_out_preset_num=10&event_out_preset_home=1
http://”camera
ipaddress”/event/event_pop.php?app=set&method=modify&event_in_id=0500&event_name=t
est&event_out_preset=1&event_out_preset_num=20&event_out_preset_home=0
11) Event out record setup
http://”camera
ipaddress”/event/event_pop.php?app=set&method=add&event_in_id=0500&event_name=test
&event_out_record=1
http://”camera
ipaddress”/event/event_pop.php?app=set&method=modify&event_in_id=0500&event_name=t
est&event_out_record=1
12) Event out event push setup
http://”camera
ipaddress”/event/event_pop.php?app=set&method=add&event_in_id=0500&event_name=test
&event_out_event_push=1
http://”camera
ipaddress”/event/event_pop.php?app=set&method=modify&event_in_id=0500&event_name=t
est&event_out_event_push=1
13) Event out light setup
http://”camera
ipaddress”/event/event_pop.php?app=set&method=add&event_in_id=0500&event_name=test
&event_out_light=1
http://”camera
ipaddress”/event/event_pop.php?app=set&method=modify&event_in_id=0500&event_name=t
est&event_out_light=1
14) Event out event notification setup
http://”camera
ipaddress”/event/event_pop.php?app=set&method=add&event_in_id=0500&event_name=test
&event_out_event_noti=1
http://”camera
ipaddress”/event/event_pop.php?app=set&method=modify&event_in_id=0500&event_name=t
est&event_out_event_noti=1
15) Event out boost setup
http://”camera
ipaddress”/event/event_pop.php?app=set&method=add&event_in_id=0500&event_name=test
&event_out_boost=1
http://”camera
ipaddress”/event/event_pop.php?app=set&method=modify&event_in_id=0500&event_name=t
est&event_out_boost=1
16) setup all Maps at once (in case of Error on individual Map setup)
In some F/W versions, individual Map setup may not be supported.
Page 76
http://”camera
Item
Value
Explanation
alarm_in
integer
Number of Event In Alarm
alarm_out
interger
Number of Event Out Alarm
VMD
Event In Motion available
ALARM_IN
Event In Alarm In available
MANUAL_TRIGGER
Event In Manual Trigger available
ONBOOT
Event In On Boot available
VIDEO_LOSS
Event In Video Loss available
NETWORK_LOSS
Event In Network Loss available
PRI
Event In PIR available
AUDIO_DETECTION
Event In Audio Detection available
TIME_TRIGGER
Event In Time Trigger available
AIHM
Event In AIHM available
SMTP
Event Out SMTP available
ALARM_OUT
Event Out Alarm Out available
FTP
Event Out FTP available
HTTP_NOTIFY
Event Out HTTP Notification available
AUD_ALERT
Event Out Audio Alert available
PTZ, BUILTIN_PTZ
Event Out Preset available
RECORD
Event Out Record available
EVENT_PUSH
Event Out Event Push available
LIGHT
Event Out Light available
EVENT_NOTI
Event Out Event Notification available
BOOST
Event Out Boost available
ipaddress”/event/event_pop.php?app=set&method=add&event_in_id=0500&event_name=test&
event_out_smtp=1&event_out_smtp_en1=1&event_out_smtp_title=test&event_out_smtp_msg=
testmsg&event_out_alarm=1&event_out_ftp=1&event_out_http=1&event_out_http_msg=test&
event_out_audio=1&event_out_audio_file=1&event_out_preset=1&event_out_preset_num=10
&event_out_preset_home=1&event_out_record=1&event_out_event_push=1&event_out_light=
1&event_out_event_noti=1&event_out_boost=1
http://”camera
ipaddress”/event/event_pop.php?app=set&method=modify&event_in_id=0500&event_name=te
st&event_out_smtp=1&event_out_smtp_en1=1&event_out_smtp_title=test&event_out_smtp_m
sg=testmsg&event_out_alarm=1&event_out_ftp=1&event_out_http=1&event_out_http_msg=tes
t&event_out_audio=1&event_out_audio_file=1&event_out_preset=1&event_out_preset_num=1
0&event_out_preset_home=1&event_out_record=1&event_out_event_push=1&event_out_light
=1&event_out_event_noti=1&event_out_boost=1
Caution
You must check the following values in the response to http://”camera ipaddress”/config.txt
options
Page 77
-77-
Event – Event Push:
Version
Date
Comment
1.00
2014-01-27
Initial version
1.00e
2014-03-18
English Trans la tio n
Parameter
Type
Value
boolean
integer
integer
integer
string
integer
string
string
Revision History
Introduction
This Chapter defines the detailed setup procedure for the Event Push.
Event Push URI
http://”camera ipaddress”/event/event_push.php
Event Push Parameter
Version: 1.00e
Date: 2014. 03. 18
event_push_enable
event_push_stream
event_push_pre_time
event_push_post_time
event_push_server
event_push_port
event_push_user
event_push_pass
0 : Off, 1 : On
1 : Stream1, 2 : Stream2, 3 : Stream3
0 – 10
0 – 60
Server URL
1 – 65535
User name
User password
Examples
1) Get the current setting
http://”camera ipaddress”/event/event_push.php?app=get
2) Event Push setup
http://”camera ipaddress”/event/event_push.php?app=set&event_push_enable=1
http://”camera ipaddress”/event/event_push.php?app=set&event_push_enable=0
3) Event Push Stream Type setup
http://”camera ipaddress”/event/event_push.php?app=set&event_push_stream=1
http://”camera ipaddress”/event/event_push.php?app=set&event_push_stream=2
http://”camera ipaddress”/event/event_push.php?app=set&event_push_stream=3
Page 78
4) Event Push Pre-event setup
Item
Value
Explanation
options
EVENT_PUSH
Event Push available
http://”camera ipaddress”/event/event_push.php?app=set&event_push_pre_time=3
http://”camera ipaddress”/event/event_push.php?app=set&event_push_pre_time=11
* If the event_push_pre_time is assigned to a value bigger than 10, the value is set to the
maximum value (10).
* If the event_push_pre_time is assigned to a value less than 0, the value is set to the minimum
value (0).
5) Event Push Post-event setup
http://”camera ipaddress”/event/event_push.php?app=set&event_push_post_time=10
http://”camera ipaddress”/event/event_push.php?app=set&event_push_post_time=70
* If the event_push_post_time is assigned to a value bigger than 60, the value is set to the
maximum value (60).
* If the event_push_post_time is assigned to a value less than 0, the value is set to the minimum
value (0).
6) Event Push URL setup
http://”camera ipaddress”/event/event_push.php?app=set&event_push_server=10.0.2.12
7) Event Push Port setup
http://”camera ipaddress”/event/event_push.php?app=set&event_push_port=8080
http://”camera ipaddress”/event/event_push.php?app=set&event_push_port=62311
* If the event_push_port is assigned to a value bigger than 65535, (Error: 400) is returned.
* If the event_push_port is assigned to a value less than 1, (Error: 400) is returned.
8) Event Push User name setup
http://”camera ipaddress”/event/event_push.php?app=set&event_push_user=admin
9) Event Push Password setup
http://”camera ipaddress”/event/event_push.php?app=set&event_push_pass=admin
Caution
You must check the following values in the response to http://”camera ipaddress”/config.txt
Page 79
-79-
Event – Face Detector:
Version
Date
Comment
1.00
2015-01-28
Initial version
1.00e
2015-01-29
English Trans la tio n
Parameter
Type
Value
fdetect_threshold
integer
1 ~ 100
Revision History
Introduction
This Chapter defines the setup procedure for the Face Detector.
Face Detector URI
http://”ipaddress”/event/face_detector.php
Face Detector Parameter
Version : 1.00e
Date : 2015. 01. 29
fdetect_enable boolean
0 : disable, 1 : enable
Examples
1) get the current setting
http://”ipaddress”/event/face_detector.php?app=get
2) face detector enable setup
http://”ipaddress”/event/tampering.php?app=set&fdetect_enable=0 ( disable )
http://”ipaddress”/event/tampering.php?app=set&fdetect_enable=1 ( enable )
3) threshold setup
http://”ipaddress”/event/tampering.php?app=set&fdetect_threshold=1
http://”ipaddress”/event/tampering.php?app=set&fdetect_threshold=50
http://”ipaddress”/event/tampering.php?app=set&fdetect_threshold=100
4) setup face detector at once
http://”ipaddress”/event/tampering.php?app=set&fdetect_enable=1&fdetect_threshold=50
Page 80
-80-
Event – FTP & JPEG:
Version
Date
Comment
1.00
2014-02-11
Initial version
1.00e
2014-03-18
English Trans la tio n
1.01e
2015-05-21
FTP&JPEG renewal
ftp_server_count
integer(ro)
Number of affordable FTP Servers
ftp_path
string
Directory for uploading JPEG images (Deprecated)
ftp#_enable
boolean
0 : Off, 1 : On
ftp#_server
string
Server address
ftp#_port
integer
1 ~ 65535
Revision History
Introduction
This Chapter defines the detailed setup procedure for the FTP & JPEG.
FTP & JPEG URI
http://”camera ipaddress”/event/ftp.php
FTP & JPEG Parameter
Parameter Type Value
ftp_enable boolean 0 : Off, 1 : On
ftp_server string Server address (Deprecated)
Version: 1.01e
Date: 2015. 05. 21
ftp_port integer 1 ~ 65535 (Deprecated)
ftp_mode boolean 0 : Active Mode, 1 : Passive Mode (Deprecated)
ftp_user string User name (Deprecated)
ftp_pass string Password (Deprecated)
ftp_anonymous boolean 0 : Identified, 1 : Anonymous (Deprecated)
jpg_pre_timeout integer 0 ~ 30 (Deprecated)
jpg_pre_fps integer 1 ~ 2 (Deprecated)
jpg_pst_timeout integer 0 ~ 30 (Deprecated)
jpg_pst_fps integer 1 ~ 2 (Deprecated)
jpg_base_name string Prefix file name (Deprecated)
jpg_suffix_name integer 1 : Date/Time, 2 : Sequence Number (Deprecated)
Page 81
-81-
ftp#_mode
boolean
0 : Active Mode, 1 : Passive Mode
ftp#_user
string
User name
ftp#_pass
string
Password
ftp#_anonymous
boolean
0 : Identified, 1 : Anonymous
ftp#_path
string
Directory for uploading JPEG images
ftp#_enable_time_folde
r
boolean
0 : Off, 1 : On
ftp#_time_folder_type
integer
1: Day, 2: Hour, 3: Minute
jpg#_pre_timeout
integer
0 ~ 30
jpg#_pre_fps
integer
1 ~ 2
jpg#_event_fps
integer
1 ~ 2
jpg#_post_timeout
integer
0 ~ 30
jpg#_post_fps
integer
1 ~ 2
jpg#_base_name
string
Prefix file name
jpg#_suffix_name
integer
1 : Date/Time, 2 : Sequence Number
* In order to support older version API, API without Server number is set to be number 1 server.
Examples
1) Get the current setting
http://”camera ipaddress”/event/ftp.php?app=get
2) FTP & JPEG setup
http://”camera ipaddress”/event/ftp.php?app=set&ftp_enable=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp_enable=1
* If ftp_server_count is 1 and the camera is T-series, ftp1_enable is set together.
3) FTP Server usage setup
http://”camera ipaddress”/event/ftp.php?app=set&ftp1_enable=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp1_enable=1
http://”camera ipaddress”/event/ftp.php?app=set&ftp2_enable=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp2_enable=1
http://”camera ipaddress”/event/ftp.php?app=set&ftp3_enable=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp3_enable=1
http://”camera ipaddress”/event/ftp.php?app=set&ftp4_enable=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp5_enable=1
4) FTP & JPEG Server add ress setu p
http://”camera ipaddress”/event/ftp.php?app=set&ftp_server=10.0.2.12
http://”camera ipaddress”/event/ftp.php?app=set&ftp1_server=10.0.2.12
http://”camera ipaddress”/event/ftp.php?app=set&ftp2_server=10.0.2.13
http://”camera ipaddress”/event/ftp.php?app=set&ftp3_server=10.0.2.14
Page 82
http://”camera ipaddress”/event/ftp.php?app=set&ftp4_server=10.0.2.15
5) FTP & JPEG Port setup
http://”camera ipaddress”/event/ftp.php?app=set&ftp_port=8079
http://”camera ipaddress”/event/ftp.php?app=set&ftp1_port=8080
http://”camera ipaddress”/event/ftp.php?app=set&ftp2_port=8081
http://”camera ipaddress”/event/ftp.php?app=set&ftp3_port=8082
http://”camera ipaddress”/event/ftp.php?app=set&ftp4_port=8083
6) FTP & JPE G Pa ss ive mode setup
http://”camera ipaddress”/event/ftp.php?app=set&ftp_mode=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp_mode=1
http://”camera ipaddress”/event/ftp.php?app=set&ftp1_mode=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp1_mode=1
http://”camera ipaddress”/event/ftp.php?app=set&ftp2_mode=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp2_mode=1
http://”camera ipaddress”/event/ftp.php?app=set&ftp3_mode=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp3_mode=1
http://”camera ipaddress”/event/ftp.php?app=set&ftp4_mode=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp4_mode=1
7) FTP & JPEG User name setup
http://”camera ipaddress”/event/ftp.php?app=set&ftp_user=admin
http://”camera ipaddress”/event/ftp.php?app=set&ftp1_user=admin
http://”camera ipaddress”/event/ftp.php?app=set&ftp2_user=admin
http://”camera ipaddress”/event/ftp.php?app=set&ftp3_user=admin
http://”camera ipaddress”/event/ftp.php?app=set&ftp4_user=admin
8) FTP & JPEG Password setup
http://”camera ipaddress”/event/ftp.php?app=set&ftp_pass=admin
http://”camera ipaddress”/event/ftp.php?app=set&ftp1_pass=admin
http://”camera ipaddress”/event/ftp.php?app=set&ftp2_pass=admin
http://”camera ipaddress”/event/ftp.php?app=set&ftp3_pass=admin
http://”camera ipaddress”/event/ftp.php?app=set&ftp4_pass=admin
9) FTP & JPEG Anonymous login setup
http://”camera ipaddress”/event/ftp.php?app=set&ftp_anonymous=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp_anonymous=1
http://”camera ipaddress”/event/ftp.php?app=set&ftp1_anonymous=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp1_anonymous=1
http://”camera ipaddress”/event/ftp.php?app=set&ftp2_anonymous=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp2_anonymous=1
http://”camera ipaddress”/event/ftp.php?app=set&ftp3_anonymous=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp3_anonymous=1
http://”camera ipaddress”/event/ftp.php?app=set&ftp4_anonymous=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp4_anonymous=1
10) FTP & JPEG Remote directory setup
http://”camera ipaddress”/event/ftp.php?app=set&ftp_path=/home1
http://”camera ipaddress”/event/ftp.php?app=set&ftp1_path=/home1
http://”camera ipaddress”/event/ftp.php?app=set&ftp2_path=/home2
Page 83
http://”camera ipaddress”/event/ftp.php?app=set&ftp3_path=/home3
http://”camera ipaddress”/event/ftp.php?app=set&ftp4_path=/home4
11) FTP & JPEG Time folder setup
http://”camera ipaddress”/event/ftp.php?app=set&ftp1_enable_time_folder=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp1_enable_time_folder=1
http://”camera ipaddress”/event/ftp.php?app=set&ftp2_enable_time_folder=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp2_enable_time_folder=1
http://”camera ipaddress”/event/ftp.php?app=set&ftp3_enable_time_folder=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp3_enable_time_folder=1
http://”camera ipaddress”/event/ftp.php?app=set&ftp4_enable_time_folder=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp4_enable_time_folder=1
12) FTP & JPEG JPEG Time folder type setup
http://”camera ipaddress”/event/ftp.php?app=set&ftp1_time_folder_type=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp1_time_folder_type=1
http://”camera ipaddress”/event/ftp.php?app=set&ftp1_time_folder_type=2
http://”camera ipaddress”/event/ftp.php?app=set&ftp2_time_folder_type=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp2_time_folder_type=1
http://”camera ipaddress”/event/ftp.php?app=set&ftp2_time_folder_type=2
http://”camera ipaddress”/event/ftp.php?app=set&ftp3_time_folder_type=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp3_time_folder_type=1
http://”camera ipaddress”/event/ftp.php?app=set&ftp3_time_folder_type=2
http://”camera ipaddress”/event/ftp.php?app=set&ftp4_time_folder_type=0
http://”camera ipaddress”/event/ftp.php?app=set&ftp4_time_folder_type=1
http://”camera ipaddress”/event/ftp.php?app=set&ftp4_time_folder_type=2
13) FTP & JPEG JPEG Pre-event time setup
http://”camera ipaddress”/event/ftp.php?app=set&jpg_pre_timeout=5
http://”camera ipaddress”/event/ftp.php?app=set&jpg1_pre_timeout=5
http://”camera ipaddress”/event/ftp.php?app=set&jpg2_pre_timeout=5
http://”camera ipaddress”/event/ftp.php?app=set&jpg3_pre_timeout=5
http://”camera ipaddress”/event/ftp.php?app=set&jpg4_pre_timeout=5
14) FTP & JPEG JPEG Pre-event FPS setup
http://”camera ipaddress”/event/ftp.php?app=set&jpg_pre_fps=1
http://”camera ipaddress”/event/ftp.php?app=set&jpg_pre_fps=2
http://”camera ipaddress”/event/ftp.php?app=set&jpg1_pre_fps=1
http://”camera ipaddress”/event/ftp.php?app=set&jpg1_pre_fps=2
http://”camera ipaddress”/event/ftp.php?app=set&jpg2_pre_fps=1
http://”camera ipaddress”/event/ftp.php?app=set&jpg2_pre_fps=2
http://”camera ipaddress”/event/ftp.php?app=set&jpg3_pre_fps=1
http://”camera ipaddress”/event/ftp.php?app=set&jpg3_pre_fps=2
http://”camera ipaddress”/event/ftp.php?app=set&jpg4_pre_fps=1
http://”camera ipaddress”/event/ftp.php?app=set&jpg4_pre_fps=2
15) FTP & JPEG JPEG Event FPS setup
http://”camera ipaddress”/event/ftp.php?app=set&jpg1_event_fps=1
http://”camera ipaddress”/event/ftp.php?app=set&jpg1_event_fps=2
http://”camera ipaddress”/event/ftp.php?app=set&jpg2_event_fps=1
http://”camera ipaddress”/event/ftp.php?app=set&jpg2_event_fps=2
Page 84
http://”camera ipaddress”/event/ftp.php?app=set&jpg3_event_fps=1
Item
Value
Explanation
options
FTP
FTP & JPEG available
http://”camera ipaddress”/event/ftp.php?app=set&jpg3_event_fps=2
http://”camera ipaddress”/event/ftp.php?app=set&jpg4_event_fps=1
http://”camera ipaddress”/event/ftp.php?app=set&jpg4_event_fps=2
16) FTP & JPEG JPEG Post-event time setup
http://”camera ipaddress”/event/ftp.php?app=set&jpg_pst_timeout=5
http://”camera ipaddress”/event/ftp.php?app=set&jpg1_post_timeout=5
http://”camera ipaddress”/event/ftp.php?app=set&jpg2_post_timeout=5
http://”camera ipaddress”/event/ftp.php?app=set&jpg3_post_timeout=5
http://”camera ipaddress”/event/ftp.php?app=set&jpg4_post_timeout=5
17) FTP & JPEG JPEG Post-event FPS setup
http://”camera ipaddress”/event/ftp.php?app=set&jpg_pst_fps=1
http://”camera ipaddress”/event/ftp.php?app=set&jpg_pst_fps=2
http://”camera ipaddress”/event/ftp.php?app=set&jpg1_post_fps=1
http://”camera ipaddress”/event/ftp.php?app=set&jpg1_post_fps=2
http://”camera ipaddress”/event/ftp.php?app=set&jpg2_post_fps=1
http://”camera ipaddress”/event/ftp.php?app=set&jpg2_post_fps=2
http://”camera ipaddress”/event/ftp.php?app=set&jpg3_post_fps=1
http://”camera ipaddress”/event/ftp.php?app=set&jpg3_post_fps=2
http://”camera ipaddress”/event/ftp.php?app=set&jpg4_post_fps=1
http://”camera ipaddress”/event/ftp.php?app=set&jpg4_post_fps=2
18) FTP & JPEG JPEG Prefix file name setup
http://”camera ipaddress”/event/ftp.php?app=set&jpg_base_name=prefix_
http://”camera ipaddress”/event/ftp.php?app=set&jpg1_base_name=prefix_
http://”camera ipaddress”/event/ftp.php?app=set&jpg2_base_name=prefix_
http://”camera ipaddress”/event/ftp.php?app=set&jpg3_base_name=prefix_
http://”camera ipaddress”/event/ftp.php?app=set&jpg4_base_name=prefix_
19) FTP & JPEG JPEG Additional suffix setup
http://”camera ipaddress”/event/ftp.php?app=set&jpg_suffix_name=1
http://”camera ipaddress”/event/ftp.php?app=set&jpg_suffix_name=2
http://”camera ipaddress”/event/ftp.php?app=set&jpg1_suffix_name=1
http://”camera ipaddress”/event/ftp.php?app=set&jpg1_suffix_name=2
http://”camera ipaddress”/event/ftp.php?app=set&jpg2_suffix_name=1
http://”camera ipaddress”/event/ftp.php?app=set&jpg2_suffix_name=2
http://”camera ipaddress”/event/ftp.php?app=set&jpg3_suffix_name=1
http://”camera ipaddress”/event/ftp.php?app=set&jpg3_suffix_name=2
http://”camera ipaddress”/event/ftp.php?app=set&jpg4_suffix_name=1
http://”camera ipaddress”/event/ftp.php?app=set&jpg4_suffix_name=2
Caution
You must check the following values in the response to http://”camera ipaddress”/config.txt
Page 85
-85-
Event – Light:
Version
Date
Comment
1.00
2014-01-27
Initial version
1.00e
2014-03-17
English Trans la tio n
Parameter
Type
Value
light_level
integer
1 ~ 10
1 : light on until the end of Event In
2 : light on until the pre-defined time
light_time_select
string
second, minute : time unit
light_time
integer
1 or 2 or 3 or … : Light time
light_night_enable
boolean
0 : Disable, 1 : Enable
light_inactivate
integer
1 : Off, 2 : Fade to off
Revision History
Introduction
This Chapter defines the detailed setup procedure for the Light.
Light URI
http://”camera ipaddress”/event/light.php
Light Parameter
light_enable boolean 0 : Disable, 1 : Enable
light_mode integer
Version: 1.00e
Date: 2014. 03. 17
* light_time, light_time_select, and light_night_enable are used only when Light_mode=2.
Examples
1) get the current setting
http://”camera ipaddress”/event/light.php?app=get
2) Light setup
http://”camera ipaddress”/event/light.php?app=set&light_enable=0
http://”camera ipaddress”/event/light.php?app=set&light_enable=1
3) Light brightness setup
http://”camera ipaddress”/event/light.php?app=set&light_level=1
http://”camera ipaddress”/event/light.php?app=set&light_level=5
http://”camera ipaddress”/event/light.php?app=set&light_level=10
4) Light mode & Light time setup
* In case of ‘Keep activate during event’, the light turns on for the duration of event in, and
light_mode=1.
* In case of ‘Keep activate for Time ’, the light turns on for setting time duration, which is
explained below, irrespective of event in duration, and light_mode=2.
* In case of ‘Operate only at night mode”, the light_mode=2 works only, and detail explanation is
in section 5).
* If the light_mode=2, the light turn on time duration is set via light_time and light_time_select.
Page 86
-86-
* light_time_select sets the time unit and light_time sets the time duration.
Item
Value
Explanation
options
LIGHT
Light available
* For example, light_time=60 and light_time_select=second means 60seconds.
* If light_time and light_time_select are not determined but light_mode=2, the previous setting
values are used.
* For light_mode=1, light_time, light_time_select, and light_night_enable are restored but not used.
* Light mode setup example
http://”camera ipaddress”/event/light.php?app=set&light_mode=1
* For light_mode=2, light_time and light_time_select a setup example is as follows.
http://”camera
ipaddress”/event/light.php?app=set&light_mode=2&light_time=60&light_time_select=second
a. light_time_select setup
http://”camera ipaddress”/event/light.php?app=set&light_mode=2&light_time_select=second
http://”camera ipaddress”/event/light.php?app=set&light_mode=2&light_time_select=minute
b. light_time setup
http://”camera ipaddress”/event/light.php?app=set&light_mode=2&light_time=60
5) Operates only at night mode setup
* This function turns the light on at night mode only, and setup via light_night_enable.
* If light_mode=1 and setup light_night_enable, it is restored but not used.
* This function works for light_mode=2 only, and setup example is as follows.
http://”camera ipaddress”/event/light.php?app=set&light_mode=2&light_night_enable=1
6) Inactivate setup
* This setup determines the operation when the light turns off. light_inactive=0 is shut off and
light_inactive=1 is fade off. Setup example is as follows.
http://”camera ipaddress”/event/light.php?app=set&light_inactivate=0
http://”camera ipaddress”/event/light.php?app=set&light_inactivate=1
Caution
You must check the following values in the response to http://”camera ipaddress”/config.txt
Page 87
-87-
Event – Manual Trigger:
Version
Date
Comment
1.00
2014-02-11
Initial version
1.00e
2014-03-18
English Trans la tio n
Item
Value
Explanation
Date: 2014. 03. 18
Revision History
Introduction
This Chapter defines the detailed setup procedure and operation for the Manual Trigger.
Manual Trigger Setup & Operation URI
http://”camera ipaddress”/event/trigger.php
Manual Trig ger Setup Parameter
Parameter Type Value
trigger#_enable boolean 0 : Off, 1 : On
trigger#_time integer 1 – 180
* ‘#’ is the trigger number and has value among 1, 2, 3, and 4.
Manual Trig ger Operation Parame ter
Version: 1.00e
Parameter Type Value
make_trigger integer 1, 2, 3, 4
Example
1) Manual Trigger setup
a) get the current setting
http://”camera ipaddress”/event/trigger.php?app=get
b) Manual Trigger On / Off
http://”camera ipaddress”/event/trigger.php?app=set&trigger1_enable=1
http://”camera ipaddress”/event/trigger.php?app=set&trigger1_enable=0
c) Manual Trigger time setup
http://”camera ipaddress”/event/trigger.php?app=set&trigger1_time=5
2) Manual Trigger operation
http://”camera ipaddress”/event/trigger.php?app=set&make_trigger=1
http://”camera ipaddress”/event/trigger.php?app=set&make_trigger=2
http://”camera ipaddress”/event/trigger.php?app=set&make_trigger=3
http://”camera ipaddress”/event/trigger.php?app=set&make_trigger=4
Caution
You must check the following values in the response to http://”camera ipaddress”/config.txt
Page 88
-88-
total_manual_trigger
4
total manual triggers available
options
MANUAL_TRIGG
ER
Manual Trigger setup and operation available
Page 89
-89-
Event – Motion:
Version
Date
Comment
1.00
2013-12-11
Initial version
1.01
2014-01-13
Detail menu set-up update
1.01e
2014-03-18
English Trans la tio n
Parameter
Type
Value
string
integer(ro)
integer(ro)
boolean
boolean
integer(ro)
integer(ro)
string
integer
integer
integer(
integer
string
integer
integer
Revision History
Introduction
This Chapter defines the detailed setup procedure for the Motion.
Event – Motion URI
http://”camera ipaddress”/event/motion.php
Event – Motion Parameter
Version: 1.01e
Date: 2014. 03. 18
method
md_max_width
md_max_height
md_enable
md_day_night_enable
md_rgn_count
md_rgn#_id
md_rgn#_name
md_rgn#_type
md_rgn#_thre
md_rgn#_sen
md_rgn#_time
md_rgn#_rgntype
md_rgn#_left
md_rgn#_top
md_rgn#_right integer Right Pixel Position or Grid Number
create, delete, modify, save
Maximum Width for Motion setup
Maximum Height for Motion setup
0(Disable), 1(Enable)
0(All Day), 1(Day & Night)
Number of current Motion Event setting
Region ID
Region Name
1(Include), 2(Exclude)
1 ~ 100
1 ~ 100
1 ~ 180
roi(Pixel Type), grid (G rid Ty pe)
Left Pixel Position or Grid Number
Top Pixel Position or Grid Number
md_rgn#_bottom integer Bottom Pixel Position or Grid Number
md_rgn#_night_thre integer 1 ~ 100
md_rgn#_night_sen integer 1 ~ 100
md_rgn#_night_time integer 1 ~ 180
md_rgn_id integer Region ID
Page 90
-90-
md_rgn_name
string
integer
md_rgn_thre
integer
1 ~ 100
md_rgn_sen
integer(
1 ~ 100
md_rgn_time
integer
1 ~ 180
md_rgn_rgntype
string
roi(Pixel Type), grid (G rid Ty pe)
md_rgn_left
integer
Left Pixel Position or Grid Number
md_rgn_top
integer
Top Pixel Position or Grid Number
md_rgn_right
integer
Right Pixel Position or Grid Number
md_rgn_bottom
integer
Bottom Pixel Position or Grid Number
md_rgn_night_thre
integer
1 ~ 100
md_rgn_night_sen
integer
1 ~ 100
Region Name
md_rgn_type
1(Include), 2(Exclude)
Examples (latest F/W)
1) get the current setting
http://”camera ipaddress”/event/motion.php?app=get
2) Motion setup
http://”camera ipaddress”/event/motion.php?app=set&md_enable=1
http://”camera ipaddress”/event/motion.php?app=set&md_enable=0
3) Motion Day & Night setup
http://”camera ipaddress”/event/motion.php?app=set&md_day_night_enable=1
http://”camera ipaddress”/event/motion.php?app=set&md_day_night_enable=0
4) Motion Region create
http://”camera ipaddress”/event/motion.php?app=set&method=create
* If Parameters are null, a region is created as the whole area with default setting.
If md_day_night_enable=0, http://”camera
ipaddress”/event/motion.php?app=set&method=create&md_rgn_name=test&md_rgn_type=1&
md_rgn_thre=10&md_rgn_sen=30&md_rgn_time=5&md_rgn_left=2&md_rgn_top=2&md_rg
n_right=6&md_rgn_bottom=6
If md_day_night_enable=1, http://”camera
ipaddress”/event/motion.php?app=set&method=create&md_rgn_name=test&md_rgn_type=1&
md_rgn_thre=10&md_rgn_sen=30&md_rgn_time=5&md_rgn_left=2&md_rgn_top=2&md_rg
n_right=6&md_rgn_bottom=6&md_rgn_night_thre=5&md_rgn_night_sen=10
* You can create one region using method=crea te at a time.
* You should assign values for left, top, right, and bottom for region creation. (If any one of those
values are missing, exceeds the maximum value, or violates the following condition, the
created region becomes the whole area. )
** Condition: the value of left cannot exceed that of right, and the value of top cannot exceed
that of bottom.
* The other values set to default if missing..
* If md_day_night_enable=0 and you assign values to md_rgn_night_thre and md_rgn_night_sen,
the assigned values are restored but not used.
Page 91
* Detail setting examples are as follows. They can be set individually as in the following example
or can be set in combination as in the above.
a. Region Name setup while Motion Region Create
http://”camera ipaddress”/event/motion.php?app=set&method=create&md_rgn_name=test
b. Region Type setup while Motion Region Create
http://”camera ipaddress”/event/motion.php?app=set&method=create&md_rgn_type=1
http://”camera ipaddress”/event/motion.php?app=set&method=create&md_rgn_type=2
* md_rgn_type 1 means include region of Motion Event, and 2 means exclude region.
* region_type is defined at Create and cannot be changed.
c. Region Threshold setup while Motion Region Create
http://”camera ipaddress”/event/motion.php?app=set&method=create&md_rgn_thre=25
http://”camera ipaddress”/event/motion.php?app=set&method=create&md_rgn_thre=100
d. Region Sensitivity setup while Motion Region Create
http://”camera ipaddress”/event/motion.php?app=set&method=create&md_rgn_sen=25
http://”camera ipaddress”/event/motion.php?app=set&method=create&md_rgn_sen=100
e. Region Dwell time setup while Motion Region Create
http://”camera ipaddress”/event/motion.php?app=set&method=create&md_rgn_time=60
http://”camera ipaddress”/event/motion.php?app=set&method=create&md_rgn_time=150
f. Region Night Threshold setup while Motion Region Create
http://”camera ipaddress”/event/motion.php?app=set&method=create&md_rgn_night_thre=25
http://”camera ipaddress”/event/motion.php?app=set&method=create&md_rgn_night_thre=100
g. Region Night Sensitivity setup while Motion Region Create
http://”camera ipaddress”/event/motion.php?app=set&method=create&md_rgn_night_sen=25
http://”camera ipaddress”/event/motion.php?app=set&method=create&md_rgn_night_sen=100
5) Motion Region Parameter modify
Single Region Parameter modify : http://”camera
ipaddress”/event/motion.php?app=set&m ethod=m odify &m d_rg n_id=1&(Paramet ers to
modify)
* Each region is assigned a unique id when created.
* If you want to modify a region, you must make a request with the assigned id.
* If you change the position of a region, the value of left cannot exceed that of right, and the value
of top cannot exceed that of bottom.
* For the single region modify, you should use Parameters without ‘#’ like md_rgn_name.
Detail setting examples are as follows. They can be set individually as in the following example or
can be set in combination as the above.
a. Region Name setup for single region modify
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn_id=1&md_rgn_name=test
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn_id=3&md_rgn_name=test
b. Region Threshold setup for single region modify
Page 92
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn_id=1&md_rgn_thre=25
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn_id=3&md_rgn_thre=100
c. Region Sensitivity setup for single region modify
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn_id=1&md_rgn_sen=25
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn_id=3&md_rgn_sen=100
d. Region Dwell time setup for single region modify
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn_id=1&md_rgn_time=60
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn_id=4&md_rgn_time=150
e. Region Night Threshold setup for single region modify
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn_id=1&md_rgn_night_thre
=25
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn_id=2&md_rgn_night_thre
=100
f. Region Night Sensitivity setup for single region modify
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn_id=1&md_rgn_night_sen
=25
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn_id=4&md_rgn_night_sen
=100
Multi Region Parameter modify : http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn1_name=test2&md_rgn2_ti
me=150&md_rgn3_right=8
* If you want to modify multiple regions, you must set with combination of the assigned id’s.
* If one of the IDs in set command is not an assigned an id, the operation excludes that id and set
the rest.
* For the multiple region modify, you should use Parameters with ‘#’ like md_rgn#_name.
* If you use Parameters for single region modify and multiple region modify at the same time,
Parameters for single region modify are ignored.
Detail setting examples are as follows. They can be set individually as in the following example or
can be set in combination as the above
a. Region Name setup for multiple region modify
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn1_name=test&md_rgn3_na
me=first
Page 93
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn1_name=second&md_rgn4_n
ame=first
b. Region Threshold setup for multiple region modify
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn3_thre=25&md_rgn4_thre=5
0
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn2_thre=100&md_rgn3_thre=
15
c. Region Sensitivity setup for multiple region modify
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn3_sen=25&md_rgn1_sen=5
0
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn4_sen=100&md_rgn1_sen=
27
d. Region Dwell Time setup for multiple region modify
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn2_time=60&md_rgn1_time=
20
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn1_time=150&md_rgn2_time
=50
e. Region Night Threshold setup for multiple region modify
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn2_night_thre=25&md_rgn1_
night_thre=76
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn1_night_thre=100&md_rgn3
_night_thre=70
f. Region Night Sensitivity setup for multiple region modify
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn3_night_sen=25&md_rgn1_
night_sen=66
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn2_night_sen=100&md_rgn4
_nigth_sen=25
6) Motion Region remove
http://”camera ipaddress”/event/motion.php?app=set&method=delete&md_rgn_id=1
* Each region is assigned a unique id when created.
* If you want to delete a region, you must request it with the assigned id.
Page 94
-94-
Examples (old F/W)
1) get the current setting
http://”camera ipaddress”/event/motion.php?app=get
2) Motion setup
http://”camera ipaddress”/event/motion.php?app=set&method=save&md_enable=1
http://”camera ipaddress”/event/motion.php?app=set&method=save&md_enable=0
3) Motion Day & Night setup
http://”camera ipaddress”/event/motion.php?app=set&method=save&md_day_night_enable=1
http://”camera ipaddress”/event/motion.php?app=set&method=save&md_day_night_enable=0
4) Motion Region create
http://”camera
ipaddress”/event/motion.php?app=set&method=create&md_rgn_name=New&md_rgn_type=
1&md_rgn_left=1&md_rgn_top=1&md_rgn_right=5&md_rgn_bottom=4
5) Motion Region modify
http://”camera
ipaddress”/event/motion.php?app=set&method=modify&md_rgn_id=4&md_rgn_thre=50&m
d_rgn_sen=20&md_rgn_time=30
* Each region is assigned a unique id when created.
* If you want to modify a region, you must request it with the assigned id.
6) Motion Region remove
http://”camera ipaddress”/event/motion.php?app=set&method=delete&md_rgn_id=1
* Each region is assigned a unique id when created.
* If you want to delete a region, you must request it with the assigned id.
7) Motion modify all
(For old F/W, the fo l lowing method is recommended t han method=modify .)
Request :
http://”ipaddress”/event/motion.php?app=get
Response :
res=200&http_port=80&https_port=443&md_enable=1&md_rgn_count=3&md_rgn1_id=2&
md_rgn1_name=New(1)&md_rgn1_type=1&md_rgn1_thre=2&md_rgn1_sen=55&md_rgn1_
time=3&md_rgn1_rgntype=grid&md_rgn1_left=1&md_rgn1_top=3&md_rgn1_right=3&md
_rgn1_bottom=6&md_rgn2_id=3&md_rgn2_name=New(2)&md_rgn2_type=1&md_rgn2_thr
e=2&md_rgn2_sen=55&md_rgn2_time=3&md_rgn2_rgntype=grid&md_rgn2_left=7&md_rg
n2_top=4&md_rgn2_right=9&md_rgn2_bottom=6&md_rgn3_id=4&md_rgn3_name=New&
md_rgn3_type=1&md_rgn3_thre=50&md_rgn3_sen=20&md_rgn3_time=30&md_rgn3_rgnt
ype=grid&md_rgn3_left=1&md_rgn3_top=1&md_rgn3_right=5&md_rgn3_bottom=4&
Request :
http://”ipddress”/event/motion.php?app=set&method=save&md_enable=0&md_rgn_count=3
&md_rgn1_id=2&md_rgn1_name=New(1)&md_rgn1_type=1&md_rgn1_thre=2&md_rgn1_
sen=44&md_rgn1_time=3&md_rgn1_rgntype=grid&md_rgn1_left=1&md_rgn1_top=3&md_
rgn1_right=3&md_rgn1_bottom=6&md_rgn2_id=3&md_rgn2_name=New(2)&md_rgn2_typ
e=1&md_rgn2_thre=2&md_rgn2_sen=55&md_rgn2_time=3&md_rgn2_rgntype=grid&md_r
gn2_left=7&md_rgn2_top=4&md_rgn2_right=9&md_rgn2_bottom=6&md_rgn3_id=4&md_
Page 95
rgn3_name=New&md_rgn3_type=1&md_rgn3_thre=50&md_rgn3_sen=20&md_rgn3_time=
Item
Value
Explanation
VMD
Motion Event function available
DAY_NIGHT
Motion Day & Night function available
30&md_rgn3_rgntype=grid&md_rgn3_left=1&md_rgn3_top=1&md_rgn3_right=4&md_rgn
3_bottom=4&
Response :
res=200&ch=1&md_enable=0&md_rgn_count=3&md_rgn1_id=2&md_rgn1_name=New(1)
&md_rgn1_type=1&md_rgn1_thre=2&md_rgn1_sen=44&md_rgn1_time=3&md_rgn1_rgnty
pe=grid&md_rgn1_left=1&md_rgn1_top=3&md_rgn1_right=3&md_rgn1_bottom=6&md_rg
n2_id=3&md_rgn2_name=New(2)&md_rgn2_type=1&md_rgn2_thre=2&md_rgn2_sen=55&
md_rgn2_time=3&md_rgn2_rgntype=grid&md_rgn2_left=7&md_rgn2_top=4&md_rgn2_rig
ht=9&md_rgn2_bottom=6&md_rgn3_id=4&md_rgn3_name=New&md_rgn3_type=1&md_r
gn3_thre=50&md_rgn3_sen=20&md_rgn3_time=30&md_rgn3_rgntype=grid&md_rgn3_left
=1&md_rgn3_top=1&md_rgn3_right=4&md_rgn3_bottom=4&
* As for the above, method=save means app=get and then set with response.
* In the save operation, you must send current information as a whole, otherwise the parameter
not transmitted will be deleted.
* In Motion setup or Motion Day & Night setup, you need to use the save operation, so be
careful not to delete current information.
Caution
You must check the following values in the response to http://”camera ipaddress”/config.txt
options
Page 96
-96-
Event – Network Loss:
Version
Date
Comment
1.00
2014-01-29
Initial version
1.00e
2014-03-17
English Trans la tio n
Parameter
Type
Value
netloss_time
integer
1~180
Item
Value
Explanation
options
NETWORK_LOSS
Network Loss function available
Version: 1.00e
Date: 2014. 03. 17
Revision History
Introduction
This Chapter defines the detailed setup procedure for the Network Loss.
Network Loss URI
http://”camera ipaddress”/event/netloss.php
Network Loss Param eter
netloss_enable boolean 0 : Disable, 1 : Enable
Examples
1) Get the current setting
http://”camera ipaddress”/event/netloss.php?app=get
2) Network Loss setup
http://”camera ipaddress”/event/netloss.php?app=set&netloss_enable=0
http://”camera ipaddress”/event/netloss.php?app=set&netloss_enable=1
3) Network Loss dwell time setup
http://”camera ipaddress”/event/netloss.php?app=set&netloss_time=1
http://”camera ipaddress”/event/netloss.php?app=set&netloss_time=180
Caution
You must check the following values in the response to http://”camera ipaddress”/config.txt
Page 97
-97-
Event –Notification Server:
Version
Date
Comment
1.00
2014-08-28
Initial version
1.00e
2015-02-06
English Translation
1.01e
2015-08-24
Method field add
noti_srv_method
string
GET, SET
Revision History
Introduction
This Chapter defines the detailed setup procedure for the Notification Server.
Notification Server URI
http://”camera ipaddress”/event/notification_server.php
Notificati on Se rve r Par am e ter
Parameter Type Value
noti_srv_enable boolean 0 : Disable, 1 : Enable
noti_srv_type string HTTP, HTTPS, TCP, UDP
Version : 1.01e
Date : 2015. 08. 25
noti_srv_server string Server URL
noti_srv_port integer 1 – 65535
noti_srv_user string User name
noti_srv_pass string User password
method string “test” : For use HTTP Server Test only
noti_srv_msg string Message
Examples
1) get the current setting
http://”camera ipaddress”/event/notification_server.php?app=get
2) Notification Server setup
http://”camera ipaddress”/event/notification_server.php?app=set¬i_srv_enable=1
http://”camera ipaddress”/event/notification_server.php?app=set¬i_srv_enable=0
3) Notification Server Type setup
http://”camera ipaddress”/event/notification_server.php?app=set¬i_srv_type=HTTP
http://”camera ipaddress”/event/notification_server.php?app=set¬i_srv_type=HTTPS
http://”camera ipaddress”/event/notification_server.php?app=set¬i_srv_type=TCP
http://”camera ipaddress”/event/notification_server.php?app=set¬i_srv_type=UDP
Page 98
4) Notification Server Method setup
Item
Value
Description
options
NOTIFY_SERVER
Notification Server available
http://”camera ipaddress”/event/http_server.php?app=set¬i_srv_method=GET
http://”camera ipaddress”/event/http_server.php?app=set¬i_srv_method=POST
5) Notification Server URL setup
http://”camera ipaddress”/event/http_server.php?app=set¬i_srv_server=192.168.xxx.xxx
http://”camera ipaddress”/event/http_server.php?app=set¬i_srv_server=www.xxx.com
http://”camera
ipaddress”/event/http_server.php?app=set¬i_srv_server=http://192.168.xxx.xxx/
event.php
6) Notification Server Port setup
http://”camera ipaddress”/event/notification_server.php?app=set¬i_srv_port=80
* If event_noti_port is set to bigger number than 65535, (Error: 400) is returned.
* If event_noti_port is set to smaller number than 1, (Error: 400) is returned.
7) Notification Server user setup
http://”camera ipaddress”/event/http_server.php?app=set¬i_srv_user=user ID
8) Notification Server password setup
http://”camera ipaddress”/event/http_server.php?app=set¬i_srv_pass=user PW
7) Notification Server Test
In case of mothod=test, http://”camera
ipaddress”/event/http_server.php?app=set&method=test¬i_srv_enable=1¬i_srv_type=H
TTP¬i_srv_method=POST¬i_srv_server=192.168.xxx.xxx¬i_srv_port=80¬i_sr
v_msg=hello
* If the user included “mothod=test” in URI, the user must include noti_srv_enable,
noti_srv_server, noti_srv_port, and noti_srv_msg.
* If method=test, noti_srv_enable must be Enabled.
* On connecting Notification Server, the user may include noti_srv_user and noti_srv_pass if
necessary.
Caution
You must check the following values in the response in http://”camera ipaddress”/config.txt
Notification Server setup must include the “noti_srv_port” parameter.
“noti_srv_server” parameter does not allow expressions such as “http://10.0.2.12:port_number”.
“noti_srv_type” param eter can be com posed of eithe r upper cas e let ter and /or low er case lette r.
Page 99
-99-
Event – On Boot:
Version
Date
Comment
1.00
2014-01-23
Initial version
1.00e
2014-03-18
English Trans la tio n
Parameter
Type
Value
onboot_time
integer
1 ~ 180
Item
Value
Explanation
options
ONBOOT
On Boot function available
Version: 1.00e
Date: 2014. 03. 18
Revision History
Introduction
This Chapter defines the detailed setup procedure for the On boot.
On Boot URI
http://”camera ipaddress”/event/onboot.php
On Boot Parameter
onboot_enable boolean 0 : Disable, 1 : Enable
Examples
1) get the current setting
http://”camera ipaddress”/event/onboot.php?app=get
2) On Boot setup
http://”camera ipaddress”/event/onboot.php?app=set&onboot_enable=0
http://”camera ipaddress”/event/onboot.php?app=set&onboot_enable=1
3) On Boot dwell time setup
http://”camera ipaddress”/event/onboot.php?app=set&onboot_time=1
http://”camera ipaddress”/event/onboot.php?app=set&onboot_time=180
Caution
You must check the following values in the response to http://”camera ipaddress”/config.txt
Page 100
-100-
Event – PIR:
Version
Date
Comment
1.00
2014-02-05
Initial version
1.00e
2014-03-17
English Trans la tio n
Parameter
Type
Value
pir_time
integer
1~180
Item
Value
Explanation
options
PIR
PIR available
Version: 1.00e
Date: 2014. 03. 17
Revision History
Introduction
This Chapter defines the detailed setup procedure for the PIR.
PIR URI
http://”camera ipaddress”/event/pir.php
PIR Parameter
pir_enable boolean 0 : Disable, 1 : Enable
pir_level integer 1 : Low, 2 : Middle, 3 : High
Examples
1) Get the current setting
http://”camera ipaddress”/event/pir.php?app=get
2) PIR setup
http://”camera ipaddress”/event/pir.php?app=set&pir_enable=0
http://”camera ipaddress”/event/pir.php?app=set&pir_enable=1
3) PIR sensitivity level setup
http://”camera ipaddress”/event/pir.php?app=set&pir_level=1 ( Low )
http://”camera ipaddress”/event/pir.php?app=set&pir_level=2 ( Middle )
http://”camera ipaddress”/event/pir.php?app=set&pir_level=3 ( High )
4) PIR dwell time setup
http://”camera ipaddress”/event/pir.php?app=set&pir_time=1
http://”camera ipaddress”/event/pir.php?app=set&pir_time=180
Caution
You must check the following values in the response to http: //”camera ipaddress”/config.txt
Loading...