Using communication packages

Selecting the communication package

In order to select this communication package in OPC UA PubSub tools, you need to set a custom property on a PubSub connection as follows:

• Property namespace: http://opclabs.com/OpcUA/PubSub
• Property name: MessageChannel!
• Property datatype: String
• Property value: The type name of the message channel object. See the communication package documentation (example: OpcLabs.Mqtt.MqttClientMessageChannel,OpcLabs.Mqtt).

How this is done depends on the concrete software you are using. The actual value is an assembly-qualified name, so if needed, you can specify the version of the assembly, its public key token, and so on.

EasyUASubscriber object

Usually, you will use the same communication package across your solution, but there is nothing that prevents you to use a different one with each PubSub connection, e.g. for compatibility reasons with different MQTT brokers.

UADemoPublisher tool

In UADemoPublisher, you set the custom property on a PubSub connection using the --ConnectionProperties (-cp) option. They key is in the form {url}name, where url is the property namespace, and name is the property name. For example, to publish messages using the OpcLabs.Mqtt communication package, you can use the following command:

UADemoPublisher -mut -cp {http://opclabs.com/OpcUA/PubSub}MessageChannel!=OpcLabs.Mqtt.MqttClientMessageChannel,OpcLabs.Mqtt

As typing this in would be cumbersome, UADemoPublisher comes with several ready-made response files which contain the necessary settings for common MQTT communication packages. With the help of the response file, the command above can be shortened to:

UADemoPublisher -mut @MessageChannel-Mqtt

Since the command-line option name is the same as in the "uaSubscriber subscribeDataSet" or "uaSubscriber subscribeDataSetField" commands in the OpcCmd tool, the same response files can be used for communication package selection as with the OpcCmd tool.

Configuring the communication package

The specific information necessary for establishing and maintaining the communication is provided by the host software. In addition to that, the communication packages typically have various configuration parameters that influence their behavior, and the parameters differ from package to package. The defaults are set in such a way that in most cases, you do not need to care about the configuration at all. If the configuration needs to be changed, the primary way of doing so is using the configuration properties.

Beside programmatically accessible configuration properties, the communication package may provide other means of configuration, described in its documentation.