Espressif IoT Development Framework. Official development framework for ESP32.
ESP-IDF is the official development framework for the ESP32 and ESP32-S Series SoCs provided for Windows, Linux and macOS.
See setup guides for detailed instructions to set up the ESP-IDF:
| Chip | Getting Started Guides for ESP-IDF | |:----:|:----| | |
Note: Each ESP-IDF release has its own documentation. Please see Section Versions how to find documentation and how to checkout specific release of ESP-IDF.
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 --recursiveto complete. If cloning ESP-IDF from GitHub, this step is not needed.
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.
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:
(See the Getting Started guide listed above for a full list of required steps with more details.)
install.ps1for Windows, and
install.fishfor Unix shells.
export.bat) or source it on Unix (
source export.sh) in every shell environment before using ESP-IDF.
idf.py set-targetsets the target of the project to . Run
idf.py set-targetwithout any arguments to see a list of supported targets.
idf.py menuconfigopens a text-based configuration menu where you can configure the project.
... will compile app, bootloader and generate a partition table based on the config.
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
/dev/ttyUSB0on Linux, or
/dev/cu.usbserial-Xon MacOS. If the
-poption is left out,
idf.py flashwill 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
You don't need to run
idf.py buildbefore running
idf.py flashwill automatically rebuild anything which needs it.
idf.py monitortarget uses the idf_monitor tool to display serial output from ESP32 or ESP32-S Series 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
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-flashwill 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.)
idf.py flashtarget 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
This can be combined with other targets, ie
idf.py -p PORT erase_flash flashwill erase everything and then re-flash the new app, bootloader and partition table.
Documentation for the latest version: https://docs.espressif.com/projects/esp-idf/. This documentation is built from the docs directory of this repository.
The esp32.com forum is a place to ask questions and find community resources.
Check the Issues section on github if you find a bug or have a feature request. Please check existing Issues before opening a new one.
If you're interested in contributing to ESP-IDF, please check the Contributions Guide.