Skip to content

Commit baf6028

Browse files
committed
fix(docs): tcpip_adapter: Document replacement of tcpip_adapter_get_sta_list
1 parent 3f632df commit baf6028

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

docs/en/migration-guides/release-5.x/5.0/networking.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,8 @@ All the ``tcpip_adapter`` functions have their ``esp-netif`` counter-part. Pleas
140140
* :component_file:`DNS <esp_netif/include/esp_netif.h#L516>`
141141
* :component_file:`IP address <esp_netif/include/esp_netif.h#L568>`
142142

143+
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.
144+
143145
Default Event Handlers
144146
^^^^^^^^^^^^^^^^^^^^^^
145147

docs/zh_CN/migration-guides/release-5.x/5.0/networking.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,8 @@ TCP/IP 适配器是在 ESP-IDF v4.1 之前使用的网络接口抽象组件。
140140
* :component_file:`DNS <esp_netif/include/esp_netif.h#L516>`
141141
* :component_file:`IP address <esp_netif/include/esp_netif.h#L568>`
142142

143+
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 服务器的客户端列表。
144+
143145
默认事件处理程序
144146
^^^^^^^^^^^^^^^^^^^^^^
145147

0 commit comments

Comments
 (0)