Symbols

loading (1/5)...

Files

loading (3/5)...

Summary Syntax Arguments Examples References Call Tree Data Use

SourceVuESP-IDF Framework and ExamplesESP-IDFesp_wifi_wps_start()

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 0/1 examples

Code

Location

int esp_wifi_wps_start(int timeout_ms)

esp_err_t esp_wifi_wps_start(int timeout_ms);

Call Tree

from 0/1 examples

esp_wifi_wps_start() calls 8 functions:

esp_wifi_wps_start()

esp_wifi_get_user_init_flag_internal()

wifi_osi_funcs_t::_recursive_mutex_create

wifi_osi_funcs_t::_mutex_lock

wifi_osi_funcs_t::_mutex_unlock

wps_get_status()

wps_post_block()

wps_check_wifi_mode()

Data Use

from 0/1 examples

esp_wifi_wps_start() reads 7 variables and writes 1 variable:

wps_type::WPS_TYPE_DISABLE

wps_status::WPS_STATUS_DISABLE

wps_status::WPS_STATUS_SCANNING

wps_sig_type::SIG_WPS_START

esp_wifi_wps_start()

Class Tree

from 0/1 examples

All items filtered out

All items filtered out

Override Tree

from 0/1 examples

All items filtered out

All items filtered out

Implementations

from 0/1 examples

All items filtered out

All items filtered out

Instances

from 0/1 examples

Lifecycle

from 0/1 examples

All items filtered out

All items filtered out