1# Espressif IoT Development Framework 2 3* [中文版](./README_CN.md) 4 5ESP-IDF is the development framework for Espressif SoCs supported on Windows, Linux and macOS. 6 7# ESP-IDF Release and SoC Compatibility 8 9The following table shows ESP-IDF support of Espressif SoCs where ![alt text][preview] and ![alt text][supported] denote preview status and support, respectively. In preview status the build is not yet enabled and some crucial parts could be missing (like documentation, datasheet). Please use an ESP-IDF release where the desired SoC is already supported. 10 11|Chip | v3.3 | v4.0 | v4.1 | v4.2 | v4.3 | v4.4 | | 12|:----------- |:---------------------: | :---------------------:| :---------------------:| :---------------------:| :---------------------:| :---------------------:|:---------------------------------------------------------- | 13|ESP32 | ![alt text][supported] | ![alt text][supported] | ![alt text][supported] | ![alt text][supported] | ![alt text][supported] | ![alt text][supported] | | 14|ESP32-S2 | | | | ![alt text][supported] | ![alt text][supported] | ![alt text][supported] | | 15|ESP32-C3 | | | | | ![alt text][supported] | ![alt text][supported] | | 16|ESP32-S3 | | | | | ![alt text][preview] | ![alt text][supported] | [Announcement](https://www.espressif.com/en/news/ESP32_S3) | 17|ESP32-H2 | | | | | | ![alt text][preview] | [Announcement](https://www.espressif.com/en/news/ESP32_H2) | 18 19[supported]: https://img.shields.io/badge/-supported-green "supported" 20[preview]: https://img.shields.io/badge/-preview-orange "preview" 21 22Espressif SoCs released before 2016 (ESP8266 and ESP8285) are supported by [RTOS SDK](https://github.com/espressif/ESP8266_RTOS_SDK) instead. 23 24# Developing With ESP-IDF 25 26## Setting Up ESP-IDF 27 28See https://idf.espressif.com/ for links to detailed instructions on how to set up the ESP-IDF depending on chip you use. 29 30**Note:** Each SoC series and each ESP-IDF release has its own documentation. Please see Section [Versions](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/versions.html) on how to find documentation and how to checkout specific release of ESP-IDF. 31 32### Non-GitHub forks 33 34ESP-IDF uses relative locations as its submodules URLs ([.gitmodules](.gitmodules)). So they link to GitHub. 35If ESP-IDF is forked to a Git repository which is not on GitHub, you will need to run the script 36[tools/set-submodules-to-github.sh](tools/set-submodules-to-github.sh) after git clone. 37The script sets absolute URLs for all submodules, allowing `git submodule update --init --recursive` to complete. 38If cloning ESP-IDF from GitHub, this step is not needed. 39 40## Finding a Project 41 42As well as the [esp-idf-template](https://github.com/espressif/esp-idf-template) project mentioned in Getting Started, ESP-IDF comes with some example projects in the [examples](examples) directory. 43 44Once you've found the project you want to work with, change to its directory and you can configure and build it. 45 46To start your own project based on an example, copy the example project directory outside of the ESP-IDF directory. 47 48# Quick Reference 49 50See 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: 51 52## Setup Build Environment 53 54(See the Getting Started guide listed above for a full list of required steps with more details.) 55 56* Install host build dependencies mentioned in the Getting Started guide. 57* 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. 58* Run the export script on Windows (`export.bat`) or source it on Unix (`source export.sh`) in every shell environment before using ESP-IDF. 59 60## Configuring the Project 61 62* `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. 63* `idf.py menuconfig` opens a text-based configuration menu where you can configure the project. 64 65## Compiling the Project 66 67`idf.py build` 68 69... will compile app, bootloader and generate a partition table based on the config. 70 71## Flashing the Project 72 73When 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: 74 75`idf.py -p PORT flash` 76 77Replace 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. 78 79This 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`. 80 81You don't need to run `idf.py build` before running `idf.py flash`, `idf.py flash` will automatically rebuild anything which needs it. 82 83## Viewing Serial Output 84 85The `idf.py monitor` target uses the [idf_monitor tool](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/idf-monitor.html) 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](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/idf-monitor.html). 86 87Exit the monitor by typing Ctrl-]. 88 89To build, flash and monitor output in one pass, you can run: 90 91`idf.py flash monitor` 92 93## Compiling & Flashing Only the App 94 95After the initial flash, you may just want to build and flash just your app, not the bootloader and partition table: 96 97* `idf.py app` - build just the app. 98* `idf.py app-flash` - flash just the app. 99 100`idf.py app-flash` will automatically rebuild the app if any source files have changed. 101 102(In normal development there's no downside to reflashing the bootloader and partition table each time, if they haven't changed.) 103 104## Erasing Flash 105 106The `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`. 107 108This 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. 109 110# Resources 111 112* Documentation for the latest version: https://docs.espressif.com/projects/esp-idf/. This documentation is built from the [docs directory](docs) of this repository. 113 114* The [esp32.com forum](https://esp32.com/) is a place to ask questions and find community resources. 115 116* [Check the Issues section on github](https://github.com/espressif/esp-idf/issues) if you find a bug or have a feature request. Please check existing Issues before opening a new one. 117 118* If you're interested in contributing to ESP-IDF, please check the [Contributions Guide](https://docs.espressif.com/projects/esp-idf/en/latest/contribute/index.html). 119
