Difference between revisions of "Open Control Architecture"
| Line 1: | Line 1: | ||
The Open Controls described on this site works as follows: | The Open Controls described on this site works as follows: | ||
----Communications between systems is performed using MQTT using a standardised 5 level topic structure. '''''network''' / '''node''' / '''device''' / '''group''' / '''key'''.'' | ----Communications between systems is performed using [[MQTT]] using a standardised 5 level topic structure. '''''network''' / '''node''' / '''device''' / '''group''' / '''key'''.'' | ||
----A device managing communications is called a node. | ----A device managing communications is called a node. | ||
----Data from within a node or from connected devices is assigned a local network identifier of "'''''local'''''" so that the node can separate internal traffic and readings from general traffic. This is stored under '''''global.localNetworkId''''' | ----Data from within a node or from connected devices is assigned a local network identifier of "'''''local'''''" so that the node can separate internal traffic and readings from general traffic. This is stored under '''''global.localNetworkId''''' | ||
| Line 16: | Line 16: | ||
<br /> | <br /> | ||
----Attributes for data may be loaded from a central index (GitHub hosted), providing additional information such as units and descriptions. This is to avoid the need to locally describe data, and to assist in compatibility. | ----Attributes for data may be loaded from a central index (GitHub hosted), providing additional information such as units and descriptions. This is to avoid the need to locally describe data, and to assist in compatibility. | ||
----Controls software is written in Node-RED. | ----Controls software is written in [[Node-RED]]. | ||
----Within Node-RED, data and attributes are stored within the '''''global.readings''''' object. | ----Within Node-RED, data and attributes are stored within the '''''global.readings''''' object. | ||
Revision as of 19:32, 30 May 2022
The Open Controls described on this site works as follows:
Communications between systems is performed using MQTT using a standardised 5 level topic structure. network / node / device / group / key.
A device managing communications is called a node.
Data from within a node or from connected devices is assigned a local network identifier of "local" so that the node can separate internal traffic and readings from general traffic. This is stored under global.localNetworkId
The external network identifier, used for all data published to external MQTT brokers, is stored under global.networkId
The node identifier is stored under global.node
The topic group is used to define the type of data, including
- dat (operational data)
- stat (statistics and status)
- settings
- cmd (a command)
- set (change a setting)
- system (software and networking)
Attributes for data may be loaded from a central index (GitHub hosted), providing additional information such as units and descriptions. This is to avoid the need to locally describe data, and to assist in compatibility.
Controls software is written in Node-RED.
Within Node-RED, data and attributes are stored within the global.readings object.
The current data can be viewed in the data explorer.
Persistent settings for a node (or application) are held on disk and in the global.settings object. This is for local operational settings.
Settings have a type, may have maximum and minimum values, units and a title. Certain types require additional fields such as select from a list settings.
The snapshot below shows a variety of setting types including numeric/text values, html, or JSON objects and arrays.
Persistent settings for local devices are held on disk and in the global.deviceSettings object, and are specific to a device (or node).
Data within the readings object is nested according to the topic (excluding the node as more than one node may publish data on a device).
e.g. a message with a topic myNetwork/node123/myDevice/dat/outputTemperature would be stored in (global).readings.myNetwork.myDevice.dat.outputTemperature.value
Internally, message topics can be truncated and the network and node will be filled in. The data group will be assumed to be "dat" if not supplied, representing operational data.
e.g. a message with a topic setpoint would be stored in (global).readings.local.myNode.dat.setpoint.value
The following code could be used to read data and its attributes for output.
var localNetworkId = global.get("localNetworkId");
var node = global.get("node");
var reading = global.get("readings." + localNetworkId + "." + node + ".dat.outputTemperature");
var output = "The value of " + reading.title + " is " + reading.value + reading.units;
// "The value of Output Temperature is 35°C