Document host platform (#3893)

In the event.on_event automation, the event type that triggered the event is accesible using the event_type variable.

.github/workflows/docker.yml

@@ -18,9 +18,14 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
+      -
+        name: Install pagefind
+        uses: jaxxstorm/action-install-gh-release@v1.12.0
+        with:
+          repo: cloudcannon/pagefind
       -
         name: Checkout source code
-        uses: actions/checkout@v4.1.0
+        uses: actions/checkout@v4.1.6
       -
         name: Set up QEMU
         uses: docker/setup-qemu-action@v3

.github/workflows/lint.yml

@@ -19,7 +19,11 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4.1.0
+    - name: Install pagefind
+      uses: jaxxstorm/action-install-gh-release@v1.12.0
+      with:
+          repo: cloudcannon/pagefind
+    - uses: actions/checkout@v4.1.6
     - name: Set up Python 3.8
       uses: actions/setup-python@v5
       with:

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.8-slim
+FROM python:3.12-slim
 
 RUN apt-get update && apt-get install -y --no-install-recommends \
         curl \
@@ -9,10 +9,25 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
         software-properties-common \
         && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/*
 
-COPY requirements.txt .
+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
 
 EXPOSE 8000
-WORKDIR /data/esphomedocs
 
 CMD ["make", "live-html"]
+
+LABEL \
+        org.opencontainers.image.title="esphome-docs" \
+        org.opencontainers.image.description="An image to help with ESPHomes documentation development" \
+        org.opencontainers.image.vendor="ESPHome" \
+        org.opencontainers.image.licenses="CC BY-NC-SA 4.0" \
+        org.opencontainers.image.url="https://esphome.io" \
+        org.opencontainers.image.source="https://github.com/esphome/esphome-docs" \
+        org.opencontainers.image.documentation="https://github.com/esphome/esphome-docs/blob/current/README.md"

Doxygen

@@ -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.0b3
+PROJECT_NUMBER         = 2024.5.4
 
 # 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

Makefile

@@ -1,15 +1,24 @@
 ESPHOME_PATH = ../esphome
-ESPHOME_REF = 2024.4.0b3
+ESPHOME_REF = 2024.5.4
+PAGEFIND_VERSION=1.1.0
+PAGEFIND=pagefind
+NET_PAGEFIND=../pagefindbin/pagefind
 
-.PHONY: html html-strict cleanhtml deploy help live-html Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify
+.PHONY: html html-strict cleanhtml deploy help live-html live-pagefind Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify
 
 html:
 	sphinx-build -M html . _build -j auto -n $(O)
-live-html:
+	${PAGEFIND}
+
+live-html:	html
 	sphinx-autobuild . _build -j auto -n $(O) --host 0.0.0.0
 
+live-pagefind:	html
+	${PAGEFIND} --serve
+
 html-strict:
 	sphinx-build -M html . _build -W -j auto -n $(O)
+	${PAGEFIND}
 
 minify:
 	minify _static/webserver-v1.js > _static/webserver-v1.min.js
@@ -32,6 +41,10 @@ api:
 	fi
 	ESPHOME_PATH=$(ESPHOME_PATH) doxygen Doxygen
 
+net-html:
+	sphinx-build -M html . _build -j auto -n $(O)
+	${NET_PAGEFIND}
+
 netlify-api: netlify-dependencies
 	mkdir -p _build/html/api
 	@if [ ! -d "$(ESPHOME_PATH)" ]; then \
@@ -40,15 +53,23 @@ netlify-api: netlify-dependencies
 	fi
 	ESPHOME_PATH=$(ESPHOME_PATH) ../doxybin/doxygen Doxygen
 
-netlify-dependencies:
+netlify-dependencies: pagefind-binary
 	mkdir -p ../doxybin
 	curl -L https://github.com/esphome/esphome-docs/releases/download/v1.10.1/doxygen-1.8.13.xz | xz -d >../doxybin/doxygen
 	chmod +x ../doxybin/doxygen
 
+pagefind-binary:
+	mkdir -p ../pagefindbin
+	curl -o pagefind-v$(PAGEFIND_VERSION)-x86_64-unknown-linux-musl.tar.gz https://github.com/CloudCannon/pagefind/releases/download/v$(PAGEFIND_VERSION)/pagefind-v$(PAGEFIND_VERSION)-x86_64-unknown-linux-musl.tar.gz -L
+	tar xzf pagefind-v$(PAGEFIND_VERSION)-x86_64-unknown-linux-musl.tar.gz
+	rm pagefind-v$(PAGEFIND_VERSION)-x86_64-unknown-linux-musl.tar.gz
+	mv pagefind ${NET_PAGEFIND}
+
+
 copy-svg2png:
 	cp svg2png/*.png _build/html/_images/
 
-netlify: netlify-dependencies netlify-api html copy-svg2png
+netlify: netlify-dependencies netlify-api net-html copy-svg2png
 
 lint: html-strict
 	python3 lint.py

_static/custom.css

@@ -1,3 +1,9 @@
+/* provide this to be queried in JS. Sadly can't be used in media-queries just yet*/
+
+:root {
+  --mobile-width-stop: 875;
+}
+
 .row-odd {
   background-color: #f3f6f6;
 }
@@ -240,9 +246,56 @@ 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;
 }
+.pagefind-ui__form {
+    width: 100%;
+    max-width: 300px;
+    left: auto;
+    right: auto;
+    position: relative;
+}
+
+.pagefind-modular-list-excerpt, .pagefind-modular-list-title {
+    color: #111111 !important;
+}
+
+.search-results {
+    background-color: #f8f8f8;
+    box-shadow: 0 6px 10px rgb(0 0 0 / 0.2);
+    position: fixed;
+    z-index: 1500;
+    padding-right: 6px;
+    padding-left: 6px;
+    border-radius: 12px;
+    overflow: auto;
+    width: 0;
+    height: fit-content;
+    max-width: 650px;
+    transition: height, width 0.1s ease-in-out;
+    display: none;
+}
+
+@media screen and (max-width: 875px) {
+  /* hide search result thumbnails on mobile */
+  .pagefind-modular-list-thumb {
+    width: 0;
+  }
+  /* reduce height of search box */
+  .pagefind-modular-input-wrapper {
+    scale: 90%;
+  }
+  .logo {
+    scale: 60%;
+  }
+}
+
 
 /* dark theme */
 @media (prefers-color-scheme: dark) {
@@ -339,4 +392,25 @@ div.body p, div.body dd, div.body li, div.body blockquote {
     background-color: #8e8129;
   }
 
+  .search-results {
+    background-color: #313131;
+    box-shadow: 0 6px 10px rgb(0 0 0 / 0.8);
+  }
+  .pagefind-modular-list-excerpt, .pagefind-modular-list-title {
+      color: #eeeeee !important;
+  }
+
+  .pagefind-ui__form, .pagefind-modular-input, .search-results {
+    color: #ececec !important;
+  }
+
+  :root {
+    --pagefind-ui-primary: #eeeeee;
+    --pagefind-ui-text: #eeeeee;
+    --pagefind-ui-background: #152028;
+    --pagefind-ui-border: #152028;
+    --pagefind-ui-tag: #152028;
+  }
+
+
 }

_static/version

@@ -1 +1 @@
-2024.4.0b3
+2024.5.4

_templates/layout.html

@@ -5,6 +5,7 @@
 {% endblock %}
 
 {%- block extrahead %}
+  <link href="/pagefind/pagefind-modular-ui.css" rel="stylesheet">
   <link rel="stylesheet" href="{{ pathto('_static/custom.css', 1) }}?hash={{ custom_css_hash }}" type="text/css" />
   <link rel="apple-touch-icon" sizes="180x180" href="/_static/apple-touch-icon.png">
   <link rel="shortcut icon" href="/_static/favicon.ico">
@@ -16,6 +17,7 @@
   <link rel="icon" type="image/png" sizes="16x16" href="/_static/favicon-16x16.png">
   <link rel="manifest" href="/_static/site.webmanifest">
   <link rel="mask-icon" href="/_static/safari-pinned-tab.svg" color="#646464">
+  <link rel="me" href="https://fosstodon.org/@esphome">
   <meta name="apple-mobile-web-app-title" content="ESPHome">
   <meta name="application-name" content="ESPHome">
   <meta name="msapplication-TileColor" content="#dfdfdf">
@@ -24,18 +26,20 @@
   <meta name="HandheldFriendly" content="True">
   <meta name="MobileOptimized" content="320">
   <meta property="og:site_name" content="ESPHome">
-  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
+  <meta name="viewport"
+        content="width=device-width, initial-scale=1, maximum-scale=3, interactive-widget=overlays-content">
 {% endblock %}
 
 {% block relbar_top %}
-  {% if parents|length > 0 %}
   <ul class="breadcrumbs">
+  {% if parents|length > 0 %}
     {%- for doc in parents %}
       <li><a href="{{ doc.link|e }}">{{ doc.title }}</a> ➔</li>
     {%- endfor %}
       <li>{{title}}</li>
-  </ul>
+
   {% endif %}
+  </ul>
 {% endblock %}
 
 {% block footer %}

_templates/search.html

@@ -0,0 +1,36 @@
+<!-- docs/_templates/search.html -->
+{% extends "page.html" %}
+
+{%- block htmltitle -%}
+<title>{{ _("Search") }} - {{ docstitle }}</title>
+{%- endblock htmltitle -%}
+
+{% block content %}
+<h1>{{ _("Search") }}</h1>
+<div id="search"></div>
+{% endblock %}
+
+{% block scripts -%}
+{{ super() }}
+{%- endblock scripts %}
+
+{% block extra_styles -%}
+{{ super() }}
+  <style type="text/css">
+    #search form input[type="text"] {
+      box-sizing: border-box;
+      width: 100%;
+      line-height: 2em;
+      padding-inline: 0.6em;
+      font-size: 1.2rem;
+      border-radius: 0.05rem;
+      border: 2px solid var(--color-foreground-border);
+      border-bottom-color: 2px solid var(--color-foreground-secondary);
+      transition: border-color 20ms ease;
+    }
+    #search form input[type="text"]:focus {
+      border-color: var(--color-foreground-primary);
+    }
+  </style>
+{%- endblock extra_styles %}
+

_templates/searchbox.html

@@ -0,0 +1,188 @@
+<script src="/pagefind/pagefind-modular-ui.js"></script>
+<div class="pagefind-ui__form" id="search"></div>
+<script>
+
+
+    class El {
+        constructor(tagname) {
+            this.element = document.createElement(tagname);
+        }
+
+        id(s) {
+            this.element.id = s;
+            return this;
+        }
+
+        class(s) {
+            this.element.classList.add(s);
+            return this;
+        }
+
+        attrs(obj) {
+            for (const [k,v] of Object.entries(obj)) {
+                this.element.setAttribute(k, v);
+            }
+            return this;
+        }
+
+        text(t) {
+            this.element.innerText = t;
+            return this;
+        }
+
+        html(t) {
+            this.element.innerHTML = t;
+            return this;
+        }
+
+        handle(e, f) {
+            this.element.addEventListener(e, f);
+            return this;
+        }
+
+        addTo(el) {
+            if (el instanceof El) {
+                el.element.appendChild(this.element);
+            } else {
+                el.appendChild(this.element);
+            }
+            return this.element;
+        }
+    }
+
+    window.addEventListener('DOMContentLoaded', (event) => {
+
+        const targetClass = "search-results";
+        const docel = document.getElementsByClassName("document");
+        if (docel.length === 0)
+            return;
+        const inpel = document.getElementById("search");
+        if (!inpel)
+            return;
+
+        var mobileWidth = getComputedStyle(document.body).getPropertyValue("--mobile-width-stop");
+
+        function isMobile() {
+            return window.innerWidth <= mobileWidth;
+        }
+
+        const target = document.createElement("div");
+        target.classList.add(targetClass);
+        target.id = targetClass;
+        target.style.display = "none";
+        docel.item(0).appendChild(target);
+
+        const margin = 20;
+
+        const resultTemplate = (result) => {
+            let wrapper = new El("li").class("pagefind-modular-list-result");
+
+            let thumb = new El("div").class("pagefind-modular-list-thumb").addTo(wrapper);
+            if (result?.meta?.image) {
+                new El("img").class("pagefind-modular-list-image").attrs({
+                    src: result.meta.image,
+                    alt: result.meta.image_alt || result.meta.title
+                }).addTo(thumb);
+            }
+
+            let inner = new El("div").class("pagefind-modular-list-inner").addTo(wrapper);
+            let title = new El("p").class("pagefind-modular-list-title").addTo(inner);
+            new El("a").class("pagefind-modular-list-link").text(result.meta?.title).attrs({
+                href: result.meta?.url || result.url
+            }).addTo(title);
+
+            let excerpt = new El("p").class("pagefind-modular-list-excerpt").addTo(inner);
+            new El("a").class("pagefind-modular-list-link").html(result.excerpt).attrs({
+                href: result.meta?.url || result.url
+            }).addTo(excerpt);
+
+            return wrapper.element;
+        }
+
+
+        function resizeTarget() {
+            const searchPos = inpel.getBoundingClientRect();
+            var leftPos;
+            var topPos;
+            var maxWidth = 650;
+            target.style.width = "auto;"
+            target.style.height = "fit-content";
+            target.style.maxWidth = maxWidth + "px";
+            let rightPos = margin;
+            if (isMobile()) {
+                // position search results left aligned with the search box, and below.
+                leftPos = margin / 2;
+                topPos = searchPos.bottom + margin / 2;
+                rightPos = margin / 2;
+            } else {
+                // position search results top aligned with the search box, and to its right.
+                leftPos = searchPos.right + margin * 2;
+                topPos = searchPos.top;
+                if (rightPos - leftPos > maxWidth)
+                    rightPos = leftPos + maxWidth;
+            }
+            target.style.right = rightPos + "px";
+            target.style.top = topPos + "px";
+            target.style.left = leftPos + "px";
+            let twidth = window.innerWidth - margin - leftPos;
+            if (twidth > maxWidth)
+                twidth = maxWidth;
+            target.style.width = twidth + "px";
+            target.style.maxHeight = (window.innerHeight - margin - topPos) + "px";
+        }
+
+        window.addEventListener("resize", (event) => { resizeTarget(); });
+
+        function showTarget() {
+            if (target.style.display !== "block") {
+                target.style.display = "block";
+                document.addEventListener('click', clickCallback);
+            }
+            resizeTarget();
+        }
+
+        function hideTargets() {
+            if (target.style.display !== "none") {
+                target.style.display = "none";
+                document.removeEventListener('click', clickCallback);
+            }
+        }
+
+
+        const instance = new PagefindModularUI.Instance({
+            showSubResults: true,
+            showImages: false,
+            ranking: {
+                pageLength: 0.0,
+                termSaturation: 1.6,
+                termFrequency: 0.4,
+                termSimilarity: 6.0
+            }
+        });
+
+        instance.add(new PagefindModularUI.Input({
+            containerElement: "#search"
+        }));
+
+        instance.add(new PagefindModularUI.ResultList({
+            containerElement: "#search-results",
+            resultTemplate: resultTemplate
+        }));
+
+        const clickCallback = (event) => {
+            const path = event.composedPath();
+            if (path.includes(target) || path.includes(inpel))
+                return;
+            hideTargets();
+        };
+        if (target) {
+            instance.on("results", (results) => {
+                if (results.results.length) {
+                    showTarget();
+                } else {
+                    hideTargets();
+                }
+            });
+        }
+    });
+</script>

