mqttools 0.11.0

MQTT tools.

MQTT Tools

Requires Python 3.7 or later!

NOTE: This project is far from complete. Lots of MQTT features are not implemented yet, and those implemented are probably buggy.

Features:

• asyncio MQTT 5.0 client (under development).

MQTT 5.0 specification: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html

Examples

Command line

Subscribe

Connect to given MQTT broker and subscribe to a topic. All received messages are printed to standard output.

$ mqttools subscribe /test/#
Topic:   /test
Message: 11

Topic:   /test/mqttools/foo
Message: bar

Publish

Connect to given MQTT broker and publish a message to a topic.

$ mqttools publish /test/mqttools/foo bar
Published 1 message(s) in 0 seconds from 1 concurrent task(s).

Publish multiple messages as quickly as possible with --count to benchmark the client and the broker.

$ mqttools publish --count 100 --qos 1 /test/mqttools/foo
Published 100 message(s) in 0.39 seconds from 10 concurrent task(s).

Monitor

Connect to given MQTT broker and monitor given topics in a text based user interface.

$ mqttools monitor /test/#

The menu at the bottom of the monitor shows the available commands.

• Quit: Quit the monitor. Ctrl-C can be used as well.

• Play/Pause: Toggle between playing and paused (or running and freezed).

Scripting

Subscribe

An example connecting to an MQTT broker, subscribing to the topic /test/#, and printing all published messaged.

import asyncio
import mqttools

async def subscriber():
    client = mqttools.Client('broker.hivemq.com', 1883)

    await client.start()
    await client.subscribe('/test/#', 0)

    while True:
        topic, message = await client.messages.get()

        if topic is None:
            print('Broker connection lost!')
            break

        print(f'Topic:   {topic}')
        print(f'Message: {message}')

asyncio.run(subscriber())

Publish

An example connecting to an MQTT broker and publishing the message bar to the topic /test/mqttools/foo.

import asyncio
import mqttools

async def publisher():
    client = mqttools.Client('broker.hivemq.com', 1883)

    await client.start()
    await client.publish('/test/mqttools/foo', b'bar', 0)
    await client.stop()

asyncio.run(publisher())