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: eb788deb03
Ranting Tag
esp-idf
ZIP TAR.GZ
Marius Vikhammer eb788deb03 esp_hw_support: merge C3 changes to master 5 tahun lalu
.github 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 tahun lalu
.gitlab 5c49987bf6 Merge branch 'feature/template_add_ci' into 'master' 5 tahun lalu
components eb788deb03 esp_hw_support: merge C3 changes to master 5 tahun lalu
docs da947d736f Docs: Add C3 support to build_docs 5 tahun lalu
examples 9fc771ad1b CI: change icmp example test address 5 tahun lalu
make 3587203495 tools: Invoke menuconfig as named module 5 tahun lalu
tools 286f06b274 Merge branch 'bugfix/ci_flasher_args_json_dict_items' into 'master' 5 tahun lalu
.editorconfig 7951152f7b CI: Refactor CI rules into `rules.yml`. 5 tahun lalu
.flake8 54ae6b871d Add Python-style ignore for the cmock component 5 tahun lalu
.gitignore 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 tahun lalu
.gitlab-ci.yml 129eefa5cb ci: use HTTPS for cloning in IT jobs 5 tahun lalu
.gitmodules 20c068ef3b cmock: added cmock as component 5 tahun lalu
.pre-commit-config.yaml 19b4f2452c pre-commit: Rearrange the YAML file to avoid the warning 5 tahun lalu
.pylintrc cccf3a9b3b pylint: disable more checkers 5 tahun lalu
.readthedocs.yml 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 tahun lalu
CMakeLists.txt 52607063cb ci: add script to check section references 5 tahun lalu
CONTRIBUTING.rst e8dc27add2 add contributing docs 5 tahun lalu
Kconfig 420aef1ffe Updates for riscv support 5 tahun lalu
LICENSE bd6ea4393c Initial public version 9 tahun lalu
README.md 23eadafd38 Fix the setup instructions in the main README 5 tahun lalu
README_CN.md 71d1b32dde docs: Provide link to ESP32-S2 specific documentation 5 tahun lalu
SUPPORT_POLICY.md 7a9abe3ec5 add chart of version support to version.rst 5 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
export.bat 12b6da0388 tools: {install,export}.{bat,sh} tools 6 tahun lalu
export.fish 346b002d9a enable autocompletion for command idf.py 5 tahun lalu
export.ps1 f2c6a64191 scripts: updates export.ps1 to export tools' paths 5 tahun lalu
export.sh 304cff9f75 Redirect warning to stderr and unset temporary shell procedure 5 tahun lalu
install.bat f38c1c18a8 tools: install.bat: bail out if idf_tools.py call fails 6 tahun lalu
install.fish 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 tahun lalu
install.ps1 bc42073a8b fixes for powershell on unix 5 tahun lalu
install.sh 12b6da0388 tools: {install,export}.{bat,sh} tools 6 tahun lalu
requirements.txt dc98d0aeee tools: Fix requirements incompatible with Python 2 5 tahun lalu
sdkconfig.rename 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 tahun lalu

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