mqttools 0.45.0

MQTT tools.

MQTT Tools

MQTT tools in Python 3.7 and later.

Both the client and the broker implements MQTT version 5.0 using asyncio.

Client features:

• Subscribe to and publish QoS level 0 topics.

• Broker session resume (or clean start support) for less initial communication.

• Topic aliases for smaller publish packets.

• monitor, subscribe and publish command line commands.

Broker features:

• Subscribe to and publish QoS level 0 topics.

• Session resume (or clean start support) for less initial communication. Session state storage in RAM.

• broker command line command.

Limitations:

There are lots of limitations in both the client and the broker. Here are a few of them:

• QoS level 1 and 2 messages are not supported. A session state storage is required to do so, both in the client and the broker.

• Authentication is not supported.

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

Project homepage: https://github.com/eerimoq/mqttools

Documentation: https://mqttools.readthedocs.io

Installation

pip install mqttools

Examples

There are plenty of examples in the examples folder.

Command line

Subscribe

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

$ mqttools subscribe /test/#
Connecting to 'localhost:1883'.
Connected.
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
Connecting to 'localhost:1883'.

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 /test/mqttools/foo
Connecting to 'localhost:1883'.

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).

• Format: Message formatting; auto, binary or text.

Broker

Start a broker to serve clients.

$ mqttools broker

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('localhost', 1883)

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

    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('localhost', 1883)

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

asyncio.run(publisher())