New branding for ESPHome (#3926)

* Update for higher i2c frequencies on IDF

* Update sht3xd.rst

.devcontainer/devcontainer.json

@@ -2,7 +2,7 @@
 {
   "name": "ESPHome - docs",
   "image": "mcr.microsoft.com/vscode/devcontainers/python:0-3.11",
-  "postCreateCommand": "pip3 install -r requirements.txt -r requirements_test.txt",
+  "postCreateCommand": ".devcontainer/postCreate.sh",
   "postAttachCommand": "make live-html",
   "forwardPorts": [8000],
   "features": {

.devcontainer/postCreate.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+
+pip3 install -r requirements.txt -r requirements_test.txt
+curl -L https://github.com/CloudCannon/pagefind/releases/download/v1.1.0/pagefind-v1.1.0-x86_64-unknown-linux-musl.tar.gz | tar -xz -C ~/.local/bin

.github/workflows/docker.yml

@@ -18,9 +18,17 @@ 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
       -
         name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
@@ -43,6 +51,7 @@ jobs:
         with:
           context: .
           push: true
+          platforms: linux/amd64,linux/arm64
           tags: |
             esphome/esphome-docs:latest
             ghcr.io/esphome/esphome-docs:latest

.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:

.gitignore

@@ -11,3 +11,5 @@ venv
 .vscode
 *.DS_Store
 /.idea/
+
+_pagefind/

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,39 @@ 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 .
+ENV PAGEFIND_VERSION="1.1.0"
+ARG TARGETARCH
+SHELL ["/bin/bash", "-c"]
+RUN <<EOF
+    export TARGETARCH=${TARGETARCH/arm64/aarch64}
+    export TARGETARCH=${TARGETARCH/amd64/x86_64}
+    curl -o pagefind.tar.gz https://github.com/CloudCannon/pagefind/releases/download/v$PAGEFIND_VERSION/pagefind-v$PAGEFIND_VERSION-$TARGETARCH-unknown-linux-musl.tar.gz -L
+    tar xzf pagefind.tar.gz
+    rm pagefind.tar.gz
+    mv pagefind /usr/bin
+    chmod +x /usr/bin/pagefind
+EOF
+
+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.2.0
+PROJECT_NUMBER         = 2024.5.5
 
 # 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,12 +1,21 @@
 ESPHOME_PATH = ../esphome
-ESPHOME_REF = 2024.2.0
+ESPHOME_REF = 2024.5.5
+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: pagefind build-html html html-strict cleanhtml deploy help live-html live-pagefind Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify
 
-html:
+html: pagefind
+	sphinx-build -M html . _build -j auto -n $(O) -Dhtml_extra_path=_redirects,_pagefind
+
+pagefind:
 	sphinx-build -M html . _build -j auto -n $(O)
-live-html:
-	sphinx-autobuild . _build -j auto -n $(O) --host 0.0.0.0
+	mkdir -p _pagefind/pagefind
+	${PAGEFIND}
+
+live-html:	pagefind
+	sphinx-autobuild . _build -j auto -n $(O) --host 0.0.0.0 -Dhtml_extra_path=_redirects,_pagefind
 
 html-strict:
 	sphinx-build -M html . _build -W -j auto -n $(O)
@@ -32,6 +41,12 @@ api:
 	fi
 	ESPHOME_PATH=$(ESPHOME_PATH) doxygen Doxygen
 
+net-html:
+	sphinx-build -M html . _build -j auto -n $(O)
+	mkdir -p _pagefind/pagefind
+	${NET_PAGEFIND}
+	sphinx-build -M html . _build -j auto -n $(O) -Dhtml_extra_path=_redirects,_pagefind
+
 netlify-api: netlify-dependencies
 	mkdir -p _build/html/api
 	@if [ ! -d "$(ESPHOME_PATH)" ]; then \
@@ -40,19 +55,31 @@ 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.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.tar.gz
+	rm pagefind.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
 
+clean:
+	rm -rf _pagefind/
+	sphinx-build -M clean . _build $(O)
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile

_static/browserconfig.xml

@@ -3,7 +3,7 @@
     <msapplication>
         <tile>
             <square150x150logo src="/_static/mstile-150x150.png"/>
-            <TileColor>#dfdfdf</TileColor>
+            <TileColor>#18bcf2</TileColor>
         </tile>
     </msapplication>
 </browserconfig>

_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,77 @@ 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;
+}
+
+/* New branding changes */
+
+div.body h1, div.body h2, div.body h3, div.body h4, div.body h5, div.body h6, div.sphinxsidebar h3, div.sphinxsidebar h4, div.admonition p.admonition-title {
+  font-family: Figtree, system, -apple-system, ".SFNSText-Regular", "San Francisco", "Roboto", "Segoe UI", "Helvetica Neue", "Lucida Grande", sans-serif;
+  font-weight: 600;
+}
+
+div.body h1 {
+  font-size: 2.5rem;
+}
+
+body {
+  font-family: "Instrument Sans", system, -apple-system, ".SFNSText-Regular", "San Francisco", "Roboto", "Segoe UI", "Helvetica Neue", "Lucida Grande", sans-serif;
+  line-height: 1.5;
+  letter-spacing: 0.01rem;
+}
+
+div.body p, div.body dd, div.body li {
+  line-height: 1.6;
+}
+
+@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 +413,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/safari-pinned-tab.svg

@@ -1 +1,10 @@
-<svg version="1.0" xmlns="http://www.w3.org/2000/svg" width="1066.667" height="1066.667" viewBox="0 0 800 800"><path d="M266.5 149.6c-12.4 3.1-19.4 8.1-24.5 17.5l-3.5 6.4-.3 17.6-.4 17.6-4.3.6c-6.1.9-11.1 4.2-14.3 9.6l-2.7 4.6-.3 160.2L216 544H94v-15h49c34.4 0 49.6-.3 51.4-1.1 5-2.3 5.7-6.1 5.4-27.4l-.3-19.5-2.8-2.7-2.7-2.8-50-.3-50-.3V460h99l3.2-2.9 3.3-2.9V412l-2.8-2.7-2.7-2.8-50-.3-50-.3v-14.8l50-.3 50-.3 2.7-2.8 2.8-2.7v-42.2l-3.3-2.9-3.2-2.9H94v-99.8l-2.6-3.1c-3.6-4.3-9.3-4.4-13.5-.2l-2.9 2.9v113.4l2.9 2.9 2.9 2.9H180v16H80.8l-2.9 2.9-2.9 2.9v41.4l2.9 2.9 2.9 2.9H180v16H80.8l-2.9 2.9-2.9 2.9v41l2.6 3.1 2.6 3.1H180v16H81.1l-2.8 2.4-2.8 2.4-.3 21-.3 21 3 3.4 2.9 3.3 67.5.3 67.5.2.7 4.3c.4 2.3 1.3 5.3 2 6.7 2.8 5.4 10.1 10 15.9 10h3.5l.3 19.7c.3 19 .4 20 3 25.5 5.4 11.6 15.2 18.1 28.3 18.6 9.8.5 17.1-1.9 23.7-7.7 9.3-8.2 11.8-17 11.8-41.4V585h12v15.3c0 8.4.5 18 1.1 21.3 2.2 11.9 9.9 21.4 20.8 25.5 7.8 2.9 19.4 2.4 26.6-1.3 6.4-3.4 12.8-10 15.7-16.3 2.1-4.6 2.3-6.7 2.6-24.8l.4-19.7h12.6l.4 19.7c.3 17.7.6 20.3 2.5 24.5 2.9 6.3 9.7 13.4 15.8 16.6 7.2 3.7 18.8 4.2 26.6 1.3 7.9-3 14.1-8.8 18.1-16.9l3.3-6.7.3-19.3.4-19.3 6.1.3 6.2.3.5 20c.5 19.5.6 20.1 3.3 25.3 3.5 6.7 9 12.2 15.3 15.3 4.1 2 6.4 2.4 14.4 2.4 8.1 0 10.3-.4 14.5-2.4 6.3-3.2 12.4-9.3 15.6-15.6 2.2-4.7 2.4-6.3 2.9-25l.5-20 6.1-.3 6.2-.3.3 19.3.4 19.3 3.3 6.7c4 8.1 10.2 13.9 18.1 16.9 7.8 2.9 19.4 2.4 26.6-1.3 6.1-3.2 12.9-10.3 15.8-16.6 2-4.2 2.2-6.7 2.5-24.5l.4-19.7h12.6l.4 19.7c.3 22.6 1.3 26.1 9.1 34.1 6.4 6.7 12.7 9.5 22.2 10 9.8.5 17-1.9 23.7-7.7 9.2-8.2 11.8-17 11.8-41.2v-14.6l4.5-.5c5.4-.7 10.2-3.7 13.6-8.7l2.4-3.6.3-173c.2-121 0-174.1-.8-176.7-2.1-7.2-10.2-13.7-17.1-13.8h-2.6l-.5-16.9c-.4-16.6-.5-17-3.6-23.4-5.9-12-16.9-19-29.6-19-13.6 0-24.8 7-30.4 19.1-2.5 5.4-2.7 6.7-3 22.9l-.4 17.3H623v-15.3c0-17.2-1.1-22.4-6.1-30.1-6.5-9.7-20.5-15.8-31.9-13.8-11.9 2.1-20.7 8.9-25.7 19.7-2.6 5.6-2.7 7-3.1 22.7l-.4 16.8H543v-16.5c0-14.1-.3-17.2-2-21.9-2.9-7.6-8.8-13.9-16.6-17.7-5.7-2.8-7.6-3.3-14.4-3.3-6.8 0-8.7.5-14.4 3.3-7.1 3.5-12.2 8.6-15.8 16-2.1 4.2-2.3 6.3-2.6 22.3l-.4 17.8h-12.6l-.4-16.8c-.6-19.7-1.7-23.7-8.8-31.5-8.6-9.5-20.5-13.2-32.1-10.2-10.5 2.6-18.2 9-22.8 18.5-2.4 5.1-2.6 6.6-2.9 22.7l-.4 17.3H384v-15.3c0-17.2-1.1-22.4-6.1-30.1-6.5-9.7-20.5-15.8-31.9-13.8-11.9 2.1-20.7 9-25.8 20.1-2.4 5.1-2.6 7-3 22.3l-.5 16.8H305v-12.3c0-21.3-2.8-30.7-11.3-38.4-7-6.2-20-10.4-27.2-8.7zm11.5 20.9c1.5.8 3.8 3 4.9 4.8 1.9 3.1 2.1 4.9 2.1 18.6V209h-28v-13.9c0-7.7.5-15.2 1.1-16.8 1.3-3.4 4.7-7.2 7.4-8.3 3.2-1.4 9.4-1.1 12.5.5zm81.6 1.6c4.6 4.2 5.4 7.6 5.4 22.9v14h-28v-15c0-16.9.8-19.6 6.3-23.1 4.5-2.8 12.7-2.2 16.3 1.2zm77.5-1.6c6 3.1 6.9 6.3 6.9 23.2V209h-28.2l.4-15.3c.2-12.7.6-15.8 2.1-18 4-6.1 12.4-8.4 18.8-5.2zm80.4.5c5.5 3.4 6.5 6.9 6.5 23.4V209h-28v-14.6c0-13 .2-15 2.1-18.3 1.1-2.1 3.3-4.5 4.7-5.4 3.7-2.3 10.7-2.2 14.7.3zm81.5 1.5c4.1 4 5 7.9 5 23.2V209h-28v-15c0-16.9.8-19.6 6.3-23.1 4.8-3 12.7-2.2 16.7 1.6zm77.1-2c6 3.1 6.9 6.3 6.9 23.2V209h-28v-13.9c0-7.7.5-15.2 1.1-16.8 1.3-3.4 4.7-7.2 7.4-8.3 3.3-1.4 9.4-1.1 12.6.5zm26.7 226.7l-.3 166.3-232.2.3-232.3.2V231h465l-.2 166.2zM285 602.3c0 14.8-.3 17.7-1.8 20.6-3.7 6.8-12.9 9.1-19.3 4.8-6.1-4-6.9-7.1-6.9-26V585h28v17.3zm79.5.7c0 19.5-.5 21.2-6.8 25-6.4 3.9-15.4 1.5-18.9-5.1-1.5-2.9-1.8-5.8-1.8-20.7v-17.3l13.8.3 13.7.3V603zm79.5-.3c0 15.7-.2 18.2-1.9 20.9-3.7 6.1-13.4 8.1-19.6 4-5-3.3-6-6.8-6.3-23.9-.2-8.7-.1-16.4.2-17.2.4-1.2 3.2-1.5 14.1-1.5H444v17.7zm80-.5c0 15.5-.2 17.6-2 20.6-4.3 7-12.8 9.2-19.1 4.9-6.1-4-6.9-7.1-6.9-26V585h28v17.2zm79.5.8c0 19.5-.5 21.2-6.8 25-6.1 3.8-14.9 1.7-18.7-4.5-1.8-2.9-2-4.9-2-20.9v-17.7l13.8.3 13.7.3V603zm79.5-.7c0 14.8-.3 17.7-1.8 20.6-3.7 6.8-12.9 9.1-19.3 4.8-6-4-6.9-7.1-6.9-25.3 0-8.8.3-16.4.7-16.7.3-.4 6.6-.7 14-.7H683v17.3z"/><path d="M413.7 359.8c-39.5 39.5-53.7 54.3-53.7 56 0 3.5 2.8 8.1 5.3 8.7 1.2.3 6.3.6 11.2.8l9 .2.5 32.3.5 32.4 2.4 1.9c2.2 1.8 5.1 1.9 82.1 1.9s79.9-.1 82.1-1.9l2.4-1.9.5-32.4.5-32.3 9-.2c11.8-.4 13.2-.8 15-4.3 2.8-5.4 2.1-6.6-11.5-20.5l-13-13.2v-22.4c-.1-16-.4-22.9-1.3-24-2.4-3.1-5.6-3.9-15.7-3.9-9.9 0-10.2.1-13.1 2.9-2.4 2.5-2.9 3.7-2.9 8 0 2.8-.3 5.1-.8 5.1-.4 0-11.3-10.6-24.2-23.5-21.8-21.8-23.7-23.5-27-23.5-3.3 0-6.6 3.1-57.3 53.8z"/></svg>
+<svg width="512" height="512" viewBox="0 0 512 512" fill="none" xmlns="http://www.w3.org/2000/svg">
+<g clip-path="url(#clip0_2_408)">
+<path d="M372.68 238.9L267.32 133.52C261.1 127.3 250.92 127.3 244.7 133.52L139.32 238.9C133.1 245.12 128 257.42 128 266.22V362.22C128 371.02 135.2 378.22 144 378.22H206.94V218.92C206.94 215.38 209.8 212.52 213.34 212.52H298.68C302.22 212.52 305.08 215.38 305.08 218.92V244.52C305.08 248.06 302.22 250.92 298.68 250.92H245.34V263.72H298.68C302.22 263.72 305.08 266.58 305.08 270.12V295.72C305.08 299.26 302.22 302.12 298.68 302.12H245.34V314.92H298.68C302.22 314.92 305.08 317.78 305.08 321.32V346.92C305.08 350.46 302.22 353.32 298.68 353.32H238.94C235.4 353.32 232.54 350.46 232.54 346.92C232.54 343.38 235.4 340.52 238.94 340.52H292.28V327.72H238.94C235.4 327.72 232.54 324.86 232.54 321.32V295.72C232.54 292.18 235.4 289.32 238.94 289.32H292.28V276.52H238.94C235.4 276.52 232.54 273.66 232.54 270.12V244.52C232.54 240.98 235.4 238.12 238.94 238.12H292.28V225.32H219.74V378.22H368C376.8 378.22 384 371.02 384 362.22V266.22C384 257.42 378.9 245.12 372.68 238.9Z" fill="#F2F4F9"/>
+</g>
+<defs>
+<clipPath id="clip0_2_408">
+<rect width="256" height="256" fill="white" transform="translate(128 128.62)"/>
+</clipPath>
+</defs>
+</svg>

_static/site.webmanifest

@@ -33,8 +33,8 @@
             "type": "image/png"
         }
     ],
