Access Point#

Functions#

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.

sl_status_t
sl_wifi_reconfigure_ap(sl_wifi_interface_t interface, sl_si91x_ap_reconfiguration_t config)

Reconfigure the dynamic parameters of a Wi-Fi access point (AP) interface.

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).

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.

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).

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.

sl_status_t
sl_wifi_stop_ap(sl_wifi_interface_t interface)

Stop Wi-Fi access point.

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)

Disconnects a client with the specified MAC address from Access Point (AP).

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.

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.

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.

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.

Parameters
[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:

Returns

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.


  • In FCC-certified modules,

    1. Region configuration is not supported and if triggered will return error SL_STATUS_SI91X_FEATURE_NOT_AVAILABLE.

    2. AP supports only 1 to 11 channels.

    3. AP will not advertise the Country IE.


Definition at line 897 of file components/protocol/wifi/inc/sl_wifi.h

sl_wifi_reconfigure_ap#

sl_status_t sl_wifi_reconfigure_ap (sl_wifi_interface_t interface, sl_si91x_ap_reconfiguration_t config)

Reconfigure the dynamic parameters of a Wi-Fi access point (AP) interface.

Parameters
[in]interface

Wi-Fi interface as identified by sl_wifi_interface_t

[in]config

Wi-Fi AP dynamic configuration. See sl_si91x_ap_reconfiguration_t

Returns

Note

  • The access point continues to transmit beacons when a client is connected, regardless of the beacon_stop configuration.


Definition at line 913 of file components/protocol/wifi/inc/sl_wifi.h

sl_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).

Parameters
[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

Note

  • This API is not yet implemented.


Definition at line 928 of file components/protocol/wifi/inc/sl_wifi.h

sl_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.

Parameters
[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:

Returns


Definition at line 944 of file components/protocol/wifi/inc/sl_wifi.h

sl_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).

Parameters
[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

Note

  • This API is not yet implemented.


Definition at line 958 of file components/protocol/wifi/inc/sl_wifi.h

sl_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.

Parameters
[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

Note

  • This API is not yet implemented.


Definition at line 973 of file components/protocol/wifi/inc/sl_wifi.h

sl_wifi_stop_ap#

sl_status_t sl_wifi_stop_ap (sl_wifi_interface_t interface)

Stop Wi-Fi access point.

Parameters
[in]interface

Wi-Fi Access Point interface as identified by sl_wifi_interface_t

Returns


Definition at line 987 of file components/protocol/wifi/inc/sl_wifi.h

sl_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)

Disconnects a client with the specified MAC address from Access Point (AP).

Parameters
[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

Use this function to disassociate (disconnect) a client from Access Point. This API is used when the device is in AP mode.

Returns

Note

  • This API is supported only in AP mode.


Definition at line 1009 of file components/protocol/wifi/inc/sl_wifi.h

sl_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.

Parameters
[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.

Returns

Note

  • This API is supported only in AP mode.


Definition at line 1028 of file components/protocol/wifi/inc/sl_wifi.h

sl_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.

Parameters
[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.

Returns

Note

  • This API is supported only in AP mode.


Definition at line 1047 of file components/protocol/wifi/inc/sl_wifi.h

sl_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.

Parameters
[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.

Returns

Note

  • This API is supported only in AP mode.


Definition at line 1066 of file components/protocol/wifi/inc/sl_wifi.h