Client#

Functions#

sl_status_t

sl_wifi_connect(sl_wifi_interface_t interface, const sl_wifi_client_configuration_t *access_point, uint32_t timeout_ms)

Connect to the given Wi-Fi AP.

sl_status_t

sl_wifi_disconnect(sl_wifi_interface_t interface)

Disconnect the Wi-Fi client interface.

sl_status_t

sl_wifi_get_signal_strength(sl_wifi_interface_t interface, int32_t *rssi)

Get current Wi-Fi client's signal strength (RSSI).

sl_status_t

sl_wifi_set_roam_configuration(sl_wifi_interface_t interface, sl_wifi_roam_configuration_t *roam_configuration)

Set the Wi-Fi roaming configuration.

sl_status_t

sl_wifi_get_roam_configuration(sl_wifi_interface_t interface, sl_wifi_roam_configuration_t *roam_configuration)

Get the Wi-Fi roaming configuration.

sl_status_t

sl_wifi_test_client_configuration(sl_wifi_interface_t interface, const sl_wifi_client_configuration_t *ap, uint32_t timeout_ms)

Verify the Wi-Fi client configuration is valid and available.

sl_status_t

sl_wifi_set_certificate(uint8_t certificate_type, const uint8_t *buffer, uint32_t certificate_length)

Load the certificate into the device.

sl_status_t

sl_wifi_set_certificate_with_index(uint8_t certificate_type, uint8_t certificate_index, uint8_t *buffer, uint32_t certificate_length)

Load the certificate into the device.

sl_status_t

sl_wifi_set_advanced_client_configuration(sl_wifi_interface_t interface, const sl_wifi_advanced_client_configuration_t *configuration)

Set the advanced configuration options of a client interface.

Function Documentation#

sl_wifi_connect#

sl_status_t sl_wifi_connect (sl_wifi_interface_t interface, const sl_wifi_client_configuration_t * access_point, uint32_t timeout_ms)

Connect to the given Wi-Fi AP.

Parameters

Type	Direction	Argument Name	Description
sl_wifi_interface_t	[in]	interface	Wi-Fi client interface as identified by sl_wifi_interface_t
const sl_wifi_client_configuration_t *	[in]	access_point	sl_wifi_client_configuration_t object that contains the details of Access Point.
uint32_t	[in]	timeout_ms	Timeout value in milliseconds. The function will abort and return when the timeout timer expires. A value of 0 indicates an asynchronous action. TBD: asynchronous action page.

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

If channel, band, and BSSID are provided, this API will attempt to connect without scanning.

sl_wifi_disconnect#

sl_status_t sl_wifi_disconnect (sl_wifi_interface_t interface)

Disconnect the Wi-Fi client interface.

Parameters

Type	Direction	Argument Name	Description
sl_wifi_interface_t	[in]	interface	Wi-Fi client interface as identified by sl_wifi_interface_t

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

sl_wifi_get_signal_strength#

sl_status_t sl_wifi_get_signal_strength (sl_wifi_interface_t interface, int32_t * rssi)

Get current Wi-Fi client's signal strength (RSSI).

Parameters

Type	Direction	Argument Name	Description
sl_wifi_interface_t	[in]	interface	Wi-Fi interface as identified by sl_wifi_interface_t
int32_t *	[in]	rssi	signal strength (RSSI) in dBm.

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

sl_wifi_set_roam_configuration#

sl_status_t sl_wifi_set_roam_configuration (sl_wifi_interface_t interface, sl_wifi_roam_configuration_t * roam_configuration)

Set the Wi-Fi roaming configuration.

Parameters

Type	Direction	Argument Name	Description
sl_wifi_interface_t	[in]	interface	Wi-Fi interface as identified by sl_wifi_interface_t
sl_wifi_roam_configuration_t *	[in]	roam_configuration	sl_wifi_roam_configuration_t object to store Wi-Fi roaming configuration.

sl_wifi_set_advanced_scan_configuration 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 si91x chips, following ranges are valid: trigger_level: [-10, -100] , trigger_level_change: [0, 90]

sl_wifi_get_roam_configuration#

sl_status_t sl_wifi_get_roam_configuration (sl_wifi_interface_t interface, sl_wifi_roam_configuration_t * roam_configuration)

Get the Wi-Fi roaming configuration.

Parameters

Type	Direction	Argument Name	Description
sl_wifi_interface_t	[in]	interface	Wi-Fi interface as identified by sl_wifi_interface_t
sl_wifi_roam_configuration_t *	[out]	roam_configuration	@sl_wifi_roam_configuration_t object that will contain the current roam 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.

sl_wifi_test_client_configuration#

sl_status_t sl_wifi_test_client_configuration (sl_wifi_interface_t interface, const sl_wifi_client_configuration_t * ap, uint32_t timeout_ms)

Verify the Wi-Fi client configuration is valid and available.

Parameters

Type	Direction	Argument Name	Description
sl_wifi_interface_t	[in]	interface	Wi-Fi interface as identified by sl_wifi_interface_t
const sl_wifi_client_configuration_t *	[in]	ap	sl_wifi_client_configuration_t object that contains the details of Access Point.
uint32_t	[in]	timeout_ms	Timeout value in milliseconds. The function will abort and return when the timeout timer expires. A value of 0 indicates an asynchronous action.

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.

sl_wifi_set_certificate#

sl_status_t sl_wifi_set_certificate (uint8_t certificate_type, const uint8_t * buffer, uint32_t certificate_length)

Load the certificate into the device.

Parameters

Type	Direction	Argument Name	Description
uint8_t	[in]	certificate_type	Certificate type being set
const uint8_t *	[in]	buffer	Pointer to buffer containing the certificate.
uint32_t	[in]	certificate_length	Length of certificate buffer data.

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.

sl_wifi_set_certificate_with_index#

sl_status_t sl_wifi_set_certificate_with_index (uint8_t certificate_type, uint8_t certificate_index, uint8_t * buffer, uint32_t certificate_length)

Load the certificate into the device.

Parameters

Type	Direction	Argument Name	Description
uint8_t	[in]	certificate_type	Certificate type being set.
uint8_t	[in]	certificate_index	Certificate to be loaded in specified index.
uint8_t *	[in]	buffer	Pointer to buffer containing the certificate.
uint32_t	[in]	certificate_length	Length of certificate buffer data.

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.

sl_wifi_set_advanced_client_configuration#

sl_status_t sl_wifi_set_advanced_client_configuration (sl_wifi_interface_t interface, const sl_wifi_advanced_client_configuration_t * configuration)

Set the advanced configuration options of a client interface.

Parameters

Type	Direction	Argument Name	Description
sl_wifi_interface_t	[in]	interface	Wi-Fi interface as identified by sl_wifi_interface_t
const sl_wifi_advanced_client_configuration_t *	[in]	configuration	Wi-Fi client advanced configuration. See sl_wifi_advanced_client_configuration_t

Returns

sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.