Espressif IoT Development Framework for ESP32-XX
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Roland Dobai 02605f1a31 Merge branch 'fix/idf_tools_download_issues' into 'master' 1 week ago
.github Merge branch 'contrib/github_pr_9273' into 'master' 3 weeks ago
.gitlab Merge branch 'fix/tools-gdbinit-with-elf-symbols' into 'master' 1 week ago
components Merge branch 'fix/tools-gdbinit-with-elf-symbols' into 'master' 1 week ago
docs Merge branch 'fix/tools-gdbinit-with-elf-symbols' into 'master' 1 week ago
examples Merge branch 'bugfix/fixed_signal_gap_in_i2s_adc_dac_example' into 'master' 1 week ago
tools Merge branch 'fix/idf_tools_download_issues' into 'master' 1 week ago
.editorconfig refactor(editorconfig): Removed FreeRTOS tab rule 2 weeks ago
.flake8 cleanup remaining references for esp-cryptoauthlib 2 months ago
.gitignore Merge branch 'ci/cache_submodules' into 'master' 3 months ago
.gitlab-ci.yml ci: simplify the python env to idf venv only 2 months ago
.gitmodules esp-cryptoautlib: remove submodule and use from IDF component manager 2 months ago
.mypy.ini Add mypy check to pre-commit-config 2 years ago
.pre-commit-config.yaml rgb_lcd: support yuv converter 2 months ago
.pylintrc style: ignore pylint too-many-instance-attributes error 3 months ago
.readthedocs.yml Whitespace: Automated whitespace fixes (large commit) 2 years ago
CMakeLists.txt tools: Increase the minimal supported CMake version to 3.16 4 months ago
CONTRIBUTING.md docs: make CONTRIBUTING.md readable on Github 5 months ago
Kconfig esp32c6: introduce the target 2 months ago
LICENSE Initial public version 6 years ago
README.md Readme: Update chip support matrix 6 months ago
README_CN.md docs: udpate CN translation for readme and build-system 5 months ago
SECURITY.md Add security policy guidelines 3 months ago
SUPPORT_POLICY.md docs: udpate CN translation for readme and build-system 5 months ago
SUPPORT_POLICY_CN.md docs: udpate CN translation for readme and build-system 5 months ago
add_path.sh Whitespace: Automated whitespace fixes (large commit) 2 years ago
conftest.py ci: add xtal_40mhz tag for c2 tests 2 months ago
export.bat tools: Remove tools that are not used by active ESP-IDF version. 8 months ago
export.fish Tools: Support ESP-IDF installed in system-wide shared directory for all users 3 weeks ago
export.ps1 tools: fix {install,export}.ps1 for IDF_PATH with spaces 4 weeks ago
export.sh Tools: Support ESP-IDF installed in system-wide shared directory for all users 3 weeks ago
install.bat Tools: Improve the Python package system 9 months ago
install.fish Tools: Fix silent failure about the incompatible Python 8 months ago
install.ps1 tools: fix {install,export}.ps1 for IDF_PATH with spaces 4 weeks ago
install.sh Tools: resolve symlinks in IDF_PATH when installing 3 months ago
pytest.ini Merge branch 'feature/add_ot_CI' into 'master' 2 weeks ago
sdkconfig.rename build: remove COMPILER_DISABLE_GCC8_WARNINGS, no longer relevant 4 months ago
sonar-project.properties ci(sonarqube): pass "sonar.exclusions" in CI 1 year ago

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

The following table shows ESP-IDF support of Espressif SoCs where alt text and alt text denote preview status and support, respectively. The preview support is usually limited in time and intended for beta versions of chips. Please use an ESP-IDF release where the desired SoC is already supported.

Chip v4.1 v4.2 v4.3 v4.4 v5.0
ESP32 alt text alt text alt text alt text alt text
ESP32-S2 alt text alt text alt text alt text
ESP32-C3 alt text alt text alt text
ESP32-S3 alt text alt text Announcement
ESP32-C2 alt text Announcement
ESP32-H2 alt text alt text Announcement

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.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