espressif/esp-mqtt
1
0
Fork 1
mirror of https://github.com/espressif/esp-mqtt.git synced 2025-09-29 00:21:38 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: update application examples for modbus.rst, mqtt.rst and lwip.rst

Browse Source
This commit is contained in:
Linda
2024-09-20 12:17:36 +08:00
committed by Rocha Euripedes
parent 2a68028e50
commit c5fb6c9436
2 changed files with 35 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/en/api-reference/protocols/mqtt.rst
View File

@@ -19,16 +19,25 @@ Features
Application Examples Application Examples
--------------------- --------------------
* :example:`protocols/mqtt/tcp`: MQTT over TCP, default port 1883 - :example:`protocols/mqtt/tcp` demonstrates how to implement MQTT communication over TCP (default port 1883).
* :example:`protocols/mqtt/ssl`: MQTT over TLS, default port 8883
* :example:`protocols/mqtt/ssl_ds`: MQTT over TLS using digital signature peripheral for authentication, default port 8883 - :example:`protocols/mqtt/ssl` demonstrates how to use SSL transport to implement MQTT communication over TLS (default port 8883).
* :example:`protocols/mqtt/ssl_mutual_auth`: MQTT over TLS using certificates for authentication, default port 8883
* :example:`protocols/mqtt/ssl_psk`: MQTT over TLS using pre-shared keys for authentication, default port 8883 - :example:`protocols/mqtt/ssl_ds` demonstrates how to use digital signature peripheral for authentication to implement MQTT communication over TLS (default port 8883).
* :example:`protocols/mqtt/ws`: MQTT over WebSocket, default port 80
* :example:`protocols/mqtt/wss`: MQTT over WebSocket Secure, default port 443 - :example:`protocols/mqtt/ssl_mutual_auth` demonstrates how to use certificates for authentication to implement MQTT communication (default port 8883).
* :example:`protocols/mqtt5`: Uses ESP-MQTT library to connect to broker with MQTT v5.0
- :example:`protocols/mqtt/ssl_psk` demonstrates how to use pre-shared keys for authentication to implement MQTT communication over TLS (default port 8883).
- :example:`protocols/mqtt/ws` demonstrates how to implement MQTT communication over WebSocket (default port 80).
- :example:`protocols/mqtt/wss` demonstrates how to implement MQTT communication over WebSocket Secure (default port 443).
- :example:`protocols/mqtt5` demonstrates how to use ESP-MQTT library to connect to broker with MQTT v5.0.
- :example:`protocols/mqtt/custom_outbox` demonstrates how to customize the outbox in the ESP-MQTT library.
MQTT Message Retransmission MQTT Message Retransmission
--------------------------- ---------------------------

25
docs/zh_CN/api-reference/protocols/mqtt.rst
View File

@@ -21,14 +21,23 @@ ESP-MQTT 是 `MQTT <https://mqtt.org/>`__ 协议客户端的实现，MQTT 是一
应用示例 应用示例
------------------- -------------------
* :example:`protocols/mqtt/tcp`：基于 TCP 的 MQTT，默认端口 1883 - :example:`protocols/mqtt/tcp` 演示了如何通过 TCP 实现 MQTT 通信（默认端口 1883）。
* :example:`protocols/mqtt/ssl`：基于 TLS 的 MQTT，默认端口 8883
* :example:`protocols/mqtt/ssl_ds`：基于 TLS 的 MQTT，使用数字签名外设进行身份验证，默认端口 8883 - :example:`protocols/mqtt/ssl` 演示了如何使用 SSL 传输来实现基于 TLS 的 MQTT 通信（默认端口 8883）。
* :example:`protocols/mqtt/ssl_mutual_auth`：基于 TLS 的 MQTT，使用证书进行身份验证，默认端口 8883
* :example:`protocols/mqtt/ssl_psk`：基于 TLS 的 MQTT，使用预共享密钥进行身份验证，默认端口 8883 - :example:`protocols/mqtt/ssl_ds` 演示了如何使用数字签名外设进行身份验证，以实现基于 TLS 的 MQTT 通信（默认端口 8883）。
* :example:`protocols/mqtt/ws`：基于 WebSocket 的 MQTT，默认端口 80
* :example:`protocols/mqtt/wss`：基于 WebSocket Secure 的 MQTT，默认端口 443 - :example:`protocols/mqtt/ssl_mutual_auth` 演示了如何使用证书进行身份验证实现 MQTT 通信（默认端口 8883）。
* :example:`protocols/mqtt5`: 使用 ESP-MQTT 库连接 MQTT v5.0 的服务器
- :example:`protocols/mqtt/ssl_psk` 演示了如何使用预共享密钥进行身份验证，以实现基于 TLS 的 MQTT 通信（默认端口 8883）。
- :example:`protocols/mqtt/ws` 演示了如何通过 WebSocket 实现 MQTT 通信（默认端口 80）。
- :example:`protocols/mqtt/wss` 演示了如何通过 WebSocket Secure 实现 MQTT 通信（默认端口 443）。
- :example:`protocols/mqtt5` 演示了如何使用 ESP-MQTT 库通过 MQTT v5.0 连接到代理。
- :example:`protocols/mqtt/custom_outbox` 演示了如何自定义 ESP-MQTT 库中的 outbox。
MQTT 消息重传 MQTT 消息重传
-------------------------- --------------------------