cvonk / ESP32_factory-reset-task

Reusable ESP-IDF component: RTOS task to honor factory reset button for ESP32.

ESP32 - Factory Reset WiFi Credentials task

Goal

This component is a supplement to:

• the [BLE Provisioning[(https://github.com/cvonk/ESP32_ble-prov) component, and
• the OTA Update Task component.

After pressing the RESET/BOOT button for 3 seconds, it clears the provisioned WiFi credentials and OTA Updates from flash memory, . This allows the device to start with code from the factory partition so it can be provisioned for a different WiFi SSID or password.

Example

An example can be found in the test directory.

1. Compile this test application, and upload the .bin to your OTA Update server.

2. For the factory application, start with the example for [BLE Provisioning[(https://github.com/cvonk/ESP32_ble-prov) component and add the OTA Update Task component. Follow the steps in those examples. This will leave the WiFi SSID and password stored in the nvs partition of flash memory. As the last step it will download this example's .bin as an OTA Update.

3. Press the RESET/BOOT button for 3 seconds, to clears the provisioned WiFi credentials and OTA Updates from flash memory, . This allows the device to start with code from the factory partition so it can be provisioned for a different WiFi SSID or password.

Usage

The software relies on the master ESP-IDF SDK version v4.3-dev-472-gcf056a7d0 and accompanying tools.

Clone this component in your project's components directory, or use it as a git submodule.

In your project's sdkconfig.defaults, specify a custom partition.csv that includes a coredump partition. An example of sdkconfig.defaults is shown below.

CONFIG_PARTITION_TABLE_CUSTOM=y
CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions.csv"
CONFIG_PARTITION_TABLE_FILENAME="partitions.csv"
CONFIG_ESPTOOLPY_FLASHSIZE_4MB=y

An example of partition.csv is shown below.

# Name,   Type, SubType, Offset,  Size, Flags
nvs,      data, nvs,      0x09000,  0x004000,
otadata,  data, ota,      0x0d000,  0x002000,
phy_init, data, phy,      0x0f000,  0x001000,
factory,  app,  factory,  0x010000, 0x150000,
ota_0,    app,  ota_0,    0x160000, 0x140000,
ota_1,    app,  ota_1,    0x2A0000, 0x140000,
coredump, data, coredump, 0x3E0000, 128k

Before start the component's task, call nvs_flash_init(). Then create the factory_reset_task using

xTaskCreate(&factory_reset_task, "factory_reset_task", 4096, NULL, 5, NULL);

Feedback

I love to hear from you. Please use the Github discussion board to contact me.