espressif /esp-idf

Espressif IoT Development Framework. Official development framework for Espressif SoCs.

★ 19,513⑂ 8,600👁 507⑃ 2,472● 15,537▤ 165
CApache-2.0Created 2016-08-17
More from this author
Download: ESP-IDF Release v6.1ESP-IDF-6.1 ↓6.12026-08-27
+4
Daily
19,513
stars
8,600
forks
507
watchers
2,472
prs
15,537
issues
165
releases

README

Espressif IoT Development Framework

 中文版

ESP-IDF is the development framework for Espressif SoCs supported on Windows, Linux and macOS.

 ESP-IDF Release Support Schedule

!Support Schedule

- Please read the support policy and the documentation for more information about ESP-IDF versions.
- Please see the End-of-Life Advisories for information about ESP-IDF releases with discontinued support.

 ESP-IDF Release and SoC Compatibility

!Chip support

See Compatibility Between ESP-IDF Releases and Revisions of Espressif SoCs for the details of the compatibility between ESP-IDF and chip revisions.

Espressif SoCs released before 2016 (ESP8266 and ESP8285) are supported by RTOS SDK instead.

 Developing With ESP-IDF

 Setting Up ESP-IDF

See https://idf.espressif.com/ for links to detailed instructions on how to set up the ESP-IDF depending on chip you use.

Note: Each SoC series and each ESP-IDF release has its own documentation. Please see Section Versions on how to find documentation and how to checkout specific release of ESP-IDF.

 Non-GitHub forks

ESP-IDF uses relative locations as its submodules URLs (.gitmodules). So they link to GitHub. If ESP-IDF is forked to a Git repository which is not on GitHub, you will need to run the script tools/set-submodules-to-github.sh after git clone.

The script sets absolute URLs for all submodules, allowing git submodule update --init --recursive to complete. If cloning ESP-IDF from GitHub, this step is not needed.

 Finding a Project

As well as the esp-idf-template project mentioned in Getting Started, ESP-IDF comes with some example projects in the examples directory.

Once you've found the project you want to work with, change to its directory and you can configure and build it.

To start your own project based on an example, copy the example project directory outside of the ESP-IDF directory.

 Quick Reference

See the Getting Started guide links above for a detailed setup guide. This is a quick reference for common commands when working with ESP-IDF projects:

 Setup Build Environment

(See the Getting Started guide listed above for a full list of required steps with more details.)

 Install host build dependencies mentioned in the Getting Started guide.
 Run the install script to set up the build environment. The options include install.bat or install.ps1 for Windows, and install.sh or install.fish for Unix shells.
 Run the export script on Windows (export.bat) or source it on Unix (source export.sh) in every shell environment before using ESP-IDF.

 Configuring the Project

 idf.py set-target  sets the target of the project to . Run idf.py set-target without any arguments to see a list of supported targets.
 idf.py menuconfig opens a text-based configuration menu where you can configure the project.

 Compiling the Project

idf.py build

... will compile app, bootloader and generate a partition table based on the config.

 Flashing the Project

When the build finishes, it will print a command line 

Top issues

Latest release

ESP-IDF Release v6.1 v6.1 2026-08-27
Documentation for IDF v6.1 is available at https://docs.espressif.com/projects/esp-idf/en/v6.1/

ESP-IDF v6.1 is a minor update for ESP-IDF v6.0. Release v6.1 is mostly compatible with apps written for ESP-IDF v6.0.

We highly recommend referring to our migration guide while moving your apps from ESP-IDF v6.0 to v6.1 release.

 Obtaining v6.1

For full installation instructions, see the ESP-IDF Programming Guide.

 Using EIM

The recommended way to obtain and install ESP-IDF v6.1 is through the ESP-IDF Installation Manager (EIM). EIM supports obtaining ESP-IDF releases from Espress

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON