Skip to content

Commit 6f950ac

Browse files
brianignacio5brianignacio5
committed
move IDF_PATH to workspace state, move frameworks settings to customExtraVars
1 parent b35a454 commit 6f950ac

File tree

79 files changed

+765
-1235
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+765
-1235
lines changed

‎README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ Press <kbd>F1</kbd> or click menu `View` -> `Command Palette...` to show Visual
167167
<tr>
168168
<td rowspan=11 align="center">Basic</td>
169169
<td>Show Example Projects</td>
170-
<td>Launch UI to show examples from selected framework and allow you to create a project from them. This command will show frameworks already configured in the extension, so to view ESP-Rainmaker examples, you need to run the <strong>Install ESP-Rainmaker</strong> first (or set the equivalent setting idf.espRainmakerPath), and then execute this command to see the examples.</td>
170+
<td>Launch UI to show examples from selected framework and allow you to create a project from them. This command will show frameworks already configured in the extension, so to view ESP-Rainmaker examples, you need to run the <strong>Install ESP-Rainmaker</strong> first (or set the equivalent setting RMAKER_PATH in idf.customExtraVars), and then execute this command to see the examples.</td>
171171
<td></td>
172172
<td></td>
173173
</tr>
@@ -235,7 +235,7 @@ Press <kbd>F1</kbd> or click menu `View` -> `Command Palette...` to show Visual
235235
<tr>
236236
<td rowspan=5 align="center">Project creation</td>
237237
<td>Show Example Projects</td>
238-
<td>Launch UI to show examples from selected framework and allow you to create a project from them. This command will show frameworks already configured in the extension, so to view ESP-Rainmaker examples, you need to run the <strong>Install ESP-Rainmaker</strong> first (or set the equivalent setting idf.espRainmakerPath), and then execute this command to see the examples.</td>
238+
<td>Launch UI to show examples from selected framework and allow you to create a project from them. This command will show frameworks already configured in the extension, so to view ESP-Rainmaker examples, you need to run the <strong>Install ESP-Rainmaker</strong> first (or set the equivalent setting RMAKER_PATH in idf.customExtraVars), and then execute this command to see the examples.</td>
239239
<td></td>
240240
<td></td>
241241
</tr>
@@ -335,7 +335,7 @@ Press <kbd>F1</kbd> or click menu `View` -> `Command Palette...` to show Visual
335335
<tr>
336336
<td rowspan=8 align="center">Additional frameworks</td>
337337
<td>Install ESP-ADF</td>
338-
<td>Clone ESP-ADF inside the selected directory and set <strong>idf.espAdfPath</strong> (<strong>idf.espAdfPathWin</strong> in Windows) configuration setting.</td>
338+
<td>Clone ESP-ADF inside the selected directory and set ADF_PATH in <strong>idf.customExtraVars</strong> configuration setting.</td>
339339
<td></td>
340340
<td></td>
341341
</tr>
@@ -354,13 +354,13 @@ Press <kbd>F1</kbd> or click menu `View` -> `Command Palette...` to show Visual
354354
</tr>
355355
<tr>
356356
<td>Install ESP-MDF</td>
357-
<td>Clone ESP-MDF inside the selected directory and set <strong>idf.espMdfPath</strong> (<strong>idf.espMdfPathWin</strong> in Windows) configuration setting.</td>
357+
<td>Clone ESP-MDF inside the selected directory and set MDF_PATH in <strong>idf.customExtraVars</strong> configuration setting.</td>
358358
<td></td>
359359
<td></td>
360360
</tr>
361361
<tr>
362362
<td>Install ESP-Matter</td>
363-
<td>Clone ESP-Matter and set <strong>idf.espMatterPath</strong>. ESP-Matter is not supported in Windows. Make sure to install <a href="https://github.com/espressif/connectedhomeip/blob/v1.1-branch/docs/guides/BUILDING.md#prerequisites">Matter system prerequisites</a> first.</td>
363+
<td>Clone ESP-Matter and set ESP_MATTER_PATH in <strong>idf.customExtraVars</strong>. ESP-Matter is not supported in Windows. Make sure to install <a href="https://github.com/espressif/connectedhomeip/blob/v1.1-branch/docs/guides/BUILDING.md#prerequisites">Matter system prerequisites</a> first.</td>
364364
<td></td>
365365
<td></td>
366366
</tr>
@@ -372,13 +372,13 @@ Press <kbd>F1</kbd> or click menu `View` -> `Command Palette...` to show Visual
372372
</tr>
373373
<tr>
374374
<td>Install ESP-Rainmaker</td>
375-
<td>Clone ESP-Rainmaker and set <strong>idf.espRainmakerPath</strong> (<strong>idf.espRainmakerPathWin</strong> in Windows) configuration setting.</td>
375+
<td>Clone ESP-Rainmaker and set RMAKER_PATH in <strong>idf.customExtraVars</strong>.</td>
376376
<td></td>
377377
<td></td>
378378
</tr>
379379
<tr>
380380
<td>Install ESP-HomeKit-SDK</td>
381-
<td>Clone ESP-HomeKit-SDK inside the selected directory and set <strong>idf.espHomeKitSdkPath</strong> (<strong>idf.espHomeKitSdkPathWin</strong> in Windows) configuration setting.</td>
381+
<td>Clone ESP-HomeKit-SDK inside the selected directory and set HOMEKIT_PATH in <strong>idf.customExtraVars</strong> configuration setting.</td>
382382
<td></td>
383383
<td></td>
384384
</tr>

