Skip to main content
### Python MQTT client implementation.


### Installation

The latest stable version is available in the Python Package Index (PyPi) and can be installed using
```bash
pip install gmqtt
```


### Usage
#### Getting Started

Here is a very simple example that subscribes to the broker TOPIC topic and prints out the resulting messages:

```python
import asyncio
import os
import signal
import time

from gmqtt import Client as MQTTClient

# gmqtt also compatibility with uvloop
import uvloop
asyncio.set_event_loop_policy(uvloop.EventLoopPolicy())


STOP = asyncio.Event()


def on_connect(client, flags, rc):
print('Connected')
client.subscribe('TEST/#', qos=0)


def on_message(client, topic, payload, qos, properties):
print('RECV MSG:', payload)


def on_disconnect(client, packet, exc=None):
print('Disconnected')

def on_subscribe(client, mid, qos):
print('SUBSCRIBED')

def ask_exit(*args):
STOP.set()

await client.connect(broker_host, 1883, keepalive=60)
async def main(broker_host, token):
client = MQTTClient("client-id")

client.on_connect = on_connect
client.on_message = on_message
client.on_disconnect = on_disconnect
client.on_subscribe = on_subscribe

client.set_auth_credentials(token, None)
await client.connect(broker_host)

client.publish('TEST/TIME', str(time.time()), qos=1)

await STOP.wait()
await client.disconnect()


if __name__ == '__main__':
loop = asyncio.get_event_loop()

host = 'mqtt.flespi.io'
token = os.environ.get('FLESPI_TOKEN')

loop.add_signal_handler(signal.SIGINT, ask_exit)
loop.add_signal_handler(signal.SIGTERM, ask_exit)

loop.run_until_complete(main(host, token))
```

### MQTT Version 5.0
gmqtt supports MQTT version 5.0 protocol

#### Version setup
Version 5.0 is used by default. If your broker does not support 5.0 protocol version, client will downgrade to 3.1 and reconnect automatically, but you can also force version in connect method:
```python
from gmqtt.mqtt.constants import MQTTv311
client = MQTTClient('clientid')
client.set_auth_credentials(token, None)
await client.connect(broker_host, 1883, keepalive=60, version=MQTTv311)
```

#### Properties
MQTT 5.0 protocol allows to include custom properties into packages, here is example of passing response topic property in published message:
```python

TOPIC = 'testtopic/TOPIC'

def on_connect(client, flags, rc):
client.subscribe(TOPIC, qos=1)
print('Connected')

def on_message(client, topic, payload, qos, properties):
print('RECV MSG:', topic, payload.decode(), properties)

async def main(broker_host, token):
client = MQTTClient('asdfghjk')
client.on_message = client_id
client.on_connect = on_connect
client.set_auth_credentials(token, None)
await client.connect(broker_host, 1883, keepalive=60)
client.publish(TOPIC, 'Message payload', response_topic='RESPONSE/TOPIC')

await STOP.wait()
await client.disconnect()
```

Metadata

Release files for gmqtt 0.0.13

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gmqtt 0.0.13
File Size Uploaded Provenance Actions
gmqtt-0.0.13.tar.gz 10.8 kB Without provenance Details for gmqtt-0.0.13.tar.gz

Release files / gmqtt-0.0.13.tar.gz

Download URL gmqtt-0.0.13.tar.gz
Size 10.8 kB
Tags Source
SHA-256 checksum
How to use checksums
7aaf1be66d83c6e58c690ee1d2dd11ebcccc79e0713281785048ebcd7fe43506
BLAKE2b-256 checksum
How to use checksums
93d6375b2abd880a0f433acab4365aa5bce8738edeb5136248c8347026ea04fe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for gmqtt 0.0.13

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.13 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page