Client#

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.

• Pre-conditions:

  • sl_wifi_init should be called before this API.

Returns

• sl_status_t. See https://docs.silabs.com/gecko-platform/latest/platform-common/status for details.

Note

• If channel, band, and BSSID are provided, this API attempts to connect without scanning. If security_type is SL_WIFI_WPA3/SL_WIFI_WPA3_ENTERPRISE then SL_SI91X_JOIN_FEAT_MFP_CAPABLE_REQUIRED join feature is enabled internally by SDK. If security_type is SL_WIFI_WPA3_TRANSITION/SL_WIFI_WPA3_TRANSITION_ENTERPRISE then SL_SI91X_JOIN_FEAT_MFP_CAPABLE_REQUIRED join feature is disabled and SL_SI91X_JOIN_FEAT_MFP_CAPABLE_ONLY join feature is enabled internally by SDK. Default Active Channel time is 100 milliseconds. If the user wants to modify the time, sl_wifi_set_advanced_scan_configuration can be called. Default Authentication timeout and Association timeout is 300 milliseconds. If the user wants to modify the time, sl_wifi_set_advanced_client_configuration can be called. Default Keep Alive timeout is 30 milliseconds. If the user wants to modify the time, sl_wifi_set_advanced_client_configuration can be called.

• In FCC certified module the behavior is as follows

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

  2. STA mode channels 1 to 11 are actively scanned and 12, 13, 14 are passively scanned.

  3. Concurrent mode supports only 1 to 11 channels.

sl_wifi_disconnect#

sl_status_t sl_wifi_disconnect (sl_wifi_interface_t interface)

Disconnect the Wi-Fi client interface.

• Pre-conditions:

  • sl_wifi_connect should be called before this API.

Returns

• sl_status_t. See https://docs.silabs.com/gecko-platform/latest/platform-common/status for details.

Note

• All si91x, BSD, and IoT sockets associated with the station interface must be closed before invoking this API.

sl_wifi_get_signal_strength#

sl_status_t sl_wifi_get_signal_strength (sl_wifi_interface_t interface, int32_t * rssi)

Retrieve the RSSI value of the Access Point to which the Wi-Fi client is connected.

• Pre-conditions:

  • sl_wifi_connect should be called before this API.

Returns

• sl_status_t. See https://docs.silabs.com/gecko-platform/latest/platform-common/status for details.

sl_wifi_get_sta_tsf#

sl_status_t sl_wifi_get_sta_tsf (sl_wifi_interface_t interface, sl_wifi_tsf64_t * tsf)

Get the station Timing Synchronization Function (TSF) time which is synchronised with connected AP beacon TSF.

• Pre-condition: sl_wifi_connect should be called before this API.

Returns

• sl_status_t. See https://docs.silabs.com/gecko-platform/latest/platform-common/status for details.

Note

• This API returns an error if the station is not connected to an Access Point or at least one beacon is not received.

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.

• Pre-conditions:

  • sl_wifi_set_advanced_scan_configuration should be called before this API.

Returns

• sl_status_t. See https://docs.silabs.com/gecko-platform/latest/platform-common/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.

Returns

• sl_status_t. See https://docs.silabs.com/gecko-platform/latest/platform-common/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.

• Pre-conditions:

  • sl_wifi_init should be called before this API.

Returns

• sl_status_t. See https://docs.silabs.com/gecko-platform/latest/platform-common/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.

• Pre-conditions:

  • sl_wifi_init should be called before this API.

Returns

• sl_status_t. See https://docs.silabs.com/gecko-platform/latest/platform-common/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.

• Pre-conditions:

  • sl_wifi_init should be called before this API.

Returns

• sl_status_t. See https://docs.silabs.com/gecko-platform/latest/platform-common/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.

• Pre-conditions:

  • sl_wifi_init should be called before this API.

Returns

• sl_status_t. See https://docs.silabs.com/gecko-platform/latest/platform-common/status for details.

sl_wifi_send_raw_data_frame#

