diff --git a/docs/en/api-guides/lwip.rst b/docs/en/api-guides/lwip.rst index 1eceef1463b..22a4d1c0019 100644 --- a/docs/en/api-guides/lwip.rst +++ b/docs/en/api-guides/lwip.rst @@ -93,7 +93,7 @@ The :doc:`Ethernet driver ` shows the same BSD s - :example:`ethernet/basic` for driver bring-up, ``esp_netif``, DHCP, and basic IP connectivity. - :example:`ethernet/iperf` for TCP/UDP throughput measurement on Ethernet. -- :example:`ethernet/ptp` for IEEE 1588 / PTP time synchronization over Ethernet. +- :example:`ethernet/ptp` for IEEE 1588/PTP time synchronization over Ethernet. Supported Functions ^^^^^^^^^^^^^^^^^^^ diff --git a/docs/zh_CN/api-guides/lwip.rst b/docs/zh_CN/api-guides/lwip.rst index fccced38411..fe29f1f0850 100644 --- a/docs/zh_CN/api-guides/lwip.rst +++ b/docs/zh_CN/api-guides/lwip.rst @@ -27,6 +27,8 @@ ESP-IDF 间接支持以下常见的 lwIP 应用程序 API： - 动态主机设置协议 (DHCP) 服务器和客户端，由 :doc:`/api-reference/network/esp_netif` 功能间接支持。 - 域名系统 (DNS)；获取 DHCP 地址时，可以自动分配 DNS 服务器，也可以通过 :doc:`/api-reference/network/esp_netif` API 手动配置。 + 关于 DNS over HTTPS，请参阅示例 :example:`protocols/dns_over_https`。 + .. note:: lwIP 中的 DNS 服务器配置为全局配置，而非针对特定接口的配置。如需同时使用不同 DNS 服务器的多个网络接口，在从一个接口获取 DHCP 租约时，请注意避免意外覆盖另一个接口的 DNS 设置。 @@ -75,6 +77,10 @@ BSD 套接字的相关参考资料十分丰富，包括但不限于： - :example:`protocols/sockets/tcp_client` 演示了如何创建一个 TCP 客户端，该客户端使用预定义的 IP 地址和端口连接到服务器。 +- :example:`protocols/sockets/tcp_transport_client` 演示了如何使用 ``tcp_transport`` 组件创建 TCP 客户端，并支持可选 SOCKS 代理。 + +- :example:`protocols/http_request` 演示了如何基于 BSD 套接字 API，通过纯 TCP 套接字发起最小化的 HTTP 请求。 + - :example:`protocols/sockets/tcp_client_multi_net` 演示了如何同时使用以太网和 Wi-Fi 接口连接，在每个接口上创建一个 TCP 客户端，并发送一个简单的 HTTP 请求和响应。 - :example:`protocols/sockets/udp_server` 演示了如何创建一个 UDP 服务器，该服务器可以接收客户端的连接请求和数据。 @@ -83,6 +89,12 @@ BSD 套接字的相关参考资料十分丰富，包括但不限于： - :example:`protocols/sockets/udp_multicast` 演示了如何通过 BSD 风格的套接字接口使用 IPV4 和 IPV6 的 UDP 组播功能。 +:doc:`以太网驱动 ` 通过 EMAC 连接的接口，提供了相同的 BSD 套接字和 TCP/IP 路径。请参考以下应用示例： + +- :example:`ethernet/basic`，用于驱动上电、``esp_netif``、DHCP 以及基本 IP 连通性。 +- :example:`ethernet/iperf`，用于在以太网上测量 TCP/UDP 吞吐量。 +- :example:`ethernet/ptp`，用于以太网上的 IEEE 1588/PTP 时间同步。 + 支持的函数 ^^^^^^^^^^^^^^^^^^^ @@ -559,7 +571,7 @@ ESP-IDF 中 lwIP 的 ``getaddrinfo()`` 系统调用在使用 ``AF_UNSPEC`` 时 最大吞吐量 ^^^^^^^^^^^^^^^^^^ -乐鑫使用 iperf 测试应用程序 https://iperf.fr/ 测试了 ESP-IDF 的 TCP/IP 吞吐量。关于实际测试和优化配置的更多信息，请参考 :ref:`improve-network-speed`。 +乐鑫使用 iperf 测试应用程序 https://iperf.fr/ 测试了 ESP-IDF 的 TCP/IP 吞吐量。关于实际测试和优化配置的更多信息，请参考 :ref:`improve-network-speed`。可参考的 iperf 示例工程 :example:`wifi/iperf` 和 :example:`ethernet/iperf`。 .. important:: diff --git a/docs/zh_CN/api-reference/protocols/icmp_echo.rst b/docs/zh_CN/api-reference/protocols/icmp_echo.rst index 38bb987ac05..d7f14edf206 100644 --- a/docs/zh_CN/api-reference/protocols/icmp_echo.rst +++ b/docs/zh_CN/api-reference/protocols/icmp_echo.rst @@ -114,6 +114,8 @@ IoT 设备通常需要检查远程服务器是否可用。如果服务器离线 - :example:`protocols/icmp_echo` 演示了如何实现一个简单的 ping 命令行工具，使用 ICMP 回显请求数据包测试远程主机在 IP 网络上的可达性。 +- :example:`protocols/icmp/pmtu_probe` 演示了如何使用 ICMP 回显请求探测路径 MTU，并通过 :cpp:func:`esp_netif_set_mtu` 将探测结果应用到活动接口。 + API 参考 -------------- diff --git a/docs/zh_CN/api-reference/protocols/mbedtls.rst b/docs/zh_CN/api-reference/protocols/mbedtls.rst index 1fbcfe59432..271874f1cd7 100644 --- a/docs/zh_CN/api-reference/protocols/mbedtls.rst +++ b/docs/zh_CN/api-reference/protocols/mbedtls.rst @@ -176,6 +176,8 @@ ESP-IDF 中的示例使用 :doc:`/api-reference/protocols/esp_tls`，为访问 如需直接使用 Mbed TLS API，请参考示例 :example:`protocols/https_mbedtls`。该示例演示了如何用 Mbed TLS 创建 HTTPS 连接。具体做法是配置安全的套接字，并使用证书包进行验证。 +:example:`protocols/smtp_client` 示例演示了如何使用 Mbed TLS API，通过带有 STARTTLS 的 SMTP 发送电子邮件（包括附件）。 + 重要配置 -------- diff --git a/docs/zh_CN/api-reference/protocols/mqtt.rst b/docs/zh_CN/api-reference/protocols/mqtt.rst index fe84f2b1a71..a111a665185 100644 --- a/docs/zh_CN/api-reference/protocols/mqtt.rst +++ b/docs/zh_CN/api-reference/protocols/mqtt.rst @@ -26,13 +26,13 @@ ESP-MQTT 是 `MQTT `__ 协议客户端的实现，属于轻 ESP-IDF 中提供了两个参考示例： -- 基于 TLS 的 MQTT 通信（证书包模式）：``examples/protocols/mqtt`` +- 基于 TLS 的 MQTT 通信（证书包模式）：:example:`protocols/mqtt` - 默认使用 ESP-IDF 证书包验证代理服务器。 - 默认代理地址指向 ``mqtts://test.mosquitto.org:8886`` （采用 Let's Encrypt 证书链）。 - 替代方案可配置 Mosquitto CA 证书并改用 ``mqtts://test.mosquitto.org:8883`` 地址。 -- 基于 TLS 的 MQTT 5.0 通信（证书包模式）：``examples/protocols/mqtt5`` +- 基于 TLS 的 MQTT 5.0 通信（证书包模式）：:example:`protocols/mqtt5` - 使用 MQTT v5.0 协议，通过 TLS 传输并借助证书包完成验证。 - 默认代理地址指向 ``mqtts://test.mosquitto.org:8886``。 diff --git a/docs/zh_CN/migration-guides/release-6.x/6.0/protocols.rst b/docs/zh_CN/migration-guides/release-6.x/6.0/protocols.rst index b362580da7f..06597a93015 100644 --- a/docs/zh_CN/migration-guides/release-6.x/6.0/protocols.rst +++ b/docs/zh_CN/migration-guides/release-6.x/6.0/protocols.rst @@ -158,5 +158,5 @@ ESP-MQTT - 移除了 ``examples/protocols/mqtt/ssl*`` 路径下的旧版 MQTT TLS 示例。 - 新增参考示例： - - ``examples/protocols/mqtt``：基于 TLS 的 MQTT。 - - ``examples/protocols/mqtt5``：基于 TLS 的 MQTT v5.0。 + - :example:`protocols/mqtt`：基于 TLS 的 MQTT。 + - :example:`protocols/mqtt5`：基于 TLS 的 MQTT v5.0。