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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9f4f438760b984ba3996c25eb7b45599d4f85dad6292bcdee36d9efa4fd37e8d |
|
MD5 | 2833773d486b81680f05305200543cc9 |
|
BLAKE2b-256 | 9aa7f2d3e5f890b9d0228b079513aca3b718f3e85a2a43d515ffc7e2e7bdef74 |
Hashes for decorated_paho_mqtt-1.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 49254632368c5ffdaea5395e991a94ee39db854d1db4bdaeb20635d0cab5a647 |
|
MD5 | 0640aa275ddf92f40e67e4f3656dd581 |
|
BLAKE2b-256 | ce2979824cb49c2d388046e6d9bdf50c456167062b0ae8c77bf965f83a4f6b84 |