-    "theme_color": "#dfdfdf",
-    "background_color": "#dfdfdf",
+    "theme_color": "#18bcf2",
+    "background_color": "#18bcf2",
     "start_url": "https://esphome.io/",
     "display": "standalone"
 }

_static/version

@@ -1 +1 @@
-2024.2.0
+2024.5.5

_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">
@@ -15,32 +16,35 @@
   <link rel="icon" type="image/png" sizes="32x32" href="/_static/favicon-32x32.png">
   <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="mask-icon" href="/_static/safari-pinned-tab.svg" color="#18bcf2">
+  <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">
+  <meta name="msapplication-TileColor" content="#18bcf2">
   <meta name="msapplication-config" content="/_static/browserconfig.xml">
-  <meta name="theme-color" content="#dfdfdf">
+  <meta name="theme-color" content="#18bcf2">
   <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 %}
   <div id="upgrade-footer">
-    A new version has been release since you last visited this page: {{ release }} 🎉
+    A new version has been released since you last visited this page: {{ release }} 🎉
     <div class="footer-button-container">
       <div role="button" id="upgrade-footer-dismiss" class="footer-button">Dismiss</div>
       <a id="upgrade-footer-changelog" class="footer-button" href="/changelog/{{ version }}.0.html">View Changelog</a>

_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.2.0.rst

@@ -18,6 +18,62 @@ ESPHome 2024.2.0 - 21st February 2024
     Honeywell HIH I2C, components/sensor/honeywell_hih_i2c, honeywellhih.jpg
     Combination, components/sensor/combination, function.svg, dark-invert
 
+micro Wake Word
+---------------
+
+ESPHome implements an on-device wake word detection framework from `microWakeWord <https://github.com/kahrendt/microWakeWord>`__.
+See the :doc:`component documentation </components/micro_wake_word>` for details on how to use it.
+
+Check out the live stream replay below for more details about how it works and came to be.
+
+.. raw:: html
+
+    <iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/NQIv3nsu7dE"
+            title="YouTube video player" frameborder="0"
+            allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
+            allowfullscreen>
+    </iframe>
+
+
+BME280 changes
+--------------
+
+:ghuser:`apbodrov` has added support for the BME280 sensor over SPI. This change is a breaking change for any existing configurations using
+the BME280 over I2C as the platform name has been changed from ``bme280`` to ``bme280_i2c``. There are no other configuration changes required
+to continue using the BME280 over I2C. See the :doc:`component documentation </components/sensor/bme280>` for the latest configuration variables.
+
+
+CSE7766 changes
+---------------
+
+:ghuser:`ssieb` has changed the CSE7766 sensor from appearing to be a polling component.
+It has a high update rate, so if you don't want to send a lot of data to HA, you can
+add the :ref:`throttle_average <sensor-filters>` filter
+with the time period you were using for the update interval (the default is 60s) to each
+sensor.  The example in the sensor doc page has been updated to show this.
+
+
+Release 2024.2.1 - February 26
+------------------------------
+
+- Add missing timeout to "async_request" :esphomepr:`6267` by :ghuser:`jesserockz`
+- Bump zeroconf timeout to 3000 :esphomepr:`6270` by :ghuser:`jesserockz`
+- web_server: Add a position property for cover entities that have the supports position trait :esphomepr:`6269` by :ghuser:`DanielBaulig`
+- allow multiple emc2101 :esphomepr:`6272` by :ghuser:`ssieb`
+- Fix RP2040 SPI pin validation :esphomepr:`6277` by :ghuser:`kbx81`
+- dashboard: move storage json update to a background task in edit save :esphomepr:`6280` by :ghuser:`bdraco`
+- make output optional for speed fan :esphomepr:`6274` by :ghuser:`ssieb`
+- fix throttle average nan handling :esphomepr:`6275` by :ghuser:`ssieb`
+- Fix thermostat supplemental actions :esphomepr:`6282` by :ghuser:`kbx81`
+
+Release 2024.2.2 - March 6
+--------------------------
+
+- CSE7766: Fix energy calculation :esphomepr:`6286` by :ghuser:`puuu`
+- handling with the negative temperature in the sensor tmp102 :esphomepr:`6316` by :ghuser:`FlyingFeng2021`
+- fix tmp102 negative calculation :esphomepr:`6320` by :ghuser:`ssieb`
+- auto load output for now :esphomepr:`6309` by :ghuser:`ssieb`
+- Add wake word phrase to voice assistant start command :esphomepr:`6290` by :ghuser:`jesserockz`
 
 Full list of changes
 --------------------

changelog/2024.3.0.rst

