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
11,669 Commits 20 Branches 148 Tags 384 MiB
C 95.6%
Python 2.1%
C++ 1.2%
CMake 0.7%
Assembly 0.3%
2483fb2777
Go to file
Angus Gratton 2483fb2777 ci: Fix websocket example test error handling 
If connection fails for websocket test, a second exception was generated in
__exit__
2021-06-01 17:19:26 +10:00
.github github: Sync PRs to JIRA as well 2019-03-14 14:29:46 +11:00
components NimBLE: Fix MITM vulnerability and free AES context (v4.0) 2021-05-25 14:57:37 +05:30
docs Backport CN translation for api-guides for v4.0 2021-04-23 15:52:58 +08:00
examples ci: Fix websocket example test error handling 2021-06-01 17:19:26 +10:00
make versions: Update version to 4.0.2 2020-11-05 09:38:34 +08:00
tools ttfw: fix DUT exception not added to junit report 2021-05-20 16:57:06 +08:00
.editorconfig cmake: Use cmake_lint project, tidy up all CMake source files 2018-04-30 09:59:20 +10:00
.flake8 ESP Local Control Feature Added 2019-07-03 21:31:04 +05:30
.gitignore tools: new installer for Windows 2019-07-01 18:08:02 +02:00
.gitlab-ci.yml docs: self host docs 2021-02-08 11:54:11 +08:00
.gitmodules tools: Add a script for switching to real submodules in forks 2019-07-05 11:12:06 +07: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
.travis.yml Check the Python coding style 2018-11-26 15:02:27 +01:00
add_path.sh tools: {install,export}.{bat,sh} tools 2019-07-01 14:51:44 +02:00
CMakeLists.txt cmake: error out on building in IDF_PATH root dir 2020-04-08 19:56:57 +08:00
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 Human-readable error if Git or Python are missing. 2021-04-26 14:08:37 +02:00
export.sh tools: Prefer python3 during install and export 2021-02-14 19:47:14 +01:00
install.bat Human-readable error if Git or Python are missing. 2021-04-26 14:08:37 +02:00
install.sh tools: Prefer python3 during install and export 2021-02-14 19:47:14 +01:00
Kconfig Docs: Encourage to used Python 3 2020-02-26 09:01:42 +01:00
LICENSE Initial public version 2016-08-17 23:08:22 +08:00
README.md docs: remove the read the docs CI badge 2021-03-23 12:25:17 +08:00
requirements.txt idf.py: Add support for action specific options 2019-06-03 13:07:02 +02:00
sdkconfig.rename Rename Kconfig options (root) 2019-05-21 09:09:01 +02:00
SUPPORT_POLICY.md docs: Add ESP-IDF support period policy 2019-10-29 16:26:13 +11:00

README.md

Espressif IoT Development Framework

ESP-IDF is the official development framework for the ESP32 chip 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:

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 for Windows, and install.sh 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 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 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