Skip to content

Commit

Permalink
rm settings use customExtraVars instead
Browse files Browse the repository at this point in the history
  • Loading branch information
brianignacio5 committed Dec 26, 2024
1 parent ce409d0 commit 5d0c552
Show file tree
Hide file tree
Showing 72 changed files with 542 additions and 1,465 deletions.
2 changes: 0 additions & 2 deletions docs_espressif/en/additionalfeatures/docker-container.rst
Original file line number Diff line number Diff line change
Expand Up @@ -204,8 +204,6 @@ For more information about ``devcontainer.json``, please refer to the comments.
*/
"settings": {
"terminal.integrated.defaultProfile.linux": "bash",
"idf.espIdfPath": "/opt/esp/idf",
"idf.toolsPath": "/opt/esp",
"idf.gitPath": "/usr/bin/git"
},
/* An array of extensions that should be installed into the container. */
Expand Down
2 changes: 0 additions & 2 deletions docs_espressif/en/additionalfeatures/multiple-projects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ Projects folders (Known in vscode as workspace folders) and workspace level sett
],
"settings": {
"idf.port": "/dev/ttyUSB1",
"idf.espIdfPath": "${env:HOME}/esp/esp-idf"
}
}
Expand Down Expand Up @@ -75,7 +74,6 @@ and ``my-ws.code-workspace``:
],
"settings": {
"idf.port": "/dev/ttyUSB1",
"idf.espIdfPath": "${env:HOME}/esp/esp-idf"
}
}
Expand Down
6 changes: 2 additions & 4 deletions docs_espressif/en/configureproject.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,12 @@ The file looks like this:
"compilerPath": "/path/to/toolchain-gcc",
"compileCommands": "${workspaceFolder}/build/compile_commands.json",
"includePath": [
"${config:idf.espIdfPath}/components/**",
"${config:idf.espIdfPathWin}/components/**",
"/path/to/esp-idf/components/**",
"${workspaceFolder}/**"
],
"browse": {
"path": [
"${config:idf.espIdfPath}/components",
"${config:idf.espIdfPathWin}/components",
"/path/to/esp-idf/components",
"${workspaceFolder}"
]
}
Expand Down
15 changes: 2 additions & 13 deletions docs_espressif/en/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,26 +50,15 @@ These are the configuration settings that ESP-IDF extension contributes to your
- Enable CCache in build task (make sure CCache is in PATH)
* - idf.enableIdfComponentManager
- Enable IDF Component manager in build command
* - idf.espIdfPath
- Path to locate ESP-IDF framework (IDF_PATH)
* - idf.espIdfPathWin
- Path to locate ESP-IDF framework in Windows (IDF_PATH)
* - idf.ninjaArgs
- Arguments for Ninja build task
* - idf.pythonInstallPath
- System Python absolute path used to compute ESP-IDF Python virtual environment
* - idf.toolsPath
- Path to locate ESP-IDF Tools (IDF_TOOLS_PATH)
* - idf.toolsPathWin
- Path to locate ESP-IDF Tools in Windows (IDF_TOOLS_PATH)

This is how the extension uses them:

1. **idf.customExtraVars** stores any custom environment variable such as OPENOCD_SCRIPTS, which is the openOCD scripts directory used in OpenOCD server startup. These variables are loaded to this extension command's process environment variables, choosing the extension variable if available, else extension commands will try to use what is already in your system PATH. **This doesn't modify your system environment outside Visual Studio Code.**
2. **idf.espIdfPath** (or **idf.espIdfPathWin** in Windows) is used to store ESP-IDF directory path within our extension. We override Visual Studio Code process IDF_PATH if this value is available. **This doesn't modify your system environment outside Visual Studio Code.**. It is also used to compute the list of ESP-IDF tools to add to environment variable PATH and the Python virtual environment path together from **idf.toolsPath** and **idf.pythonInstallPath**.
3. **idf.pythonInstallPath** is the system Python absolute path used to compute ESP-IDF Python virtual environment from **idf.toolsPath** and **idf.espIdfPath** where ESP-IDF Python packages will be installed and used.
4. **idf.gitPath** (or **idf.gitPathWin** in Windows) is used in the extension to clone ESP-IDF master version or the additional supported frameworks such as ESP-ADF, ESP-MDF and Arduino-ESP32.
5. **idf.toolsPath** (or **idf.toolsPathWin** in Windows) is used to compute the list of ESP-IDF tools to add to environment variable PATH and the Python virtual environment path together from **idf.pythonInstallPath** and **idf.espIdfPath**.
2. **idf.gitPath** (or **idf.gitPathWin** in Windows) is used in the extension to clone ESP-IDF master version or the additional supported frameworks such as ESP-ADF, ESP-MDF and Arduino-ESP32.

