_images/logo-text.svg

ESPHome is a organization to command your ESP8266/ESP32 by unproblematic yet powerful configuration files and control them remotely through Domicile Automation systems.

_images/hero.png

Getting started

  • from Home Assistant
  • using the command line
  • by migrating from Tasmota
              esphome:               name: awesome             esp32:               board: nodemcu-32s            

Next steps

  • FAQ and Tips
  • Automations
  • DIY Examples
  • Configuration types
  • Sharing ESPHome devices
  • Fabricated for ESPHome programme

Keeping up

  • Discord
  • Forums
  • Changelog
  • Supporters
  • Contributing

Devices¶

This list contains a bunch of getting started and more avant-garde guides for using ESPHome. Technically, all ESP8266/ESP32 devices are supported by ESPHome.

Generic ESP8266

Generic ESP32

NodeMCU ESP8266

Generic ESP8266

Generic ESP32

NodeMCU ESP8266

NodeMCU ESP32

Sonoff S20

Sonoff 4CH

NodeMCU ESP32

Sonoff S20

Sonoff 4CH

Generic Sonoff

Sonoff Basic

Sonoff T1 UK 3 Gang V1.1

Generic Sonoff

Sonoff Basic

Sonoff T1 UK 3 Gang V1.1

Sonoff T3 EU 3 Gang V1.0

Sonoff T3 EU three Gang V1.0

Core Components¶

Core

WiFi

MQTT

Core

WiFi

MQTT

Network

I²C Bus

SPI Bus

Network

I²C Motorbus

SPI Jitney

UART Bus

CAN Bus

OTA Updates

UART Double-decker

CAN Bus

OTA Updates

Logger

Web Server

Native API

Logger

Web Server

Native API

Power Supply

Deep Sleep

External Components

Power Supply

Deep Slumber

External Components

Sensor Components¶

Sensors have been split into categories. If a sensor fits into more than 1 category, it will exist listed multiple times.

Core¶

Sensor Core

Home Assistant

Integration

Sensor Core

Domicile Assistant

Integration

MQTT Subscribe

Uptime Sensor

WiFi Signal Strength

MQTT Subscribe

Uptime Sensor

WiFi Betoken Strength

Template Sensor

Custom Sensor

Template Sensor

Custom Sensor

Air Quality¶

AirThings BLE

CCS811

HM3301

AirThings BLE

Radon

CCS811

CO2 & Volatile organics

HM3301

Particulate

MH-Z19

PM1006 Sensor

PMSA003I

MH-Z19

CO2 & Temperature

PM1006 Sensor

Particulate

PMSA003I

Particulate

PMSX003

RadonEye BLE

SDS011 Sensor

PMSX003

Particulate

RadonEye BLE

Radon

SDS011 Sensor

Particulate

SenseAir

SCD30

SCD4X

SenseAir

CO2

SCD30

CO2 & Temperature & Humidity

SCD4X

CO2 & Temperature & Humidity

SGP30

SGP40

SM300D2

SGP30

CO2 & Volatile organics

SGP40

Volatile organics

SM300D2

Air quality

SPS30

T6613/15

ZyAura

SPS30

Particulate

T6613/15

CO2

ZyAura

CO2 & Temperature & Humidity

Counterpart¶

ADC

ADS1115

CD74HC4067

ADC

ESP internal

ADS1115

iv-channel ADC

CD74HC4067

16-channel analog multiplexer

MCP3008

MCP3204

Resistance

MCP3008

8-channel ADC

MCP3204

iv-channel ADC

Resistance

Bluetooth Low Free energy (BLE)¶

AM43

BLE Client Sensor

BLE RSSI

AM43

Lux & Bombardment level

BLE Client Sensor

BLE RSSI

Inkbird IBS-TH1 Mini

Mopeka Pro Check LP

RuuviTag

Inkbird IBS-TH1 Mini

Temperature & Humidity

Mopeka Pro Check LP

tank level

RuuviTag

Temperature & Humidity & Accelerometer