‎README_CN.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ ESP-IDF 扩展在 VS Code 底部蓝色窗口的状态栏中提供了一系列命
167167
<tr>
168168
<td rowspan=11 align="center">基础命令</td>
169169
<td>展示示例项目</td>
170-
<td>启动 UI 以显示所选框架的示例，可从中创建新项目。此命令将显示扩展中已配置的框架，如果想查看 ESP-Rainmaker 示例，需要先运行 <strong>安装 ESP-Rainmaker</strong> 命令（或设置相应的 idf.espRainmakerPath），然后执行此命令以查看示例。</td>
170+
<td>启动 UI 以显示所选框架的示例，可从中创建新项目。此命令将显示扩展中已配置的框架，如果想查看 ESP-Rainmaker 示例，需要先运行 <strong>安装 ESP-Rainmaker</strong> 命令（或设置相应的 RMAKER_PATH 在 idf.customExtraVars），然后执行此命令以查看示例。</td>
171171
<td></td>
172172
<td></td>
173173
</tr>
@@ -235,7 +235,7 @@ ESP-IDF 扩展在 VS Code 底部蓝色窗口的状态栏中提供了一系列命
235235
<tr>
236236
<td rowspan=5 align="center">创建项目</td>
237237
<td>展示示例项目</td>
238-
<td>启动 UI 以显示所选框架的示例，可从中创建新项目。此命令将显示扩展中已配置的框架，如果想查看 ESP-Rainmaker 示例，需要先运行 <strong>安装 ESP-Rainmaker</strong> 命令（或设置相应的 idf.espRainmakerPath），然后执行此命令以查看示例。</td>
238+
<td>启动 UI 以显示所选框架的示例，可从中创建新项目。此命令将显示扩展中已配置的框架，如果想查看 ESP-Rainmaker 示例，需要先运行 <strong>安装 ESP-Rainmaker</strong> 命令（或设置相应的 RMAKER_PATH 在 idf.customExtraVars），然后执行此命令以查看示例。</td>
239239
<td></td>
240240
<td></td>
241241
</tr>
@@ -335,7 +335,7 @@ ESP-IDF 扩展在 VS Code 底部蓝色窗口的状态栏中提供了一系列命
335335
<tr>
336336
<td rowspan=8 align="center">可集成软件框架</td>
337337
<td>安装 ESP-ADF</td>
338-
<td>在所选目录中克隆 ESP-ADF，并配置 <strong>idf.espAdfPath</strong>（Windows 系统中为 <strong>idf.espAdfPathWin</strong>）。</td>
338+
<td>在所选目录中克隆 ESP-ADF，并配置 ADF_PATH 在 <strong>idf.customExtraVars</strong>。</td>
339339
<td></td>
340340
<td></td>
341341
</tr>
@@ -354,13 +354,13 @@ ESP-IDF 扩展在 VS Code 底部蓝色窗口的状态栏中提供了一系列命
354354
</tr>
355355
<tr>
356356
<td>安装 ESP-MDF</td>
357-
<td>在所选目录中克隆 ESP-MDF，并配置 <strong>idf.espMdfPath</strong>（Windows 系统中为 <strong>idf.espMdfPathWin</strong>）。</td>
357+
<td>在所选目录中克隆 ESP-MDF，并配置 MDF_PATH 在 <strong>idf.customExtraVars</strong>。</td>
358358
<td></td>
359359
<td></td>
360360
</tr>
361361
<tr>
362362
<td>安装 ESP-Matter</td>
363-
<td>克隆 ESP-Matter 并配置 <strong>idf.espMatterPath</strong>。Windows 系统不支持 ESP-Matter。运行该命令前请确保已安装 <a href="https://github.com/espressif/connectedhomeip/blob/v1.1-branch/docs/guides/BUILDING.md#prerequisites">Matter 系统依赖项</a>。</td>
363+
<td>克隆 ESP-Matter 并配置 ESP_MATTER_PATH 在 <strong>idf.customExtraVars</strong>。Windows 系统不支持 ESP-Matter。运行该命令前请确保已安装 <a href="https://github.com/espressif/connectedhomeip/blob/v1.1-branch/docs/guides/BUILDING.md#prerequisites">Matter 系统依赖项</a>。</td>
364364
<td></td>
365365
<td></td>
366366
</tr>
@@ -372,13 +372,13 @@ ESP-IDF 扩展在 VS Code 底部蓝色窗口的状态栏中提供了一系列命
372372
</tr>
373373
<tr>
374374
<td>安装 ESP-Rainmaker</td>
375-
<td>克隆 ESP-Rainmaker，并配置 <strong>idf.espRainmakerPath</strong>（Windows 系统中为 <strong>idf.espRainmakerPathWin</strong>）。</td>
375+
<td>克隆 ESP-Rainmaker，并配置 RMAKER_PATH 在 <strong>idf.customExtraVars</strong>。</td>
376376
<td></td>
377377
<td></td>
378378
</tr>
379379
<tr>
380380
<td>安装 ESP-HomeKit-SDK</td>
381-
<td>在所选目录中克隆 ESP-HomeKit-SDK，并配置 <strong>idf.espHomeKitSdkPath</strong>（Windows 系统中为 <strong>idf.espHomeKitSdkPathWin</strong>）。</td>
381+
<td>在所选目录中克隆 ESP-HomeKit-SDK，并配置 HOMEKIT_PATH 在 <strong>idf.customExtraVars</strong>。</td>
382382
<td></td>
383383
<td></td>
384384
</tr>

