blackbeard420/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf synced 2025-03-10 09:39:10 -04:00
Code Issues Projects Releases Wiki Activity

fix(doc): update api esp_wifi_sta_get_rssic docs

Browse Source 
Closes https://github.com/espressif/esp-idf/issues/12685
This commit is contained in:
muhaidong 2024-03-04 20:37:39 +08:00
parent 33c5194008
commit bc6d79c84a
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
components/esp_wifi/include/esp_wifi.h
View File

@ -391,6 +391,7 @@ esp_err_t esp_wifi_restore(void);
* - ESP_OK: succeed * - ESP_OK: succeed
* - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by esp_wifi_init * - 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_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_CONN: WiFi internal error, station or soft-AP control block wrong
* - ESP_ERR_WIFI_SSID: SSID of AP which station connects is invalid * - 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); 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. * @param rssi store the rssi info received from last beacon.
* *