Install the adapter

You can install adapters on either a Windows or Linux operating system. Before installing the adapter, see the respective system requirements to ensure your machine is properly configured to provide optimum adapter operation.

The installation and configuration directories can be found here:

• Windows

  Configuration: C:\ProgramData\OSIsoft\Adapters\MQTT

  Installation: C:\Program Files\OSIsoft\Adapters\MQTT

• Linux

  Configuration: /usr/share/OSIsoft/Adapters/MQTT

  Installation: /opt/OSIsoft/Adapters/MQTT

Windows

Complete the following steps to install an AVEVA adapter on a Windows computer:

1. Download AVEVA-Adapter-for-MQTT_1.4.0.455-x64_.msi from the Customer portal.

   Note: Customer login credentials are required to access the portal.

2. Run the .msi file and follow the setup wizard.

   You can change the installation folder or port number during setup. The default port number is 5590.

3. Optional: To verify the installation, run the following curl command with the port number that you specified during installation:

   curl http://localhost:5590/api/v1/configuration

   If you receive an error, wait a few seconds and try the script again. If the installation was successful, a JSON copy of the default system configuration is returned.

Linux

Complete the following steps to install an adapter on a Linux computer:

4. Download the appropriate Linux distribution file (AVEVA-Adapter-for-MQTT_1.4.0.455-platform_.deb) from the Customer portal.

   Note: Customer login credentials are required to access the portal.

5. Open a terminal.

6. Run the sudo apt update command to update available packages information.

7. Run the sudo apt install command against the Linux distribution file (AVEVA-Adapter-for-MQTT_1.4.0.455-platform_.deb) selected in step 1 of this procedure.

   For example:

   sudo apt install ./AVEVA-Adapter-for-MQTT_1.4.0.455-x64_.deb

8. Optional: To verify the installation, run the following curl command with the port number that you specified during installation:

   curl http://localhost:5590/api/v1/configuration

   If you receive an error, wait a few seconds and run the command again. If the installation was successful, a JSON copy of the default system configuration is returned.