esp_wifi_wps_start() function

Start WPS session. @attention WPS can only be used when station is enabled. WPS needs to be enabled first for using this API.

Syntax

Show:

Summary

Declaration

Definition

from esp_wps.h:140

esp_err_t esp_wifi_wps_start(int timeout_ms);

Implemented in esp_wps.c:2022

Arguments

Argument

Description

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 value

- ESP_OK : succeed - ESP_ERR_WIFI_WPS_TYPE : wps type is invalid - ESP_ERR_WIFI_WPS_MODE : wifi is not in station mode or sniffer mode is on - ESP_ERR_WIFI_WPS_SM : wps state machine is not initialized - ESP_FAIL : wps initialization fails

Examples

esp_wifi_wps_start() is referenced by 1 libraries and example projects:

References

from examples

esp_wifi_wps_start() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle