Versions Compared

Old Version 1

changes.mady.by.user Gill Houghton

Saved on

compared with

New Version 2

changes.mady.by.user Gill Houghton

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Step 1: Install MQTT Engine and MQTT Distributor on the host machine

Install the MQTT Engine and Distributor modules onto your host Ignition system following the Cirrus Link Module Installation guide.

By default, MQTT Engine is configured to connect to MQTT Distributor on tcp://localhost:1883 and will show as Connected under the Servers configuration setting in the Ignition UI.

Step 2: Install MQTT Transmission on the edge machine

Install the MQTT Transmission onto your edge Ignition system following the Cirrus Link Module Installation guide.

By default, MQTT Transmission is configured to connect to MQTT Distributor on tcp://localhost:1883. As the MQTT Distributor is installed o a different server, we will need to edit the configuration to allow MQTT Transmission to connect to the host server.

Note

The MQTT Server must be accessible to the Ignition system running MQTT Transmission. In order for this to work port 1883 must be open to outside connections. Make sure this is allowed via your operating system's firewall configuration and any anti-virus software you may have installed.

This configuration is not recommended for production systems. If running this in production, you should be using TLS encryption on port 8883. More information on how to configure TLS can be found here.

Navigate to the MQTT Transmission > Settings in the left side bar of the Ignition Gateway UI and select the Servers tab.

Change the server URL to point to the server IP address or domain name of the Ignition system running MQTT Distributor and save the configuration. When complete, you should see something similar to the following:Image Modified

Tipwarning
If you do not see '1 of 1' under the 'Connected' status, check the logs to show what may be going wrong and/or to validate the rest of your configuration


MQTT Transmission will also have an Example Transmitter configured pointing to a set of tags that are configured in the Ignition "default" tag provider. 

Tip
Review the MQTT Transmission Transmitters and Tag Trees tutorial for additional information on how Transmitter configurations interact with Ignition tag trees to create the Sparkplug IDs required.


Now we have the three modules connected, we can setup the file publish configuration.

Step 3: Config MQTT Engine 





  • MQTT Engine Settings → Namespaces → Default Tab
    • Click the 'edit' button to the right of the 'Sparkplug B' namespace as shown below
    • Now select the 'Files' tab and set the following
      • Ignore Files: unchecked/false
      • File Host Type: ACTIVE
      • Base File Directory: Set to some directory file path (i.e. 'C:\My Files' or something similar)
      • Add Topic Tokens: checked/true
      • File Storing Policy: REPLACE_EXISTING_FILE
      • When complete, it should look similar to the following. Save the changes after confirming.
    • Finally select the 'Servers' tab and confirm that the 'Status' shows 'Connected' as shown below.

...