granicus.if.org Git - esp-idf/blob - README.md

   1 # Espressif IoT Development Framework
   2
   3 [![Documentation Status](https://readthedocs.com/projects/espressif-esp-idf/badge/?version=latest)](https://docs.espressif.com/projects/esp-idf/en/latest/?badge=latest)
   4
   5 ESP-IDF is the official development framework for the [ESP32](https://espressif.com/en/products/hardware/esp32/overview) chip.
   6
   7 # Developing With ESP-IDF
   8
   9 ## Setting Up ESP-IDF
  10
  11 See setup guides for detailed instructions to set up the ESP-IDF:
  12
  13 * [Getting Started Guide for the stable ESP-IDF version](https://docs.espressif.com/projects/esp-idf/en/stable/get-started/)
  14 * [Getting Started Guide for the latest (master branch) ESP-IDF version](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/)
  15
  16 ### Non-GitHub forks
  17
  18 ESP-IDF uses relative locations as its submodules URLs ([.gitmodules](.gitmodules)). So they link to GitHub.
  19 If ESP-IDF is forked to a Git repository which is not on GitHub, you will need to run the script
  20 [tools/set-submodules-to-github.sh](tools/set-submodules-to-github.sh) after git clone.
  21 The script sets absolute URLs for all submodules, allowing `git submodule update --init --recursive` to complete.
  22 If cloning ESP-IDF from GitHub, this step is not needed.
  23
  24 ## Finding a Project
  25
  26 As well as the [esp-idf-template](https://github.com/espressif/esp-idf-template) project mentioned in Getting Started, ESP-IDF comes with some example projects in the [examples](examples) directory.
  27
  28 Once you've found the project you want to work with, change to its directory and you can configure and build it.
  29
  30 To start your own project based on an example, copy the example project directory outside of the ESP-IDF directory.
  31
  32 # Quick Reference
  33
  34 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:
  35
  36 ## Configuring the Project
  37
  38 `make menuconfig`
  39
  40 * Opens a text-based configuration menu for the project.
  41 * Use up & down arrow keys to navigate the menu.
  42 * Use Enter key to go into a submenu, Escape key to go out or to exit.
  43 * Type `?` to see a help screen. Enter key exits the help screen.
  44 * Use Space key, or `Y` and `N` keys to enable (Yes) and disable (No) configuration items with checkboxes "`[*]`"
  45 * Pressing `?` while highlighting a configuration item displays help about that item.
  46 * Type `/` to search the configuration items.
  47
  48 Once done configuring, press Escape multiple times to exit and say "Yes" to save the new configuration when prompted.
  49
  50 ## Compiling the Project
  51
  52 `make -j4 all`
  53
  54 ... will compile app, bootloader and generate a partition table based on the config.
  55
  56 NOTE: The `-j4` option causes `make` to run 4 parallel jobs. This is much faster than the default single job. The recommended number to pass to this option is `-j(number of CPUs + 1)`.
  57
  58 ## Flashing the Project
  59
  60 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:
  61
  62 `make -j4 flash`
  63
  64 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 `make menuconfig`.
  65
  66 You don't need to run `make all` before running `make flash`, `make flash` will automatically rebuild anything which needs it.
  67
  68 ## Viewing Serial Output
  69
  70 The `make monitor` target uses the [idf_monitor tool](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/idf-monitor.html) 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](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/idf-monitor.html).
  71
  72 Exit the monitor by typing Ctrl-].
  73
  74 To build, flash and monitor output in one pass, you can run:
  75
  76 `make -j4 flash monitor`
  77
  78 ## Compiling & Flashing Only the App
  79
  80 After the initial flash, you may just want to build and flash just your app, not the bootloader and partition table:
  81
  82 * `make app` - build just the app.
  83 * `make app-flash` - flash just the app.
  84
  85 `make app-flash` will automatically rebuild the app if any source files have changed.
  86
  87 (In normal development there's no downside to reflashing the bootloader and partition table each time, if they haven't changed.)
  88
  89 ## Parallel Builds
  90
  91 ESP-IDF supports compiling multiple files in parallel, so all of the above commands can be run as `make -jN` where `N` is the number of parallel make processes to run (generally N should be equal to the number of CPU cores in your system, plus one.)
  92
  93 Multiple make functions can be combined into one. For example: to build the app & bootloader using 5 jobs in parallel, then flash everything, and then display serial output from the ESP32 run:
  94
  95 ```
  96 make -j5 flash monitor
  97 ```
  98
  99
 100 ## The Partition Table
 101
 102 Once you've compiled your project, the "build" directory will contain a binary file with a name like "my_app.bin". This is an ESP32 image binary that can be loaded by the bootloader.
 103
 104 A single ESP32's flash can contain multiple apps, as well as many different kinds of data (calibration data, filesystems, parameter storage, etc). For this reason a partition table is flashed to offset 0x8000 in the flash.
 105
 106 Each entry in the partition table has a name (label), type (app, data, or something else), subtype and the offset in flash where the partition is loaded.
 107
 108 The simplest way to use the partition table is to `make menuconfig` and choose one of the simple predefined partition tables:
 109
 110 * "Single factory app, no OTA"
 111 * "Factory app, two OTA definitions"
 112
 113 In both cases the factory app is flashed at offset 0x10000. If you `make partition_table` then it will print a summary of the partition table.
 114
 115 For more details about partition tables and how to create custom variations, view the [`docs/en/api-guides/partition-tables.rst`](docs/en/api-guides/partition-tables.rst) file.
 116
 117 ## Erasing Flash
 118
 119 The `make 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 `make erase_flash`.
 120
 121 This can be combined with other targets, ie `make erase_flash flash` will erase everything and then re-flash the new app, bootloader and partition table.
 122
 123 # Resources
 124
 125 * Documentation for the latest version: https://docs.espressif.com/projects/esp-idf/. This documentation is built from the [docs directory](docs) of this repository.
 126
 127 * The [esp32.com forum](https://esp32.com/) is a place to ask questions and find community resources.
 128
 129 * [Check the Issues section on github](https://github.com/espressif/esp-idf/issues) if you find a bug or have a feature request. Please check existing Issues before opening a new one.
 130
 131 * If you're interested in contributing to ESP-IDF, please check the [Contributions Guide](https://docs.espressif.com/projects/esp-idf/en/latest/contribute/index.html).
 132
 133