Startseite Erkunden Hilfe
Anmelden
RT-Thread-packages
/
esp-idf
Mirror von https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Dateien Issues 0 Wiki

Keine Beschreibung

Struktur: d48c4e1da7
Branches Tags
esp-idf
ZIP TAR.GZ
Michael (XIAO Xufeng) d48c4e1da7 spi_flash_test: workaround for broken ROM API after new API calls. vor 5 Jahren
.github d003f96a9d gh_action: fix python lint vor 5 Jahren
.gitlab 988be69466 esp_hw_support: create component vor 5 Jahren
components d48c4e1da7 spi_flash_test: workaround for broken ROM API after new API calls. vor 5 Jahren
docs 79887fdc6c soc: descriptive part occupy whole component vor 5 Jahren
examples 6bed9ec70c Merge branch 'bugfix/fix_ag_outging_callback_not_triggered' into 'master' vor 5 Jahren
make 261363855c build system: Also get IDF version from annotated tags only vor 5 Jahren
tools 3bacf35310 esp_flash: support high capacity flash chips (32-bit address) vor 5 Jahren
.editorconfig 7951152f7b CI: Refactor CI rules into `rules.yml`. vor 5 Jahren
.flake8 54ae6b871d Add Python-style ignore for the cmock component vor 5 Jahren
.gitignore 3057b76a7e tests: re-add all disabled tests and all disabled configurations vor 5 Jahren
.gitlab-ci.yml 7951152f7b CI: Refactor CI rules into `rules.yml`. vor 5 Jahren
.gitmodules 20c068ef3b cmock: added cmock as component vor 5 Jahren
.pylintrc aeb3c02746 Add sonarqube code static analysis for idf project vor 5 Jahren
.readthedocs.yml 363f3e8311 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. vor 6 Jahren
CMakeLists.txt 52607063cb ci: add script to check section references vor 5 Jahren
CONTRIBUTING.rst 52d888a68b docs: Fix broken URLs & permanent redirects vor 5 Jahren
Kconfig 0bb21281ca esp32s3: select esp32s3 beta version in menuconfig vor 5 Jahren
LICENSE bd6ea4393c Initial public version vor 9 Jahren
README.md 23eadafd38 Fix the setup instructions in the main README vor 5 Jahren
README_CN.md 71d1b32dde docs: Provide link to ESP32-S2 specific documentation vor 5 Jahren
SUPPORT_POLICY.md 7a9abe3ec5 add chart of version support to version.rst vor 5 Jahren
SUPPORT_POLICY_CN.md 540e5774d9 doc: Update support period policy document vor 5 Jahren
add_path.sh 12b6da0388 tools: {install,export}.{bat,sh} tools vor 6 Jahren
export.bat 12b6da0388 tools: {install,export}.{bat,sh} tools vor 6 Jahren
export.fish 9a79de3659 export.fish: Remove source check vor 5 Jahren
export.ps1 f2c6a64191 scripts: updates export.ps1 to export tools' paths vor 5 Jahren
export.sh 4712392161 tools: export.sh: fix compatibility with dash shell vor 5 Jahren
install.bat f38c1c18a8 tools: install.bat: bail out if idf_tools.py call fails vor 6 Jahren
install.fish 39fd234576 tool: fix install.fish vor 5 Jahren
install.ps1 bc42073a8b fixes for powershell on unix vor 5 Jahren
install.sh 12b6da0388 tools: {install,export}.{bat,sh} tools vor 6 Jahren
requirements.txt 883cbc416e tools: Use kconfiglib from package vor 5 Jahren
sdkconfig.rename 4fdaeb6b6e cmake: Add new compiler optimization levels definitions vor 6 Jahren

README.md

Espressif IoT Development Framework

ESP-IDF is the official development framework for the ESP32 and ESP32-S Series SoCs provided for Windows, Linux and macOS.

Developing With ESP-IDF

Setting Up ESP-IDF

See setup guides for detailed instructions to set up the ESP-IDF:

Chip Getting Started Guides for ESP-IDF
ESP32
ESP32-S2

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.

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

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