From 7b665b651223302eb3ab0b9d7607c533128b4e77 Mon Sep 17 00:00:00 2001 From: Kapil Gupta Date: Thu, 25 Sep 2025 16:21:06 +0530 Subject: [PATCH] fix(esp_wifi): Correct some documentation --- components/esp_wifi/include/esp_wifi_types_generic.h | 4 ++-- docs/en/migration-guides/release-6.x/6.0/wifi.rst | 2 ++ docs/zh_CN/migration-guides/release-6.x/6.0/wifi.rst | 2 ++ tools/idf_py_actions/hints.yml | 5 +++++ 4 files changed, 11 insertions(+), 2 deletions(-) diff --git a/components/esp_wifi/include/esp_wifi_types_generic.h b/components/esp_wifi/include/esp_wifi_types_generic.h index ea69624896..fb7e7b6764 100644 --- a/components/esp_wifi/include/esp_wifi_types_generic.h +++ b/components/esp_wifi/include/esp_wifi_types_generic.h @@ -95,8 +95,8 @@ typedef enum { WIFI_AUTH_WAPI_PSK, /**< Authenticate mode : WAPI_PSK */ WIFI_AUTH_OWE, /**< Authenticate mode : OWE */ WIFI_AUTH_WPA3_ENT_192, /**< Authenticate mode : WPA3_ENT_SUITE_B_192_BIT */ - WIFI_AUTH_DUMMY_1, /**< Placeholder: Previously used by WIFI_AUTH_WPA3_EXT_PSK. Can be reused in the future if needed. */ - WIFI_AUTH_DUMMY_2, /**< Placeholder: Previously used by WIFI_AUTH_WPA3_EXT_PSK_MIXED_MODE. Can be reused in the future if needed. */ + WIFI_AUTH_DUMMY_1, /**< Placeholder: Previously used by WIFI_AUTH_WPA3_EXT_PSK */ + WIFI_AUTH_DUMMY_2, /**< Placeholder: Previously used by WIFI_AUTH_WPA3_EXT_PSK_MIXED_MODE */ WIFI_AUTH_DPP, /**< Authenticate mode : DPP */ WIFI_AUTH_WPA3_ENTERPRISE, /**< Authenticate mode : WPA3-Enterprise Only Mode */ WIFI_AUTH_WPA2_WPA3_ENTERPRISE, /**< Authenticate mode : WPA3-Enterprise Transition Mode */ diff --git a/docs/en/migration-guides/release-6.x/6.0/wifi.rst b/docs/en/migration-guides/release-6.x/6.0/wifi.rst index 9ac822cbcc..5700543b54 100644 --- a/docs/en/migration-guides/release-6.x/6.0/wifi.rst +++ b/docs/en/migration-guides/release-6.x/6.0/wifi.rst @@ -27,6 +27,8 @@ Removed Variables, Macros and Enum Values - **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. +- **Wi-Fi Interface Macros:** The macros ``ESP_IF_WIFI_STA`` and ``ESP_IF_WIFI_AP`` have been removed. Please use the enum values ``WIFI_IF_STA`` and ``WIFI_IF_AP`` directly. + - **Wi-Fi Disconnection Reasons:** The disconnection reason codes ``WIFI_REASON_ASSOC_EXPIRE``, ``WIFI_REASON_NOT_AUTHED``, and ``WIFI_REASON_NOT_ASSOCED`` have been removed. Please use ``WIFI_REASON_AUTH_EXPIRE``, ``WIFI_REASON_CLASS2_FRAME_FROM_NONAUTH_STA``, and ``WIFI_REASON_CLASS3_FRAME_FROM_NONASSOC_STA`` respectively. - **NAN:** diff --git a/docs/zh_CN/migration-guides/release-6.x/6.0/wifi.rst b/docs/zh_CN/migration-guides/release-6.x/6.0/wifi.rst index 2cdb265657..a0215a985d 100644 --- a/docs/zh_CN/migration-guides/release-6.x/6.0/wifi.rst +++ b/docs/zh_CN/migration-guides/release-6.x/6.0/wifi.rst @@ -27,6 +27,8 @@ Wi-Fi - **Wi-Fi 接口：** 头文件 :project_file:`components/esp_wifi/include/esp_interface.h` 已被移除。``wifi_interface_t`` 枚举现在定义在 :project_file:`components/esp_wifi/include/esp_wifi_types_generic.h` 中。枚举值（例如 ``WIFI_IF_STA``、``WIFI_IF_AP``）不再基于 ``ESP_IF_WIFI_STA``、``ESP_IF_WIFI_AP`` 等定义。 +- **Wi-Fi 接口宏：** 宏 ``ESP_IF_WIFI_STA`` 和 ``ESP_IF_WIFI_AP`` 已被移除。请直接使用枚举值 ``WIFI_IF_STA`` 和 ``WIFI_IF_AP``。 + - **Wi-Fi 断开连接原因：** 断开连接原因代码 ``WIFI_REASON_ASSOC_EXPIRE``、``WIFI_REASON_NOT_AUTHED`` 和 ``WIFI_REASON_NOT_ASSOCED`` 已被移除。请改用 ``WIFI_REASON_AUTH_EXPIRE``、``WIFI_REASON_CLASS2_FRAME_FROM_NONAUTH_STA`` 和 ``WIFI_REASON_CLASS3_FRAME_FROM_NONASSOC_STA``。 - **NAN：** diff --git a/tools/idf_py_actions/hints.yml b/tools/idf_py_actions/hints.yml index c249e201dd..765fad9d34 100644 --- a/tools/idf_py_actions/hints.yml +++ b/tools/idf_py_actions/hints.yml @@ -663,3 +663,8 @@ - re_variables: ['WIFI_REASON_NOT_ASSOCED'] hint_variables: ['WIFI_REASON_NOT_ASSOCED', 'WIFI_REASON_CLASS3_FRAME_FROM_NONASSOC_STA'] + +- + re: "error: '(ESP_IF_WIFI_STA|ESP_IF_WIFI_AP)' undeclared" + hint: "The macros '{}' have been removed. Please use the enum values 'WIFI_IF_STA' and 'WIFI_IF_AP' directly." + match_to_output: True