v1.8.0 release (#1207)

* add changelog * fix workspace folder esp matter bootstrap * fix openOCD settings not updated * add dl espressif pypi pip install * update changelog with whitespaces pr * update readme fix rom elf validation * add esp-idf project validation for menuconfig * clean devcontainer commas add return to isIdfProject * fix gcov html report error handling * select Espressif mirror in locale is chinese * add commands description * ad rainmaker gitee link * add websocket client validation install * fix editor coverage errors * rm setDefaultConfig cmd * fix lint * add troubleshoot form ui * fix l10n lint * removes the ouput of esptool.py to the console inside vscode when using it for device identification (VSC-1378) (#1218) Co-authored-by: Petr Gadorek <petr.gadorek@espressif.com> * fix new project create project empty openocd files * add code coverage link in esp-idf output * fix warning treated as error in py install setup step * add docs in coverage at end of output * fix lint * try catch init check extension settings activation * add rainmaker to new project wizard examples * add dev rimraf for windows clean script * rm device configuration command * rm Configure Paths cmd * update build path in c cpp properties json template * send troubleshoot form as telemetry event * add matter prerequisites to docs * add web extension to codespace settings in devcontainer json * add progress for component install * add flash cmd after build is complete * add hints viewer to changelog * rm esptool from PATH * fix gitee submodules fix esp rainmaker * add debug to status bar items and cmd tree view --------- Co-authored-by: Hahihula <hahihula@gmail.com> Co-authored-by: Petr Gadorek <petr.gadorek@espressif.com>
espressif · Jun 28, 2024 · 2b23ac3 · 2b23ac3
1 parent 4ea0963
commit 2b23ac3
Show file tree

Hide file tree

Showing 68 changed files with 1,994 additions and 687 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,31 @@
 
 All notable changes to the "Espressif IDF" extension will be documented in this file.
 
+## [1.8.0](https://github.com/espressif/vscode-esp-idf-extension/releases/tag/v1.8.0)
+
+### Features and enhancements
+
+- [Add button to enable custom partition when calling Partition table editor](https://github.com/espressif/vscode-esp-idf-extension/pull/1160)
+- [Add ESP-IDF version switcher](https://github.com/espressif/vscode-esp-idf-extension/pull/1173)
+- [Translation using l10n vscode api, remove gulp files](https://github.com/espressif/vscode-esp-idf-extension/pull/1178)
+- [Add Eclipse CDT Debug Adapter and update debugging documentation](https://github.com/espressif/vscode-esp-idf-extension/pull/1131)
+- [Add Chip Id in port selection](https://github.com/espressif/vscode-esp-idf-extension/pull/1195)
+- [Add idf.py reconfigure task as extension command](https://github.com/espressif/vscode-esp-idf-extension/pull/1198)
+- [Add white spaces support for IDF_PATH and extension tasks](https://github.com/espressif/vscode-esp-idf-extension/pull/1159)
+- [Add Hints viewers bar and code editor highlight](https://github.com/espressif/vscode-esp-idf-extension/pull/1225)
+- [Add docs espressif files and workflow](https://github.com/espressif/vscode-esp-idf-extension/pull/1226)
+
+### Bug Fixes
+
+- [Avoid saveDefSdkconfig in all menu items](https://github.com/espressif/vscode-esp-idf-extension/pull/1171) Thanks @ArcticLampyrid
+- [Add clarity to flash placeholder text](https://github.com/espressif/vscode-esp-idf-extension/pull/1142)
+- [Fix output channel interrupt](https://github.com/espressif/vscode-esp-idf-extension/pull/1174)
+- [Fix github tags to retrieve up to 100 tags](https://github.com/espressif/vscode-esp-idf-extension/pull/1196)
+- [Fix and update devcontainer json mount and python setting](https://github.com/espressif/vscode-esp-idf-extension/pull/1200)
+- [Add no ports validation](https://github.com/espressif/vscode-esp-idf-extension/pull/1204)
+- [Update blink example reference in docs](https://github.com/espressif/vscode-esp-idf-extension/pull/1188) Thanks @kowyo
+- [Consistent ESP Component Registry URL](https://github.com/espressif/vscode-esp-idf-extension/pull/1206) Thanks @XDanielPaul
+
 ## [1.7.1](https://github.com/espressif/vscode-esp-idf-extension/releases/tag/v1.7.1)
 
 ### Features and enhancements

diff --git a/README.md b/README.md
diff --git a/docs/FEATURES.md b/docs/FEATURES.md
diff --git a/docs/HARDWARE_SUPPORT.md b/docs/HARDWARE_SUPPORT.md
@@ -24,7 +24,7 @@ In addition to ESP-IDF chips, there are several boards configurations files impl
 
 - [Espressif Mesh Development Framework (ESP-MDF)](https://github.com/espressif/esp-mdf) to develop with the [ESP-WIFI-MESH](https://docs.espressif.com/projects/esp-idf/en/stable/api-guides/mesh.html) networking protocol. The **Install ESP-MDF** will clone ESP-MDF to a selected directory and set `idf.espMdfPath` (`idf.espMdfPathWin` in Windows) configuration setting.
 
-- [Espressif Matter Framework (ESP-Matter)](https://github.com/espressif/esp-matter) to develop with the [Matter](https://buildwithmatter.com/) unified IP-based connectivity protocol. The **Install ESP-Matter** will clone ESP-Matter to a selected directory and set `idf.espMatterPath` configuration setting. **ESP-Matter is Not Supported in Windows**.
+- [Espressif Matter Framework (ESP-Matter)](https://github.com/espressif/esp-matter) to develop with the [Matter](https://buildwithmatter.com/) unified IP-based connectivity protocol. The **Install ESP-Matter** will clone ESP-Matter to a selected directory and set `idf.espMatterPath` configuration setting. **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.
 
 - [Espressif Rainmaker](https://github.com/espressif/esp-rainmaker) can be clone with the **ESP-IDF: Install ESP-Rainmaker** to a selected and set `idf.espRainmakerPath` (`idf.espRainmakerPathWin` in Windows) configuration setting.
 

diff --git a/docs/ONBOARDING.md b/docs/ONBOARDING.md
@@ -22,6 +22,7 @@
 16. [Open Existing ESP-IDF Project](./tutorial/existing_idf_project.md)
 17. [Using the Project Configuration Editor](./tutorial/project_configuration.md)
 18. [Using Multiple Build Configuration with the Project Configuration Editor](./tutorial/multiple_config.md)
+19. [ESP-IDF Hints viewer](./tutorial/hints_viewer.md)
 
 ## Documentation
 

diff --git a/docs/SETTINGS.md b/docs/SETTINGS.md
@@ -4,7 +4,7 @@ This extension contributes the following settings that can be later updated in s
 
 > **NOTE:** Please consider that `~`, `%VARNAME%` and `$VARNAME` are not recognized when set on ANY of this extension configuration settings. You can instead set any environment variable in the path using a `${env:VARNAME}` such as `${env:HOME}` or you can refer to other configuration parameter path with `${config:SETTINGID}` such as `${config:idf.espIdfPath}`.
 
-The `idf.saveScope` allows the user to specify where to save settings when using commands such as `Configure Paths`, `Device Configuration`, `Set Espressif Device Target` and other commands. Possible values are Global (User Settings), Workspace and WorkspaceFolder. For more information please take a look at [Working with Multiple Projects](./MULTI_PROJECTS.md). Use the `Select where to Save Configuration Settings` command to choose where to save settings when using this extension commands.
+The `idf.saveScope` allows the user to specify where to save settings when using commands such as `Set Espressif Device Target` and other commands. Possible values are Global (User Settings), Workspace and WorkspaceFolder. For more information please take a look at [Working with Multiple Projects](./MULTI_PROJECTS.md). Use the `Select where to Save Configuration Settings` command to choose where to save settings when using this extension commands.
 
 > **NOTE:** All settings can be applied to Global (User Settings), Workspace and WorkspaceFolder unless Scope is specified.
 
@@ -68,7 +68,7 @@ This is how the extension uses them:
 1. `idf.adapterTargetName` is used to select the chipset (esp32, esp32s2, esp32s3, esp32c3 and custom) on which to run the extension commands.
    > **NOTE** When you use the command **ESP-IDF: Set Espressif Device Target** it will override `idf.adapterTargetName` with selected chip and `idf.openOcdConfigs` with its default OpenOCD Configuration Files.
    >
-   > > If you want to customize the `idf.openOcdConfigs` alone, you can modify your user settings.json or use **ESP-IDF: Device Configuration** and select `Enter OpenOCD Configuration File Paths List` by entering each file separated by comma ",".
+   > > If you want to customize the `idf.openOcdConfigs` alone, you can use the **ESP-IDF: Select OpenOCD Board Configuration** or modify your settings.json directly.
 2. `idf.customAdapterTargetName` is used when `idf.adapterTargetName` is set to `custom`.
 3. `idf.flashBaudRate` is the baud rate value used for the **ESP-IDF: Flash your Project** command and [ESP-IDF Debug](./DEBUGGING.md).
 4. `idf.monitorBaudRate` is the ESP-IDF Monitor baud rate value and fallback from your project's skdconfig `CONFIG_ESPTOOLPY_MONITOR_BAUD` (idf.py monitor' baud rate). This value can also be override by setting the environment variable `IDF_MONITOR_BAUD` or `MONITORBAUD` in your system environment variables or this extension's `idf.customExtraVars` configuration setting.
@@ -156,14 +156,6 @@ These settings allow to support additional frameworks together with ESP-IDF:
 | `idf.espRainmakerPathWin` | Path to locate ESP-Rainmaker framework in Windows (RMAKER_PATH) |
 | `idf.sbomFilePath`        | Path to create ESP-IDF SBOM report                              |
 
-The **ESP-IDF: Install ESP-ADF** command will clone ESP-ADF and set `idf.espAdfPath` (`idf.espAdfPathWin` in Windows).
-The **ESP-IDF: Install ESP-MDF** command will clone ESP-MDF and set `idf.espMdfPath` (`idf.espMdfPathWin` in Windows).
-The **ESP-IDF: Install ESP-Matter** command will clone ESP-Matter and set `idf.espMatterPath`. 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.
-The **ESP-IDF: Install ESP-Rainmaker** command will clone ESP-Rainmaker and set `idf.espRainmakerPath` (`idf.espRainmakerPathWin` in Windows) configuration setting.
-The **ESP-IDF: Install ESP-HomeKit-SDK** command will clone ESP-HomeKit-SDK inside the selected directory and set `idf.espHomeKitSdkPath` (`idf.espHomeKitSdkPathWin` in Windows) configuration setting.
-
-The **ESP-IDF: Show Examples Projects** command allows you create a new project using one of the examples in ESP-IDF, ESP-ADF, ESP-Matter or ESP-MDF directory if related configuration settings are set, or to create projects from examples found in the ESP Component Registry.
-
 ## Use of Environment Variables in ESP-IDF settings.json and tasks.json
 
 Environment (env) variables and other ESP-IDF settings (config) current values strings can be used in other ESP-IDF setting as `${env:VARNAME}` and `${config:ESPIDFSETTING}`, respectively.

diff --git a/docs/SETUP.md b/docs/SETUP.md
@@ -117,7 +117,7 @@ where:
 Make sure to install the extension and extension debug adapter Python requirements by running the following commands in your terminal:
 
 ```
-PYTHON_INTERPRETER -m pip install --upgrade -r EXTENSION_PATH/esp_debug_adapter/requirements.txt
+PYTHON_INTERPRETER -m pip install --upgrade -r EXTENSION_PATH/esp_debug_adapter/requirements.txt --extra-index-url https://dl.espressif.com/pypi
 ```
 
 where EXTENSION_PATH is

diff --git a/docs/tutorial/additional_frameworks.md b/docs/tutorial/additional_frameworks.md
@@ -8,7 +8,7 @@ Besides ESP-IDF, you can install other frameworks to extend the extension functi
 
 2. [Espressif Mesh Development Framework (ESP-MDF)](https://github.com/espressif/esp-mdf) with this extension using the **Install ESP-MDF** command, which will clone ESP-MDF to the selected directory and set `idf.espMdfPath` (`idf.espMdfPathWin` in Windows) configuration setting.
 
-3. [Espressif Matter Framework (ESP-Matter)](https://github.com/espressif/esp-matter) with this extension using the **Install ESP-Matter** command, which will clone ESP-Matter to the selected directory and set `idf.espMatterPath` configuration setting. 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**.
+3. [Espressif Matter Framework (ESP-Matter)](https://github.com/espressif/esp-matter) with this extension using the **Install ESP-Matter** command, which will clone ESP-Matter to the selected directory and set `idf.espMatterPath` configuration setting. 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**. 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.
 
 4. [Espressif Rainmaker](https://github.com/espressif/esp-rainmaker) can be clone with the **ESP-IDF: Install ESP-Rainmaker** to a selected and set `idf.espRainmakerPath` (`idf.espRainmakerPathWin` in Windows) configuration setting.
 

diff --git a/docs/tutorial/debugging.md b/docs/tutorial/debugging.md
@@ -5,7 +5,7 @@
 This tutorial shows the user how to debug ESP-IDF projects using the Visual Studio Code extension for ESP-IDF. If you haven't configured the extension as explained in [Install tutorial](./install.md) please do it first.
 
 1. Configure, build and flash your project as explained in [Basic use tutorial](./basic_use.md).
-2. Set the proper values for openOCD Configuration files in the `idf.openOCDConfigs` configuration setting. You can choose a specific board listed in openOCD using **ESP-IDF: Select OpenOCD Board Configuration**, **ESP-IDF: Set Espressif Device Target** or use **ESP-IDF: Device Configuration** to manually set any value you desire.
+2. Set the proper values for openOCD Configuration files in the `idf.openOCDConfigs` configuration setting. You can choose a specific board listed in openOCD using **ESP-IDF: Select OpenOCD Board Configuration** or **ESP-IDF: Set Espressif Device Target**.
 
 > **NOTE:** Please take a look at [Configuring of OpenOCD for specific target](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-guides/jtag-debugging/tips-and-quirks.html#configuration-of-openocd-for-specific-target) for more information about these configuration files.
 

diff --git a/docs/tutorial/toc.md b/docs/tutorial/toc.md
@@ -20,3 +20,4 @@
 16. [Open Existing ESP-IDF Project](./existing_idf_project.md)
 17. [Using the Project Configuration](./project_configuration.md) editor.
 18. [Using Multiple Build Configuration with the Project Configuration Editor](./multiple_config.md)
+19. [ESP-IDF Hints viewer](./hints_viewer.md)
diff --git a/l10n/bundle.l10n.es.json b/l10n/bundle.l10n.es.json
@@ -5,7 +5,7 @@
   "File project_description.json cannot be found.": "No se puede encontrar el archivo project_description.json.",
   "Open a folder first.": "Primero abra una carpeta.",
   "Selected command is not available in WebIDE": "El comando seleccionado no está disponible en WebIDE",
-  "Use current folder: {workspace}": "Usar carpeta actual: {workspace}",
+  "Use current folder: {workspace}": "Usar carpeta actual: {espacio de trabajo}",
   "Choose a container directory...": "Elija un directorio de contenedor...",
   "Select a directory to use": "Seleccione un directorio para usar",
   "Select a template to use": "Seleccione una plantilla para usar",
@@ -29,26 +29,12 @@
   "Do not show notifications but focus tasks output.": "No muestre notificaciones, pero centre la salida de las tareas.",
   "Show notifications and focus tasks output.": "Muestra notificaciones y resultados de tareas de enfoque.",
   "Select the output and notification mode": "Seleccione el modo de salida y notificación",
-  "Notification mode has changed to {mode}": "El modo de notificación ha cambiado a {modo}",
-  "Select framework to define its path:": "Seleccione el marco para definir su ruta:",
-  "IDF_PATH Path": "Ruta IDF_PATH",
-  "Set IDF_TOOLS_PATH Path": "Establecer ruta IDF_TOOLS_PATH",
-  "Set paths to append to PATH": "Establecer rutas para agregar a PATH",
-  "No option selected.": "Ninguna opción seleccionada.",
-  "Enter IDF_PATH Path": "Introduzca la ruta IDF_PATH",
-  "Enter IDF_TOOLS_PATH path": "Introduzca la ruta IDF_TOOLS_PATH",
-  "Enter extra paths to append to PATH": "Ingrese rutas adicionales para agregar a PATH",
-  "No path has been updated": "No se ha actualizado ninguna ruta.",
+  "Notification mode has changed to {mode}": "El modo de notificación ha cambiado a {mode}",
   "No project configuration found": "No se encontró ninguna configuración de proyecto",
   "Select configuration to use:": "Seleccione la configuración a utilizar:",
+  "No option selected.": "Ninguna opción seleccionada.",
   "ESP-IDF: Select Project Configuration": "ESP-IDF: Seleccionar configuración del proyecto",
-  "Select option to define its path:": "Seleccione la opción para definir su ruta:",
-  "Relative paths to OpenOCD Scripts directory separated by comma(,)": "Rutas relativas al directorio OpenOCD Scripts separadas por coma (,)",
-  "Enter device port Path": "Introduzca la ruta del puerto del dispositivo",
-  "Enter flash baud rate": "Introduzca la velocidad en baudios del flash",
-  "Enter monitor baud rate": "Introduzca la velocidad en baudios del monitor",
   "Enter OpenOCD Configuration File Paths list": "Ingrese a la lista de rutas de archivos de configuración de OpenOCD",
-  "No device parameter has been updated": "No se ha actualizado ningún parámetro del dispositivo.",
   "Installing ESP-IDF extension Python Requirements...": "Instalación de la extensión ESP-IDF Requisitos de Python...",
   "ESP-IDF Python Requirements has been installed": "Se han instalado los requisitos de ESP-IDF Python",
   "Installing ESP-Matter Python Requirements...": "Instalación de los requisitos de ESP-Matter Python...",
@@ -59,6 +45,7 @@
   "ESP-IDF container files have been added to the project.": "Se han agregado archivos contenedores ESP-IDF al proyecto.",
   "Enter ESP-IDF component name": "Ingrese el nombre del componente ESP-IDF",
   "The ESP-IDF component {componentName} has been created": "Se ha creado el componente ESP-IDF {componentName}",
+  "The current directory is not an ESP-IDF project.": "El directorio actual no es un proyecto ESP-IDF.",
   "ESP-IDF: SDK Configuration Editor": "ESP-IDF: Editor de configuración del SDK",
   "ESP-IDF: Save Default Configuration (save-defconfig)": "ESP-IDF: Guardar configuración predeterminada (save-defconfig)",
   "Enter target name (IDF_TARGET)": "Introduzca el nombre del objetivo (IDF_TARGET)",
@@ -83,6 +70,8 @@
   "Select an action to use": "Seleccione una acción para usar",
   "ESP-IDF: Preparing ESP-IDF extension report": "ESP-IDF: Preparando informe de extensión ESP-IDF",
   "Extension configuration report has been copied to clipboard with errors": "El informe de configuración de la extensión se ha copiado al portapapeles con errores",
+  "No launch.json found.\n             Use the ESP-IDF: Add vscode Configuration Folder command.": "No se encontró launch.json.\n             ",
+  "No gdbtarget configuration found in launch.json.\n           Delete launch.json and use the ESP-IDF: Add vscode Configuration Folder' command.": "No se encontró ninguna configuración de gdbtarget en launch.json.\n           ",
   "Cannot call this command directly, click on any Trace to view its report!": "No se puede llamar a este comando directamente. Haga clic en cualquier seguimiento para ver su informe.",
   "Do you want to view Heap Trace plot or System View Trace": "¿Quiere ver el gráfico de seguimiento del montón o el seguimiento de vista del sistema?",
   "Show System View Tracing Plot (will open a webview window)": "Mostrar gráfico de seguimiento de vista del sistema (se abrirá una ventana de vista web)",
@@ -93,7 +82,7 @@
   "Would you like to unlink your ESP Rainmaker cloud account?": "¿Le gustaría desvincular su cuenta en la nube ESP Rainmaker?",
   "Would you like to delete this node from your ESP Rainmaker account?": "¿Le gustaría eliminar este nodo de su cuenta ESP Rainmaker?",
   "ESP-IDF: Deleting node from your rainmaker account": "ESP-IDF: Eliminando nodo de su cuenta rainmaker",
-  "Failed to delete node, maybe the node is already marked for delete, please try again after sometime": "No se pudo eliminar el nodo, tal vez el nodo ya esté marcado para eliminarse; inténtelo nuevamente después de algún tiempo",
+  "Failed to delete node, maybe the node is already marked for delete, please try again after sometime": "No se pudo eliminar el nodo; tal vez el nodo ya esté marcado para eliminarse; inténtelo nuevamente después de algún tiempo",
   "Coming Soon!! until then you can add nodes using mobile app": "¡¡Muy pronto!! ",
   "Failed to update the param, please try once more": "No se pudo actualizar el parámetro, inténtelo una vez más.",
   "Failed to update param because, ": "No se pudo actualizar el parámetro porque, ",
@@ -133,14 +122,16 @@
   "ESP-IDF: Select Flash Method": "ESP-IDF: seleccione el método Flash",
   "ESP-IDF: Flash Device": "ESP-IDF: Dispositivo flash",
   "ESP-IDF: Monitor Device": "ESP-IDF: Dispositivo de monitoreo",
+  "ESP-IDF: Debug": "ESP-IDF: Depurar",
   "ESP-IDF: Build, Flash and Monitor": "ESP-IDF: construir, flashear y monitorear",
   "ESP-IDF: Open ESP-IDF Terminal": "ESP-IDF: Abrir terminal ESP-IDF",
   "ESP-IDF: Execute Custom Task": "ESP-IDF: ejecutar tarea personalizada",
-  "QEMU is not running. Run first.": "QEMU no se está ejecutando. ",
   "ESP-IDF: Building project": "ESP-IDF: Proyecto de construcción",
   "Select flash method, you can modify the choice later from 'settings.json' (idf.flashType)": "Seleccione el método flash, puede modificar la elección más tarde desde 'settings.json' (idf.flashType)",
   "Current app binary is different from your project. Flash first.": "El binario de la aplicación actual es diferente de su proyecto. ",
   "ESP-IDF Welcome": "ESP-IDF Bienvenido",
+  "ESP-IDF Troubleshooting Form": "Formulario de solución de problemas ESP-IDF",
+  "ESP-IDF Troubleshoot Report has been generated.": "Se ha generado el informe de solución de problemas de ESP-IDF.",
   "ESP-IDF Setup": "Configuración ESP-IDF",
   "ESP-IDF Project Configuration": "Configuración del proyecto ESP-IDF",
   "New Project": "Nuevo proyecto",