Xiaomi BLE

Xiaomi BLE

Various

Digital Signals¶

Duty Cycle

Pulse Counter

Pulse Meter

Duty Cycle

Pulse Counter

Pulse Meter

Pulse Width

Pulse Width

Distance¶

HRXL MaxSonar WR

TOF10120

Ultrasonic Sensor

HRXL MaxSonar WR

Audio-visual distance

TOF10120

IR optical distance

Ultrasonic Sensor

Acoustic distance

VL53L0x

VL53L0x

IR optical distance

Electricity¶

ADE7953

ATM90E32

BL0940

ADE7953

Power

ATM90E32

Voltage & Electric current & Ability

BL0940

Voltage & Current & Power

CS5460A

CSE7761

CSE7766

CS5460A

Voltage & Current & Power

CSE7761

Voltage & Current & Power

CSE7766

Voltage & Current & Ability

CT Clamp

Daly BMS

DSMR

CT Clamp

Air conditioning electric current

Daly BMS

Voltage & Current & Power

DSMR

Electrical counter

HLW8012

INA219

INA226

HLW8012

Voltage & Current & Power

INA219

DC Current

INA226

DC Current & Power

INA260

INA3221

MAX9611

INA260

DC Current & Power

INA3221

3-Ch DC electric current

MAX9611

+60VDC Voltage & Current & Ability & Temperature

PZEM AC

PZEM DC

PZEM004T

PZEM AC

Voltage & Current & Power

PZEM DC

Voltage & Current & Power

PZEM004T

Voltage & Current & Power

SDM Meter

Selec Meter

Teleinfo

SDM Meter

Modbus energy monitor

Selec Meter

Modbus energy monitor

Teleinfo

Electrical counter

Total Daily Energy

Total Daily Free energy

Environmental¶

AHT10

AirThings BLE

AM2320

AHT10

Temperature & Humidity

AirThings BLE

Temperature & Humidity & Pressure

AM2320

Temperature & Humidity

BME280

BME680

BME680 via BSEC

BME280

Temperature & Humidity & Pressure

BME680

Temperature & Humidity & Pressure & Gas

BME680 via BSEC

Temperature & Humidity & Pressure & Gas

BMP085

BMP280

BMP388 and BMP390

BMP085

Temperature & Pressure

BMP280

Temperature & Pressure

BMP388 and BMP390

Temperature & Pressure

b-parasite

Dallas DS18B20

DHT

b-parasite

Moisture & Temperature & Humidity & Light

Dallas DS18B20

Temperature

DHT

Temperature & Humidity

DHT12

HDC1080

Honeywell ABP

DHT12

Temperature & Humidity

HDC1080

Temperature & Humidity

Honeywell ABP

Pressure & Temperature

HTU21D / Si7021 / SHT21

Inkbird IBS-TH1 Mini

MCP9808

HTU21D / Si7021 / SHT21

Temperature & Humidity

Inkbird IBS-TH1 Mini

Temperature & Humidity

MCP9808

Temperature

MH-Z19

MS5611

NTC Thermistor

MH-Z19

CO2 & Temperature

MS5611

Pressure

NTC Thermistor

Temperature

RadonEye BLE

RuuviTag

SCD30

RadonEye BLE

Radon

RuuviTag

Temperature & Humidity & Accelerometer

SCD30

CO2 & Temperature & Humidity

SCD4X

SDP3x / SDP800 Series

SHT3X-D

SCD4X

CO2 & Temperature & Humidity

SDP3x / SDP800 Series

Pressure

SHT3X-D

Temperature & Humidity

SHT4X

SHTCx

STS3X

SHT4X

Temperature & Humidity

SHTCx

Temperature & Humidity

STS3X

Temperature

TMP102

TMP117

TMP102

Temperature

TMP117

Temperature

Light¶

AM43

APDS9960

BH1750

AM43

Lux

APDS9960

Colour & Gesture

BH1750

Lux

LTR390

MAX44009

TCS34725

LTR390

Lux & UV

MAX44009

Lux

TCS34725

Lux & RGB colour

TSL2561

TSL2591

TSL2561

Lux

TSL2591

Lux

Magnetic¶

ESP32 Hall Sensor

HMC5883L

MLX90393

ESP32 Hall Sensor

ESP internal

HMC5883L

three-Axis magnetometer

MLX90393

3-Axis magnetometer

QMC5883L

QMC5883L

iii-Centrality magnetometer

Miscellaneous¶

AS3935

Binary Sensor Map

b-parasite

AS3935

Storm lightning

Binary Sensor Map

Map binary to value

b-parasite

Moisture & Temperature & Humidity & Low-cal

EZO sensor circuits

Havells Solar

Growatt Solar

EZO sensor circuits

(pH)

Havells Solar

Solar rooftop

Growatt Solar

Solar rooftop

Kalman Combinator

Modbus Sensor

Nextion

Kalman Combinator

Modbus Sensor

Nextion

Sensors from brandish

Rotary Encoder

Tuya Sensor

TX20

Rotary Encoder

Tuya Sensor

TX20

Current of air speed & Air current direction

Motion¶

APDS9960

MPU6050

MPU6886

APDS9960

Colour & Gesture

MPU6050

Accelerometer & Gyroscope

MPU6886

Accelerometer & Gyroscope

RuuviTag

RuuviTag

Temperature & Humidity & Accelerometer

Thermocouple¶

MAX31855

MAX31856

MAX31865

MAX31855

Chiliad-Type

MAX31856

All types

MAX31865

Platinum RTD

MAX6675

MAX6675

K-Blazon

Weight¶

HX711

Xiaomi Miscale

HX711

Load cell amplifier

Xiaomi Miscale

Looking for a sensor that outputs its values equally an analog voltage? Have a look at the ADC Sensor together with a formula like in the TEMT6000 instance.

Binary Sensor Components¶

Binary Sensor Core

GPIO

Home Assistant

Binary Sensor Core

GPIO

Home Assistant

Status

Analog Threshold

ESP32 BLE Presence

Condition

Analog Threshold

ESP32 BLE Presence

ESP32 Touch Pad

MPR121  Capacitive Touch Sensor

Nextion Binary Sensor

ESP32 Affect Pad

MPR121 Capacitive Touch on Sensor

Nextion Binary Sensor

Template Binary Sensor

PN532

RC522

Template Binary Sensor

PN532

RC522

RDM6300

TTP229

Tuya Binary Sensor

RDM6300

TTP229

Tuya Binary Sensor

Modbus Binary Sensor

XPT2046

CAP1188 Capacitive Touch Sensor

Modbus Binary Sensor

XPT2046

CAP1188 Capacitive Touch Sensor

Touchscreen

Custom Binary Sensor

Touchscreen

Custom Binary Sensor

Output Components¶

Output Core

ESP8266 Software PWM

Slow PWM

Output Core

ESP8266 Software PWM

Slow PWM

GPIO Output

ESP32 DAC

ESP32 LEDC

GPIO Output

ESP32 DAC

ESP32 LEDC

AC Dimmer

PCA9685

TLC59208F

AC Dimmer

PCA9685

TLC59208F

TLC5947

MY9231/MY9291

SM16716

TLC5947

MY9231/MY9291

SM16716

SM2135

MCP4725

MCP4728

SM2135

MCP4725

MCP4728

MCP47A1

BLE Binary Output

Modbus Output

MCP47A1

BLE Binary Output

Modbus Output

Custom Output

Template Output

Custom Output

Template Output

Lite Components¶

Light Core

Binary Light

Status Led

Light Core

Binary Light

Status Led

Monochromatic Light

Cold+Warm White Light

Color Temperature Light

Monochromatic Light

Common cold+Warm White Lite

Color Temperature Low-cal

RGB Light

RGBW Light

RGBWW Light

RGB Light

RGBW Lite

RGBWW Light

RGBCT Light

FastLED Light

NeoPixelBus Light

