2021-09-10 11:31:42 +02:00
.. title :: ESPHome
2018-11-15 13:36:01 +01:00
.. meta ::
2019-02-07 14:12:09 +01:00
:google-site-verification: Q5q5TFbCofxA8-cSa1Frv5Hj4RopF5zwEZf_zaNHqf4
2018-11-15 13:36:01 +01:00
2018-11-14 22:12:27 +01:00
.. seo ::
2019-02-27 18:32:47 +01:00
:description: ESPHome Homepage - Reimagining DIY Home Automation. ESPHome is a framework that
tries to provide the best possible use experience for using ESP8266 and ESP32 microcontrollers
for Home Automation. Just write a simple YAML configuration file and get your own customized firmware.
2019-02-13 23:14:10 +01:00
:image: logo.png
2018-05-13 11:37:02 +02:00
2019-02-07 13:54:45 +01:00
.. image :: /images/logo-text.svg
2018-05-13 11:37:02 +02:00
2019-07-03 16:48:49 +02:00
ESPHome is a system to control your ESP8266/ESP32 by simple yet powerful configuration files and control them remotely through Home Automation systems.
2021-06-16 02:24:40 +02:00
.. image :: /images/hero.png
2019-02-07 13:54:45 +01:00
2021-06-16 02:24:40 +02:00
.. raw :: html
2019-02-07 13:54:45 +01:00
2021-06-16 02:24:40 +02:00
<div class="guide-container">
<div class="guide-card">
2021-06-16 12:51:32 +02:00
<h3 class="guide-card-title">Getting started</h3>
2021-06-16 02:24:40 +02:00
<ul>
<li>
2021-06-16 12:51:32 +02:00
<a class="reference" href="/guides/getting_started_hassio.html">
ESPHome Dashboard
2021-06-16 02:24:40 +02:00
</a>
</li>
<li>
2021-06-16 12:51:32 +02:00
<a class="reference" href="/guides/getting_started_command_line.html">
Command Line Interface
2021-06-16 02:24:40 +02:00
</a>
</li>
<li>
2021-06-16 12:51:32 +02:00
<a class="reference" href="/guides/migrate_sonoff_tasmota.html">
Migrating from Tasmota
2021-06-16 02:24:40 +02:00
</a>
</li>
</ul>
<pre class="guide-code">
esphome:
2021-06-16 12:51:32 +02:00
name: awesome
2021-06-16 02:24:40 +02:00
platform: ESP32
board: nodemcu-32s
</pre>
</div>
<div class="guide-card">
<h3 class="guide-card-title">Next steps</h3>
<ul>
<li>
<a class="reference" href="/guides/faq.html">
FAQ and Tips
</a>
</li>
<li>
<a class="reference" href="/guides/automations.html">
Automations
</a>
</li>
<li>
<a class="reference" href="/guides/diy.html">
DIY Examples
</a>
</li>
<li>
<a class="reference" href="/guides/configuration-types.html">
Configuration types
</a>
</li>
2021-07-20 02:47:13 +02:00
<li>
<a class="reference" href="/guides/creators.html">
2021-10-17 00:03:24 +02:00
Sharing ESPHome devices
2021-07-20 02:47:13 +02:00
</a>
</li>
2021-09-07 23:28:34 +02:00
<li>
<a class="reference" href="/guides/made_for_esphome.html">
Made for ESPHome program
</a>
2021-07-20 02:47:13 +02:00
</li>
2021-06-16 02:24:40 +02:00
</ul>
</div>
<div class="guide-card">
2021-06-16 12:51:32 +02:00
<h3 class="guide-card-title">Keeping up</h3>
2021-06-16 02:24:40 +02:00
<ul>
<li>
2021-06-16 12:51:32 +02:00
<a class="reference" href="/changelog/index.html">
Changelog
2021-06-16 02:24:40 +02:00
</a>
</li>
<li>
2021-06-16 12:51:32 +02:00
<a class="reference" href="/guides/supporters.html">
Supporters
2021-06-16 02:24:40 +02:00
</a>
</li>
<li>
2021-06-16 12:51:32 +02:00
<a class="reference" href="/guides/contributing.html">
Contributing
2021-06-16 02:24:40 +02:00
</a>
2021-06-16 03:50:49 +02:00
</li>
2021-06-16 02:24:40 +02:00
</ul>
</div>
</div>
2020-07-13 16:57:43 +02:00
2019-02-07 13:54:45 +01:00
.. _devices:
Devices
-------
2019-02-16 23:25:23 +01:00
This list contains a bunch of getting started and more advanced guides for using ESPHome.
Technically, all ESP8266/ESP32 devices are supported by ESPHome.
2019-02-07 13:54:45 +01:00
.. imgtable ::
Generic ESP8266, devices/esp8266, esp8266.svg
Generic ESP32, devices/esp32, esp32.svg
NodeMCU ESP8266, devices/nodemcu_esp8266, nodemcu_esp8266.jpg
NodeMCU ESP32, devices/nodemcu_esp32, nodemcu_esp32.jpg
Sonoff S20, devices/sonoff_s20, sonoff_s20.jpg
Sonoff 4CH, devices/sonoff_4ch, sonoff_4ch.jpg
Generic Sonoff, devices/sonoff, sonoff.svg
Sonoff Basic, devices/sonoff_basic, sonoff_basic.jpg
2019-03-05 18:33:18 +01:00
Sonoff T1 UK 3 Gang V1.1, devices/sonoff_t1_uk_3gang_v1.1, sonoff_t1_uk_3g_v1.1.jpg
2020-12-21 01:55:44 +01:00
Sonoff T3 EU 3 Gang V1.0, devices/sonoff_t3_eu_3gang_v1.0, sonoff_t3_eu_3g_v1.0.jpg
2019-02-07 13:54:45 +01:00
Core Components
---------------
.. imgtable ::
2019-02-16 23:25:23 +01:00
Core, components/esphome, cloud-circle.svg
2019-02-07 13:54:45 +01:00
WiFi, components/wifi, network-wifi.svg
MQTT, components/mqtt, mqtt.png
I²C Bus, components/i2c, i2c.svg
SPI Bus, components/spi, spi.svg
UART Bus, components/uart, uart.svg
2020-12-21 20:27:24 +01:00
CAN Bus, components/canbus, canbus.svg
2019-02-07 13:54:45 +01:00
OTA Updates, components/ota, system-update.svg
Logger, components/logger, file-document-box.svg
Web Server, components/web_server, http.svg
Native API, components/api, server-network.svg
Power Supply, components/power_supply, power.svg
Deep Sleep, components/deep_sleep, hotel.svg
2021-05-07 20:02:08 +02:00
External Components, components/external_components, external_components.svg
2019-02-07 13:54:45 +01:00
Sensor Components
-----------------
2021-08-10 04:22:08 +02:00
Sensors have been split into categories. If a sensor fits into more than one category, it will be listed multiple times.
Core
*** *
2019-02-07 13:54:45 +01:00
.. imgtable ::
Sensor Core, components/sensor/index, folder-open.svg
Home Assistant, components/sensor/homeassistant, home-assistant.svg
2019-05-12 22:59:06 +02:00
Integration, components/sensor/integration, sigma.svg
2019-02-07 13:54:45 +01:00
MQTT Subscribe, components/sensor/mqtt_subscribe, mqtt.png
2021-08-10 04:22:08 +02:00
Uptime Sensor, components/sensor/uptime, timer.svg
WiFi Signal Strength, components/sensor/wifi_signal, network-wifi.svg
Template Sensor, components/sensor/template, description.svg
Custom Sensor, components/sensor/custom, language-cpp.svg
Air Quality
***** ***** *
.. imgtable ::
2021-08-31 04:02:10 +02:00
AirThings BLE, components/sensor/airthings_ble, airthings_logo.png, Radon, CO2, Volatile organics
2021-08-10 04:22:08 +02:00
CCS811, components/sensor/ccs811, ccs811.jpg, CO2 & Volatile organics
HM3301, components/sensor/hm3301, hm3301.jpg, Particulate
2021-08-18 01:10:17 +02:00
MH-Z19, components/sensor/mhz19, mhz19.jpg, CO2 & Temperature
2021-08-10 04:22:08 +02:00
PM1006 Sensor, components/sensor/pm1006, pm1006.jpg, Particulate
2021-08-10 11:03:12 +02:00
PMSA003I, components/sensor/pmsa003i, pmsa003i.jpg, Particulate
2021-08-18 01:10:17 +02:00
PMSX003, components/sensor/pmsx003, pmsx003.svg, Particulate
2021-08-10 04:22:08 +02:00
SDS011 Sensor, components/sensor/sds011, sds011.jpg, Particulate
2021-08-18 01:10:17 +02:00
SenseAir, components/sensor/senseair, senseair_s8.jpg, CO2
2021-09-13 22:02:44 +02:00
SCD30, components/sensor/scd30, scd30.jpg, CO2 & Temperature & Humidity
2021-09-28 22:16:43 +02:00
SCD4X, components/sensor/scd4x, scd4x.jpg, CO2 & Temperature & Humidity
2021-08-10 04:22:08 +02:00
SGP30, components/sensor/sgp30, sgp30.jpg, CO2 & Volatile organics
SGP40, components/sensor/sgp40, sgp40.jpg, Volatile organics
2021-08-18 01:10:17 +02:00
SM300D2, components/sensor/sm300d2, sm300d2.jpg, Air quality
SPS30, components/sensor/sps30, sps30.jpg, Particulate
2021-08-25 03:56:44 +02:00
T6613/15, components/sensor/t6615, t6615.png, CO2
2021-08-10 04:22:08 +02:00
ZyAura, components/sensor/zyaura, zgm053.jpg, CO2 & Temperature & Humidity
Analogue
***** ***
.. imgtable ::
ADC, components/sensor/adc, flash.svg, ESP internal
ADS1115, components/sensor/ads1115, ads1115.jpg, 4-channel ADC
MCP3008, components/sensor/mcp3008, mcp3008.jpg, 8-channel ADC
Resistance, components/sensor/resistance, omega.svg
Bluetooth Low Energy (BLE)
***** ***** ***** ***** ***** *
.. imgtable ::
2021-08-11 06:07:18 +02:00
AM43, components/sensor/am43, am43.jpg, Lux & Battery level
2021-08-10 04:22:08 +02:00
BLE Client Sensor, components/sensor/ble_client, bluetooth.svg
2021-08-18 01:10:17 +02:00
BLE RSSI, components/sensor/ble_rssi, bluetooth.svg
2021-08-10 04:22:08 +02:00
Inkbird IBS-TH1 Mini, components/sensor/inkbird_ibsth1_mini, inkbird_isbth1_mini.jpg, Temperature & Humidity
RuuviTag, components/sensor/ruuvitag, ruuvitag.jpg, Temperature & Humidity & Accelerometer
2021-08-18 01:10:17 +02:00
Xiaomi BLE, components/sensor/xiaomi_ble, xiaomi_mijia_logo.jpg, Various
2021-08-10 04:22:08 +02:00
Digital Signals
***** ***** *****
.. imgtable ::
Duty Cycle, components/sensor/duty_cycle, percent.svg
2019-02-07 13:54:45 +01:00
Pulse Counter, components/sensor/pulse_counter, pulse.svg
2021-03-19 09:20:09 +01:00
Pulse Meter, components/sensor/pulse_meter, pulse.svg
2019-05-25 09:08:05 +02:00
Pulse Width, components/sensor/pulse_width, pulse.svg
2021-08-10 04:22:08 +02:00
Distance
***** ***
.. imgtable ::
HRXL MaxSonar WR, components/sensor/hrxl_maxsonar_wr, hrxl_maxsonar_wr.jpg, Acoustic distance
TOF10120, components/sensor/tof10120, tof10120.jpg, IR optical distance
Ultrasonic Sensor, components/sensor/ultrasonic, ultrasonic.jpg, Acoustic distance
VL53L0x, components/sensor/vl53l0x, vl53l0x.png, IR optical distance
Electricity
***** ***** *
.. imgtable ::
ADE7953, components/sensor/ade7953, ade7953.svg, Power
ATM90E32, components/sensor/atm90e32, atm90e32.jpg, Voltage & Current & Power
CS5460A, components/sensor/cs5460a, cs5460a.png, Voltage & Current & Power
2021-10-28 20:59:01 +02:00
CSE7761, components/sensor/cse7761, cse7761.svg, Voltage & Current & Power
2021-08-18 01:10:17 +02:00
CSE7766, components/sensor/cse7766, cse7766.svg, Voltage & Current & Power
2021-08-10 04:22:08 +02:00
CT Clamp, components/sensor/ct_clamp, ct_clamp.jpg, AC current
2021-09-22 12:03:58 +02:00
Daly BMS, components/sensor/daly_bms, daly_bms.png, Voltage & Current & Power
2021-08-10 14:32:40 +02:00
DSMR, components/sensor/dsmr, dsmr.svg, Electrical counter
2021-08-10 04:22:08 +02:00
HLW8012, components/sensor/hlw8012, hlw8012.svg, Voltage & Current & Power
INA219, components/sensor/ina219, ina219.jpg, DC current
INA226, components/sensor/ina226, ina226.jpg, DC current & Power
INA3221, components/sensor/ina3221, ina3221.jpg, 3-Ch DC current
PZEM AC, components/sensor/pzemac, pzem-ac.png, Voltage & Current & Power
PZEM DC, components/sensor/pzemdc, pzem-dc.png, Voltage & Current & Power
2021-08-18 01:10:17 +02:00
PZEM004T, components/sensor/pzem004t, pzem004t.svg, Voltage & Current & Power
2021-08-10 04:22:08 +02:00
SDM Meter, components/sensor/sdm_meter, sdm220m.png, Modbus energy monitor
Selec Meter, components/sensor/selec_meter, selec_meter_em2m.jpg, Modbus energy monitor
Teleinfo, components/sensor/teleinfo, teleinfo.jpg, Electrical counter
Total Daily Energy, components/sensor/total_daily_energy, sigma.svg
Environmental
***** ***** ***
.. imgtable ::
AHT10, components/sensor/aht10, aht10.jpg, Temperature & Humidity
2021-08-31 04:02:10 +02:00
AirThings BLE, components/sensor/airthings_ble, airthings_logo.png, Temperature & Humidity & Pressure
2021-08-10 04:22:08 +02:00
AM2320, components/sensor/am2320, am2320.jpg, Temperature & Humidity
BME280, components/sensor/bme280, bme280.jpg, Temperature & Humidity & Pressure
BME680, components/sensor/bme680, bme680.jpg, Temperature & Humidity & Pressure & Gas
BME680 via BSEC, components/sensor/bme680_bsec, bme680.jpg, Temperature & Humidity & Pressure & Gas
2021-08-18 01:10:17 +02:00
BMP085, components/sensor/bmp085, bmp180.jpg, Temperature & Pressure
2021-09-13 21:57:56 +02:00
BMP280, components/sensor/bmp280, bmp280.jpg, Temperature & Pressure
2021-09-25 13:16:31 +02:00
b-parasite, components/sensor/b_parasite, b_parasite.jpg, Moisture & Temperature & Humidity & Light
2021-08-10 04:22:08 +02:00
Dallas DS18B20, components/sensor/dallas, dallas.jpg, Temperature
DHT, components/sensor/dht, dht.jpg, Temperature & Humidity
DHT12, components/sensor/dht12, dht12.jpg, Temperature & Humidity
HDC1080, components/sensor/hdc1080, hdc1080.jpg, Temperature & Humidity
HTU21D, components/sensor/htu21d, htu21d.jpg, Temperature & Humidity
Inkbird IBS-TH1 Mini, components/sensor/inkbird_ibsth1_mini, inkbird_isbth1_mini.jpg, Temperature & Humidity
MCP9808, components/sensor/mcp9808, mcp9808.jpg, Temperature
MH-Z19, components/sensor/mhz19, mhz19.jpg, CO2 & Temperature
MS5611, components/sensor/ms5611, ms5611.jpg, Pressure
NTC Thermistor, components/sensor/ntc, ntc.jpg, Temperature
RuuviTag, components/sensor/ruuvitag, ruuvitag.jpg, Temperature & Humidity & Accelerometer
2021-09-13 22:02:44 +02:00
SCD30, components/sensor/scd30, scd30.jpg, CO2 & Temperature & Humidity
2021-09-28 22:16:43 +02:00
SCD4X, components/sensor/scd4x, scd4x.jpg, CO2 & Temperature & Humidity
2021-08-11 10:14:32 +02:00
SDP3x, components/sensor/sdp3x, sdp31.jpg, Pressure
2021-08-10 04:22:08 +02:00
SHT3X-D, components/sensor/sht3xd, sht3xd.jpg, Temperature & Humidity
SHT4X, components/sensor/sht4x, sht4x.jpg, Temperature & Humidity
2021-08-18 01:10:17 +02:00
SHTCx, components/sensor/shtcx, shtc3.jpg, Temperature & Humidity
2021-08-10 04:22:08 +02:00
STS3X, components/sensor/sts3x, sts3x.jpg, Temperature
TMP102, components/sensor/tmp102, tmp102.jpg, Temperature
TMP117, components/sensor/tmp117, tmp117.jpg, Temperature
2021-08-18 01:10:17 +02:00
Light
*****
.. imgtable ::
AM43, components/sensor/am43, am43.jpg, Lux
APDS9960, components/sensor/apds9960, apds9960.jpg, Colour & Gesture
BH1750, components/sensor/bh1750, bh1750.jpg, Lux
2021-10-13 07:08:58 +02:00
LTR390, components/sensor/ltr390, ltr390.jpg, Lux & UV
2021-08-18 01:10:17 +02:00
TCS34725, components/sensor/tcs34725, tcs34725.jpg, Lux & RGB colour
TSL2561, components/sensor/tsl2561, tsl2561.jpg, Lux
TSL2591, components/sensor/tsl2591, tsl2591.jpg, Lux
Magnetic
***** ***
.. imgtable ::
ESP32 Hall Sensor, components/sensor/esp32_hall, magnet.svg, ESP internal
HMC5883L, components/sensor/hmc5883l, hmc5883l.jpg, 3-Axis magnetometer
QMC5883L, components/sensor/qmc5883l, qmc5883l.jpg, 3-Axis magnetometer
Miscellaneous
***** ***** ***
.. imgtable ::
AS3935, components/sensor/as3935, as3935.jpg, Storm lightning
Binary Sensor Map, components/sensor/binary_sensor_map, binary_sensor_map.jpg, Map binary to value
2021-09-25 13:16:31 +02:00
b-parasite, components/sensor/b_parasite, b_parasite.jpg, Moisture & Temperature & Humidity & Light
2021-08-18 01:10:17 +02:00
EZO sensor circuits, components/sensor/ezo, ezo-ph-circuit.png, (pH)
Havells Solar, components/sensor/havells_solar, havellsgti5000d_s.jpg, Solar rooftop
2021-09-26 22:27:26 +02:00
Modbus Sensor, components/sensor/modbus_controller, modbus.png
2021-08-18 01:10:17 +02:00
Nextion, components/sensor/nextion, nextion.jpg, Sensors from display
Rotary Encoder, components/sensor/rotary_encoder, rotary_encoder.jpg
Tuya Sensor, components/sensor/tuya, tuya.png
TX20, components/sensor/tx20, tx20.jpg, Wind speed & Wind direction
Motion
***** *
.. imgtable ::
APDS9960, components/sensor/apds9960, apds9960.jpg, Colour & Gesture
MPU6050, components/sensor/mpu6050, mpu6050.jpg, Accelerometer & Gyroscope
RuuviTag, components/sensor/ruuvitag, ruuvitag.jpg, Temperature & Humidity & Accelerometer
2021-08-10 04:22:08 +02:00
Thermocouple
***** ***** **
.. imgtable ::
MAX31855, components/sensor/max31855, max31855.jpg, K-Type
MAX31856, components/sensor/max31856, max31856.jpg, All types
MAX31865, components/sensor/max31865, max31865.jpg, Platinum RTD
MAX6675, components/sensor/max6675, max6675.jpg, K-Type
2019-02-07 13:54:45 +01:00
2021-08-18 01:10:17 +02:00
Weight
***** *
.. imgtable ::
HX711, components/sensor/hx711, hx711.jpg, Load cell amplifier
2021-09-22 12:13:32 +02:00
Xiaomi Miscale, components/sensor/xiaomi_miscale, xiaomi_miscale1&2.jpg
2021-08-18 01:10:17 +02:00
2019-02-07 13:54:45 +01:00
Looking for a sensor that outputs its values as an analog voltage? Have a look at the
:doc: `ADC Sensor </components/sensor/adc>` together with a formula like in the :doc:`TEMT6000
example </cookbook/temt6000>`.
Binary Sensor Components
------------------------
2018-05-13 11:37:02 +02:00
2018-11-14 22:12:27 +01:00
.. imgtable ::
2018-05-13 11:37:02 +02:00
2019-02-07 13:54:45 +01:00
Binary Sensor Core, components/binary_sensor/index, folder-open.svg
GPIO, components/binary_sensor/gpio, pin.svg
2019-02-16 23:25:23 +01:00
Home Assistant, components/binary_sensor/homeassistant, home-assistant.svg
2019-02-07 13:54:45 +01:00
Status, components/binary_sensor/status, server-network.svg
2019-05-12 22:59:06 +02:00
ESP32 BLE Presence, components/binary_sensor/ble_presence, bluetooth.svg
2019-02-07 13:54:45 +01:00
ESP32 Touch Pad, components/binary_sensor/esp32_touch, touch.svg
2019-02-27 13:35:49 +01:00
MPR121 Capacitive Touch Sensor, components/binary_sensor/mpr121, mpr121.jpg
2021-07-15 02:51:30 +02:00
Nextion Binary Sensor, components/binary_sensor/nextion, nextion.jpg
2019-02-07 13:54:45 +01:00
Template Binary Sensor, components/binary_sensor/template, description.svg
2019-02-27 10:10:09 +01:00
PN532, components/binary_sensor/pn532, pn532.jpg
2020-10-27 00:42:09 +01:00
RC522, components/binary_sensor/rc522, rc522.jpg
2019-02-27 10:10:09 +01:00
RDM6300, components/binary_sensor/rdm6300, rdm6300.jpg
2019-05-13 13:10:12 +02:00
TTP229, components/binary_sensor/ttp229, ttp229.jpg
2020-07-12 00:50:33 +02:00
Tuya Binary Sensor, components/binary_sensor/tuya, tuya.png
2021-09-26 22:27:26 +02:00
Modbus Binary Sensor, components/binary_sensor/modbus_controller, modbus.png
2021-05-17 03:04:12 +02:00
XPT2046, components/binary_sensor/xpt2046, xpt2046.jpg
2021-11-10 18:53:33 +01:00
CAP1188 Capacitive Touch Sensor, components/binary_sensor/cap1188, cap1188.jpg
2019-02-07 13:54:45 +01:00
Custom Binary Sensor, components/binary_sensor/custom, language-cpp.svg
Output Components
-----------------
.. imgtable ::
Output Core, components/output/index, folder-open.svg
ESP8266 Software PWM, components/output/esp8266_pwm, pwm.png
2019-12-07 17:14:55 +01:00
Slow PWM, components/output/slow_pwm, pwm.png
2019-02-07 13:54:45 +01:00
GPIO Output, components/output/gpio, pin.svg
2020-05-24 05:06:37 +02:00
ESP32 DAC, components/output/esp32_dac, dac.svg
2019-02-07 13:54:45 +01:00
ESP32 LEDC, components/output/ledc, pwm.png
2020-04-10 05:07:34 +02:00
AC Dimmer, components/output/ac_dimmer, ac_dimmer.svg
2019-02-07 13:54:45 +01:00
PCA9685, components/output/pca9685, pca9685.jpg
2019-10-14 11:38:20 +02:00
TLC59208F, components/output/tlc59208f, tlc59208f.jpg
2021-07-29 11:26:17 +02:00
TLC5947, components/output/tlc5947, tlc5947.jpg
2019-02-07 13:54:45 +01:00
MY9231/MY9291, components/output/my9231, my9231.svg
2019-05-31 15:06:16 +02:00
SM16716, components/output/sm16716, sm16716.svg
2021-05-12 21:14:26 +02:00
SM2135, components/output/sm2135, sm2135.svg
2021-02-06 16:23:23 +01:00
MCP4725, components/output/mcp4725, mcp4725.jpg
2021-09-26 22:27:26 +02:00
Modbus Output, components/output/modbus_controller, modbus.png
2019-02-07 13:54:45 +01:00
Custom Output, components/output/custom, language-cpp.svg
2020-06-14 00:35:55 +02:00
Template Output, components/output/template, description.svg
2019-02-07 13:54:45 +01:00
Light Components
----------------
.. imgtable ::
2018-05-13 11:37:02 +02:00
2019-02-07 13:54:45 +01:00
Light Core, components/light/index, folder-open.svg
Binary Light, components/light/binary, lightbulb.svg
2021-08-10 09:55:37 +02:00
Status Led, components/light/status_led, led-on.svg
2019-02-07 13:54:45 +01:00
Monochromatic Light, components/light/monochromatic, brightness-medium.svg
2018-11-14 22:12:27 +01:00
2019-02-07 13:54:45 +01:00
Cold+Warm White Light, components/light/cwww, brightness-medium.svg
2021-08-10 11:29:11 +02:00
Color Temperature Light, components/light/color_temperature, brightness-medium.svg
2019-02-07 13:54:45 +01:00
RGB Light, components/light/rgb, rgb.png
RGBW Light, components/light/rgbw, rgbw.png
RGBWW Light, components/light/rgbww, rgbw.png
2021-08-10 11:29:11 +02:00
RGBCT Light, components/light/rgbct, rgbw.png
2019-02-27 10:10:09 +01:00
FastLED Light, components/light/fastled, color_lens.svg
2019-02-07 13:54:45 +01:00
NeoPixelBus Light, components/light/neopixelbus, color_lens.svg
2019-02-16 23:25:23 +01:00
Light Partition, components/light/partition, color_lens.svg
2021-08-10 11:29:11 +02:00
2020-07-11 23:12:47 +02:00
Tuya Dimmer, components/light/tuya, tuya.png
2019-05-15 10:54:51 +02:00
Custom Light, components/light/custom, language-cpp.svg
2019-02-07 13:54:45 +01:00
2020-11-08 02:46:39 +01:00
H-bridge Light, components/light/hbridge, brightness-medium.svg
2019-02-07 13:54:45 +01:00
Looking for WS2811 and similar individually addressable lights? Have a look at the
2019-02-27 10:10:09 +01:00
:doc: `FastLED Light </components/light/fastled>` .
2019-02-07 13:54:45 +01:00
Switch Components
-----------------
.. imgtable ::
Switch Core, components/switch/index, folder-open.svg
GPIO Switch, components/switch/gpio, pin.svg
Restart Switch, components/switch/restart, restart.svg
2021-10-06 09:44:52 +02:00
Safe Mode Switch, components/switch/safe_mode, restart-alert.svg
2019-02-07 13:54:45 +01:00
Shutdown Switch, components/switch/shutdown, power_settings.svg
Generic Output Switch, components/switch/output, upload.svg
Template Switch, components/switch/template, description.svg
UART Switch, components/switch/uart, uart.svg
Custom Switch, components/switch/custom, language-cpp.svg
2020-07-11 23:12:47 +02:00
Tuya Switch, components/switch/tuya, tuya.png
2021-09-26 22:27:26 +02:00
Modbus Switch, components/switch/modbus_controller, modbus.png
2021-05-15 01:31:31 +02:00
BLE Client Switch, components/switch/ble_client, bluetooth.svg
2021-07-15 02:51:30 +02:00
Nextion Switch, components/switch/nextion, nextion.jpg
2019-02-07 13:54:45 +01:00
Fan Components
--------------
.. imgtable ::
Fan Core, components/fan/index, folder-open.svg
Binary Fan, components/fan/binary, fan.svg
2021-08-31 00:10:29 +02:00
H-bridge Fan, components/fan/hbridge, fan.svg
2019-02-07 13:54:45 +01:00
Speed Fan, components/fan/speed, fan.svg
2020-07-11 23:12:47 +02:00
Tuya Fan, components/fan/tuya, tuya.png
2019-02-07 13:54:45 +01:00
Display Components
------------------
.. imgtable ::
Display Core, components/display/index, folder-open.svg
2021-03-18 07:09:17 +01:00
Addressable Light, components/display/addressable_light, addressable_light.jpg
2019-02-27 10:10:09 +01:00
LCD Display, components/display/lcd_display, lcd.jpg
2019-02-07 13:54:45 +01:00
MAX7219, components/display/max7219, max7219.jpg
2020-06-28 22:33:15 +02:00
MAX7219 Dot Matrix, components/display/max7219digit, max7219digit.png
2020-01-13 23:44:03 +01:00
TM1637, components/display/tm1637, tm1637.jpg
2019-02-07 13:54:45 +01:00
Nextion, components/display/nextion, nextion.jpg
2019-02-27 10:10:09 +01:00
SSD1306, components/display/ssd1306, ssd1306.jpg
2020-12-30 10:52:46 +01:00
SSD1322, components/display/ssd1322, ssd1322.jpg
2019-10-19 20:44:49 +02:00
SSD1325, components/display/ssd1325, ssd1325.jpg
2020-12-30 10:48:30 +01:00
SSD1327, components/display/ssd1327, ssd1327.jpg
2020-11-18 07:35:00 +01:00
SSD1331, components/display/ssd1331, ssd1331.jpg
2020-07-10 04:49:21 +02:00
SSD1351, components/display/ssd1351, ssd1351.jpg
2021-01-04 19:51:51 +01:00
ST7735, components/display/st7735, st7735.jpg
2020-06-28 23:37:55 +02:00
ST7789V, components/display/st7789v, st7789v.jpg
2021-08-26 04:33:23 +02:00
ST7920, components/display/st7920, st7920.jpg
2020-12-06 14:45:10 +01:00
ILI9341, components/display/ili9341, ili9341.jpg
2019-02-07 13:54:45 +01:00
Waveshare E-Paper, components/display/waveshare_epaper, waveshare_epaper.jpg
2021-05-12 09:36:04 +02:00
Inkplate 6, components/display/inkplate6, inkplate6.jpg
2020-04-05 18:47:28 +02:00
PCD8544 (Nokia 5110/ 3310), components/display/pcd8544, pcd8544.jpg
2019-02-07 13:54:45 +01:00
Cover Components
----------------
.. imgtable ::
Cover Core, components/cover/index, folder-open.svg
Template Cover, components/cover/template, description.svg
2019-05-12 22:59:06 +02:00
Endstop Cover, components/cover/endstop, electric-switch.svg
2021-09-27 22:23:50 +02:00
Current-Based Cover, components/cover/current_based, flash.svg
2019-05-12 22:59:06 +02:00
Time-Based Cover, components/cover/time_based, timer.svg
2019-05-15 10:54:51 +02:00
Custom Cover, components/cover/custom, language-cpp.svg
2021-08-11 06:07:18 +02:00
AM43 Cover, components/cover/am43, am43.jpg
2021-09-28 23:02:17 +02:00
Tuya Cover, components/cover/tuya, tuya.png
2019-02-07 13:54:45 +01:00
Text Sensor Components
----------------------
.. imgtable ::
Text Sensor Core, components/text_sensor/index, folder-open.svg
Home Assistant, components/text_sensor/homeassistant, home-assistant.svg
MQTT Subscribe Text, components/text_sensor/mqtt_subscribe, mqtt.png
Version, components/text_sensor/version, new-box.svg
2019-03-14 16:41:37 +01:00
WiFi Info, components/text_sensor/wifi_info, network-wifi.svg
2020-05-20 02:13:39 +02:00
BLE Scanner, components/text_sensor/ble_scanner, bluetooth.svg
2021-09-26 22:27:26 +02:00
Modbus Text Sensor, components/text_sensor/modbus_controller, modbus.png
2019-02-07 13:54:45 +01:00
Template Text Sensor, components/text_sensor/template, description.svg
Custom Text Sensor, components/text_sensor/custom, language-cpp.svg
2021-07-15 02:51:30 +02:00
Nextion Text Sensor, components/text_sensor/nextion, nextion.jpg
2019-02-07 13:54:45 +01:00
2019-05-12 22:59:06 +02:00
Climate Components
------------------
.. imgtable ::
Climate Core, components/climate/index, folder-open.svg
Bang Bang Controller, components/climate/bang_bang, air-conditioner.svg
2020-07-02 03:39:50 +02:00
Thermostat Controller, components/climate/thermostat, air-conditioner.svg
2019-05-15 10:54:51 +02:00
Custom Climate, components/climate/custom, language-cpp.svg
2020-06-13 02:40:06 +02:00
PID Controller, components/climate/pid, function.svg
2019-12-30 13:20:17 +01:00
IR Remote Climate, components/climate/ir_climate, air-conditioner-ir.svg
2020-07-12 00:04:48 +02:00
Tuya Climate, components/climate/tuya, tuya.png
2021-09-08 23:10:05 +02:00
Midea, components/climate/midea, midea.svg
2021-07-05 01:59:18 +02:00
Anova Cooker, components/climate/anova, anova.png
2019-05-12 22:59:06 +02:00
2021-07-12 21:20:18 +02:00
Number Components
-----------------
.. imgtable ::
Number Core, components/number/index, folder-open.svg
2021-09-26 22:27:26 +02:00
Modbus Number, components/number/modbus_controller, modbus.png
2021-07-12 21:20:18 +02:00
Template Number, components/number/template, description.svg
2021-08-02 10:01:08 +02:00
Select Components
-----------------
.. imgtable ::
Select Core, components/select/index, folder-open.svg
Template Select, components/select/template, description.svg
2019-02-07 13:54:45 +01:00
Misc Components
---------------
.. imgtable ::
2021-10-19 23:08:37 +02:00
ESP8266, components/esp8266, esp8266.svg
ESP32, components/esp32, esp32.svg
2019-05-13 21:51:04 +02:00
Remote Receiver, components/remote_receiver, remote.svg
Remote Transmitter, components/remote_transmitter, remote.svg
2019-02-07 13:54:45 +01:00
Status LED, components/status_led, led-on.svg
2019-11-09 18:39:13 +01:00
HTTP Request, components/http_request, connection.svg
2021-11-25 20:59:02 +01:00
mDNS, components/mdns, radio-tower.svg
2019-05-13 21:51:04 +02:00
2019-02-07 13:54:45 +01:00
Time, components/time, clock-outline.svg
2019-05-12 22:59:06 +02:00
Sun, components/sun, weather-sunny.svg
2019-05-13 21:51:04 +02:00
GPS, components/gps, crosshairs-gps.svg
2021-05-03 01:11:02 +02:00
ESP32 BLE Client, components/ble_client, bluetooth.svg
2019-05-13 21:51:04 +02:00
ESP32 BLE Tracker, components/esp32_ble_tracker, bluetooth.svg
ESP32 BLE Beacon, components/esp32_ble_beacon, bluetooth.svg
2019-02-07 13:54:45 +01:00
ESP32 Ethernet, components/ethernet, ethernet.svg
2019-05-13 21:51:04 +02:00
2019-03-13 16:17:05 +01:00
ESP32 Camera, components/esp32_camera, camera.svg
2021-11-10 01:10:13 +01:00
ESP32 Camera Web Server, components/esp32_camera_web_server, camera.svg
2019-05-13 21:51:04 +02:00
Stepper, components/stepper/index, stepper.svg
Servo, components/servo, servo.svg
PCF8574 I/O Expander, components/pcf8574, pcf8574.jpg
2020-12-06 18:44:06 +01:00
MCP230XX I/O Expander - I²C Bus, components/mcp230xx, mcp230xx.svg
2021-03-29 21:50:43 +02:00
TCA9548A I²C Multiplexer, components/tca9548a, tca9548a.jpg
2020-12-06 18:44:06 +01:00
MCP23SXX I/O Expander - SPI Bus, components/mcp23Sxx, mcp230xx.svg
2019-10-19 22:04:41 +02:00
SX1509 I/O Expander, components/sx1509, sx1509.jpg
2020-06-27 23:10:05 +02:00
SN74HC595 I/O Expander, components/sn74hc595, sn74hc595.jpg
2019-06-17 16:58:16 +02:00
SIM800L, components/sim800l, sim800l.jpg
2019-10-20 18:04:20 +02:00
DFPlayer, components/dfplayer, dfplayer.svg
2019-07-28 12:41:15 +02:00
Captive Portal, components/captive_portal, wifi-strength-alert-outline.svg
2021-11-10 21:01:30 +01:00
Improv via BLE, components/esp32_improv, improv.svg
Improv via Serial, components/improv_serial, improv.svg
2019-05-13 21:51:04 +02:00
Debug Component, components/debug, bug-report.svg
2019-12-04 13:11:49 +01:00
TM1651 Battery Display, components/tm1651, tm1651_battery_display.jpg
2019-12-10 11:09:47 +01:00
RF Bridge, components/rf_bridge, rf_bridge.jpg
2020-07-11 22:50:17 +02:00
Tuya MCU, components/tuya, tuya.png
2021-09-26 22:27:26 +02:00
Modbus Controller, components/modbus_controller, modbus.png
2020-07-14 19:08:27 +02:00
Exposure Notifications, components/exposure_notifications, exposure_notifications.png
2020-07-25 18:02:21 +02:00
RTTTL Buzzer, components/rtttl, buzzer.jpg
2020-07-27 12:06:56 +02:00
Prometheus, components/prometheus, prometheus.svg
2021-08-10 21:48:36 +02:00
PipSolar - compatible PV Inverter, components/pipsolar, pipsolar.jpg
2021-04-29 00:08:31 +02:00
Grow Fingerprint Reader, components/fingerprint_grow, fingerprint.svg
2021-07-29 12:03:43 +02:00
Demo, components/demo, description.svg
2019-02-07 13:54:45 +01:00
Additional Custom Components
----------------------------
.. imgtable ::
Generic Custom Component, custom/custom_component, language-cpp.svg
2020-05-10 21:27:59 +02:00
Custom I²C Component, custom/i2c, language-cpp.svg
2019-02-07 13:54:45 +01:00
Custom SPI Component, custom/spi, language-cpp.svg
Custom UART Component, custom/uart, language-cpp.svg
.. _cookbook:
Cookbook
2018-11-14 22:12:27 +01:00
--------
2019-02-07 13:54:45 +01:00
.. imgtable ::
2019-10-19 22:24:47 +02:00
Arduino Port Extender, cookbook/arduino_port_extender, arduino_logo.svg
2019-03-11 13:18:15 +01:00
Endstop Cover, cookbook/endstop-cover, window-open.svg
2019-02-07 13:54:45 +01:00
PIR Sensor, cookbook/pir, pir.jpg
Relay, cookbook/relay, relay.jpg
BRUH Multisensor, cookbook/bruh, bruh.png
TEMT6000, cookbook/temt6000, temt6000.jpg
Non-Invasive Power Meter, cookbook/power_meter, power_meter.jpg
Dual Relay Motor Cover, cookbook/dual-r2-cover, sonoff_dual_r2.jpg
BME280 Environment, cookbook/bme280_environment, bme280.jpg
Sonoff Fishpond Pump, cookbook/sonoff-fishpond-pump, cookbook-sonoff-fishpond-pump.jpg
2019-02-12 00:05:30 +01:00
H801 LED Controller, cookbook/h801, h801.jpg
2019-02-26 21:29:34 +01:00
Time & Temperature on OLED Display, cookbook/display_time_temp_oled, display_time_temp_oled_2.jpg
2019-03-11 11:47:45 +01:00
Mirabella Genio Bulb, cookbook/mirabella-genio-bulb, cookbook-mirabella-genio-b22-rgbw.jpg
2019-03-11 13:18:15 +01:00
Garage Door, cookbook/garage-door, window-open.svg
2019-03-13 16:35:04 +01:00
Brilliant / Mirabella Genio Smart Plugs, cookbook/brilliant-mirabella-genio-smart-plugs, cookbook-brilliant-mirabella-genio-smart-plugs.jpg
2020-06-13 03:15:30 +02:00
Etekcity Voltson (ESW01-EU) , cookbook/esw01-eu, esw01-eu.jpg
2020-04-05 18:49:52 +02:00
Sonoff iFan02, cookbook/ifan02, fan.svg
2019-10-19 22:18:52 +02:00
Zemismart RGBW Downlights, cookbook/zemismart-rgbw-downlights, cookbook-zemismart-rgbw-downlight.jpg
2019-10-17 14:06:16 +02:00
Teckin SB50, cookbook/teckin_sb50, teckin_sb50.jpg
2019-11-29 18:27:26 +01:00
Sonoff light switch options, cookbook/sonoff-light-switch, light_switch.png
2020-06-13 03:09:22 +02:00
ESP32 Water Leak Detector, cookbook/leak-detector-m5stickC, leak-detector-m5stickC_main_index.jpg
2021-05-03 01:11:02 +02:00
ESP32 BLE iTag Button, cookbook/ble_itag, esp32_ble_itag.jpg
2020-12-21 01:55:44 +01:00
IAQ (Indoor Air Quality) Board, cookbook/iaq_board, iaq_board2.jpg
2021-02-20 22:02:46 +01:00
Custom UART Text Sensor, cookbook/uart_text_sensor, language-cpp.svg
2021-02-28 07:45:29 +01:00
IWOOLE Table Lamp, cookbook/iwoole_rgbw_table_lamp, iwoole_rgbw_table_lamp.png
2021-09-26 22:27:26 +02:00
EPEVER Tracer, cookbook/tracer-an, tracer-an.jpg
2021-07-26 12:23:23 +02:00
Ilonda Wifi Smart Fish Feeder, cookbook/ilonda-wifi-smart-fish-feeder, ilonda-wifi-smart-fish-feeder-cookbook.jpg
2018-05-13 11:37:02 +02:00
2019-02-07 13:54:45 +01:00
Do you have other awesome automations or cool setups? Please feel free to add them to the
documentation for others to copy. See :doc: `Contributing </guides/contributing>` .
2018-05-13 11:37:02 +02:00
2018-06-01 18:10:00 +02:00
.. toctree ::
2018-11-14 22:12:27 +01:00
:hidden:
2018-06-01 18:10:00 +02:00
2018-06-03 14:00:32 +02:00
web-api/index
2018-12-31 13:17:43 +01:00
misc/index
2019-02-07 13:54:45 +01:00
components/index
cookbook/index
devices/index
guides/index
changelog/index
custom/index
2019-02-14 16:19:07 +01:00
images/index