changelog/2023.12.0.rst

@@ -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

changelog/2024.4.0.rst

@@ -38,6 +38,27 @@ use that route instead. This is more reliable because the ESPHome API uses a TCP
 your audio will also be encrypted in transit.
 
 
+Release 2024.4.1 - April 23
+---------------------------
+
+- [Tuya Climate] Fix compilation error caused by codegen :esphomepr:`6568` by :ghuser:`zry98`
+- wifi: fix reconnect issue due to enablement of fast connect :esphomepr:`6598` by :ghuser:`jpeletier`
+- Calibrate Beken internal temperature :esphomepr:`6599` by :ghuser:`Mat931`
+- fix streaming logs from MQTT for ESP32 devices using TLS :esphomepr:`6605` by :ghuser:`ccutrer`
+- Disallow variant/family override for known boards :esphomepr:`6512` by :ghuser:`clydebarrow`
+- esp32_ble: Consider ESP_BT_STATUS_DONE a successful state :esphomepr:`6493` by :ghuser:`polyfloyd`
+- 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
 --------------------
 
@@ -158,6 +179,9 @@ All changes
 - Add dooya remote transmitter test :esphomepr:`6508` by :ghuser:`jesserockz`
 - ads1115: remove auto-load and split sensor into platform folder :esphomepr:`5981` by :ghuser:`jesserockz` (new-platform)
 - Bump esphome-dashboard to 20240412.0 :esphomepr:`6517` by :ghuser:`jesserockz`
+- Fix missing ifdefs in voice assistant :esphomepr:`6520` by :ghuser:`jesserockz`
+- Fix project version longer than 30 characters breaking compilation :esphomepr:`6535` by :ghuser:`jesserockz`
+- Fix no-release bug on ft6x36 :esphomepr:`6527` by :ghuser:`clydebarrow`
 
 Past Changelogs
 ---------------

changelog/2024.5.0.rst

@@ -0,0 +1,319 @@
+ESPHome 2024.5.0 - 15th May 2024
+================================
+
+.. seo::
+    :description: Changelog for ESPHome 2024.5.0.
+    :image: /_static/changelog-2024.5.0.png
+    :author: Jesse Hills
+    :author_twitter: @jesserockz
+
+.. imgtable::
+    :columns: 3
+
+
+    Valve Core, components/valve/index, folder-open.svg, dark-invert
+    Template Valve, components/valve/template, description.svg, dark-invert
+    Event Core, components/event/index, folder-open.svg, dark-invert
+    Template Event, components/event/template, description.svg, dark-invert
+    Template Time, components/datetime/template, description.svg, dark-invert
+    Template Datetime, components/datetime/template, description.svg, dark-invert
+    WeiKai SPI/I²C UART/IO Expander, components/weikai, wk2168.jpg
+
+
+Valves, Events, and More
+------------------------
+
+This release brings a new ``Valve`` component, which can be used to control valves.
+A ``Valve`` can be opened, closed, or a specific position set if supported.
+
+``Event`` entities were added to Home Assistant in `2023.8 <https://www.home-assistant.io/blog/2023/08/02/release-20238/#introducing-the-event-entity>`__.
+They allow better structure and also history and logging of the events sent from ESPHome to Home Assistant compared to just using publishing events onto the
+Home Assistant event bus with the ``homeassistant.event`` action.
+
+The ``datetime`` component has also been extended with ``DateTime`` and ``Time`` entity types this release.
+
+
+ESP32 ADC Attenuation
+---------------------
+
+The attenuation configuration option for ESP32 ``adc`` sensors has had a deprecation in the underlying ESP-IDF framework with the ``11dB`` option.
+The value to replace ``11dB`` with is ``12dB``. There are no functionality changes otherwise. There will be a warning in the logs when installing if you
+are using ``11dB`` and it will be removed in **2024.8.0**.
+
+Remote Receiver tolerance
+-------------------------
+
+The ``tolerance`` option in the ``remote_receiver`` component has been extended to allow time values, but at the same time the validation is now more strict.
+If you were using a raw value with no unit before 2024.5.0, for example ``25``, you will need to change it to ``25%``.
+
+
+Release 2024.5.1 - May 20
+-------------------------
+
+- Add device_class to valve core config :esphomepr:`6765` by :ghuser:`acshef`
+- Synchronise Device Classes from Home Assistant :esphomepr:`6768` by :ghuser:`esphomebot`
+- Fix Upload from Dashboard with MQTT discovery. :esphomepr:`6774` by :ghuser:`Links2004`
+- Fix MQTT dashboard discovery (Exception in MqttStatusThread). :esphomepr:`6775` by :ghuser:`Links2004`
+
+
+Release 2024.5.2 - May 21
+-------------------------
+
+- Revert "Fix MQTT dashboard discovery (Exception in MqttStatusThread)." :esphomepr:`6782` by :ghuser:`bdraco`
+- Fix DashboardEntries.all() call :esphomepr:`6783` by :ghuser:`bdraco`
+- [remote_receiver] Add better error message for tolerance breaking change :esphomepr:`6784` by :ghuser:`jesserockz`
+- Update webserver local assets to 20240519-215627 :esphomepr:`6779` by :ghuser:`esphomebot`
+
+
+Release 2024.5.3 - May 25
+-------------------------
+
+- [voice_assistant] Don't allocate buffers until starting the microphone for the first time :esphomepr:`6800` by :ghuser:`jesserockz`
+
+
+Release 2024.5.4 - May 28
+-------------------------
+
+- [web_server_base] Bump ESPAsyncWebServer-esphome to 3.2.2 :esphomepr:`6797` by :ghuser:`jesserockz`
+- [helpers] Move Base64 string to cpp :esphomepr:`6819` by :ghuser:`gabest11`
+
+
+Full list of changes
+--------------------
+
+New Components
+^^^^^^^^^^^^^^
+
+- Add valve component :esphomepr:`6447` by :ghuser:`kbx81` (new-integration)
+- Add the WeiKai SPI/I2C UART/IO Expander components to esphome  :esphomepr:`5218` by :ghuser:`DrCoolzic` (new-integration)
+- Event entity support :esphomepr:`6451` by :ghuser:`nohat` (new-integration)
+- SPI and I2C for BMP390 and BMP380 :esphomepr:`6652` by :ghuser:`latonita` (new-integration) (breaking-change)
+
+Breaking Changes
+^^^^^^^^^^^^^^^^
+
+- Add DNS sensor and simplify format :esphomepr:`6450` by :ghuser:`HeMan` (breaking-change)
+- SM2135 - Use standard channel ordering. :esphomepr:`6573` by :ghuser:`Cossid` (breaking-change)
+- [sn74hc595] Enforce type field to distinguish gpio vs spi mode :esphomepr:`6609` by :ghuser:`jesserockz` (breaking-change)
+- Add datetime entities :esphomepr:`6513` by :ghuser:`jesserockz` (breaking-change)
+- SPI and I2C for BMP390 and BMP380 :esphomepr:`6652` by :ghuser:`latonita` (new-integration) (breaking-change)
+
+Beta Changes
+^^^^^^^^^^^^
+
+- [github] Upgrade to actions/[upload,download]-artifact v4 :esphomepr:`6698` by :ghuser:`jesserockz`
+- [nextion] Replace flags to ``USE_ARDUINO`` :esphomepr:`6700` by :ghuser:`edwardtfn`
+- [remote_receiver, remote_transmitter] Improve error messages on the ESP32 :esphomepr:`6701` by :ghuser:`Mat931`
+- [ethernet] Use constexpr instead of inline define for KSZ80XX_PC2R_REG_ADDR :esphomepr:`6705` by :ghuser:`jesserockz`
+- Add PHY register writes to enable external clock on Ethernet with RTL8201 :esphomepr:`6704` by :ghuser:`heythisisnate`
+- Bump recommended ESP-IDF to 4.4.7 :esphomepr:`6703` by :ghuser:`bdraco`
+- [core] Ensure that a generated ID name is distinct from its type. :esphomepr:`6706` by :ghuser:`clydebarrow`
+- [color] Fix crash when hex color parses as int, improve error reporting. :esphomepr:`6707` by :ghuser:`clydebarrow`
+- [github] Fix digest artifact name :esphomepr:`6710` by :ghuser:`jesserockz`
+- fix(ltr390): stuck ALS values when configured for ALS+UV readings :esphomepr:`6723` by :ghuser:`CodeInPolish`
+- Set FEATURE_API_AUDIO flag also if the speaker component is not used :esphomepr:`6712` by :ghuser:`gnumpi`
+- Bump platformio from 6.1.13 to 6.1.15 :esphomepr:`6634` by :ghuser:`dependabot[bot]`
+- Fix ESPHOME_PROJECT_VERSION_30 :esphomepr:`6731` by :ghuser:`jesserockz`
+- Voice-Assistant: Start-order change for VAD disabled: start va-pipeline when microphon… :esphomepr:`6391` by :ghuser:`gnumpi`
+- Add ANNOUNCING state to media_player. :esphomepr:`6691` by :ghuser:`gnumpi`
+- [adc] Fix 11db deprecation warning :esphomepr:`6749` by :ghuser:`jesserockz` (notable-change)
+
+Notable Changes
+^^^^^^^^^^^^^^^
+
+- [adc] Fix 11db deprecation warning :esphomepr:`6749` by :ghuser:`jesserockz` (notable-change)
+
+All changes
+^^^^^^^^^^^
+
+- Add some components to the new testing framework (H) :esphomepr:`6179` by :ghuser:`kbx81`
+- Added Htu21d model option :esphomepr:`6511` by :ghuser:`MRemy2`
+- Add bk72xx base test file :esphomepr:`6522` by :ghuser:`jesserockz`
+- Add "log" alias for "logs" command :esphomepr:`6519` by :ghuser:`pzich`
+- Add DNS sensor and simplify format :esphomepr:`6450` by :ghuser:`HeMan` (breaking-change)
+- Add all missing ``remote_receiver`` ``on_...`` tests :esphomepr:`6524` by :ghuser:`kbx81`
+- Add actions to http_request tests :esphomepr:`6529` by :ghuser:`kbx81`
+- Update homeassistant component tests with actions :esphomepr:`6528` by :ghuser:`kbx81`
+- Define ``USE_PSRAM`` :esphomepr:`6526` by :ghuser:`edwardtfn`
+- Bump black from 24.2.0 to 24.4.0 :esphomepr:`6539` by :ghuser:`dependabot[bot]`
+- Bump peter-evans/create-pull-request from 6.0.2 to 6.0.3 :esphomepr:`6525` by :ghuser:`dependabot[bot]`
+- Bump python version in sync-device-classes workflow to 3.12 for HA :esphomepr:`6541` by :ghuser:`jesserockz`
+- Bump pylint from 3.0.3 to 3.1.0 :esphomepr:`6287` by :ghuser:`dependabot[bot]`
+- Bump aioesphomeapi from 23.2.0 to 24.0.0 :esphomepr:`6544` by :ghuser:`dependabot[bot]`
+- Bump pyupgrade from 3.15.1 to 3.15.2 :esphomepr:`6543` by :ghuser:`dependabot[bot]`
+- Add enum option to typed_schema :esphomepr:`6546` by :ghuser:`jesserockz`
+- Move esphome-fork startup script to main repo. :esphomepr:`6523` by :ghuser:`jesserockz`
+- Call workflow for addon with dev version :esphomepr:`6549` by :ghuser:`jesserockz`
+- Use trusted publishing token for pypi :esphomepr:`6545` by :ghuser:`jesserockz`
+- Fix uart to work with new enum definition in esp-idf-v5.2.1 :esphomepr:`6487` by :ghuser:`luar123`
+- Housecleaning: Use walrus operator in datetime :esphomepr:`6552` by :ghuser:`jesserockz`
+- Housecleaning: Use walrus operator in text :esphomepr:`6560` by :ghuser:`jesserockz`
+- Housecleaning: Use walrus operator in light :esphomepr:`6556` by :ghuser:`jesserockz`
+- Housecleaning: Use walrus operator in select :esphomepr:`6557` by :ghuser:`jesserockz`
+- Housecleaning: Use walrus operator in number :esphomepr:`6561` by :ghuser:`jesserockz`
+- Housecleaning: Use walrus operator in cover :esphomepr:`6562` by :ghuser:`jesserockz`
+- Housecleaning: Use walrus operator in climate :esphomepr:`6551` by :ghuser:`jesserockz`
+- Housecleaning: Use walrus operator in fan :esphomepr:`6555` by :ghuser:`jesserockz`
+- Housecleaning: Use walrus operator in text_sensor :esphomepr:`6559` by :ghuser:`jesserockz`
+- Bump zeroconf to 0.132.2 :esphomepr:`6548` by :ghuser:`bdraco`
+- Housecleaning: Use walrus operator in switch :esphomepr:`6558` by :ghuser:`jesserockz`
+- Housecleaning: Use walrus operator in lock :esphomepr:`6554` by :ghuser:`jesserockz`
+- Housecleaning: Use walrus operator in sensor :esphomepr:`6553` by :ghuser:`jesserockz`
+- Bump pytest-mock from 3.12.0 to 3.14.0 :esphomepr:`6572` by :ghuser:`dependabot[bot]`
+- Bump peter-evans/create-pull-request from 6.0.3 to 6.0.4 :esphomepr:`6569` by :ghuser:`dependabot[bot]`
+- Nextion - Review set_protocol_reparse_mode() :esphomepr:`6567` by :ghuser:`edwardtfn`
+- Allow component final_validate :esphomepr:`6475` by :ghuser:`kbx81`
+- SM2135 - Use standard channel ordering. :esphomepr:`6573` by :ghuser:`Cossid` (breaking-change)
+- Nextion - Do not refresh sensors while updating :esphomepr:`6566` by :ghuser:`edwardtfn`
+- Nextion - Review types :esphomepr:`6565` by :ghuser:`edwardtfn`
+- On failure, dump the output of preceding jobs in CI status :esphomepr:`6564` by :ghuser:`clydebarrow`
+- Nextion ``send_command`` method :esphomepr:`6540` by :ghuser:`edwardtfn`
+- Fix some printf formats for size_t. :esphomepr:`6542` by :ghuser:`clydebarrow`
+- remove delay from tmp102 :esphomepr:`6577` by :ghuser:`ssieb`
+- Create ``component_dir`` substitution for local files to be included in… :esphomepr:`6575` by :ghuser:`jesserockz`
+- Define ``USE_ESP32_BLE`` :esphomepr:`6585` by :ghuser:`edwardtfn`
+- Bump aioesphomeapi from 24.0.0 to 24.3.0 :esphomepr:`6602` by :ghuser:`dependabot[bot]`
+- Add yamllint and clang-format to pre-commit hooks :esphomepr:`6578` by :ghuser:`clydebarrow`
+- Use clang-format version from requirements_dev file :esphomepr:`6606` by :ghuser:`jesserockz`
+- Add some components to the new testing framework (P) :esphomepr:`6213` by :ghuser:`kbx81`
+- Add some components to the new testing framework (M part 1) :esphomepr:`6207` by :ghuser:`kbx81`
+- Add some components to the new testing framework (M part 2) :esphomepr:`6208` by :ghuser:`kbx81`
+- Add some components to the new testing framework (O) :esphomepr:`6211` by :ghuser:`kbx81`
+- [mopeka_std_check] Fix test file indentation :esphomepr:`6610` by :ghuser:`jesserockz`
+- Add valve component :esphomepr:`6447` by :ghuser:`kbx81` (new-integration)
+- Add some components to the new testing framework (R) :esphomepr:`6219` by :ghuser:`kbx81`
+- [sn74hc595] Enforce type field to distinguish gpio vs spi mode :esphomepr:`6609` by :ghuser:`jesserockz` (breaking-change)
+- [tests] Run yaml tests in groups if over 100 to run :esphomepr:`6612` by :ghuser:`jesserockz`
+- Add some components to the new testing framework (I) :esphomepr:`6185` by :ghuser:`kbx81`
+- Add some components to the new testing framework (T) :esphomepr:`6229` by :ghuser:`kbx81`
+- Add some components to the new testing framework (S part 1) :esphomepr:`6224` by :ghuser:`kbx81`
+- Add some components to the new testing framework (S part 2) :esphomepr:`6227` by :ghuser:`kbx81`
+- ``graphical_display_menu`` requires a Display, not DisplayBuffer :esphomepr:`6614` by :ghuser:`clydebarrow`
+- Add null GPIO pin  :esphomepr:`6611` by :ghuser:`clydebarrow`
+- Allow UART to be AUTO LOADed :esphomepr:`6617` by :ghuser:`jesserockz`
+- Add the WeiKai SPI/I2C UART/IO Expander components to esphome  :esphomepr:`5218` by :ghuser:`DrCoolzic` (new-integration)
+- Sort mqtt_const alphabetically :esphomepr:`6619` by :ghuser:`jesserockz`
+- Limit Rx wait loop time to 3 seconds. :esphomepr:`6594` by :ghuser:`descipher`
+- Event entity support :esphomepr:`6451` by :ghuser:`nohat` (new-integration)
+- Only check c/c++ files with clang-format :esphomepr:`6620` by :ghuser:`jesserockz`
+- Added base64 helper :esphomepr:`4866` by :ghuser:`freekode`
+- Add Roomba IR protocol :esphomepr:`4595` by :ghuser:`rforro`
+- Fix issue when setting cw/ww brightness via temperature :esphomepr:`5976` by :ghuser:`patagonaa`
+- Add get/set color temperature functions in Kelvin :esphomepr:`5006` by :ghuser:`danielkent-net`
+- Move CONF_PLATFORM_VERSION to global const.py :esphomepr:`6629` by :ghuser:`tomaszduda23`
+- Ble client fixes for proxy :esphomepr:`6596` by :ghuser:`elupus`
+- Fix for #6614- use background_color, improve anti-aliasing :esphomepr:`6618` by :ghuser:`clydebarrow`
+- Fix graph hangs when y <= 0 :esphomepr:`6593` by :ghuser:`chiahsing`
+- Feature add last_operation to time based cover :esphomepr:`6084` by :ghuser:`xprofiler`
+- Add ``event``, ``text_sensor`` and ``valve`` device classes to sync script :esphomepr:`6624` by :ghuser:`kbx81`
+- Add datetime entities :esphomepr:`6513` by :ghuser:`jesserockz` (breaking-change)
+- Multiple Daly-BMS support :esphomepr:`6615` by :ghuser:`latonita`
+- Remove text_sensor from sync-device-class job :esphomepr:`6637` by :ghuser:`kbx81`
+- Synchronise Device Classes from Home Assistant :esphomepr:`6638` by :ghuser:`esphomebot`
+- Display: add diagnostic test_card option :esphomepr:`6608` by :ghuser:`nielsnl68`
+- waveshare_epaper: Add 2.90in-dke :esphomepr:`6492` by :ghuser:`polyfloyd`
+- Extract core comments from #6241 :esphomepr:`6643` by :ghuser:`javawizard`
+- [hm3301] Updated the AQI based on the airnow document :esphomepr:`6004` by :ghuser:`optimusprimespace`
+- Fix command line substitutions without any yaml substitutions :esphomepr:`6644` by :ghuser:`jesserockz`
+- Allow platform dependencies :esphomepr:`6623` by :ghuser:`kbx81`
+- [light] Add transition_length to strobe effect. :esphomepr:`6595` by :ghuser:`lhartmann`
+- Fixed the issue that graph draws out of the boundary. :esphomepr:`6651` by :ghuser:`chiahsing`
+- Fix upload command. MQTT user and password is missing from configuration. #5093 :esphomepr:`5766` by :ghuser:`dylan09`
+- patch esphome cli to skip mqtt based device discovery if --device option is specified :esphomepr:`6371` by :ghuser:`quigleymd`
+- Fix for #4866 - inconsistent arguments :esphomepr:`6639` by :ghuser:`clydebarrow`
+- [template/text] Fix lambda config :esphomepr:`6655` by :ghuser:`asergunov`
+- web_server: Add support for v3 local server_index :esphomepr:`6563` by :ghuser:`pzich`
+- Update webserver local assets to 20240429-211523 :esphomepr:`6657` by :ghuser:`esphomebot`
+- [nextion] Exit reparse before update TFT :esphomepr:`6589` by :ghuser:`edwardtfn`
+- [nextion] Set alternative TFT update baud rate :esphomepr:`6587` by :ghuser:`edwardtfn`
+- [TM1637] Let turn off the display :esphomepr:`6656` by :ghuser:`asergunov`
+- [nextion] Use persistent http connection for TFT upload (Arduino) :esphomepr:`6582` by :ghuser:`edwardtfn`
+- Extend MQTT tests :esphomepr:`6648` by :ghuser:`kbx81`
+- Extend and consolidate ``script`` tests :esphomepr:`6663` by :ghuser:`kbx81`
+- [nextion] Use persistent http connection for TFT upload (ESP-IDF) :esphomepr:`6576` by :ghuser:`edwardtfn`
+- Add a function to return the loop_interval :esphomepr:`6666` by :ghuser:`tronikos`
+- Remote receiver improvements :esphomepr:`4642` by :ghuser:`Mat931`
+- Make fast update intervals in qmc5883l work :esphomepr:`6647` by :ghuser:`tronikos`
+- SPI and I2C for BMP390 and BMP380 :esphomepr:`6652` by :ghuser:`latonita` (new-integration) (breaking-change)
+- Set ``CONF_`` CI counter to fail on 3 or more definitions :esphomepr:`6668` by :ghuser:`jesserockz`
+- [core] Rename ALWAYS_INLINE to ESPHOME_ALWAYS_INLINE :esphomepr:`6636` by :ghuser:`tomaszduda23`
+- print task name if logger is called from other than main thread :esphomepr:`6630` by :ghuser:`tomaszduda23`
+- Fix recent definitions into `defines.h` :esphomepr:`6667` by :ghuser:`edwardtfn`
+- Add fast update to HMC5883L :esphomepr:`6669` by :ghuser:`mkmer`
+- Minor tidy up of BME280 code :esphomepr:`6672` by :ghuser:`latonita`
+- External components: optional configurable path for git source :esphomepr:`6677` by :ghuser:`twasilczyk`
+- Use clang-apply-replacements when clang-apply-replacements-14 does not exist :esphomepr:`6684` by :ghuser:`Links2004`
+- fix conflict with EMPTY macro in zephyr :esphomepr:`6679` by :ghuser:`tomaszduda23`
+- Bump actions/checkout from 4.1.1 to 4.1.5 :esphomepr:`6685` by :ghuser:`dependabot[bot]`
+- Fix Datetime-Datetime compiler error :esphomepr:`6686` by :ghuser:`RFDarter`
+- Bump esphome/ESPAsyncWebServer-esphome to 3.2.0 :esphomepr:`6687` by :ghuser:`jesserockz`
+- fix date_time validation :esphomepr:`6688` by :ghuser:`RFDarter`
+- proceed if AP mode is set up :esphomepr:`6631` by :ghuser:`ssieb`
+- Migrate some constants to core code :esphomepr:`6692` by :ghuser:`clydebarrow`
+- Consolidate test files where all tests are identical :esphomepr:`6690` by :ghuser:`kbx81`
+- Make ``pulse_meter`` PULSE filter report the pulse as soon as it can :esphomepr:`6014` by :ghuser:`TrentHouliston`
+- Update webserver local assets to 20240507-231331 :esphomepr:`6696` by :ghuser:`esphomebot`
+- [github] Upgrade to actions/[upload,download]-artifact v4 :esphomepr:`6698` by :ghuser:`jesserockz`
+- [nextion] Replace flags to ``USE_ARDUINO`` :esphomepr:`6700` by :ghuser:`edwardtfn`
+- [remote_receiver, remote_transmitter] Improve error messages on the ESP32 :esphomepr:`6701` by :ghuser:`Mat931`
+- [ethernet] Use constexpr instead of inline define for KSZ80XX_PC2R_REG_ADDR :esphomepr:`6705` by :ghuser:`jesserockz`
+- Add PHY register writes to enable external clock on Ethernet with RTL8201 :esphomepr:`6704` by :ghuser:`heythisisnate`
+- Bump recommended ESP-IDF to 4.4.7 :esphomepr:`6703` by :ghuser:`bdraco`
+- [core] Ensure that a generated ID name is distinct from its type. :esphomepr:`6706` by :ghuser:`clydebarrow`
+- [color] Fix crash when hex color parses as int, improve error reporting. :esphomepr:`6707` by :ghuser:`clydebarrow`
+- [github] Fix digest artifact name :esphomepr:`6710` by :ghuser:`jesserockz`
+- fix(ltr390): stuck ALS values when configured for ALS+UV readings :esphomepr:`6723` by :ghuser:`CodeInPolish`
+- Set FEATURE_API_AUDIO flag also if the speaker component is not used :esphomepr:`6712` by :ghuser:`gnumpi`
+- Bump platformio from 6.1.13 to 6.1.15 :esphomepr:`6634` by :ghuser:`dependabot[bot]`
+- Fix ESPHOME_PROJECT_VERSION_30 :esphomepr:`6731` by :ghuser:`jesserockz`
+- Voice-Assistant: Start-order change for VAD disabled: start va-pipeline when microphon… :esphomepr:`6391` by :ghuser:`gnumpi`
+- Add ANNOUNCING state to media_player. :esphomepr:`6691` by :ghuser:`gnumpi`
+- [adc] Fix 11db deprecation warning :esphomepr:`6749` by :ghuser:`jesserockz` (notable-change)
+
+Past Changelogs
+---------------
+
+- :doc:`2024.4.0`
+- :doc:`2024.3.0`
+- :doc:`2024.2.0`
+- :doc:`2023.12.0`
+- :doc:`2023.11.0`
+- :doc:`2023.10.0`
+- :doc:`2023.9.0`
+- :doc:`2023.8.0`
+- :doc:`2023.7.0`
+- :doc:`2023.6.0`
+- :doc:`2023.5.0`
+- :doc:`2023.4.0`
+- :doc:`2023.3.0`
+- :doc:`2023.2.0`
+- :doc:`2022.12.0`
+- :doc:`2022.11.0`
+- :doc:`2022.10.0`
+- :doc:`2022.9.0`
+- :doc:`2022.8.0`
+- :doc:`2022.6.0`
+- :doc:`2022.5.0`
+- :doc:`2022.4.0`
+- :doc:`2022.3.0`
+- :doc:`2022.2.0`
+- :doc:`2022.1.0`
+- :doc:`2021.12.0`
+- :doc:`2021.11.0`
+- :doc:`2021.10.0`
+- :doc:`2021.9.0`
+- :doc:`2021.8.0`
+- :doc:`v1.20.0`
+- :doc:`v1.19.0`
+- :doc:`v1.18.0`
+- :doc:`v1.17.0`
+- :doc:`v1.16.0`
+- :doc:`v1.15.0`
+- :doc:`v1.14.0`
+- :doc:`v1.13.0`
+- :doc:`v1.12.0`
+- :doc:`v1.11.0`
+- :doc:`v1.10.0`
+- :doc:`v1.9.0`
+- :doc:`v1.8.0`
+- :doc:`v1.7.0`

