From bebe3255c74107369752b6b10774ab5377ec58f1 Mon Sep 17 00:00:00 2001 From: "Brian A. Ignacio" Date: Thu, 6 Apr 2023 19:41:22 +0800 Subject: [PATCH] add changelog v1.6.1 (#924) update supported targets update docs add zap-cli to changelog --- CHANGELOG.md | 19 +++++++++++++++++++ README.md | 11 +++++------ docs/HARDWARE_SUPPORT.md | 12 ++++++++++-- docs/tutorial/install.md | 2 +- package.json | 6 ++++++ 5 files changed, 41 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 183c5c79a..dc94bc279 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,25 @@ All notable changes to the "Espressif IDF" extension will be documented in this file. +## [1.6.1](https://github.com/espressif/vscode-esp-idf-extension/releases/tag/v1.6.1) + + ### Features and enhancements + + - [Add coredump as data subtype](https://github.com/espressif/vscode-esp-idf-extension/pull/901) Thanks @ramiws ! + - [Use webpack 5](https://github.com/espressif/vscode-esp-idf-extension/pull/916) Thanks @Spacefish ! + - [Add ESP32 C6 boards](https://github.com/espressif/vscode-esp-idf-extension/pull/917) Thanks @Spacefish ! + - [Add unit test and end to end testing docs](https://github.com/espressif/vscode-esp-idf-extension/pull/912) + - [Update platform on ESP-Matter shallow cloning](https://github.com/espressif/vscode-esp-idf-extension/pull/923) Thanks @Diegorro98 ! + - [Add zap-cli install in ESP-Matter install](https://github.com/espressif/vscode-esp-idf-extension/pull/925) Thanks @Diegorro98 ! + + ### Bug Fixes + + - [Show only valid ESP-IDF setups](https://github.com/espressif/vscode-esp-idf-extension/pull/908) + - [Update non root dockerfile](https://github.com/espressif/vscode-esp-idf-extension/pull/910) + - [Fix wrong binaries multiple options](https://github.com/espressif/vscode-esp-idf-extension/pull/920) Thanks @jmigual ! + - [Fix CMakeLists launch error](https://github.com/espressif/vscode-esp-idf-extension/pull/909) + - [Fix target reset on IDF Monitor when debug session starts](https://github.com/espressif/vscode-esp-idf-extension/pull/914) + ## [1.6.0](https://github.com/espressif/vscode-esp-idf-extension/releases/tag/v1.6.0) ### Features and enhancements diff --git a/README.md b/README.md index 2254667da..a2ca59148 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,8 @@ [![Tutorials](https://img.shields.io/badge/-Tutorials-red)](./docs/tutorial/toc.md) [![Documentation](https://img.shields.io/badge/Documentation-blue)](./docs/ONBOARDING.md) -[![ESP32](https://img.shields.io/badge/Supported%20Chip-ESP32%20ESP32--S2%20ESP32--S3%20ESP32--C3-red)](./docs/HARDWARE_SUPPORT.md) +[![Troubleshooting](https://img.shields.io/badge/Troubleshooting-red)](./README.md#Troubleshooting) +[![ESP32](https://img.shields.io/badge/Supported%20Chips-red)](./docs/HARDWARE_SUPPORT.md) ![Version](https://img.shields.io/github/package-json/v/espressif/vscode-esp-idf-extension) [![Releases](https://img.shields.io/badge/Github-Releases-blue)](https://github.com/espressif/vscode-esp-idf-extension/releases) [![Forum](https://img.shields.io/badge/Forum-esp32.com-blue)](https://esp32.com/viewforum.php?f=40) @@ -54,11 +55,9 @@ Check all the [documentation](./docs/ONBOARDING.md). - Download and install [Visual Studio Code](https://code.visualstudio.com/). - Then - Either open Visual Studio Code and create a workspace folder. - - Run `code ${YOUR_PROJECT_DIR}` from the command line. + - Run `code ${YOUR_PROJECT_DIR}` from a command line terminal. - Install this extension in your Visual Studio Code. -## Prerequisites - There are few dependencies required in your system and available in environment variable PATH before installing this extension. Please review the following documentation. - Requirements for [Linux](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/linux-setup.html#install-prerequisites) @@ -69,13 +68,13 @@ Installation of ESP-IDF and ESP-IDF Tools is being done from this extension itse > **NOTE:** Please note that this extension **only [supports](https://github.com/espressif/esp-idf/blob/master/SUPPORT_POLICY.md)** the release versions of ESP-IDF, you can still use the extension on `master` branch or some other branch, but certain feature might not properly work. -> **NOTE:** If you are using Windows Subsystem for Linux (WSL) 2, please take a look at the additional requirements in [WSL Documentation](./docs/WSL.md) needed in the WSL distribution. +> **NOTE:** If you are using Windows Subsystem for Linux (WSL) 2, please take a look at the [WSL tutorial](docs/tutorial/wsl.md) for an step by step instruction or check the requirements in [WSL Documentation](./docs/WSL.md) needed in the WSL distribution. - (OPTIONAL) Press F1 and type **ESP-IDF: Select where to save configuration settings**, which can be User settings, Workspace settings or workspace folder settings. > **NOTE:** Please take a look at [Working with multiple projects](./docs/MULTI_PROJECTS.md) for more information. Default is User settings. -- On the first time using the extension, press F1 and type **ESP-IDF: Configure ESP-IDF extension** to open the extension configuration wizard. This will install ESP-IDF, ESP-IDF tools, create a virtual python environment with ESP-IDF and this extension python packages and configure the extension settings with these values. **NOTE: Make sure that there is no spaces in any configured path since [ESP-IDF build system doesn't support spaces yet.](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/windows-setup.html#start-a-project)**. +- On the first time using the extension, press F1 to show the Visual Studio Code Command Palette and type **ESP-IDF: Configure ESP-IDF extension** to open the extension configuration wizard. This will install ESP-IDF, ESP-IDF tools, create a virtual python environment with ESP-IDF and this extension python packages and configure the extension settings with these values. **NOTE: Make sure that there is no spaces in any configured path since [ESP-IDF build system doesn't support spaces yet.](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/windows-setup.html#start-a-project)**. > **NOTE:** Please take a look at [SETUP](./docs/SETUP.md) documentation or the [Install](./docs/tutorial/install.md) tutorial for details about extension setup and configuration. diff --git a/docs/HARDWARE_SUPPORT.md b/docs/HARDWARE_SUPPORT.md index f3a3e9aea..a9fa0735a 100644 --- a/docs/HARDWARE_SUPPORT.md +++ b/docs/HARDWARE_SUPPORT.md @@ -1,9 +1,17 @@ # Current chips supported in this extension -[ESP32](https://www.espressif.com/en/products/socs/esp32-s2) +[ESP32](https://www.espressif.com/en/products/socs/esp32) +[ESP32-C2](https://www.espressif.com/en/products/socs/esp32-c2) +[ESP32-C3](https://www.espressif.com/en/products/socs/esp32-c3) +[ESP32-C6](https://www.espressif.com/en/products/socs/esp32-c6) [ESP32-S2](https://www.espressif.com/en/products/socs/esp32-s2) [ESP32-S3](https://www.espressif.com/en/products/socs/esp32-s3) -[ESP32-C3](https://www.espressif.com/en/products/socs/esp32-c3) +[ESP32-H2](https://www.espressif.com/en/products/socs/esp32-h2) + +The chips supported in the extension are directly dependent on the ESP-IDF and OpenOCD version you are using: + +- The list of OpenOCD configuration boards is obtained from `$OPENOCD_SCRIPTS/esp-config.json` where `$OPENOCD_SCRIPTS` is your OpenOCD Scripts path. +- The list of IDF Targets is obtained from the `idf.py --list-targets` command from the configured ESP-IDF in this extension. In addition to ESP-IDF chips, there are several boards configurations files implemented for OpenOCD. The `idf.openOcdConfigs` configuration setting is used by this extension to set OpenOCD Configuration files for the OpenOCD server executed within the extension. Here is more information about [OpenOCD Configuration targets](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/tips-and-quirks.html#jtag-debugging-tip-openocd-configure-target). diff --git a/docs/tutorial/install.md b/docs/tutorial/install.md index 9e45e4d2e..d5920dc92 100644 --- a/docs/tutorial/install.md +++ b/docs/tutorial/install.md @@ -13,7 +13,7 @@

6. (OPTIONAL) Press F1 and type **ESP-IDF: Select where to save configuration settings**, which can be User settings, Workspace settings or workspace folder settings. Please take a look at [Working with multiple projects](../MULTI_PROJECTS.md) for more information. Default is User settings. -7. In Visual Studio Code, select menu "View" and "Command Palette" and type [configure esp-idf extension]. After, choose the **ESP-IDF: Configure ESP-IDF extension** option. +7. In Visual Studio Code, select menu "View" and "Command Palette" and type [configure esp-idf extension]. After, choose the **ESP-IDF: Configure ESP-IDF extension** option. You can also choose where to save settings in the setup wizard. 8. Now the setup wizard window will be shown with several setup options: **Express**, **Advanced** or **Use existing setup**. > **NOTE**: **Use existing setup** setup mode option is only shown if: diff --git a/package.json b/package.json index 488bbff1a..49d6e506f 100644 --- a/package.json +++ b/package.json @@ -24,7 +24,12 @@ "Debuggers" ], "keywords": [ + "arduino-esp32", + "bluetooth", "ESP-IDF", + "ESP-ADF", + "ESP-MDF", + "ESP-matter", "ESP", "Espressif", "ESP32", @@ -40,6 +45,7 @@ "esp32h2", "esp32s2", "esp32s3", + "matter", "iot", "wifi", "soc"