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 security_type is SL_WIFI_WPA3/SL_WIFI_WPA3_ENTERPRISE then SL_WIFI_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_WIFI_JOIN_FEAT_MFP_CAPABLE_REQUIRED join feature is disabled and SL_WIFI_JOIN_FEAT_MFP_CAPABLE_ONLY join feature is enabled internally by SDK. Default Active Channel time is 100 milliseconds. Users can change this default by calling sl_wifi_set_advanced_scan_configuration() before connecting, which allows customization of the active channel scan time for different performance requirements. 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 seconds. 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.

• For IC parts (non-FCC certified modules), channels 12, 13, and 14 can be actively scanned by setting the device region to a non-US region using sl_si91x_set_device_region API before calling this API.

• It is recommended to set the timeout to 120000 milliseconds to cover the worst case timeout scenario.

• If this API fails with error SL_STATUS_TIMEOUT, reset the NWP with sl_net_deinit.

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.

• This function uses a user-configurable timeout parameter that is not affected by the global timeout scaling factors (SL_WIFI_INTERNAL_COMMANDS_TIMEOUT_SF, SL_WIFI_MANAGEMENT_COMMANDS_TIMEOUT_SF, SL_WIFI_NETWORK_COMMANDS_TIMEOUT_SF) or the additional wait time configuration (SL_TX_ADDITIONAL_WAIT_TIME).

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.

Note

• The RSSI value is valid only when the Wi-Fi client is connected to an access point. If the Wi-Fi client is disconnected, the RSSI value will be 0xFF.

• The RSSI value is the average of the last four beacons received by the STA from the connected AP.

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, const 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, 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_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_configure_timeout#

sl_status_t sl_wifi_configure_timeout (sl_wifi_interface_t interface, sl_wifi_timeout_type_t timeout_type, uint16_t timeout_value)

Configure Wi-Fi timeout parameters.

This API configures various timeout settings for the Wi-Fi module including authentication/association timeout, channel scan timeouts, keep alive timeout, and BSS Max Idle Period. The timeout type determines which parameter is being configured.

For BSS Max Idle Period (SL_WIFI_BSS_MAX_IDLE_PERIOD), this allows the IoT client device to negotiate a longer idle period with the AP, reducing the frequency of keepalive messages for improved power efficiency.

• 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

• For BSS_MAX_IDLE_PERIOD: can be called after opermode set and before association.

• Configuration is applied during the next association/reconnection.

sl_wifi_get_timeout#

sl_status_t sl_wifi_get_timeout (sl_wifi_interface_t interface, sl_wifi_timeout_type_t timeout_type, uint16_t * timeout_value)

Get Wi-Fi timeout parameter value.

This API queries timeout parameter values from NWP. For BSS Max Idle Period (SL_WIFI_BSS_MAX_IDLE_PERIOD), it returns the negotiated value from the AP after a successful association.

• sl_wifi_init should be called before this API. For SL_WIFI_BSS_MAX_IDLE_PERIOD, an active connection to an AP is required.

Returns

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

Note

• For BSS Max Idle configuration, the AP may indicate whether keepalive frames must be secured or non-secured. The firmware logs this frame type information, which can be accessed if the application has enabled logging.

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.

  • This API should be invoked only after the module has established a connection in STA or AP mode.

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 (const 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 (const 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_v2#

sl_status_t sl_wifi_target_wake_time_auto_selection_v2 (const sl_wifi_twt_selection_v2_t * config)

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

DeprecatedUse sl_wifi_target_wake_time_auto_selection_v2 with sl_wifi_twt_selection_v2_t instead. Internal TWT fields in sl_wifi_twt_selection_t are overwritten by the SDK with default values; only twt_enable, average_tx_throughput, tx_latency, and rx_latency are effective. This API is retained for backward compatibility.

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

DeprecatedDeprecated as of WiSeConnect SDK 4.1.0. Use sl_wifi_set_groupcast_filter_config for broadcast/multicast filtering options and sl_wifi_set_beacon_drop_threshold for the beacon drop threshold; see product documentation for migration from TIM-related fields.

• 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

• Moving forward, this API will be deprecated. Instead, use the sl_wifi_set_groupcast_filter_config and sl_wifi_set_beacon_drop_threshold APIs.

sl_wifi_set_groupcast_filter_config#

sl_status_t sl_wifi_set_groupcast_filter_config (const sl_wifi_groupcast_filter_config_t * config)

Configure broadcast and multicast filtering on the station 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_allowlist_mcast_add_ip#

sl_status_t sl_wifi_allowlist_mcast_add_ip (const sl_ip_address_t * ip_address, sl_ip_address_handle_t * id)

Add an IP multicast address to the NWP allowlist.

Returns a handle for later removal.

• 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_allowlist_mcast_remove_ip#

sl_status_t sl_wifi_allowlist_mcast_remove_ip (sl_ip_address_handle_t id)

Remove one multicast allowlist entry by handle.

• 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_allowlist_mcast_remove_all#

sl_status_t sl_wifi_allowlist_mcast_remove_all (void )

Clear the multicast IP allowlist.

• 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_beacon_drop_threshold#

sl_status_t sl_wifi_set_beacon_drop_threshold (sl_wifi_interface_t interface, uint16_t beacon_drop_threshold)

Set the beacon drop threshold used for power save (NWP advanced configuration).

For migration, this supersedes the beacon threshold aspect of deprecated sl_wifi_filter_broadcast; TIM-related broadcast filtering is configured separately via sl_wifi_set_groupcast_filter_config.

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

DeprecatedDeprecated as of WiSeConnect SDK 4.1.0. Use sl_wifi_set_groupcast_filter_config and the multicast IP allowlist APIs (sl_wifi_allowlist_mcast_add_ip and related) as described in product documentation.

• 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

• Moving forward, this API will be deprecated. Instead, use the sl_wifi_set_groupcast_filter_config API and the multicast IP allowlist APIs (for example sl_wifi_allowlist_mcast_add_ip).