MQTT Keyword Library for Robot Framework
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.


MQTTLibrary for Robot Framework

MQTTLibrary is a Robot Framework library that provides keywords for testing on MQTT brokers. MQTT is a lightweight protocol for machine-to-machine communication, typically used for IoT messaging. This library uses the paho client library published by eclipse project.


MQTTLibrary can be installed using pip:

pip install robotframework-mqttlibrary

You can also install it from the source distribution by running:

python install

You may need to run the above command with administrator privileges.


Import the library:

*** Settings ***
Library          MQTTLibrary

Connect to the broker, publish and disconnect:

*** Test Cases ***
    Publish     topic=test/mqtt_test    message=test message
    [Teardown]  Disconnect

Connect to the broker, subscribe and validate that a message is received:

*** Test Cases ***
Subsribe and Validate
    Subscribe and Validate  topic=test/mqtt_test    qos=1   payload=test
    [Teardown]              Disconnect

Keyword documentation is available at:

Also look at tests folder for examples.

For general information about using test libraries with Robot Framework, see Robot Framework User Guide.