Morse Micro IoT SDK  2.13.1

Detailed Description

Structure to hold scan arguments.

This structure should be initialized using MMWLAN_SCAN_ARGS_INIT for forward compatibility.

Definition at line 869 of file mmwlan.h.

#include <mmwlan.h>

Data Fields

uint32_t dwell_time_ms
 Minimum time to dwell on a channel waiting for probe responses/beacons. More...
 
uint8_t * extra_ies
 Extra Information Elements to include in Probe Request frames. More...
 
size_t extra_ies_len
 Length of extra_ies. More...
 
uint8_t ssid [MMWLAN_SSID_MAXLEN]
 SSID used for scan. More...
 
uint16_t ssid_len
 Length of the SSID. More...
 
uint32_t dwell_on_home_ms
 Time to dwell on home channel in between channels during a scan, to allow traffic to still pass. More...
 
uint8_t * selected_channels
 Optional selected list of S1G channel numbers to scan. More...
 
uint8_t selected_channels_len
 Length of selected_channels. More...
 

Field Documentation

◆ dwell_on_home_ms

uint32_t mmwlan_scan_args::dwell_on_home_ms

Time to dwell on home channel in between channels during a scan, to allow traffic to still pass.

This will only perform while connected to an AP and is ignored otherwise. If set to 0, the device will not return to the home channel during the scan.

Definition at line 897 of file mmwlan.h.

◆ dwell_time_ms

uint32_t mmwlan_scan_args::dwell_time_ms

Minimum time to dwell on a channel waiting for probe responses/beacons.

Note
There is some additional delay applied on top of this to allow for tuning to each channel and sending a probe request.

Definition at line 877 of file mmwlan.h.

◆ extra_ies

uint8_t* mmwlan_scan_args::extra_ies

Extra Information Elements to include in Probe Request frames.

May be NULL if extra_ies_len is zero.

Definition at line 882 of file mmwlan.h.

◆ extra_ies_len

size_t mmwlan_scan_args::extra_ies_len

Length of extra_ies.

Definition at line 884 of file mmwlan.h.

◆ selected_channels

uint8_t* mmwlan_scan_args::selected_channels

Optional selected list of S1G channel numbers to scan.

When NULL (and selected_channels_len is zero) the full configured channel list is scanned. If a channel with bandwidth larger than 2 MHz or an invalid channel is entered, mmwlan_scan_request() will return an error code.

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.

Definition at line 907 of file mmwlan.h.

◆ selected_channels_len

uint8_t mmwlan_scan_args::selected_channels_len

Length of selected_channels.

Zero means "scan all channels".

Definition at line 909 of file mmwlan.h.

◆ ssid

uint8_t mmwlan_scan_args::ssid[MMWLAN_SSID_MAXLEN]

SSID used for scan.

May be NULL, with ssid_len set to zero for an undirected scan.

Definition at line 889 of file mmwlan.h.

◆ ssid_len

uint16_t mmwlan_scan_args::ssid_len

Length of the SSID.

Definition at line 891 of file mmwlan.h.


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