@@ -0,0 +1,311 @@
+ESPHome 2024.3.0 - 20th March 2024
+==================================
+
+.. seo::
+    :description: Changelog for ESPHome 2024.3.0.
+    :image: /_static/changelog-2024.3.0.png
+    :author: Jesse Hills
+    :author_twitter: @jesserockz
+
+.. imgtable::
+    :columns: 5
+
+    Datetime Core, components/datetime/index, clock-outline.svg, dark-invert
+    Template Datetime, components/datetime/template, description.svg, dark-invert
+
+    AM2315C, components/sensor/am2315c, am2315c.jpg
+    HTU31D, components/sensor/htu31d, htu31d.jpg,
+    MS8607, components/sensor/ms8607, ms8607.jpg
+
+    AGS10, components/sensor/ags10, ags10.jpg
+    VEML6030, components/sensor/veml7700, veml6030.jpg
+    VEML7700, components/sensor/veml7700, veml7700.jpg
+
+    MR24HPC1 mmWave, components/seeed_mr24hpc1, seeed-mr24hpc1.jpg
+
+    ADS1118, components/sensor/ads1118, ads1118.jpg
+
+    CST816, components/touchscreen/cst816, cst816.jpg
+    CST226, components/touchscreen/cst226, t4-s3.jpg
+
+    RPI_DPI_RGB, components/display/rpi_dpi_rgb, waveshare_touch-s3.jpg
+    Quad SPI AMOLED, components/display/qspi_amoled, t4-s3.jpg
+    ST7701S, components/display/st7701s, indicator.jpg
+
+    ADE7880, components/sensor/ade7880, ade7880.svg
+    Emmeti, components/climate/climate_ir, air-conditioner-ir.svg, dark-invert
+    Uponor Smatrix, components/uponor_smatrix, uponor.svg
+    Kamstrup KMP, components/sensor/kamstrup_kmp, kamstrup_kmp.jpg
+    Template Fan, components/fan/template, description.svg, dark-invert
+
+
+Dates
+-----
+
+ESPHome now has support for ``date`` entities that can be set from the frontend (like Home Assistant) for you to check against and execute
+automations in the future.
+
+ESPHome Dates require Home Assistant 2024.4 or later.
+
+
+IPv6
+----
+
+ESPHome is now prepared for the future! The future that is the old IPv6 that is.
+Dualstack is added and it could now have up to 5 ip addresses of any type, and communication with Home assistant,
+MQTT and NTP works with IPv6. ESPHome still depends on IPv4, but the crystal ball shows sign of IPv6-only networks.
+
+If you are building an :doc:`/components/external_components` or you use
+``network::get_ip_address()``, ``wifi::global_wifi_component->get_ip_address()`` or ``ethernet::global_eth_component->get_ip_address()``,
+these functions have been renamed to ``::get_ip_addresses()`` respectively and now return a list of all IP addresses.
+
+
+Release 2024.3.1 - March 27
+---------------------------
+
+- AHT10: Fix bug :esphomepr:`6409` by :ghuser:`clydebarrow`
+- microWakeWord: Fix model path joining :esphomepr:`6426` by :ghuser:`ebw44`
+- Don't compile strptime unless its required :esphomepr:`6424` by :ghuser:`gabest11`
+- Fix editor live validation :esphomepr:`6431` by :ghuser:`bdraco`
+
+Release 2024.3.2 - April 4
+--------------------------
+
+- Fix logger compile error on ESP32-C6 :esphomepr:`6323` by :ghuser:`DAVe3283`
+- Add missing ethernet types :esphomepr:`6444` by :ghuser:`ssieb`
+- fix: changing the content source when playing is paused blocks the player :esphomepr:`6454` by :ghuser:`NewoPL`
+
+Thank you for your support
+--------------------------
+
+We would like to thank all Home Assistant Cloud subscribers for their support. It allows `Nabu Casa <https://nabucasa.com/>`__ to
+employ two developers to maintain and further develop the ESPHome project.
+
+Full list of changes
+--------------------
+
+New Components
+^^^^^^^^^^^^^^
+
+- New component: ADE7880 voltage/current/power/energy sensor :esphomepr:`5242` by :ghuser:`kpfleming` (new-integration)
+- Add Uponor Smatrix component :esphomepr:`5769` by :ghuser:`kroimon` (new-integration)
+- Support for MS8607 PHT (Pressure Humidity Temperature) sensor :esphomepr:`3307` by :ghuser:`e28eta` (new-integration)
+- Add datetime date entities :esphomepr:`6191` by :ghuser:`RFDarter` (new-integration)
+- Add AGS10 Sensor :esphomepr:`6070` by :ghuser:`mak-42` (new-integration)
+- ads1118 component :esphomepr:`5711` by :ghuser:`solomondg1` (new-integration)
+- Add CST816 touchscreen driver :esphomepr:`5941` by :ghuser:`clydebarrow` (new-integration)
+- AM2315C Temperature + Humidity Sensor :esphomepr:`6266` by :ghuser:`swoboda1337` (new-integration)
+- Touchscreen: add support for CST226 controller chip :esphomepr:`6151` by :ghuser:`clydebarrow` (new-integration)
+- Drivers for RGB 16 bit parallel displays :esphomepr:`5872` by :ghuser:`clydebarrow` (new-integration)
+- VEML7700 and VEML6030 light sensors :esphomepr:`6067` by :ghuser:`latonita` (new-integration)
+- Add Seeed Studio mmWave Kit MR24HPC1 :esphomepr:`5761` by :ghuser:`limengdu` (new-integration)
+- Add driver for quad SPI AMOLED displays :esphomepr:`6354` by :ghuser:`clydebarrow` (new-integration)
+- feat: Add HTU31D Support :esphomepr:`5805` by :ghuser:`betterengineering` (new-integration)
+- Emmeti infrared climate support :esphomepr:`5197` by :ghuser:`E440QF` (new-integration)
+- Added Kamstrup Multical 40x component :esphomepr:`4200` by :ghuser:`cfeenstra1024` (new-integration)
+
+New Platforms
+^^^^^^^^^^^^^
+
+- Additional sensors and binary sensors support for Haier Climate :esphomepr:`6257` by :ghuser:`paveldn` (breaking-change) (new-platform)
+- add template fan :esphomepr:`6310` by :ghuser:`ssieb` (breaking-change) (new-platform)
+
+Breaking Changes
+^^^^^^^^^^^^^^^^
+
+- LTR390 - Multiple bugfixes :esphomepr:`6161` by :ghuser:`sjtrny` (breaking-change)
+- Touchscreen component and driver fixes :esphomepr:`5997` by :ghuser:`nielsnl68` (breaking-change)
+- Additional sensors and binary sensors support for Haier Climate :esphomepr:`6257` by :ghuser:`paveldn` (breaking-change) (new-platform)
+- add template fan :esphomepr:`6310` by :ghuser:`ssieb` (breaking-change) (new-platform)
+
+Beta Changes
+^^^^^^^^^^^^
+
+- SPI: Revert clk_pin to standard output pin schema :esphomepr:`6368` by :ghuser:`clydebarrow`
+- Allow actions in web_server to be executed via GET method :esphomepr:`5938` by :ghuser:`afarago`
+- fix servo restore :esphomepr:`6370` by :ghuser:`ssieb`
+- Don't try to get IPv6 addresses when disabled :esphomepr:`6366` by :ghuser:`HeMan`
+- Use AQI device class :esphomepr:`6376` by :ghuser:`fgsch`
+- Fix list-components when PR is not targeting dev :esphomepr:`6375` by :ghuser:`jesserockz`
+- allow negative ppm for sensair :esphomepr:`6385` by :ghuser:`ssieb`
+- microWakeWord - add new ops and small improvements :esphomepr:`6360` by :ghuser:`kahrendt`
+- Fix compilation for uponor_smatrix without time component :esphomepr:`6389` by :ghuser:`kroimon`
+- Shows component operation time in ``ms`` :esphomepr:`6388` by :ghuser:`edwardtfn`
+- IPv6 can't be enabled for libretiny :esphomepr:`6387` by :ghuser:`HeMan`
+- Replace name and friendly name in full adopted configs :esphomepr:`4456` by :ghuser:`jesserockz`
+- Fix bug in ``remote_base`` conditional :esphomepr:`6281` by :ghuser:`swoboda1337`
+- Fix sending packets to uponor_smatrix devices :esphomepr:`6392` by :ghuser:`kroimon`
+- Fix wrong initialization of vectors in ade7953_i2c :esphomepr:`6393` by :ghuser:`kroimon`
+- ld2420: Firmware v1.5.4+ bug workaround :esphomepr:`6168` by :ghuser:`descipher`
+- Require xsrf/csrf when using a password :esphomepr:`6396` by :ghuser:`jesserockz`
+- AHT10: Use state machine to avoid blocking delay :esphomepr:`6401` by :ghuser:`clydebarrow`
+- Show component warnings and errors in the log; :esphomepr:`6400` by :ghuser:`clydebarrow`
+- web_server support for v3 :esphomepr:`6203` by :ghuser:`RFDarter`
+
+All changes
+^^^^^^^^^^^
+
+- Bump openssh-client to 1:9.2p1-2+deb12u2 :esphomepr:`6216` by :ghuser:`jesserockz`
+- Add support for 1.8V-powered devices :esphomepr:`6234` by :ghuser:`bisbastuner`
+- Adjust HeatpumpIR dependency :esphomepr:`6222` by :ghuser:`ivankravets`
+- INA226 - fixed improper work with signed values, added configurable ADC parameters :esphomepr:`6172` by :ghuser:`latonita`
+- Prevent network config on rpipico board :esphomepr:`5832` by :ghuser:`carlosV2`
+- Bump pytest-asyncio from 0.23.3 to 0.23.5 :esphomepr:`6201` by :ghuser:`dependabot[bot]`
+- New component: ADE7880 voltage/current/power/energy sensor :esphomepr:`5242` by :ghuser:`kpfleming` (new-integration)
+- Add some components to the new testing framework (D) :esphomepr:`6175` by :ghuser:`kbx81`
+- Provide example devcontainer config for mdns and USB passthrough :esphomepr:`6094` by :ghuser:`linkedupbits`
+- Bump black from 23.12.1 to 24.2.0 :esphomepr:`6221` by :ghuser:`dependabot[bot]`
+- Bump pytest from 7.4.4 to 8.0.1 :esphomepr:`6246` by :ghuser:`dependabot[bot]`
+- Bump codecov/codecov-action from 3 to 4 :esphomepr:`6160` by :ghuser:`dependabot[bot]`
+- Bump peter-evans/create-pull-request from 5.0.2 to 6.0.0 :esphomepr:`6159` by :ghuser:`dependabot[bot]`
+- Bump frenck/action-yamllint from 1.4.2 to 1.5.0 :esphomepr:`6236` by :ghuser:`dependabot[bot]`
+- Bump voluptuous from 0.14.1 to 0.14.2 :esphomepr:`6181` by :ghuser:`dependabot[bot]`
+- Bump pyupgrade from 3.15.0 to 3.15.1 :esphomepr:`6247` by :ghuser:`dependabot[bot]`
+- LTR390 - Multiple bugfixes :esphomepr:`6161` by :ghuser:`sjtrny` (breaking-change)
+- Fix yamllint :esphomepr:`6253` by :ghuser:`jesserockz`
+- Improve the error message on OTA version mismatch :esphomepr:`6259` by :ghuser:`sybrenstuvel`
+- Bump aioesphomeapi from 21.0.2 to 22.0.0 :esphomepr:`6263` by :ghuser:`dependabot[bot]`
+- Allow ESP8266 to use multiple i2c busses :esphomepr:`6145` by :ghuser:`LouDou`
+- Add Uponor Smatrix component :esphomepr:`5769` by :ghuser:`kroimon` (new-integration)
+- Fix test_build_components for macOS sed :esphomepr:`6278` by :ghuser:`kbx81`
+- Allow to specify global build directory :esphomepr:`6276` by :ghuser:`werwolfby`
+- Add device class support to text sensor :esphomepr:`6202` by :ghuser:`dougiteixeira`
+- Bump pytest from 8.0.1 to 8.0.2 :esphomepr:`6288` by :ghuser:`dependabot[bot]`
+- Improve dualstack and IPv6 support :esphomepr:`5449` by :ghuser:`HeMan`
+- Waveshare e-ink 2IN9_V2 - fix full and partial update based on vendor… :esphomepr:`5481` by :ghuser:`darianndd`
+- Add RTTTL volume control. :esphomepr:`5968` by :ghuser:`nielsnl68`
+- Touchscreen component and driver fixes :esphomepr:`5997` by :ghuser:`nielsnl68` (breaking-change)
+- Add `on_update` trigger for Project versions :esphomepr:`6298` by :ghuser:`jesserockz`
+- Bump peter-evans/create-pull-request from 6.0.0 to 6.0.1 :esphomepr:`6302` by :ghuser:`dependabot[bot]`
+- CSE7766 Apparent Power & Power Factor calculations :esphomepr:`6292` by :ghuser:`DAVe3283`
+- Adding W5500 support to ethernet component :esphomepr:`4424` by :ghuser:`JeroenVanOort`
+- Fix numbering of ip_address sensors :esphomepr:`6305` by :ghuser:`HeMan`
+- Bump aioesphomeapi from 22.0.0 to 23.0.0 :esphomepr:`6293` by :ghuser:`dependabot[bot]`
+- Add regular polygon shapes to display component :esphomepr:`6108` by :ghuser:`mathieu-mp`
+- Fix return value in `core/automation.h` :esphomepr:`6314` by :ghuser:`FlyingFeng2021`
+- aht10: Added new CMD and renamed existing CMD to match datasheet :esphomepr:`6303` by :ghuser:`cptskippy`
+- handling with the negative temperature in the sensor tmp102 :esphomepr:`6316` by :ghuser:`FlyingFeng2021`
+- x9c: fix off by 1 error :esphomepr:`6318` by :ghuser:`andynumber2`
+- Support for MS8607 PHT (Pressure Humidity Temperature) sensor :esphomepr:`3307` by :ghuser:`e28eta` (new-integration)
+- Separate logger implementations for each hardware platform into different files :esphomepr:`6167` by :ghuser:`tomaszduda23`
+- Additional sensors and binary sensors support for Haier Climate :esphomepr:`6257` by :ghuser:`paveldn` (breaking-change) (new-platform)
+- Add toggle command to cover web_server endpoint :esphomepr:`6319` by :ghuser:`heythisisnate`
+- Improv: support connecting to hidden networks :esphomepr:`6322` by :ghuser:`jesserockz`
+- Update mDNS for IDF >= 5.0 :esphomepr:`6328` by :ghuser:`HeMan`
+- DFPlayer: refix Bug created with PR 4758 :esphomepr:`5861` by :ghuser:`sandronidi`
+- Fix build failures on host platform caused by #6167 :esphomepr:`6338` by :ghuser:`clydebarrow`
+- Update bang_bang to log two decimal places in config dump :esphomepr:`6304` by :ghuser:`rafalw1277`
+- Add datetime date entities :esphomepr:`6191` by :ghuser:`RFDarter` (new-integration)
+- Add AGS10 Sensor :esphomepr:`6070` by :ghuser:`mak-42` (new-integration)
+- Bump aioesphomeapi from 23.0.0 to 23.1.0 :esphomepr:`6332` by :ghuser:`dependabot[bot]`
+- Bump pytest-asyncio from 0.23.5 to 0.23.5.post1 :esphomepr:`6334` by :ghuser:`dependabot[bot]`
+- Bump docker/setup-buildx-action from 3.0.0 to 3.1.0 :esphomepr:`6295` by :ghuser:`dependabot[bot]`
+- Set dependabot to look at composite actions versions :esphomepr:`6343` by :ghuser:`jesserockz`
+- ads1118 component :esphomepr:`5711` by :ghuser:`solomondg1` (new-integration)
+- Bump actions/cache from 4.0.0 to 4.0.1 :esphomepr:`6306` by :ghuser:`dependabot[bot]`
+- Bump docker/build-push-action from 5.0.0 to 5.2.0 in /.github/actions/build-image :esphomepr:`6347` by :ghuser:`dependabot[bot]`
+- fix: modbus_textsensor response is too long in some cases :esphomepr:`6333` by :ghuser:`NewoPL`
+- add template fan :esphomepr:`6310` by :ghuser:`ssieb` (breaking-change) (new-platform)
+- dump config after logging CDC port is opened by host :esphomepr:`6169` by :ghuser:`tomaszduda23`
+- Add IRK support to allow tracking of devices with random MAC addresses :esphomepr:`6335` by :ghuser:`chbmuc`
+- [Fingerprint_grow] Implements Sleep Mode feature :esphomepr:`6116` by :ghuser:`alexborro`
+- cleanup ili9xxx component by removing data rate define :esphomepr:`6350` by :ghuser:`nielsnl68`
+- web_server_idf: support x-www-form-urlencoded POST requests :esphomepr:`6037` by :ghuser:`dentra`
+- feat(MQTT): Add QoS option for each MQTT component :esphomepr:`6279` by :ghuser:`Rapsssito`
+- Check permissions :esphomepr:`6255` by :ghuser:`OdileVidrine`
+- Add CST816 touchscreen driver :esphomepr:`5941` by :ghuser:`clydebarrow` (new-integration)
+- ILI9XXX: Lazily allocate buffer :esphomepr:`6352` by :ghuser:`clydebarrow`
+- AM2315C Temperature + Humidity Sensor :esphomepr:`6266` by :ghuser:`swoboda1337` (new-integration)
+- Add ble_presence binary sensor timeout config value. :esphomepr:`6024` by :ghuser:`clydebarrow`
+- Add state listeners to `rotary_encoder` :esphomepr:`6035` by :ghuser:`clydebarrow`
+- ili9xxx: Add support for GC9A01A display :esphomepr:`6351` by :ghuser:`clydebarrow`
+- Touchscreen: add support for CST226 controller chip :esphomepr:`6151` by :ghuser:`clydebarrow` (new-integration)
+- font: add anti-aliasing and other features :esphomepr:`6198` by :ghuser:`clydebarrow`
+- Mhz19 warmup :esphomepr:`6214` by :ghuser:`fornellas`
+- Refactor ATM90E32 to reduce blocking time and improve accuracy. :esphomepr:`5670` by :ghuser:`descipher`
+- Bump aioesphomeapi from 23.1.0 to 23.1.1 :esphomepr:`6348` by :ghuser:`dependabot[bot]`
+- Bump pytest from 8.0.2 to 8.1.1 :esphomepr:`6346` by :ghuser:`dependabot[bot]`
+- Add support for Waveshare 2.13" V2 display :esphomepr:`6337` by :ghuser:`manuelkasper`
+- Mitsubishi Climate updates :esphomepr:`3886` by :ghuser:`RubyBailey`
+- Drivers for RGB 16 bit parallel displays :esphomepr:`5872` by :ghuser:`clydebarrow` (new-integration)
+- hydreon_rgxx - add resolution option :esphomepr:`6077` by :ghuser:`mrtoy-me`
+- SPI schema now uses typed_schema with `type` key  :esphomepr:`6353` by :ghuser:`clydebarrow`
+- VEML7700 and VEML6030 light sensors :esphomepr:`6067` by :ghuser:`latonita` (new-integration)
+- Add Seeed Studio mmWave Kit MR24HPC1 :esphomepr:`5761` by :ghuser:`limengdu` (new-integration)
+- Add getter for font glyph data :esphomepr:`6355` by :ghuser:`clydebarrow`
+- Require reset_pin for certain waveshare_epaper models in YAML validation :esphomepr:`6357` by :ghuser:`manuelkasper`
+- touchscreen driver fixes :esphomepr:`6356` by :ghuser:`clydebarrow`
+- Make USE_HOST compilable on msys2 :esphomepr:`6359` by :ghuser:`maruel`
+- download font from url on build :esphomepr:`5254` by :ghuser:`landonr`
+- Add driver for quad SPI AMOLED displays :esphomepr:`6354` by :ghuser:`clydebarrow` (new-integration)
+- ADE7953: Add the ability to use accumulating energy registers, more precise power reporting :esphomepr:`6311` by :ghuser:`isorin`
+- feat: Add HTU31D Support :esphomepr:`5805` by :ghuser:`betterengineering` (new-integration)
+- Emmeti infrared climate support :esphomepr:`5197` by :ghuser:`E440QF` (new-integration)
+- Added Kamstrup Multical 40x component :esphomepr:`4200` by :ghuser:`cfeenstra1024` (new-integration)
+- add possibility to provide different conversion times for Bus Voltage… :esphomepr:`6327` by :ghuser:`kev300`
+- SPI: Revert clk_pin to standard output pin schema :esphomepr:`6368` by :ghuser:`clydebarrow`
+- Allow actions in web_server to be executed via GET method :esphomepr:`5938` by :ghuser:`afarago`
+- fix servo restore :esphomepr:`6370` by :ghuser:`ssieb`
+- Don't try to get IPv6 addresses when disabled :esphomepr:`6366` by :ghuser:`HeMan`
+- Use AQI device class :esphomepr:`6376` by :ghuser:`fgsch`
+- Fix list-components when PR is not targeting dev :esphomepr:`6375` by :ghuser:`jesserockz`
+- allow negative ppm for sensair :esphomepr:`6385` by :ghuser:`ssieb`
+- microWakeWord - add new ops and small improvements :esphomepr:`6360` by :ghuser:`kahrendt`
+- Fix compilation for uponor_smatrix without time component :esphomepr:`6389` by :ghuser:`kroimon`
+- Shows component operation time in ``ms`` :esphomepr:`6388` by :ghuser:`edwardtfn`
+- IPv6 can't be enabled for libretiny :esphomepr:`6387` by :ghuser:`HeMan`
+- Replace name and friendly name in full adopted configs :esphomepr:`4456` by :ghuser:`jesserockz`
+- Fix bug in ``remote_base`` conditional :esphomepr:`6281` by :ghuser:`swoboda1337`
+- Fix sending packets to uponor_smatrix devices :esphomepr:`6392` by :ghuser:`kroimon`
+- Fix wrong initialization of vectors in ade7953_i2c :esphomepr:`6393` by :ghuser:`kroimon`
+- ld2420: Firmware v1.5.4+ bug workaround :esphomepr:`6168` by :ghuser:`descipher`
+- Require xsrf/csrf when using a password :esphomepr:`6396` by :ghuser:`jesserockz`
+- AHT10: Use state machine to avoid blocking delay :esphomepr:`6401` by :ghuser:`clydebarrow`
+- Show component warnings and errors in the log; :esphomepr:`6400` by :ghuser:`clydebarrow`
+- web_server support for v3 :esphomepr:`6203` by :ghuser:`RFDarter`
+
+Past Changelogs
+---------------
+
+- :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/2024.4.0.rst

