esp-protocols/README.md

# Collection of protocol components for ESP-IDF

## How to use

The [ESP-Protocols](https://github.com/espressif/esp-protocols) repository contains a collection of protocol components for [ESP-IDF](https://github.com/espressif/esp-idf).
Additionally, each component is available in [IDF Component Registry](https://components.espressif.com).
Please refer to instructions in [ESP-IDF](https://github.com/espressif/esp-idf)

## Components

### esp_modem

* Brief introduction [README](components/esp_modem/README.md)
* Full html [documentation](https://docs.espressif.com/projects/esp-protocols/esp_modem/docs/latest/index.html)

### mDNS

* Brief introduction [README](components/mdns/README.md)
* Full html [documentation(English)](https://docs.espressif.com/projects/esp-protocols/mdns/docs/latest/en/index.html)
* Full html [documentation(Chinese)](https://docs.espressif.com/projects/esp-protocols/mdns/docs/latest/zh_CN/index.html)

### esp_websocket_client

* Brief introduction [README](components/esp_websocket_client/README.md)
* Full html [documentation](https://docs.espressif.com/projects/esp-protocols/esp_websocket_client/docs/latest/index.html)

### ASIO port

* Brief introduction [README](components/asio/README.md)
* Full html [documentation](https://docs.espressif.com/projects/esp-protocols/asio/docs/latest/index.html)

### esp_mqtt_cxx

* Brief introduction [README](components/esp_mqtt_cxx/README.md)
* Full html [documentation](https://docs.espressif.com/projects/esp-protocols/esp_mqtt_cxx/docs/latest/index.html)

### console_simple_init

* Brief introduction [README](components/console_simple_init/README.md)

### console_cmd_ping

* Brief introduction [README](components/console_cmd_ping/README.md)

### console_cmd_ifconfig

* Brief introduction [README](components/console_cmd_ifconfig/README.md)

### console_cmd_wifi

* Brief introduction [README](components/console_cmd_wifi/README.md)

### ESP PPP Link (eppp)

* Brief introduction [README](components/eppp_link/README.md)

### mbedtls_cxx

* Brief introduction [README](components/mbedtls_cxx/README.md)

### mosquitto

* Brief introduction [README](components/mosquitto/README.md)
* API documentation [api.md](components/mosquitto/api.md)

### Socket helpers (sock-utils)

* Brief introduction [README](components/sock_utils/README.md)
Docs: Add links to GitHub pages 2021-11-16 08:11:57 +01:00			`# Collection of protocol components for ESP-IDF`

docs(common): updated README regarding esp-idf integration 2023-08-11 15:30:09 +04:00			`## How to use`

			`The [ESP-Protocols](https://github.com/espressif/esp-protocols) repository contains a collection of protocol components for [ESP-IDF](https://github.com/espressif/esp-idf).`
fix(modem): Add CMUX example to target tests 2023-09-26 10:43:17 +02:00			`Additionally, each component is available in [IDF Component Registry](https://components.espressif.com).`
docs(common): updated README regarding esp-idf integration 2023-08-11 15:30:09 +04:00			`Please refer to instructions in [ESP-IDF](https://github.com/espressif/esp-idf)`

Docs: Add links to GitHub pages 2021-11-16 08:11:57 +01:00			`## Components`

			`### esp_modem`

			`* Brief introduction [README](components/esp_modem/README.md)`
docs: fixed broken link in README.md 2023-04-10 18:38:23 +04:00			`* Full html [documentation](https://docs.espressif.com/projects/esp-protocols/esp_modem/docs/latest/index.html)`
DOC: Updated README.md regarding esp_websocket_client 2022-05-23 17:08:35 +04:00
mDNS: Initial version based on IDF 5.0 2022-05-27 17:47:00 +04:00			`### mDNS`

			`* Brief introduction [README](components/mdns/README.md)`
docs: fixed broken link in README.md 2023-04-10 18:38:23 +04:00			`* Full html [documentation(English)](https://docs.espressif.com/projects/esp-protocols/mdns/docs/latest/en/index.html)`
			`* Full html [documentation(Chinese)](https://docs.espressif.com/projects/esp-protocols/mdns/docs/latest/zh_CN/index.html)`
mDNS: Initial version based on IDF 5.0 2022-05-27 17:47:00 +04:00
DOC: Updated README.md regarding esp_websocket_client 2022-05-23 17:08:35 +04:00			`### esp_websocket_client`

			`* Brief introduction [README](components/esp_websocket_client/README.md)`
docs: fixed broken link in README.md 2023-04-10 18:38:23 +04:00			`* Full html [documentation](https://docs.espressif.com/projects/esp-protocols/esp_websocket_client/docs/latest/index.html)`
ASIO: Initial version based on IDF 5.0 with history 2022-06-22 14:49:37 +04:00
			`### ASIO port`

			`* Brief introduction [README](components/asio/README.md)`
docs: fixed broken link in README.md 2023-04-10 18:38:23 +04:00			`* Full html [documentation](https://docs.espressif.com/projects/esp-protocols/asio/docs/latest/index.html)`
docs(esp_mqtt_cxx): updated documentation and deployment file 2023-04-04 14:36:52 +04:00
			`### esp_mqtt_cxx`

			`* Brief introduction [README](components/esp_mqtt_cxx/README.md)`
docs: fixed broken link in README.md 2023-04-10 18:38:23 +04:00			`* Full html [documentation](https://docs.espressif.com/projects/esp-protocols/esp_mqtt_cxx/docs/latest/index.html)`
fix(console): Fixed bump version check in publish-docs yml 2023-10-13 12:08:24 +00:00
			`### console_simple_init`

			`* Brief introduction [README](components/console_simple_init/README.md)`
feat(console): Added ping command to console component 2023-10-18 10:57:05 +02:00
			`### console_cmd_ping`

			`* Brief introduction [README](components/console_cmd_ping/README.md)`
feat(console): Console for runtime network interface configuration and monitoring 2023-07-29 00:08:33 +10:00
			`### console_cmd_ifconfig`

			`* Brief introduction [README](components/console_cmd_ifconfig/README.md)`
fix(console): Fixed license file for console_cmd_wifi 2023-12-23 00:03:56 +11:00
			`### console_cmd_wifi`

			`* Brief introduction [README](components/console_cmd_wifi/README.md)`
feat(eppp): Added support for SPI transport 2023-12-22 20:03:01 +01:00
			`### ESP PPP Link (eppp)`

			`* Brief introduction [README](components/eppp_link/README.md)`
fix(wifi_remote): Publish missing esp_wifi_remote and add to README 2024-04-02 14:42:31 +02:00
feat(tls_cxx): Publish mbedtls component Adds examples and tests. Also supports DTLS now. 2024-02-08 20:11:30 +01:00			`### mbedtls_cxx`

			`* Brief introduction [README](components/mbedtls_cxx/README.md)`
docs(mosq): Prepare mosquitto component for publishing 2024-10-11 08:49:33 +02:00
			`### mosquitto`

			`* Brief introduction [README](components/mosquitto/README.md)`
			`* API documentation [api.md](components/mosquitto/api.md)`
feat(sockutls): Add initial support for socket helpers 2024-10-08 21:27:11 +02:00
			`### Socket helpers (sock-utils)`

			`* Brief introduction [README](components/sock_utils/README.md)`