diff --git a/content/components/esp32.md b/content/components/esp32.md index 3377301d40..5639e6ec42 100644 --- a/content/components/esp32.md +++ b/content/components/esp32.md @@ -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). @@ -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