mirrors-embedded/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2026-01-20 23:49:17 +01:00
Code Issues Projects Releases Packages Wiki Activity
Espressif IoT Development Framework. Official development framework for Espressif SoCs.
49,575 commits 22 branches 174 tags 477 MiB
Find a file
Exact
He Binglin 94c20b3ba7 Merge branch 'bugfix/esp_idf_c2_pm-613' into 'master' 
fix(esp_hw_support): fix cpu restart failed due to rtc_clk in flash

Closes PM-613

See merge request espressif/esp-idf!44739
2026-01-15 16:27:40 +08:00
.github fix: Update esptool command in GitHub issue template to use legacy command 2025-11-07 16:01:38 +01:00
.gitlab Merge branch 'ci/update_check_doc_links_tags' into 'master' 2026-01-13 14:09:31 +08:00
components Merge branch 'bugfix/esp_idf_c2_pm-613' into 'master' 2026-01-15 16:27:40 +08:00
docs Merge branch 'docs/add_ble_support_c5_c61' into 'master' 2026-01-14 14:56:54 +08:00
examples Merge branch 'bugfix/ad_type_example' into 'master' 2026-01-14 12:01:48 +05:30
tools Merge branch 'feat/remove_sdm_set_duty_api' into 'master' 2026-01-14 08:57:34 +08:00
.codespellrc change(esp_libc): rename newlib component to esp_libc 2025-09-09 22:00:44 +08:00
.editorconfig refactor(editorconfig): Removed FreeRTOS tab rule 2022-09-23 12:53:33 +02:00
.gitignore feat(heap): Update test to CMake and use Catch2 component 2025-09-18 10:07:08 +02:00
.gitlab-ci.yml ci: move the retry_failed_jobs to pre_check stage 2025-11-19 10:51:20 +01:00
.gitmodules docs: update git clone command to only clone latest commit 2025-12-12 19:21:59 +08:00
.idf_build_apps.toml ci(esp32s31): Add ci build test for esp32s31 2025-12-11 15:17:15 +08:00
.idf_ci.toml ci: fix if clause in .idf_ci.toml 2025-11-28 13:57:11 +01:00
.mypy.ini feat: Deprecate Python 3.9 2025-08-01 08:05:10 +02:00
.pre-commit-config.yaml fix(ci): add rules.yml to check-tools-files-patterns pre-commit hook pattern 2026-01-13 21:58:55 +08:00
.shellcheckrc feat(tools): Add shellcheck for shell scripts to CI 2023-10-03 10:57:29 +02:00
.vale.ini docs(vale): Add configuration for Vale documentation linter 2023-10-10 15:27:09 +08:00
add_path.sh
CMakeLists.txt feat(esp_libc): make picolibc default libc 2025-12-03 13:31:42 +07:00
COMPATIBILITY.md docs(compatibility): add new chips and improve translations 2025-12-12 15:53:56 +08:00
COMPATIBILITY_CN.md docs(compatibility): add new chips and improve translations 2025-12-12 15:53:56 +08:00
conftest.py refactor: Remove idf_test component 2026-01-01 02:26:42 +08:00
CONTRIBUTING.md docs: make CONTRIBUTING.md readable on Github 2022-05-04 01:16:34 +02:00
export.bat revert(tools): Revert backup option to use legacy export scrips 2025-08-15 09:11:02 +02:00
export.fish revert(tools): Revert backup option to use legacy export scrips 2025-08-15 09:11:02 +02:00
export.ps1 revert(tools): Revert backup option to use legacy export scrips 2025-08-15 09:11:02 +02:00
export.sh revert(tools): Revert backup option to use legacy export scrips 2025-08-15 09:11:02 +02:00
install.bat feat(tools): Inform user about IDF_PATH set/change in install/export scripts 2024-11-25 15:56:16 +08:00
install.fish feat(tools): Inform user about IDF_PATH set/change in install/export scripts 2024-11-25 15:56:16 +08:00
install.ps1 feat(tools): Inform user about IDF_PATH set/change in install/export scripts 2024-11-25 15:56:16 +08:00
install.sh feat(tools): Inform user about IDF_PATH set/change in install/export scripts 2024-11-25 15:56:16 +08:00
Kconfig docs(i3c): Add i3c master programming guide 2026-01-13 19:56:39 +08:00
LICENSE
pytest.ini change(esp_driver): set cases with toppd check only run in esp32c5eco3 rather than eco2 2026-01-12 14:30:57 +08:00
README.md change(readme): Add auto-generated chip support table into the README 2025-12-30 13:21:07 +01:00
README_CN.md change(readme): Add auto-generated chip support table into the README 2025-12-30 13:21:07 +01:00
ROADMAP.md docs: update cn and en roadmap for v6.0 2025-03-19 10:38:59 +08:00
ROADMAP_CN.md docs: update cn and en roadmap for v6.0 2025-03-19 10:38:59 +08:00
ruff.toml component: Remove wifi_provisioning component and esp_prov tool 2025-09-26 09:48:50 +08:00
sdkconfig.rename core-system: changed CONFIG_COMPILER_OPTIMIZATION_DEFAULT to CONFIG_COMPILER_OPTIMIZATION_DEBUG 2023-06-02 15:16:50 +08:00
SECURITY.md Add a note about Espressif Security Incident Policy document 2023-05-10 12:10:41 +05:30
sgconfig.yml feat(ci): add ast-grep rules to lint kconfig in the hal 2024-11-29 22:41:12 +08:00
sonar-project.properties ci: pylint with codeclimate 2023-08-15 08:31:45 +08:00
SUPPORT_POLICY.md docs: udpate CN translation for readme and build-system 2022-05-11 19:49:16 +08:00
SUPPORT_POLICY_CN.md docs: udpate CN translation for readme and build-system 2022-05-11 19:49:16 +08:00

README.md

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

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 <chip_name> sets the target of the project to <chip_name>. 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 to use esptool to flash the chip. However you can also do this automatically by running:

idf.py -p PORT flash

Replace PORT with the name of your serial port (like COM3 on Windows, /dev/ttyUSB0 on Linux, or /dev/cu.usbserial-X on MacOS. If the -p option is left out, idf.py flash will try to flash the first available serial port.

This will flash the entire project (app, bootloader and partition table) to a new chip. The settings for serial port flashing can be configured with idf.py menuconfig.

You don't need to run idf.py build before running idf.py flash, idf.py flash will automatically rebuild anything which needs it.

Viewing Serial Output

The idf.py monitor target uses the esp-idf-monitor tool to display serial output from Espressif SoCs. esp-idf-monitor also has a range of features to decode crash output and interact with the device. Check the documentation page for details.

Exit the monitor by typing Ctrl-].

To build, flash and monitor output in one pass, you can run:

idf.py flash monitor

Compiling & Flashing Only the App

After the initial flash, you may just want to build and flash just your app, not the bootloader and partition table:

  • idf.py app - build just the app.
  • idf.py app-flash - flash just the app.

idf.py app-flash will automatically rebuild the app if any source files have changed.

(In normal development there's no downside to reflashing the bootloader and partition table each time, if they haven't changed.)

Erasing Flash

The idf.py flash target does not erase the entire flash contents. However it is sometimes useful to set the device back to a totally erased state, particularly when making partition table changes or OTA app updates. To erase the entire flash, run idf.py erase-flash.

This can be combined with other targets, ie idf.py -p PORT erase-flash flash will erase everything and then re-flash the new app, bootloader and partition table.

Resources