RGBCT Light

FastLED Light

NeoPixelBus Calorie-free

Light Partition

Tuya Dimmer

Custom Light

Calorie-free Partition

Tuya Dimmer

Custom Light

H-bridge Light

H-bridge Light

Looking for WS2811 and similar individually addressable lights? Have a look at the FastLED Light.

Switch Components¶

Switch Core

GPIO Switch

Restart Switch

Switch Core

GPIO Switch

Restart Switch

Safe Mode Switch

Shutdown Switch

Generic Output Switch

Safe Mode Switch

Shutdown Switch

Generic Output Switch

Template Switch

UART Switch

Custom Switch

Template Switch

UART Switch

Custom Switch

Tuya Switch

Modbus Switch

BLE Client Switch

Tuya Switch

Modbus Switch

BLE Client Switch

Nextion Switch

Nextion Switch

Button Components¶

Button Core

Template Button

Generic Output Button

Push button Core

Template Push

Generic Output Button

Restart Button

Safe Mode Button

Shutdown Button

Restart Button

Condom Mode Button

Shutdown Button

Wake-on-LAN

Wake-on-LAN

Fan Components¶

Fan Core

Binary Fan

H-bridge Fan

Fan Core

Binary Fan

H-span Fan

Speed Fan

Tuya Fan

Speed Fan

Tuya Fan

Brandish Components¶

Display Core

Addressable Light

LCD Display

Brandish Core

Addressable Calorie-free

LCD Brandish

MAX7219

MAX7219 Dot Matrix

TM1637

MAX7219

MAX7219 Dot Matrix

TM1637

Nextion

SSD1306

SSD1322

Nextion

SSD1306

SSD1322

SSD1325

SSD1327

SSD1331

SSD1325

SSD1327

SSD1331

SSD1351

ST7735

ST7789V

SSD1351

ST7735

ST7789V

ST7920

ILI9341

Waveshare E-Paper

ST7920

ILI9341

Waveshare E-Paper

Inkplate

PCD8544 (Nokia 5110/ 3310)

Inkplate

PCD8544 (Nokia 5110/ 3310)

Touchscreen Components¶

Touchscreen Core

EKTF2232

Lilygo T5 4.7"

Touchscreen Core

EKTF2232

Inkplate vi Plus

Lilygo T5 4.7"

Cover Components¶

Cover Core

Template Cover

Endstop Cover

Cover Core

Template Cover

Endstop Comprehend

Current-Based Cover

Time-Based Cover

Custom Cover

Current-Based Comprehend

Time-Based Cover

Custom Cover

AM43 Cover

Tuya Cover

AM43 Cover

Tuya Encompass

Text Sensor Components¶

Text Sensor Core

Home Assistant

MQTT Subscribe Text

Text Sensor Core

Dwelling Assistant

MQTT Subscribe Text

Version

WiFi Info

BLE Scanner

Version

WiFi Info

BLE Scanner

Modbus Text Sensor

Template Text Sensor

Custom Text Sensor

Modbus Text Sensor

Template Text Sensor

Custom Text Sensor

Nextion Text Sensor

Tuya Text Sensor

Nextion Text Sensor

Tuya Text Sensor

Climate Components¶

Climate Core

Bang Bang Controller

Thermostat Controller

Climate Cadre

Bang Bang Controller

Thermostat Controller

Custom Climate

PID Controller

IR Remote Climate

Custom Climate

PID Controller

IR Remote Climate

Tuya Climate

Midea

Anova Cooker

Tuya Climate

Midea

Anova Cooker

Number Components¶

Number Core

Modbus Number

Template Number

Number Core

Modbus Number

Template Number

Tuya Number

Tuya Number

Select Components¶

Select Core

Template Select

Modbus Select

Select Core

Template Select

Modbus Select

Lock Components¶

Lock Core

Generic Output Lock

Template Lock

Lock Cadre

Generic Output Lock

Template Lock

Misc Components¶

ESP8266

ESP32

Remote Receiver

