JVC VN-E4U API Guide - Page 36

Setting Chattering Guard Time of Alarm Input for VN-E4, Acquiring Alarm Output Time Setting from VN-E4

Page 36 highlights

5. API for Acquiring/Changing Parameters of VN-E4 _ 5.5. Alarm Environment Setting Setting Chattering Guard Time of Alarm Input for VN-E4 Format /api/param?peripheral.input_pin.pin(Number).chatter=data Example When setting the chattering guard time for alarm input 1 /api/param?peripheral.input_pin.pin(1).chatter=150 Example of response peripheral.input_pin.pin(1).chatter&200 OK Interpretation Change the time setting to prevent chattering in the alarm input. Specify a number between 1 to 4 as VN-E4 has 4 alarm inputs. Unit of the response value is in msec. Allowed users admin, operator Acquiring Alarm Output Time Setting from VN-E4 Format /api/param?peripheral.output_pin.pin.duration Example of Response peripheral.output_pin.pin.duration=1000&200 OK Interpretation Acquire the current alarm output duration in millisecond. If alarm output is set in alarm action, this parameter can be acqurired by following API. /api/param?application.event(Number).action Allowed users admin, operator, user Setting Alarm Output Time for VN-E4 Format /api/param?peripheral.input_pin.pin.duration=data Example /api/param?peripheral.input_pin.pin.duration=50 Example of response peripheral.input_pin.pin.duration&200 OK Interpretation Change the alarm output duration in millisecond. Specify 0, or 50 to 5000. Following API is also available to set the parameter. /api/param?application.event(Number).action Allowed users admin, operator Acquiring Alarm Output Status from VN-E4 Format /api/param?peripheral.output_pin.pin.status Example of Response peripheral.output_pin.pin.status=make&200 OK Interpretation Acquire the current alarm output status. Either make or break will be returned. Allowed users admin, operator, user Changing Alarm Output of VN-E4 Format /api/param?peripheral.output_pin.pin.status=data Example /api/param?peripheral.output_pin.pin.status=break Example of Response peripheral.output_pin.pin.status&200 OK Interpretation Change the alarm output. Specify as make or break. When the alarm output time is zero, alarm output is changed as this API specifies. When the alarm output time is not zero, alarm output is changed as this API specifies, then alarm output is changed again after the alarm output time. Allowed users admin, operator 36

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80

36
5. API for Acquiring/Changing Parameters of VN-E4 _
5.5. Alarm Environment Setting
Setting Chattering Guard Time of Alarm Input for VN-E4
Format
/api/param?peripheral.input_pin.pin(Number).chatter=data
Example
When setting the chattering guard time for alarm input 1
/api/param?peripheral.input_pin.pin(1).chatter=150
Example of response
peripheral.input_pin.pin(1).chatter&200 OK
Interpretation
Change the time setting to prevent chattering in the alarm input. Specify a number between 1 to 4 as VN-E4
has 4 alarm inputs. Unit of the response value is in msec.
Allowed users
admin, operator
Acquiring Alarm Output Time Setting from VN-E4
Format
/api/param?peripheral.output_pin.pin.duration
Example of Response
peripheral.output_pin.pin.duration=1000&200 OK
Interpretation
Acquire the current alarm output duration in millisecond. If alarm output is set in alarm action, this parameter
can be acqurired by following API.
/api/param?application.event(Number).action
Allowed users
admin, operator, user
Setting Alarm Output Time for VN-E4
Format
/api/param?peripheral.input_pin.pin.duration=data
Example
/api/param?peripheral.input_pin.pin.duration=50
Example of response
peripheral.input_pin.pin.duration&200 OK
Interpretation
Change the alarm output duration in millisecond. Specify 0, or 50 to 5000. Following API is also available to
set the parameter.
/api/param?application.event(Number).action
Allowed users
admin, operator
Acquiring Alarm Output Status from VN-E4
Format
/api/param?peripheral.output_pin.pin.status
Example of Response
peripheral.output_pin.pin.status=make&200 OK
Interpretation
Acquire the current alarm output status. Either make or break will be returned.
Allowed users
admin, operator, user
Changing Alarm Output of VN-E4
Format
/api/param?peripheral.output_pin.pin.status=data
Example
/api/param?peripheral.output_pin.pin.status=break
Example of Response
peripheral.output_pin.pin.status&200 OK
Interpretation
Change the alarm output. Specify as make or break.
When the alarm output time is zero, alarm output is changed as this API specifies. When the alarm output time is not
zero, alarm output is changed as this API specifies, then alarm output is changed again after the alarm output time.
Allowed users
admin, operator