@@ -0,0 +1,231 @@
+ESPHome 2024.4.0 - 17th April 2024
+==================================
+
+.. seo::
+    :description: Changelog for ESPHome 2024.4.0.
+    :image: /_static/changelog-2024.4.0.png
+    :author: Jesse Hills
+    :author_twitter: @jesserockz
+
+.. imgtable::
+    :columns: 4
+
+    Template Datetime Time, components/datetime/template, description.svg, dark-invert
+    SUN-GTIL2 inverter, components/sun_gtil2, sun_1000g2.png
+    AT581X, components/at581x, at581x.png
+    JSN-SR04T, components/sensor/jsn_sr04t, jsn-sr04t-v3.jpg
+
+    Daikin ARC, components/climate/climate_ir, air-conditioner-ir.svg, dark-invert
+    HHCCJCY10 (MiFlora Pink), components/sensor/xiaomi_hhccjcy10, xiaomi_hhccjcy10.jpg
+    TLC5971, components/output/tlc5971, tlc5971.jpg
+    Dooya, components/remote_transmitter, remote.svg
+
+
+Time Entities
+-------------
+
+ESPHome now has support for ``time`` entities that can be set from the frontend (like Home Assistant). THis allows you to set a timer to execute future automations on device.
+
+ESPHome Dates require Home Assistant 2024.4 or later.
+
+
+Voice Assistant Audio
+---------------------
+
+This release adds support for sending and receiving audio to/from voice assistants via the API. Currently ESPHome sends and receives the Voice Assistant audio bytes
+via a UDP socket which can be unreliable and insecure. Beginning with Home Assistant 2024.5, both sides will automatically recognise that they both support API Audio and will
+use that route instead. This is more reliable because the ESPHome API uses a TCP socket, so packet order and delivery is guaranteed, and if you use API Encryption,
+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
+--------------------
+
+New Components
+^^^^^^^^^^^^^^
+
+- Add sun_gtil2 component (for SUN-1000G2 / SUN-2000G2 grid tie inverters) :esphomepr:`4958` by :ghuser:`Mat931` (new-integration)
+- Add support for AT581x component :esphomepr:`6297` by :ghuser:`X-Ryl669` (new-integration)
+- Add new Component: Ultrasonic Distance Sensor JSN-SR04T :esphomepr:`6023` by :ghuser:`Mafus1` (new-integration)
+- feat: Add Daikin ARC (tested on Daikin ARC472A62) :esphomepr:`6429` by :ghuser:`magicbear` (new-integration)
+- add support for Tuya pink version of miflora :esphomepr:`5402` by :ghuser:`fariouche` (new-integration)
+- Implemented support for the TLC5971 as an output component :esphomepr:`6494` by :ghuser:`IJIJI` (new-integration)
+
+Breaking Changes
+^^^^^^^^^^^^^^^^
+
+- Add support for new modes in Tuya Climate :esphomepr:`5159` by :ghuser:`moriahmorgan` (breaking-change)
+- IPv6 string representation follows RFC5952 :esphomepr:`6449` by :ghuser:`HeMan` (breaking-change)
+
+Beta 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`
+
+All changes
+^^^^^^^^^^^
+
+- Bump docker/login-action from 3.0.0 to 3.1.0 :esphomepr:`6367` by :ghuser:`dependabot[bot]`
+- Bump peter-evans/create-pull-request from 6.0.1 to 6.0.2 :esphomepr:`6361` by :ghuser:`dependabot[bot]`
+- Bump docker/build-push-action from 5.2.0 to 5.3.0 in /.github/actions/build-image :esphomepr:`6373` by :ghuser:`dependabot[bot]`
+- Bump docker/setup-buildx-action from 3.1.0 to 3.2.0 :esphomepr:`6372` by :ghuser:`dependabot[bot]`
+- Fix deep_sleep for ESP32-C6 :esphomepr:`6377` by :ghuser:`ferrets6`
+- Fix keeloq for IDF 5+ :esphomepr:`6382` by :ghuser:`kbx81`
+- Fix Nextion set_component_picture call :esphomepr:`6378` by :ghuser:`edwardtfn`
+- Add line_at_angle method to Display component :esphomepr:`6381` by :ghuser:`deisterhold`
+- Check generated proto files are as expected if any are modified in PRs :esphomepr:`6254` by :ghuser:`jesserockz`
+- ld2420: fix energy mode documentation :esphomepr:`6225` by :ghuser:`andresv`
+- Add actions for component tests A, B and C :esphomepr:`6256` by :ghuser:`kbx81`
+- Add some components to the new testing framework (V) :esphomepr:`6231` by :ghuser:`kbx81`
+- Add some components to the new testing framework (X,Y,Z) :esphomepr:`6233` by :ghuser:`kbx81`
+- Add some components to the new testing framework (E) :esphomepr:`6176` by :ghuser:`kbx81`
+- Make SPI compile with IDF >= 5.0 :esphomepr:`6383` by :ghuser:`HeMan`
+- Fix esp32-camera test yaml :esphomepr:`6398` by :ghuser:`kbx81`
+- Bump pytest-asyncio from 0.23.5.post1 to 0.23.6 :esphomepr:`6402` by :ghuser:`dependabot[bot]`
+- Bump actions/cache from 4.0.1 to 4.0.2 in /.github/actions/restore-python :esphomepr:`6403` by :ghuser:`dependabot[bot]`
+- Bump actions/cache from 4.0.1 to 4.0.2 :esphomepr:`6404` by :ghuser:`dependabot[bot]`
+- Bump ESP8266 Arduino versions :esphomepr:`5359` by :ghuser:`HeMan`
+- Allow accept/reject delta to be specified. :esphomepr:`5060` by :ghuser:`cvwillegen`
+- Allow setting htop for ledc :esphomepr:`6340` by :ghuser:`Gagootron`
+- sm2135: add separate_modes option to support different chip variants :esphomepr:`6152` by :ghuser:`jasperro`
+- AHT10: fix temperature-only operation; add warning/error messages :esphomepr:`6405` by :ghuser:`clydebarrow`
+- Add support for new modes in Tuya Climate :esphomepr:`5159` by :ghuser:`moriahmorgan` (breaking-change)
+- Add sun_gtil2 component (for SUN-1000G2 / SUN-2000G2 grid tie inverters) :esphomepr:`4958` by :ghuser:`Mat931` (new-integration)
+- SPI: Make some validation failures give more useful messages. :esphomepr:`6413` by :ghuser:`clydebarrow`
+- Bump aioesphomeapi from 23.1.1 to 23.2.0 :esphomepr:`6412` by :ghuser:`dependabot[bot]`
+- Add check for use of GPIOXX in config :esphomepr:`6419` by :ghuser:`clydebarrow`
+- WireGuard for esp8266 :esphomepr:`6365` by :ghuser:`droscy`
+- setup.cfg: drop duplicate, underintended trove classifier :esphomepr:`6421` by :ghuser:`mweinelt`
+- Store preferences in disk file on host platform :esphomepr:`6428` by :ghuser:`clydebarrow`
+- Add support for AT581x component :esphomepr:`6297` by :ghuser:`X-Ryl669` (new-integration)
+- Add some components to the new testing framework (F) :esphomepr:`6177` by :ghuser:`kbx81`
+- Add get_contrast() and get_brightness() to SSD1306 class to get protected variables :esphomepr:`6435` by :ghuser:`benediktkr`
+- Add new Component: Ultrasonic Distance Sensor JSN-SR04T :esphomepr:`6023` by :ghuser:`Mafus1` (new-integration)
+- Add some components to the new testing framework (G) :esphomepr:`6178` by :ghuser:`kbx81`
+- Add some components to the new testing framework (K) :esphomepr:`6186` by :ghuser:`kbx81`
+- Add some components to the new testing framework (N) :esphomepr:`6210` by :ghuser:`kbx81`
+- Add some components to the new testing framework (Q) :esphomepr:`6218` by :ghuser:`kbx81`
+- Add some components to the new testing framework (U) :esphomepr:`6230` by :ghuser:`kbx81`
+- Fix spacing in new test yaml :esphomepr:`6441` by :ghuser:`kbx81`
+- Add some components to the new testing framework (W) :esphomepr:`6232` by :ghuser:`kbx81`
+- Add some components to the new testing framework (L) :esphomepr:`6195` by :ghuser:`kbx81`
+- feat: Add Daikin ARC (tested on Daikin ARC472A62) :esphomepr:`6429` by :ghuser:`magicbear` (new-integration)
+- Disable truthy yamllint rule :esphomepr:`6442` by :ghuser:`jesserockz`
+- Add get_size method to QR Code header :esphomepr:`6430` by :ghuser:`deisterhold`
+- Minor change to support sht85 sensor :esphomepr:`6415` by :ghuser:`mrtoy-me`
+- IPv6 string representation follows RFC5952 :esphomepr:`6449` by :ghuser:`HeMan` (breaking-change)
+- Bump actions/setup-python from 5.0.0 to 5.1.0 :esphomepr:`6437` by :ghuser:`dependabot[bot]`
+- Bump actions/setup-python from 5.0.0 to 5.1.0 in /.github/actions/restore-python :esphomepr:`6438` by :ghuser:`dependabot[bot]`
+- Optimize QMC5883L: Read registers only for enabled sensors :esphomepr:`6458` by :ghuser:`tronikos`
+- minor refactor to allow commit hash as ref value. :esphomepr:`6446` by :ghuser:`LelandSindt`
+- TMP117 fix polling period config :esphomepr:`6452` by :ghuser:`mrtoy-me`
+- Bump Arduino Pico Framework to 3.7.2 and Platform to 1.12.0 :esphomepr:`6386` by :ghuser:`HeMan`
+- Display menu: Allow "left" key to exit current menu if not editing :esphomepr:`6460` by :ghuser:`jesserockz`
+- Fix NOLINT on inclusive-language check :esphomepr:`6464` by :ghuser:`jesserockz`
+- Add yamllint to dev requirements :esphomepr:`6466` by :ghuser:`jesserockz`
+- Add temperature for QMC5883L :esphomepr:`6456` by :ghuser:`tronikos`
+- web_server: Return early if no clients connected :esphomepr:`6467` by :ghuser:`jesserockz`
+- ESP32 Arduino WiFi: misc bug fixes :esphomepr:`6470` by :ghuser:`paravoid`
+- Replace std::regex with sscanf calls :esphomepr:`6468` by :ghuser:`jesserockz`
+- Include "Failed" status in config log. :esphomepr:`6482` by :ghuser:`clydebarrow`
+- Fix Microphone IsCapturingCondition :esphomepr:`6490` by :ghuser:`RaymiiOrg`
+- Remove misleading tag/line in messages :esphomepr:`6495` by :ghuser:`clydebarrow`
+- Send/Receive Voice Assistant audio via API :esphomepr:`6471` by :ghuser:`jesserockz`
+- Datetime date initial value fix :esphomepr:`6483` by :ghuser:`RFDarter`
+- If the loop() took more than the required time, don't delay further :esphomepr:`6496` by :ghuser:`clydebarrow`
+- Bump LibreTiny version to 1.5.1 :esphomepr:`6500` by :ghuser:`kuba2k2`
+- Internal temperature: Support Beken platform :esphomepr:`6491` by :ghuser:`Mat931`
+- Bump docker/setup-buildx-action from 3.2.0 to 3.3.0 :esphomepr:`6502` by :ghuser:`dependabot[bot]`
+- add support for Tuya pink version of miflora :esphomepr:`5402` by :ghuser:`fariouche` (new-integration)
+- Add MAC address to WiFi config reply :esphomepr:`6489` by :ghuser:`cvwillegen`
+- Adds i2c timeout config :esphomepr:`4614` by :ghuser:`tracestep`
+- Add ABB-Welcome / Busch-Welcome Door Intercom Protocol :esphomepr:`4689` by :ghuser:`Mat931`
+- Add support for time entities :esphomepr:`6399` by :ghuser:`jesserockz`
+- Fix Match by IRK :esphomepr:`6499` by :ghuser:`MRemy2`
+- Add rmt_channel to remote_transmitter and remote_receiver :esphomepr:`6497` by :ghuser:`jesserockz` (new-integration)
+- Rework tlc5947 to remove AUTO_LOAD :esphomepr:`6503` by :ghuser:`jesserockz`
+- UART: ignore require_tx/rx if not a native uart implementation :esphomepr:`6504` by :ghuser:`jesserockz`
+- esp32_rmt_led_strip bugfixes :esphomepr:`6506` by :ghuser:`Mat931`
+- Implemented support for the TLC5971 as an output component :esphomepr:`6494` by :ghuser:`IJIJI` (new-integration)
+- Add Dooya protocol to remote_base :esphomepr:`6488` by :ghuser:`bukureckid`
+- Only give error for connected sensors at startup :esphomepr:`6474` by :ghuser:`leejoow`
+- Webserver float to string fix :esphomepr:`6507` by :ghuser:`RFDarter`
+- 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
+---------------
+
+- :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/2024.5.0.rst

@@ -0,0 +1,327 @@
+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`
+
+
+Release 2024.5.5 - June 5
+-------------------------
+
+- [voice_assistant] Half the microphone ringbuffer size :esphomepr:`6830` by :ghuser:`jesserockz`
+- [i2s_speaker] Add buffer allocation failure checks :esphomepr:`6829` by :ghuser:`jesserockz`
+- [improv_serial] Fix for IDF 4.4.7 :esphomepr:`6855` by :ghuser:`kbx81`
+
+
+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.2.0.html
+    :url: /changelog/2024.5.0.html
 
 .. toctree::
     :glob:

changelog/v1.9.0.rst

@@ -30,7 +30,7 @@ awesome things with DIY hardware!
 
 The features I'm particularly excited about are:
 
-* :ref:`esphomeflasher <esphome-flasher>` - Experiencing problems flashing esphomelib firmwares using esphomeyaml?
+* ``esphomeflasher`` - Experiencing problems flashing esphomelib firmwares using esphomeyaml?
   No problem, esphomeflasher is a tool designed to make that super easy. Just let esphomeyaml generate the binary and flash
   from your PC.
 * :doc:`Over-the-Air Updates </components/ota>` have been completely re-written to make them a lot more
@@ -76,7 +76,7 @@ New Features
 
 - esphomelib now has a new tool: `esphomeflasher <https://github.com/esphome/esphome-flasher>`__ to simplify
   flashing on Windows/MacOS machines **without having to install esphomeyaml**. So if esphomeyaml for some reason
-  can't find your USB port, you now can use the esphomeflasher app. See :ref:`esphome-flasher`.
+  can't find your USB port, you now can use the esphomeflasher app. See ``esphomeflasher``.
 
 - ESP8266s now save the states of lights/switches/... internally and restores them on boot.
   Additionally, esphomelib can now operate in fully offline mode if your WiFi network goes down

components/alarm_control_panel/template.rst

@@ -27,8 +27,8 @@ Configuration variables:
 - **codes** (*Optional*, list of string): A list of codes for disarming the alarm, if *requires_code_to_arm* set to true then for arming the alarm too.
 - **requires_code_to_arm** (*Optional*, boolean): Code required for arming the alarm, *codes* must be provided.
 - **arming_away_time** (*Optional*, :ref:`config-time`): The exit delay before the alarm is armed to away mode. Defaults to ``0s``.
-- **arming_home_time** (*Optional*, :ref:`config-time`): The exit delay before the alarm is armed to home mode.  
-- **arming_night_time** (*Optional*, :ref:`config-time`): The exit delay before the alarm is armed to night mode.  
+- **arming_home_time** (*Optional*, :ref:`config-time`): The exit delay before the alarm is armed to home mode.
+- **arming_night_time** (*Optional*, :ref:`config-time`): The exit delay before the alarm is armed to night mode.
 - **pending_time** (*Optional*, :ref:`config-time`): The entry delay before the alarm is triggered. Defaults to ``0s``.
 - **trigger_time** (*Optional*, :ref:`config-time`): The time after a triggered alarm before resetting to previous state if the sensors are cleared/off. Defaults to ``0s``.
 - **binary_sensors** (*Optional*, *list*): A list of binary sensors the panel should use. Each consists of:
@@ -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

