Merge branch 'next' into aidot-wifi-lights

home-assistant · May 15, 2024 · 81b2455 · 81b2455
2 parents 4819500 + 3af6700
commit 81b2455
Show file tree

Hide file tree

Showing 428 changed files with 3,459 additions and 1,154 deletions.
diff --git a/.github/workflows/add_prs_to_project.yml b/.github/workflows/add_prs_to_project.yml
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out files from GitHub
-        uses: actions/[email protected].4
+        uses: actions/[email protected].5
       - name: Setting up Node.js
         uses: actions/[email protected]
         with:
@@ -25,7 +25,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out files from GitHub
-        uses: actions/[email protected].4
+        uses: actions/[email protected].5
       - name: Setting up Node.js
         uses: actions/[email protected]
         with:

diff --git a/Gemfile b/Gemfile
@@ -10,7 +10,7 @@ group :development do
   gem 'stringex', '2.8.6'
   # > 2.1.0 causes slowdowns https://github.com/sass/sassc-ruby/issues/189
   gem 'sassc', '2.1.0'
-  gem 'rubocop', '1.63.4'
+  gem 'rubocop', '1.63.5'
   gem 'ruby-lsp', '0.16.6'
   gem 'rackup', '2.1.0'
 end
@@ -23,7 +23,7 @@ group :jekyll_plugins do
 end
 
 gem 'sinatra', '4.0.0'
-gem 'nokogiri', '1.16.4'
+gem 'nokogiri', '1.16.5'
 
 # Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
 # and associated library

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -30,7 +30,7 @@ GEM
     google-protobuf (4.26.1-x86_64-linux)
       rake (>= 13)
     http_parser.rb (0.8.0)
-    i18n (1.14.4)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
     jekyll (4.3.3)
       addressable (~> 2.4)
@@ -74,7 +74,7 @@ GEM
     multi_json (1.15.0)
     mustermann (3.0.0)
       ruby2_keywords (~> 0.0.1)
-    nokogiri (1.16.4-x86_64-linux)
+    nokogiri (1.16.5-x86_64-linux)
       racc (~> 1.4)
     parallel (1.24.0)
     parser (3.3.1.0)
@@ -85,7 +85,7 @@ GEM
     prism (0.27.0)
     public_suffix (5.0.5)
     racc (1.7.3)
-    rack (3.0.10)
+    rack (3.0.11)
     rack-protection (4.0.0)
       base64 (>= 0.1.0)
       rack (>= 3.0.0, < 4)
@@ -99,10 +99,10 @@ GEM
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    regexp_parser (2.9.0)
+    regexp_parser (2.9.1)
     rexml (3.2.6)
     rouge (4.2.1)
-    rubocop (1.63.4)
+    rubocop (1.63.5)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -123,7 +123,7 @@ GEM
     ruby2_keywords (0.0.5)
     safe_yaml (1.0.5)
     sass (3.4.25)
-    sass-embedded (1.76.0-x86_64-linux-gnu)
+    sass-embedded (1.77.1-x86_64-linux-gnu)
       google-protobuf (>= 3.25, < 5.0)
     sass-globbing (1.1.5)
       sass (>= 3.1)
@@ -135,7 +135,7 @@ GEM
       rack-protection (= 4.0.0)
       rack-session (>= 2.0.0, < 3)
       tilt (~> 2.0)
-    sorbet-runtime (0.5.11367)
+    sorbet-runtime (0.5.11375)
     stringex (2.8.6)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
@@ -157,10 +157,10 @@ DEPENDENCIES
   jekyll-paginate (= 1.1.0)
   jekyll-sitemap (= 1.4.0)
   jekyll-toc (= 0.18.0)
-  nokogiri (= 1.16.4)
+  nokogiri (= 1.16.5)
   rackup (= 2.1.0)
   rake (= 13.2.1)
-  rubocop (= 1.63.4)
+  rubocop (= 1.63.5)
   ruby-lsp (= 0.16.6)
   sass-globbing (= 1.1.5)
   sassc (= 2.1.0)

diff --git a/_config.yml b/_config.yml
@@ -110,8 +110,8 @@ social:
 # Home Assistant release details
 current_major_version: 2024
 current_minor_version: 5
-current_patch_version: 0
-date_released: 2024-05-01
+current_patch_version: 3
+date_released: 2024-05-10
 
 # Either # or the anchor link to latest release notes in the blog post.
 # Must be prefixed with a # and have double quotes around it.

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -18,7 +18,7 @@
     "textlint": "^14.0.4",
     "textlint-filter-rule-comments": "^1.2.2",
     "textlint-rule-common-misspellings": "^1.0.1",