‎docs_espressif/en/commands.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,17 +65,17 @@ All commands start with ``ESP-IDF:``.
6565
* - Import ESP-IDF Project
6666
- Import an existing ESP-IDF project, add .vscode and .devcontainer files to a new location, and optionally rename the project.
6767
* - Install ESP-ADF
68-
- Clone ESP-ADF inside the selected directory and set **idf.espAdfPath** (**idf.espAdfPathWin** in Windows) configuration setting.
68+
- Clone ESP-ADF inside the selected directory and set **ADF_PATH** in **idf.customExtraVars** configuration setting.
6969
* - Install ESP-IDF Python Packages (DEPRECATION NOTICE)
7070
- Install extension Python packages. This command is deprecated and will be removed soon.
7171
* - Install ESP-MDF
72-
- Clone ESP-MDF inside the selected directory and set **idf.espMdfPath** (**idf.espMdfPathWin** in Windows) configuration setting.
72+
- Clone ESP-MDF inside the selected directory and set **MDF_PATH** in **idf.customExtraVars** configuration setting.
7373
* - Install ESP-Matter
74-
- Clone ESP-Matter and set **idf.espMatterPath**. ESP-Matter is not supported on Windows.
74+
- Clone ESP-Matter and set **ESP_MATTER_PATH** in **idf.customExtraVars**. ESP-Matter is not supported on Windows.
7575
* - Install ESP-Rainmaker
76-
- Clone ESP-Rainmaker and set **idf.espRainmakerPath** (**idf.espRainmakerPathWin** in Windows) configuration setting.
76+
- Clone ESP-Rainmaker and set **RMAKER_PATH** in **idf.customExtraVars** configuration setting.
7777
* - Install ESP-HomeKit-SDK
78-
- Clone ESP-HomeKit-SDK inside the selected directory and set **idf.espHomeKitSdkPath** (**idf.espHomeKitSdkPathWin** in Windows) configuration setting.
78+
- Clone ESP-HomeKit-SDK inside the selected directory and set **HOMEKIT_PATH** in **idf.customExtraVars** configuration setting.
7979
* - Launch IDF Monitor for Core Dump Mode/GDB Stub Mode
8080
- Launch ESP-IDF Monitor with WebSocket capabilities. If you have configured the panic handler to gdbstub or core dump, the monitor will launch a post-mortem debug session of the chip.
8181
* - Launch QEMU Server
@@ -125,7 +125,7 @@ All commands start with ``ESP-IDF:``.
125125
* - Set ESP-MATTER Device Path (ESP_MATTER_DEVICE_PATH)
126126
- The **ESP-IDF: Set ESP-MATTER Device Path (ESP_MATTER_DEVICE_PATH)** is used to define the device path for ESP-Matter. ESP-Matter is not supported in Windows.
127127
* - Show Example Projects
128-
- Launch UI to show examples from selected framework and allow you to create a project from them. This command will show frameworks already configured in the extension. To view ESP-Rainmaker examples, you need to run the **Install ESP-Rainmaker** first (or set the equivalent setting idf.espRainmakerPath), and then execute this command to see the examples.
128+
- Launch UI to show examples from selected framework and allow you to create a project from them. This command will show frameworks already configured in the extension. To view ESP-Rainmaker examples, you need to run the **Install ESP-Rainmaker** first (or set the equivalent setting RMAKER_PATH in idf.customExtraVars), and then execute this command to see the examples.
129129
* - Show Ninja Build Summary
130130
- Execute the Chromium ninja-build-summary.py.
131131
* - Size Analysis of the Binaries

