Wrapper for Paho MQTT with declarative subscriptions and topic parsing utilities
Project description
decorated_paho_mqtt
decorated_paho_mqtt is a wrapper to the Eclipse paho mqtt library ( https://pypi.org/project/paho-mqtt/ )
It is intended to be used with MQTTv5
pack_topic
pack_topic
takes an mqtt topic pattern, such as a/+/c/#
, and additional parameters to fill in for the placeholders.
For each +
placeholder, a string has to be passed; for a trailing #
, a list/tuple has to be passed.
pack_topic('a/+/c/#', "b", ("d","e"))
will return the topic a/b/c/d/e
Packing a topic with obviously invalid characters as parameters will raise an exception.
Known Bug: Packing a topic with an empty tuple as parameter for a #
placeholder will not remove the trailing slash.
pack_topic and unpack_topic are not yet completely symmetrical.
unpack_topic
unpack_topic
takes an mqtt topic pattern, such as a/+/c/#
, and an actual topic, such as a/b/c/d/e
.
It will match the topic against the pattern, and for each placeholder in the pattern, yield the actual values.
list(unpack_topic('a/+/c/#','a/b/c/d/e'))
will return ["b", ["d","e"]]
GenericMqttEndpoint
GenericMqttEndpoint
allows to specify topic subscriptions in a declarative way using decorators.
It wraps an paho mqtt client.
You can use the subscribe_decorator on methods of derived classes to receive messages.
You can use the publish method to publish messages.
Example:
import json
from signal import pause
from icecream import ic
from decorated_paho_mqtt import GenericMqttEndpoint
class MyMqtt(GenericMqttEndpoint):
# Using this decorator will automatically subscribe to the topic and provide the values as positional parameters
# The paho parameters will be passed as named parameters.
@GenericMqttEndpoint.subscribe_decorator("a/+/c/#", qos=2)
def receive_something(self, b, d_e, *, client, userdata, message):
assert b == "b"
assert len(d_e) == 2
assert d_e[0] == "d"
assert d_e[1] == "e"
def send_something(self, b, d, e):
self.publish("a/+/c/#", (b, (d, e)), qos=2, retain=False, payload=json.dumps(None))
def _on_log(self, client, userdata, level, buf):
super(MyMqtt, self)._on_log(client, userdata, level, buf)
ic(client, userdata, level, buf)
mqtt = MyMqtt(
# Same parameters as paho's MqttClient()
dict(transport="tcp"),
# None or same parameters as paho's MqttClient.username_pw_set()
dict(username="username", password="password"),
# Same parameters as paho's MqttClient.connect_async()
dict(host="127.0.0.1", port=1883, keepalive=10),
# Whether to activate TLS
False
)
# Non-Blocking, callbacks will return in another thread:
mqtt.connect()
pause()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for decorated_paho_mqtt-1.0.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd0dfa9e8850d1466e637964e8b6e3273468b1809b93046550c67da0cc836464 |
|
MD5 | cc408b3a65df8f038bc80ad8fb4934a0 |
|
BLAKE2b-256 | 698b3bd26f6d0cca0fe360a99a9510779e35946e71c6df70b3ac8f2b17b3beba |
Hashes for decorated_paho_mqtt-1.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4bb5abaca33c5f6f76669dd312b9ca821de871cbd38d8e90066d58ce06a98e53 |
|
MD5 | f72f0c3e6c91179398ca2f1bc3fb6e13 |
|
BLAKE2b-256 | 8b0e37ea728e5a582415f759926a6d59d4d7af9f97142afc6f8c1ddbb8a95123 |