Skip to main content

CLI Python Client

This guide will help you get started with the Python CLI client. The client connects to your MQTT broker and allows you to interact with your devices.

You need to have an MQTT broker set up. Both the client will connect to it.

Setup Instructions​

  1. Clone the StormPythonCLIClient repository.

  2. Open a command line terminal and navigate to the cloned project folder. Install the requirements:

    pip install -r requirements.txt

  3. Create a secrets.py file in the project folder with your MQTT broker details:

    BROKER_ADDRESS = "your_broker_address"
    BROKER_PORT = your_broker_port
    USERNAME = "your_username"
    PASSWORD = "your_password"

  4. Start the client:

    python client.py

    When successfully started, you should see output similar to this:

    CLI client terminal output

    The client will automatically connect to any devices being simulated by the device simulator.