API types

WFM API types.

Data Structures

struct  WfmHiSsidDef_t
 Service Set Identifier (SSID) of a network.
 
struct  WfmHiRateSetBitmask_t
 Device TX rate set bitmask used in WfmHiSetTxRateParametersReqBody_t.
 
struct  WfmHiNsIpAddr_t
 NS IP address element.

Detailed Description

WFM API types.


Data Structure Documentation

◆ WfmHiSsidDef_t

struct WfmHiSsidDef_t

Service Set Identifier (SSID) of a network.

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

Definition at line 288 of file wfm_cmd_api.h.

Data Fields
uint8_t Ssid[32] SSID data.
uint32_t SsidLength Length of SSID data.

0 - 32: The amount of bytes.

◆ WfmHiRateSetBitmask_t

struct WfmHiRateSetBitmask_t

Device TX rate set bitmask used in WfmHiSetTxRateParametersReqBody_t.

Definition at line 301 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.

◆ WfmHiNsIpAddr_t

struct WfmHiNsIpAddr_t

NS IP address element.

Note that the IP element must always contain WFM_API_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 331 of file wfm_cmd_api.h.

Data Fields
uint8_t Ipv6Addr[16] NS IP address.