espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-10-03 10:30:58 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: add Wi-Fi migration guide for v6.0

Browse Source
This commit is contained in:
Kapil Gupta
2025-09-09 16:04:37 +05:30
parent 5898086eca
commit a28fefcf73
3 changed files with 101 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/en/api-reference/network/esp_now.rst
View File

@@ -128,17 +128,7 @@ Instead, post the necessary data to a queue and handle it from a lower priority
Config ESP-NOW Rate
-------------------
.. only:: esp32 or esp32s2 or esp32s3 or esp32c2 or esp32c3
Call :cpp:func:`esp_wifi_config_espnow_rate()` to config ESP-NOW rate of specified interface. Make sure that the interface is enabled before config rate. This API should be called after :cpp:func:`esp_wifi_start()`.
.. only:: esp32c5 or esp32c6
Call :cpp:func:`esp_now_set_peer_rate_config()` to configure ESP-NOW rate of each peer. Make sure that the peer is added before configuring the rate. This API should be called after :cpp:func:`esp_wifi_start()` and :cpp:func:`esp_now_add_peer()`.
.. note::
:cpp:func:`esp_wifi_config_espnow_rate()` is deprecated, please use cpp::func:`esp_now_set_peer_rate_config()` instead.
Call :cpp:func:`esp_now_set_peer_rate_config()` to configure ESP-NOW rate of each peer. Make sure that the peer is added before configuring the rate. This API should be called after :cpp:func:`esp_wifi_start()` and :cpp_func:`esp_now_add_peer()`.
Config ESP-NOW Power-saving Parameter
--------------------------------------------

54
docs/en/migration-guides/release-6.x/6.0/wifi.rst Normal file
View File

