From 6c726860706872ee6d8c26d7e2a536a4b2196e75 Mon Sep 17 00:00:00 2001 From: Keith Burzinski Date: Mon, 13 Nov 2023 18:47:30 -0600 Subject: [PATCH] Add documentation for flash size (#3345) --- components/esp32.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/components/esp32.rst b/components/esp32.rst index e2a2daade..4be16b578 100644 --- a/components/esp32.rst +++ b/components/esp32.rst @@ -23,13 +23,16 @@ Configuration variables: choose a generic board from Espressif such as ``esp32dev``. - **framework** (*Optional*): Options for the underlying framework used by ESPHome. See :ref:`esp32-arduino_framework` and :ref:`esp32-espidf_framework`. +- **flash_size** (*Optional*, string): The amount of flash memory available on the ESP32 board/module. One of ``4MB``, + ``8MB``, ``16MB`` or ``32MB``. Defaults to ``4MB``. **Warning: specifying a size larger than that available on your + board will cause the ESP32 to fail to boot.** - **variant** (*Optional*, string): The variant of the ESP32 that is used on this board. One of ``esp32``, - ``esp32s2``, ``esp32s3``, ``esp32c3`` and ``esp32h2``. Defaults to the variant that is detected from the board, if + ``esp32s2``, ``esp32s3``, ``esp32c3`` and ``esp32h2``. Defaults to the variant that is detected from the board; if a board that's unknown to ESPHome is used, this option is mandatory. .. note:: - Support for the ESP32-S2 and ESP32-C3 is still in development and there could be issues. + Support for ESP32 variants such as the S2, S3 and C3 is still in development and there could be issues. GPIO Pin Numbering ------------------