Versions Compared

Key

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

...

This tutorial shows how to configure the MQTT modules to publish and process files.

Step 1: Install the MQTT modules

Install the four MQTT modules listed in the pre-requisites onto your Ignition system following the Cirrus Link Module Installation guide.

By default, both MQTT Engine and MQTT Transmission are configured to connect to MQTT Distributor on tcp://localhost:1883 and will show as Connected under their respective Servers configuration setting in the Ignition UI. 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.

...

When complete, it should look similar to the following. Save the changes after confirming.

Step

...

3: Configure MQTT Transmission to publish files

Now we can configure the MQTT Transmission module to publish files using the existing MQTT client created by the Example Transmitter. Navigate to the MQTT Transmission > Settings in the left side bar of the Ignition Gateway UI and select the Transmitters tab. Make note of the Sparkplug IDs configured for your transmitter.

...

After the configuration is saved, it should look similar to below:

Step

...

4: Publish Files

At this point, everything should be configured to send files from MQTT Transmission to MQTT Engine. Open Ignition Designer on the system running MQTT Transmission. You should see the control and information tags created in the specified tag provider and folder as shown below:

...

Note
With the File Auto_Publish disabled, the files will be left on the originating filesystem after a successful publish and will need to be removed manually


Step 5: Viewing the messages in the Ignition logs

The records published from MQTT Transmission can be be viewed in the Ignition Gateway logs by setting the com.cirruslink.mqtt.engine.gateway.sparkplug.SparkplugPayloadHandler logger to TRACE.

Tip
Review the Gateway Loggers from Ignition for details on how to do this.

Image Added




Extra Activities

At this point you have a fully functional system which can be expanded or modified as required. Below are some addition configuration options to try:

...