Access Point#
Functions#
Start a Wi-Fi access point (AP) interface.
Set the configuration of a running Wi-Fi access point (AP).
Get the configuration of a Wi-Fi AP interface.
Set the advanced configuration options of a running Wi-Fi access point (AP).
Get the advanced configuration options of a running Wi-Fi access point interface.
Stop Wi-Fi access point.
De-authenticate Wi-Fi client with the given MAC address.
Return the Wi-Fi client information of all clients connected to the AP.
Return a list of Wi-Fi clients connected to the Wi-Fi access point.
Provide the number of Wi-Fi clients connected to the Wi-Fi access point.
Function Documentation#
sl_wifi_start_ap#
sl_status_t sl_wifi_start_ap (sl_wifi_interface_t interface, const sl_wifi_ap_configuration_t * configuration)
Start a Wi-Fi access point (AP) interface.
| [in] | interface | Wi-Fi interface as identified by sl_wifi_interface_t |
| [in] | configuration | Wi-Fi AP configuration. See sl_wifi_ap_configuration_t |
Pre-conditions:
sl_wifi_init should be called before this API.
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.
Note
For AP mode with WPA3 security, only SAE-H2E method is supported. SAE Hunting and pecking method is not supported. TKIP encryption mode is not supported. Encryption mode is automatically configured to RSI_CCMP. PMKSA is not supported in WPA3 AP mode.
790 of file components/protocol/wifi/inc/sl_wifi.hsl_wifi_set_ap_configuration#
sl_status_t sl_wifi_set_ap_configuration (sl_wifi_interface_t interface, const sl_wifi_ap_configuration_t * configuration)
Set the configuration of a running Wi-Fi access point (AP).
| [in] | interface | Wi-Fi interface as identified by sl_wifi_interface_t |
| [in] | configuration | Wi-Fi AP configuration. See sl_wifi_ap_configuration_t |
If the new configuration modifies vital settings such as SSID or security, the AP will be stopped and restarted automatically. Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.
Note
This API is not yet implemented.
805 of file components/protocol/wifi/inc/sl_wifi.hsl_wifi_get_ap_configuration#
sl_status_t sl_wifi_get_ap_configuration (sl_wifi_interface_t interface, sl_wifi_ap_configuration_t * configuration)
Get the configuration of a Wi-Fi AP interface.
| [in] | interface | Wi-Fi interface as identified by sl_wifi_interface_t |
| [out] | configuration | sl_wifi_ap_configuration_t object that contains the AP configuration. |
Pre-conditions:
sl_wifi_init should be called before this API.
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.
821 of file components/protocol/wifi/inc/sl_wifi.hsl_wifi_set_advanced_ap_configuration#
sl_status_t sl_wifi_set_advanced_ap_configuration (sl_wifi_interface_t interface, const sl_wifi_advanced_ap_configuration_t * configuration)
Set the advanced configuration options of a running Wi-Fi access point (AP).
| [in] | interface | Wi-Fi interface as identified by sl_wifi_interface_t |
| [in] | configuration | Wi-Fi AP advanced configuration. See sl_wifi_advanced_ap_configuration_t |
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.
Note
This API is not yet implemented.
835 of file components/protocol/wifi/inc/sl_wifi.hsl_wifi_get_advanced_ap_configuration#
sl_status_t sl_wifi_get_advanced_ap_configuration (sl_wifi_interface_t interface, const sl_wifi_advanced_ap_configuration_t * configuration)
Get the advanced configuration options of a running Wi-Fi access point interface.
| [in] | interface | Wi-Fi interface as identified by sl_wifi_interface_t |
| [out] | configuration | sl_wifi_advanced_ap_configuration_t object that will contain the AP advanced configuration. |
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.
Note
This API is not yet implemented.
850 of file components/protocol/wifi/inc/sl_wifi.hsl_wifi_stop_ap#
sl_status_t sl_wifi_stop_ap (sl_wifi_interface_t interface)
Stop Wi-Fi access point.
| [in] | interface | Wi-Fi Access Point interface as identified by sl_wifi_interface_t |
Pre-conditions:
sl_wifi_start_ap should be called before this API.
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.
864 of file components/protocol/wifi/inc/sl_wifi.hsl_wifi_disconnect_ap_client#
sl_status_t sl_wifi_disconnect_ap_client (sl_wifi_interface_t interface, const sl_mac_address_t * mac, sl_wifi_deauth_reason_t reason)
De-authenticate Wi-Fi client with the given MAC address.
| [in] | interface | Wi-Fi Access Point interface as identified by sl_wifi_interface_t |
| [in] | mac | Wi-Fi client's MAC address of type sl_mac_address_t |
| [in] | reason | Reason for de-authentication as specified in sl_wifi_deauth_reason_t |
Pre-conditions:
sl_wifi_start_ap should be called before this API.
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.
Note
Client interfaces are not supported.
883 of file components/protocol/wifi/inc/sl_wifi.hsl_wifi_get_ap_client_info#
sl_status_t sl_wifi_get_ap_client_info (sl_wifi_interface_t interface, sl_wifi_client_info_response_t * client_info)
Return the Wi-Fi client information of all clients connected to the AP.
| [in] | interface | Wi-Fi Access Point interface as identified by sl_wifi_interface_t |
| [out] | client_info | sl_wifi_client_info_response_t object to store the client info. |
Pre-conditions:
sl_wifi_start_ap should be called before this API.
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.
Note
Client interfaces are not supported.
902 of file components/protocol/wifi/inc/sl_wifi.hsl_wifi_get_ap_client_list#
sl_status_t sl_wifi_get_ap_client_list (sl_wifi_interface_t interface, uint16_t client_list_count, sl_mac_address_t * client_list)
Return a list of Wi-Fi clients connected to the Wi-Fi access point.
| [in] | interface | Wi-Fi Access Point interface as identified by sl_wifi_interface_t |
| [in] | client_list_count | The number of sl_mac_address_t objects the client_list can store. |
| [out] | client_list | A pointer to an array of client_list_count number of sl_mac_address_t objects where the client list will be copied to. |
Pre-conditions:
sl_wifi_start_ap should be called before this API.
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.
Note
Client interfaces are not supported.
921 of file components/protocol/wifi/inc/sl_wifi.hsl_wifi_get_ap_client_count#
sl_status_t sl_wifi_get_ap_client_count (sl_wifi_interface_t interface, uint32_t * client_count)
Provide the number of Wi-Fi clients connected to the Wi-Fi access point.
| [in] | interface | Wi-Fi Access Point interface as identified by sl_wifi_interface_t |
| [out] | client_count | A uint32_t pointer that will store the number of associated clients. |
Pre-conditions:
sl_wifi_start_ap should be called before this API.
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.
Note
Client interfaces are not supported.
940 of file components/protocol/wifi/inc/sl_wifi.h