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

This commit is contained in:
Linda
2024-09-20 12:17:36 +08:00
committed by BOT
parent 93de26537c
commit 4d7436f861
10 changed files with 101 additions and 66 deletions

View File

@@ -82,20 +82,20 @@ ESP-NETIF 组件使用了系统事件,典型的网络启动代码如下所示
初始化网络接口可能有些复杂ESP-NETIF 提供了一些创建常见接口(例如 Wi-Fi 和以太网)的快捷方式。
以下示例展示了默认接口的初始化过程:
请参考以下示例来了解如何初始化默认接口:
.. only:: SOC_WIFI_SUPPORTED
.. list::
- Wi-Fi 站点::example_file:`wifi/getting_started/station/main/station_example_main.c`
:SOC_WIFI_SUPPORTED: - :example:`wifi/getting_started/station` 演示了如何使用 station 功能将 {IDF_TARGET_NAME} 连接到 AP。
- 以太网::example_file:`ethernet/basic/main/ethernet_example_main.c`
:CONFIG_ESP_WIFI_SOFTAP_SUPPORT: - :example:`wifi/getting_started/softAP` 演示了如何使用 SoftAP 功能将 {IDF_TARGET_NAME} 配置为 AP。
- L2 TAP: :example_file:`protocols/l2tap/main/l2tap_main.c`
- :example:`ethernet/basic` 演示了如何使用以太网驱动程序,将其添加到 `esp_netif`,并获取一个可 ping 的 IP 地址。
.. only:: CONFIG_ESP_WIFI_SOFTAP_SUPPORT
- :example:`protocols/l2tap` 演示了如何使用 ESP-NETIF L2 TAP 接口访问数据链路层,以接收和传输帧,实现非 IP 协议,并使用特定的 EthTypes 回显以太网帧。
- Wi-Fi 接入点::example_file:`wifi/getting_started/softAP/main/softap_example_main.c`
- :example:`protocols/static_ip` 演示了如何将 Wi-Fi 配置为 station包括设置静态 IP、子网掩码、网关和 DNS 服务器。
.. only:: SOC_WIFI_SUPPORTED

View File

@@ -112,7 +112,7 @@ IoT 设备通常需要检查远程服务器是否可用。如果服务器离线
应用示例
----------
ICMP echo 示例: :example:`protocols/icmp_echo`
- :example:`protocols/icmp_echo` 演示了如何实现一个简单的 ping 命令行工具,使用 ICMP 回显请求数据包测试远程主机在 IP 网络上的可达性。
API 参考
--------------

View File

@@ -19,10 +19,13 @@ ESP-Modbus
以下示例分别介绍了 ESP-Modbus 库的串行端口、TCP 端口的从机和主机实现。
- :example:`protocols/modbus/serial/mb_slave`
- :example:`protocols/modbus/serial/mb_master`
- :example:`protocols/modbus/tcp/mb_tcp_slave`
- :example:`protocols/modbus/tcp/mb_tcp_master`
- :example:`protocols/modbus/serial/mb_slave` 演示了如何使用 {IDF_TARGET_NAME} 作为 Modbus 串行从设备,通过 esp-modbus 栈,使外部 Modbus 主机能够使用 Modbus 协议读取和写入设备参数。
- :example:`protocols/modbus/serial/mb_master` 演示了如何在 {IDF_TARGET_NAME} 上使用 esp-modbus 栈端口作为 Modbus 串行主设备,读取和写入 Modbus 网络中从设备的值。
- :example:`protocols/modbus/tcp/mb_tcp_slave` 演示了 esp-modbus TCP 从设备栈端口,允许外部 Modbus 主机通过 Modbus 协议读取和写入设备参数。
- :example:`protocols/modbus/tcp/mb_tcp_master` 演示了如何在 {IDF_TARGET_NAME} 上使用 esp-modbus 栈端口作为 Modbus TCP 主设备,读取和写入 Modbus 网络中从设备的值。
详情请参阅具体示例的 ``README.md``

View File

@@ -21,14 +21,23 @@ ESP-MQTT 是 `MQTT <https://mqtt.org/>`__ 协议客户端的实现MQTT 是一
应用示例
-------------------
* :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_mutual_auth`:基于 TLS 的 MQTT使用证书进行身份验证默认端口 8883
* :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/tcp` 演示了如何通过 TCP 实现 MQTT 通信(默认端口 1883)。
- :example:`protocols/mqtt/ssl` 演示了如何使用 SSL 传输来实现基于 TLS 的 MQTT 通信(默认端口 8883)。
- :example:`protocols/mqtt/ssl_ds` 演示了如何使用数字签名外设进行身份验证,以实现基于 TLS 的 MQTT 通信(默认端口 8883)。
- :example:`protocols/mqtt/ssl_mutual_auth` 演示了如何使用证书进行身份验证实现 MQTT 通信(默认端口 8883
- :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 消息重传
--------------------------