Espressif IoT Development Framework. Official development framework for Espressif SoCs. https://docs.espressif.com/projects/esp-idf/en/stable/esp32/index.html
Go to file
Jiang Jiang Jian 4bdc7853cf Merge branch 'bugfix/put_sempher_and_queue_used_in_isr_into_DRAM_v4.2' into 'release/v4.2'
Make sure semphr/queue used in interrupt is in DRAM

See merge request espressif/esp-idf!18990
2022-08-02 11:32:18 +08:00
.github tools/docker: add README.md file to be displayed on Docker Hub 2022-05-27 14:15:51 +02:00
.gitlab add simplified CODEOWNERS file for older release branches 2021-06-22 09:21:51 +02:00
components Merge branch 'bugfix/put_sempher_and_queue_used_in_isr_into_DRAM_v4.2' into 'release/v4.2' 2022-08-02 11:32:18 +08:00
docs Apply 1 suggestion(s) to 1 file(s) 2022-07-14 16:44:00 +08:00
examples Merge branch 'mesh/non_mesh_connections_access_v4.2' into 'release/v4.2' 2022-07-21 19:19:14 +08:00
make versions: Update version to 4.2.3 2022-03-03 14:44:57 +01:00
tools ci: limit switching branches for auto_test_script 2022-07-06 11:55:33 +08:00
.editorconfig cmake: Use cmake_lint project, tidy up all CMake source files 2018-04-30 09:59:20 +10:00
.flake8 bugfix: fix flake8 warning for esp-cryptoauthlib submodule 2020-05-21 21:02:33 +05:30
.gitignore hal: avoid generate 8/16 bits intruction for register access 2021-10-12 11:06:55 +08:00
.gitlab-ci.yml bugfix: set authmode by switching number to string (backport v4.2) 2021-12-27 20:00:33 +08:00
.gitmodules secure_element: atecc608_ecdsa example 2020-05-21 13:08:30 +05:30
.readthedocs.yml docs: Remove building of zipped HTML docs from build process and consequently from Downloads as many users don't use that. We are still providing PDF documentation for people who prefer viewing docs off-line. Removal of this build step is expected to save almost 10 minutes of build time and resolve issue of build failures because of hitting 40 min build time limit on Read The Docs. 2019-07-08 13:19:56 +08:00
add_path.sh tools: {install,export}.{bat,sh} tools 2019-07-01 14:51:44 +02:00
CMakeLists.txt Build: Fix CMake to pass -Wwrite-string compiler flag if enabled 2021-08-18 19:29:32 +08:00
CONTRIBUTING.rst docs: Fix broken URLs & permanent redirects 2020-03-23 18:11:23 +11:00
export.bat tools: {install, export}.bat: fix path quoting 2021-11-22 23:08:49 +01:00
export.fish tools: Prefer python3 during install and export 2021-02-14 19:05:33 +01:00
export.ps1 scripts: updates export.ps1 to export tools' paths 2020-07-30 13:55:03 +02:00
export.sh tools: Prefer python3 during install and export 2021-02-14 19:05:33 +01:00
install.bat tools: {install, export}.bat: fix path quoting 2021-11-22 23:08:49 +01:00
install.fish Fix install.fish 2021-08-16 16:27:35 +02:00
install.ps1 tools: Installing tools for given IDF_TARGET 2021-08-16 16:27:35 +02:00
install.sh tools: Installing tools for given IDF_TARGET 2021-08-16 16:27:35 +02:00
Kconfig tests: gdb_loadable_elf: adjust the breakpoint location for ESP32 ECO3 2021-06-18 15:09:47 +02:00
LICENSE Initial public version 2016-08-17 23:08:22 +08:00
README_CN.md docs: Linking to a page that helps navigate to documentation for specific ESP32-x chip 2021-06-03 08:13:03 +02:00
README.md docs: Linking to a page that helps navigate to documentation for specific ESP32-x chip 2021-06-03 08:13:03 +02:00
requirements.txt Add idf-component-manager python dependency 2022-02-02 16:44:43 +01:00
sdkconfig.rename cmake: Add new compiler optimization levels definitions 2019-09-06 17:37:19 +08:00
SUPPORT_POLICY_CN.md add chinese translation for support period policy 2019-11-11 10:40:30 +08:00
SUPPORT_POLICY.md add chinese translation for support period policy 2019-11-11 10:40:30 +08:00

Espressif IoT Development Framework

ESP-IDF is the development framework for Espressif SoCs (released after 20161) provided for Windows, Linux and macOS.

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.py 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 idf_monitor tool to display serial output from Espressif SoCs. 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


1: ESP8266 and ESP8285 are not supported in ESP-IDF. See RTOS SDK instead.