Skip to main content

MQTT tools.

Project description

buildstatus coverage

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
Topic:   /test/mqttools/foo
Message: bar
QoS:     0

Monitor

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

$ mqttools monitor /test/#
https://github.com/eerimoq/mqttools/raw/master/docs/monitor.png

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, 'mqttools-subscribe')

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

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

        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, 'mqttools-publish')

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

asyncio.run(publisher())

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mqttools-0.9.0.tar.gz (13.0 kB view hashes)

Uploaded Source

Built Distribution

mqttools-0.9.0-py2.py3-none-any.whl (12.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page