Upstream
/
esphome-docs
mirror of https://github.com/esphome/esphome-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge branch 'current' into fix-some-terms-202404

This commit is contained in:
Keith Burzinski 2024-05-06 20:05:50 -05:00 committed by GitHub
parent 90f358776a 567fa6a76a
commit 8af9f6653e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
22 changed files with 365 additions and 249 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Dockerfile
View File

@ -14,6 +14,7 @@ RUN useradd -ms /bin/bash esphome
USER esphome
WORKDIR /workspaces/esphome-docs
ENV PATH="${PATH}:/home/esphome/.local/bin"
COPY requirements.txt ./
RUN pip3 install --no-cache-dir --no-binary :all: -r requirements.txt

2
Doxygen
View File

@ -38,7 +38,7 @@ PROJECT_NAME = "ESPHome"
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = 2024.4.1
PROJECT_NUMBER = 2024.4.2
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a

2
Makefile
View File

@ -1,5 +1,5 @@
ESPHOME_PATH = ../esphome
ESPHOME_REF = 2024.4.1
ESPHOME_REF = 2024.4.2
.PHONY: html html-strict cleanhtml deploy help live-html Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify

5
_static/custom.css
View File

@ -240,6 +240,11 @@ a:hover code {
background: none;
}
/* don't underline links that contain an image and nothing else */
a:has(> img:only-child) {
border-bottom: none;
}
div.body p, div.body dd, div.body li, div.body blockquote {
hyphens: none;
}

2
_static/version
View File

@ -1 +1 @@
2024.4.1
2024.4.2

2
changelog/2023.12.0.rst
View File

@ -14,7 +14,7 @@ ESPHome 2023.12.0 - 20th December 2023
GT911, components/touchscreen/gt911, esp32_s3_box_3.png
Pylontech Batteries, components/pylontech, pylontech.jpg
HE60R Cover, components/cover/he60r, he60r.jpg
Graphical Display Menu, components/display_menu/graphical_display_menu, graphical_display_menu.jpg
Graphical Display Menu, components/display_menu/graphical_display_menu, graphical_display_menu.png
FT63X6, components/touchscreen/ft63x6, wt32-sc01.png
A02YYUW, components/sensor/a02yyuw, a02yyuw.jpg
PN7150, components/binary_sensor/pn7150, pn7150.jpg

9
changelog/2024.4.0.rst
View File

@ -50,6 +50,15 @@ Release 2024.4.1 - April 23
- Fix or filter :esphomepr:`6574` by :ghuser:`swoboda1337`
Release 2024.4.2 - April 30
---------------------------
- Fix SHT3xd fails sometimes in 2024.4.0 :esphomepr:`6592` by :ghuser:`mrtoy-me`
- allow defaults with no include vars :esphomepr:`6613` by :ghuser:`ssieb`
- Revert #6458 :esphomepr:`6650` by :ghuser:`tronikos`
- [i2s_audio.microphone] Fixing adc bug :esphomepr:`6654` by :ghuser:`jesserockz`
Full list of changes
--------------------

37
components/api.rst
View File

@ -75,20 +75,35 @@ Configuration variables:
.. _api-actions:
.. note::
Before a newly added ESPHome device can interact with the Home Assistant API it needs to be allowed to communicate
with it. This setting can be found in the ESPHome integration (NOT in the Add-On) by clicking "CONFIGURE" for
that device and enabling the "Allow device to make service calls" option.
Actions
-------
Before using any of the actions below, you'll need to tell Home Assistant to allow your device to
make service calls.
Open the ESPHome integration page on your Home Assistant instance:
.. raw:: html
<a href="https://my.home-assistant.io/redirect/integration/?domain=esphome" target="_blank" rel="noreferrer noopener"><img src="https://my.home-assistant.io/badges/integration.svg" alt="Open your Home Assistant instance and show an integration." /></a>
Then:
#. Fnd your device in the device list
#. Click the "configure" button next to it
#. Check the "Allow the device to make Home Assistant service calls" box
#. Then click "submit".
.. _api-homeassistant_event_action:
``homeassistant.event`` Action
******************************
.. note::
Be sure to :ref:`follow the instructions above <api-actions>` to tell Home Assistant to allow
your device to make service calls.
When using the native API with Home Assistant, you can create events in the Home Assistant event bus
straight from ESPHome :ref:`Automations <automation>`.
@ -117,6 +132,11 @@ Configuration variables:
``homeassistant.service`` Action
********************************
.. note::
Be sure to :ref:`follow the instructions above <api-actions>` to tell Home Assistant to allow
your device to make service calls.
When using the native API with Home Assistant, you can create Home Assistant service
calls straight from ESPHome :ref:`Automations <automation>`.
@ -189,6 +209,11 @@ Then, in ESPHome:
``homeassistant.tag_scanned`` Action
************************************
.. note::
Be sure to :ref:`follow the instructions above <api-actions>` to tell Home Assistant to allow
your device to make service calls.
When using the native API with Home Assistant, you can push tag_scanned to Home Assistant
straight from ESPHome :ref:`Automations <automation>`.

2
components/display_menu/graphical_display_menu.rst
View File

