Skip to main content
Chariot v2.7 - v2.8.1

Chariot Client Overview

Prerequisites​

Before using the Chariot MQTT Client:

  • Install the Chariot MQTT Server
  • No Chariot license is required to use the MQTT Client
  • The MQTT Client can be used without running the Chariot trial timer

Summary​

The Chariot MQTT Client is a built-in MQTT application that allows you to:

  • Connect to multiple MQTT servers simultaneously
  • Subscribe to MQTT topics across connected servers
  • Publish MQTT messages with custom payloads
  • Browse and interact with live MQTT topic trees
  • Configure MQTT QoS levels and retained messages
  • Decode message payloads in multiple formats, including:
  • Plaintext
  • Sparkplug B
  • Hex
  • Base64

The client includes three primary views:

  • Connections: Create and manage MQTT server connections.
  • Publish/Subscribe: Subscribe to topics, publish MQTT messages, and simulate device traffic for testing.
  • Topic Tree Viewer: View live MQTT topic activity across all connected servers in a hierarchical topic tree.

Launch the Chariot MQTT Client​

To launch the Chariot MQTT Client:

  1. Log in to the Chariot MQTT Server Web UI
  2. In the left-hand navigation menu, navigate to Test Client
  3. Select MQTT Client View

Add a Server Connection​

To create a new MQTT server connection:

  1. Open the Connections tab
  2. Click Add Connection
  3. Configure the connection settings, including:
  • MQTT username
  • Password
  • Server address or URL
  • Port
  • Client ID
  1. Click Add

The client can connect to any MQTT server, including public brokers such as test.mosquitto.org.

If connecting to the local Chariot MQTT Server instance, ensure the trial timer is enabled so the server accepts incoming MQTT connections.

After creating the connection, find the active connection and current connection state are displayed in the upper-right corner of the window.

  1. Select the server connection
  2. Click the green Connect button
    • The connection status of your server should be visible in the top right-hand corner.

Publish and Subscribe​

To subscribe to MQTT topics and publish messages:

  1. Open the Publish/Subscribe tab
  2. In the Subscribe section:
    • Enter a topic filter (for example: #)
    • Click Subscribe

To publish a message:

  1. Enter a topic and payload in the Publish section
  2. Click Publish

Published messages will appear in the Messages view and will be automatically decoded when possible.

View the Topic Tree​

The Topic Tree Viewer provides a live view of MQTT topics and messages across all connected MQTT servers.

To browse messages:

  1. Open the Topic Tree Viewer tab
  2. Expand topics in the tree to navigate the MQTT hierarchy
  3. Select a leaf topic to view cached messages for that topic

Additional behavior:

  • Each topic displays the number of locally cached messages
  • Selecting a topic automatically populates the Messages view
  • Subscriptions configured in the Publish/Subscribe tab are shared with the Topic Tree Viewer