From b842640d9fc32ec21ae6cc3087024c582e563341 Mon Sep 17 00:00:00 2001 From: "Brian A. Ignacio" Date: Tue, 1 Mar 2022 19:50:51 +0800 Subject: [PATCH] add changelog for v1.4.0 (#653) * add changelog for v1.4.0 * update Espressif dl mirror * update readme add openvsx --- CHANGELOG.md | 27 ++++++++++++++++++++ README.md | 45 ++++++++++++++++++---------------- src/setup/espIdfVersionList.ts | 2 +- 3 files changed, 52 insertions(+), 22 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c69c5a59c..878c4c1e1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,33 @@ All notable changes to the "Espressif IDF" extension will be documented in this file. +## [1.4.0](https://github.com/espressif/vscode-esp-idf-extension/releases/tag/v1.4.0) + +### Features and enhancements + +- [Show task output on Notification silent mode](https://github.com/espressif/vscode-esp-idf-extension/pull/606) +- [DFU Support](https://github.com/espressif/vscode-esp-idf-extension/pull/566) +- [Check core requirements.txt first](https://github.com/espressif/vscode-esp-idf-extension/pull/620) +- [Add debug adapter use generic classes](https://github.com/espressif/vscode-esp-idf-extension/pull/617) +- [Update compilerPath when IDF_TARGET changes](https://github.com/espressif/vscode-esp-idf-extension/pull/619) +- [Update marked dependency to latest](https://github.com/espressif/vscode-esp-idf-extension/pull/634) +- [Add other platforms in setup](https://github.com/espressif/vscode-esp-idf-extension/pull/636) +- [Use workspace folder in readParameter](https://github.com/espressif/vscode-esp-idf-extension/pull/641) +- [Add project wizard tutorial](https://github.com/espressif/vscode-esp-idf-extension/pull/651) +- [Update extension node dependencies](https://github.com/espressif/vscode-esp-idf-extension/pull/639) like node-sass to sass +- [Add eFuse Explorer refresh and clear summary](https://github.com/espressif/vscode-esp-idf-extension/pull/650) +- [OpenVSX extension release](https://github.com/espressif/vscode-esp-idf-extension/pull/652) + +### Bug Fixes + +- [Remove Windows Prerequisites](https://github.com/espressif/vscode-esp-idf-extension/pull/604) +- [Add tutorials links](https://github.com/espressif/vscode-esp-idf-extension/pull/621) +- [Clean dirty repositories](https://github.com/espressif/vscode-esp-idf-extension/pull/622) +- [Hide not-visible options in SDK Configuration editor](https://github.com/espressif/vscode-esp-idf-extension/pull/633) +- [Use relative elf in WSL monitor](https://github.com/espressif/vscode-esp-idf-extension/pull/625) +- [Add ccache logic in SDK Configuration editor](https://github.com/espressif/vscode-esp-idf-extension/pull/637) +- [Add ccache fixes for IDF_TARGET and add idf component](https://github.com/espressif/vscode-esp-idf-extension/pull/645) Thanks @meltdown03 ! + ## [1.3.0](https://github.com/espressif/vscode-esp-idf-extension/releases/tag/v1.3.0) ### Features and enhancements diff --git a/README.md b/README.md index e90c8bb1a..b725de82b 100644 --- a/README.md +++ b/README.md @@ -33,39 +33,42 @@ Check all the tutorials [here](./docs/tutorial/toc.md). # Table of content -1. [Prerequisites](#Prerequisites) -2. [How to use](#How-to-use) -3. [Available commands](#Available-commands) -4. [Commands for tasks.json and launch.json](#Commands-for-tasks.json-and-launch.json) -5. [Available Tasks in tasks.json](#Available-Tasks-in-tasks.json) -6. [Troubleshooting](#Troubleshooting) -7. [Code of Conduct](#Code-of-Conduct) -8. [License](#License) +1. [How to use](#How-to-use) +2. [Available commands](#Available-commands) +3. [Commands for tasks.json and launch.json](#Commands-for-tasks.json-and-launch.json) +4. [Available Tasks in tasks.json](#Available-Tasks-in-tasks.json) +5. [Troubleshooting](#Troubleshooting) +6. [Code of Conduct](#Code-of-Conduct) +7. [License](#License) Check all the [documentation](./docs/ONBOARDING.md). -# Prerequisites +# How to use + +- 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. +- 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 [ESP-IDF Prerequisites](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html#step-1-install-prerequisites) documentation. +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) - Requirements for [MacOS](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/macos-setup.html#install-prerequisites) - For Windows the [C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools) might be required. -All the other dependencies like ESP-IDF and ESP-IDF Tools can be installed using the **ESP-IDF: Configure ESP-IDF extension** setup wizard or following the steps in the [setup documentation](./docs/SETUP.md). +Installation of ESP-IDF and ESP-IDF Tools is being done from this extension itself (existing ESP-IDF installation may also be reused) using the **ESP-IDF: Configure ESP-IDF extension** setup wizard or following the steps in the [setup documentation](./docs/SETUP.md). -> 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:** 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 additional requirements in [WSL Documentation](./docs/WSL.md) needed in the WSL distribution. -# How to use +- (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. -- Install this extension in your Visual Studio Code. -- Then - - Either open Visual Studio Code and create a workspace folder. - - Run `code ${YOUR_PROJECT_DIR}` from the command line. -- Check you have installed the [Prerequisites](#Prerequisites) -- (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](./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:** 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. @@ -86,7 +89,7 @@ All the other dependencies like ESP-IDF and ESP-IDF Tools can be installed using > **NOTE:** When using the **ESP-IDF: Select Flash Method and Flash** command, your choice will be saved in the `idf.flashType` configuration setting. - You can later start a monitor by pressing F1 and typing **ESP-IDF: Monitor your device** which will log the device activity in a Visual Studio Code terminal. - To make sure you can debug your device, select the your board by pressing F1 and typing **ESP-IDF: Select OpenOCD Board Configuration** or manually define the openOCD configuration files with `idf.openOcdConfigs` configuration in your settings.json. -- If you want to start a debug session, just press F5 (make sure you had at least build and flash once before so the debugger works correctly). +- If you want to start a debug session, just press F5 (make sure you had at least build and flash once before so the debugger works correctly). Check the [Troubleshooting](#Troubleshooting) section if you have any issues. # Available commands diff --git a/src/setup/espIdfVersionList.ts b/src/setup/espIdfVersionList.ts index f7f9defce..c9a770ef8 100644 --- a/src/setup/espIdfVersionList.ts +++ b/src/setup/espIdfVersionList.ts @@ -76,7 +76,7 @@ export function createEspIdfLinkList(data: Buffer, splitString: string) { const versionZip = "https://github.com/espressif/esp-idf/releases/download/IDFZIPFileVersion/esp-idf-IDFZIPFileVersion.zip"; const mirrorZip = - "https://dl.espressif.com/dl/esp-idf/releases/esp-idf-IDFZIPFileVersion.zip"; + `https://dl.espressif.com/github_assets/espressif/esp-idf/releases/download/IDFZIPFileVersion/esp-idf-IDFZIPFileVersion.zip`; const versionRegex = /\b(IDFZIPFileVersion)\b/g; const espIdfMasterZip = "https://github.com/espressif/esp-idf/archive/master.zip";