XCORE SDK
XCORE Software Development Kit
Public Attributes | List of all members
sl_wfx_start_ap_req_body_s Struct Reference

Request message body for sl_wfx_start_ap_req_t. More...

#include <sl_wfx_cmd_api.h>

Public Attributes

sl_wfx_ssid_def_t ssid_def
 Service Set Identifier (SSID) of the network.
 
uint8_t hidden_ssid
 Boolean option to hide the network. More...
 
uint8_t client_isolation
 Boolean option to isolate connected clients from each other. More...
 
uint8_t security_mode
 Security mode of the Access Point. More...
 
uint8_t mgmt_frame_protection
 Protected Management Frames (PMF) mode. More...
 
uint16_t channel
 Channel of the Access Point. More...
 
uint16_t password_length
 Length of the network password. More...
 
uint8_t password [SL_WFX_PASSWORD_SIZE]
 Password of the network. More...
 
uint16_t beacon_ie_data_length
 Length of vendor-specific Information Element (IE) data in 802.11 Beacon frames. More...
 
uint16_t probe_resp_ie_data_length
 Length of vendor-specific Information Element (IE) data in 802.11 Probe Response frames. More...
 
uint8_t ie_data []
 Vendor-specific IE data added to the 802.11 Beacon frames and Probe Response frames. More...
 

Detailed Description

Request message body for sl_wfx_start_ap_req_t.

Member Data Documentation

◆ beacon_ie_data_length

uint16_t sl_wfx_start_ap_req_body_s::beacon_ie_data_length

Length of vendor-specific Information Element (IE) data in 802.11 Beacon frames.

0 - 255: The amount of bytes.

◆ channel

uint16_t sl_wfx_start_ap_req_body_s::channel

Channel of the Access Point.

1 - 13: The device will create the access point on the given channel.

◆ client_isolation

uint8_t sl_wfx_start_ap_req_body_s::client_isolation

Boolean option to isolate connected clients from each other.

0: The device will allow connected clients to communicate with each other.
1: The device will prevent multiple connected clients from communicating.
Regardless of the value, the connected stations will always be able to communicate with the device.
See Client isolation for further details.

◆ hidden_ssid

uint8_t sl_wfx_start_ap_req_body_s::hidden_ssid

Boolean option to hide the network.

0: The device will advertise the SSID of the network to any near-by stations.
1: The device will hide the SSID of the network and will only respond to stations that specify the SSID.
See Hidden network for further details.

◆ ie_data

uint8_t sl_wfx_start_ap_req_body_s::ie_data[]

Vendor-specific IE data added to the 802.11 Beacon frames and Probe Response frames.

The IE data must be in 802.11 Vendor-Specific Element format. It may contain multiple concatenated IEs, up to the maximum length. First part of the IE data, up to the amount of bytes specified in BeaconIeDataLength, is added to the Beacon frames. The remaining part whose length is defined in ProbeRespIeDataLength is added to the Probe Response frames.
See Vendor-Specific IE for further details.

◆ mgmt_frame_protection

uint8_t sl_wfx_start_ap_req_body_s::mgmt_frame_protection

Protected Management Frames (PMF) mode.

WFM_MGMT_FRAME_PROTECTION_DISABLED: The device will not use PMF even if supported by the connecting station.
WFM_MGMT_FRAME_PROTECTION_OPTIONAL: The device will use PMF if supported by the connecting station.
WFM_MGMT_FRAME_PROTECTION_MANDATORY: The device will only allow connecting stations that support PMF.
See wfm_mgmt_frame_protection for enumeration values.

◆ password

uint8_t sl_wfx_start_ap_req_body_s::password[SL_WFX_PASSWORD_SIZE]

Password of the network.

64-bit WEP key: 5 bytes in ASCII format or 10 bytes in HEX format.
128-bit WEP key: 13 bytes in ASCII format or 26 bytes in HEX format.
WPA pass phrase: 8 - 63 bytes in ASCII format.
WPA PMK: 64 bytes in HEX format.
See Passwords and pass phrases for further details.

◆ password_length

uint16_t sl_wfx_start_ap_req_body_s::password_length

Length of the network password.

0 - 64: The amount of bytes.

◆ probe_resp_ie_data_length

uint16_t sl_wfx_start_ap_req_body_s::probe_resp_ie_data_length

Length of vendor-specific Information Element (IE) data in 802.11 Probe Response frames.

0 - 255: The amount of bytes.

◆ security_mode

uint8_t sl_wfx_start_ap_req_body_s::security_mode

Security mode of the Access Point.

WFM_SECURITY_MODE_OPEN: The device will only allow unsecured connections.
WFM_SECURITY_MODE_WEP: The device will only allow WEP connections.
WFM_SECURITY_MODE_WPA2_WPA1_PSK: The device will only allow WPA-Personal and WPA2-Personal connections.
WFM_SECURITY_MODE_WPA2_PSK: The device will only allow WPA2-Personal connections.
WFM_SECURITY_MODE_WPA3_SAE: Unsupported in AP mode
See wfm_security_mode for enumeration values.


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