|
1 | | -[](https://github.com/espressif/idf-eclipse-plugin/releases/latest) |
| 1 | +<h1 align="center">Espressif-IDE</h1> |
| 2 | +<p align="center"> |
| 3 | + <strong>The official Eclipse-based IDE for ESP-IDF development</strong> |
| 4 | +</p> |
2 | 5 |
|
3 | | -[中文](./README_CN.md) |
| 6 | +<p align="center"> |
| 7 | + <a href="https://github.com/espressif/idf-eclipse-plugin/releases/latest"><img src="https://img.shields.io/github/release/espressif/idf-eclipse-plugin.svg" alt="GitHub Release"></a> |
| 8 | + <a href="https://github.com/espressif/idf-eclipse-plugin/blob/master/LICENSE.md"><img src="https://img.shields.io/badge/License-EPL%202.0-blue.svg" alt="License"></a> |
| 9 | + <a href="https://github.com/espressif/idf-eclipse-plugin/issues"><img src="https://img.shields.io/github/issues/espressif/idf-eclipse-plugin.svg" alt="GitHub Issues"></a> |
| 10 | + <a href="https://github.com/espressif/idf-eclipse-plugin/actions"><img src="https://img.shields.io/github/actions/workflow/status/espressif/idf-eclipse-plugin/ci.yml?branch=master" alt="Build Status"></a> |
| 11 | +</p> |
4 | 12 |
|
5 | | -# Espressif-IDE (ESP-IDF Eclipse Plugin) |
| 13 | +<p align="center"> |
| 14 | + <img src="docs_readme/images/macos-logo.png" alt="macOS"> |
| 15 | + <img src="docs_readme/images/windows-logo.png" alt="Windows"> |
| 16 | + <img src="docs_readme/images/linux-logo.png" alt="Linux"> |
| 17 | +</p> |
6 | 18 |
|
7 | | -Espressif-IDE is an Integrated Development Environment (IDE) based on Eclipse CDT for developing IoT Applications using the <a href=https://github.com/espressif/esp-idf>ESP-IDF</a>. 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. |
| 19 | +<p align="center"> |
| 20 | + <a href="https://docs.espressif.com/projects/espressif-ide/en/latest/">Documentation</a> · |
| 21 | + <a href="https://github.com/espressif/idf-eclipse-plugin/releases/latest">Download</a> · |
| 22 | + <a href="https://github.com/espressif/idf-eclipse-plugin/issues">Report Bug</a> · |
| 23 | + <a href="./README_CN.md">中文</a> |
| 24 | +</p> |
8 | 25 |
|
9 | | -The plug-in runs on `macOS`, `Windows` and `Linux` platforms. |
| 26 | +--- |
10 | 27 |
|
11 | | - |
12 | | - |
13 | | - |
| 28 | +Espressif-IDE is a standalone, customized IDE built on Eclipse CDT for developing IoT applications with [ESP-IDF](https://github.com/espressif/esp-idf). It bundles the IDF Eclipse plugins, Eclipse CDT, and essential third-party plugins into a single ready-to-use environment for the entire ESP32 family of chips. |
| 29 | +## Key Features |
14 | 30 |
|
| 31 | +### Write |
15 | 32 |
|
16 | | -> **Note:** Espressif-IDE version 3.0 and later supports ESP-IDF version 5.x and above. For ESP-IDF version 4.x, please use Espressif-IDE version <a href="https://github.com/espressif/idf-eclipse-plugin/releases/tag/v2.12.1">2.12.1</a> |
| 33 | +| Feature | Description | |
| 34 | +|---------|-------------| |
| 35 | +| **Project Wizards** | Create new projects from scratch or from 100+ ESP-IDF example templates | |
| 36 | +| **Clangd-Powered Editor** | LSP-based C/C++ editor with code completion, navigation, and real-time diagnostics | |
| 37 | +| **CMake Editor** | Syntax highlighting and content assist for `CMakeLists.txt` files | |
| 38 | +| **SDK Configuration (menuconfig)** | Visual editor for Kconfig options -- no terminal needed | |
17 | 39 |
|
18 | | -# To Get Started with the Espressif-IDE |
| 40 | +### Build |
19 | 41 |
|
20 | | -Please refer to the <a href="https://docs.espressif.com/projects/espressif-ide/en/latest/">Espressif-IDE documentation</a>. |
| 42 | +| Feature | Description | |
| 43 | +|---------|-------------| |
| 44 | +| **CMake Build System** | Full integration with ESP-IDF's CMake-based build | |
| 45 | +| **Toolchain Management** | Auto-configured ESP GCC and Clang toolchains | |
| 46 | +| **ESP-IDF Manager** | Install, manage, and switch between multiple ESP-IDF versions from inside the IDE | |
| 47 | +| **Size Analysis** | Visualize your firmware's static memory footprint (RAM/Flash) | |
21 | 48 |
|
22 | | -# How to Build Locally |
| 49 | +### Flash |
23 | 50 |
|
24 | | -1. Install prerequisites: Java 17+ and Maven. |
25 | | -2. Run the below commands to clone and build. |
| 51 | +| Feature | Description | |
| 52 | +|---------|-------------| |
| 53 | +| **UART Flashing** | One-click flash over serial using `idf.py flash` | |
| 54 | +| **JTAG Flashing** | Flash via JTAG debug probes | |
| 55 | +| **DFU Flashing** | Flash over USB using Device Firmware Update protocol | |
| 56 | +| **Partition Table Editor** | Visual editor for custom partition layouts | |
| 57 | +| **NVS Editor** | Create and edit Non-Volatile Storage partition data | |
26 | 58 |
|
27 | | - ``` |
28 | | - git clone https://github.com/espressif/idf-eclipse-plugin.git |
29 | | - cd idf-eclipse-plugin |
30 | | - mvn clean verify -Djarsigner.skip=true |
31 | | - ``` |
| 59 | +### Debug |
32 | 60 |
|
33 | | -This will generate p2 update site artifact: |
| 61 | +| Feature | Description | |
| 62 | +|---------|-------------| |
| 63 | +| **OpenOCD Debugging** | Fully integrated JTAG debugging with pre-built launch configurations | |
| 64 | +| **GDB Stub Debugging** | Debug panics and exceptions over serial | |
| 65 | +| **Core Dump Analysis** | Post-mortem debugging from crash dumps | |
| 66 | +| **Heap Tracing** | Profile memory allocations and detect leaks at runtime | |
| 67 | +| **App-Level Tracing** | Collect real-time trace data from running firmware | |
34 | 68 |
|
35 | | -* Name: `com.espressif.idf.update-*` |
36 | | -* Location: `releng/com.espressif.idf.update/target` |
| 69 | +### Monitor & Simulate |
37 | 70 |
|
38 | | -This artifact can be installed using the mechanism mentioned <a href="https://docs.espressif.com/projects/espressif-ide/en/latest/marketplaceupdate.html?#installing-idf-eclipse-plugin-from-local-archive">here</a> |
| 71 | +| Feature | Description | |
| 72 | +|---------|-------------| |
| 73 | +| **Serial Monitor** | Integrated terminal for viewing device output | |
| 74 | +| **ESP-IDF Terminal** | Pre-configured shell with all build environment variables set | |
| 75 | +| **Wokwi Simulator** | Test your firmware on a virtual ESP32 -- no hardware required | |
39 | 76 |
|
40 | | -# How to Get the Latest Development Build |
| 77 | +## Quick Start |
41 | 78 |
|
42 | | -1. Go to the last commit of the master branch <a href="https://github.com/espressif/idf-eclipse-plugin/commits/master">here</a>. |
43 | | -1. Click on a :white_check_mark: green tick mark. |
44 | | -1. Click on `Details`. |
45 | | -1. Click on `Summary` on the left. |
46 | | -1. Scroll down to see the `Artifacts` section. |
47 | | -1. Download `com.espressif.idf.update` p2 update site archive and install as per the instructions mentioned <a |
48 | | -href="https://docs.espressif.com/projects/espressif-ide/en/latest/marketplaceupdate.html?#installing-idf-eclipse-plugin-from-local-archive">here</a>. |
| 79 | +### Option 1: Download Espressif-IDE (Recommended) |
49 | 80 |
|
| 81 | +Download the latest standalone installer from the [releases page](https://github.com/espressif/idf-eclipse-plugin/releases/latest) for your platform. |
50 | 82 |
|
51 | | -<a name="Support"></a> |
52 | | -# How to Raise Bugs |
| 83 | +### Option 2: Install the Plugin into an Existing Eclipse |
53 | 84 |
|
54 | | -Please raise the issues [here](https://github.com/espressif/idf-eclipse-plugin/issues) with the complete environment details and log. |
| 85 | +Install from the Eclipse Marketplace or the update site. See the [installation guide](https://docs.espressif.com/projects/espressif-ide/en/latest/) for details. |
| 86 | + |
| 87 | +### First Steps |
| 88 | + |
| 89 | +1. Launch Espressif-IDE |
| 90 | +2. Install ESP-IDF and tools through the built-in ESP-IDF Manager |
| 91 | +3. Create a new project using **File > New > Espressif IDF Project** |
| 92 | +4. Select a target chip and serial port |
| 93 | +5. Build, flash, and monitor |
| 94 | + |
| 95 | +Full walkthrough in the [official documentation](https://docs.espressif.com/projects/espressif-ide/en/latest/). |
| 96 | + |
| 97 | +## Building from Source |
| 98 | + |
| 99 | +**Prerequisites:** Java 17+ and Maven 3.9+ |
| 100 | + |
| 101 | +```bash |
| 102 | +git clone https://github.com/espressif/idf-eclipse-plugin.git |
| 103 | +cd idf-eclipse-plugin |
| 104 | +mvn clean verify -Djarsigner.skip=true |
| 105 | +``` |
| 106 | + |
| 107 | +The p2 update site artifact is generated at `releng/com.espressif.idf.update/target/`. Install it using the [local archive instructions](https://docs.espressif.com/projects/espressif-ide/en/latest/marketplaceupdate.html?#installing-idf-eclipse-plugin-from-local-archive). |
| 108 | + |
| 109 | +## Getting the Latest Development Build |
| 110 | + |
| 111 | +1. Go to the [latest commits on master](https://github.com/espressif/idf-eclipse-plugin/commits/master) |
| 112 | +2. Click the green checkmark on the latest commit |
| 113 | +3. Click **Details** > **Summary** |
| 114 | +4. Download the `com.espressif.idf.update` artifact from the **Artifacts** section |
| 115 | +5. Install using the [local archive instructions](https://docs.espressif.com/projects/espressif-ide/en/latest/marketplaceupdate.html?#installing-idf-eclipse-plugin-from-local-archive) |
| 116 | + |
| 117 | +## Contributing |
| 118 | + |
| 119 | +We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for development environment setup, coding guidelines, and how to submit pull requests. |
| 120 | + |
| 121 | +## Resources |
| 122 | + |
| 123 | +- [Official Documentation](https://docs.espressif.com/projects/espressif-ide/en/latest/) |
| 124 | +- [ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/en/latest/) |
| 125 | +- [Espressif on GitHub](https://github.com/espressif) |
| 126 | +- [ESP32 Forum](https://esp32.com/) |
| 127 | + |
| 128 | +## Reporting Issues |
| 129 | + |
| 130 | +Found a bug or have a feature request? Please open an issue [here](https://github.com/espressif/idf-eclipse-plugin/issues) with your environment details and relevant logs. |
| 131 | + |
| 132 | +## License |
| 133 | + |
| 134 | +This project is licensed under the [Eclipse Public License v2.0](LICENSE.md). |
0 commit comments