From 5f0a92e2e61348b20c52b3770218447c40f43ee7 Mon Sep 17 00:00:00 2001 From: David Cermak Date: Wed, 24 Apr 2024 11:14:20 +0200 Subject: [PATCH] fix(docs): tcpip_adapter: Document replacement of tcpip_adapter_get_sta_list --- docs/en/migration-guides/release-5.x/networking.rst | 2 ++ docs/zh_CN/migration-guides/release-5.x/networking.rst | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/en/migration-guides/release-5.x/networking.rst b/docs/en/migration-guides/release-5.x/networking.rst index 74d1f37da9..92666db100 100644 --- a/docs/en/migration-guides/release-5.x/networking.rst +++ b/docs/en/migration-guides/release-5.x/networking.rst @@ -140,6 +140,8 @@ All the tcpip_adapter functions have their esp-netif counter-part. Please refer * :component_file:`DNS ` * :component_file:`IP address ` +The TCP/IP Adapter API ``tcpip_adapter_get_sta_list()`` that was used to acquire a list of associated Wi-Fi stations to the Software Access Point (softAP) has been moved to the Wi-Fi component and renamed to :cpp:func:`esp_wifi_ap_get_sta_list_with_ip()`, which is a special case of the ESP-NETIF API :cpp:func:`esp_netif_dhcps_get_clients_by_mac()` that could be used more generally to provide a list of clients connected to a DHCP server no matter which network interface the server is running on. + Default Event Handlers ^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/zh_CN/migration-guides/release-5.x/networking.rst b/docs/zh_CN/migration-guides/release-5.x/networking.rst index 6903f22913..d9b62ab182 100644 --- a/docs/zh_CN/migration-guides/release-5.x/networking.rst +++ b/docs/zh_CN/migration-guides/release-5.x/networking.rst @@ -132,6 +132,8 @@ TCP/IP 适配器是在 ESP-IDF v4.1 之前使用的网络接口抽象组件。 * :component_file:`DNS ` * :component_file:`IP address ` +TCP/IP 适配器 API ``tcpip_adapter_get_sta_list()`` 用于获取与软件接入点 (softAP) 相关联的 Wi-Fi 站点列表，现已移到 Wi-Fi 组件，并更名为 :cpp:func:`esp_wifi_ap_get_sta_list_with_ip()`，它是 ESP-NETIF API :cpp:func:`esp_netif_dhcps_get_clients_by_mac()` 一个特例。无论服务器在哪个网络接口上运行，该 API 都可更方便地提供连接到 DHCP 服务器的客户端列表。 + 默认事件处理程序 ^^^^^^^^^^^^^^^^^^^^^^