AVEVA™ Communication Drivers Pack – Standards – MQTT Driver Readme

Last revision: Monday, November 27, 2023

HMI SCADA YouTube Channel

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

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 Communication Driver. Review this document for known issues and changes to MQTT.

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.

In this release, as a subscriber, the MQTT Communication Driver will subscribe MQTT payload of Sparkplug, JSON, and/or plain text format. As a publisher, the MQTT Communication Driver will publish data in JSON and Sparkplug format.

Note: You cannot use the Gateway Communication Driver or the 2020R2 release of the MQTT Communication Driver to subscribe to the JSON payload published by this release of the MQTT Communication Driver. To subscribe to the MQTT payload published by this release of MQTT Communication Driver, please upgrade the installation of any previous installations of the MQTT Communication Driver to this release. MQTT payload published by the Gateway Communication Driver will continue to be recognized by the MQTT Communication Driver.

New Features and Enhancements

There are no new features and enhancements in this release of the MQTT Communication Driver.

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 DataSet, Template Parameters and nested Templates is not supported.

Resolved Issues

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

Known Issues

There are no known issues in this release of the MQTT Communication Driver.

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 OCMC.

1. Standards - AVEVA™ MQTT Communication Driver Help (PDF). This guide describes the user interface and functions of the MQTT Communication Driver.
2. AVEVA™ Communication Drivers Pack Help (Web Help). This documentation describes the runtime Configuration, Diagnostics, and Activation/Deactivation aspects of a Communication Driver. This also includes the user guides of all the Communication Drivers.
3. Log Viewer Help. This guide provides information about the Logger™ and the Log Viewer snap-in to the Operations Control 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 Operations Control 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.