Skip to content

Getting Started with Coreflux Cloud Broker using MQTT Explorer

Introduction

Welcome to Coreflux MQTT Cloud Broker! This document will guide you through the steps to connect to the broker using MQTT Explorer, an intuitive tool for interacting with your MQTT broker. You will also learn how to manage users by adding, removing, and changing passwords through MQTT commands.

Requirements

  • MQTT Explorer installed on your computer.
  • Credentials provided by Coreflux - email with username / password / broker address

Connecting to Coreflux Cloud Broker

  1. Launch MQTT Explorer and initiate a new connection:
  2. Click the + icon to add a new connection.
  3. Enter a connection name (e.g., "Coreflux Cloud Broker").
  4. Choose either mqtts:// for encrypted connection (port 8883) or ws:// for WebSockets (port 443).
  5. Enter the broker address (broker.example.com).
  6. Input the port number (8883 for mqtts:// or 443 for ws://).
  7. Provide the username and password as sent in your Coreflux welcome email.
  8. Select Advanced and enable TLS if connecting via mqtts://.
  9. Click Save.

  10. Subscribe to the topics in order to control the broker:

    • Navigate to the Subscribe tab within MQTT Explorer.
    • Enter # to subscribe to all messages published to the broker.
    • Specifically, subscribe to $SYS/Coreflux/Config/Users to receive user configuration updates and $SYS/Coreflux/Command/# to monitor command topics.
    • Word of Caution: Be careful about leaving your MQTT Explorer session open, as this user has the ability to control access within your broker.
  11. Connect to the broker :

    • Select your newly created connection profile.
    • Click Connect to establish a connection with the Coreflux Cloud Broker.

using mqtt explorer with coreflux

MQTT Explorer - Result of connection to Coreflux MQTT Cloud Broker

Managing Users

Adding a New User

  1. Navigate to the Publish section after connecting to the broker.
  2. In the Topic field, enter $SYS/Coreflux/Cloud/Command or $SYS/Coreflux/Command.
  3. In the Message field, enter the add user command: -addUser <username> <password>.
  4. Example: -addUser JohnDoe secure123.
  5. Click Publish.

Removing a User

  1. In the Publish section, enter the same topic as above.
  2. For the Message, input the remove user command: -removeUser <username>.
  3. Example: -removeUser JohnDoe.
  4. Click Publish.

Changing a User's Password

  1. Again, in the Publish section, use the same topic.
  2. In the Message field, type the change password command: -changeUserPassword <username> <newPassword>.
  3. Example: -changeUserPassword JohnDoe newSecure123.
  4. Click Publish.

Wrap it up 🌯

You are now ready to manage your MQTT users through MQTT Explorer. Remember to always maintain secure password practices and manage user access carefully. For further information and support, consult the Coreflux documentation or contact customer support.