‎docs_espressif/en/settings.rst

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -254,20 +254,6 @@ These settings support additional frameworks together with ESP-IDF:
254254

255255
* - Setting ID
256256
- Description
257-
* - **idf.espAdfPath**
258-
- Path to locate ESP-ADF framework (ADF_PATH)
259-
* - **idf.espAdfPathWin**
260-
- Path to locate ESP-ADF framework in Windows (ADF_PATH)
261-
* - **idf.espMdfPath**
262-
- Path to locate ESP-MDF framework (MDF_PATH)
263-
* - **idf.espMdfPathWin**
264-
- Path to locate ESP-MDF framework in Windows (MDF_PATH)
265-
* - **idf.espMatterPath**
266-
- Path to locate ESP-Matter framework (ESP_MATTER_PATH)
267-
* - **idf.espRainmakerPath**
268-
- Path to locate ESP-Rainmaker framework in Windows (RMAKER_PATH)
269-
* - **idf.espRainmakerPathWin**
270-
- Path to locate ESP-Rainmaker framework in Windows (RMAKER_PATH)
271257
* - **idf.sbomFilePath**
272258
- Path to create ESP-IDF SBOM report
273259

‎docs_espressif/zh_CN/commands.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,17 +65,17 @@
6565
* - 导入 ESP-IDF 项目
6666
- 导入现有的 ESP-IDF 项目，在新位置添加 .vscode 和 .devcontainer 文件，同时可以重命名项目。
6767
* - 安装 ESP-ADF
68-
- 在所选目录中克隆 ESP-ADF，并配置 **idf.espAdfPath**（Windows 系统中为 **idf.espAdfPathWin**）。
68+
- 在所选目录中克隆 ESP-ADF，并配置 **ADF_PATH** 在 **idf.customExtraVars**。
6969
* - 安装 ESP-IDF Python 包（已弃用）
7070
- 安装扩展 Python 包。本命令已弃用，即将被移除。
7171
* - 安装 ESP-MDF
72-
- 在所选目录中克隆 ESP-MDF，并配置 **idf.espMdfPath**（Windows 系统中为 **idf.espMdfPathWin**）。
72+
- 在所选目录中克隆 ESP-MDF，并配置 **MDF_PATH** 在 **idf.customExtraVars**。
7373
* - 安装 ESP-Matter
74-
- 克隆 ESP-Matter 并设置 **idf.espMatterPath**。ESP-Matter 不支持 Windows。
74+
- 克隆 ESP-Matter 并设置 **ESP_MATTER_PATH** 在 **idf.customExtraVars**。ESP-Matter 不支持 Windows。
7575
* - 安装 ESP-Rainmaker
76-
- 克隆 ESP-Rainmaker，并配置 **idf.espRainmakerPath**（Windows 系统中为 **idf.espRainmakerPathWin**）。
76+
- 克隆 ESP-Rainmaker，并配置 **RMAKER_PATH** 在 **idf.customExtraVars**。
7777
* - 安装 ESP-HomeKit-SDK
78-
- 在所选目录中克隆 ESP-HomeKit-SDK，并配置 **idf.espHomeKitSdkPath**（Windows 系统中为 **idf.espHomeKitSdkPathWin**）。
78+
- 在所选目录中克隆 ESP-HomeKit-SDK，并配置 **HOMEKIT_PATH** 在 **idf.customExtraVars**。
7979
* - 启动 IDF 监视器以支持 Core Dump 模式/GDB Stub 模式
8080
- 启动支持 WebSocket 的 ESP-IDF 监控器。如果紧急处理程序已经配置为 gdbstub 或核心转储，监控器将启动芯片的事后调试会话。
8181
* - 启动 QEMU 服务器
@@ -125,7 +125,7 @@
125125
* - 设置 ESP-MATTER 设备路径 (ESP_MATTER_DEVICE_PATH)
126126
- **ESP-IDF：设置 ESP-MATTER 设备路径 (ESP_MATTER_DEVICE_PATH)** 命令用于定义 ESP-Matter 的设备路径。Windows 系统不支持 ESP-Matter。
127127
* - 展示示例项目
128-
- 启动 UI 以显示所选框架的示例，可从中创建新项目。此命令将显示扩展中已配置的框架，如果想查看 ESP-Rainmaker 示例，需要先运行 **安装 ESP-Rainmaker** 命令（或设置相应的 idf.espRainmakerPath），然后执行此命令以查看示例。
128+
- 启动 UI 以显示所选框架的示例，可从中创建新项目。此命令将显示扩展中已配置的框架，如果想查看 ESP-Rainmaker 示例，需要先运行 **安装 ESP-Rainmaker** 命令（或设置相应的 RMAKER_PATH 在 idf.customExtraVars），然后执行此命令以查看示例。
129129
* - 显示 Ninja 构建摘要
130130
- 运行 Chromium ninja-build-summary.py。
131131
* - 二进制文件大小分析