@ -12,7 +12,7 @@ on graphical displays. This offers the user an interactive method to display
labels, control entities like ``switch``, ``select``, ``number`` available locally on the
ESPHome node, without the requirement of a network connection.
.. figure:: images/graphical_display_menu.jpg
.. figure:: images/graphical_display_menu.png
:align: center
:width: 60.0%

BIN
components/display_menu/images/graphical_display_menu.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 101 KiB

BIN
components/display_menu/images/graphical_display_menu.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.9 KiB

2
components/mqtt.rst
View File

@ -265,7 +265,7 @@ then run the ``mqtt-fingerprint`` script of ESPHome to get the certificate:
.. code-block:: bash
esphome livingroom.yaml mqtt-fingerprint
esphome mqtt-fingerprint livingroom.yaml
> SHA1 Fingerprint: a502ff13999f8b398ef1834f1123650b3236fc07
> Copy above string into mqtt.ssl_fingerprints section of livingroom.yaml

2
components/sensor/bme680_bsec.rst
View File

@ -30,7 +30,7 @@ The :ref:`I²C <i2c>` is required to be set up in your configuration for this se
BME680 Temperature, Pressure, Humidity & Gas Sensor.
.. _BSEC license agreement: https://www.bosch-sensortec.com/media/boschsensortec/downloads/bsec/2017-07-17_clickthrough_license_terms_environmentalib_sw_clean.pdf
.. _BSEC license agreement: https://www.bosch-sensortec.com/media/boschsensortec/downloads/software/bme688_development_software/2023_04/license_terms_bme688_bme680_bsec.pdf
.. _Adafruit: https://www.adafruit.com/product/3660

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

2
conf.py
View File

@ -69,7 +69,7 @@ author = "ESPHome"
# The short X.Y version.
version = "2024.4"
# The full version, including alpha/beta/rc tags.
release = "2024.4.1"
release = "2024.4.2"
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

2
guides/contributing.rst
View File

@ -98,7 +98,7 @@ Build
.. code-block:: bash
docker run --rm -v "${PWD}/":/data/esphomedocs -p 8000:8000 -it ghcr.io/esphome/esphome-docs
docker run --rm -v "${PWD}/":/workspaces/esphome-docs -p 8000:8000 -it ghcr.io/esphome/esphome-docs
With ``PWD`` referring to the root of the ``esphome-docs`` git repository. Then go to ``<CONTAINER_IP>:8000`` in your browser.

2
guides/getting_started_command_line.rst
View File

@ -191,7 +191,7 @@ for docker you need to supply an additional parameter:
.. code-block:: bash
esphome livingroom.yaml run
esphome run livingroom.yaml
# On docker
docker run --rm -v "${PWD}":/config -it ghcr.io/esphome/esphome run livingroom.yaml

2
guides/migrate_espeasy.rst
View File

