ESPHome Docs
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.
Help improve this documentation
Section titled “Help improve this documentation”If you find any errors in this site, corrections are welcome. You can submit a Pull Request (PR) in the GitHub repo with corrections. If you don’t know how to create a PR you can just use the “Edit this page on GitHub” link on the page in question which will take you to the source file for that page.
Alternatively, post in the Documentation channel in the Discord server.
ESPHome Configuration
Section titled “ESPHome Configuration”ESPHome is configured in YAML files - use these links for basic and advanced information about ESPHome configuration files.
Supported Microcontrollers
Section titled “Supported Microcontrollers”
Microcontroller Peripherals
Section titled “Microcontroller Peripherals”Peripherals which directly support the operation of the microcontroller’s processor(s).
ESPHome Automations
Section titled “ESPHome Automations”“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
Section titled “ESPHome Components”ESPHome-specific components or components supporting ESPHome device provisioning post-installation.
Network Hardware
Section titled “Network Hardware”
Network Protocols
Section titled “Network Protocols”
Bluetooth/BLE
Section titled “Bluetooth/BLE”
Management and Monitoring
Section titled “Management and Monitoring”
Update Installation
Section titled “Update Installation”Install updates over-the-air (OTA).
Update Management
Section titled “Update Management”Create update entities simplifying management of OTA updates.
Hardware Peripheral Interfaces/Busses
Section titled “Hardware Peripheral Interfaces/Busses”
I/O Expanders/Multiplexers
Section titled “I/O Expanders/Multiplexers”
1-Wire Bus
Section titled “1-Wire Bus”Platforms which specifically support or extend the index, allowing communication with 1-Wire-based devices.
CAN Bus
Section titled “CAN Bus”Platforms which specifically support or extend the index, allowing communication with CAN-based devices.
Sensor Components
Section titled “Sensor Components”Sensors are organized into categories; if a given sensor fits into more than one category, it will appear multiple times.
Air Quality
Section titled “Air Quality”
Analogue
Section titled “Analogue”
Bluetooth Low Energy (BLE)
Section titled “Bluetooth Low Energy (BLE)”
Digital Signals
Section titled “Digital Signals”
Distance
Section titled “Distance”
Electricity
Section titled “Electricity”
Environmental
Section titled “Environmental”
Health/Safety
Section titled “Health/Safety”
Magnetic
Section titled “Magnetic”
Miscellaneous
Section titled “Miscellaneous”
Motion
Section titled “Motion”
Thermocouple
Section titled “Thermocouple”
Weight
Section titled “Weight”
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.
Binary Sensor Components
Section titled “Binary Sensor Components”Binary Sensors are organized into categories; if a given sensor fits into more than one category, it will appear multiple times.
Capacitive Touch
Section titled “Capacitive Touch”
Mechanical
Section titled “Mechanical”
NFC/RFID
Section titled “NFC/RFID”Often known as “tag” or “card” readers within the community.
Touchscreen
Section titled “Touchscreen”
Presence Detection
Section titled “Presence Detection”
Miscellaneous
Section titled “Miscellaneous”
Alarm Control Panel Components
Section titled “Alarm Control Panel Components”
Audio ADC Components
Section titled “Audio ADC Components”
Audio DAC Components
Section titled “Audio DAC Components”
Button Components
Section titled “Button Components”
Climate Components
Section titled “Climate Components”
Cover Components
Section titled “Cover Components”
Datetime Components
Section titled “Datetime Components”
Display Components
Section titled “Display Components”
Display Hardware Platforms
Section titled “Display Hardware Platforms”
Electromechanical
Section titled “Electromechanical”
Energy/Solar Management
Section titled “Energy/Solar Management”
Event Components
Section titled “Event Components”Fan Components
Section titled “Fan Components”
Home Assistant Components
Section titled “Home Assistant Components”Components specifically for interacting with Home Assistant.
Infrared Components
Section titled “Infrared Components”Used for creating infrared (IR) remote control transmitters and/or receivers.
Light Components
Section titled “Light Components”
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; for other processors, have a look at the FastLED Light.
Lock Components
Section titled “Lock Components”Media Player Components
Section titled “Media Player Components”
Microphone Components
Section titled “Microphone Components”
Number Components
Section titled “Number Components”Output Components
Section titled “Output Components”
Select Components
Section titled “Select Components”
Speaker Components
Section titled “Speaker Components”
Switch Components
Section titled “Switch Components”
Text Components
Section titled “Text Components”
Text Sensor Components
Section titled “Text Sensor Components”
Time Components
Section titled “Time Components”
Touchscreen Components
Section titled “Touchscreen Components”
Valve Components
Section titled “Valve Components”Water Heater Components
Section titled “Water Heater Components”
Wireless Communication
Section titled “Wireless Communication”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
Section titled “Miscellaneous Components”
Cookbook
Section titled “Cookbook”
Contributing
Section titled “Contributing”ESPHome depends on and welcomes contributions from our community. If you’d like to contribute, please see our developer site.