.. MCUXpresso for VS Code documentation master file, created by
   sphinx-quickstart on Mon Nov  3 17:43:08 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

MCUXpresso for VS Code documentation
====================================

Overview
========

**MCUXpresso for VS Code** is an NXP extension for Microsoft Visual Studio Code that turns VS Code into a full embedded development environment for NXP microcontrollers. It provides an easy and fast way to create, build, flash and debug applications based on `MCUXpresso SDK <https://www.nxp.com/design/software/development-software/mcuxpresso-software-and-tools-/mcuxpresso-software-development-kit-sdk:MCUXpresso-SDK>`_, `Zephyr <https://www.zephyrproject.org/>`_ or `Matter <https://docs.mcuxpresso.nxp.com/matter/latest/html/index.html>`_ projects.

The extension is designed around a few core ideas:

* **Guided setup** - a companion tool, the *MCUXpresso Installer*, manages all external dependencies (toolchains, debug probe software, CMake, Ninja, Python, Zephyr SDK, and more) so you can focus on development rather than environment configuration.
* **Repository-centric workflow** - import an MCUXpresso SDK, a Zephyr west workspace, a Matter application-layer, or an Application Code Hub example, and manage all your projects from a dedicated MCUXpresso view in VS Code.
* **Familiar VS Code experience** - projects use standard CMake, `launch.json` and `tasks.json` files, so everything remains transparent, scriptable, and CI-friendly.
* **Rich debug capabilities** - Flash Programmer, multi-probe support (LinkServer, SEGGER J-Link, PEmicro), Peripherals, SWO, RTOS thread awareness, memory inspector and Image Info views.

If this is your first time using the extension, the recommended path is:

1. Read the :doc:`Explore-Extension` chapter to learn what the extension contributes to VS Code.
2. Install the required dependencies with the :doc:`MCUXpresso-Installer`.
3. Import a software repository and open one of the :doc:`Getting-Started` guides for the ecosystem you are targeting.

Table of Contents
=================

.. toctree::
   :maxdepth: 1
   :caption: MCUXpresso for VS Code

   Explore-Extension
   Settings

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   Getting-Started

.. toctree::
   :maxdepth: 1
   :caption: Software Repositories

   Import-Repository
   Working-with-MCUXpresso-SDK
   Working-with-Zephyr
   Application-Code-Hub
   Working-with-Matter
   Git-Authentication
   Terminal

.. toctree::
   :maxdepth: 1
   :caption: Project Management

   Create-Project
   MCUXpresso-IDE-Project-Converter
   Import-Multiple-Projects
   New-Project-Wizard
   Working-with-Pure-CMake-Projects
   Working-with-MCUXpresso-Config-Tools
   Working-with-MCUXpresso-Secure-Provisioning-Tool
   Serial-Memory-Quick-Start-Guide
   Device-Tree
   CMake
   Sysbuild
   Component-Management
   Offline-Peripherals
   Linked-Projects
   Binary-Utilities
   Image-Info
   Collaborative-Work-On-Projects
   Add-Files-to-Project
   Linker-Script

.. toctree::
   :maxdepth: 1
   :caption: Flash and Debug

   Flash
   Debug
   Debug-Common-Operations
   Debug-Views
   RTOS-Details
   Peripherals
   Heap-and-Stack
   SWO
   Energy-Measurement

.. toctree::
   :maxdepth: 1
   :caption: MCUXpresso Installer

   MCUXpresso-Installer
   MCUXpresso-Installer-Integration
   Offline-Installation
   Installer-Update
   MCUXpresso-Installer-Troubleshooting
   MCUXpresso-Installer-CLI

.. toctree::
   :maxdepth: 1
   :caption: MCUXpresso Tasks for CI/CD

   Tasks-Introduction
   Tasks-Definition
   Tasks-Examples
   Tasks-Notes-Limitations

.. toctree::
   :maxdepth: 2
   :caption: Reference Guides

   TrustZone-Examples
   Multicore-Examples
   SDRAM-Examples-on-RT1060-and-MCUXpresso-SDK
   Debugging-Linux-Apps-with-VS-Code

.. toctree::
   :maxdepth: 1
   :caption: Troubleshooting

   Network-Troubleshooting
   General-Troubleshooting
   Windows-Long-Path-Support

Useful Links
============

* `MCUXpresso for Visual Studio Code <https://www.nxp.com/design/microcontrollers-developer-resources/mcuxpresso-for-visual-studio-code:MCUXPRESSO-VSC?tid=vanMCUXPRESSO-VSC>`_
* `Community page <https://community.nxp.com/t5/MCUXpresso-for-VSCode/bd-p/mcuxpresso-vscode>`_