ESP32 Platform

This component contains platform-specific options for the ESP32 platform.

# Example configuration entry
esp32:
  board: nodemcu-32s

Configuration variables:

  • board (Required, string): The PlatformIO board ID that should be used. Choose the appropriate board from this list (the icon next to the name can be used to copy the board ID). This only affects pin aliases, flash size and some internal settings, if unsure choose a generic board from Espressif such as esp32dev.

  • framework (Optional): Options for the underlying framework used by ESPHome. See GPIO Pin Numbering and ESP-IDF framework.

  • variant (Optional, boolean): 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 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.

GPIO Pin Numbering

The ESP32 boards often use the internal GPIO pin numbering on the board, this means that you don’t have to worry about other kinds of pin numberings, yay!

Some notes about the pins on the ESP32:

  • GPIO0 is used to determine the boot mode on startup. It should therefore not be pulled LOW on startup to avoid booting into flash mode. You can, however, still use this as an output pin.

  • GPIO34-GPIO39 can not be used as outputs (even though GPIO stands for “general purpose input output”…).

  • GPIO32-GPIO39: These pins can be used with the Analog To Digital Sensor to measure voltages.

  • GPIO2: This pin is connected to the blue LED on the board. It also supports the touch pad binary sensor like some other pins.

# Example configuration entry
binary_sensor:
  - platform: gpio
    name: "Pin GPIO23"
    pin: GPIO23

Arduino framework

This is the default framework for ESP32 chips at the moment.

# Example configuration entry
esp32:
  board: nodemcu-32s
  framework:
    type: arduino
    version: 2.0.0

Configuration variables:

  • version (Optional, string): The base framework version number to use, from ESP32 arduino releases. Defaults to recommended. Additional values are:

  • source (Optional, string): The PlatformIO package or repository to use for framework. This can be used to use a custom or patched version of the framework.

  • platform_version (Optional, string): The version of the platformio/espressif32 package to use.

ESP-IDF framework

This is an alternative base framework for ESP32 chips, and recommended for variants of the ESP32 like ESP32S2, ESP32S3, ESP32C3 and single-core ESP32 chips.

# Example configuration entry
esp32:
  board: esp32-c3-devkitm-1
  framework:
    type: esp-idf
    version: recommended
    # Custom sdkconfig options
    sdkconfig_options:
      CONFIG_COMPILER_OPTIMIZATION_SIZE: y
    # Advanced tweaking options
    advanced:
      ignore_efuse_mac_crc: false

Configuration variables:

  • version (Optional, string): The base framework version number to use, from ESP32 ESP-IDF releases. Defaults to recommended. Additional values are:

  • source (Optional, string): The PlatformIO package or repository to use for the framework. This can be used to use a custom or patched version of the framework.

  • platform_version (Optional, string): The version of the platformio/espressif32 package to use.

  • sdkconfig_options (Optional, mapping): Custom sdkconfig options to set in the ESP-IDF project.

  • advanced (Optional, mapping): Advanced options for highly specific tweaks.

    • ignore_efuse_mac_crc (Optional, boolean): Can be set to true for devices on which the burnt in MAC address does not match the also burnt in CRC for that MAC address, resulting in an error like Base MAC address from BLK0 of EFUSE CRC error.

See Also