changelog/index.rst

@@ -2,7 +2,7 @@ Changelog
 =========
 
 .. redirect::
-    :url: /changelog/2024.4.0.html
+    :url: /changelog/2024.5.0.html
 
 .. toctree::
     :glob:

components/alarm_control_panel/template.rst

@@ -169,7 +169,7 @@ Example:
         name: Zone 1
         device_class: door
         pin:
-          number: D1
+          number: GPIOXX
           mode: INPUT_PULLUP
           inverted: True
       - platform: gpio
@@ -177,7 +177,7 @@ Example:
         name: Zone 2
         device_class: door
         pin:
-          number: D2
+          number: GPIOXX
           mode: INPUT_PULLUP
           inverted: True
       - platform: gpio
@@ -185,7 +185,7 @@ Example:
         name: Zone 3
         device_class: motion
         pin:
-          number: D3
+          number: GPIOXX
           mode: INPUT_PULLUP
           inverted: True
       - platform: gpio
@@ -193,7 +193,7 @@ Example:
         name: Zone 4
         device_class: door
         pin:
-          number: D4
+          number: GPIOXX
           mode: INPUT_PULLUP
           inverted: True
       - platform: homeassistant
@@ -206,7 +206,7 @@ Example:
         id: siren
         name: Siren
         icon: mdi:alarm-bell
-        pin: D7
+        pin: GPIOXX
 
 
 See Also

components/api.rst

@@ -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>`.
 

components/at581x.rst

@@ -32,17 +32,6 @@ a :doc:`/components/i2c` component (and its requisite GPIO pins) is required in
       id: "Radar"
       i2c_id: bus_a
 
-    binary_sensor:
-      - platform: gpio
-        pin: GPIO21
-        name: "Radar motion"
-
-    switch:
-      # Switch to turn on/off RF emission
-      - platform: at581x
-        at581x_id: "Radar"
-        name: "Enable Radar"
-
 .. _at581x-component:
 
 Component/Hub
@@ -87,7 +76,7 @@ The state of the radar detection is available via its GPIO pin. It's required to
     binary_sensor:
       - platform: gpio
         name: "Human in front"
-        pin: GPIO21
+        pin: GPIOXX
 
 Configuration variables:
 ************************

components/binary_sensor/cap1188.rst

@@ -30,7 +30,7 @@ required to be set up in your configuration for this sensor to work.
     cap1188:
       id: cap1188_component
       address: 0x29
-      reset_pin: 14
+      reset_pin: GPIOXX
       touch_threshold: 0x40
       allow_multiple_touches: true
 

components/binary_sensor/custom.rst

@@ -1,22 +1,28 @@
 Custom Binary Sensor
 ====================
 
+.. seo::
+    :description: Instructions for setting up Custom C++ binary sensors with ESPHome.
+    :image: language-cpp.svg
+    :keywords: C++, Custom
+
 .. warning::
 
-    Custom components are deprecated, not recommended for new configurations
-    and will be removed from ESPHome in a future release.
-    Please look at creating a real ESPHome component and "importing" it into your
-    configuration with :doc:`/components/external_components`.
+    Custom components are deprecated, not recommended for new configurations and will be removed from ESPHome in a
+    future release. Please look at creating a real ESPHome component and "importing" it into your configuration with
+    :doc:`/components/external_components`.
 
-    You can find some basic documentation on creating your own components
-    at :ref:`contributing_to_esphome`.
+    You can find some basic documentation on creating your own components at :ref:`contributing_to_esphome`.
 
-This integration can be used to create custom binary sensors in ESPHome
-using the C++ (Arduino) API.
+.. warning::
 
-Please first read :doc:`/components/sensor/custom` guide,
-the same principles apply here and binary sensors are very similar
-to sensors internally.
+    While we try to keep the ESPHome YAML configuration options as stable as possible, the ESPHome API is less
+    stable. If something in the APIs needs to be changed in order for something else to work, we will do so.
+
+This component can be used to create custom binary sensors in ESPHome using the C++ (Arduino) API.
+
+Please first read :doc:`/components/sensor/custom` guide, the same principles apply here and binary
+sensors are very similar to sensors internally.
 
 The example below is an example of a custom binary sensor; this custom sensor is essentially the
 same as the gpio binary sensor.

components/binary_sensor/esp32_touch.rst

@@ -130,8 +130,8 @@ an ``OFF`` state.
 
     binary_sensor:
       - platform: esp32_touch
-        name: "ESP32 Touch Pad GPIO27"
-        pin: GPIO27
+        name: "ESP32 Touch Pad"
+        pin: GPIOXX
         threshold: 1000
 
 Configuration variables:
@@ -164,7 +164,7 @@ If access to the raw values is required, a template sensor can be created that p
     binary_sensor:
       - platform: esp32_touch
         id: esp32_touch_pad
-        pin: GPIO4
+        pin: GPIOXX
         threshold: 0
 
     sensor:

components/binary_sensor/haier.rst

@@ -17,8 +17,8 @@ Additional sensors for Haier Climate device. **These sensors are supported only
     # Example configuration entry
     uart:
       baud_rate: 9600
-      tx_pin: 17
-      rx_pin: 16
+      tx_pin: GPIOXX
+      rx_pin: GPIOXX
       id: ac_port
 
     climate:

components/binary_sensor/homeassistant.rst

@@ -34,7 +34,6 @@ Configuration variables:
 - **entity_id** (**Required**, string): The entity ID to import from Home Assistant.
 - **attribute** (*Optional*, string): The name of the state attribute to import from the
   specified entity. The entity state is used when this option is omitted.
-  Requires Home Assistant 2021.6 or newer.
 - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - All other options from :ref:`Binary Sensor <config-binary_sensor>`.
 

components/binary_sensor/hydreon_rgxx.rst

@@ -12,12 +12,6 @@ For this sensor to work, a :doc:`/components/sensor/hydreon_rgxx` must be set up
 .. code-block:: yaml
 
     # Example RG-9 entry
-
-    uart:
-      rx_pin: GPIO16
-      tx_pin: GPIO17
-      baud_rate: 9600
-
     sensor:
       - platform: hydreon_rgxx
         model: "RG_9"

components/binary_sensor/index.rst

@@ -66,12 +66,12 @@ Advanced options:
   a ``name`` will implicitly set this to true.
 - **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend,
   (usually Home Assistant) without the user manually enabling it (via the Home Assistant UI).
-  Requires Home Assistant 2021.9 or newer. Defaults to ``false``.
+  Defaults to ``false``.
 - **publish_initial_state** (*Optional*, boolean): If true, then the sensor will publish its initial state at boot or when
   HA first connects, depending on the platform.  This means that any applicable triggers will be run. Defaults to ``false``.
 - **entity_category** (*Optional*, string): The category of the entity.
   See https://developers.home-assistant.io/docs/core/entity/#generic-properties
-  for a list of available options. Requires Home Assistant 2021.11 or newer.
+  for a list of available options.
   Set to ``""`` to remove the default entity category.
 - If MQTT enabled, all other options from :ref:`MQTT Component <config-mqtt-component>`.
 

components/binary_sensor/rc522.rst

@@ -42,7 +42,7 @@ you can then create individual binary sensors that track if an NFC/RFID tag is c
     spi:
 
     rc522_spi:
-      cs_pin: GPIO15
+      cs_pin: GPIOXX
 
     binary_sensor:
       - platform: rc522

components/bluetooth_proxy.rst

@@ -43,15 +43,11 @@ Configuration:
 
     bluetooth_proxy:
 
-- **active** (*Optional*, boolean): Enables proxying active connections. Defaults to ``false``. Requires Home Assistant 2022.10 or later.
+- **active** (*Optional*, boolean): Enables proxying active connections. Defaults to ``false``.
 - **cache_services** (*Optional*, boolean): Enables caching GATT services in NVS flash storage which significantly speeds up active connections. Defaults to ``true`` when using the ESP-IDF framework.
 
 The Bluetooth proxy depends on :doc:`esp32_ble_tracker` so make sure to add that to your configuration.
 
-.. note::
-
-    Bluetooth proxy requires Home Assistant 2022.9 or later. ESPHome 2022.12.0 and Home Assistant 2022.12.6 or later is recommended.
-
 Improving reception performance
 -------------------------------
 

components/button/output.rst

@@ -17,7 +17,7 @@ momentarily set a GPIO pin using a button.
     # Example configuration entry
     output:
       - platform: gpio
-        pin: 25
+        pin: GPIOXX
         id: output1
 
     button:

components/button/uart.rst

@@ -11,10 +11,6 @@ The ``uart`` button platform allows you to send a pre-defined sequence of bytes
 .. code-block:: yaml
 
     # Example configuration entry
-    uart:
-      baud_rate: 9600
-      tx_pin: D0
-
     button:
       - platform: uart
         name: "UART String Output"

components/canbus.rst

@@ -197,8 +197,8 @@ You only need to specify the RX and TX pins. Any GPIO will work.
     # Example configuration entry
     canbus:
       - platform: esp32_can
-        tx_pin: GPIO5
-        rx_pin: GPIO4
+        tx_pin: GPIOXX
+        rx_pin: GPIOXX
         can_id: 4
         bit_rate: 50kbps
         on_frame:
@@ -273,7 +273,7 @@ For wiring up the MSP2515 please refer to the section below.
     # Example configuration entry
     canbus:
       - platform: mcp2515
-        cs_pin: D5
+        cs_pin: GPIOXX
         can_id: 4
         bit_rate: 50kbps
         on_frame:
@@ -359,7 +359,7 @@ Standard IDs and Extended IDs can coexist on the same segment.
       - platform: mcp2515
         id: my_mcp2515
         spi_id: McpSpi
-        cs_pin: GPIO14
+        cs_pin: GPIOXX
         can_id: 0x1fff
         use_extended_id: true
         bit_rate: 125kbps
@@ -385,9 +385,9 @@ Button is connected on a can node which sends an A message on ID 0x100 with payl
 
     spi:
       id: McpSpi
-      clk_pin: GPIO16
-      mosi_pin: GPIO5
-      miso_pin: GPIO4
+      clk_pin: GPIOXX
+      mosi_pin: GPIOXX
+      miso_pin: GPIOXX
 
     binary_sensor:
       - platform: template
@@ -398,7 +398,7 @@ Button is connected on a can node which sends an A message on ID 0x100 with payl
       - platform: mcp2515
         id: my_mcp2515
         spi_id: McpSpi
-        cs_pin: GPIO14
+        cs_pin: GPIOXX
         can_id: 4
         bit_rate: 125kbps
         on_frame:
@@ -430,15 +430,15 @@ Buttons are connected on the CAN-Node and also the motor is connected via CAN.
 
     spi:
       id: McpSpi
-      clk_pin: GPIO16
-      mosi_pin: GPIO5
-      miso_pin: GPIO4
+      clk_pin: GPIOXX
+      mosi_pin: GPIOXX
+      miso_pin: GPIOXX
 
     canbus:
       - platform: mcp2515
         id: my_mcp2515
         spi_id: McpSpi
-        cs_pin: GPIO14
+        cs_pin: GPIOXX
         can_id: 4
         bit_rate: 125kbps
         on_frame:

components/climate/bang_bang.rst

@@ -10,8 +10,7 @@ The ``bang_bang`` climate platform allows you to regulate a value with a
 
 .. note::
 
-    A number of people have asked about the behavior of the bang-bang controller. In version 1.15, a
-    :doc:`thermostat <thermostat>` component was added which behaves more like a common thermostat; it is
+    The :doc:`thermostat <thermostat>` component behaves more like a common thermostat; it is
     essentially two bang-bang controllers in one. Please see the `Bang-bang vs. Thermostat`_ section below
     if you are not sure which is appropriate for your application.
 

components/climate/climate_ir.rst

@@ -76,7 +76,7 @@ controller unit.
 
     # Example configuration entry
     remote_transmitter:
-      pin: GPIO32
+      pin: GPIOXX
       carrier_duty_percent: 50%
 
     climate:
@@ -156,7 +156,7 @@ IR receiver.
     remote_receiver:
       id: rcvr
       pin:
-        number: GPIO14
+        number: GPIOXX
         inverted: true
         mode:
           input: true

components/climate/custom.rst

@@ -1,21 +1,27 @@
 Custom Climate
 ==============
 
+.. seo::
+    :description: Instructions for setting up Custom C++ climate components with ESPHome.
+    :image: language-cpp.svg
+    :keywords: C++, Custom
+
 .. warning::
 
-    Custom components are deprecated, not recommended for new configurations
-    and will be removed from ESPHome in a future release.
-    Please look at creating a real ESPHome component and "importing" it into your
-    configuration with :doc:`/components/external_components`.
+    Custom components are deprecated, not recommended for new configurations and will be removed from ESPHome in a
+    future release. Please look at creating a real ESPHome component and "importing" it into your configuration with
+    :doc:`/components/external_components`.
 
-    You can find some basic documentation on creating your own components
-    at :ref:`contributing_to_esphome`.
+    You can find some basic documentation on creating your own components at :ref:`contributing_to_esphome`.
 
-This integration can be used to create custom climate devices in ESPHome
-using the C++ (Arduino) API.
+.. warning::
 
-Please first read :doc:`/components/sensor/custom` guide,
-the same principles apply here.
+    While we try to keep the ESPHome YAML configuration options as stable as possible, the ESPHome API is less
+    stable. If something in the APIs needs to be changed in order for something else to work, we will do so.
+
+This component can be used to create custom climate devices in ESPHome using the C++ (Arduino) API.
+
+Please first read :doc:`/components/sensor/custom` guide, the same principles apply here.
 
 The example below is an example of a custom climate device - all climate devices must override
 two methods (:apiclass:`Climate <climate::Climate>`):

components/climate/haier.rst

@@ -58,13 +58,6 @@ This component requires a :ref:`uart` to be setup.
 .. code-block:: yaml
 
     # Example configuration entry
-
-    uart:
-      baud_rate: 9600
-      tx_pin: 17
-      rx_pin: 16
-      id: ac_port  
-    
     climate:
       - platform: haier
         id: haier_ac

components/climate/index.rst

@@ -80,10 +80,10 @@ Advanced options:
   a ``name`` will implicitly set this to true.
 - **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend,
   (usually Home Assistant) without the user manually enabling it (via the Home Assistant UI).
-  Requires Home Assistant 2021.9 or newer. Defaults to ``false``.
+  Defaults to ``false``.
 - **entity_category** (*Optional*, string): The category of the entity.
   See https://developers.home-assistant.io/docs/core/entity/#generic-properties
-  for a list of available options. Requires Home Assistant 2021.11 or newer.
+  for a list of available options.
   Set to ``""`` to remove the default entity category.
 
 MQTT options:

components/climate/midea.rst

@@ -25,17 +25,6 @@ The ``midea`` component creates a Midea air conditioner climate device.
 .. code-block:: yaml
 
     # Example configuration entry
-
-    # Disable logging over UART (required)
-    logger:
-      baud_rate: 0
-
-    # UART settings for Midea dongle (required)
-    uart:
-      tx_pin: 1         # hardware dependant
-      rx_pin: 3         # hardware dependant
-      baud_rate: 9600
-
     # Main settings
     climate:
       - platform: midea

components/copy.rst

@@ -1,11 +1,11 @@
-Copy Integration
-================
+Copy Component
+==============
 
 .. seo::
-    :description: Instructions for setting up the copy integration in ESPHome
+    :description: Instructions for setting up the copy component in ESPHome
     :image: content-copy.svg
 
-The ``copy`` integration can be used to copy an existing component (like a sensor, switch, etc.)
+The ``copy`` component can be used to copy an existing component (like a sensor, switch, etc.)
 and create a duplicate mirroring the source's state and forwarding actions such as turning on to the source.
 
 For each of the supported platforms, the configuration consists of the required configuration

components/cover/custom.rst

@@ -1,24 +1,29 @@
 Custom Cover
 ============
 
+.. seo::
+    :description: Instructions for setting up Custom C++ covers with ESPHome.
+    :image: language-cpp.svg
+    :keywords: C++, Custom
+
 .. warning::
 
-    Custom components are deprecated, not recommended for new configurations
-    and will be removed from ESPHome in a future release.
-    Please look at creating a real ESPHome component and "importing" it into your
-    configuration with :doc:`/components/external_components`.
+    Custom components are deprecated, not recommended for new configurations and will be removed from ESPHome in a
+    future release. Please look at creating a real ESPHome component and "importing" it into your configuration with
+    :doc:`/components/external_components`.
 
-    You can find some basic documentation on creating your own components
-    at :ref:`contributing_to_esphome`.
+    You can find some basic documentation on creating your own components at :ref:`contributing_to_esphome`.
 
-This integration can be used to create custom covers in ESPHome
-using the C++ (Arduino) API.
+.. warning::
 
-Please first read :doc:`/components/sensor/custom` guide,
-the same principles apply here.
+    While we try to keep the ESPHome YAML configuration options as stable as possible, the ESPHome API is less
+    stable. If something in the APIs needs to be changed in order for something else to work, we will do so.
 
-The example below is an example of a custom cover - all covers must override
-two methods:
+This component can be used to create custom covers in ESPHome using the C++ (Arduino) API.
+
+Please first read :doc:`/components/sensor/custom` guide, the same principles apply here.
+
+The example below is an example of a custom cover - all covers must override two methods:
 
 - ``get_traits``: This should return a :apiclass:`CoverTraits <cover::CoverTraits>` object
   representing the capabilities of the cover.

components/cover/he60r.rst

@@ -26,8 +26,8 @@ below for a sample hardware interface.
         baud_rate: 1200
         parity: even
         stop_bits: 1
-        tx_pin: REPLACEME
-        rx_pin: REPLACEME
+        tx_pin: GPIOXX
+        rx_pin: GPIOXX
 
     cover:
       platform: he60r
@@ -72,9 +72,9 @@ Note that this circuit inverts the TX line. A configuration for this would look
         parity: even
         stop_bits: 1
         tx_pin:
-          number: REPLACEME
+          number: GPIOXX
           inverted: true
-        rx_pin: REPLACEME
+        rx_pin: GPIOXX
 
     cover:
       platform: he60r
@@ -84,7 +84,7 @@ Note that this circuit inverts the TX line. A configuration for this would look
     binary_sensor:
       - platform: gpio
         pin:
-          number: REPLACEME
+          number: GPIOXX
           inverted: true
           mode:
             input: true

components/cover/index.rst

@@ -46,10 +46,10 @@ Advanced options:
   a ``name`` will implicitly set this to true.
 - **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend,
   (usually Home Assistant) without the user manually enabling it (via the Home Assistant UI).
-  Requires Home Assistant 2021.9 or newer. Defaults to ``false``.
+  Defaults to ``false``.
 - **entity_category** (*Optional*, string): The category of the entity.
   See https://developers.home-assistant.io/docs/core/entity/#generic-properties
-  for a list of available options. Requires Home Assistant 2021.11 or newer.
+  for a list of available options.
   Set to ``""`` to remove the default entity category.
 
 MQTT options:

components/cover/time_based.rst

@@ -77,7 +77,22 @@ Configuration variables:
     ``esp8266_restore_from_flash: true`` option set. 
     See :doc:`esp8266_restore_from_flash </components/esphome>` for details.
 
+Handle stop_action:
+------------------------
+For some cover controllers, separate switches for UP and DOWN action are used while a stop is issued when sending a counter command.
+This can be handled at the **stop_action** by using the following lambda function:
 
+.. code-block:: yaml
+
+    stop_action: 
+      - lambda: !lambda |-
+          if (id(cover).last_operation() == CoverOperation::COVER_OPERATION_OPENING) {
+            // Cover is currently opening
+            id(cover_button_down).press();
+          } else if (id(cover).last_operation() == CoverOperation::COVER_OPERATION_CLOSING) {
+            // Cover is currently closing
+            id(cover_button_up).press();
+          }
 
 See Also
 --------

components/cover/tuya.rst

@@ -45,7 +45,7 @@ Configuration variables:
 Supported devices
 -----------------
 
-Tuya cover devices known to be supported by this integration:
+Tuya cover devices known to be supported by this component:
 
 - Tuya ``M515EGWT`` (motor for bead chain roller blinds)
 

components/datetime/index.rst

@@ -42,22 +42,27 @@ Configuration variables:
   a ``name`` will implicitly set this to true.
 - **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend,
   (usually Home Assistant) without the user manually enabling it (via the Home Assistant UI).
-  Requires Home Assistant 2021.9 or newer. Defaults to ``false``.
+  Defaults to ``false``.
 - **entity_category** (*Optional*, string): The category of the entity.
   See https://developers.home-assistant.io/docs/core/entity/#generic-properties
-  for a list of available options. Requires Home Assistant 2021.11 or newer.
+  for a list of available options.
   Set to ``""`` to remove the default entity category.
+- **time_id** (**Required**, :ref:`config-id`): The ID of the time entity. Automatically set
+  to the ID of a time component if only a single one is defined.
 
 MQTT Options:
 
 - All other options from :ref:`MQTT Component <config-mqtt-component>`.
 
-Datetime Automation
--------------------
+Time and DateTime Options:
 
-You can access the most recent state as a string of the datetime in :ref:`lambdas <config-lambda>` using
-``id(datetime_id).state``.
-You can also access it as a ``ESPTime`` object by ``id(datetime_id).state_as_time``
+- **on_time** (*Optional*, :ref:`automation`): Automation to run when the current datetime or time matches the current state.
+  Only valid on ``time`` or ``datetime`` types.
+
+Automation
+----------
+
+You can access the most recent state as a ``ESPTime`` object by ``id(datetime_id).state_as_esptime()``
 
 .. _datetime-on_value:
 
@@ -98,12 +103,12 @@ The ``date`` provided can be in one of 3 formats:
 
     # String date
     - datetime.date.set:
-        id: my_date
+        id: my_datetime_date
         date: "2023-12-04"
 
     # Individual date parts
     - datetime.date.set:
-        id: my_date
+        id: my_datetime_date
         date:
           year: 2023
           month: 12
@@ -111,7 +116,7 @@ The ``date`` provided can be in one of 3 formats:
 
     # Using a lambda
     - datetime.date.set:
-        id: my_date
+        id: my_datetime_date
         date: !lambda |-
           // Return an ESPTime struct
           return {.day_of_month: 4, .month: 12, .year: 2023};
@@ -137,7 +142,7 @@ advanced stuff (see the full API Reference for more info).
   .. code-block:: cpp
 
       // Within lambda, set the date to 2024-02-25
-      auto call = id(my_date).make_call();
+      auto call = id(my_datetime_date).make_call();
       call.set_date("2024-02-25");
       call.perform();
 
@@ -169,12 +174,12 @@ The ``time`` provided can be in one of 3 formats:
 
     # String time
     - datetime.time.set:
-        id: my_time
+        id: my_datetime_time
         time: "12:34:56"
 
     # Individual time parts
     - datetime.time.set:
-        id: my_time
+        id: my_datetime_time
         time:
           hour: 12
           minute: 34
@@ -182,7 +187,7 @@ The ``time`` provided can be in one of 3 formats:
 
     # Using a lambda
     - datetime.time.set:
-        id: my_time
+        id: my_datetime_time
         time: !lambda |-
           // Return an ESPTime struct
           return {.second: 56, .minute: 34, .hour: 12};
@@ -207,8 +212,8 @@ advanced stuff (see the full API Reference for more info).
   .. code-block:: cpp
 
       // Within lambda, set the time to 12:34:56
-      auto call = id(my_time).make_call();
-      call.set_date("12:34:56");
+      auto call = id(my_datetime_time).make_call();
+      call.set_time("12:34:56");
       call.perform();
 
   Check the API reference for information on the methods that are available for
@@ -222,7 +227,85 @@ advanced stuff (see the full API Reference for more info).
   .. code-block:: cpp
 
       // For example, create a custom log message when a value is received:
-      ESP_LOGI("main", "Value of my datetime: %0d:%02d:%02d", id(my_time).hour, id(my_time).minute, id(my_time).second);
+      ESP_LOGI("main", "Value of my datetime: %0d:%02d:%02d", id(my_datetime_time).hour, id(my_datetime_time).minute, id(my_datetime_time).second);
+
+
+DateTime Automation
+-------------------
+
+.. _datetime-datetime_set_action:
+
+``datetime.datetime.set`` Action
+********************************
+
+This is an :ref:`Action <config-action>` for setting a datetime datetime state.
+The ``datetime`` provided can be in one of 3 formats:
+
+.. code-block:: yaml
+
+    # String datetime
+    - datetime.time.set:
+        id: my_datetime
+        datetime: "2024-12-31 12:34:56"
+
+    # Individual datetime parts
+    - datetime.datetime.set:
+        id: my_datetime
+        datetime:
+          year: 2024
+          month: 12
+          day: 31
+          hour: 12
+          minute: 34
+          second: 56
+
+    # Using a lambda
+    - datetime.datetime.set:
+        id: my_datetime
+        datetime: !lambda |-
+          // Return an ESPTime struct
+          return {.second: 56, .minute: 34, .hour: 12, .day_of_month: 31, .month: 12, .year: 2024};
+
+Configuration variables:
+
+- **id** (**Required**, :ref:`config-id`): The ID of the datetime to set.
+- **datetime** (**Required**, string, datetime parts, :ref:`templatable <config-templatable>`):
+  The value to set the datetime to.
+
+
+.. _datetime-datetime-lambda_calls:
+
+Lambda calls
+************
+
+For more complex use cases, several methods are available for use on datetimes from within :ref:`lambdas <config-lambda>`. See the full API Reference for more information.
+
+- ``.make_call()``: Make a call for updating the datetime value.
+
+  .. code-block:: cpp
+
+      // Within lambda, set the datetime to 2024-12-31 12:34:56
+      auto call = id(my_datetime).make_call();
+      call.set_date("2024-12-31 12:34:56");
+      call.perform();
+
+  Check the API reference for information on the methods that are available for
+  the ``DateTimeCall`` object.
+
+- ``.year``: Retrieve the current year of the ``datetime``. It will be ``0`` if no value has been set.
+- ``.month``: Retrieve the current month of the ``datetime``. It will be ``0`` if no value has been set.
+- ``.day``: Retrieve the current day of the ``datetime``. It will be ``0`` if no value has been set.
+- ``.hour``: Retrieve the current hour of the ``datetime``. It will be ``0`` if no value has been set.
+- ``.minute``: Retrieve the current minute of the ``datetime``. It will be ``0`` if no value has been set.
+- ``.second``: Retrieve the current second of the ``datetime``. It will be ``0`` if no value has been set.
+- ``.state_as_esptime()``: Retrieve the current value of the datetime as a :apistruct:`ESPTime` object.
+
+  .. code-block:: cpp
+
+      // For example, create a custom log message when a value is received:
+      ESP_LOGI("main", "Value of my datetime: %04d-%02d-%02d %0d:%02d:%02d",
+               id(my_datetime).year, id(my_datetime).month, id(my_datetime).day,
+               id(my_datetime).hour, id(my_datetime).minute, id(my_datetime).second);
 
 
 See Also
@@ -231,8 +314,10 @@ See Also
 - :apiref:`DateTimeBase <datetime/datetime_base.h>`
 - :apiref:`DateEntity <datetime/date_entity.h>`
 - :apiref:`DateCall <datetime/date_entity.h>`
-- :apiref:`TimeeEntity <datetime/time_entity.h>`
+- :apiref:`TimeEntity <datetime/time_entity.h>`
 - :apiref:`TimeCall <datetime/time_entity.h>`
+- :apiref:`DateTimeEntity <datetime/datetime_entity.h>`
+- :apiref:`DateTimeCall <datetime/datetime_entity.h>`
 - :ghedit:`Edit`
 
 .. toctree::

components/datetime/template.rst

@@ -13,7 +13,7 @@ using :ref:`lambdas <config-lambda>`.
     datetime:
       # Example Date
       - platform: template
-        id: my_date
+        id: my_datetime_date
         type: date
         name: Pick a Date
         optimistic: yes
@@ -22,13 +22,22 @@ using :ref:`lambdas <config-lambda>`.
 
       # Example Time
       - platform: template
-        id: my_time
+        id: my_datetime_time
         type: time
         name: Pick a Time
         optimistic: yes
         initial_value: "12:34:56"
         restore_value: true
 
+      # Example DateTime
+      - platform: template
+        id: my_datetime
+        type: datetime
+        name: Pick a DateTime
+        optimistic: yes
+        initial_value: "2024-12-31 12:34:56"
+        restore_value: true
+
 Configuration variables:
 ------------------------
 
@@ -72,6 +81,21 @@ Configuration variables:
           minute: 34
           second: 56
 
+  - For ``type: datetime``:
+
+    - A string in the format ``%Y-%m-%d %H:%M:%S`` , eg: ``"2023-12-04 12:34:56"``.
+    - An object including ``year``, ``month``, ``day``, ``hour``, ``minute``, ``second``.
+
+    .. code-block:: yaml
+
+        initial_value:
+          year: 2023
+          month: 12
+          day: 4
+          hour: 12
+          minute: 34
+          second: 56
+
 - All other options from :ref:`Datetime <config-datetime>`.
 
 See Also

components/demo.rst

@@ -1,12 +1,12 @@
-Demo Integration
-================
+Demo Component
+==============
 
 .. seo::
-    :description: Instructions for setting up the demo integration in ESPHome
+    :description: Instructions for setting up the demo component in ESPHome
     :image: description.svg
 
-The ``demo`` integration can be used for testing to generate sample instances of many
-different integrations (sensors, lights, ...)
+The ``demo`` component can be used for testing to generate sample instances of many
+different components (sensors, lights, ...)
 
 .. figure:: images/demo-ui.png
     :align: center
@@ -20,7 +20,7 @@ different integrations (sensors, lights, ...)
 Configuration variables:
 ------------------------
 
-This integration has no configuration variables
+This component has no configuration variables
 
 See Also
 --------

components/dfplayer.rst

@@ -2,7 +2,7 @@ DF-Player mini
 ==============
 
 .. seo::
-    :description: Instructions for setting up DF Player Mini integration in ESPHome.
+    :description: Instructions for setting up DF Player Mini component in ESPHome.
     :image: dfplayer.svg
 
 The ``dfplayer`` (`datasheet <https://wiki.dfrobot.com/DFPlayer_Mini_SKU_DFR0299>`__), component
