30
5. API for Acquiring/Changing Parameters of VN-E4 _
5.4. Alarm Setting
Setting Example
/api/param?application.event(1).action=tcpto/10.0.0.100/20000/Message
Specify udpto, IP address, port number and the character string to be sent when sending via UDP. Segments are
indicated by /. The upper limit of the character string to be sent is 40 bytes. Specify using the 3 characters %20
when inserting a space in the character string. For example, to send the character string "This is alarm.",
specify as "This%20is%20alarm.".
Setting Example
/api/param?application.event(1).action=udpto/10.0.0.100/20000/Message
Specify pinout, distinction between make/break (m1 or b1) and the time (millisecond) when alarm output is
specified. Segments are indicated by /. Different values cannot be specified for the alarm output time of each
alarm action. When the alarm output time is changed for an alarm action, the alarm output time for other alarm
actions will also be altered.
Setting Example
/api/param?application.event(1).action=pinout/m1/1500
Allowed users
admin, operator
Acquiring Alarm Trigger from VN-E4
Format
/api/param?application.event(Number).trigger
Example
When acquiring Trigger of Alarm No. 1
/api/param?application.event(1).trigger
Example of Response
application.event(1).trigger=0&200 OK
Interpretation
Acquire Trigger of the alarm action for the specified alarm number. Up to 10 alarm actions can be specified,
and therefore the number of alarm(number) can also be set between the range of 1 to 10. Note that alarm
numbers are different from the alarm input pin numbers.
When only 1 Trigger is set, m1 will be returned in the case of make for alarm input 1, b2 will be returned in the
case of break for alarm input 2, and v3 will be returned for motion detection of video input 3.
Example of Response
application.event(1).trigger=v4&200 OK
When a combination of 2 Triggers are set, responses such as m1(10)b2 will be returned. The example above
indicates that trigger will be activated when break is invoked at alarm input 2 within 10 seconds after make is
invoked at alarm input 1.
Example of Response
application.event(1).trigger=m3(100)b4&200 OK
Allowed users
admin, operator
Setting Alarm Trigger for VN-E4
Format
/api/param?application.event(Number).trigger=data
Example
When setting Trigger of Alarm No. 1
/api/param?application.event(1).trigger=m1
Example of Response
application.event(1).trigger&200 OK
Interpretation
Set Trigger of the alarm action for the specified alarm number. Up to 10 alarm actions can be specified, and
therefore the number of alarm(number) can also be set between the range of 1 to 10. Note that alarm numbers
are different from the alarm input pin numbers.
When setting only 1 Trigger, specify as m1 in the case of make for alarm input 1, b2 in the case of break for
alarm input 2, and v3 for motion detection of video input 3.
Setting Example
/api/param?application.event(1).trigger=v4
When setting Trigger upon combining 2 alarm inputs, specify as m1(50)b2. The example above indicates that
trigger will be activated when break is invoked at alarm input 2 within 100 seconds after make is invoked at
alarm input 1. Additionally, combination is only allowed for alarm inputs and not motion detect. And same
alarm can not be combined. For example, m1(50)m1 is not available.
Setting Example
/api/param?application.event(1).trigger=m3(100)b4
Allowed users
admin, operator
