ESPHome is a system to control your microcontrollers by simple yet powerful configuration files and control them remotely through Home Automation systems.
Getting started
esphome:
name: awesome
esp32:
board: nodemcu-32s
Next steps
Keeping up
Supported Microcontrollers¶
|
|
|
|
|
|
Microcontroller Peripherals¶
Peripherals which directly support the operation of the microcontroller’s processor(s).
|
|
|
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¶
ESPHome-specific components or components supporting ESPHome device provisioning post-installation.
|
|
|
|
|
|
|
|
|
|
|
|
ESPHome Configuration¶
Streamline your ESPHome configuration and/or use components provided by other contributors.
|
|
|
Network Hardware¶
|
|
|
Network Protocols¶
|
|
|
|
|
|
|
|
|
Bluetooth/BLE¶
|
|
|
|
|
|
Management and Monitoring¶
|
|
|
|
|
|
|
||
Update Installation¶
Install updates over-the-air (OTA).
|
|
|
Update Management¶
Create update entities simplifying management of OTA updates.
|
|
|
Hardware Peripheral Interfaces/Busses¶
|
|
|
|
|
|
|
||
I/O Expanders/Multiplexers¶
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
CAN Bus¶
|
|
|
Sensor Components¶
Sensors are organized into categories; if a given sensor fits into more than one category, it will appear multiple times.
Core¶
|
|
|
|
|
|
Air Quality¶
|
|
|
|
Volatile Organic Compound Sensor |
CO2 & Volatile organics |
|
|
|
|
|
CO2 & Temperature & Pressure |
CO2 & Air Quality |
Particulate |
|
|
|
|
Particulate |
NO2 & CO & Ethanol & Volatile organics |
Particulate |
|
|
|
|
CO2 & Volatile organics |
CO2 & Temperature |
Gas concentration |
|
|
|
|
Particulate |
Particulate |
Particulate |
|
|
|
|
Radon |
CO2 & Temperature & Humidity |
CO2 & Temperature & Humidity |
|
|
|
|
Particulate |
Ozone |
Temperature & Humidity & Volatile organics & NOx |
|
|
|
|
CO2 |
Formaldehyde |
CO2 & Volatile organics |
|
|
|
|
Volatile organics & NOx |
Air quality |
Particulate |
|
|
|
|
CO2 |
CO2 & Temperature & Humidity |
Analogue¶
|
|
|
|
ESP internal |
8-channel ADC |
4-channel ADC |
|
|
|
|
4-channel ADC |
16-channel analog multiplexer |
8-channel ADC |
|
|
|
|
4-channel ADC |
ADC |
Bluetooth Low Energy (BLE)¶
|
|
|
|
Lux & Battery level |
||
|
|
|
|
Soil moisture & Temperature & Light |
Temperature & Humidity |
|
|
|
|
|
Tank level |
Tank level |
Temperature & Humidity & Accelerometer |
|
||
|
Various |
Digital Signals¶
|
|
|
|
||
Distance¶
|
|
|
|
Acoustic distance |
Acoustic distance |
Acoustic distance |
|
|
|
|
Acoustic distance |
IR optical distance |
Acoustic distance |
|
|
|
|
IR optical distance |
Acoustic distance |
Electricity¶
|
|
|
|
Voltage & Current & Power |
Power |
Voltage & Current & Power |
|
|
|
|
Voltage & Current & Power |
Voltage & Current & Power & Energy |
Voltage & Current & Power & Energy |
|
|
|
|
Voltage & Current & Power |
Voltage & Current & Power |
Voltage & Current & Power |
|
|
|
|
Voltage & Current & Power |
Voltage & Current & Power |
Alternating Current (AC) |
|
|
|
|
Voltage & Current & Power |
Electrical counter |
Voltage & Current & Power |
|
|
|
|
Direct Current (DC) |
Direct Current (DC) & Power |
DC Voltage & Current & Power & Charge |
|
|
|
|
DC Voltage & Current & Power & Charge |
DC Voltage & Current & Power |
DC Voltage & Current & Power |
|
|
|
|
DC Voltage & Current & Power |
DC Current & Power |
3-Ch DC current |
|
|
|
|
District Heating Meter |
Voltage & Current & Power & Temperature |
Voltage & Current & Power |
|
|
|
|
Voltage & Current & Power |
Voltage & Current & Power |
Modbus energy monitor |
|
|
|
|
Modbus energy monitor |
Electrical counter |
Environmental¶
|
|
|
|
Temperature & Humidity |
Temperature & Humidity & Pressure |
|
|
|
|
|
Temperature & Humidity |
Temperature & Humidity |
Moisture & Temperature & Humidity & Light |
|
|
|
|
Temperature & Humidity & Pressure |
Temperature & Humidity & Pressure & Gas |
Temperature & Humidity & Pressure & Gas |
|
|
|
|
Temperature & Humidity & Pressure & Gas |
Temperature & Pressure |
Temperature & Pressure |
|
|
|
|
Temperature & Pressure |
Temperature & Pressure |
Temperature |
|
|
|
|
Temperature & Humidity |
Temperature & Humidity |
Temperature & Pressure |
|
|
|
|
Temperature |
CO2 & Air Quality |
Temperature & Humidity |
|
|
|
|
Temperature & Humidity |
Soil moisture & Temperature & Light |
Pressure & Temperature |
|
|
|
|
Pressure & Temperature |
Temperature & Humidity |
Temperature & Humidity |
|
|
|
|
Temperature & Humidity |
Temperature & Humidity |
Rain |
|
|
|
|
Temperature & Humidity |
Temperature & Humidity |
Temperature |
|
|
|
|
Temperature |
CO2 & Temperature |
Temperature |
|
|
|
|
Temperature & Pressure |
Pressure |
Temperature & Humidity & Pressure |
|
|
|
|
Pressure |
Temperature |
Soil moisture & Temperature |
|
|
|
|
Temperature & Pressure |
Radon |
Temperature & Humidity & Accelerometer |
|
|
|
|
CO2 & Temperature & Humidity |
CO2 & Temperature & Humidity |
Pressure |
|
|
|
|
Formaldehyde |
Temperature & Humidity |
Temperature & Humidity |
|
|
|
|
Temperature & Humidity |
Moisture & Temperature |
Temperature |
|
|
|
|
Temperature |
Temperature |
Temperature & Pressure |
|
|
|
|
Temperature |
Temperature |
Temperature |
|
||
|
Differential Pressure |
Light¶
|
|
|
|
Lux |
Lux |
Colour & Gesture |
|
|
|
|
Spectral Color Sensor |
Lux |
Lux |
|
|
|
|
Lux |
Lux |
Lux & UV |
|
|
|
|
Lux & Proximity |
Lux & Proximity |
Lux & Proximity |
|
|
|
|
Lux & Proximity |
Lux & Proximity |
Proximity |
|
|
|
|
Lux |
Lux & RGB colour |
Lux |
|
|
|
|
Lux |
Lux |
Lux |
|
||
|
Lux |
Magnetic¶
|
|
|
|
12-Bit Magnetic Position Sensor |
ESP internal |
3-Axis magnetometer |
|
|
|
|
3-Axis magnetometer |
3-Axis magnetometer |
3-Axis magnetometer |
|
||
|
3-Axis magnetometer |
Miscellaneous¶
|
|
|
|
Storm lightning |
Moisture & Temperature & Humidity & Light |
Map binary to value |
|
|
|
|
(pH) |
||
|
|
|
|
Air velocity |
Radiation |
Solar rooftop |
|
|
|
|
Solar rooftop |
||
|
|
|
|
Battery |
||
|
|
|
|
Sensors from display |
||
|
|
|
|
|
|
|
Moisture & Temperature |
Wind speed & Wind direction |
|
|
|
|
|
EC & Temperature |
pH & Temperature |
Motion¶
|
|
|
|
Colour & Gesture |
Accelerometer & Gyroscope |
Motion & Presence |
|
|
|
|
Motion & Presence |
Accelerometer & Gyroscope |
Accelerometer & Gyroscope |
|
|
|
|
Temperature & Humidity & Accelerometer |
Motion & Presence |
Thermocouple¶
|
|
|
|
K-Type |
All types |
|
|
|
|
|
Platinum RTD |
All types |
Weight¶
|
|
|
|
Load cell amplifier |
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¶
Binary Sensors are organized into categories; if a given sensor fits into more than one category, it will appear multiple times.
Core¶
|
|
|
|
|
|
Capacitive Touch¶
|
|
|
|
||
Mechanical¶
|
|
|
NFC/RFID¶
Often known as “tag” or “card” readers within the community.
|
|
|
|
|
|
|
||
Touchscreen¶
|
|
|
|
|
|
Presence Detection¶
|
|
|
|
|
|
Miscellaneous¶
|
|
|
|
|
|
|
|
|
|
||
Alarm Control Panel Components¶
|
|
|
Audio DAC Components¶
|
|
|
Button Components¶
|
|
|
|
|
|
|
|
|
Climate Components¶
|
|
|
|
|
|
|
|
|
|
|
|
Cover Components¶
|
|
|
|
|
|
|
|
|
Datetime Components¶
|
|
|
Display Components¶
|
|
|
|
|
|
|
|
|
|
|
|
Display Hardware Platforms¶
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Electromechanical¶
|
|
|
|
|
|
Energy/Solar Management¶
|
|
|
|
|
|
Event Components¶
|
|
|
Fan Components¶
|
|
|
|
|
|
Home Assistant Components¶
Components specifically for interacting with Home Assistant.
|
|
|
|
|
|
|
|
|
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 Light; for other processors, have a look at the FastLED Light.
Lock Components¶
|
|
|
Media Player Components¶
|
|
|
Microphone Components¶
|
|
|
Number Components¶
|
|
|
|
|
|
Output Components¶
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Select Components¶
|
|
|
|
|
|
Speaker Components¶
|
|
|
Switch Components¶
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Text Components¶
|
|
|
Text Sensor Components¶
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Time Components¶
|
|
|
|
|
|
|
||
Touchscreen Components¶
|
|
|
|
|
|
|
Inkplate 6 Plus |
||
|
|
|
|
||
Valve Components¶
|
|
|
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¶
|
|
|
|
|
|
|
|
|
Custom Components¶
Note: Custom Components are deprecated in favor of External Components!
|
|
|
|
|
|
|
|
|
|
|
|
Cookbook¶
|
|
|
|
|
|
|
|
|
|
||
Do you have other awesome automations or cool setups? Please feel free to add them to the documentation for others to copy. See Contributing.
If you’d like to share configurations for specific devices, please contribute to our ESPHome Devices database.