From c4b2d8d922111bccc3a7288ac6d809b8fb189f37 Mon Sep 17 00:00:00 2001 From: Keith Burzinski Date: Tue, 25 Feb 2025 22:29:28 -0600 Subject: [PATCH] Move docs off of main page (#4706) --- components/index.rst | 1088 ++++++++++++++++++++++++++++++- guides/contributing.rst | 1 - images/xiaomi_lywsd03mmc.jpg | Bin 0 -> 9032 bytes index.rst | 1171 ++-------------------------------- 4 files changed, 1150 insertions(+), 1110 deletions(-) create mode 100644 images/xiaomi_lywsd03mmc.jpg diff --git a/components/index.rst b/components/index.rst index 5b34e33a0..507327fdc 100644 --- a/components/index.rst +++ b/components/index.rst @@ -1,9 +1,1091 @@ -Components -========== +.. title:: ESPHome Docs + +.. seo:: + :description: ESPHome main documentation + :image: logo-docs.svg + +.. image:: /images/logo-docs.svg + +This page is an index of all of the hardware components and platforms ESPHome currently supports. + +.. _devices: + +Supported Microcontrollers +-------------------------- + +.. imgtable:: + + ESP32, components/esp32, esp32.svg + ESP8266, components/esp8266, esp8266.svg + RP2040, components/rp2040, rp2040.svg + BK72xx, components/libretiny, bk72xx.svg + RTL87xx, components/libretiny, rtl87xx.svg + Host, components/host, host.svg, dark-invert + +Microcontroller Peripherals +--------------------------- + +Peripherals which directly support the operation of the microcontroller's processor(s). + +.. imgtable:: + + PSRAM, components/psram, psram.svg + Deep Sleep, components/deep_sleep, hotel.svg, dark-invert + +ESPHome Automations +------------------- + +*"When this happens, I want it to do that..."* + +Automations are how we customize ESPHome devices to respond/behave exactly how you want them to. + +.. imgtable:: + + Overview, automations/index, description.svg, dark-invert + "Actions, Triggers, Conditions", automations/actions, description.svg, dark-invert + Templates, automations/templates, description.svg, dark-invert + +ESPHome Components +------------------ + +ESPHome-specific components or components supporting ESPHome device provisioning post-installation. + +.. imgtable:: + + Core, components/esphome, cloud-circle.svg, dark-invert + Captive Portal, components/captive_portal, wifi-strength-alert-outline.svg, dark-invert + Copy, components/copy, content-copy.svg, dark-invert + Demo, components/demo, description.svg, dark-invert + External Components, components/external_components, external_components.svg, dark-invert + Globals, components/globals, description.svg, dark-invert + Improv via BLE, components/esp32_improv, improv.svg, dark-invert + Improv via Serial, components/improv_serial, improv.svg, dark-invert + Interval, components/interval, description.svg, dark-invert + JSON, components/json, json.svg, dark-invert + XXTEA, components/xxtea, xxtea.svg + Script, components/script, description.svg, dark-invert + +ESPHome Configuration +--------------------- + +Streamline your ESPHome configuration and/or use components provided by other contributors. + +.. imgtable:: + + External Components, components/external_components, external_components.svg, dark-invert + Packages, components/packages, description.svg, dark-invert + Substitutions, components/substitutions, description.svg, dark-invert + +Network Hardware +---------------- + +.. imgtable:: + + WiFi, components/wifi, network-wifi.svg, dark-invert + ESP32 Ethernet, components/ethernet, ethernet.svg, dark-invert + +Network Protocols +----------------- + +.. imgtable:: + + Network Core, components/network, server-network.svg, dark-invert + Native API, components/api, server-network.svg, dark-invert + MQTT, components/mqtt, mqtt.png + HTTP Request, components/http_request, connection.svg, dark-invert + mDNS, components/mdns, radio-tower.svg, dark-invert + WireGuard, components/wireguard, wireguard_custom_logo.svg, dark-invert + StatsD, components/statsd, connection.svg, dark-invert + UDP, components/udp, udp.svg + +Bluetooth/BLE +------------- + +.. imgtable:: + + ESP32 BLE Beacon, components/esp32_ble_beacon, bluetooth.svg, dark-invert + ESP32 BLE Client, components/ble_client, bluetooth.svg, dark-invert + ESP32 BLE Tracker, components/esp32_ble_tracker, bluetooth.svg, dark-invert + Bluetooth Proxy, components/bluetooth_proxy, bluetooth.svg, dark-invert + Improv via BLE, components/esp32_improv, improv.svg, dark-invert + +Management and Monitoring +------------------------- + +.. imgtable:: + + Debug, components/debug, bug-report.svg, dark-invert + Logger, components/logger, file-document-box.svg, dark-invert + Prometheus, components/prometheus, prometheus.svg + StatsD, components/statsd, connection.svg, dark-invert + Safe Mode, components/safe_mode, restart-alert.svg, dark-invert + Web Server, components/web_server, http.svg + ESP32 Camera Web Server, components/esp32_camera_web_server, camera.svg, dark-invert + +Update Installation +------------------- + +Install updates over-the-air (OTA). + +.. imgtable:: + + OTA Core, components/ota/index, system-update.svg, dark-invert + OTA Updates, components/ota/esphome, system-update.svg, dark-invert + OTA Updates via HTTP Request, components/ota/http_request, system-update.svg, dark-invert + +Update Management +----------------- + +Create update entities simplifying management of OTA updates. + +.. imgtable:: + + Update Core, components/update/index, system-update.svg, dark-invert + Managed Updates, components/update/http_request, system-update.svg, dark-invert + +Hardware Peripheral Interfaces/Busses +------------------------------------- + +.. imgtable:: + + 1-Wire, components/one_wire, one-wire.svg + CAN Bus, components/canbus/index, canbus.svg + I²C Bus, components/i2c, i2c.svg + I²S Audio, components/i2s_audio, i2s_audio.svg + OpenTherm, components/opentherm, opentherm.png + SPI Bus, components/spi, spi.svg + UART, components/uart, uart.svg + +I/O Expanders/Multiplexers +-------------------------- + +.. imgtable:: + + CH422G, components/ch422g, ch422g.svg + MAX6956 - I²C Bus, components/max6956, max6956.jpg + MCP230XX - I²C Bus, components/mcp230xx, mcp230xx.svg + MCP23SXX - SPI Bus, components/mcp23Sxx, mcp23sxx.svg + PCA6416A, components/pca6416a, pca6416a.svg + PCA9554, components/pca9554, pca9554a.jpg + PCF8574, components/pcf8574, pcf8574.jpg + SN74HC165, components/sn74hc165, sn74hc595.jpg + SN74HC595, components/sn74hc595, sn74hc595.jpg + SX1509, components/sx1509, sx1509.jpg + TCA9548A I²C Multiplexer, components/tca9548a, tca9548a.jpg + TCA9555, components/tca9555, tca9555.svg + WeiKai SPI/I²C UART/IO Expander, components/weikai, wk2168.jpg + XL9535, components/xl9535, xl9535.svg + +CAN Bus +------- + +.. imgtable:: + + CAN Bus, components/canbus/index, canbus.svg + ESP32 CAN, components/canbus/esp32_can, esp32.svg + MCP2515, components/canbus/mcp2515, mcp2515.svg + +Sensor Components +----------------- + +Sensors are organized into categories; if a given sensor fits into more than one category, it will appear multiple times. + +Core +**** + +.. imgtable:: + + Sensor Core, components/sensor/index, folder-open.svg, dark-invert + Template Sensor, components/sensor/template, description.svg, dark-invert + Home Assistant, components/sensor/homeassistant, home-assistant.svg, dark-invert + MQTT Subscribe, components/sensor/mqtt_subscribe, mqtt.png + Uptime Sensor, components/sensor/uptime, timer.svg, dark-invert + WiFi Signal Strength, components/sensor/wifi_signal, network-wifi.svg, dark-invert + +Air Quality +*********** + +.. imgtable:: + + AGS10, components/sensor/ags10, ags10.jpg, Volatile Organic Compound Sensor + AirThings BLE, components/sensor/airthings_ble, airthings_logo.png, Radon, CO2, Volatile organics + CCS811, components/sensor/ccs811, ccs811.jpg, CO2 & Volatile organics + EE895, components/sensor/ee895, EE895.png, CO2 & Temperature & Pressure + ENS160, components/sensor/ens160, ens160.jpg, CO2 & Air Quality + GCJA5, components/sensor/gcja5, gcja5.svg, Particulate + GP2Y1010AU0F, components/sensor/gp2y1010au0f, gp2y1010au0f.png, Particulate + Grove Multichannel Gas V2, components/sensor/grove_gas_mc_v2, grove-gas-mc-v2.png, NO2 & CO & Ethanol & Volatile organics + HM3301, components/sensor/hm3301, hm3301.jpg, Particulate + iAQ-Core, components/sensor/iaqcore, iaqcore.jpg, CO2 & Volatile organics + MH-Z19, components/sensor/mhz19, mhz19.jpg, CO2 & Temperature + MiCS-4514, components/sensor/mics_4514, mics_4514.jpg, Gas concentration + PM1006 Sensor, components/sensor/pm1006, pm1006.jpg, Particulate + PMSA003I, components/sensor/pmsa003i, pmsa003i.jpg, Particulate + PMSX003, components/sensor/pmsx003, pmsx003.svg, Particulate + RadonEye BLE, components/sensor/radon_eye_ble, radon_eye_logo.png, Radon + SCD30, components/sensor/scd30, scd30.jpg, CO2 & Temperature & Humidity + SCD4X, components/sensor/scd4x, scd4x.jpg, CO2 & Temperature & Humidity + SDS011 Sensor, components/sensor/sds011, sds011.jpg, Particulate + SEN0321, components/sensor/sen0321, sen0321.jpg, Ozone + SEN5x, components/sensor/sen5x, sen54.jpg, Temperature & Humidity & Volatile organics & NOx + SenseAir, components/sensor/senseair, senseair_s8.jpg, CO2 + SFA30, components/sensor/sfa30, sfa30.jpg, Formaldehyde + SGP30, components/sensor/sgp30, sgp30.jpg, CO2 & Volatile organics + SGP4x, components/sensor/sgp4x, sgp40.jpg, Volatile organics & 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, dark-invert + ADC128S102, components/sensor/adc128s102, adc128s102.png , 8-channel ADC + ADS1115, components/sensor/ads1115, ads1115.jpg, 4-channel ADC + ADS1118, components/sensor/ads1118, ads1118.jpg, 4-channel ADC + CD74HC4067, components/sensor/cd74hc4067, cd74hc4067.jpg, 16-channel analog multiplexer + MCP3008, components/sensor/mcp3008, mcp3008.jpg, 8-channel ADC + MCP3204 / MCP3208, components/sensor/mcp3204, mcp3204.jpg, 4-channel ADC + NAU7802, components/sensor/nau7802, nau7802.jpg, ADC + Resistance, components/sensor/resistance, omega.svg, dark-invert + +Bluetooth Low Energy (BLE) +************************** + +.. imgtable:: + + Alpha3, components/sensor/alpha3, alpha3.jpg + AM43, components/sensor/am43, am43.jpg, Lux & Battery level + BLE Client Sensor, components/sensor/ble_client, bluetooth.svg, dark-invert + BLE RSSI, components/sensor/ble_rssi, bluetooth.svg, dark-invert + HHCCJCY10 (MiFlora Pink), components/sensor/xiaomi_hhccjcy10, xiaomi_hhccjcy10.jpg, Soil moisture & Temperature & Light + Inkbird IBS-TH1 Mini, components/sensor/inkbird_ibsth1_mini, inkbird_isbth1_mini.jpg, Temperature & Humidity + Mopeka Pro Check LP, components/sensor/mopeka_pro_check, mopeka_pro_check.jpg, Tank level + Mopeka Standard Check LP, components/sensor/mopeka_std_check, mopeka_std_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, dark-invert + Pulse Counter, components/sensor/pulse_counter, pulse.svg, dark-invert + Pulse Meter, components/sensor/pulse_meter, pulse.svg, dark-invert + Pulse Width, components/sensor/pulse_width, pulse.svg, dark-invert + +Distance +******** + +.. imgtable:: + + A01NYUB, components/sensor/a01nyub, a01nyub.jpg, Acoustic distance + A02YYUW, components/sensor/a02yyuw, a02yyuw.jpg, Acoustic distance + HRXL MaxSonar WR, components/sensor/hrxl_maxsonar_wr, hrxl_maxsonar_wr.jpg, Acoustic distance + JSN-SR04T, components/sensor/jsn_sr04t, jsn-sr04t-v3.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 + Zio Ultrasonic Sensor, components/sensor/zio_ultrasonic, zio_ultrasonic.jpg, Acoustic distance + +Electricity +*********** + +.. imgtable:: + + ADE7880, components/sensor/ade7880, ade7880.svg, Voltage & Current & Power + ADE7953, components/sensor/ade7953, ade7953.svg, Power + ATM90E26, components/sensor/atm90e26, atm90e26.jpg, Voltage & Current & Power + ATM90E32, components/sensor/atm90e32, atm90e32.jpg, Voltage & Current & Power + BL0906, components/sensor/bl0906, bl0906.png, Voltage & Current & Power & Energy + BL0939, components/sensor/bl0939, bl0939.png, Voltage & Current & Power & Energy + BL0940, components/sensor/bl0940, bl0940.png, Voltage & Current & Power + BL0942, components/sensor/bl0942, bl0942.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, Alternating Current (AC) + 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, Direct Current (DC) + INA226, components/sensor/ina226, ina226.jpg, Direct Current (DC) & Power + INA228, components/sensor/ina2xx, ina228.jpg, DC Voltage & Current & Power & Charge + INA229, components/sensor/ina2xx, ina2xx.jpg, DC Voltage & Current & Power & Charge + INA237, components/sensor/ina2xx, ina2xx.jpg, DC Voltage & Current & Power + INA238, components/sensor/ina2xx, ina2xx.jpg, DC Voltage & Current & Power + INA239, components/sensor/ina2xx, ina2xx.jpg, DC Voltage & Current & Power + INA260, components/sensor/ina260, ina260.jpg, DC Current & Power + INA3221, components/sensor/ina3221, ina3221.jpg, 3-Ch DC current + Kamstrup KMP, components/sensor/kamstrup_kmp, kamstrup_kmp.jpg, District Heating Meter + MAX9611, components/sensor/max9611, max9611.jpg, 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, dark-invert + +Environmental +************* + +.. imgtable:: + + Absolute Humidity, components/sensor/absolute_humidity, water-drop.svg, dark-invert + AHT10 / AHT20 / AHT21 / DHT20, components/sensor/aht10, aht10.jpg, Temperature & Humidity + AirThings BLE, components/sensor/airthings_ble, airthings_logo.png, Temperature & Humidity & Pressure + AM2315C, components/sensor/am2315c, am2315c.jpg, Temperature & Humidity + AM2320, components/sensor/am2320, am2320.jpg, Temperature & Humidity + b-parasite, components/sensor/b_parasite, b_parasite.jpg, Moisture & Temperature & Humidity & Light + BME280, components/sensor/bme280, bme280.jpg, Temperature & Humidity & Pressure + BME68x via BSEC2, components/sensor/bme68x_bsec2, bme680.jpg, Temperature & Humidity & Pressure & Gas + BME680 via BSEC, components/sensor/bme680_bsec, bme680.jpg, Temperature & Humidity & Pressure & Gas + BME680, components/sensor/bme680, bme680.jpg, Temperature & Humidity & Pressure & Gas + BMP085, components/sensor/bmp085, bmp180.jpg, Temperature & Pressure + BMP280, components/sensor/bmp280, bmp280.jpg, Temperature & Pressure + BMP388 and BMP390, components/sensor/bmp3xx, bmp388.jpg, Temperature & Pressure + BMP581, components/sensor/bmp581, bmp581.jpg, Temperature & Pressure + Dallas DS18B20, components/sensor/dallas_temp, dallas.jpg, Temperature + DHT, components/sensor/dht, dht.jpg, Temperature & Humidity + DHT12, components/sensor/dht12, dht12.jpg, Temperature & Humidity + DPS310, components/sensor/dps310, dps310.jpg, Temperature & Pressure + EMC2101, components/emc2101, emc2101.jpg, Temperature + ENS160, components/sensor/ens160, ens160.jpg, CO2 & Air Quality + ENS210, components/sensor/ens210, ens210.jpg, Temperature & Humidity + HDC1080, components/sensor/hdc1080, hdc1080.jpg, Temperature & Humidity + HHCCJCY10 (MiFlora Pink), components/sensor/xiaomi_hhccjcy10, xiaomi_hhccjcy10.jpg, Soil moisture & Temperature & Light + Honeywell ABP, components/sensor/honeywellabp, honeywellabp.jpg, Pressure & Temperature + Honeywell ABP2 I2C, components/sensor/honeywellabp2_i2c, honeywellabp.jpg, Pressure & Temperature + Honeywell HIH I2C, components/sensor/honeywell_hih_i2c, honeywellhih.jpg, Temperature & Humidity + HTE501, components/sensor/hte501, HTE501.png, Temperature & Humidity + HTU21D / Si7021 / SHT21, components/sensor/htu21d, htu21d.jpg, Temperature & Humidity + HTU31D, components/sensor/htu31d, htu31d.jpg, Temperature & Humidity + Hydreon Rain Sensor, components/sensor/hydreon_rgxx, hydreon_rg9.jpg, Rain + HYT271, components/sensor/hyt271, hyt271.jpg, Temperature & Humidity + Inkbird IBS-TH1 Mini, components/sensor/inkbird_ibsth1_mini, inkbird_isbth1_mini.jpg, Temperature & Humidity + Internal Temperature, components/sensor/internal_temperature, thermometer.svg, Temperature, dark-invert + MCP9808, components/sensor/mcp9808, mcp9808.jpg, Temperature + MH-Z19, components/sensor/mhz19, mhz19.jpg, CO2 & Temperature + MLX90614, components/sensor/mlx90614, mlx90614.jpg, Temperature + MPL3115A2, components/sensor/mpl3115a2, mpl3115a2.jpg, Temperature & Pressure + MS5611, components/sensor/ms5611, ms5611.jpg, Pressure + MS8607, components/sensor/ms8607, ms8607.jpg, Temperature & Humidity & Pressure + NPI-19, components/sensor/npi19, npi19.jpg, Pressure + NTC Thermistor, components/sensor/ntc, ntc.jpg, Temperature + PMWCS3, components/sensor/pmwcs3, pmwcs3.jpg, Soil moisture & Temperature + QMP6988, components/sensor/qmp6988, qmp6988_env3.png, Temperature & Pressure + 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 + SFA30, components/sensor/sfa30, sfa30.jpg, Formaldehyde + 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 + SMT100, components/sensor/smt100, smt100.jpg, Moisture & Temperature + STS3X, components/sensor/sts3x, sts3x.jpg, Temperature + TC74, components/sensor/tc74, tc74.jpg, Temperature + TEE501, components/sensor/tee501, TEE501.png, Temperature + TE-M3200, components/sensor/tem3200, tem3200.jpg, Temperature & Pressure + TMP102, components/sensor/tmp102, tmp102.jpg, Temperature + TMP1075, components/sensor/tmp1075, tmp1075.jpg, Temperature + TMP117, components/sensor/tmp117, tmp117.jpg, Temperature + XGZP68xx Series, components/sensor/xgzp68xx, 6897d.jpg, Differential Pressure + +Health/Safety +************* + +.. imgtable:: + + Seeed Studio MR60BHA2 mmWave, components/seeed_mr60bha2, seeed_mr60bha2.jpg, Breathing & heartbeat detection + Seeed Studio MR60FDA2 mmWave, components/seeed_mr60fda2, seeed_mr60fda2.jpg, Presence & Fall detection + +Light +***** + +.. imgtable:: + + AM43, components/sensor/am43, am43.jpg, Lux + APDS9306, components/sensor/apds9306, apds9306.png, Lux + APDS9960, components/sensor/apds9960, apds9960.jpg, Colour & Gesture + AS7341, components/sensor/as7341, as7341.jpg, Spectral Color Sensor + BH1750, components/sensor/bh1750, bh1750.jpg, Lux + LTR301, components/sensor/ltr501, ltr501.jpg, Lux + LTR303, components/sensor/ltr_als_ps, ltr303.jpg, Lux + LTR329, components/sensor/ltr_als_ps, ltr329.jpg, Lux + LTR390, components/sensor/ltr390, ltr390.jpg, Lux & UV + LTR501, components/sensor/ltr501, ltr501.jpg, Lux & Proximity + LTR553, components/sensor/ltr_als_ps, ltr-ps.jpg, Lux & Proximity + LTR556, components/sensor/ltr_als_ps, ltr-ps.jpg, Lux & Proximity + LTR558, components/sensor/ltr501, ltr501.jpg, Lux & Proximity + LTR559, components/sensor/ltr_als_ps, ltr559.jpg, Lux & Proximity + LTR659, components/sensor/ltr_als_ps, ltr-ps.jpg, Proximity + 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 + VEML3235, components/sensor/veml3235, veml3235.jpg, Lux + VEML6030, components/sensor/veml7700, veml6030.jpg, Lux + VEML7700, components/sensor/veml7700, veml7700.jpg, Lux + +Magnetic +******** + +.. imgtable:: + + AS5600, components/sensor/as5600, as5600.jpg, 12-Bit Magnetic Position Sensor + ESP32 Hall Sensor, components/sensor/esp32_hall, magnet.svg, ESP internal, dark-invert + HMC5883L, components/sensor/hmc5883l, hmc5883l.jpg, 3-Axis magnetometer + MLX90393, components/sensor/mlx90393, mlx90393.jpg, 3-Axis magnetometer + MMC5603, components/sensor/mmc5603, mmc5603.jpg, 3-Axis magnetometer + MMC5983, components/sensor/mmc5983, mmc5983.jpg, 3-Axis magnetometer + QMC5883L, components/sensor/qmc5883l, qmc5883l.jpg, 3-Axis magnetometer + +Miscellaneous +************* + +.. imgtable:: + + AS3935, components/sensor/as3935, as3935.jpg, Storm lightning + b-parasite, components/sensor/b_parasite, b_parasite.jpg, Moisture & Temperature & Humidity & Light + Binary Sensor Map, components/sensor/binary_sensor_map, binary_sensor_map.jpg, Map binary to value + Combination, components/sensor/combination, function.svg, dark-invert + Duty Time, components/sensor/duty_time, timer-play-outline.svg, dark-invert + EZO sensor circuits, components/sensor/ezo, ezo-ph-circuit.png, (pH) + FS3000, components/sensor/fs3000, fs3000.jpg, Air velocity + GDK101, components/sensor/gdk101, gdk101.jpg, Radiation + Growatt Solar, components/sensor/growatt_solar, growatt.jpg, Solar rooftop + Havells Solar, components/sensor/havells_solar, havellsgti5000d_s.jpg, Solar rooftop + Integration, components/sensor/integration, sigma.svg, dark-invert + Kuntze pool sensor, components/sensor/kuntze, kuntze.jpg + LVGL widget, components/sensor/lvgl, lvgl_c_num.png + M5Stack Unit 8 Angle, components/sensor/m5stack_8angle, m5stack_8angle.png + MAX17043, components/sensor/max17043, max17043.jpg, Battery + MicroNova pellet stove, components/micronova, micronova.svg + Modbus Sensor, components/sensor/modbus_controller, modbus.png + Nextion, components/sensor/nextion, nextion.jpg, Sensors from display + Person Sensor (SEN21231), components/sensor/sen21231, sen21231.png + Resol VBus, components/vbus, resol_deltasol_bs_plus.jpg + Rotary Encoder, components/sensor/rotary_encoder, rotary_encoder.jpg + SMT100, components/sensor/smt100, smt100.jpg, Moisture & Temperature + Tuya Sensor, components/sensor/tuya, tuya.png + TX20, components/sensor/tx20, tx20.jpg, Wind speed & Wind direction + uFire EC sensor, components/sensor/ufire_ec, ufire_ec.png, EC & Temperature + uFire ISE sensor, components/sensor/ufire_ise, ufire_ise.png, pH & Temperature + WireGuard, components/wireguard, wireguard_custom_logo.svg, dark-invert + +Motion +****** + +.. imgtable:: + + APDS9960, components/sensor/apds9960, apds9960.jpg, Colour & Gesture + BMI160, components/sensor/bmi160, bmi160.jpg, Accelerometer & Gyroscope + LD2410, components/sensor/ld2410, ld2410.jpg, Motion & Presence + LD2420, components/sensor/ld2420, ld2420.jpg, Motion & Presence + 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 + Seeed Studio MR24HPC1 mmWave, components/seeed_mr24hpc1, seeed-mr24hpc1.jpg, Motion & Presence + +Thermocouple +************ + +.. imgtable:: + + KMeterISO, components/sensor/kmeteriso, kmeteriso.jpg, K-Type, + 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, + MCP9600, components/sensor/mcp9600, mcp9600.jpg, All types + +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 ` together with a formula like in the `TEMT6000 +configuration `__. + + +Binary Sensor Components +------------------------ + +Binary Sensors are organized into categories; if a given sensor fits into more than one category, it will appear multiple times. + +Core +**** + +.. imgtable:: + + Binary Sensor Core, components/binary_sensor/index, folder-open.svg, dark-invert + Template Binary Sensor, components/binary_sensor/template, description.svg, dark-invert + GPIO, components/binary_sensor/gpio, gpio.svg + Home Assistant, components/binary_sensor/homeassistant, home-assistant.svg, dark-invert + Status, components/binary_sensor/status, server-network.svg, dark-invert + Switch, components/binary_sensor/switch, electric-switch.svg, dark-invert + Host SDL2, components/binary_sensor/sdl, sdl.png + +Capacitive Touch +**************** + +.. imgtable:: + + CAP1188 Capacitive Touch Sensor, components/binary_sensor/cap1188, cap1188.jpg + ESP32 Touch Pad, components/binary_sensor/esp32_touch, touch.svg, dark-invert + MPR121 Capacitive Touch Sensor, components/binary_sensor/mpr121, mpr121.jpg + TTP229, components/binary_sensor/ttp229, ttp229.jpg + +Mechanical +********** + +.. imgtable:: + + Matrix Keypad, components/matrix_keypad, matrix_keypad.jpg + TM1637, components/display/tm1637, tm1637.jpg + TM1638, components/display/tm1638, tm1638.jpg + +NFC/RFID +******** + +Often known as "tag" or "card" readers within the community. + +.. imgtable:: + + NFC Tag, components/binary_sensor/nfc, nfc.png, dark-invert + PN532, components/binary_sensor/pn532, pn532.jpg + PN7150, components/pn7150, pn7150.jpg + PN716X, components/pn7160, pn716x.jpg + RC522, components/binary_sensor/rc522, rc522.jpg + RDM6300, components/binary_sensor/rdm6300, rdm6300.jpg + Wiegand Reader, components/wiegand, wiegand.jpg + +Touchscreen +*********** + +.. imgtable:: + + Touchscreen Core, components/touchscreen/index, touch.svg, dark-invert + FT5X06, components/touchscreen/ft5x06, indicator.jpg + GT911, components/touchscreen/gt911, esp32_s3_box_3.png + Nextion Binary Sensor, components/binary_sensor/nextion, nextion.jpg + TT21100, components/touchscreen/tt21100, esp32-s3-korvo-2-lcd.png + LVGL widget, components/binary_sensor/lvgl, lvgl_c_bns.png + +Presence Detection +****************** + +.. imgtable:: + + AT581X, components/at581x, at581x.png + DFRobot mmWave Radar, components/dfrobot_sen0395, dfrobot_sen0395.jpg + LD2410, components/sensor/ld2410, ld2410.jpg + LD2420, components/sensor/ld2420, ld2420.jpg + Seeed Studio MR24HPC1 mmWave, components/seeed_mr24hpc1, seeed-mr24hpc1.jpg + +Miscellaneous +************* + +.. imgtable:: + + Analog Threshold, components/binary_sensor/analog_threshold, analog_threshold.svg, dark-invert + ESP32 BLE Presence, components/binary_sensor/ble_presence, bluetooth.svg, dark-invert + Hydreon Rain Sensor Binary Sensor, components/binary_sensor/hydreon_rgxx, hydreon_rg9.jpg + Modbus Binary Sensor, components/binary_sensor/modbus_controller, modbus.png + PipSolar - compatible PV Inverter, components/pipsolar, pipsolar.jpg + Pylontech Batteries, components/pylontech, pylontech.jpg + Qwiic PIR Motion, components/binary_sensor/qwiic_pir, qwiic_pir.jpg + Resol VBus, components/vbus, resol_deltasol_bs_plus.jpg + Tuya Binary Sensor, components/binary_sensor/tuya, tuya.png + WireGuard, components/wireguard, wireguard_custom_logo.svg, dark-invert + +Alarm Control Panel Components +------------------------------ + +.. imgtable:: + + Alarm Control Panel Core, components/alarm_control_panel/index, alarm-panel.svg, dark-invert + Template Alarm Control Panel, components/alarm_control_panel/template, description.svg, dark-invert + +Audio ADC Components +-------------------- + +.. imgtable:: + + Audio ADC Core, components/audio_adc/index, audio_adc.svg + ES7210, components/audio_adc/es7210, es7210.svg + ES7243E, components/audio_adc/es7243e, es7243e.svg + +Audio DAC Components +-------------------- + +.. imgtable:: + + Audio DAC Core, components/audio_dac/index, audio_dac.svg + AIC3204, components/audio_dac/aic3204, aic3204.svg + ES8156, components/audio_dac/es8156, es8156.svg + ES8311, components/audio_dac/es8311, es8311.svg + +Button Components +----------------- + +.. imgtable:: + + Button Core, components/button/index, folder-open.svg, dark-invert + Template Button, components/button/template, description.svg, dark-invert + Factory Reset Button, components/button/factory_reset, restart-alert.svg, dark-invert + Generic Output Button, components/button/output, upload.svg, dark-invert + Restart Button, components/button/restart, restart.svg, dark-invert + Safe Mode Button, components/button/safe_mode, restart-alert.svg, dark-invert + Shutdown Button, components/button/shutdown, power_settings.svg, dark-invert + UART Button, components/button/uart, uart.svg + Wake-on-LAN, components/button/wake_on_lan, power_settings.svg, dark-invert + +Climate Components +------------------ + +.. imgtable:: + + Climate Core, components/climate/index, folder-open.svg, dark-invert + Anova Cooker, components/climate/anova, anova.png + Bang Bang Controller, components/climate/bang_bang, air-conditioner.svg, dark-invert + BedJet Climate System, components/climate/bedjet, bedjet.png + Haier Climate, components/climate/haier, haier.svg + IR Remote Climate, components/climate/climate_ir, air-conditioner-ir.svg, dark-invert + Midea, components/climate/midea, midea.svg + PID Controller, components/climate/pid, function.svg, dark-invert + Thermostat Controller, components/climate/thermostat, air-conditioner.svg, dark-invert + Tuya Climate, components/climate/tuya, tuya.png + Uponor Smatrix Base Pulse Underfloor Heating, components/uponor_smatrix, uponor.svg + +Cover Components +---------------- + +.. imgtable:: + + Cover Core, components/cover/index, folder-open.svg, dark-invert + Template Cover, components/cover/template, description.svg, dark-invert + AM43 Cover, components/cover/am43, am43.jpg + Current-Based Cover, components/cover/current_based, flash.svg, dark-invert + Endstop Cover, components/cover/endstop, electric-switch.svg, dark-invert + Feedback Cover, components/cover/feedback, feedback_cover.svg, dark-invert + HE60R Cover, components/cover/he60r, he60r.jpg + Time-Based Cover, components/cover/time_based, timer.svg, dark-invert + Tuya Cover, components/cover/tuya, tuya.png + +Datetime Components +------------------- + +.. imgtable:: + + Datetime Core, components/datetime/index, clock-outline.svg, dark-invert + Template Datetime, components/datetime/template, description.svg, dark-invert + +Display Components +------------------ + +.. imgtable:: + + Display Core, components/display/index, folder-open.svg, dark-invert + Font Renderer, components/font, format-font.svg, dark-invert + Graph, components/graph, chart-line.svg, dark-invert + QR Code, components/qr_code, qr-code.svg, dark-invert + Image, components/image, image-outline.svg, dark-invert + Animation, components/animation, image-multiple-outline.svg, dark-invert + Online Image, components/online_image, image-sync-outline.svg, dark-invert + Display Menu Core, components/display_menu/index, folder-open.svg, dark-invert + Graphical Display Menu, components/display_menu/graphical_display_menu, graphical_display_menu.png + LCD Menu, components/display_menu/lcd_menu, lcd_menu.png + LVGL Graphics, components/lvgl/index, lvgl.png + +.. _display-hw: + +Display Hardware Platforms +-------------------------- + +.. imgtable:: + + Addressable Light, components/display/addressable_light, addressable_light.jpg + ILI9xxx, components/display/ili9xxx, ili9341.jpg + ILI9341, components/display/ili9xxx, ili9341.svg + ILI9342, components/display/ili9xxx, ili9342.svg + ILI9481, components/display/ili9xxx, ili9481.svg + ILI9486, components/display/ili9xxx, ili9341.jpg + ILI9488, components/display/ili9xxx, ili9488.svg + WSPICOLCD, components/display/ili9xxx, ili9488.svg + Inkplate, components/display/inkplate6, inkplate6.jpg + LCD Display, components/display/lcd_display, lcd.jpg + MAX7219 Dot Matrix, components/display/max7219digit, max7219digit.jpg + MAX7219, components/display/max7219, max7219.jpg + Nextion, components/display/nextion, nextion.jpg + PCD8544 (Nokia 5110/ 3310), components/display/pcd8544, pcd8544.jpg + PVVX MiThermometer, components/display/pvvx_mithermometer, xiaomi_lywsd03mmc.jpg + Quad SPI Displays, components/display/qspi_dbi, t4-s3.jpg + RPI_DPI_RGB, components/display/rpi_dpi_rgb, waveshare_touch-s3.jpg + SSD1306, components/display/ssd1306, ssd1306.jpg + SSD1322, components/display/ssd1322, ssd1322.jpg + SSD1325, components/display/ssd1325, ssd1325.jpg + SSD1327, components/display/ssd1327, ssd1327.jpg + SSD1331, components/display/ssd1331, ssd1331.jpg + SSD1351, components/display/ssd1351, ssd1351.jpg + ST7567, components/display/st7567, st7567.jpg + ST7701S, components/display/st7701s, indicator.jpg + ST7735, components/display/st7735, st7735.jpg + ST7789V, components/display/st7789v, st7789v.jpg + ST7796, components/display/ili9xxx, st7796.svg + ST7920, components/display/st7920, st7920.jpg + TM1621, components/display/tm1621, tm1621.jpg + TM1637, components/display/tm1637, tm1637.jpg + TM1638, components/display/tm1638, tm1638.jpg + TM1651 Battery Display, components/tm1651, tm1651_battery_display.jpg + Waveshare E-Paper, components/display/waveshare_epaper, waveshare_epaper.jpg + Host SDL2 display, components/display/sdl, sdl.png + +Electromechanical +----------------- + +.. imgtable:: + + Atlas Scientific Peristaltic Pump, components/ezo_pmp, ezo-pmp.jpg + Grove TB6612FNG, components/grove_tb6612fng, motor.png, dark-invert + Matrix Keypad, components/matrix_keypad, matrix_keypad.jpg + RTTTL Buzzer, components/rtttl, buzzer.jpg + Servo, components/servo, servo.svg + Stepper, components/stepper/index, stepper.svg + +Energy/Solar Management +----------------------- + +.. imgtable:: + + PipSolar-compatible PV Inverter, components/pipsolar, pipsolar.jpg + Power Supply, components/power_supply, power.svg, dark-invert + Resol VBus, components/vbus, resol_deltasol_bs_plus.jpg + SML, components/sml, sml.svg + SUN-GTIL2 inverter, components/sun_gtil2, sun_1000g2.png + +Event Components +---------------- + +.. imgtable:: + + Event Core, components/event/index, folder-open.svg, dark-invert + Template Event, components/event/template, description.svg, dark-invert + +Fan Components +-------------- + +.. imgtable:: + + Fan Core, components/fan/index, folder-open.svg, dark-invert + Template Fan, components/fan/template, description.svg, dark-invert + Binary Fan, components/fan/binary, fan.svg, dark-invert + H-bridge Fan, components/fan/hbridge, fan.svg, dark-invert + Speed Fan, components/fan/speed, fan.svg, dark-invert + Tuya Fan, components/fan/tuya, tuya.png + +Home Assistant Components +------------------------- + +Components specifically for interacting with Home Assistant. + +.. imgtable:: + + Binary Sensor, components/binary_sensor/homeassistant, home-assistant.svg, dark-invert + Bluetooth Proxy, components/bluetooth_proxy, bluetooth.svg, dark-invert + micro Wake Word, components/micro_wake_word, voice-assistant.svg, dark-invert + Number, components/number/homeassistant, home-assistant.svg, dark-invert + Sensor, components/sensor/homeassistant, home-assistant.svg, dark-invert + Switch, components/switch/homeassistant, home-assistant.svg, dark-invert + Text Sensor, components/text_sensor/homeassistant, home-assistant.svg, dark-invert + Voice Assistant, components/voice_assistant, voice-assistant.svg, dark-invert + +Light Components +---------------- + +.. imgtable:: + + Light Core, components/light/index, folder-open.svg, dark-invert + Beken SPI, components/light/beken_spi_led_strip, color_lens.svg, dark-invert + Binary Light, components/light/binary, lightbulb.svg, dark-invert + Cold+Warm White Light, components/light/cwww, brightness-medium.svg, dark-invert + Color Temperature Light, components/light/color_temperature, brightness-medium.svg, dark-invert + ESP32 RMT, components/light/esp32_rmt_led_strip, color_lens.svg, dark-invert + FastLED Light, components/light/fastled, color_lens.svg, dark-invert + H-bridge Light, components/light/hbridge, brightness-medium.svg, dark-invert + Light Partition, components/light/partition, color_lens.svg, dark-invert + LightWaveRF, components/lightwaverf, brightness-medium.svg, dark-invert + LVGL widget, components/light/lvgl, lvgl_c_lig.png + Monochromatic Light, components/light/monochromatic, brightness-medium.svg, dark-invert + NeoPixelBus Light, components/light/neopixelbus, color_lens.svg, dark-invert + RGB Light, components/light/rgb, rgb.png + RGBCT Light, components/light/rgbct, rgbw.png + RGBW Light, components/light/rgbw, rgbw.png + RGBWW Light, components/light/rgbww, rgbw.png + RP2040 PIO, components/light/rp2040_pio_led_strip, color_lens.svg, dark-invert + Shelly Dimmer, components/light/shelly_dimmer, shellydimmer2.jpg + Sonoff D1 Dimmer, components/light/sonoff_d1, sonoff_d1.jpg + SPI LED Strips, components/light/spi_led_strip, apa102.jpg + Status Led, components/light/status_led, led-on.svg, dark-invert + Tuya Dimmer, components/light/tuya, tuya.png + +**Looking for WS2811 and similar individually addressable lights?** For the ESP32 and its variants, we recommend the +:doc:`light/esp32_rmt_led_strip` or :doc:`light/spi_led_strip`; for other processors, have a look at the +:doc:`FastLED Light `. + +Lock Components +--------------- + +.. imgtable:: + + Lock Core, components/lock/index, folder-open.svg, dark-invert + Template Lock, components/lock/template, description.svg, dark-invert + Generic Output Lock, components/lock/output, upload.svg, dark-invert + +Media Player Components +----------------------- + +.. imgtable:: + + Media Player Core, components/media_player/index, folder-open.svg, dark-invert + DFPlayer, components/dfplayer, dfplayer.svg, dark-invert + I2S Audio, components/media_player/i2s_audio, i2s_audio.svg + Speaker, components/media_player/speaker, speaker.svg + +Microphone Components +--------------------- + +.. imgtable:: + + Microphone Core, components/microphone/index, microphone.svg, dark-invert + I2S Microphone, components/microphone/i2s_audio, i2s_audio.svg + +Number Components +----------------- + +.. imgtable:: + + Number Core, components/number/index, folder-open.svg, dark-invert + Template Number, components/number/template, description.svg, dark-invert + Home Assistant, components/number/homeassistant, home-assistant.svg, dark-invert + LVGL widget Number, components/number/lvgl, lvgl_c_num.png + Modbus Number, components/number/modbus_controller, modbus.png + Tuya Number, components/number/tuya, tuya.png + +Output Components +----------------- + +.. imgtable:: + + Output Core, components/output/index, folder-open.svg, dark-invert + Template Output, components/output/template, description.svg, dark-invert + AC Dimmer, components/output/ac_dimmer, ac_dimmer.svg, dark-invert + BLE Binary Output, components/output/ble_client, bluetooth.svg, dark-invert + BP1658CJ, components/output/bp1658cj, bp1658cj.svg + BP5758D, components/output/bp5758d, bp5758d.svg + DAC7678, components/output/dac7678, dac7678.svg + EMC2101, components/emc2101, emc2101.jpg + ESP32 DAC, components/output/esp32_dac, dac.svg + ESP32 LEDC, components/output/ledc, pwm.png + ESP8266 Software PWM, components/output/esp8266_pwm, pwm.png + GP8403, components/output/gp8403, gp8403.svg + GPIO Output, components/output/gpio, gpio.svg + LibreTiny PWM, components/output/libretiny_pwm, pwm.png + MCP4725, components/output/mcp4725, mcp4725.jpg + MCP4728, components/output/mcp4728, mcp4728.jpg + MCP47A1, components/output/mcp47a1, mcp47a1.svg + Modbus Output, components/output/modbus_controller, modbus.png + MY9231/MY9291, components/output/my9231, my9231.svg + PCA9685, components/output/pca9685, pca9685.jpg + Sigma-Delta Output, components/output/sigma_delta_output, sigma-delta.svg, dark-invert + Slow PWM, components/output/slow_pwm, pwm.png + SM16716, components/output/sm16716, sm16716.svg + SM2135, components/output/sm2135, sm2135.svg + SM2235, components/output/sm2235, sm2235.svg + SM2335, components/output/sm2335, sm2335.svg + TLC59208F, components/output/tlc59208f, tlc59208f.jpg + TLC5947, components/output/tlc5947, tlc5947.jpg + TLC5971, components/output/tlc5971, tlc5971.jpg + X9C Potentiometer, components/output/x9c, x9c.jpg + +Select Components +----------------- + +.. imgtable:: + + Select Core, components/select/index, folder-open.svg, dark-invert + Template Select, components/select/template, description.svg, dark-invert + LVGL widget Select, components/select/lvgl, lvgl_c_sel.png + Modbus Select, components/select/modbus_controller, modbus.png + Tuya Select, components/select/tuya, tuya.png + +Speaker Components +------------------ + +.. imgtable:: + + Speaker Core, components/speaker/index, speaker.svg, dark-invert + I2S Speaker, components/speaker/i2s_audio, i2s_audio.svg + Mixer Speaker, components/speaker/mixer, mixer.svg + Resampler Speaker, components/speaker/resampler, waveform.svg, dark-invert + +Switch Components +----------------- + +.. imgtable:: + + Switch Core, components/switch/index, folder-open.svg, dark-invert + Template Switch, components/switch/template, description.svg, dark-invert + BLE Client Switch, components/switch/ble_client, bluetooth.svg, dark-invert + Factory Reset Switch, components/switch/factory_reset, restart-alert.svg, dark-invert + Generic Output Switch, components/switch/output, upload.svg, dark-invert + GPIO Switch, components/switch/gpio, gpio.svg + H-bridge Switch, components/switch/hbridge, hbridge-relay.jpg + LVGL Widget, components/switch/lvgl, lvgl_c_swi.png + Modbus Switch, components/switch/modbus_controller, modbus.png + Nextion Switch, components/switch/nextion, nextion.jpg + Restart Switch, components/switch/restart, restart.svg, dark-invert + Safe Mode Switch, components/switch/safe_mode, restart-alert.svg, dark-invert + Shutdown Switch, components/switch/shutdown, power_settings.svg, dark-invert + Tuya Switch, components/switch/tuya, tuya.png + UART Switch, components/switch/uart, uart.svg + Home Assistant, components/switch/homeassistant, home-assistant.svg, dark-invert + +Text Components +--------------- + +.. imgtable:: + + Text Core, components/text/index, folder-open.svg, dark-invert + Template Text, components/text/template, description.svg, dark-invert + LVGL textarea Text, components/text/lvgl, lvgl_c_txt.png + +Text Sensor Components +---------------------- + +.. imgtable:: + + Text Sensor Core, components/text_sensor/index, folder-open.svg, dark-invert + Template Text Sensor, components/text_sensor/template, description.svg, dark-invert + BLE Scanner, components/text_sensor/ble_scanner, bluetooth.svg, dark-invert + Ethernet Info, components/text_sensor/ethernet_info, ethernet.svg, dark-invert + Home Assistant, components/text_sensor/homeassistant, home-assistant.svg, dark-invert + LibreTiny, components/text_sensor/libretiny, libretiny.svg + LVGL textarea Text Sensor, components/text_sensor/lvgl, lvgl_c_txt.png + Modbus Text Sensor, components/text_sensor/modbus_controller, modbus.png + MQTT Subscribe Text, components/text_sensor/mqtt_subscribe, mqtt.png + Nextion Text Sensor, components/text_sensor/nextion, nextion.jpg + Tuya Text Sensor, components/text_sensor/tuya, tuya.png + Version, components/text_sensor/version, new-box.svg, dark-invert + WiFi Info, components/text_sensor/wifi_info, network-wifi.svg, dark-invert + WireGuard, components/wireguard, wireguard_custom_logo.svg, dark-invert + WL-134 Pet Tag Sensor , components/text_sensor/wl_134, fingerprint.svg, dark-invert + +Time Components +--------------- + +.. imgtable:: + + Time Core, components/time/index, clock-outline.svg, dark-invert + DS1307 RTC, components/time/ds1307, clock-outline.svg, dark-invert + GPS Time, components/time/gps, crosshairs-gps.svg, dark-invert + Home Assistant Time, components/time/homeassistant, home-assistant.svg, dark-invert + PCF85063 RTC, components/time/pcf85063, clock-outline.svg, dark-invert + PCF8563 RTC, components/time/pcf8563, clock-outline.svg, dark-invert + SNTP, components/time/sntp, clock-outline.svg, dark-invert + +Touchscreen Components +---------------------- + +.. imgtable:: + + Touchscreen Core, components/touchscreen/index, folder-open.svg, dark-invert + AXS15231, components/touchscreen/axs15231, axs15231.svg + CST226, components/touchscreen/cst226, t4-s3.jpg + CST816, components/touchscreen/cst816, cst816.jpg + EKTF2232, components/touchscreen/ektf2232, ektf2232.svg, Inkplate 6 Plus + FT63X6, components/touchscreen/ft63x6, wt32-sc01.png + GT911, components/touchscreen/gt911, esp32_s3_box_3.png + Lilygo T5 4.7", components/touchscreen/lilygo_t5_47, lilygo_t5_47_touch.jpg + TT21100, components/touchscreen/tt21100, esp32-s3-korvo-2-lcd.png + XPT2046, components/touchscreen/xpt2046, xpt2046.jpg + +Valve Components +---------------- + +.. imgtable:: + + Valve Core, components/valve/index, folder-open.svg, dark-invert + Template Valve, components/valve/template, description.svg, dark-invert + +Wireless Communication +---------------------- + +Used for creating infrared (IR) or radio frequency (RF) remote control transmitters and/or receivers, or to connect +ESPHome to cellular networks. **Does not encompass Wi-Fi.** + +.. imgtable:: + + IR Remote Climate, components/climate/climate_ir, air-conditioner-ir.svg, dark-invert + Remote Receiver, components/remote_receiver, remote.svg, dark-invert + Remote Transmitter, components/remote_transmitter, remote.svg, dark-invert + RF Bridge, components/rf_bridge, rf_bridge.jpg + SIM800L, components/sim800l, sim800l.jpg + +Miscellaneous Components +------------------------ + +.. imgtable:: + + ESP32 Camera, components/esp32_camera, camera.svg, dark-invert + Exposure Notifications, components/exposure_notifications, exposure_notifications.png + GPS, components/gps, crosshairs-gps.svg, dark-invert + Grow Fingerprint Reader, components/fingerprint_grow, fingerprint.svg, dark-invert + Modbus Controller, components/modbus_controller, modbus.png + Sprinkler, components/sprinkler, sprinkler-variant.svg, dark-invert + Status LED, components/status_led, led-on.svg, dark-invert + Sun, components/sun, weather-sunny.svg, dark-invert + Tuya MCU, components/tuya, tuya.png + +.. _cookbook: + +Cookbook +-------- + +.. imgtable:: + + Lambda Magic: Tips and Tricks, cookbook/lambda_magic, head-lightbulb-outline.svg, dark-invert + LVGL Recipes, cookbook/lvgl, lvgl.png + Garage Door Template Cover, cookbook/garage-door, garage-variant.svg, dark-invert + Time & Temperature on OLED Display, cookbook/display_time_temp_oled, display_time_temp_oled_2.jpg + ESP32 Water Leak Detector, cookbook/leak-detector-m5stickC, leak-detector-m5stickC_main_index.jpg + BME280 Environment extras, cookbook/bme280_environment, bme280.jpg + Non-Invasive Power Meter, cookbook/power_meter, power_meter.jpg + Sonoff Fishpond Pump, cookbook/sonoff-fishpond-pump, cookbook-sonoff-fishpond-pump.jpg + Arduino Port Extender, cookbook/arduino_port_extender, arduino_logo.svg + EHMTX a matrix status/text display, cookbook/ehmtx, ehmtx.jpg + +Contributing +------------ + +ESPHome depends on and welcomes contributions from our community. If you'd like to contribute, please see +:doc:`Contributing `. .. toctree:: - :maxdepth: 3 :glob: + :hidden: binary_sensor/index canbus/index diff --git a/guides/contributing.rst b/guides/contributing.rst index 1f46aea69..45bae6379 100644 --- a/guides/contributing.rst +++ b/guides/contributing.rst @@ -18,7 +18,6 @@ Contributing to ``esphome-docs`` .. image:: /images/logo-docs.svg :align: center :width: 60.0% - :class: dark-invert Our documentation can always be improved. We rely on contributions from our users to do so. If you notice an issue (for example, spelling/grammar mistakes) or if you want to share your awesome new setup, we encourage you to submit a pull diff --git a/images/xiaomi_lywsd03mmc.jpg b/images/xiaomi_lywsd03mmc.jpg new file mode 100644 index 0000000000000000000000000000000000000000..63089769420dcd36f82b746d3c649d5a7342d900 GIT binary patch literal 9032 zcmbVxc|4R~)c9i=vSgAq+epclifli}?uNB-aXc^>t@ad-iMSK>eXSZ{#;Z+v)67^Fuu z06_V_f58U;APBef@6*-QN#^;h&cn+GcZWOj!(Sl*guuV; z|LY1g3e$*$ngH=l03D$7@u&d2;yirfJkUFyTv(upzbO2NXqZlzFu_ei!XjG$ULHO^ zUVc6VOfQTX@mnnX;)t!=b<6}L?A--b0wi^BCqLV?<4Ae4)TwUz&ix)YqJ)H{Wn{O> zsqRu!*U;3{H!w6hV0`osa|_F3$E_SrJDzbmd(PSO;-$-1yu5t^gMvds!)}I0--)>! z8+R}MValV_wDiYMGII0s3kr*#zbJlPQCU@8Q~Rc_h4SuwE48it1Ffg`OJD!M;Lyb6 z)bzLSGqZC)7)#45tIRcUeFI*nzu19)|KjL>@FNcM!^_Xl$1nJsA0FONxbTVdBev@Z zY&EkNbPteF(Y?J%@<{Tt@@AnO`%lrOJZ^LgOYhX1P-XmP=}(UScML`SpE&xLp?~>- zh5%7M9(cj{!~rzG<*Mh#1OL|oef}T)i~9{jm;viGd&DgR&qut#9_uMROTDt~(MC3c z$CLJ)wADX86at!kQQy6Z^vYHA`f9?mo*1>({`@uw5V1YG;D`L)i;Q<}A9pzl0R%hg zL!I&TLXcRxRvn2SJ58iltUfppwU-hsE&i+5DH;M=y7~_u-Nc?lzT@C??jrl1My_RO z&8(Yh{w!C}+egenPn|$X2RG7>uA>;aO%a0TSSC)}mq_79CqsZ726Qq0j_&>MJjPH!Hert$Z33Qq-jiU zV>krFRFLppvcF$a7@qG?6j9XgNq`NNc)AGwet66q)KEBX<(K<4%W>b{dYvhMB=}lo z=)_>MDci=NjqHf-i3fgq{k;}Y_g`|=6nR1$lFm39nTJlbbyXuQI`{l>@o4mR5ztOZ z>G-7WR=1yqS7j$vjU1V;Tuig)|8M20cxZ5UoPPG^*QN za+9vlJ(m)Z=c|6I?2^X^EKqG5(Q{7EbIzDn(9`3T8K%+xrDjb}aF@70#kS#jwF*c8 zsD|^b{SvelcXo8o7JR>171@!5&yQ+0mvrERXn(P$^}%#k+t}rrgmTaGr1O>xy~%@@ z*7U^G60^nB3l4d!8u5B4q?Sb>(*PfeiQQ&-m8@ZV;@fC5p=!x4NE9T z@}?OX$?|`WyHQ;J4$T=Do3%g)VCbXRCc{&JLfHOe5YW^? z;HnV&R8$iRaXlA<@^|M&W8%s5<-PZB)zU+fQy{=L6vZ~zgSWUfS9ivn9+Cu)@n@S; zbzH=?CoDttgGsjE?473e zt+R0Gz4D*W{^v0*8QYo5zXVqbKGr4ttn3;(5=bpj#ip|Ma=&C4E+GAG=3@r%9$@TA zv)xP&TLX>lYW|u0cQlk01kM1jEbYulrC!GF`l?|uYE|02QAxuSdX1KZ?{WAJ-yIN; zWCUx*Mtq|aco_f*V(6Jpe~ysWkND&F;eF_VhI;ESJUePkzc*Z~PoMN5stiCt zrI&&mLGF;ZhOM*J<`iM>Ir4aU%89Y+kQfmi^*RL?r?Pc|54TWj-5uuSy#@r_?fD$| zc~%EMdwStnm&?SJG`3+oO)}i6P(v_E3*Ia>Y^%fiv-M7*E8!@;_DtdZNvT_3OSeg? z^DH~?HoR~i(h*N4)EO1ne{l8orFd=hm?V=zcWEJe8T%kbx(VbANfR*6!UN|led z`tcR%?usur6V0H?Nh@SxjC*uAH&-d{8C?a0)QB+G{1R9)4z) zp(yg^l8zNsivAQ=e9QY9DyF=PO=~P6rQ+o9?MG`MfOG%?R(6t#i#^{8NZOm*5uo0G z)DEYHr&iUlS{t0}^CoY;Z+H#?-p}PsTvzk|RJ$WVq;Djyh(a;?YL{5{%wfVxAf}fj zAAsoyWlP(K;0BdsweRCE?B(7so(=3DK1$`v^VV5KcWNzLG6|d%{CIA7`aA0eJo5_p z$;24JPSl;NYZ$yepOE!9FYVy*JLS9qN=IJ5;?cg}KS!Y4khdB+WJI!Z@3i!p&g`Q` z78`w-8Q;!%2m#}jA`qaDw}JKPC6WD-r18bXpA~^?$5%SFKmZ^62KaPu+@gv5%X1b( z5tX^OB+DKyX&tYhdH7X2dF&HsD7WzAwViaW4I924#7R<h=hSyscFp@K^;@$}^y4qzQ(1l`kEQtm*OJS0sV|Ha`iRQBz;Ad5jpZUU=DH`n5pN%yUc4td^D*v1 z+4PnVJdAVXi+FJNM~Av*MpDb^Q%A_m{1>%ivHnc&Vd9Cbpid64Hqpkhmp~+8oznmT zv;|#qjzqs?pjWVQ)}yJ5I6mT_C09hzD>1Z$eYw24GUh~zRmP(VU5n_z*HlhcW}Dsh zx9Nv;wP1q-?xa#7;2s)<69YSSHoUCrnxs9dDdVK=4fq zUQpXc>LE%)K--IAe1BpW_g*;L38qF0-_Fm-KIm&e-0-U@ir^ax?D5OTO{X@sFAT*r zp;LD}wCG;2j*1VYRlI5GszhJd16#ZUQ>w3_VO^2^xhB-O z8ZL{!!_nHcWlXSp%wztVU5ag`r^1$Lpg<>xX`?C1-)#wQCM-z z9X{2>p)dcam#G@V&yUL>IgxgOLXTDeLUQ5?H;$_qTEtp4J&%QC3$3n>PBtrN1YD zn&f-hCYaz$to>}mTJYXP=JCxW=IYzgs`@p1g%b}-pO&_Y8&N*kwLk5CLGZ1a!`(SX z7swB2u7J7d-it{g(~oFe#6)uS>}&+8u8csyXM?YA6kiQa9?_}DblHZcGf_i15b%ko zfn7!9p6Ne0K@w&A!7_hPTGsDvLmWMrRrbTy!S{+E?5~?Uz{nUPNreoQ?0(DF@%O0@?ClDZPUEl0L(h z6q)FZHcTA=;+6nRQC&9Dd^Pm}o$aT&slhSYDQ=FqmD!AQ^(Wh=NESNMS ziJEhEk_jI#I2vZ{ncUal#WEIoYV4ot;<=XMrKZ2dqnNkvjzU10>={mOX@?m8^&)vik~B=yd5_!9ZNhT9_xa6m zRnzkzK+%fRaCIhIt1h-Bd=THHDrxVe=2`obD+gO~5n<%UGI6~i!U3a&-H&2iS4OYQ z{i*on=Eu*%?#e|X)c2q2-*+B1%#&LUUn1YjiHJwO$a$Xk9_ehQUKpPi=Y1#!zlTge zmrG^7qsO_o(cz<_dzE9Jo#nK&46o~xQ|POqKF;bH)c`K5X(b+ORWq^Hw@ITJYz?h(F^Hr^GqB) zYk|2&*L~wE$Bp7DS&(wqbwx`=FRY=s#dHxes1`eK`P}W(b2s+>ZYA&0{J?Mf5Ra$n zvOHbxO$)BN-fl|z2U;~+EmKKssZ6FAKLotTgo3kmMG&yVsRzYF_C*b@F*B0ZxRRte zk1s_%^lRGL8l~4fEhb!>uP3*ct%%9^U+vF8fod}I`vM?9y2BjB{6q$e7q|-CR@CeM z7L<%j*wh3eDrf=eR5hYfS1I;Tvu@!MYe3Tyacsv>idDbG4JPLDOdk6(I7QE6M$m6F z##$A9#{TFrjI;kf(xsO#EpE0|;NiJV{CCXN_zJbA@Zc?{c|`~~8vGSKFH($O(vPrb zM8nRA5QDqa!kSWxnP;2t${;Ads2BZe)n;}*avxuSV|%NOp!<1K{CF0=jA{#>G2SDX z?+-J4nw3{L=knE5i31xNfBfK4<^#^-`YUu#_;AJbOe$V`XX)-2?0M6pW^4ZQNy)VD zvQx_nd&EOGQ*WPVu>hI7#UMtw>h1?BdvS4&K!xi;d!E%AMW@O=F= zlyIXcdpEdaqJ~araTDt|>p6dPznM?1=uG0ftdu4ouxb2)<3Z<^VDINf%?fCWb%_fh z3BR>ed)_0;;6v>eD^)CQ|Hd>OkoD80YFL{R7J9aIi$SYhNRq&<09wOAN~6+eHtLy6m?tF!0xp-mHj~s5xV$Mk zH)=XdY=my4aN2byU2A|!#iJ|f5dgA-|i_B!jreb!Ih;O$=+ z1eCNIqbhAZc^jJ5l^)sKc+DR~-pxa88AttPd2$=ig5D6I%8T4sA+A#~4!xUyU-b!4 z|G#!f9l4_Azt*(`J0a@eGuR0^0|AQ}f)ek$oc#r|!h6hJEtO}r*0HcSKkE{PU}rQx zls=pc0k@?%W`-kZD=r2 zd9tWi0fU&i^FhC00<=P}3?II~+^G?IkzL>4jFLn9lVit(xXM1J!rgke#-y4j)OR#6 zB7UXc+wpnfQnIImGO+$oeV1ioz-v8^n>@C|rdt_Kck2TuI`+zj88a2Ft$LqXC%BY^ zASKIqM~mvkrqTGO_-(KWVrO!tN{dnRfU^t2WcKIgZ;=JwG){HV2m>Amh=x7F0K z*3oV8+VKl_q&me!#Po)pEJrt2)+&030ytbM!*Icnfq}hU1WpI5%1}%ysA$G*?;E2y zFGL@HS?CM4m%TYx-l+1hD9s|IdVEu-)`G}SEo;_+pyAmxuU!`LXGbobll8l_<8zYE z@y6UoyHm8Qn~WngOs}QV-KcB{U#4B%(-~>!X_tWq$zZJGA1AWoa%Y6|auj2*gz=IC zrgFHC5KvWfr(XVMg#VQZ--h#>)!T0dnDn(P5hV7se+zk__^vuMxR{V!Tp&|{_Gug8 zS&RpalmjqnXkPdVMjWfa5E_NT(5+nMntpk^K0O!tjucc}@Y&BDdYZo+5uK73>BeGF zFK=2IZR=;x34^(zyw7aPyzg8-Yq zntZ;?3#;coCj1k%)cU~P#qQg3doVG);HKrfa&9!zXdMCy5SD?hMmsY6jP5)5dd=_B zZ=Be0T7sj4h%8rJ|9QbKMwpK+?Fad}1uJ$A)3L~wzQwhfY0BdkJRz?f*L<<5op<71x9Fn(`kr-9YQoV2Ae&hRblPV8v=U%fFY}eG+2BonGuq!Gaz)p#w&e?o5bK&=-3mC(-HDY4 zF^p^4D#*BSJ!AOHTVrlyXUqiMa2|E8t3PGF^U}HNr!Scebu5)>y$>^_KmZaqX28|y zDFmNR68OK)YV7fMFQdJhd=pkqQ}c}~9&8ojzvVP|g?QEBTiLg;`K~VbSkf@)<7DsN zv&G{(S|-f9l=BC9$X*OB+CTOZl_j15x-hH3h$-TIyd+ngeSlV(`IaC$0LFzSobQzo z@e}q=u5doQ@Zem2)(c@CR{gls@LEcTudn{cef7WMI#mc>p~@FEe`&rsBybF6btB}A zLV6t`Iv8_%tma#1QD8tJHnhiYAwP9UmJqYuQ%?E=98K)(zD@L5r%W__A>JilCJ!Zb zOjf-HOB}ivSD#IaJl<9buBOSI_J5<|1_7QQZ+WhZa7H;cf@D`N4O0{E+7`4p*jBln zkamf2GU|XU`)#Uc@R?Ra#BQE(X+UBI#}95}OuZ)qcrRbrMtWoSlh~(;cEl4sYV}c5 z9llR>4_iueWM)qz-OG|SzMQPgjh`B(A-?W z-h1=gZzAfgm6(a*UxcWmqK8*WmpO@8MFzo!5&9l^k0{IDjoltF<#uD(uBK<`mwf9V z@vX9`wKBzm&}YLB@(B}C+Nx3N=j*Jq@S@I2u|n?$VB+v)D0bFvzP^@42r%zoSdRFy zKw+zu!bWaLJ-6ndP1gjGP52A}{rM2kX}pov=nP(g-SHLlDtswPYAkql9X4>0=zr1& zuz^!6E{%bszWy6d#ZKvLn;DygL2?0~Wt_wS?Nst-+L`Ww6TT6Y71B2rSHzsmmFsW1 zWr-2}1Y1E5@^k6m2JWLFTRPH@^Rf|@Hv4tk8|p+zWl^~lY~pYVv2w>eX$`7E!aTh7 zQxhLv&;Z4fZn~w^OwEhs3abqyj~UgKmU>|P6t57q$SQz>ElhEX$w^r2qUBw?Q8`t~ zrp#Go$$d1dyr>~LwMMt}x!3j4VD&|kv0RZnFs2=W*rCq*xJj%*qiKAaRwgPdDxi7f z=^SrB_M=$k`worKZZW5FZfM-08v#hG^UV#0K%|rJYk1;AQk=V=T8pjT_M4TeUPs zL9e5p{poZiHRiv<<-l=N0RM0LqJs;&^=$@w*QiS*JCYvw_z7*xhEa|ey`t}7bYJ}F z)$Pa=PTvLDlGaS|KD4iw$-ya1tP?ZCKc20{j8n1Z{Per&9axnu^KjoMiI;INA6|7& z{NVJ!@(04zaye(u2B+Q5KLiea!A`M zVB?(_2?4dEBnS}4kawo^JqVz^W{Mxc<(*&)VFogpbvtJ0PvfW@3qL%VA;VPXl&0BW zwJs4@qOj-3&}T7fd%T$9h^RtBQ#WfXx9?;}*qL|u5s!X2N(Z}s6mf2!Q5*d|fh(p> z1~WK|1^h{m(v-9=Y$WcdAIE#3hREEQOz{N{362rH>q%!SbBZ@mn+K7s1Q$F!{NS4x zx`7$EmhG$RsHiC>ic=i7&OYdI2tDcdyF)LLP9atq9H4X3xtrkzc!ufrf|1@^o1&X~ z(1PfRSiFw~fWH8H&EvGO-z4pw*Js)BMdu6<3XA-?QmiH+MRk~@Mv{2Mktg6Wv^!zw z7B@1@2)!y14dWMJ1~ANQ6GiDJ{D>8bP8x0aWbr+}jIp)pF!+{f&q>{5iZJ17GlEA9 z!$+r;j>V7d(h9mN!_y`|FfJMiDDKbdA6&^#>3djx|I`^vM`It&Hu&D3+u1RZ&VIBB z|FaX%5jNh)X!Haf1)oe6KEQVzRD%F&zCA~4?!(LqoK{ok`!}U=pYi2c9i9EwBE-FX zRI>7wn>gZ42>EpLa~;o&8l{z)pp@&Gz}gG$k7Y7B<%9QorA!M~{BW>Nt? zyU*e6iMlZS-~)dYQJ?`A53H}Scl28a1p6nA7=re2I*Q=Nm+%@Tn<0az zGa!J?c7cGYv58~2tzprXOn6(Yfli+*9cK7uh~Vk$?QoVBZp_3p;8g4jEPQ7^R7y60 zfJxukaCI054W9lAt7mrKSSGy1^%j3W@^SoXzQZG*jF2){7{|`QbLYKl!oRGBfJPYW z9-If6I1N^?nB=u#c;BwXNCw_s#wPYZDgU zkitdpAOGD+l1MK$acNcR{}a72IX54fNoXNThxlTC_ld`Vj;6b*U#s95han)2l&@ZN z-P9M(9Xn2K*{9UQW#PFhCCBL%RAF?`)d5yp6Mj}|WkJ#vnFVJRqra-Z@duxdQT$MA zeh=Q_$800fiy5n3qG1vgu7toz1C^dyN|(l%7V;!Dhv|y+nV-$)F_*OaT?GG$Pyb%2 J|4V@e{~!8vp_l*w literal 0 HcmV?d00001 diff --git a/index.rst b/index.rst index 868dfc7d0..7fd1847a6 100644 --- a/index.rst +++ b/index.rst @@ -9,12 +9,19 @@ for Home Automation. Just write a simple YAML configuration file and get your own customized firmware. :image: logo.svg -.. image:: /images/logo-text.svg +.. image:: images/logo-text.svg :class: logo -ESPHome is a system to control your microcontrollers by simple yet powerful configuration files and control them remotely through Home Automation systems. +ESPHome is a system which allows you to turn common microcontrollers into smart home devices. -.. image:: /images/hero.png +.. image:: images/hero.png + +It uses `YAML `__ configuration files and, based on the content of these file(s), +it creates custom firmware which you can then install directly onto your device. + +Hardware defined in the configuration--such as sensors, switches, lights, and so on--will automatically appear in +`Home Assistant's `__ user interface or can be made available via a simple web user interface +or MQTT. .. raw:: html @@ -42,6 +49,11 @@ ESPHome is a system to control your microcontrollers by simple yet powerful conf by migrating from Tasmota +
  • + + FAQ and Tips + + 
    • @@ -56,8 +68,8 @@ ESPHome is a system to control your microcontrollers by simple yet powerful conf
             
    Next steps
    -.. _devices: - -Supported Microcontrollers --------------------------- - -.. imgtable:: - - ESP32, components/esp32, esp32.svg - ESP8266, components/esp8266, esp8266.svg - RP2040, components/rp2040, rp2040.svg - BK72xx, components/libretiny, bk72xx.svg - RTL87xx, components/libretiny, rtl87xx.svg - Host, components/host, host.svg, dark-invert - -Microcontroller Peripherals ---------------------------- - -Peripherals which directly support the operation of the microcontroller's processor(s). - -.. imgtable:: - - PSRAM, components/psram, psram.svg - Deep Sleep, components/deep_sleep, hotel.svg, dark-invert - -ESPHome Automations -------------------- - -*"When this happens, I want it to do that..."* - -Automations are how we customize ESPHome devices to respond/behave exactly how you want them to. - -.. imgtable:: - - Overview, automations/index, description.svg, dark-invert - "Actions, Triggers, Conditions", automations/actions, description.svg, dark-invert - Templates, automations/templates, description.svg, dark-invert - -ESPHome Components ------------------- - -ESPHome-specific components or components supporting ESPHome device provisioning post-installation. - -.. imgtable:: - - Core, components/esphome, cloud-circle.svg, dark-invert - Captive Portal, components/captive_portal, wifi-strength-alert-outline.svg, dark-invert - Copy, components/copy, content-copy.svg, dark-invert - Demo, components/demo, description.svg, dark-invert - External Components, components/external_components, external_components.svg, dark-invert - Globals, components/globals, description.svg, dark-invert - Improv via BLE, components/esp32_improv, improv.svg, dark-invert - Improv via Serial, components/improv_serial, improv.svg, dark-invert - Interval, components/interval, description.svg, dark-invert - JSON, components/json, json.svg, dark-invert - XXTEA, components/xxtea, xxtea.svg - Script, components/script, description.svg, dark-invert - -ESPHome Configuration ---------------------- - -Streamline your ESPHome configuration and/or use components provided by other contributors. - -.. imgtable:: - - External Components, components/external_components, external_components.svg, dark-invert - Packages, components/packages, description.svg, dark-invert - Substitutions, components/substitutions, description.svg, dark-invert - -Network Hardware ----------------- - -.. imgtable:: - - WiFi, components/wifi, network-wifi.svg, dark-invert - ESP32 Ethernet, components/ethernet, ethernet.svg, dark-invert - -Network Protocols ------------------ - -.. imgtable:: - - Network Core, components/network, server-network.svg, dark-invert - Native API, components/api, server-network.svg, dark-invert - MQTT, components/mqtt, mqtt.png - HTTP Request, components/http_request, connection.svg, dark-invert - mDNS, components/mdns, radio-tower.svg, dark-invert - WireGuard, components/wireguard, wireguard_custom_logo.svg, dark-invert - StatsD, components/statsd, connection.svg, dark-invert - UDP, components/udp, udp.svg - -Bluetooth/BLE -------------- - -.. imgtable:: - - ESP32 BLE Beacon, components/esp32_ble_beacon, bluetooth.svg, dark-invert - ESP32 BLE Client, components/ble_client, bluetooth.svg, dark-invert - ESP32 BLE Tracker, components/esp32_ble_tracker, bluetooth.svg, dark-invert - Bluetooth Proxy, components/bluetooth_proxy, bluetooth.svg, dark-invert - Improv via BLE, components/esp32_improv, improv.svg, dark-invert - -Management and Monitoring -------------------------- - -.. imgtable:: - - Debug, components/debug, bug-report.svg, dark-invert - Logger, components/logger, file-document-box.svg, dark-invert - Prometheus, components/prometheus, prometheus.svg - StatsD, components/statsd, connection.svg, dark-invert - Safe Mode, components/safe_mode, restart-alert.svg, dark-invert - Web Server, components/web_server, http.svg - ESP32 Camera Web Server, components/esp32_camera_web_server, camera.svg, dark-invert - -Update Installation -------------------- - -Install updates over-the-air (OTA). - -.. imgtable:: - - OTA Core, components/ota/index, system-update.svg, dark-invert - OTA Updates, components/ota/esphome, system-update.svg, dark-invert - OTA Updates via HTTP Request, components/ota/http_request, system-update.svg, dark-invert - -Update Management ------------------ - -Create update entities simplifying management of OTA updates. - -.. imgtable:: - - Update Core, components/update/index, system-update.svg, dark-invert - Managed Updates, components/update/http_request, system-update.svg, dark-invert - -Hardware Peripheral Interfaces/Busses -------------------------------------- - -.. imgtable:: - - 1-Wire, components/one_wire, one-wire.svg - CAN Bus, components/canbus/index, canbus.svg - I²C Bus, components/i2c, i2c.svg - I²S Audio, components/i2s_audio, i2s_audio.svg - OpenTherm, components/opentherm, opentherm.png - SPI Bus, components/spi, spi.svg - UART, components/uart, uart.svg - -I/O Expanders/Multiplexers --------------------------- - -.. imgtable:: - - CH422G, components/ch422g, ch422g.svg - MAX6956 - I²C Bus, components/max6956, max6956.jpg - MCP230XX - I²C Bus, components/mcp230xx, mcp230xx.svg - MCP23SXX - SPI Bus, components/mcp23Sxx, mcp23sxx.svg - PCA6416A, components/pca6416a, pca6416a.svg - PCA9554, components/pca9554, pca9554a.jpg - PCF8574, components/pcf8574, pcf8574.jpg - SN74HC165, components/sn74hc165, sn74hc595.jpg - SN74HC595, components/sn74hc595, sn74hc595.jpg - SX1509, components/sx1509, sx1509.jpg - TCA9548A I²C Multiplexer, components/tca9548a, tca9548a.jpg - TCA9555, components/tca9555, tca9555.svg - WeiKai SPI/I²C UART/IO Expander, components/weikai, wk2168.jpg - XL9535, components/xl9535, xl9535.svg - -CAN Bus -------- - -.. imgtable:: - - CAN Bus, components/canbus/index, canbus.svg - ESP32 CAN, components/canbus/esp32_can, esp32.svg - MCP2515, components/canbus/mcp2515, mcp2515.svg - -Sensor Components ------------------ - -Sensors are organized into categories; if a given sensor fits into more than one category, it will appear multiple times. - -Core -**** - -.. imgtable:: - - Sensor Core, components/sensor/index, folder-open.svg, dark-invert - Template Sensor, components/sensor/template, description.svg, dark-invert - Home Assistant, components/sensor/homeassistant, home-assistant.svg, dark-invert - MQTT Subscribe, components/sensor/mqtt_subscribe, mqtt.png - Uptime Sensor, components/sensor/uptime, timer.svg, dark-invert - WiFi Signal Strength, components/sensor/wifi_signal, network-wifi.svg, dark-invert - -Air Quality -*********** - -.. imgtable:: - - AGS10, components/sensor/ags10, ags10.jpg, Volatile Organic Compound Sensor - AirThings BLE, components/sensor/airthings_ble, airthings_logo.png, Radon, CO2, Volatile organics - CCS811, components/sensor/ccs811, ccs811.jpg, CO2 & Volatile organics - EE895, components/sensor/ee895, EE895.png, CO2 & Temperature & Pressure - ENS160, components/sensor/ens160, ens160.jpg, CO2 & Air Quality - GCJA5, components/sensor/gcja5, gcja5.svg, Particulate - GP2Y1010AU0F, components/sensor/gp2y1010au0f, gp2y1010au0f.png, Particulate - Grove Multichannel Gas V2, components/sensor/grove_gas_mc_v2, grove-gas-mc-v2.png, NO2 & CO & Ethanol & Volatile organics - HM3301, components/sensor/hm3301, hm3301.jpg, Particulate - iAQ-Core, components/sensor/iaqcore, iaqcore.jpg, CO2 & Volatile organics - MH-Z19, components/sensor/mhz19, mhz19.jpg, CO2 & Temperature - MiCS-4514, components/sensor/mics_4514, mics_4514.jpg, Gas concentration - PM1006 Sensor, components/sensor/pm1006, pm1006.jpg, Particulate - PMSA003I, components/sensor/pmsa003i, pmsa003i.jpg, Particulate - PMSX003, components/sensor/pmsx003, pmsx003.svg, Particulate - RadonEye BLE, components/sensor/radon_eye_ble, radon_eye_logo.png, Radon - SCD30, components/sensor/scd30, scd30.jpg, CO2 & Temperature & Humidity - SCD4X, components/sensor/scd4x, scd4x.jpg, CO2 & Temperature & Humidity - SDS011 Sensor, components/sensor/sds011, sds011.jpg, Particulate - SEN0321, components/sensor/sen0321, sen0321.jpg, Ozone - SEN5x, components/sensor/sen5x, sen54.jpg, Temperature & Humidity & Volatile organics & NOx - SenseAir, components/sensor/senseair, senseair_s8.jpg, CO2 - SFA30, components/sensor/sfa30, sfa30.jpg, Formaldehyde - SGP30, components/sensor/sgp30, sgp30.jpg, CO2 & Volatile organics - SGP4x, components/sensor/sgp4x, sgp40.jpg, Volatile organics & 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, dark-invert - ADC128S102, components/sensor/adc128s102, adc128s102.png , 8-channel ADC - ADS1115, components/sensor/ads1115, ads1115.jpg, 4-channel ADC - ADS1118, components/sensor/ads1118, ads1118.jpg, 4-channel ADC - CD74HC4067, components/sensor/cd74hc4067, cd74hc4067.jpg, 16-channel analog multiplexer - MCP3008, components/sensor/mcp3008, mcp3008.jpg, 8-channel ADC - MCP3204 / MCP3208, components/sensor/mcp3204, mcp3204.jpg, 4-channel ADC - NAU7802, components/sensor/nau7802, nau7802.jpg, ADC - Resistance, components/sensor/resistance, omega.svg, dark-invert - -Bluetooth Low Energy (BLE) -************************** - -.. imgtable:: - - Alpha3, components/sensor/alpha3, alpha3.jpg - AM43, components/sensor/am43, am43.jpg, Lux & Battery level - BLE Client Sensor, components/sensor/ble_client, bluetooth.svg, dark-invert - BLE RSSI, components/sensor/ble_rssi, bluetooth.svg, dark-invert - HHCCJCY10 (MiFlora Pink), components/sensor/xiaomi_hhccjcy10, xiaomi_hhccjcy10.jpg, Soil moisture & Temperature & Light - Inkbird IBS-TH1 Mini, components/sensor/inkbird_ibsth1_mini, inkbird_isbth1_mini.jpg, Temperature & Humidity - Mopeka Pro Check LP, components/sensor/mopeka_pro_check, mopeka_pro_check.jpg, Tank level - Mopeka Standard Check LP, components/sensor/mopeka_std_check, mopeka_std_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, dark-invert - Pulse Counter, components/sensor/pulse_counter, pulse.svg, dark-invert - Pulse Meter, components/sensor/pulse_meter, pulse.svg, dark-invert - Pulse Width, components/sensor/pulse_width, pulse.svg, dark-invert - -Distance -******** - -.. imgtable:: - - A01NYUB, components/sensor/a01nyub, a01nyub.jpg, Acoustic distance - A02YYUW, components/sensor/a02yyuw, a02yyuw.jpg, Acoustic distance - HRXL MaxSonar WR, components/sensor/hrxl_maxsonar_wr, hrxl_maxsonar_wr.jpg, Acoustic distance - JSN-SR04T, components/sensor/jsn_sr04t, jsn-sr04t-v3.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 - Zio Ultrasonic Sensor, components/sensor/zio_ultrasonic, zio_ultrasonic.jpg, Acoustic distance - -Electricity -*********** - -.. imgtable:: - - ADE7880, components/sensor/ade7880, ade7880.svg, Voltage & Current & Power - ADE7953, components/sensor/ade7953, ade7953.svg, Power - ATM90E26, components/sensor/atm90e26, atm90e26.jpg, Voltage & Current & Power - ATM90E32, components/sensor/atm90e32, atm90e32.jpg, Voltage & Current & Power - BL0906, components/sensor/bl0906, bl0906.png, Voltage & Current & Power & Energy - BL0939, components/sensor/bl0939, bl0939.png, Voltage & Current & Power & Energy - BL0940, components/sensor/bl0940, bl0940.png, Voltage & Current & Power - BL0942, components/sensor/bl0942, bl0942.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, Alternating Current (AC) - 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, Direct Current (DC) - INA226, components/sensor/ina226, ina226.jpg, Direct Current (DC) & Power - INA228, components/sensor/ina2xx, ina228.jpg, DC Voltage & Current & Power & Charge - INA229, components/sensor/ina2xx, ina2xx.jpg, DC Voltage & Current & Power & Charge - INA237, components/sensor/ina2xx, ina2xx.jpg, DC Voltage & Current & Power - INA238, components/sensor/ina2xx, ina2xx.jpg, DC Voltage & Current & Power - INA239, components/sensor/ina2xx, ina2xx.jpg, DC Voltage & Current & Power - INA260, components/sensor/ina260, ina260.jpg, DC Current & Power - INA3221, components/sensor/ina3221, ina3221.jpg, 3-Ch DC current - Kamstrup KMP, components/sensor/kamstrup_kmp, kamstrup_kmp.jpg, District Heating Meter - MAX9611, components/sensor/max9611, max9611.jpg, 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, dark-invert - -Environmental -************* - -.. imgtable:: - - Absolute Humidity, components/sensor/absolute_humidity, water-drop.svg, dark-invert - AHT10 / AHT20 / AHT21 / DHT20, components/sensor/aht10, aht10.jpg, Temperature & Humidity - AirThings BLE, components/sensor/airthings_ble, airthings_logo.png, Temperature & Humidity & Pressure - AM2315C, components/sensor/am2315c, am2315c.jpg, Temperature & Humidity - AM2320, components/sensor/am2320, am2320.jpg, Temperature & Humidity - b-parasite, components/sensor/b_parasite, b_parasite.jpg, Moisture & Temperature & Humidity & Light - BME280, components/sensor/bme280, bme280.jpg, Temperature & Humidity & Pressure - BME68x via BSEC2, components/sensor/bme68x_bsec2, bme680.jpg, Temperature & Humidity & Pressure & Gas - BME680 via BSEC, components/sensor/bme680_bsec, bme680.jpg, Temperature & Humidity & Pressure & Gas - BME680, components/sensor/bme680, bme680.jpg, Temperature & Humidity & Pressure & Gas - BMP085, components/sensor/bmp085, bmp180.jpg, Temperature & Pressure - BMP280, components/sensor/bmp280, bmp280.jpg, Temperature & Pressure - BMP388 and BMP390, components/sensor/bmp3xx, bmp388.jpg, Temperature & Pressure - BMP581, components/sensor/bmp581, bmp581.jpg, Temperature & Pressure - Dallas DS18B20, components/sensor/dallas_temp, dallas.jpg, Temperature - DHT, components/sensor/dht, dht.jpg, Temperature & Humidity - DHT12, components/sensor/dht12, dht12.jpg, Temperature & Humidity - DPS310, components/sensor/dps310, dps310.jpg, Temperature & Pressure - EMC2101, components/emc2101, emc2101.jpg, Temperature - ENS160, components/sensor/ens160, ens160.jpg, CO2 & Air Quality - ENS210, components/sensor/ens210, ens210.jpg, Temperature & Humidity - HDC1080, components/sensor/hdc1080, hdc1080.jpg, Temperature & Humidity - HHCCJCY10 (MiFlora Pink), components/sensor/xiaomi_hhccjcy10, xiaomi_hhccjcy10.jpg, Soil moisture & Temperature & Light - Honeywell ABP, components/sensor/honeywellabp, honeywellabp.jpg, Pressure & Temperature - Honeywell ABP2 I2C, components/sensor/honeywellabp2_i2c, honeywellabp.jpg, Pressure & Temperature - Honeywell HIH I2C, components/sensor/honeywell_hih_i2c, honeywellhih.jpg, Temperature & Humidity - HTE501, components/sensor/hte501, HTE501.png, Temperature & Humidity - HTU21D / Si7021 / SHT21, components/sensor/htu21d, htu21d.jpg, Temperature & Humidity - HTU31D, components/sensor/htu31d, htu31d.jpg, Temperature & Humidity - Hydreon Rain Sensor, components/sensor/hydreon_rgxx, hydreon_rg9.jpg, Rain - HYT271, components/sensor/hyt271, hyt271.jpg, Temperature & Humidity - Inkbird IBS-TH1 Mini, components/sensor/inkbird_ibsth1_mini, inkbird_isbth1_mini.jpg, Temperature & Humidity - Internal Temperature, components/sensor/internal_temperature, thermometer.svg, Temperature, dark-invert - MCP9808, components/sensor/mcp9808, mcp9808.jpg, Temperature - MH-Z19, components/sensor/mhz19, mhz19.jpg, CO2 & Temperature - MLX90614, components/sensor/mlx90614, mlx90614.jpg, Temperature - MPL3115A2, components/sensor/mpl3115a2, mpl3115a2.jpg, Temperature & Pressure - MS5611, components/sensor/ms5611, ms5611.jpg, Pressure - MS8607, components/sensor/ms8607, ms8607.jpg, Temperature & Humidity & Pressure - NPI-19, components/sensor/npi19, npi19.jpg, Pressure - NTC Thermistor, components/sensor/ntc, ntc.jpg, Temperature - PMWCS3, components/sensor/pmwcs3, pmwcs3.jpg, Soil moisture & Temperature - QMP6988, components/sensor/qmp6988, qmp6988_env3.png, Temperature & Pressure - 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 - SFA30, components/sensor/sfa30, sfa30.jpg, Formaldehyde - 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 - SMT100, components/sensor/smt100, smt100.jpg, Moisture & Temperature - STS3X, components/sensor/sts3x, sts3x.jpg, Temperature - TC74, components/sensor/tc74, tc74.jpg, Temperature - TEE501, components/sensor/tee501, TEE501.png, Temperature - TE-M3200, components/sensor/tem3200, tem3200.jpg, Temperature & Pressure - TMP102, components/sensor/tmp102, tmp102.jpg, Temperature - TMP1075, components/sensor/tmp1075, tmp1075.jpg, Temperature - TMP117, components/sensor/tmp117, tmp117.jpg, Temperature - XGZP68xx Series, components/sensor/xgzp68xx, 6897d.jpg, Differential Pressure - -Health/Safety -************* - -.. imgtable:: - - Seeed Studio MR60BHA2 mmWave, components/seeed_mr60bha2, seeed_mr60bha2.jpg, Breathing & heartbeat detection - Seeed Studio MR60FDA2 mmWave, components/seeed_mr60fda2, seeed_mr60fda2.jpg, Presence & Fall detection - -Light -***** - -.. imgtable:: - - AM43, components/sensor/am43, am43.jpg, Lux - APDS9306, components/sensor/apds9306, apds9306.png, Lux - APDS9960, components/sensor/apds9960, apds9960.jpg, Colour & Gesture - AS7341, components/sensor/as7341, as7341.jpg, Spectral Color Sensor - BH1750, components/sensor/bh1750, bh1750.jpg, Lux - LTR301, components/sensor/ltr501, ltr501.jpg, Lux - LTR303, components/sensor/ltr_als_ps, ltr303.jpg, Lux - LTR329, components/sensor/ltr_als_ps, ltr329.jpg, Lux - LTR390, components/sensor/ltr390, ltr390.jpg, Lux & UV - LTR501, components/sensor/ltr501, ltr501.jpg, Lux & Proximity - LTR553, components/sensor/ltr_als_ps, ltr-ps.jpg, Lux & Proximity - LTR556, components/sensor/ltr_als_ps, ltr-ps.jpg, Lux & Proximity - LTR558, components/sensor/ltr501, ltr501.jpg, Lux & Proximity - LTR559, components/sensor/ltr_als_ps, ltr559.jpg, Lux & Proximity - LTR659, components/sensor/ltr_als_ps, ltr-ps.jpg, Proximity - 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 - VEML3235, components/sensor/veml3235, veml3235.jpg, Lux - VEML6030, components/sensor/veml7700, veml6030.jpg, Lux - VEML7700, components/sensor/veml7700, veml7700.jpg, Lux - -Magnetic -******** - -.. imgtable:: - - AS5600, components/sensor/as5600, as5600.jpg, 12-Bit Magnetic Position Sensor - ESP32 Hall Sensor, components/sensor/esp32_hall, magnet.svg, ESP internal, dark-invert - HMC5883L, components/sensor/hmc5883l, hmc5883l.jpg, 3-Axis magnetometer - MLX90393, components/sensor/mlx90393, mlx90393.jpg, 3-Axis magnetometer - MMC5603, components/sensor/mmc5603, mmc5603.jpg, 3-Axis magnetometer - MMC5983, components/sensor/mmc5983, mmc5983.jpg, 3-Axis magnetometer - QMC5883L, components/sensor/qmc5883l, qmc5883l.jpg, 3-Axis magnetometer - -Miscellaneous -************* - -.. imgtable:: - - AS3935, components/sensor/as3935, as3935.jpg, Storm lightning - b-parasite, components/sensor/b_parasite, b_parasite.jpg, Moisture & Temperature & Humidity & Light - Binary Sensor Map, components/sensor/binary_sensor_map, binary_sensor_map.jpg, Map binary to value - Combination, components/sensor/combination, function.svg, dark-invert - Duty Time, components/sensor/duty_time, timer-play-outline.svg, dark-invert - EZO sensor circuits, components/sensor/ezo, ezo-ph-circuit.png, (pH) - FS3000, components/sensor/fs3000, fs3000.jpg, Air velocity - GDK101, components/sensor/gdk101, gdk101.jpg, Radiation - Growatt Solar, components/sensor/growatt_solar, growatt.jpg, Solar rooftop - Havells Solar, components/sensor/havells_solar, havellsgti5000d_s.jpg, Solar rooftop - Integration, components/sensor/integration, sigma.svg, dark-invert - Kuntze pool sensor, components/sensor/kuntze, kuntze.jpg - LVGL widget, components/sensor/lvgl, lvgl_c_num.png - M5Stack Unit 8 Angle, components/sensor/m5stack_8angle, m5stack_8angle.png - MAX17043, components/sensor/max17043, max17043.jpg, Battery - MicroNova pellet stove, components/micronova, micronova.svg - Modbus Sensor, components/sensor/modbus_controller, modbus.png - Nextion, components/sensor/nextion, nextion.jpg, Sensors from display - Person Sensor (SEN21231), components/sensor/sen21231, sen21231.png - Resol VBus, components/vbus, resol_deltasol_bs_plus.jpg - Rotary Encoder, components/sensor/rotary_encoder, rotary_encoder.jpg - SMT100, components/sensor/smt100, smt100.jpg, Moisture & Temperature - Tuya Sensor, components/sensor/tuya, tuya.png - TX20, components/sensor/tx20, tx20.jpg, Wind speed & Wind direction - uFire EC sensor, components/sensor/ufire_ec, ufire_ec.png, EC & Temperature - uFire ISE sensor, components/sensor/ufire_ise, ufire_ise.png, pH & Temperature - WireGuard, components/wireguard, wireguard_custom_logo.svg, dark-invert - -Motion -****** - -.. imgtable:: - - APDS9960, components/sensor/apds9960, apds9960.jpg, Colour & Gesture - BMI160, components/sensor/bmi160, bmi160.jpg, Accelerometer & Gyroscope - LD2410, components/sensor/ld2410, ld2410.jpg, Motion & Presence - LD2420, components/sensor/ld2420, ld2420.jpg, Motion & Presence - 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 - Seeed Studio MR24HPC1 mmWave, components/seeed_mr24hpc1, seeed-mr24hpc1.jpg, Motion & Presence - -Thermocouple -************ - -.. imgtable:: - - KMeterISO, components/sensor/kmeteriso, kmeteriso.jpg, K-Type, - 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, - MCP9600, components/sensor/mcp9600, mcp9600.jpg, All types - -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 ` together with a formula like in the `TEMT6000 -configuration `__. - - -Binary Sensor Components ------------------------- - -Binary Sensors are organized into categories; if a given sensor fits into more than one category, it will appear multiple times. - -Core -**** - -.. imgtable:: - - Binary Sensor Core, components/binary_sensor/index, folder-open.svg, dark-invert - Template Binary Sensor, components/binary_sensor/template, description.svg, dark-invert - GPIO, components/binary_sensor/gpio, gpio.svg - Home Assistant, components/binary_sensor/homeassistant, home-assistant.svg, dark-invert - Status, components/binary_sensor/status, server-network.svg, dark-invert - Switch, components/binary_sensor/switch, electric-switch.svg, dark-invert - Host SDL2, components/binary_sensor/sdl, sdl.png - -Capacitive Touch -**************** - -.. imgtable:: - - CAP1188 Capacitive Touch Sensor, components/binary_sensor/cap1188, cap1188.jpg - ESP32 Touch Pad, components/binary_sensor/esp32_touch, touch.svg, dark-invert - MPR121 Capacitive Touch Sensor, components/binary_sensor/mpr121, mpr121.jpg - TTP229, components/binary_sensor/ttp229, ttp229.jpg - -Mechanical -********** - -.. imgtable:: - - Matrix Keypad, components/matrix_keypad, matrix_keypad.jpg - TM1637, components/display/tm1637, tm1637.jpg - TM1638, components/display/tm1638, tm1638.jpg - -NFC/RFID -******** - -Often known as "tag" or "card" readers within the community. - -.. imgtable:: - - NFC Tag, components/binary_sensor/nfc, nfc.png, dark-invert - PN532, components/binary_sensor/pn532, pn532.jpg - PN7150, components/pn7150, pn7150.jpg - PN716X, components/pn7160, pn716x.jpg - RC522, components/binary_sensor/rc522, rc522.jpg - RDM6300, components/binary_sensor/rdm6300, rdm6300.jpg - Wiegand Reader, components/wiegand, wiegand.jpg - -Touchscreen -*********** - -.. imgtable:: - - Touchscreen Core, components/touchscreen/index, touch.svg, dark-invert - FT5X06, components/touchscreen/ft5x06, indicator.jpg - GT911, components/touchscreen/gt911, esp32_s3_box_3.png - Nextion Binary Sensor, components/binary_sensor/nextion, nextion.jpg - TT21100, components/touchscreen/tt21100, esp32-s3-korvo-2-lcd.png - LVGL widget, components/binary_sensor/lvgl, lvgl_c_bns.png - -Presence Detection -****************** - -.. imgtable:: - - AT581X, components/at581x, at581x.png - DFRobot mmWave Radar, components/dfrobot_sen0395, dfrobot_sen0395.jpg - LD2410, components/sensor/ld2410, ld2410.jpg - LD2420, components/sensor/ld2420, ld2420.jpg - Seeed Studio MR24HPC1 mmWave, components/seeed_mr24hpc1, seeed-mr24hpc1.jpg - -Miscellaneous -************* - -.. imgtable:: - - Analog Threshold, components/binary_sensor/analog_threshold, analog_threshold.svg, dark-invert - ESP32 BLE Presence, components/binary_sensor/ble_presence, bluetooth.svg, dark-invert - Hydreon Rain Sensor Binary Sensor, components/binary_sensor/hydreon_rgxx, hydreon_rg9.jpg - Modbus Binary Sensor, components/binary_sensor/modbus_controller, modbus.png - PipSolar - compatible PV Inverter, components/pipsolar, pipsolar.jpg - Pylontech Batteries, components/pylontech, pylontech.jpg - Qwiic PIR Motion, components/binary_sensor/qwiic_pir, qwiic_pir.jpg - Resol VBus, components/vbus, resol_deltasol_bs_plus.jpg - Tuya Binary Sensor, components/binary_sensor/tuya, tuya.png - WireGuard, components/wireguard, wireguard_custom_logo.svg, dark-invert - -Alarm Control Panel Components ------------------------------- - -.. imgtable:: - - Alarm Control Panel Core, components/alarm_control_panel/index, alarm-panel.svg, dark-invert - Template Alarm Control Panel, components/alarm_control_panel/template, description.svg, dark-invert - -Audio ADC Components --------------------- - -.. imgtable:: - - Audio ADC Core, components/audio_adc/index, audio_adc.svg - ES7210, components/audio_adc/es7210, es7210.svg - ES7243E, components/audio_adc/es7243e, es7243e.svg - -Audio DAC Components --------------------- - -.. imgtable:: - - Audio DAC Core, components/audio_dac/index, audio_dac.svg - AIC3204, components/audio_dac/aic3204, aic3204.svg - ES8156, components/audio_dac/es8156, es8156.svg - ES8311, components/audio_dac/es8311, es8311.svg - -Button Components ------------------ - -.. imgtable:: - - Button Core, components/button/index, folder-open.svg, dark-invert - Template Button, components/button/template, description.svg, dark-invert - Factory Reset Button, components/button/factory_reset, restart-alert.svg, dark-invert - Generic Output Button, components/button/output, upload.svg, dark-invert - Restart Button, components/button/restart, restart.svg, dark-invert - Safe Mode Button, components/button/safe_mode, restart-alert.svg, dark-invert - Shutdown Button, components/button/shutdown, power_settings.svg, dark-invert - UART Button, components/button/uart, uart.svg - Wake-on-LAN, components/button/wake_on_lan, power_settings.svg, dark-invert - -Climate Components ------------------- - -.. imgtable:: - - Climate Core, components/climate/index, folder-open.svg, dark-invert - Anova Cooker, components/climate/anova, anova.png - Bang Bang Controller, components/climate/bang_bang, air-conditioner.svg, dark-invert - BedJet Climate System, components/climate/bedjet, bedjet.png - Haier Climate, components/climate/haier, haier.svg - IR Remote Climate, components/climate/climate_ir, air-conditioner-ir.svg, dark-invert - Midea, components/climate/midea, midea.svg - PID Controller, components/climate/pid, function.svg, dark-invert - Thermostat Controller, components/climate/thermostat, air-conditioner.svg, dark-invert - Tuya Climate, components/climate/tuya, tuya.png - Uponor Smatrix Base Pulse Underfloor Heating, components/uponor_smatrix, uponor.svg - -Cover Components ----------------- - -.. imgtable:: - - Cover Core, components/cover/index, folder-open.svg, dark-invert - Template Cover, components/cover/template, description.svg, dark-invert - AM43 Cover, components/cover/am43, am43.jpg - Current-Based Cover, components/cover/current_based, flash.svg, dark-invert - Endstop Cover, components/cover/endstop, electric-switch.svg, dark-invert - Feedback Cover, components/cover/feedback, feedback_cover.svg, dark-invert - HE60R Cover, components/cover/he60r, he60r.jpg - Time-Based Cover, components/cover/time_based, timer.svg, dark-invert - Tuya Cover, components/cover/tuya, tuya.png - -Datetime Components -------------------- - -.. imgtable:: - - Datetime Core, components/datetime/index, clock-outline.svg, dark-invert - Template Datetime, components/datetime/template, description.svg, dark-invert - -Display Components ------------------- - -.. imgtable:: - - Display Core, components/display/index, folder-open.svg, dark-invert - Font Renderer, components/font, format-font.svg, dark-invert - Graph, components/graph, chart-line.svg, dark-invert - QR Code, components/qr_code, qr-code.svg, dark-invert - Image, components/image, image-outline.svg, dark-invert - Animation, components/animation, image-multiple-outline.svg, dark-invert - Online Image, components/online_image, image-sync-outline.svg, dark-invert - Display Menu Core, components/display_menu/index, folder-open.svg, dark-invert - Graphical Display Menu, components/display_menu/graphical_display_menu, graphical_display_menu.png - LCD Menu, components/display_menu/lcd_menu, lcd_menu.png - LVGL Graphics, components/lvgl/index, lvgl.png - -.. _display-hw: - -Display Hardware Platforms --------------------------- - -.. imgtable:: - - Addressable Light, components/display/addressable_light, addressable_light.jpg - ILI9xxx, components/display/ili9xxx, ili9341.jpg - ILI9341, components/display/ili9xxx, ili9341.svg - ILI9342, components/display/ili9xxx, ili9342.svg - ILI9481, components/display/ili9xxx, ili9481.svg - ILI9486, components/display/ili9xxx, ili9341.jpg - ILI9488, components/display/ili9xxx, ili9488.svg - WSPICOLCD, components/display/ili9xxx, ili9488.svg - Inkplate, components/display/inkplate6, inkplate6.jpg - LCD Display, components/display/lcd_display, lcd.jpg - MAX7219 Dot Matrix, components/display/max7219digit, max7219digit.jpg - MAX7219, components/display/max7219, max7219.jpg - Nextion, components/display/nextion, nextion.jpg - PCD8544 (Nokia 5110/ 3310), components/display/pcd8544, pcd8544.jpg - PVVX MiThermometer, components/display/pvvx_mithermometer, ../components/sensor/images/xiaomi_lywsd03mmc.jpg - Quad SPI Displays, components/display/qspi_dbi, t4-s3.jpg - RPI_DPI_RGB, components/display/rpi_dpi_rgb, waveshare_touch-s3.jpg - SSD1306, components/display/ssd1306, ssd1306.jpg - SSD1322, components/display/ssd1322, ssd1322.jpg - SSD1325, components/display/ssd1325, ssd1325.jpg - SSD1327, components/display/ssd1327, ssd1327.jpg - SSD1331, components/display/ssd1331, ssd1331.jpg - SSD1351, components/display/ssd1351, ssd1351.jpg - ST7567, components/display/st7567, st7567.jpg - ST7701S, components/display/st7701s, indicator.jpg - ST7735, components/display/st7735, st7735.jpg - ST7789V, components/display/st7789v, st7789v.jpg - ST7796, components/display/ili9xxx, st7796.svg - ST7920, components/display/st7920, st7920.jpg - TM1621, components/display/tm1621, tm1621.jpg - TM1637, components/display/tm1637, tm1637.jpg - TM1638, components/display/tm1638, tm1638.jpg - TM1651 Battery Display, components/tm1651, tm1651_battery_display.jpg - Waveshare E-Paper, components/display/waveshare_epaper, waveshare_epaper.jpg - Host SDL2 display, components/display/sdl, sdl.png - -Electromechanical ------------------ - -.. imgtable:: - - Atlas Scientific Peristaltic Pump, components/ezo_pmp, ezo-pmp.jpg - Grove TB6612FNG, components/grove_tb6612fng, motor.png, dark-invert - Matrix Keypad, components/matrix_keypad, matrix_keypad.jpg - RTTTL Buzzer, components/rtttl, buzzer.jpg - Servo, components/servo, servo.svg - Stepper, components/stepper/index, stepper.svg - -Energy/Solar Management ------------------------ - -.. imgtable:: - - PipSolar-compatible PV Inverter, components/pipsolar, pipsolar.jpg - Power Supply, components/power_supply, power.svg, dark-invert - Resol VBus, components/vbus, resol_deltasol_bs_plus.jpg - SML, components/sml, sml.svg - SUN-GTIL2 inverter, components/sun_gtil2, sun_1000g2.png - -Event Components ----------------- - -.. imgtable:: - - Event Core, components/event/index, folder-open.svg, dark-invert - Template Event, components/event/template, description.svg, dark-invert - -Fan Components --------------- - -.. imgtable:: - - Fan Core, components/fan/index, folder-open.svg, dark-invert - Template Fan, components/fan/template, description.svg, dark-invert - Binary Fan, components/fan/binary, fan.svg, dark-invert - H-bridge Fan, components/fan/hbridge, fan.svg, dark-invert - Speed Fan, components/fan/speed, fan.svg, dark-invert - Tuya Fan, components/fan/tuya, tuya.png - -Home Assistant Components -------------------------- - -Components specifically for interacting with Home Assistant. - -.. imgtable:: - - Binary Sensor, components/binary_sensor/homeassistant, home-assistant.svg, dark-invert - Bluetooth Proxy, components/bluetooth_proxy, bluetooth.svg, dark-invert - micro Wake Word, components/micro_wake_word, voice-assistant.svg, dark-invert - Number, components/number/homeassistant, home-assistant.svg, dark-invert - Sensor, components/sensor/homeassistant, home-assistant.svg, dark-invert - Switch, components/switch/homeassistant, home-assistant.svg, dark-invert - Text Sensor, components/text_sensor/homeassistant, home-assistant.svg, dark-invert - Voice Assistant, components/voice_assistant, voice-assistant.svg, dark-invert - -Light Components ----------------- - -.. imgtable:: - - Light Core, components/light/index, folder-open.svg, dark-invert - Beken SPI, components/light/beken_spi_led_strip, color_lens.svg, dark-invert - Binary Light, components/light/binary, lightbulb.svg, dark-invert - Cold+Warm White Light, components/light/cwww, brightness-medium.svg, dark-invert - Color Temperature Light, components/light/color_temperature, brightness-medium.svg, dark-invert - ESP32 RMT, components/light/esp32_rmt_led_strip, color_lens.svg, dark-invert - FastLED Light, components/light/fastled, color_lens.svg, dark-invert - H-bridge Light, components/light/hbridge, brightness-medium.svg, dark-invert - Light Partition, components/light/partition, color_lens.svg, dark-invert - LightWaveRF, components/lightwaverf, brightness-medium.svg, dark-invert - LVGL widget, components/light/lvgl, lvgl_c_lig.png - Monochromatic Light, components/light/monochromatic, brightness-medium.svg, dark-invert - NeoPixelBus Light, components/light/neopixelbus, color_lens.svg, dark-invert - RGB Light, components/light/rgb, rgb.png - RGBCT Light, components/light/rgbct, rgbw.png - RGBW Light, components/light/rgbw, rgbw.png - RGBWW Light, components/light/rgbww, rgbw.png - RP2040 PIO, components/light/rp2040_pio_led_strip, color_lens.svg, dark-invert - Shelly Dimmer, components/light/shelly_dimmer, shellydimmer2.jpg - Sonoff D1 Dimmer, components/light/sonoff_d1, sonoff_d1.jpg - SPI LED Strips, components/light/spi_led_strip, apa102.jpg - Status Led, components/light/status_led, led-on.svg, dark-invert - Tuya Dimmer, components/light/tuya, tuya.png - -**Looking for WS2811 and similar individually addressable lights?** For the ESP32 and its variants, we -recommend the :doc:`components/light/esp32_rmt_led_strip` or :doc:`components/light/spi_led_strip`; for -other processors, have a look at the :doc:`FastLED Light `. - -Lock Components ---------------- - -.. imgtable:: - - Lock Core, components/lock/index, folder-open.svg, dark-invert - Template Lock, components/lock/template, description.svg, dark-invert - Generic Output Lock, components/lock/output, upload.svg, dark-invert - -Media Player Components ------------------------ - -.. imgtable:: - - Media Player Core, components/media_player/index, folder-open.svg, dark-invert - DFPlayer, components/dfplayer, dfplayer.svg, dark-invert - I2S Audio, components/media_player/i2s_audio, i2s_audio.svg - Speaker, components/media_player/speaker, speaker.svg - -Microphone Components ---------------------- - -.. imgtable:: - - Microphone Core, components/microphone/index, microphone.svg, dark-invert - I2S Microphone, components/microphone/i2s_audio, i2s_audio.svg - -Number Components ------------------ - -.. imgtable:: - - Number Core, components/number/index, folder-open.svg, dark-invert - Template Number, components/number/template, description.svg, dark-invert - Home Assistant, components/number/homeassistant, home-assistant.svg, dark-invert - LVGL widget Number, components/number/lvgl, lvgl_c_num.png - Modbus Number, components/number/modbus_controller, modbus.png - Tuya Number, components/number/tuya, tuya.png - -Output Components ------------------ - -.. imgtable:: - - Output Core, components/output/index, folder-open.svg, dark-invert - Template Output, components/output/template, description.svg, dark-invert - AC Dimmer, components/output/ac_dimmer, ac_dimmer.svg, dark-invert - BLE Binary Output, components/output/ble_client, bluetooth.svg, dark-invert - BP1658CJ, components/output/bp1658cj, bp1658cj.svg - BP5758D, components/output/bp5758d, bp5758d.svg - DAC7678, components/output/dac7678, dac7678.svg - EMC2101, components/emc2101, emc2101.jpg - ESP32 DAC, components/output/esp32_dac, dac.svg - ESP32 LEDC, components/output/ledc, pwm.png - ESP8266 Software PWM, components/output/esp8266_pwm, pwm.png - GP8403, components/output/gp8403, gp8403.svg - GPIO Output, components/output/gpio, gpio.svg - LibreTiny PWM, components/output/libretiny_pwm, pwm.png - MCP4725, components/output/mcp4725, mcp4725.jpg - MCP4728, components/output/mcp4728, mcp4728.jpg - MCP47A1, components/output/mcp47a1, mcp47a1.svg - Modbus Output, components/output/modbus_controller, modbus.png - MY9231/MY9291, components/output/my9231, my9231.svg - PCA9685, components/output/pca9685, pca9685.jpg - Sigma-Delta Output, components/output/sigma_delta_output, sigma-delta.svg, dark-invert - Slow PWM, components/output/slow_pwm, pwm.png - SM16716, components/output/sm16716, sm16716.svg - SM2135, components/output/sm2135, sm2135.svg - SM2235, components/output/sm2235, sm2235.svg - SM2335, components/output/sm2335, sm2335.svg - TLC59208F, components/output/tlc59208f, tlc59208f.jpg - TLC5947, components/output/tlc5947, tlc5947.jpg - TLC5971, components/output/tlc5971, tlc5971.jpg - X9C Potentiometer, components/output/x9c, x9c.jpg - -Select Components ------------------ - -.. imgtable:: - - Select Core, components/select/index, folder-open.svg, dark-invert - Template Select, components/select/template, description.svg, dark-invert - LVGL widget Select, components/select/lvgl, lvgl_c_sel.png - Modbus Select, components/select/modbus_controller, modbus.png - Tuya Select, components/select/tuya, tuya.png - -Speaker Components ------------------- - -.. imgtable:: - - Speaker Core, components/speaker/index, speaker.svg, dark-invert - I2S Speaker, components/speaker/i2s_audio, i2s_audio.svg - Mixer Speaker, components/speaker/mixer, mixer.svg - Resampler Speaker, components/speaker/resampler, waveform.svg, dark-invert - -Switch Components ------------------ - -.. imgtable:: - - Switch Core, components/switch/index, folder-open.svg, dark-invert - Template Switch, components/switch/template, description.svg, dark-invert - BLE Client Switch, components/switch/ble_client, bluetooth.svg, dark-invert - Factory Reset Switch, components/switch/factory_reset, restart-alert.svg, dark-invert - Generic Output Switch, components/switch/output, upload.svg, dark-invert - GPIO Switch, components/switch/gpio, gpio.svg - H-bridge Switch, components/switch/hbridge, hbridge-relay.jpg - LVGL Widget, components/switch/lvgl, lvgl_c_swi.png - Modbus Switch, components/switch/modbus_controller, modbus.png - Nextion Switch, components/switch/nextion, nextion.jpg - Restart Switch, components/switch/restart, restart.svg, dark-invert - Safe Mode Switch, components/switch/safe_mode, restart-alert.svg, dark-invert - Shutdown Switch, components/switch/shutdown, power_settings.svg, dark-invert - Tuya Switch, components/switch/tuya, tuya.png - UART Switch, components/switch/uart, uart.svg - Home Assistant, components/switch/homeassistant, home-assistant.svg, dark-invert - -Text Components ---------------- - -.. imgtable:: - - Text Core, components/text/index, folder-open.svg, dark-invert - Template Text, components/text/template, description.svg, dark-invert - LVGL textarea Text, components/text/lvgl, lvgl_c_txt.png - -Text Sensor Components ----------------------- - -.. imgtable:: - - Text Sensor Core, components/text_sensor/index, folder-open.svg, dark-invert - Template Text Sensor, components/text_sensor/template, description.svg, dark-invert - BLE Scanner, components/text_sensor/ble_scanner, bluetooth.svg, dark-invert - Ethernet Info, components/text_sensor/ethernet_info, ethernet.svg, dark-invert - Home Assistant, components/text_sensor/homeassistant, home-assistant.svg, dark-invert - LibreTiny, components/text_sensor/libretiny, libretiny.svg - LVGL textarea Text Sensor, components/text_sensor/lvgl, lvgl_c_txt.png - Modbus Text Sensor, components/text_sensor/modbus_controller, modbus.png - MQTT Subscribe Text, components/text_sensor/mqtt_subscribe, mqtt.png - Nextion Text Sensor, components/text_sensor/nextion, nextion.jpg - Tuya Text Sensor, components/text_sensor/tuya, tuya.png - Version, components/text_sensor/version, new-box.svg, dark-invert - WiFi Info, components/text_sensor/wifi_info, network-wifi.svg, dark-invert - WireGuard, components/wireguard, wireguard_custom_logo.svg, dark-invert - WL-134 Pet Tag Sensor , components/text_sensor/wl_134, fingerprint.svg, dark-invert - -Time Components ---------------- - -.. imgtable:: - - Time Core, components/time/index, clock-outline.svg, dark-invert - DS1307 RTC, components/time/ds1307, clock-outline.svg, dark-invert - GPS Time, components/time/gps, crosshairs-gps.svg, dark-invert - Home Assistant Time, components/time/homeassistant, home-assistant.svg, dark-invert - PCF85063 RTC, components/time/pcf85063, clock-outline.svg, dark-invert - PCF8563 RTC, components/time/pcf8563, clock-outline.svg, dark-invert - SNTP, components/time/sntp, clock-outline.svg, dark-invert - -Touchscreen Components ----------------------- - -.. imgtable:: - - Touchscreen Core, components/touchscreen/index, folder-open.svg, dark-invert - AXS15231, components/touchscreen/axs15231, axs15231.svg - CST226, components/touchscreen/cst226, t4-s3.jpg - CST816, components/touchscreen/cst816, cst816.jpg - EKTF2232, components/touchscreen/ektf2232, ektf2232.svg, Inkplate 6 Plus - FT63X6, components/touchscreen/ft63x6, wt32-sc01.png - GT911, components/touchscreen/gt911, esp32_s3_box_3.png - Lilygo T5 4.7", components/touchscreen/lilygo_t5_47, lilygo_t5_47_touch.jpg - TT21100, components/touchscreen/tt21100, esp32-s3-korvo-2-lcd.png - XPT2046, components/touchscreen/xpt2046, xpt2046.jpg - -Valve Components ----------------- - -.. imgtable:: - - Valve Core, components/valve/index, folder-open.svg, dark-invert - Template Valve, components/valve/template, description.svg, dark-invert - -Wireless Communication ----------------------- - -Used for creating infrared (IR) or radio frequency (RF) remote control transmitters and/or receivers, or to connect -ESPHome to cellular networks. **Does not encompass Wi-Fi.** - -.. imgtable:: - - IR Remote Climate, components/climate/climate_ir, air-conditioner-ir.svg, dark-invert - Remote Receiver, components/remote_receiver, remote.svg, dark-invert - Remote Transmitter, components/remote_transmitter, remote.svg, dark-invert - RF Bridge, components/rf_bridge, rf_bridge.jpg - SIM800L, components/sim800l, sim800l.jpg - -Miscellaneous Components ------------------------- - -.. imgtable:: - - ESP32 Camera, components/esp32_camera, camera.svg, dark-invert - Exposure Notifications, components/exposure_notifications, exposure_notifications.png - GPS, components/gps, crosshairs-gps.svg, dark-invert - Grow Fingerprint Reader, components/fingerprint_grow, fingerprint.svg, dark-invert - Modbus Controller, components/modbus_controller, modbus.png - Sprinkler, components/sprinkler, sprinkler-variant.svg, dark-invert - Status LED, components/status_led, led-on.svg, dark-invert - Sun, components/sun, weather-sunny.svg, dark-invert - Tuya MCU, components/tuya, tuya.png - -.. _cookbook: - -Cookbook --------- - -.. imgtable:: - - Lambda Magic: Tips and Tricks, cookbook/lambda_magic, head-lightbulb-outline.svg, dark-invert - LVGL Recipes, cookbook/lvgl, lvgl.png - Garage Door Template Cover, cookbook/garage-door, garage-variant.svg, dark-invert - Time & Temperature on OLED Display, cookbook/display_time_temp_oled, display_time_temp_oled_2.jpg - ESP32 Water Leak Detector, cookbook/leak-detector-m5stickC, leak-detector-m5stickC_main_index.jpg - BME280 Environment extras, cookbook/bme280_environment, bme280.jpg - Non-Invasive Power Meter, cookbook/power_meter, power_meter.jpg - Sonoff Fishpond Pump, cookbook/sonoff-fishpond-pump, cookbook-sonoff-fishpond-pump.jpg - Arduino Port Extender, cookbook/arduino_port_extender, arduino_logo.svg - EHMTX a matrix status/text display, cookbook/ehmtx, ehmtx.jpg - .. _device_database: Device Database @@ -1200,13 +152,20 @@ Device Database You will find configurations for specific devices in our `ESPHome Devices `__ database. +.. _documentation: + +Documentation +------------- + +You will find all :doc:`ESPHome documentation here`. + .. _contributing: Contributing ------------ -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 `. +ESPHome depends on and welcomes contributions from our community. If you'd like to contribute, please see +:doc:`Contributing `. .. toctree:: :hidden: