This is a Node-RED node used to interact with the SmithTek service. It publishes and suscribes to one or multiple variables.
The smithtek-nodered node for Node-RED is available as an npm package. We recommend
you to read Node-RED documentation if you
have any doubts installing nodes in the platform.
There are two different nodes: One for reading information from SmithTek and another one for sending information to SmithTek.
There is also a squencer node which will send a true value to each of its outputs, delaying a set amount of time between them.
This node is used to suscribe to one or more (up to 10) Smithtek Variable(s). It will listen to new values and pass it to further nodes in the msg.payload.
These are the properties you should configure, by double clicking the node:
-
Token: (Required) This is your account token.
-
Device label: The Device Label containing the Variables to subscribe to.
-
Variable label: The Variable Label to which the node will suscribe.
-
TLS: By default, all data is sent encrypted via TLS. Uncheck if data should be sent unencrypted.
-
Simple Node: Simple Node mode subscribes to a topic to retrieve only the last value of the variable.
-
Add Variable: Adds an additional variable (up to 10).
The output is a JSON object with the variable label as key and the Last Value/Dot object as value, e.g.: {"variable_label": {"value": 100, "timestamp": 1583523586668, "context": { "key1": "value1", "key2": "value2"}, "created_at": 1583523586732}
If you get the error: TypeError: send is not a function, please run npm update node-red and reload Node-Red. You probably run a 0.x node-red version. This library requires >1.0.
This node is used to publish to one or multiple variables in Smithtek service via MQTT.
These are the properties you should configure, by double clicking the node:
-
Token: (Required) This is your account token.
-
Device label or msg.payload.device_label: The Device Label to which data will be published. If no Device exists with this label, it will be automatically created. Can be sent dynamically in the input JSON message object with the key
device_label. If no Device label is sent in the message, it defaults back to the value from the Device Label field. Keep in mind that the Device Label is required. -
Variable label: The Variable Label to which the node will publish (only required in Simple Node mode).
-
TLS: By default all data is sent encrypted via TLS. Uncheck if data should be sent unencrypted.
-
Simple Node: If selected, the node receives a raw number and publishes an object with the Variable Label as key and an object as value, e.g.
{"variable_label": {"value": 100}}. -
msg.payload: This payload will contain all the values that will be sent to the Device. It's structured to use the key of the object as the Variable Label and the value of the key as the value to send to SmithTek, e.g.
{"variable_label": 42}
The message can contain the following properties:
-
msg.payload.device_label(Optional) - The Device Label to which the payload will be published. If no Device Label is sent, it takes the Device Label from the Device Label field in the node settings. -
msg.payload(Required) - The Variable Labels and its values to be published on the given Device. Each key corresponds to a Variable Label.
Example of a simple value JSON message:{"variable_label": 100}.
Example of a JSON message providing context data: {"variable_label": {"value": 200, "context": {"key1": "value1","key2": "value2"}}}.
Example of JSON message with multiple variables: {"variable_label1": {"value": 100}, "variable_label2": {"value": 200}}.
## Authentication
The authentication is made by using the Token field in your nodes.
This node is used to trigger other nodes with true values in the msg.payload.
If you want to modify this extension, you just have to run npm install or yarn install to fetch and install the dependencies.
To install the development version and use it on your Node-RED instance, you can execute npm link on this folder and then execute
npm link smithtek-nodered in your ~/.nodered folder.
This software is provided under the MIT license. See LICENSE for applicable terms.