Skip to content

Commit 37521c1

Browse files
docs:Adding preview targets in the IDE (#1237)
1 parent 0ea3046 commit 37521c1

File tree

6 files changed

+60
-1
lines changed

6 files changed

+60
-1
lines changed
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
How to Add a Preview or Custom ESP-IDF Target in the IDE (Manual Configuration)
2+
===============================================================================
3+
4+
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:
5+
6+
Step 1: Configure Toolchain
7+
---------------------------
8+
1. Go to Preferences → C/C++ → Core Build Toolchain.
9+
2. Under User Defined Toolchain, click on Add….
10+
3. Select GCC and configure as follows:
11+
- **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`)
12+
- **Operating System:** (e.g. `esp32c5` for ESP32-C5)
13+
- **CPU Arch:** (e.g. `riscv32` for ESP32-C5)
14+
4. Click Finish.
15+
16+
.. image:: ../../../media/toolchain/toolchain_1.png
17+
:alt: Core Build Toolchains Preferences (Add Custom Target)
18+
19+
*Core Build Toolchains Preferences: Adding a custom/preview target toolchain (example: ESP32-C5)*
20+
21+
Step 2: Configure CMake Toolchain
22+
---------------------------------
23+
1. Navigate to Preferences → C/C++ → CMake.
24+
2. Click on Add….
25+
3. Browse and select the CMake toolchain file for your target (e.g. `toolchain-esp32c5.cmake`).
26+
4. Choose the corresponding toolchain entry created in Step 1.
27+
5. Click Finish.
28+
29+
.. image:: ../../../media/toolchain/toolchain_2.png
30+
:alt: CMake Toolchain Preferences (Add Custom Target)
31+
32+
*CMake Toolchain Preferences: Adding a custom/preview target toolchain file (example: ESP32-C5)*
33+
34+
Step 3: Add Launch Target
35+
-------------------------
36+
1. From the IDE's top toolbar target list, click on New Launch Target.
37+
2. Select ESP Target.
38+
3. Provide the following details:
39+
- **Name:** (e.g. `esp32c5`)
40+
- **IDF Target:** (e.g. `esp32c5`)
41+
4. Click Finish.
42+
43+
.. image:: ../../../media/toolchain/toolchain_3.png
44+
:alt: New ESP Target Dialog (Custom Target Example)
45+
46+
*New ESP Target Dialog: Creating a launch target for a custom/preview target (example: ESP32-C5)*
47+
48+
Step 4: Build a Project
49+
-----------------------
50+
- Create or open a project.
51+
- Select your custom/preview target from the target list.
52+
- Build the project.
53+
54+
.. image:: ../../../media/toolchain/toolchain_4.png
55+
:alt: Build Output for Custom Target Project
56+
57+
*Build Output: Successfully building a project for a custom/preview target (example: ESP32-C5)*

docs/en/buildproject.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,6 @@ References
4040
.. toctree::
4141
:maxdepth: 1
4242

43-
Configure CDT Build Environment Variables<additionalfeatures/configureenvvariables>
43+
Configure CDT Build Environment Variables <additionalfeatures/configureenvvariables>
44+
Add a Preview or Custom ESP-IDF Target <additionalfeatures/configuretoolchain>
45+

media/toolchain/toolchain_1.png

1.05 MB
Loading

media/toolchain/toolchain_2.png

678 KB
Loading

media/toolchain/toolchain_3.png

296 KB
Loading

media/toolchain/toolchain_4.png

1.74 MB
Loading

0 commit comments

Comments
 (0)