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
12,315 Commits 20 Branches 148 Tags 384 MiB
C 95.6%
Python 2.1%
C++ 1.2%
CMake 0.7%
Assembly 0.3%
d2526e6dda
Go to file
Ivan Grokhotkov d2526e6dda nvs: fix out of bounds array access in host test
2020-03-13 11:29:39 +01:00
.github gh: remove default label on new issues 2020-01-09 17:07:34 +08:00
components nvs: fix out of bounds array access in host test 2020-03-13 11:29:39 +01:00
docs Updated index 2020-03-11 06:43:31 +08:00
examples Merge branch 'feature/multi_target_performance_test' into 'master' 2020-03-11 14:38:51 +08:00
make bootloader: Set the bootloader optimization level separately to the app 2020-02-27 14:38:52 +05:30
tools Add multi-target support for performance tests 2020-03-09 13:41:56 +01:00
.editorconfig cmake: Use cmake_lint project, tidy up all CMake source files 2018-04-30 09:59:20 +10:00
.flake8 Update kconfiglib to upstream version and replace mconf-idf 2019-10-29 10:40:04 +01:00
.gitignore bugfix/build_docs_add_warning_check: Added null value check for warnings 2020-02-12 12:32:41 +05:30
.gitlab-ci.yml ci: remove using IDF_XTENSA_TOOLCHAIN_URL because there are idf_tools.json and multi-target support 2020-02-10 18:05:21 +07:00
.gitmodules usb: added a tinyusb component; ci; soc. 2020-03-09 07:55:06 +01:00
.readthedocs.yml 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. 2019-07-08 13:19:56 +08:00
add_path.sh tools: {install,export}.{bat,sh} tools 2019-07-01 14:51:44 +02:00
CMakeLists.txt bootloader: Set the bootloader optimization level separately to the app 2020-02-27 14:38:52 +05:30
CONTRIBUTING.rst 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. 2019-02-17 20:32:50 +01:00
export.bat tools: {install,export}.{bat,sh} tools 2019-07-01 14:51:44 +02:00
export.ps1 tools: add install.ps1, export.ps1 2019-08-27 13:45:50 +08:00
export.sh tools: export.sh: fix ESP-IDF path detection on macos 2019-07-28 10:04:36 +02:00
install.bat tools: install.bat: bail out if idf_tools.py call fails 2019-07-23 06:20:52 +02:00
install.ps1 tools: add install.ps1, export.ps1 2019-08-27 13:45:50 +08:00
install.sh tools: {install,export}.{bat,sh} tools 2019-07-01 14:51:44 +02:00
Kconfig Merge branch 'feat/secure_boot_v2_v41' into 'master' 2020-02-27 18:54:08 +08:00
LICENSE Initial public version 2016-08-17 23:08:22 +08:00
README_CN.md add zh_CN translation of README in esp-idf repo 2019-10-09 11:50:06 +08:00
README.md README: Drop the RTD docs status badge, add a note about docs not updating for a period 2020-02-07 16:47:50 +11:00
requirements.txt Use component manager if available as python package 2019-12-19 16:48:36 +01:00
sdkconfig.rename cmake: Add new compiler optimization levels definitions 2019-09-06 17:37:19 +08:00
SUPPORT_POLICY_CN.md add chinese translation for support period policy 2019-11-11 10:40:30 +08:00
SUPPORT_POLICY.md add chinese translation for support period policy 2019-11-11 10:40:30 +08:00

README.md

Espressif IoT Development Framework

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:

Note: ESP-IDF Programmers Guide is in the process of transitioning to a new documentation host. Master branch ("latest") docs will not be updated from 2020-02-05 for approximately two weeks. This note will be removed once the master branch docs are updating again. Other branch & release docs continue to update as normal.

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