-    "textlint-rule-terminology": "^4.0.1"
+    "textlint-rule-terminology": "^5.0.0"
   },
   "resolutions": {
     "minimist": ">=1.2.5"

diff --git a/plugins/terminology_tooltip.rb b/plugins/terminology_tooltip.rb
@@ -34,7 +34,7 @@ def render(context)
 
         if glossary.key?("link")
           rendered_link = Liquid::Template.parse(glossary["link"]).render(context).strip
-          link = "<br><a class='terminology-link' href='#{rendered_link}' target='_blank'>[Learn more]</a>"
+          link = "<small><a class='terminology-link' href='#{rendered_link}' target='_blank'>[Learn more]</a></small>"
         end
 
         tooltip = "<span class='terminology-tooltip'>#{definition}#{link || ""}</span>"

diff --git a/sass/custom/_terminology_tooltip.scss b/sass/custom/_terminology_tooltip.scss
@@ -66,4 +66,7 @@
       }
     }
   }
+  code {
+    border-bottom: 2px dotted $primary-color;
+  }
 }
diff --git a/source/_data/glossary.yml b/source/_data/glossary.yml
@@ -140,6 +140,13 @@
   link: /docs/scripts/conditions/
   aliases:
     - conditions
+- term: Configuration file
+  aliases:
+    - configuration.yaml
+    - "`configuration.yaml`"
+  definition: >-
+    The configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI.
+  link: /docs/configuration/
 - term: Cover
   definition: >-
     Covers are devices such as blinds, garage doors, etc that can be opened and

diff --git a/source/_includes/asides/about.html b/source/_includes/asides/about.html
@@ -8,6 +8,7 @@ <h1 class="title delta">About Home Assistant</h1>
     <li><a href='https://demo.home-assistant.io'>Try the online demo</a></li>
     <li><a href='https://building.open-home.io/#/portal'>Join our newsletter</a></li>
     <li><a href="https://twitter.com/Home_Assistant">Follow Home Assistant on X</a></li>
+    <li><a href="https://www.openhomefoundation.org/">Home Assistant is part of the Open Home Foundation</a></li>
     {% comment %}
     <li>
       Subscribe to the Home Assistant Newsletter

diff --git a/source/_includes/common-tasks/filters.md b/source/_includes/common-tasks/filters.md
@@ -32,4 +32,4 @@ Filters are applied as follows:
 The following characters can be used in entity globs:
 
 `*` - The asterisk represents zero, one, or multiple characters
-`?` - The question mark represents a single character
+`?` - The question mark represents zero or one character
diff --git a/source/_includes/common-tasks/flashing_n2_otg.md b/source/_includes/common-tasks/flashing_n2_otg.md
@@ -72,9 +72,9 @@ This will configure the ODROID-N2+ and OTG to act as a memory card reader:
    - Make sure to toggle the boot mode switch back to MMC.
 
 4. Put the ODROID back in its case.
-5. Connect your ODROID-N2+ to your network with an Ethernet cable and plug in power.
+5. Connect your ODROID-N2+ to your network with an Ethernet cable, make sure there is internet access, and plug in power.
 
 6. If your router supports mDNS, you can reach your installation at `http://homeassistant.local:8123`. 
-   - If your network doesn’t support mDNS, you’ll have to use the IP address of your ODROID-N2+ instead of `homeassistant.local`. For example, `http://192.168.0.9:8123`. 
+   - If your network doesn’t support mDNS, you’ll have to use the IP address of your ODROID-N2+ instead of `homeassistant.local`. For example, `http://192.168.0.9:8123`.
    - You should be able to find the IP address of your ODROID-N2+ from the admin interface of your router.
 7. Continue with [onboarding](/getting-started/onboarding/).
diff --git a/source/_includes/installation/operating_system.md b/source/_includes/installation/operating_system.md
@@ -227,7 +227,8 @@ Use this method only if Method 1 does not work for you.
 
 - If you used method 2 for the installation, install the boot medium into your x86-64 hardware.
 
-1. Plug in an Ethernet cable that is connected to the network.
+1. Plug in an Ethernet cable that is connected to the network and to the internet.
+   - Note: Internet is required because the newly installed Home Assistant OS does not contain all Home Assistant components yet. It downloads the latest version of Home Assistant Core on first start.
 2. Power the system on. If you have a screen connected to the {{site.installation.types[page.installation_type].board}} system, after a minute or so the Home Assistant welcome banner will appear in the console.
 
 <div class="note">
@@ -254,7 +255,8 @@ Or else, the BIOS might provide you with a tool to add boot options, there you c
 {% else %}
 
 1. Insert the boot medium ({{ site.installation.types[page.installation_type].installation_media }}) you just created.
