Migrating from WiSeConnect™ SDK v3.5.0 to v3.5.1#
Overview#
This is a guide for updating an existing application using the WiSeConnect™ SDK v3.5.0 to a v3.5.1 application.
There are few naming and file changes in v3.5.1 as compared to v3.5.0, and these are mostly to standardize the names and improve the overall usage experience of the application programming interface (API). Migration requires all of the names to be updated in the existing application.
Migration Steps#
Follow the steps below to convert a WiSeConnect SDK v3.5.0 application to a v3.5.1 application:
Open your existing application project in Simplicity Studio.
In each source file of the project, replace the v3.5.0 names or interfaces with v3.5.1 names or interfaces.
See the tables in the following sections for a comparison of API elements between v3.5.0 and v3.5.1. Differences are emphasized in bold where applicable.
API Naming/Signature Corrections#
Module | v3.5.0 | v3.5.1 |
---|---|---|
Platform |
|
|
Structure Naming Corrections#
Module | v3.5.0 | v3.5.1 |
---|---|---|
None |
Updated Structures#
Module | v3.5.0 | v3.5.1 |
---|---|---|
None |
Deprecated APIs#
Note: The following elements are applicable to both NCP and SoC modes.
Note: Starting from WC-3.5.1, we recommend using the new versions of APIs/Structures/Macros to ensure compatibility with future releases.
Module | v3.5.0 | v3.5.1 |
---|---|---|
None |
Deprecated Structures#
Note: The following elements are applicable to both NCP and SoC modes.
Note: Starting from WC-3.5.1, we recommend using the new versions of APIs/Structures/Macros to ensure compatibility with future releases.
Module | v3.5.0 | v3.5.1 |
---|---|---|
None |
Deprecated Macros#
Note: The following elements are applicable to both NCP and SoC modes.
Note: Starting from WC-3.5.1, we recommend using the new versions of APIs/Structures/Macros to ensure compatibility with future releases.
Module | v3.5.0 | v3.5.1 |
---|---|---|
None |
Note: The following elements are applicable to SoC mode.
Module | v3.5.0 | v3.5.1 |
---|---|---|
None |
Added an enhanced version of API for BOD Button Wakeup Enable
As part of the migration from WiSeConnect™ SDK v3.5.0 to v3.5.1, the API sl_si91x_bod_button_wakeup_enable
is deprecated and a new API sl_si91x_bod_button_wakeup_enable_v2
has been added.
Reason for Change
This change improves type safety and error handling. The updated API uses a more appropriate input parameter data type and now returns a status code, allowing for better error detection and reporting compared to the previous version.
The parameter type was changed from uint8_t enable
to boolean_t bod_button_enable
to clearly indicate that the input is a boolean value. Additionally, the return type was changed from void
to sl_status_t
to allow the function to return status codes, enabling better detection and handling of errors during API usage.
User Impact
For applications using the old
sl_si91x_bod_button_wakeup_enable(uint8_t enable)
API, we recommend to use the new API:sl_status_t sl_si91x_bod_button_wakeup_enable_v2(boolean_t bod_button_enable)
.The function now returns a status code (
sl_status_t
), so add error handling where this API is called.The parameter type is now
boolean_t
instead ofuint8_t
, so update the argument accordingly (usetrue
orfalse
).Review all instances where this API is used to ensure compatibility with v3.5.1.
Note#
For information about deprecation warnings in WiSeConnect™ SDK v3.5.1, see SL_DEPRECATED_API_WISECONNECT_3_5.
For information on supressing deprecation warnings in WiSeConnect™ SDK v3.5.1, see SL_SUPPRESS_DEPRECATION_WARNINGS_WISECONNECT_3_5.