API typesFULL_MAC_API

WFM API types.

Data Structures

struct sl_wfx_ssid_def_t
Service Set Identifier (SSID) of a network.
struct sl_wfx_security_mode_bitmask_t
Security mode bitmask for scan results.
struct sl_wfx_rate_set_bitmask_t
Device TX rate set bitmask used in sl_wfx_set_tx_rate_parameters_req_body_t .
struct sl_wfx_ns_ip_addr_t
NS IP address element.

Detailed Description

WFM API types.

Data Structure Documentation

◆ sl_wfx_ssid_def_t

struct sl_wfx_ssid_def_t

Service Set Identifier (SSID) of a network.

Note that the Ssid element must always contain SL_WFX_SSID_SIZE bytes. Only the bytes up to SsidLength are considered to be valid, the rest should be set to zero.

Definition at line 356 of file wfm_cmd_api.h .

Data Fields
uint8_t ssid[32] SSID data.
uint32_t ssid_length Length of SSID data.

0 - 32 : The amount of bytes.

◆ sl_wfx_security_mode_bitmask_t

struct sl_wfx_security_mode_bitmask_t

Security mode bitmask for scan results.

Empty if Open network.

Definition at line 369 of file wfm_cmd_api.h .

Data Fields
uint8_t eap: 1 Network supports Enterprise authentication.
uint8_t psk: 1 Network supports Personal authentication.
uint8_t unused: 3 Reserved, set to zero.
uint8_t wep: 1 Network supports WEP.
uint8_t wpa: 1 Network supports WPA. If both WPA bits are set the network supports mixed mode.
uint8_t wpa2: 1 Network supports WPA2. If both WPA bits are set the network supports mixed mode.

◆ sl_wfx_rate_set_bitmask_t

struct sl_wfx_rate_set_bitmask_t

Device TX rate set bitmask used in sl_wfx_set_tx_rate_parameters_req_body_t .

Definition at line 381 of file wfm_cmd_api.h .

Data Fields
uint8_t b11Mbps: 1 If set, the device may use 802.11b 11Mbps data rate.
uint8_t b1Mbps: 1 If set, the device may use 802.11b 1Mbps data rate.
uint8_t b2Mbps: 1 If set, the device may use 802.11b 2Mbps data rate.
uint8_t b5P5Mbps: 1 If set, the device may use 802.11b 5.5Mbps data rate.
uint8_t g12Mbps: 1 If set, the device may use 802.11g 12Mbps data rate.
uint8_t g18Mbps: 1 If set, the device may use 802.11g 18Mbps data rate.
uint8_t g24Mbps: 1 If set, the device may use 802.11g 24Mbps data rate.
uint8_t g36Mbps: 1 If set, the device may use 802.11g 36Mbps data rate.
uint8_t g48Mbps: 1 If set, the device may use 802.11g 48Mbps data rate.
uint8_t g54Mbps: 1 If set, the device may use 802.11g 54Mbps data rate.
uint8_t g6Mbps: 1 If set, the device may use 802.11g 6Mbps data rate.
uint8_t g9Mbps: 1 If set, the device may use 802.11g 9Mbps data rate.
uint8_t mcs0: 1 If set, the device may use 802.11n 6.5Mbps data rate.
uint8_t mcs1: 1 If set, the device may use 802.11n 13Mbps data rate.
uint8_t mcs2: 1 If set, the device may use 802.11n 19.5Mbps data rate.
uint8_t mcs3: 1 If set, the device may use 802.11n 26Mbps data rate.
uint8_t mcs4: 1 If set, the device may use 802.11n 39Mbps data rate.
uint8_t mcs5: 1 If set, the device may use 802.11n 52Mbps data rate.
uint8_t mcs6: 1 If set, the device may use 802.11n 58.5Mbps data rate.
uint8_t mcs7: 1 If set, the device may use 802.11n 65Mbps data rate.
uint8_t unused: 4 Reserved, set to zero.
uint8_t unused2 Reserved, set to zero.

◆ sl_wfx_ns_ip_addr_t

struct sl_wfx_ns_ip_addr_t

NS IP address element.

Note that the IP element must always contain SL_WFX_IPV6_ADDR_SIZE bytes. Only the bytes up to SsidLength are considered to be valid, the rest should be set to zero.

Definition at line 411 of file wfm_cmd_api.h .

Data Fields
uint8_t ipv6_addr[16] NS IP address.