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
15,441 Commits 20 Branches 148 Tags 384 MiB
C 95.6%
Python 2.1%
C++ 1.2%
CMake 0.7%
Assembly 0.3%
76c279bee1
Go to file
Yuan Ming Fu 76c279bee1 bugfix: update genie timer in aligenie example
2020-12-02 12:04:27 +08:00
.github Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
.gitlab Merge branch 'feature/template_add_ci' into 'master' 2020-11-13 18:40:07 +08:00
components Merge branch 'bugfix/parttool_miss_arg' into 'master' 2020-12-01 07:30:42 +08:00
docs Merge branch 'doc/update_Chinese_translation_for_four_files_in_get-started_folder' into 'master' 2020-11-30 18:06:10 +08:00
examples bugfix: update genie timer in aligenie example 2020-12-02 12:04:27 +08:00
make Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
tools Merge branch 'bugfix/kconfig_ref_sort_content' into 'master' 2020-12-01 07:36:20 +08:00
.editorconfig CI: Refactor CI rules into rules.yml. 2020-10-26 10:23:46 +08:00
.flake8 Add Python-style ignore for the cmock component 2020-09-30 10:06:46 +02:00
.gitignore Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
.gitlab-ci.yml ci: use HTTPS for cloning in IT jobs 2020-10-30 10:07:51 +01:00
.gitmodules cmock: added cmock as component 2020-09-02 16:38:37 +08:00
.pre-commit-config.yaml pre-commit: Rearrange the YAML file to avoid the warning 2020-11-13 14:22:18 +11:00
.pylintrc Add sonarqube code static analysis for idf project 2020-08-24 14:39:15 +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 ci: add script to check section references 2020-09-03 18:14:17 +02:00
CONTRIBUTING.rst add contributing docs 2020-11-03 18:33:11 +08:00
export.bat tools: {install,export}.{bat,sh} tools 2019-07-01 14:51:44 +02:00
export.fish enable autocompletion for command idf.py 2020-11-03 23:27:58 +01:00
export.ps1 scripts: updates export.ps1 to export tools' paths 2020-07-27 11:55:04 +02:00
export.sh Redirect warning to stderr and unset temporary shell procedure 2020-11-11 15:12:58 +01:00
install.bat tools: install.bat: bail out if idf_tools.py call fails 2019-07-23 06:20:52 +02:00
install.fish Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
install.ps1 fixes for powershell on unix 2020-05-15 14:05:03 +02:00
install.sh tools: {install,export}.{bat,sh} tools 2019-07-01 14:51:44 +02:00
Kconfig Updates for riscv support 2020-11-13 07:49:11 +11:00
LICENSE Initial public version 2016-08-17 23:08:22 +08:00
README_CN.md docs: Provide link to ESP32-S2 specific documentation 2020-05-25 02:59:36 +08:00
README.md Fix the setup instructions in the main README 2020-09-07 16:06:05 +02:00
requirements.txt esptool: Update to v3.0 release version 2020-11-10 02:36:18 +00:00
sdkconfig.rename Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
SUPPORT_POLICY_CN.md doc: Update support period policy document 2020-08-14 09:59:35 +10:00
SUPPORT_POLICY.md add chart of version support to version.rst 2020-09-09 11:32:44 +02:00

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