esphome-docs/index.rst

756 lines
32 KiB
ReStructuredText
Raw Normal View History

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.
:image: logo.svg
2018-05-13 11:37:02 +02:00
.. image:: /images/logo-text.svg
2018-05-13 11:37:02 +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.
.. image:: /images/hero.png
.. raw:: html
<div class="guide-container">
<div class="guide-card">
2021-06-16 12:51:32 +02:00
<h3 class="guide-card-title">Getting started</h3>
<ul>
<li>
2021-06-16 12:51:32 +02:00
<a class="reference" href="/guides/getting_started_hassio.html">
from Home Assistant
</a>
</li>
<li>
2021-06-16 12:51:32 +02:00
<a class="reference" href="/guides/getting_started_command_line.html">
using the command line
</a>
</li>
<li>
2021-06-16 12:51:32 +02:00
<a class="reference" href="/guides/migrate_sonoff_tasmota.html">
by migrating from Tasmota
</a>
</li>
</ul>
<pre class="guide-code">
esphome:
2021-06-16 12:51:32 +02:00
&nbsp;&nbsp;name: awesome
2022-02-10 23:10:43 +01:00
esp32:
&nbsp;&nbsp;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">
Sharing ESPHome devices
2021-07-20 02:47:13 +02:00
</a>
</li>
<li>
<a class="reference" href="/guides/made_for_esphome.html">
Made for ESPHome program
</a>
2021-07-20 02:47:13 +02:00
</li>
</ul>
</div>
<div class="guide-card">
2021-06-16 12:51:32 +02:00
<h3 class="guide-card-title">Keeping up</h3>
<ul>
<li>
<a class="reference" href="https://discord.gg/KhAMKrd" target="_blank">
Discord
</a>
</li>
<li>
<a class="reference" href="https://community.home-assistant.io/c/esphome/" target="_blank">
Forums
</a>
</li>
<li>
2021-06-16 12:51:32 +02:00
<a class="reference" href="/changelog/index.html">
Changelog
</a>
</li>
<li>
2021-06-16 12:51:32 +02:00
<a class="reference" href="/guides/supporters.html">
Supporters
</a>
</li>
<li>
2021-06-16 12:51:32 +02:00
<a class="reference" href="/guides/contributing.html">
Contributing
</a>
2021-06-16 03:50:49 +02:00
</li>
</ul>
</div>
</div>
.. _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.
.. 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
Sonoff T1 UK 3 Gang V1.1, devices/sonoff_t1_uk_3gang_v1.1, sonoff_t1_uk_3g_v1.1.jpg
Sonoff T3 EU 3 Gang V1.0, devices/sonoff_t3_eu_3gang_v1.0, sonoff_t3_eu_3g_v1.0.jpg
Core Components
---------------
.. imgtable::
2019-02-16 23:25:23 +01:00
Core, components/esphome, cloud-circle.svg
WiFi, components/wifi, network-wifi.svg
MQTT, components/mqtt, mqtt.png
Network, components/network, network-wifi.svg
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
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
External Components, components/external_components, external_components.svg
Sensor Components
-----------------
Sensors have been split into categories. If a sensor fits into more than one category, it will be listed multiple times.
Core
****
.. 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
MQTT Subscribe, components/sensor/mqtt_subscribe, mqtt.png
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::
AirThings BLE, components/sensor/airthings_ble, airthings_logo.png, Radon, CO2, Volatile organics
CCS811, components/sensor/ccs811, ccs811.jpg, CO2 & Volatile organics
HM3301, components/sensor/hm3301, hm3301.jpg, Particulate
MH-Z19, components/sensor/mhz19, mhz19.jpg, CO2 & Temperature
PM1006 Sensor, components/sensor/pm1006, pm1006.jpg, Particulate
PMSA003I, components/sensor/pmsa003i, pmsa003i.jpg, Particulate
PMSX003, components/sensor/pmsx003, pmsx003.svg, Particulate
2022-02-08 04:32:42 +01:00
RadonEye BLE, components/sensor/radon_eye_ble, radon_eye_logo.png, Radon
SDS011 Sensor, components/sensor/sds011, sds011.jpg, Particulate
2022-05-10 10:15:10 +02:00
SEN5x, components/sensor/sen5x, sen54.jpg, Temperature & Humidity, Volatile organics and NOx
SenseAir, components/sensor/senseair, senseair_s8.jpg, CO2
SCD30, components/sensor/scd30, scd30.jpg, CO2 & Temperature & Humidity
SCD4X, components/sensor/scd4x, scd4x.jpg, CO2 & Temperature & Humidity
SGP30, components/sensor/sgp30, sgp30.jpg, CO2 & Volatile organics
2022-05-19 02:47:37 +02:00
SGP4x, components/sensor/sgp4x, sgp40.jpg, Volatile organics and NOx
SM300D2, components/sensor/sm300d2, sm300d2.jpg, Air quality
SPS30, components/sensor/sps30, sps30.jpg, Particulate
T6613/15, components/sensor/t6615, t6615.jpg, CO2
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
CD74HC4067, components/sensor/cd74hc4067, cd74hc4067.jpg, 16-channel analog multiplexer
MCP3008, components/sensor/mcp3008, mcp3008.jpg, 8-channel ADC
2022-04-13 05:31:22 +02:00
MCP3204/MCP3208, components/sensor/mcp3204, mcp3204.jpg, 4-channel ADC
Resistance, components/sensor/resistance, omega.svg
Bluetooth Low Energy (BLE)
**************************
.. imgtable::
AM43, components/sensor/am43, am43.jpg, Lux & Battery level
BLE Client Sensor, components/sensor/ble_client, bluetooth.svg
BLE RSSI, components/sensor/ble_rssi, bluetooth.svg
Inkbird IBS-TH1 Mini, components/sensor/inkbird_ibsth1_mini, inkbird_isbth1_mini.jpg, Temperature & Humidity
2022-05-15 21:35:54 +02:00
Mopeka Pro Check LP, components/sensor/mopeka_pro_check, mopeka_pro_check.jpg, tank level
RuuviTag, components/sensor/ruuvitag, ruuvitag.jpg, Temperature & Humidity & Accelerometer
Xiaomi BLE, components/sensor/xiaomi_ble, xiaomi_mijia_logo.jpg, Various
Digital Signals
***************
.. imgtable::
Duty Cycle, components/sensor/duty_cycle, percent.svg
Pulse Counter, components/sensor/pulse_counter, pulse.svg
Pulse Meter, components/sensor/pulse_meter, pulse.svg
2019-05-25 09:08:05 +02:00
Pulse Width, components/sensor/pulse_width, pulse.svg
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.jpg, IR optical distance
Electricity
***********
.. imgtable::
ADE7953, components/sensor/ade7953, ade7953.svg, Power
ATM90E32, components/sensor/atm90e32, atm90e32.jpg, Voltage & Current & Power
BL0939, components/sensor/bl0939, bl0939.png, Voltage & Current & Power & Energy
2022-01-04 10:45:49 +01:00
BL0940, components/sensor/bl0940, bl0940.png, Voltage & Current & Power
CS5460A, components/sensor/cs5460a, cs5460a.png, Voltage & Current & Power
CSE7761, components/sensor/cse7761, cse7761.svg, Voltage & Current & Power
CSE7766, components/sensor/cse7766, cse7766.svg, Voltage & Current & Power
CT Clamp, components/sensor/ct_clamp, ct_clamp.jpg, AC current
Daly BMS, components/sensor/daly_bms, daly_bms.jpg, Voltage & Current & Power
DSMR, components/sensor/dsmr, dsmr.svg, Electrical counter
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
INA260, components/sensor/ina260, ina260.jpg, DC Current & Power
INA3221, components/sensor/ina3221, ina3221.jpg, 3-Ch DC current
MAX9611, components/sensor/max9611, max9611.jpg, +60VDC Voltage & Current & Power & Temperature
PZEM AC, components/sensor/pzemac, pzem-ac.jpg, Voltage & Current & Power
PZEM DC, components/sensor/pzemdc, pzem-dc.jpg, Voltage & Current & Power
PZEM004T, components/sensor/pzem004t, pzem004t.svg, Voltage & Current & Power
SDM Meter, components/sensor/sdm_meter, sdm220m.jpg, 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
AirThings BLE, components/sensor/airthings_ble, airthings_logo.png, Temperature & Humidity & Pressure
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
BMP085, components/sensor/bmp085, bmp180.jpg, Temperature & Pressure
BMP280, components/sensor/bmp280, bmp280.jpg, Temperature & Pressure
2022-01-08 09:36:01 +01:00
BMP388 and BMP390, components/sensor/bmp3xx, bmp388.jpg, Temperature & Pressure
b-parasite, components/sensor/b_parasite, b_parasite.jpg, Moisture & Temperature & Humidity & Light
Dallas DS18B20, components/sensor/dallas, dallas.jpg, Temperature
DHT, components/sensor/dht, dht.jpg, Temperature & Humidity
DHT12, components/sensor/dht12, dht12.jpg, Temperature & Humidity
ENS210, components/sensor/ens210, ens210.jpg, Temperature & Humidity
HDC1080, components/sensor/hdc1080, hdc1080.jpg, Temperature & Humidity
Honeywell ABP, components/sensor/honeywellabp, honeywellabp.jpg, Pressure & Temperature
HTU21D / Si7021 / SHT21, components/sensor/htu21d, htu21d.jpg, Temperature & Humidity
Hydreon Rain Sensor, components/sensor/hydreon_rgxx, hydreon_rg9.jpg, Rain
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
2022-03-14 20:09:29 +01:00
QMP6988, components/sensor/qmp6988, qmp6988_env3.png, Temperature & Pressure
2022-02-08 04:32:42 +01:00
RadonEye BLE, components/sensor/radon_eye_ble, radon_eye_logo.png, Radon
RuuviTag, components/sensor/ruuvitag, ruuvitag.jpg, Temperature & Humidity & Accelerometer
SCD30, components/sensor/scd30, scd30.jpg, CO2 & Temperature & Humidity
SCD4X, components/sensor/scd4x, scd4x.jpg, CO2 & Temperature & Humidity
SDP3x / SDP800 Series, components/sensor/sdp3x, sdp31.jpg, Pressure
SHT3X-D, components/sensor/sht3xd, sht3xd.jpg, Temperature & Humidity
SHT4X, components/sensor/sht4x, sht4x.jpg, Temperature & Humidity
SHTCx, components/sensor/shtcx, shtc3.jpg, Temperature & Humidity
STS3X, components/sensor/sts3x, sts3x.jpg, Temperature
TMP102, components/sensor/tmp102, tmp102.jpg, Temperature
TMP117, components/sensor/tmp117, tmp117.jpg, Temperature
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
2022-02-18 22:25:38 +01:00
MAX44009, components/sensor/max44009, max44009.svg, Lux
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
2022-02-08 08:42:16 +01:00
MLX90393, components/sensor/mlx90393, mlx90393.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
b-parasite, components/sensor/b_parasite, b_parasite.jpg, Moisture & Temperature & Humidity & Light
EZO sensor circuits, components/sensor/ezo, ezo-ph-circuit.png, (pH)
Havells Solar, components/sensor/havells_solar, havellsgti5000d_s.jpg, Solar rooftop
Growatt Solar, components/sensor/growatt_solar, growatt.jpg, Solar rooftop
2022-01-09 23:55:29 +01:00
Kalman Combinator, components/sensor/kalman_combinator, function.svg
Modbus Sensor, components/sensor/modbus_controller, modbus.png
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
MPU6886, components/sensor/mpu6886, mpu6886.jpg, Accelerometer & Gyroscope
RuuviTag, components/sensor/ruuvitag, ruuvitag.jpg, Temperature & Humidity & Accelerometer
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
Weight
******
.. imgtable::
HX711, components/sensor/hx711, hx711.jpg, Load cell amplifier
Xiaomi Miscale, components/sensor/xiaomi_miscale, xiaomi_miscale1&2.jpg
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
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
Status, components/binary_sensor/status, server-network.svg
2022-02-17 21:14:14 +01:00
Analog Threshold, components/binary_sensor/analog_threshold, analog_threshold.svg
2019-05-12 22:59:06 +02:00
ESP32 BLE Presence, components/binary_sensor/ble_presence, bluetooth.svg
ESP32 Touch Pad, components/binary_sensor/esp32_touch, touch.svg
Hydreon Rain Sensor Binary Sensor, components/binary_sensor/hydreon_rgxx, hydreon_rg9.jpg
MPR121 Capacitive Touch Sensor, components/binary_sensor/mpr121, mpr121.jpg
Nextion Binary Sensor, components/binary_sensor/nextion, nextion.jpg
Template Binary Sensor, components/binary_sensor/template, description.svg
PN532, components/binary_sensor/pn532, pn532.jpg
2020-10-27 00:42:09 +01:00
RC522, components/binary_sensor/rc522, rc522.jpg
RDM6300, components/binary_sensor/rdm6300, rdm6300.jpg
2019-05-13 13:10:12 +02:00
TTP229, components/binary_sensor/ttp229, ttp229.jpg
Tuya Binary Sensor, components/binary_sensor/tuya, tuya.png
Modbus Binary Sensor, components/binary_sensor/modbus_controller, modbus.png
XPT2046, components/binary_sensor/xpt2046, xpt2046.jpg
CAP1188 Capacitive Touch Sensor, components/binary_sensor/cap1188, cap1188.jpg
Touchscreen, components/touchscreen/index, touch.svg
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
Slow PWM, components/output/slow_pwm, pwm.png
GPIO Output, components/output/gpio, pin.svg
ESP32 DAC, components/output/esp32_dac, dac.svg
ESP32 LEDC, components/output/ledc, pwm.png
AC Dimmer, components/output/ac_dimmer, ac_dimmer.svg
PCA9685, components/output/pca9685, pca9685.jpg
2019-10-14 11:38:20 +02:00
TLC59208F, components/output/tlc59208f, tlc59208f.jpg
TLC5947, components/output/tlc5947, tlc5947.jpg
MY9231/MY9291, components/output/my9231, my9231.svg
SM16716, components/output/sm16716, sm16716.svg
2021-05-12 21:14:26 +02:00
SM2135, components/output/sm2135, sm2135.svg
MCP4725, components/output/mcp4725, mcp4725.jpg
MCP4728, components/output/mcp4728, mcp4728.jpg
2022-01-08 09:36:01 +01:00
MCP47A1, components/output/mcp47a1, mcp47a1.svg
BLE Binary Output, components/output/ble_client, bluetooth.svg
Modbus Output, components/output/modbus_controller, modbus.png
Custom Output, components/output/custom, language-cpp.svg
Template Output, components/output/template, description.svg
Light Components
----------------
.. imgtable::
2018-05-13 11:37:02 +02: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
Monochromatic Light, components/light/monochromatic, brightness-medium.svg
2018-11-14 22:12:27 +01:00
Cold+Warm White Light, components/light/cwww, brightness-medium.svg
Color Temperature Light, components/light/color_temperature, brightness-medium.svg
RGB Light, components/light/rgb, rgb.png
RGBW Light, components/light/rgbw, rgbw.png
RGBWW Light, components/light/rgbww, rgbw.png
RGBCT Light, components/light/rgbct, rgbw.png
FastLED Light, components/light/fastled, color_lens.svg
NeoPixelBus Light, components/light/neopixelbus, color_lens.svg
2019-02-16 23:25:23 +01:00
Light Partition, components/light/partition, color_lens.svg
Tuya Dimmer, components/light/tuya, tuya.png
2022-05-15 21:35:54 +02:00
Shelly Dimmer, components/light/shelly_dimmer, shellydimmer2.jpg
2019-05-15 10:54:51 +02:00
Custom Light, components/light/custom, language-cpp.svg
H-bridge Light, components/light/hbridge, brightness-medium.svg
Sonoff D1 Dimmer, components/light/sonoff_d1, sonoff_d1.jpg
Looking for WS2811 and similar individually addressable lights? Have a look at the
:doc:`FastLED Light </components/light/fastled>`.
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
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
Tuya Switch, components/switch/tuya, tuya.png
Modbus Switch, components/switch/modbus_controller, modbus.png
BLE Client Switch, components/switch/ble_client, bluetooth.svg
Nextion Switch, components/switch/nextion, nextion.jpg
Button Components
-----------------
.. imgtable::
Button Core, components/button/index, folder-open.svg
Template Button, components/button/template, description.svg
Generic Output Button, components/button/output, upload.svg
Restart Button, components/button/restart, restart.svg
Safe Mode Button, components/button/safe_mode, restart-alert.svg
Shutdown Button, components/button/shutdown, power_settings.svg
Wake-on-LAN, components/button/wake_on_lan, power_settings.svg
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
Speed Fan, components/fan/speed, fan.svg
Tuya Fan, components/fan/tuya, tuya.png
Display Components
------------------
.. imgtable::
Display Core, components/display/index, folder-open.svg
Addressable Light, components/display/addressable_light, addressable_light.jpg
LCD Display, components/display/lcd_display, lcd.jpg
MAX7219, components/display/max7219, max7219.jpg
MAX7219 Dot Matrix, components/display/max7219digit, max7219digit.jpg
2020-01-13 23:44:03 +01:00
TM1637, components/display/tm1637, tm1637.jpg
Nextion, components/display/nextion, nextion.jpg
SSD1306, components/display/ssd1306, ssd1306.jpg
2020-12-30 10:52:46 +01:00
SSD1322, components/display/ssd1322, ssd1322.jpg
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
SSD1351, components/display/ssd1351, ssd1351.jpg
ST7735, components/display/st7735, st7735.jpg
ST7789V, components/display/st7789v, st7789v.jpg
ST7920, components/display/st7920, st7920.jpg
ILI9341, components/display/ili9341, ili9341.jpg
Waveshare E-Paper, components/display/waveshare_epaper, waveshare_epaper.jpg
Inkplate, components/display/inkplate6, inkplate6.jpg
PCD8544 (Nokia 5110/ 3310), components/display/pcd8544, pcd8544.jpg
Touchscreen Components
----------------------
.. imgtable::
Touchscreen Core, components/touchscreen/index, folder-open.svg
EKTF2232, components/touchscreen/ektf2232, ektf2232.svg, Inkplate 6 Plus
2022-02-20 10:39:33 +01:00
Lilygo T5 4.7", components/touchscreen/lilygo_t5_47, lilygo_t5_47_touch.jpg
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
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
AM43 Cover, components/cover/am43, am43.jpg
Tuya Cover, components/cover/tuya, tuya.png
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
BLE Scanner, components/text_sensor/ble_scanner, bluetooth.svg
Modbus Text Sensor, components/text_sensor/modbus_controller, modbus.png
Template Text Sensor, components/text_sensor/template, description.svg
Custom Text Sensor, components/text_sensor/custom, language-cpp.svg
Nextion Text Sensor, components/text_sensor/nextion, nextion.jpg
Tuya Text Sensor, components/text_sensor/tuya, tuya.png
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
PID Controller, components/climate/pid, function.svg
2022-04-03 09:30:25 +02:00
IR Remote Climate, components/climate/climate_ir, air-conditioner-ir.svg
Tuya Climate, components/climate/tuya, tuya.png
2021-09-08 23:10:05 +02:00
Midea, components/climate/midea, midea.svg
Anova Cooker, components/climate/anova, anova.png
BedJet Climate System, components/climate/bedjet, bedjet.png
2019-05-12 22:59:06 +02:00
Number Components
-----------------
.. imgtable::
Number Core, components/number/index, folder-open.svg
Modbus Number, components/number/modbus_controller, modbus.png
Template Number, components/number/template, description.svg
2021-12-20 02:35:24 +01:00
Tuya Number, components/number/tuya, tuya.png
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
Modbus Select, components/select/modbus_controller, modbus.png
2022-05-15 21:49:48 +02:00
Tuya Select, components/select/tuya, tuya.png
2021-08-02 10:01:08 +02:00
Lock Components
-----------------
.. imgtable::
Lock Core, components/lock/index, folder-open.svg
Generic Output Lock, components/lock/output, upload.svg
Template Lock, components/lock/template, description.svg
Media Player Components
-----------------------
.. imgtable::
Media Player Core, components/media_player/index, folder-open.svg
I2S Audio, components/media_player/i2s_audio, i2s_audio.svg
Misc Components
---------------
.. imgtable::
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
Status LED, components/status_led, led-on.svg
2019-11-09 18:39:13 +01:00
HTTP Request, components/http_request, connection.svg
mDNS, components/mdns, radio-tower.svg
2019-05-13 21:51:04 +02: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
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
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
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
MCP230XX I/O Expander - I²C Bus, components/mcp230xx, mcp230xx.svg
TCA9548A I²C Multiplexer, components/tca9548a, tca9548a.jpg
MCP23SXX I/O Expander - SPI Bus, components/mcp23Sxx, mcp230xx.svg
SX1509 I/O Expander, components/sx1509, sx1509.jpg
SN74HC595 I/O Expander, components/sn74hc595, sn74hc595.jpg
SIM800L, components/sim800l, sim800l.jpg
DFPlayer, components/dfplayer, dfplayer.svg
2019-07-28 12:41:15 +02:00
Captive Portal, components/captive_portal, wifi-strength-alert-outline.svg
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
TM1651 Battery Display, components/tm1651, tm1651_battery_display.jpg
RF Bridge, components/rf_bridge, rf_bridge.jpg
Tuya MCU, components/tuya, tuya.png
Modbus Controller, components/modbus_controller, modbus.png
2020-07-14 19:08:27 +02:00
Exposure Notifications, components/exposure_notifications, exposure_notifications.png
RTTTL Buzzer, components/rtttl, buzzer.jpg
2020-07-27 12:06:56 +02:00
Prometheus, components/prometheus, prometheus.svg
PipSolar - compatible PV Inverter, components/pipsolar, pipsolar.jpg
Grow Fingerprint Reader, components/fingerprint_grow, fingerprint.svg
SML, components/sml, sml.svg
2021-07-29 12:03:43 +02:00
Demo, components/demo, description.svg
2022-02-20 21:13:39 +01:00
Copy, components/copy, content-copy.svg
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
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
--------
.. imgtable::
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
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
H801 LED Controller, cookbook/h801, h801.jpg
Time & Temperature on OLED Display, cookbook/display_time_temp_oled, display_time_temp_oled_2.jpg
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
Brilliant / Mirabella Genio Smart Plugs, cookbook/brilliant-mirabella-genio-smart-plugs, cookbook-brilliant-mirabella-genio-smart-plugs.jpg
Etekcity Voltson (ESW01-EU) , cookbook/esw01-eu, esw01-eu.jpg
ifan02 cookbook (#218) * ifan02 cookbook * removed spaces * removed spaces * indent codeblock, newline at end * fixes * add seo :image: * spaces... * Complete the example code & fix compilation errors Tried compiling this code today using ESPHome 1.13.6.. it would not compile. * The ifan02.h file was the main culprit and I was able to fix the issue. * The .yaml example was missing a few declarations at the beginning so I added them. * I fixed an error related to using ```light``` for the light id since that is a reserved name. * I added an ```on_boot``` declaration to turn off the light as early as possible after power is restored. (if mains power is restored in the middle of the night and the light turns on while you are sleeping it can be quite annoying, this turns it off during the boot process). * removed blank spaces on line 66 Those blank spaces get me every time ;-) * fix doc links (hopefully) I think my last PR was made against the wrong fork/branch/etc... sorry, I'm still learning github. I currently have the time and really want to see this make it into the cookbook. I think if you add me as a collaborator I would be able to push the changes and help get the errors sorted more quickly; if not, no worries, I'll take no offense and do my best to continue helping as we are doing now. * fix fan link replace ``` :doc:`/components/fan` ``` with ``` :doc:`/components/fan/index` ``` Co-authored-by: mjoshd <35782597+mjoshd@users.noreply.github.com> Co-authored-by: Guillermo Ruffino <glm.net@gmail.com>
2020-04-05 18:49:52 +02:00
Sonoff iFan02, cookbook/ifan02, fan.svg
Zemismart RGBW Downlights, cookbook/zemismart-rgbw-downlights, cookbook-zemismart-rgbw-downlight.jpg
Teckin SB50, cookbook/teckin_sb50, teckin_sb50.jpg
Sonoff light switch options, cookbook/sonoff-light-switch, light_switch.png
ESP32 Water Leak Detector, cookbook/leak-detector-m5stickC, leak-detector-m5stickC_main_index.jpg
ESP32 BLE iTag Button, cookbook/ble_itag, esp32_ble_itag.jpg
IAQ (Indoor Air Quality) Board, cookbook/iaq_board, iaq_board2.jpg
TUYA Smart Life RGBW Controller, cookbook/tuya_rgbw, tuya_rgbw.jpg
Custom UART Text Sensor, cookbook/uart_text_sensor, language-cpp.svg
IWOOLE Table Lamp, cookbook/iwoole_rgbw_table_lamp, iwoole_rgbw_table_lamp.png
EPEVER Tracer, cookbook/tracer-an, tracer-an.jpg
Ilonda Wifi Smart Fish Feeder, cookbook/ilonda-wifi-smart-fish-feeder, ilonda-wifi-smart-fish-feeder-cookbook.jpg
AirGradient DIY Air Quality Sensor, cookbook/air_gradient_diy_air_quality_sensor, air_gradient_diy_air_quality_sensor.jpg
2018-05-13 11:37:02 +02: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
components/index
cookbook/index
devices/index
guides/index
changelog/index
custom/index
images/index