@@ -14,8 +14,7 @@ allows you to play sound and music stored in an SD card or USB flash drive.
 
     DF-Player mini Module.
 
-For this integration to work you need to have set up a :ref:`UART bus <uart>`
-in your configuration.
+For this component to work you need to have set up a :ref:`UART bus <uart>` in your configuration.
 
 Overview
 --------
@@ -31,16 +30,7 @@ will be required.
 .. code-block:: yaml
 
     # Example configuration entry
-    uart:
-      tx_pin: GPIO2
-      rx_pin: GPIO5
-      baud_rate: 9600
-
-    # Declare DFPlayer mini module
     dfplayer:
-      on_finished_playback:
-        then:
-          logger.log: 'Somebody press play!'
 
 Configuration variables:
 ------------------------
@@ -345,8 +335,8 @@ Sample code
 .. code-block:: yaml
 
     uart:
-      tx_pin: GPIO2
-      rx_pin: GPIO5
+      tx_pin: GPIOXX
+      rx_pin: GPIOXX
       baud_rate: 9600
 
     dfplayer:

components/dfrobot_sen0395.rst

@@ -36,7 +36,7 @@ a :doc:`/components/uart` component (and its requisite GPIO pins) is required in
         name: Mmwave Detected via GPIO
         device_class: motion
         pin:
-          number: REPLACEME
+          number: GPIOXX
           mode: INPUT_PULLDOWN
 
     switch:
@@ -97,7 +97,7 @@ If you don't want/need to change the radar's settings and only need to determine
         name: Presence Detected via GPIO
         device_class: motion
         pin:
-          number: REPLACEME
+          number: GPIOXX
           mode: INPUT_PULLDOWN
 
 .. _dfrobot_sen0395-via_uart:

components/display/addressable_light.rst

@@ -19,18 +19,6 @@ The display requires that an :apiclass:`AddressableLight <light::AddressableLigh
 
 .. code-block:: yaml
 
-    light:
-      - platform: fastled_clockless
-        chipset: WS2812B
-        pin: GPIO4
-        num_leds: 64
-        rgb_order: GRB
-        name: "led_matrix"
-        id: led_matrix_light
-        default_transition_length: 0s
-        color_correct: [50%, 50%, 50%]
-        restore_mode: ALWAYS_ON
-
     display:
       - platform: addressable_light
         id: led_matrix_display

components/display/ili9xxx.rst

@@ -55,8 +55,8 @@ beyond the basic SPI connections, and a reasonable amount of RAM, it is not well
     display:
       - platform: ili9xxx
         model: ili9341
-        dc_pin: 27
-        reset_pin: 33
+        dc_pin: GPIOXX
+        reset_pin: GPIOXX
         lambda: |-
           it.fill(COLOR_BLACK);
           it.print(0, 0, id(my_font), id(my_red), TextAlign::TOP_LEFT, "Hello World!");
@@ -180,13 +180,13 @@ To configure a dimmable backlight:
     # Define a PWM output on the ESP32
     output:
       - platform: ledc
-        pin: 32
-        id: gpio_32_backlight_pwm
+        pin: GPIOXX
+        id: backlight_pwm
 
     # Define a monochromatic, dimmable light for the backlight
     light:
       - platform: monochromatic
-        output: gpio_32_backlight_pwm
+        output: backlight_pwm
         name: "Display Backlight"
         id: back_light
         restore_mode: ALWAYS_ON
@@ -204,8 +204,8 @@ To configure an image adaptive color pallet to show greater than 8 bit color dep
     display:
       - platform: ili9xxx
         model: ili9341
-        dc_pin: 4
-        reset_pin: 22
+        dc_pin: GPIOXX
+        reset_pin: GPIOXX
         rotation: 90
         id: tft_ha
         color_palette: IMAGE_ADAPTIVE
@@ -234,7 +234,7 @@ This config rotates the display into landscape mode using the driver chip.
           mirror_y: true
         color_order: bgr
         data_rate: 80MHz
-        cs_pin: 10
+        cs_pin: GPIOXX
         dc_pin: GPIO13
         reset_pin: GPIO9
 

components/display/index.rst

@@ -2,7 +2,7 @@ Display Component
 =================
 
 .. seo::
-    :description: Instructions for setting up the display integration.
+    :description: Instructions for setting up the display component.
     :image: folder-open.svg
 
 The ``display`` component houses ESPHome's powerful rendering and display
@@ -360,8 +360,7 @@ You can display current time using a time component. Please see the example :ref
 Screen Clipping
 ---------------
 
-Screen clipping is a new set of methods since version 2023.2.0 of esphome. It could be useful when you just want to show
-a part of an image or make sure that what you draw on the screen does not go outside a specific region on the screen.
+Screen clipping can be useful when you just want to show a part of an image or make sure that what you draw on the screen does not go outside a specific region on the screen.
 
 With ``start_clipping(left, top, right, bottom);`` start you the clipping process and when you are done drawing in that region
 you can stop the clipping process with ``end_clipping();`` . You can nest as many ``start_clipping();`` as you want as long
@@ -935,49 +934,30 @@ Additionally the old page will be given as the variable ``from`` and the new one
 Troubleshooting
 ---------------
 
-Color Test Pattern
-------------------
+Using the Color Test Card
+-------------------------
 
-If you're experiencing issues with your color display, the script below can help you to identify what might be wrong.
-It will show 3 color bars in **RED**, **GREEN** and **BLUE**. To help the graphics display team determine
-the best way to help you, **a picture of the result of this script is very helpful.**
+If you're experiencing issues with your color display, the ``show_test_card: true`` option can help you to identify what might be wrong.
+
+- It will show bars for Red, Green and Blue, graduating to black and white.
+- Together with that it will show the letters "**R**", "**G**" and "**B**" to validate the display geometry.
+- There will be a rectangle around the corners of the display with a marker at the 0,0 corner which should be at the top left of the screen.
+
+.. figure:: images/test_card.jpg
+    :align: center
+    :width: 50.0%
+
+
+
+When all points above are shown correctly then the display is working as expected.
+To help the graphics display team determine the best way to help you, **a picture of the result of this option is very helpful.**
 
 Should you `create an issue <https://github.com/esphome/issues/issues>`__ in GitHub regarding your display, please
-be sure to **include a link to where you purchased it** so that we can validate the configuration you've used.
+be sure to **include a link to where you purchased the display** so that we can validate the configuration you've used.
 
-.. code-block:: yaml
+.. note::
 
-    display:
-      - platform: ...
-        ...
-        lambda: |-
-          int shift_x = (it.get_width()-310)/2;
-          int shift_y = (it.get_height()-256)/2;
-          for(auto i = 0; i<256; i++) {
-            it.horizontal_line(shift_x+  0,i+shift_y,50, my_red.fade_to_white(i));
-            it.horizontal_line(shift_x+ 50,i+shift_y,50, my_red.fade_to_black(i));
-
-            it.horizontal_line(shift_x+105,i+shift_y,50, my_green.fade_to_white(i));
-            it.horizontal_line(shift_x+155,i+shift_y,50, my_green.fade_to_black(i));
-
-            it.horizontal_line(shift_x+210,i+shift_y,50, my_blue.fade_to_white(i));
-            it.horizontal_line(shift_x+260,i+shift_y,50, my_blue.fade_to_black(i));
-          }
-          it.rectangle(shift_x+ 0, 0+shift_y, shift_x+ 310, 256+shift_y, my_yellow);
-
-    color:
-      - id: my_blue
-        blue: 100%
-      - id: my_red
-        red: 100%
-      - id: my_green
-        green: 100%
-      - id: my_white
-        red: 100%
-        blue: 100%
-        green: 100%
-      - id: my_yellow
-        hex: ffff00
+    For displays in 8 bit mode you will see distinct color blocks rather than a smooth gradient.
 
 See Also
 --------

components/display/lcd_display.rst

@@ -2,12 +2,12 @@ Character-Based LCD Display
 ===========================
 
 .. seo::
-    :description: Instructions for setting up character-based HD44780 LCD displays.
+    :description: Instructions for setting up character-based HD44780 LCDs.
     :image: lcd.jpg
 
-The ``lcd_pcf8574`` and ``lcd_gpio`` display components allow you to use HD44780-compatible, character-based LCD displays 
-with ESPHome. This integration is only for LCD displays that display individual characters on a screen 
-(usually 8-40 columns and 2-4 rows), and not for LCD displays that can control each pixel individually.
+The ``lcd_pcf8574`` and ``lcd_gpio`` display components allow you to use HD44780-compatible, character-based LCDs
+with ESPHome. This component is only for LCDs that display individual characters on a screen
+(usually 8-40 columns and 2-4 rows), and not for LCDs that can control each pixel individually.
 
 .. figure:: images/lcd-hello_world.jpg
     :align: center
@@ -90,12 +90,12 @@ faster refresh, especially in conjunction with an :ref:`LCD Menu <lcd_menu>`.
       - platform: lcd_gpio
         dimensions: 20x4
         data_pins:
-          - GPIO32
-          - GPIO33
-          - GPIO5
-          - GPIO17
-        enable_pin: D4
-        rs_pin: D5
+          - GPIOXX
+          - GPIOXX
+          - GPIOXX
+          - GPIOXX
+        enable_pin: GPIOXX
+        rs_pin: GPIOXX
         lambda: |-
           it.print("Hello World!");
 

components/display/max7219.rst

@@ -8,7 +8,7 @@ MAX7219 7-Segment Display
 The ``max7219`` display platform allows you to use MAX7219 7-segment display drivers (
 `datasheet <https://datasheets.maximintegrated.com/en/ds/MAX7219-MAX7221.pdf>`__,
 `hobbycomponents <https://hobbycomponents.com/displays/597-max7219-8-digit-seven-segment-display-module>`__)
-with ESPHome. Please note that this integration is *only* for 7-segment display, not matrix configurations.
+with ESPHome. Please note that this component is *only* for 7-segment display, not matrix configurations.
 
 .. figure:: images/max7219-full.jpg
     :align: center
@@ -16,7 +16,7 @@ with ESPHome. Please note that this integration is *only* for 7-segment display,
 
     MAX7219 7-Segment Display.
 
-As the communication with the MAX7219 is done using SPI for this integration, you need
+As the communication with the MAX7219 is done using SPI for this component, you need
 to have an :ref:`SPI bus <spi>` in your configuration with both the **mosi_pin** set (miso_pin is not required).
 Connect VCC to 3.3V (the manufacturer recommends 4+ V, but 3.3V seems to work fine), DIN to your ``mosi_pin`` and
 CS to your set ``cs_pin`` and finally GND to GND.

components/display/max7219digit.rst

@@ -5,7 +5,7 @@ MAX7219 Digit Display
     :description: Instructions for setting up MAX7219 Digit displays.
     :image: max7219digit.jpg
 
-The ``max7219`` display platform allows you to use MAX7219 digit with ESPHome. Please note that this integration
+The ``max7219`` display platform allows you to use MAX7219 digit with ESPHome. Please note that this component
 is *only* for the digit "matrix" display, for the 7 segment display see :doc:`max7219`.
 
 .. figure:: images/max7219digit.png
@@ -14,7 +14,7 @@ is *only* for the digit "matrix" display, for the 7 segment display see :doc:`ma
 
     MAX7219 Digit Display.
 
-As the communication with the MAX7219 Digit is done using SPI for this integration, you need
+As the communication with the MAX7219 Digit is done using SPI for this component, you need
 to have an :ref:`SPI bus <spi>` in your configuration with both the **mosi_pin** set (miso_pin is not required).
 Connect VCC to 3.3V (the manufacturer recommends 4+ V, but 3.3V seems to work fine), DIN to your ``mosi_pin`` and
 CS to your set ``cs_pin`` and finally GND to GND.

components/display/nextion.rst

@@ -36,17 +36,9 @@ The below example configures a UART for the Nextion display to use
 .. code-block:: yaml
 
     # Example configuration entry
-    uart:
-      id: uart_2
-      rx_pin: GPIO16
-      tx_pin: GPIO17
-      baud_rate: 115200
-
-
     display:
       - platform: nextion
         id: nextion1
-        uart_id: uart_2      
         lambda: |-
           it.set_component_value("gauge", 50);
           it.set_component_text("textview", "Hello World!");

components/display/qspi_amoled.rst

@@ -50,9 +50,9 @@ ESP-IDF. PSRAM is a requirement due to the size of the display buffer. A :ref:`q
         color_order: rgb
         invert_colors: false
         brightness: 255
-        cs_pin: 11
-        reset_pin: 13
-        enable_pin: 9
+        cs_pin: GPIOXX
+        reset_pin: GPIOXX
+        enable_pin: GPIOXX
 
 
 Configuration variables:

components/display/st7789v.rst

@@ -40,17 +40,13 @@ to an ESP module.
 .. code-block:: yaml
 
     # Example minimal configuration entry
-    spi:
-      clk_pin: GPIO18
-      mosi_pin: GPIO19
-
     display:
       - platform: st7789v
         model: TTGO TDisplay 135x240
-        backlight_pin: GPIO4
-        cs_pin: GPIO5
-        dc_pin: GPIO16
-        reset_pin: GPIO23
+        backlight_pin: GPIOXX
+        cs_pin: GPIOXX
+        dc_pin: GPIOXX
+        reset_pin: GPIOXX
         lambda: |-
           it.print(0, 0, id(font), "Hello World!");
 

components/display/tm1621.rst

@@ -22,10 +22,10 @@ The LCD have four signal, ``cs`` for chip select, ``data`` for data signal, ``re
     display:
       platform: tm1621
       id: tm1621_display
-      cs_pin: GPIO17
-      data_pin: GPIO5
-      read_pin: GPIO23
-      write_pin: GPIO18
+      cs_pin: GPIOXX
+      data_pin: GPIOXX
+      read_pin: GPIOXX
+      write_pin: GPIOXX
       lambda: |-
         it.printf(0, "%.1f", id(my_sensor1).state);
         it.display_celsius(true);

components/display/tm1638.rst

@@ -23,9 +23,9 @@ The module can be powered with 5v DC. To display the colon punctuation use the
     display:
         platform: tm1638
         id: tm1638_display
-        stb_pin: 5
-        clk_pin: 18
-        dio_pin: 23
+        stb_pin: GPIOXX
+        clk_pin: GPIOXX
+        dio_pin: GPIOXX
         intensity: 5
         update_interval: 5s
         lambda: |-
@@ -113,9 +113,9 @@ The following example creates a typical digital clock with the ``:`` colon flash
 
     display:
       platform: tm1638
-      clk_pin: 18
-      dio_pin: 23
-      stb_pin: 5
+      clk_pin: GPIOXX
+      dio_pin: GPIOXX
+      stb_pin: GPIOXX
       update_interval: 500ms
       lambda: |-
           static int i = 0;

components/display/waveshare_epaper.rst

@@ -23,7 +23,7 @@ single-color E-Ink displays are implemented and of those only a few modules.
 
     Waveshare E-Paper 2.9 Inch E-Paper Display.
 
-The communication ESPHome has chosen to use for this integration is 4-wire :ref:`SPI <spi>`, as it's the most stable
+The communication ESPHome has chosen to use for this component is 4-wire :ref:`SPI <spi>`, as it's the most stable
 and high-speed. So you need to make sure your board is set to the 4-wire SPI mode and have an ``spi:`` section in your
 configuration.
 
@@ -96,6 +96,7 @@ Configuration variables:
   - ``2.70in-b`` - Black/White/Red
   - ``2.70in-bv2`` - Black/White/Red
   - ``2.90in``
+  - ``2.90in-dke``
   - ``2.90inv2``
   - ``2.90inv2-r2`` - 2.9in V2 display, but with different initialization and full/partial display refresh management than ``2.90inv2`` 
   - ``2.90in-b`` - B/W rendering only

components/display_menu/graphical_display_menu.rst

@@ -12,14 +12,14 @@ 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%
 
 Overview
 --------
 
-The integration implements the :ref:`Display Menu <display_menu>` integration providing
+The component implements the :ref:`Display Menu <display_menu>` component providing
 a hierarchical menu primarily intended to be controlled either by a rotary encoder
 with a button or a five-button joystick controller.
 

components/display_menu/index.rst

@@ -7,7 +7,7 @@ Display Menu
 
 .. _display_menu:
 
-The integration provides a menu primarily intended to be controlled either by a rotary encoder
+The component provides a menu primarily intended to be controlled either by a rotary encoder
 with a button or a five-button joystick controller. It allows to navigate a hierarchy of items
 and submenus with the ability to change the values and execute commands. The menu can
 be activated and deactivated on demand, allowing alternating between using the screen for
@@ -17,8 +17,8 @@ Overview
 --------
 
 This document describes the configuration and automations common for the components implementing
-this integration. At the moment the character based LCD displays are supported using
-the :ref:`lcd_menu <lcd_menu>` integration and an instance of this is used in the configuration
+this component. At the moment the character based LCD displays are supported using
+the :ref:`lcd_menu <lcd_menu>` component and an instance of this is used in the configuration
 examples.
 
 

