XCORE SDK
XCORE Software Development Kit
Classes | Typedefs
API messages in idle mode

WFM API messages applicable for an interface in idle mode. More...

Classes

struct  sl_wfx_set_mac_address_req_s
 Request message to set MAC address of the interface. More...
 
struct  sl_wfx_set_mac_address_cnf_s
 Confirmation message for sl_wfx_set_mac_address_req_t. More...
 
struct  sl_wfx_connect_req_s
 Request message for connecting to a Wi-Fi network. More...
 
struct  sl_wfx_connect_cnf_s
 Confirmation message for sl_wfx_connect_req_t. More...
 
struct  sl_wfx_connect_ind_s
 Indication message used to signal the completion of a connection operation. More...
 
struct  sl_wfx_start_ap_req_s
 Request message for starting a Wi-Fi network. More...
 
struct  sl_wfx_start_ap_cnf_s
 Confirmation message for sl_wfx_start_ap_req_t. More...
 
struct  sl_wfx_start_ap_ind_s
 Indication message used to signal the completion of a start request. More...
 
struct  sl_wfx_start_scan_req_s
 Request message for starting a scan to detect near-by access points. More...
 
struct  sl_wfx_start_scan_cnf_s
 Confirmation message for sl_wfx_start_scan_req_t. More...
 
struct  sl_wfx_stop_scan_cnf_s
 Confirmation message for sl_wfx_stop_scan_req_t. More...
 
struct  sl_wfx_scan_result_ind_s
 Indication message used to signal an access point has been detected. More...
 
struct  sl_wfx_scan_complete_ind_s
 Indication message used to signal a scan was completed. More...
 
struct  sl_wfx_set_roam_parameters_req_s
 Request message for setting the roaming parameters. More...
 
struct  sl_wfx_set_roam_parameters_cnf_s
 Confirmation message for sl_wfx_set_roam_parameters_req_t. More...
 
struct  sl_wfx_set_tx_rate_parameters_req_s
 Request message for setting the TX rate set parameters. More...
 
struct  sl_wfx_set_tx_rate_parameters_cnf_s
 Confirmation message for sl_wfx_set_tx_rate_parameters_req_t. More...
 
struct  sl_wfx_set_scan_parameters_req_s
 Request message for setting scan parameters. More...
 
struct  sl_wfx_set_max_tx_power_req_s
 Request message for setting the maximum transmit power of the device. More...
 
struct  sl_wfx_set_max_tx_power_cnf_s
 Confirmation message for sl_wfx_set_max_tx_power_req_t. More...
 
struct  sl_wfx_get_max_tx_power_cnf_s
 Confirmation message for sl_wfx_get_max_tx_power_req_t. More...
 
struct  sl_wfx_stop_scan_req_t
 Request message for stopping an ongoing scan. More...
 
struct  sl_wfx_get_max_tx_power_req_t
 Request message for getting the maximum transmit power. More...
 

Typedefs

typedef struct sl_wfx_set_mac_address_req_s sl_wfx_set_mac_address_req_t
 Request message to set MAC address of the interface. More...
 
typedef struct sl_wfx_set_mac_address_cnf_s sl_wfx_set_mac_address_cnf_t
 Confirmation message for sl_wfx_set_mac_address_req_t.
 
typedef struct sl_wfx_connect_req_s sl_wfx_connect_req_t
 Request message for connecting to a Wi-Fi network. More...
 
typedef struct sl_wfx_connect_cnf_s sl_wfx_connect_cnf_t
 Confirmation message for sl_wfx_connect_req_t.
 
typedef struct sl_wfx_connect_ind_s sl_wfx_connect_ind_t
 Indication message used to signal the completion of a connection operation. More...
 
typedef struct sl_wfx_start_ap_req_s sl_wfx_start_ap_req_t
 Request message for starting a Wi-Fi network. More...
 
typedef struct sl_wfx_start_ap_cnf_s sl_wfx_start_ap_cnf_t
 Confirmation message for sl_wfx_start_ap_req_t.
 
typedef struct sl_wfx_start_ap_ind_s sl_wfx_start_ap_ind_t
 Indication message used to signal the completion of a start request. More...
 

Detailed Description

WFM API messages applicable for an interface in idle mode.

Typedef Documentation

◆ sl_wfx_connect_ind_t

Indication message used to signal the completion of a connection operation.

The device will send this indication to signal the connection request initiated with sl_wfx_connect_req_t has been completed. The indication is also sent when the device autonomously roams to another access point.

◆ sl_wfx_connect_req_t

Request message for connecting to a Wi-Fi network.

The host can use this request to initiate a connection to a Wi-Fi network. An ongoing connection attempt can be canceled by sending sl_wfx_disconnect_req_t message. Completion of the connection request will be signaled by sl_wfx_connect_ind_t message. It may take up to 10 seconds to receive the message.

Interface mode Request allowed
idle Yes
station No
AP No


◆ sl_wfx_set_mac_address_req_t

Request message to set MAC address of the interface.

The host can use this request to set the MAC address of an interface. If not set, the device will use a built-in MAC address. Note that if multiple interfaces are used, the MAC address MUST be different on each interface.

Interface mode Request allowed
idle Yes
station No
AP No


◆ sl_wfx_start_ap_ind_t

Indication message used to signal the completion of a start request.

The device will send this indication to signal the start request initiated with sl_wfx_start_ap_req_t has been completed.

◆ sl_wfx_start_ap_req_t

Request message for starting a Wi-Fi network.

The host can use this request to initiate a Wi-Fi network.

Interface mode Request allowed
idle Yes
station No
AP No