fastapi-mqtt
MQTT is a lightweight publish/subscribe messaging protocol designed for M2M (machine to machine) telemetry in low bandwidth environments. Fastapi-mqtt is the client for working with MQTT.
For more information about MQTT, please refer to here: MQTT
Fatapi-mqtt wraps around gmqtt module. Gmqtt Python async client for MQTT client implementation. Module has support of MQTT version 5.0 protocol
Documentation: FastApi-MQTT
The key feature are:
MQTT specification avaliable with help decarator methods using callbacks:
-
on_connect()
-
on_disconnect()
-
on_subscribe()
-
on_message()
-
subscribe(topic_names)
-
Base Settings available with
pydanticclass -
Authetication to broker with credentials
-
unsubscribe certain topics and publish to certain topics
🔨
Installation
$ pip install fastapi-mqtt
🕹
Guide
from fastapi import FastAPI
from fastapi_mqtt import FastMQTT, MQTTConfig
app = FastAPI()
mqtt_config = MQTTConfig()
mqtt = FastMQTT(
config=mqtt_config
)
@app.on_event("startup")
async def startapp():
await mqtt.connection()
@app.on_event("shutdown")
async def shutdown():
await mqtt.client.disconnect()
@mqtt.on_connect()
def connect(client, flags, rc, properties):
mqtt.client.subscribe("/mqtt") #subscribing mqtt topic
print("Connected: ", client, flags, rc, properties)
@mqtt.on_message()
async def message(client, topic, payload, qos, properties):
print("Received message: ",topic, payload.decode(), qos, properties)
@mqtt.on_disconnect()
def disconnect(client, packet, exc=None):
print("Disconnected")
@mqtt.on_subscribe()
def subscribe(client, mid, qos, properties):
print("subscribed", client, mid, qos, properties)
Publish method:
async def func():
await mqtt.publish("/mqtt", "Hello from Fastapi") #publishing mqtt topic
return {"result": True,"message":"Published" }
Subscribe method:
@mqtt.on_connect()
def connect(client, flags, rc, properties):
mqtt.client.subscribe("/mqtt") #subscribing mqtt topic
print("Connected: ", client, flags, rc, properties)
Changing connection params
mqtt_config = MQTTConfig(host = "mqtt.mosquito.org",
port= 1883,
keepalive = 60,
username="username",
password="strong_password")
mqtt = FastMQTT(
config=mqtt_config)
Contributing
Fell free to open issue and send pull request.
Thanks To Contributors. Contributions of any kind are welcome!
Before you start please read CONTRIBUTING
5 Dec 23, 2022
3 May 9, 2022
19 Dec 12, 2022
10 Jul 11, 2022
1k Jan 2, 2023
1 Oct 8, 2022
9 Nov 10, 2022
2 Jan 17, 2022
1 Jan 1, 2022
14 Dec 5, 2022
27 Oct 16, 2022
29 Nov 20, 2022
318 Dec 31, 2022
310 Dec 14, 2022
131 Sep 26, 2022
249 Jan 6, 2023
950 Jan 8, 2023
465 Jan 7, 2023
543 Jan 5, 2023