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

   1 # Using Espressif IoT Development Framework with the ESP32
   2
   3 # Prerequisites
   4
   5 # Configuring your project
   6
   7 `make menuconfig`
   8
   9 # Compiling your project
  10
  11 `make all`
  12
  13 ... will compile app, bootloader and generate a partition table based on the config.
  14
  15 # Flashing your project
  16
  17 When `make all` finishes, it will print a command line to use esptool.py to flash the chip. However you can also do this from make by running:
  18
  19 `make flash`
  20
  21 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`.
  22
  23 You don't need to run `make all` before running `make flash`, `make flash` will automatically rebuild anything which needs it.
  24
  25 # Compiling & Flashing Just the App
  26
  27 After the initial flash, you may just want to build and flash just your app, not the bootloader and partition table:
  28
  29 * `make app` - build just the app.
  30 * `make app-flash` - flash just the app.
  31
  32 `make app-flash` will automatically rebuild the app if it needs it.
  33
  34 (There's no downside to reflashing the bootloader and partition table each time, if they haven't changed.)
  35
  36 # The Partition Table
  37
  38 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.
  39
  40 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 0x4000 in the flash.
  41
  42 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.
  43
  44 The simplest way to use the partition table is to `make menuconfig` and choose one of the simple predefined partition tables:
  45
  46 * "Single factory app, no OTA"
  47 * "Factory app, two OTA definitions"
  48
  49 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.
  50
  51 For more details about partition tables and how to create custom variations, view the `docs/partition_tables.rst` file.
  52
  53 # Resources
  54
  55 * The [docs directory of the esp-idf repository](https://github.com/espressif/esp-idf/tree/master/docs) contains esp-idf documentation.
  56
  57 * The [esp32.com forum](http://esp32.com/) is a place to ask questions and find community resources.
  58
  59 * [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.