@@ -0,0 +1,54 @@
Wi-Fi
=====
This document outlines the Wi-Fi related breaking changes in release v6.0.
Removed Functions and Types
---------------------------
The following functions and types have been removed.
- **WPA2 Enterprise:** The header file :project_file:`components/wpa_supplicant/esp_supplicant/include/esp_wpa2.h` has been removed. Please use the APIs from :project_file:`components/wpa_supplicant/esp_supplicant/include/esp_eap_client.h` instead. The following functions have been removed:
- ``esp_wifi_sta_wpa2_ent_enable``, use ``esp_eap_client_enable`` instead.
- ``esp_wifi_sta_wpa2_ent_disable``, use ``esp_eap_client_disable`` instead.
- ``esp_wifi_sta_wpa2_ent_set_identity``, use ``esp_eap_client_set_identity`` instead.
- ``esp_wifi_sta_wpa2_ent_clear_identity``, use ``esp_eap_client_clear_identity`` instead.
- ``esp_wifi_sta_wpa2_ent_set_username``, use ``esp_eap_client_set_username`` instead.
- ``esp_wifi_sta_wpa2_ent_clear_username``, use ``esp_eap_client_clear_username`` instead.
- ``esp_wifi_sta_wpa2_ent_set_password``, use ``esp_eap_client_set_password`` instead.
- ``esp_wifi_sta_wpa2_ent_clear_password``, use ``esp_eap_client_clear_password`` instead.
- ``esp_wifi_sta_wpa2_ent_set_new_password``, use ``esp_eap_client_set_new_password`` instead.
- ``esp_wifi_sta_wpa2_ent_clear_new_password``, use ``esp_eap_client_clear_new_password`` instead.
- ``esp_wifi_sta_wpa2_ent_set_ca_cert``, use ``esp_eap_client_set_ca_cert`` instead.
- ``esp_wifi_sta_wpa2_ent_clear_ca_cert``, use ``esp_eap_client_clear_ca_cert`` instead.
- ``esp_wifi_sta_wpa2_ent_set_cert_key``, use ``esp_eap_client_set_certificate_and_key`` instead.
- ``esp_wifi_sta_wpa2_ent_clear_cert_key``, use ``esp_eap_client_clear_certificate_and_key`` instead.
- ``esp_wifi_sta_wpa2_ent_set_disable_time_check``, use ``esp_eap_client_set_disable_time_check`` instead.
- ``esp_wifi_sta_wpa2_ent_get_disable_time_check``, use ``esp_eap_client_get_disable_time_check`` instead.
- ``esp_wifi_sta_wpa2_ent_set_ttls_phase2_method``, use ``esp_eap_client_set_ttls_phase2_method`` instead.
- ``esp_wifi_sta_wpa2_set_suiteb_192bit_certification``, use ``esp_eap_client_set_suiteb_192bit_certification`` instead.
- ``esp_wifi_sta_wpa2_ent_set_pac_file``, use ``esp_eap_client_set_pac_file`` instead.
- ``esp_wifi_sta_wpa2_ent_set_fast_phase1_params``, use ``esp_eap_client_set_fast_params`` instead.
- ``esp_wifi_sta_wpa2_use_default_cert_bundle``, use ``esp_eap_client_use_default_cert_bundle`` instead.
- **DPP:**
- The DPP event callback ``esp_supp_dpp_event_cb_t`` and event enum ``esp_supp_dpp_event_t`` have been removed. Please use Wi-Fi events directly (e.g. ``WIFI_EVENT_DPP_URI_READY``, ``WIFI_EVENT_DPP_CFG_RECVD``, ``WIFI_EVENT_DPP_FAILED``).
- The function ``esp_supp_dpp_init`` no longer accepts a callback and should be called as ``esp_supp_dpp_init(void)``.
- **RRM:** The function ``esp_rrm_send_neighbor_rep_request`` has been removed. Use ``esp_rrm_send_neighbor_report_request`` instead.
- **Antenna Configuration:**
- The functions ``esp_wifi_set_ant_gpio``, ``esp_wifi_get_ant_gpio``, ``esp_wifi_set_ant``, and ``esp_wifi_get_ant`` have been removed. Please use the equivalent functions from ``esp_phy`` component: ``esp_phy_set_ant_gpio``, ``esp_phy_get_ant_gpio``, ``esp_phy_set_ant``, and ``esp_phy_get_ant``.
- **ESP-NOW:** The function ``esp_wifi_config_espnow_rate`` has been removed. Use ``esp_now_set_peer_rate_config`` instead.
- **WPS:** The function ``esp_wifi_wps_start`` no longer accepts a ``timeout_ms`` argument. It should now be called as ``esp_wifi_wps_start(void)``.
Removed Macros and Enum Values
-------------------------------
- **Authentication Modes:** The authentication modes ``WIFI_AUTH_WPA3_EXT_PSK`` and ``WIFI_AUTH_WPA3_EXT_PSK_MIXED_MODE`` have been removed. Use ``WIFI_AUTH_WPA3_PSK`` instead.
- **Neighbor Report Event:** In the ``wifi_event_neighbor_report_t`` structure, the ``report`` field has been removed. Please use the ``n_report`` field instead, which is a flexible array member.
- **Wi-Fi Interface:** The header file :project_file:`components/esp_wifi/include/esp_interface.h` has been removed. The ``wifi_interface_t`` enum is now defined in :project_file:`components/esp_wifi/include/esp_wifi_types_generic.h`. The enum values (e.g. ``WIFI_IF_STA``, ``WIFI_IF_AP``) are no longer defined based on ``ESP_IF_WIFI_STA``, ``ESP_IF_WIFI_AP``, etc.

46
tools/idf_py_actions/hints.yml
View File

