biggates/esp-idf-devcontainer repository overview

⁠esp-idf-devcontainer

⁠

docker image for developing espressif idf in VS Code devcontainer

⁠How to use

1. "Add Docker container configuration" in ESP-IDF VS Code Extension, as in Tutorial: Using Docker Container⁠
2. Replace .devcontainer/Dockerfile with:

FROM biggates/esp-idf-devcontainer:(TAG)

⁠Available tags

• biggates/esp-idf-devcontainer:v5.4.2_qemu_20250228
• biggates/esp-idf-devcontainer:v5.4.1_qemu_20250228
• biggates/esp-idf-devcontainer:v5.3.3_qemu_20250228
• biggates/esp-idf-devcontainer:v5.3.2_qemu_20250228
• biggates/esp-idf-devcontainer:v5.2.5_qemu_20250228
• biggates/esp-idf-devcontainer:v5.2.4_qemu_20250228
• biggates/esp-idf-devcontainer:v5.1.6_qemu_20250228
• biggates/esp-idf-devcontainer:v5.1.5_qemu_20250228
• biggates/esp-idf-devcontainer:v5.0.9_qemu_20250228

⁠Solved Problem

Currently, the dev container provided by ESP-IDF VS Code Extension is a Dockerfile⁠, which has to be re-built every time when switching between idf versions.

This project provides a pre-built image so you can skip this build process.

⁠Base Container

• https://github.com/espressif/vscode-esp-idf-extension/blob/master/templates/.devcontainer/Dockerfile⁠

⁠Additional packages

• instead of using linux-tools-5.4.0-77-generic, use linux-tools-virtual instead. via dorssel/usbipd-win⁠
• a more recently version of espressif/qemu⁠
• pre-commit⁠

⁠Developing

⁠Environment

• python
• install python requirements by python -m pip install -r requirements.txt

⁠Add more idf versions

Supported idf versions (tags) are stored in idf_versions.json⁠ as a whitelist.

⁠Add more qemu versions

Known espressif/qemu info are stored in qemu_versions.json⁠ as a list.

The tricky part is that you have to specify sha256 of the asset.

⁠How to build an image manually

build all tags:

$ python scripts/main.py build --all

build specific one or more tags:

$ python scripts/main.py build v4.3.4

⁠How to push an image

$ python scripts/main.py push v5.0.1