ESP8266

ESP32

Remote Receiver

Remote Transmitter

Status LED

HTTP Request

Remote Transmitter

Status LED

HTTP Request

mDNS

Time

Sun

mDNS

Time

Dominicus

GPS

ESP32 BLE Client

ESP32 BLE Tracker

GPS

ESP32 BLE Client

ESP32 BLE Tracker

ESP32 BLE Beacon

ESP32 Ethernet

ESP32 Camera

ESP32 BLE Beacon

ESP32 Ethernet

ESP32 Camera

ESP32 Camera Web Server

Stepper

Servo

ESP32 Camera Web Server

Stepper

Servo

PCF8574 I/O Expander

MCP230XX I/O Expander - I²C Bus

TCA9548A I²C Multiplexer

PCF8574 I/O Expander

MCP230XX I/O Expander - I²C Bus

TCA9548A I²C Multiplexer

MCP23SXX I/O Expander - SPI Bus

SX1509 I/O Expander

SN74HC595 I/O Expander

MCP23SXX I/O Expander - SPI Motorcoach

SX1509 I/O Expander

SN74HC595 I/O Expander

SIM800L

DFPlayer

Captive Portal

SIM800L

DFPlayer

Captive Portal

Improv via BLE

Improv via Serial

Debug Component

Improv via BLE

Improv via Serial

Debug Component

TM1651 Battery Display

RF Bridge

Tuya MCU

TM1651 Battery Display

RF Span

Tuya MCU

Modbus Controller

Exposure Notifications

RTTTL Buzzer

Modbus Controller

Exposure Notifications

RTTTL Buzzer

Prometheus

PipSolar - compatible PV Inverter

Grow Fingerprint Reader

Prometheus

PipSolar - compatible PV Inverter

Grow Fingerprint Reader

Demo

Copy

Demo

Copy

Additional Custom Components¶

Generic Custom Component

Custom I²C Component

Custom SPI Component

Generic Custom Component

Custom I²C Component

Custom SPI Component

Custom UART Component

Custom UART Component

Cookbook¶

Arduino Port Extender

Endstop Cover

PIR Sensor

Arduino Port Extender

Endstop Embrace

PIR Sensor

Relay

BRUH Multisensor

TEMT6000

Relay

BRUH Multisensor

TEMT6000

Non-Invasive Power Meter

Dual Relay Motor Cover

BME280 Environment

Non-Invasive Power Meter

Dual Relay Motor Encompass

BME280 Environment

Sonoff Fishpond Pump

H801 LED Controller

Time & Temperature on OLED Display

Sonoff Fishpond Pump

H801 LED Controller

Fourth dimension & Temperature on OLED Display

Mirabella Genio Bulb

Garage Door

Brilliant / Mirabella Genio Smart Plugs

Mirabella Genio Bulb

Garage Door

Brilliant / Mirabella Genio Smart Plugs

Etekcity Voltson (ESW01-EU)

Sonoff iFan02

Zemismart RGBW Downlights

Etekcity Voltson (ESW01-Eu)

Sonoff iFan02

Zemismart RGBW Downlights

Teckin SB50

Sonoff light switch options

ESP32 Water Leak Detector

Teckin SB50

Sonoff low-cal switch options

ESP32 Water Leak Detector

ESP32 BLE iTag Button

IAQ (Indoor Air Quality) Board

TUYA Smart Life RGBW Controller

ESP32 BLE iTag Button

IAQ (Indoor Air Quality) Lath

TUYA Smart Life RGBW Controller

Custom UART Text Sensor

IWOOLE Table Lamp

EPEVER Tracer

Custom UART Text Sensor

IWOOLE Tabular array Lamp

EPEVER Tracer

Ilonda Wifi Smart Fish Feeder

AirGradient DIY Air Quality Sensor

Ilonda Wifi Smart Fish Feeder

AirGradient DIY Air Quality Sensor

Do you have other awesome automations or cool setups? Please experience free to add them to the documentation for others to copy. See Contributing.