Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
Espressif IoT Development Framework. Official development framework for ESP32.
656 commits 10 branches 75 tags 114 MiB
C 91.5%
Python 3.7%
C++ 2.7%
CMake 0.7%
Assembly 0.5%
Other 0.7%
Find a file
Ivan Grokhotkov e03b45eb0a spi_flash: improve documentation
2016-10-27 17:58:42 +08:00
components spi_flash: improve documentation 2016-10-27 17:58:42 +08:00
docs nvs: Remove flash layout arguments from nvs_init() 2016-09-27 13:28:45 +10:00
examples Merge remote-tracking branch 'origin/bugfix/modify_some_wifi_apis' into feature/initial_examples 2016-09-27 19:37:06 +10:00
make vfs and newlib: small fixes 2016-10-27 17:22:18 +08:00
tools kconfig: fix build on macOS 2016-09-20 11:31:46 +08:00
.gitignore config system: Fix configuration when BUILD_DIR_BASE out-of-tree 2016-10-04 15:38:20 +11:00
.gitlab-ci.yml Add test for compiling in release mode, fix warnings and errors which appeared 2016-10-17 13:40:10 +08:00
.gitmodules components/bt: add library as submodule 2016-09-22 17:54:19 +08:00
add_path.sh add_path.sh: Use non-bash-specific instructions 2016-09-12 18:39:20 +10:00
CONTRIBUTING.md Add contributor agreement, update CONTRIBUTING file 2016-09-27 12:06:54 +10:00
Kconfig build system: fix setting C**FLAGS from project makefile 2016-10-20 17:17:54 +08:00
LICENSE Initial public version 2016-08-17 23:08:22 +08:00
README.md Documentation: Add contributor guide, expand README & add an examples README 2016-09-27 10:38:00 +10:00

README.md

Using Espressif IoT Development Framework with the ESP32

Setting Up ESP-IDF

In the docs directory you will find per-platform setup guides:

Finding A Project

As well as the esp-idf-template project mentioned in the setup guide, 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:

Configuring your project

make menuconfig

Compiling your project

make all

... will compile app, bootloader and generate a partition table based on the config.

Flashing your project

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:

make flash

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.

You don't need to run make all before running make flash, make flash will automatically rebuild anything which needs it.

Compiling & Flashing Just the App

After the initial flash, you may just want to build and flash just your app, not the bootloader and partition table:

  • make app - build just the app.
  • make app-flash - flash just the app.

make app-flash will automatically rebuild the app if it needs it.

(There's no downside to reflashing the bootloader and partition table each time, if they haven't changed.)

The Partition Table

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.

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.

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.

The simplest way to use the partition table is to make menuconfig and choose one of the simple predefined partition tables:

  • "Single factory app, no OTA"
  • "Factory app, two OTA definitions"

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.

For more details about partition tables and how to create custom variations, view the docs/partition_tables.rst file.

Resources