openmanufacturingplatform / iotcon-opc-ua-connector-dotnet

This repository is dedicated to the OMP IoT Connectivity Working Group

THIS REPOSITORY WAS ARCHIVED ON DECEMBER 8, 2022. OMP WILL CLOSE AT THE END OF DECEMBER, 2022.

OMP OPC UA Edge Connector

• OMP OPC UA Edge Connector
  • Software under construction
  • Introduction
  • Infrastructural View
  • Application View
  • Operational View
  • Getting Started and Contribution
  • Build and Installation
  • Create your own OPC UA Server
  • Third party software

Introduction

• OPC UA is the major vendor independent machine protocol on production asset level
• IT systems don't have support for OPC UA, but follow streaming approaches
• There are currently no standalone, industrial-prove connectors for OPC UA available that convert OPC UA to a neutral format (e.g. MQTT or Kafka) and can be purely controlled by messages

That's why the OMP IoT Connectivity Working Group saw the need for a connector software, that is able to run on the edge level. The key OPC UA functionalities are supported according to the OPC Foundation Specifications and the OMP Edge standards are followed as defined in the OMP White Paper. Both further OPC UA functionalities and new integration capabilities are to be added in a modular approach in the future. The focus on easy integrability and flexible extensibility is intended to encourage usage and collaboration.

Infrastructural View

The OPC UA Edge Connector is hosted on the Edge Level and can connect to the cloud level and the production asset level. Southbound to the production asset level it connects via the OPC UA Client/Server protocol. Northbound it connects to a message broker like MQTT or Kafka, which is in the cloud level or in the edge level, either on the same edge node for local processing of the data or centrally in the plant data center. The OPC UA connector is a containerized software and can run on an Edge Node like an industrial PC or a container platform.

Application View

The OPC UA Edge Connector is controlled by messages. Therefor it consumes JSON messages from a command topic. After receiving a command, it executes an OPC UA operation against the OPC UA Server on an device (e.g. read/write/subscribe). The information about the success or failure of the operation is sent via the command result topic.

A special function has the telemetry topic. Notifications of monitored items resulting from an active subscription are sent to the telemetry topic.

Operational View

In the configuration phase of the OPC UA Edge Connector a configuration needs to be applied. The configuration contains for example information about the message broker endpoints. The software is logging by default to the console. The user needs to bring a appropriate Monitoring Service and Management Service in place to be control, observe and operate the software centrally and in large scale.

Getting Started and Contribution

• Please check our documentation: README
• Share your thoughts with us in our Discussion Board
• You found a issue? Please create a GitHub Issue

Build and Installation

• Please go to the MQTT Example to see how to build and run it.
• Please go to the Kafka Example to see how to build and run it.

Create your own OPC UA Server

• If you want to create your own OPC UA server for testing. We suggest having a look at the OPC UA Server Stack Feature Matrix

Third party software

• Please see all 3rd Party software used with the licenses 3rd Party Software

iotcon-opc-ua-connector-dotnet's Issues

MQTT example crashes when 'destinationIdentifiers' field is empty

'destinationIdentifiers' field can not be empty on requests (when subscribing...)

Solution Criteria:

• Prevent app from crashing
• Provide proper error message
• Proper documentation & example of 'destinationIdentifiers' field (What it is and why)

Browse on Node with NodeClass object fails

In the current schema it is the Browse command in the new schema it will become the ReadNode command.

Request/Command :
Send a OpcUaCommandType = Browse command on a Node with NodeClass = Object

Expectation:
Good result of OpcUaCommandType = Browse.

Actual Result:
Bad result of OpcUaCommandType = Read and not Browse.
The payload data is of type = BrowseResponse (Which is correct)
The error message =
Missing type map configuration or unsupported mapping.
Mapping types:
Object -> BrowsedOpcNode
System.Object -> OMP.Connector.Domain.Schema.BrowsedOpcNode