components/display_menu/lcd_menu.rst

@@ -19,7 +19,7 @@ ESPHome node, without the requirement of a network connection.
 Overview
 --------
 
-The integration implements the :ref:`Display Menu <display_menu>` integration providing
+The component implements the :ref:`Display Menu <display_menu>` component providing
 a hierarchical menu primarily intended to be controlled either by a rotary encoder
 with a button or a five-button joystick controller.
 

components/esp32_camera.rst

@@ -14,16 +14,16 @@ directly integrate into Home Assistant through the native API.
     esp32_camera:
       name: My Camera
       external_clock:
-        pin: GPIO27
+        pin: GPIOXX
         frequency: 20MHz
       i2c_pins:
-        sda: GPIO25
-        scl: GPIO23
-      data_pins: [GPIO17, GPIO35, GPIO34, GPIO5, GPIO39, GPIO18, GPIO36, GPIO19]
-      vsync_pin: GPIO22
-      href_pin: GPIO26
-      pixel_clock_pin: GPIO21
-      reset_pin: GPIO15
+        sda: GPIOXX
+        scl: GPIOXX
+      data_pins: [GPIOXX, GPIOXX, GPIOXX, GPIOXX, GPIOXX, GPIOXX, GPIOXX, GPIOXX]
+      vsync_pin: GPIOXX
+      href_pin: GPIOXX
+      pixel_clock_pin: GPIOXX
+      reset_pin: GPIOXX
       resolution: 640x480
       jpeg_quality: 10
 
@@ -37,10 +37,10 @@ Configuration variables:
   a ``name`` will implicitly set this to true.
 - **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend,
   (usually Home Assistant) without the user manually enabling it (via the Home Assistant UI).
-  Requires Home Assistant 2021.9 or newer. Defaults to ``false``.
+  Defaults to ``false``.
 - **entity_category** (*Optional*, string): The category of the entity.
   See https://developers.home-assistant.io/docs/core/entity/#generic-properties
-  for a list of available options. Requires Home Assistant 2021.11 or newer.
+  for a list of available options.
   Set to ``""`` to remove the default entity category.
 
 Connection Options:
@@ -80,24 +80,24 @@ Image Settings:
 - **resolution** (*Optional*, enum): The resolution the camera will capture images at. Higher
   resolutions require more memory, if there's not enough memory you will see an error during startup.
 
-    - ``160x120`` (QQVGA)
-    - ``176x144`` (QCIF)
-    - ``240x176`` (HQVGA)
-    - ``320x240`` (QVGA)
-    - ``400x296`` (CIF)
-    - ``640x480`` (VGA, default)
-    - ``800x600`` (SVGA)
-    - ``1024x768`` (XGA)
-    - ``1280x1024`` (SXGA)
-    - ``1600x1200`` (UXGA)
-    - ``1920x1080`` (FHD)
-    - ``720x1280`` (Portrait HD)
-    - ``864x1536`` (Portrait 3MP)
-    - ``2048x1536`` (QXGA)
-    - ``2560x1440`` (QHD)
-    - ``2560x1600`` (WQXGA)
-    - ``1080x1920`` (Portrait FHD)
-    - ``2560x1920`` (QSXGA)
+    - ``160x120`` (QQVGA, 4:3)
+    - ``176x144`` (QCIF, 11:9)
+    - ``240x176`` (HQVGA, 15:11)
+    - ``320x240`` (QVGA, 4:3)
+    - ``400x296`` (CIF, 50:37)
+    - ``640x480`` (VGA, 4:3, default)
+    - ``800x600`` (SVGA, 4:3)
+    - ``1024x768`` (XGA, 4:3)
+    - ``1280x1024`` (SXGA, 5:4)
+    - ``1600x1200`` (UXGA, 4:3)
+    - ``1920x1080`` (FHD, 16:9)
+    - ``720x1280`` (Portrait HD, 9:16)
+    - ``864x1536`` (Portrait 3MP, 9:16)
+    - ``2048x1536`` (QXGA, 4:3)
+    - ``2560x1440`` (QHD, 16:9)
+    - ``2560x1600`` (WQXGA, 8:5)
+    - ``1080x1920`` (Portrait FHD, 9:16)
+    - ``2560x1920`` (QSXGA, 4:3)
 
 
 - **jpeg_quality** (*Optional*, int): The JPEG quality that the camera should encode images with.

components/ethernet.rst

@@ -17,8 +17,8 @@ This component and the Wi-Fi component may **not** be used simultaneously, even
     # Example configuration entry for RMII chips
     ethernet:
       type: LAN8720
-      mdc_pin: GPIO23
-      mdio_pin: GPIO18
+      mdc_pin: GPIOXX
+      mdio_pin: GPIOXX
       clk_mode: GPIO0_IN
       phy_addr: 0
 
@@ -33,12 +33,12 @@ This component and the Wi-Fi component may **not** be used simultaneously, even
     # Example configuration entry for SPI chips
     ethernet:
       type: W5500
-      clk_pin: GPIO19
-      mosi_pin: GPIO21
-      miso_pin: GPIO23
-      cs_pin: GPIO18
-      interrupt_pin: GPIO36
-      reset_pin: GPIO22
+      clk_pin: GPIOXX
+      mosi_pin: GPIOXX
+      miso_pin: GPIOXX
+      cs_pin: GPIOXX
+      interrupt_pin: GPIOXX
+      reset_pin: GPIOXX
 
 Configuration variables:
 ------------------------
@@ -233,7 +233,7 @@ Configuration examples
 
 .. note::
 
-    Revision 5 and below of the wESP32 board use the LAN8720 Ethernet PHY. Revision 7 and newer of it use the RTL8201 Ethernet PHY. Support for RTL8201 is available from ESPHome version 2022.12 upwards.
+    Revision 5 and below of the wESP32 board use the LAN8720 Ethernet PHY. Revision 7 and newer of it use the RTL8201 Ethernet PHY.
 
 
 **OpenHacks LAN8720**:

components/event/index.rst

@@ -0,0 +1,149 @@
+Event Component
+===============
+
+.. seo::
+    :description: Instructions for setting up event components in ESPHome.
+    :image: folder-open.svg
+
+ESPHome supports the creation of event entities in Home Assistant.
+These entities allow for the triggering of custom events within the Home Assistant ecosystem,
+enabling complex automations and integrations. An event entity is represented as a stateless
+entity associated with a device that has a pre-defined set of event types which can be
+triggered in Home Assistant via automations.
+
+.. note::
+
+    Events in ESPHome are designed to trigger an action in Home Assistant, and have a unidirectional flow from ESPHome to Home Assistant.
+    Home Assistant event entities are different from events on event bus. If you just want to trigger an event on the
+    Home Assistant event bus, you should use a :ref:`Home Assistant event <api-homeassistant_event_action>` instead.
+
+
+.. note::
+
+    Home Assistant Core 2024.5 or higher is required for ESPHome event entities to work.
+
+.. _config-event:
+
+Base Event Configuration
+------------------------
+
+Each event in ESPHome needs to be configured with a list of event types it can trigger and an optional device class.
+
+.. code-block:: yaml
+
+    # Example event configuration
+    event:
+      - platform: ...
+        name: Motion Detected Event
+        id: my_event
+
+        # Optional variables:
+        icon: "mdi:motion-sensor"
+        device_class: "motion"
+        on_event:
+          then:
+            - logger.log: "Event triggered"
+
+Configuration variables:
+
+One of ``id`` or ``name`` is required.
+
+- **id** (**Required**, :ref:`config-id`): Manually specify the ID used for code generation, allowing for further customization or interaction with this event within ESPHome scripts or lambda functions.
+- **name** (**Required**, string): The name for the event.
+
+  .. note::
+
+      If you have a :ref:`friendly_name <esphome-configuration_variables>` set for your device and
+      you want the event to use that name, you can set ``name: None``.
+
+- **icon** (*Optional*, icon): Manually set the icon to use for the event in the frontend.
+- **internal** (*Optional*, boolean): Mark this component as internal. Internal components will
+  not be exposed to the frontend (like Home Assistant). Only specifying an ``id`` without
+  a ``name`` will implicitly set this to true.
+- **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend,
+  (usually Home Assistant) without the user manually enabling it (via the Home Assistant UI).
+- **entity_category** (*Optional*, string): The category of the entity.
+  See https://developers.home-assistant.io/docs/core/entity/#generic-properties
+  for a list of available options. Set to ``""`` to remove the default entity category.
+- **device_class** (*Optional*, string): The device class for the event. The following device classes are supported by event entities:
+
+  - None: Generic event. This is the default and doesn't need to be set.
+  - ``button``: For remote control buttons.
+  - ``doorbell``: Specifically for buttons that are used as a doorbell.
+  - ``motion``: For motion events detected by a motion sensor.
+
+  See https://www.home-assistant.io/integrations/event/#device-class
+  for a list of available options.
+
+Automations:
+
+- **on_event** (*Optional*, :ref:`Automation <automation>`): An automation to perform when an event is triggered.
+
+MQTT options:
+
+- All other options from :ref:`MQTT Component <config-mqtt-component>`.
+
+Event Automation
+----------------
+
+.. _event-on_event:
+
+``on_event``
+************
+
+This automation will be triggered when an event of the specified types is triggered.
+In :ref:`Lambdas <config-lambda>` you can get the event type from the trigger with ``event_type``.
+
+.. code-block:: yaml
+
+    event:
+      - platform: template
+        # ...
+        on_event:
+          then:
+            - lambda: |-
+                ESP_LOGD("main", "Event %s triggered.", event_type.c_str());
+
+Configuration variables: see :ref:`Automation <automation>`.
+
+``event.trigger`` Action
+************************
+
+This action allows for the triggering of an event from within an automation.
+
+.. code-block:: yaml
+
+    - event.trigger:
+        id: my_event
+        event_type: "custom_event"
+
+Configuration variables:
+
+- **id** (**Required**, :ref:`config-id`): The ID of the event.
+- **event_type** (**Required**, string): The type of event to trigger.
+
+.. _event-lambda_calls:
+
+lambda Calls
+************
+
+From :ref:`lambdas <config-lambda>`, you can trigger an event.
+
+- ``trigger(std::string event_type)``: Trigger an event with the specified type.
+
+  .. code-block:: cpp
+
+      // Within lambda, trigger the event.
+      id(my_event).trigger("custom_event");
+
+See Also
+--------
+
+- :apiref:`event/event.h`
+- :ghedit:`Edit`
+
+.. toctree::
+    :maxdepth: 1
+    :glob:
+
+    *

components/event/template.rst

@@ -0,0 +1,31 @@
+Template Event
+==============
+
+.. seo::
+    :description: Instructions for setting up template events that can trigger arbitrary automations when an event occurs.
+    :image: description.svg
+
+The ``template`` event platform enables you to define events that trigger specific automations or actions within Home Assistant. These custom events can be utilized to orchestrate complex behaviors across your smart home ecosystem based on conditions or sequences defined in your ESPHome configuration.
+
+.. code-block:: yaml
+
+    # Example configuration entry
+    event:
+      - platform: template
+        name: "Template Event"
+        event_types:
+          - "custom_event_1"
+          - "custom_event_2"
+
+Configuration variables:
+------------------------
+
+- **event_types** (**Required**, list): A list of custom event identifiers that this template event is capable of triggering. These identifiers can be used in Home Assistant automations or ESPHome scripts to perform actions when the event occurs.
+- All other options from :ref:`Event <config-event>`.
+
+See Also
+--------
+
+- :doc:`/guides/automations`
+- :doc:`/components/event/index`
+- :ghedit:`Edit`

components/exposure_notifications.rst

@@ -52,7 +52,7 @@ minute, the indicator will be on.
 
     switch:
       - platform: gpio
-        pin: GPIO22
+        pin: GPIOXX
         id: led
 
     script:

components/external_components.rst

@@ -46,6 +46,7 @@ Configuration variables:
   - **ref** (*Optional*, string): Git ref (branch or tag). If not specified the default branch is used.
   - **username** (*Optional*, string): Username for the Git server, if one is required
   - **password** (*Optional*, string): Password for the Git server, if one is required
+  - **path** (*Optional*, string): Path inside the repo, if different from ``components`` or ``esphome/components``
 
   local options:
 

components/fan/binary.rst

@@ -14,11 +14,6 @@ The ``binary`` fan platform lets you represent any binary :ref:`output` as a fan
 .. code-block:: yaml
 
     # Example configuration entry
-    output:
-      - id: fan_output
-        platform: gpio
-        pin: GPIO16
-        
     fan:
       - platform: binary
         output: fan_output

components/fan/hbridge.rst

