https://esphome.io/index.html Logo Quick search [ ] [Go] Table of Contents * Devices * Core Components * Sensor Components + Core + Air Quality + Analogue + Bluetooth Low Energy (BLE) + Digital Signals + Distance + Electricity + Environmental + Light + Magnetic + Miscellaneous + Motion + Thermocouple + Weight * Binary Sensor Components * Output Components * Light Components * Switch Components * Button Components * Fan Components * Display Components * Touchscreen Components * Cover Components * Text Sensor Components * Climate Components * Number Components * Select Components * Lock Components * Misc Components * Additional Custom Components * Cookbook --------------------------------------------------------------------- * Join the community * Follow us on Twitter * Source Code * Contact (no support!) ESPHome is an open source project by Nabu Casa * This site is powered by Netlify _images/logo-text.svg ESPHome is a system to control your ESP8266/ESP32 by simple yet powerful configuration files and control them remotely through Home 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 * Made for ESPHome program Keeping up * Discord * Forums * Changelog * Supporters * Contributing DevicesP This list contains a bunch of getting started and more advanced 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 3 Gang V1.0 Core ComponentsP Core WiFi MQTT Core WiFi MQTT Network I2C Bus SPI Bus Network I2C Bus SPI Bus UART Bus CAN Bus OTA Updates UART Bus CAN Bus OTA Updates Logger Web Server Native API Logger Web Server Native API Power Supply Deep Sleep External Components Power Supply Deep Sleep External Components Sensor ComponentsP Sensors have been split into categories. If a sensor fits into more than one category, it will be listed multiple times. CoreP Sensor Core Home Assistant Integration Sensor Core Home Assistant Integration MQTT Subscribe Uptime Sensor WiFi Signal Strength MQTT Subscribe Uptime Sensor WiFi Signal Strength Template Sensor Custom Sensor Template Sensor Custom Sensor Air QualityP AirThings BLE CCS811 HM3301 AirThings BLE CCS811 HM3301 Radon CO2 & Volatile Particulate organics MH-Z19 PM1006 Sensor PMSA003I MH-Z19 PM1006 Sensor PMSA003I CO2 & Temperature Particulate Particulate PMSX003 RadonEye BLE SDS011 Sensor PMSX003 RadonEye BLE SDS011 Sensor Particulate Radon Particulate SEN5x SenseAir SCD30 SEN5x SenseAir SCD30 Temperature & Humidity CO2 CO2 & Temperature & Humidity SCD4X SGP30 SGP40 SCD4X SGP30 SGP40 CO2 & Temperature & CO2 & Volatile Volatile organics Humidity organics SM300D2 SPS30 T6613/15 SM300D2 SPS30 T6613/15 Air quality Particulate CO2 ZyAura ZyAura CO2 & Temperature & Humidity AnalogueP ADC ADS1115 CD74HC4067 ADC ADS1115 CD74HC4067 ESP internal 4-channel ADC 16-channel analog multiplexer MCP3008 MCP3204/MCP3208 Resistance MCP3008 MCP3204/MCP3208 Resistance 8-channel ADC 4-channel ADC Bluetooth Low Energy (BLE)P AM43 BLE Client BLE RSSI Sensor AM43 BLE Client Sensor BLE RSSI Lux & Battery level Inkbird IBS-TH1 Mopeka Pro Check RuuviTag Mini LP Inkbird IBS-TH1 Mopeka Pro Check RuuviTag Mini LP Temperature & Humidity & Temperature & tank level Accelerometer Humidity Xiaomi BLE Xiaomi BLE Various Digital SignalsP Duty Cycle Pulse Counter Pulse Meter Duty Cycle Pulse Counter Pulse Meter Pulse Width Pulse Width DistanceP HRXL MaxSonar WR TOF10120 Ultrasonic Sensor HRXL MaxSonar WR TOF10120 Ultrasonic Sensor Acoustic distance IR optical distance Acoustic distance VL53L0x VL53L0x IR optical distance ElectricityP ADE7953 ATM90E32 BL0939 ADE7953 ATM90E32 BL0939 Power Voltage & Voltage & Current & Current & Power Power & Energy BL0940 CS5460A CSE7761 BL0940 CS5460A CSE7761 Voltage & Current & Power Voltage & Voltage & Current & Current & Power Power CSE7766 CT Clamp Daly BMS CSE7766 CT Clamp Daly BMS Voltage & Current & Power AC current Voltage & Current & Power DSMR HLW8012 INA219 DSMR HLW8012 INA219 Electrical counter Voltage & DC Current Current & Power INA226 INA260 INA3221 INA226 INA260 INA3221 DC Current & Power DC Current & 3-Ch DC current Power MAX9611 PZEM AC PZEM DC MAX9611 PZEM AC PZEM DC +60VDC Voltage & Current & Voltage & Voltage & Current & Power & Temperature Current & Power Power PZEM004T SDM Meter Selec Meter PZEM004T SDM Meter Selec Meter Voltage & Current & Power Modbus energy Modbus energy monitor monitor Teleinfo Total Daily Energy Teleinfo Total Daily Energy Electrical counter EnvironmentalP AHT10 AirThings BLE AM2320 AHT10 AirThings BLE AM2320 Temperature & Humidity Temperature & Humidity Temperature & Humidity & Pressure BME280 BME680 BME680 via BSEC BME280 BME680 BME680 via BSEC Temperature & Humidity Temperature & Humidity Temperature & Humidity & Pressure & Pressure & Gas & Pressure & Gas BMP085 BMP280 BMP388 and BMP390 BMP085 BMP280 BMP388 and BMP390 Temperature & Pressure Temperature & Pressure Temperature & Pressure b-parasite Dallas DS18B20 DHT b-parasite Dallas DS18B20 DHT Moisture & Temperature Temperature Temperature & Humidity & Humidity & Light DHT12 ENS210 HDC1080 DHT12 ENS210 HDC1080 Temperature & Humidity Temperature & Humidity Temperature & Humidity Honeywell ABP HTU21D / Si7021 / Hydreon Rain Sensor SHT21 Honeywell ABP HTU21D / Si7021 / Hydreon Rain Sensor SHT21 Pressure & Temperature Rain Temperature & Humidity Inkbird IBS-TH1 Mini MCP9808 MH-Z19 Inkbird IBS-TH1 Mini MCP9808 MH-Z19 Temperature & Humidity Temperature CO2 & Temperature MS5611 NTC Thermistor QMP6988 MS5611 NTC Thermistor QMP6988 Pressure Temperature Temperature & Pressure RadonEye BLE RuuviTag SCD30 RadonEye BLE RuuviTag SCD30 Radon Temperature & Humidity CO2 & Temperature & & Accelerometer Humidity SCD4X SDP3x / SDP800 Series SHT3X-D SCD4X SDP3x / SDP800 Series SHT3X-D CO2 & Temperature & Pressure Temperature & Humidity Humidity SHT4X SHTCx STS3X SHT4X SHTCx STS3X Temperature & Humidity Temperature & Humidity Temperature TMP102 TMP117 TMP102 TMP117 Temperature Temperature LightP AM43 APDS9960 BH1750 AM43 APDS9960 BH1750 Lux Colour & Gesture Lux LTR390 MAX44009 TCS34725 LTR390 MAX44009 TCS34725 Lux & UV Lux Lux & RGB colour TSL2561 TSL2591 TSL2561 TSL2591 Lux Lux MagneticP ESP32 Hall Sensor HMC5883L MLX90393 ESP32 Hall Sensor HMC5883L MLX90393 ESP internal 3-Axis magnetometer 3-Axis magnetometer QMC5883L QMC5883L 3-Axis magnetometer MiscellaneousP AS3935 Binary Sensor b-parasite Map Binary Sensor b-parasite AS3935 Map Moisture & Temperature & Humidity & Storm lightning Map binary to Light value EZO sensor Havells Solar Growatt Solar circuits EZO sensor Havells Solar Growatt Solar circuits Solar rooftop Solar rooftop (pH) Kalman Modbus Sensor Nextion Combinator Kalman Nextion Combinator Modbus Sensor Sensors from display Rotary Encoder Tuya Sensor TX20 TX20 Rotary Encoder Tuya Sensor Wind speed & Wind direction MotionP APDS9960 MPU6050 MPU6886 APDS9960 MPU6050 MPU6886 Colour & Gesture Accelerometer & Accelerometer & Gyroscope Gyroscope RuuviTag RuuviTag Temperature & Humidity & Accelerometer ThermocoupleP MAX31855 MAX31856 MAX31865 MAX31855 MAX31856 MAX31865 K-Type All types Platinum RTD MAX6675 MAX6675 K-Type WeightP HX711 Xiaomi Miscale HX711 Xiaomi Miscale 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 example. Binary Sensor ComponentsP Binary Sensor Core GPIO Home Assistant Binary Sensor Core GPIO Home Assistant Status Analog Threshold ESP32 BLE Presence Status Analog Threshold ESP32 BLE Presence ESP32 Touch Pad Hydreon Rain Sensor MPR121 Capacitive Binary Sensor Touch Sensor ESP32 Touch Pad Hydreon Rain Sensor MPR121 Capacitive Binary Sensor Touch Sensor Nextion Binary Sensor Template Binary Sensor PN532 Nextion Binary Sensor Template Binary Sensor PN532 RC522 RDM6300 TTP229 RC522 RDM6300 TTP229 Tuya Binary Sensor Modbus Binary Sensor XPT2046 Tuya Binary Sensor Modbus Binary Sensor XPT2046 CAP1188 Capacitive Touchscreen Custom Binary Sensor Touch Sensor CAP1188 Capacitive Touchscreen Custom Binary Sensor Touch Sensor Output ComponentsP 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 Light ComponentsP Light Core Binary Light Status Led Light Core Binary Light Status Led Monochromatic Light Cold+Warm White Light Color Temperature Light Monochromatic Light Cold+Warm White Light Color Temperature Light RGB Light RGBW Light RGBWW Light RGB Light RGBW Light RGBWW Light RGBCT Light FastLED Light NeoPixelBus Light RGBCT Light FastLED Light NeoPixelBus Light Light Partition Tuya Dimmer Shelly Dimmer Light Partition Tuya Dimmer Shelly Dimmer Custom Light H-bridge Light Sonoff D1 Dimmer Custom Light H-bridge Light Sonoff D1 Dimmer Looking for WS2811 and similar individually addressable lights? Have a look at the FastLED Light. Switch ComponentsP 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 ComponentsP Button Core Template Button Generic Output Button Button Core Template Button Generic Output Button Restart Button Safe Mode Button Shutdown Button Restart Button Safe Mode Button Shutdown Button Wake-on-LAN Wake-on-LAN Fan ComponentsP Fan Core Binary Fan H-bridge Fan Fan Core Binary Fan H-bridge Fan Speed Fan Tuya Fan Speed Fan Tuya Fan Display ComponentsP Display Core Addressable Light LCD Display Display Core Addressable Light LCD Display 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 ComponentsP Touchscreen Core EKTF2232 Lilygo T5 4.7" EKTF2232 Touchscreen Core Lilygo T5 4.7" Inkplate 6 Plus Cover ComponentsP Cover Core Template Cover Endstop Cover Cover Core Template Cover Endstop Cover Current-Based Cover Time-Based Cover Custom Cover Current-Based Cover Time-Based Cover Custom Cover AM43 Cover Tuya Cover AM43 Cover Tuya Cover Text Sensor ComponentsP Text Sensor Core Home Assistant MQTT Subscribe Text Text Sensor Core Home 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 ComponentsP Climate Core Bang Bang Controller Thermostat Controller Climate Core 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 BedJet Climate System BedJet Climate System Number ComponentsP Number Core Modbus Number Template Number Number Core Modbus Number Template Number Tuya Number Tuya Number Select ComponentsP Select Core Template Select Modbus Select Select Core Template Select Modbus Select Lock ComponentsP Lock Core Generic Output Lock Template Lock Lock Core Generic Output Lock Template Lock Misc ComponentsP 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 Sun 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 - TCA9548A I2C I2C Bus Multiplexer PCF8574 I/O Expander MCP230XX I/O Expander - TCA9548A I2C I2C Bus Multiplexer MCP23SXX I/O Expander - SX1509 I/O Expander SN74HC595 I/O SPI Bus Expander MCP23SXX I/O Expander - SX1509 I/O Expander SN74HC595 I/O SPI Bus 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 Bridge Tuya MCU Modbus Controller Exposure Notifications RTTTL Buzzer Modbus Controller Exposure Notifications RTTTL Buzzer Prometheus PipSolar - compatible PV Grow Fingerprint Inverter Reader Prometheus PipSolar - compatible PV Grow Fingerprint Inverter Reader SML Demo Copy SML Demo Copy Additional Custom ComponentsP Generic Custom Component Custom I2C Component Custom SPI Component Generic Custom Component Custom I2C Component Custom SPI Component Custom UART Component Custom UART Component CookbookP Arduino Port Endstop Cover PIR Sensor Extender Arduino Port Endstop Cover PIR Sensor Extender Relay BRUH Multisensor TEMT6000 Relay BRUH Multisensor TEMT6000 Non-Invasive Power Dual Relay Motor Cover BME280 Environment Meter Non-Invasive Power Dual Relay Motor Cover BME280 Environment Meter Sonoff Fishpond H801 LED Controller Time & Temperature on OLED Pump Display Sonoff Fishpond H801 LED Controller Time & Temperature on OLED Pump Display Mirabella Genio Garage Door Brilliant / Mirabella Bulb Genio Smart Plugs Mirabella Genio Garage Door Brilliant / Mirabella Bulb Genio Smart Plugs Etekcity Voltson Sonoff iFan02 Zemismart RGBW Downlights (ESW01-EU) Etekcity Voltson Sonoff iFan02 Zemismart RGBW Downlights (ESW01-EU) Teckin SB50 Sonoff light switch ESP32 Water Leak Detector options Teckin SB50 Sonoff light switch ESP32 Water Leak Detector options ESP32 BLE iTag IAQ (Indoor Air TUYA Smart Life RGBW Button Quality) Board Controller ESP32 BLE iTag IAQ (Indoor Air TUYA Smart Life RGBW Button Quality) Board Controller Custom UART Text IWOOLE Table Lamp EPEVER Tracer Sensor Custom UART Text IWOOLE Table Lamp EPEVER Tracer Sensor Ilonda Wifi Smart AirGradient DIY Air Fish Feeder Quality Sensor Ilonda Wifi Smart AirGradient DIY Air Fish Feeder Quality Sensor Do you have other awesome automations or cool setups? Please feel free to add them to the documentation for others to copy. See Contributing. A new version has been release since you last visited this page: 2022.5.1 Dismiss View Changelog