@@ -0,0 +1,183 @@
+AirTouch AT581x Radar
+=====================
+
+.. seo::
+    :description: Instructions for setting up AirTouch AT581x Radar
+    :image: at581x.png
+    :keywords: radar
+
+The `AirTouch AT581x radar <https://en.airtouching.com/product/32.html>`__
+(aka ``AT581x``) is a familly of 5.8GHz radar which can be used for human presence detection. It can detect tiny movements
+and compared to a PIR sensor **it can detect presence continuously**. This can be useful, for example, to turn
+the lights on when you enter a room, keep them on as long as you are there (without waving your hands at the
+sensor) and turn them off almost immediately after you leave the room.
+
+They are ultra-low power (as low as 40µA of current consumption) and are extremely simple to use, yet can be setup by I2C.
+It's installed in many low cost appliance, like the ESP32S3-BOX-3, and can be found by many different manufacturer or reference,
+like the MoreSense MS58-3909S68U4.
+
+It is possible to use this sensor with only a single GPIO pin; however, if you wish to change its settings,
+a :doc:`/components/i2c` component (and its requisite GPIO pins) is required in your device's configuration.
+
+.. figure:: ../images/at581x.png
+    :align: center
+    :width: 75%
+
+    AirTouch AT581x Radar / presence detection sensor
+
+.. code-block:: yaml
+
+    # Example configuration entry
+    at581x:
+      id: "Radar"
+      i2c_id: bus_a
+
+.. _at581x-component:
+
+Component/Hub
+-------------
+
+You need to have the hub component (``at581x:`` entry) defined to be able to change the sensor's
+settings, get it listed as an motion entity or being able to turn on/off the radio frequency emmission.
+A :doc:`/components/binary_sensor/gpio` alone could be sufficient if you only want
+to determine presence/occupancy. When you define ``at581x:`` you'll need to have a ``i2c:`` entry in
+your configuration with both the SDA and SCL pins defined.
+
+Multiple instances of this component may be defined if multiple :doc:`/components/i2c` components are available:
+
+.. code-block:: yaml
+
+    at581x:
+      - id: mmWave_1
+        i2c_id: bus_a
+        address: 0x28
+      - id: mmWave_2
+        i2c_id: bus_a
+        address: 0x29
+      ...
+
+Configuration variables:
+************************
+
+- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. Necessary if you want
+  to define multiple instances of this component.
+- **i2c_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :doc:`/components/i2c` if you want
+  to use multiple I2C buses.
+
+.. _at581x-binary_sensor:
+
+Binary Sensor
+-------------
+
+The state of the radar detection is available via its GPIO pin. It's required to use a GPIO binary sensor to monitor the motion status
+
+.. code-block:: yaml
+
+    binary_sensor:
+      - platform: gpio
+        name: "Human in front"
+        pin: GPIOXX
+
+Configuration variables:
+************************
+
+- Refer to other options from :ref:`Binary Sensor <config-binary_sensor>` and :doc:`GPIO Binary Sensor </components/binary_sensor/gpio>`.
+
+.. _at581x-switch:
+
+Switch
+------
+
+:ref:`Switch components <config-switch>` are used to enable/disable radio frequency hardware.
+
+.. code-block:: yaml
+
+    switch:
+      - platform: at581x
+        at581x_id: Radar
+        name: "Enable Radar"
+
+Configuration variables:
+************************
+
+- **at581x_id** (*Optional*, :ref:`config-id`): The ID of the AT581x component defined above.
+  Required when multiple instances of the ``at581x`` component are defined.
+- All other options from :ref:`Switch <config-switch>`.
+
+.. _at581x-actions:
+
+Actions
+-------
+
+.. _at581x-action_settings:
+
+``at581x.settings`` Action
+**************************
+
+.. warning::
+
+    The hardware frontend reset option is only required to reset the frontend in case it is struck, before sending the
+    new configuration. However, a frontend reset is always performed after changing the settings.
+
+The radar has several settings which can be changed. These settings are not saved in non-volatile memory
+and need to be set on each boot.
+
+The settings action allows changing of any number of the radar's internal parameters/settings. With this
+action, any unspecified parameters will remain unchanged.
+
+.. code-block:: yaml
+
+    on_...:
+      - at581x.settings:
+          id: "Waveradar"
+          hw_frontend_reset: false
+          frequency: 5800MHz
+          sensing_distance: 200 # 0-1023
+          poweron_selfcheck_time: 2000ms
+          protect_time: 1s
+          trigger_base: 500ms
+          trigger_keep: 10s
+          stage_gain: 3 # 0-12 the higher the value the smaller the gain
+          power_consumption: 70µA
+
+
+Configuration variables:
+````````````````````````
+
+- **id** (*Optional*, :ref:`config-id`): Manually specify the ID of the sensor on which settings should be
+  changed. If only one radar is defined, this is optional.
+- **hw_frontend_reset** (*Optional*, boolean): If set to true, a reset of the analog frontend will be performed before
+  changing other options. Ignored if not set or set to ``false``. Upon applying the settings a frontend reset
+  will be performed anyway, this is only useful if the sensor is not answering or locked up.
+- **frequency** (*Optional*, int): Any of the possible frequencies (5696, 5715, 5730, 5748, 5765, 5784, 5800, 5819, 5836, 5851, 5869, 5888) in MHz.
+- **sensing_distance** (*Optional*, int): A unitless number, in range 0-1023, specifying the maximum distance to detect motion
+- **poweron_selfcheck_time** (*Optional*, int): The delay to perform self check and calibration on power on. Recommanded not to change this
+- **protect_time** (*Optional*, int): The delay after an end-of-trigger event where the detection will not trigger anymore. Max 65535ms
+- **trigger_base** (*Optional*, int): The delay while a detection must be active to change the state of the sensor. Max 65535ms
+- **trigger_keep** (*Optional*, int): The delay that the output will stay high after a detection event. This is usually what you want to change.
+- **stage_gain** (*Optional*, int): The analog gain to use for threshold test. Any value in range 0-12, with 12 being the lowest gain and 0 the highest
+- **power_consumption** (*Optional*, int): Any of the possible power profile (48, 56, 63, 70, 77, 91, 105, 115, 40, 44, 47, 51, 54, 61, 68, 78) in µA
+
+
+``at581x.reset`` Action
+***********************
+
+Restart the sensor.
+
+.. code-block:: yaml
+
+    on_...:
+      at581x.reset:
+
+Configuration variables:
+````````````````````````
+
+- **id** (*Optional*, :ref:`config-id`): Manually specify the ID of the AT581x component. Useful when multiple instances of this component are defined.
+
+See Also
+--------
+- :ref:`I2C bus <i2c>`
+- :ref:`Binary Sensor <config-binary_sensor>`
+- :doc:`GPIO Binary Sensor </components/binary_sensor/gpio>`
+- :ref:`config-id`
+- :ghedit:`Edit`

components/binary_sensor/ble_presence.rst

@@ -30,10 +30,15 @@ The ``ble_presence`` binary sensor platform lets you track the presence of a Blu
         mac_address: AC:37:43:77:5F:4C
         name: "ESP32 BLE Tracker Google Home Mini"
         min_rssi: -80dB
+      # Presence based on Identity Resolving Key (IRK)
+      - platform: ble_presence
+        irk: 1234567890abcdef1234567890abcdef
+        name: "ESP32 BLE Tracker iPhone"
       # Presence based on BLE Service UUID
       - platform: ble_presence
         service_uuid: '11aa'
         name: "ESP32 BLE Tracker Test Service 16 bit"
+        timeout: 45s
       # Presence based on iBeacon UUID
       - platform: ble_presence
         ibeacon_uuid: '68586f1e-89c2-11eb-8dcd-0242ac130003'
@@ -51,14 +56,17 @@ Configuration variables:
 
 -  **name** (**Required**, string): The name of the binary sensor.
 -  **mac_address** (*Optional*, MAC Address): The MAC address to track for this
-   binary sensor. Note that exactly one of ``mac_address``, ``service_uuid`` or ``ibeacon_uuid``
+   binary sensor. Note that exactly one of ``mac_address``, ``irk``, ``service_uuid`` or ``ibeacon_uuid``
+   must be present.
+-  **irk** (*Optional*, 16 byte hex string): The Identity Resolving Key (IRK) to track for this
+   binary sensor. Note that exactly one of ``mac_address``, ``irk``, ``service_uuid`` or ``ibeacon_uuid``
    must be present.
 -  **service_uuid** (*Optional*, string): 16 bit, 32 bit, or 128 bit BLE Service UUID
    which can be tracked if the device randomizes the MAC address. Note that exactly one of
-   ``mac_address``, ``service_uuid`` or ``ibeacon_uuid`` must be present.
+   ``mac_address``, ``irk``, ``service_uuid`` or ``ibeacon_uuid`` must be present.
 -  **ibeacon_uuid** (*Optional*, string): The `universally unique identifier <https://en.wikipedia.org/wiki/Universally_unique_identifier>`__
    to identify the beacon that needs to be tracked. Note that exactly one of ``mac_address``,
-   ``service_uuid`` or ``ibeacon_uuid`` must be present.
+   ``irk``, ``service_uuid`` or ``ibeacon_uuid`` must be present.
 -  **ibeacon_major** (*Optional*, int): The iBeacon major identifier of the beacon that needs
    to be tracked. Usually used to group beacons, for example for grouping all beacons in the
    same building.
@@ -67,6 +75,8 @@ Configuration variables:
 -  **id** (*Optional*, :ref:`config-id`): Manually specify
    the ID used for code generation.
 -  **min_rssi** (*Optional*, int): at which minimum RSSI level would the component report the device be present.
+-  **timeout** (*Optional*, :ref:`config-time`): The delay after last detecting the device before publishing not present state.
+   The default is 5 minutes.
 -  All other options from :ref:`Binary Sensor <config-binary_sensor>`.
 
 .. _esp32_ble_tracker-setting_up_devices:
@@ -105,8 +115,15 @@ iBeacon major and minor identifiers, BLE manufacturer data, RSSI and other data
 debugging purposes. Note that this is useful only during set-up and a less verbose log level
 should be specified afterwards.
 
-Please note that devices that show a ``RANDOM`` address type in the logs cannot be used for
-MAC address based tracking, since their MAC-address periodically changes. Instead you can:
+Please note that devices that show a ``RANDOM`` address type in the logs probably use a privacy
+feature called Resolvable Private Addresses to avoid BLE tracking. Since their MAC-address periodically
+changes, they can't be tracked by the MAC address. However, if you know the devices "Identity Resolving
+Key" (IRK), you can check if the generated private MAC address belongs to the device with the IRK.
+
+There is no support to obtain the key with ESPHome. For now you will have to use one of the options
+described in the ESPresense project: https://espresense.com/beacons
+
+Alternatively you can:
 
 -  Create a BLE beacon, set a unique 16 bit, 32 bit or 128 bit Service UUID and track your device
    based on that. Make sure you don't pick a `GATT Service UUID

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:
@@ -149,6 +149,35 @@ Configuration variables:
    wake-up from a touch event. Note that no filter(s) is/are active during deep sleep.
 -  All other options from :ref:`Binary Sensor <config-binary_sensor>`.
 
+
+Raw Values
+----------
+
+If access to the raw values is required, a template sensor can be created that polls for them:
+
+.. code-block:: yaml
+
+    # Example configuration entry for accessing raw values
+    esp32_touch:
+      id: esp32_touch_1
+
+    binary_sensor:
+      - platform: esp32_touch
+        id: esp32_touch_pad
+        pin: GPIOXX
+        threshold: 0
+
+    sensor:
+      - platform: template
+        name: "Raw touch value"
+        lambda: |-
+            return id(esp32_touch_pad).get_value();
+        update_interval: 3s
+
+One example of use is a wide area pressure sensor that integrates a number of smaller sensors in an area. Make two strips
+of aluminium foil that sandwich paper, and connect one wire to a touch pin and the other to ground. Set up several sensors
+under a flexible object like a plastic mat, add the raw values, and apply a threshold.
+
 .. _esp32-touch-pad-pins:
 
 Touch Pad Pins

components/binary_sensor/haier.rst

@@ -0,0 +1,68 @@
+Haier Climate Binary Sensors
+============================
+
+.. seo::
+    :description: Instructions for setting up additional binary sensors for Haier climate devices.
+    :image: haier.svg
+
+Additional sensors for Haier Climate device. **These sensors are supported only by the hOn protocol**.
+
+
+.. figure:: images/haier-climate.jpg
+    :align: center
+    :width: 50.0%
+
+.. code-block:: yaml
+
+    # Example configuration entry
+    uart:
+      baud_rate: 9600
+      tx_pin: GPIOXX
+      rx_pin: GPIOXX
+      id: ac_port
+
+    climate:
+      - platform: haier
+        id: haier_ac
+        protocol: hOn
+        name: Haier AC
+        uart_id: ac_port
+
+    binary_sensor:
+      - platform: haier
+        haier_id: haier_ac
+        compressor_status:
+          name: Haier Outdoor Compressor Status
+        defrost_status:
+          name: Haier Defrost Status
+        four_way_valve_status:
+          name: Haier Four Way Valve Status
+        indoor_electric_heating_status:
+          name: Haier Indoor Electric Heating Status
+        indoor_fan_status:
+          name: Haier Indoor Fan Status
+        outdoor_fan_status:
+          name: Haier Outdoor Fan Status
+
+Configuration variables:
+------------------------
+
+- **haier_id** (**Required**, :ref:`config-id`): The id of haier climate component
+- **compressor_status** (*Optional*): A binary sensor that indicates Haier climate compressor activity.
+  All options from :ref:`Binary Sensor <config-binary_sensor>`.
+- **defrost_status** (*Optional*): A binary sensor that indicates defrost procedure activity.
+  All options from :ref:`Binary Sensor <config-binary_sensor>`.
+- **four_way_valve_status** (*Optional*): A binary sensor that indicates four way valve status.
+  All options from :ref:`Binary Sensor <config-binary_sensor>`.
+- **indoor_electric_heating_status** (*Optional*): A binary sensor that indicates electrical heating system activity.
+  All options from :ref:`Binary Sensor <config-binary_sensor>`.
+- **indoor_fan_status** (*Optional*): A binary sensor that indicates indoor fan activity.
+  All options from :ref:`Binary Sensor <config-binary_sensor>`.
+- **outdoor_fan_status** (*Optional*): A binary sensor that indicates outdoor fan activity.
+  All options from :ref:`Binary Sensor <config-binary_sensor>`.
+
+See Also
+--------
+
+- :doc:`Haier Climate </components/climate/haier>`
+- :ghedit:`Edit`

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

@@ -32,7 +32,7 @@ our `Bluetooth Proxy installer <https://esphome.github.io/bluetooth-proxies/>`__
 
     The :doc:`web_server` component should be disabled as the device is likely
     to run out of memory and will malfunction when both components are enabled simultaneously.
-    
+
     Not all devices are supported and ESPHome does not decode or keep a list. To find out if your device is supported,
     please search for it in the `Home Assistant Integrations <https://www.home-assistant.io/integrations/>`__ list.
 
@@ -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

@@ -69,7 +69,7 @@ Configuration variables:
     - ``12K5BPS`` - Support by ``esp32_can`` depends on ESP32 variant
     - ``16KBPS`` - Support by ``esp32_can`` depends on ESP32 variant
     - ``20KBPS`` - Support by ``esp32_can`` depends on ESP32 variant
-    - ``25KBPS`` 
+    - ``25KBPS``
     - ``31K25BPS`` - Not supported by ``esp32_can``
     - ``33KBPS`` - Not supported by ``esp32_can``
     - ``40KBPS`` - Not supported by ``esp32_can``
@@ -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:
@@ -209,28 +209,28 @@ You only need to specify the RX and TX pins. Any GPIO will work.
 
 The table lists the specific bit rates supported by the component for ESP32 variants:
  =================== ======= ========== ========== ========== ========== ==========
