Skip to content

Commit

Permalink
add changelog v1.6.1 (#924)
Browse files Browse the repository at this point in the history
update supported targets

update docs

add zap-cli to changelog
  • Loading branch information
brianignacio5 authored Apr 6, 2023
1 parent 88cb7ba commit bebe325
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 9 deletions.
19 changes: 19 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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

This comment has been minimized.

Copy link
@xs314

xs314 Aug 21, 2023

5. Install [ESP-IDF Prerequisites](../../README.md#Prerequisites) and, if using WSL2, the required packages specified in [WSL Documentation](../WSL.md).

install.md should be updated.

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)
Expand All @@ -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 <kbd>F1</kbd> 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 <kbd>F1</kbd> 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 <kbd>F1</kbd> 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.
Expand Down
12 changes: 10 additions & 2 deletions docs/HARDWARE_SUPPORT.md
Original file line number Diff line number Diff line change
@@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</p>

6. (OPTIONAL) Press <kbd>F1</kbd> 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:
Expand Down
6 changes: 6 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,12 @@
"Debuggers"
],
"keywords": [
"arduino-esp32",
"bluetooth",
"ESP-IDF",
"ESP-ADF",
"ESP-MDF",
"ESP-matter",
"ESP",
"Espressif",
"ESP32",
Expand All @@ -40,6 +45,7 @@
"esp32h2",
"esp32s2",
"esp32s3",
"matter",
"iot",
"wifi",
"soc"
Expand Down

0 comments on commit bebe325

Please sign in to comment.