.. note::

Expand Down Expand Up @@ -286,4 +275,4 @@ Use of Environment Variables in ESP-IDF ``settings.json`` and ``tasks.json``

Environment (env) variables and other ESP-IDF settings (config) can be referenced in ESP-IDF settings using the syntax ``${env:VARNAME}`` and ``${config:ESPIDFSETTING}``, respectively.

For example, to use ``"~/esp/esp-idf"``, set the value of **idf.espIdfPath** to ``"${env:HOME}/esp/esp-idf"``.
For example, to use ``"~/workspace/blink"``, set the value to ``"${env:HOME}/workspace/blink"``.
1 change: 0 additions & 1 deletion l10n/bundle.l10n.es.json
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,6 @@
"Install ESP-Rainmaker": "Instalar ESP-Rainmaker",
"Project Configuration editor": "Editor de configuración del proyecto",
"Select Project Configuration": "Seleccione Configuración del proyecto",
"Install Extension Python Requirements": "Instalar la extensión Requisitos de Python",
"Install ESP-Matter Python Requirements": "Instalar los requisitos de ESP-Matter Python",
"Add .vscode subdirectory files": "Agregar archivos de subdirectorio .vscode",
"Add .devcontainer subdirectory files": "Agregar archivos de subdirectorio .devcontainer",
Expand Down
1 change: 0 additions & 1 deletion l10n/bundle.l10n.pt.json
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,6 @@
"Install ESP-Rainmaker": "Instale ESP-Rainmaker",
"Project Configuration editor": "Editor de configuração do projeto",
"Select Project Configuration": "Selecione Configuração do Projeto",
"Install Extension Python Requirements": "Instalar requisitos de extensão Python",
"Install ESP-Matter Python Requirements": "Instale os requisitos do ESP-Matter Python",
"Add .vscode subdirectory files": "Adicionar arquivos de subdiretório .vscode",
"Add .devcontainer subdirectory files": "Adicionar arquivos de subdiretório .devcontainer",
Expand Down
1 change: 0 additions & 1 deletion l10n/bundle.l10n.ru.json
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,6 @@
"Install ESP-Rainmaker": "Установите ESP-Rainmaker",
"Project Configuration editor": "Редактор конфигурации проекта",
"Select Project Configuration": "Выберите конфигурацию проекта",
"Install Extension Python Requirements": "Установить требования Python к расширению",
"Install ESP-Matter Python Requirements": "Установите требования ESP-Matter Python",
"Add .vscode subdirectory files": "Добавьте файлы подкаталога .vscode.",
"Add .devcontainer subdirectory files": "Добавьте файлы подкаталога .devcontainer.",
Expand Down
1 change: 0 additions & 1 deletion l10n/bundle.l10n.zh-CN.json
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,6 @@
"Install ESP-Rainmaker": "安装 ESP-Rainmaker",
"Project Configuration editor": "项目配置编辑器",
"Select Project Configuration": "选择项目配置",
"Install Extension Python Requirements": "为扩展安装 Python 依赖包",
"Install ESP-Matter Python Requirements": "为 ESP-Matter 安装 Python 依赖包",
"Add .vscode subdirectory files": "添加 .vscode 子目录文件",
"Add .devcontainer subdirectory files": "添加 .devcontainer 子目录文件",
Expand Down
35 changes: 0 additions & 35 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -589,12 +589,6 @@
"description": "%param.eimIdfJsonPath%",
"scope": "application"
},
"idf.espIdfPath": {
"type": "string",
"default": "${env:IDF_PATH}",
"description": "%param.espIdfPath%",
"scope": "resource"
},
"idf.espAdfPath": {
"type": "string",
"default": "${env:ADF_PATH}",
Expand All @@ -619,24 +613,12 @@
"description": "%param.espHomeKitSdkPath%",
"scope": "resource"
},
"idf.toolsPath": {
"type": "string",
"default": "${env:IDF_TOOLS_PATH}",
"description": "%param.toolsPath%",
"scope": "resource"
},
"idf.espRainmakerPath": {
"type": "string",
"default": "${env:RMAKER_PATH}",
"description": "%param.espRainmakerPath%",
"scope": "resource"
},
"idf.espIdfPathWin": {
"type": "string",
"default": "${env:IDF_PATH}",
"description": "%param.espIdfPath%",
"scope": "resource"
},
"idf.espAdfPathWin": {
"type": "string",
"default": "${env:ADF_PATH}",
Expand All @@ -649,12 +631,6 @@
"description": "%param.espMdfPath%",
"scope": "resource"
},
"idf.toolsPathWin": {
"type": "string",
"default": "${env:IDF_TOOLS_PATH}",
"description": "%param.toolsPath%",
"scope": "resource"
},
"idf.espRainmakerPathWin": {
"type": "string",
"default": "${env:RMAKER_PATH}",
Expand All @@ -679,12 +655,6 @@
"description": "%param.port%",
"scope": "resource"
},
"idf.pythonInstallPath": {
"type": "string",
"default": "python",
"description": "%param.pythonBinPath%",
"scope": "application"
},
"idf.flashBaudRate": {
"type": "string",
"default": "460800",
Expand Down Expand Up @@ -1478,11 +1448,6 @@
"title": "%espIdf.installEspMatterPyReqs.title%",
"category": "ESP-IDF"
},
{
"command": "espIdf.installPyReqs",
"title": "%espIdf.installPyReqs.title%",
"category": "ESP-IDF"
},
{
"command": "esp.webview.open.partition-table",
"title": "%esp.webview.open.partition-table.title%"
Expand Down
5 changes: 1 addition & 4 deletions package.nls.es.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
"espIdf.importProject.title": "Importar proyecto ESP-IDF",
"espIdf.installEspMatterPyReqs.title": "Instalar paquetes Python de ESP-Matter",
"espIdf.installManager.title": "Abrir el administrador de instalación ESP-IDF",
"espIdf.installPyReqs.title": "Instalar paquetes Python de la extensión ESP-IDF",
"espIdf.jtag_flash.title": "Flashear (con JTag)",
"espIdf.launchQemu.title": "Iniciar servidor QEMU",
"espIdf.launchWSServerAndMonitor.title": "Lanzar monitor IDF para CoreDump / GDB-Stub Mode",
Expand Down Expand Up @@ -116,7 +115,6 @@
"param.esp.rainmaker.oauth.url": "URL del servidor OAuth de ESP-Rainmaker",
"param.espAdfPath": "Ruta para localizar el framework ESP-ADF (ADF_PATH)",
"param.espHomeKitSdkPath": "Ruta para localizar el framework ESP-HomeKit-SDK (HOMEKIT_PATH)",
"param.espIdfPath": "Ruta para localizar el framework ESP-IDF (IDF_PATH)",
"param.espMatterPath": "Ruta para localizar el framework ESP-Matter (ESP_MATTER_PATH)",
"param.espMdfPath": "Ruta para localizar el framework ESP-MDF (MDF_PATH)",
"param.espRainmakerPath": "Ruta para localizar el framework ESP-Rainmaker (RMAKER_PATH)",
Expand Down Expand Up @@ -145,7 +143,6 @@
"param.postFlashTask": "Tarea personalizada posterior al flasheo",
"param.preBuildTask": "Tarea personalizada previa a la construcción",
"param.preFlashTask": "Tarea personalizada previa al flasheo",
"param.pythonBinPath": "Ruta absoluta del binario Python utilizado para ejecutar Scripts de Python de ESP-IDF",
"param.qemuTcpPort": "Puerto tcp de QEMU para comunicación serial",
"param.rainmaker.api.server_url": "URL del servidor en la nube de ESP-Rainmaker",
"param.saveBeforeBuildDescription": "Guardar todos los archivos editados en el espacio de trabajo antes de proceder con la construcción, aunque si no se pueden guardar los archivos, se construirá de todos modos",
Expand Down Expand Up @@ -184,6 +181,6 @@
"view.idf.idfSearchResults": "Resultados de búsqueda de documentación",
"viewContainer.title": "ESP-IDF: Explorador",
"viewWelcome.idfPartitionExplorer": "Muestra la lista de particiones de su dispositivo con la opción de flashear binarios (.bin) en la partición seleccionada.\n\nSeleccione el puerto serial de su dispositivo y haga clic en Actualizar tabla de particiones.",
"viewWelcome.idfSearchResults": "En cualquier editor de archivos abierto, seleccione un texto y haga clic con el botón derecho y seleccione ESP-IDF: Buscar en la documentación para obtener resultados coincidentes aquí.\n\nLos resultados se basan en su idioma actual de VS Code, versión de idf.espIdfPath (si no, la última)",
"viewWelcome.idfSearchResults": "En cualquier editor de archivos abierto, seleccione un texto y haga clic con el botón derecho y seleccione ESP-IDF: Buscar en la documentación para obtener resultados coincidentes aquí.\n\nLos resultados se basan en su idioma actual de VS Code, versión de IDF_PATH (si no, la última)",
"viewWelcome.peripheralView": "Muestra los registros periféricos del archivo SVD definido en la configuración idf.svdFilePath durante la sesión de depuración activa"
}
5 changes: 1 addition & 4 deletions package.nls.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
"espIdf.importProject.title": "Import ESP-IDF Project",
"espIdf.installEspMatterPyReqs.title": "Install ESP-Matter Python Packages",
"espIdf.installManager.title": "Open ESP-IDF Install manager",
"espIdf.installPyReqs.title": "Install ESP-IDF Extension Python Packages",
"espIdf.jtag_flash.title": "Flash (with JTag)",
"espIdf.launchQemu.title": "Launch QEMU Server",
"espIdf.launchWSServerAndMonitor.title": "Launch IDF Monitor for Core Dump Mode/GDB Stub Mode",
Expand Down Expand Up @@ -116,7 +115,6 @@
"param.esp.rainmaker.oauth.url": "ESP-Rainmaker OAuth server URL",
"param.espAdfPath": "Path to locate ESP-ADF framework (ADF_PATH)",
"param.espHomeKitSdkPath": "Path to locate ESP-HomeKit-SDK framework (HOMEKIT_PATH)",
"param.espIdfPath": "Path to locate ESP-IDF framework (IDF_PATH)",
"param.espMatterPath": "Path to locate ESP-Matter framework (ESP_MATTER_PATH)",
"param.espMdfPath": "Path to locate ESP-MDF framework (MDF_PATH)",
"param.espRainmakerPath": "Path to locate ESP-Rainmaker framework (RMAKER_PATH)",
Expand Down Expand Up @@ -145,7 +143,6 @@
"param.postFlashTask": "Post flash custom task",
"param.preBuildTask": "Pre build custom task",
"param.preFlashTask": "Pre flash custom task",
"param.pythonBinPath": "Python absolute binary path used to execute ESP-IDF Python scripts",
"param.qemuTcpPort": "QEMU TCP port for serial communication",
"param.rainmaker.api.server_url": "ESP-Rainmaker cloud server URL",
"param.saveBeforeBuildDescription": "Save all edited files in the workspace before proceeding with the build. If saving fails, the build will proceed regardless",
Expand Down Expand Up @@ -184,6 +181,6 @@
"view.idf.idfSearchResults": "Documentation Search Results",
"viewContainer.title": "ESP-IDF: Explorer",
"viewWelcome.idfPartitionExplorer": "Show the partition list from your device with the option to flash binaries (.bin) to the selected partition.\n\nSelect your device serial port and click Refresh Partition Table.",
"viewWelcome.idfSearchResults": "On any opened file editor, select some text, right click and select ESP-IDF: Search in Documentation to get matching results here.\n\nResults are based on your current VS Code language and idf.espIdfPath version (latest otherwise).",
"viewWelcome.idfSearchResults": "On any opened file editor, select some text, right click and select ESP-IDF: Search in Documentation to get matching results here.\n\nResults are based on your current VS Code language and IDF_PATH version (latest otherwise).",
"viewWelcome.peripheralView": "Show peripheral registers from SVD files defined in ESP-IDF SVD file path (idf.svdFilePath) configuration setting during active debug session."
}
3 changes: 0 additions & 3 deletions package.nls.pt.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
"espIdf.importProject.title": "Importar projeto ESP-IDF",
"espIdf.installEspMatterPyReqs.title": "Instale pacotes ESP-Matter Python",
"espIdf.installManager.title": "Abra o gerenciador de instalação ESP-IDF",
"espIdf.installPyReqs.title": "Instale pacotes Python de extensão ESP-IDF",
"espIdf.jtag_flash.title": "Flash (com JTag)",
"espIdf.launchQemu.title": "Inicie o servidor QEMU",
"espIdf.launchWSServerAndMonitor.title": "Inicie o IDF Monitor para modo CoreDump / GDB-Stub",
Expand Down Expand Up @@ -115,7 +114,6 @@
"param.esp.rainmaker.oauth.url": "URL do servidor ESP-Rainmaker OAuth",
"param.espAdfPath": "Caminho para localizar a estrutura ESP-ADF (ADF_PATH)",
"param.espHomeKitSdkPath": "Caminho para localizar a estrutura ESP-HomeKit-SDK (HOMEKIT_PATH)",
"param.espIdfPath": "Caminho para localizar a estrutura ESP-IDF (IDF_PATH)",
"param.espMatterPath": "Caminho para localizar a estrutura ESP-Matter (ESP_MATTER_PATH)",
"param.espMdfPath": "Caminho para localizar a estrutura ESP-MDF (MDF_PATH)",
"param.espRainmakerPath": "Caminho para localizar a estrutura ESP-Rainmaker (RMAKER_PATH)",
Expand Down Expand Up @@ -144,7 +142,6 @@
"param.postFlashTask": "Tarefa personalizada pós-flash",
"param.preBuildTask": "Tarefa personalizada de pré-construção",
"param.preFlashTask": "Tarefa personalizada pré-flash",
"param.pythonBinPath": "Caminho binário absoluto do Python usado para executar scripts Python ESP-IDF",
"param.qemuTcpPort": "Porta tcp QEMU para comunicação serial",
"param.rainmaker.api.server_url": "URL do servidor em nuvem ESP-Rainmaker",
"param.saveBeforeBuildDescription": "Salve todos os arquivos editados na área de trabalho antes de prosseguir com a compilação, embora se não conseguir salvar os arquivos, a compilação será de qualquer maneira",
Expand Down
3 changes: 0 additions & 3 deletions package.nls.ru.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
"espIdf.importProject.title": "Импортировать проект ESP-IDF",
"espIdf.installEspMatterPyReqs.title": "Установите пакеты Python ESP-Matter",
"espIdf.installManager.title": "Откройте диспетчер установки ESP-IDF.",
"espIdf.installPyReqs.title": "Установите пакеты Python расширения ESP-IDF",
"espIdf.jtag_flash.title": "Flash (с JTag)",
"espIdf.launchQemu.title": "Запустить сервер QEMU",
"espIdf.launchWSServerAndMonitor.title": "Запустите IDF Monitor для режима CoreDump/GDB-Stub.",
Expand Down Expand Up @@ -116,7 +115,6 @@
"param.esp.rainmaker.oauth.url": "URL-адрес сервера OAuth ESP-Rainmaker",
"param.espAdfPath": "Путь для поиска платформы ESP-ADF (ADF_PATH)",
"param.espHomeKitSdkPath": "Путь для поиска платформы ESP-HomeKit-SDK (HOMEKIT_PATH)",
"param.espIdfPath": "Путь для поиска платформы ESP-IDF (IDF_PATH)",
"param.espMatterPath": "Путь для поиска структуры ESP-Matter (ESP_MATTER_PATH)",
"param.espMdfPath": "Путь для поиска платформы ESP-MDF (MDF_PATH)",
"param.espRainmakerPath": "Путь к инфраструктуре ESP-Rainmaker (RMAKER_PATH)",
Expand Down Expand Up @@ -145,7 +143,6 @@
"param.postFlashTask": "Пользовательская задача после прошивки",
"param.preBuildTask": "Предварительная сборка пользовательской задачи",
"param.preFlashTask": "Специальная задача перед прошивкой",
"param.pythonBinPath": "Абсолютный двоичный путь Python, используемый для выполнения сценариев Python ESP-IDF",
"param.qemuTcpPort": "TCP-порт QEMU для последовательной связи",
"param.rainmaker.api.server_url": "URL-адрес облачного сервера ESP-Rainmaker",
"param.saveBeforeBuildDescription": "Сохраните все отредактированные файлы в рабочей области, прежде чем приступить к сборке, хотя, если файлы не удастся сохранить, сборка все равно будет выполнена.",
Expand Down
1 change: 0 additions & 1 deletion package.nls.zh-CN.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
"espIdf.importProject.title": "导入 ESP-IDF 项目",
"espIdf.installEspMatterPyReqs.title": "安装 ESP-Matter Python 包",
"espIdf.installManager.title": "打开 ESP-IDF 安装管理器",
"espIdf.installPyReqs.title": "安装 ESP-IDF 扩展 Python 包",
"espIdf.jtag_flash.title": "通过 JTAG 接口烧录项目",
"espIdf.launchQemu.title": "启动 QEMU 服务器",
"espIdf.launchWSServerAndMonitor.title": "启动 IDF 监视器以支持核心转储模式/GDB 存根模式",
Expand Down
Loading

0 comments on commit 5d0c552

Please sign in to comment.