‎docs_espressif/zh_CN/settings.rst

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -265,20 +265,6 @@ QEMU 相关设置
265265

266266
* - 设置 ID
267267
- 描述
268-
* - **idf.espAdfPath**
269-
- 定位 ESP-ADF 框架的路径 (ADF_PATH)
270-
* - **idf.espAdfPathWin**
271-
- 在 Windows 系统中定位 ESP-ADF 框架的路径 (ADF_PATH)
272-
* - **idf.espMdfPath**
273-
- 定位 ESP-MDF 框架的路径 (MDF_PATH)
274-
* - **idf.espMdfPathWin**
275-
- 在 Windows 系统中定位 ESP-MDF 框架的路径 (MDF_PATH)
276-
* - **idf.espMatterPath**
277-
- 定位 ESP-Matter 框架的路径 (ESP_MATTER_PATH)
278-
* - **idf.espRainmakerPath**
279-
- 定位 ESP-Rainmaker 框架的路径 (RMAKER_PATH)
280-
* - **idf.espRainmakerPathWin**
281-
- 在 Windows 系统中定位 ESP-Rainmaker 框架的路径 (RMAKER_PATH)
282268
* - **idf.sbomFilePath**
283269
- 创建 ESP-IDF SBOM 报告的路径
284270

‎package.json

Lines changed: 3 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -589,58 +589,10 @@
589589
"description": "%param.eimIdfJsonPath%",
590590
"scope": "application"
591591
},
592-
"idf.espAdfPath": {
592+
"idf.currentSetup": {
593593
"type": "string",
594-
"default": "${env:ADF_PATH}",
595-
"description": "%param.espAdfPath%",
596-
"scope": "resource"
597-
},
598-
"idf.espMdfPath": {
599-
"type": "string",
600-
"default": "${env:MDF_PATH}",
601-
"description": "%param.espMdfPath%",
602-
"scope": "resource"
603-
},
604-
"idf.espMatterPath": {
605-
"type": "string",
606-
"default": "${env:ESP_MATTER_PATH}",
607-
"description": "%param.espMatterPath%",
608-
"scope": "resource"
609-
},
610-
"idf.espHomeKitSdkPath": {
611-
"type": "string",
612-
"default": "${env:HOMEKIT_PATH}",
613-
"description": "%param.espHomeKitSdkPath%",
614-
"scope": "resource"
615-
},
616-
"idf.espRainmakerPath": {
617-
"type": "string",
618-
"default": "${env:RMAKER_PATH}",
619-
"description": "%param.espRainmakerPath%",
620-
"scope": "resource"
621-
},
622-
"idf.espAdfPathWin": {
623-
"type": "string",
624-
"default": "${env:ADF_PATH}",
625-
"description": "%param.espAdfPath%",
626-
"scope": "resource"
627-
},
628-
"idf.espMdfPathWin": {
629-
"type": "string",
630-
"default": "${env:MDF_PATH}",
631-
"description": "%param.espMdfPath%",
632-
"scope": "resource"
633-
},
634-
"idf.espRainmakerPathWin": {
635-
"type": "string",
636-
"default": "${env:RMAKER_PATH}",
637-
"description": "%param.espRainmakerPath%",
638-
"scope": "resource"
639-
},
640-
"idf.espHomeKitSdkPathWin": {
641-
"type": "string",
642-
"default": "${env:HOMEKIT_PATH}",
643-
"description": "%param.espHomeKitSdkPath%",
594+
"default": "",
595+
"description": "%param.currentSetup%",
644596
"scope": "resource"
645597
},
646598
"idf.port": {

0 commit comments

Comments
 (0)