MCUXpresso Installer Integration - nxp-mcuxpresso/vscode-for-mcux GitHub Wiki

The MCUXpresso for VS Code extension provides a robust integration with the MCUXpresso Installer for automatic dependency verification. The integration is currently experimental.

Prerequisites

The integration requires at least extension version 25.02 and MCUXpresso Installer version 24.12.

Dependency Verification

Automatic Dependency Verification

Upon opening VS Code, the integration will check if all core dependencies are installed and up to date. If any dependencies do not fulfill the required criteria an error message will appear.

Additionally, the extension icon will also be updated with a badge that counts the number of missing or outdated dependencies.

In the case that all dependencies are up to date, no message or badge will appear.

Certain dependencies will also be checked on demand whenever necessary. For instance, when cloning an MCUXpresso SDK, the integration will check for all the required dependencies, after the repository is installed.

Some dependencies display information in the UI. For example, the DEBUG PROBES view will update to reflect the installation status of the underlying dependencies.

Manual Dependency Verification

Dependencies can also be checked manually by running the Check for missing dependencies command. This command can be accessed either from the command palette or from the Quickstart Panel by hovering on the Open MCUXpresso Installer option and clicking on the last icon.

Dependency installation

Dependencies can be installed or updated in multiple ways.

The Check for missing dependencies command, which can be accessed from the Quickstart Panel or from the command palette, will run dependency verification in the background. Once the process is done, a prompt with the missing dependencies will be shown.

If you are using the latest MCUXpresso Installer, the dependencies can also be automatically installed in the background, without having to open the MCUXpresso Installer. The option is present only if the MCUXpresso Installer version has CLI support.

Core dependencies

Core dependencies are dependencies that are required for all workflows. These include:

• CMake
• Git
• Ninja
• Python
• Pip
• Zephyr West Tool

Check Optional Updates

If this setting is checked, the MCUXpresso Installer Integration will also warn the user about dependencies that may meet the minimum required versions, but do not meet the recommended versions. These updates are optional, and are not mandatory for performing their associated workflows.

Disable MCUXpresso Installer Integration

The MCUXpresso Installer integration can be disabled in the extension settings. It is recommended to restart VS Code after changing this setting.