VS Code Integration — ESP-IDF

Visual Studio Code with the ESP-IDF extension gives you a complete IDE experience — IntelliSense, one-click build/flash, an integrated serial monitor, and JTAG debugging.

Prerequisites

• VS Code installed (code.visualstudio.com)
• ESP-IDF v6.0.1 installed via EIM — Windows Setup →
• Your board connected via USB with drivers installed
• COM port identified from Device Manager (e.g., COM3)

Step 1 — Install VS Code

Download from code.visualstudio.com.

On Windows — choose the System Installer, not the User Installer. This avoids permission issues with ESP-IDF build tools.

Step 2 — Install the ESP-IDF Extension

1. Open VS Code
2. Press Ctrl+Shift+X to open the Extensions panel
3. Search for "ESP-IDF"
4. Install the extension by Espressif Systems

Step 3 — Point the Extension to Your ESP-IDF Installation (Optional)[This Set's Automatically in v6.0.1]

Since ESP-IDF v6.0.1 is already installed via EIM, you just need to select it:

Open the Command Palette (Ctrl+Shift+P) and run:

ESP-IDF: Select Current ESP-IDF Version

A dropdown appears showing all ESP-IDF versions detected on your machine. Select ESP-IDF v6.0.1.

The extension saves this as the active setup for your current workspace.

Step 4 — Open Your Project [Optional - you can create a new project using the extension also - See below]

File → Open Folder → select your project directory

The extension automatically detects CMakeLists.txt and configures IntelliSense for all ESP-IDF headers.

To create a new project instead of opening an existing one:

1. Press Ctrl+Shift+P
2. Type ESP-IDF: New Project
3. Select a template — use get-started/hello_world for a basic test
4. Set project name, location (no spaces in path), and target chip
5. Click Create Project → Open Project

Step 4 — Create a New Project Using VSCode ESP-IDF Extension

Other way you can just use the VSCode ESP-IDF Extension to create the project also . Follow the below steps

1. Click on the ESP-IDF Icon in the VS Code sidebar

2. Click on New Project

3. Select a template — use get-started/hello_world for a basic test

4. Set project name, location (no spaces in path), and target chip

5. Click Create Project → Open Project

Step 5 — Set the Target Chip

Open the Command Palette and run:

ESP-IDF: Set Espressif Device Target

Select your chip — esp32, esp32s3, esp32c3, or esp32c6.

You can also click the target chip name in the VS Code status bar at the bottom to change it quickly.

Step 6 — Select the Serial Port

Click the serial port icon in the VS Code status bar, or run:

ESP-IDF: Select Port to Use

Choose your board's COM port from the list — e.g., COM3.

Step 7 — Build, Flash and Monitor

Use the status bar buttons or the Command Palette:

Keyboard Shortcuts

Step 8 — IntelliSense and Code Navigation

After building once, VS Code has full IntelliSense for all ESP-IDF APIs:

• Auto-complete for all IDF functions — gpio_set_level, esp_wifi_init, xTaskCreate, etc.
• Go to definition (F12) — jump directly to ESP-IDF source
• Hover documentation — see function signatures and descriptions inline
• Error highlighting — build errors shown in the editor before you compile

If IntelliSense is not working after building, regenerate the configuration:

1. Press Ctrl+Shift+P
2. Type ESP-IDF: Add .vscode Configuration Folder
3. Run the command — this recreates c_cpp_properties.json with correct include paths

Step 9 — Menuconfig (Project Configuration)

To configure project-specific settings — WiFi credentials, FreeRTOS tick rate, log levels, partition tables:

1. Press Ctrl+Shift+P
2. Type ESP-IDF: SDK Configuration Editor
3. Run the command

A graphical menuconfig interface opens inside VS Code. This is easier to use than the terminal version.

Manage ESP-IDF Versions from VS Code

The extension integrates with EIM directly. To manage your installations:

Open Command Palette → ESP-IDF: Open ESP-IDF Installation Manager

This launches EIM inside VS Code where you can:

• Install additional ESP-IDF versions
• Switch between versions for different projects
• Update or repair an existing installation

Debugging with JTAG (Advanced)

1. Connect your JTAG probe to the board's JTAG pins
2. Open the Run and Debug panel — Ctrl+Shift+D
3. Click "Create a launch.json file" → select "ESP-IDF Debug"
4. Press F5 to start a debug session

You can set breakpoints, inspect variables, watch memory regions, and step through code line by line.

Recommended Extensions

Install all of these for the best ESP-IDF development experience in VS Code:

Troubleshooting

Extension not detecting ESP-IDF

Run ESP-IDF: Doctor Command. Then run ESP-IDF: Select Current ESP-IDF Version and manually select your v6.0.1 installation.

COM port not visible

Make sure USB drivers are installed (CP210x or CH340), board is connected, and no other application is using the port. Unplug and replug the board.

IntelliSense errors but build works fine

Run ESP-IDF: Add .vscode Configuration Folder to regenerate include path configuration.

Flash fails — port access denied

Close Arduino IDE, PuTTY, or any serial monitor using the same COM port.

Next Steps

• Your First Project →
• Windows Setup Guide →
• Official VS Code Extension Docs →