Scanning#

Functions#

sl_status_t

sl_wifi_start_scan(sl_wifi_interface_t interface, const sl_wifi_ssid_t *optional_ssid, const sl_wifi_scan_configuration_t *configuration)

Start scanning for Wi-Fi networks.

sl_status_t

sl_wifi_stop_scan(sl_wifi_interface_t interface)

Stop Wi-Fi scan.

sl_status_t

sl_wifi_set_advanced_scan_configuration(const sl_wifi_advanced_scan_configuration_t *configuration)

Set advanced scan configuration.

sl_status_t

sl_wifi_get_advanced_scan_configuration(sl_wifi_advanced_scan_configuration_t *configuration)

Get advanced scan configuration.

sl_status_t

sl_wifi_wait_for_scan_results(sl_wifi_scan_result_t **scan_result_array, uint32_t max_scan_result_count)

Wait for current scan to complete and stores the results in the provided array.

Function Documentation#

sl_wifi_start_scan#

sl_status_t sl_wifi_start_scan (sl_wifi_interface_t interface, const sl_wifi_ssid_t * optional_ssid, const sl_wifi_scan_configuration_t * configuration)

Start scanning for Wi-Fi networks.

Parameters

Type	Direction	Argument Name	Description
sl_wifi_interface_t	[in]	interface	Wi-Fi interface as identified by sl_wifi_interface_t
const sl_wifi_ssid_t *	[in]	optional_ssid	Optional SSID of type sl_wifi_ssid_t can be used to scan for a particular Wi-Fi network
const sl_wifi_scan_configuration_t *	[in]	configuration	sl_wifi_scan_configuration_t

Pre-conditions:
- sl_wifi_init should be called before this API.

Returns

sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.

Note

For 911x, Advanced scan results are not populated to user. Default Active Channel time is 100 milliseconds. If the user needs to modify the time, sl_wifi_set_advanced_scan_configuration can be called. If the scan_type is not ADV_SCAN then, the time is for foreground scan. Otherwise, it is used for back ground scanning. If the user needs to enable Passive Scanning, user should set the scan_type to SL_WIFI_SCAN_TYPE_PASSIVE. If the user needs to enable LP mode in Passive Scan, user needs to enable lp_mode in sl_wifi_scan_configuration_t. Default Passive Scan Channel time is 400 milliseconds. If the user needs to modify the time, sl_si91x_set_timeout can be called.

sl_wifi_stop_scan#

sl_status_t sl_wifi_stop_scan (sl_wifi_interface_t interface)

Stop Wi-Fi scan.

Parameters

Type	Direction	Argument Name	Description
sl_wifi_interface_t	[in]	interface	Wi-Fi interface as identified by sl_wifi_interface_t

Pre-conditions:
- sl_wifi_init should be called before this API.

Returns

sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.

Note

For 911x, sl_wifi_stop_scan is ONLY supported for advanced scan.

sl_wifi_set_advanced_scan_configuration#

sl_status_t sl_wifi_set_advanced_scan_configuration (const sl_wifi_advanced_scan_configuration_t * configuration)

Set advanced scan configuration.

Parameters

Type	Direction	Argument Name	Description
const sl_wifi_advanced_scan_configuration_t *	[in]	configuration	Set advanced scan configuration as identified by sl_wifi_advanced_scan_configuration_t

Pre-conditions:
- sl_wifi_init should be called before this API.

Returns

sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.

sl_wifi_get_advanced_scan_configuration#

sl_status_t sl_wifi_get_advanced_scan_configuration (sl_wifi_advanced_scan_configuration_t * configuration)

Get advanced scan configuration.

Parameters

Type	Direction	Argument Name	Description
sl_wifi_advanced_scan_configuration_t *	[out]	configuration	sl_wifi_advanced_scan_configuration_t object that will contain the current advanced scan configuration.

Pre-conditions:
- sl_wifi_init should be called before this API.

Returns

sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.

sl_wifi_wait_for_scan_results#

sl_status_t sl_wifi_wait_for_scan_results (sl_wifi_scan_result_t ** scan_result_array, uint32_t max_scan_result_count)

Wait for current scan to complete and stores the results in the provided array.

Parameters

Type	Direction	Argument Name	Description
sl_wifi_scan_result_t **	[in]	scan_result_array	Array of sl_wifi_scan_result_t objects to store the scan results.
uint32_t	[in]	max_scan_result_count	The maximum number of scan result objects that can fit in the scan result array.

Pre-conditions:
- This function also returns when the scan result array is full.
Pre-conditions:
- Once the scan result array is full, any further scan results will be lost.

Returns

sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.

Note

This API is not supported in the current release.