@@ -23,14 +23,6 @@ The ``hbridge`` fan platform allows you to use a compatible *h-bridge* (L298N, D
 .. code-block:: yaml
 
     # Example configuration entry
-    output:
-      - platform: ...
-        id: motor_forward_pin
-        pin: GPIO5
-      - platform: ...
-        id: motor_reverse_pin
-        pin: GPIO4
-
     fan:
       - platform: hbridge
         id: my_fan

components/fan/index.rst

@@ -49,10 +49,10 @@ Configuration variables:
   a ``name`` will implicitly set this to true.
 - **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend
   (usually Home Assistant) without the user manually enabling it (via the Home Assistant UI).
-  Requires Home Assistant 2021.9 or newer. Defaults to ``false``.
+  Defaults to ``false``.
 - **entity_category** (*Optional*, string): The category of the entity.
   See https://developers.home-assistant.io/docs/core/entity/#generic-properties
-  for a list of available options. Requires Home Assistant 2021.11 or newer.
+  for a list of available options.
   Set to ``""`` to remove the default entity category.
 
 MQTT options:

components/fingerprint_grow.rst

@@ -2,7 +2,7 @@ Grow Fingerprint Reader
 =======================
 
 .. seo::
-    :description: Instructions for setting up Grow Fingerprint Reader integration in ESPHome.
+    :description: Instructions for setting up Grow Fingerprint Reader component in ESPHome.
     :image: fingerprint.svg
 
 The ``fingerprint_grow`` component allows you to use your R307, R503, R503-RGB, ZFM-20, ... fingerprint sensors with ESPHome.
@@ -30,16 +30,10 @@ If available on your reader model, it's recommended to connect 3.3VT (touch indu
 .. code-block:: yaml
 
     # Example configuration entry
-    uart:
-      rx_pin: GPIO13
-      tx_pin: GPIO15
-      baud_rate: 57600
-
-    # Declare Grow Fingerprint Reader
     fingerprint_grow:
-      sensing_pin: GPIO12
+      sensing_pin: GPIOXX
       sensor_power_pin:
-          number: GPIO18
+          number: GPIOXX
           inverted: true
       idle_period_to_sleep: 5s
 
@@ -93,46 +87,27 @@ Configuration variables:
 - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - All other options from :ref:`Binary Sensor <config-binary_sensor>`.
 
-Optional Sensor Configuration:
 
 Sensor
 ------
 
 - **fingerprint_count**: The number of enrolled fingerprints stored on the reader.
-
-  - **name** (**Required**, string): The name for the sensor.
-  - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
-  - All other options from :ref:`Sensor <config-sensor>`.
+  All options from :ref:`Sensor <config-sensor>`.
 
 - **last_finger_id**: The last matched enrolled fingerprint as set by :ref:`fingerprint_grow-on_finger_scan_matched`.
-
-  - **name** (**Required**, string): The name for the sensor.
-  - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
-  - All other options from :ref:`Sensor <config-sensor>`.
+  All options from :ref:`Sensor <config-sensor>`.
 
 - **last_confidence**: The last matched confidence as set by :ref:`fingerprint_grow-on_finger_scan_matched`.
-
-  - **name** (**Required**, string): The name for the sensor.
-  - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
-  - All other options from :ref:`Sensor <config-sensor>`.
+  All options from :ref:`Sensor <config-sensor>`.
 
 - **status**: The integer representation of the internal status register of the reader.
-
-  - **name** (**Required**, string): The name for the sensor.
-  - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
-  - All other options from :ref:`Sensor <config-sensor>`.
+  All options from :ref:`Sensor <config-sensor>`.
 
 - **capacity**: The fingerprint storage capacity of the reader.
-
-  - **name** (**Required**, string): The name for the sensor.
-  - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
-  - All other options from :ref:`Sensor <config-sensor>`.
+  All options from :ref:`Sensor <config-sensor>`.
 
 - **security_level**: The integer representation of the currently configured security level of the reader. Higher security levels reduce the false acceptance rate (FAR) at the expense of increasing the false rejection rate (FRR). Range is 1 (lowest) to 5 (highest).
-
-  - **name** (**Required**, string): The name for the sensor.
-  - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
-  - All other options from :ref:`Sensor <config-sensor>`.
+  All options from :ref:`Sensor <config-sensor>`.
 
 .. _fingerprint_grow-sleep_mode:
 
@@ -150,14 +125,14 @@ This is a wiring example for the R503 and below you can find the respective conf
 .. code-block:: yaml
 
     uart:
-      rx_pin: GPIO16
-      tx_pin: GPIO17
+      rx_pin: GPIOXX
+      tx_pin: GPIOXX
       baud_rate: 57600
 
     fingerprint_grow:
-      sensing_pin: GPIO4
+      sensing_pin: GPIOXX
       sensor_power_pin:
-          number: GPIO18
+          number: GPIOXX
           inverted: true
       idle_period_to_sleep: 5s
 
@@ -513,12 +488,12 @@ Sample code
 .. code-block:: yaml
 
     uart:
-      rx_pin: GPIO13
-      tx_pin: GPIO15
+      rx_pin: GPIOXX
+      tx_pin: GPIOXX
       baud_rate: 57600
 
     fingerprint_grow:
-      sensing_pin: GPIO12
+      sensing_pin: GPIOXX
       on_finger_scan_invalid:
         - homeassistant.event:
             event: esphome.test_node_finger_scan_invalid

components/gps.rst

@@ -2,7 +2,7 @@ GPS Component
 =============
 
 .. seo::
-    :description: Instructions for setting up GPS integration in ESPHome.
+    :description: Instructions for setting up GPS component in ESPHome.
     :image: crosshairs-gps.svg
 
 The ``gps`` component allows you to connect GPS modules to your ESPHome project.
@@ -16,15 +16,12 @@ Any GPS module that uses the standardized NMEA communication protocol will work.
 
 .. _Adafruit: https://www.adafruit.com/product/746
 
-For this integration to work you need to have set up a :ref:`UART bus <uart>`
+For this component to work you need to have set up a :ref:`UART bus <uart>`
 in your configuration - only the RX pin should be necessary.
 
 .. code-block:: yaml
 
     # Example configuration entry
-    uart:
-      rx_pin: D7
-      baud_rate: 9600
 
     # Declare GPS module
     gps:

components/host.rst

@@ -0,0 +1,38 @@
+HOST Platform
+=============
+
+.. seo::
+    :description: Configuration for the host platform for ESPHome.
+    :image: host.svg
+
+The ``host`` platform allows ESPHome configurations to be compiled and run on a desktop computer. This is known
+to work on MacOS and Linux. On Windows `WSL <https://learn.microsoft.com/en-us/windows/wsl/install>`_ (Windows Subsystem for Linux) can be used to create a Linux environment that will run ESPHome.
+
+The only configuration required is to optionally set a dummy MAC address that will be used to identify the
+configuration to Home Assistant (the native MAC address is not readily available.)
+
+.. note::
+
+    HA will not automatically discover an ESPHome instance running on ``host`` using MDNS, and you will need
+    to add it explicitly using the IP address of your host computer.
+
+Many components, especially those interfacing to actual hardware, will not be available when using ``host``. Do not
+configure wifi - network will automatically be available using the host computer.
+
+.. code-block:: yaml
+
+    # Example configuration entry
+    host:
+      mac_address: "98:35:69:ab:f6:79"
+
+Configuration variables:
+------------------------
+
+- **mac_address** (**Optional**, MAC address): A dummy MAC address to use when communicating with HA.
+
+
+See Also
+--------
+
+- :doc:`esphome`
+- :ghedit:`Edit`

components/i2c.rst

@@ -20,8 +20,8 @@ connecting the wires from each device back to the two I²C pins on the ESP.
 
     # Example configuration entry for ESP32
     i2c:
-      sda: 21
-      scl: 22
+      sda: GPIOXX
+      scl: GPIOXX
       scan: true
       id: bus_a
 
@@ -51,12 +51,12 @@ Configuration variables:
         # Example configuration entry
         i2c:
           - id: bus_a
-            sda: 13
-            scl: 16
+            sda: GPIOXX
+            scl: GPIOXX
             scan: true
           - id: bus_b
-            sda: 14
-            scl: 15
+            sda: GPIOXX
+            scl: GPIOXX
             scan: true
        # Sensors should be specified as follows
        - platform: bme680

components/i2s_audio.rst

@@ -14,8 +14,8 @@ This component only works on ESP32 based chips.
 
     # Example configuration entry
     i2s_audio:
-      i2s_lrclk_pin: GPIO33
-      i2s_bclk_pin: GPIO19
+      i2s_lrclk_pin: GPIOXX
+      i2s_bclk_pin: GPIOXX
 
 Configuration variables:
 ------------------------

components/index.rst

@@ -17,6 +17,7 @@ Components
     sensor/index
     switch/index
     button/index
+    event/index
     display/index
     text_sensor/index
     stepper/index
@@ -29,4 +30,5 @@ Components
     time/index
     alarm_control_panel/index
     text/index
+    valve/index
     *

components/light/binary.rst

@@ -20,10 +20,6 @@ The ``binary`` light platform creates a simple ON/OFF-only light from a
         name: "Desk Lamp"
         output: light_output
 
-    output:
-      - id: light_output
-        platform: gpio
-        pin: GPIO16
 
 Configuration variables:
 ------------------------

components/light/custom.rst

@@ -1,21 +1,27 @@
 Custom Light Output
 ===================
 
+.. seo::
+    :description: Instructions for setting up Custom C++ lights with ESPHome.
+    :image: language-cpp.svg
+    :keywords: C++, Custom
+
 .. warning::
 
-    Custom components are deprecated, not recommended for new configurations
-    and will be removed from ESPHome in a future release.
-    Please look at creating a real ESPHome component and "importing" it into your
-    configuration with :doc:`/components/external_components`.
+    Custom components are deprecated, not recommended for new configurations and will be removed from ESPHome in a
+    future release. Please look at creating a real ESPHome component and "importing" it into your configuration with
+    :doc:`/components/external_components`.
 
-    You can find some basic documentation on creating your own components
-    at :ref:`contributing_to_esphome`.
+    You can find some basic documentation on creating your own components at :ref:`contributing_to_esphome`.
 
-This integration can be used to create custom lights in ESPHome
-using the C++ (Arduino) API.
+.. warning::
 
-Please first read :doc:`/components/sensor/custom` guide,
-the same principles apply here.
+    While we try to keep the ESPHome YAML configuration options as stable as possible, the ESPHome API is less
+    stable. If something in the APIs needs to be changed in order for something else to work, we will do so.
+
+This component can be used to create custom lights in ESPHome using the C++ (Arduino) API.
+
+Please first read :doc:`/components/sensor/custom` guide, the same principles apply here.
 
 All internal stuff (like effects, transitions etc) is handled by the light core
 and cannot be overridden. Light outputs are only responsible for displaying some state

components/light/esp32_rmt_led_strip.rst

@@ -12,7 +12,7 @@ This is a component using the ESP32 RMT peripheral to drive most addressable LED
     light:
       - platform: esp32_rmt_led_strip
         rgb_order: GRB
-        pin: GPIO13
+        pin: GPIOXX
         num_leds: 30
         rmt_channel: 0
         chipset: ws2812

components/light/fastled.rst

@@ -47,7 +47,7 @@ Clockless FastLED lights differ from the
     light:
       - platform: fastled_clockless
         chipset: WS2811
-        pin: GPIO23
+        pin: GPIOXX
         num_leds: 60
         rgb_order: BRG
         name: "FastLED WS2811 Light"
@@ -126,8 +126,8 @@ whereas the clockless lights only need a single pin.
     light:
       - platform: fastled_spi
         chipset: WS2801
-        data_pin: GPIO23
-        clock_pin: GPIO22
+        data_pin: GPIOXX
+        clock_pin: GPIOXX
         num_leds: 60
         rgb_order: BRG
         name: "FastLED SPI Light"

components/light/hbridge.rst

@@ -18,17 +18,6 @@ The pins are switched alternatively to allow two sets of lights to operate.
 .. code-block:: yaml
 
     # Example configuration entry
-
-    # Specify the two pins of the h-bridge as PWM pins
-    output:
-      - platform: esp8266_pwm
-        id: pina
-        pin: GPIO12
-      - platform: esp8266_pwm
-        id: pinb
-        pin: GPIO14
-
-    # Create a light using the hbridge
     light:
       - platform: hbridge
         id: mainlight

components/light/index.rst

@@ -77,10 +77,10 @@ Advanced options:
   a ``name`` will implicitly set this to true.
 - **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend,
   (usually Home Assistant) without the user manually enabling it (via the Home Assistant UI).
-  Requires Home Assistant 2021.9 or newer. Defaults to ``false``.
+  Defaults to ``false``.
 - **entity_category** (*Optional*, string): The category of the entity.
   See https://developers.home-assistant.io/docs/core/entity/#generic-properties
-  for a list of available options. Requires Home Assistant 2021.11 or newer.
+  for a list of available options.
   Set to ``""`` to remove the default entity category.
 - If MQTT enabled, all other options from :ref:`MQTT Component <config-mqtt-component>`.
 
@@ -583,6 +583,7 @@ Configuration variables:
   - **cold_white** (*Optional*, percentage): The cold white channel of the light, if applicable. Defaults to ``100%``.
   - **warm_white** (*Optional*, percentage): The warm white channel of the light, if applicable. Defaults to ``100%``.
   - **duration** (**Required**, :ref:`config-time`): The duration this color should be active.
+  - **transition_length** (*Optional*, :ref:`config-time`): The duration of each transition. Defaults to ``0s``.
 
 See `light.turn_on <light-turn_on_action>` for more information on the various color fields.
 

components/light/monochromatic.rst

@@ -26,11 +26,6 @@ The ``monochromatic`` light platform creates a simple brightness-only light from
         name: "Kitchen Lights"
         output: output_component1
 
-    # Example output entry
-    output:
-      - platform: esp8266_pwm
-        id: output_component1
-        pin: D1
 
 Configuration variables:
 ------------------------

components/light/neopixelbus.rst

@@ -18,7 +18,7 @@ in ESPHome for individually addressable lights like NeoPixel or WS2812.
 It is very similar to the :doc:`fastled` platform.
 In fact, most addressable lights are supported through both light platforms. The
 difference is that they use different libraries: while the fastled platform uses
-the `FastLED <https://github.com/FastLED/FastLED>`__ library, this integration uses
+the `FastLED <https://github.com/FastLED/FastLED>`__ library, this component uses
 the `NeoPixelBus <https://github.com/Makuna/NeoPixelBus/>`__ library internally.
 
 .. code-block:: yaml
@@ -28,7 +28,7 @@ the `NeoPixelBus <https://github.com/Makuna/NeoPixelBus/>`__ library internally.
       - platform: neopixelbus
         type: GRB
         variant: WS2811
-        pin: GPIO23
+        pin: GPIOXX
         num_leds: 60
         name: "NeoPixel Light"
 

components/light/rgb.rst

@@ -28,12 +28,6 @@ The ``rgb`` light platform creates an RGB light from 3 :ref:`float output compon
         green: output_component2
         blue: output_component3
 
-    # Example output entry
-    output:
-      - platform: esp8266_pwm
-        id: output_component1
-        pin: D1
-      # Repeat for green and blue output
 
 Color Correction
 ----------------
@@ -54,9 +48,8 @@ perceived intensity of different colors will generally vary. This can be done by
 
     # Example output entry
     output:
-      - platform: esp8266_pwm
+      - platform: ...
         id: output_component1
-        pin: D1
         max_power: 80%
       # Repeat for green and blue output
 

components/light/rgbw.rst

@@ -38,9 +38,8 @@ perceived intensity of different colors will generally vary. This can be done by
 
     # Example output entry
     output:
-      - platform: esp8266_pwm
+      - platform: ...
         id: output_component1
-        pin: D1
         max_power: 80%
 
 .. note::

components/light/rgbww.rst

@@ -44,9 +44,8 @@ perceived intensity of different colors will generally vary. This can be done by
 
     # Example output entry
     output:
-      - platform: esp8266_pwm
+      - platform: ...
         id: output_component1
-        pin: D1
         max_power: 80%
 
 .. note::

components/light/rp2040_pio_led_strip.rst

@@ -13,7 +13,7 @@ This is a component using the RP2040 PIO peripheral to drive most addressable LE
       - platform: rp2040_pio_led_strip
         name: led_strip
         id: led_strip
-        pin: GPIO13
+        pin: GPIOXX
         num_leds: 10
         pio: 0
         rgb_order: GRB

components/light/spi_led_strip.rst

@@ -18,14 +18,9 @@ LEDs, or any others with a similar interface - SPI, 8 bits per colour and BGR or
 .. code-block:: yaml
 
     # Example configuration entry
-    spi:
-      mosi_pin: GPIO3
-      clk_pin: GPIO9
-
     light:
       - platform: spi_led_strip
         num_leds: 30
-        color_correct: [80%, 60%, 100%]
         id: rgb_led
         name: "RGB LED Strip"
         data_rate: 1MHz

components/light/status_led.rst

@@ -22,7 +22,7 @@ When the device is in OK state, the LED will be restored to the state of the ``b
     light:
       - platform: status_led
         name: "Switch state"
-        pin: GPIO2
+        pin: GPIOXX
 
 .. note::
 
@@ -50,7 +50,7 @@ Configuration variables:
     .. code-block:: yaml
 
         pin:
-          number: GPIO2
+          number: GPIOXX
           inverted: true