-
Notifications
You must be signed in to change notification settings - Fork 133
Adding preview targets in the IDE #1237
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| How to Add a Preview or Custom ESP-IDF Target in the IDE (Manual Configuration) | ||
| =============================================================================== | ||
|
|
||
| To add support for any preview or custom ESP-IDF target (such as ESP32-C5 or others not listed by default in the IDE), follow these steps: | ||
|
|
||
| Step 1: Configure Toolchain | ||
| --------------------------- | ||
| 1. Go to Preferences → C/C++ → Core Build Toolchain. | ||
| 2. Under User Defined Toolchain, click on Add…. | ||
| 3. Select GCC and configure as follows: | ||
| - **Compiler:** (Path to the toolchain compiler for your target, e.g. `/Users/testuser/.espressif/tools/riscv32-esp-elf/esp-14.2.0_20241119/riscv32-esp-elf/bin/riscv32-esp-elf-gcc`) | ||
| - **Operating System:** (e.g. `esp32c5` for ESP32-C5) | ||
| - **CPU Arch:** (e.g. `riscv32` for ESP32-C5) | ||
| 4. Click Finish. | ||
|
|
||
| .. image:: ../../../media/toolchain/toolchain_1.png | ||
| :alt: Core Build Toolchains Preferences (Add Custom Target) | ||
|
|
||
| *Core Build Toolchains Preferences: Adding a custom/preview target toolchain (example: ESP32-C5)* | ||
|
|
||
| Step 2: Configure CMake Toolchain | ||
| --------------------------------- | ||
| 1. Navigate to Preferences → C/C++ → CMake. | ||
| 2. Click on Add…. | ||
| 3. Browse and select the CMake toolchain file for your target (e.g. `toolchain-esp32c5.cmake`). | ||
| 4. Choose the corresponding toolchain entry created in Step 1. | ||
| 5. Click Finish. | ||
|
|
||
| .. image:: ../../../media/toolchain/toolchain_2.png | ||
| :alt: CMake Toolchain Preferences (Add Custom Target) | ||
|
|
||
| *CMake Toolchain Preferences: Adding a custom/preview target toolchain file (example: ESP32-C5)* | ||
|
|
||
| Step 3: Add Launch Target | ||
| ------------------------- | ||
| 1. From the IDE's top toolbar target list, click on New Launch Target. | ||
| 2. Select ESP Target. | ||
| 3. Provide the following details: | ||
| - **Name:** (e.g. `esp32c5`) | ||
| - **IDF Target:** (e.g. `esp32c5`) | ||
| 4. Click Finish. | ||
|
|
||
| .. image:: ../../../media/toolchain/toolchain_3.png | ||
| :alt: New ESP Target Dialog (Custom Target Example) | ||
|
|
||
| *New ESP Target Dialog: Creating a launch target for a custom/preview target (example: ESP32-C5)* | ||
|
|
||
| Step 4: Build a Project | ||
| ----------------------- | ||
| - Create or open a project. | ||
| - Select your custom/preview target from the target list. | ||
| - Build the project. | ||
|
|
||
| .. image:: ../../../media/toolchain/toolchain_4.png | ||
| :alt: Build Output for Custom Target Project | ||
|
|
||
| *Build Output: Successfully building a project for a custom/preview target (example: ESP32-C5)* | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Invalid image paths will break docs build
The relative paths for your screenshots are off by one directory; from
docs/en/additionalfeatures, you should use../../media/...instead of../../../media/....Also applies to: 29-31, 43-44, 54-55
🤖 Prompt for AI Agents