API messages in idle modeFULL_MAC_API > API messages by mode
WFM API messages applicable for an interface in idle mode.
Data Structures |
|
| struct | sl_wfx_set_mac_address_req_t |
|
Request message to set MAC address of the interface.
|
|
| struct | sl_wfx_set_mac_address_cnf_t |
|
Confirmation message for
sl_wfx_set_mac_address_req_t
.
|
|
| struct | sl_wfx_connect_req_t |
|
Request message for connecting to a Wi-Fi network.
|
|
| struct | sl_wfx_connect_cnf_t |
|
Confirmation message for
sl_wfx_connect_req_t
.
|
|
| struct | sl_wfx_connect_ind_t |
|
Indication message used to signal the completion of a connection operation.
|
|
| struct | sl_wfx_start_ap_req_t |
|
Request message for starting a Wi-Fi network.
|
|
| struct | sl_wfx_start_ap_cnf_t |
|
Confirmation message for
sl_wfx_start_ap_req_t
.
|
|
| struct | sl_wfx_start_ap_ind_t |
|
Indication message used to signal the completion of a start request.
|
|
| struct | sl_wfx_start_scan_req_t |
|
Request message for starting a scan to detect near-by access points.
|
|
| struct | sl_wfx_start_scan_cnf_t |
|
Confirmation message for
sl_wfx_start_scan_req_t
.
|
|
| struct | sl_wfx_stop_scan_cnf_t |
|
Confirmation message for
sl_wfx_stop_scan_req_t
.
|
|
| struct | sl_wfx_scan_result_ind_t |
|
Indication message used to signal an access point has been detected.
|
|
| struct | sl_wfx_scan_complete_ind_t |
|
Indication message used to signal a scan was completed.
|
|
| struct | sl_wfx_join_ibss_req_t |
|
Request message for connecting to or starting an IBSS network.
|
|
| struct | sl_wfx_join_ibss_cnf_t |
|
Confirmation message for
sl_wfx_join_ibss_req_t
.
|
|
| struct | sl_wfx_join_ibss_ind_t |
|
Indication message used to signal the completion of a join request.
|
|
| struct | sl_wfx_set_roam_parameters_req_t |
|
Request message for setting the roaming parameters.
|
|
| struct | sl_wfx_set_roam_parameters_cnf_t |
|
Confirmation message for
sl_wfx_set_roam_parameters_req_t
.
|
|
| struct | sl_wfx_set_tx_rate_parameters_req_t |
|
Request message for setting the TX rate set parameters.
|
|
| struct | sl_wfx_set_tx_rate_parameters_cnf_t |
|
Confirmation message for
sl_wfx_set_tx_rate_parameters_req_t
.
|
|
| struct | sl_wfx_set_scan_parameters_req_t |
|
Request message for setting scan parameters.
|
|
| struct | sl_wfx_set_max_tx_power_req_t |
|
Request message for setting a maximum transmit power.
|
|
| struct | sl_wfx_set_max_tx_power_cnf_t |
|
Confirmation message for
sl_wfx_set_max_tx_power_req_t
.
|
|
| struct | sl_wfx_get_max_tx_power_cnf_t |
|
Confirmation message for
sl_wfx_get_max_tx_power_req_t
.
|
|
| struct | sl_wfx_stop_scan_req_t |
|
Request message for stopping an ongoing scan.
|
|
| struct | sl_wfx_get_max_tx_power_req_t |
|
Request message for getting the maximum transmit power.
|
|
Detailed Description
WFM API messages applicable for an interface in idle mode.
Data Structure Documentation
◆ sl_wfx_set_mac_address_req_t
| struct 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 |
| IBSS | No |
Definition at line
721
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_set_mac_address_req_body_t | body | Request message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_mac_address_cnf_t
| struct sl_wfx_set_mac_address_cnf_t |
Confirmation message for sl_wfx_set_mac_address_req_t .
Definition at line
745
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_set_mac_address_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_connect_req_t
| struct sl_wfx_connect_req_t |
Request message for connecting to a Wi-Fi network.
The host can use this request to iniate 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 |
| IBSS | No |
Definition at line
839
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_connect_req_body_t | body | Request message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_connect_cnf_t
| struct sl_wfx_connect_cnf_t |
Confirmation message for sl_wfx_connect_req_t .
Definition at line
863
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_connect_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_connect_ind_t
| struct 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.
Definition at line
913
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_connect_ind_body_t | body | Indication message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_start_ap_req_t
| struct sl_wfx_start_ap_req_t |
Request message for starting a Wi-Fi network.
The host can use this request to iniate a Wi-Fi network.
| Interface mode | Request allowed |
|---|---|
| idle | Yes |
| station | No |
| AP | No |
| IBSS | No |
Definition at line
1195
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_start_ap_req_body_t | body | Request message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_start_ap_cnf_t
| struct sl_wfx_start_ap_cnf_t |
Confirmation message for sl_wfx_start_ap_req_t .
Definition at line
1219
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_start_ap_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_start_ap_ind_t
| struct 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.
Definition at line
1245
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_start_ap_ind_body_t | body | Indication message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_start_scan_req_t
| struct sl_wfx_start_scan_req_t |
Request message for starting a scan to detect near-by access points.
The host can use this request to start a scan operation to detect near-by access points.
| Interface mode | Request allowed |
|---|---|
| idle | Yes |
| station | Yes |
| AP | No |
| IBSS | No |
Definition at line
1694
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_start_scan_req_body_t | body | Request message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_start_scan_cnf_t
| struct sl_wfx_start_scan_cnf_t |
Confirmation message for sl_wfx_start_scan_req_t .
Definition at line
1719
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_start_scan_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_stop_scan_cnf_t
| struct sl_wfx_stop_scan_cnf_t |
Confirmation message for sl_wfx_stop_scan_req_t .
Definition at line
1759
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_stop_scan_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_scan_result_ind_t
| struct sl_wfx_scan_result_ind_t |
Indication message used to signal an access point has been detected.
The device will send this indication to signal an access point has has been detected during the scan operation.
Definition at line
1817
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_scan_result_ind_body_t | body | Indication message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_scan_complete_ind_t
| struct sl_wfx_scan_complete_ind_t |
Indication message used to signal a scan was completed.
The device will send this indication to signal a scan operation has been completed.
Definition at line
1844
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_scan_complete_ind_body_t | body | Indication message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_join_ibss_req_t
| struct sl_wfx_join_ibss_req_t |
Request message for connecting to or starting an IBSS network.
The host can use this request to connect to an IBSS network. If no existing network is found, the device will start a new network.
| Interface mode | Request allowed |
|---|---|
| idle | Yes |
| station | No |
| AP | No |
| IBSS | No |
Definition at line
1899
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_join_ibss_req_body_t | body | Request message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_join_ibss_cnf_t
| struct sl_wfx_join_ibss_cnf_t |
Confirmation message for sl_wfx_join_ibss_req_t .
Definition at line
1923
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_join_ibss_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_join_ibss_ind_t
| struct sl_wfx_join_ibss_ind_t |
Indication message used to signal the completion of a join request.
The device will send this indication to signal the join request initiated with sl_wfx_join_ibss_req_t has been completed.
Definition at line
1958
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_join_ibss_ind_body_t | body | Indication message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_roam_parameters_req_t
| struct sl_wfx_set_roam_parameters_req_t |
Request message for setting the roaming parameters.
The host can use this request to configure the roaming parameters used by the device.
See
Roaming
for further details.
| Interface mode | Request allowed |
|---|---|
| idle | Yes |
| station | Yes |
| AP | No |
| IBSS | No |
Definition at line
2324
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_set_roam_parameters_req_body_t | body | Request message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_roam_parameters_cnf_t
| struct sl_wfx_set_roam_parameters_cnf_t |
Confirmation message for sl_wfx_set_roam_parameters_req_t .
Definition at line
2349
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_set_roam_parameters_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_tx_rate_parameters_req_t
| struct sl_wfx_set_tx_rate_parameters_req_t |
Request message for setting the TX rate set parameters.
The host can use this request to configure the TX rate set parameters of the device. The rate set determines what data rates will be used by the device to transmit data frames.
| Interface mode | Request allowed |
|---|---|
| idle | Yes |
| station | Yes |
| AP | No |
| IBSS | No |
Definition at line
2391
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_set_tx_rate_parameters_req_body_t | body | Request message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_tx_rate_parameters_cnf_t
| struct sl_wfx_set_tx_rate_parameters_cnf_t |
Confirmation message for sl_wfx_set_tx_rate_parameters_req_t .
Definition at line
2416
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_set_tx_rate_parameters_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_scan_parameters_req_t
| struct sl_wfx_set_scan_parameters_req_t |
Request message for setting scan parameters.
The host can use this request to configure the scan parameters used by the device.
| Interface mode | Request allowed |
|---|---|
| idle | Yes |
| station | Yes |
| AP | No |
| IBSS | No |
Definition at line
2654
of file
wfm_cmd_api.h
.
◆ sl_wfx_set_max_tx_power_req_t
| struct sl_wfx_set_max_tx_power_req_t |
Request message for setting a maximum transmit power.
The host can use this request to set a maximum transmit power. The device can still use a lower transmit power depending on regulatory rules or internal limitations.
| Interface mode | Request allowed |
|---|---|
| idle | Yes |
| station | Yes |
| AP | Yes |
| IBSS | Yes |
Definition at line
2901
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_set_max_tx_power_req_body_t | body | Request message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_max_tx_power_cnf_t
| struct sl_wfx_set_max_tx_power_cnf_t |
Confirmation message for sl_wfx_set_max_tx_power_req_t .
Definition at line
2928
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_set_max_tx_power_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_get_max_tx_power_cnf_t
| struct sl_wfx_get_max_tx_power_cnf_t |
Confirmation message for sl_wfx_get_max_tx_power_req_t .
Definition at line
2982
of file
wfm_cmd_api.h
.
| Data Fields | ||
|---|---|---|
| sl_wfx_get_max_tx_power_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_stop_scan_req_t
| struct sl_wfx_stop_scan_req_t |
Request message for stopping an ongoing scan.
The host can use this request to stop an ongoing scan operation.
| Interface mode | Request allowed |
|---|---|
| idle | Yes |
| station | Yes |
| AP | No |
| IBSS | No |
◆ sl_wfx_get_max_tx_power_req_t
| struct sl_wfx_get_max_tx_power_req_t |
Request message for getting the maximum transmit power.
The host can use this request to get the current value of maximum transmit power.
| Interface mode | Request allowed |
|---|---|
| idle | Yes |
| station | Yes |
| AP | Yes |
| IBSS | Yes |