esp-mqtt/README.md

[![](https://travis-ci.org/tuanpmt/espmqtt.svg?branch=master)](https://travis-ci.org/tuanpmt/espmqtt)
[![](http://hits.dwyl.io/tuanpmt/espmqtt.svg)](http://hits.dwyl.io/tuanpmt/espmqtt)
[![Twitter Follow](https://img.shields.io/twitter/follow/tuanpmt.svg?style=social&label=Follow)](https://twitter.com/tuanpmt)
![GitHub contributors](https://img.shields.io/github/contributors/tuanpmt/espmqtt.svg)

# 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).

## How to use

[ESP-MQTT](https://github.com/espressif/esp-mqtt) is a standard [ESP-IDF](https://github.com/espressif/esp-idf) component.
Please refer to instructions in [ESP-IDF](https://github.com/espressif/esp-idf)

## Documentation

* Please refer to the standard [ESP-IDF](https://github.com/espressif/esp-idf), documentation for the latest version: https://docs.espressif.com/projects/esp-idf/

* Documentation of ESP-MQTT API: https://docs.espressif.com/projects/esp-idf/en/latest/api-reference/protocols/mqtt.html

## License

- MQTT Package - [Stephen Robinson - contiki-mqtt](https://github.com/esar/contiki-mqtt)
- Others [@tuanpmt](https://twitter.com/tuanpmt)
Apache License

## Older IDF verisons

For [ESP-IDF](https://github.com/espressif/esp-idf) versions prior to IDFv3.2, please  clone as a component of [ESP-IDF](https://github.com/espressif/esp-idf):
```
git submodule add https://github.com/espressif/esp-mqtt.git components/espmqtt
```
and checkout the [ESP-MQTT_FOR_IDF_3.1](https://github.com/espressif/esp-mqtt/tree/ESP-MQTT_FOR_IDF_3.1) tag
Update README with svg build icon, mention about kconfig 2018-03-01 23:14:11 +07:00			`[![](https://travis-ci.org/tuanpmt/espmqtt.svg?branch=master)](https://travis-ci.org/tuanpmt/espmqtt)`
Add header license 2018-02-17 11:42:41 +07:00			`[![](http://hits.dwyl.io/tuanpmt/espmqtt.svg)](http://hits.dwyl.io/tuanpmt/espmqtt)`
			`[![Twitter Follow](https://img.shields.io/twitter/follow/tuanpmt.svg?style=social&label=Follow)](https://twitter.com/tuanpmt)`
			`![GitHub contributors](https://img.shields.io/github/contributors/tuanpmt/espmqtt.svg)`

Initial Project 2016-09-11 10:10:24 +07:00			`# ESP32 MQTT Library`

Add support ws and wss 2018-02-17 01:03:35 +07:00			`## Features`

			`- Based on: https://github.com/tuanpmt/esp_mqtt`
Add default scheme, resolve #21, remove sdkconfig in examples 2018-02-22 10:07:57 +07:00			`- Support MQTT over TCP, SSL with mbedtls, MQTT over Websocket, MQTT over Websocket Secure`
Add support ws and wss 2018-02-17 01:03:35 +07:00			`- 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).`

Add support outbox, changed API 2018-02-16 02:40:16 +07:00			`## How to use`
Add sample project link to README 2016-09-12 13:27:35 +07:00
mqtt_client_stop stops only if started, fixed tabs->spaces, updated README, removed unused config closes #62 2018-10-04 13:50:37 +02:00			`[ESP-MQTT](https://github.com/espressif/esp-mqtt) is a standard [ESP-IDF](https://github.com/espressif/esp-idf) component.`
			`Please refer to instructions in [ESP-IDF](https://github.com/espressif/esp-idf)`
Add header license 2018-02-17 11:42:41 +07:00
Add support outbox, changed API 2018-02-16 02:40:16 +07:00			`## Documentation`
support for esp event loop library while keeping backward compatible mode if callback configured 2018-12-18 16:43:08 +01:00
			`* Please refer to the standard [ESP-IDF](https://github.com/espressif/esp-idf), documentation for the latest version: https://docs.espressif.com/projects/esp-idf/`

			`* Documentation of ESP-MQTT API: https://docs.espressif.com/projects/esp-idf/en/latest/api-reference/protocols/mqtt.html`
remove license header and add doc 2018-02-16 18:46:13 +07:00
Add support outbox, changed API 2018-02-16 02:40:16 +07:00			`## License`
support for esp event loop library while keeping backward compatible mode if callback configured 2018-12-18 16:43:08 +01:00
Update license 2018-06-01 22:29:28 +07:00			`- MQTT Package - [Stephen Robinson - contiki-mqtt](https://github.com/esar/contiki-mqtt)`
			`- Others [@tuanpmt](https://twitter.com/tuanpmt)`
remove license header and add doc 2018-02-16 18:46:13 +07:00			`Apache License`
support for esp event loop library while keeping backward compatible mode if callback configured 2018-12-18 16:43:08 +01:00
			`## Older IDF verisons`

			`For [ESP-IDF](https://github.com/espressif/esp-idf) versions prior to IDFv3.2, please clone as a component of [ESP-IDF](https://github.com/espressif/esp-idf):`
			```
			`git submodule add https://github.com/espressif/esp-mqtt.git components/espmqtt`
			```
			`and checkout the [ESP-MQTT_FOR_IDF_3.1](https://github.com/espressif/esp-mqtt/tree/ESP-MQTT_FOR_IDF_3.1) tag`