mirror of
https://github.com/espressif/esp-mqtt.git
synced 2025-10-01 17:41:37 +02:00
master
ci: Makes build parallel to speed up ci See merge request espressif/esp-mqtt!255
ESP32 MQTT Library
Features
- Based on: https://github.com/tuanpmt/esp_mqtt
- Support MQTT over TCP, SSL with mbedtls, MQTT over Websocket, MQTT over Websocket Secure
- Easy to setup with URI
- Multiple instances (Multiple clients in one application)
- Support subscribing, publishing, authentication, will messages, keep alive pings and all 3 QoS levels (it should be a fully functional client).
- Support for MQTT 3.1.1 and 5.0
How to use
ESP-MQTT is available through the ESP-IDF Component Manager and ships as a standard ESP-IDF component.
-
To add it via the Component Manager (recommended), declare the dependency in your project's
idf_component.yml
, for example:dependencies: espressif/mqtt: "*"
Replace
*
with the version constraint you want to track, or runidf.py add-dependency espressif/mqtt
. -
For local development, clone this repository as
mqtt
so the component name matches:git clone https://github.com/espressif/esp-mqtt.git mqtt
Documentation
- Documentation of ESP-MQTT API: https://docs.espressif.com/projects/esp-mqtt/en/master/esp32/index.html
License
- Apache License 2.0
- MQTT package origin: Stephen Robinson - contiki-mqtt
- Additional contributions by @tuanpmt
Older IDF versions
For ESP-IDF versions prior to IDFv3.2, please clone as a component of ESP-IDF:
git submodule add https://github.com/espressif/esp-mqtt.git components/espmqtt
and checkout the ESP-MQTT_FOR_IDF_3.1 tag
Languages
C
89.1%
Python
6.7%
C++
2.6%
CMake
1.4%
Shell
0.2%