ESP32 Studio VS Code Extension
ESP32 Studio provides three tools for ESP32 workflows inside VS Code:
- NVS Tool
- Combine Bin
- Advanced Bin (batch export)
Features
Commands and Panels
Use the status bar:
- Click the ESPSTUDIO icon to open the ESP32 Studio panel container.
The panel container includes three views:
Open the Command Palette and run:
- "ESP32 Studio: Open Panel"
- "ESP32 Studio: Open NVS Tool"
- "ESP32 Studio: Open Combine Bin"
- "ESP32 Studio: Open Advanced Bin"
Project Configuration
Project settings are stored in a workspace file:
- .vscode/esp32_studio.json
Notes:
- NVS entries can contain plain-text values. Do not commit secrets.
- This config file is already ignored by Git.
Requirements
Python
- Python 3.x available in PATH
- The extension uses the "pythonPath" field from the panel (default: python)
Verify:
Python Modules
Required:
- esptool
- esp_idf_nvs_partition_gen
Install:
- python -m pip install --upgrade esptool
- python -m pip install --upgrade esp-idf-nvs-partition-gen
Verify:
- python -m esptool version
- python -m esp_idf_nvs_partition_gen --help
Common Issues
- "python not found": set the correct pythonPath in the panel or fix PATH.
- "Missing python module: esptool": install esptool (see above).
- "Missing python module: esp_idf_nvs_partition_gen": install esp-idf-nvs-partition-gen.
- "Serial connection failed": check port, baud, cable, and device permissions.
Development and Debugging
From this folder (vscode-extension):
- npm install
- npm run compile
Debug in VS Code:
- Open the vscode-extension folder.
- Press F5 to launch "Extension Development Host".
- Run the commands from the Command Palette.
Packaging
Generate a .vsix package:
The output .vsix will appear in the vscode-extension folder.
Marketplace publishing (placeholder):
- Create a publisher in the VS Code Marketplace.
- Create a Personal Access Token (PAT).
- Run
npx @vscode/vsce publish with your PAT.
- Verify the listing in the Marketplace.
| |
