Wi-Fi scan configuration structure.
Indicates the configuration parameters for a Wi-Fi scan operation.
Note
The Quick Scan feature is enabled when a specific channel and SSID are given for scanning. SiWx91x scans for the AP given in the scan API and posts the scan results immediately after finding the access point.
The
channel_bitmap_2g4uses the lower 14 bits to represent channels from 1 to 14, where channel 1 = (1 << 0), channel 2 = (1 << 1), and so on.When
channel_bitmap_2g4is not set (value is 0), the device will scan all available channels.periodic_scan_intervalis only applicable for SL_WIFI_SCAN_TYPE_ADV_SCAN of type sl_wifi_scan_type_t.To configure active_channel_time and passive_channel_time for active and passive scans, use the sl_wifi_set_advanced_scan_configuration() API with sl_wifi_advanced_scan_configuration_t.
Channel scanning behavior:
For active scans: Scans the channels specified in
channel_bitmap_2g4. If set to 0, scans all available channels. Can be configured as a subset of channels.For background scans (SL_WIFI_SCAN_TYPE_ADV_SCAN): Scans the channels that were originally specified in
channel_bitmap_2g4during the first scan. The channel bitmap cannot be modified for background scans.
5 GHz is not supported.
Channel Number 2.4 GHz | channel_bitmap_2g4 |
|---|---|
1 | (1 << 0) |
2 | (1 << 1) |
3 | (1 << 2) |
4 | (1 << 3) |
5 | (1 << 4) |
6 | (1 << 5) |
7 | (1 << 6) |
8 | (1 << 7) |
9 | (1 << 8) |
10 | (1 << 9) |
11 | (1 << 10) |
12 | (1 << 11) |
13 | (1 << 12) |
14 | (1 << 13) |
Public Attributes#
Scan type to be configured of type sl_wifi_scan_type_t.
Reserved.
Duration in milliseconds between periodic scans.
Bitmap of selected 2.4 GHz channels.
Bitmap of selected 5 GHz channels (currently not supported)
Enable LP mode, 1 - Enable LP mode, 0 - Disable LP mode.
Public Attribute Documentation#
type#
sl_wifi_scan_type_t sl_wifi_scan_configuration_t::type
Scan type to be configured of type sl_wifi_scan_type_t.
periodic_scan_interval#
uint32_t sl_wifi_scan_configuration_t::periodic_scan_interval
Duration in milliseconds between periodic scans.
channel_bitmap_2g4#
uint16_t sl_wifi_scan_configuration_t::channel_bitmap_2g4
Bitmap of selected 2.4 GHz channels.
channel_bitmap_5g#
uint32_t sl_wifi_scan_configuration_t::channel_bitmap_5g[8]
Bitmap of selected 5 GHz channels (currently not supported)
lp_mode#
uint8_t sl_wifi_scan_configuration_t::lp_mode
Enable LP mode, 1 - Enable LP mode, 0 - Disable LP mode.