Morse Micro IoT SDK  2.13.1

Detailed Description

Scan configuration data structure.

Use MMWLAN_SCAN_CONFIG_INIT for initialization. For example:

#define MMWLAN_SCAN_CONFIG_INIT
Initializer for mmwlan_scan_config.
Definition: mmwlan.h:821
Scan configuration data structure.
Definition: mmwlan.h:752
See also
mmwlan_set_scan_config()

Definition at line 751 of file mmwlan.h.

#include <mmwlan.h>

Data Fields

uint32_t dwell_time_ms
 Set the per-channel dwell time to use for scans that are requested internally within the mmwlan driver (e.g., when connecting or background scanning). More...
 
bool ndp_probe_enabled
 Boolean value indicating whether NDP probe support should be enabled. More...
 
uint32_t home_channel_dwell_time_ms
 Set the home channel dwell time to use for scans that are requested internally within the mmwlan driver (e.g., when connecting or background scanning). More...
 
uint8_t * selected_channels
 Optional list of S1G channel numbers to use for selective scans during the (re)connection sequence. More...
 
uint8_t selected_channels_len
 Length of selected_channels. More...
 
uint8_t selective_scan_attempts
 Number of scans at the start of an association sequence that should be restricted to the channels configured via selected_channels. More...
 

Field Documentation

◆ dwell_time_ms

uint32_t mmwlan_scan_config::dwell_time_ms

Set the per-channel dwell time to use for scans that are requested internally within the mmwlan driver (e.g., when connecting or background scanning).

Note
This does not affect scans requested with the mmwlan_scan_request().

Definition at line 759 of file mmwlan.h.

◆ home_channel_dwell_time_ms

uint32_t mmwlan_scan_config::home_channel_dwell_time_ms

Set the home channel dwell time to use for scans that are requested internally within the mmwlan driver (e.g., when connecting or background scanning).

Note
This does not affect scans requested with the mmwlan_scan_request().

Definition at line 780 of file mmwlan.h.

◆ ndp_probe_enabled

bool mmwlan_scan_config::ndp_probe_enabled

Boolean value indicating whether NDP probe support should be enabled.

NDP probe requests are smaller than regular probe requests and will save energy when scanning.

Warning
Be careful when enabling NDP probe requests. Some APs may not respond to NDP probe requests if the CSSID (Compressed SSID) field is not populated. When using the mmwlan_scan_request() API with NDP probe requests enabled, it is advisable to include an SSID in the scan arguments (see mmwlan_scan_args::ssid).

Definition at line 772 of file mmwlan.h.

◆ selected_channels

uint8_t* mmwlan_scan_config::selected_channels

Optional list of S1G channel numbers to use for selective scans during the (re)connection sequence.

When set, the first selective_scan_attempts scans of an association attempt will be restricted to these channels, after which it falls back to scanning the full configured channel list.

If a channel is not present in the currently configured channel list, or that corresponds to a channel with bandwidth greater than 2 MHz, mmwlan_set_scan_config() will return an error.

A copy of the array is made internally; the caller may free it after the call returns. Set to NULL with selected_channels_len of zero to disable.

See also
selective_scan_attempts

Definition at line 797 of file mmwlan.h.

◆ selected_channels_len

uint8_t mmwlan_scan_config::selected_channels_len

Length of selected_channels.

Set to zero to disable the selective scan feature.

Definition at line 800 of file mmwlan.h.

◆ selective_scan_attempts

uint8_t mmwlan_scan_config::selective_scan_attempts

Number of scans at the start of an association sequence that should be restricted to the channels configured via selected_channels.

After this many attempts, scan falls back to scanning the full configured channel list. The counter resets when the STA leaves the connected state, so each reconnect attempt begins with another batch of selective scans.

Special values:

  • 0 disables the feature (scans always use the full channel list).
  • UINT8_MAX always uses the selected channel list, including for background and roam scans while connected.

Has no effect unless selected_channels has also been set with a non-empty list.

Definition at line 817 of file mmwlan.h.


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