@@ -583,3 +583,49 @@
-
re: "cannot open linker script file bootloader.ld"
hint: "The file 'bootloader.ld' was renamed to 'bootloader.ld.in' in ESP-IDF v6.0. Please use update your build scripts."
-
re: "fatal error: esp_wpa2.h: No such file or directory"
hint: "The header file 'esp_wpa2.h' has been removed. Please use 'esp_eap_client.h' instead."
-
re: "error: implicit declaration of function '(esp_wifi_sta_wpa2_ent_enable|esp_wifi_sta_wpa2_ent_disable|esp_wifi_sta_wpa2_ent_set_identity|esp_wifi_sta_wpa2_ent_clear_identity|esp_wifi_sta_wpa2_ent_set_username|esp_wifi_sta_wpa2_ent_clear_username|esp_wifi_sta_wpa2_ent_set_password|esp_wifi_sta_wpa2_ent_clear_password|esp_wifi_sta_wpa2_ent_set_new_password|esp_wifi_sta_wpa2_ent_clear_new_password|esp_wifi_sta_wpa2_ent_set_ca_cert|esp_wifi_sta_wpa2_ent_clear_ca_cert|esp_wifi_sta_wpa2_ent_set_cert_key|esp_wifi_sta_wpa2_ent_clear_cert_key|esp_wifi_sta_wpa2_ent_set_disable_time_check|esp_wifi_sta_wpa2_ent_get_disable_time_check|esp_wifi_sta_wpa2_ent_set_ttls_phase2_method|esp_wifi_sta_wpa2_set_suiteb_192bit_certification|esp_wifi_sta_wpa2_ent_set_pac_file|esp_wifi_sta_wpa2_ent_set_fast_phase1_params|esp_wifi_sta_wpa2_use_default_cert_bundle)'"
hint: "The function '{}' has been removed from esp_wpa2.h. Please use the equivalent function from esp_eap_client.h instead."
match_to_output: True
-
re: "error: too many arguments to function 'esp_supp_dpp_init'"
hint: "The function 'esp_supp_dpp_init' no longer accepts a callback. Please register for Wi-Fi events directly to get DPP events."
-
re: "error: unknown type name '(esp_supp_dpp_event_t|esp_supp_dpp_event_cb_t)'"
hint: "The DPP event callback 'esp_supp_dpp_event_cb_t' and event enum 'esp_supp_dpp_event_t' have been removed. Please use Wi-Fi events directly."
-
re: "error: implicit declaration of function 'esp_rrm_send_neighbor_rep_request'"
hint: "The function 'esp_rrm_send_neighbor_rep_request' has been removed. Use 'esp_rrm_send_neighbor_report_request' instead."
-
re: "error: implicit declaration of function '(esp_wifi_set_ant_gpio|esp_wifi_get_ant_gpio|esp_wifi_set_ant|esp_wifi_get_ant)'"
hint: "The function '{}' has been removed. Please use the equivalent function from the esp_phy component (e.g. 'esp_phy_set_ant_gpio')."
match_to_output: True
-
re: "error: implicit declaration of function 'esp_wifi_config_espnow_rate'"
hint: "The function 'esp_wifi_config_espnow_rate' has been removed. Use 'esp_now_set_peer_rate_config' instead."
-
re: "error: too many arguments to function 'esp_wifi_wps_start'"
hint: "The function 'esp_wifi_wps_start' no longer accepts a 'timeout_ms' argument."
-
re: "error: '(WIFI_AUTH_WPA3_EXT_PSK|WIFI_AUTH_WPA3_EXT_PSK_MIXED_MODE)' undeclared"
hint: "The authentication modes 'WIFI_AUTH_WPA3_EXT_PSK' and 'WIFI_AUTH_WPA3_EXT_PSK_MIXED_MODE' have been removed. Use 'WIFI_AUTH_WPA3_PSK' instead."
-
re: "error: 'struct wifi_event_neighbor_report_t' has no member named 'report'"
hint: "In the 'wifi_event_neighbor_report_t' structure, the 'report' field has been removed. Please use the 'n_report' field instead."
-
re: "fatal error: esp_interface.h: No such file or directory"
hint: "The header file 'esp_interface.h' has been removed. The 'wifi_interface_t' enum is now defined in 'esp_wifi_types_generic.h'."