esp_wifi_scan_start() function

Scan all available APs. @attention If this API is called, the found APs are stored in WiFi driver dynamic allocated memory. And then can be freed in esp_wifi_scan_get_ap_records(), esp_wifi_scan_get_ap_record() or esp_wifi_clear_ap_list(), so call any one to free the memory once the scan is done. @attention The values of maximum active scan time and passive scan time per channel are limited to 1500 milliseconds. Values above 1500ms may cause station to disconnect from AP and are not recommended.

Syntax

Show:

Summary

Declaration

from esp_wifi.h:517

esp_err_t esp_wifi_scan_start(const wifi_scan_config_t *config, bool block);

Arguments

Argument

Description

config

configuration settings for scanning, if set to NULL default settings will be used of which default values are show_hidden:false, scan_type:active, scan_time.active.min:0, scan_time.active.max:120 milliseconds, scan_time.passive:360 milliseconds home_chan_dwell_time:30ms

block

if block is true, this API will block the caller until the scan is done, otherwise it will return immediately

Return value

- ESP_OK: succeed - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by esp_wifi_init - ESP_ERR_WIFI_NOT_STARTED: WiFi was not started by esp_wifi_start - ESP_ERR_WIFI_TIMEOUT: blocking scan is timeout - ESP_ERR_WIFI_STATE: WiFi still connecting when invoke esp_wifi_scan_start - others: refer to error code in esp_err.h

Examples

esp_wifi_scan_start() is referenced by 7 libraries and example projects:

References

from examples

esp_wifi_scan_start() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle

esp_wifi_scan_start() function

Syntax

Arguments

Return value

Related Functions

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle