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.
1428 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%
Go to file
Ivan Grokhotkov 576052e5c2 Merge branch 'feature/extend_deep_sleep_apis' into 'master' 
extend deep sleep APIs

This adds the following APIs to enable various wakeup sources:
- esp_deep_sleep_enable_timer_wakeup
- esp_deep_sleep_enable_ulp_wakeup
- esp_deep_sleep_enable_ext0_wakeup
- esp_deep_sleep_enable_ext1_wakeup

And an API to start deep sleep:
- esp_deep_sleep_start

Add an API to control which peripherals are kept enabled in deep sleep mode:
- esp_err_t esp_deep_sleep_pd_config

Also rolled an update of rtc_io header comments into this MR, as I had to add `slpie`, `slpsel`, and `hold` fields into `rtc_gpio_desc_t` struct.

Deep sleep unit tests don’t do anything useful in CI context because we don’t have a way to check reset behavior (time till reset, reason for reset) in CI environment, yet. Also for external wakeup we would need to control some ESP32 pins from the test environment.

Currently there is one known issue:
- RTC Fast memory may be isolated from the bus after deep sleep reset. We work around this by setting FORCE_NONISO flag in RTC power control register. This is non-optimal and we will keep looking for the reason why isolation gets enabled.

See merge request !297
2016-12-16 16:17:37 +08:00
components deep sleep: add documentation 2016-12-16 14:31:29 +08:00
docs docs: fix some warnings 2016-12-16 14:31:29 +08:00
examples deep sleep: rename header file 2016-12-16 14:30:27 +08:00
make build system tests: Add test case for sdkconfig-triggered recompilation 2016-12-15 08:45:32 +11:00
tools Add testcase, fix executable memory allocated in shared dram/iram region 2016-12-15 15:03:22 +08:00
.gitignore add unit tests to esp-idf 2016-11-22 14:45:50 +08:00
.gitlab-ci.yml remove not used code as rm -rf always return 0 2016-12-12 09:31:06 +08:00
.gitmodules Secure boot: initial image signature support 2016-11-14 11:08:42 +11:00
add_path.sh add_path.sh: Use non-bash-specific instructions 2016-09-12 18:39:20 +10:00
CONTRIBUTING.rst docs: Hyperlinks to guides 2016-11-21 10:24:12 +08: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 Back to .md format 2016-11-01 01:20:04 +08:00

README.md

Using Espressif IoT Development Framework with the ESP32

alt text

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