Migrating from WiSeConnect SDK v3.5.3 to v4.0.0#

Overview#

This guide describes how to update an existing application from WiSeConnect™ SDK v3.5.3 to v4.0.0.

Version 4.0.0 introduces naming and file changes compared to v3.5.3, primarily to standardize naming and improve overall API usability. As a result, migration requires updating these names throughout the existing application.

Important: After migrating to Studio v6, it is mandatory to upgrade to SDK 4.0.0 or later to use examples that require RAM execution or ultra-low-power (ULP) peripherals.

Migration Steps#

Follow these steps to convert a WiSeConnect SDK v3.5.3 application to a v4.0.0 application:

  1. Open your existing application project in Simplicity Studio.

  2. [Mandatory] For SI91x – SL_ULP_I2S application, replace the I2S_LOOP_BACK define with I2S1_LOOP_BACK in the project’s slcp file.

  3. [Recommended] In the project files, update the v3.5.3 deprecated content with the corresponding v4.0.0 equivalents. This step is not mandatory but recommended due to the deprecation of the specified APIs. If you intend to upgrade to future releases, we recommend that you make these changes before June 2027, the end of the deprecation period for this release.

Product Name Change#

Note: Starting from WC-4.0.0, we have updated the product name from WiSeConnect3 to WiSeConnect. As part of this change, several documents, studio software components, and studio supporting files have also been renamed to reflect the new naming convention.

  • Studio Software Components:

    Module

    v3.5.3

    v4.0.0

    Common

    wiseconnect3_common

    wiseconnect_common

    Common

    wiseconnect3_logger

    wiseconnect_logger

  • Build Package

    v3.5.3

    v4.0.0

    wiseconnect3

    wiseconnect

  • Studio Files:

    v3.5.3

    v4.0.0

    wiseconnect3.slsdk

    wiseconnect.slsdk

    wiseconnect3.slce

    wiseconnect.slce

    wiseconnect3.xapi

    wiseconnect.xapi

    wiseconnect3_demos.xml

    wiseconnect_demos.xml

    wiseconnect3_docs.xml

    wiseconnect_docs.xml

    wiseconnect3_common.slcc

    wiseconnect_common.slcc

    wiseconnect3_logger.slcc

    wiseconnect_logger.slcc

Review your project structure and update any references to these names in your source files, build scripts, and project configurations to ensure a smooth migration.

Refer to the tables in each of the sections that follow, which map the v3.5.3 API elements to v4.0.0. In some instances, the differences between v3.5.3 and v4.0.0 are highlighted in bold text.

Updated APIs#

Note: Due to fixes in the APIs: sl_net_set_profile, sl_net_set_credential, following applications have been updated: wifi_provisioning_via_access_point, wifi_ap_ble_provisioning.

Module

v3.5.3

v4.0.0

Wi-Fi

Added validation check for SSID length in sl_net_set_profile API to prevent invalid credentials from being set without error.

Wi-Fi

Added validation check for PSK and PMK lengths in sl_net_set_credential API to prevent invalid credentials from being set without error.

Deprecated APIs#

Note: The following elements are applicable to both NCP and SoC modes.

Note: Starting from WC-4.0.0, we recommend using the new versions of APIs/Structures/Macros to ensure compatibility with future releases.

Module

v3.5.3 [Deprecated]

v4.0.0 [New]

Wi-Fi

sl_wifi_get_wireless_info

sl_wifi_get_interface_info

Wi-Fi

sl_wifi_set_scan_callback

sl_wifi_set_scan_callback_v2

Wi-Fi

sl_wifi_set_join_callback

sl_wifi_set_join_callback_v2

Wi-Fi

sl_wifi_set_twt_config_callback

sl_wifi_set_twt_config_callback_v2

Wi-Fi

sl_wifi_set_stats_callback

sl_wifi_set_stats_callback_v2

Wi-Fi

sl_wifi_set_transceiver_callback

sl_wifi_set_transceiver_callback_v2

Wi-Fi

sl_wifi_start_wps

sl_wifi_start_wps_v2

Wi-Fi

sl_si91x_get_saved_firmware_status

sl_wifi_get_saved_firmware_status

Wi-Fi

sl_si91x_register_event_handler

sli_net_register_event_handler

Wi-Fi

sl_mqtt_client_connect

sl_mqtt_client_connect_v2

Network Management

sl_si91x_set_credential

sli_net_set_credential

Network Management

sl_si91x_get_credential

sli_net_get_credential

Network Management

sl_si91x_delete_credential

sli_net_delete_credential

SiWx91x Platform

