Configure the AVEVA Adapter for MQTT module

The AVEVA Adapter for MQTT module is a data-collection component that transfers time-series data from source devices to OMF endpoints in AVEVA Data Hub or PI Servers. MQTT (Message Queuing Telemetry Transport) 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. The AVEVA Adapter for MQTT module runs on Linux (x64) and Linux (ARM64).

Use the secret store to complete the secure transfer of secret values to the device. The configuration file should contain secret variables that act as placeholders for the actual secrets and passwords. Complete the secret store configuration in AVEVA Edge Management to define values for the secret variables. AVEVA Edge Management encrypts the values and provides the Setup module secret command. After you deploy the module configuration, run the Setup module secret command in a Linux terminal on the device to replace the secret variables with the encrypted values.

To configure the AVEVA Adapter for MQTT module for Linux (x64):

1. Select the specific version of the module you want to configure from the Versions drop-down.

2. Specify the Deployment Name. This identifies the module deployment on the device.

3. Select the Configuration File field to upload a configuration file for the module. A file Open dialog displays. Locate and select the JSON file containing the configuration, then click Open. If you do not specify a configuration file, the module uses the default configuration.

   For information on modifying the configuration on the device, refer to the PI Adapter for MQTT documentation.

4. Specify the Connection Port. This port is used for local configurations.

5. In the Secret Store section, select Setup.

6. In the Setup module secret dialog, enter the secrets or passwords to replace the secret variables in the configuration file.

   Enter values only for the secrets and passwords required to configure the module.

   • Egress Endpoint Secret - Enter the secret or password value to connect to the egress endpoint. When the egress endpoint is AVEVA Data Hub, this is the client secret. When the egress endpoint is PI Web API, this is the password.

   • Additional Egress Endpoint Secret - Enter the secret or password for the additional endpoint when egressing data to more than one endpoint and the other endpoint requires a different password.

   • Data Source Secret - Enter the data source password when the data source requires a password in order to connect.

   • Additional Data Source Secret - Enter the secret or password for the additional data source when connecting to more than one data source and the other data source requires a different password in order to connect.

   By default, the text you enter is hidden, indicated by . To toggle visibility and see the text you entered, select , changing it to . The text you enter in the field is now visible.

7. When you are finished, select Create.

   A module command script is generated containing the encrypted secret information. Use this command to replace the variables in the configuration file on the device with the encrypted secrets.

8. Copy this command, then after you deploy the module configuration, run the command on the edge device in a Linux terminal.

   If this is a new device, you can now pair your edge device with the device twin and deploy the device twin. See Pair a device twin with an edge device for more information.

   If this is an existing device and you are updating the secret information, you must publish your device changes. See Deploy a device twin for more information.

   Important: Every time you generate a new module command script to update secret information, you must run the script on your device, and also publish the device changes. Failure to perform both of these steps prevents the device from functioning correctly.

9. Select Update to save your changes.