AVEVA™ Communication Drivers Pack – Standards - MQTT Driver Readme

Last revision: Friday, November 20, 2020

HMI SCADA YouTube Channel

Our HMI SCADA YouTube channel contains instructional and promotional videos on our various product lines. Please follow the links below:

Platform Connectivity and Device Integration Playlist

https://www.youtube.com/playlist?list=PLJq4rR8tWINwTpCnlHqjUUlysBClU-YqU

HMI SCADA Channel Main Page

https://www.youtube.com/user/wonderwarehmi

eLearning Training Courses

You can now access hundreds of training courses that cover simple and complex topics with all the products that you use in our Monitoring and Control portfolio. Access to the eLearning modules is free!

https://sw.aveva.com/training/wonderware

About This Release

This document contains important information about MQTT Communications Driver. Review this document for known issues and changes to MQTT.

Message Queuing Telemetry Transport (MQTT), is a publish/subscribe messaging protocol for use over TCP/IP. MQTT is designed to ensure that devices can communicate with each other while minimizing power and bandwidth requirements. It is a simple messaging protocol that is well-suited for use with devices that rely on slow or unreliable networks.

The MQTT protocol is an application layer specification, and has been published as standard ISO/IEC 20922. MQTT uses a Publish-Subscribe mechanism which requires a mediating broker. The publishers send data to the broker, and subscribing clients receive data published to the broker. Only clients that have subscribed to a particular topic receive messages about that topic. The protocol supports bidirectional communication such that a device that is a publisher can also receive updates.

The MQTT Communication Driver also supports Sparkplug B specification with payload data encoding in binary format. MQTT Communication Driver is a subscriber, which automatically analyzes whether the payloads are Sparkplug encoded or traditional JSON encoded. AVEVA Edge is an MQTT publisher which can be configured to send its data to a broker for MQTT Communication Driver to subscribe.

Note:The MQTT subscriber plug-in within the Gateway Communication Driver has been superseded with this standalone MQTT Communication Driver. The MQTT Gateway plug-in will be phased out in the next major release of the Communication Drivers. We recommend you to modify your configuration to start using the new standalone MQTT Communication Driver instead.

New Features and Enhancements

OpenSSL 1.1.1g Support

MQTT Communication Driver now uses OpenSSL 1.1.1g for secure communication with the MQTT Broker.

System Requirements

Platform Compatibility

The MQTT Communication Driver will always be compatible with the latest release of System Platform.

Operating Systems

For a list of supported operating systems for the communication drivers, refer to the Technology Matrix, available at the Global Customer Support (GCS) Site:

The Technology Matrix is a searchable database that contains the latest product information. Enter the product name in the search bar, then select the release to view:

• Product Information: version name, number, release date, etc.
• Product Notes: key release information, new features, and updates
• OS Compatibility: list of compatible Windows and Windows Server versions
• Browser Compatibility: list of compatible browsers
• Virtualization Compatibility: list of compatible virtualization software products and versions
• Product Coexistence: list of products that can be installed on the same computer

Product Interoperability/Compatibility: list of products that can operate together and communicate with each other through a common message protocol.

Hardware Requirements

To run a Communication Driver, the following hardware configurations are the minimum recommended:

• 2 GHz or faster processor, 32-bit or 64-bit (Intel Itanium processor is not supported)
• RAM: 8 GB or more
• At least 80 GB of available hard disk space
• Super VGA (1024 x 768) or higher-resolution video adapter and monitor
• Keyboard and Microsoft Mouse or compatible pointing device

  Note: For every additional 5 connections (Up to 10,000 I/O @ 1000 ms each), add 1 GB RAM and 1 Cores.

Runtime Poking Behavior of MQTT Communication Driver

Poking to Sparkplug Template structure items is only allowed for items with the following syntax :

spvB1.0/GroupName/EdgeGatewayName.(TemplateName).value.template.(MemberName).value

or

spvB1.0/GroupName/EdgeGatewayName/DeviceName.(TemplateName).value.template.(MemberName).value

where,

GroupName: Name of Sparkplug group

EdgeGatewayName: Name of the Edge Gateway

DeviceName: Name of the Device

TemplateName: Name of the Sparkplug template instance

MemberName: Name of the member in the Sparkplug template instance

Note: Poking to items associated with Sparkplug Data Set, Template Parameters and nested Templates is not supported.

Resolved Issues

The following issues are resolved in this release for the MQTT Communication Driver.

Known Issues

There are no known issues in this release.

MQTT Communication Driver Documentation

The MQTT Communication Driver documentation set includes the following guides. These documents can be accessed from the Help menu in the SMC.

1. Standards - AVEVA™ MQTT Communication Driver Help. This guide describes the user interface and functions of the MQTT Communication Driver.
2. AVEVA™ Communication Drivers Pack Help. This documentation describes the runtime Configuration, Diagnostics, and Activation/Deactivation aspects of a Communication Driver.
3. Log Viewer Help. This guide provides information about the Logger™ and the Log Viewer snap-in to the System Management Console.
4. LogFlag Editor User's Guide. This documentation describes the user interface and functions of the LogFlag Editor utility. This utility can be opened only from the Log Viewer, a part of the System Management Console suite of utilities.
5. AVEVA Enterprise License Manager Help This guide describes how to use the License Manager to activate and acquire licenses.

   Note: The AVEVA Enterprise License Manager Help can be accessed through the License Manager application (available only for the new license framework). For earlier versions of the license framework, see License Utility Guide.