This is the top-level ESPHome documentation index. Browse the tables below, use the sidebar menu, or the search function to find the information you’re looking for.

ESPHome Configuration Copy link to header

ESPHome is configured in YAML files - use these links for basic and advanced information about ESPHome configuration files.

Supported Microcontrollers Copy link to header

Microcontroller Peripherals Copy link to header

Peripherals which directly support the operation of the microcontroller’s processor(s).

ESPHome Automations Copy link to header

“When this happens, I want it to do that…”

Automations are how we customize ESPHome devices to respond/behave exactly how you want them to.

ESPHome Components Copy link to header

ESPHome-specific components or components supporting ESPHome device provisioning post-installation.

Network Hardware Copy link to header

Network Protocols Copy link to header

Bluetooth/BLE Copy link to header

Management and Monitoring Copy link to header

Update Installation Copy link to header

Install updates over-the-air (OTA).

Update Management Copy link to header

Create update entities simplifying management of OTA updates.

Hardware Peripheral Interfaces/Busses Copy link to header

I/O Expanders/Multiplexers Copy link to header

CAN Bus Copy link to header

Sensor Components Copy link to header

Sensors are organized into categories; if a given sensor fits into more than one category, it will appear multiple times.

Core Copy link to header

Air Quality Copy link to header

Analogue Copy link to header

Bluetooth Low Energy (BLE) Copy link to header

Digital Signals Copy link to header

Distance Copy link to header

Electricity Copy link to header

Environmental Copy link to header

Health/Safety Copy link to header

Light Copy link to header

Magnetic Copy link to header

Miscellaneous Copy link to header

Motion Copy link to header

Thermocouple Copy link to header

Weight Copy link to header

Looking for a sensor that outputs its values as an analog voltage? Have a look at the ADC Sensor together with a formula like in the TEMT6000 configuration <https://devices.esphome.io/devices/temt6000>__.

Binary Sensor Components Copy link to header

Binary Sensors are organized into categories; if a given sensor fits into more than one category, it will appear multiple times.

Core Copy link to header

Capacitive Touch Copy link to header

Mechanical Copy link to header

NFC/RFID Copy link to header

Often known as “tag” or “card” readers within the community.

Touchscreen Copy link to header

Presence Detection Copy link to header

Miscellaneous Copy link to header

Alarm Control Panel Components Copy link to header

Audio ADC Components Copy link to header

Audio DAC Components Copy link to header

Button Components Copy link to header

Climate Components Copy link to header

Cover Components Copy link to header

Datetime Components Copy link to header

Display Components Copy link to header

Display Hardware Platforms Copy link to header

Electromechanical Copy link to header

Energy/Solar Management Copy link to header

Event Components Copy link to header

Fan Components Copy link to header

Home Assistant Components Copy link to header

Components specifically for interacting with Home Assistant.

Light Components Copy link to header

Looking for WS2811 and similar individually addressable lights? For the ESP32 and its variants, we recommend the ESP32 RMT LED Strip or SPI LED Strip Light; for other processors, have a look at the FastLED Light.

Lock Components Copy link to header

Media Player Components Copy link to header

Microphone Components Copy link to header

Number Components Copy link to header

Output Components Copy link to header

Select Components Copy link to header

Speaker Components Copy link to header

Switch Components Copy link to header

Text Components Copy link to header

Text Sensor Components Copy link to header

Time Components Copy link to header

Touchscreen Components Copy link to header

Valve Components Copy link to header

Wireless Communication Copy link to header

Used for creating infrared (IR) or radio frequency (RF) remote control transmitters and/or receivers, or to connect ESPHome to cellular networks. Does not encompass Wi-Fi.

Miscellaneous Components Copy link to header

Cookbook Copy link to header

Contributing Copy link to header

ESPHome depends on and welcomes contributions from our community. If you’d like to contribute, please see our developer siteExternal link.

CURRENT