Working with OpenCMSISPack - nxp-mcuxpresso/vscode-for-mcux GitHub Wiki

CMSIS-Toolbox

In order to use Open-CMSIS-Packs, CMSIS-Toolbox has to be installed.

It can be installed by using MCUXpresso Installer and selecting the corresponding category.

nxp-opencmsis-mcux-installer

Alternatively, you can follow installation steps listed here.

The toolbox will be automatically detected if it is registered in the OS's Path environment variable. If the toolbox cannot be found, the extension will prompt you to specify its path in the MCUXpresso for VS Code extension's settings.

CMSIS-Toolbox

Import remote repository

Navigate to the Quickstart Panel and click Import Repository.

Quickstart panel-import

Similar with MCUXpresso SDK, the REMOTE tab option on the Import repository view will allow the user to specify the details about the remote repository. Specify the location in the Location field and select the Open-CMSIS-Pack repository in the Repository dropdown. Click Import.

Install remote Open-CMSIS

Manage imported repository

The INSTALLED REPOSITORIES view lists all the packs available in the repository and their latest local version. The tooltip will show all the installed versions for the selected pack.

Multiple Open-CMSIS

The context menu for an Open-CMSIS-Pack repository offers additional options for managing the installed packs.

To add one or multiple packs to the selected repository:

  • Select Add Open-CMSIS-Pack package(s) from the context menu

Add Open-CMSIS Pack

  • Choose the location of the pack(s) that will be imported

Open-CMSIS Pack Location

  • When selecting Local file(s)..., a file browser will allow you to select one or multiple packs to be installed.
  • When selecting Remote index..., a list of the packs available in the remote index will be displayed.

Open-CMSIS Remote Index

Multiple selection is supported. Press OK at the end to install the packs.

To remove pack(s) from the selected repository:

  • Select Remove Open-CMSIS-Pack package(s) from the context menu

Remove Open-CMSIS Pack

  • Choose one or more packs from the list of installed packs

Remove Open-CMSIS Pack

Packs can also be removed using the inline icon:

Inline Remove Open-CMSIS Pack

It is also possible to view the license for a certain pack.

Open License for Open-CMSIS Pack

If a newer version of the packs are available online, use the context menu to Update Repository.

Update Open-CMSIS Pack Repository

Create a project

Go to Import Example viewer as explained on Create and build project and select the Open-CMIS-Pack repository.

The imported project now maintains the origin (ID and version) of the source pack. The information is visible in Projects view under Repository information.

Origin Pack

Build and debug the project

Note: The Arm CMSIS csolution extension has to be installed in order to build, rebuild, clean or manage components of a project based on Open-CMSIS-Packs. If it is not, you'll be prompted to install it when initiating one of these operations.

Arm CMSIS csolution Install Notification

Clicking yes will open the VS Code Marketplace. Click Install.
Arm CMSIS Marketplace

You can now navigate to your project and click the build icon.

VS Code project build

These configurations are for new workspaces. To build and debug more projects, the standard steps for building and debugging a project are described in build and debug documentation sections.

home