Upgrading the SDK version in the existing project#

In this method, we should import the already existing application project into the workspace and upgrade the WiSeConnect SDK extension attached to the project using Simplicity Studio.

1. Get the new WiSeConnect SDK to your local system.

   a. Navigate to Install > Manage Installed Packages > SDKs, select the latest version SiSDK and WiSeConnect extension, click on Finish.

   

   b. After the installation is successful, navigate to Preferences > Simplicity Studio > SDKs, ensure the newly installed GSDK and WiSeConnect SDK combination is enabled. (It is preferred to disable the older version SDKs)

   

2. Import the existing project.

   a. Browse to the project directory from File > Import, select <project_name>.sls file to import the project.

   Note: While importing the project use the same project name as before to avoid conflicts.

3. Once the project is successfully imported, open <project_name>.slcp file.

   If only the latest SDK is present in the preferences, follow section Project Migration with only latest SDK in preferences to migrate the project. Else If the .slcp file is opened properly, follow section Project Migration with multiple SDKs in preferences to migrate the project with multiple SDKs in preferences.

Project Migration with only latest SDK in preferences#

1. If a prompt appears as in the following image, select the latest SDK from the list, and click OK.

   

2. In the prompt visible, click VERIFY.

   

   Note: If the project upgradation prompt is not seen, make sure only the latest SDK is enabled in the SDK Preferences.

3. Once the compatibility is verified, click on UPGRADE for upgrading the project to the selected SDK.

   

4. After upgradation, the latest WiSeConnect SDK version can be seen in the project folders as shown in the following image.

   

5. Restore the /autogen and /config files.

   a. During migration, contents of <project>/autogen/, <project>/config/ and <wiseconnect3_x.x.x> folders are replaced with the new SDK files. The old project files are moved to trashed_modified_files folder (this folder is excluded from build, and can be used as a migration reference).

   b. To preserve the functionality, merge the project related file changes from the existing project (with old SDK) to the newly migrated project.

   c. There can be newly added files and changes in the existing files. It is recommended to compare both the old and new config and autogen folders and incorporate necessary changes from the old project files.

   Note: Step-5 is crucial to restore all the peripheral pin mappings and configurations needed for the successful project migration.#

6. Build and run the project as usual.

Project Migration with multiple SDKs in preferences#

1. Open the .slcp, then Change Target/SDK/Generators in overview.

   

2. Select the SDK from drop down in change SDK tab, select the latest SDK.

   

3. In the prompt visible, click VERIFY.

   

   Note: If the project upgradation prompt is not seen, make sure only the latest SDK is enabled in the SDK Preferences.

4. Once the compatibility is verified, click on UPGRADE for upgrading the project to the selected SDK.

   

5. After upgradation, the latest WiSeConnect SDK version can be seen in the project folders as shown in the following image.

   

6. Restore the /autogen and /config files.

   a. During migration, contents of <project>/autogen/, <project>/config/ and <wiseconnect3_x.x.x> folders are replaced with the new SDK files. The old project files are moved to trashed_modified_files folder (this folder is excluded from build, and can be used as a migration reference).

   b. To preserve the functionality, merge the project related file changes from the existing project (with old SDK) to the newly migrated project.

   c. There can be newly added files and changes in the existing files. It is recommended to compare both the old and new config and autogen folders and incorporate necessary changes from the old project files.

   Note: Step-6 is crucial to restore all the pin mappings and configurations needed for the successful project migration.#

7. Build and run the project as usual.

Note:#

1. Some projects contain custom folders (other than the WiSeConnect SDK), which results in compilation errors after project migration, such as undefined or undeclared macros, functions, or variables. You need to resolve these issues manually.

2. API and predefined terminology changes across SDKs are documented in the migration guide. Refer to this guide for understanding and resolving any further issues in the project.

General Source Control Information for Project Configurator Projects:#