Skip to content

ESP32 custom partitions #5538

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: next
Choose a base branch
from
Open

ESP32 custom partitions #5538

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cc21121
Update esp32.md with custom partitions information
luar123 Oct 28, 2025
cd47767
Update custom partitions section in esp32.md
luar123 Oct 29, 2025
7f34655
fix
luar123 Oct 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion content/components/esp32.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@ esp32:
`360MHz` or `400MHz`. Defaults to `160MHz`. Not all values are available for all chips.

- **partitions** (*Optional*, filename): The name of (optionally including the path to) the file containing the
partitioning scheme to be used. When not specified, partitions are automatically generated based on `flash_size`.
partitioning scheme to be used. When not specified, partitions are automatically generated based on `flash_size` and `custom_partitions`.

- **custom_partitions** (*Optional*): Add partitions to the automatically generated partition scheme. See [Custom Partitions](#esp32-partitions).

- **framework** (*Optional*): Options for the underlying framework used by ESPHome. See [Framework](#esp32-framework).

Expand Down Expand Up @@ -239,6 +241,18 @@ git repository.
- **path** (*Optional*, string): The path of the component in the git repository or a local path to the
component if `source` is not set.

{{< anchor "esp32-partitions" >}}

## Custom Partitions

The `custom_partitions` option allows you to add partitions to the automatically generated partition table. Valid partition types and subtypes
are found in the [esp-idf documentation](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-guides/partition-tables.html).

- **name** (*Required*, string): Name of the partition. Can not be any of `nvs`, `app0`, `app1`, `otadata`, `eeprom`, `spiffs`, `phy_init`.
- **type** (*Required*, string or integer): Partition type. One of `app` or `data` or a custom type with integer between 0x40 and 0xFE.
- **subtype** (*Required*, string or integer): Partition sub type. Can be a valid sub type name or integer between 0x0 and 0xFE.
- **size** (*Required*, integer): Partition size in bytes.

## GPIO Pin Numbering

The ESP32 boards often use the internal GPIO pin numbering based on the microcontroller, so you likely don't have to
Expand Down