Wi-Fi scan parameters structure. More...

#include <wifi_mgmt.h>

Data Fields
enum wifi_scan_type	scan_type
	Scan type, see enum wifi_scan_type.

uint8_t	bands
	Bitmap of bands to be scanned.

uint16_t	dwell_time_active
	Active scan dwell time (in ms) on a channel.

uint16_t	dwell_time_passive
	Passive scan dwell time (in ms) on a channel.

const char *	ssids [1]
	Array of SSID strings to scan.

uint16_t	max_bss_cnt
	Specifies the maximum number of scan results to return.

struct wifi_band_channel	band_chan [1]
	Channel information array indexed on Wi-Fi frequency bands and channels within that band.

Detailed Description

Wi-Fi scan parameters structure.

Used to specify parameters which can control how the Wi-Fi scan is performed.

Field Documentation

◆ band_chan

struct wifi_band_channel wifi_scan_params::band_chan[1]

Channel information array indexed on Wi-Fi frequency bands and channels within that band.

E.g. to scan channel 6 and 11 on the 2.4 GHz band, channel 36 on the 5 GHz band:

chan[0] = {WIFI_FREQ_BAND_2_4_GHZ, 6};
chan[1] = {WIFI_FREQ_BAND_2_4_GHZ, 11};
chan[2] = {WIFI_FREQ_BAND_5_GHZ, 36};

This list specifies the channels to be considered for scan. The underlying Wi-Fi chip can silently omit some channels due to various reasons such as channels not conforming to regulatory restrictions etc. The invoker of the API should ensure that the channels specified follow regulatory rules.

◆ bands

uint8_t wifi_scan_params::bands

Bitmap of bands to be scanned.

Refer to wifi_frequency_bands for bit position of each band.

◆ dwell_time_active

uint16_t wifi_scan_params::dwell_time_active

Active scan dwell time (in ms) on a channel.

◆ dwell_time_passive

uint16_t wifi_scan_params::dwell_time_passive

Passive scan dwell time (in ms) on a channel.

◆ max_bss_cnt

uint16_t wifi_scan_params::max_bss_cnt

Specifies the maximum number of scan results to return.

These results would be the BSSIDS with the best RSSI values, in all the scanned channels. This should only be used to limit the number of returned scan results, and cannot be counted upon to limit the scan time, since the underlying Wi-Fi chip might have to scan all the channels to find the max_bss_cnt number of APs with the best signal strengths. A value of 0 signifies that there is no restriction on the number of scan results to be returned.

◆ scan_type

enum wifi_scan_type wifi_scan_params::scan_type

Scan type, see enum wifi_scan_type.

The scan_type is only a hint to the underlying Wi-Fi chip for the preferred mode of scan. The actual mode of scan can depend on factors such as the Wi-Fi chip implementation support, regulatory domain restrictions etc.

◆ ssids

const char* wifi_scan_params::ssids[1]

Array of SSID strings to scan.

The documentation for this struct was generated from the following file:

zephyr/net/wifi_mgmt.h

Data Fields