API messages in AP modeFULL_MAC_API > API messages by mode
WFM API messages applicable for an interface in AP mode.
Data Structures | |
| struct | sl_wfx_update_ap_req_t |
| Request message for updating parameters of the started Wi-Fi network. | |
| struct | sl_wfx_update_ap_cnf_t |
| Confirmation message for sl_wfx_update_ap_req_t. | |
| struct | sl_wfx_stop_ap_cnf_t |
| Confirmation message for sl_wfx_stop_ap_req_t. | |
| struct | sl_wfx_ap_client_connected_ind_t |
| Indication message used to signal a connected station. | |
| struct | sl_wfx_ap_client_rejected_ind_t |
| Indication message used to signal a rejected connection attempt from a station. | |
| struct | sl_wfx_disconnect_ap_client_req_t |
| Request message for disconnecting a client from the started Wi-Fi network. | |
| struct | sl_wfx_disconnect_ap_client_cnf_t |
| Confirmation message for sl_wfx_disconnect_ap_client_req_t. | |
| struct | sl_wfx_ap_client_disconnected_ind_t |
| Indication message used to signal a disconnected station. | |
| struct | sl_wfx_send_frame_req_t |
| Request message for sending a packet to the network. | |
| struct | sl_wfx_send_frame_cnf_t |
| Confirmation message for sl_wfx_send_frame_req_t. | |
| struct | sl_wfx_received_ind_t |
| Indication message used to signal a received packet. | |
| struct | sl_wfx_add_multicast_addr_req_t |
| Request message for adding a multicast address to the multicast filter whitelist. | |
| struct | sl_wfx_add_multicast_addr_cnf_t |
| Confirmation message for sl_wfx_add_multicast_addr_req_t. | |
| struct | sl_wfx_remove_multicast_addr_req_t |
| Request message for removing a multicast address from the multicast filter whitelist. | |
| struct | sl_wfx_remove_multicast_addr_cnf_t |
| Confirmation message for sl_wfx_remove_multicast_addr_req_t. | |
| struct | sl_wfx_set_max_ap_client_count_req_t |
| Request message for setting the maximum number of connected clients. | |
| struct | sl_wfx_set_max_ap_client_count_cnf_t |
| Confirmation message for sl_wfx_set_max_ap_client_count_req_t. | |
| struct | sl_wfx_set_max_ap_client_inactivity_req_t |
| Request message for setting the maximum number of connected clients. | |
| struct | sl_wfx_set_max_ap_client_inactivity_cnf_t |
| Confirmation message for sl_wfx_set_max_ap_client_inactivity_req_t. | |
| struct | sl_wfx_set_unicast_filter_req_t |
| Request message for setting unicast filter state. | |
| struct | sl_wfx_set_unicast_filter_cnf_t |
| Confirmation message for sl_wfx_set_unicast_filter_req_t. | |
| struct | sl_wfx_add_whitelist_addr_req_t |
| Request message for adding a MAC address to the device whitelist. | |
| struct | sl_wfx_add_whitelist_addr_cnf_t |
| Confirmation message for sl_wfx_add_whitelist_addr_req_t. | |
| struct | sl_wfx_add_blacklist_addr_req_t |
| Request message for adding a MAC address to the device blacklist. | |
| struct | sl_wfx_add_blacklist_addr_cnf_t |
| Confirmation message for sl_wfx_add_blacklist_addr_req_t. | |
| struct | sl_wfx_set_max_tx_power_req_t |
| Request message for setting the maximum transmit power of the device. | |
| 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_get_pmk_cnf_t |
| Confirmation message for sl_wfx_get_pmk_req_t. | |
| struct | sl_wfx_get_ap_client_signal_strength_req_t |
| Request message for retrieving the signal strength of a client of the started Wi-Fi network. | |
| struct | sl_wfx_get_ap_client_signal_strength_cnf_t |
| Confirmation message for sl_wfx_get_ap_client_signal_strength_cnf_t. | |
| struct | sl_wfx_stop_ap_req_t |
| Request message for stopping the started Wi-Fi network. | |
| struct | sl_wfx_stop_ap_ind_t |
| Indication message used to signal the completion of a stop operation. | |
| struct | sl_wfx_get_max_tx_power_req_t |
| Request message for getting the maximum transmit power. | |
| struct | sl_wfx_get_pmk_req_t |
| Request message for getting the Pairwise Master Key (PMK). | |
Detailed Description
WFM API messages applicable for an interface in AP mode.
Data Structure Documentation
◆ sl_wfx_update_ap_req_t
| struct sl_wfx_update_ap_req_t |
Request message for updating parameters of the started Wi-Fi network.
The host can use this request to update parameters of the started Wi-Fi network.
| Interface mode | Request allowed |
|---|---|
| idle | No |
| station | No |
| AP | Yes |
| IBSS | No |
Definition at line 1303 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_update_ap_req_body_t | body | Request message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_update_ap_cnf_t
| struct sl_wfx_update_ap_cnf_t |
Confirmation message for sl_wfx_update_ap_req_t.
Definition at line 1327 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_update_ap_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_stop_ap_cnf_t
| struct sl_wfx_stop_ap_cnf_t |
Confirmation message for sl_wfx_stop_ap_req_t.
Definition at line 1365 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_stop_ap_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_ap_client_connected_ind_t
| struct sl_wfx_ap_client_connected_ind_t |
Indication message used to signal a connected station.
The device will send this indication to signal a station has connected to the started network.
Definition at line 1398 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_ap_client_connected_ind_body_t | body | Indication message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_ap_client_rejected_ind_t
| struct sl_wfx_ap_client_rejected_ind_t |
Indication message used to signal a rejected connection attempt from a station.
The device will send this indication to signal a station has attempted connection to the started network and was rejected by the device.
Definition at line 1431 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_ap_client_rejected_ind_body_t | body | Indication message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_disconnect_ap_client_req_t
| struct sl_wfx_disconnect_ap_client_req_t |
Request message for disconnecting a client from the started Wi-Fi network.
The host can use this request to disconnect a client from the started Wi-Fi network.
| Interface mode | Request allowed |
|---|---|
| idle | No |
| station | No |
| AP | Yes |
| IBSS | No |
Definition at line 1460 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_disconnect_ap_client_req_body_t | body | Request message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_disconnect_ap_client_cnf_t
| struct sl_wfx_disconnect_ap_client_cnf_t |
Confirmation message for sl_wfx_disconnect_ap_client_req_t.
Definition at line 1484 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_disconnect_ap_client_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_ap_client_disconnected_ind_t
| struct sl_wfx_ap_client_disconnected_ind_t |
Indication message used to signal a disconnected station.
The device will send this indication to signal a station has left the started network.
Definition at line 1513 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_ap_client_disconnected_ind_body_t | body | Indication message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_send_frame_req_t
| struct sl_wfx_send_frame_req_t |
Request message for sending a packet to the network.
The host can use this request to send a packet to the network.
| Interface mode | Request allowed |
|---|---|
| idle | No |
| station | Yes |
| AP | Yes |
| IBSS | Yes |
Definition at line 1566 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_send_frame_req_body_t | body | Request message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_send_frame_cnf_t
| struct sl_wfx_send_frame_cnf_t |
Confirmation message for sl_wfx_send_frame_req_t.
Definition at line 1600 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_send_frame_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_received_ind_t
| struct sl_wfx_received_ind_t |
Indication message used to signal a received packet.
The device will send this indication to signal a packet has been received.
Definition at line 1641 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_received_ind_body_t | body | Indication message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_add_multicast_addr_req_t
| struct sl_wfx_add_multicast_addr_req_t |
Request message for adding a multicast address to the multicast filter whitelist.
The host can use this request to add a multicast address to the multicast filter whitelist. When the first address is added the whitelist, the device will discard all multicast frames whose destination address does not match any of the addresses on the list. The default state is to allow all multicast addresses. The whitelist is reset to the default state when the interface is reset. Up to 8 multicast addresses may be added.
See Filtering for further details.
| Interface mode | Request allowed |
|---|---|
| idle | No |
| station | Yes |
| AP | Yes |
| IBSS | No |
Definition at line 2068 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_add_multicast_addr_req_body_t | body | Request message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_add_multicast_addr_cnf_t
| struct sl_wfx_add_multicast_addr_cnf_t |
Confirmation message for sl_wfx_add_multicast_addr_req_t.
Definition at line 2093 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_add_multicast_addr_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_remove_multicast_addr_req_t
| struct sl_wfx_remove_multicast_addr_req_t |
Request message for removing a multicast address from the multicast filter whitelist.
The host can use this request to remove a multicast address from the multicast filter whitelist.
| Interface mode | Request allowed |
|---|---|
| idle | No |
| station | Yes |
| AP | Yes |
| IBSS | No |
Definition at line 2126 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_remove_multicast_addr_req_body_t | body | Request message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_remove_multicast_addr_cnf_t
| struct sl_wfx_remove_multicast_addr_cnf_t |
Confirmation message for sl_wfx_remove_multicast_addr_req_t.
Definition at line 2151 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_remove_multicast_addr_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_max_ap_client_count_req_t
| struct sl_wfx_set_max_ap_client_count_req_t |
Request message for setting the maximum number of connected clients.
The host can use this request to limit the number of stations that can connect the started Wi-Fi network.
| Interface mode | Request allowed |
|---|---|
| idle | No |
| station | No |
| AP | Yes |
| IBSS | No |
Definition at line 2188 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_set_max_ap_client_count_req_body_t | body | Request message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_max_ap_client_count_cnf_t
| struct sl_wfx_set_max_ap_client_count_cnf_t |
Confirmation message for sl_wfx_set_max_ap_client_count_req_t.
Definition at line 2212 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_set_max_ap_client_count_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_max_ap_client_inactivity_req_t
| struct sl_wfx_set_max_ap_client_inactivity_req_t |
Request message for setting the maximum number of connected clients.
The host can use this request to limit the number of stations that can connect the started Wi-Fi network.
| Interface mode | Request allowed |
|---|---|
| idle | No |
| station | No |
| AP | Yes |
| IBSS | No |
Definition at line 2249 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_set_max_ap_client_inactivity_req_body_t | body | Request message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_max_ap_client_inactivity_cnf_t
| struct sl_wfx_set_max_ap_client_inactivity_cnf_t |
Confirmation message for sl_wfx_set_max_ap_client_inactivity_req_t.
Definition at line 2273 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_set_max_ap_client_inactivity_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_unicast_filter_req_t
| struct sl_wfx_set_unicast_filter_req_t |
Request message for setting unicast filter state.
The host can use this request to configure the state of the unicast filter. When enabled, the device will only forward certain unicast frames to the host and automatically discard the rest.
See Filtering for further details.
| Interface mode | Request allowed |
|---|---|
| idle | No |
| station | No |
| AP | Yes |
| IBSS | No |
Definition at line 2737 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_set_unicast_filter_req_body_t | body | Request message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_unicast_filter_cnf_t
| struct sl_wfx_set_unicast_filter_cnf_t |
Confirmation message for sl_wfx_set_unicast_filter_req_t.
Definition at line 2761 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_set_unicast_filter_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_add_whitelist_addr_req_t
| struct sl_wfx_add_whitelist_addr_req_t |
Request message for adding a MAC address to the device whitelist.
The host can use this request to add a MAC address to the list of allowed MAC addresses. When the first address is added the whitelist, the device will prevent communication with any devices whose MAC address does not match any of the addresses on the list. Setting a whitelist will clear all entries from the device blacklist. The default state is to allow all MAC addresses. The whitelist is reset to the default state when the interface is reset. Up to 8 MAC addresses may be added.
See Filtering for further details.
| Interface mode | Request allowed |
|---|---|
| idle | No |
| station | No |
| AP | Yes |
| IBSS | No |
Definition at line 2798 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_add_whitelist_addr_req_body_t | body | Request message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_add_whitelist_addr_cnf_t
| struct sl_wfx_add_whitelist_addr_cnf_t |
Confirmation message for sl_wfx_add_whitelist_addr_req_t.
Definition at line 2822 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_add_whitelist_addr_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_add_blacklist_addr_req_t
| struct sl_wfx_add_blacklist_addr_req_t |
Request message for adding a MAC address to the device blacklist.
The host can use this request to add a MAC address to the list of denied MAC addresses. When the first address is added the blacklist, the device will prevent communication with any device whose MAC address matches any of the addresses on the list. Setting a blacklist will clear all entries from the device whitelist. The default state is to allow all MAC addresses. The blacklist is reset to the default state when the interface is reset. Up to 8 MAC addresses may be added.
See Filtering for further details.
| Interface mode | Request allowed |
|---|---|
| idle | No |
| station | No |
| AP | Yes |
| IBSS | No |
Definition at line 2859 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_add_blacklist_addr_req_body_t | body | Request message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_add_blacklist_addr_cnf_t
| struct sl_wfx_add_blacklist_addr_cnf_t |
Confirmation message for sl_wfx_add_blacklist_addr_req_t.
Definition at line 2883 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_add_blacklist_addr_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_max_tx_power_req_t
| struct sl_wfx_set_max_tx_power_req_t |
Request message for setting the maximum transmit power of the device.
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 2923 of file sl_wfx_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 2950 of file sl_wfx_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 3004 of file sl_wfx_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_get_pmk_cnf_t
| struct sl_wfx_get_pmk_cnf_t |
Confirmation message for sl_wfx_get_pmk_req_t.
Definition at line 3058 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_get_pmk_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_get_ap_client_signal_strength_req_t
| struct sl_wfx_get_ap_client_signal_strength_req_t |
Request message for retrieving the signal strength of a client of the started Wi-Fi network.
The host can use this request to retrieve the signal strength of a client of the started Wi-Fi network.
| Interface mode | Request allowed |
|---|---|
| idle | No |
| station | No |
| AP | Yes |
| IBSS | No |
Definition at line 3087 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_get_ap_client_signal_strength_req_body_t | body | Request message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_get_ap_client_signal_strength_cnf_t
| struct sl_wfx_get_ap_client_signal_strength_cnf_t |
Confirmation message for sl_wfx_get_ap_client_signal_strength_cnf_t.
Definition at line 3116 of file sl_wfx_cmd_api.h.
| Data Fields | ||
|---|---|---|
| sl_wfx_get_ap_client_signal_strength_cnf_body_t | body | Confirmation message body. |
| sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_stop_ap_req_t
| struct sl_wfx_stop_ap_req_t |
Request message for stopping the started Wi-Fi network.
The host can use this request to stop the started Wi-Fi network.
| Interface mode | Request allowed |
|---|---|
| idle | No |
| station | No |
| AP | Yes |
| IBSS | No |
◆ sl_wfx_stop_ap_ind_t
| struct sl_wfx_stop_ap_ind_t |
Indication message used to signal the completion of a stop operation.
The device will send this indication to signal the stop request initiated with sl_wfx_stop_ap_req_t has been completed. The indication is also sent when the started network has encountered a fatal error.
◆ 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 |
◆ sl_wfx_get_pmk_req_t
| struct sl_wfx_get_pmk_req_t |
Request message for getting the Pairwise Master Key (PMK).
The host can use this request to retrieve the Pairwise Master Key (PMK) used to connect to the current secure network. PMK can be given in the next sl_wfx_connect_req_t message to speed up connection process. See Passwords and pass phrases for further details.
| Interface mode | Request allowed |
|---|---|
| idle | No |
| station | Yes |
| AP | Yes |
| IBSS | No |