Versions Compared

Key

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

Prerequisites

Install HiveMQ

  • Download and Extract HiveMQ:

    • First, you need to download the HiveMQ ZIP file from the official HiveMQ website. https://www.hivemq.com/download/

    • Unzip the folder to C:\ e.g. C:\hivemq-4.25.1

    • Rename this folder to hivemq so the path looks like C:\hivemq

    • Files inside the folder would have a structure e.g. C:\hivemq\bin

  • Doing sanity checks

    • Setting Heap to 50% of system memory(2GB minimum, 4GB in this installation as RAM is 8 GB)

      • Go to C:\hivemq\bin

      • Open the run.bat file with notepad or any other editor

      • Search for VARIABLES section

      • Add the heap configuration (4 GB in this case)
        set "JAVA_OPTS= %JAVA_OPTS% -Xmx4g"

      • Save the file

  • Run HiveMQ broker

    • Go to C:\hivemq\bin

    • Right-click on the file “run.bat” and run it as an administrator

    • This should start the HiveMQ process as shown below

End to End connection testing with MQTT CLI

  • Please make sure HiveMQ Broker is running

  • Please make sure that port 1883 is enabled (e.g. inbound rules under security groups)

  • Setup MQTT CLI

    • Download MQTT CLI

      • Go to the release link https://hivemq.github.io/mqtt-cli/ and go to the latest release

      • Download the correct zip for Windows (mqtt-cli-4.25.0-win.zip on our case)

      • Extract the zip file

      • Open the command prompt and cd into the CLI folder, this folder contains mqtt-cli.exe which will be used for the next steps

  • Subscribe to a Topic: Subscribe to a topic using MQTT CLI with the command:

    Code Block
    mqtt-cli.exe sub -h localhost -p 1883 -i MQTTCLIClientSUB -t "connection/test"

    This command subscribes to the topic connection/test on the broker running on localhost.

  • Publish to the Same Topic: Open another command prompt window, cd to the mqttcli folder and publish a message to the same topic with:

    Code Block
    mqtt-cli.exe pub -h localhost -p 1883 -i MQTTCLIClientPUB -t "connection/test" -m "Test MQTT CLI"

    This publishes the message "Test MQTT CLI" to the connection/test topic.

  • Verify Message Receipt: Check the first command prompt window where you subscribed to the topic. You should see the message "Test MQTT CLI" appear, indicating that the message was successfully published and received.

Next steps