Skip to content
Snippets Groups Projects
Select Git revision
  • f69f05ecd70ec4eb810a9d77c22a7edc6edd8d73
  • 5.1-flow3r default
  • v5.1-flow3r
  • v4.2.5
  • v5.1
  • v5.1-rc2
  • v4.4.5
  • v5.1-rc1
  • v5.0.2
  • v5.1-beta1
  • v5.2-dev
  • v4.3.5
  • v5.0.1
  • v4.4.4
  • v4.1.4
  • v5.0
  • v5.0-rc1
  • v4.4.3
  • v4.3.4
  • v4.2.4
  • v5.0-beta1
  • v5.1-dev
22 results

esp-idf

  • Clone with SSH
  • Clone with HTTPS
    • user avatar
    bootloader: esp32s2: fix enabling custom console pins
    Ivan Grokhotkov authored
    f69f05ec
    History
    user avatar f69f05ec
    History
    Name Last commit Last update
    .github
    components
    docs
    examples
    make
    tools
    .editorconfig
    .flake8
    .gitignore
    .gitlab-ci.yml
    .gitmodules
    .readthedocs.yml
    CMakeLists.txt
    CONTRIBUTING.rst
    Kconfig
    LICENSE
    README.md
    README_CN.md
    SUPPORT_POLICY.md
    SUPPORT_POLICY_CN.md
    add_path.sh
    export.bat
    export.ps1
    export.sh
    install.bat
    install.ps1
    install.sh
    requirements.txt
    sdkconfig.rename
    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