sl_si91x_button_state_toggle

sl_si91x_button_toggle_state

SiWx91x Platform

sl_si91x_button_state_set

sl_si91x_button_set_state

SiWx91x Platform

sl_si91x_button_state_get

sl_si91x_button_get_state

SiWx91x Platform

sl_si91x_button_state

sl_si91x_button_pin_state

SiWx91x Platform

sl_si91x_gpio_driver_unmask_uulp_npss_interrupt

sl_si91x_gpio_driver_mask_clear_uulp_npss_interrupt

SiWx91x Platform

sl_si91x_gpio_driver_clear_uulp_interrupt

sl_si91x_gpio_driver_clear_uulp_npss_interrupt

SiWx91x Platform

sl_si91x_efuse_write_bit

sl_si91x_efuse_write_bit_v2

SiWx91x Platform

sl_si91x_usart_register_event_callback

sl_si91x_usart_multiple_instance_register_event_callback

SiWx91x Platform

sl_si91x_adc_configure_clock

No replacement

SiWx91x Platform

sl_si91x_calendar_set_configuration

No replacement

SiWx91x Platform

sl_si91x_calendar_rcclk_calibration

No replacement

SiWx91x Platform

sl_si91x_calendar_roclk_calibration

No replacement

SiWx91x Platform

sl_si91x_gspi_configure_clock

No replacement

SiWx91x Platform

sl_i2c_driver_receive_data_non_blocking

No replacement

SiWx91x Platform

sl_si91x_ssi_configure_clock

No replacement

SiWx91x Platform

sl_si91x_watchdog_configure_clock

No replacement

Deprecated Structures#

Module

v3.5.3 [Deprecated]

v4.0.0 [New]

Wi-Fi

sl_si91x_rsp_wireless_info_t

sl_wifi_interface_info_t

Wi-Fi

sl_wifi_callback_function_t

sl_wifi_callback_function_v2_t

Wi-Fi

sl_wifi_scan_callback_t

sl_wifi_scan_callback_v2_t

Wi-Fi

sl_wifi_stats_callback_t

sl_wifi_stats_callback_v2_t

Wi-Fi

sl_wifi_join_callback_t

sl_wifi_join_callback_v2_t

Wi-Fi

sl_wifi_twt_config_callback_t

sl_wifi_twt_config_callback_v2_t

Wi-Fi

sl_wifi_transceiver_callback_t

sl_wifi_transceiver_callback_v2_t

Wi-Fi

sl_si91x_set_join_configuration

sl_wifi_set_join_configuration

Wi-Fi

sl_si91x_get_join_configuration

sl_wifi_get_join_configuration

Wi-Fi

sl_si91x_packet_t

sl_wifi_system_packet_t

Wi-Fi

sl_si91x_boot_configuration_t

sl_wifi_system_boot_configuration_t

Wi-Fi

sl_si91x_timeout_t

sl_wifi_timeout_t

Wi-Fi

sl_si91x_module_state_stats_response_t

sl_wifi_module_state_stats_response_t

Wi-Fi

sl_si91x_fw_version_info_t

sl_wifi_system_fw_version_info_t

Wi-Fi

sl_si91x_fw_version_ext_info_t

sl_wifi_fw_version_ext_info_t

Wi-Fi

sl_si91x_firmware_header_t

sl_wifi_firmware_header_t

Wi-Fi

sl_si91x_dynamic_pool

sl_wifi_system_dynamic_pool_t

Wi-Fi

sl_si91x_ap_reconfiguration_t

sl_wifi_ap_reconfiguration_t

Wi-Fi

sl_si91x_coex_mode_t

sl_wifi_system_coex_mode_t

Wi-Fi

sl_si91x_operation_mode_t

sl_wifi_operation_mode_t

Wi-Fi

sl_si91x_performance_profile_t

sl_wifi_system_performance_profile_t

Wi-Fi

sl_si91x_request_tx_test_info_t

sl_wifi_request_tx_test_info_t

Wi-Fi

sl_si91x_async_stats_response_t

sl_wifi_async_stats_response_t

Wi-Fi

sl_si91x_advance_stats_response_t

sl_wifi_advanced_stats_response_t

Wi-Fi

sl_si91x_twt_response_t

sl_wifi_twt_response_t

Wi-Fi

sl_mqtt_broker_t

sl_mqtt_broker_v2_t

Network Management

sl_si91x_ping_response_t

sl_net_ping_response_t

Deprecated Enums#

Module

v3.5.3[Deprecated]

v4.0.0[New]

Wi-Fi

sl_si91x_band_mode_t

