https://github.com/va1da5/esp32-idf-dev-container
Visual Studio Code Dev Container based C/C++ development environment for Espressif ESP32
https://github.com/va1da5/esp32-idf-dev-container
container containers cpp docker esp32 freertos
Last synced: 3 months ago
JSON representation
Visual Studio Code Dev Container based C/C++ development environment for Espressif ESP32
- Host: GitHub
- URL: https://github.com/va1da5/esp32-idf-dev-container
- Owner: va1da5
- Created: 2023-01-29T14:04:19.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-12T13:34:24.000Z (over 1 year ago)
- Last Synced: 2025-01-12T14:36:53.973Z (over 1 year ago)
- Topics: container, containers, cpp, docker, esp32, freertos
- Language: C
- Homepage:
- Size: 9.77 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Espressif ESP32 Development Environment
The setup provides a [container environment for Visual Studio Code](https://code.visualstudio.com/docs/devcontainers/containers) for developing solutions with ESP32 chips. The following hardware are supported.
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-H4 | ESP32-S2 | ESP32-S3 |
| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- | -------- |
## Hello World Example
Starts a FreeRTOS task to print "Hello World".
(See the README.md file in the upper level 'examples' directory for more information about examples.)
### How to use example
Follow detailed instructions provided specifically for this example.
Select the instructions depending on Espressif chip installed on your development board:
- [ESP32 Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/stable/get-started/index.html)
- [ESP32-S2 Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/get-started/index.html)
### Example folder contents
The project **hello_world** contains one source file in C language [hello_world_main.c](main/hello_world_main.c). The file is located in folder [main](main).
ESP-IDF projects are built using CMake. The project build configuration is contained in `CMakeLists.txt` files that provide set of directives and instructions describing the project's source files and targets (executable, library, or both).
Below is short explanation of remaining files in the project folder.
```
├── CMakeLists.txt
├── Dockerfile Configuration for the development container image
├── main
│ ├── CMakeLists.txt
│ └── hello_world_main.c
└── README.md This is the file you are currently reading
```
For more information on structure and contents of ESP-IDF projects, please refer to Section [Build System](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/build-system.html) of the ESP-IDF Programming Guide.
### Troubleshooting
* Program upload failure
* Check chip details `esptool.py flash_id`.
* Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there are any output logs.
* The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.
### Technical support and feedback
Please use the following feedback channels:
* For technical queries, go to the [esp32.com](https://esp32.com/) forum
* For a feature request or bug report, create a [GitHub issue](https://github.com/espressif/esp-idf/issues)
We will get back to you as soon as possible.
## References
- [ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/index.html)
- [Standard Toolchain Setup for Linux and macOS](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/linux-macos-setup.html)
- [ESP32 - DEBUGGING your ESP-IDF code using JTAG [VS CODE]](https://www.youtube.com/watch?v=uq93H7T7cOQ)
- [JTAG Debugging](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-guides/jtag-debugging/index.html)
- [ESP32 WROOM, SOLO and WROVER Modules](https://docs.espressif.com/projects/esp-idf/en/v3.3/hw-reference/modules-and-boards.html#wroom-solo-and-wrover-modules)
- [DevCon23 - ESP-IDF Getting Started (Beginners Guide to Key Concepts and Resources)](https://www.youtube.com/watch?v=J8zc8mMNKtc)
- [The ESP Component Registry](https://components.espressif.com/)
- [How to Save and Restore ESP8266 and ESP32 Firmware](https://cyberblogspot.com/how-to-save-and-restore-esp8266-and-esp32-firmware/)