alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

wpa_supplicant: Update WPS API documentation

Browse Source
This commit is contained in:
Kapil Gupta 2022-12-20 12:36:07 +05:30
parent ef4b1b7704
commit f44ce0960a
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -101,9 +101,10 @@ esp_err_t esp_wifi_wps_disable(void);
*
* @attention WPS can only be used when station is enabled.
*
* @param timeout_ms : maximum blocking time before API return.
* - 0 : non-blocking
* - 1~120000 : blocking time (not supported in IDF v1.0)
* @param timeout_ms : deprecated: This argument's value will have not effect in functionality of API.
* The argument will be removed in future.
* 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
* - ESP_OK : succeed