@logiccloud/node-red-runtime-connection 3.3.1
All the necessary nodes to use logiccloud runtime in Node-RED environment.
Introduction
This package contains all the necessary nodes to use logiccloud runtime in Node-RED environment:
- runtime-connection
- runtime-input
- runtime-output
runtime-connection
This node is used to connect to the logiccloud runtime.
The communication with the logiccloud runtime is always done via logiccloud Node-RED connector.
The logiccloud Node-RED connector is the one responsible with the data handling between the logiccloud runtime-input / runtime-output nodes and the logiccloud runtime.
The logiccloud Node-RED connector is only allowing access to the logiccloud runtime access variables defined in its mappings.
This means that the logiccloud Node-RED nodes only have access to a subset of all logiccloud runtime access variables, so only to the ones defined in the mappings.
If the mappings of logiccloud Node-RED connector are updated, the Node-RED flow has to be restarted in order for the changes to take effect also on logiccloud Node-RED nodes.
The logiccloud runtime-connection node provides the following properties:
- name: the name of the node; if it is not set, the node will have the default name "runtime-on:[host]:[port]"
- host: the hostname or IP address of the logiccloud Node-RED connector
- port: the port of the logiccloud Node-RED connector
The logiccloud runtime-connection node provides browsing support that can be used to discover the available input/output access variables in the logiccloud runtime (of course, as described before, the ones defined in the mappings by the logiccloud Node-RED connector). In order to use this feature, the logiccloud runtime-connection node has to be properly configured (valid host and port of an existing running logiccloud runtime and Node-RED connector) and deployed.
runtime-input
This node is used to write (input) data to the logiccloud runtime.
The logiccloud runtime-input node provides the following properties:
- name: the name of the node; if it is not set, the node will have the default name "runtime-input"
- runtime: the runtime connection node to be used for the communication with the logiccloud runtime
- variable: the access variable name to be written; there are two ways to set the access variable name:
- by typing the access variable name in the variable field
- by browsing the available input access variables in the logiccloud runtime (by clicking on the search icon next to the variable field)
Note: in order to use the browsing functionality, several steps have to be performed beforehand:
- the logiccloud runtime-connection node has to be properly configured (valid host and port of an existing running logiccloud runtime and Node-RED connector)
- the logiccloud runtime-connection node has to be deployed
- the logiccloud runtime-connection node has to be selected in the runtime field of the logiccloud runtime-input node
- close and re-open the configuration for the logiccloud runtime-input node
If the above steps are performed and the logiccloud runtime and Node-RED connector are running, by clicking the search icon next to the variable field the list of available inputs will be displayed.
Then the user can select the desired access variable.
The access variable name will be automatically filled in the variable field.
If all of the above steps are performed and the logiccloud runtime and Node-RED connector are running, but there are no input access variables defined in the mappings for the logiccloud Node-RED connector, a warning message will be displayed: "No inputs found on runtime connection on port: [port]".
If one of the above steps is not performed or logiccloud runtime and Node-RED connector are not running, the browsing functionality will not work.
In this case, a warning message will be displayed: "No inputs found on runtime connection on port: [port]".
The user has to manually type the access variable name in the variable field.
runtime-output
This node is used to receive (output) data from the logiccloud runtime.
The logiccloud runtime-output node provides the following properties:
- name: the name of the node; if it is not set, the node will have the default name "runtime-output"
- runtime: the runtime connection node to be used for the communication with the logiccloud runtime
- variable: the access variable name for which the node will receive updates; there are two ways to set the access variable name:
- by typing the access variable name in the variable field
- by browsing the available output access variables in the logiccloud runtime (by clicking on the search icon next to the variable field)
Note: in order to use the browsing functionality, several steps have to be performed beforehand:
- the logiccloud runtime-connection node has to be properly configured (valid host and port of an existing running logiccloud runtime and Node-RED connector)
- the logiccloud runtime-connection node has to be deployed
- the logiccloud runtime-connection node has to be selected in the runtime field of the logiccloud runtime-output node
- close and re-open the configuration for the logiccloud runtime-output node
If the above steps are performed and the logiccloud runtime and Node-RED connector are running, by clicking the search icon next to the variable field the list of available outputs will be displayed.
Then the user can select the desired access variable.
The access variable name will be automatically filled in the variable field.
If all of the above steps are performed and the logiccloud runtime and Node-RED connector are running, but there are no output access variables defined in the mappings for the logiccloud Node-RED connector, a warning message will be displayed: "No outputs found on runtime connection on port: [port]".
If one of the above steps is not performed or logiccloud runtime and Node-RED connector are not running, the browsing functionality will not work.
In this case, a warning message will be displayed: "No outputs found on runtime connection on port: [port]".
The user has to manually type the access variable name in the variable field.
