Principles of operation

AVEVA Adapter for MQTT is a data-collection component that transfers time-series data from source devices to Open Message Format (OMF) endpoints in CONNECT data services or AVEVA PI Servers. Message Queuing Telemetry Transport (MQTT) is a messaging protocol created for Machine-to-Machine (M2M)/Internet of Things (IOT) communication. The adapter can connect to any device that uses the MQTT protocol for communication with constrained devices and server applications for data exchange.

This adapter's operations focus on data collection and stream creation:

• Adapter configuration

• Connection

• Data collection

• Data types

• Stream creation

Adapter installation

You can install the adapter with a download kit that you can obtain from the Customer Portal. You can install the adapter on devices running either Windows or Linux operating systems.

Adapter configuration

Using REST API, you can configure all functions of the adapter. The configurations are stored in JSON files. For data ingress, you must define an adapter component in the system components configuration for each device to which the adapter will connect. You configure each adapter component with the connection information for the device and the data to collect. For data egress, you must specify destinations for the data, including security for the outgoing connection. Additional configurations are available to egress health and diagnostics data, add buffering configuration to protect against data loss, and record logging information for troubleshooting purposes.

After you have configured the adapter and it is sending data, you can use administration functions to manage the adapter or individual ingress components of the adapter. Health and diagnostics functions monitor the status of connected devices, adapter system functions, the number of active data streams, the rate of data ingress, the rate of errors, and the rate of data egress.

EdgeCmd utility

AVEVA also provides the EdgeCmd utility, a proprietary command line tool to configure and administer an adapter on both Linux and Windows operating systems. EdgeCmd utility is installed separately from the adapter.

The EdgeCmd utility guide provides an overview on how to configure and administer AVEVA adapters on Linux and Windows using command line arguments.