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

Merge branch 'bugfix/update_wps_api_documentation_v4.4' into 'release/v4.4'

Browse Source 
wpa_supplicant: Update WPS API documentation (v4.4)

See merge request espressif/esp-idf!23014
This commit is contained in:
Jiang Jiang Jian
2023-03-31 13:58:42 +08:00
parent 4531322dd9 5c642f98c7
commit fa3c3a8b46
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
components/wpa_supplicant/esp_supplicant/include/esp_wps.h
View File

@@ -113,9 +113,10 @@ esp_err_t esp_wifi_wps_disable(void);
* *
* @attention WPS can only be used when ESP32 station is enabled. * @attention WPS can only be used when ESP32 station is enabled.
* *
* @param timeout_ms : maximum blocking time before API return. * @param timeout_ms : deprecated: This argument's value will have not effect in functionality of API.
* - 0 : non-blocking * The argument will be removed in future.
* - 1~120000 : blocking time (not supported in IDF v1.0) * The app should start WPS and register for WIFI events to get the status.
* WPS status is updated through WPS events. See wifi_event_t enum for more info.
* *
* @return * @return
* - ESP_OK : succeed * - ESP_OK : succeed