alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
Espressif IoT Development Framework. Official development framework for Espressif SoCs. https://docs.espressif.com/projects/esp-idf/en/stable/esp32/index.html
21,338 Commits 20 Branches 148 Tags 384 MiB
C 95.6%
Python 2.1%
C++ 1.2%
CMake 0.7%
Assembly 0.3%
7d888f3669
Go to file
Chen Yudong 7d888f3669 ci: exclude git files when uploading artifacts
2022-01-25 11:49:55 +08:00
.github ci: limit github-jira sync actions to a single concurrent run 2022-01-07 12:51:51 +01:00
.gitlab ci: exclude git files when uploading artifacts 2022-01-25 11:49:55 +08:00
components ci: move integration test related files outside of components 2022-01-25 11:49:55 +08:00
docs Merge branch 'feature/add_flash_suspend_example' into 'master' 2022-01-24 07:40:00 +00:00
examples Merge branch 'example/pytest_for_component_ut' into 'master' 2022-01-25 02:34:34 +00:00
tools ci: update intergration test to support esp32c3 2022-01-25 11:49:55 +08:00
.editorconfig style: add ini editorconfig 2021-11-30 09:04:10 +08:00
.flake8 Push out expat to idf-extra-components repository 2022-01-12 10:13:23 +05:30
.gitignore Add idf-component-manager python dependency 2021-08-30 13:23:23 +02:00
.gitlab-ci.yml ci: add flaky test 2022-01-24 16:37:23 +08:00
.gitmodules Push out expat to idf-extra-components repository 2022-01-12 10:13:23 +05:30
.mypy.ini Add mypy check to pre-commit-config 2021-02-25 07:05:43 +00:00
.pre-commit-config.yaml build-system: include soc_caps defines into kconfig 2021-12-06 12:37:07 +08:00
.pylintrc refactor: rewrite ldgen fragment file parser 2022-01-07 16:18:32 +08:00
.readthedocs.yml Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
add_path.sh Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
CMakeLists.txt newlib: auto-detect sizeof(time_t) 2022-01-11 19:01:21 +01:00
conftest.py ci: replace all component ut with pytest-embedded 2022-01-24 16:37:23 +08:00
CONTRIBUTING.rst Docs: Add copyright header guide for contributions 2021-11-04 11:55:26 +01:00
export.bat Tools: Improve the Python package system 2022-01-17 16:54:36 +01:00
export.fish Tools: Improve the Python package system 2022-01-17 16:54:36 +01:00
export.ps1 Tools: Improve the Python package system 2022-01-17 16:54:36 +01:00
export.sh Tools: Improve the Python package system 2022-01-17 16:54:36 +01:00
install.bat Tools: Improve the Python package system 2022-01-17 16:54:36 +01:00
install.fish Tools: Improve the Python package system 2022-01-17 16:54:36 +01:00
install.ps1 Tools: Improve the Python package system 2022-01-17 16:54:36 +01:00
install.sh Tools: Improve the Python package system 2022-01-17 16:54:36 +01:00
Kconfig esp8684: rename target to esp32c2 2022-01-19 11:08:57 +08:00
LICENSE Initial public version 2016-08-17 23:08:22 +08:00
pytest.ini ci: replace all component ut with pytest-embedded 2022-01-24 16:37:23 +08:00
README_CN.md tools: replace _ with - in idf.py 2021-10-13 17:30:38 +08:00
README.md tools: replace _ with - in idf.py 2021-10-13 17:30:38 +08:00
requirements.core.txt Tools: Improve the Python package system 2022-01-17 16:54:36 +01:00
requirements.gdbgui.txt Tools: Improve the Python package system 2022-01-17 16:54:36 +01:00
sdkconfig.rename cmake: using toolchain prefix determined by cmake itself 2022-01-10 10:06:09 +08:00
sonar-project.properties ci(sonarqube): pass "sonar.exclusions" in CI 2021-09-02 14:28:22 +08:00
SUPPORT_POLICY_CN.md doc: Update support period policy document 2020-08-14 09:59:35 +10:00
SUPPORT_POLICY.md Drop support for unsupported Python versions 2021-06-21 21:48:49 +02:00

README.md

Espressif IoT Development Framework

ESP-IDF is the development framework for Espressif SoCs supported on Windows, Linux and macOS.

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

Chip v3.3 v4.0 v4.1 v4.2 v4.3 v4.4
ESP32 alt text alt text alt text alt text alt text alt text
ESP32-S2 alt text alt text alt text
ESP32-C3 alt text alt text
ESP32-S3 alt text alt text Announcement
ESP32-H2 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