-  bit_rate            ESP32   ESP32-S2   ESP32-S3   ESP32-C3   ESP32-C6   ESP32-H2   
+  bit_rate            ESP32   ESP32-S2   ESP32-S3   ESP32-C3   ESP32-C6   ESP32-H2
  =================== ======= ========== ========== ========== ========== ==========
-  1KBPS                        x          x          x          x          x          
-  5KBPS                        x          x          x          x          x          
-  10KBPS                       x          x          x          x          x          
-  12K5BPS                      x          x          x          x          x          
-  16KBPS                       x          x          x          x          x          
-  20KBPS                       x          x          x          x          x          
-  25KBPS               x       x          x          x          x          x          
-  31K25BPS                                                                           
-  33KBPS                                                                              
-  40KBPS                                                                              
-  50KBPS               x       x          x          x          x          x          
-  80KBPS                                                                              
-  83K38BPS                                                                           
-  95KBPS                                                                              
-  100KBPS              x       x          x          x          x          x          
-  125KBPS (Default)    x       x          x          x          x          x          
-  250KBPS              x       x          x          x          x          x          
-  500KBPS              x       x          x          x          x          x          
-  800KBPS              x       x          x          x          x          x          
-  1000KBPS             x       x          x          x          x          x          
+  1KBPS                        x          x          x          x          x
+  5KBPS                        x          x          x          x          x
+  10KBPS                       x          x          x          x          x
+  12K5BPS                      x          x          x          x          x
+  16KBPS                       x          x          x          x          x
+  20KBPS                       x          x          x          x          x
+  25KBPS               x       x          x          x          x          x
+  31K25BPS
+  33KBPS
+  40KBPS
+  50KBPS               x       x          x          x          x          x
+  80KBPS
+  83K38BPS
+  95KBPS
+  100KBPS              x       x          x          x          x          x
+  125KBPS (Default)    x       x          x          x          x          x
+  250KBPS              x       x          x          x          x          x
+  500KBPS              x       x          x          x          x          x
+  800KBPS              x       x          x          x          x          x
+  1000KBPS             x       x          x          x          x          x
  =================== ======= ========== ========== ========== ========== ==========
 
 
@@ -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

@@ -27,10 +27,14 @@ submit a feature request (see FAQ).
 +---------------------------------------+---------------------+----------------------+
 | Daikin                                | ``daikin``          | yes                  |
 +---------------------------------------+---------------------+----------------------+
+| :ref:`Daikin ARC<daikin_arc>`         | ``daikin_arc``      | yes                  |
++---------------------------------------+---------------------+----------------------+
 | :ref:`Daikin BRC<daikin_brc>`         | ``daikin_brc``      | yes                  |
 +---------------------------------------+---------------------+----------------------+
 | :ref:`Delonghi<delonghi_ir>`          | ``delonghi``        | yes                  |
 +---------------------------------------+---------------------+----------------------+
+| Emmeti                                | ``emmeti``          | yes                  |
++---------------------------------------+---------------------+----------------------+
 | Fujitsu General                       | ``fujitsu_general`` | yes                  |
 +---------------------------------------+---------------------+----------------------+
 | :ref:`GREE<gree_ir>`                  | ``gree``            |                      |
@@ -40,9 +44,9 @@ submit a feature request (see FAQ).
 +---------------------------------------+---------------------+----------------------+
 | :ref:`LG<climate_ir_lg>`              | ``climate_ir_lg``   | yes                  |
 +---------------------------------------+---------------------+----------------------+
-| Midea                                 | ``midea_ir``        | yes                  |
+| :ref:`Midea<midea_ir>`                | ``midea_ir``        | yes                  |
 +---------------------------------------+---------------------+----------------------+
-| Mitsubishi                            | ``mitsubishi``      |                      |
+| :ref:`Mitsubishi<mitsubishi>`         | ``mitsubishi``      | yes                  |
 +---------------------------------------+---------------------+----------------------+
 | Noblex                                | ``noblex``          | yes                  |
 +---------------------------------------+---------------------+----------------------+
@@ -72,7 +76,7 @@ controller unit.
 
     # Example configuration entry
     remote_transmitter:
-      pin: GPIO32
+      pin: GPIOXX
       carrier_duty_percent: 50%
 
     climate:
@@ -152,7 +156,7 @@ IR receiver.
     remote_receiver:
       id: rcvr
       pin:
-        number: GPIO14
+        number: GPIOXX
         inverted: true
         mode:
           input: true
@@ -165,35 +169,6 @@ IR receiver.
         name: "Living Room AC"
         receiver_id: rcvr
 
-.. _midea_ir:
-
-``midea_ir`` Climate
--------------------------
-
-These air conditioners support two protocols: Midea and Coolix. Therefore, when using an IR receiver, it considers both protocols and publishes the received states.
-
-Additional configuration is available for this platform
-
-
-Configuration variables:
-
-- **use_fahrenheit** (*Optional*, boolean): Allows you to transfer the temperature to the air conditioner in degrees Fahrenheit. The air conditioner display also shows the temperature in Fahrenheit. Defaults to ``false``.
-
-.. code-block:: yaml
-
-    # Example configuration entry
-    climate:
-      - platform: midea_ir
-        name: "AC"
-        sensor: room_temperature
-        use_fahrenheit: true
-
-.. note::
-
-    - See :ref:`Transmit Midea<remote_transmitter-transmit_midea>` to send custom commands, including Follow Me mode.
-    - See :ref:`Toshiba<toshiba>` below if you are looking for compatibility with Midea model MAP14HS1TBL or similar.
-
-
 .. _climate_ir_lg:
 
 ``climate_ir_lg`` Climate
@@ -220,6 +195,21 @@ Configuration variables:
         header_high: 3265us # AC Units from LG in Brazil, for example use these timings
         header_low: 9856us
 
+.. _daikin_arc:
+
+``daikin_arc`` Climate
+-------------------------
+
+The Daikin ARC remotes are used by the japanese model of Daikin.
+
+.. code-block:: yaml
+
+    # Example configuration entry
+    climate:
+      - platform: daikin_arc
+        name: "AC"
+        sensor: room_temperature
+
 .. _daikin_brc:
 
 ``daikin_brc`` Climate
@@ -253,6 +243,76 @@ Known working with:
 
 - Delonghi PAC WE 120HP
 
+.. _midea_ir:
+
+``midea_ir`` Climate
+-------------------------
+
+These air conditioners support two protocols: Midea and Coolix. Therefore, when using an IR receiver, it considers both protocols and publishes the received states.
+
+Additional configuration is available for this platform
+
+
+Configuration variables:
+
+- **use_fahrenheit** (*Optional*, boolean): Allows you to transfer the temperature to the air conditioner in degrees Fahrenheit. The air conditioner display also shows the temperature in Fahrenheit. Defaults to ``false``.
+
+.. code-block:: yaml
+
+    # Example configuration entry
+    climate:
+      - platform: midea_ir
+        name: "AC"
+        sensor: room_temperature
+        use_fahrenheit: true
+
+.. note::
+
+    - See :ref:`Transmit Midea<remote_transmitter-transmit_midea>` to send custom commands, including Follow Me mode.
+    - See :ref:`Toshiba<toshiba>` below if you are looking for compatibility with Midea model MAP14HS1TBL or similar.
+
+.. _mitsubishi:
+
+``mitsubishi`` Climate
+------------------------
+
+Additonal configurations available for this platform.
+
+Configuration variables:
+
+- **set_fan_mode** (*Optional*, string): Select the fan modes desired or that are supported on your remote. Defaults to ``3levels``
+
+  - Options are: ``3levels`` , ``4levels``, ``quiet_4levels``.
+
+    - ``3levels``; Low [fan speed 1], Medium [2], High [3]
+    - ``4levels``; Low [1], Middle [2], Medium [3], High [4]
+    - ``quiet_4levels``; Low [1], Middle [2], Medium [3], High [4], Quiet [5]
+
+- **supports_dry** (*Optional*, boolean): Enables setting dry mode for this unit. Defaults to ``false``.
+- **supports_fan_only** (*Optional*, boolean): Enables setting fan only mode for this unit. Confirm that mode is supported on your remote. Defaults to ``false``.
+
+- **horizontal_default** (*Optional*, string): What to default to when the AC unit's horizontal direction is *not* set to swing. Defaults to ``middle``.
+
+  - Options are: ``left``, ``middle-left``, ``middle``, ``middle-right``, ``right``, ``auto``
+- **vertical_default** (*Optional*, string): What to default to when the AC unit's vertical direction is *not* set to swing. Defaults to ``middle``.
+
+  - Options are: ``down``, ``middle-down``, ``middle``, ``middle-up``, ``up``, ``auto``
+
+.. note::
+
+    - This climate IR component is also known to work with some Stiebel Eltron Units. It has been tested with Stiebel Eltron IR-Remote ``KM07F`` and unit ``ACW 25 i``
+
+.. code-block:: yaml
+
+    # Example configuration entry
+    climate:
+      - platform: mitsubishi
+        name: "Heatpump"
+        set_fan_mode: "quiet_4levels"
+        supports_dry: "true"
+        supports_fan_only: "true"
+        horizontal_default: "left"
+        vertical_default: "down"
 
 .. _toshiba:
 
@@ -284,7 +344,7 @@ Configuration variables:
       ``update_interval`` must be less than seven minutes or the ``RAC-PT1411HWRU`` will revert to using its own
       internal temperature sensor; a value of 30 seconds seems to work well. See :doc:`/components/sensor/index`
       for more information.
