From bc6d79c84ac5f2bb80d6f3023854287a926c70af Mon Sep 17 00:00:00 2001 From: muhaidong Date: Mon, 4 Mar 2024 20:37:39 +0800 Subject: [PATCH] fix(doc): update api esp_wifi_sta_get_rssic docs Closes https://github.com/espressif/esp-idf/issues/12685 --- components/esp_wifi/include/esp_wifi.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/components/esp_wifi/include/esp_wifi.h b/components/esp_wifi/include/esp_wifi.h index 1cb528afd4..cccf64e3f7 100644 --- a/components/esp_wifi/include/esp_wifi.h +++ b/components/esp_wifi/include/esp_wifi.h @@ -391,6 +391,7 @@ esp_err_t esp_wifi_restore(void); * - ESP_OK: succeed * - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by esp_wifi_init * - ESP_ERR_WIFI_NOT_STARTED: WiFi is not started by esp_wifi_start + * - ESP_ERR_WIFI_MODE: WiFi mode error * - ESP_ERR_WIFI_CONN: WiFi internal error, station or soft-AP control block wrong * - ESP_ERR_WIFI_SSID: SSID of AP which station connects is invalid */ @@ -1457,9 +1458,10 @@ esp_err_t esp_wifi_sta_get_aid(uint16_t *aid); esp_err_t esp_wifi_sta_get_negotiated_phymode(wifi_phy_mode_t *phymode); /** - * @brief Get the rssi info after station connected to AP + * @brief Get the rssi information of AP to which the device is associated with * - * @attention This API should be called after station connected to AP. + * @attention 1. This API should be called after station connected to AP. + * @attention 2. Use this API only in WIFI_MODE_STA or WIFI_MODE_APSTA mode. * * @param rssi store the rssi info received from last beacon. *