Files
esp-mqtt/README.md
Euripedes Rocha Filho 169e1ee88d fix: Adjust all examples and test to use local component
- Makes the name of component mqtt
- Updates README
- Adjust CI to build for supported idf versions
- Removes qemu job
2025-09-24 16:25:42 +02:00

2.0 KiB

ESP32 MQTT Library

GitHub Actions Workflow Status License GitHub contributors

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 run idf.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

License

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