-2. Plug in an Ethernet cable that is connected to the network and power the system on.
+2. Plug in an Ethernet cable that is connected to the network and to the internet and power the system on.
+   - Note: Internet is required because the newly installed Home Assistant OS does not contain all Home Assistant components yet. It downloads the latest version of Home Assistant Core on first start.
 
 {% endif %}
 

diff --git a/source/_includes/integrations/restart_ha_after_config_inclusion.md b/source/_includes/integrations/restart_ha_after_config_inclusion.md
@@ -0,0 +1 @@
+After changing the {% term "`configuration.yaml`" %} file, [restart Home Assistant](/docs/configuration/#reloading-the-configuration-to-apply-changes) to apply the changes. {% if page.ha_platforms %} {% if page.ha_quality_scale != "internal" or page.ha_domain contains 'generic' %} To view the changes, go to {% my entities title="**Settings** > **Devices & services** > **Entities**" %}. {% endif %}{% endif %}
diff --git a/source/_includes/site/footer.html b/source/_includes/site/footer.html
@@ -76,6 +76,7 @@
             <li>
               <a href="https://status.home-assistant.io">System Status</a>
             </li>
+            <li><a href="https://www.openhomefoundation.org/">Home Assistant is part of the Open Home Foundation</a></li>
           </ul>
         </div>
 

diff --git a/source/_integrations/acer_projector.markdown b/source/_integrations/acer_projector.markdown
@@ -9,13 +9,17 @@ ha_domain: acer_projector
 ha_platforms:
   - switch
 ha_integration_type: integration
+related:
+  - docs: /docs/configuration/
+    title: Configuration file
 ---
 
 The `acer_projector` switch platform allows you to control the state of RS232 connected projectors from [Acer](https://www.acer.com/).
 
 ## Configuration
 
-To use your Acer Projector in your installation, add the following to your `configuration.yaml` file:
+To use your Acer Projector in your installation, add the following to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
 
 ```yaml
 # Example configuration.yaml entry

diff --git a/source/_integrations/actiontec.markdown b/source/_integrations/actiontec.markdown
@@ -9,6 +9,9 @@ ha_domain: actiontec
 ha_platforms:
   - device_tracker
 ha_integration_type: integration
+related:
+  - docs: /docs/configuration/
+    title: Configuration file
 ---
 
 The **Actiontec** {% term integration %} allows you to detect presence by looking at devices connected to an [Actiontec](https://www.actiontec.com/) device.
@@ -21,7 +24,8 @@ Supported devices (tested):
 This device tracker needs telnet to be enabled on the router.
 </div>
 
-To use this device tracker in your installation, add the following to your `configuration.yaml` file:
+To use this device tracker in your installation, add the following to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
 
 ```yaml
 # Example configuration.yaml entry

diff --git a/source/_integrations/ads.markdown b/source/_integrations/ads.markdown
@@ -18,6 +18,9 @@ ha_platforms:
   - sensor
   - switch
 ha_integration_type: integration
+related:
+  - docs: /docs/configuration/
+    title: Configuration file
 ---
 
 The ADS (automation device specification) describes a device-independent and fieldbus independent interface for communication between [Beckhoff](https://www.beckhoff.com/) automation devices running [TwinCAT](https://www.beckhoff.com/en-en/products/automation/twincat/) and other devices implementing this interface.
@@ -32,7 +35,8 @@ There is currently support for the following device types within Home Assistant:
 
 ## Configuration
 
-To enable ADS, add the following lines to your `configuration.yaml` file:
+To enable ADS, add the following lines to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
 
 ```yaml
 # Example configuration.yaml entry
@@ -78,7 +82,7 @@ Service parameters:
 
 The `ads` binary sensor platform can be used to monitor a boolean value on your ADS device.
 
-To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your `configuration.yaml`
+To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %}
 file:
 
 ```yaml
@@ -107,7 +111,7 @@ device_class:
 
 The `ads` light platform allows you to control your connected ADS lights.
 
-To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your `configuration.yaml`
+To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %}
 file:
 
 ```yaml
@@ -137,7 +141,7 @@ name:
 
 The `ads` sensor platform allows reading the value of a numeric variable on your ADS device. The variable can be of type *INT*, *UINT*,  *BYTE*, *DINT* or *UDINT*.
 
-To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your `configuration.yaml`
+To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %}
 file:
 
 ```yaml
@@ -176,7 +180,7 @@ The *factor* can be used to implement fixed decimals. E.g., set *factor* to 100
 
 The `ads` switch platform accesses a boolean variable on the connected ADS device. The variable is identified by its name.
 
-To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your `configuration.yaml`
+To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %}
 file:
 
 ```yaml
@@ -201,7 +205,7 @@ name:
 
 The `ads` cover platform allows you to control your connected ADS covers.
 
-To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your `configuration.yaml`
+To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %}
 file:
 
 ```yaml