Installation

The MQTT Client software application is installed using the CIMPLICITY 2023 Integrated installer.

The integrated installer helps you setup and install the following applications on your machine. The MQTT Client enables you to connect the SCADA/HMI clients with MQTT Brokers to communicate with the IoT devices.
  1. MQTT Client
  2. License Client
  3. Proficy Authentication
  4. Configuration Hub
Note:
  • When you select MQTT Client from the CIMPLICITY Integrated installer, along with the MQTT Client software installation, the License Client will also be installed silently. The License Client helps you manage the license for the MQTT Client software and authenticates you to use the application on your machine.
  • Configuration of the MQTT Client requires Configuration Hub to be installed on the SCADA network. Refer to the Configuration Hub documentation for more details.
  • Setting up Proficy Authentication provides access to all the products (CIMPLICITY) registered with Configuration Hub. You use the same Proficy Authentication server to authenticate the user of all the products. Refer to the Proficy Authentication documentation for more details.

To install the MQTT Client using the CIMPLICITY Integrated installer:

  1. Double-click the <Integrated Installer>.iso disc file or select Mount from the context menu.
  2. Double-click the Setup.bat windows batch file, which will launch the CIMPLICITY Integrated installer.
    Note: You can also navigate through the Setup folder, and then double-click the setup.exe application to launch the CIMPLICITY Integrated installer.
    The welcome screen for the CIMPLICITY installation suite appears.
  3. Select MQTT Client, and then click START.
  4. Click ACCEPT to proceed with the License Agreement.
  5. Click NEXT to install the MQTT Client in the default location C:\Program Files\Proficy or click to modify the install location.
    Note:
    • It is recommended to install the MQTT Client application in its default location, that is, C:\Program Files\Proficy\MqttClient\.
    • You can choose to install the MQTT Client application in a different path, however you cannot install the MQTT Client in the Program Files (x86) folder. If you choose C:\Program Files (x86)\Proficy\MqttClient\ the MQTT Client application will still be installed in its default location, that is, C:\Program Files\Proficy\MqttClient\.
    Note: If the default ports are already in use, the Integrated installer will automatically resolve to the next available port numbers. You can check the ports used by the MQTT Client application by selecting TCP Port List.
  6. Create login credentials for MQTT Client, and then click NEXT.
    Note:
    • For a strong password, you must use an alphabet and a number.
    • Make a note of the credentials, as the same credentials are used for logging into MQTT Plug-in Registration.
  7. Click START in the Confirm Install screen to start the MQTT Client installation.
    The MQTT Client application is installed on your machine.
    Note: You can click Log for MQTT Client and Proficy Installer to view the respective installation logs.
  8. Click CLOSE.
    Note: You can now enable your HMI/SCADA OPC UA clients to communicate with IoT devices and MQTT brokers by using the MQTT Client application.
  9. You must restart your system for proper functioning of the MQTT Client application. Click REBOOT NOW to restart your system.
    Note: Click REBOOT LATER if you want to restart your system at a later time, or click INSTALL MORE PRODUCTS if you want to install common components (Configuration Hub and Proficy Authentication) and other products from the Integrated installer.
  10. Double-click the MQTT Client Registration desktop shortcut to register the MQTT Plug-in with the Proficy Authentication and the Configuration Hub servers. Refer to Registration and Proficy Authentication for more information.