Bladeren bron

Merge branch 'bugfix/update_wps_api_documentation' into 'master'

wpa_supplicant: Update WPS API documentation

Closes IDFGH-8996

See merge request espressif/esp-idf!21714
Kapil Gupta 3 jaren geleden
bovenliggende
commit
de42b2912c
1 gewijzigde bestanden met toevoegingen van 4 en 3 verwijderingen
  1. 4 3
      components/wpa_supplicant/esp_supplicant/include/esp_wps.h

+ 4 - 3
components/wpa_supplicant/esp_supplicant/include/esp_wps.h

@@ -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