-    
+
     - This climate IR component is also known to work with Midea model MAP14HS1TBL and may work with other similar
       models, as well. (Midea acquired Toshiba's product line and re-branded it.)
 
@@ -362,8 +422,8 @@ Configuration variables:
 ``zhlt01`` Climate
 ---------------------
 
-ZH/LT-01 is a remote control that is used with many locally branded split airconditioners. 
-Supported brands include: 
+ZH/LT-01 is a remote control that is used with many locally branded split airconditioners.
+Supported brands include:
 
 - Eurom
 - Chigo

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,24 +58,15 @@ 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
         protocol: hOn
-        name: Haier AC 
+        name: Haier AC
         uart_id: ac_port
         wifi_signal: true
         beeper: true
         display: true
-        outdoor_temperature:
-          name: Haier AC outdoor temperature
         visual:
           min_temperature: 16 °C
           max_temperature: 30 °C
@@ -125,16 +116,11 @@ Configuration variables:
 - **control_method** (*Optional*, list): (supported only by hOn) Defines control method (should be supported by AC). Supported values: MONITOR_ONLY - no control, just monitor status, SET_GROUP_PARAMETERS - set all AC parameters with one command (default method), SET_SINGLE_PARAMETER - set each parameter individually (this method is supported by some new ceiling ACs like AD71S2SM3FA)
 - **display** (*Optional*, boolean): Can be used to set the AC display off.
 - **beeper** (*Optional*, boolean): Can be used to disable beeping on commands from AC. Supported only by hOn protocol.
-- **outdoor_temperature** (*Optional*): Temperature sensor for outdoor temperature. Supported only by hOn protocol.
-
-  - **name** (**Required**, string): The name of the sensor.
-  - **id** (*Optional*, :ref:`config-id`): ID of the sensor, can be used for code generation
-  - All other options from :ref:`Sensor <config-sensor>`.
 - **supported_modes** (*Optional*, list): Can be used to disable some of AC modes. Possible values: 'OFF', HEAT_COOL, COOL, HEAT, DRY, FAN_ONLY
 - **supported_swing_modes** (*Optional*, list): Can be used to disable some swing modes if your AC does not support it. Possible values: 'OFF', VERTICAL, HORIZONTAL, BOTH
 - **supported_presets** (*Optional*, list): Can be used to disable some presets. Possible values for smartair2 are: AWAY, BOOST, COMFORT. Possible values for hOn are: AWAY, ECO, BOOST, SLEEP. AWAY preset can be enabled only in HEAT mode, it is disabled by default
-- **on_alarm_start (Optional, :ref:`Automation <automation>`):** (supported only by hOn) Automation to perform when AC activates a new alarm. See :ref:`haier-on_alarm_start`
-- **on_alarm_end (Optional, :ref:`Automation <automation>`):** (supported only by hOn) Automation to perform when AC deactivates a new alarm. See :ref:`haier-on_alarm_end`
+- **on_alarm_start** (*Optional*, :ref:`Automation <automation>`): (supported only by hOn) Automation to perform when AC activates a new alarm. See :ref:`haier-on_alarm_start`
+- **on_alarm_end** (*Optional*, :ref:`Automation <automation>`): (supported only by hOn) Automation to perform when AC deactivates a new alarm. See :ref:`haier-on_alarm_end`
 - All other options from :ref:`Climate <config-climate>`.
 
 Automations
@@ -327,6 +313,8 @@ See Also
 --------
 
 - `haier-esphome <https://github.com/paveldn/haier-esphome>`__
+- :doc:`Haier Climate Sensors </components/sensor/haier>`
+- :doc:`Haier Climate Binary Sensors </components/binary_sensor/haier>`
 - :doc:`/components/climate/index`
 - :apiref:`haier/climate/haier.h`
 - :ghedit:`Edit`

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/climate/tuya.rst

@@ -39,8 +39,10 @@ Based on this, you can create the climate device as follows:
         switch_datapoint: 1
         target_temperature_datapoint: 3
         current_temperature_datapoint: 4
-        eco_datapoint: 7
-        eco_temperature: 20 °C
+        preset:
+          eco:
+            datapoint: 8
+            temperature: 28
 
 Configuration variables:
 ------------------------
@@ -50,22 +52,46 @@ Configuration variables:
 - **supports_heat** (*Optional*, boolean): Specifies if the device has a heating mode. Defaults to ``true``.
 - **supports_cool** (*Optional*, boolean): Specifies if the device has a cooling mode. Defaults to ``false``.
 - **switch_datapoint** (**Required**, int): The datapoint id number of the climate switch (device on/off).
-- **active_state_datapoint** (*Optional*, int): The datapoint id number of the active state - :ref:`see below <active_state_detection>`.
-- **active_state_heating_value** (*Optional*, int): The active state datapoint value the device reports when heating. Defaults to ``1`` - :ref:`see below <active_state_detection>`.
-- **active_state_cooling_value** (*Optional*, int): The active state datapoint value the device reports when cooling - :ref:`see below <active_state_detection>`.
+- **active_state** (*Optional*): Configuration for the Active State Configuration.
+
+    - **datapoint** (**Required**, int): The datapoint id number of the active state - :ref:`see below <active_state_detection>`.
+    - **heating_value** (*Optional*, int): The active state datapoint value the device reports when heating. Defaults to ``1`` - :ref:`see below <active_state_detection>`.
+    - **cooling_value** (*Optional*, int): The active state datapoint value the device reports when cooling - :ref:`see below <active_state_detection>`.
+    - **drying_value** (*Optional*, int): The active state datapoint value the device reports when in drying mode.
+    - **fanonly_value** (*Optional*, int): The active state datapoint value the device reports when in Fan Only mode.
+- **preset** (*Optional*): Configuration for presets.
+
+    - **eco** (*Optional*): Configuration for Eco preset.
+
+        - **datapoint** (**Required**, int): The datapoint id number of the Eco action.
+        - **temperature** (*Optional*, int): Temperature setpoint for Eco preset.
+    - **sleep** (*Optional*): Configuration for Sleep preset
+
+        - **datapoint** (**Required**, int): The Datapoint id number of the Sleep Action
+- **swing_mode** (*Optional*): Configuration for the swing (oscillation) modes.
+
+    - **vertical_datapoint** (*Optional*, int): The datapoint id number of the vertical swing action.
+    - **horizontal_datapoint** (*Optional*, int): The datapoint id number of the horizontal swing action.
+- **fan_mode** (*Optional*): Configuration for fan modes/fan speeds.
+
+    - **datapoint** (**Required**, int): The datapoint id number of the Fan value state.
+    - **auto_value** (*Optional*, int): The datapoint value the device reports when the fan is on ``auto`` speed.
+    - **low_value** (*Optional*, int):  The datapoint value the device reports when the fan is on ``low`` speed.
+    - **medium_value** (*Optional*, int):  The datapoint value the device reports when the fan is on ``medium`` speed.
+    - **middle_value** (*Optional*, int):  The datapoint value the device reports when the fan is on ``middle`` speed. (May set to device's ``high`` value if you have a ``Turbo`` option).
+    - **high_value** (*Optional*, int):  The datapoint value the device reports when the fan is on ``high`` speed. (Sometimes called ``Turbo``).
 - **heating_state_pin** (*Optional*, :ref:`config-pin`): The input pin indicating that the device is heating - :ref:`see below <active_state_detection>`. Only used if **active_state_datapoint** is not configured.
 - **cooling_state_pin** (*Optional*, :ref:`config-pin`): The input pin indicating that the device is cooling - :ref:`see below <active_state_detection>`. Only used if **active_state_datapoint** is not configured.
 - **target_temperature_datapoint** (**Required**, int): The datapoint id number of the target temperature.
 - **current_temperature_datapoint** (**Required**, int): The datapoint id number of the current temperature.
 - **temperature_multiplier** (*Optional*, float): A multiplier to modify the incoming and outgoing temperature values - :ref:`see below <temperature-multiplier>`.
-- **eco_datapoint** (*Optional*, int): The datapoint id number of the eco mode state.
-- **eco_temperature** (*Optional*, float): The target temperature the controller uses while the eco mode is active.
+
 - **reports_fahrenheit** (*Optional*, boolean): Set to ``true`` if the device reports temperatures in Fahrenheit. ESPHome expects all climate temperatures to be in Celcius, otherwise unexpected conversions will take place when it is published to Home Assistant. Defaults to ``false``.
 
 If the device has different multipliers for current and target temperatures, **temperature_multiplier** can be replaced with both of:
 
-- **current_temperature_multiplier** (*Optional*, float): A multiplier to modify the current temperature value.
-- **target_temperature_multiplier** (*Optional*, float): A multiplier to modify the target temperature value.
+    - **current_temperature_multiplier** (*Optional*, float): A multiplier to modify the current temperature value.
+    - **target_temperature_multiplier** (*Optional*, float): A multiplier to modify the target temperature value.
 
 - All other options from :ref:`Climate <config-climate>`.
 

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/template.rst

@@ -62,7 +62,6 @@ Configuration variables:
   of hiding one of them. Defaults to ``false``.
 - **has_position** (*Optional*, boolean): Whether this cover will publish its position as a floating point number.
   By default (``false``), the cover only publishes OPEN/CLOSED position.
-  Parameter useless if you set the POSITION_ACTION (is set to TRUE).
 - **tilt_action** (*Optional*, :ref:`Action <config-action>`): The action that should
   be performed when the remote (like Home Assistant's frontend) requests the cover be set to a specific
   tilt position. The desired tilt is available in the lambda in the ``tilt`` variable.
@@ -71,6 +70,7 @@ Configuration variables:
 - **position_action** (*Optional*, :ref:`Action <config-action>`): The action that should
   be performed when the remote (like Home Assistant's frontend) requests the cover be set to a specific
   position. The desired position is available in the lambda in the ``pos`` variable.
+  Useless if `has_position` is not set to ``true``.
 - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - All other options from :ref:`Cover <config-cover>`.
 

components/cover/time_based.rst

@@ -77,7 +77,25 @@ 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).get_last_operation() == CoverOperation::COVER_OPERATION_OPENING) {
+            // Cover is currently opening
+            id(cover_button_down).press();
+          } else if (id(cover).get_last_operation() == CoverOperation::COVER_OPERATION_CLOSING) {
+            // Cover is currently closing
+            id(cover_button_up).press();
+          }
+
+Be aware that ``get_last_operation`` will only return the last opening or closing operation, but not the last idle operation. 
+This issue is tracked `here <https://github.com/esphome/issues/issues/4252#issuecomment-2132727377>`_.
 
 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

@@ -0,0 +1,327 @@
+Datetime Component
+==================
+
+.. seo::
+    :description: Instructions for setting up datetime components in ESPHome.
+    :image: folder-open.svg
+
+ESPHome has support for components to create a datetime entity. A datetime entity
+currently represents a date that can be set by the user/frontend.
+
+.. note::
+
+    Requires Home Assistant 2024.4 or newer.
+
+.. _config-datetime:
+
+Base Datetime Configuration
+---------------------------
+
+All datetime in ESPHome have a name and an optional icon.
+
+.. code-block:: yaml
+
+    # Example datetime configuration
+    name: Date to check
+
+    # Optional variables:
+    icon: "mdi:calendar-alert"
+
+Configuration variables:
+
+- **name** (**Required**, string): The name for the datetime.
+
+  .. note::
+
+      If you have a :ref:`friendly_name <esphome-configuration_variables>` set for your device and
+      you want the datetime to use that name, you can set ``name: None``.
+
+- **icon** (*Optional*, icon): Manually set the icon to use for the datetime 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).
+  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.
+  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>`.
+
+Time and DateTime Options:
+
+- **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:
+
+``on_value``
+************
+
+This automation will be triggered when a new value is published. In :ref:`Lambdas <config-lambda>`
+you can get the value as a ESPTime object from the trigger with ``x``.
+
+.. code-block:: yaml
+
+    datetime:
+      - platform: template
+        # ...
+        on_value:
+          then:
+            - lambda: |-
+                if(x.hour >= 12) {
+                  ESP_LOGD("main", "Updated hour is later or equal to 12");
+                } else {
+                  ESP_LOGD("main", "Updated hour is earlier than 12");
+                }
+
+Configuration variables: See :ref:`Automation <automation>`.
+
+Date Automation
+---------------
+
+.. _datetime-date_set_action:
+
+``datetime.date.set`` Action
+****************************
+
+This is an :ref:`Action <config-action>` for setting a datetime date state.
+The ``date`` provided can be in one of 3 formats:
+
+.. code-block:: yaml
+
+    # String date
+    - datetime.date.set:
+        id: my_datetime_date
+        date: "2023-12-04"
+
+    # Individual date parts
+    - datetime.date.set:
+        id: my_datetime_date
+        date:
+          year: 2023
+          month: 12
+          day: 4
+
+    # Using a lambda
+    - datetime.date.set:
+        id: my_datetime_date
+        date: !lambda |-
+          // Return an ESPTime struct
+          return {.day_of_month: 4, .month: 12, .year: 2023};
+
+Configuration variables:
+
+- **id** (**Required**, :ref:`config-id`): The ID of the datetime to set.
+- **date** (**Required**, string, date parts, :ref:`templatable <config-templatable>`):
+  The value to set the datetime to.
+
+
+
+.. _datetime-lambda_calls:
+
+lambda calls
+************
+
+From :ref:`lambdas <config-lambda>`, you can call several methods on all datetimes to do some
+advanced stuff (see the full API Reference for more info).
+
+- ``.make_call()``: Make a call for updating the datetime value.
+
+  .. code-block:: cpp
+
+      // Within lambda, set the date to 2024-02-25
+      auto call = id(my_datetime_date).make_call();
+      call.set_date("2024-02-25");
+      call.perform();
+
+  Check the API reference for information on the methods that are available for
+  the ``DateCall`` object.
+
+- ``.year``: Retrieve the current year of the ``date``. It will be ``0`` if no value has been set.
+- ``.month``: Retrieve the current month of the ``date``. It will be ``0`` if no value has been set.
+- ``.day``: Retrieve the current day of the ``date``. 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", id(my_date).year, id(my_date).month, id(my_date).day);
+
+Time Automation
+---------------
+
+.. _datetime-time_set_action:
+
+``datetime.time.set`` Action
+****************************
+
+This is an :ref:`Action <config-action>` for setting a datetime time state.
+The ``time`` provided can be in one of 3 formats:
+
+.. code-block:: yaml
+
+    # String time
+    - datetime.time.set:
+        id: my_datetime_time
+        time: "12:34:56"
+
+    # Individual time parts
+    - datetime.time.set:
+        id: my_datetime_time
+        time:
+          hour: 12
+          minute: 34
+          second: 56
+
+    # Using a lambda
+    - datetime.time.set:
+        id: my_datetime_time
+        time: !lambda |-
+          // Return an ESPTime struct
+          return {.second: 56, .minute: 34, .hour: 12};
+
+Configuration variables:
+
+- **id** (**Required**, :ref:`config-id`): The ID of the datetime to set.
+- **time** (**Required**, string, time parts, :ref:`templatable <config-templatable>`):
+  The value to set the datetime to.
+
+
+.. _datetime-time-lambda_calls:
+
+lambda calls
+************
+
+From :ref:`lambdas <config-lambda>`, you can call several methods on all datetimes to do some
+advanced stuff (see the full API Reference for more info).
+
+- ``.make_call()``: Make a call for updating the datetime value.
+
+  .. code-block:: cpp
+
+      // Within lambda, set the time to 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
+  the ``TimeCall`` object.
+
+- ``.hour``: Retrieve the current hour of the ``time``. It will be ``0`` if no value has been set.
+- ``.minute``: Retrieve the current minute of the ``time``. It will be ``0`` if no value has been set.
+- ``.second``: Retrieve the current second of the ``time``. 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: %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
+--------
+
+- :apiref:`DateTimeBase <datetime/datetime_base.h>`
+- :apiref:`DateEntity <datetime/date_entity.h>`
+- :apiref:`DateCall <datetime/date_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::
+    :maxdepth: 1
+    :glob:
+
+    *

components/datetime/template.rst

@@ -0,0 +1,106 @@
+Template Datetime
+=================
+
+.. seo::
+    :description: Instructions for setting up template datetime with ESPHome.
+    :image: description.svg
+
+The ``template`` datetime platform allows you to create a datetime with templated values
+using :ref:`lambdas <config-lambda>`.
+
+.. code-block:: yaml
+
+    datetime:
+      # Example Date
+      - platform: template
+        id: my_datetime_date
+        type: date
+        name: Pick a Date
+        optimistic: yes
+        initial_value: "2024-01-30"
+        restore_value: true
+
+      # Example Time
+      - platform: template
+        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:
+------------------------
+
+- **type** (*Required*, enum): The type of the datetime. Can be one of ``date`` or ``time``.
+- **lambda** (*Optional*, :ref:`lambda <config-lambda>`):
+  Lambda to be evaluated every update interval to get the current value of the datetime.
+- **set_action** (*Optional*, :ref:`Action <config-action>`): The action that should
+  be performed when the remote (like Home Assistant's frontend) requests to set the
+  dateime value. The new value is available to lambdas in the ``x`` variable.
+- **update_interval** (*Optional*, :ref:`config-time`): The interval on which to update the datetime
+  by executing the ``lambda``. Defaults to ``60s``.
+- **optimistic** (*Optional*, boolean): Whether to operate in optimistic mode - when in this mode,
+  any command sent to the template datetime will immediately update the reported state.
+  Cannot be used with ``lambda``. Defaults to ``false``.
+- **restore_value** (*Optional*, boolean): Saves and loads the state to RTC/Flash.
+  Cannot be used with ``lambda``. Defaults to ``false``.
+- **initial_value** (*Optional*, string): The value to set the state to on setup if not
+  restored with ``restore_value``. Can be one of:
+
+  - For ``type: date``:
+
+    - A string in the format ``%Y-%m-%d`` , eg: ``"2023-12-04"``.
+    - An object including ``year``, ``month``, ``day``.
+
+    .. code-block:: yaml
+
+        initial_value:
+          year: 2023
+          month: 12
+          day: 4
+
+  - For ``type: time``:
+
+    - A string in the format ``%H:%M:%S`` , eg: ``"12:34:56"``.
+    - An object including ``hour``, ``minute``, ``second``.
+
+    .. code-block:: yaml
+
+        initial_value:
+          hour: 12
+          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
+--------
+
+- :ref:`automation`
+- :apiref:`template/datetime/template_date.h`
+- :ghedit:`Edit`

components/deep_sleep.rst

@@ -21,7 +21,9 @@ to wake up on any RTC pin (``GPIO0``, ``GPIO2``, ``GPIO4``, ``GPIO12``, ``GPIO13
 ``GPIO15``, ``GPIO25``, ``GPIO26``, ``GPIO27``, ``GPIO32``, ``GPIO39``).
 
 While in deep sleep mode, the node will not do any work and not respond to any network traffic,
-even Over The Air updates.
+even Over The Air updates. If the device's entities are appearing as **Unavailable** while your device is actively
+sleeping, this component was likely added after the device was added to Home Assistant. To prevent this behavior,
+you can remove and re-add the device in Home Assistant.
 
 .. code-block:: yaml
 
@@ -32,8 +34,8 @@ even Over The Air updates.
 
 .. note::
 
-    Some ESP8266s have an onboard USB chip (e.g. D1 mini) on the chips' control line that is connected to the RST pin. This enables the flasher to reboot the ESP when required. This may interfere with deep sleep on some devices and prevent the ESP from waking when it's powered through its USB connector. Powering the ESP from a separate 3.3V source connected to the 3.3V pin and GND will solve this issue. In these cases, using a USB to TTL adapter will allow you to log ESP activity. 
-    
+    Some ESP8266s have an onboard USB chip (e.g. D1 mini) on the chips' control line that is connected to the RST pin. This enables the flasher to reboot the ESP when required. This may interfere with deep sleep on some devices and prevent the ESP from waking when it's powered through its USB connector. Powering the ESP from a separate 3.3V source connected to the 3.3V pin and GND will solve this issue. In these cases, using a USB to TTL adapter will allow you to log ESP activity.
+
 Configuration variables:
 ------------------------
 
@@ -85,6 +87,34 @@ when the deep sleep should start? There are three ways of handling this using th
   then re-configure deep sleep to wake up on a LOW signal and vice versa. Useful in situations when you want to
   use observe the state changes of a pin using deep sleep and the ON/OFF values last longer.
 
+ESP32 Wakeup Cause
+------------------
+
+On the ESP32, the ``esp_sleep_get_wakeup_cause()`` function can be used to check which wakeup source has triggered
+wakeup from sleep mode.
+
+.. code-block:: yaml
+
+    sensor:
+      - platform: template
+        name: "Wakeup Cause"
+        accuracy_decimals: 0
+        lambda: return esp_sleep_get_wakeup_cause();
+
+The following integers are the wakeup causes:
+    - **0** - ``ESP_SLEEP_WAKEUP_UNDEFINED``: In case of deep sleep, reset was not caused by exit from deep sleep
+    - **1** - ``ESP_SLEEP_WAKEUP_ALL``: Not a wakeup cause, used to disable all wakeup sources with esp_sleep_disable_wakeup_source
+    - **2** - ``ESP_SLEEP_WAKEUP_EXT0``: Wakeup caused by external signal using RTC_IO
+    - **3** - ``ESP_SLEEP_WAKEUP_EXT1``: Wakeup caused by external signal using RTC_CNTL
+    - **4** - ``ESP_SLEEP_WAKEUP_TIMER``: Wakeup caused by timer
+    - **5** - ``ESP_SLEEP_WAKEUP_TOUCHPAD``: Wakeup caused by touchpad
+    - **6** - ``ESP_SLEEP_WAKEUP_ULP``: Wakeup caused by ULP program
+    - **7** - ``ESP_SLEEP_WAKEUP_GPIO``: Wakeup caused by GPIO (light sleep only on ESP32, S2 and S3)
+    - **8** - ``ESP_SLEEP_WAKEUP_UART``: Wakeup caused by UART (light sleep only)
+    - **9** - ``ESP_SLEEP_WAKEUP_WIFI``: Wakeup caused by WIFI (light sleep only)
+    - **10** - ``ESP_SLEEP_WAKEUP_COCPU``: Wakeup caused by COCPU int
+    - **11** - ``ESP_SLEEP_WAKEUP_COCPU_TRAP_TRIG``: Wakeup caused by COCPU crash
+    - **12** - ``ESP_SLEEP_WAKEUP_BT``: Wakeup caused by BT (light sleep only)
 
 .. _deep_sleep-enter_action:
 

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:
 ------------------------
@@ -114,11 +104,11 @@ Configuration options:
 ``dfplayer.play_mp3`` Action
 ----------------------------
 
-Plays a track inside the folder ``mp3``. Files inside the folder must be numbered from 1 
+Plays a track inside the folder ``mp3``. Files inside the folder must be numbered from 1
 to 9999, like ``0001.mp3``, ``0002.mp3``, ... etc.
-The folder name needs to be ``mp3``, placed under the SD card root directory, and the 
-mp3 file name needs to be 4 digits, for example, "0001.mp3", placed under the mp3 folder. 
-If you want, you can add additional text after the number in the filename, for example, 
+The folder name needs to be ``mp3``, placed under the SD card root directory, and the
+mp3 file name needs to be 4 digits, for example, "0001.mp3", placed under the mp3 folder.
+If you want, you can add additional text after the number in the filename, for example,
 ``0001hello.mp3``, but must always be referenced by number only in yaml.
 
 .. code-block:: bash
@@ -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
@@ -61,10 +49,10 @@ Configuration variables:
 - **update_interval** (*Optional*, :ref:`config-time`): The interval to call the lambda to update the display.
   Defaults to ``16ms``.
 - **pixel_mapper** (*Optional*, :ref:`lambda <config-lambda>`): A lambda that returns the integer address of the LED
-  given the supplied the ``x`` and ``y`` pixel coordinate. By default, a left-to-right direct pixel mapper is used. 
+  given the supplied the ``x`` and ``y`` pixel coordinate. By default, a left-to-right direct pixel mapper is used.
 - **lambda** (*Optional*, :ref:`lambda <config-lambda>`): The lambda to use for rendering the content on the display.
   ``it`` will be an instance of :apiclass:`DisplayBuffer <display::DisplayBuffer>`.
-  See :ref:`display-engine` for more information. 
+  See :ref:`display-engine` for more information.
 - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 
 
@@ -73,7 +61,7 @@ Configuration variables:
     When enabled (the default, but also via ``it.set_enabled(true)``), any effect currently running on the
     addressable light will be disabled. When disabled (``it.set_enabled(false)``), the last configured effect will
     be restored.
-    
+
     While the display is enabled, it is still possible to control the parent addressable light component in some
     limited capacity. Changing the brightness will still work, but changing the color will have no affect. It is not
     adivsable to enable any effects (ex: rainbow, color wipe, etc) while the display is enabled, as this will cause a

components/display/fonts.rst

@@ -0,0 +1,160 @@
+.. _display-fonts:
+
+Font Renderer Component
+=======================
+
+.. seo::
+    :description: Instructions for setting up fonts in ESPHome.
+    :image: format-font.svg
+
+ESPHome's graphical rendering engine also has a powerful font drawer which integrates seamlessly into the system. You have the option to use **any** OpenType/TrueType (``.ttf``, ``.otf``, ``.woff``) font file at **any** size, as well as fixed-size `PCF <https://en.wikipedia.org/wiki/Portable_Compiled_Format>`_ and `BDF <https://en.wikipedia.org/wiki/Glyph_Bitmap_Distribution_Format>`_ bitmap fonts.
+
+These fonts can be used in ESPHome's :ref:`own rendering engine <display-engine>`.
+
+To use fonts you can either
+ - Just grab a ``.ttf``, ``.otf``, ``.woff``, ``.pcf``, or ``.bdf`` file from somewhere on the internet and place it, for example, inside a ``fonts`` folder next to your configuration file.
+ - Use the ``gfonts://`` short form to use Google Fonts directly.
+ - Load a font from a URL directly on build.
+
+Next, create a ``font:`` section in your configuration:
+
+.. code-block:: yaml
+
+    # Various ways to configure fonts
+    font:
+      - file: "fonts/Comic Sans MS.ttf"
+        id: my_font
+        size: 20
+        bpp: 2
+
+      - file: "fonts/tom-thumb.bdf"
+        id: tomthumb
+
+        # gfonts://family[@weight]
+      - file: "gfonts://Roboto"
+        id: roboto_20
+        size: 20
+
+      - file:
+          type: gfonts
+          family: Roboto
+          weight: 900
+        id: roboto_16
+        size: 16
+
+      - file: "gfonts://Material+Symbols+Outlined"
+        id: icons_50
+        size: 50
+        glyphs: ["\U0000e425"] # mdi-timer
+
+      - file: "fonts/RobotoCondensed-Regular.ttf"
+        id: roboto_special_28
+        size: 28
+        bpp: 4
+        glyphs: [
+          a,A,á,Á,e,E,é,É,
+          (,),+,-,_,.,°,•,µ,
+          "\u0020", #space
+          "\u0021", #!
+          "\u0022", #"
+          "\u0027", #'
+          ]
+
+      - file: "fonts/RobotoCondensed-Regular.ttf"
+        id: my_font_with_icons
+        size: 20
+        bpp: 4
+        extras:
+          - file: "fonts/materialdesignicons-webfont.ttf"
+            glyphs: [
+              "\U000F02D1", # mdi-heart
+              "\U000F05D4", # mdi-airplane-landing
+              ]
+
+      - file: "https://github.com/IdreesInc/Monocraft/releases/download/v3.0/Monocraft.ttf"
+        id: web_font
+        size: 20
+      - file:
+          url: "https://github.com/IdreesInc/Monocraft/releases/download/v3.0/Monocraft.ttf"
+          type: web
+        id: web_font2
+        size: 24
+
+    display:
+      # ...
+
+Configuration variables:
+------------------------
+
+- **file** (**Required**, string): The path (relative to where the .yaml file is) of the font
+  file. You can also use the ``gfonts://`` short form to use Google Fonts, or use the below structure:
+
+  - **type** (**Required**, string): Can be ``local``, ``gfonts`` or ``web``.
+
+  **Local Fonts**:
+
+  - **path** (**Required**, string): The path (relative to where the .yaml file is) of the OpenType/TrueType or bitmap font file.
+
+  **Google Fonts**:
+
+    Each Google Font will be downloaded once and cached for future use. This can also be used to download Material
+    Symbols or Icons as in the example above.
+
+  - **family** (**Required**, string): The name of the Google Font family.
+  - **italic** (*Optional*, boolean): Whether the font should be italic.
+  - **weight** (*Optional*, enum): The weight of the font. Can be either the text name or the integer value:
+      - **thin**: 100
+      - **extra-light**: 200
+      - **light**: 300
+      - **regular**: 400 (**default**)
+      - **medium**: 500
+      - **semi-bold**: 600
+      - **bold**: 700
+      - **extra-bold**: 800
+      - **black**: 900
+
+  **Web Fonts**:
+
+  - **url** (**Required**, string): The URL of the TrueType or bitmap font file.
+
+- **id** (**Required**, :ref:`config-id`): The ID with which you will be able to reference the font later
+  in your display code.
+- **size** (*Optional*, int): The size of the font in pt (not pixel!).
+  If you want to use the same font in different sizes, create two font objects. Note: *size* is ignored
+  by bitmap fonts. Defaults to ``20``.
+- **bpp** (*Optional*, int): The bit depth of the rendered font from OpenType/TrueType, for anti-aliasing. Can be ``1``, ``2``, ``4``, ``8``. Defaults to ``1``.
+- **glyphs** (*Optional*, list): A list of characters you plan to use. Only the characters you specify
+  here will be compiled into the binary. Adjust this if you need some special characters or want to
+  reduce the size of the binary if you don't plan to use some glyphs. You can also specify glyphs by their codepoint (see below). Defaults to ``!"%()+=,-_.:°/?0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz``.
+- **extras** (*Optional*, enum): A list of font glyph configurations you'd like to include within this font, from other OpenType/TrueType files (eg. icons from other font, but at the same size as the main font):
+
+  - **file** (**Required**, string): The path of the font file with the extra glyphs.
+  - **glyphs** (**Required**, list): A list of glyphs you want to include. Can't repeat the same glyph codepoint if it was declared in the level above.
+
+.. note::
+
+    OpenType/TrueType font files offer icons at codepoints far from what's reachable on a standard keyboard, for these it's needed
+    to specify the unicode codepoint of the glyph as a hex address escaped with ``\u`` or ``\U``.
+
+    - Code points up to ``0xFFFF`` are encoded like ``\uE6E8``. Lowercase ``\u`` and exactly 4 hexadecimal digits.
+    - Code points above ``0xFFFF`` are encoded like ``\U0001F5E9``. Capital ``\U`` and exactly 8 hexadecimal digits.
+
+    The ``extras`` section only supports OpenType/TrueType files, ``size`` and ``bpp`` will be the same as the above level. This will allow printing icons alongside the characters in the same string, like ``I \uF004 You \uF001``.
+
+    Many font sizes with multiple glyphs at high bit depths will increase the binary size considerably. Make your choices carefully.
+
+
+.. note::
+
+    To use fonts you will need to have the python ``pillow`` package installed, as ESPHome uses that package
+    to translate the OpenType/TrueType and bitmap font files into an internal format. If you're running this as a Home Assistant add-on or with the official ESPHome docker image, it should already be installed. Otherwise you need
+    to install it using ``pip install "pillow==10.2.0"``.
+
+See Also
+--------
+
+- :apiref:`display/display_buffer.h`
+- :ref:`display-engine`
+- `MDI cheatsheet <https://pictogrammers.com/library/mdi/>`_
+- `MDI font repository <https://github.com/Pictogrammers/pictogrammers.github.io/tree/main/%40mdi/font/>`_
+- :ghedit:`Edit`

components/display/ili9xxx.rst

@@ -10,6 +10,7 @@ ILI9xxx TFT LCD Series
 Models
 ------
 With this display driver you can control the following displays:
+  - GC9A01A
   - ILI9341
   - ILI9342
   - ILI9481
@@ -54,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!");
@@ -69,6 +70,7 @@ Configuration variables:
   - ``ILI9341``, ``ILI9342``, ``ILI9486``, ``ILI9488``, ``ILI9488_A`` (alternative gamma configuration for ILI9488)
   - ``ILI9481``, ``ILI9481-18`` (18 bit mode)
   - ``ST7789V``, ``ST7796``
+  - ``GC9A01A``
 
 - **dc_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The DC pin.
 - **reset_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The RESET pin.
@@ -94,8 +96,6 @@ Configuration variables:
     - **offset_width** (*Optional*, int): Specify an offset for the x-direction of the display, typically used when an LCD is smaller than the maximum supported by the driver chip. Default is 0
     - **offset_height** (*Optional*, int): Specify an offset for the y-direction of the display. Default is 0.
 
-- **data_rate** (*Optional*): Set the data rate of the SPI interface to the display. One of ``80MHz``, ``40MHz`` (default), ``20MHz``, ``10MHz``, ``5MHz``, ``2MHz``, ``1MHz``, ``200kHz``, ``75kHz`` or ``1kHz``. If you have multiple ILI9xxx displays they must all use the same **data_rate**.
-- **spi_mode** (*Optional*): Set the mode for the SPI interface to the display. Default is ``MODE0`` but some displays require ``MODE3``.
 - **invert_colors** (*Optional*): With this boolean option you can invert the display colors. **Note** some of the displays have this option set automatically to true and can't be changed.
 - **18bit_mode** (*Optional*): With this boolean option you can manual enable or disable the 18 bit color mode.
 - **rotation** (*Optional*): Rotate the display presentation in software. Choose one of ``0°``, ``90°``, ``180°``, or ``270°``. This option cannot be used with ``transform``.
@@ -105,14 +105,18 @@ Configuration variables:
    - **mirror_x** (*Optional*, boolean): If true, mirror the x axis.
    - **mirror_y** (*Optional*, boolean): If true, mirror the y axis.
 
-
-**Note:** To rotate the display in hardware use one of the following combinations - with 90 and 270 rotations you
-will also need to use `dimensions:` to swap the height and width (see example below.)
-
+**Note:** The ``rotation`` variable will do a software based rotation. It is better to use the **transform** to rotate the display in hardware. Use one of the following combinations:
     - 90 degrees - use ``swap_xy`` with ``mirror_x``
     - 180 degrees - use ``mirror_x`` with ``mirror_y``
     - 270 degrees - use ``swap_xy`` with ``mirror_y``
 
+With 90 and 270 rotations you will also need to swap the **dimensions** ''height'' and ''width'' (see example below.
+
+
+To modify the SPI setting see :ref:`SPI bus <spi>` . The default **data_rate** is set to ``40MHz`` and the **spi_mode** mode is ``MODE0`` but some displays require ``MODE3`` (*).
+
+**Note:** The maximum achievable data rate will depend on the chip type (e.g. ESP32 vs ESP32-S3) the pins used (on ESP32 using the default SPI pins allows higher rates) and the connection type (on-board connections will support higher rates than long cables or DuPont wires.) If in doubt, start with a low speed and test higher rates to find what works. A MISO pin should preferably not be specified, as this will limit the maximum rate in some circumstances, and is not required if the SPI bus is used only for the display.
+
 
 Configuration examples
 **********************
@@ -130,8 +134,6 @@ height 320 and width 480 into portrait. Note that the dimensions are those of th
       width: 320
 
 
-
-
 To utilize the color capabilities of this display module, you'll likely want to add a ``color:`` section to your
 YAML configuration; please see :ref:`color <config-color>` for more detail on this configuration section.
 
@@ -178,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
@@ -202,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
@@ -232,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