@ -19,7 +19,7 @@ file. Then, generate and download the binary:
.. figure:: images/download_binary.png
- **Using the command line**: run ``esphome livingroom.yaml compile`` (replacing
- **Using the command line**: run ``esphome compile livingroom.yaml`` (replacing
``livingroom.yaml`` with your configuration file of course) and navigate to the
``<NODE_NAME>/.pioenvs/<NODE_NAME>/`` folder. There you will find a ``firmware.bin`` file,
this is the binary you will upload.

2
guides/migrate_espurna.rst
View File

@ -20,7 +20,7 @@ file. Then, generate and download the binary:
.. figure:: images/download_binary.png
- **Using the command line**: run ``esphome livingroom.yaml compile`` (replacing
- **Using the command line**: run ``esphome compile livingroom.yaml`` (replacing
``livingroom.yaml`` with your configuration file of course) and navigate to the
``<NODE_NAME>/.pioenvs/<NODE_NAME>/`` folder. There you will find a ``firmware.bin`` file,
this is the binary you will upload.

14
guides/supporters.rst
View File

@ -122,6 +122,7 @@ Contributors
- `arunderwood (@arunderwood) <https://github.com/arunderwood>`__
- `Arya (@Arya11111) <https://github.com/Arya11111>`__
- `aschmitz (@aschmitz) <https://github.com/aschmitz>`__
- `Anton Sergunov (@asergunov) <https://github.com/asergunov>`__
- `Borys Pierov (@ashald) <https://github.com/ashald>`__
- `Ash McKenzie (@ashmckenzie) <https://github.com/ashmckenzie>`__
- `ashp8i (@ashp8i) <https://github.com/ashp8i>`__
@ -259,6 +260,7 @@ Contributors
- `cg089 (@cg089) <https://github.com/cg089>`__
- `Audric Schiltknecht (@chemicalstorm) <https://github.com/chemicalstorm>`__
- `Charles Johnson (@ChemicalXandco) <https://github.com/ChemicalXandco>`__
- `chiahsing (@chiahsing) <https://github.com/chiahsing>`__
- `chris-jennings (@chris-jennings) <https://github.com/chris-jennings>`__
- `Chris (@chrismaki) <https://github.com/chrismaki>`__
- `Christoph Wagner (@Christoph-Wagner) <https://github.com/Christoph-Wagner>`__
@ -319,6 +321,7 @@ Contributors
- `Daniel Bjørnbakk (@danibjor) <https://github.com/danibjor>`__
- `Daniel Baulig (@DanielBaulig) <https://github.com/DanielBaulig>`__
- `danielionutmuresan (@danielionutmuresan) <https://github.com/danielionutmuresan>`__
- `Daniel Kent (@danielkent-net) <https://github.com/danielkent-net>`__
- `Daniel Kucera (@danielkucera) <https://github.com/danielkucera>`__
- `Daniel O'Connor (@DanielO) <https://github.com/DanielO>`__
- `Daniel Rheinbay (@danielrheinbay) <https://github.com/danielrheinbay>`__
@ -350,7 +353,6 @@ Contributors
- `Davy Landman (@DavyLandman) <https://github.com/DavyLandman>`__
- `Dawid Cieszyński (@dawidcieszynski) <https://github.com/dawidcieszynski>`__
- `Darren Tucker (@daztucker) <https://github.com/daztucker>`__
- `Donovan Baarda (@dbaarda) <https://github.com/dbaarda>`__
- `David Buezas (@dbuezas) <https://github.com/dbuezas>`__
- `dckiller51 (@dckiller51) <https://github.com/dckiller51>`__
- `Daniel Correa Lobato (@dclobato) <https://github.com/dclobato>`__
@ -392,7 +394,6 @@ Contributors
- `Dan Mannock (@dmannock) <https://github.com/dmannock>`__
- `Dmitriy Lopatko (@dmitriy5181) <https://github.com/dmitriy5181>`__
- `Tristan Rowley (@doctea) <https://github.com/doctea>`__
- `DrZoid (@docteurzoidberg) <https://github.com/docteurzoidberg>`__
- `DominikBitzer (@DominikBitzer) <https://github.com/DominikBitzer>`__
- `Dominik (@DomiStyle) <https://github.com/DomiStyle>`__
- `Don Burch (@donburch888) <https://github.com/donburch888>`__
@ -452,8 +453,8 @@ Contributors
- `Elkropac (@Elkropac) <https://github.com/Elkropac>`__
- `Elliot Wood (@elliot-wood) <https://github.com/elliot-wood>`__
- `Eduard Llull (@ellull) <https://github.com/ellull>`__
- `Joakim Plate (@elupus) <https://github.com/elupus>`__
- `Andrew Elwell (@Elwell) <https://github.com/Elwell>`__
- `EmbeddedDevver (@EmbeddedDevver) <https://github.com/EmbeddedDevver>`__
- `EmmanuelLM (@EmmanuelLM) <https://github.com/EmmanuelLM>`__
- `Emory Dunn (@emorydunn) <https://github.com/emorydunn>`__
- `Eric van Blokland (@Emrvb) <https://github.com/Emrvb>`__
@ -727,7 +728,6 @@ Contributors
- `AngeloGioacchino Del Regno (@kholk) <https://github.com/kholk>`__
- `Kilowatt (@Kilowatt-W) <https://github.com/Kilowatt-W>`__
- `Kip (@kipwittchen) <https://github.com/kipwittchen>`__
- `Ed (@kixtarter) <https://github.com/kixtarter>`__
- `Klaas Schoute (@klaasnicolaas) <https://github.com/klaasnicolaas>`__
- `Klarstein (@Klarstein) <https://github.com/Klarstein>`__
- `Marcus Klein (@kleini) <https://github.com/kleini>`__
@ -752,7 +752,6 @@ Contributors
- `Ludovic BOUÉ (@lboue) <https://github.com/lboue>`__
- `lcavalli (@lcavalli) <https://github.com/lcavalli>`__
- `Craig Fletcher (@leakypixel) <https://github.com/leakypixel>`__
- `Dominik Wagenknecht (@LeDominik) <https://github.com/LeDominik>`__
- `Benny de Leeuw (@leeuwte) <https://github.com/leeuwte>`__
- `Thayne (@Legot) <https://github.com/Legot>`__
- `Leonardo La Rocca (@leoli51) <https://github.com/leoli51>`__
@ -1023,6 +1022,7 @@ Contributors
- `Jan Pluskal (@pluskal) <https://github.com/pluskal>`__
- `DK (@poldim) <https://github.com/poldim>`__
- `poloswiss (@poloswiss) <https://github.com/poloswiss>`__
- `polyfloyd (@polyfloyd) <https://github.com/polyfloyd>`__
- `Pontus Oldberg (@PontusO) <https://github.com/PontusO>`__
- `poptix (@poptix) <https://github.com/poptix>`__
- `Peter Provost (@PProvost) <https://github.com/PProvost>`__
@ -1159,6 +1159,7 @@ Contributors
- `Niklas Wagner (@Skaronator) <https://github.com/Skaronator>`__
- `Brian Slesinsky (@skybrian) <https://github.com/skybrian>`__
- `Jordan W. Cobb (@skykingjwc) <https://github.com/skykingjwc>`__
- `slimeinacloak (@slimeinacloak) <https://github.com/slimeinacloak>`__
- `Sebastian Lövdahl (@slovdahl) <https://github.com/slovdahl>`__
- `smischny (@smischny) <https://github.com/smischny>`__
- `John Mueller (@softplus) <https://github.com/softplus>`__
@ -1345,9 +1346,10 @@ Contributors
- `Brynley McDonald (@ZephireNZ) <https://github.com/ZephireNZ>`__
- `Stefan Goethals (@zipkid) <https://github.com/zipkid>`__
- `zivillian (@zivillian) <https://github.com/zivillian>`__
- `zry98 (@zry98) <https://github.com/zry98>`__
- `Zack Barett (@zsarnett) <https://github.com/zsarnett>`__
- `Zsolt Zsiros (@ZsZs73) <https://github.com/ZsZs73>`__
- `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
- `Zynth-dev (@Zynth-dev) <https://github.com/Zynth-dev>`__
*This page was last updated April 23, 2024.*
*This page was last updated April 30, 2024.*

BIN
images/graphical_display_menu.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 14 KiB

BIN
images/graphical_display_menu.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 10 KiB

524
index.rst
View File

@ -121,41 +121,112 @@ ESPHome is a system to control your microcontrollers by simple yet powerful conf
.. _devices:
Platforms
---------
Supported Microcontrollers
--------------------------
.. imgtable::
ESP8266, components/esp8266, esp8266.svg
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
Core Components
---------------
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 Components
------------------
ESPHome-specific components or components supporting ESPHome device provisioning post-installation.
.. imgtable::
Core, components/esphome, cloud-circle.svg, dark-invert
PSRAM, components/psram, psram.svg
WiFi, components/wifi, network-wifi.svg, dark-invert
Network, components/network, network-wifi.svg, dark-invert
I²C Bus, components/i2c, i2c.svg
SPI Bus, components/spi, spi.svg
UART Bus, components/uart, uart.svg
CAN Bus, components/canbus, canbus.svg
MQTT, components/mqtt, mqtt.png
OTA Updates, components/ota, system-update.svg, dark-invert
Logger, components/logger, file-document-box.svg, dark-invert
Web Server, components/web_server, http.svg, dark-invert
Native API, components/api, server-network.svg, dark-invert
Power Supply, components/power_supply, power.svg, dark-invert
Deep Sleep, components/deep_sleep, hotel.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
Improv via BLE, components/esp32_improv, improv.svg, dark-invert
Improv via Serial, components/improv_serial, improv.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
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
OTA Updates, components/ota, system-update.svg, dark-invert
Prometheus, components/prometheus, prometheus.svg
Web Server, components/web_server, http.svg, dark-invert
ESP32 Camera Web Server, components/esp32_camera_web_server, camera.svg, dark-invert
Hardware Peripheral Interfaces/Busses
-------------------------------------
.. imgtable::
CAN Bus, components/canbus, canbus.svg
I²C Bus, components/i2c, i2c.svg
I²S Audio, components/i2s_audio, i2s_audio.svg
SPI Bus, components/spi, spi.svg
UART, components/uart, uart.svg
I/O Expanders/Multiplexers
--------------------------
.. imgtable::
MAX6956 - I²C Bus, components/max6956, max6956.jpg
MCP230XX - I²C Bus, components/mcp230xx, mcp230xx.svg
MCP23SXX - SPI Bus, components/mcp23Sxx, mcp230xx.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
XL9535, components/xl9535, xl9535.svg
Sensor Components
-----------------
@ -164,19 +235,19 @@ Sensors are split into categories. If a sensor fits into more than one category,
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
Template Sensor, components/sensor/template, description.svg, dark-invert
Custom Sensor, components/sensor/custom, language-cpp.svg, dark-invert
Air Quality
***********
.. imgtable::
AGS10, components/sensor/ags10, ags10.jpg, Volatile Organic Compound Sensor
@ -186,18 +257,19 @@ Air Quality
ENS160, components/sensor/ens160, ens160.jpg, CO2 & Air Quality
GCJA5, components/sensor/gcja5, gcja5.svg, Particulate
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 and NOx
SenseAir, components/sensor/senseair, senseair_s8.jpg, CO2
SCD30, components/sensor/scd30, scd30.jpg, CO2 & Temperature & Humidity
SCD4X, components/sensor/scd4x, scd4x.jpg, CO2 & Temperature & Humidity
SFA30, components/sensor/sfa30, sfa30.jpg, Formaldehyde
SGP30, components/sensor/sgp30, sgp30.jpg, CO2 & Volatile organics
SGP4x, components/sensor/sgp4x, sgp40.jpg, Volatile organics and NOx
@ -205,11 +277,10 @@ 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
iAQ-Core, components/sensor/iaqcore, iaqcore.jpg, CO2 & Volatile organics
Analogue
********
.. imgtable::
ADC, components/sensor/adc, flash.svg, ESP internal, dark-invert
@ -221,25 +292,25 @@ Analogue
MCP3204 / MCP3208, components/sensor/mcp3204, mcp3204.jpg, 4-channel 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
HHCCJCY10 (MiFlora Pink), components/sensor/xiaomi_hhccjcy10, xiaomi_hhccjcy10.jpg, Soil moisture & Temperature & Light
Alpha3, components/sensor/alpha3, alpha3.jpg
Digital Signals
***************
.. imgtable::
Duty Cycle, components/sensor/duty_cycle, percent.svg, dark-invert
@ -247,22 +318,23 @@ Digital Signals
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
JSN-SR04T, components/sensor/jsn_sr04t, jsn-sr04t-v3.jpg, Acoustic distance
Electricity
***********
.. imgtable::
ADE7880, components/sensor/ade7880, ade7880.svg, Voltage & Current & Power
@ -293,7 +365,6 @@ Electricity
Teleinfo, components/sensor/teleinfo, teleinfo.jpg, Electrical counter
Total Daily Energy, components/sensor/total_daily_energy, sigma.svg, dark-invert
Environmental
*************
@ -304,14 +375,14 @@ Environmental
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
BME680, components/sensor/bme680, 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
b-parasite, components/sensor/b_parasite, b_parasite.jpg, Moisture & Temperature & Humidity & Light
Dallas DS18B20, components/sensor/dallas, dallas.jpg, Temperature
DHT, components/sensor/dht, dht.jpg, Temperature & Humidity
DHT12, components/sensor/dht12, dht12.jpg, Temperature & Humidity
@ -321,13 +392,14 @@ Environmental
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
HTE501, components/sensor/hte501, HTE501.png, Temperature & Humidity
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
@ -352,14 +424,13 @@ Environmental
STS3X, components/sensor/sts3x, sts3x.jpg, Temperature
TEE501, components/sensor/tee501, TEE501.png, Temperature
TMP102, components/sensor/tmp102, tmp102.jpg, Temperature
TMP117, components/sensor/tmp117, tmp117.jpg, Temperature
TMP1075, components/sensor/tmp1075, tmp1075.jpg, Temperature
HYT271, components/sensor/hyt271, hyt271.jpg, Temperature & Humidity
TMP117, components/sensor/tmp117, tmp117.jpg, Temperature
XGZP68xx Series, components/sensor/xgzp68xx, 6897d.jpg, Differential Pressure
Light
*****
.. imgtable::
AM43, components/sensor/am43, am43.jpg, Lux
@ -375,65 +446,65 @@ Light
VEML6030, components/sensor/veml7700, veml6030.jpg, Lux
VEML7700, components/sensor/veml7700, veml7700.jpg, Lux
Magnetic
********
.. imgtable::
ESP32 Hall Sensor, components/sensor/esp32_hall, magnet.svg, ESP internal, dark-invert
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
MLX90393, components/sensor/mlx90393, mlx90393.jpg, 3-Axis magnetometer
QMC5883L, components/sensor/qmc5883l, qmc5883l.jpg, 3-Axis magnetometer
Miscellaneous
*************
.. imgtable::
AS3935, components/sensor/as3935, as3935.jpg, Storm lightning
Binary Sensor Map, components/sensor/binary_sensor_map, binary_sensor_map.jpg, Map binary to value
b-parasite, components/sensor/b_parasite, b_parasite.jpg, Moisture & Temperature & Humidity & Light
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
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
Growatt Solar, components/sensor/growatt_solar, growatt.jpg, Solar rooftop
Kuntze pool sensor, components/sensor/kuntze, kuntze.jpg
MicroNova pellet stove, components/micronova, pellet.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
Resol VBus, components/vbus, resol_deltasol_bs_plus.jpg
Person Sensor (SEN21231), components/sensor/sen21231, sen21231.png
Kuntze pool sensor, components/sensor/kuntze, kuntze.jpg
WireGuard, components/wireguard, wireguard_custom_logo.svg
MicroNova pellet stove, components/micronova, pellet.svg
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
Seeed Studio MR24HPC1 mmWave, components/seeed_mr24hpc1, seeed-mr24hpc1.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,
@ -443,9 +514,9 @@ Thermocouple
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
@ -464,17 +535,18 @@ Binary Sensors are split into categories. If a sensor fits into more than one ca
Core
****
.. imgtable::
Binary Sensor Core, components/binary_sensor/index, folder-open.svg, dark-invert
Custom Binary Sensor, components/binary_sensor/custom, language-cpp.svg, dark-invert
Template Binary Sensor, components/binary_sensor/template, description.svg, dark-invert
GPIO, components/binary_sensor/gpio, pin.svg, dark-invert
Home Assistant, components/binary_sensor/homeassistant, home-assistant.svg, dark-invert
Status, components/binary_sensor/status, server-network.svg, dark-invert
Template Binary Sensor, components/binary_sensor/template, description.svg, dark-invert
Capacitive Touch
****************
.. imgtable::
CAP1188 Capacitive Touch Sensor, components/binary_sensor/cap1188, cap1188.jpg
@ -484,14 +556,15 @@ Capacitive Touch
Mechanical
**********
.. imgtable::
Matrix Keypad, components/matrix_keypad, matrix_keypad.jpg
TM1637, components/display/tm1637, tm1637.jpg
TM1638, components/display/tm1638, tm1638.jpg
NFC/RFID Components
*******************
NFC/RFID
********
Often known as "tag" or "card" readers within the community.
@ -503,29 +576,33 @@ Often known as "tag" or "card" readers within the community.
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::
Nextion Binary Sensor, components/binary_sensor/nextion, nextion.jpg
Touchscreen, components/touchscreen/index, touch.svg, dark-invert
TT21100, components/touchscreen/tt21100, esp32-s3-korvo-2-lcd.png
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
Presence Detection
******************
.. imgtable::
DFRobot mmWave Radar, components/dfrobot_sen0395, dfrobot_sen0395.jpg
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
@ -546,36 +623,35 @@ Output Components
.. imgtable::
Output Core, components/output/index, folder-open.svg, dark-invert
ESP8266 Software PWM, components/output/esp8266_pwm, pwm.png
Slow PWM, components/output/slow_pwm, pwm.png
GPIO Output, components/output/gpio, pin.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, pin.svg, dark-invert
LibreTiny PWM, components/output/libretiny_pwm, pwm.png
AC Dimmer, components/output/ac_dimmer, ac_dimmer.svg, dark-invert
PCA9685, components/output/pca9685, pca9685.jpg
TLC59208F, components/output/tlc59208f, tlc59208f.jpg
TLC5947, components/output/tlc5947, tlc5947.jpg
TLC5971, components/output/tlc5971, tlc5971.jpg
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
MCP4725, components/output/mcp4725, mcp4725.jpg
MCP4728, components/output/mcp4728, mcp4728.jpg
MCP47A1, components/output/mcp47a1, mcp47a1.svg
DAC7678, components/output/dac7678, dac7678.svg
BLE Binary Output, components/output/ble_client, bluetooth.svg, dark-invert
Modbus Output, components/output/modbus_controller, modbus.png
Custom Output, components/output/custom, language-cpp.svg, dark-invert
Sigma-Delta Output, components/output/sigma_delta_output, sigma-delta.svg, dark-invert
Template Output, components/output/template, description.svg, dark-invert
BP1658CJ, components/output/bp1658cj, bp1658cj.svg
BP5758D, components/output/bp5758d, bp5758d.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
GP8403, components/output/gp8403, gp8403.svg
EMC2101, components/emc2101, emc2101.jpg
Light Components
----------------
@ -584,33 +660,29 @@ Light Components
Light Core, components/light/index, folder-open.svg, dark-invert
Binary Light, components/light/binary, lightbulb.svg, dark-invert
Status Led, components/light/status_led, led-on.svg, dark-invert
Monochromatic Light, components/light/monochromatic, brightness-medium.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
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
RGBCT Light, components/light/rgbct, rgbw.png
ESP32 RMT, components/light/esp32_rmt_led_strip, color_lens.svg, dark-invert
RP2040 PIO, components/light/rp2040_pio_led_strip, color_lens.svg, dark-invert
FastLED Light, components/light/fastled, color_lens.svg, dark-invert
NeoPixelBus Light, components/light/neopixelbus, color_lens.svg, dark-invert
Light Partition, components/light/partition, color_lens.svg, dark-invert
SPI LED Strips, components/light/spi_led_strip, apa102.jpg
Tuya Dimmer, components/light/tuya, tuya.png
Shelly Dimmer, components/light/shelly_dimmer, shellydimmer2.jpg
Custom Light, components/light/custom, language-cpp.svg, dark-invert
LightWaveRF, components/lightwaverf, brightness-medium.svg
H-bridge Light, components/light/hbridge, brightness-medium.svg, dark-invert
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? Have a look at the
:doc:`FastLED Light </components/light/fastled>`.
**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 </components/light/fastled>`.
Switch Components
-----------------
@ -618,19 +690,18 @@ 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, pin.svg, dark-invert
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
Factory Reset Switch, components/switch/factory_reset, restart-alert.svg, dark-invert
Generic Output Switch, components/switch/output, upload.svg, dark-invert
Template Switch, components/switch/template, description.svg, dark-invert
UART Switch, components/switch/uart, uart.svg
Custom Switch, components/switch/custom, language-cpp.svg, dark-invert
Tuya Switch, components/switch/tuya, tuya.png
Modbus Switch, components/switch/modbus_controller, modbus.png
BLE Client Switch, components/switch/ble_client, bluetooth.svg, dark-invert
Nextion Switch, components/switch/nextion, nextion.jpg
UART Switch, components/switch/uart, uart.svg
Button Components
-----------------
@ -639,14 +710,13 @@ Button Components
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
Factory Reset Button, components/button/factory_reset, restart-alert.svg, dark-invert
Wake-on-LAN, components/button/wake_on_lan, 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
Fan Components
--------------
@ -654,11 +724,11 @@ 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
Template Fan, components/fan/template, description.svg, dark-invert
Display Components
------------------
@ -666,7 +736,17 @@ Display Components
.. imgtable::
Display Core, components/display/index, folder-open.svg, dark-invert
Display Menu Core, components/display_menu/index, folder-open.svg, dark-invert
Font Renderer, components/display/fonts, format-font.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
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
@ -675,15 +755,14 @@ Display Components
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, components/display/max7219, max7219.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
Quad SPI AMOLED, components/display/qspi_amoled, t4-s3.jpg
PVVX MiThermometer, components/display/pvvx_mithermometer, ../components/sensor/images/xiaomi_lywsd03mmc.jpg
Quad SPI AMOLED, components/display/qspi_amoled, 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
@ -692,14 +771,15 @@ Display Components
SSD1331, components/display/ssd1331, ssd1331.jpg
SSD1351, components/display/ssd1351, ssd1351.jpg
ST7567, components/display/st7567, st7567.jpg
ST7735, components/display/st7735, st7735.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
Touchscreen Components
@ -708,14 +788,14 @@ Touchscreen Components
.. imgtable::
Touchscreen Core, components/touchscreen/index, folder-open.svg, dark-invert
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
CST226, components/touchscreen/cst226, t4-s3.jpg
GT911, components/touchscreen/gt911, esp32_s3_box_3.png
FT63X6, components/touchscreen/ft63x6, wt32-sc01.png
Cover Components
----------------
@ -724,14 +804,21 @@ Cover Components
Cover Core, components/cover/index, folder-open.svg, dark-invert
Template Cover, components/cover/template, description.svg, dark-invert
Feedback Cover, components/cover/feedback, feedback_cover.svg, dark-invert
Endstop Cover, components/cover/endstop, electric-switch.svg, dark-invert
Current-Based Cover, components/cover/current_based, flash.svg, dark-invert
Time-Based Cover, components/cover/time_based, timer.svg, dark-invert
Custom Cover, components/cover/custom, language-cpp.svg, dark-invert
AM43 Cover, components/cover/am43, am43.jpg
Tuya Cover, components/cover/tuya, tuya.png
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
Text Components
---------------
.. imgtable::
Text Core, components/text/index, folder-open.svg, dark-invert
Template Text, components/text/template, description.svg, dark-invert
Text Sensor Components
----------------------
@ -739,20 +826,19 @@ Text Sensor Components
.. imgtable::
Text Sensor Core, components/text_sensor/index, folder-open.svg, dark-invert
Home Assistant, components/text_sensor/homeassistant, home-assistant.svg, dark-invert
MQTT Subscribe Text, components/text_sensor/mqtt_subscribe, mqtt.png
Version, components/text_sensor/version, new-box.svg, dark-invert
WiFi Info, components/text_sensor/wifi_info, network-wifi.svg, dark-invert
Ethernet Info, components/text_sensor/ethernet_info, ethernet.svg, dark-invert
BLE Scanner, components/text_sensor/ble_scanner, bluetooth.svg, dark-invert
Modbus Text Sensor, components/text_sensor/modbus_controller, modbus.png
Template Text Sensor, components/text_sensor/template, description.svg, dark-invert
Custom Text Sensor, components/text_sensor/custom, language-cpp.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
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
WL-134 Pet Tag Sensor , components/text_sensor/wl_134, fingerprint.svg, dark-invert
LibreTiny, components/text_sensor/libretiny, libretiny.svg
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
WL-134 Pet Tag Sensor , components/text_sensor/wl_134, fingerprint.svg, dark-invert
Climate Components
------------------
@ -760,16 +846,15 @@ Climate Components
.. imgtable::
Climate Core, components/climate/index, folder-open.svg, dark-invert
Bang Bang Controller, components/climate/bang_bang, air-conditioner.svg, dark-invert
Thermostat Controller, components/climate/thermostat, air-conditioner.svg, dark-invert
Custom Climate, components/climate/custom, language-cpp.svg, dark-invert
PID Controller, components/climate/pid, function.svg, dark-invert
IR Remote Climate, components/climate/climate_ir, air-conditioner-ir.svg, dark-invert
Tuya Climate, components/climate/tuya, tuya.png
Midea, components/climate/midea, midea.svg
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
Number Components
@ -778,8 +863,8 @@ Number Components
.. imgtable::
Number Core, components/number/index, folder-open.svg, dark-invert
Modbus Number, components/number/modbus_controller, modbus.png
Template Number, components/number/template, description.svg, dark-invert
Modbus Number, components/number/modbus_controller, modbus.png
Tuya Number, components/number/tuya, tuya.png
Select Components
@ -798,16 +883,8 @@ Lock Components
.. imgtable::
Lock Core, components/lock/index, folder-open.svg, dark-invert
Generic Output Lock, components/lock/output, upload.svg, dark-invert
Template Lock, components/lock/template, description.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
Generic Output Lock, components/lock/output, upload.svg, dark-invert
Media Player Components
-----------------------
@ -815,6 +892,7 @@ 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
Microphone Components
@ -839,24 +917,26 @@ Time Components
.. imgtable::
Time Core, components/time/index, clock-outline.svg, dark-invert
Home Assistant Time, components/time/homeassistant, home-assistant.svg, dark-invert
SNTP, components/time/sntp, clock-outline.svg, dark-invert
GPS Time, components/time/gps, crosshairs-gps.svg, dark-invert
DS1307 RTC, components/time/ds1307, clock-outline.svg, dark-invert
PCF8563 RTC, components/time/pcf8563, 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
Home Assistant Companion Components
-----------------------------------
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
Voice Assistant, components/voice_assistant, voice-assistant.svg, dark-invert
micro Wake Word, components/micro_wake_word, voice-assistant.svg, dark-invert
Sensor, components/sensor/homeassistant, home-assistant.svg, dark-invert
Text Sensor, components/text_sensor/homeassistant, home-assistant.svg, dark-invert
Binary Sensor, components/binary_sensor/homeassistant, home-assistant.svg, dark-invert
Voice Assistant, components/voice_assistant, voice-assistant.svg, dark-invert
Alarm Control Panel Components
@ -875,81 +955,75 @@ Datetime Components
Datetime Core, components/datetime/index, clock-outline.svg, dark-invert
Template Datetime, components/datetime/template, description.svg, dark-invert
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
Electromechanical
-----------------
.. imgtable::
Atlas Scientific Peristaltic Pump, components/ezo_pmp, ezo-pmp.jpg
Grove TB6612FNG, components/grove_tb6612fng, motor.png
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
Wireless Communication
----------------------
Wireless communication that is **not 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::
Remote Receiver, components/remote_receiver, remote.svg, dark-invert
Remote Transmitter, components/remote_transmitter, remote.svg, dark-invert
Status LED, components/status_led, led-on.svg, dark-invert
Display Menu Core, components/display_menu/index, folder-open.svg, dark-invert
LCD Menu, components/display_menu/lcd_menu, lcd_menu.png
Graphical Display Menu, components/display_menu/graphical_display_menu, graphical_display_menu.jpg
Matrix Keypad, components/matrix_keypad, matrix_keypad.jpg
Wiegand Reader, components/wiegand, wiegand.jpg
HTTP Request, components/http_request, connection.svg, dark-invert
mDNS, components/mdns, radio-tower.svg, dark-invert
Sun, components/sun, weather-sunny.svg, dark-invert
GPS, components/gps, crosshairs-gps.svg, dark-invert
Bluetooth Proxy, components/bluetooth_proxy, 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
ESP32 BLE Beacon, components/esp32_ble_beacon, bluetooth.svg, dark-invert
ESP32 Ethernet, components/ethernet, ethernet.svg, dark-invert
ESP32 Camera, components/esp32_camera, camera.svg, dark-invert
ESP32 Camera Web Server, components/esp32_camera_web_server, camera.svg, dark-invert
I²S Audio, components/i2s_audio, i2s_audio.svg
Stepper, components/stepper/index, stepper.svg
Servo, components/servo, servo.svg
Sprinkler, components/sprinkler, sprinkler-variant.svg, dark-invert
Grove TB6612FNG, components/grove_tb6612fng, motor.png
PCA6416A I/O Expander, components/pca6416a, pca6416a.svg
PCA9554 I/O Expander, components/pca9554, pca9554a.jpg
PCF8574 I/O Expander, components/pcf8574, pcf8574.jpg
MAX6956 I/O expander - I²C Bus, components/max6956, max6956.jpg
MCP230XX I/O Expander - I²C Bus, components/mcp230xx, mcp230xx.svg
TCA9548A I²C Multiplexer, components/tca9548a, tca9548a.jpg
MCP23SXX I/O Expander - SPI Bus, components/mcp23Sxx, mcp230xx.svg
SX1509 I/O Expander, components/sx1509, sx1509.jpg
SN74HC165 I/O Expander, components/sn74hc165, sn74hc595.jpg
SN74HC595 I/O Expander, components/sn74hc595, sn74hc595.jpg
XL9535 I/O Expander, components/xl9535, xl9535.svg
SIM800L, components/sim800l, sim800l.jpg
DFPlayer, components/dfplayer, dfplayer.svg, dark-invert
Captive Portal, components/captive_portal, wifi-strength-alert-outline.svg, dark-invert
Improv via BLE, components/esp32_improv, improv.svg, dark-invert
Improv via Serial, components/improv_serial, improv.svg, dark-invert
Debug Component, components/debug, bug-report.svg, dark-invert
TM1651 Battery Display, components/tm1651, tm1651_battery_display.jpg
RF Bridge, components/rf_bridge, rf_bridge.jpg
Tuya MCU, components/tuya, tuya.png
Modbus Controller, components/modbus_controller, modbus.png
Exposure Notifications, components/exposure_notifications, exposure_notifications.png
RTTTL Buzzer, components/rtttl, buzzer.jpg
Prometheus, components/prometheus, prometheus.svg
PipSolar - compatible PV Inverter, components/pipsolar, pipsolar.jpg
GPS, components/gps, crosshairs-gps.svg, dark-invert
Grow Fingerprint Reader, components/fingerprint_grow, fingerprint.svg, dark-invert
SML, components/sml, sml.svg
SUN-GTIL2 inverter, components/sun_gtil2, sun_1000g2.png
Atlas Scientific Peristaltic Pump, components/ezo_pmp, ezo-pmp.jpg
Resol VBus, components/vbus, resol_deltasol_bs_plus.jpg
WireGuard, components/wireguard, wireguard_custom_logo.svg
Demo, components/demo, description.svg, dark-invert
Copy, components/copy, content-copy.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
Additional Custom Components
----------------------------
Custom Components
-----------------
**Note: Custom Components are deprecated in favor of** :doc:`components/external_components`!
.. imgtable::
Generic Custom Component, custom/custom_component, language-cpp.svg, dark-invert
Custom Binary Sensor, components/binary_sensor/custom, language-cpp.svg, dark-invert
Custom Climate, components/climate/custom, language-cpp.svg, dark-invert
Custom Cover, components/cover/custom, language-cpp.svg, dark-invert
Custom Light, components/light/custom, language-cpp.svg, dark-invert
Custom Output, components/output/custom, language-cpp.svg, dark-invert
Custom Sensor, components/sensor/custom, language-cpp.svg, dark-invert
Custom Switch, components/switch/custom, language-cpp.svg, dark-invert
Custom Text Sensor, components/text_sensor/custom, language-cpp.svg, dark-invert
Custom I²C Component, custom/i2c, language-cpp.svg, dark-invert
Custom SPI Component, custom/spi, language-cpp.svg, dark-invert
Custom UART Component, custom/uart, language-cpp.svg, dark-invert