sl_wifi_band_mode_t

Wi-Fi

sl_si91x_region_code_t

sl_wifi_region_code_t

Wi-Fi

sl_si91x_vap_id_t

sl_wifi_vap_id_t

Wi-Fi

sl_si91x_ap_keepalive_type_t

sl_wifi_ap_keepalive_type_t

Network Management

sl_si91x_ip_config_mode_t

sli_net_ip_config_mode_t

Deprecated Macros#

Module

v3.5.3[Deprecated]

v4.0.0[New]

Wi-Fi

SL_SI91X_FEAT_SECURITY_OPEN

SL_WIFI_FEAT_SECURITY_OPEN

Wi-Fi

SL_SI91X_FEAT_SECURITY_PSK

SL_WIFI_FEAT_SECURITY_PSK

Wi-Fi

SL_SI91X_FEAT_AGGREGATION

SL_WIFI_FEAT_AGGREGATION

Wi-Fi

SL_SI91X_FEAT_WPS_DISABLE

SL_WIFI_FEAT_WPS_DISABLE

Wi-Fi

SL_SI91X_FEAT_EAP_LEAP_IN_COEX

SL_WIFI_FEAT_EAP_LEAP_IN_COEX

Wi-Fi

SL_SI91X_FEAT_HIDE_PSK_CREDENTIALS

SL_WIFI_FEAT_HIDE_PSK_CREDENTIALS

Wi-Fi

SL_SI91X_FEAT_TRANSCEIVER_MAC_PEER_DS_SUPPORT

SL_WIFI_FEAT_TRANSCEIVER_MAC_PEER_DS_SUPPORT

Wi-Fi

SL_SI91X_FEAT_DISABLE_11AX_SUPPORT

SL_WIFI_FEAT_DISABLE_11AX_SUPPORT

Wi-Fi

SL_SI91X_FEAT_SECURE_ATTESTATION

SL_WIFI_FEAT_SECURE_ATTESTATION

Wi-Fi

SL_SI91X_BURN_GAIN_OFFSET

SL_WIFI_BURN_GAIN_OFFSET

Wi-Fi

SL_SI91X_BURN_FREQ_OFFSET

SL_WIFI_BURN_FREQ_OFFSET

Wi-Fi

SL_SI91X_ALIGN_WITH_BEACON

SL_WIFI_ALIGN_WITH_BEACON

Wi-Fi

SL_SI91X_ALIGN_WITH_DTIM_BEACON

SL_WIFI_ALIGN_WITH_DTIM_BEACON

Wi-Fi

SL_SI91X_JOIN_FEAT_STA_BG_ONLY_MODE_ENABLE

SL_WIFI_JOIN_FEAT_STA_BG_ONLY_MODE_ENABLE

Wi-Fi

SL_SI91X_JOIN_FEAT_LISTEN_INTERVAL_VALID

SL_WIFI_JOIN_FEAT_LISTEN_INTERVAL_VALID

Wi-Fi

SL_SI91X_JOIN_FEAT_QUICK_JOIN

SL_WIFI_JOIN_FEAT_QUICK_JOIN

Wi-Fi

SL_SI91X_JOIN_FEAT_CCXV2_FEATURE

SL_WIFI_JOIN_FEAT_CCXV2_FEATURE

Wi-Fi

SL_SI91X_JOIN_FEAT_BSSID_BASED

SL_WIFI_JOIN_FEAT_BSSID_BASED

Wi-Fi

SL_SI91X_JOIN_FEAT_MFP_CAPABLE_ONLY

SL_WIFI_JOIN_FEAT_MFP_CAPABLE_ONLY

Wi-Fi

SL_SI91X_JOIN_FEAT_MFP_CAPABLE_REQUIRED

SL_WIFI_JOIN_FEAT_MFP_CAPABLE_REQUIRED

Wi-Fi

SL_SI91X_JOIN_FEAT_PS_CMD_LISTEN_INTERVAL_VALID

SL_WIFI_JOIN_FEAT_PS_CMD_LISTEN_INTERVAL_VALID

Wi-Fi

SL_SI91X_FEAT_EAP_TLS_V1P0

SL_WIFI_FEAT_EAP_TLS_V1P0

Wi-Fi

SL_SI91X_FEAT_EAP_TLS_V1P2

SL_WIFI_FEAT_EAP_TLS_V1P2

Wi-Fi

SL_SI91X_FEAT_CONC_STA_AP_DYN_SWITCH_SEL

SL_WIFI_FEAT_CONC_STA_AP_DYN_SWITCH_SEL

Wi-Fi

SL_SI91X_FEAT_DISABLE_MCS_5_6_7_DATARATES

SL_WIFI_FEAT_DISABLE_MCS_5_6_7_DATARATES

Wi-Fi

SL_SI91X_FEAT_DISABLE_SHORT_GI

SL_WIFI_FEAT_DISABLE_SHORT_GI

Wi-Fi

SL_SI91X_ENABLE_ENHANCED_MAX_PSP

SL_WIFI_ENABLE_ENHANCED_MAX_PSP

Wi-Fi

SL_SI91X_CUSTOM_FEAT_DISABLE_GATEWAY_IN_RSI_AP

SL_WIFI_CUSTOM_FEAT_DISABLE_GATEWAY_IN_RSI_AP

Wi-Fi

SL_SI91X_CUSTOM_FEAT_AP_IN_HIDDEN_MODE

SL_WIFI_CUSTOM_FEAT_AP_IN_HIDDEN_MODE

Wi-Fi

SL_SI91X_CUSTOM_FEAT_DFS_CHANNEL_SUPPORT

SL_WIFI_CUSTOM_FEAT_DFS_CHANNEL_SUPPORT

Wi-Fi

SL_SI91X_CUSTOM_FEAT_ASYNC_CONNECTION_STATUS

SL_WIFI_CUSTOM_FEAT_ASYNC_CONNECTION_STATUS

Wi-Fi

SL_SI91X_CUSTOM_FEAT_WAKE_ON_WIRELESS

SL_WIFI_CUSTOM_FEAT_WAKE_ON_WIRELESS

Wi-Fi

SL_SI91X_CUSTOM_FEAT_ENABLE_AP_BLACKLIST

SL_WIFI_CUSTOM_FEAT_ENABLE_AP_BLACKLIST

Wi-Fi

SL_SI91X_CUSTOM_FEAT_MAX_NUM_OF_CLIENTS

SL_WIFI_CUSTOM_FEAT_MAX_NUM_OF_CLIENTS

Wi-Fi

SL_SI91X_CUSTOM_FEAT_ROAM_WITH_DEAUTH_OR_NULL_DATA

SL_WIFI_CUSTOM_FEAT_ROAM_WITH_DEAUTH_OR_NULL_DATA

Wi-Fi

SL_SI91X_CUSTOM_FEAT_LIMIT_PACKETS_PER_STA

SL_WIFI_CUSTOM_FEAT_LIMIT_PACKETS_PER_STA

Wi-Fi

SL_SI91X_CUSTOM_FEAT_DUAL_BAND_ROAM_VCSAFD

SL_WIFI_CUSTOM_FEAT_DUAL_BAND_ROAM_VCSAFD

Wi-Fi

SL_SI91X_CUSTOM_FEAT_EXTENTION_VALID

SL_WIFI_SYSTEM_CUSTOM_FEAT_EXTENSION_VALID

Wi-Fi

SL_SI91X_EXT_FEAT_AP_BROADCAST_PKT_SND_B4_DTIM

SL_WIFI_EXT_FEAT_AP_BROADCAST_PKT_SND_BEFORE_DTIM

Wi-Fi

SL_SI91X_EXT_FEAT_FCC_LOW_PWR

SL_WIFI_EXT_FEAT_FCC_LOW_PWR

Wi-Fi

SL_SI91X_EXT_FEAT_ENABLE_11R_OTA

SL_WIFI_EXT_FEAT_ENABLE_11R_OTA

Wi-Fi

SL_SI91X_EXT_FEAT_IEEE_80211J

SL_WIFI_EXT_FEAT_IEEE_80211J

Wi-Fi

SL_SI91X_EXT_FEAT_IEEE_80211W

SL_WIFI_EXT_FEAT_IEEE_80211W

Wi-Fi

SL_SI91X_EXT_FEAT_16th_STATION_IN_AP_MODE

SL_WIFI_EXT_FEAT_16TH_STATION_IN_AP_MODE

Wi-Fi

SL_SI91X_EXT_FEAT_ENABLE_11R_ODS

SL_WIFI_EXT_FEAT_ENABLE_11R_ODS

Wi-Fi

SL_SI91X_EXT_FEAT_WOWLAN_DISABLE

SL_WIFI_EXT_FEAT_WOWLAN_DISABLE

Wi-Fi

SL_SI91X_EXT_FEAT_LOW_POWER_MODE

SL_WIFI_SYSTEM_EXT_FEAT_LOW_POWER_MODE

Network Management

SL_SI91X_WAIT_FOR_EVER

SL_NET_WAIT_FOREVER

Note#