Test data:
Opc Ua Server = mcr.microsoft.com/iot/opc-ua-test-server:latest (docker)
Node = ns=11;i=442 and ns=17;s=Telemetry

Mqtt example crashes with 'Connection already exists' error

In the Mqtt example only a single clientId is given in the shared section. Resulting in the M2MqttClientFactory to create multiple connections with the same ID. The desired behavior is that the M2MqttClientFactory shares the same connection per client ID,

Standardize API (Merge Models and remove 'dead' code)

Discussed in #20

^{Originally posted by ivomp September 3, 2021}

Merge Models and remove 'dead' code

At the moment the ('Schema') models are scattered between the Domain and the Domain.Schema projects. There are also many models (and code) that are no longer used.

The idea is to merge the Domain & Domain.Schema projects and fix all the namespaces accordingly. Also to remove all the dead/unused models & code.

Build & Publish container to docker hub

FIx zlib vulnerability

FIx zlib vulnerability

Get access to create milestones

MQTT example crashes when wrong endpoint are given

MQTT example crashes when wrong endpoint are given

Acceptance Criteria:

• App handles error gracefully
• Proper Error logged

Build & Publish Domain Nuget Package

Setup github action to build, run test, package nuget and publish to nuget.org

Docker files out of date

The code base has recently been updated to .Net 6 but some of the docker files in the solution still references .Net5

Add Unit Tests

remove endpoint description config

Build & Publish Application Nuget Package

Setup github action to build, run test, package nuget and publish to nuget.org

Build & Publish Kafka Nuget Package

Setup github action to build, run test, package nuget and publish to nuget.org

Add E2E tests

Replace ComplexTypeSystem code borrowed from OPCFoundation with reference to their nuget package.

Code was borrowed from OPCFoundation github a few years ago in order to apply custom fixes.
Need to check if issues still persist, and fix and create a PR for it on the OPCFoundation repo, so that we can reference the official nuget package instead of duplicating the code.

• May need to create a fix and PR on OPCFoundation Github.

Re-add support for MQTT

Discussed in #19

^{Originally posted by ivomp September 3, 2021}
A running connector that received commands and send responses & telemetry on MQTT

Change code architecture to pull in infrastructure as opposed to the infrastructure running the application

Add support for basic user authentication

Discussed in #25

^{Originally posted by maxschueler September 7, 2021}
A connector that is capable of running a basic user authentication (username/password)

Basic Setup Antora Documentation

Redundant setting in sample kafka application config file

iotcon-opc-ua-connector-dotnet/samples/KafkaSample/moduleSettings.example.json

Line 62 in 4efcf70

"Key": "....",

I think the key setting is not needed here?
I compared it with an actual config file and noticed that the key is not in the actual config file, only in the example template

Can you please confirm this @ivomp, then I will fix this.

Use OPC UA JSON Encoding for PubSub Payload

The current JSON Payload is OMP own mapping/encoding.

OPC UA defines with Part 14 also the PubSub communication over transport protocols like MQTT.

For JSON the OPC spec defines an interoperable mapping to be consumed by cloud and data analytics applications.
https://reference.opcfoundation.org/Core/docs/Part14/6.3.2/

As a starting point please have a look an the reference implementation by @barnstee.
https://github.com/barnstee/UA-CloudPublisher

@veithammerstingl for OPC UA for Machine Tools a prototype implementation is already available at: https://github.com/umati/Sample-Server/tree/pubsub

Add initial code

Update project targets to .net6.0

Since .net5.0 is not LTS, the targets need to be upgraded to .net6.0

Add initial documentation

Setup github action to build, run test, package nuget and publish to nuget.org

ModuleSettings.example.json incorrect

The example settings file has some naming issues and have some missing values.

For example the 'CommandEndpoint' section under 'Communication' should in fact be 'RequestEndpoint'
Also how the behavior changes when certain values are configured (or not configured) ex. On MQTT example if the 'clientId' is not configured under each section then the mqtt connection will be shared for all topics

Add support for registered write