Example

The following examples can be found on this page:

• Basic Settings Example

• Advanced Settings Example

Basic Settings Example

This example demonstrates how to use the Listener to return temperature readings from an MQTT broker using minimal configuration. It is designed to work with the MQTT Action Agent Basic Settings Example.

Refer to configuration to understand all configuration options of this Agent.

Step 1: Add the Agent

Drag the MQTT Listener onto the canvas and rename it. Link the output endpoint to the printer and save the Data Stream.

Step 2: Configure General

Select the Agent and click Configure. In this case, keep the default Collection.

Step 3: Configure Broker Connection

Fill in the broker address of your MQTT broker and the topic to listen for. In this case, tick to use variables, and select a broker address and topic.

Step 4: Configure Payload

Fill in the payload definition. In this case, leave the payload format default and enter the following properties:

• Temperature, Double

• Timestamp, DateTime

Step 5: Results

Apply the changes, save the Data Stream, and publish it.

Let's look at the Live Data View. Make sure the MQTT Action Agent Basic Settings Example is also published.

Observe that any new temperature readings published by the MQTT Action Agent for the specified topic are printed by the Listener.

Files

File	Link	Security Key
Data Stream	MQTT Listener Example.xuc	C0mp|ex123

See the Import, Export, and Clone - XMPro article for steps to import a Data Stream.

Advanced Settings Example

This example demonstrates how to use the Listener to return temperature readings from an MQTT broker with a Secured channel using advanced configuration.

Refer to configuration to understand all configuration options of this Agent.

Step 1: Add the Agent

1. Drag the MQTT Listener onto the canvas.

2. Link the output endpoint to the printer.

3. Save the Data Stream.

4. Click Configure.

Advanced Example Step 1: Add the Agent

Step 2: Configure Broker Connection

Fill in the broker address of your MQTT broker and the topic to listen for. In this case, tick to use variables, select a broker address and topic and leave clean session ticked.

Tick the advanced settings to show more configuration options.

Advanced Example Step 2: Configure Broker Connection

Step 3: Configure Advanced

Enter the port, client ID, QoS, and status message preference.

In this example, select your port and client ID. Keep the default QoS (Exactly Once), and status message (unticked).

Advanced Example Step 3: Configure Advanced

Step 4: Configure Channel

Tick the secure channel if you want to enable TLS/SSL channel communication and enter the channel details.

In this case, keep the default protocol (TSL v1.2), upload both the root and client certificates and select the client certificate password.

Advanced Example Step 4: Configure Channel

Step 5: Configure Authentication

Enter the authentication details: select a username and password.

Advanced Example Step 5: Configure Authentication

Step 6: Configure Payload

Fill in the payload definition. In this case, leave the payload format default and enter the following properties:

• Temperature, Double

• Timestamp, DateTime

Advanced Example Step 6: Configure Payload

Step 7: Results

Apply the changes, save the Data Stream, and publish it.

Let's look at the Live Data View. Observe that any new temperature readings published to the MQTT broker for the specified topic are printed.

See Basic Settings Example for a side-by-side results with an Action Agent.

Advanced Example Step 7: Results

Files

File	Link	Security Key
Data Stream	MQTT Listener Example - Advanced Settings.xuc	C0mp|ex123

See the Import, Export, and Clone - XMPro article for steps to import a Data Stream.