DLI DC3 Object Model Reference
|
object | mqtt/ |
Object representing the MQTT client configuration |
Retrieving the value is denied if not administrative user
This object contains the following items:
Sample requests
read command:
print(requests.get('http://192.168.0.100/restapi/mqtt/',auth=auth,headers=headers).json())
⇒
<...>
Sample JS request
write command:
request.put({url:"mqtt/",body:<...>});
sum (boolean) | mqtt/enabled/ |
MQTT client 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 requests
write command:
requests.put('http://192.168.0.100/restapi/mqtt/enabled/',auth=auth,headers=headers,json=False)
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/mqtt/enabled/"
⇒
false
array | mqtt/outlets/ |
Properties related to exposing outlets via MQTT |
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 MQTT configuration elements.
Sample requests
outlet MQTT configuration creation command:
requests.post('http://192.168.0.100/restapi/mqtt/outlets/',auth=auth,headers=headers,json={'allow_read': True, 'topic_subtree': 'EOV0rZ', 'qos': 2, 'allow_write': True})
Sample JS request
read command:
request.get({url:"mqtt/outlets/"},function(error,response,body) {console.log(body)});
⇒
See also Outlet MQTT configuration settings: Outlet MQTT configuration
object | mqtt/outlets/N/ |
Properties related to exposing the outlet via MQTT |
The value is subject to the following constraints: outlets[index of the value]
This object contains the following items:
topic_subtree | Topic subtree, if any |
allow_read | Allow read |
allow_write | Allow write |
qos | State subscription and report QoS |
Sample requests
deletion command (note that _outlet_mqtt_configuration_index
is a variable):
requests.delete('http://192.168.0.100/restapi/mqtt/outlets/'+str(_outlet_mqtt_configuration_index)+'/',auth=auth,headers=headers)
Sample uom
library deletion command (note that _outlet_mqtt_configuration_index
is a variable):
uom.remove(uom.mqtt.outlets,_outlet_mqtt_configuration_index)
sum (optional string) | mqtt/outlets/N/topic_subtree/ |
MQTT topic subtree (relative to the topic root), 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 | Outlet index-based | Use 'outlets/'+the 0-based outlet index as topic subtree | |
string | Topic subtree | MQTT topic subtree (relative to the topic root) |
Sample uom
library read command (note that _outlet_mqtt_configuration_index
is a variable):
print(uom.dump(uom.mqtt.outlets[_outlet_mqtt_configuration_index].topic_subtree))
⇒
"4wg7Ti"
Sample CLI read command (note that outlet_mqtt_configuration_index
is a variable):
uom get "mqtt/outlets/${outlet_mqtt_configuration_index}/topic_subtree"
⇒
"Ukiq29W"
sum (boolean) | mqtt/outlets/N/allow_read/ |
Outlet state is broadcasted via MQTT |
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 requests
read command (note that _outlet_mqtt_configuration_index
is a variable):
print(requests.get('http://192.168.0.100/restapi/mqtt/outlets/'+str(_outlet_mqtt_configuration_index)+'/allow_read/',auth=auth,headers=headers).json())
⇒
False
Sample uom
library write command (note that _outlet_mqtt_configuration_index
is a variable):
uom.mqtt.outlets[_outlet_mqtt_configuration_index].allow_read=false
sum (boolean) | mqtt/outlets/N/allow_write/ |
Outlet state can be changed via MQTT |
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 _outlet_mqtt_configuration_index
is a variable):
request.put({url:"mqtt/outlets/"+_outlet_mqtt_configuration_index.toString()+"/allow_write/",body:true});
Sample requests
write command (note that _outlet_mqtt_configuration_index
is a variable):
requests.put('http://192.168.0.100/restapi/mqtt/outlets/'+str(_outlet_mqtt_configuration_index)+'/allow_write/',auth=auth,headers=headers,json=True)
sum (enumerated number) | mqtt/outlets/N/qos/ |
Quality of service when subscribing to and broadcasting outlet state |
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 0 | At most once | Message should be delivered at most once | |
constant 1 | At least once | Message should be delivered at least once | |
constant 2 | Exactly once | Message should be delivered exactly once |
Sample curl
write command (note that :outlet_mqtt_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 "2" "http://192.168.0.100/restapi/mqtt/outlets/:outlet_mqtt_configuration_index/qos/"
Sample curl
read command (note that :outlet_mqtt_configuration_index
is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/mqtt/outlets/:outlet_mqtt_configuration_index/qos/"
⇒
1
sum (string) | mqtt/broker_address/ |
Host name or IPv4 address of the MQTT broker to connect to |
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:
string | Hostname | Hostname | the value matches ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]).)*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9])?|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9])?)$ |
string | IPv4 address | IPv4 address in dotted quad notation | the value matches ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$ |
Sample CLI write command:
uom set "mqtt/broker_address" "\"jUPbbqTKo0.LOla.goMcwWd.aGvh0.example.com\""
Sample CLI read command:
uom get "mqtt/broker_address"
⇒
"ZzGgu.example.com"
sum (optional number) | mqtt/broker_port/ |
Port of the MQTT broker to connect to, 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 | Connect to port 1883 when SSL is not used, port 8883 if SSL is used | |
number | MQTT broker port | Port of the MQTT broker to connect to | all of the following is true: |
Sample CLI write command:
uom set "mqtt/broker_port" "null"
Sample uom
library write command:
uom.mqtt.broker_port="47667"
sum (boolean) | mqtt/use_ssl/ |
Use SSL when connecting to the MQTT broker |
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/mqtt/use_ssl/"
Sample uom
library write command:
uom.mqtt.use_ssl=false
string | mqtt/username/ |
Username to use when connecting to the MQTT broker |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
Sample uom
library read command:
print(uom.dump(uom.mqtt.username))
⇒
"userz4kcq"
Sample JS request
write command:
request.put({url:"mqtt/username/",body:"userijhU"});
string | mqtt/password/ |
Password to use when connecting to the MQTT broker |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
This string should be displayed in a secure manner.
Sample JS request
write command:
request.put({url:"mqtt/password/",body:"~e$7ymbp7sBn"});
Sample uom
library read command:
print(uom.dump(uom.mqtt.password))
⇒
"gABJaXV2Cg0j"
string | mqtt/topic_root/ |
Topic root to use for all messages |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
Sample uom
library read command:
print(uom.dump(uom.mqtt.topic_root))
⇒
"pVX6"
Sample CLI write command:
uom set "mqtt/topic_root" "\"4FBL/ZTn\""
string | mqtt/connect_topic/ |
Topic of the message to send on initial connection to broker (not relative to the topic root) |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
Sample uom
library read command:
print(uom.dump(uom.mqtt.connect_topic))
⇒
"2JZ4ofaPEM"
Sample JS request
write command:
request.put({url:"mqtt/connect_topic/",body:"PBZRHui"});
string | mqtt/connect_payload/ |
Payload of the message to send on initial connection to broker |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
Sample JS request
read command:
request.get({url:"mqtt/connect_payload/"},function(error,response,body) {console.log(body)});
⇒
"a4AM"
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/mqtt/connect_payload/"
⇒
"Aoj"
sum (enumerated number) | mqtt/connect_qos/ |
Quality of service for the message to send on initial connection to broker |
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 0 | At most once | Message should be delivered at most once | |
constant 1 | At least once | Message should be delivered at least once | |
constant 2 | Exactly once | Message should be delivered exactly once |
Sample uom
library write command:
uom.mqtt.connect_qos=0
Sample requests
read command:
print(requests.get('http://192.168.0.100/restapi/mqtt/connect_qos/',auth=auth,headers=headers).json())
⇒
1
sum (boolean) | mqtt/connect_retain/ |
Flag indicating whether the message to be sent on initial connection to broker should be retained |
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 | Retained | The latest message payload should be retained on the broker and sent on subscription | |
constant false | Not retained | Messages should not be retained on the broker |
Sample uom
library read command:
print(uom.dump(uom.mqtt.connect_retain))
⇒
false
Sample uom
library write command:
uom.mqtt.connect_retain=true
string | mqtt/reconnect_topic/ |
Topic of the message to send on reconnection to broker (not relative to the topic root) |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
Sample requests
write command:
requests.put('http://192.168.0.100/restapi/mqtt/reconnect_topic/',auth=auth,headers=headers,json='5yeV')
Sample CLI write command:
uom set "mqtt/reconnect_topic" "\"J6NlOG\""
string | mqtt/reconnect_payload/ |
Payload of the message to send on reconnection to broker |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
Sample CLI write command:
uom set "mqtt/reconnect_payload" "\"O\""
Sample JS request
read command:
request.get({url:"mqtt/reconnect_payload/"},function(error,response,body) {console.log(body)});
⇒
""
sum (enumerated number) | mqtt/reconnect_qos/ |
Quality of service for the message to send on reconnection to broker |
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 0 | At most once | Message should be delivered at most once | |
constant 1 | At least once | Message should be delivered at least once | |
constant 2 | Exactly once | Message should be delivered exactly once |
Sample uom
library write command:
uom.mqtt.reconnect_qos=1
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 "0" "http://192.168.0.100/restapi/mqtt/reconnect_qos/"
sum (boolean) | mqtt/reconnect_retain/ |
Flag indicating whether the message to be sent on reconnection to broker should be retained |
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 | Retained | The latest message payload should be retained on the broker and sent on subscription | |
constant false | Not retained | Messages should not be retained on the broker |
Sample requests
write command:
requests.put('http://192.168.0.100/restapi/mqtt/reconnect_retain/',auth=auth,headers=headers,json=False)
Sample uom
library read command:
print(uom.dump(uom.mqtt.reconnect_retain))
⇒
false
string | mqtt/disconnect_topic/ |
Topic of the message to send before disconnecting from broker (not relative to the topic root) |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
Sample requests
write command:
requests.put('http://192.168.0.100/restapi/mqtt/disconnect_topic/',auth=auth,headers=headers,json='WPCZ4')
Sample JS request
write command:
request.put({url:"mqtt/disconnect_topic/",body:"VMYDPNNb"});
string | mqtt/disconnect_payload/ |
Payload of the message to send before disconnecting from broker |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
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 "\"\"" "http://192.168.0.100/restapi/mqtt/disconnect_payload/"
Sample uom
library read command:
print(uom.dump(uom.mqtt.disconnect_payload))
⇒
"g"
sum (enumerated number) | mqtt/disconnect_qos/ |
Quality of service for the message to send before disconnecting from broker |
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 0 | At most once | Message should be delivered at most once | |
constant 1 | At least once | Message should be delivered at least once | |
constant 2 | Exactly once | Message should be delivered exactly once |
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/mqtt/disconnect_qos/"
⇒
2
Sample requests
write command:
requests.put('http://192.168.0.100/restapi/mqtt/disconnect_qos/',auth=auth,headers=headers,json=0)
sum (boolean) | mqtt/disconnect_retain/ |
Flag indicating whether the message to be sent before disconnecting from broker should be retained |
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 | Retained | The latest message payload should be retained on the broker and sent on subscription | |
constant false | Not retained | Messages should not be retained on the broker |
Sample requests
write command:
requests.put('http://192.168.0.100/restapi/mqtt/disconnect_retain/',auth=auth,headers=headers,json=False)
Sample uom
library read command:
print(uom.dump(uom.mqtt.disconnect_retain))
⇒
false
string | mqtt/lwt_topic/ |
Topic of the message for the broker to send if the unit goes offline unexpectedly (not relative to the topic root) |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
Sample JS request
read command:
request.get({url:"mqtt/lwt_topic/"},function(error,response,body) {console.log(body)});
⇒
"rw4GOAa"
Sample uom
library write command:
uom.mqtt.lwt_topic="/Jcvw3"
string | mqtt/lwt_payload/ |
Payload of the message for the broker to send if the unit goes offline unexpectedly |
Retrieving the value is denied if not administrative user
Changing the value is denied if any of the following is true:
This string represents a value in persistent storage.
Sample uom
library read command:
print(uom.dump(uom.mqtt.lwt_payload))
⇒
"vFr"
Sample requests
read command:
print(requests.get('http://192.168.0.100/restapi/mqtt/lwt_payload/',auth=auth,headers=headers).json())
⇒
'33sZU'
sum (enumerated number) | mqtt/lwt_qos/ |
Quality of service for the message for the broker to send if the unit goes offline unexpectedly |
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 0 | At most once | Message should be delivered at most once | |
constant 1 | At least once | Message should be delivered at least once | |
constant 2 | Exactly once | Message should be delivered exactly once |
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/mqtt/lwt_qos/"
⇒
2
Sample uom
library read command:
print(uom.dump(uom.mqtt.lwt_qos))
⇒
0
sum (boolean) | mqtt/lwt_retain/ |
Flag indicating whether the message to be sent if the unit goes offline unexpectedly should be retained |
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 | Retained | The latest message payload should be retained on the broker and sent on subscription | |
constant false | Not retained | Messages should not be retained on the broker |
Sample uom
library write command:
uom.mqtt.lwt_retain=true
Sample requests
write command:
requests.put('http://192.168.0.100/restapi/mqtt/lwt_retain/',auth=auth,headers=headers,json=False)
object | mqtt/notifications/ |
MQTT-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 JS request
read command:
request.get({url:"mqtt/notifications/"},function(error,response,body) {console.log(body)});
⇒
Sample CLI read command:
uom get "mqtt/notifications"
⇒
See also Notifications: Parameter kinds
map | mqtt/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 "mqtt/notifications/events"
⇒
Sample curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/mqtt/notifications/events/"
⇒
See also Events: Event
object | mqtt/notifications/parameter_kinds/ |
Kinds of event parameters |
This object does not correspond to an actual resource.
This object contains the following items:
connected | Connection status |
sum (boolean) | mqtt/notifications/parameter_kinds/connected/ |
Broker connection status |
This sum can assume the following values:
constant true | Connected | Broker connection successful | |
constant false | Failed to connect | Broker connection failed |
object | mqtt/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 requests
read command (note that _event
and _event_parameter_index
are variables):
print(requests.get('http://192.168.0.100/restapi/mqtt/notifications/events/'+_event+'/parameters/'+str(_event_parameter_index)+'/',auth=auth,headers=headers).json())
⇒
{'fixed_value': False, 'has_fixed_value': True, 'id': 'connected'}
Sample requests
write command (note that _event
and _event_parameter_index
are variables):
requests.put('http://192.168.0.100/restapi/mqtt/notifications/events/'+_event+'/parameters/'+str(_event_parameter_index)+'/',auth=auth,headers=headers,json={'fixed_value': False, 'has_fixed_value': True, 'id': 'connected'})
string | mqtt/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 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/mqtt/notifications/events/:event/parameters/:event_parameter_index/id/"
⇒
"connected"
Sample uom
library read command (note that _event
and _event_parameter_index
are variables):
print(uom.dump(uom.mqtt.notifications.events[_event].parameters[_event_parameter_index].id))
⇒
"connected"
sum (boolean) | mqtt/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 requests
read command (note that _event
and _event_parameter_index
are variables):
print(requests.get('http://192.168.0.100/restapi/mqtt/notifications/events/'+_event+'/parameters/'+str(_event_parameter_index)+'/has_fixed_value/',auth=auth,headers=headers).json())
⇒
True
Sample uom
library read command (note that _event
and _event_parameter_index
are variables):
print(uom.dump(uom.mqtt.notifications.events[_event].parameters[_event_parameter_index].has_fixed_value))
⇒
true
sum (variant) | mqtt/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 uom
library read command (note that _event
and _event_parameter_index
are variables):
print(uom.dump(uom.mqtt.notifications.events[_event].parameters[_event_parameter_index].fixed_value))
⇒
false
Sample requests
read command (note that _event
and _event_parameter_index
are variables):
print(requests.get('http://192.168.0.100/restapi/mqtt/notifications/events/'+_event+'/parameters/'+str(_event_parameter_index)+'/fixed_value/',auth=auth,headers=headers).json())
⇒
True
object | mqtt/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 uom
library write command (note that _event
is a variable):
uom.mqtt.notifications.events[_event]={message_template={"connected to broker"},parameters={{fixed_value=true,has_fixed_value=true,id="connected"}},severity=6}
Sample CLI write command (note that event
is a variable):
uom set "mqtt/notifications/events/${event}" "{\"severity\":6,\"message_template\":[\"connected to broker\"],\"parameters\":[{\"fixed_value\":true,\"has_fixed_value\":true,\"id\":\"connected\"}]}"
array | mqtt/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 uom
library read command (note that _event
is a variable):
print(uom.dump(uom.mqtt.notifications.events[_event].message_template))
⇒
{"failed to connect to broker"}
Sample JS request
read command (note that _event
is a variable):
request.get({url:"mqtt/notifications/events/"+_event+"/message_template/"},function(error,response,body) {console.log(body)});
⇒
["connected to broker"]
sum (variant) | mqtt/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 CLI read command (note that event
and message_template_element_index
are variables):
uom get "mqtt/notifications/events/${event}/message_template/${message_template_element_index}"
⇒
"connected to broker"
Sample uom
library read command (note that _event
and _message_template_element_index
are variables):
print(uom.dump(uom.mqtt.notifications.events[_event].message_template[_message_template_element_index]))
⇒
"connected to broker"
sum (enumerated number) | mqtt/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 JS request
read command (note that _event
is a variable):
request.get({url:"mqtt/notifications/events/"+_event+"/severity/"},function(error,response,body) {console.log(body)});
⇒
6
Sample CLI read command (note that event
is a variable):
uom get "mqtt/notifications/events/${event}/severity"
⇒
6
array | mqtt/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 JS request
read command (note that _event
is a variable):
request.get({url:"mqtt/notifications/events/"+_event+"/parameters/"},function(error,response,body) {console.log(body)});
⇒
[{"fixed_value":true,"has_fixed_value":true,"id":"connected"}]
Sample uom
library read command (note that _event
is a variable):
print(uom.dump(uom.mqtt.notifications.events[_event].parameters))
⇒
{{fixed_value=false,has_fixed_value=true,id="connected"}}
See also Event parameters: Event parameter