Settings - nxp-mcuxpresso/vscode-for-mcux GitHub Wiki

The NXP MCUXpresso for VS Code extension provides various settings you can use to set up the environment.

To configure these settings, open the Settings editor from the Command Palette (Ctrl+Shift+P) with Preferences: Open Settings and search MCUXpresso.

General settings

Config Tools setting

Path to the MCUXpresso Config Tools executable.

Check Optional Updates (Experimental) setting

Setting related to Enable MCUXpresso Installer Integration. If enabled, update notifications will be displayed even for non-mandatory tools.

Enable MCUXpresso Installer Integration (Experimental) setting

Configure enablement of automatic integration with the MCUXpresso Installer. The MCUXpresso for VS Code extension will notify you about missing, or outdated, tool dependencies and provide actions to automatically download and install required tools.

DTC Path setting

Specify the path to the Device Tree Compiler (DTC) executable.

Energy Measurement File path setting

Set the file path for storing data collected by the Energy Measurement tool.

Enable Add Files to Project (Experimental) setting

Configure enablement of source file managenement using drag and drop, or dedicated actions in PROJECTS view.

Enable Freestanding Copy Board Files (Experimental) setting

Setting that affects how board-specific files are handled during project creation and configuration. When enabled, allows copying board files in freestanding projects.

Enable MCUXpresso Tasks for Automation (Experimental) setting

Enable support for MCUXpresso Tasks that can be used in CI/CD environments to automatically execute various tasks.

Long Path Warning setting

On Windows systems, enable or disable the checks, and warnings, about long file paths that may cause issues during build operations.

SDKs setting

Configure the list of SDKs/repositories installed and used by the MCUXpresso for VS Code extension.

ZAP Tool Path setting

Specify the folder where ZAP Tool can be found.

Secure Provisioning Tool settings

Secure Provisioning Tool Path setting

Specify the path to the Secure Provisioning Tool executable.

Secure Provisioning Tool Usage setting

Configure enablement of Secure Provisioning Tool usage within the MCUXpresso for VS Code extension.

Python settings

Virtual Environment setting

This setting allows to user to configure the Python virtual environment. There are three options available:

• auto: use the Python virtual environment created by MCUXpresso Installer;
• custom: use the Python virtual environment configured by the user;
• off: do not use a Python virtual environment, use the native Python installation instead;

Note: When using the custom option, you must also set the path to the Python virtual environment.

Virtual Environment Path setting

This setting allows to user to provide the path to the Python virtual environment. This setting it is taken into consideration only when the virtual environment setting is set to custom.

West Path setting

This setting allows the user to set the path to the 'west' tool. This setting is considered first, before any other Python related settings.

Note: The Virtual Environment and Virtual Environment Path settings are also available as Workspace settings.

Zephyr settings

Instruct the MCUXpresso for VS Code extension to also show non-NXP boards in the board selection drop-down when importing example projects.

Debug settings

Debug Server Log File setting

Specify the path to the debug server log file for detailed debugging information and troubleshooting. This can be overwritten in the debug configuration by using the debugServerLogFile property.

Default Debug Interface setting

Specify the preferred debug interface to be used when debugging, and the debug configuration doesn't specify an interface via the gdbServerConfigs property. This setting also affects the Flash Programmer view, making it pre-select the flash programming interface according to the current setting.

Live Watch Refresh Rate setting

Set the refresh interval when using the Live Watch functionality during debug.

Register Use Natural Format setting

Specify whether to display registers (inside the VARIABLES view) in the format specified by ARM, instead of hex.

Show Dev Debug Output setting

The default logging type during a debug session. This setting controls the verbosity of debug messages printed in the DEBUG CONSOLE view during debugging. The value specified in this setting can be overridden by specifying a valid showDevDebugOutput property in the debug configuration.

Switch to MCUXpresso after Terminate Debug setting

When enabled, this setting automatically switches your active collection of views back to the MCUXpresso extension after terminating an MCUXpresso debug session.

Warn Probe in Use setting

Configure whether to display a warning when a debug probe is already in use by another debug session. Note that linked multicore debug session are not affected by this setting.

Variables Use Natural Format setting

Specify whether to display variables (inside the VARIABLES) in the format specified by ARM, instead of hex.

Debug Probes settings

LinkServer Path setting

Allows specifying the root path of a LinkServer tool installation. The path specified in this setting will always be used, even newer versions might be installed in the system. The path to the LinkServer can be also specified inside the debug configuration.

PEmicro Path setting

Allows specifying the root path of a PEmicro tool installation. The path specified in this setting will always be used, even newer versions might be installed in the system. The path to the PEmicro tool can be also specified inside the debug configuration.

Segger Path setting

Allows specifying the path to the Segger J-Link GDB server. The GDB server file path specified in this setting will always be used, even newer versions might be installed in the system. The path to the GDB server file can be also specified inside the debug configuration.

RTOS Details settings

Configure whether the RTOS DETAILS view shall compute, and display, stack usage based on the RTOS-specific high-watermark implementation. Note that this usually takes time to compute.