HBMQTT¶
HBMQTT
is an open source MQTT client and broker implementation.
Built on top of asyncio
, Python’s standard asynchronous I/O framework, HBMQTT provides a straightforward API
based on coroutines, making it easy to write highly concurrent applications.
Features¶
HBMQTT implements the full set of MQTT 3.1.1 protocol specifications and provides the following features:
- Support QoS 0, QoS 1 and QoS 2 messages flow
- Client auto-reconnection on network lost
- Authentication through password file (more methods can be added through a plugin system)
- Basic
$SYS
topics - TCP and websocket support
- SSL support over TCP and websocket
- Plugin system
Requirements¶
HBMQTT is built on Python asyncio
library which was introduced in Python 3.4. Tests have shown that HBMQTT run
best with Python 3.4.3. Python 3.5.0 is also fully supported and recommended. Make sure you use one of these version
before installing HBMQTT.
Installation¶
It is not recommended to install third-party library in Python system packages directory. The preferred way for installing HBMQTT is to create a virtual environment and then install all the dependencies you need. Refer to PEP 405 to learn more.
Once you have a environment setup and ready, HBMQTT can be installed with the following command
(venv) $ pip install hbmqtt
pip
will download and install HBMQTT and all its dependencies.
User guide¶
If you need HBMQTT for running a MQTT client or deploying a MQTT broker, the Quickstart describes how to use console scripts provided by HBMQTT.
If you want to develop an application which needs to connect to a MQTT broker, the MQTTClient API documentation explains how to use HBMQTT API for connecting, publishing and subscribing with a MQTT broker.
If you want to run you own MQTT broker, th Broker API reference reference documentation explains how to embed a MQTT broker inside a Python application.
News and updates are listed in the Changelog.