@octobus/node-red-contrib-octobus-connector

node-red-contrib-octobus-connector

A set of nodes to connect between the data from different sources and OCTOBUS cloud

Installing OCTOBUS connector using npm

# change to your ~./node-red/ folder
cd ~/.node-red/
npm install npm i @octobus/node-red-contrib-octobus-connector

Installing OCTOBUS connector via Node-RED palette

You can install the node also via the Manage palette feature in the Node-RED administration UI.

Connecting to OCTOBUS via OPC UA using Generated Flow function on OCTOBUS

1: Create Client on OCTOBUS

• Go to Clients Tab create new Client.
• On Client Type select Node-RED.

2: Create Data Flow on Client

The data flow on OCTOBUS doesn't the same definition on Node-RED. If you have multiple data flow on client it will be created on the same flow on Node-RED.

• Names data flow and select protocol to OPC UA.
• Go to Setting/Parameters
  • Fill the setting and parameters for OPC UA.
• Go to Measurement Mapping tab
  • Add and select asset.
  • Select measurement that you want to map varaible/tag inside of OPC Server to OCTOBUS.
  • Fill the NodeId from OPC server then select Sampling Method. ( Subscribe interval will be fixed to 300 ms)
  • Select more assets or measurements if it's needed then click create.

3: Deploy to Node-RED

• Generate Flow for Node-RED.

• Copy or Download the configuration.

• Open Node-RED web application.

• Click the hamburger button and then select import.

• Paste the configuration or select the downloaded configuration file then click import.

• You will see the pop up that show the flow has been imported then DEPLOY it!

Connecting to OCTOBUS using MQTT Client and OCTOBUS payload node.

1: Create Client on OCTOBUS

• Go to Clients Tab create new Client.

• On Client Type select Generic MQTT.

• Select any assets which you want to add to the client.

2: Preparing nodes on Node-RED

• Prepare the OCTOBUS payload node

  • For each OCTOBUS payload reserve for each measurement in OCTOBUS
  • On OCTOBUS you will see the message payload format for each measurement.
  • Copy Asset Id and Measurement Id from OCTOBUS and paste to OCTOBUS payload on Node-RED.
  • Select the Data type which have to match on OCTOBUS.

• Prepare the MQTT Client node

  • On mqtt out node, fill the topic and set the QoS to 1.
  • Fill the MQTT Endpoints, username and password on Connection and Security tab accordingly

• The wire for OCTOBUS payload node and mqtt out node will be look like this.

FAQ

• Install to the .node-red folder if you have installed node-red globally
• Install to the userDir directory if you have custom userDir
• Make sure that your nodejs version is relatively current