sl_status_t sl_wifi_send_raw_data_frame (sl_wifi_interface_t interface, const void * data, uint16_t data_length)

Send raw data frame.

• Pre-conditions:

  • sl_wifi_init should be called before this API.

Returns

• sl_status_t. See https://docs.silabs.com/gecko-platform/latest/platform-common/status for details.

sl_wifi_enable_target_wake_time#

sl_status_t sl_wifi_enable_target_wake_time (sl_wifi_twt_request_t * twt_req)

Configure TWT parameters.

Enables a TWT session. This is blocking API.

• Pre-conditions:

  • sl_wifi_connect should be called before this API.

Returns

• sl_status_t. See https://docs.silabs.com/gecko-platform/latest/platform-common/status for details.

sl_wifi_disable_target_wake_time#

sl_status_t sl_wifi_disable_target_wake_time (sl_wifi_twt_request_t * twt_req)

Configure TWT parameters.

Disables a TWT session. This is blocking API.

• Pre-conditions:

  • sl_wifi_enable_target_wake_time should be called before this API.

Returns

• sl_status_t. See https://docs.silabs.com/gecko-platform/latest/platform-common/status for details.

sl_wifi_target_wake_time_auto_selection#

sl_status_t sl_wifi_target_wake_time_auto_selection (sl_wifi_twt_selection_t * twt_selection_req)

Calculates and configures TWT parameters based on the given inputs.

Enables or disables a TWT session. This is blocking API.

• Pre-conditions:

  • sl_wifi_connect should be called before this API.

Returns

• sl_status_t. See https://docs.silabs.com/gecko-platform/latest/platform-common/status for details.

sl_wifi_reschedule_twt#

sl_status_t sl_wifi_reschedule_twt (uint8_t flow_id, sl_wifi_reschedule_twt_action_t twt_action, uint64_t suspend_duration)

Suspends the TWT agreement corresponding to given flow id and resumes it when suspend duration expires.

This API performs the following actions on TWT agreement: SL_WIFI_SUSPEND_INDEFINITELY, SL_WIFI_RESUME_IMMEDIATELY, SL_WIFI_SUSPEND_FOR_DURATION. Note

• The reschedule TWT actions are valid till the end of current TWT agreement. If the TWT agreement is terminated (TWT tear down or WLAN disconnection), these actions are not retained. To reapply these actions upon new TWT agreement, the user must re-issue the command.

• Pre-conditions:

  • sl_wifi_connect should be called before this API.

The table below outlines the valid values for TWT actions and their corresponding suspend durations:#

Returns

• sl_status_t. See https://docs.silabs.com/gecko-platform/latest/platform-common/status for details.

sl_wifi_filter_broadcast#

sl_status_t sl_wifi_filter_broadcast (uint16_t beacon_drop_threshold, uint8_t filter_bcast_in_tim, uint8_t filter_bcast_tim_till_next_cmd)

Send Filter Broadcast Request frame.

• Pre-conditions:

  • sl_wifi_init should be called before this API.

Returns

• sl_status_t. See https://docs.silabs.com/gecko-platform/latest/platform-common/status for details.

sl_wifi_get_pairwise_master_key#

sl_status_t sl_wifi_get_pairwise_master_key (sl_wifi_interface_t interface, const uint8_t type, const sl_wifi_ssid_t * ssid, const char * pre_shared_key, uint8_t * pairwise_master_key)

Generate PMK if PSK and SSID are provided.

This is a blocking API.

• Pre-conditions:

  • This API should be called after sl_wifi_init and called before sl_wifi_connect.

Returns

• sl_status_t. See https://docs.silabs.com/gecko-platform/latest/platform-common/status for details.

sl_wifi_configure_multicast_filter#

sl_status_t sl_wifi_configure_multicast_filter (sl_wifi_multicast_filter_info_t * multicast_filter_info)

Configure multicast filter parameters.

This is a blocking API.

• Pre-conditions:

  • sl_wifi_init should be called before this API.

Returns

• sl_status_t. See https://docs.silabs.com/gecko-platform/latest/platform-common/status for details.