Halaman utama Jelajahi Bantuan
Masuk
RT-Thread-packages
/
esp-idf
cermin dari https://github-proxy.rt-thread.io/RT-Thread-packages/esp-idf.git
2
0
Fork 0
Berkas Masalah 0 Wiki

Tidak Ada Deskripsi

Pohon: c49e99f9e7
Ranting Tag
esp-idf
ZIP TAR.GZ
morris c49e99f9e7 uart: use clk_tree API to acquire FAST_RC clock 3 tahun lalu
.github 9857049521 gh_actions: Don't use outdated actions/checkout@master 3 tahun lalu
.gitlab 977a2830dd example: update ir nec example with new rmt driver 3 tahun lalu
components c49e99f9e7 uart: use clk_tree API to acquire FAST_RC clock 3 tahun lalu
docs 6b29118765 docs: sync up lines for api-guides and get-started 3 tahun lalu
examples 722fde218d uart: add default source clock for all targets 3 tahun lalu
tools 722fde218d uart: add default source clock for all targets 3 tahun lalu
.editorconfig d9a354505d style: add ini editorconfig 4 tahun lalu
.flake8 2bb7dc4471 esptool: Include as a package, delete submodule 3 tahun lalu
.gitignore 4573448a74 test: ignore pytest dut log artifacts 3 tahun lalu
.gitlab-ci.yml 8dde0b1676 Update target-test-env-v5.0:2 3 tahun lalu
.gitmodules 2bb7dc4471 esptool: Include as a package, delete submodule 3 tahun lalu
.mypy.ini a22597a2d6 Add mypy check to pre-commit-config 4 tahun lalu
.pre-commit-config.yaml 08cc2fd493 Tools: Fix the Python dependency checker by skipping not installed dependency sub-trees 3 tahun lalu
.pylintrc 172854a850 refactor: rewrite ldgen fragment file parser 4 tahun lalu
.readthedocs.yml 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 tahun lalu
CMakeLists.txt 34aa82a11a cmake: use -warn_commons instead of --warn-common on macOS 3 tahun lalu
CONTRIBUTING.md 0f515ce3fb docs: make CONTRIBUTING.md readable on Github 3 tahun lalu
Kconfig 0580d68b69 esp32c2: Support riscv floating-point library selection 3 tahun lalu
LICENSE bd6ea4393c Initial public version 9 tahun lalu
README.md 9dd356f02d Readme: Update chip support matrix 3 tahun lalu
README_CN.md 9dd356f02d Readme: Update chip support matrix 3 tahun lalu
SUPPORT_POLICY.md 407053592e Drop support for unsupported Python versions 4 tahun lalu
SUPPORT_POLICY_CN.md 540e5774d9 doc: Update support period policy document 5 tahun lalu
add_path.sh 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 tahun lalu
conftest.py 877e98ae4b Revert "ci: rename all the generic s3 tag to generic_s3_fixme" 3 tahun lalu
export.bat a4b0560014 tools: Remove tools that are not used by active ESP-IDF version. 3 tahun lalu
export.fish 029de43db3 tools: bugfix export.sh change IDF_PATH only if file is esp-idf 3 tahun lalu
export.ps1 a4b0560014 tools: Remove tools that are not used by active ESP-IDF version. 3 tahun lalu
export.sh 9703b68215 tools: export.sh: fix expansion of IDF_PATH with spaces 3 tahun lalu
install.bat b28d7e6850 Tools: Improve the Python package system 4 tahun lalu
install.fish a93e372364 Tools: Fix silent failure about the incompatible Python 3 tahun lalu
install.ps1 3e7627c8c9 tools: fix python-env install by install.ps1 3 tahun lalu
install.sh a93e372364 Tools: Fix silent failure about the incompatible Python 3 tahun lalu
pytest.ini 977a2830dd example: update ir nec example with new rmt driver 3 tahun lalu
sdkconfig.rename bb88338118 system: move kconfig options out of target component 3 tahun lalu
sonar-project.properties 5671039154 ci(sonarqube): pass "sonar.exclusions" in CI 4 tahun lalu

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