| object | modbus/ |
| Object representing the Modbus/TCP slave configuration | |
Retrieving the value is denied if not administrative user
This object contains the following items:
Sample JS request write command:
request.put({url:"modbus/",body:<...>});
Sample curl read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/modbus/"
⇒
...
Modbus/TCP slave enabled
| sum (boolean) | modbus/enabled/ |
| Modbus/TCP slave enable status | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum represents a value in persistent storage.
This sum can assume the following values:
| constant true | Enabled | The feature is enabled | |
| constant false | Disabled | The feature is disabled | |
Sample curl write command:
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "true" "http://192.168.0.100/restapi/modbus/enabled/"
Sample CLI write command:
uom set "modbus/enabled" "true"
Outlet Modbus configuration settings
| array | modbus/outlets/ |
| Properties related to exposing outlets via Modbus | |
The value is subject to the following constraints: length of the value is equal to length of outlets
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This array represents a value in persistent storage.
This array contains Outlet Modbus/TCP configuration elements.
Sample CLI write command:
uom set "modbus/outlets" "[{\"allow_write\":false,\"allow_read\":true},{\"allow_write\":true,\"allow_read\":true},{\"allow_write\":false,\"allow_read\":true},{\"allow_write\":true,\"allow_read\":false},{\"allow_write\":false,\"allow_read\":true},{\"allow_write\":false,\"allow_read\":false},{\"allow_write\":true,\"allow_read\":true},{\"allow_write\":true,\"allow_read\":false}]"
Sample requests outlet Modbus/TCP configuration creation command:
requests.post('http://192.168.0.100/restapi/modbus/outlets/',auth=auth,headers=headers,json={'allow_write': True, 'allow_read': True})
See also Outlet Modbus configuration settings: Outlet Modbus/TCP configuration
Outlet Modbus configuration settings: Outlet Modbus/TCP configuration
| object | modbus/outlets/N/ |
| Properties related to exposing the outlet via Modbus/TCP | |
The value is subject to the following constraints: outlets[index of the value]
This object contains the following items:
| allow_read | Allow read |
| allow_write | Allow write |
Sample curl read command (note that :outlet_modbus_tcp_configuration_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/modbus/outlets/:outlet_modbus_tcp_configuration_index/"
⇒
{"allow_write":false,"allow_read":false}
Sample CLI read command (note that outlet_modbus_tcp_configuration_index is a variable):
uom get "modbus/outlets/${outlet_modbus_tcp_configuration_index}"
⇒
{"allow_write":true,"allow_read":true}
Allow read
| sum (boolean) | modbus/outlets/N/allow_read/ |
| Outlet state is reported via Modbus/TCP | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum represents a value in persistent storage.
This sum can assume the following values:
| constant true | Enabled | The feature is enabled | |
| constant false | Disabled | The feature is disabled | |
Sample JS request read command (note that _outlet_modbus_tcp_configuration_index is a variable):
request.get({url:"modbus/outlets/"+_outlet_modbus_tcp_configuration_index.toString()+"/allow_read/"},function(error,response,body) {console.log(body)});
⇒
false
Sample uom library read command (note that _outlet_modbus_tcp_configuration_index is a variable):
print(uom.dump(uom.modbus.outlets[_outlet_modbus_tcp_configuration_index].allow_read))
⇒
false
Allow write
| sum (boolean) | modbus/outlets/N/allow_write/ |
| Outlet state can be changed via Modbus/TCP | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum represents a value in persistent storage.
This sum can assume the following values:
| constant true | Enabled | The feature is enabled | |
| constant false | Disabled | The feature is disabled | |
Sample JS request read command (note that _outlet_modbus_tcp_configuration_index is a variable):
request.get({url:"modbus/outlets/"+_outlet_modbus_tcp_configuration_index.toString()+"/allow_write/"},function(error,response,body) {console.log(body)});
⇒
true
Sample curl read command (note that :outlet_modbus_tcp_configuration_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/modbus/outlets/:outlet_modbus_tcp_configuration_index/allow_write/"
⇒
true
Discrete input configuration settings
| array | modbus/discrete_inputs/ |
| Properties related to custom discrete inputs | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This array represents a value in persistent storage.
This array contains Discrete input configuration elements.
Sample requests discrete input configuration creation command:
requests.post('http://192.168.0.100/restapi/modbus/discrete_inputs/',auth=auth,headers=headers,json={'value': False, 'allow_read': False, 'name': 'pbewbro0', 'index': 25394})
Sample requests write command:
requests.put('http://192.168.0.100/restapi/modbus/discrete_inputs/',auth=auth,headers=headers,json=[{'value': True, 'allow_read': True, 'name': 'eoymhkj92', 'index': 34010}])
See also Discrete input configuration settings: Discrete input configuration
Discrete input configuration settings: Discrete input configuration
| object | modbus/discrete_inputs/N/ |
| Properties related to a custom discrete input | |
This object contains the following items:
| name | Name |
| index | Index |
| allow_read | Allow read |
| value | State |
Sample curl write command (note that :discrete_input_configuration_index is a URL template argument):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"value\":false,\"allow_read\":false,\"name\":\"jbajdbgr0\",\"index\":2045}" "http://192.168.0.100/restapi/modbus/discrete_inputs/:discrete_input_configuration_index/"
Sample JS request read command (note that _discrete_input_configuration_index is a variable):
request.get({url:"modbus/discrete_inputs/"+_discrete_input_configuration_index.toString()+"/"},function(error,response,body) {console.log(body)});
⇒
{"value":true,"allow_read":true,"name":"nhsyantl69","index":52613}
Name
| string | modbus/discrete_inputs/N/name/ |
| Discrete input name | |
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Sample uom library write command (note that _discrete_input_configuration_index is a variable):
uom.modbus.discrete_inputs[_discrete_input_configuration_index].name="nnnq19"
Sample curl write command (note that :discrete_input_configuration_index is a URL template argument):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"icaitoqh7\"" "http://192.168.0.100/restapi/modbus/discrete_inputs/:discrete_input_configuration_index/name/"
Index
| number | modbus/discrete_inputs/N/index/ |
| Zero-based index of discrete input (without 10...01 added) | |
The value is subject to the following constraints: all of the following is true:
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This number represents a value in persistent storage.
Sample CLI write command (note that discrete_input_configuration_index is a variable):
uom set "modbus/discrete_inputs/${discrete_input_configuration_index}/index" "7339"
Sample CLI read command (note that discrete_input_configuration_index is a variable):
uom get "modbus/discrete_inputs/${discrete_input_configuration_index}/index"
⇒
6527
Allow read
| sum (boolean) | modbus/discrete_inputs/N/allow_read/ |
| Discrete input is readable via Modbus/TCP | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum represents a value in persistent storage.
This sum can assume the following values:
| constant true | Enabled | The feature is enabled | |
| constant false | Disabled | The feature is disabled | |
Sample JS request read command (note that _discrete_input_configuration_index is a variable):
request.get({url:"modbus/discrete_inputs/"+_discrete_input_configuration_index.toString()+"/allow_read/"},function(error,response,body) {console.log(body)});
⇒
true
Sample uom library write command (note that _discrete_input_configuration_index is a variable):
uom.modbus.discrete_inputs[_discrete_input_configuration_index].allow_read=true
State
| sum (boolean) | modbus/discrete_inputs/N/value/ |
| State of discrete input | |
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This sum represents a value in persistent storage.
This sum can assume the following values:
| constant true | On | The input is on | |
| constant false | Off | The input is off | |
Sample curl write command (note that :discrete_input_configuration_index is a URL template argument):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "false" "http://192.168.0.100/restapi/modbus/discrete_inputs/:discrete_input_configuration_index/value/"
Sample requests write command (note that _discrete_input_configuration_index is a variable):
requests.put('http://192.168.0.100/restapi/modbus/discrete_inputs/'+str(_discrete_input_configuration_index)+'/value/',auth=auth,headers=headers,json=True)
Input register configuration settings
| array | modbus/input_registers/ |
| Properties related to custom input registers | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This array represents a value in persistent storage.
This array contains Input register configuration elements.
Sample CLI input register configuration creation command:
uom insert "modbus/input_registers/0" "{\"value\":31403,\"allow_read\":false,\"name\":\"x4\",\"index\":56485}"
Sample uom library read command:
print(uom.dump(uom.modbus.input_registers))
⇒
See also Input register configuration settings: Input register configuration
Input register configuration settings: Input register configuration
| object | modbus/input_registers/N/ |
| Properties related to a custom input register | |
This object contains the following items:
| name | Name |
| index | Index |
| allow_read | Allow read |
| value | State |
Sample requests read command (note that _input_register_configuration_index is a variable):
print(requests.get('http://192.168.0.100/restapi/modbus/input_registers/'+str(_input_register_configuration_index)+'/',auth=auth,headers=headers).json())
⇒
{'value': 50943, 'allow_read': False, 'name': 'iwyoyyi21', 'index': 3663}
Sample CLI read command (note that input_register_configuration_index is a variable):
uom get "modbus/input_registers/${input_register_configuration_index}"
⇒
{"value":7885,"allow_read":false,"name":"r7","index":23475}
Name
| string | modbus/input_registers/N/name/ |
| Input register name | |
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Sample requests read command (note that _input_register_configuration_index is a variable):
print(requests.get('http://192.168.0.100/restapi/modbus/input_registers/'+str(_input_register_configuration_index)+'/name/',auth=auth,headers=headers).json())
⇒
'ienbj14'
Sample CLI read command (note that input_register_configuration_index is a variable):
uom get "modbus/input_registers/${input_register_configuration_index}/name"
⇒
"d1"
Index
| number | modbus/input_registers/N/index/ |
| Zero-based index of input register (without 30...01 added) | |
The value is subject to the following constraints: all of the following is true:
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This number represents a value in persistent storage.
Sample CLI read command (note that input_register_configuration_index is a variable):
uom get "modbus/input_registers/${input_register_configuration_index}/index"
⇒
45856
Sample JS request read command (note that _input_register_configuration_index is a variable):
request.get({url:"modbus/input_registers/"+_input_register_configuration_index.toString()+"/index/"},function(error,response,body) {console.log(body)});
⇒
4691
Allow read
| sum (boolean) | modbus/input_registers/N/allow_read/ |
| Input register is readable via Modbus/TCP | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum represents a value in persistent storage.
This sum can assume the following values:
| constant true | Enabled | The feature is enabled | |
| constant false | Disabled | The feature is disabled | |
Sample CLI read command (note that input_register_configuration_index is a variable):
uom get "modbus/input_registers/${input_register_configuration_index}/allow_read"
⇒
true
Sample curl write command (note that :input_register_configuration_index is a URL template argument):
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "false" "http://192.168.0.100/restapi/modbus/input_registers/:input_register_configuration_index/allow_read/"
State
| number | modbus/input_registers/N/value/ |
| State of input register | |
The value is subject to the following constraints: all of the following is true:
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample requests write command (note that _input_register_configuration_index is a variable):
requests.put('http://192.168.0.100/restapi/modbus/input_registers/'+str(_input_register_configuration_index)+'/value/',auth=auth,headers=headers,json=9981)
Sample JS request write command (note that _input_register_configuration_index is a variable):
request.put({url:"modbus/input_registers/"+_input_register_configuration_index.toString()+"/value/",body:5120});
Holding register configuration settings
| array | modbus/holding_registers/ |
| Properties related to custom holding registers | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This array represents a value in persistent storage.
This array contains Holding register configuration elements.
Sample uom library write command:
uom.modbus.holding_registers={{allow_read=false,allow_write=true,index=32202,name="yuv5",value=3859},{allow_read=false,allow_write=false,index=44993,name="oqgchshcopkb98",value=62717},{allow_read=true,allow_write=true,index=62514,name="p5",value=16961}}
Sample requests write command:
requests.put('http://192.168.0.100/restapi/modbus/holding_registers/',auth=auth,headers=headers,json=[{'allow_read': True, 'name': 'lu1', 'value': 7841, 'allow_write': False, 'index': 11953}, {'allow_read': True, 'name': 'scfs0', 'value': 53518, 'allow_write': True, 'index': 15349}, {'allow_read': True, 'name': 'vmo2', 'value': 61539, 'allow_write': True, 'index': 61632}, {'allow_read': True, 'name': 'g24', 'value': 50886, 'allow_write': False, 'index': 58814}, {'allow_read': False, 'name': 'ij23', 'value': 49190, 'allow_write': False, 'index': 49848}, {'allow_read': False, 'name': 'qqjrj3', 'value': 14806, 'allow_write': True, 'index': 9615}, {'allow_read': True, 'name': 'oew7', 'value': 57734, 'allow_write': False, 'index': 51050}, {'allow_read': False, 'name': 'rms5', 'value': 7375, 'allow_write': True, 'index': 37738}, {'allow_read': True, 'name': 'mvshivf46', 'value': 54121, 'allow_write': False, 'index': 1976}])
See also Holding register configuration settings: Holding register configuration
Holding register configuration settings: Holding register configuration
| object | modbus/holding_registers/N/ |
| Properties related to a custom holding register | |
This object contains the following items:
| name | Name |
| index | Index |
| allow_read | Allow read |
| allow_write | Allow write |
| value | State |
Sample curl read command (note that :holding_register_configuration_index is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/modbus/holding_registers/:holding_register_configuration_index/"
⇒
{"allow_read":false,"name":"nle8","value":60965,"allow_write":false,"index":37917}
Sample requests deletion command (note that _holding_register_configuration_index is a variable):
requests.delete('http://192.168.0.100/restapi/modbus/holding_registers/'+str(_holding_register_configuration_index)+'/',auth=auth,headers=headers)
Name
| string | modbus/holding_registers/N/name/ |
| Holding register name | |
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This string represents a value in persistent storage.
Sample requests write command (note that _holding_register_configuration_index is a variable):
requests.put('http://192.168.0.100/restapi/modbus/holding_registers/'+str(_holding_register_configuration_index)+'/name/',auth=auth,headers=headers,json='htstpjnq13')
Sample uom library write command (note that _holding_register_configuration_index is a variable):
uom.modbus.holding_registers[_holding_register_configuration_index].name="wi5"
Index
| number | modbus/holding_registers/N/index/ |
| Zero-based index of holding register (without 40...01 added) | |
The value is subject to the following constraints: all of the following is true:
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This number represents a value in persistent storage.
Sample CLI read command (note that holding_register_configuration_index is a variable):
uom get "modbus/holding_registers/${holding_register_configuration_index}/index"
⇒
17261
Sample JS request write command (note that _holding_register_configuration_index is a variable):
request.put({url:"modbus/holding_registers/"+_holding_register_configuration_index.toString()+"/index/",body:37443});
Allow read
| sum (boolean) | modbus/holding_registers/N/allow_read/ |
| Holding register is readable via Modbus/TCP | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum represents a value in persistent storage.
This sum can assume the following values:
| constant true | Enabled | The feature is enabled | |
| constant false | Disabled | The feature is disabled | |
Sample CLI read command (note that holding_register_configuration_index is a variable):
uom get "modbus/holding_registers/${holding_register_configuration_index}/allow_read"
⇒
false
Sample uom library write command (note that _holding_register_configuration_index is a variable):
uom.modbus.holding_registers[_holding_register_configuration_index].allow_read=false
Allow write
| sum (boolean) | modbus/holding_registers/N/allow_write/ |
| Holding register is writable via Modbus/TCP | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum represents a value in persistent storage.
This sum can assume the following values:
| constant true | Enabled | The feature is enabled | |
| constant false | Disabled | The feature is disabled | |
Sample JS request write command (note that _holding_register_configuration_index is a variable):
request.put({url:"modbus/holding_registers/"+_holding_register_configuration_index.toString()+"/allow_write/",body:true});
Sample requests read command (note that _holding_register_configuration_index is a variable):
print(requests.get('http://192.168.0.100/restapi/modbus/holding_registers/'+str(_holding_register_configuration_index)+'/allow_write/',auth=auth,headers=headers).json())
⇒
False
State
| number | modbus/holding_registers/N/value/ |
| State of holding register | |
The value is subject to the following constraints: all of the following is true:
Retrieving the value is denied if not administrative user
Changing the value is denied if not administrative user
This number represents a value in persistent storage.
Sample CLI read command (note that holding_register_configuration_index is a variable):
uom get "modbus/holding_registers/${holding_register_configuration_index}/value"
⇒
11922
Sample CLI write command (note that holding_register_configuration_index is a variable):
uom set "modbus/holding_registers/${holding_register_configuration_index}/value" "12803"
Modbus broker port, if any
| sum (optional number) | modbus/port/ |
| TCP port to listen on, if any | |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This sum represents a value in persistent storage.
This sum can assume the following values:
| constant null | Use default port | Listen on TCP port 502 | |
| number | Modbus broker port | TCP port to listen on | all of the following is true: |
Sample curl write command:
curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "null" "http://192.168.0.100/restapi/modbus/port/"
Sample uom library write command:
uom.modbus.port=null
Notifications
| object | modbus/notifications/ |
| Modbus-related notifications | |
Retrieving the value is denied if not administrative user
This object does not support direct modification.
This object contains the following items:
| parameter_kinds | Parameter kinds |
| events | Events |
Sample uom library read command:
print(uom.dump(uom.modbus.notifications))
⇒
{events={["dli.modbus.sample_event"]={message_template={"sample event"},parameters={{fixed_value=null,has_fixed_value=false,id="sample_parameter"}}}},parameter_kinds={}}
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/modbus/notifications/',auth=auth,headers=headers).json())
⇒
{'events': {'dli.modbus.sample_event': {'parameters': [{'id': 'sample_parameter', 'has_fixed_value': False, 'fixed_value': None}], 'message_template': ['sample event']}}, 'parameter_kinds': {}}
Parameter kinds
| object | modbus/notifications/parameter_kinds/ |
| Kinds of event parameters | |
This object does not correspond to an actual resource.
This object is empty.
Events
| map | modbus/notifications/events/ |
| Event templates | |
Retrieving the value is denied if not administrative user
This map is composite, i.e. is modified as a whole.
This map does not support direct modification.
This map contains Event elements.
Creating elements in this collection is not supported.
Sample CLI read command:
uom get "modbus/notifications/events"
⇒
{"dli.modbus.sample_event":{"parameters":[{"id":"sample_parameter","has_fixed_value":false,"fixed_value":null}],"message_template":["sample event"]}}
Sample requests read command:
print(requests.get('http://192.168.0.100/restapi/modbus/notifications/events/',auth=auth,headers=headers).json())
⇒
{'dli.modbus.sample_event': {'parameters': [{'id': 'sample_parameter', 'has_fixed_value': False, 'fixed_value': None}], 'message_template': ['sample event']}}
See also Events: Event
Event parameters: Event parameter
| object | modbus/notifications/events/S/parameters/N/ |
| Properties of a parameter associated with the event | |
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
| id | Identifier |
| has_fixed_value | Fixed value flag |
| fixed_value | Fixed value |
Sample curl read command (note that :event and :event_parameter_index are URL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/modbus/notifications/events/:event/parameters/:event_parameter_index/"
⇒
{"id":"sample_parameter","has_fixed_value":false,"fixed_value":null}
Sample JS request write command (note that _event and _event_parameter_index are variables):
request.put({url:"modbus/notifications/events/"+_event+"/parameters/"+_event_parameter_index.toString()+"/",body:{"id":"sample_parameter","has_fixed_value":false,"fixed_value":null}});
Identifier
| string | modbus/notifications/events/S/parameters/N/id/ |
| Parameter identifier | |
The value is subject to the following constraints: parameter kinds[the value]
Retrieving the value is denied if not administrative user
This string is a part of a composite value which is modified as a whole.
This string does not support direct modification.
Sample uom library read command (note that _event and _event_parameter_index are variables):
print(uom.dump(uom.modbus.notifications.events[_event].parameters[_event_parameter_index].id))
⇒
"sample_parameter"
Sample JS request read command (note that _event and _event_parameter_index are variables):
request.get({url:"modbus/notifications/events/"+_event+"/parameters/"+_event_parameter_index.toString()+"/id/"},function(error,response,body) {console.log(body)});
⇒
"sample_parameter"
Fixed value flag
| sum (boolean) | modbus/notifications/events/S/parameters/N/has_fixed_value/ |
| Flag indicating that the parameter's value for this event is fixed | |
Retrieving the value is denied if not administrative user
This sum is a part of a composite value which is modified as a whole.
This sum does not support direct modification.
This sum can assume the following values:
| constant true | Fixed | The value is fixed | |
| constant false | Variable | The value is variable | |
Sample uom library read command (note that _event and _event_parameter_index are variables):
print(uom.dump(uom.modbus.notifications.events[_event].parameters[_event_parameter_index].has_fixed_value))
⇒
false
Sample CLI read command (note that event and event_parameter_index are variables):
uom get "modbus/notifications/events/${event}/parameters/${event_parameter_index}/has_fixed_value"
⇒
false
Fixed value
| sum (variant) | modbus/notifications/events/S/parameters/N/fixed_value/ |
| Fixed parameter value for this particular event | |
Retrieving the value is denied if not administrative user
This sum is a part of a composite value which is modified as a whole.
This sum does not support direct modification.
This sum can assume the following values:
| constant null | Null | Null | |
| constant true | True | True | |
| constant false | False | False | |
| string | String | This string | |
| number | Number | This number | |
Sample curl read command (note that :event and :event_parameter_index are URL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/modbus/notifications/events/:event/parameters/:event_parameter_index/fixed_value/"
⇒
null
Sample uom library read command (note that _event and _event_parameter_index are variables):
print(uom.dump(uom.modbus.notifications.events[_event].parameters[_event_parameter_index].fixed_value))
⇒
null
Events: Event
| object | modbus/notifications/events/S/ |
| Event template | |
This object is a part of a composite value which is modified as a whole.
This object contains the following items:
| message_template | Message template |
| severity | Severity |
| parameters | Event parameters |
Sample requests read command (note that _event is a variable):
print(requests.get('http://192.168.0.100/restapi/modbus/notifications/events/'+_event+'/',auth=auth,headers=headers).json())
⇒
{'parameters': [{'id': 'sample_parameter', 'has_fixed_value': False, 'fixed_value': None}], 'message_template': ['sample event']}
Sample JS request read command (note that _event is a variable):
request.get({url:"modbus/notifications/events/"+_event+"/"},function(error,response,body) {console.log(body)});
⇒
{"parameters":[{"id":"sample_parameter","has_fixed_value":false,"fixed_value":null}],"message_template":["sample event"]}
Message template
| array | modbus/notifications/events/S/message_template/ |
| Template for human-readable message generation | |
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array contains Message template element elements.
Creating elements in this collection is not supported.
Sample requests read command (note that _event is a variable):
print(requests.get('http://192.168.0.100/restapi/modbus/notifications/events/'+_event+'/message_template/',auth=auth,headers=headers).json())
⇒
['sample event']
Sample CLI read command (note that event is a variable):
uom get "modbus/notifications/events/${event}/message_template"
⇒
["sample event"]
Message template element
| sum (variant) | modbus/notifications/events/S/message_template/N/ |
| Element of human-readable message template | |
Retrieving the value is denied if not administrative user
This sum is a part of a composite value which is modified as a whole.
This sum does not support direct modification.
This sum can assume the following values:
| string | String | Fixed string | |
| number | Parameter | Index of message parameter to insert | event parameters[the value] |
Sample uom library read command (note that _event and _message_template_element_index are variables):
print(uom.dump(uom.modbus.notifications.events[_event].message_template[_message_template_element_index]))
⇒
"sample event"
Sample CLI read command (note that event and message_template_element_index are variables):
uom get "modbus/notifications/events/${event}/message_template/${message_template_element_index}"
⇒
"sample event"
Severity
| sum (enumerated number) | modbus/notifications/events/S/severity/ |
| Severity rating assigned to the event | |
Retrieving the value is denied if not administrative user
This sum is a part of a composite value which is modified as a whole.
This sum does not support direct modification.
This sum can assume the following values:
| constant 1 | Emergency | Treat the event as an emergency | |
| constant 2 | Alert | Treat the event as an alert | |
| constant 3 | Critical | Treat the event as critical | |
| constant 4 | Error | Treat the event as an error | |
| constant 5 | Warning | Treat the event as a warning | |
| constant 6 | Notice | Treat the event as a notice | |
| constant 7 | Informational | Treat the event as informational | |
| constant 8 | Debug | Treat the event as debugging-related | |
Sample uom library read command (note that _event is a variable):
print(uom.dump(uom.modbus.notifications.events[_event].severity))
⇒
{}
Sample JS request read command (note that _event is a variable):
request.get({url:"modbus/notifications/events/"+_event+"/severity/"},function(error,response,body) {console.log(body)});
⇒
[]
Event parameters
| array | modbus/notifications/events/S/parameters/ |
| Additional data associated with the event | |
Retrieving the value is denied if not administrative user
This array is a part of a composite value which is modified as a whole.
This array does not support direct modification.
This array contains Event parameter elements.
Creating elements in this collection is not supported.
Sample uom library read command (note that _event is a variable):
print(uom.dump(uom.modbus.notifications.events[_event].parameters))
⇒
{{fixed_value=null,has_fixed_value=false,id="sample_parameter"}}
Sample CLI read command (note that event is a variable):
uom get "modbus/notifications/events/${event}/parameters"
⇒
[{"id":"sample_parameter","has_fixed_value":false,"fixed_value":null}]
See also Event parameters: Event parameter
