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: 2ac8900a58
Ranting Tag
esp-idf
ZIP TAR.GZ
lly 2ac8900a58 ble_mesh: Remove useless example files 6 tahun lalu
.github 7e72e12e4c github: Update to new issue templates 6 tahun lalu
components 98495e5939 sntp: Add API to set update interval 6 tahun lalu
docs 9f038edbfd Merge branch 'feature/github_issue_templates' into 'master' 6 tahun lalu
examples 2ac8900a58 ble_mesh: Remove useless example files 6 tahun lalu
make 86d65b88f4 make: fix undefined variable warning (IDF_SKIP_CHECK_SUBMODULES) 6 tahun lalu
tools c0d12988d3 Merge branch 'feature/component_manager' into 'master' 6 tahun lalu
.editorconfig 88df8fd293 cmake: Use cmake_lint project, tidy up all CMake source files 7 tahun lalu
.flake8 01887f71e7 Update kconfiglib to upstream version and replace mconf-idf 6 tahun lalu
.gitignore dfafa98253 Use component manager if available as python package 6 tahun lalu
.gitlab-ci.yml a11b15b92b CI: build system do not check submodule for CI 6 tahun lalu
.gitmodules dfafa98253 Use component manager if available as python package 6 tahun lalu
.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. 6 tahun lalu
CMakeLists.txt f287f59ae3 build system: move -fno-rtti link option next to the compile option 6 tahun lalu
CONTRIBUTING.rst ed0db52f74 docs: This is a quick reference of more than a dozen and-ons and extensions prepared over the last two years to add contents, improve look & feel and cut on maintenance of the ESP-IDF documentation. 7 tahun lalu
Kconfig 2237cc11a3 add IDF_ENV_FPGA option 6 tahun lalu
LICENSE bd6ea4393c Initial public version 9 tahun lalu
README.md 18183871de add zh_CN translation of README in esp-idf repo 6 tahun lalu
README_CN.md 18183871de add zh_CN translation of README in esp-idf repo 6 tahun lalu
SUPPORT_POLICY.md 806229492e add chinese translation for support period policy 6 tahun lalu
SUPPORT_POLICY_CN.md 806229492e add chinese translation for support period policy 6 tahun lalu
add_path.sh 12b6da0388 tools: {install,export}.{bat,sh} tools 6 tahun lalu
export.bat 12b6da0388 tools: {install,export}.{bat,sh} tools 6 tahun lalu
export.ps1 79dd142ab8 tools: add install.ps1, export.ps1 6 tahun lalu
export.sh 3f9fc97de7 tools: export.sh: fix ESP-IDF path detection on macos 6 tahun lalu
install.bat f38c1c18a8 tools: install.bat: bail out if idf_tools.py call fails 6 tahun lalu
install.ps1 79dd142ab8 tools: add install.ps1, export.ps1 6 tahun lalu
install.sh 12b6da0388 tools: {install,export}.{bat,sh} tools 6 tahun lalu
requirements.txt dfafa98253 Use component manager if available as python package 6 tahun lalu
sdkconfig.rename 4fdaeb6b6e cmake: Add new compiler optimization levels definitions 6 tahun lalu

README.md

Espressif IoT Development Framework

Documentation Status

ESP-IDF is the official development framework for the ESP32 chip.

Developing With ESP-IDF

Setting Up ESP-IDF

See setup guides for detailed instructions to set up the 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 Getting Started guide for a full list of required steps with details.)

  • Install host build dependencies mentioned in Getting Started guide.
  • Add tools/ directory to the PATH
  • Run python -m pip install -r requirements.txt to install Python dependencies

Configuring the Project

idf.py menuconfig

  • Opens a text-based configuration menu for the project.
  • Use up & down arrow keys to navigate the menu.
  • Use Enter key to go into a submenu, Escape key to go out or to exit.
  • Type ? to see a help screen. Enter key exits the help screen.
  • Use Space key, or Y and N keys to enable (Yes) and disable (No) configuration items with checkboxes "[*]"
  • Pressing ? while highlighting a configuration item displays help about that item.
  • Type / to search the configuration items.

Once done configuring, press Escape multiple times to exit and say "Yes" to save the new configuration when prompted.

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