/node-red-contrib-iiot-opcua

A Node-OPCUA based IIoT contribution package for Node-RED.

Primary LanguageJavaScriptBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

node-red-contrib-iiot-opcua

Platform Node-RED Node-RED IIoT OPC UA License NPM version ES_Deploy_Version NodeJS_Version Standard - JavaScript Style Guide NPM download Build status Test Coverage Codacy Badge Gitpod Ready-to-Code

The IoT/IIoT OPC UA toolbox package for Node-RED based on node-opcua

  • tested with Node.js v16.15 and Node-RED v3.0.0
  • tested with Node.js v14.19 and Node-RED v2.2.2
  • based on node-opcua v2.64

The actual DATATRONiQ and Iniationware contributions to v4.x+ upgrade the original work of v3.x by migrating to TypeScript, breaking-changes, and updating dependencies, including updates to new major release versions of Node-RED (v1.x to v2.x and higher) and node-opcua (v0.7 to v2.64 and higher). Now DATATRONiQ and Iniationware working together and try to build a community from the industry and individuals to provide an LTS Industrial IoT package for OPC UA.

International IIoT Website for Node-RED

For an international area, Iniationware has provided the PLUS for Node-RED International website.

IIoT Webseite Deutschland für Node-RED

Für einen deutschsprachigen Bereich hat Iniationware die Webseite PLUS for Node-RED Germany bereitgestellt.

Installing

Node-RED

Use the Node-RED "Manage Pallet" to install it via Node-RED

Manual

  1. Navigate to your Node-RED data directly. This defaults to $HOME/.node-red/
  2. Install via npm. 
    npm install node-red-contrib-iiot-opcua

Migrating from previous versions

The update from v3.x to v4.x changed the way some nodes are implemented. As a major version v4.x has breaking-changes.

General Changes

  • The message format was standardized. While in older versions, a lot of additional properties were placed directly into the message, they have been moved into the message's payload (msg.payload). This is to ensure the standard Node-RED message format is used, where the message itself may only contain an ID, a topic, and a payload. This means that any references like msg.nodetype should be changed to msg.payload.nodetype.

Browser

  • The option singleBrowseResult has been replaced with multipleOutputs, and the default value now combines all outputs into one message. To maintain the same output, replace singleBrowseResult with multipleOutputs and swap the corresponding boolean value (true becomes false, false becomes true).

Flex-Server

  • The node-opcua library is now directly accessible as opcua. This means all references to coreServer.core.nodeOPCUA should be replaced with opcua.
  • node.iiot.assert is no longer accessible. The functionality can be replaced by using an if statement that throws a new error (if (errorConfition) throw new Error('Error Message'). Errors can be displayed by using a catch node connected to a debug node, which displys the entire message.

Contributing

Every bit helps! If you come across any bugs, please send a bug report, or if you feel inclined to fix it yourself, submit a pull request.

Debugging

To increase the verbosity of logging, enable debug modes and verbose logging.

Start debug with Node-RED in verbose (-v) mode to get a verbose logging:

DEBUG=opcuaIIoT* npm run start -v 1>nodeREDIIoTOPCUA.log 2>&1

Examples

Basic Flow

Flow Example

Your own address space model!

With the flex server you could create your own information model with the OPC UA address space.

Flex server Example

Learn with the examples!

The server node contains demo objects and variables to start playing with OPC UA method call, read and write operations.

see Node-RED menu (right upper corner) -> Import -> Examples -> iiot opcua

Flow Example

... secure reading from OPC UA servers with your own key pairs ...

Read Example

... and secure writing and moving data between OPC UA servers ...

Write Example

Read Write Example

... create your own variables and objects from events ...

Node-RED UAExpert / Client
ASO Example ASO UAExpert

Reconnect via events with the Flex Connector!

Flow Flex Connector

Package Information

License

The BSD 3-Clause License

DATATRONiQ, is the current maintainer of the DATATRONiQ node-red-contrib-iiot-opcua detached Fork

This Node-RED package has been revitalized in 2022 and is based on the node-red-contrib-iiot-opcua package created by Klaus Landsdorf in 2017. Copyright notices by Mika Karaila, Klaus Landsdorf, and others are to honor their work in previous years on Node-RED, OPC-UA, and node-red-contrib-iiot-opcua; we are very grateful for all the time and energy they've invested!!

Klaus Landsdorf, creator and current maintainer of the Bianco-Royal node-red-contrib-iiot-opcua

That is a whole new Node-RED package started in 2017 based on the node-opcua v0.4 and the API documentation. The old copyrights by Mika Karaila are just to honor his pioneer work in the years 2015/2016 for Node-RED and OPC UA.

Important

This is not an official product of the OPC Foundation or Plattform Industrie 4.0.

Special thanks

Special thanks go to Etienne Rossignon for the node-opcua packages and very special for the node-opcua-isa95 package! Special thanks also go to Klaus Landsdorf for creating node-red-contrib-iiot-opcua in the first place!