diff --git a/README.md b/README.md index ed3d26830..341c3faeb 100644 --- a/README.md +++ b/README.md @@ -2,882 +2,22 @@ [中文](./README_CN.md) -# ESP-IDF Eclipse Plugin (Espressif-IDE) +# Espressif-IDE (IDF Eclipse Plugin) -ESP-IDF Eclipse Plugin brings developers an easy-to-use Eclipse-based development environment for developing ESP32-based IoT applications. -It provides better tooling capabilities, which simplifies and enhances standard Eclipse CDT for developing and debugging ESP32 IoT applications. It offers advanced editing, compiling, flashing and debugging features with the addition of Installing the tools, SDK configuration and CMake editors. +Espressif-IDE is an Integrated Development Environment (IDE) based on Eclipse CDT for developing IoT Applications using the ESP-IDF. It’s a standalone and customized IDE built specifically for ESP-IDF. Espressif-IDE comes with the IDF Eclipse plugins, essential Eclipse CDT plugins, and other third-party plugins from the Eclipse platform to support building ESP-IDF applications. The plug-in runs on `macOS`, `Windows` and `Linux` platforms. -![](docs_readme/images/macos-logo.png) -![](docs_readme/images/windows-logo.png) -![](docs_readme/images/linux-logo.png) +![](media/macos-logo.png) +![](media/windows-logo.png) +![](media/linux-logo.png) -> **Note:** Espressif-IDE 3.0 and higher supports ESP-IDF 5.x and above +> **Note:** Espressif-IDE version 3.0 and later supports ESP-IDF version 5.x and above. For ESP-IDF version 4.x and earlier, please use Espressif-IDE version 2.12.1. -To get a quick understanding of ESP-IDF and Eclipse plugin features, check our session which was presented in EclipseCon 2020. +# How to Use +Please check our IDE documentation [here](https://docs.espressif.com/projects/espressif-ide/en/latest/index.html). -# Table Of Contents -
- Get Started - -* [ Installation](#Installation)
-* [ Creating a new Project ](#NewProjectUsingDefault)
-* [ Configuring Launch Target ](#ConfigureLaunchTarget)
-* [ Compiling the Project ](#BuildApplication)
-* [ Flashing the Project ](#FlashApplication)
-* [ Viewing Serial Output ](#ConfigureLaunchTerminal)
-* [ Debugging the Project ](#debugging)
-* [ Troubleshooting Guide](#troubleshooting)
-* FAQ -
- -
- Other IDE Features - -* [ Configuring the Project using sdkconfig Editor](#projectconfigure)
-* [ LSP Editor](#lspeditor)
-* [ CMake Editor](#cmakeproject)
-* [ ESP-IDF Application Size Analysis Editor](#sizeanalysiseditor)
-* [ Installing ESP-IDF Components](#espidfcomponents)
-* [ ESP-IDF Terminal](#idfterminal)
-* [ Configuring Build Environment Variables ](#configureEnvironmentVariables)
-* [ Configuring Core Build Toolchain ](#ConfigureToolchains)
-* [ Configuring CMake Toolchain ](#ConfigureCMakeToolchain)
-* [ Selecting Clang Toolchain](#SelectDifferentToolchain)
-* [ Configuring the flash arguments ](#customizeLaunchConfig)
-* [ Installing IDF Eclipse Plugin from Eclipse Market Place](#installPluginsFromMarketPlace)
-* [ Installing IDF Eclipse Plugin using local archive ](#installPluginsUsingLocalFile)
-* [ Upgrading IDF Eclipse Plugin ](#upgradePlugins)
-* [ Importing an existing IDF Project ](#ImportProject)
-* [ Importing an existing Debug launch configuration ](#importDebugLaunchConfig)
-* [ Device Firmware Upgrade (DFU) through USB ](#deviceFirmwareUpgrade)
-* [ GDBStub Debugging ](#gdbStubDebugging)
-* [ Core Dump Debugging ](#coreDumpDebugging)
-* [ Application Level Tracing ](#appLvlTracing)
-* [ Partition Table Editor UI for ESP-IDF](#partitionTableEditor)
-* [ NVS Table Editor](#nvsTableEditor)
-* [ Write Binary Data to Flash](#writeFlashBinary)
-* [ Changing Language ](#changeLanguage)
-* [ Wokwi Simulator](#wokwisimulator)
-
- - - -# Installation -We recommend using the Espressif-IDE instead of the Eclipse CDT + IEP Plugin update approach to avoid the hassles of updating. - -## Espressif-IDE for Windows -* Download the [Espressif-IDE with ESP-IDF Offline Windows Installer](https://dl.espressif.com/dl/esp-idf/) and follow the instructions provided [here](https://github.com/espressif/idf-eclipse-plugin/blob/master/docs_readme/Espressif-IDE-Windows-Installer.md). This guide will walk you through the installation process for Java, Git, CMake, ESP-IDF, IDF Tools, Device Drivers, and Espressif-IDE to help you get started. - -## Espressif-IDE for macOS and Linux -* To begin, download the [Espressif-IDE](https://github.com/espressif/idf-eclipse-plugin/blob/master/docs_readme/Espressif-IDE.md#downloads) for your respective operating system. Following this, launch the IDE and proceed to install the necessary ESP-IDF and related tools. Please note that prior to launching the IDE, you must ensure that Java, Python, and Git are installed as [prerequisites](#Prerequisites). and available in the system path. - -If you plan to use Eclipse CDT and update it through the IDF Eclipse plugin, please ensure that you download the supported version for your operating system from here . - - -## Prerequisites - -The minimum requirements for running the Espressif-IDE are below. -* **Java 17 and above** : Download and install Java SE from here. -* **Python 3.8 and above** : Download and install Python from here. -* **Git** : Get the latest git from here. - -> **Note:** Make sure Java, Python and Git are available on the system environment PATH. - - - -# Installing IDF Plugin using update site URL - -You can install the IDF Eclipse plugin into an existing IDE using the update site URL. First, add the release repository URL as follows: - -1. Go to `Help` > `Install New Software`. -1. Click `Add…`, and in the pop-up window: - * Enter `Name` as `Espressif IDF Plugin for Eclipse` - * Enter `Location` of the repository: - * Stable release: https://dl.espressif.com/dl/idf-eclipse-plugin/updates/latest/ - * Click `Add`. -1. Select `Espressif IDF` from the list and proceed with the installation. - -For adding beta and nightly builds, you can use the following update site urls. - * Beta version: https://dl.espressif.com/dl/idf-eclipse-plugin/updates/beta/ - * Nightly build: https://dl.espressif.com/dl/idf-eclipse-plugin/updates/nightly/ - -> **Note:** While the screenshots are captured on macOS, the installation instructions are applicable to Windows, Linux, and macOS. - -![](docs_readme/images/idf_update_site_install.png) - - -# Installing ESP-IDF - -Please follow the instructions below for installing ESP-IDF in the Espressif-IDE. - -1. Go to `Espressif` > `ESP-IDF Manager`. The following editor will open -![](docs_readme/images/ToolsManager/ESP-IDF_Manager_Editor_Screen.png) - -1. Click on `Add ESP-IDF` button. -![](docs_readme/images/ToolsManager/ESP-IDF_Configuration_Download_or_Use_ESP-IDF.png) -From the screen shown above you can choose an already downloaded ESP-IDF Directory or you can select and download directly from the given dialog. The `Git` and `Python` must be installed and if it is configured in system PATH it will be preloaded in the given view. If not you can Browse to the directory and select the proper executables. - -1. Click on `Finish` which will be enabled after all the paths and executables are properly configured. - -> **Note** Please note that the python executable is not the one from the virtual environment created from the installation of the ESP-IDF via other means like from CLI. If you are selecting an already installed ESP-IDF directory IDE will automatically pick up the python once you have installed the tools. -To configure an existing ESP-IDF: - -After you have clicked `Finish` you will see the progress on console for the tools getting installed. Once the installation is done and this is the very first set of ESP-IDF installed in the IDE it will be activated as well and you will see a similar entry in the editor for ESP-IDF Manager -![](docs_readme/images/ToolsManager/Tool_installed_and_activated.png) - -You can add as many version of ESP-IDF as you want but only one of the version can be set active and that will be used to compile and index projects in your workspace. This new feature can help you in swithcing between versions in the workspace easily. - -Lets take a look at how the multiple versions will look like. You have to follow the same steps as done previously to add another ESP-IDF version to the IDE. -![](docs_readme/images/ToolsManager/ESP-IDF_Manager_Multiple_versions.png) - -To activate any specific version simply click on the radio button next to it in the `Active` column. - -The refresh button in last column for the active ESP-IDF version can be used to reload any changes in the directory you made. - -> **Note** Please note that you can not delete an active ESP-IDF Version you need to activate another version before deleting that. - - -# Create a new Project - -1. Make sure you are in `C/C++ Perspective`. -1. Go to `File` > `New` > `Espressif IDF Project` -1. Provide the `Project name` (The ESP-IDF build system does not support spaces in the project path). -1. Click `Finish`. - -To create a project using existing ESP-IDF templates, please refer to [this](#NewProjectUsingTemplates). - -> **Note:** You may see numerous unresolved headers and symbols errors in the editor, and these will only be resolved after the build process. - -![](docs_readme/images/3_new_project_default.png) - - -# Configuring build target - -Next, you should select the ESP target for your project. By default, the launch target drop-down will display all the supported targets by the plugin. - -target - -However, if you would like to add a target that is not available in the launch target drop-down, please follow the instructions below. -1. Click on the launch target dropdown. -1. Select `New Launch Target`. -1. Select `ESP Target`. -1. Provide properties for the target where you would like to launch the application. Enter a `Name` for the target and select the `Serial Port` your ESP device is connected to on your machine. - -![](docs_readme/images/8_launch_target.png) - - -# Compiling the Project - -1. Select a project from the `Project Explorer`. -1. Select `Run` from the first drop-down, which is called `Launch Mode`. -1. Select your application from the second drop-down, which is called `Launch Configuration`(Auto-detected). -1. Select a target from the third drop-down, which is called `Launch Target`. -1. Now click on the `Build` ![](docs_readme/images/icons/build.png) button to start with a build process. - -![](docs_readme/images/9_cmake_build.png) - - -# Flashing the Project - -Flash operation can be initiated with just a click of a launch button ![](docs_readme/images/icons/run.png) and it's auto-configured to flash the application with the default flash command i.e, `idf.py -p PORT flash`. - -flash - -To provide the customized flash arguments, please follow [this](#customizeLaunchConfig) link for further instructions. - -To configure flashing via JTAG, please refer to this JTAG Flashing guide. - - -# Viewing Serial Output - -To see the serial output in Eclipse, we need to configure the `ESP-IDF Serial Monitor` to connect to the serial port. This is integrated with the `IDF Monitor`. Please check more details here. - -monitor - -1. Click on the `Open a Terminal` icon from the toolbar. -1. Choose `ESP-IDF Serial Monitor` from the terminal drop-down. -1. Select `Serial Port` for your board if it's not detected. -1. Configure serial monitor filter options for output filtering. -1. Click on `OK` to launch the terminal, which will listen to the USB port. - -![](docs_readme/images/10_serial_terminal.png) - -### ESP-IDF Serial Monitor Settings - -ESP-IDF Serial Monitor will allow you to configure the default settings of the serial monitor character limit and number of lines. - -1. Navigate to `Espressif` from the Eclipse Preferences. -1. Click on `ESP-IDF Serial Monitor Settings`. -1. Provide `Console Line Width` and `Limit Console Output`. - - -# Debugging the Project -In most cases, only two things are required to start debugging an esp-idf project: -1) Create a debug configuration -2) Check whether the board in the created configuration corresponds to the board in use. -> **Note:** If you're using Windows, you may need to install drivers using Zadig to run a debug session successfully. For detailed instructions, please refer to this [guide](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/configure-ft2232h-jtag.html#configure-usb-drivers). - -The fastest way to create a debug configuration is to expand the configuration list in the launch bar and click `New Launch Configuration...`. Then select `ESP-IDF GDB OpenOCD Debugging` -> Double Click or `Next`. After that, the preview for the new debug configuration will open where it's necessary to check the board. - -After creating the debug configuration, you can go ahead and debug the project. Select the configuration you just created, select debug mode, and click on the "Debug" icon ![](docs_readme/images/icons/debug.png) to start debugging: - -![Debugging_process](https://github.com/espressif/idf-eclipse-plugin/assets/24419842/1fb0fb9b-a02a-4ed1-bdba-b4b4d36d100f) - - -To learn more about the debug configuration, please refer to GDB OpenOCD Debugging. - -# Other IDE Features - - -## Create a new project using ESP-IDF Templates - -1. Make sure you're in `C/C++ Perspective`. -1. Go to `File` > `New` > `Espressif IDF Project` (If you don't see this, please reset the perspective from `Window` > `Perspective` > `Reset Perspective..`). -1. Provide the `Project name`. -1. Click `Next`. -1. Check `Create a project using one of the templates`. -1. Select the required template from the tree. -1. Click `Finish`. - -> **Note:** You will see a lot of unresolved inclusion errors in the editor and those will be resolved only after the build. - -![](docs_readme/images/4_new_project_templates.png) - - - -# SDK Configuration editor - -Project configuration is held in a single file called `sdkconfig` in the root directory of the project. This configuration file can be modified using `SDK Configuration Editor` - -To launch the SDK Configuration editor: - -1. Navigate to `sdkconfig` file. -1. Double-click on the file to launch the SDK configuration editor. -1. Use `Ctrl+S` or `Command+S` based on the OS environment to save the changes. You can also use Eclipse `Save` button from the toolbar. -1. To revert the sdkconfig editor changes, you can either close the editor without saving them or you can right-click on the `sdkconfig` file and select `Load sdkconfig` menu option to revert the changes from the editor. - -![](docs_readme/images/13_sdkconfig_editor.png) - - -# LSP Editor -Starting with Espressif IDE 3.0.0, the default code editor is the LSP Editor, which differs in several ways from the previous default editor. Below are the most notable differences: - -## Formatting -To customize the formatting, open the .clang-format file located in your project. By default, the file contains the following content: - -``` -BasedOnStyle: LLVM -UseTab: Always -IndentWidth: 4 -TabWidth: 4 -PackConstructorInitializers: NextLineOnly -BreakConstructorInitializers: AfterColon -IndentAccessModifiers: false -AccessModifierOffset: -4 -``` -You can also disable formatting for specific folders by using the `DisableFormat: true option.` For example, if you want to disable formatting for the managed_components folder in a project structured like this: -``` -project - - managed_components - - .clang-format - - main - - .clang-format -``` -Add the `DisableFormat: true` option to the `.clang-format` file located in the managed_components folder. This flag tells ClangFormat to completely ignore this specific `.clang-format` file and its formatting rules within the managed-components directory. - -For more information about available style options, refer to [the Clang-Format Style Options guide](https://clang.llvm.org/docs/ClangFormatStyleOptions.html#configurable-format-style-options). - -## Search -The “search text” option in the right-click menu is currently unavailable in the LSP-based C/C++ Editor. However, you can use the toolbar menu **Search > Text > Workspace** as a workaround. - - -## Inlay Hints -The LSP Editor has inlay hints enabled by default. If you prefer not to use them, you can disable this feature by editing the `.clangd` file: -``` -CompileFlags: - CompilationDatabase: build - Remove: - - -m* - - -f* - -InlayHints: - Enabled: No -``` -## Searching ESP-IDF Components -To browse ESP-IDF components, follow these steps: -- Create a new project. -- Add the ESP-IDF components folder as a virtual folder to the newly created project. -- Press **Ctrl + Shift + T** or **Ctrl + Shift + R**. -- You should now be able to browse the ESP-IDF component files. -- To search for a specific function or keyword, use the Search menu in the toolbar. - -Creating a Virtual Folder -- Navigate to **New > Folder.** -- Click on **Advanced.** -- Select **Link to alternate Location (Linked Folder)**. -- Click **Browse** and select the `ESP-IDF components` folder. - -It is recommended to always create a new project instead of modifying your current one to avoid unnecessary Git files and error markers created by the indexer for the components folder. As both the projects will be in the same workspace, you should be able to search anywhere within your workspace. - - -# CMake Editor - -CMake Editor Plug-in is integrated with IDF Plugin for editing CMake files such as CMakeLists.txt. It provides syntax coloring, CMake command content assist, and code templates. - -![](docs_readme/images/cmake_editor_ca.png) - -CMake editor preferences can be controlled using `Eclipse` > `Preferences` > `CMakeEd`. - -![](docs_readme/images/cmake_editor_preferences.png) - - -# ESP-IDF Application Size Analysis - -The Application Size Analysis editor provides a way to analyze the static memory footprint of your application. It has two sections: -- The **Overview** section provides a summary of the application's memory usage; -- The **Details** section will have in-depth details about components and per-symbol level memory information. - -**Details** table viewer also provides you with searching and sorting capabilities on various columns. - -To launch the Application Size Analysis editor: - -1. Right-click on the project. -1. Select `ESP-IDF` > `Application Size Analysis` menu option to launch the editor. - -**Application Size Analysis - Overview** - -![](docs_readme/images/sizeanalysis_overview.png) - -**Application Size Analysis - Details** - -![](docs_readme/images/sizeanalysis_details.png) - - -# ESP-IDF Terminal - -This would launch a local terminal with all the environment variables which are set under `Preferences` > `C/C++` > `Build` > `Environment`. The default working directory would be either the currently selected project or IDF_PATH if there is no project selected. - -The terminal PATH is also configured with `esptool`, `espcoredump`, `partition_table`, and `app_update` component paths so that it will be handy to access them directly from the ESP-IDF terminal. - -To launch the ESP-IDF Terminal: - -* Click on the `Open a Terminal` icon from the toolbar. -* Choose `ESP-IDF Terminal` from the terminal drop-down and click `OK` to launch a terminal. - -![](docs_readme/images/idf_terminal.png) - - -# Installing ESP-IDF Components - -You can install the ESP-IDF Components directly into your project from the available components online. Follow the steps below: - -* Right-click on the project from `Project Explorer` in which you want to add the component to and Select `Install ESP-IDF Components`. - - ![](docs_readme/images/ESP-IDF_Components/install_components.png) - - A new window will open up showing all the available component to be installed. - -* From the window, you can click on `Install` button to add that component to the project. To get to the readme file for that component you can click on `More Info` which will open the browser link to the readme file of that component. - ![](docs_readme/images/ESP-IDF_Components/components_window.png) - -Already added components are also shown but the `Install` button changes text to `Already Added` and is disabled. - - -# Configuring Environment Variables - -All the required environment variables are automatically configured by the IDE during the ESP-IDF and Tools installation process (Espressif > ESP-IDF Manager > Add ESP-IDF). You can verify them in the Preferences page under `C/C++` > `Build` > `Environment`. - -![](docs_readme/images/2_environment_pref.png) - -# Configuring Toolchains - -We need to tell Eclipse CDT what core build toolchain and CMake toolchain to use to build the project. However, this will be auto-detected if you've installed the tools using the `Espressif` > `ESP-IDF Manager` > `Add ESP-IDF` option from IDE. - -If these toolchains are not detected for any reason, please follow the step-by-step instructions below to add a new toolchain. - - -# Configuring Core Build Toolchains - -1. Open Eclipse Preferences. -1. Navigate to `C/C++` > `Core Build Toolchains` preference page. -1. Click on `Add..` from the user-defined toolchains tables. -1. Select `GCC` as a toolchain type. -1. Click on `Next`. -1. Provide the GCC toolchain settings: - - * **Compiler:** /Users/user-name/esp/xtensa-esp32-elf/bin/xtensa-esp32-elf-gcc, - * **Operating System:** esp32, - * **CPU Architecture:** xtensa - -![](docs_readme/images/6_core_build_toolchains.png) - - -# Configuring CMake Toolchain - -We now need to tell CDT which toolchain to use when building the project. This will pass the required arguments to CMake when generating the Ninja files. - -1. Navigate to `C/C++` > `CMake` preference page. -1. Click `Add...` and this will launch the New CMake toolchain configuration dialog. -1. Browse CMake toolchain `Path`. Example: `/Users/user-name/esp/esp-idf/tools/cmake/toolchain-esp32.cmake`. -1. Select GCC Xtensa toolchain compiler from the drop-down list. Example: `esp32 xtensa /Users/user-name/esp/xtensa-esp32-elf/bin/xtensa-esp32-elf-gcc`. - -> **Note:** Eclipse CDT has a bug in saving the toolchain preferences, hence it's recommended to restart Eclipse before we move further configuring the launch target. - -![](docs_readme/images/7_cmake_toolchain.png) - - -# Selecting Clang Toolchain - -1. After creating a new project, edit the project configuration -![image](https://user-images.githubusercontent.com/24419842/194882285-9faadb5d-0fe2-4012-bb6e-bc23dedbdbd2.png) -1. Go to the `Build Settings` tab and select clang toolchain there: -![image](https://user-images.githubusercontent.com/24419842/194882462-3c0fd660-b223-4caf-964d-58224d91b518.png) - -> **Note:** Clang toolchain now is an experimental feature and you may face some build issues due to the incompatibility of esp-idf. Below is a description of how to fix the most common build issue on the current ESP-IDF master (ESP-IDF v5.1-dev-992-gaf28c1fa21-dirty). To work around clang build errors please refer to [this](https://github.com/espressif/idf-eclipse-plugin/blob/master/WORKAROUNDS.md#clang-toolchain-buid-errors). - - -# Launch Configuration - -To provide the customized launch configuration and flash arguments, please follow the step-by-step instructions below. - -1. Click on the `Launch Configuration` edit button. -1. Switch to the `Main` tab. -1. Specify the `Location` where this application has to run. Since `idf.py` is a Python file, will configure the Python system path. Example:`${system_path:python}`. -1. Specify the `Working directory` of the application. Example: `${workspace_loc:/hello_world}`. -1. In additional arguments, provide a flashing command which will run in the specified working directory. -1. Flash command looks like this: `/Users/user-name/esp/esp-idf/tools/idf.py -p /dev/cu.SLAB_USBtoUART flash`. -1. Click OK to save the settings. -1. Click on the `Launch` icon to flash the application to the selected board. - -![](docs_readme/images/11_launch_configuration.png) - -![](docs_readme/images/12_flashing.png) - - -# Changing Language - -To change the plugin language a menu is provided to show the list of available languages for the plugin. - -1. Click on the `Espressif` menu from the menu bar. -1. Select the `Change Language` from the drop-down menu. -1. From the sub menu select the language you want. -1. IDE will restart with the selected language. - -![](docs_readme/images/change_language.png) - -Remember this will only change the language of the Eclipse if the required language bundles for the selected language are installed or else only the plugin interfaces will be changed. - - -# Troubleshooting - -## Suggestions for Solving Errors from ESP-IDF by Hints Viewer - -If you run into a problem during a build, chances are that there is a hint for this error in the ESP-IDF hint database, which is stored in `tools/idf_py_actions/hints.yml` of ESP-IDF. The ESP-IDF Eclipse plugin provides a hint viewer where you can type an error message and find a hint for it. -Prerequisites for it is to have `hints.yml`, which is available from ESP-IDF v5.0 and higher. If you are using lower versions of ESP-IDF, you can still use the hints viewer. To do it, you have to manually download the hints.yml file from [here](https://github.com/espressif/esp-idf/blob/master/tools/idf_py_actions/hints.yml) and put it to your `esp-idf/tools/idf_py_actions/` path. To download a file from GitHub, right-click the `Raw` button and then `Save as...`. - -To open the hints viewer go to `Windows` -> `Show View` -> `Other...` -> `Espressif` -> `Hints`. You will see the following view: -![image](https://user-images.githubusercontent.com/24419842/189666994-78cc8b24-b934-426f-9df5-79af28c50c55.png) - -Now you can type or copy paste some error from the build log, for example: -`ccache error: Failed to create temporary file for esp-idf/libsodium/CMakeFiles/..../....: No such file or directory` - -![image](https://user-images.githubusercontent.com/24419842/189672552-994624f3-c0c5-48e6-aa2c-61e4ed8915e5.png) - -Double-clicking on the row will give you a hint message, so you can clearly see it if it doesn't fit on your screen in the table view. - -![image](https://user-images.githubusercontent.com/24419842/189673174-8ce40cda-6933-4dc4-a555-5d2ca617256e.png) - -## Error Log - -The Error Log view captures all the warnings and errors logged by plug-ins. The underlying log file is a .log file stored in the .metadata subdirectory of the workspace. - -The Error Log view is available in `Window` > `Show View` > `Error Log`. - -To export the current log view content into a file, press the Export Log toolbar button or select `Export Log...` from the context menu. Then, enter a file name. - -Always provide an error log when reporting an issue. - -![](docs_readme/images/export_log.png) - -## Console View Log - -The Console View provides all the warnings and errors related to the current running process or build. To access the console view. - -From the menu bar, `Window` > `Show View` > `Console`. - -![](docs_readme/images/CDT_Build_Console.png) - -## CDT Global Build Log - -Go to `Preferences > C/C++ > Build > Logging` - -## Espressif IDF Tools Console - -The Espressif IDF Tools Console is part of the Console view, this will be opened only during the installation of IDF tools from the Eclipse. - -If you encounter any issue while installing the IDF tools using `Espressif` > `ESP-IDF Tools Manager` > `Install tools`, please check the Espressif IDF Tools Console to see the errors reported. - -If this is not active, it can be switched by clicking on the `Display Selected Console` icon from the console view. - -![](docs_readme/images/IDF_tools_console.png) - -## Heap Tracing - -Please refer to this doc. - - -# Installing IDF Eclipse Plugin from Eclipse Market Place - -Please follow the steps below to install IDF Eclipse Plugin from the Eclipse Market Place. - -1. In Eclipse, choose `Help` > `Eclipse Market Place...`. -1. Enter `ESP-IDF Eclipse Plugin` in the search box to find the plugin. -1. Click on `Install` to follow the installation instructions. -1. Restart the Eclipse. - -![](docs_readme/images/market_place.png) - - -# Installing IDF Eclipse Plugin from Local Archive - -1. Download the latest update site archive for IDF Eclipse Plugin here - https://github.com/espressif/idf-eclipse-plugin/releases. -1. In Eclipse, choose `Help` > `Install New Software`. -1. Click `Add…` button. -1. Select `Archive` from Add repository dialog and select the file `com.espressif.idf.update-vxxxxxxx.zip`. -1. Click `Add`. -1. Select `Espressif IDF` from the list and proceed with the installation. -1. Restart the Eclipse. - -![](docs_readme/images/1_idffeature_install.png) - - -# How do I upgrade my existing IDF Eclipse Plugin? - -If you are installing IDF Eclipse Plugin into your Eclipse for the first time, you first need to add the new release's repository as follows: - -1. `Window` > `Preferences` > `Install/Update` > `Available Software Sites`. -1. Click `Add`. -1. Enter the URL of the new repository https://dl.espressif.com/dl/idf-eclipse-plugin/updates/latest/. -1. Click `Ok`. - -If you've already installed IDF Eclipse Plugin using `update site URL`, you can get the latest changes by following the steps below: - -1. `Help` > `Check for Updates`. -1. If updates are found, select `Espressif IDF Plugins for Eclipse` and deselect all other items. -1. Click `Next` to proceed with the installation. - -![](docs_readme/images/Update_plugins.png) - - -# Importing an existing IDF Project - -1. Make sure you're in `C/C++ Perspective`. -1. Right-click in the `Project Explorer`. -1. Select `Import..` Menu. -1. Select `Existing IDF Project` from `Espressif` import wizard menu list. -1. Click `Next`. -1. Click on `Browse...` to choose an existing project location directory. -1. Provide `Project name` if you wish you have a different name. -1. Click `Finish` to import the selected project into Eclipse workspace as a CMake project. - -![](docs_readme/images/5_import_project.png) - - -# Importing an existing Debug launch configuration - -To import an existing launch configuration into Eclipse: - -1. Select `Import...` from the `File` menu. -1. In the Import dialog box, expand the `Run/Debug` group and select `Launch Configurations`. -1. Click on `Next`. -1. Click on `Browse...` to select the required location in the local file system. -1. Select the folder containing the launch files and then click `OK`. -1. Select the checkboxes for the required folder and launch file. -1. If you are replacing an existing configuration with the same name then select `Overwrite existing launch configurations without warning`. -1. Click on `Finish`. - - -# GDBStub Debugging - -You can now use the GDBStub debugging inside our Eclipse plugin to help you diagnose and debug issues on chips via Eclipse when it is in panic mode. - -To enable GDBStub debugging for a project: - -1. Launch the `sdkconfig` in project root by double-clicking on it which will open the configuration editor. -![](docs_readme/images/GDBStubDebugging/sdkconfig_editor.png) - -1. Expand the `Component Config` section and select `ESP System Settings`. From the settings on the right for `Panic Handler behaviour` select the `GDBStub on Panic option` from the list. -![](docs_readme/images/GDBStubDebugging/sdkconfig_editor_panic_behavior.png) - -Now you will be taken to the GDBStub debugger automatically when you connect the serial monitor and there is a panic for this example. - -To use the GDBStub debugging for a project: - -1. Create a template `hello_world` project and add the following lines in the main c file. - - ``` - This is a global variable
- COREDUMP_DRAM_ATTR uint8_t global_var; - ``` - -1. Now add these two lines just above the `esp_restart()` function - - ``` - global_var = 25; - assert(0); - ``` - -The final file should be something like this: -![](docs_readme/images/GDBStubDebugging/code_example.png) - -Build and flash the project and launch the serial monitor. On line number 45, we are signaling for a failing assert which will put the chip in panic mode and when that line reaches, you will be prompted to switch the perspective to debug mode and the chip will be halted. - -Remember that this is a panic mode and you cannot continue the execution from here, you will have to stop and restart the chip through IDF commands or simply restart the serial monitor. - -![](docs_readme/images/GDBStubDebugging/debug_panic_mode.png) - -You can view the registers stack trace and even view the value of variables in the stack frame. - -To exit the debug session simply press `stop` button. - - - -# Core Dump Debugging - -The IDF-Eclipse plugin allows you to debug the core dump if any crash occurs on the chip and the configurations are set. Currently only the UART core dump capture and debugging is supported. - -To enable core dump debugging for a project: - -1. You need to enable it first in `sdkconfig`. Launch the `sdkconfig` in the project root by double-clicking on it which will open the configuration editor - -1. Click on the `Core Dump` from the settings on the left and select `Data Destination` as `UART`. -![](docs_readme/images/CoreDumpDebugging/sdkconfig_editor.png) - -This will enable the core dump debugging and whenever you connect a serial monitor for that project if any crash occurs it will load the dump and open a debug perspective in Eclipse to let you diagnose the dump where you can view all the information in the core dump. - -You can view the registers stack trace and even view the value of variables in stack frame. - -To exit the debug session: simply press stop button. - - -# Device Firmware Upgrade (DFU) through USB - -Device Firmware Upgrade (DFU) is a mechanism for upgrading the firmware of devices through Universal Serial Bus (USB). There are a few requirements that need to be met: - -- DFU is supported by ESP32-S2 and ESP32-S3 chips. -- You will need to do some electrical connection work (Here is a [guide](https://blog.espressif.com/dfu-using-the-native-usb-on-esp32-s2-for-flashing-the-firmware-b2c4af3335f1) for the ESP32-S2 board). The necessary connections for the USB peripheral are shown in the following table. - -| GPIO | USB | -| -----| ------------| -| 20 | D+ (green) | -| 19 | D- (white) | -| GND | GND (black)| -| +5V | +5V (red) | - -After meeting the above requirements: - -1. The chip needs to be in bootloader mode for the detection as a DFU device and flashing. This can be achieved by pulling GPIO0 down (e.g. pressing the BOOT button), pulsing RESET down for a moment and releasing GPIO0. - -1. Install USB drivers (Windows only). The drivers can be installed by the [Zadig tool](https://zadig.akeo.ie/). - - Please make sure that the device is in download mode before running the tool and that it detects the device before installing the drivers. - - The Zadig tool might detect several USB interfaces of the target. Please install the WinUSB driver for only that interface for which there is no driver installed (probably it is Interface 2) and don't re-install the driver for the other interface. - - The manual installation of the driver in Device Manager of Windows is not recommended because the flashing might not work properly. - -After meeting the above requirements, you are free to build and flash via DFU. How to use DFU: - -1. Edit the active launch configuration. -1. In the main tab, select the `Flash over DFU` option. -1. Select a suitable IDF target for DFU -1. Now, if you use the build command, an extra file (dfu.bin) will be created, which can be used later for flashing. - -![DFU actions](https://user-images.githubusercontent.com/24419842/226182180-286099d3-9c1c-4394-abb0-212d43054529.png) - -Additional information, including common errors and known issues, is mentioned in this [guide](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/api-guides/dfu.html#usb-drivers-windows-only). - - -# Application Level Tracing - -ESP-IDF provides a useful feature for program behavior analysis called [Application Level Tracing](https://docs.espressif.com/projects/esp-idf/en/latest/esp32c3/api-guides/app_trace.html?). IDF-Eclipse plugin has UI, that allows the use of start, and stop tracing commands and process received data. To familiarize yourself with this library, you can use the [app_trace_to_host](https://github.com/espressif/esp-idf/tree/release/v5.0/examples/system/app_trace_to_host) project or the [app_trace_basic](https://github.com/espressif/esp-idf/tree/release/v5.1/examples/system/app_trace_basic) project if you are using esp-idf 5.1 and higher. These projects can be created from the plugin itself: -![](docs_readme/images/AppLvlTracing_1.png) - -Before you start using application-level tracing, it is important to create a debug configuration for the project where you must select the board you are using in order to successfully start the OpenOCD server. - -![](docs_readme/images/AppLvlTracing_3.png) - -After the debug configuration is created, right-click on the project in the Project Explorer and click on `ESP-IDF` > `Application Level Tracing`: - -![](docs_readme/images/AppLvlTracing_2.png) - -It can take a while to open the application level tracing dialog because the OpenOCD server starts first, so you don't need to start it externally. At the very top of the application-level trace dialog, there are auto-configured fields that you can change for the trace start command. - -Start command: - -* Syntax: `start [poll_period [trace_size [stop_tmo [wait4halt [skip_size]]]]` -* Argument: - * `outfile`: Path to file to save data from both CPUs. This argument should have the following format: ``file://path/to/file``. - * `poll_period`: Data polling period (in ms) for available trace data. If greater than 0 then command runs in non-blocking mode. By default, 1 ms. - * `trace_size`: Maximum size of data to collect (in bytes). Tracing is stopped after specified amount of data is received. By default -1 (trace size stop trigger is disabled). - * `stop_tmo`: Idle timeout (in sec). Tracing is stopped if there is no data for a specified period of time. By default -1 (disable this stop trigger). Optionally set it to a value longer than the longest pause between tracing commands from the target. - * `wait4halt`: If 0 start tracing immediately, otherwise command waits for the target to be halted (after reset, by breakpoint etc.) and then automatically resumes it and starts tracing. By default, 0. - * `skip_size`: Number of bytes to skip at the start. By default, 0. - -Additional information can be found [here](https://docs.espressif.com/projects/esp-idf/en/latest/esp32c3/api-guides/app_trace.html?). - -![](docs_readme/images/AppLvlTracing_4.png) - -The next two fields `Trace Processing Script` and `Start Parsing Command` are used to parse the output file. - -* `Trace Processing Script` is used to provide the path to the parsing script, by default it is logtrace_proc.py from esp-idf. -* `Start Parsing Command` allows you to check the resulting parsing command and edit it if it's necessary. By default, this field is automatically configured to match `$IDF_PATH/tools/esp_app_trace/logtrace_proc.py/path/to/trace/file/path/to/program/elf/file`. - -Note the `Start parse` button is disabled until a dump file is available. To generate it, click the `Start` button at the bottom of the dialog box. After you click, the button changes to Stop so that you can stop tracking. - -When the output file is generated, you can click on `Start parse` button, and you will see the parsed script output in the Eclipse console: - -![](docs_readme/images/AppLvlTracing_5.png) - - -# Partition Table Editor UI for ESP-IDF - -The Partition Table Editor command allows you to edit your [partition table](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/partition-tables.html) in a more convenient way, where you can see the supported types and subtypes and monitor the correctness of the entered data. - -Steps: - -1. Go to `Project Explorer`, open any IDF Project where you want to have a customized partition table. -2. In `Project Explorer`, right-click on the project and click on `ESP-IDF` > `Partition Table Editor` menu: - - ![partition_table_editor_3](https://user-images.githubusercontent.com/24419842/216105408-ca2e73ce-5df3-4bdd-ac61-b7265deb9b44.png) - - When opening the partition table editor for the selected project, you will see the standard editable content. Errors (if any) will be highlighted. You can hover your mouse over it to get a hint of what it is about: - - ![partition_table_editor_4](https://user-images.githubusercontent.com/24419842/216106804-703b2eb4-b141-48de-8559-0599f072219f.png) - -3. Click "Save" or "Save and Quit" to save your changes. - -To use a customized partition table: - -1. Go to `sdkconfig` and set `Custom partition table CSV` like below: - - ![partition_table_editor](https://user-images.githubusercontent.com/24419842/216104107-2844068b-8412-468b-931f-b4778af4417c.png) - - -# NVS Table Editor - -The NVS Table Editor helps to create a binary file based on key-value pairs provided in a CSV file. The resulting binary file is compatible with NVS architecture defined in [ESP_IDF Non Volatile Storage](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/storage/nvs_flash.html). The expected CSV format is: - -``` - key,type,encoding,value <-- column header (must be the first line) - namespace_name,namespace,, <-- First entry must be of type "namespace" - key1,data,u8,1 - key2,file,string,/path/to/file -``` -> Note: This is based on ESP-IDF [NVS Partition Generator Utility](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/storage/nvs_partition_gen.html). - -Steps: - -1. Right-click on a project in the `Project Explorer` -2. Click on the `ESP-IDF` > `NVS Table Editor` menu option: - - ![NVS Table Editor](https://user-images.githubusercontent.com/24419842/216114697-9f231211-f5dd-431b-9432-93ecc656cfec.png) - -3. Make desired changes to CSV data -4. Save changes by clicking the `Save` button. If everything is ok, you will see an information message at the top of the dialog: - - ![NVS_TABLE_EDITOR_2png](https://user-images.githubusercontent.com/24419842/216115906-9bb4fe55-293b-4c6b-8d22-0aa3520581ab.png) - -5. Generate the partition binary (Choose `encrypt` to encrypt the binary and disable the generate key option to use your own key if desired). You will see an information message at the top of the dialog about the result of generated binaries. You can hover your mouse over it to read the whole message if it's too long: - - ![NVS_Table_Editor_4](https://user-images.githubusercontent.com/24419842/216117261-9bee798a-3a9e-4be5-9466-fc9d3847834b.png) - - > Note: If there are any errors, you will see them highlight, hover on the error icon to read more about the error. Also, you will see an error message at the top of the dialog if saving the CSV file is not successful: - - ![NVS_Table_editor_5](https://user-images.githubusercontent.com/24419842/216118486-69f819fa-7a95-49ae-805e-473cd2c424e8.png) - -After all these steps, you should see `nvs.csv` and `nvs.bin` files in the project directory. - - -# Write Binary to Flash - -Binary data can be written to the ESP’s flash chip via `ESP-IDF` > `Write Binary Data to Flash` command accessible by right click on the project in the project explorer: - -Screenshot 2023-10-16 at 10 51 52 - -After clicking this command, the `Write Binary Data to Flash` dialog box will open. Editable default values ​​are provided for binary path and offset. The correct offset can be checked by looking at the partition table via `ESP-IDF` > `Partition Table Editor` or manually by opening the partitions.csv file - -Screenshot 2023-10-16 at 10 51 27 - -After clicking on the `Flash` button the result of the flash command will be printed inside of this dialog. - -# How to build locally - -1. Install prerequisites Java 11+ and Maven. -2. Run the below commands to clone and build. - - ``` - git clone https://github.com/espressif/idf-eclipse-plugin.git - cd idf-eclipse-plugin - mvn clean verify -Djarsigner.skip=true - ``` - -This will generate p2 update site artifact: - -* Name: `com.espressif.idf.update-*` -* Location: `releng/com.espressif.idf.update/target` - -This artifact can be installed using the mechanism mentioned here - -# How do I get the latest development build - -1. Go to the last commit of the master branch here. -1. Click on a :white_check_mark: green tick mark. -1. Click on `Details`. -1. Click on `Summary` on the left. -1. Scroll down to see the `Artifacts` section. -1. Download `com.espressif.idf.update` p2 update site archive and install as per the instructions mentioned here. - -# Custom IDE Configuration -## Custom build directory - -IDE allows configuring a custom build directory to the project: - -1. Select a project and click on a launch configuration `Edit` button from the top toolbar and this will the launch `Edit Configuration` window. -2. Navigate to the `Build Settings` tab. -3. In the `Additional CMake Arguments` section, provide a custom build directory with arguments `-B ` with an absolute path. Customized build directory path could be within the project or a path from the file system. For example: `-B /Users/myUser/esp/generated`. -4. Click on `Ok` and build the project. - -Note this configuration changes where all the project build artifacts will be generated. - -![](docs_readme/images/custombuilddir.png) - - -# Wokwi Simulator - -1. Install `wokwi-server` as mentioned [here](https://github.com/MabezDev/wokwi-server/) -1. In the Eclipse CDT build environment variables, configure `WOKWI_SERVER_PATH` with the wokwi-server executable path (`Preferences` > `C/C++` > `Build` > `Environment`). -1. Create a new `Run launch configuration` with the `Wokwi Simulator`. -1. Choose a project and add the project ID of the Wokwi project. The ID of a Wokwi project can be found in the URL. E.g., the URL of project ESP32 Rust Blinky is [https://wokwi.com/projects/345932416223806035](https://wokwi.com/projects/345932416223806035) and the project ID is 345932416223806035. -1. Click `Finish` to save the changes. -1. From the IDE Toolbar, click on the `Launch` button to launch the Wokwi simulator. -1. Wokwi Simulator will be launched in the external browser. The serial monitor output is also displayed in the Eclipse CDT build console. -1. To kill a Wokwi simulator, click on the `Stop` button from the toolbar. - -# ESP-IDF Eclipse Plugin Compatibility Matrix - -| IEP | Eclipse | Java | Installer | Description | -| ------ | ------ | ------ |------ | ------ | -| IEP 2.12.1 | Eclipse 2023-03 to Eclipse 2023-12 |Java 17 and above |[espressif-ide-setup-2.12.1-with-esp-idf-5.2.exe](https://github.com/espressif/idf-installer/releases/download/espressif-ide-2.12.1-esp-idf-5.2/espressif-ide-setup-2.12.1-with-esp-idf-5.2.exe) | -| IEP 2.12.0 | Eclipse 2023-03, Eclipse 2023-06, Eclipse 2023-09 |Java 17 and above | [espressif-ide-setup-2.12.0-with-esp-idf-5.1.2](https://github.com/espressif/idf-installer/releases/download/espressif-ide-2.12.0-esp-idf-5.1.2/espressif-ide-setup-2.12.0-with-esp-idf-5.1.2.exe) | -| IEP 2.11.0 | Eclipse 2023-03, Eclipse 2023-06, Eclipse 2023-09 |Java 17 and above |[espressif-ide-setup-2.11.0-with-esp-idf-5.1.1.exe](https://github.com/espressif/idf-installer/releases/download/espressif-ide-2.11.0-esp-idf-5.1.1/espressif-ide-setup-2.11.0-with-esp-idf-5.1.1.exe) | -| IEP 2.10.0 | Eclipse 2022-09,2022-12,2023-03 |Java 17 and above | [espressif-ide-setup-2.10.0-with-esp-idf-5.0.1.exe](https://github.com/espressif/idf-installer/releases/download/untagged-52aeb689780472c126c1/espressif-ide-setup-2.10.0-with-esp-idf-5.0.1.exe)| -| IEP 2.9.1 | Eclipse 2022-09 and Eclipse 2022-12 |Java 17 and above | [espressif-ide-setup-2.9.0-with-esp-idf-5.0.1.exe](https://github.com/espressif/idf-installer/releases/download/espressif-ide-2.9.0-esp-idf-5.0.1/espressif-ide-setup-2.9.0-with-esp-idf-5.0.1.exe) | For Windows Users, it's recommended to use the Windows Offline Installer and upgrade to the latest IEP v2.9.1 plugin| -| IEP 2.9.0 | Eclipse 2022-09 |Java 17 and above | [espressif-ide-setup-2.9.0-with-esp-idf-5.0.1.exe](https://github.com/espressif/idf-installer/releases/download/espressif-ide-2.9.0-esp-idf-5.0.1/espressif-ide-setup-2.9.0-with-esp-idf-5.0.1.exe) | For Windows, it's recommended to use the Windows Offline Installer| - - - # How to raise bugs Please raise the issues [here](https://github.com/espressif/idf-eclipse-plugin/issues) with the complete environment details and log. diff --git a/docs_readme/Espressif-IDE-Windows-Installer.md b/docs_readme/Espressif-IDE-Windows-Installer.md deleted file mode 100644 index b25c600df..000000000 --- a/docs_readme/Espressif-IDE-Windows-Installer.md +++ /dev/null @@ -1,88 +0,0 @@ -# Installing Espressif-IDE by Windows Offline Installer - -## Overview -Espressif-IDE Installer (All-in-One) is an offline installer and it comes with all the required components to work with the ESP-IDF Application development. - -The installer deploys the following components: - -- Embedded Python -- Cross-compilers -- OpenOCD -- CMake and Ninja build tools -- ESP-IDF -- Espressif-IDE -- Amazon Corretto OpenJDK - -As Installer bundles, all the required components and tools including stable esp-idf so people behind corporate firewalls can use the whole solution out-of-box. This also configures all the required build environment variables and tool paths as you launch the IDE. All you could do is to get started with your project direclty without manually configuring anything. This will give you a big boost to your productivity! - -More details about the standard setup of toolchain for Windows can be found in the [windows-setup](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/windows-setup.html). - -## Download - -You can download the latest version of the installer from [here](https://dl.espressif.com/dl/esp-idf/) and run the installer. You can find installer name with `espressif-ide-setup-2.10.0-with-esp-idf-5.0.1` or similar name based on the version of the installer and the version of the ESP-IDF. - -Choose the Installer as shown below. - -drawing - -## Installation - -The installer is an executable file with .exe extension. You can run the installer by double-clicking on it. - -The installer will guide you through the installation process. Please find the step-by-step guide below. - -### Step 1: Choose Language -Select language for the installer and click Ok. - -drawing - -### Step 2: Accept the product license agreement -Read through the product license agreement, and then select `I accept the agreement`. You must accept the product license in order to continue with the installation. Continue by clicking Next. - -drawing - -### Step 3: Pre-installation checks -drawing - -### Step 4: Choose the installation directory -drawing - -### Step 5: Select Components to Install -By default all the components are selected. You can deselect any component if you don't want to install it. -drawing - -### Step 6: Review the installation summary -A review summary is presented before the Espressif-IDE and others are installed. -drawing -drawing - -### Step 6: Finalize the installation -drawing -drawing - -### Step 7: Launch Espressif-IDE -Launch Espressif-IDE by double-clicking on the icon. - -drawing - -### Step 8: Choose Espressif-IDE Workspace -It's advised to select a workspace directory outside the Espressif-IDE Installer folder. -drawing - -### Step 9: Espressif-IDE Workbench -As soon as you launch the Espressif-IDE, it will automatically configure the required environment variables and launch the Welcome page. You can close the Welcome page. You don't need to run any additional install tools from the IDE. - -drawing - -You can verify the CDT Build environment variables from the Eclipse Preferences. - -drawing - -### Step 10: Build Your First Project -As IDE already configured with all the required environment variables, you can start with your project. - -You can find more details for creating a project in the [New Project](https://github.com/espressif/idf-eclipse-plugin#create-a-new-project) section of the documentation. - -drawing - - diff --git a/docs_readme/Espressif-IDE.md b/docs_readme/Espressif-IDE.md deleted file mode 100644 index 8fc7aebf6..000000000 --- a/docs_readme/Espressif-IDE.md +++ /dev/null @@ -1,58 +0,0 @@ -# Espressif-IDE - -## Overview -Espressif-IDE is an Integrated Development Environment(IDE) based on Eclipse CDT for developing IoT Applications using the ESP-IDF framework. It's a standalone and customized IDE built specifically for ESP-IDF. Espressif-IDE comes with the IDF Eclipse plugins, essential Eclipse CDT plugins, and other third-party plugins from the Eclipse platform to support building ESP-IDF applications. - -![](images/espressifide_splash.bmp) - -## Features: -- Easy-to-use IDE built on Eclipse CDT environment -- Specifically built for ESP-IDF application development -- Auto-configuration of the build environment variables -- Integrated toolchain configuration -- New Project Wizards and getting started ESP-IDF examples -- Advanced editing, compiling, and editing with syntax coloring features -- Pre-built function header and function definition navigation -- ESP-IDF and ESP-IDF Tools installation and configuration directly from IDE -- SDK Configuration editor for project-specific settings -- Integrated CMake Editor plug-in for editing CMake files such as CMakeLists.txt -- CMake based build support -- Support for UART and JTAG flashing -- Customized ESP-IDF OpenOCD Debugging with pre-built configuration and settings -- GDB Hardware debugging -- Integrated ESP-IDF serial monitor -- ESP-IDF Terminal with the pre-configured ESP-IDF build environment -- Application size analysis editor for analyzing static memory footprint of your application -- Supports Heap profiling for memory analysis and finding memory leaks -- Supports GDB Stub debugging and Application level tracing -- Supports esp32,esp32s2, esp32s3 and esp32c3 chips -- English and Chinese language support for IDE -- Extensible IDE for other third-party plugins from Eclipse eco-system -- Host operating systems supported: Windows, macOS, and Linux - -## Downloads - -### Espressif-IDE - -You can find the latest Espressif-IDE release notes from [here](https://github.com/espressif/idf-eclipse-plugin/releases). Provided below are the direct download links for various platforms. - -| OS | Download | -| ------------- | ------------- | -| Windows | Espressif-IDE-win32.win32.x86_64 | -| macOS x86_64 | Espressif-IDE-macosx-cocoa-x86_64 | -| macOS aarch64| Espressif-IDE-macosx-cocoa-aarch64 | -| Linux | Espressif-IDE-linux.gtk.x86_64 | - -### macOS security notice (Applicable for Nightly Builds) -On macOS, if you download the archive with the browser, the strict security checks on recent macOS will prevent it to run, and complain that the program is damaged. That’s obviously not true, and the fix is simple, you need to remove the `com.apple.quarantine` extended attribute. -``` -$ xattr -d com.apple.quarantine ~/Downloads/Espressif-IDE-x.x.x-macosx.cocoa.x86_64.tar.gz -``` -After un-archiving, if the application still complains, check/remove the attribute from the Espressif-IDE.app folder too: -``` -$ xattr -dr com.apple.quarantine ~/Downloads/Espressif-IDE.app -``` -### Other Topics -- [Installing Espressif-IDE by Windows Offline Installer](https://github.com/espressif/idf-eclipse-plugin/blob/master/docs_readme/Espressif-IDE-Windows-Installer.md) -- [Updating Espressif-IDE with the Latest Version](https://github.com/espressif/idf-eclipse-plugin#installing-idf-plugin-using-update-site-url) - diff --git a/docs_readme/HeapTracing.md b/docs_readme/HeapTracing.md deleted file mode 100644 index b08980ec7..000000000 --- a/docs_readme/HeapTracing.md +++ /dev/null @@ -1,91 +0,0 @@ -# Heap Tracing - -- [Heap Tracing](#heap-tracing) - - [Generating Dump File](#generating-dump-file) - - [Analyzing the Dump File](#analyzing-the-dump-file) - - [Overview Tab](#overview-tab) - - [Details Tab](#details-tab) - -To perform heap tracing, we need to generate a svdat dump file via debugging. The IDF Eclipse Plugin supports this by adding special breakpoints. To learn more about the configuration at the sdk level and different tracing features please use the following [link](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/heap_debug.html). - -## Generating Dump File - -For the purpose of this document, it is assumed that you know how to create the template project. To create a template project in IDE from the **system** templates named **sysview\_tracing\_heap\_log.** - -1. Now open the sysview\_heap\_log.c file from the project explorer - -![](images/HeapTracing/sysview_heap_log_file.PNG) - -2. Add a breakpoint at a line and right click on the breakpoint icon on the left side of the editor and select Breakpoint Properties… from the context menu. - -![](images/HeapTracing/breakpoint_properties_popup.png) - - -3. The properties window will popup select Actions from the left pane and click on new. - -![](images/HeapTracing/breakpoint_properties_actions.png) - -4. You need to select the Action Type from the Action Type drop down as Heap Tracing. For the initial breakpoint we need to make sure that we select the Start Heap Trace Action. Also specify the location for the file to be saved here, it is recommended that you select a folder inside the project directory and save the file there. It is also important that you name your action to something meaningful so that you can differentiate it later from other actions. Click OK after it is done. - -![](images/HeapTracing/heap_tracing_action.png) - -5. Now we have created an action that can be run when the breakpoint is hit but it still needs to be attached to the breakpoint so we can simply click on Attach button and it will be attached to the breakpoint and will be shown in the Actions for this breakpoint section. - -![](images/HeapTracing/breakpoint_properties_actions_start_attached.png) - -6. Click Apply and Close. - -

-Now we have created a breakpoint that has an action attached to it that will start the tracing and will generate a dump file, but we still need to stop the tracing somewhere before our program ends so that the dump file can be generated so we need another breakpoint and another action that can be used to stop the tracing. For this example, we simply add a breakpoint on line number 102 and set its properties. -

-Follow all the steps from 1 to 4 with one difference that you need to select the Stop Heap Trace checkbox from the action. Also attach the new created action if all steps are followed properly you will see the given action as shown below attached to the breakpoint. - -![](images/HeapTracing/breakpoint_properties_actions_stop_attached.png) - -Click apply and close. - -Now that the breakpoints are added we need to create a debug configuration for our esp32 board and launch it to learn more about creating debug configuration please refer to the main Readme file. - -Once you start the debug using the proper debug configuration for your board the IDE will ask you to switch to the debugger perspective and will stop on the breakpoints we can simply continue the execution of our program for the both added breakpoints. After that is done you can see that the dump file will be generated at the location you specified and if you stored the file in the project directory you can refresh the project by right clicking on it in project explorer and selecting refresh from the context menu. - -Up to this point we have successfully generated a dump file but that dump file is a binary file that is of no use until we parse it and generate some meaningful information. - -## Analyzing the Dump File - -With IDF Eclipse Plugin you can analyze the dump files generated for a project. To analyze svdat dump file simply right click on it and from the context menu select Heap Dump Analysis. - -**Note: It is important to know that for analysis to be run properly the project should have been built and contain the appropriate symbols file** - -![](images/HeapTracing/analysis_context_menu.png) - -After clicking on that be patient it can take a few seconds to a couple of minutes depending upon the dump file and how big is that. - -### Overview Tab - -Once the dump file is parsed you will see something like this your graph can be different based on your own dump file. - -![](images/HeapTracing/overview_tab_tracing.png) - -The graph simply lets you know about the memory consumption over time. Initially all the contexts are collectively shown we can select any context we want form the list of available contexts that corresponds to the contexts that were found in the dump file against the heap events. For example, the below image shows two contexts selected for the graph. - -![](images/HeapTracing/overview_tab_tracing_contexts.png) - -### Details Tab - -Further information regarding the details of the tracing can be found in the details tab. If you click on the details tab you will have something like this the data can vary depending on your dump file. - -![](images/HeapTracing/details_tab_tracing.png) - -The highlighted light orange rows are the ones that can **possibly** be memory leaks. The keyword to know here is possibly because the trace could have been stopped before the free event was found. - -The green highlights show the free heap events. You can also use the check box below View Possible Memory Leaks to only show the entries that are possibly causing memory leakage. - -Each entry here corresponds to an event in heap we can also view the callers for them you can simply right click on any record from the table and select the option Show Callers. - -![](images/HeapTracing/show_callers_context_menu.png) - -Once you click on this you a `Callers View` will popup that will show the call stack for that event in the heap. - -![](images/HeapTracing/callers_view.png) - -You can navigate to the exact line in the code by simply clicking on an entry and it will take you to the location of the caller in the c file. diff --git a/docs_readme/JTAG Flashing.md b/docs_readme/JTAG Flashing.md deleted file mode 100644 index 9a53743a5..000000000 --- a/docs_readme/JTAG Flashing.md +++ /dev/null @@ -1,31 +0,0 @@ -# Upload application via JTAG - -The default option for uploading application is UART. To change it to JTAG, you need to edit launch configuration for your project and select the appropriate option. -To do it, select your project in launch configuration bar and click on wheel to edit launch configuration: - -![](images/JtagFlash_1.png) - -Then select the `Flash Over JTAG` option and fill the `OpenOCD Setup` section. - -Screenshot 2023-03-19 at 16 41 24 - - -If the `Flash Over JTAG` option is not available and you see message like this: - -![](images/JtagFlash_3.png) - -It means that OpenOCD needs to be updated. You can find the latest OpenOCD version on the openocd-esp32 GitHub page. - -## Providing the right path for OpenOCD - -After downloading the necessary OpenOCD version you need to extract it to the new folder in the `.espressif/tools/openocd-esp32/`. So make sure you are following these steps: - -* Download required v0.10.0-esp32-20201202. version or higher for the JTAG Flashing -* Go to `.../.espressif/tools/openocd-esp32/`, create a new folder named `v0.10.0-esp32-20201202` there and extract openOCD there. -* The resulting path to the openocd might have a look like: `.../.espressif/tools/openocd-esp32/v0.10.0-esp32-20201202/openocd-esp32/...` - -After doing this, update the `OPENOCD_SCRIPT` environment variable in the eclipse. - -* Go to `Eclipse > Preferences > C/C++ > Build > Environment` -* Edit `OPENOCD_SCRIPTS` variable by providing the right path to the `openocd/scripts` folder -* As a result, the path to the OpenOCD scipts may look like this: `.../.espressif/tools/openocd-esp32/v0.10.0-esp32-20201202/openocd-esp32/share/openocd/scripts` diff --git a/docs_readme/MissingToolsManualPathUpdateGuide.md b/docs_readme/MissingToolsManualPathUpdateGuide.md deleted file mode 100644 index f9384ecc5..000000000 --- a/docs_readme/MissingToolsManualPathUpdateGuide.md +++ /dev/null @@ -1,36 +0,0 @@ -# Installing Missing Tools and Updating Path - -Some tools are required as mandatory for the IDF and must be installed manually or must be selected when you are using the tools installation wizard on Linux and MAC and only selected recommended tools for windows these tools installation are mandatory and are selected with recommended tools. - -If you have these tools already present on your system you can skip the first step and continue from the second step. -1. In case you want to manually install these tools to the system first please vist [this](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/linux-macos-setup.html) link to install them respective to your platform. - -*Once you have installed the required tools you can move to the next step. -The `PATH` in the IDE is independent of the system's `PATH` variable so we need to configure it.
* -*We will be using CMake as an example but you need to make sure to follow the steps below for all the tools you have installed from the previous link.* - -2. Run the following command to find out the install location of the tools. For CMake `which cmake` This will output the path to the directory where the CMake is installed. If you dont get the path it could mean a trouble with the path in your terminal or installation please consult the documentation again for the installation and correct configuration of the PATH for your system. Your output may look something like this -
-`/opt/homebrew/bin/cmake` -
-We need to copy the path for the directory in which the CMake is present. So the path you will copy will look like this `/opt/homebrew/bin` -
- -Once that is copied you can head over to the IDE. - -3. Open Settings and Go to `C/C++ -> Build -> Environment`. You will see these variables if you have installed the tools. -![](images/ToolsValidation/EnvSettings.png) - -
- -4. Select the `PATH` variable and click `Edit...`
-![](images/ToolsValidation/PathVarEdit.png) - -5. Now paste the path that we previously copeid `/opt/homebrew/bin` at the start of the current path and place a colon `:` after that. Your original `PATH` value will always come after the path you have copied. It should look something like this.
-![](images/ToolsValidation/PathVarEdited.png) -
- - -Now as stated previously this was only for cmake you need to find the install locations of the other required tools and add them in the same way to the `PATH`. After you have done that you can click `OK` and then click `Apply and Close`. - -Once you have configured these correctly you should be able to build the projects. \ No newline at end of file diff --git a/docs_readme/OpenOCD Debugging.md b/docs_readme/OpenOCD Debugging.md deleted file mode 100644 index 1eb6496fd..000000000 --- a/docs_readme/OpenOCD Debugging.md +++ /dev/null @@ -1,104 +0,0 @@ -# ESP-IDF GDB OpenOCD Debugging - -## Create a new debug configuration -Please follow the below steps to create a new debug configuration. -* Right-click on the project -* `Debug As > Debug Configurations...` This will launch a debug configuration window -* On the left Panel, choose `ESP-IDF GDB OpenOCD Debugging` -* Right Click and create `New Configuration` This will create a new debug configuration for your project - -Please navigate through each tab and configure project specific settings. -> **NOTE:** Most of the settings are auto-configured by the plugin. - -![](images/OpenOCDDebug_4.png) - - -The other way to create a debug configuration is from the launch configuration bar: -* Expand list with launch/debug configurations -* Click on `New Launch Configuration...` -* Select `ESP-IDF GDB OpenOCD Debugging` and double click on it or on `Next >` button -* In the `Debugger` tab, check if the `Config options` is right for your board. -* Click on `Finish` - -![](images/OpenOCDDebug_9.png) -## Main Tab -1. Enter the “Name:” of this configuration, the default name is "{project_name} Configuration". -2. On the “Main” tab below, under “Project:”, press “Browse” button and select the project if it's not selected or you want to change it. -3. In the next line “C/C++ Application:” should be a relative path to the elf file, for example, "build\hello_world.elf" for `hello_world` project. If the elf file is not there, then likely this project has not been build yet. After building the project, the elf file will appear there, however, you can change it by pressing "Browse" button. - -The last section on the "Main" tab is "Build (if required) before launching". If you don't want to build the project each time you are pressing the "Debug" button, click “Disable auto build”. - -Points 1 - 3 are shown below. -![](images/OpenOCDDebug_5.png) - -## Debugger Tab -In the `Debugger` tab, all parameters are automatically configured to start debugging, you just need to check if the `Config options` line is appropriate for your board. It automatically adjusts based on `Flash voltage` and `Board` options. If you expand the list of boards, only those that match the selected `Target` will appear. So, for example, if the selected target is `esp32`, you will not see `ESP32-S2-KALUGA-1` in the list, to see it there, you need to change the target to `esp32s2` first. The second option in the debugger tab, which depends on the target, is the `gdb executable`, which is also automatically and dynamically configured based on the target you choose. - -Let's take a look at some other options, that you need to check if they auto configured correctly for you: - -4. The "Executable path" for OpenOCD is based on eclipse preferences, which are configured after tools installation. Check if the "Actual executable" is correct and if it's not, then likely the tools installation went wrong, so you need to check if tools installed correctly to avoid possible problems. If it's still not correct after tools installation, click on "Browse" and select the path to `openocd.exe` manually. -5. In the next step, please make sure that the GDB port is 3333 if you want to use an internal gdb client and the Tcl port is 6666 if you want to use [Application Level Tracing](https://github.com/espressif/idf-eclipse-plugin#application-level-tracing). Also, check `Config options` as described above. -6. In the `GDB Client Setup` section as described above, the gdb executable should be automatically and dynamically configured based on the target you choose. You can change it, by clicking "Browse" button and selecting the path to the gdb executable. By default, the "Commands" line should be `set mem inaccessible-by-default off`. - -Points 4 - 6 are shown below. -![](images/OpenOCDDebug_6.png) - -> **NOTE:** Update the OpenOCD Config options based on the esp board you've choosen. Please check this here https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/tips-and-quirks.html#id1 - -## Startup Tab - -7. By default, the binaries will be uploaded to your board before joining a debug session, so there is no need to flash them to the target separately. If for some reason you don't want to do that, you can uncheck the `Flash every time with application binaries` option. Also, you can check `Enable verbose output` option, this will enable debug level 3 - '-d3'. -8. Under “Initialization Commands”, “Initial Reset.” and “Enable ARM semihosting” are enabled by default. Then, in entry field below, must be the following lines: - - mon reset halt - flushregs - set remote hardware-watchpoint-limit 2 -Points 7 - 8 are shown below. -![](images/OpenOCDDebug_7.png) - -9. Options `Load Symbols` and `Use project binary` are selected. -10. Further down on the same tab, establish an initial breakpoint to halt CPUs after they are reset by debugger. The plugin will set this breakpoint at the beginning of the function entered under “Set break point at:”. Checkout this option and enter the name of the main function e.g. app_main in provided field. -11. Checkout “Continue” option. This will make the program to resume after `mon reset halt` is invoked per point 8. The program will then stop at breakpoint inserted at app_main. - -Points 9 - 11 are shown below. -![](images/OpenOCDDebug_8.png) - -## Common Tab - -You can save your debug logs to an external file. To do this: -* Go-to Common tab. -* Under `Standard Input and Output` section: Select Output file checkbox, enter log file name and path where you want logs to be redirected. -* Apply changes and run your application. - - **NOTE:** Path to the file can be relative if it's located in the workspace (see screenshot below) - - ![](images/OpenOCDDebug_13.png) - -# Preferences for OpenOCD Configuration -OpenOCD path is auto-configured based on the `OPENOCD_SCRIPTS` path defined in the CDT Build environment variables. - -![](images/OpenOCDDebug_2.png) -# Start Debugging - -To start debugging, you need to select your debug configuration, change mode from `Run` to `Debug` and click on launch icon (bug icon). - -![](images/OpenOCDDebug_10.png) - -After stopping the target at the default breakpoint, you will be suggested to switch to the `Debug perspective`. - -![](images/OpenOCDDebug_11.png) - -You can customize the `Debug perspective` in your own way, for example, move some tabs, add additional views that you might find useful, or remove them. To add a view, follow these steps: -* On the top panel of the Eclipse click on `Window` -* `Short View` -* Select the view you want to add - -![](images/OpenOCDDebug_12.png) - -# Troubleshooting -* Please make sure always have the [latest](https://github.com/espressif/idf-eclipse-plugin/releases/) ESP-IDF Eclipse Plugin/Espressif-IDE. -* Please [check](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/index.html#selecting-jtag-adapter) if the board is having JTAG enabled. -* If there is any OpenOCD timeout issue, please [increase the GDB server timeout value](https://www.esp32.com/viewtopic.php?f=40&t=36164#p122701) from the preferences. Usually this happens while working with big size applications. -* If you see any error while debugging, please check this [OpenOCD troubleshooting FAQ guide](https://github.com/espressif/openocd-esp32/wiki/Troubleshooting-FAQ) and see if that helps to resolve the issue. -* If you have any issue and want to enable OpenOCD debugging verbose, please check [Enable verbose output](https://github.com/espressif/idf-eclipse-plugin/blob/master/docs_readme/OpenOCD%20Debugging.md#startup-tab) option from the startup tab. - diff --git a/docs_readme/clangd_cdt_support.md b/docs_readme/clangd_cdt_support.md deleted file mode 100644 index 4885fb20b..000000000 --- a/docs_readme/clangd_cdt_support.md +++ /dev/null @@ -1,53 +0,0 @@ -# Espressif-IDE LSP Support for C/C++ Editor. - -The Espressif-IDE 3.0.0 (and higher) now includes the [Eclipse CDT-LSP](https://github.com/eclipse-cdt/cdt-lsp/), enabling support for the latest C/C++ standards and providing an LSP-based C/C++ Editor. This editor, powered by the [LLVM](https://clangd.llvm.org/) clangd C/C++ language server, offers advanced functionality for ESP-IDF developers. - -In line with this enhancement, we've discontinued support for the standard CDT Editor/Indexer, as it only offers support for up to C++ 14. This has been replaced with a new LSP editor, especially considering that ESP-IDF now utilizes C++ 20 (with GCC 11.2) in v5.0.x, transitions to C++ 23 (with GCC 12.1) in v5.1, and to C++ 23 with GCC 13.1 in v5.2 - -The LSP powered C/C++ editor greatly benefits ESP-IDF developers by aligning with the latest language standards and compiler versions, enhancing productivity, and improving code quality. - -You can find more details on the LSP based C/C++ Editor features [here](https://github.com/eclipse-cdt/cdt-lsp/). - -## Prerequisites -* You need to have Espressif-IDE 3.0.0 (and higher) to have access to the LSP powered C/C++ editor. -* If you are updating Eclipse CDT or Espressif-IDE via the update site, you need to select the ESP-IDF Eclipse Plugin and its dependencies, as shown below: - - ![](images/clangd/cdtlsp_updatesite.png) - -## Clangd Configuration - -By default, the esp-clang toolchain is installed as a part of the ESP-IDF tools installation process, and clangd **Path** is configured in the preferences. - -The **Drivers** path and **--compile-commands-dir** path will be configured based on the selected target(esp32, esp32c6 etc) and project you're building. - -However, if there are any issues in configuration, this can be configured in the following way. - - -1. Go to `Window` > `Preferences` > `C/C++` > `Editor(LSP)` -2. Navigate to `clangd` node -3. Provide `Drivers` path as shown in the screenshot. -4. Set `--compile-commands-dir=/project/build`in the additional argument section. -5. Click on `Apply and Close`. - - ![Configuration settings for clangd in Espressif-IDE](images/clangd/clangd_config.png) - -By default, when you create a new project, a `.clangd` configuration file is created with the following arguments. - -However, if you are dealing with an existing project, please create a `.clangd` file at the root of the project and add the following content. - -```yaml -CompileFlags: - CompilationDatabase: build - Remove: [-m*, -f*] -``` - -## Disable CDT Indexer -With Espressif-IDE 3.0.0 (and higher), the CDT Indexer is disabled by default; instead, the LSP Indexer server will be used for code analysis. - -If, for some reason, it is not disabled, please follow the steps below to disable it. - -1. Go to `Window` > `Preferences` > `C/C++` > `Indexer` -2. Uncheck `Enable Indexer` option and then click on `Apply and Close`. - - - ![](images/clangd/cdt_indexer_disable.png) diff --git a/docs_readme/images/10_serial_terminal.png b/docs_readme/images/10_serial_terminal.png deleted file mode 100644 index 0cc5b4ac9..000000000 Binary files a/docs_readme/images/10_serial_terminal.png and /dev/null differ diff --git a/docs_readme/images/11_launch_configuration.png b/docs_readme/images/11_launch_configuration.png deleted file mode 100644 index 75b83ff12..000000000 Binary files a/docs_readme/images/11_launch_configuration.png and /dev/null differ diff --git a/docs_readme/images/12_flashing.png b/docs_readme/images/12_flashing.png deleted file mode 100644 index 281787b7b..000000000 Binary files a/docs_readme/images/12_flashing.png and /dev/null differ diff --git a/docs_readme/images/13_sdkconfig_editor.png b/docs_readme/images/13_sdkconfig_editor.png deleted file mode 100644 index ced8f764b..000000000 Binary files a/docs_readme/images/13_sdkconfig_editor.png and /dev/null differ diff --git a/docs_readme/images/1_idffeature_install.png b/docs_readme/images/1_idffeature_install.png deleted file mode 100644 index 3a557aa14..000000000 Binary files a/docs_readme/images/1_idffeature_install.png and /dev/null differ diff --git a/docs_readme/images/2_environment_pref.png b/docs_readme/images/2_environment_pref.png deleted file mode 100644 index fb00c89cd..000000000 Binary files a/docs_readme/images/2_environment_pref.png and /dev/null differ diff --git a/docs_readme/images/3_new_project_default.png b/docs_readme/images/3_new_project_default.png deleted file mode 100644 index 0832a08c5..000000000 Binary files a/docs_readme/images/3_new_project_default.png and /dev/null differ diff --git a/docs_readme/images/4_new_project_templates.png b/docs_readme/images/4_new_project_templates.png deleted file mode 100644 index 4d01524fd..000000000 Binary files a/docs_readme/images/4_new_project_templates.png and /dev/null differ diff --git a/docs_readme/images/5_import_project.png b/docs_readme/images/5_import_project.png deleted file mode 100644 index 6ec06fb33..000000000 Binary files a/docs_readme/images/5_import_project.png and /dev/null differ diff --git a/docs_readme/images/6_core_build_toolchains.png b/docs_readme/images/6_core_build_toolchains.png deleted file mode 100644 index 59e8190a8..000000000 Binary files a/docs_readme/images/6_core_build_toolchains.png and /dev/null differ diff --git a/docs_readme/images/7_cmake_toolchain.png b/docs_readme/images/7_cmake_toolchain.png deleted file mode 100644 index ba3131d1d..000000000 Binary files a/docs_readme/images/7_cmake_toolchain.png and /dev/null differ diff --git a/docs_readme/images/8_launch_target.png b/docs_readme/images/8_launch_target.png deleted file mode 100644 index ff7a70417..000000000 Binary files a/docs_readme/images/8_launch_target.png and /dev/null differ diff --git a/docs_readme/images/9_cmake_build.png b/docs_readme/images/9_cmake_build.png deleted file mode 100644 index b983ff412..000000000 Binary files a/docs_readme/images/9_cmake_build.png and /dev/null differ diff --git a/docs_readme/images/AppLvlTracing_1.png b/docs_readme/images/AppLvlTracing_1.png deleted file mode 100644 index cedbc5987..000000000 Binary files a/docs_readme/images/AppLvlTracing_1.png and /dev/null differ diff --git a/docs_readme/images/AppLvlTracing_2.png b/docs_readme/images/AppLvlTracing_2.png deleted file mode 100644 index 017a3a3ae..000000000 Binary files a/docs_readme/images/AppLvlTracing_2.png and /dev/null differ diff --git a/docs_readme/images/AppLvlTracing_3.png b/docs_readme/images/AppLvlTracing_3.png deleted file mode 100644 index 4e2e506d8..000000000 Binary files a/docs_readme/images/AppLvlTracing_3.png and /dev/null differ diff --git a/docs_readme/images/AppLvlTracing_4.png b/docs_readme/images/AppLvlTracing_4.png deleted file mode 100644 index 45beebf01..000000000 Binary files a/docs_readme/images/AppLvlTracing_4.png and /dev/null differ diff --git a/docs_readme/images/AppLvlTracing_5.png b/docs_readme/images/AppLvlTracing_5.png deleted file mode 100644 index fc7ca2c95..000000000 Binary files a/docs_readme/images/AppLvlTracing_5.png and /dev/null differ diff --git a/docs_readme/images/CDT_Build_Console.png b/docs_readme/images/CDT_Build_Console.png deleted file mode 100644 index 4d79391df..000000000 Binary files a/docs_readme/images/CDT_Build_Console.png and /dev/null differ diff --git a/docs_readme/images/CoreDumpDebugging/sdkconfig_editor.png b/docs_readme/images/CoreDumpDebugging/sdkconfig_editor.png deleted file mode 100644 index ec63dbcfa..000000000 Binary files a/docs_readme/images/CoreDumpDebugging/sdkconfig_editor.png and /dev/null differ diff --git a/docs_readme/images/ESP-IDF_Components/components_window.png b/docs_readme/images/ESP-IDF_Components/components_window.png deleted file mode 100644 index de432f634..000000000 Binary files a/docs_readme/images/ESP-IDF_Components/components_window.png and /dev/null differ diff --git a/docs_readme/images/ESP-IDF_Components/install_components.png b/docs_readme/images/ESP-IDF_Components/install_components.png deleted file mode 100644 index 5f75a726f..000000000 Binary files a/docs_readme/images/ESP-IDF_Components/install_components.png and /dev/null differ diff --git a/docs_readme/images/GDBStubDebugging/code_example.png b/docs_readme/images/GDBStubDebugging/code_example.png deleted file mode 100644 index 23cdfe7ea..000000000 Binary files a/docs_readme/images/GDBStubDebugging/code_example.png and /dev/null differ diff --git a/docs_readme/images/GDBStubDebugging/debug_panic_mode.png b/docs_readme/images/GDBStubDebugging/debug_panic_mode.png deleted file mode 100644 index 63d95df22..000000000 Binary files a/docs_readme/images/GDBStubDebugging/debug_panic_mode.png and /dev/null differ diff --git a/docs_readme/images/GDBStubDebugging/sdkconfig_editor.png b/docs_readme/images/GDBStubDebugging/sdkconfig_editor.png deleted file mode 100644 index b4aed75f8..000000000 Binary files a/docs_readme/images/GDBStubDebugging/sdkconfig_editor.png and /dev/null differ diff --git a/docs_readme/images/GDBStubDebugging/sdkconfig_editor_panic_behavior.png b/docs_readme/images/GDBStubDebugging/sdkconfig_editor_panic_behavior.png deleted file mode 100644 index 5057f99af..000000000 Binary files a/docs_readme/images/GDBStubDebugging/sdkconfig_editor_panic_behavior.png and /dev/null differ diff --git a/docs_readme/images/HeapTracing/analysis_context_menu.png b/docs_readme/images/HeapTracing/analysis_context_menu.png deleted file mode 100644 index 32715eed8..000000000 Binary files a/docs_readme/images/HeapTracing/analysis_context_menu.png and /dev/null differ diff --git a/docs_readme/images/HeapTracing/breakpoint_properties_actions.png b/docs_readme/images/HeapTracing/breakpoint_properties_actions.png deleted file mode 100644 index 095b89796..000000000 Binary files a/docs_readme/images/HeapTracing/breakpoint_properties_actions.png and /dev/null differ diff --git a/docs_readme/images/HeapTracing/breakpoint_properties_actions_start_attached.png b/docs_readme/images/HeapTracing/breakpoint_properties_actions_start_attached.png deleted file mode 100644 index 738cd9fd1..000000000 Binary files a/docs_readme/images/HeapTracing/breakpoint_properties_actions_start_attached.png and /dev/null differ diff --git a/docs_readme/images/HeapTracing/breakpoint_properties_actions_stop_attached.png b/docs_readme/images/HeapTracing/breakpoint_properties_actions_stop_attached.png deleted file mode 100644 index 8462844d5..000000000 Binary files a/docs_readme/images/HeapTracing/breakpoint_properties_actions_stop_attached.png and /dev/null differ diff --git a/docs_readme/images/HeapTracing/breakpoint_properties_popup.png b/docs_readme/images/HeapTracing/breakpoint_properties_popup.png deleted file mode 100644 index b13ac9b1b..000000000 Binary files a/docs_readme/images/HeapTracing/breakpoint_properties_popup.png and /dev/null differ diff --git a/docs_readme/images/HeapTracing/callers_view.png b/docs_readme/images/HeapTracing/callers_view.png deleted file mode 100644 index d9211a027..000000000 Binary files a/docs_readme/images/HeapTracing/callers_view.png and /dev/null differ diff --git a/docs_readme/images/HeapTracing/details_tab_tracing.png b/docs_readme/images/HeapTracing/details_tab_tracing.png deleted file mode 100644 index f59c44a41..000000000 Binary files a/docs_readme/images/HeapTracing/details_tab_tracing.png and /dev/null differ diff --git a/docs_readme/images/HeapTracing/heap_tracing_action.png b/docs_readme/images/HeapTracing/heap_tracing_action.png deleted file mode 100644 index 7a344d9a6..000000000 Binary files a/docs_readme/images/HeapTracing/heap_tracing_action.png and /dev/null differ diff --git a/docs_readme/images/HeapTracing/overview_tab_tracing.png b/docs_readme/images/HeapTracing/overview_tab_tracing.png deleted file mode 100644 index f948ddd09..000000000 Binary files a/docs_readme/images/HeapTracing/overview_tab_tracing.png and /dev/null differ diff --git a/docs_readme/images/HeapTracing/overview_tab_tracing_contexts.png b/docs_readme/images/HeapTracing/overview_tab_tracing_contexts.png deleted file mode 100644 index f3be594ef..000000000 Binary files a/docs_readme/images/HeapTracing/overview_tab_tracing_contexts.png and /dev/null differ diff --git a/docs_readme/images/HeapTracing/show_callers_context_menu.png b/docs_readme/images/HeapTracing/show_callers_context_menu.png deleted file mode 100644 index 04595139b..000000000 Binary files a/docs_readme/images/HeapTracing/show_callers_context_menu.png and /dev/null differ diff --git a/docs_readme/images/HeapTracing/sysview_heap_log_file.PNG b/docs_readme/images/HeapTracing/sysview_heap_log_file.PNG deleted file mode 100644 index 3540798c5..000000000 Binary files a/docs_readme/images/HeapTracing/sysview_heap_log_file.PNG and /dev/null differ diff --git a/docs_readme/images/IDF_tools_console.png b/docs_readme/images/IDF_tools_console.png deleted file mode 100644 index a47f7be88..000000000 Binary files a/docs_readme/images/IDF_tools_console.png and /dev/null differ diff --git a/docs_readme/images/JtagFlash_1.png b/docs_readme/images/JtagFlash_1.png deleted file mode 100644 index 15676cefc..000000000 Binary files a/docs_readme/images/JtagFlash_1.png and /dev/null differ diff --git a/docs_readme/images/JtagFlash_2.png b/docs_readme/images/JtagFlash_2.png deleted file mode 100644 index 7d2bc7a4a..000000000 Binary files a/docs_readme/images/JtagFlash_2.png and /dev/null differ diff --git a/docs_readme/images/JtagFlash_3.png b/docs_readme/images/JtagFlash_3.png deleted file mode 100644 index 20ad7f30e..000000000 Binary files a/docs_readme/images/JtagFlash_3.png and /dev/null differ diff --git a/docs_readme/images/OpenOCDDebug_1.png b/docs_readme/images/OpenOCDDebug_1.png deleted file mode 100644 index 0f68dcd30..000000000 Binary files a/docs_readme/images/OpenOCDDebug_1.png and /dev/null differ diff --git a/docs_readme/images/OpenOCDDebug_10.png b/docs_readme/images/OpenOCDDebug_10.png deleted file mode 100644 index 377aaf275..000000000 Binary files a/docs_readme/images/OpenOCDDebug_10.png and /dev/null differ diff --git a/docs_readme/images/OpenOCDDebug_11.png b/docs_readme/images/OpenOCDDebug_11.png deleted file mode 100644 index 481113e97..000000000 Binary files a/docs_readme/images/OpenOCDDebug_11.png and /dev/null differ diff --git a/docs_readme/images/OpenOCDDebug_12.png b/docs_readme/images/OpenOCDDebug_12.png deleted file mode 100644 index caf8a4e60..000000000 Binary files a/docs_readme/images/OpenOCDDebug_12.png and /dev/null differ diff --git a/docs_readme/images/OpenOCDDebug_13.png b/docs_readme/images/OpenOCDDebug_13.png deleted file mode 100644 index 42c2b9bc9..000000000 Binary files a/docs_readme/images/OpenOCDDebug_13.png and /dev/null differ diff --git a/docs_readme/images/OpenOCDDebug_2.png b/docs_readme/images/OpenOCDDebug_2.png deleted file mode 100644 index 30cfc1b89..000000000 Binary files a/docs_readme/images/OpenOCDDebug_2.png and /dev/null differ diff --git a/docs_readme/images/OpenOCDDebug_3.png b/docs_readme/images/OpenOCDDebug_3.png deleted file mode 100644 index eb3c424f8..000000000 Binary files a/docs_readme/images/OpenOCDDebug_3.png and /dev/null differ diff --git a/docs_readme/images/OpenOCDDebug_4.png b/docs_readme/images/OpenOCDDebug_4.png deleted file mode 100644 index 799c200b1..000000000 Binary files a/docs_readme/images/OpenOCDDebug_4.png and /dev/null differ diff --git a/docs_readme/images/OpenOCDDebug_5.png b/docs_readme/images/OpenOCDDebug_5.png deleted file mode 100644 index 16b729c7e..000000000 Binary files a/docs_readme/images/OpenOCDDebug_5.png and /dev/null differ diff --git a/docs_readme/images/OpenOCDDebug_6.png b/docs_readme/images/OpenOCDDebug_6.png deleted file mode 100644 index e4d8723c4..000000000 Binary files a/docs_readme/images/OpenOCDDebug_6.png and /dev/null differ diff --git a/docs_readme/images/OpenOCDDebug_7.png b/docs_readme/images/OpenOCDDebug_7.png deleted file mode 100644 index c7e381778..000000000 Binary files a/docs_readme/images/OpenOCDDebug_7.png and /dev/null differ diff --git a/docs_readme/images/OpenOCDDebug_8.png b/docs_readme/images/OpenOCDDebug_8.png deleted file mode 100644 index 548671d83..000000000 Binary files a/docs_readme/images/OpenOCDDebug_8.png and /dev/null differ diff --git a/docs_readme/images/OpenOCDDebug_9.png b/docs_readme/images/OpenOCDDebug_9.png deleted file mode 100644 index 9e5307bec..000000000 Binary files a/docs_readme/images/OpenOCDDebug_9.png and /dev/null differ diff --git a/docs_readme/images/Preference_recorder.png b/docs_readme/images/Preference_recorder.png deleted file mode 100644 index 7ba725a61..000000000 Binary files a/docs_readme/images/Preference_recorder.png and /dev/null differ diff --git a/docs_readme/images/ToolsManager/ESP-IDF_Configuration_Download_or_Use_ESP-IDF.png b/docs_readme/images/ToolsManager/ESP-IDF_Configuration_Download_or_Use_ESP-IDF.png deleted file mode 100644 index 888dca0fc..000000000 Binary files a/docs_readme/images/ToolsManager/ESP-IDF_Configuration_Download_or_Use_ESP-IDF.png and /dev/null differ diff --git a/docs_readme/images/ToolsManager/ESP-IDF_Manager_Editor_Screen.png b/docs_readme/images/ToolsManager/ESP-IDF_Manager_Editor_Screen.png deleted file mode 100644 index a94e900ab..000000000 Binary files a/docs_readme/images/ToolsManager/ESP-IDF_Manager_Editor_Screen.png and /dev/null differ diff --git a/docs_readme/images/ToolsManager/ESP-IDF_Manager_Multiple_versions.png b/docs_readme/images/ToolsManager/ESP-IDF_Manager_Multiple_versions.png deleted file mode 100644 index 77fba0f43..000000000 Binary files a/docs_readme/images/ToolsManager/ESP-IDF_Manager_Multiple_versions.png and /dev/null differ diff --git a/docs_readme/images/ToolsManager/Tool_installed_and_activated.png b/docs_readme/images/ToolsManager/Tool_installed_and_activated.png deleted file mode 100644 index dbe98b931..000000000 Binary files a/docs_readme/images/ToolsManager/Tool_installed_and_activated.png and /dev/null differ diff --git a/docs_readme/images/ToolsValidation/EnvSettings.png b/docs_readme/images/ToolsValidation/EnvSettings.png deleted file mode 100644 index 36d320a0f..000000000 Binary files a/docs_readme/images/ToolsValidation/EnvSettings.png and /dev/null differ diff --git a/docs_readme/images/ToolsValidation/PathVarEdit.png b/docs_readme/images/ToolsValidation/PathVarEdit.png deleted file mode 100644 index 7211fe937..000000000 Binary files a/docs_readme/images/ToolsValidation/PathVarEdit.png and /dev/null differ diff --git a/docs_readme/images/ToolsValidation/PathVarEdited.png b/docs_readme/images/ToolsValidation/PathVarEdited.png deleted file mode 100644 index 55de61112..000000000 Binary files a/docs_readme/images/ToolsValidation/PathVarEdited.png and /dev/null differ diff --git a/docs_readme/images/Update_plugins.png b/docs_readme/images/Update_plugins.png deleted file mode 100644 index 20684dc56..000000000 Binary files a/docs_readme/images/Update_plugins.png and /dev/null differ diff --git a/docs_readme/images/buildconfiguration_clang.png b/docs_readme/images/buildconfiguration_clang.png deleted file mode 100644 index 8b2940350..000000000 Binary files a/docs_readme/images/buildconfiguration_clang.png and /dev/null differ diff --git a/docs_readme/images/change_language.png b/docs_readme/images/change_language.png deleted file mode 100644 index ec74b2658..000000000 Binary files a/docs_readme/images/change_language.png and /dev/null differ diff --git a/docs_readme/images/cland_starting.png b/docs_readme/images/cland_starting.png deleted file mode 100644 index 7952803ab..000000000 Binary files a/docs_readme/images/cland_starting.png and /dev/null differ diff --git a/docs_readme/images/clangd/build_settings_clang.png b/docs_readme/images/clangd/build_settings_clang.png deleted file mode 100644 index 3ecc47db6..000000000 Binary files a/docs_readme/images/clangd/build_settings_clang.png and /dev/null differ diff --git a/docs_readme/images/clangd/cdt_indexer_disable.png b/docs_readme/images/clangd/cdt_indexer_disable.png deleted file mode 100644 index 115608363..000000000 Binary files a/docs_readme/images/clangd/cdt_indexer_disable.png and /dev/null differ diff --git a/docs_readme/images/clangd/cdtlsp_updatesite.png b/docs_readme/images/clangd/cdtlsp_updatesite.png deleted file mode 100644 index 577c48255..000000000 Binary files a/docs_readme/images/clangd/cdtlsp_updatesite.png and /dev/null differ diff --git a/docs_readme/images/clangd/clang_compiler_config.png b/docs_readme/images/clangd/clang_compiler_config.png deleted file mode 100644 index dd8161129..000000000 Binary files a/docs_readme/images/clangd/clang_compiler_config.png and /dev/null differ diff --git a/docs_readme/images/clangd/clangd_config.png b/docs_readme/images/clangd/clangd_config.png deleted file mode 100644 index 56c268757..000000000 Binary files a/docs_readme/images/clangd/clangd_config.png and /dev/null differ diff --git a/docs_readme/images/clangd/clangd_context_help.png b/docs_readme/images/clangd/clangd_context_help.png deleted file mode 100644 index 75bc9333c..000000000 Binary files a/docs_readme/images/clangd/clangd_context_help.png and /dev/null differ diff --git a/docs_readme/images/clangd/clangd_editor.png b/docs_readme/images/clangd/clangd_editor.png deleted file mode 100644 index bcf7c302a..000000000 Binary files a/docs_readme/images/clangd/clangd_editor.png and /dev/null differ diff --git a/docs_readme/images/clangd/new_cmake_clang_toolchain_config.png b/docs_readme/images/clangd/new_cmake_clang_toolchain_config.png deleted file mode 100644 index 898240eb6..000000000 Binary files a/docs_readme/images/clangd/new_cmake_clang_toolchain_config.png and /dev/null differ diff --git a/docs_readme/images/clangd_consolelog_config.png b/docs_readme/images/clangd_consolelog_config.png deleted file mode 100644 index a80cb4c97..000000000 Binary files a/docs_readme/images/clangd_consolelog_config.png and /dev/null differ diff --git a/docs_readme/images/clangd_generic_editor.png b/docs_readme/images/clangd_generic_editor.png deleted file mode 100644 index 6199df9a2..000000000 Binary files a/docs_readme/images/clangd_generic_editor.png and /dev/null differ diff --git a/docs_readme/images/clangd_preference.png b/docs_readme/images/clangd_preference.png deleted file mode 100644 index 26a3b0a27..000000000 Binary files a/docs_readme/images/clangd_preference.png and /dev/null differ diff --git a/docs_readme/images/clangd_proposals.png b/docs_readme/images/clangd_proposals.png deleted file mode 100644 index a17ca8880..000000000 Binary files a/docs_readme/images/clangd_proposals.png and /dev/null differ diff --git a/docs_readme/images/clangd_updatesite.png b/docs_readme/images/clangd_updatesite.png deleted file mode 100644 index 9aad721da..000000000 Binary files a/docs_readme/images/clangd_updatesite.png and /dev/null differ diff --git a/docs_readme/images/cmake_editor_ca.png b/docs_readme/images/cmake_editor_ca.png deleted file mode 100644 index 654b4bc3b..000000000 Binary files a/docs_readme/images/cmake_editor_ca.png and /dev/null differ diff --git a/docs_readme/images/cmake_editor_preferences.png b/docs_readme/images/cmake_editor_preferences.png deleted file mode 100644 index e503b1fa0..000000000 Binary files a/docs_readme/images/cmake_editor_preferences.png and /dev/null differ diff --git a/docs_readme/images/code_analysis_disable_symbols.png b/docs_readme/images/code_analysis_disable_symbols.png deleted file mode 100644 index 64478c0f0..000000000 Binary files a/docs_readme/images/code_analysis_disable_symbols.png and /dev/null differ diff --git a/docs_readme/images/custombuilddir.png b/docs_readme/images/custombuilddir.png deleted file mode 100644 index 6b4d18bf3..000000000 Binary files a/docs_readme/images/custombuilddir.png and /dev/null differ diff --git a/docs_readme/images/espressifide_splash.bmp b/docs_readme/images/espressifide_splash.bmp deleted file mode 100644 index b63e36b8a..000000000 Binary files a/docs_readme/images/espressifide_splash.bmp and /dev/null differ diff --git a/docs_readme/images/export_log.png b/docs_readme/images/export_log.png deleted file mode 100644 index ca0b50a21..000000000 Binary files a/docs_readme/images/export_log.png and /dev/null differ diff --git a/docs_readme/images/icons/build.png b/docs_readme/images/icons/build.png deleted file mode 100644 index c0272bb5d..000000000 Binary files a/docs_readme/images/icons/build.png and /dev/null differ diff --git a/docs_readme/images/icons/debug.png b/docs_readme/images/icons/debug.png deleted file mode 100644 index 59875d1b3..000000000 Binary files a/docs_readme/images/icons/debug.png and /dev/null differ diff --git a/docs_readme/images/icons/delete.png b/docs_readme/images/icons/delete.png deleted file mode 100644 index 5f0038585..000000000 Binary files a/docs_readme/images/icons/delete.png and /dev/null differ diff --git a/docs_readme/images/icons/run.png b/docs_readme/images/icons/run.png deleted file mode 100644 index 08571c1f2..000000000 Binary files a/docs_readme/images/icons/run.png and /dev/null differ diff --git a/docs_readme/images/icons/terminate.png b/docs_readme/images/icons/terminate.png deleted file mode 100644 index 4679b9375..000000000 Binary files a/docs_readme/images/icons/terminate.png and /dev/null differ diff --git a/docs_readme/images/idf_terminal.png b/docs_readme/images/idf_terminal.png deleted file mode 100644 index 9db992ae5..000000000 Binary files a/docs_readme/images/idf_terminal.png and /dev/null differ diff --git a/docs_readme/images/idf_update_site_install.png b/docs_readme/images/idf_update_site_install.png deleted file mode 100644 index a9232fd07..000000000 Binary files a/docs_readme/images/idf_update_site_install.png and /dev/null differ diff --git a/docs_readme/images/linux-logo.png b/docs_readme/images/linux-logo.png deleted file mode 100644 index 1112db655..000000000 Binary files a/docs_readme/images/linux-logo.png and /dev/null differ diff --git a/docs_readme/images/macos-logo.png b/docs_readme/images/macos-logo.png deleted file mode 100644 index 289d1f601..000000000 Binary files a/docs_readme/images/macos-logo.png and /dev/null differ diff --git a/docs_readme/images/market_place.png b/docs_readme/images/market_place.png deleted file mode 100644 index 708c26249..000000000 Binary files a/docs_readme/images/market_place.png and /dev/null differ diff --git a/docs_readme/images/sizeanalysis_details.png b/docs_readme/images/sizeanalysis_details.png deleted file mode 100644 index eead18e29..000000000 Binary files a/docs_readme/images/sizeanalysis_details.png and /dev/null differ diff --git a/docs_readme/images/sizeanalysis_overview.png b/docs_readme/images/sizeanalysis_overview.png deleted file mode 100644 index a537df6db..000000000 Binary files a/docs_readme/images/sizeanalysis_overview.png and /dev/null differ diff --git a/docs_readme/images/windows-installation/ide_windows_installer_0.png b/docs_readme/images/windows-installation/ide_windows_installer_0.png deleted file mode 100644 index 07f721223..000000000 Binary files a/docs_readme/images/windows-installation/ide_windows_installer_0.png and /dev/null differ diff --git a/docs_readme/images/windows-installation/ide_windows_installer_1.png b/docs_readme/images/windows-installation/ide_windows_installer_1.png deleted file mode 100644 index 5dfa2525f..000000000 Binary files a/docs_readme/images/windows-installation/ide_windows_installer_1.png and /dev/null differ diff --git a/docs_readme/images/windows-installation/ide_windows_installer_10.png b/docs_readme/images/windows-installation/ide_windows_installer_10.png deleted file mode 100644 index c096dde02..000000000 Binary files a/docs_readme/images/windows-installation/ide_windows_installer_10.png and /dev/null differ diff --git a/docs_readme/images/windows-installation/ide_windows_installer_11.png b/docs_readme/images/windows-installation/ide_windows_installer_11.png deleted file mode 100644 index c0d48024a..000000000 Binary files a/docs_readme/images/windows-installation/ide_windows_installer_11.png and /dev/null differ diff --git a/docs_readme/images/windows-installation/ide_windows_installer_12.png b/docs_readme/images/windows-installation/ide_windows_installer_12.png deleted file mode 100644 index 3a150228a..000000000 Binary files a/docs_readme/images/windows-installation/ide_windows_installer_12.png and /dev/null differ diff --git a/docs_readme/images/windows-installation/ide_windows_installer_13.png b/docs_readme/images/windows-installation/ide_windows_installer_13.png deleted file mode 100644 index d6d924943..000000000 Binary files a/docs_readme/images/windows-installation/ide_windows_installer_13.png and /dev/null differ diff --git a/docs_readme/images/windows-installation/ide_windows_installer_14.png b/docs_readme/images/windows-installation/ide_windows_installer_14.png deleted file mode 100644 index b4f34451f..000000000 Binary files a/docs_readme/images/windows-installation/ide_windows_installer_14.png and /dev/null differ diff --git a/docs_readme/images/windows-installation/ide_windows_installer_2.png b/docs_readme/images/windows-installation/ide_windows_installer_2.png deleted file mode 100644 index fafea72d9..000000000 Binary files a/docs_readme/images/windows-installation/ide_windows_installer_2.png and /dev/null differ diff --git a/docs_readme/images/windows-installation/ide_windows_installer_3.png b/docs_readme/images/windows-installation/ide_windows_installer_3.png deleted file mode 100644 index a02a7bba4..000000000 Binary files a/docs_readme/images/windows-installation/ide_windows_installer_3.png and /dev/null differ diff --git a/docs_readme/images/windows-installation/ide_windows_installer_4.png b/docs_readme/images/windows-installation/ide_windows_installer_4.png deleted file mode 100644 index 60d7e40d8..000000000 Binary files a/docs_readme/images/windows-installation/ide_windows_installer_4.png and /dev/null differ diff --git a/docs_readme/images/windows-installation/ide_windows_installer_5.png b/docs_readme/images/windows-installation/ide_windows_installer_5.png deleted file mode 100644 index 3b446678f..000000000 Binary files a/docs_readme/images/windows-installation/ide_windows_installer_5.png and /dev/null differ diff --git a/docs_readme/images/windows-installation/ide_windows_installer_6.png b/docs_readme/images/windows-installation/ide_windows_installer_6.png deleted file mode 100644 index 3b1abea39..000000000 Binary files a/docs_readme/images/windows-installation/ide_windows_installer_6.png and /dev/null differ diff --git a/docs_readme/images/windows-installation/ide_windows_installer_7.png b/docs_readme/images/windows-installation/ide_windows_installer_7.png deleted file mode 100644 index de1b76351..000000000 Binary files a/docs_readme/images/windows-installation/ide_windows_installer_7.png and /dev/null differ diff --git a/docs_readme/images/windows-installation/ide_windows_installer_8.png b/docs_readme/images/windows-installation/ide_windows_installer_8.png deleted file mode 100644 index eba106a96..000000000 Binary files a/docs_readme/images/windows-installation/ide_windows_installer_8.png and /dev/null differ diff --git a/docs_readme/images/windows-installation/ide_windows_installer_9.png b/docs_readme/images/windows-installation/ide_windows_installer_9.png deleted file mode 100644 index 1e6a26f7c..000000000 Binary files a/docs_readme/images/windows-installation/ide_windows_installer_9.png and /dev/null differ diff --git a/docs_readme/images/windows-logo.png b/docs_readme/images/windows-logo.png deleted file mode 100644 index 122f53a2c..000000000 Binary files a/docs_readme/images/windows-logo.png and /dev/null differ diff --git a/docs_readme/images/zh/10_serial_terminal.png b/docs_readme/images/zh/10_serial_terminal.png deleted file mode 100644 index 15046a608..000000000 Binary files a/docs_readme/images/zh/10_serial_terminal.png and /dev/null differ diff --git a/docs_readme/images/zh/11_launch_configuration.png b/docs_readme/images/zh/11_launch_configuration.png deleted file mode 100644 index 800f64260..000000000 Binary files a/docs_readme/images/zh/11_launch_configuration.png and /dev/null differ diff --git a/docs_readme/images/zh/1_idffeature_install.png b/docs_readme/images/zh/1_idffeature_install.png deleted file mode 100644 index 702cc7bc9..000000000 Binary files a/docs_readme/images/zh/1_idffeature_install.png and /dev/null differ diff --git a/docs_readme/images/zh/2_environment_pref.png b/docs_readme/images/zh/2_environment_pref.png deleted file mode 100644 index b4cab73d5..000000000 Binary files a/docs_readme/images/zh/2_environment_pref.png and /dev/null differ diff --git a/docs_readme/images/zh/3_new_project_default.png b/docs_readme/images/zh/3_new_project_default.png deleted file mode 100644 index 591da2ac5..000000000 Binary files a/docs_readme/images/zh/3_new_project_default.png and /dev/null differ diff --git a/docs_readme/images/zh/4_new_project_templates.png b/docs_readme/images/zh/4_new_project_templates.png deleted file mode 100644 index 2d545c3bb..000000000 Binary files a/docs_readme/images/zh/4_new_project_templates.png and /dev/null differ diff --git a/docs_readme/images/zh/5_import_project.png b/docs_readme/images/zh/5_import_project.png deleted file mode 100644 index 658609e92..000000000 Binary files a/docs_readme/images/zh/5_import_project.png and /dev/null differ diff --git a/docs_readme/images/zh/8_launch_target.png b/docs_readme/images/zh/8_launch_target.png deleted file mode 100644 index 7ee868996..000000000 Binary files a/docs_readme/images/zh/8_launch_target.png and /dev/null differ diff --git a/docs_readme/images/zh/ESP-IDF_Components/components_window.png b/docs_readme/images/zh/ESP-IDF_Components/components_window.png deleted file mode 100644 index 7a8ca5ab3..000000000 Binary files a/docs_readme/images/zh/ESP-IDF_Components/components_window.png and /dev/null differ diff --git a/docs_readme/images/zh/ESP-IDF_Components/install_components.png b/docs_readme/images/zh/ESP-IDF_Components/install_components.png deleted file mode 100644 index 5f75a726f..000000000 Binary files a/docs_readme/images/zh/ESP-IDF_Components/install_components.png and /dev/null differ diff --git a/docs_readme/images/zh/GDBStubDebugging/code_example.png b/docs_readme/images/zh/GDBStubDebugging/code_example.png deleted file mode 100644 index 23cdfe7ea..000000000 Binary files a/docs_readme/images/zh/GDBStubDebugging/code_example.png and /dev/null differ diff --git a/docs_readme/images/zh/GDBStubDebugging/debug_panic_mode.png b/docs_readme/images/zh/GDBStubDebugging/debug_panic_mode.png deleted file mode 100644 index 63d95df22..000000000 Binary files a/docs_readme/images/zh/GDBStubDebugging/debug_panic_mode.png and /dev/null differ diff --git a/docs_readme/images/zh/GDBStubDebugging/sdkconfig_editor.png b/docs_readme/images/zh/GDBStubDebugging/sdkconfig_editor.png deleted file mode 100644 index b4aed75f8..000000000 Binary files a/docs_readme/images/zh/GDBStubDebugging/sdkconfig_editor.png and /dev/null differ diff --git a/docs_readme/images/zh/GDBStubDebugging/sdkconfig_editor_panic_behavior.png b/docs_readme/images/zh/GDBStubDebugging/sdkconfig_editor_panic_behavior.png deleted file mode 100644 index 5057f99af..000000000 Binary files a/docs_readme/images/zh/GDBStubDebugging/sdkconfig_editor_panic_behavior.png and /dev/null differ diff --git a/docs_readme/images/zh/HeapTracing/analysis_context_menu.png b/docs_readme/images/zh/HeapTracing/analysis_context_menu.png deleted file mode 100644 index 32715eed8..000000000 Binary files a/docs_readme/images/zh/HeapTracing/analysis_context_menu.png and /dev/null differ diff --git a/docs_readme/images/zh/HeapTracing/breakpoint_properties_actions.png b/docs_readme/images/zh/HeapTracing/breakpoint_properties_actions.png deleted file mode 100644 index 095b89796..000000000 Binary files a/docs_readme/images/zh/HeapTracing/breakpoint_properties_actions.png and /dev/null differ diff --git a/docs_readme/images/zh/HeapTracing/breakpoint_properties_actions_start_attached.png b/docs_readme/images/zh/HeapTracing/breakpoint_properties_actions_start_attached.png deleted file mode 100644 index 738cd9fd1..000000000 Binary files a/docs_readme/images/zh/HeapTracing/breakpoint_properties_actions_start_attached.png and /dev/null differ diff --git a/docs_readme/images/zh/HeapTracing/breakpoint_properties_actions_stop_attached.png b/docs_readme/images/zh/HeapTracing/breakpoint_properties_actions_stop_attached.png deleted file mode 100644 index 8462844d5..000000000 Binary files a/docs_readme/images/zh/HeapTracing/breakpoint_properties_actions_stop_attached.png and /dev/null differ diff --git a/docs_readme/images/zh/HeapTracing/breakpoint_properties_popup.png b/docs_readme/images/zh/HeapTracing/breakpoint_properties_popup.png deleted file mode 100644 index b13ac9b1b..000000000 Binary files a/docs_readme/images/zh/HeapTracing/breakpoint_properties_popup.png and /dev/null differ diff --git a/docs_readme/images/zh/HeapTracing/callers_view.png b/docs_readme/images/zh/HeapTracing/callers_view.png deleted file mode 100644 index d9211a027..000000000 Binary files a/docs_readme/images/zh/HeapTracing/callers_view.png and /dev/null differ diff --git a/docs_readme/images/zh/HeapTracing/details_tab_tracing.png b/docs_readme/images/zh/HeapTracing/details_tab_tracing.png deleted file mode 100644 index f59c44a41..000000000 Binary files a/docs_readme/images/zh/HeapTracing/details_tab_tracing.png and /dev/null differ diff --git a/docs_readme/images/zh/HeapTracing/heap_tracing_action.png b/docs_readme/images/zh/HeapTracing/heap_tracing_action.png deleted file mode 100644 index 7a344d9a6..000000000 Binary files a/docs_readme/images/zh/HeapTracing/heap_tracing_action.png and /dev/null differ diff --git a/docs_readme/images/zh/HeapTracing/overview_tab_tracing.png b/docs_readme/images/zh/HeapTracing/overview_tab_tracing.png deleted file mode 100644 index f948ddd09..000000000 Binary files a/docs_readme/images/zh/HeapTracing/overview_tab_tracing.png and /dev/null differ diff --git a/docs_readme/images/zh/HeapTracing/overview_tab_tracing_contexts.png b/docs_readme/images/zh/HeapTracing/overview_tab_tracing_contexts.png deleted file mode 100644 index f3be594ef..000000000 Binary files a/docs_readme/images/zh/HeapTracing/overview_tab_tracing_contexts.png and /dev/null differ diff --git a/docs_readme/images/zh/HeapTracing/show_callers_context_menu.png b/docs_readme/images/zh/HeapTracing/show_callers_context_menu.png deleted file mode 100644 index 04595139b..000000000 Binary files a/docs_readme/images/zh/HeapTracing/show_callers_context_menu.png and /dev/null differ diff --git a/docs_readme/images/zh/HeapTracing/sysview_heap_log_file.PNG b/docs_readme/images/zh/HeapTracing/sysview_heap_log_file.PNG deleted file mode 100644 index 3540798c5..000000000 Binary files a/docs_readme/images/zh/HeapTracing/sysview_heap_log_file.PNG and /dev/null differ diff --git a/docs_readme/images/zh/IDF_tools_console.png b/docs_readme/images/zh/IDF_tools_console.png deleted file mode 100644 index 19c6914e7..000000000 Binary files a/docs_readme/images/zh/IDF_tools_console.png and /dev/null differ diff --git a/docs_readme/images/zh/ToolsManager/git_python_selection.png b/docs_readme/images/zh/ToolsManager/git_python_selection.png deleted file mode 100644 index 06e5cfbc0..000000000 Binary files a/docs_readme/images/zh/ToolsManager/git_python_selection.png and /dev/null differ diff --git a/docs_readme/images/zh/ToolsManager/install_tools_manager.png b/docs_readme/images/zh/ToolsManager/install_tools_manager.png deleted file mode 100644 index 14eef1ecb..000000000 Binary files a/docs_readme/images/zh/ToolsManager/install_tools_manager.png and /dev/null differ diff --git a/docs_readme/images/zh/ToolsManager/manage_tools_installation.png b/docs_readme/images/zh/ToolsManager/manage_tools_installation.png deleted file mode 100644 index 2e82cb01e..000000000 Binary files a/docs_readme/images/zh/ToolsManager/manage_tools_installation.png and /dev/null differ diff --git a/docs_readme/images/zh/ToolsManager/select_or_download_new_esp_idf.png b/docs_readme/images/zh/ToolsManager/select_or_download_new_esp_idf.png deleted file mode 100644 index 7d5ef685c..000000000 Binary files a/docs_readme/images/zh/ToolsManager/select_or_download_new_esp_idf.png and /dev/null differ diff --git a/docs_readme/images/zh/change_language.png b/docs_readme/images/zh/change_language.png deleted file mode 100644 index 8ad5983d9..000000000 Binary files a/docs_readme/images/zh/change_language.png and /dev/null differ diff --git a/docs_readme/images/zh/cmake_editor_preferences.png b/docs_readme/images/zh/cmake_editor_preferences.png deleted file mode 100644 index bd65d4568..000000000 Binary files a/docs_readme/images/zh/cmake_editor_preferences.png and /dev/null differ diff --git a/docs_readme/images/zh/esp_idf_dir.png b/docs_readme/images/zh/esp_idf_dir.png deleted file mode 100644 index c9e8f764b..000000000 Binary files a/docs_readme/images/zh/esp_idf_dir.png and /dev/null differ diff --git a/docs_readme/images/zh/espidf_download.png b/docs_readme/images/zh/espidf_download.png deleted file mode 100644 index ceef26240..000000000 Binary files a/docs_readme/images/zh/espidf_download.png and /dev/null differ diff --git a/docs_readme/images/zh/export_log.png b/docs_readme/images/zh/export_log.png deleted file mode 100644 index 079bed727..000000000 Binary files a/docs_readme/images/zh/export_log.png and /dev/null differ diff --git a/docs_readme/images/zh/idf_terminal.png b/docs_readme/images/zh/idf_terminal.png deleted file mode 100644 index 4d23462ea..000000000 Binary files a/docs_readme/images/zh/idf_terminal.png and /dev/null differ diff --git a/docs_readme/images/zh/idf_update_site_install.png b/docs_readme/images/zh/idf_update_site_install.png deleted file mode 100644 index e3e42400e..000000000 Binary files a/docs_readme/images/zh/idf_update_site_install.png and /dev/null differ diff --git a/docs_readme/images/zh/sizeanalysis_details.png b/docs_readme/images/zh/sizeanalysis_details.png deleted file mode 100644 index 451801a4a..000000000 Binary files a/docs_readme/images/zh/sizeanalysis_details.png and /dev/null differ diff --git a/docs_readme/images/zh/sizeanalysis_overview.png b/docs_readme/images/zh/sizeanalysis_overview.png deleted file mode 100644 index 4248659e1..000000000 Binary files a/docs_readme/images/zh/sizeanalysis_overview.png and /dev/null differ