Merge branch 'fix/docs_wifi_get_sta_list_v5.2' into 'release/v5.2'

fix(docs): tcpip_adapter: Document replacement of tcpip_adapter_get_sta_list (v5.2) See merge request espressif/esp-idf!31171
tasmota · Jul 1, 2024 · a23f078 · a23f078
2 parents 5df4132 + 26ce69c
commit a23f078
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/docs/en/migration-guides/release-5.x/5.0/networking.rst b/docs/en/migration-guides/release-5.x/5.0/networking.rst
@@ -131,6 +131,8 @@ All the ``tcpip_adapter`` functions have their ``esp-netif`` counter-part. Pleas
 *  :component_file:`DNS <esp_netif/include/esp_netif.h#L516>`
 *  :component_file:`IP address <esp_netif/include/esp_netif.h#L568>`
 
+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/5.0/networking.rst b/docs/zh_CN/migration-guides/release-5.x/5.0/networking.rst
@@ -131,6 +131,8 @@ TCP/IP 适配器是在 ESP-IDF v4.1 之前使用的网络接口抽象组件。
 * :component_file:`DNS <esp_netif/include/esp_netif.h#L516>`
 * :component_file:`IP address <esp_netif/include/esp_netif.h#L568>`
 
+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 服务器的客户端列表。
+
 默认事件处理程序
 ^^^^^^^^^^^^^^^^^^^^^^