@@ -273,17 +289,3 @@ For this tutorial, we're going to share it on GitHub Gists. This is a good optio
### Share on the Blueprint Exchange
If you follow the [Rules and format for posting](/get-blueprints), you can share your blueprint on the Home Assistant Blueprint Exchange forum. This option is accessible to the general Home Assistant community but recommended only for your original blueprints. Please don't post this tutorial to the Blueprint Exchange, but instead, remember this as an option for releasing your real blueprints.
-
-## Related topics
-
-**Prerequisites**
-- [Editing the configuration file](/docs/configuration/)
-- [YAML](/docs/configuration/yaml/), and specifically, [YAML used in automations](/docs/automation/yaml/)
-- [Scripts](/docs/scripts/)
-
-**Blueprints**
-
-- [Blueprint selectors](/docs/blueprint/selectors/)
-- [Blueprint schema](/docs/blueprint/schema/)
-- [About blueprints](/docs/blueprint/)
-- [Using automation blueprints](/docs/automation/using_blueprints/)
diff --git a/source/_docs/configuration.markdown b/source/_docs/configuration.markdown
index b02e1a6e379c..ade0f779d0a9 100644
--- a/source/_docs/configuration.markdown
+++ b/source/_docs/configuration.markdown
@@ -1,45 +1,90 @@
---
title: "Configuration.yaml"
description: "Configuring Home Assistant via text files."
+related:
+ - docs: /docs/configuration/yaml/
+ title: YAML syntax
+ - docs: /docs/configuration/secrets
+ title: Storing credentials in `secrets.yaml` file
+ - docs: /common-tasks/os/#backups
+ title: Creating and restoring backups
+ - docs: /integrations/backup/docs/tools/dev-tools/#reloading-the-yaml-configuration
+ title: Creating backups for Home Assistant Container and Core
+ - docs: /docs/tools/dev-tools/#reloading-the-yaml-configuration
+ title: Reloading the YAML configuration from developer tools
+ - docs: /common-tasks/os/#configuring-access-to-files
+ title: Configuring file access on the Operating System
+ - docs: /common-tasks/supervised/#configuring-access-to-files
+ title: Configuring file access on Supervised
+ - docs: docs/configuration/troubleshooting/
+ title: Troubleshooting the configuration
---
-While you can configure most of Home Assistant directly from the user interface under {% my config %}, some parts need you to edit `configuration.yaml`. This file contains {% term integrations %} to be loaded along with their configurations. Throughout the documentation you will find snippets that you can add to your configuration file to enable specific functionality.
+While you can configure most of Home Assistant from the user interface, for some integrations, you need to edit the `configuration.yaml` file. This file contains {% term integrations %} to be loaded along with their configurations. Throughout the documentation, you will find snippets that you can add to your configuration file to enable specific functionality.
-If you run into trouble while configuring Home Assistant, refer to the [configuration troubleshooting page](/docs/configuration/troubleshooting/) and the [`configuration.yaml` examples](/examples/#example-configurationyaml).
+
+
+Example of a configuration.yaml file, accessed using the File editor add-on on a Home Assistant Operating System installation.
+
## Editing `configuration.yaml`
-The easiest option to edit `configuration.yaml` is to use the {% my supervisor_addon title="Studio Code Server add-on" addon="a0d7b954_vscode" %}. This add-on runs VS Code, which offers live syntax checking and auto-fill of various Home Assistant entities. See [here](/common-tasks/supervised/#installing-and-using-the-visual-studio-code-vsc-add-on) for details. If unavailable on your system, use {% my supervisor_addon title="File Editor add-on" addon="core_configurator" %} instead. Again, details can be found [here](/common-tasks/supervised/#installing-and-using-the-file-editor-add-on).
+How you edit your `configuration.yaml` file depends on your editor preferences and the [installation method](/installation/#advanced-installation-methods) you used to set up Home Assistant.
-If you prefer to use a file editor on your computer, use the {% my supervisor_addon title="Samba add-on" addon="core_samba" %} to access the files as a network share. More details can be found [here](/common-tasks/supervised/#installing-and-using-the-samba-add-on).
+### To set up access to the files and prepare an editor
-The path to your configuration directory can be found in the Home Assistant {% term frontend %} by going to {% my system_health title="Settings > System > Repairs > System information from the top right menu" %}
+Before you can edit a file, you need to know how to access files in Home Assistant and setup an editor.
+File access depends on your [installation method](/installation/#advanced-installation-methods). If you use {% term "Home Assistant Operating System" %} or {% term "Home Assistant Supervised" %}, you can use editor add-ons, for example, but not if you use {% term "Home Assistant Core" %} or {% term "Home Assistant Container" %}.
-
+1. To set up file access, follow the steps for your [installation method](/installation/#advanced-installation-methods):
-Right under the version you are running, you will find what path Home Assistant has loaded the configuration from.
-
+ - [Configuring file access on the Operating System](/common-tasks/os/#configuring-access-to-files)
+ - If you are unsure which option to choose, install the [file editor add-on](/common-tasks/os/#installing-and-using-the-file-editor-add-on).
+ - Alternatively, use the [VS Code add-on](/common-tasks/os/#installing-and-using-the-visual-studio-code-vsc-add-on). This editor offers live syntax checking and auto-fill of various Home Assistant entities. But it looks more complex than the file editor.
+ - If you prefer to use a file editor on your computer, use the [Samba add-on](/common-tasks/os/#installing-and-using-the-samba-add-on).
+ - [Configuring file access on Supervised](/common-tasks/supervised/#configuring-access-to-files)
+ - [File editor add-on](/common-tasks/supervised/#installing-and-using-the-file-editor-add-on).
+ - [VS Code add-on](/common-tasks/supervised/#installing-and-using-the-visual-studio-code-vsc-add-on).
+ - [Samba add-on](/common-tasks/supervised/#installing-and-using-the-samba-add-on).
-_If you use Home Assistant Container, you can find `configuration.yaml` in the config folder that you mounted in your container._
+2. To look up the to your configuration directory, go to {% my system_health title="**Settings** > **System** > **Repairs**" %}.
+ - Select the three dots menu and select **System information**.
-_If you use Home Assistant Operating System, you can find `configuration.yaml` in the `/config` folder of the installation._
+ 
-_If you use Home Assistant Core, you can find `configuration.yaml` in the config folder passed to the `hass` command (default is `~/.homeassistant`)._
+3. Find out the location of the **Configuration directory**.
-## Reloading changes
+ 
+ - Unless you changed the file structure, the default is as follows: -
+ - {% term "Home Assistant Operating System" %}: the `configuration.yaml` is in the `/config` folder of the installation.
+ - {% term "Home Assistant Container" %}: the `configuration.yaml` is in the config folder that you mounted in your container.
+ - {% term "Home Assistant Core" %}: the `configuration.yaml` is in the config folder passed to the `hass` command (default is `~/.homeassistant`).
-Most integrations in Home Assistant that do not interact with {% term devices %} or {% term services %} can reload changes made to their configuration in `configuration.yaml`. To do this, go to {% my server_controls title="Developer Tools > YAML" %} and scroll down to the YAML configuration reloading section (alternatively, hit "c" anywhere in the UI and search for it).
+## Validating the configuration
-If you can't see your integration listed there, you will need to restart Home Assistant for changes to take effect.
+After changing configuration or automation files, you can check if the configuration is valid. A configuration check is also applied automatically when you reload the configuration or when you restart Home Assistant.
-
+The method for running a configuration check depends on your [installation type](/installation/#advanced-installation-methods). Check the common tasks for your installation type:
- To test any changes to your configuration files from the command line, check out the common tasks for [operating system](/common-tasks/os/#configuration-check), [supervised](/common-tasks/supervised/#configuration-check), [container](/common-tasks/container/#configuration-check), [core](/common-tasks/core/#configuration-check) for how to do that. Configuration changes can also be tested using the UI by navigating to {% my server_controls title="Developer Tools > YAML" %} and clicking "Check Configuration". For the button to be visible, you must enable "Advanced Mode" on your {% my profile title="User Profile" %}.
+- [Configuration check on Operating System](/common-tasks/os/#configuration-check)
+- [Configuration check on Supervised](/common-tasks/supervised/#configuration-check)
+- [Configuration check on Container](/common-tasks/container/#configuration-check)
+- [Configuration check on Core](/common-tasks/core/#configuration-check)
-
+## Reloading the configuration to apply changes
-## Migrating to a new system
+For configuration changes to become effective, the configuration must be reloaded. Most integrations in Home Assistant (that do not interact with {% term devices %} or {% term services %}) can reload changes made to their configuration in `configuration.yaml` without needing to restart Home Assistant.
-The preferred way of migrating to a new system is by {% my supervisor_backups title="making a backup" %}. Once you have created the backup on the old system, you can download it to the system that is running the Home Assistant frontend. When setting up the new system, you may use the backup. Alternatively, you can upload it to your new system using the _Upload backup_ menu option of the _Backups_ menu. Then, a restore of the uploaded backup on the new system concludes the migration.
+1. Under **Settings**, select the three dots menu (top right), select **Restart Home Assistant** > **Quick reload**.
-If you run the container or core installation methods, you will need to manually make a backup of your configuration folder. Be aware that some of the files you need start with `.`, which is hidden by default from both `ls` (in SSH), in Windows Explorer, and macOS Finder. You'll need to ensure that you're viewing all files before you copy them.
+ 
+
+2. If you find that your changes were not applied, you need to restart.
+ - Select **Restart Home Assistant**.
+ - Note: This interrupts automations and scripts.
+
+ 
+
+## Troubleshooting the configuration
+
+If you run into trouble while configuring Home Assistant, refer to the [configuration troubleshooting page](/docs/configuration/troubleshooting/) and the [`configuration.yaml` examples](/examples/#example-configurationyaml).
\ No newline at end of file
diff --git a/source/_docs/configuration/basic.markdown b/source/_docs/configuration/basic.markdown
index 5fc503984b87..afac72742f32 100644
--- a/source/_docs/configuration/basic.markdown
+++ b/source/_docs/configuration/basic.markdown
@@ -1,117 +1,32 @@
---
title: "Setup basic information"
description: "Setting up the basic info of Home Assistant."
+related:
+ - docs: /integrations/homeassistant/
+ - docs: /docs/configuration/
---
-As part of the default onboarding process, Home Assistant can detect your location from IP address geolocation. Home Assistant will automatically select a unit system and time zone based on this location. You may adjust this during onboarding, or afterwards at {% my general title="Settings > System > General" %}, network related configuration is found under {% my network title="Settings > System > Network" %}.
+As part of the default onboarding process, Home Assistant can detect your location from IP address geolocation. Home Assistant will automatically select a unit system and time zone based on this location. If you didn't adjust this directly during onboarding, you can do it later.
-If you prefer YAML, you can add the following information to your `configuration.yaml`:
+
+ 
+ Screenshot showing the General settings page.
+
-```yaml
-homeassistant:
- name: Home
- latitude: 32.87336
- longitude: 117.22743
- elevation: 430
- unit_system: metric
- currency: USD
- country: US
- time_zone: "America/Los_Angeles"
- external_url: "https://www.example.com"
- internal_url: "http://homeassistant.local:8123"
- allowlist_external_dirs:
- - "/usr/var/dumping-ground"
- - "/tmp"
- allowlist_external_urls:
- - "http://images.com/image1.png"
- media_dirs:
- media: "/media"
- recordings: "/mnt/recordings"
-```
+The general settings described here are managed by the [Home Assistant Core integration](/integrations/homeassistant/). If you are interested in the services offered by this integration, check out the integration documentation.
-
+## Editing the general settings
- You will not be able to edit anything in {% my general title="Settings > System > General" %} in the UI if you are using YAML configuration for any of the following: name, latitude, longitude, elevation, unit_system, temperature_unit, time_zone, external_url, internal_url, country, currency. Additionally, some options are only visible after "Advanced Mode" is enabled on your {% my profile title="User Profile" %}.
+To change the general settings that were defined during onboarding, follow these steps:
-
+1. Go to {% my general title="**Settings** > **System** > **General**" %} and make your changes.
+2. To change network-related configuration, such as the network name, go to {% my network title="**Settings** > **System** > **Network**" %}.
+3. If some of the settings are not visible, you may need to enable **Advanced mode**.
+ - In the bottom left, select your user name to go to your {% my profile title="**User profile**" %}, and enable **Advanced mode**.
+4. **Troubleshooting**: If any of the settings are grayed out and can't be edited, this is because they are defined in the [`configuration.yaml` file](/docs/configuration/).
+ - If you prefer editing the settings in the UI, you have to delete these entries from the [`configuration.yaml` file](/docs/configuration/).
+ - For more information about the general settings in YAML, refer to the [Home Assistant Core integration documentation](/integrations/homeassistant/).
-{% configuration %}
-name:
- description: Name of the location where Home Assistant is running.
- required: false
- type: string
-latitude:
- description: Latitude of your location required to calculate the time the sun rises and sets.
- required: false
- type: float
-longitude:
- description: Longitude of your location required to calculate the time the sun rises and sets.
- required: false
- type: float
-elevation:
- description: Altitude above sea level in meters. Impacts sunrise data.
- required: false
- type: integer
-unit_system:
- description: "`metric` for Metric, `us_customary` for US Customary. This also sets temperature_unit, Celsius for Metric and Fahrenheit for US Customary"
- required: false
- type: string
-temperature_unit:
- description: "Override temperature unit set by unit_system. `C` for Celsius, `F` for Fahrenheit."
- required: false
- type: string
-time_zone:
- description: "Pick your time zone from the column **TZ** of [Wikipedia's list of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)"
- required: false
- type: string
-currency:
- description: "Pick your currency code from the column **Code** of [Wikipedia's list of ISO 4217 active codes](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)"
- required: false
- type: string
- default: "EUR"
-external_url:
- description: "The URL that Home Assistant is available on from the internet. For example: `https://example.duckdns.org:8123`. Note that this setting may only contain a protocol, hostname and port; using a path is not supported."
- required: false
- type: string
-internal_url:
- description: "The URL that Home Assistant is available on from your local network. For example: `http://homeassistant.local:8123`. Note that this setting may only contain a protocol, hostname and port; using a path is not supported."
- required: false
- type: string
-customize:
- description: "[Customize](/docs/configuration/customizing-devices/) entities."
- required: false
- type: string
-customize_domain:
- description: "[Customize](/docs/configuration/customizing-devices/) all entities in a domain."
- required: false
- type: string
-customize_glob:
- description: "[Customize](/docs/configuration/customizing-devices/) entities matching a pattern."
- required: false
- type: string
-allowlist_external_dirs:
- description: List of folders that can be used as sources for sending files.
- required: false
- type: list
-allowlist_external_urls:
- description: List of external URLs that can be fetched. URLs can match specific resources (e.g., `http://10.10.10.12/images/image1.jpg`) or a relative path that allows access to resources within it (e.g., `http://10.10.10.12/images` would allow access to anything under that path)
- required: false
- type: list
-media_dirs:
- description: A mapping of local media sources and their paths on disk.
- required: false
- type: map
-language:
- description: "Default language used by Home Assistant. This may, for example, influence the language used by voice assistants. The language should be specified as an RFC 5646 language tag, and must be a language which Home Assistant is translated to."
- required: false
- type: string
- default: "en"
-country:
- description: "Country in which Home Assistant is running. This may, for example, influence radio settings to comply with local regulations. The country should be specified as an ISO 3166.1 alpha-2 code. Pick your country from the column **Code** of [Wikipedia's list of ISO 31661 alpha-2 officially assigned code codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)"
- required: false
- type: string
-{% endconfiguration %}
+ 
-## Reload core service
-
-Home Assistant offers a service to reload the core configuration while Home Assistant is running called {% my developer_call_service service="homeassistant.reload_core_config" %}. This allows you to change any of the above sections and see it being applied without having to restart Home Assistant. To call this service, go to the "{% my developer_services %}" tab under {% my developer_services title="Developer Tools" %}, select the {% my developer_call_service service="homeassistant.reload_core_config" %} service and click the "CALL SERVICE" button. Alternatively, you can press the "Location & Customizations" button under {% my server_controls title="Developer Tools > YAML" %}.
+5. To apply the changes, follow the steps on [reloading the configuration](/docs/configuration/#reloading-configuration-changes).
diff --git a/source/_docs/configuration/customizing-devices.markdown b/source/_docs/configuration/customizing-devices.markdown
index e289cdc10e8a..6a2d8e64db82 100644
--- a/source/_docs/configuration/customizing-devices.markdown
+++ b/source/_docs/configuration/customizing-devices.markdown
@@ -1,129 +1,33 @@
---
title: "Customizing entities"
description: "Simple customization for entities."
+related:
+ - docs: /integrations/homeassistant/
+ - docs: /docs/configuration/
+ title: Home Assistant Core integration documentation
---
-## Changing the entity ID
+## Changing entity name and entity ID
-You can use the UI to change the entity ID and friendly name of supported entities. To do this:
+After adding a new device, the entity may not have a name and the automatically assigned entity ID might look very technical. If you like, you can use your own naming concept for devices.
-1. Select the {% term entity %}, either from the frontend or by selecting the info button next to the entity in the Developer Tools "States" tab.
-2. Select the cog icon in the right corner of the entity's dialog
-
-3. Enter the new name or the new entity ID (remember not to change the domain of the entity - the part before the `.`)
-
-4. Select *Update*
+To change the entity ID and friendly name of supported entities, follow these steps:
-If your entity is not supported, or you cannot customize what you need via this method, please see below for more options.
+1. Go to {% my entities title="**Settings** > **Devices & services** > **Entities**" %} and select the entity from the list.
+2. In the top right corner, select the cog icon.
-## Customizing entities
+ 
-By default, all of your devices will be visible and have a default icon determined by their domain. You can customize the look and feel of your front page by altering some of these parameters. This can be done by overriding attributes of specific entities.
+3. Enter the new name or the new entity ID.
+ - For example, the entity ID here could be `light.bedroom_ligthstrip`.
+ - Do not change the domain of the entity - the part before the `.`.
-### Possible values
+ 
-{% configuration customize %}
-friendly_name:
- description: Name of the entity as displayed in the UI.
- required: false
- type: string
-entity_picture:
- description: URL to use as picture for entity.
- required: false
- type: string
-icon:
- description: "Any icon from [Material Design Icons](https://pictogrammers.com/library/mdi/). Prefix name with `mdi:`, ie `mdi:home`. Note: Newer icons may not yet be available in the current Home Assistant release."
- required: false
- type: string
-assumed_state:
- description: For switches with an assumed state two buttons are shown (turn off, turn on) instead of a switch. By setting `assumed_state` to `false` you will get the default switch icon.
- required: false
- type: boolean
- default: true
-device_class:
- description: Sets the class of the device, changing the device state and icon that is displayed on the UI (see below). It does not set the `unit_of_measurement`.
- required: false
- type: device_class
- default: None
-unit_of_measurement:
- description: Defines the units of measurement, if any. This will also influence the graphical presentation in the history visualization as continuous value. Sensors with missing `unit_of_measurement` are showing as discrete values.
- required: false
- type: string
- default: None
-initial_state:
- description: Sets the initial state for automations, `on` or `off`.
- required: false
- type: boolean
- default: None
-{% endconfiguration %}
+4. Select **Update**.
+5. If you have used this entity in automations and scripts, you need to rename the entity ID there, too.
+ - Go to {% my automations title="**Settings** > **Automations & Scenes**" %} open the respective tab and find your automation or script.
-### Device class
+ 
-Device class is currently supported by the following platforms:
-
-- [Binary sensor](/integrations/binary_sensor/)
-- [Button](/integrations/button/)
-- [Cover](/integrations/cover/)
-- [Humidifier](/integrations/humidifier/)
-- [Media player](/integrations/media_player/)
-- [Number](/integrations/number/)
-- [Sensor](/integrations/sensor/)
-- [Switch](/integrations/switch/)
-
-### Manual customization
-
-
-
-If you implement `customize`, `customize_domain`, or `customize_glob` you must make sure it is done inside of `homeassistant:` or it will fail.
-
-
-
-```yaml
-homeassistant:
- name: Home
- unit_system: metric
- # etc
-
- customize:
- # Add an entry for each entity that you want to overwrite.
- thermostat.family_room:
- entity_picture: https://example.com/images/nest.jpg
- friendly_name: Nest
- switch.wemo_switch_1:
- friendly_name: Toaster
- entity_picture: /local/toaster.jpg
- switch.wemo_switch_2:
- friendly_name: Kitchen kettle
- icon: mdi:kettle
- switch.rfxtrx_switch:
- assumed_state: false
- media_player.my_media_player:
- source_list:
- - Channel/input from my available sources
- # Customize all entities in a domain
- customize_domain:
- light:
- icon: mdi:home
- automation:
- initial_state: "on"
- # Customize entities matching a pattern
- customize_glob:
- "light.kitchen_*":
- icon: mdi:description
- "scene.month_*_colors":
- icon: mdi:other
-```
-
-### Reloading customize
-
-Home Assistant offers a service to reload the core configuration while Home Assistant is running. This allows you to change your customize section and see your changes being applied without having to restart Home Assistant.
-
-To reload customizations, navigate to Developer Tools > YAML and then press the "Reload Location & Customizations" button. If you don't see this, enable Advanced Mode on your user profile page first.
-
-You can also use the [Quick bar](/docs/tools/quick-bar/#command-palette), and choose "Reload Location & Customizations".
-
-Alternatively, you can reload via service call. Navigate to Developer Tools > Services tab, select `homeassistant.reload_core_config` from the dropdown and press the "Call Service" button.
-
-
-New customize information will be applied the next time the state of the entity gets updated.
-
+If your entity is not supported, or you cannot customize what you need via this method, you need to edit the settings in your [`configuration.yaml` file](/docs/configuration/). For a detailed description of the entity configuration variables and device class information, refer to the [Home Assistant Core integration documentation](/integrations/homeassistant/).
diff --git a/source/_docs/configuration/secrets.markdown b/source/_docs/configuration/secrets.markdown
index df67cfd84302..559f1ff4dc20 100644
--- a/source/_docs/configuration/secrets.markdown
+++ b/source/_docs/configuration/secrets.markdown
@@ -1,6 +1,11 @@
---
title: "Storing secrets"
description: "Storing secrets outside of your configuration.yaml."
+related:
+ - docs: /docs/configuration/
+ title: configuration.yaml file
+ - docs: /docs/configuration/splitting_configuration/
+ title: Splitting the configuration
---
The `configuration.yaml` file is a plain-text file, thus it is readable by anyone who has access to the file. The file contains passwords and API tokens which need to be redacted if you want to share your configuration. By using `!secret` you can remove any private information from your configuration files. This separation can also help you to keep easier track of your passwords and API keys, as they are all stored at one place and no longer spread across the `configuration.yaml` file or even multiple YAML files if you [split up your configuration](/docs/configuration/splitting_configuration/).
@@ -42,7 +47,7 @@ When you start splitting your configuration into multiple files, you might end u
- A `secrets.yaml` located in the same folder as the YAML file referencing the secret,
- next, parent folders will be searched for a `secrets.yaml` file with the secret, stopping at the folder with the main `configuration.yaml`.
-To see where secrets are being loaded from, you can either add an option to your `secrets.yaml` file or use the `check_config` script. The latter is only available for Home Assistant Core installations given it's available through [`hass`](/docs/tools/hass/).
+To see where secrets are being loaded from, you can either add an option to your `secrets.yaml` file or use the `check_config` script. The latter is only available for {% term "Home Assistant Core" %} installations given it's available through [`hass`](/docs/tools/hass/).
*Option 1*: Print where secrets are retrieved from to the Home Assistant log by adding the following to `secrets.yaml`:
diff --git a/source/_docs/configuration/splitting_configuration.markdown b/source/_docs/configuration/splitting_configuration.markdown
index 2f3e7bd30c10..c4f459b03dd6 100644
--- a/source/_docs/configuration/splitting_configuration.markdown
+++ b/source/_docs/configuration/splitting_configuration.markdown
@@ -1,17 +1,32 @@
---
title: "Splitting up the configuration"
description: "Splitting the configuration.yaml into several files."
+related:
+ - docs: /docs/configuration/
+ title: configuration.yaml file
+ - docs: /examples/#example-configurationyaml
+ title: Example configuration files by the community
+ - docs: /docs/configuration/packages
+ title: Using packages to organize configuration files
---
-So you've been using Home Assistant for a while now and your `configuration.yaml` file brings people to tears or you simply want to start off with the distributed approach, here's how to split the `configuration.yaml` into more manageable (read: humanly readable) pieces.
+So you've been using Home Assistant for a while now and your `configuration.yaml` file brings people to tears because it has become so large. Or, you simply want to start off with the distributed approach. Here's how to split the `configuration.yaml` into more manageable (read: human-readable) pieces.
-First off, several community members have sanitized (read: without API keys/passwords etc) versions of their configurations available for viewing, you can see a list of them [here](/examples/#example-configurationyaml).
+## Example configuration files for inspiration
-As commenting code doesn't always happen, please read on for the details.
+First off, several community members have sanitized (read: without API keys/passwords) versions of their configurations available for viewing. You can see a [list of example files here](/examples/#example-configurationyaml).
-Now despite the logical assumption that the `configuration.yaml` will be replaced by this process it will in fact remain, albeit in a much less cluttered form.
+As commenting code doesn't always happen, please read on to learn in detail how configuration files can be structured.
-In this lighter version we will still need what could be called the core snippet:
+## Analyzing the configuration files
+
+In this section, we are going use some example configuration files and look at their structure and format in more detail.
+
+Now you might think that the `configuration.yaml` will be replaced during the splitting process. However, it will in fact remain, albeit in a much less cluttered form.
+
+### The core configuration file
+
+In this lighter version, we will still need what could be called the core snippet:
```yaml
homeassistant:
@@ -27,9 +42,11 @@ homeassistant:
customize: !include customize.yaml
```
+### Indentation, includes, comments, and modularization
+
Note that each line after `homeassistant:` is indented two (2) spaces. Since the configuration files in Home Assistant are based on the YAML language, indentation and spacing are important. Also note that seemingly strange entry under `customize:`.
-`!include filename.yaml` is the statement that tells Home Assistant to insert the contents of `filename.yaml` at that point. This is how we are going to break a monolithic and hard to read file (when it gets big) into more manageable chunks.
+`!include customize.yaml` is the statement that tells Home Assistant to insert the parsed contents of `customize.yaml` at that point. The contents of the included file must be yaml data that is valid at the location it is included. This is how we are going to break a monolithic and hard to read file (when it gets big) into more manageable chunks.
Now before we start splitting out the different components, let's look at the other integrations (in our example) that will stay in the base file:
@@ -51,9 +68,20 @@ mqtt:
state_topic: "test/some_topic2"
```
-As with the core snippet, indentation makes a difference. The integration headers (`mqtt:`) should be fully left aligned (aka no indent), and the key (`sensor:`) should be indented two (2) spaces. The list `-` under the key `sensor` should be indented another two (2) spaces followed by a single space. The `mqtt` sensor list contains two (2) configurations containing two (2) keys each.
+As with the core snippet, indentation makes a difference:
+
+- The integration headers (`mqtt:`) should be fully left aligned (aka no indent).
+- The key (`sensor:`) should be indented two (2) spaces.
+- The list `-` under the key `sensor` should be indented another two (2) spaces followed by a single space.
+- The `mqtt` sensor list contains two (2) configurations, with two (2) keys each.
-While some of these integrations can technically be moved to a separate file they are so small or "one off's" where splitting them off is superfluous. Also, you'll notice the # symbol (hash/pound). This represents a "comment" as far as the commands are interpreted. Put another way, any line prefixed with a `#` will be ignored. This makes breaking up files for human readability really convenient, not to mention turning off features while leaving the entry intact.
+#### Comments
+
+The # symbol (hash/pound) represents a "comment" as far as the commands are interpreted. Put another way, any line prefixed with a `#` will be ignored by the software. It is for humans only. Comments allow breaking up files for readability, as well as turning off features while leaving the entry intact.
+
+#### Modularization and granularity
+
+While some of these integrations could technically be moved to a separate file, they are so small or "one off's" where splitting them off is superfluous.
Now, lets assume that a blank file has been created in the Home Assistant configuration directory for each of the following:
@@ -68,7 +96,7 @@ customize.yaml
`automation.yaml` will hold all the automation integration details. `zone.yaml` will hold the zone integration details and so forth. These files can be called anything but giving them names that match their function will make things easier to keep track of.
-Inside the base configuration file add the following entries:
+Inside the base configuration file, add the following entries:
```yaml
automation: !include automation.yaml
@@ -78,9 +106,15 @@ switch: !include switch.yaml
device_tracker: !include device_tracker.yaml
```
-Nesting `!include`s (having an `!include` within a file that is itself `!include`d) will also work.
+#### Include statements and packages to split files
+
+Nesting `!include` statements (having an `!include` within a file that is itself `!include`d) will also work.
+
+Some integrations support multiple top-level `!include` statements. This includes integrations defining an IoT domain. For example, `light`, `switch`, or `sensor`; as well as the `automation`, `script`, and `template` integrations, if you give a different label to each one.
+
+Configuration for other integrations can instead be split up by using packages. To learn more about packages, see the [Packages](/docs/configuration/packages) page.
-Some integrations support multiple top-level `!include`s, this includes integrations defining an IoT domain, e.g. `light`, `switch`, `sensor` as well as the `automation`, `script` and `template` integrations, if you give a different label to each one. Configuration for other integrations can instead be split up by using packages. To learn more about packages, see the [Packages](/docs/configuration/packages) page.
+#### Top level keys
Example of multiple top-level keys for the `light` platform.
@@ -189,11 +223,11 @@ learn more about packages, see the [Packages](/docs/configuration/packages) page
That about wraps it up.
-If you have issues checkout `home-assistant.log` in the configuration directory as well as your indentations. If all else fails, head over to our [Discord chat server][discord] and ask away.
+If you have issues, checkout `home-assistant.log` in the configuration directory as well as your indentations. If all else fails, head over to our [Discord chat server][discord] and ask away.
## Debugging configuration files
-If you have many configuration files, Home Assistant provides a CLI that allows you to see how it interprets them, each installation type has its own section in the common-tasks about this:
+If you have many configuration files, Home Assistant provides a CLI that allows you to see how it interprets them. Each installation type has its own section in the common-tasks about this:
- [Operating System](/common-tasks/os/#configuration-check)
- [Container](/common-tasks/container/#configuration-check)
diff --git a/source/_docs/configuration/state_object.markdown b/source/_docs/configuration/state_object.markdown
index 0b33f6bf7cb5..4736c0da719d 100644
--- a/source/_docs/configuration/state_object.markdown
+++ b/source/_docs/configuration/state_object.markdown
@@ -16,8 +16,9 @@ All states will always have an entity id, a state and a timestamp when last upda
| `state.domain` | Domain of the entity. Example: `light`. |
| `state.object_id` | Object ID of entity. Example: `kitchen`. |
| `state.name` | Name of the entity. Based on `friendly_name` attribute with fall back to object ID. Example: `Kitchen Ceiling`. |
-| `state.last_updated` | Time the state was written to the state machine in UTC time. Note that writing the exact same state including attributes will not result in this field being updated. Example: `2017-10-28 08:13:36.715874+00:00`. |
-| `state.last_changed` | Time the state changed in the state machine in UTC time. This is not updated when there are only updated attributes. Example: `2017-10-28 08:13:36.715874+00:00`. |
+| `state.last_changed` | Time the state changed in the state machine in UTC time. This is not updated if only state attributes change. Example: `2017-10-28 08:13:36.715874+00:00`. |
+| `state.last_reported`| Time the state was written to the state machine in UTC time. This timestamp is updated regardless of any change to the state or a state attribute. Example: `2017-10-28 08:13:36.715874+00:00`. |
+| `state.last_updated` | Time the state or state attributes changed in the state machine in UTC time. This is not updated if neither state nor state attributes changed. Example: `2017-10-28 08:13:36.715874+00:00`. |
| `state.attributes` | A dictionary with extra attributes related to the current state. |
| `state.context` | A dictionary with extra attributes related to the context of the state. |
@@ -41,8 +42,8 @@ When an attribute contains spaces, you can retrieve it like this: `state_attr('s
Context is used to tie {% term events %} and {% term states %} together in Home Assistant. Whenever an {% term automation %} or user interaction causes states to change, a new context is assigned. This context will be attached to all events and states that happen as result of the change.
-| Field | Description |
-| ----- | ------------------------------------------------------------------- |
-| context_id | Unique identifier for the context. |
-| user_id | Unique identifier of the user that started the change. Will be `None` if action was not started by a user (ie. started by an automation) |
-| parent_id | Unique identifier of the parent context that started the change, if available. For example, if an automation is triggered, the context of the trigger will be set as parent. |
+| Field | Description |
+| ------------ | ------------------------------------------------------------------- |
+| `context_id` | Unique identifier for the context. |
+| `user_id` | Unique identifier of the user that started the change. Will be `None` if the action was not started by a user (for example, started by an automation). |
+| `parent_id` | Unique identifier of the parent context that started the change, if available. For example, if an automation is triggered, the context of the trigger will be set as parent. |
diff --git a/source/_docs/configuration/templating.markdown b/source/_docs/configuration/templating.markdown
index 791294ae44b2..099bb0b4ac3c 100644
--- a/source/_docs/configuration/templating.markdown
+++ b/source/_docs/configuration/templating.markdown
@@ -325,6 +325,32 @@ List of lights that are on with a brightness of 255:
{% endraw %}
+
+### State translated
+
+Not supported in [limited templates](#limited-templates).
+
+The `state_translated` function returns a translated state of an entity using a language that is currently configured in the [general settings](https://my.home-assistant.io/redirect/general/).
+
+#### State translated examples
+
+{% raw %}
+
+```text
+{{ states("sun.sun") }} # below_horizon
+{{ state_translated("sun.sun") }} # Below horizon
+{{ "sun.sun" | state_translated }} # Below horizon
+```
+
+```text
+{{ states("binary_sensor.movement_backyard") }} # on
+{{ state_translated("binary_sensor.movement_backyard") }} # Detected
+{{ "binary_sensor.movement_backyard" | state_translated }} # Detected
+```
+
+{% endraw %}
+
+
### Working with groups
Not supported in [limited templates](#limited-templates).
@@ -432,6 +458,51 @@ The same thing can also be expressed as a test:
{% endraw %}
+### Floors
+
+- `floors()` returns the full list of floor IDs.
+- `floor_id(lookup_value)` returns the floor ID for a given device ID, entity ID, area ID, or area name. Can also be used as a filter.
+- `floor_name(lookup_value)` returns the floor name for a given device ID, entity ID, area ID, or floor ID. Can also be used as a filter.
+- `floor_areas(floor_name_or_id)` returns the list of area IDs tied to a given floor ID or name. Can also be used as a filter.
+
+#### Floors examples
+
+{% raw %}
+
+```text
+{{ floors() }} # ['floor_id']
+```
+
+```text
+{{ floor_id('First floor') }} # 'first_floor'
+```
+
+```text
+{{ floor_id('my_device_id') }} # 'second_floor'
+```
+
+```text
+{{ floor_id('sensor.sony') }} # 'first_floor'
+```
+
+```text
+{{ floor_name('first_floor') }} # 'First floor'
+```
+
+```text
+{{ floor_name('my_device_id') }} # 'Second floor'
+```
+
+```text
+{{ floor_name('sensor.sony') }} # 'First floor'
+```
+
+```text
+{{ floor_areas('first_floor') }} # ['living_room', 'kitchen']
+```
+
+{% endraw %}
+
### Areas
- `areas()` returns the full list of area IDs
@@ -482,10 +553,12 @@ The same thing can also be expressed as a test:
{% endraw %}
-### Integrations
+### Entities for an integration
- `integration_entities(integration)` returns a list of entities that are associated with a given integration, such as `hue` or `zwave_js`.
-- `integration_entities(title)` if you have multiple instances set-up for an integration, you can also use the title you've set for the integration in case you only want to target a specific device bridge.
+- `integration_entities(config_entry_title)` if you have multiple entries set-up for an integration, you can also use the title you've set for the integration in case you only want to target a specific entry.
+
+If there is more than one entry with the same title, the entities for all the matching entries will be returned, even if the entries are for different integrations. It's not possible to search for entities of an untitled integration.
#### Integrations examples
@@ -501,6 +574,78 @@ The same thing can also be expressed as a test:
{% endraw %}
+### Labels
+
+- `labels()` returns the full list of label IDs, or those for a given area ID, device ID, or entity ID.
+- `label_id(lookup_value)` returns the label ID for a given label name.
+- `label_name(lookup_value)` returns the label name for a given label ID.
+- `label_areas(label_name_or_id)` returns the list of area IDs tied to a given label ID or name.
+- `label_devices(label_name_or_id)` returns the list of device IDs tied to a given label ID or name.
+- `label_entities(label_name_or_id)` returns the list of entity IDs tied to a given label ID or name.
+
+Each of the label template functions can also be used as a filter.
+
+#### Labels examples
+
+{% raw %}
+
+```text
+{{ labels() }} # ['christmas_decorations', 'energy_saver', 'security']
+```
+
+```text
+{{ labels("living_room") }} # ['christmas_decorations', 'energy_saver']
+```
+
+```text
+{{ labels("my_device_id") }} # ['security']
+```
+
+```text
+{{ labels("light.christmas_tree") }} # ['christmas_decorations']
+```
+
+```text
+{{ label_id('Energy saver') }} # 'energy_saver'
+```
+
+```text
+{{ label_name('energy_saver') }} # 'Energy saver'
+```
+
+```text
+{{ label_areas('security') }} # ['driveway', 'garden', 'porch']
+```
+
+```text
+{{ label_devices('energy_saver') }} # ['deadbeefdeadbeefdeadbeefdeadbeef']
+```
+
+```text
+{{ label_entities('security') }} # ['camera.driveway', 'binary_sensor.motion_garden', 'camera.porch']
+```
+
+{% endraw %}
+
+### Issues
+
+- `issues()` returns all open issues as a mapping of (domain, issue_id) tuples to the issue object.
+- `issue(domain, issue_id)` returns a specific issue for the provided domain and issue_id.
+
+#### Issues examples
+
+{% raw %}
+
+```text
+{{ issues() }} # { ("homeassistant", "deprecated_yaml_ping"): {...}, ("cloud", "legacy_subscription"): {...} }
+```
+
+```text
+{{ issue('homeassistant', 'python_version') }} # {"breaks_in_ha_version": "2024.4", "domain": "homeassistant", "issue_id": "python_version", "is_persistent": False, ...}
+```
+
+{% endraw %}
+
### Immediate if (iif)
A common case is to conditionally return a value based on another value.
@@ -587,12 +732,16 @@ For example, if you wanted to select a field from `trigger` in an automation bas
{% endraw %}
-- `as_datetime()` converts a string containing a timestamp, or valid UNIX timestamp, to a datetime object.
+- `as_datetime(value, default)` converts a string containing a timestamp, or valid UNIX timestamp, to a datetime object. If that fails, it returns the `default` value or, if omitted, raises an error. When the input is already a datetime object it will be returned as is. in case the input is a datetime.date object, midnight will be added as time. This function can also be used as a filter.
- `as_timestamp(value, default)` converts datetime object or string to UNIX timestamp. If that fails, returns the `default` value, or if omitted raises an error. This function can also be used as a filter.
- `as_local()` converts datetime object to local time. This function can also be used as a filter.
- `strptime(string, format, default)` parses a string based on a [format](https://docs.python.org/3.10/library/datetime.html#strftime-and-strptime-behavior) and returns a datetime object. If that fails, it returns the `default` value or, if omitted, raises an error.
-- `relative_time` converts datetime object to its human-friendly "age" string. The age can be in second, minute, hour, day, month or year (but only the biggest unit is considered, e.g., if it's 2 days and 3 hours, "2 days" will be returned). Note that it only works for dates _in the past_.
- - Using `relative_time()` will cause templates to be refreshed at the start of every new minute.
+- `time_since(datetime, precision)` converts a datetime object into its human-readable time string. The time string can be in seconds, minutes, hours, days, months, and years. `precision` takes an integer (full number) and indicates the number of units returned. The last unit is rounded. For example: `precision = 1` could return "2 years" while `precision = 2` could return "1 year 11 months". This function can also be used as a filter.
+If the datetime is in the future, returns 0 seconds.
+A precision of 0 returns all available units, default is 1.
+- `time_until(datetime, precision)` converts a datetime object into a human-readable time string. The time string can be in seconds, minutes, hours, days, months, and years. `precision` takes an integer (full number) and indicates the number of units returned. The last unit is rounded. For example: `precision = 1` could return "2 years" while `precision = 2` could return "1 year 11 months". This function can also be used as a filter.
+If the datetime is in the past, returns 0 seconds.
+A precision of 0 returns all available units, default is 1.
- `timedelta` returns a timedelta object and accepts the same arguments as the Python `datetime.timedelta` function -- days, seconds, microseconds, milliseconds, minutes, hours, weeks.
{% raw %}
@@ -905,6 +1054,8 @@ The numeric functions and filters raise an error if the input is not a valid num
- `max([x, y, ...])` will obtain the largest item in a sequence. Uses the same parameters as the built-in [max](https://jinja.palletsprojects.com/en/latest/templates/#jinja-filters.max) filter.
- `min([x, y, ...])` will obtain the smallest item in a sequence. Uses the same parameters as the built-in [min](https://jinja.palletsprojects.com/en/latest/templates/#jinja-filters.min) filter.
- `average([x, y, ...], default)` will return the average value of the sequence. If list is empty or contains non-numeric value, returns the `default` value, or if omitted raises an error. Can be used as a filter.
+- `median([x, y, ...], default)` will return the median value of the sequence. If list is empty or contains non-numeric value, returns the `default` value, or if omitted raises an error. Can be used as a filter.
+- `statistical_mode([x, y, ...], default)` will return the statistical mode value (most frequent occurrence) of the sequence. If the list is empty, it returns the `default` value, or if omitted raises an error. It can be used as a filter.
- `e` mathematical constant, approximately 2.71828.
- `pi` mathematical constant, approximately 3.14159.
- `tau` mathematical constant, approximately 6.28318.
@@ -914,6 +1065,7 @@ The numeric functions and filters raise an error if the input is not a valid num
- `round(1, "half", default)` will always round to the nearest .5 value. `precision` should be 1 for this mode
- Filter `value_one|bitwise_and(value_two)` perform a bitwise and(&) operation with two values.
- Filter `value_one|bitwise_or(value_two)` perform a bitwise or(\|) operation with two values.
+- Filter `value_one|bitwise_xor(value_two)` perform a bitwise xor(\^) operation with two values.
- Filter `ord` will return for a string of length one an integer representing the Unicode code point of the character when the argument is a Unicode object, or the value of the byte when the argument is an 8-bit string.
### Complex type checking
diff --git a/source/_docs/configuration/troubleshooting.markdown b/source/_docs/configuration/troubleshooting.markdown
index 1033a4859bc9..327d8a8b62e5 100644
--- a/source/_docs/configuration/troubleshooting.markdown
+++ b/source/_docs/configuration/troubleshooting.markdown
@@ -123,3 +123,14 @@ After you download logs, you will also want to download the diagnostics for the
Example of Download Diagnostics.
+
+### Handling unexpected restarts or crashes
+
+Suppose you find that Home Assistant unexpectedly restarts or crashes; it's likely that you have a misbehaving integration impacting system stability. Home Assistant has a built-in debug option that can help find implementation errors. It can also block many unsafe thread operations from crashing the system. Enabling debug has a slight performance impact on the system and is not recommended for long-term use. To enable debug, add the following to your `configuration.yaml`:
+
+```yaml
+homeassistant:
+ debug: true
+```
+
+Once debug is enabled, periodically check [Home Assistant System Logs](https://my.home-assistant.io/redirect/logs) for new messages.
\ No newline at end of file
diff --git a/source/_docs/configuration/yaml.markdown b/source/_docs/configuration/yaml.markdown
index d3f2adda2262..bbc31bf9c0cc 100644
--- a/source/_docs/configuration/yaml.markdown
+++ b/source/_docs/configuration/yaml.markdown
@@ -1,13 +1,30 @@
---
-title: "YAML"
-description: "Details about YAML to configure Home Assistant."
+title: "YAML syntax"
+description: "Details about the YAML syntax used to configure Home Assistant."
+related:
+ - docs: /docs/configuration/
+ title: configuration.yaml file
+ - docs: /docs/configuration/secrets/
+ title: Storing private data in separate file
+ - docs: /docs/automation/yaml/
+ title: Automation.yaml
+ - docs: /docs/configuration/troubleshooting/
+ title: Troubleshooting the configuration files
+ - docs: /docs/configuration/#validating-the-configuration
+ title: Validating the configuration
+ - url: https://developers.home-assistant.io/docs/documenting/yaml-style-guide/
+ title: YAML Style Guide for Home Assistant developers
---
-Home Assistant uses the [YAML](https://yaml.org/) syntax for configuration. YAML might take a while to get used to but is really powerful in allowing you to express complex configurations.
+Home Assistant uses the [YAML](https://yaml.org/) syntax for configuration. While most integrations can be configured through the UI, some integrations require you to edit your [`configuration.yaml`](/docs/configuration/) file to specify its settings.
-While more and more integrations are configured through the UI, for some, you will add code in your [`configuration.yaml`](/docs/configuration/) file to specify its settings.
+## YAML Style Guide
-The following example entry assumes that you would like to set up the [notify integration](/integrations/notify) with the [pushbullet platform](/integrations/pushbullet).
+This page gives a high-level introduction to the YAML syntax used in Home Assistant. For a more detailed description and more examples, refer to the [YAML Style Guide for Home Assistant developers](https://developers.home-assistant.io/docs/documenting/yaml-style-guide/).
+
+## A first example
+
+The following YAML example entry assumes that you would like to set up the [notify integration](/integrations/notify) with the [pushbullet platform](/integrations/pushbullet).
```yaml
notify:
@@ -21,22 +38,20 @@ notify:
The basics of YAML syntax are block collections and mappings containing key-value pairs. Each item in a collection starts with a `-` while mappings have the format `key: value`. This is somewhat similar to a Hash table or more specifically a dictionary in Python. These can be nested as well. **Beware that if you specify duplicate keys, the last value for a key is used**.
-Note that indentation is an important part of specifying relationships using YAML. Things that are indented are nested "inside" things that are one level higher. So in the above example, `platform: pushbullet` is a property of (nested inside) the `notify` integration.
+## Indentation in YAML
-Getting the right indentation can be tricky if you're not using an editor with a fixed width font. Tabs are not allowed to be used for indentation. Convention is to use 2 spaces for each level of indentation.
+In YAML, indentation is important for specifying relationships. Indented lines are nested inside lines that are one level higher. In the above example, `platform: pushbullet` is a property of (nested inside) the `notify` integration.
-You can use the online service [YAML Validator](https://codebeautify.org/yaml-validator/) to check if your YAML syntax is correct before loading it into Home Assistant which will save you some time. If you do so, be aware that this is a third-party service and is not maintained by the Home Assistant community.
+Getting the right indentation can be tricky if you're not using an editor with a fixed-width font. Tabs are not allowed to be used for indentation. The convention is to use 2 spaces for each level of indentation.
-
+## Comments
-Please pay attention to not storing private data (passwords, API keys, etc.) directly in your `configuration.yaml` file. Private data can be stored in either a [separate file](/docs/configuration/secrets/) or in [environmental variables](/docs/configuration/yaml/#using-environment-variables), which circumvents this security problem.
+Strings of text following a `#` are comments. They are ignored by the system. Comments explain in plain language what a particular code block is supposed to do. For future-you or someone else looking at the file.
-
-
-Strings of text following a `#` are comments and are ignored by the system.
+### Example with comment and nesting
The next example shows an [input_select](/integrations/input_select) integration that uses a block collection for the values of options.
-The other properties (like `name:`) are specified using mappings. Note that the second line just has `threat:` with no value on the same line. Here threat is the name of the input_select and the values for it are everything nested below it.
+The other properties (like `name:`) are specified using mappings. Note that the second line just has `threat:` with no value on the same line. Here, `threat` is the name of the input_select. The values for it are everything nested below it.
```yaml
input_select:
@@ -51,6 +66,8 @@ input_select:
initial: 0
```
+### Example of nested mapping
+
The following example shows nesting a collection of mappings in a mapping. In Home Assistant, this would create two sensors that each use the MQTT platform but have different values for their `state_topic` (one of the properties used for MQTT sensors).
```yaml
@@ -65,8 +82,8 @@ sensor:
### Environment variables
-On Home Assistant Core installations, you can include values from your system's environment variables with `!env_var`.
-Note that this will only work for Home Assistant Core installations, in a scenario where it is possible to specify these.
+On {% term "Home Assistant Core" %} installations, you can include values from your system's environment variables with `!env_var`.
+Note that this will only work for {% term "Home Assistant Core" %} installations, in a scenario where it is possible to specify these.
Regular Home Assistant users are recommended to use `!include` statements instead.
```yaml
@@ -76,7 +93,7 @@ example:
#### Default value
-If an environment variable is not set, you can fallback to a default value.
+If an environment variable is not set, you can fall back to a default value.
```yaml
example:
@@ -120,3 +137,9 @@ Not quoting the value may generate an error such as:
```txt
not a valid value for dictionary value @ data
```
+
+## Validating YAML syntax
+
+With all these indents and rules, it is easy to make a mistake. The best way to check if your YAML syntax is correct (validate) depends on the editor you use. We can't list them all here.
+
+- If you edit the files directly in Home Assistant, refer to the section: [Validating the configuration](/docs/configuration/#validating-the-configuration)
diff --git a/source/_docs/energy/faq.markdown b/source/_docs/energy/faq.markdown
index 25fce51be539..2cefbaf96ad4 100644
--- a/source/_docs/energy/faq.markdown
+++ b/source/_docs/energy/faq.markdown
@@ -15,7 +15,7 @@ Think of this in a parallel to speed and distance: Power is the speed you are go
Therefore Energy (kiloWatt-hour) is not an average of the Power you are consuming over a given period of time (the unit of the average power would be Watt or kiloWatt again). Energy is the integral (mathematical operation) of the Power function.
-This difference is very important as you need to use the proper entities in our Energy Panel.
+This difference is very important as you need to use the proper entities in our Energy dashboard.
## Creating an Energy Sensor out of a Power Sensor
@@ -29,9 +29,9 @@ If you are using a 3rd party device (e.g. not reading directly from your utility
To accomplish such, you can use the [utility_meter integration](/integrations/utility_meter/). With this integration, you define as many tariffs as required (in accordance with your utility provider contract) and HA will be able to differentiate energy consumptions in each of the tariffs. Please note that each utility provider has its own time schedules for peak and off-peak and you are required to create an automation that switches the utility_meter entity from one tariff to the other.
-## The energy panel is not visible
+## The energy dashboard is not visible
-If you do not see the Energy panel in the sidebar, make sure you have not removed [`default_config:`](/integrations/default_config/) from your `configuration.yaml`. If you have, you will need to add the `energy:` integration manually.
+If you do not see the Energy dashboard in the sidebar, make sure you have not removed [`default_config:`](/integrations/default_config/) from your `configuration.yaml`. If you have, you will need to add the `energy:` integration manually.
## Troubleshooting missing entities
diff --git a/source/_docs/energy/gas.markdown b/source/_docs/energy/gas.markdown
index ae0f109e8345..ec9b6ebbf106 100644
--- a/source/_docs/energy/gas.markdown
+++ b/source/_docs/energy/gas.markdown
@@ -31,4 +31,4 @@ We have worked with creator [Marcel Zuidwijk](https://www.zuidwijk.com) to devel
#### Read the Gas Meter using a magnetometer
-[Diaphragm gas meters](https://en.wikipedia.org/wiki/Gas_meter#Diaphragm/bellows_meters) are the most common type of gas meter, and their movement can frequently be observed with a magnetometer. The [QMC5883L](https://esphome.io/components/sensor/qmc5883l.html) is a common and inexpensive option that ESPHome supports. Many posts on the forums of users having luck with this method, such as [this one](https://community.home-assistant.io/t/water-gas-meter-monitoring-via-magnetometer-sine-wave-to-pulse-issue/245904).
+[Diaphragm/bellows gas meters](https://en.wikipedia.org/wiki/Gas_meter#Diaphragm/bellows_meters) are the most common type of gas meter, seen in almost all residential installations, and their movement can frequently be observed with a magnetometer. The [QMC5883L](https://esphome.io/components/sensor/qmc5883l.html) is a common and inexpensive option that ESPHome supports. A project that makes it easy to use this magnetometer and calibrate it is [this water-gas-meter project on GitHub](https://github.com/tronikos/esphome-magnetometer-water-gas-meter).
diff --git a/source/_docs/energy/individual-devices.markdown b/source/_docs/energy/individual-devices.markdown
index 6e17a2516a54..ec6222a18c22 100644
--- a/source/_docs/energy/individual-devices.markdown
+++ b/source/_docs/energy/individual-devices.markdown
@@ -19,6 +19,6 @@ Smart relays sit behind your "normal" switches and make them smart. It allows yo
## Devices with power (W) sensors
-Some smart devices, such as air conditioning, boilers, and others, may provide a power sensor, measured in Watts. You can use the [Integration (Riemann sum integral) integration](/integrations/integration/#energy) to calculate the energy your device is using. You can then use the energy sensor in the Energy Dashboard, as individual devices.
+Some smart devices, such as air conditioning, boilers, and others, may provide a power sensor, measured in Watts. You can use the [Integration (Riemann sum integral) integration](/integrations/integration/#energy) to calculate the energy your device is using. You can then use the energy sensor in the Energy Dashboard, as individual devices. For information on setting up an entity for use in the **Energy** dashboard, refer to the [energy FAQ](/docs/energy/faq/#troubleshooting-missing-entities).
diff --git a/source/_docs/energy/water.markdown b/source/_docs/energy/water.markdown
index 496f83b70b41..a37d5ab79144 100644
--- a/source/_docs/energy/water.markdown
+++ b/source/_docs/energy/water.markdown
@@ -5,32 +5,66 @@ description: "Learn how to add information about your water usage to Home Assist
Home Assistant allows you to track your water usage in the home energy management too.
-Although water is not strictly "energy", it is still a valuable resource to track and monitor as it is often tightly coupled with energy usage (like gas). Additionally, it can help you reduce your ecological footprint by using less water.
+Although water usage is not strictly "energy", it is still a valuable resource to track and monitor as it is often tightly coupled with energy usage (like gas). Additionally, it can help you reduce your ecological footprint by using less water.
-## Hardware
+### Home water meters
-Home Assistant will need to know the amount of water that is being consumed in order to be able to track it. Several hardware options are available to do this.
+There are several ways to measure water usage in your home. Multiple methods exist for reading your water usage. Older water meters typically feature a common arrow or only display total consumption. For these meters, you may require an [AI-on-the-edge-device](https://github.com/jomjol/AI-on-the-edge-device) with an ESP32 camera. While effective, this solution can be tedious to set up as it leans towards a DIY approach.
+
+Newer water meters are equipped with a rotary disk that can be read using two methods. The first method utilizes light sensors, while the second method employs proximity sensors. The proximity sensor detects changes in the magnetic field, with each rotation of the disk representing one liter of water used. Meanwhile, the light sensor method operates on an autocorrelation technique, providing accuracy down to 100 milliliters instead of the traditional one-liter step.
+
+For most water meters, the rotary encoder disk suffices the light sensor version. However, some older or specialized meters may necessitate the use of a proximity meter instead.
+
+Home Assistant also has integrations build into the platform that connect with existing products
+
+## Home Assistant integrations
+
+Home Assistant will need to know the amount of water that is being consumed to be able to track usage. Several [water metering (fluid flow rate sensor device)](https://en.wikipedia.org/wiki/Water_metering) hardware options are available to do this. Depending on your setup, the required hardware is provided by your public water utility company, or you may need to buy your own.
+
+Some hardware with water meters may also provide additional practical functions or sensors, such as [valve](/integrations/valve), for example, for controlling water shutoff, or temperature and pressure (to enable freeze alarms).
We have the following integrations available for existing products that can provide information about water usage:
- [Flo](/integrations/flo)
- [Flume](/integrations/flume)
- [HomeWizard Energy](/integrations/homewizard)
+- [StreamLabs](/integrations/streamlabswater)
+- [Suez Water](/integrations/suez_water)
+
+There are also products for water usage monitoring that are based on existing common IoT protocol standards:
+
+- [Z-Wave](/integrations/zwave_js)
+- [Zigbee](/integrations/zha)
+- [Matter (BETA)](/integrations/matter)
+
+
+## Community-made sensors
+
+If your water meter lacks a rotary disk, magnetic disk, or coil. There are alternative solutions available to seamlessly integrate water monitoring into your smart home setup:
+
+- [AI-on-the-edge-device](https://github.com/jomjol/AI-on-the-edge-device) is a project running on an ESP32-CAM and can be fully integrated into Home Assistant using the Home Assistant Discovery Functionality of MQTT. It digitalizes your gas/water/electricity meter display and provides its data in various ways., `Gallons Per Minute` (gal/min), and `Gallons to Recharge` (gal):
+
+- [cullAssistant](https://github.com/LelandSindt/cullAssistant) (ESPHome)
-Alternatively, the following shops sell ESPHome-based devices, that use a proximity sensor to detect a rotating magnet in your water meter and use that pulse to count each liter of water used.
+Alternatively, the following shops sell ESPHome-based devices that use a 3-phase light sensor to detect a rotating disk in your water meter and convert this to the amount of water used in milliliters (ml):
+- [Muino water meter reader](https://watermeter.muino.nl/) (ESPHome)
-- [S0tool](https://huizebruin.github.io/s0tool/) ("Made for ESPHome" approved)
+Alternatively, the following shops sell ESPHome-based devices, that use a proximity sensor to detect a rotating magnet in your water meter and use that pulse to count each liter of water used:
+- [S0tool](https://s0tool.nl/) ("Made for ESPHome" approved)
- [Waterlezer dongle](https://smart-stuff.nl/product/esphome-waterlezer-dongle/) (Dutch)
- [Slimme Watermeter Gateway](https://smartgateways.nl/product/slimme-watermeter-gateway/) (Dutch)
- [watermeterkit.nl](https://watermeterkit.nl/) (Dutch)
-Alternatively, the following shops sell ESPHome-based devices that use a 3-phase light sensor to detect a rotating disk in your water meter and convert this to the amount of water used in milliliters (ml).
-- [Muino water meter reader](https://watermeter.muino.nl/)
+## DIY
Maybe you like to build one yourself?
- - Pieter Brinkman has quite a [nice blog article on how to create your own water sensor](https://www.pieterbrinkman.com/2022/02/02/build-a-cheap-water-usage-sensor-using-esphome-home-assistant-and-a-proximity-sensor/) using ESPHome, or [build a water meter](https://www.ztatz.nl/p1-monitor-watermeter/) that works with the [P1 Monitor](/integrations/p1_monitor) integration.
- - [AI-on-the-edge-device](https://github.com/jomjol/AI-on-the-edge-device) is a project running on an ESP32-CAM and can be fully integrated into Home Assistant using the Home Assistant Discovery Functionality of MQTT. It digitalizes your gas/water/electricity meter display and provides its data in various ways.
- - [watermeter](https://github.com/nohn/watermeter) running classic OCR and statistical pattern recognition on any system supporting Docker
+- Pieter Brinkman has quite a [nice blog article on how to create your own water sensor](https://www.pieterbrinkman.com/2022/02/02/build-a-cheap-water-usage-sensor-using-esphome-home-assistant-and-a-proximity-sensor/) using ESPHome, or [build a water meter](https://www.ztatz.nl/p1-monitor-watermeter/) that works with the [P1 Monitor](/integrations/p1_monitor) integration.
+- [AI-on-the-edge-device](https://github.com/jomjol/AI-on-the-edge-device) is a project running on an ESP32-CAM and can be fully integrated into Home Assistant using the Home Assistant Discovery Functionality of MQTT. It digitalizes your gas/water/electricity meter display and provides its data in various ways.
+- [watermeter](https://github.com/nohn/watermeter) running classic OCR and statistical pattern recognition on any system supporting Docker
+- [Muino water meter reader 3-phase](https://muino.nl/product/3-phase-muino-light-sensor-encoder/) Using the 3-phase sensor technique, a battery-powered version can be possible with this sensor.
+- [Read water meter with magnetometer](https://github.com/tronikos/esphome-magnetometer-water-gas-meter) using [QMC5883L](https://esphome.io/components/sensor/qmc5883l.html), a common and inexpensive magnetometer. This should be compatible with all the water meters the Flume water sensor is compatible with, which is [compatible](https://help.flumewater.com/en/articles/1618594-is-the-flume-device-compatible-with-all-water-meters) with about 95% of water meters in the United States.
If you manually integrate your sensors, for example, using the [MQTT](/integrations/mqtt) or [RESTful](/integrations/rest) integrations: Make sure you set and provide the `device_class`, `state_class`, and `unit_of_measurement` for those sensors.
diff --git a/source/_docs/frontend/browsers.markdown b/source/_docs/frontend/browsers.markdown
deleted file mode 100644
index 18afa58b9606..000000000000
--- a/source/_docs/frontend/browsers.markdown
+++ /dev/null
@@ -1,93 +0,0 @@
----
-title: "Browsers"
-description: "Browser compatibility list"
----
-
-Home Assistant requires a web browser to show the frontend and supports all major modern browsers. We don't test the web interface against all available browsers but this page tracks different browsers on various operating systems and should help you to pick a browser which works. The "Release" column contains the release number which was tested. This doesn't mean that older or newer releases will not work.
-
-If a browser is listed as working but you are still having problems, it is possible that some add-on or extension may be the problem. Some add-ons or extension are known to cause issue with the frontend, but it's not possible to test them all.
-
-If you are having issues with the frontend displaying correctly, you should disable all your add-ons or extensions and enable them one at a time. At last but not least, consider restarting your browser.
-
-We would appreciate if you help to keep this page up-to-date and add feedback.
-
-## Microsoft Windows
-
-| Browser | Release | State | Comments |
-| :------------------------ |:---------------|:-----------|:-------------------------|
-| Internet Explorer ([IE]) | 11 | Not supported | Does not support promises. |
-| Microsoft [Edge] | deli. Win 10 | works | Streaming updates not working. |
-| [Chrome] | 61.0.3163.100 | works | |
-| [Firefox] | 62.0.3 | works | |
-| [Iridium] | 48.2 | works | |
-| [Opera] | 42.0.2393.351 | works | |
-
-## macOS
-
-| Browser | Release | State | Comments |
-| :-------------------- |:---------------|:-----------|:-------------------------|
-| [Safari] | | works | Not working with Safari Technology Preview 112 beta |
-
-## Linux
-
-| Browser | Release | State | Comments |
-| :-------------------- |:---------------|:-----------|:-------------------------|
-| [Firefox] | 62.0 | works | |
-| [Midori] | 0.5.11 | works | |
-| [Chromium] | 69.0.3497.81 | works | |
-| [Conkeror] | 1.0.2 | works | |
-| [Tor Browser] | 7.0.8 | works | |
-| [Konqueror] | | unknown | |
-| [Uzbl] | 0.9.0 | works | |
-| [Opera] | 42.0.2393.351 | works | |
-| [Lynx] | 2.12 | fails | loads empty page |
-| [elinks] | | fails | page with manifest and import |
-| [w3m] | 0.5.3 | fails | display the icon shown while loading HA |
-| [Epiphany] | 3.18.5 | works | |
-| [surf] | 0.7 | works | |
-| [Chrome] | 71.0.3578.98 | works | |
-| [Waterfox] | 56.2.6 | fails | |
-
-## Android
-
-| Browser | Release | State | Comments |
-| :-------------------- |:---------------|:-----------|:-------------------------|
-| [Chrome] | 50.0.2661.89 | works | Can also be added to desktop |
-| [Firefox] | 46.0.1 | works | Can also be added to desktop |
-| [Opera] | 42.0.2246.112628 | works | Can also be added to desktop |
-
-## iOS
-
-| Browser | Release | State | Comments |
-| :-------------------- |:---------------|:-----------|:-------------------------|
-| [Safari] | | works | Can also be added to desktop. Not working in iOS 14 beta 5. |
-| [Chrome] | | works | Not working in iOS 14 beta 5. |
-
-There are reports that devices running with iOS prior to iOS 10, especially old iPads, are having trouble. Devices running iOS 14 beta 5, you will not be able to interact with Home Assistant controls.
-
-## webOS
-
-| Browser | Release | State | Comments |
-| :-------------------- |:---------------|:-----------|:-------------------------|
-| [LG webOS TV Built-in]| webOS 04.80.03 | works | including magic remote |
-
-[Chrome]: https://www.google.com/chrome/
-[Chromium]: https://www.chromium.org/
-[Conkeror]: http://conkeror.org/
-[Edge]: https://www.microsoft.com/en-us/edge
-[elinks]: http://elinks.or.cz/
-[Epiphany]: https://wiki.gnome.org/Apps/Web
-[Firefox]: https://www.mozilla.org/en-US/firefox/
-[IE]: https://support.microsoft.com/en-us/help/17621/internet-explorer-downloads
-[Iridium]: https://iridiumbrowser.de/
-[Konqueror]: https://konqueror.org/
-[Lynx]: https://lynx.browser.org/
-[Midori]: https://astian.org/en/midori-browser/
-[Opera]: https://www.opera.com/
-[Safari]: https://www.apple.com/safari/
-[surf]: https://surf.suckless.org/
-[Tor Browser]: https://www.torproject.org/
-[Uzbl]: https://www.uzbl.org/
-[w3m]: https://w3m.sourceforge.net/
-[Waterfox]: https://www.waterfox.net
-[LG webOS TV Built-In]: https://www.lg.com/uk/support/help-library/details-on-enjoying-internet-browsing-on-your-lg-webos-tv-CT00008334-1435838149474
diff --git a/source/_docs/locked_out.md b/source/_docs/locked_out.md
index 37cedcf4adc1..d8935e29b31c 100644
--- a/source/_docs/locked_out.md
+++ b/source/_docs/locked_out.md
@@ -1,41 +1,68 @@
---
title: "I'm locked out!"
description: "Options for regaining access"
+related:
+ - docs: /common-tasks/os/#listing-all-users-from-the-command-line
+ title: Listing all user names via command line
+ - url: https://yellow.home-assistant.io/guides/factory-reset/
+ title: Reset the Yellow
+ - url: https://green.home-assistant.io/guides/reset/
+ title: Reset the Green
---
The sections below deal with recovering from a situation where you are not able to sign in,
or need to recover your data.
+## Forgot user name
+
+If you’ve forgotten your username, ask the owner to help you.
+If you are using the {% term "Home Assistant Operating System" %} and have access to the Home Assistant server, you can connect a terminal and enter the `auth list` command. This command lists all users that are registered on your Home Assistant.
+
## Forgot password
-### Home Assistant (including Supervised)
+If you are not the owner or do not have administrator rights, ask the owner to give you a new password.
+
+- In the navigation pane on the left, check if you see the **Settings** menu listed above the **Notifications**.
+ - If you don't, you do not have administrator rights.
+
+If you are the owner or have administrator, there are different methods to reset a password, depending on your setup:
-If you are still logged in to the web interface with your user, then you are in luck.
+### To reset a password while still logged in (including Supervised)
-1. Add a new user as an administrator and give the new user a password you can remember.
-2. Then log out, and log in with this new user.
-3. Reset your password via this new administrator account (and then delete this new account).
- - Your configuration will remain, and you don't have to do a new onboarding process.
+The method used to reset a password depends on your user rights:
-If you’ve forgotten your username, then deleting the files mentioned further below will be necessary to start a new onboarding process.
+- If you are a regular user without administrator rights, ask the owner to [give you a new password](/docs/locked_out/#to-reset-a-users-password-as-an-owner-via-the-web-interface).
+- If you are the owner, choose one of the procedures below to reset your password.
+ - You cannot recover an owner password from within Home Assistant.
+ - There is only one owner per system. You cannot add a new owner.
+- If you are an administrator, add a new user as an administrator and give the new user a password you can remember.
+ 1. Then log out, and log in with this new user.
+ 2. Reset your password via this new administrator account (and then [delete this new account](/docs/locked_out/#to-delete-a-user)).
+ - Your configuration will remain, and you don't have to do a new onboarding process.
-#### To reset a user's password, via console
+### To reset an owner's password, via console
-Use this procedure if you know the username, and you can access the [Home Assistant console](/hassio/commandline/) on the device itself (not the SSH terminal from the add-ons).
+Use this procedure only if the following conditions are met:
-1. Connect a keyboard and monitor to your device and access the terminal:
+- You know the username.
+- You can access the [Home Assistant console](/hassio/commandline/) **on the device itself** (not via the SSH terminal from the add-ons).
+
+1. Connect to the console of the Home Assistant server:
+ - If you are using a virtual machine, connect to your virtual machine console.
- If you are using a Home Assistant Yellow, refer to the following procedure:
- [Using the serial console on Windows](https://yellow.home-assistant.io/guides/use-serial-console-windows/)
- [Using the serial console on macOS / Linux](https://yellow.home-assistant.io/guides/use-serial-console-linux-macos/)
- If you are using a Home Assistant Green, refer to the following procedure:
- [Using the terminal](https://green.home-assistant.io/guides/use-terminal/)
+ - If you are using another board, connect a keyboard and monitor to your device and access the terminal. The procedure is likely very similar to the one described for the Green in the step above.
2. Once you have opened the Home Assistant command line, enter the following command:
- Note: `existing_user` is a placeholder. Replace it with your user name.
- Note: `new_password` is a placeholder. Replace it with your new password.
- **Command**: `auth reset --username existing_user --password new_password`
+ - **Troubleshooting**: If you see the message `zsh: command not found: auth`, you likely did not enter the command in the serial console connected to the device itself, but in the terminal within Home Assistant.
3. You can now log in to Home Assistant using this new password.
-#### To reset a user's password, via the container command line
+### To reset a user's password, via the container command line
If you are running Home Assistant in a container, you can use the command line in the container with the `hass` command to change your password. The steps below refer to a Home Assistant container in Docker named `homeassistant`. Note that while working in the container, commands will take a few moments to execute.
@@ -45,7 +72,9 @@ If you are running Home Assistant in a container, you can use the command line i
4. `exit` to exit the container command line
5. `docker restart homeassistant` to restart the container.
-#### To reset a user's password, as an owner via the web interface
+### To reset a user's password, as an owner via the web interface
+
+Only the owner can change other user's passwords.
1. In the bottom left, select your user to go to the {% my profile title="**Profile**" %} page and make sure **Advanced Mode** is activated.
2. Go to {% my people title="**Settings** > **People**" %} and select the person for which you want to change the password.
@@ -55,7 +84,9 @@ If you are running Home Assistant in a container, you can use the command line i
5. Confirm the new password by entering it again, and select **OK** again.
6. A confirmation box will be displayed with the text **Password was changed successfully**.
-#### To delete a user, as an administrator via the web interface
+### To delete a user
+
+You need to be an owner or have administrator rights to delete a user.
1. Go to {% my people title="**Settings** > **People**" %} and select the person which you want to delete.
- Note: you cannot delete the owner.
@@ -63,21 +94,15 @@ If you are running Home Assistant in a container, you can use the command line i
- A confirmation dialog box will be displayed.
3. To confirm, select **OK**.
-#### Start a new onboarding process
+### To prepare the system to start a new onboarding process
+
+If you lose the password associated with the owner account and the steps above do not work to reset the password, the only way to resolve this is to start a new onboarding process.
-If you lose the password associated with the owner account and the steps above do not work to reset the password, the only way to resolve this is to start a new onboarding process. If you have an external backup with an administrator account of which you still know the login credentials, you can restore that backup. If you do not have a backup, resetting the device will erase all data.
+- If you have an external backup with an administrator account of which you still know the login credentials, you can restore that backup.
+- If you do not have a backup, resetting the device will erase all data.
- If you have a Home Assistant Green, [reset the Green](https://green.home-assistant.io/guides/reset/).
- If you have a Home Assistant Yellow, [reset the Yellow](https://yellow.home-assistant.io/guides/factory-reset/).
-- If you have a Raspberry Pi, delete *all* the authentication data.
- - Shut down Home Assistant.
- - Remove your SD card and access it from your PC.
- - Delete the following files from the `.storage/` folder in your [configuration folder](/docs/configuration/):
- - `auth`
- - `auth_provider.homeassistant`
- - `onboarding`
- - `hassio`
- - `cloud`
## Recovering data for Home Assistant (including Supervised)
diff --git a/source/_docs/organizing.markdown b/source/_docs/organizing.markdown
new file mode 100644
index 000000000000..5091baaac10a
--- /dev/null
+++ b/source/_docs/organizing.markdown
@@ -0,0 +1,55 @@
+---
+title: "Grouping your assets"
+description: "Grouping your assets makes it easier to find them and allows you to target groups in automations."
+related:
+ - docs: /docs/organizing/areas/
+ title: Areas
+ - docs: /docs/organizing/floors/
+ title: Floors
+ - docs: /docs/organizing/labels/
+ title: Labels
+ - docs: /docs/organizing/categories/
+ title: Categories
+---
+
+Once you have more devices, you may want to target entire groups of devices in automations. It also becomes more challenging to find items in lists. There are a few tools to group your assets: [Areas](#areas), [floors](#floors), [labels](#labels), and [categories](#categories).
+
+| Taxonomy | Automation target | Entity can have multiple |
+| -------- | ----------------- | ------------------------ |
+| Area | ✅ | ❌ |
+| Floor | ✅ | ❌ |
+| Label | ✅ | ✅ |
+| Category | ❌ | ❌ |
+
+## Area
+
+- Groups {% term devices %} and {% term entities %}.
+- Can be assigned to one floor.
+- Reflects a physical area (or room) in your home.
+- Can be used in automations: Allows targeting an entire group of devices with a service call. For example, turning off all the lights in the living room.
+
+- Areas can also be used to automatically generate cards, such as the [Area card](/dashboards/area/).
+
+## Floor
+
+- Groups areas.
+- {% term Devices %} and {% term entities %} cannot be assigned to floors, but to areas only.
+- Can have multiple areas.
+- Can be used in automations and scripts as a target for actions. For example, to turn off all the lights on the downstairs floor when you go to bed.
+
+
+
+## Labels
+
+- Can be assigned to areas, devices, entities, automations, scenes, scripts, and helpers.
+- Can be used in automations and scripts as a target for actions and services.
+- Labels can also be used to filter data in tables. For example, you can filter the list of devices to show only devices with the label `heavy energy usage` or turn these devices off when there is not a lot of solar energy available.
+
+
+
+## Category
+
+- Groups items in a table.
+- Categories are unique for each table. The automations page can have different categories than the scene, scripts, or helpers settings page.
+
+
diff --git a/source/_docs/organizing/areas.markdown b/source/_docs/organizing/areas.markdown
new file mode 100644
index 000000000000..6af4f1434ba7
--- /dev/null
+++ b/source/_docs/organizing/areas.markdown
@@ -0,0 +1,90 @@
+---
+title: "Areas"
+description: "Group your devices and entities in areas and group areas in floors."
+related:
+ - docs: /docs/organizing/areas/
+ title: Areas
+ - docs: /docs/organizing/
+ - docs: /docs/organizing/labels/
+ title: Labels
+ - docs: /docs/organizing/categories/
+ title: Categories
+ - docs: /docs/configuration/templating/#areas
+ title: Using areas in template
+---
+
+An area in Home Assistant is a logical grouping of {% term devices %} and {% term entities %} that are meant to match areas (or rooms) in the physical world of your home. For example, the "Living room" area groups devices and entities in your living room. Areas allow you to target an entire group of devices with a service call. For example, turning off all the lights in the living room.
+Areas can be assigned to floors. Areas can also be used to automatically generate cards, such as the [Area card](/dashboards/area/).
+
+## Creating an area
+
+Follow these steps to create a new area from the **Areas** view.
+
+1. Go to {% my areas title="**Settings** > **Areas, labels & zones**" %} and select **Create area**.
+2. In the dialog, enter the area details:
+ - Give the area a **Name** (required).
+ - Add an icon (We use [Material icons](https://pictogrammers.com/library/mdi/)).
+ - Assign the area to a floor.
+ - If you have not created floors yet, you can [create a new one](/docs/organizing/floors/#creating-a-floor).
+ - The number can be negative. For example for underground floors.
+ - This number can later be used for sorting.
+ - Add an image representing that area.
+ - Add an **Alias**.
+ - Aliases are alternative names used in [voice assistants](/voice_control/aliases/) to refer to an area, entity, or floor.
+
+ 
+3. Select **Add**.
+
+ **Result**: A new area is created.
+
+## Assigning areas to floors and add labels
+
+If an area has not yet been assigned to a floor, it is shown in the **Unassigned areas** section. Follow these steps to assign an area to a floor.
+
+1. Go to {% my areas title="**Settings** > **Areas, labels & zones**" %} and select **Create area**.
+2. On the area card, select the pencil icon.
+3. In the dialog, select the floor and add labels, if you like.
+
+## Assigning an area to multiple items
+
+You can assign an area to multiple items at once in the automation, scene, script, and device pages.
+
+1. Depending on what you want to assign, go to one of the following pages:
+ - For automations, scripts, or scenes {% my automations title="**Settings** > **Automations & Scenes**" %} and open the respective tab.
+ - For devices, go to {% my devices title="**Settings** > **Devices & services** > **Devices**" %}.
+2. In the list, [select all the items](/docs/organizing/filtering#selecting-multiple-items-in-a-table) you want to assign to an area.
+
+ 
+
+3. In the top right corner, select **Move to area** and select the target area from the list.
+
+## Editing an area
+
+Follow these steps to edit an area.
+
+1. Go to {% my areas title="**Settings** > **Areas, labels & zones**" %} and on the area card, select the pencil icon.
+2. In the dialog, adjust the area details you want to change:
+ - Edit the area **Name**.
+ - Add an icon (We use [Material icons](https://pictogrammers.com/library/mdi/)).
+ - Assign the area to a floor.
+ - If you have not created floors yet, you can [create a new one](/docs/organizing/floors/#creating-a-floor).
+ - The number can be negative. For example for underground floors.
+ - This number can later be used for sorting.
+ - Add an image representing that area.
+ - Add an **Alias**.
+ - Aliases are alternative names used in [voice assistants](/voice_control/aliases/) to refer to an area, entity, or floor.
+
+## Deleting an area
+
+Follow these steps to delete an area. It will be removed from all the floors it was assigned to. All the devices that were assigned to this area will become unassigned.
+If you used this area in automations or script as targets, or with voice assistant, these will no longer work.
+
+1. Go to {% my areas title="**Settings** > **Areas, labels & zones**" %} and select the area card.
+2. In the top right corner, select the three dot menu. Then, select **Delete**.
+
+ 
+
+3. If you used this area in automations or script as targets, or with voice assistant, they will no longer work.
+ - You can adjust or delete the related scripts or automations.
+4. If you still had devices in that area, they are no longer assigned to any room.
+ - If you have moved the devices, you can now reassign them to a new area.
diff --git a/source/_docs/organizing/categories.markdown b/source/_docs/organizing/categories.markdown
new file mode 100644
index 000000000000..261332fbc02c
--- /dev/null
+++ b/source/_docs/organizing/categories.markdown
@@ -0,0 +1,56 @@
+---
+title: "Categories"
+description: "Use categories to group and filter your table items"
+related:
+ - docs: /docs/organizing/areas/
+ title: Areas
+ - docs: /docs/organizing/floors/
+ title: Floors
+ - docs: /docs/organizing/labels/
+ title: Labels
+---
+
+Categories let you group and filter items in a table. Like labels, categories allow grouping irrespective of the items physical location. For example, on the automations page, you can create the categories “Notifications” or “NFC tags” to view your automations grouped or filtered. These categories group automations on the automation page, but have no effect anywhere else. Categories are unique for each table. The automations page can have different categories than the scene, scripts, or helpers settings page.
+
+## Creating a category
+
+Follow these steps to create a new category.
+
+1. Go to {% my automations title="**Settings** > **Automations & Scenes**" %} and open the respective tab.
+2. In the top left, select the **Filters** button.
+
+ 
+3. Select **Category**, then **Add category**.
+4. Enter a name, select an icon and select **Add**.
+
+ **Result**: A new category is created.
+
+## Assigning a category
+
+1. Go to {% my automations title="**Settings** > **Automations & Scenes**" %} and open the respective tab.
+2. To assign a category to a single item:
+ - Find the item in the list and select the three dots menu.
+ - Select **Assign category** and select the category from the list.
+ - If the category is not in the list, select **Add new category** and make a new one.
+3. To assign a category to multiple items:
+ - Select the
button.
+ - From the list, select all the items to which you want to apply a category.
+ - In the top right corner, select **Move to category**.
+ - Then, select the category from the list.
+4. Once categories are applied, the table items are grouped by those categories.
+ - The example shows 2 categories: Coffee and housekeeping.
+
+ 
+
+## Editing or deleting a category
+
+To rename or delete a category, follow these steps:
+
+1. Go to {% my automations title="**Settings** > **Automations & Scenes**" %} and open the respective tab.
+2. In the top left, select the **Filters** button.
+
+ 
+3. In the list, find the category you want to edit and select the three dot menu next to it.
+4. Select **Edit category** or **Delete category**.
+
+ 
diff --git a/source/_docs/organizing/filtering.markdown b/source/_docs/organizing/filtering.markdown
new file mode 100644
index 000000000000..d8fa65532d75
--- /dev/null
+++ b/source/_docs/organizing/filtering.markdown
@@ -0,0 +1,62 @@
+---
+title: "Filtering your assets"
+description: "Filter for items in tables."
+related:
+ - docs: /docs/organizing/floors/
+ title: Floors
+ - docs: /docs/organizing/labels/
+ title: Labels
+ - docs: /docs/organizing/areas/
+ title: Areas
+ - docs: /docs/organizing/categories/
+ title: Categories
+ - docs: /docs/organizing/
+ title: Grouping your assets
+ - docs: /common-tasks/general/
+ title: Enabling or disabling entities and automations
+---
+
+When working with tables, you can select multiple items to apply an action. If you have [grouped](/docs/organizing/) items by assigning them to floors, areas, labels, or directories, you can also filter your data accordingly.
+
+## Selecting multiple items in a table
+
+1. In your table, select the
button.
+
+ 
+
+2. In the list, select the items of interest.
+
+ 
+
+3. You can now apply changes to all selected elements, such as [applying labels](/docs/organzing/labels/) or [enabling or disabling entities and automations](/common-tasks/general/).
+
+## Filtering items in a table
+
+You can filter a table so that only items matching certain criteria are shown.
+
+1. In the top left corner above the table, select the **Filters** button.
+
+ 
+
+2. In the filters panel, select your filter criteria.
+ - You can filter for [floors](/docs/organizing/floors/), [areas](/docs/organizing/areas/), [labels](/docs/organizing/labels/), and [categories](/docs/organizing/categories/) if you have previously defined them.
+ - The list of available criteria depends on the type of table.
+
+ 
+
+## Grouping and sorting items in a table
+
+You can group items in a table according to certain criteria. The number of shown items stays the same. No items will be hidden.
+
+1. In the top right above the table, select the **Group by** button.
+2. The items will be grouped according to the criteria you chose.
+ - The list of available criteria depends on the type of table.
+ - The example shows a list of devices, grouped by manufacturer.
+ - In contrast, the entities table does not allow grouping by manufacturer, but by entity domains.
+
+ 
+
+3. To sort the items, select the **Sort by** button.
+4. To get a better overview, you can collapse groups in the list.
+
+ 
\ No newline at end of file
diff --git a/source/_docs/organizing/floors.markdown b/source/_docs/organizing/floors.markdown
new file mode 100644
index 000000000000..3a39c03ec91e
--- /dev/null
+++ b/source/_docs/organizing/floors.markdown
@@ -0,0 +1,50 @@
+---
+title: "Floors"
+description: "Group your areas per floor"
+related:
+ - docs: /docs/organizing/areas/
+ title: Areas
+ - docs: /docs/organizing/
+ - docs: /docs/organizing/labels/
+ title: Labels
+ - docs: /docs/configuration/templating/#floors
+ title: Using floors in templates
+ - docs: /voice_control/aliases/
+ title: Using floor alias for voice assistants
+---
+
+A floor in Home Assistant is a logical grouping of areas meant to match your home's physical floors. Devices and entities
+cannot be assigned to floors directly but to areas. Floors can be used in automations and scripts as a target for actions. For example, to turn off all the lights on the downstairs floor when you go to bed.
+
+## Creating a floor
+
+Follow these steps to create a new floor.
+
+1. Go to {% my areas title="**Settings** > **Areas, labels & zones**" %} and select **Create floor**.
+2. In the dialog, enter the floor details:
+ - Give the floor a **Name** (required).
+ - Add a floor **Level**.
+ - The number can be negative. For example for underground floors.
+ - This number can later be used for sorting.
+ - Add an icon (We use [Material icons](https://pictogrammers.com/library/mdi/)).
+ - Add an **Alias**.
+ - Aliases are alternative names used in [voice assistants](/voice_control/aliases/) to refer to an entity, area, or floor.
+
+ 
+3. Select **Add**.
+
+ **Result**: A new floor is created.
+
+ 
+4. You can now [assign areas to that floor](/docs/organizing/areas/#assigning-areas-to-floors-and-add-labels).
+
+## Deleting a floor
+
+Follow these steps to delete a floor. Areas that are assigned to a floor will become unassigned. Automations and scripts or voice assistants that used a floor as a target will no longer work as they no longer have a target.
+
+1. Go to {% my areas title="**Settings** > **Areas, labels & zones**" %}.
+2. Next to the floor, select the three dots menu and select **Delete floor**.
+
+ 
+
+3. If you have automations, scripts, or voice assistants that used floors as a target, you will need to update these.
diff --git a/source/_docs/organizing/labels.markdown b/source/_docs/organizing/labels.markdown
new file mode 100644
index 000000000000..0e95e8dc515b
--- /dev/null
+++ b/source/_docs/organizing/labels.markdown
@@ -0,0 +1,73 @@
+---
+title: "Labels"
+description: "Label your areas, devices, entities, automations, scripts, and helpers. Then, filter by label or run an automation on all entities with that label."
+related:
+ - docs: /docs/organizing/areas/
+ title: Areas
+ - docs: /docs/organizing/floors/
+ title: Floors
+ - docs: /docs/organizing/categories/
+ title: Categories
+ - docs: /docs/configuration/templating/#labels
+ title: Using labels in templates
+---
+
+Labels in Home Assistant allow grouping elements irrespective of their physical location or type. Labels can be assigned to areas, devices, entities, automations, scenes, scripts, and helpers. Labels can be used in automations and scripts as a target for actions and services. Labels can also be used to filter data. For example, you can filter the list of devices to show only devices with the label `heavy energy usage` or turn these devices off when there is not a lot of solar energy available.
+
+## Creating a label
+
+Follow these steps to create a new label from the **Labels** view.
+
+1. Go to {% my labels title="**Settings** > **Areas, labels & zones**" %} and on top, select the **Labels** tab.
+2. Select the **Create label** button.
+3. In the dialog, enter the label details:
+ - Give the label a **Name** (required).
+ - Add an icon (We use [Material icons](https://pictogrammers.com/library/mdi/)).
+ - Add a **Color**.
+
+ 
+4. Select **Create**.
+
+ **Result**: A new label is created.
+
+## Applying labels
+
+Follow these steps to apply a label
+
+1. To apply a label to an area:
+ - Go to {% my areas title="**Settings** > **Areas, labels & zones**" %}.
+ - On the area card, select the pencil icon.
+ - Select one or more labels or select **Add new label** to create a new one.
+2. To apply a label to a device, entity, or helper:
+ - Go to **{% my integrations title="Settings > Devices & Services" %}** and open the respective tab.
+ - Select the
button.
+ - From the list, select all the list entries to which you want to apply a label.
+ - In the top right corner, select **Add label**. Then, select the labels from the list.
+
+ 
+3. To apply a label to an automation, scene, or script:
+ - Go to {% my automations title="**Settings** > **Automations & Scenes**" %} and open the respective tab.
+ - Select the
button.
+ - From the list, select all the list entries to which you want to apply a label.
+ - In the top right corner, select the three dots menu, then select **Add label**. Then, select the labels from the list.
+
+## Deleting a label
+
+Follow these steps to delete a label. It will be removed from all the list entries it was applied to.
+If you used this label in automations or script as targets, you need to adjust those.
+
+1. Go to {% my labels title="**Settings** > **Areas, labels & zones**" %} and on top, select the **Labels** tab.
+2. In the list of labels, find the label you want to delete and select the three dots menu.
+3. Select **Delete**.
+4. If you used this label in automations or script as targets, you need to adjust those.
+
+## Removing labels
+
+1. Go to the data table that contains the element from which you want to remove the label:
+ - Go to **{% my integrations title="Settings > Devices & Services" %}** and open the respective tab.
+ - Or, go to {% my automations title="**Settings** > **Automations & Scenes**" %} and open the respective tab.
+2. Select the
button.
+ - From the list, select all the items from which you want to remove a label.
+ - In the top right corner, select the three dots menu, then select **Add label**.
+ - Then, deselect the checkbox for the label you want to remove.
+
diff --git a/source/_docs/scripts.markdown b/source/_docs/scripts.markdown
index a8988e68b8f2..f7b5ee49517a 100644
--- a/source/_docs/scripts.markdown
+++ b/source/_docs/scripts.markdown
@@ -7,11 +7,13 @@ no_toc: true
Scripts are a sequence of {% term actions %} that Home Assistant will execute. Scripts are available as an entity through the standalone [Script integration] but can also be embedded in {% term automations %} and [Alexa/Amazon Echo] configurations.
-When the script is executed within an automation the `trigger` variable is available. See [Available-Trigger-Data](/docs/automation/templating/#available-trigger-data).
+When the script is executed within an {% term automation %}, the `trigger` variable is available. See [Available-Trigger-Data](/docs/automation/templating/#available-trigger-data).
-The script syntax basic structure is a list of key/value maps that contain actions. If a script contains only 1 action, the wrapping list can be omitted.
+## Script syntax
-All actions support an optional `alias`.
+The script syntax basic structure is a list of key/value maps that contain {% term actions %}. If a script contains only 1 {% term action %}, the wrapping list can be omitted.
+
+All {% term actions %} support an optional `alias`.
```yaml
# Example script integration containing script syntax
@@ -31,9 +33,9 @@ script:
{{ page.content | markdownify | toc_only }}
-## Call a Service
+## Call a service
-The most important one is the action to call a service. This can be done in various ways. For all the different possibilities, have a look at the [service calls page].
+The most important one is the action to call a {% term service %}. This can be done in various ways. For all the different possibilities, have a look at the [service calls page].
```yaml
- alias: "Bedroom lights on"
@@ -44,9 +46,9 @@ The most important one is the action to call a service. This can be done in vari
brightness: 100
```
-### Activate a Scene
+### Activate a scene
-Scripts may also use a shortcut syntax for activating scenes instead of calling the `scene.turn_on` service.
+Scripts may also use a shortcut syntax for activating {% term scenes %} instead of calling the `scene.turn_on` service.
```yaml
- scene: scene.morning_living_room
@@ -54,7 +56,7 @@ Scripts may also use a shortcut syntax for activating scenes instead of calling
## Variables
-The variables action allows you to set/override variables that will be accessible by templates in actions after it. See also [script variables] for how to define variables accessible in the entire script.
+The variables {% term action %} allows you to set/override variables that will be accessible by templates in {% term action %} after it. See also [script variables] for how to define variables accessible in the entire script.
{% raw %}
@@ -91,11 +93,11 @@ Variables can be templated.
{% endraw %}
-### Scope of Variables
+### Scope of variables
Variables have local scope. This means that if a variable is changed in a nested sequence block, that change will not be visible in an outer sequence block.
-Inside the `if` sequence the `variables` action will only alter the `people` variable for that sequence.
+Inside the `if` sequence the `variables` {% term action %} will only alter the `people` variable for that sequence.
{% raw %}
@@ -125,13 +127,13 @@ sequence:
{% endraw %}
-## Test a Condition
+## Test a condition
-While executing a script you can add a condition in the main sequence to stop further execution. When a condition does not return `true`, the script will stop executing. There are many different conditions which are documented at the [conditions page].
+While executing a script you can add a condition in the main sequence to stop further execution. When a condition does not return `true`, the script will stop executing. For documentation on the many different conditions refer to the [conditions page].
-The `condition` action only stops executing the current sequence block. When it is used inside a [repeat](#repeat-a-group-of-actions) action, only the current iteration of the `repeat` loop will stop. When it is used inside a [choose](#choose-a-group-of-actions) action, only the actions within that `choose` will stop.
+The `condition` {% term action %} only stops executing the current sequence block. When it is used inside a [repeat](#repeat-a-group-of-actions) action, only the current iteration of the `repeat` loop will stop. When it is used inside a [choose](#choose-a-group-of-actions) action, only the {% term actions %} within that `choose` will stop.
@@ -204,11 +206,11 @@ All forms accept templates.
## Wait
-These actions allow a script to wait for entities in the system to be in a certain state as specified by a template, or some event to happen as expressed by one or more triggers.
+These {% term actions %} allow a script to wait for entities in the system to be in a certain state as specified by a template, or some event to happen as expressed by one or more triggers.
### Wait for a template
-This action evaluates the template, and if true, the script will continue. If not, then it will wait until it is true.
+This {% term action %} evaluates the template, and if true, the script will continue. If not, then it will wait until it is true.
The template is re-evaluated whenever an entity ID that it references changes state. If you use non-deterministic functions like `now()` in the template it will not be continuously re-evaluated, but only when an entity ID that is referenced is changed. If you need to periodically re-evaluate the template, reference a sensor from the [Time and Date](/integrations/time_date/) integration that will update minutely or daily.
@@ -224,7 +226,7 @@ The template is re-evaluated whenever an entity ID that it references changes st
### Wait for a trigger
-This action can use the same triggers that are available in an automation's `trigger` section. See [Automation Trigger](/docs/automation/trigger). The script will continue whenever any of the triggers fires. All previously defined [trigger variables](/docs/automation/trigger#trigger-variables), [variables](#variables) and [script variables] are passed to the trigger.
+This {% term action %} can use the same triggers that are available in an automation's `trigger` section. See [Automation Trigger](/docs/automation/trigger). The script will continue whenever any of the triggers fires. All previously defined [trigger variables](/docs/automation/trigger#trigger-variables), [variables](#variables) and [script variables] are passed to the trigger.
{% raw %}
```yaml
@@ -324,9 +326,9 @@ This can be used to take different actions based on whether or not the condition
```
{% endraw %}
-## Fire an Event
+## Fire an event
-This action allows you to fire an event. Events can be used for many things. It could trigger an automation or indicate to another integration that something is happening. For instance, in the below example it is used to create an entry in the logbook.
+This {% term action %} allows you to fire an event. Events can be used for many things. It could trigger an {% term automation %} or indicate to another integration that something is happening. For instance, in the below example it is used to create an entry in the logbook.
```yaml
- alias: "Fire LOGBOOK_ENTRY event"
@@ -356,7 +358,7 @@ The `event_data` accepts templates.
### Raise and Consume Custom Events
-The following automation example shows how to raise a custom event called `event_light_state_changed` with `entity_id` as the event data. The action part could be inside a script or an automation.
+The following {% term automation %} example shows how to raise a custom event called `event_light_state_changed` with `entity_id` as the event data. The {% term action %} part could be inside a script or an {% term automation %}.
```yaml
- alias: "Fire Event"
@@ -370,7 +372,7 @@ The following automation example shows how to raise a custom event called `event
state: "on"
```
-The following automation example shows how to capture the custom event `event_light_state_changed` with an [Event Automation Trigger](/docs/automation/trigger#event-trigger), and retrieve corresponding `entity_id` that was passed as the event trigger data, see [Available-Trigger-Data](/docs/automation/templating/#available-trigger-data) for more details.
+The following {% term automation %} example shows how to capture the custom event `event_light_state_changed` with an [Event Automation Trigger](/docs/automation/trigger#event-trigger), and retrieve corresponding `entity_id` that was passed as the event trigger data, see [Available-Trigger-Data](/docs/automation/templating/#available-trigger-data) for more details.
{% raw %}
@@ -389,7 +391,7 @@ The following automation example shows how to capture the custom event `event_li
## Repeat a group of actions
-This action allows you to repeat a sequence of other actions. Nesting is fully supported.
+This {% term action %} allows you to repeat a sequence of other {% term actions %}. Nesting is fully supported.
There are three ways to control how many times the sequence will be run.
### Counted repeat
@@ -566,7 +568,7 @@ For example:
### Repeat loop variable
-A variable named `repeat` is defined within the repeat action (i.e., it is available inside `sequence`, `while` & `until`.)
+A variable named `repeat` is defined within the repeat {% term action %} (i.e., it is available inside `sequence`, `while` & `until`.)
It contains the following fields:
field | description
@@ -577,7 +579,7 @@ field | description
## If-then
-This action allow you to conditionally (`if`) run a sequence of actions (`then`)
+This {% term action %} allow you to conditionally (`if`) run a sequence of actions (`then`)
and optionally supports running other sequence when the condition didn't
pass (`else`).
@@ -600,13 +602,13 @@ script:
message: "Skipped cleaning, someone is home!"
```
-This action supports nesting, however, if you find yourself using nested if-then
+This {% term action %} supports nesting, however, if you find yourself using nested if-then
actions in the `else` part, you may want to consider using
[choose](#choose-a-group-of-actions) instead.
-## Choose a Group of Actions
+## Choose a group of actions
-This action allows you to select a sequence of other actions from a list of sequences.
+This {% term action %} allows you to select a sequence of other {% term actions %} from a list of sequences.
Nesting is fully supported.
Each sequence is paired with a list of conditions. (See the [conditions page] for available options and how multiple conditions are handled.) The first sequence whose conditions are all true will be run.
@@ -614,7 +616,7 @@ An _optional_ `default` sequence can be included which will be run only if none
An _optional_ `alias` can be added to each of the sequences, excluding the `default` sequence.
-The `choose` action can be used like an "if/then/elseif/then.../else" statement. The first `conditions`/`sequence` pair is like the "if/then", and can be used just by itself. Or additional pairs can be added, each of which is like an "elif/then". And lastly, a `default` can be added, which would be like the "else."
+The `choose` {% term action %} can be used like an "if/then/elseif/then.../else" statement. The first `conditions`/`sequence` pair is like the "if/then", and can be used just by itself. Or additional pairs can be added, each of which is like an "elif/then". And lastly, a `default` can be added, which would be like the "else."
{% raw %}
@@ -696,7 +698,7 @@ automation:
More `choose` can be used together. This is the case of an IF-IF.
-The following example shows how a single automation can control entities that aren't related to each other but have in common the same trigger.
+The following example shows how a single {% term automation %} can control entities that aren't related to each other but have in common the same trigger.
When the sun goes below the horizon, the `porch` and `garden` lights must turn on. If someone is watching the TV in the living room, there is a high chance that someone is in that room, therefore the living room lights have to turn on too. The same concept applies to the `studio` room.
@@ -753,13 +755,13 @@ automation:
## Parallelizing actions
-By default, all sequences of actions in Home Assistant run sequentially. This
-means the next action is started after the current action has been completed.
+By default, all sequences of {% term actions %} in Home Assistant run sequentially. This
+means the next {% term action %} is started after the current action has been completed.
This is not always needed, for example, if the sequence of actions doesn't rely
on each other and order doesn't matter. For those cases, the `parallel` action
-can be used to run the actions in the sequence in parallel, meaning all
-the actions are started at the same time.
+can be used to run the {% term actions %} in the sequence in parallel, meaning all
+the {% term actions %} are started at the same time.
The following example shows sending messages out at the same time (in parallel):
@@ -802,32 +804,32 @@ script:
-Running actions in parallel can be helpful in many cases, but use it with
+Running {% term actions %} in parallel can be helpful in many cases, but use it with
caution and only if you need it.
There are some caveats (see below) when using parallel actions.
While it sounds attractive to parallelize, most of the time, just the regular
-sequential actions will work just fine.
+sequential {% term actions %} will work just fine.
-Some of the caveats of running actions in parallel:
+Some of the caveats of running {% term actions %} in parallel:
-- There is no order guarantee. The actions will be started in parallel, but
+- There is no order guarantee. The {% term actions %} will be started in parallel, but
there is no guarantee that they will be completed in the same order.
-- If one action fails or errors, the other actions will keep running until
+- If one {% term action %} fails or errors, the other {% term actions %} will keep running until
they too have finished or errored.
-- Variables created/modified in one parallelized action are not available
- in another parallelized action. Each step in a parallelized has its own scope.
+- Variables created/modified in one parallelized {% term action %} are not available
+ in another parallelized {% term action %}. Each step in a parallelized has its own scope.
## Stopping a script sequence
It is possible to halt a script sequence at any point and return script responses
-using the `stop` action.
+using the `stop` {% term action %}.
-The `stop` action takes a text as input explaining the reason for halting the
-sequence. This text will be logged and shows up in the automations and
+The `stop` {% term action %} takes a text as input explaining the reason for halting the
+sequence. This text will be logged and shows up in the {% term automations %} and
script traces.
`stop` can be useful to halt a script halfway through a sequence when,
@@ -847,7 +849,7 @@ response data must contains a mapping of key/value pairs.
```
There is also an `error` option, to indicate we are stopping because of
-an unexpected error. It stops the sequence as well, but marks the automation
+an unexpected error. It stops the sequence as well, but marks the {% term automation %}
or script as failed to run.
```yaml
@@ -857,20 +859,20 @@ or script as failed to run.
## Continuing on error
-By default, a sequence of actions will be halted when one of the actions in
-that sequence encounters an error. The automation or script will be halted,
-an error is logged, and the automation or script run is marked as errored.
+By default, a sequence of {% term actions %} will be halted when one of the {% term actions %} in
+that sequence encounters an error. The {% term automation %} or script will be halted,
+an error is logged, and the {% term automation %} or script run is marked as errored.
Sometimes these errors are expected, for example, because you know the service
you call can be problematic at times, and it doesn't matter if it fails.
-You can set `continue_on_error` for those cases on such an action.
+You can set `continue_on_error` for those cases on such an {% term action %}.
-The `continue_on_error` is available on all actions and is set to
-`false`. You can set it to `true` if you'd like to continue the action
-sequence, regardless of whether that action encounters an error.
+The `continue_on_error` is available on all {% term actions %} and is set to
+`false`. You can set it to `true` if you'd like to continue the {% term action %}
+sequence, regardless of whether that {% term action %} encounters an error.
-The example below shows the `continue_on_error` set on the first action. If
-it encounters an error; it will continue to the next action.
+The example below shows the `continue_on_error` set on the first {% term action %}. If
+it encounters an error; it will continue to the next {% term action %}.
```yaml
- alias: "If this one fails..."
@@ -891,8 +893,8 @@ or errors that Home Assistant does not handle.
## Disabling an action
-Every individual action in a sequence can be disabled, without removing it.
-To do so, add `enabled: false` to the action. For example:
+Every individual {% term action %} in a sequence can be disabled, without removing it.
+To do so, add `enabled: false` to the {% term action %}. For example:
```yaml
# Example script with a disabled action
@@ -914,6 +916,36 @@ script:
entity_id: light.ceiling
```
+## Respond to a conversation
+
+The `set_conversation_response` script {% term action %} allows returning a custom response
+when an {% term automation %} is triggered by a conversation engine, for example a voice
+assistant. The conversation response can be templated.
+
+{% raw %}
+
+```yaml
+# Example of a templated conversation response resulting in "Testing 123"
+- variables:
+ my_var: "123"
+- set_conversation_response: "{{ 'Testing ' + my_var }}":
+```
+
+{% endraw %}
+
+The response is handed to the conversation engine when the {% term automation %} finishes. If
+the `set_conversation_response` is executed multiple times, the most recent
+response will be handed to the conversation engine. To clear the response, set it
+to `None`:
+
+```yaml
+# Example of a clearing a conversation response
+set_conversation_response: ~
+```
+
+If the {% term automation %} was not triggered by a conversation engine, the response
+will not be used by anything.
+
[Script integration]: /integrations/script/
[automations]: /docs/automation/action/
[Alexa/Amazon Echo]: /integrations/alexa/
diff --git a/source/_docs/scripts/conditions.markdown b/source/_docs/scripts/conditions.markdown
index 71529b270f58..2860510c95a3 100644
--- a/source/_docs/scripts/conditions.markdown
+++ b/source/_docs/scripts/conditions.markdown
@@ -218,8 +218,8 @@ condition:
below: 25
```
-Number helpers (`input_number` entities), `number` and `sensor` entities that
-contain a numeric value, can be used in the `above` and `below`
+Number helpers (`input_number` entities), `number`, `sensor`, and `zone` entities
+that contain a numeric value, can be used in the `above` and `below`
options to make the condition more dynamic.
```yaml
diff --git a/source/_docs/scripts/service-calls.markdown b/source/_docs/scripts/service-calls.markdown
index d153233b4ca3..ccd734c536cf 100644
--- a/source/_docs/scripts/service-calls.markdown
+++ b/source/_docs/scripts/service-calls.markdown
@@ -28,7 +28,7 @@ Instead of targeting an entity, you can also target an {% term area %} or {% ter
This is done with the `target` key.
A `target` is a map that contains at least one of the following: `area_id`, `device_id`, `entity_id`.
-Each of these can be a list.
+Each of these can be a list. The values should be lower-cased.
The following example uses a single service call to turn on the lights in the
living room area, 2 additional light devices and 2 additional light entities:
@@ -80,7 +80,7 @@ entity_id: switch.ac
### Using the Services Developer Tool
You can use the Services Developer Tool to test data to pass in a service call.
-For example, you may test turning on or off a 'group' (See [groups] for more info)
+For example, you may test turning on or off a 'group' (See [groups](/integrations/group/) for more info)
To turn a group on or off, pass the following info:
@@ -133,13 +133,12 @@ Examples of service response data are upcoming calendar events for the next week
Templates can also be used for handling response data. The service call can specify
a `response_variable`. This is the [variable](/docs/scripts/#variables)
-that contains the response data. You can define any name for your `response_variable`. This example calls a service and stores the response in
-the variable called `agenda`.
+that contains the response data. You can define any name for your `response_variable`. This example calls a service and stores the response in the variable called `agenda`.
{% raw %}
```yaml
-service: calendar.list_events
+service: calendar.get_events
target:
entity_id: calendar.school
data:
@@ -168,7 +167,7 @@ data:
message: >-
Your agenda for today:
- {% for event in agenda.events %}
+ {% for event in agenda['calendar.school'].events %}
{{ event.start}}: {{ event.summary }}
{% endfor %}
diff --git a/source/_docs/tools/check_config.markdown b/source/_docs/tools/check_config.markdown
index 245922939132..4a805d672cd0 100644
--- a/source/_docs/tools/check_config.markdown
+++ b/source/_docs/tools/check_config.markdown
@@ -1,9 +1,12 @@
---
title: "check_config"
description: "Script to perform a check of the current configuration"
+related:
+ - docs: /docs/configuration/#validating-the-configuration
+ title: Validating the configuration
---
-Test any changes to your `configuration.yaml` file before launching Home Assistant. This {% term script %} allows you to test changes without the need to restart Home Assistant.
+Test any changes to your `configuration.yaml` file before launching Home Assistant. This script allows you to test changes without the need to restart Home Assistant.
```bash
hass --script check_config
diff --git a/source/_docs/tools/dev-tools.markdown b/source/_docs/tools/dev-tools.markdown
index 627fac764f47..f33111825d3e 100644
--- a/source/_docs/tools/dev-tools.markdown
+++ b/source/_docs/tools/dev-tools.markdown
@@ -10,8 +10,8 @@ The dashboard contains a section called **Developer tools**.
Screenshot of Home Assistant's developer tools.
-| Section |Description |
-| ---------- |---------------------------------------------------------------------|
+| Section | Description |
+| ---------- | ------------------------------------------------------------------- |
| YAML | Lets you validate the configuration and trigger a reload or restart |
| States | Sets the representation of an entity |
| Services | Calls services from integrations |
@@ -24,7 +24,27 @@ Screenshot of Home Assistant's developer tools.
The Developer Tools is meant for **all** (not just for the developers) to quickly try out things - like calling services, updating states, raising events, and publishing messages in MQTT). It is also a necessary tool for those who write custom automations and scripts by hand. The following describes each of the sections in detail.
-## States
+## YAML tab
+
+The YAML tab provides buttons to trigger a check of configuration files and to reload the configuration. Reloading is needed to apply changes that you've made to the configuration.
+
+It is almost the same as the option under **Settings** > three dot menu (top right) > **Restart Home Assistant** > **Quick reload**. The only difference is that **Quick reload** reloads all the configuration, whereas this YAML tab allows you to only reload one specific configuration at a time.
+
+### Reloading the YAML configuration
+
+For configuration changes to become effective, the configuration must be reloaded. Most integrations in Home Assistant (that do not interact with {% term devices %} or {% term services %}) can reload changes made to their configuration in `configuration.yaml` without needing to restart Home Assistant.
+
+1. Go to {% my server_controls title="**Developer Tools** > **YAML**" %} and scroll down to the YAML configuration reloading section (alternatively, hit ["c"](/docs/tools/quick-bar/) anywhere in the UI and search for "reload").
+ - You are presented with a list of integrations, such as **Automations** or **Conversation**.
+
+ 
+
+2. Depending on what you find in the list, you can proceed with either reloading or you need to restart Home Assistant:
+ - If the integration is listed, select it to reload the settings.
+ - For example, if you've changed the [General settings](/docs/configuration/basic/), you can select **Location & customizations** to apply those changes.
+ - If the integration is not listed, you need to **Restart** Home Assistant for changes to take effect.
+
+## States tab
This section shows all the available entities, their corresponding state and the attribute values. The state and the attribute information is what Home Assistant sees at run time. To update the entity with a new state, or a new attribute value, click on the entity, scroll to the top, and modify the values, and click on “SET STATE” button.
@@ -35,7 +55,7 @@ For example, changing the `light.bedroom` state from `off` to `on` does not turn
The table containing all entities can be filtered for each column. The used search is a wildcard search meaning that if you input "office" in the entity column filter, every entity whose ID matches "\*office\*" will be shown. You can also add your own wildcards in the search input (e.g., "office\*light").
The attribute filter supports separate filters for attribute names and values, separated by a colon ":". So the filter "location:3" will result in the table showing all entities that have an attribute name that contains "location" and whose attribute value contains "3".
-## Services
+## Services tab
This section is used to call Services that are available in the ServiceRegistry.
@@ -48,6 +68,7 @@ A Service may also require additional input to be passed. It is commonly referre
When an entity is selected from the Entity dropdown, it automatically populates service data with the corresponding `entity_id`. The service data YAML can then be modified to pass additional \[optional\] parameters. The following is an illustration on how to call a `light.turn_on` service.
To turn on a light bulb, use the following steps:
+
1. Select `light.turn_on` from the Service dropdown
2. Select the entity (typically the light bulb) from the Entity dropdown (if no entity_id is selected, it turns on ALL lights)
3. If an entity is selected, the service data is populated with basic YAML that will be passed to the service. Additional data can also be passed by updating the YAML as below.
@@ -58,7 +79,7 @@ brightness: 255
rgb_color: [255, 0, 0]
```
-## Template editor
+## Template editor tab
The template editor provides a way to quickly test templates prior to placing them into automations and scripts. A code editor is on the left side and your real-time output is displayed in the preview on the right side.
@@ -66,7 +87,7 @@ By default, this will contain sample code that illustrates how templates can be
For more information about Jinja2, visit [Jinja2 documentation](https://jinja.palletsprojects.com/en/latest/templates/), and also read templating document [here](/docs/configuration/templating).
-## Events
+## Events tab
In the Events section, you can either fire an event on the event bus or subscribe to an event type in order to view the event data JSON.
@@ -118,7 +139,7 @@ Event 0 fired 9:53 AM:
}
```
-## Statistics
+## Statistics tab
The **Statistics** tab shows a list of long-term statistic entities. If the long term statistics is not working for an entity, a **Fix Issue** link is shown. Select it to view a description of the issue. There might also be an option to fix the issue.
@@ -130,15 +151,16 @@ icon. Use date & time to search for the incorrect data point and adjust the valu
-## Assist
+## Assist tab
The **Assist** tab lets you see how Home Assistant's Assist processes a sentence.
If no matching intent is found, then Assist is unable to interpret the sentence. If a matching intent was found, information is provided on the action that will be performed on which entities. The example below shows how the following sentence was parsed: *what lights are on in the office*.
+
- Assist found a matching intent: *HassGetState*.
- It found entities matching the domain: *lights*.
- The lights have the state *on*.
-- The lights are in the area *office*.
+- The lights are in the area *office*.
- The targets are the narrowed-down entities in scope.
diff --git a/source/_docs/troubleshooting_general.markdown b/source/_docs/troubleshooting_general.markdown
new file mode 100644
index 000000000000..9180465edbd0
--- /dev/null
+++ b/source/_docs/troubleshooting_general.markdown
@@ -0,0 +1,44 @@
+---
+title: "General troubleshooting"
+description: "General troubleshooting information"
+related:
+ - docs: /docs/configuration/#editing-configurationyaml
+ title: Editing your configuration
+ - docs: /integrations/recovery_mode/
+ title: Recovery mode integration
+ - docs: /docs/locked_out/
+ title: Resetting your password
+---
+
+This page provides some information about more generic troubleshooting topics.
+
+## Home Assistant went into recovery mode
+
+### Symptom: Home Assistant is in recovery mode
+
+On top of the page you see a red banner. On the **Overview** page, you see a **Recovery mode** notification.
+
+
+
+### Description
+
+When Home Assistant is in recovery mode, there was an issue with the configuration.
+
+Recovery mode loads a minimum set of integrations to allow troubleshooting the configuration. Recovery mode will use the parts of the configuration that was used the last time Home Assistant started successfully. You can still see the user interface, the settings, and add-ons.
+
+### Resolution
+
+You need to identify the issue in the configuration files and fix it there. The issue could be caused by something as simple as an invalid YAML file.
+
+- If you are running {% term "Home Assistant Operating System" %}, you can install an add-on such as VS code to edit the configuration file if needed.
+- If you are still logged in, you can [edit your configuration](/docs/configuration/#editing-configurationyaml).
+ - In the Home Assistant user interface, open the add-on you usually use and edit the configuration file.
+- Restart Home Assistant.
+- If you are locked out because you forgot your password, you cannot edit the configuration file from the user interface. Follow the steps to [reset your password](/docs/locked_out/).
+
+## Restarting Home Assistant in safe mode
+
+If your Home Assistant is acting up and you cannot identify a root cause, you can use **Safe mode** to narrow down the number of possible causes.
+Safe mode loads Home Assistant Core, but no custom integrations, no custom cards, and no custom themes. If the issue does not persist in Safe mode, the issue is not with Home Assistant Core. Before reporting an issue, check if the issue persists in Safe mode.
+
+To enable Safe mode, go to **Settings** > **System** > **Restart Home Assistant** (top right) > **Restart Home Assistant in safe mode**.
diff --git a/source/_docs/z-wave/controllers.markdown b/source/_docs/z-wave/controllers.markdown
index 14b849223f52..b5f007108087 100644
--- a/source/_docs/z-wave/controllers.markdown
+++ b/source/_docs/z-wave/controllers.markdown
@@ -66,12 +66,7 @@ The alternative to a stick is a hub that supports Z-Wave. Home Assistant support
### 800 Series Controllers
-Z-Wave JS and Z-Wave JS UI do not support the following features available on most 800 series controllers.
-
-Unsupported:
-
- - Long Range
- - NVM Backup/Restore
+Z-Wave JS does not support Z-Wave Long Range yet.
### Aeotec Z-Stick
@@ -85,9 +80,20 @@ It's totally normal for your Z-Wave stick to cycle through its LEDs (Yellow, Blu
### Razberry Board
-You need to disable the on-board Bluetooth since the board requires the use of the hardware UART (and there's only one on the Pi3). You do this by adding the following to the end of `/boot/config.txt`:
+On Raspberry Pi 3 and 4, you need to disable the on-board Bluetooth since the board requires the use of the hardware UART (whose pins are shared with the Bluetooth). You do this by adjusting the `/boot/config.txt`.
+
+For both processes below you will need to insert your SD card into your PC and open the configuration file with your favorite text editor.
+
+- If you are using {% term "Home Assistant Operating System" %}, once you mounted the disk, you will see the `config.txt` directly in the root directory.
+- If you are using {% term "Home Assistant Supervised" %}, the config file is stored in the boot folder: `/boot/config.txt`.
-For both processes below you will need to insert your SD card into your PC and open the `/boot/config.txt` file with your favorite text editor.
+#### Raspberry Pi 5 procedure
+
+Add the following parameters to the bottom of the `config.txt` file.
+
+```text
+dtoverlay=uart0
+```
#### Raspberry Pi 4 procedure
diff --git a/source/_includes/asides/categories.html b/source/_includes/asides/categories.html
index f7dda7399480..639ce3fc038d 100644
--- a/source/_includes/asides/categories.html
+++ b/source/_includes/asides/categories.html
@@ -4,7 +4,7 @@
Categories
{% assign categories = site.categories | sort %}
{% for category in categories %}
{% assign category_name = category | first | downcase %}
- {% if category_name != "core" %}
+ {% if category_name != "core"%}
{{ category | first | replace: '-', ' '}}
{% endif %}
{% endfor %}
diff --git a/source/_includes/asides/dashboards_navigation.html b/source/_includes/asides/dashboards_navigation.html
index 016aacfaf61c..e438544380c2 100644
--- a/source/_includes/asides/dashboards_navigation.html
+++ b/source/_includes/asides/dashboards_navigation.html
@@ -6,7 +6,7 @@
Dashboards
- If you have been using a data disk previously with Home Assistant Operating System, you need to use your host computer to delete all partitions *before* using it as a data disk again.
+ If you have been using a data disk previously with {% term "Home Assistant Operating System" %}, you need to use your host computer to delete all partitions *before* using it as a data disk again.
@@ -28,7 +28,7 @@ The data disk feature can be used on an existing installation without losing dat
1. Connect the data disk to your system.
2. Go to **{% my storage title="Settings > System > Storage" %}** in the UI.
-3. Select the "Move data disk" button.
+3. Select **Move data disk**.
4. Select the data disk from the list of available devices.
5. Select **Move**.
@@ -64,3 +64,41 @@ The system will prepare the data disk and immediately reboot. The reboot will ta
Using an USB attached SSD can draw quite some power. For instance on Raspberry Pi 3 the official Raspberry Pi power supply (PSU) only provides 2.5A which can be too tight. Use a more powerful power supply if you experience issues. Alternatively use a powered USB hub. Connect the Hub to one of the USB slots of your Raspberry Pi, and connect the SSD to the Hub. In this setup the power supply of the Hub will power the attached device(s).
+
+### Migrating an external data disk to another system
+
+This section shows how to move an external data disk from one system to another.
+This can be an option if the following elements apply to your use case:
+
+- You already have a functioning Home Assistant instance (system 1) that is using an external data disk.
+- You have another, new, Home Assistant instance (system 2).
+- You want now want to use the data disk of system 1 on system 2 instead.
+
+The aim is to migrate the data from system 1 to system 2. One way to do this is by [restoring a backup](/common-tasks/os/#restoring-a-backup). The other way is to move the data disk. This can be an interesting option if you have a large amount of data on your external disk or if your external disk has more storage capacity than your new system.
+
+#### Prerequisites
+
+- A Home Assistant instance using an external data disk (system 1)
+- A Home Assistant instance to which you want to move the external data disk (system 2)
+
+#### To migrate an external data disk to another system
+
+To migrate an external data disk from one system to another, follow these steps:
+
+1. [Create a backup](/common-tasks/os/#backups) of both systems and store these backups on another system (not strictly necessary, but recommended just in case, at least for the important data).
+2. Shut down system 1 and remove the data disk.
+3. Make sure system 2 has Home Assistant OS installed, and Home Assistant is up and running. Home Assistant is using the data disk (partition) on the boot drive (e.g. SD card) at this point.
+4. Make sure system 2 has completed the basic [onboarding](/getting-started/onboarding/) steps, including the last steps where devices are discovered automatically.
+5. Plug the external disk into system 2 and go to the **Settings** > **System**. Select the three dots menu, and **Restart Home Assistant** > **Reboot system**.
+ **Result**: A repair issue is displayed **Multiple data disks detected**.
+ - The repair issue comes up because system 2 now sees two file systems with an identical name. During a reboot, there is a name conflict with the existing data disk as it is undefined which file system should be used. This can lead to a random selection of the system you end up with. Hence you must make a decision.
+6. Open the repair issue and choose one of the options:
+ - Select **Use the detected data disk instead of the current system**.
+ - This will override the current file system of system 2 and use your external data disk instead.
+ - You won't have access anymore to the current Home Assistant data. It will be marked as inactive data disk.
+ - If you changed your mind about using the external data disk:
+ - Unplug the external data disk.
+ - If you cannot unplug the external data disk for some reason, select **Mark as inactive data disk (rename file system)**.
+ - This makes sure that there is no name conflict after rebooting.
+ - It also means you cannot use the file system that is stored on your external disk.
+ - You keep using the current file system of system 1.
diff --git a/source/_includes/common-tasks/define_custom_polling.md b/source/_includes/common-tasks/define_custom_polling.md
index bfa616483928..13b3e15f2d6f 100644
--- a/source/_includes/common-tasks/define_custom_polling.md
+++ b/source/_includes/common-tasks/define_custom_polling.md
@@ -1,6 +1,8 @@
-If you want to define a specific interval at which your device is being polled for data, you can disable the default polling interval and create your own polling service.
+If you want to define a specific interval at which your device is being polled for data, you can disable the default polling interval and create your own polling automation.
+
+To add the automation:
1. Go to {% my integrations title="**Settings** > **Devices & Services**" %}, and select your integration.
2. On the integration entry, select the three dots.
diff --git a/source/_includes/common-tasks/enable_entities.md b/source/_includes/common-tasks/enable_entities.md
index 25981da8629c..4b05c795dd79 100644
--- a/source/_includes/common-tasks/enable_entities.md
+++ b/source/_includes/common-tasks/enable_entities.md
@@ -1,12 +1,17 @@
-## Enabling entities
+## Enabling or disabling elements
Some entities are disabled by default. To enable them, follow these steps:
-1. Go to **{% my integrations title="Settings > Devices & Services" %}** and select the integration of interest.
-2. Select **entities**.
-3. From the list of entities, select the entity you want to enable.
- 
-4. In the pop-up, select the cogwheel.
-5. Toggle the **Enabled** button.
- 
-6. To save the changes, select **Update**.
+1. In Home Assistant, open the table of interest.
+ - To enable or disable entities, go to {% my entities title="**Settings** > **Devices & Services** > **Entities**" %}.
+ - To enable or disable automations, go to {% my automations title="**Settings** > **Automations & Scenes**" %}.
+2. [Enable multiselect](/docs/organizing/filtering) and select all the entities you want to enable or disable.
+3. In the top right corner, select the three dots menu, then select **Enable** or **Disable**.
+
+ 
+
+## Related topics
+
+- [Enable multiselect](/docs/organizing/filtering)
+- [Grouping your assets](/docs/organizing/)
+- [Filtering your assets](/docs/organizing/filtering)
diff --git a/source/_includes/common-tasks/enable_i2c.md b/source/_includes/common-tasks/enable_i2c.md
index 27877fd75f6d..8e89d4b89cd7 100644
--- a/source/_includes/common-tasks/enable_i2c.md
+++ b/source/_includes/common-tasks/enable_i2c.md
@@ -1,6 +1,6 @@
## Enable I2C
-Home Assistant using the Home Assistant Operating System which is a managed environment, which means you can't use existing methods to enable the I2C bus on a Raspberry Pi. In order to use I2C devices you will have to
+Home Assistant using the {% term "Home Assistant Operating System" %} which is a managed environment, which means you can't use existing methods to enable the I2C bus on a Raspberry Pi. In order to use I2C devices you will have to
- Enable I2C for the Home Assistant Operating System
- Setup I2C devices e.g. sensors
@@ -10,7 +10,7 @@ Home Assistant using the Home Assistant Operating System which is a managed envi
You will need:
- SD card reader
-- SD card with Home Assistant Operating System flashed on it
+- SD card with {% term "Home Assistant Operating System" %} flashed on it
Shutdown/turn-off your Home Assistant installation and unplug the SD card.
Plug the SD card into an SD card reader and find a drive/file system named
@@ -43,7 +43,7 @@ and make sure the first partition is available.
### Enable I2C via Home Assistant Operating System Terminal
-Alternatively, by attaching a keyboard and screen to your device, you can access the physical terminal to the Home Assistant Operating System.
+Alternatively, by attaching a keyboard and screen to your device, you can access the physical terminal to the {% term "Home Assistant Operating System" %}.
You can enable I2C via this terminal:
diff --git a/source/_includes/common-tasks/file_access.md b/source/_includes/common-tasks/file_access.md
index f7a3e7f464cf..f5d13a7c62f7 100644
--- a/source/_includes/common-tasks/file_access.md
+++ b/source/_includes/common-tasks/file_access.md
@@ -4,7 +4,7 @@ Your Home Assistant Operating server includes two repositories by default: The o
One of the first things to take care of after installing Home Assistant OS is to provide yourself access to files. There are several add-ons commonly used for this, and most users employ a mix of various add-ons. Default directories on the host are mapped to the add-ons so that they can be accessed by the services any particular add-on might provide. On the host system these directories exist on the `/data` partition at `/mnt/data/supervisor/`.
-Using any of the add-ons listed below,the following directories are made available for access:
+Using any of the add-ons listed below, the following directories are made available for access:
- `addons`
- `backup`
@@ -47,14 +47,37 @@ The Terminal & SSH add-on also provides a web terminal which allows you to acces
### Installing and using the Visual Studio Code (VSC) add-on
-The Visual Studio Code add-on provides access through a feature packed web-based version of the Visual Studio Code editor and currently only supports AMD64 and aarch64/ARM64 machines. This add-on can be installed in the add-on store from the Community add-on repository. The add-on also provides access to the Home Assistant Command Line Interface (CLI) using VSC's built in terminal, which allows for checking logs, stopping and starting Home Assistant and add-ons, creating/restoring backups, and more. (See [Home Assistant via Command Line](https://www.home-assistant.io/hassio/commandline/) for further info).
+The **Studio Code Server** add-on provides access through a feature-packed web-based version of the Visual Studio Code editor. It currently only supports AMD64 and aarch64/ARM64 machines. The add-on also provides access to the Home Assistant Command Line Interface (CLI) using VSC's built-in terminal, which allows for checking logs, stopping, and starting Home Assistant and add-ons, creating/restoring backups, and more. (See [Home Assistant via Command Line](/hassio/commandline/) for further info).
-There is no configuration required for editing files within your `/config` directory. In order to enable access to other directories, it is necessary to edit the add-on's configuration from its configuration tab. See the add-on documentation for details.
+
- You need to make sure you run a supported Home Assistant Supervised installation with the latest version of the [os-agent](https://github.com/home-assistant/os-agent). Make sure that your supervisor uses [slave bind propagation](https://docs.docker.com/storage/bind-mounts/#configure-bind-propagation) for the data volume.
+ You need to make sure you run a supported {% term "Home Assistant Supervised" %} installation with the latest version of the [os-agent](https://github.com/home-assistant/os-agent). Make sure that your supervisor uses [slave bind propagation](https://docs.docker.com/storage/bind-mounts/#configure-bind-propagation) for the data volume.
diff --git a/source/_includes/common-tasks/update.md b/source/_includes/common-tasks/update.md
index e4f924d70083..00498602479b 100644
--- a/source/_includes/common-tasks/update.md
+++ b/source/_includes/common-tasks/update.md
@@ -1,11 +1,9 @@
-## Update
+Best practice for updating Home Assistant Core:
-Best practice for updating a Home Assistant installation:
-
-1. Backup your installation{% if page.installation == "os" or page.installation == "supervised" %}, using the backup functionality Home Assistant offers{% endif %}.
+1. Backup your installation{% if page.installation == "os" or page.installation == "supervised" %}, using the [backup functionality](/common-tasks/os/#backups) Home Assistant offers{% endif %}.
2. Check the release notes for backward-incompatible changes on [Home Assistant release notes](/blog/categories/core/). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f` / `CMD + f`) and search for **Backward-incompatible changes**.
{% if page.installation == "os" or page.installation == "supervised" %}
-3. Select "Create backup before updating" in case you encounter an issue that requires a rollback.
+3. Select **Create backup before updating** in case you encounter an issue that requires a rollback.
4. Update Home Assistant.
5. Review persistent notifications and log to see if there are any issues with your configuration that need to be addressed.
{% endif %}
@@ -19,9 +17,9 @@ To update Home Assistant Core when you run Home Assistant {{ page.installation_n
- title: Using the UI
content: |
- 1. Open your Home Assistant UI
- 2. Navigate to the Settings panel
- 3. On the top you will be presented with an update notification
+ 1. Open your Home Assistant UI.
+ 2. Navigate to the **Settings** panel.
+ 3. On the top you will be presented with an update notification.
_If you do not see that notification you can click the overflow menu in the top right and select "Check for updates"._
diff --git a/source/_includes/dashboard/edit_dashboard.md b/source/_includes/dashboard/edit_dashboard.md
index d826f6906b9f..0e5d9dd0bb1a 100644
--- a/source/_includes/dashboard/edit_dashboard.md
+++ b/source/_includes/dashboard/edit_dashboard.md
@@ -3,6 +3,10 @@
{% capture title %}{{ include.title | default: page.title }}{% endcapture %}
To add the {{ title | downcase }} to your user interface:
-1. In the top right of the screen, select the three dots menu and then select **Edit dashboard**.
- - By editing the dashboard, you are taking over control of this dashboard. This means that it is no longer automatically updated when new dashboard elements become available. To continue, in the dialog, select **Take control**.
-2. In the bottom right corner, select the **Add card** button and select from the card picker.
+
+1. In the top right of the screen, select the pencil icon.
+ - If this is your first time editing a dashboard, the **Edit dashboard** dialog appears.
+ - By editing the dashboard, you are taking over control of this dashboard.
+ - This means that it is no longer automatically updated when new dashboard elements become available.
+ - To continue, in the dialog, select the three dots menu, then select **Take control**.
+2. [Add a card](/dashboards/cards/#adding-cards-to-your-dashboard) to your dashboard.
diff --git a/source/_includes/installation/container.md b/source/_includes/installation/container.md
index 554a30af4302..6dbf16734afd 100644
--- a/source/_includes/installation/container.md
+++ b/source/_includes/installation/container.md
@@ -1,7 +1,7 @@
## Install Home Assistant Container
{% if page.installation_type != 'alternative' %}
-These below instructions are for an installation of Home Assistant Container running in your own container environment, which you manage yourself. Any [OCI](https://opencontainers.org/) compatible runtime can be used, however this guide will focus on installing it with Docker.
+These below instructions are for an installation of {% term "Home Assistant Container" %} running in your own container environment, which you manage yourself. Any [OCI](https://opencontainers.org/) compatible runtime can be used, however this guide will focus on installing it with Docker.
-AfterShip recently removed the tracking API functionality from the Forever Free plan. The tracking API functionality requires at least the Essentials plan.
+AfterShip removed the Tracking API functionality from the Forever Free plan, and also no longer offers it in the Essentials plan. Using this integration now requires at least the [Pro](https://www.aftership.com/pricing/tracking) plan.
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/air_quality.markdown b/source/_integrations/air_quality.markdown
index 370e6f6c187e..0fc8d32f0a3f 100644
--- a/source/_integrations/air_quality.markdown
+++ b/source/_integrations/air_quality.markdown
@@ -1,5 +1,5 @@
---
-title: Air Quality
+title: Air quality
description: Instructions on how to add air quality sensors with Home Assistant
ha_release: 0.85
ha_domain: air_quality
@@ -10,7 +10,7 @@ ha_codeowners:
ha_integration_type: entity
---
-The `air_quality` base platform allows other integrations to process information about air quality and pollution details. It is used by integrations that provide an `air_quality` sensor - you can find those under the `health` [integrations](/integrations/#health).
+The **Air quality** {% term integration %} allows other integrations to process information about air quality and pollution details. It is used by integrations that provide an `air_quality` sensor - you can find those under the `health` [integrations](/integrations/#health).
The platforms cover the following levels (if they are available):
diff --git a/source/_integrations/airnow.markdown b/source/_integrations/airnow.markdown
index 137c2a247d33..26eacd1770ab 100644
--- a/source/_integrations/airnow.markdown
+++ b/source/_integrations/airnow.markdown
@@ -20,10 +20,20 @@ as a source for air quality data for your location.
## Setup
-To generate an AirNow API key, go to the [AirNow Developer Tools Page](https://docs.airnowapi.org/account/request/) page.
+To generate an AirNow API key, go to the [AirNow Developer Tools](https://docs.airnowapi.org/account/request/) page.
{% include integrations/config_flow.md %}
+## Troubleshooting
+
+The EPA AirNow API is often flaky and will occasionally not return any results for a particular location. This will prevent the integration from being added to Home Assistant, but the situation is usually temporary and will resolve itself later.
+
+If the integration continues to report "No results found for that location" and cannot be added to Home Assistant, please do the following before submitting a bug report.
+
+First, navigate to the [AirNow Current Observations By Lat/Lon](https://docs.airnowapi.org/CurrentObservationsByLatLon/query) page, enter the same latitude/longitude and station radius, select `application/json` as the output format, select "Build" and then "Run".
+
+If the query returns a result other than `[]`, open a bug report and include the query result (you may sanitize the data to remove your latitude and longitude, but please do not remove any fields). This information will help a lot to figure out the source of the issue.
+
diff --git a/source/_dashboards/area.markdown b/source/_dashboards/area.markdown
index 6d9acaa9afcf..be21b487ee8f 100644
--- a/source/_dashboards/area.markdown
+++ b/source/_dashboards/area.markdown
@@ -3,9 +3,14 @@ type: card
title: "Area card"
sidebar_label: Area
description: "The area card gives control of your entities in a specified area."
+related:
+ - docs: /integrations/frontend/
+ title: Themes
+ - docs: /dashboards/cards/
+ title: Dashboard cards
---
-The area card lets you control and monitor an individual area.
+The area card lets you control and monitor an individual {% term area %}.
@@ -16,9 +21,9 @@ The area card lets you control and monitor an individual area.
All options for this card can be configured via the user interface.
-Buttons will appear on the card for the entities in the area including fan, light and switch. A motion sensor icon will appear in the top left if a motion sensor is in the area and motion is detected by the motion sensor.
+Buttons will appear on the card for the {% term entities %} in the area including fan, light, and switch. A motion sensor icon will appear in the top left if a motion sensor is in the area and if motion is detected by the motion sensor.
-If a camera is added to the area you can show the camera feed instead of the area picture.
+If a camera is added to the {% term area %} you can show the camera feed instead of the area picture.
## YAML configuration
@@ -56,6 +61,16 @@ theme:
required: false
description: Override the used theme for this card with any loaded theme. For more information about themes, see the [frontend documentation](/integrations/frontend/).
type: string
+alert_classes:
+ required: false
+ type: list
+ default: "moisture, motion"
+ description: A list of binary sensor device classes which will populate alert icons in the card when the state is on.
+sensor_classes:
+ required: false
+ type: list
+ default: "temperature, humidity"
+ description: A list of sensor device classes which will display their averaged sensor readings for the area.
{% endconfiguration %}
### Example
diff --git a/source/_dashboards/button.markdown b/source/_dashboards/button.markdown
index 88ce2c1eba71..c7eed878e8cf 100644
--- a/source/_dashboards/button.markdown
+++ b/source/_dashboards/button.markdown
@@ -3,6 +3,15 @@ type: card
title: "Button card"
sidebar_label: Button
description: "The Button card allows you to add buttons to perform tasks."
+related:
+ - docs: /dashboards/actions/
+ title: Card actions
+ - docs: /docs/scripts/
+ title: Scripts
+ - docs: /integrations/frontend/
+ title: Themes
+ - docs: /dashboards/cards/
+ title: Dashboard cards
---
The button card allows you to add buttons to perform tasks.
diff --git a/source/_dashboards/calendar.markdown b/source/_dashboards/calendar.markdown
index 18ae6b31661c..940a45c7fe69 100644
--- a/source/_dashboards/calendar.markdown
+++ b/source/_dashboards/calendar.markdown
@@ -3,9 +3,14 @@ type: card
title: "Calendar card"
sidebar_label: Calendar
description: "The calendar card displays your calendar entities in a month, day and list view"
+related:
+ - docs: /integrations/frontend/
+ title: Themes
+ - docs: /dashboards/cards/
+ title: Dashboard cards
---
-The calendar card displays your [calendar](/integrations/#calendar) entities in a month, day and list view (7 days).
+The calendar card displays your [calendar](/integrations/#calendar) {% term entities %} in a month, day, and list view (7 days).
 entities in
All options for this card can be configured via the user interface.
-## Card settings
-
-{% configuration_basic %}
-Title:
- description: The title displayed at the top of the card.
-Initial View:
- description: "The view that will show first when the card is loaded onto the page. Options are `Month View`, `Day View`, or `List (7 days)`."
-Entities:
- description: The calendar entities that will be displayed in the card.
-Theme:
- description: Name of any loaded theme to be used for this card. For more information about themes, see the [frontend documentation](/integrations/frontend/).
-{% endconfiguration_basic %}
-
## YAML configuration
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
diff --git a/source/_dashboards/conditional.markdown b/source/_dashboards/conditional.markdown
index ac25d30af4ff..ead8ea37a11b 100644
--- a/source/_dashboards/conditional.markdown
+++ b/source/_dashboards/conditional.markdown
@@ -1,13 +1,16 @@
---
type: card
-title: Conditional Card
+title: Conditional card
sidebar_label: Conditional
description: The Conditional card displays another card based on conditions.
+related:
+ - docs: /dashboards/cards/
+ title: Dashboard cards
---
The conditional card displays another card based on conditions.
-Note: if there are multiple conditions there will be treated as an](/images/dashboards/calendar_card.png "energy configuration page")
-This card will allow you to pick what data to show. Changing it in this card will influence the data in all other cards.
+This card allows you to pick what data to show. Changing it in this card will influence the data in all other cards.
Specific dates and ranges can be selected by opening the date range picker. The current period can be compared to the previous one using the compare data option within the menu.
### Example
+
```yaml
type: energy-date-selection
```
@@ -35,6 +41,7 @@ The energy usage graph card shows the amount of energy your house has consumed,
It will also show the amount of energy your have returned to the grid.
### Example
+
```yaml
type: energy-usage-graph
```
@@ -49,6 +56,7 @@ type: energy-usage-graph
The solar production graph card shows the amount of energy your solar panels have produced per source, and if setup and available the forecast of the solar production.
### Example
+
```yaml
type: energy-solar-graph
```
@@ -97,6 +105,7 @@ If setup, it will also tell you how many kWh of the energy you got from the grid
If you set `link_dashboard` to `true`, the card will include a link to the energy dashboard.
### Example
+
```yaml
type: energy-distribution
link_dashboard: true
@@ -113,6 +122,7 @@ The energy sources table card shows all your energy sources, and the correspondi
If setup, it will also show the costs and compensation per source and the total.
### Example
+
```yaml
type: energy-sources-table
```
@@ -127,6 +137,7 @@ type: energy-sources-table
The grid neutrality gauge card represents your energy dependency. If the needle is in the purple, you returned more energy to the grid than you consumed from it. If it's in the blue, you consumed more energy from the grid than you returned.
### Example
+
```yaml
type: energy-grid-neutrality-gauge
```
@@ -141,6 +152,7 @@ type: energy-grid-neutrality-gauge
The solar consumed gauge represents how much of the solar energy was used by your home and was not returned to the grid. If you frequently return a lot, try to conserve this energy by installing a battery or buying an electric car to charge.
### Example
+
```yaml
type: energy-solar-consumed-gauge
```
@@ -155,6 +167,7 @@ type: energy-solar-consumed-gauge
The carbon consumed gauge card represents how much of the energy consumed by your home was generated using non-fossil fuels like solar, wind and nuclear. It includes the solar energy you generated your self.
### Example
+
```yaml
type: energy-carbon-consumed-gauge
```
@@ -169,6 +182,7 @@ type: energy-carbon-consumed-gauge
The self-sufficiency gauge represents how self-sufficient your home is. If you rely on grid imports, this value decreases. You can increase this value by adding more solar capacity or battery storage.
### Example
+
```yaml
type: energy-self-sufficiency-gauge
```
@@ -196,3 +210,27 @@ The following example limits the number of shown devices to 5:
type: energy-devices-graph
max_devices: 5
```
+
+## Detail devices energy graph
+
+
+ Screenshot of the detail devices energy graph card.
+
Windy weather radar as webpage.
@@ -16,6 +23,7 @@ The webpage card allows you to embed your favorite webpage right into Home Assis
All options for this card can be configured via the user interface.
+Note that not every webpage can be embedded due to security restrictions that some sites have in place. These restrictions are enforced by your browser and prevent embedding them into a Home Assistant dashboard.
@@ -38,6 +45,11 @@ auto_fit:
description: The map will follow moving `entities` by adjusting the viewport of the map each time an entity is updated.
type: boolean
default: false
+fit_zones:
+ required: false
+ description: Whether the map should consider the zones in the list of specified entities when fitting its viewport.
+ type: boolean
+ default: false
title:
required: false
description: The card title.
@@ -51,11 +63,11 @@ default_zoom:
description: The default zoom level of the map.
type: integer
default: 14 (or whatever zoom level is required to fit all visible markers)
-dark_mode:
+theme_mode:
required: false
- description: Enable a dark theme for the map.
- type: boolean
- default: false
+ description: 'Override the theme to force the map to display in either a light mode (`theme_mode: light`) or a dark mode (`theme_mode: dark`). Default (`theme_mode: auto`) will follow the theme settings.'
+ type: string
+ default: 'auto'
hours_to_show:
required: false
description: Shows a path of previous locations. Hours to show as path on the map.
@@ -129,3 +141,4 @@ entities:
focus: false
hours_to_show: 48
```
+
diff --git a/source/_dashboards/markdown.markdown b/source/_dashboards/markdown.markdown
index f1886128004b..d6145a082b24 100644
--- a/source/_dashboards/markdown.markdown
+++ b/source/_dashboards/markdown.markdown
@@ -3,6 +3,11 @@ type: card
title: "Markdown card"
sidebar_label: Markdown
description: "The Markdown card is used to render Markdown"
+related:
+ - docs: /integrations/frontend/
+ title: Themes
+ - docs: /dashboards/cards/
+ title: Dashboard cards
---
The Markdown card is used to render [Markdown](https://commonmark.org/help/).
diff --git a/source/_dashboards/masonry.markdown b/source/_dashboards/masonry.markdown
index 76615e5cd524..6bbf31ccef2f 100644
--- a/source/_dashboards/masonry.markdown
+++ b/source/_dashboards/masonry.markdown
@@ -2,11 +2,29 @@
type: view
title: Masonry view
sidebar_label: Masonry (default)
-description: "The default panel layout uses a masonry algorithme."
+description: "The default panel layout uses a masonry algorithm."
+related:
+ - docs: /dashboards/panel/
+ title: Panel view
+ - docs: /dashboards/sidebar/
+ title: Sidebar view
---
The masonry view is the default view type.
-It sorts cards in columns based on their `card size`. If you want to group some cards you have to use `stack` or `grid` cards.
+
+
+Screenshot of the masonry view.
+
+Masonry arranges cards based on size.
+
+Screenshot of the panel view.
+
+ A fully populated dashboard in Sections view layout
+
button.
+ - If you leave the section title empty, this line will be hidden.
+7. To delete a section, select the 
button.
+
+## Rearranging sections and cards
+
+In the sections view, you can rearrange sections and cards by dragging them to a new location. This is not yet possible in other views.
+
+1. To edit your dashboard, in the top right corner, select the pencil icon.
+2. To rearrange sections, hold the 
button and move the card.
+
+ 
+ Rearranging sections by dragging
+ 
+ Rearranging cards by dragging
+ 
+Screenshot of the sidebar view used for the energy dashboard.
+
+Screenshot showing how to move a card between sidebar and main view.
+
+ 
Screenshot of the thermostat card.
@@ -33,7 +40,7 @@ icon:
type: string
color:
required: false
- description: Set the color when the entity is active. By default, the color is based on `state`, `domain`, and `device_class` of your entity. It accepts [color token](/dashboards/tile/#available-color-tokens) or hex color code.
+ description: Set the color when the entity is active. By default, the color is based on `state`, `domain`, and `device_class` of your entity. It accepts [color token](/dashboards/tile/#available-colors) or hex color code.
type: string
default: state
show_entity_picture:
@@ -126,6 +133,7 @@ features:
- return_home
```
-## Available color tokens
+## Available colors
+
+You want to colorize the tile card? Choose one of the following colors: `primary`, `accent`, `disabled`, `red`, `pink`, `purple`, `deep-purple`, `indigo`, `blue`, `light-blue`, `cyan`, `teal`, `green`, `light-green`, `lime`, `yellow`, `amber`, `orange`, `deep-orange`, `brown`, `grey`, `blue-grey`, `black` and `white`.
-Some color tokens are available to colorize the tile card : `primary`, `accent`, `disabled`, `red`, `pink`, `purple`, `deep-purple`, `indigo`, `blue`, `light-blue`, `cyan`, `teal`, `green`, `light-green`, `lime`, `yellow`, `amber`, `orange`, `deep-orange`, `brown`, `grey`, `blue-grey`, `black` and `white`.
\ No newline at end of file
diff --git a/source/_dashboards/todo-list.markdown b/source/_dashboards/todo-list.markdown
new file mode 100644
index 000000000000..846d6cfd7f28
--- /dev/null
+++ b/source/_dashboards/todo-list.markdown
@@ -0,0 +1,74 @@
+---
+type: card
+title: "To-do list card"
+sidebar_label: To-do list
+description: "The to-do list card allows you to add, edit, check-off, and clear items from your to-do list."
+related:
+ - docs: /dashboards/dashboards/
+ title: Dashboards
+ - docs: /integrations/frontend/
+ title: Themes
+ - docs: /dashboards/cards/
+ title: Dashboard cards
+ - docs: /integrations/todo
+ title: To-do list integration documentation
+ - docs: /integrations/#to-do-list
+ title: List of to-do list integrations
+ - docs: /integrations/local_todo/
+ title: Local to-do integration
+---
+
+The to-do list card allows you to add, edit, check-off, and clear items from your to-do list.
+
+
+Screenshot of the to-do list card.
+
Create a grid layout using vertical and horizontal stack.
+
diff --git a/source/_dashboards/weather-forecast.markdown b/source/_dashboards/weather-forecast.markdown
index 5e6f3a4e1980..2ef074996505 100644
--- a/source/_dashboards/weather-forecast.markdown
+++ b/source/_dashboards/weather-forecast.markdown
@@ -3,6 +3,11 @@ type: card
title: "Weather forecast card"
sidebar_label: Weather forecast
description: "The weather forecast card displays the weather. Very useful to include on interfaces that people display on the wall."
+related:
+ - docs: /integrations/frontend/
+ title: Themes
+ - docs: /dashboards/cards/
+ title: Dashboard cards
---
The weather forecast card displays the weather. This card is particularly useful on wall-mounted displays.
diff --git a/source/_data/glossary.yml b/source/_data/glossary.yml
index af8e517f322a..4b0ed4611a53 100644
--- a/source/_data/glossary.yml
+++ b/source/_data/glossary.yml
@@ -3,20 +3,30 @@
# Format is a list of terms, each term is a dictionary with the following keys:
# - term: The term to define (required)
# - definition: The definition of the term (required)
-# - excerpt: Short excerpt of the definition, overrides definition for tooltips (optional)
+# - excerpt: Short excerpt of the definition, overrides definition for tooltips
+# (optional)
# - link: A URL to link to for more information (optional)
# - aliases: A list of aliases for the term (optional)
#
- term: Action
definition: |-
- Actions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*.
- Actions use service calls and/or scenes to interact with entities and cause these entities to do something. Actions can also include conditions and a delay. An action can call multiple services at the same time. For example, if your presence is detected in a room, an action may call one service to turn on a light and call another service to start playing music after a delay.
- Actions are also used on the dashboard, for example as tap or hold action on a UI element. When triggered, the action calls a service.
+ Actions are used in several places in Home Assistant. As part of a script or
+ automation, actions define what is going to happen once a trigger is
+ activated. In scripts, an action is called *sequence*. Actions use service
+ calls and/or scenes to interact with entities and cause these entities to do
+ something. Actions can also include conditions and a delay. An action can
+ call multiple services at the same time. For example, if your presence is
+ detected in a room, an action may call one service to turn on a light and
+ call another service to start playing music after a delay. Actions are also
+ used on the dashboard, for example as tap or hold action on a UI element.
+ When triggered, the action calls a service.
aliases:
- actions
link: /docs/automation/action/
excerpt: >
- Actions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*.
+ Actions are used in several places in Home Assistant. As part of a script or
+ automation, actions define what is going to happen once a trigger is
+ activated. In scripts, an action is called *sequence*.
- term: Add-on
definition: >-
Add-ons are additional standalone third-party software packages that can be
@@ -28,21 +38,29 @@
installed on Home Assistant OS.
- term: Area
definition: >-
- Locations within your home such as living room, dance floor, etc.
- Devices can be associated to an area for easier sorting and automatically
- generated cards, such as the [Area card](/dashboards/area/).
+ An area in Home Assistant is a logical grouping of devices and entities that
+ are meant to match areas (or rooms) in the physical world: your home. For
+ example, the `living room` area groups devices and entities in your living
+ room. Areas allow you to target service calls at an entire group of devices.
+ For example, turning off all the lights in the living room. Locations within
+ your home such as living room, dance floor, etc. Areas can be assigned to
+ floors. Areas can also be used for automatically generated cards, such as
+ the [Area card](/dashboards/area/).
excerpt: >-
- Places within your home such as rooms, spaces, etc.
+ An area in Home Assistant is a logical grouping of devices and entities that
+ are meant to match areas (or rooms) in the physical world: your home. For
+ example, the `living room` area groups devices and entities in your living
+ room.
aliases:
- areas
- term: Automation
definition: >-
- Automations connect one or more triggers to one or more actions in a
- 'when trigger then do action' fashion with additional optional conditions.
- For example, an automation might connect the trigger 'sunset' to the action
+ Automations connect one or more triggers to one or more actions in a 'when
+ trigger then do action' fashion with additional optional conditions. For
+ example, an automation might connect the trigger 'sunset' to the action
'turn the lights on' but only if the condition 'someone is home' is met.
- Pre-made automations for common use-cases are available via
- [the blueprints feature](/docs/automation/using_blueprints/).
+ Pre-made automations for common use-cases are available via [the blueprints
+ feature](/docs/automation/using_blueprints/).
excerpt: >-
Automations in Home Assistant allow you to automatically respond to things
that happen in and around your home.
@@ -51,14 +69,14 @@
- automations
- term: Backup
definition: >-
- Home Assistant has built-in functionality to create files containing a copy of
- your configuration. This can be used to restore your Home Assistant as well
- as migrate to a new system. The backup feature is available on some installation
- types.
+ Home Assistant has built-in functionality to create files containing a copy
+ of your configuration. This can be used to restore your Home Assistant as
+ well as migrate to a new system. The backup feature is available on some
+ installation types.
link: /integrations/backup/
excerpt: >-
- Home Assistant has built-in functionality to create files containing a copy of
- your configurations. This is available on certain installation types.
+ Home Assistant has built-in functionality to create files containing a copy
+ of your configurations. This is available on certain installation types.
aliases:
- backups
- term: Binary sensor
@@ -68,41 +86,85 @@
link: /integrations/binary_sensor
- term: Blueprint
definition: >-
- A blueprint is a script or automation configuration with certain parts marked as configurable. This allows users to create multiple scripts or automations based on the same blueprint, with each having its own configuration-specific settings. Blueprints are shared by the community on the [blueprints exchange](https://community.home-assistant.io/c/blueprints-exchange/53) in the forum.
+ A blueprint is a script or automation configuration with certain parts
+ marked as configurable. This allows users to create multiple scripts or
+ automations based on the same blueprint, with each having its own
+ configuration-specific settings. Blueprints are shared by the community on
+ the [blueprints
+ exchange](https://community.home-assistant.io/c/blueprints-exchange/53) in
+ the forum.
link: /docs/blueprint/
excerpt: >-
- A blueprint is a script or automation configuration with certain parts marked as configurable. This allows users to create multiple scripts or automations based on the same blueprint, with each having its own configuration-specific settings.
+ A blueprint is a script or automation configuration with certain parts
+ marked as configurable. This allows users to create multiple scripts or
+ automations based on the same blueprint, with each having its own
+ configuration-specific settings.
aliases:
- blueprints
+- term: Category
+ definition: >-
+ A category is an organization tool that allows grouping items in a table.
+ Like labels, categories allow grouping irrespective of the items' physical
+ location. For example, on the automations page, you can create the
+ categories “Notifications” or “NFC tags” to view your automations grouped or
+ filtered. Categories are unique for each table. The automations page can
+ have different categories than the scene, scripts, or helpers settings page.
+ aliases:
+ - categories
+- term: Commissioning
+ definition: >-
+ In the context of Matter devices, *commissioning* is the process of adding a
+ device to a Matter controller. It is the equivalent of pairing a device in
+ Zigbee or Z-Wave. Commissioning is done by scanning a QR code or entering a
+ code manually. The code is printed on the device or its packaging. The code
+ contains information about the device, such as its type, manufacturer, and
+ serial number. The controller uses this information to identify the device
+ and to download the required information to control the device. For example,
+ the controller downloads the device's capabilities, such as the supported
+ commands and the available attributes. The controller also downloads the
+ device's configuration, such as the device's name and location.
+ link: /integrations/matter/
+ aliases:
+ - commission
+ excerpt: >
+ In the context of Matter devices, *commissioning* is the process of adding a
+ device to a Matter controller. It is the equivalent of pairing a device in
+ Zigbee or Z-Wave.
- term: Component
definition: >-
Better known as: Integrations. Integrations used to be known as components.
- term: Condition
definition: >-
- Conditions are an optional part of an automation that will prevent an
- action from firing if they are not met.
+ Conditions are an optional part of an automation that will prevent an action
+ from firing if they are not met.
link: /docs/scripts/conditions/
aliases:
- conditions
- term: Cover
definition: >-
- Covers are devices such as blinds, garage doors, etc that can be opened
- and closed and optionally set to a specific position.
+ Covers are devices such as blinds, garage doors, etc that can be opened and
+ closed and optionally set to a specific position.
link: /integrations/cover
- term: Customize
definition: >-
- Customization allows you to overwrite the default parameters of your
- devices in the configuration.
+ Customization allows you to overwrite the default parameters of your devices
+ in the configuration.
- term: Device
definition: |-
- A device is a model representing a physical or logical unit that contains entities.
- **Example for a device as a physical unit**
- A smart plug named 'Coffee machine' which provides 2 entities: a `switch` entity to turn power on or off ('Coffee machine power switch') and a `sensor` entity for power monitoring ('Coffee machine power sensor').
- **Example for a device as a logical unit**
- An ecobee thermostat with 4 room sensors. This thermostat is seen as 5 devices in Home Assistant: 1 device for the thermostat with 4 sensors, and 1 device for each room sensor. Each device can be in a different area and may have more than one input or output within that area.
- Devices have properties such as ID, manufacturer, name, model, hardware version, firmware version, connections, etc.
+ A device is a model representing a physical or logical unit that contains
+ entities. **Example for a device as a physical unit** A smart plug named
+ 'Coffee machine' which provides 2 entities: a `switch` entity to turn power
+ on or off ('Coffee machine power switch') and a `sensor` entity for power
+ monitoring ('Coffee machine power sensor'). **Example for a device as a
+ logical unit** An ecobee thermostat with 4 room sensors. This thermostat is
+ seen as 5 devices in Home Assistant: 1 device for the thermostat with 4
+ sensors, and 1 device for each room sensor. Each device can be in a
+ different area and may have more than one input or output within that area.
+ Devices have properties such as ID, manufacturer, name, model, hardware
+ version, firmware version, connections, etc.
excerpt: >
- A device is a model representing a physical or logical unit that contains entities.
+ A device is a model representing a physical or logical unit that contains
+ entities.
aliases:
- devices
- term: Device tracker
@@ -115,35 +177,43 @@
they are discovered.
- term: Domain
definition: >-
- Each integration in Home Assistant has a unique identifier:
- a domain. All of the entities and services available in Home Assistant
- are provided by integrations and thus belong to such a domain. The first
- part of the entity or service, before the `.` shows the domain they belong
- to. For example `light.kitchen` is an entity in the `light` domain from
- the [light integration](/integrations/light), while `hue.activate_scene`
- is the `activate_scene` service for the `hue` domain which belongs to
- the [Hue integration](/integrations/hue).
+ Each integration in Home Assistant has a unique identifier: a domain. All of
+ the entities and services available in Home Assistant are provided by
+ integrations and thus belong to such a domain. The first part of the entity
+ or service, before the `.` shows the domain they belong to. For example
+ `light.kitchen` is an entity in the `light` domain from the [light
+ integration](/integrations/light), while `hue.activate_scene` is the
+ `activate_scene` service for the `hue` domain which belongs to the [Hue
+ integration](/integrations/hue).
excerpt: >
- Each integration in Home Assistant has a unique identifier: The domain.
- It is often shown as the first part (before the dot) of entity IDs.
+ Each integration in Home Assistant has a unique identifier: The domain. It
+ is often shown as the first part (before the dot) of entity IDs.
aliases:
- domains
- term: Entity
definition: |-
- An entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. Entities have states.
- **Example for entities as part of a device**
- A combined temperature and humidity sensor device provides two sensor entities. One for temperature (e.g. `sensor.temperature` with state `21.0` and unit `°C`) and one for humidity
- (e.g. `sensor.humidity` with state `65.4` and unit `%`).
- **Example for entities as part of a service**
- A weather service that provides 3 entities: wind speed, air pressure, and ozon level.
- **Example of an entity used for control**
- A fan that is turned on when the temperature exceeds 30 °C.
- There are standardized types of entities for common integrations such as light, switch, camera, sensor, fan, or vacuum.
- Some entities are not part of a device or service. Examples of standalone entities are automation, script, scene entities, and helper entities (e.g. input helpers).
- Most properties of entities are related to the state. Entities have optional attributes such as friendly name, unit of measurement, and an icon or picture that can be displayed in the frontend.
+ An entity represents a sensor, actor, or function in Home Assistant.
+ Entities are used to monitor physical properties or to control other
+ entities. An entity is usually part of a device or a service. Entities have
+ states. **Example for entities as part of a device** A combined temperature
+ and humidity sensor device provides two sensor entities. One for temperature
+ (e.g. `sensor.temperature` with state `21.0` and unit `°C`) and one for
+ humidity (e.g. `sensor.humidity` with state `65.4` and unit `%`). **Example
+ for entities as part of a service** A weather service that provides 3
+ entities: wind speed, air pressure, and ozon level. **Example of an entity
+ used for control** A fan that is turned on when the temperature exceeds
+ 30 °C. There are standardized types of entities for common integrations
+ such as light, switch, camera, sensor, fan, or vacuum. Some entities are not
+ part of a device or service. Examples of standalone entities are automation,
+ script, scene entities, and helper entities (e.g. input helpers). Most
+ properties of entities are related to the state. Entities have optional
+ attributes such as friendly name, unit of measurement, and an icon or
+ picture that can be displayed in the frontend.
link: /docs/configuration/state_object/
excerpt: >
- An entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service.
+ An entity represents a sensor, actor, or function in Home Assistant.
+ Entities are used to monitor physical properties or to control other
+ entities. An entity is usually part of a device or a service.
aliases:
- entities
- term: Event
@@ -152,10 +222,28 @@
link: /docs/configuration/events/
aliases:
- events
+- term: Floor
+ definition: >-
+ A floor in Home Assistant is a logical grouping of areas that are meant to
+ match the physical floors in your home. Devices & entities are not assigned
+ to floors but to areas. A floor has properties such as: Floor ID, name,
+ aliases (for use in assistants), an icon, and a floor level. Some of these
+ properties are optional. The level number can be negative to reflect floors
+ below the basement. Floors can be used in automations and scripts as a
+ target for actions. For example, to turn off all the lights on the
+ downstairs floor when you go to bed.
+ excerpt: >-
+ A floor in Home Assistant is a logical grouping of areas that are meant to
+ match the physical floors in your home. Devices & entities are not assigned
+ to floors but to areas. Floors can be used in automations and scripts as a
+ target for actions. For example, to turn off all the lights on the
+ downstairs floor when you go to bed.
+ aliases:
+ - floors
- term: Frontend
definition: >-
- The frontend is a necessary component for the UI, it is also where you
- can define your themes.
+ The frontend is a necessary component for the UI, it is also where you can
+ define your themes.
link: /integrations/frontend/
- term: Group
definition: >-
@@ -165,66 +253,90 @@
- groups
- term: HASS
definition: >-
- HASS or [hass](/docs/tools/hass/) is often used as an abbreviation for
- Home Assistant. It is also the command-line tool.
+ HASS or [hass](/docs/tools/hass/) is often used as an abbreviation for Home
+ Assistant. It is also the command-line tool.
- term: HassOS
definition: >-
Another name for Home Assistant Operating System
link: /hassio/installation/
+- term: Home Assistant Container
+ definition: >-
+ Home Assistant Container is a standalone container-based installation of
+ Home Assistant Core. Any [OCI](https://opencontainers.org/) compatible
+ runtime can be used, but the documentation focus is on Docker.
+ link: /installation/#advanced-installation-methods
- term: Home Assistant Core
definition: >-
- Home Assistant Core is a Python program. It can be run on various operating
- systems and is the basis for Home Assistant. When people are talking about
- Home Assistant Core they usually refer to a standalone installation method
- that can be installed using a Virtual Environment or Docker. Home Assistant
- Core does not use the Home Assistant Supervisor.
+ Home Assistant Core is the Python program at the heart of Home Assistant. It
+ is part of all of the four installation types and can be run on various
+ operating systems. It can be installed standalone (without Home Assistant
+ Supervisor), using a Virtual Environment (typically referred to as Home
+ Assistant Core installation method) or as a container using Docker
+ (typically referred to as Home Assistant Container installation method).
+ link: /installation/#advanced-installation-methods
excerpt: >
- Home Assistant Core is the hart of Home Assistant itself. It is a Python
- program that powers every installation type, but can be installed standalone.
+ Home Assistant Core is the heart of Home Assistant itself. It is a Python
+ program that powers every installation type, but can be installed
+ standalone.
- term: Home Assistant Supervised
definition: >-
- Home Assistant Supervised is a full UI managed home automation ecosystem that
- runs Home Assistant, the Home Assistant Supervisor and add-ons. It comes
- pre-installed on Home Assistant OS, but can be installed on any Linux system.
- It leverages Docker, which is managed by the Home Assistant Supervisor.
+ Home Assistant Supervised is a full UI managed home automation ecosystem
+ that runs the Home Assistant Core program, the Home Assistant Supervisor and
+ add-ons. It comes pre-installed on Home Assistant OS, but can be installed
+ standalone on Debian Linux systems. It leverages Docker, which is managed by
+ the Home Assistant Supervisor.
excerpt: >
Home Assistant Supervised is the full Home Assistant ecosystem, without the
Home Assistant Operating System.
+ link: /installation/#advanced-installation-methods
- term: Home Assistant Supervisor
definition: >-
The Home Assistant Supervisor is a program that manages a Home Assistant
installation, taking care of installing and updating Home Assistant,
- add-ons, itself and, if used, updating the Home Assistant Operating System.
+ add-ons, itself, and, if used, updating the Home Assistant Operating System.
+ link: /installation/#advanced-installation-methods
- term: Home Assistant Operating System
definition: >-
Home Assistant OS, the Home Assistant Operating System, is an embedded,
minimalistic, operating system designed to run the Home Assistant ecosystem
- on single board computers (like the Raspberry Pi) or Virtual Machines.
- The Home Assistant Supervisor can keep it up to date, removing the need for
- you to manage an operating system.
+ on single board computers (like the Raspberry Pi) or Virtual Machines. It
+ includes Home Assistant Core, the Home Assistant Supervisor, and supports
+ add-ons. Home Assistant Supervisor keeps it up to date, removing the need
+ for you to manage an operating system. Home Assistant Operating System is
+ the recommended installation method for most users.
excerpt: >
Home Assistant OS, the Home Assistant Operating System, is an embedded,
minimalistic, operating system designed to run the Home Assistant ecosystem.
+ It is the recommended installation method for most users.
+ link: /installation/#advanced-installation-methods
- term: Host
definition: >-
- A device that can communicate with other devices on a network. During setup and configuration,
- an input requesting a **Host** typically refers to a device's network address so that
- Home Assistant can attempt to connect to it. This may be in the form of a hostname, URL,
- IP address or some other type of network identifier. If you do not know the hostname or IP address of a device, you can find it in your router's webinterface. For example, if your device is connected wirelessly, somewhere there is a page listing all the devices that are connected to your network. It depends on your router, where exactly this page is. It could be under **Network** > **Wireless**.
+ A device that can communicate with other devices on a network. During setup
+ and configuration, an input requesting a **Host** typically refers to a
+ device's network address so that Home Assistant can attempt to connect to
+ it. This may be in the form of a hostname, URL, IP address or some other
+ type of network identifier. If you do not know the hostname or IP address of
+ a device, you can find it in your router's webinterface. For example, if
+ your device is connected wirelessly, somewhere there is a page listing all
+ the devices that are connected to your network. It depends on your router,
+ where exactly this page is. It could be under **Network** > **Wireless**.
excerpt: >-
- A device that participates in your network. If asked for the host, enter either the device's IP address or host name. If you don't know those, check the list of hosts in your router.
+ A device that participates in your network. If asked for the host, enter
+ either the device's IP address or host name. If you don't know those, check
+ the list of hosts in your router.
link: https://en.wikipedia.org/wiki/Host_(network)
aliases:
- hosts
- term: Integration
definition: >-
Integrations connect and integrate Home Assistant with devices, services,
- and more. They contain all the logic to handle
- vendor- and device-specific implementations, such as authentication or
- specific protocols. The integration brings such device-specific elements into Home Assistant in a standardized
- way. For example, the [Hue](/integrations/hue) integration integrates
- the Philips Hue bridge and its connected bulbs into Home Assistant, making
- them available as Home Assistant light entities you can control.
+ and more. They contain all the logic to handle vendor- and device-specific
+ implementations, such as authentication or specific protocols. The
+ integration brings such device-specific elements into Home Assistant in a
+ standardized way. For example, the [Hue](/integrations/hue) integration
+ integrates the Philips Hue bridge and its connected bulbs into Home
+ Assistant, making them available as Home Assistant light entities you can
+ control.
excerpt: >
Integrations connect and integrate Home Assistant with your devices,
services, and more.
@@ -233,17 +345,40 @@
- integrations
- term: Intent
definition: >-
- Intent is a term used with voice assistants. The intent is what Home Assistant thinks you want it to do when it extracts a command from your voice or text utterance. Currently, the following intents are supported out of the box: HassTurnOn, HassTurnOff, HassGetState, and HassLightSet.
- These intents allow you to turn things on or off, inquire about a state, or change the brightness or color of a light.
+ Intent is a term used with voice assistants. The intent is what Home
+ Assistant thinks you want it to do when it extracts a command from your
+ voice or text utterance. Currently, the following intents are supported out
+ of the box: HassTurnOn, HassTurnOff, HassGetState, and HassLightSet. These
+ intents allow you to turn things on or off, inquire about a state, or change
+ the brightness or color of a light.
excerpt: >
- Intent is a term used with voice assistants. The intent is what Home Assistant thinks you want it to do when it extracts a command from your voice or text utterance.
+ Intent is a term used with voice assistants. The intent is what Home
+ Assistant thinks you want it to do when it extracts a command from your
+ voice or text utterance.
link: https://developers.home-assistant.io/docs/intent_builtin
aliases:
- Intents
+- term: Label
+ definition: >-
+ Labels in Home Assistant allow grouping elements irrespective of their
+ physical location or type. Labels can be assigned to areas, devices,
+ entities, automations, scenes, scripts, and helpers. Labels can be used in
+ automations and scripts as a target for actions and services. Labels can
+ also be used to filter data. For example, you can filter the list of devices
+ to show only devices with the label `heavy energy usage` or turn these
+ devices off when there is not a lot of solar energy available.
+ excerpt: >-
+ Labels in Home Assistant allow grouping elements irrespective of their
+ physical location or type. Labels can be assigned to areas, devices,
+ entities, automations, scenes, scripts, and helpers. Labels can be used in
+ automations and scripts as a target for actions and services. Labels can
+ also be used to filter data.
+ aliases:
+ - labels
- term: Lovelace
definition: >-
- Lovelace is the original code name of the UI that is now known as
- [Home Assistant dashboards](/dashboards).
+ Lovelace is the original code name of the UI that is now known as [Home
+ Assistant dashboards](/dashboards).
- term: Light
definition: >-
A light has a brightness you can control, and optionally color temperature
@@ -251,9 +386,17 @@
link: /integrations/light
- term: Matter
definition: >-
- Matter is an open-source standard that defines how to control smart home devices on a Wi-Fi or Thread network. The aim of the standard is to improve security and to make devices interoperable across vendors, replacing proprietary protocols for smart home ecosystems. Unlike other standards, Matter allows joining the same device to multiple controllers. For example, you can add a light to Google Home, Apple Home, and Home Assistant at the same time. A bridge device can be used to connect devices running on other smart home technologies such as Zigbee or Z-Wave.
+ Matter is an open-source standard that defines how to control smart home
+ devices on a Wi-Fi or Thread network. The aim of the standard is to improve
+ security and to make devices interoperable across vendors, replacing
+ proprietary protocols for smart home ecosystems. Unlike other standards,
+ Matter allows joining the same device to multiple controllers. For example,
+ you can add a light to Google Home, Apple Home, and Home Assistant at the
+ same time. A bridge device can be used to connect devices running on other
+ smart home technologies such as Zigbee or Z-Wave.
excerpt: >
- Matter is an open-source standard that defines how to control smart home devices on a Wi-Fi or Thread network.
+ Matter is an open-source standard that defines how to control smart home
+ devices on a Wi-Fi or Thread network.
link: /integrations/matter
- term: Notification
definition: >-
@@ -272,8 +415,8 @@
Platforms are building blocks provided by some integrations to be used by
other integrations. For example, the [Light](/integrations/light)
integration provides the `light platform` that is utilized by all
- integrations providing `light` entities such
- as e.g. [Hue](/integrations/hue).
+ integrations providing `light` entities such as e.g.
+ [Hue](/integrations/hue).
excerpt: >
Platforms are building blocks provided by some integrations to be used by
other integrations.
@@ -283,78 +426,97 @@
- term: Reload
definition: >-
Applies the changes made to the Home Assistant configuration files. Changes
- are normally automatically updated. However, changes made outside of the front
- end will not be reflected in Home Assistant and require a reload.
- To perform a manual reload, go to **Settings** > **System** >
- **Restart Home Assistant** (top right) > **Quick reload**. More granular
- reload options are available in *YAML configuration reloading* section
- in **Developer tools** > **YAML**.
+ are normally automatically updated. However, changes made outside of the
+ front end will not be reflected in Home Assistant and require a reload. To
+ perform a manual reload, go to **Settings** > **System** > **Restart Home
+ Assistant** (top right) > **Quick reload**. If you do not see the **Quick
+ reload** option in the menu, you need to enable **Advanced mode** in your
+ user settings. More granular reload options are available in *YAML
+ configuration reloading* section in **Developer tools** > **YAML**.
excerpt: >
- Applies the changes made to Home Assistant configuration files. Changes are normally
- automatically updated. However, changes made outside of the front
+ Applies the changes made to Home Assistant configuration files. Changes are
+ normally automatically updated. However, changes made outside of the front
end will not be reflected in Home Assistant and require a reload.
- term: Scene
definition: >-
- Scenes capture the states you want certain entities to be. For example,
- a scene can specify that light A should be turned on and light B should
- be bright red.
+ Scenes capture the states you want certain entities to be. For example, a
+ scene can specify that light A should be turned on and light B should be
+ bright red.
link: /integrations/scene/
aliases:
- scenes
- term: Script
definition: >
- Scripts are components that allow users to specify a sequence of actions
- to be executed by Home Assistant when turned on.
+ Scripts are components that allow users to specify a sequence of actions to
+ be executed by Home Assistant when turned on.
link: /docs/scripts/
aliases:
- scripts
- term: Sensor
definition: >-
- Sensors return information about a thing, for instance the level of water
- in a tank.
+ Sensors return information about a thing, for instance the level of water in
+ a tank.
link: /integrations/sensor/
aliases:
- sensors
- term: Selector
definition: >-
- Selectors are components for the user interface. Some selectors can,
- for example, show a toggle button to turn something on or off, while another
+ Selectors are components for the user interface. Some selectors can, for
+ example, show a toggle button to turn something on or off, while another
select can filter a list of devices to show only devices that have
motion-sensing capabilities.
excerpt: >
- Selectors are components for the user interface. Like toggle, dropdown,
- and more.
+ Selectors are components for the user interface. Like toggle, dropdown, and
+ more.
link: /docs/blueprint/selectors/
aliases:
- selectors
- term: Service
definition: |-
- The term service has 2 meanings in Home Assistant:
- **The information service**
- For example, the municipal waste management service that provides entities for organic, paper, and packaging waste. In terms of functionality, the information service is like a device. It is called *service* to avoid confusion, as it does not come with a piece of hardware.
- **The software function that interacts with targets to make something happen**
- A service carries out one specific task, for example: turning on the light in the living room or sending a notification to a mobile phone.
- A service has targets and data. Service targets are: areas, devices, and entities. Service data carries the information required to define the desired state change in the target. For example, the target, together with brightness 150 and RGB color `[255,0,0]`, or the message “Your coffee is ready”.
- Services can be used in, for example, automation, scripts, dashboards, or voice commands to control your home.
- Home Assistant provides a series of predefined services, such as `homeassistant.turn_on`, `homeassistant.toggle`, or `homeassistant.reload`.
+ The term service has 2 meanings in Home Assistant: **The information
+ service** For example, the municipal waste management service that provides
+ entities for organic, paper, and packaging waste. In terms of functionality,
+ the information service is like a device. It is called *service* to avoid
+ confusion, as it does not come with a piece of hardware. **The software
+ function that interacts with targets to make something happen** A service
+ carries out one specific task, for example: turning on the light in the
+ living room or sending a notification to a mobile phone. A service has
+ targets and data. Service targets are: areas, devices, and entities. Service
+ data carries the information required to define the desired state change in
+ the target. For example, the target, together with brightness 150 and RGB
+ color `[255,0,0]`, or the message “Your coffee is ready”. Services can be
+ used in, for example, automation, scripts, dashboards, or voice commands to
+ control your home. Home Assistant provides a series of predefined services,
+ such as `homeassistant.turn_on`, `homeassistant.toggle`, or
+ `homeassistant.reload`.
excerpt: >
- A service carries out one specific task, for example: turn on the light in the
- living room. A service has targets and data and can be called by actions, a
- dashboard, or via voice command.
+ A service carries out one specific task, for example: turn on the light in
+ the living room. A service has targets and data and can be called by
+ actions, a dashboard, or via voice command.
link: /docs/scripts/service-calls/
aliases:
- services
- term: State
definition: |-
- The state holds the information of interest of an entity. For example, if a light is on or off, the current temperature, or the amount of energy used. The data type of state is `string` (a textual value). Entities store 2 timestamps related to the state: `last_updated` and `last_changed`. Each entity has exactly one state and the state only holds one value at a time. However, entities can store attributes related to that state. For example, the state of a light is _on_, and the related state attributes could be its current brightness and color values.
- State changes can be used as the source of triggers. The current state can be used in conditions.
-
+ The state holds the information of interest of an entity. For example, if a
+ light is on or off, the current temperature, or the amount of energy used.
+ The data type of state is `string` (a textual value). Entities store 2
+ timestamps related to the state: `last_updated` and `last_changed`. Each
+ entity has exactly one state and the state only holds one value at a time.
+ However, entities can store attributes related to that state. For example,
+ the state of a light is _on_, and the related state attributes could be its
+ current brightness and color values. State changes can be used as the source
+ of triggers. The current state can be used in conditions.
+
link: /docs/configuration/state_object/
aliases:
- states
excerpt: >
- The state holds the information of interest of an entity, for example, if a light is on or off. Each entity has exactly one state and the state only holds one value at a time. However, entities can store attributes related to that state such as brightness, color, or a unit of measurement.
+ The state holds the information of interest of an entity, for example, if a
+ light is on or off. Each entity has exactly one state and the state only
+ holds one value at a time. However, entities can store attributes related to
+ that state such as brightness, color, or a unit of measurement.
- term: Switch
definition: >-
Switches are things that have two states you can select between, such as
@@ -371,14 +533,37 @@
- term: Thread
definition: >-
- Thread is a low-power mesh networking standard that is specifically designed for smart home applications. It is a protocol that defines how devices communicate. *Mesh* topology means that the devices can communicate with each other directly, without going through a central controller first. Thread uses the same radio frequency (RF) technology as Zigbee, but provides IP connectivity similar to Wi-Fi. Unlike Zigbee, Thread does not specify how to control devices. How Thread-enabled devices are controlled is specified in a higher level protocol such as HomeKit or Matter.
+ Thread is a low-power mesh networking standard that is specifically designed
+ for smart home applications. It is a protocol that defines how devices
+ communicate. *Mesh* topology means that the devices can communicate with
+ each other directly, without going through a central controller first.
+ Thread uses the same radio frequency (RF) technology as Zigbee, but provides
+ IP connectivity similar to Wi-Fi. Unlike Zigbee, Thread does not specify how
+ to control devices. How Thread-enabled devices are controlled is specified
+ in a higher level protocol such as HomeKit or Matter.
link: /integrations/thread/
excerpt: >
- Thread is a low-power mesh networking standard that is specifically designed for smart home applications. It is a protocol that defines how devices communicate.
+ Thread is a low-power mesh networking standard that is specifically designed
+ for smart home applications. It is a protocol that defines how devices
+ communicate.
+- term: Thread border router
+ definition: >-
+ A Thread border router forwards data packets between your local network and
+ the Thread network. This enables smart home devices within a Thread network
+ to communicate with IPv6-capable devices in your local network. A Thread
+ border router is connected to your network either via Wi-Fi or Ethernet and
+ uses its radio frequency (RF) radio to communicate with the Thread mesh
+ network. In case of Matter, the data that is forwarded is encrypted.
+ Examples of Thread border routers are the Nest Hub (2nd gen), the HomePod
+ mini, and the Home Assistant SkyConnect together with the OpenThread Border
+ Router add-on.
+ link: /integrations/thread/#about-thread-border-routers
+ aliases:
+ - Thread border routers
- term: Trigger
definition: >-
- A trigger is a set of values or conditions of a platform that are defined
- to cause an automation to run.
+ A trigger is a set of values or conditions of a platform that are defined to
+ cause an automation to run.
link: /docs/automation/trigger/
aliases:
- triggers
@@ -388,21 +573,21 @@
TTS (text-to-speech) allows Home Assistant to talk to you.
link: /integrations/tts/
-
- term: Valve
definition: >-
- Valves are devices to control the flow of liquids and gases. All valves in Home Assistant can be opened
- and closed. Some valves can also be set to a specific position.
+ Valves are devices to control the flow of liquids and gases. All valves in
+ Home Assistant can be opened and closed. Some valves can also be set to a
+ specific position.
link: /integrations/valve
- term: Variables
definition: >-
- Variables are used to store values in memory that can be processed
- for example, in a script.
+ Variables are used to store values in memory that can be processed for
+ example, in a script.
link: /docs/scripts/#variables
- term: Zone
definition: >-
Zones are areas that can be used for presence detection.
link: /integrations/zone/
aliases:
- - zones
\ No newline at end of file
+ - zones
diff --git a/source/_docs/authentication.markdown b/source/_docs/authentication.markdown
index 02d299c9ad5c..de84130966b5 100644
--- a/source/_docs/authentication.markdown
+++ b/source/_docs/authentication.markdown
@@ -7,21 +7,13 @@ The authentication system secures access to Home Assistant.
## Login screen
-If you log in from within your local network, you are greeted with a login screen showing all the people in Home Assistant.
-
-
-
-### Privacy: Not showing users when logging in from outside the network
-
-When logging in from outside your local network, the users are not shown. This is to protect your privacy. In this case, you need to enter your user name.
-
-You might also see this screen if you are using a Chromium-based browser (Chrome, Edge) and IPv6. Home Assistant might not be able to detect if your are logging in from a local network. This is a known issue with Chromium.
+You are greeted with a log in screen, asking you for user name and password.
## User accounts
-When you start Home Assistant for the first time the _owner_ user account is created. This account has some special privileges and can:
+When you start Home Assistant for the first time, the _owner_ user account is created. This account has some special privileges and can:
- Create and manage other user accounts.
- Configure integrations and other settings (coming soon).
@@ -31,12 +23,12 @@ For the moment, other user accounts will have the same access as the owner accou
@@ -46,8 +38,15 @@ You can:
- Enable or disable [multi-factor authentication](/docs/authentication/multi-factor-auth/).
- Delete _Refresh Tokens_. These are created when you log in from a device. Delete them if you want to force the device to log out.
- Create [Long Lived Access Tokens](https://developers.home-assistant.io/docs/auth_api/#long-lived-access-token) so scripts can securely interact with Home Assistant.
+- Define language and other locale settings.
- Log out of Home Assistant.
+
-Home Assistant upgrade process from the SSH command line
-
+Example of a configuration.yaml file, accessed using the Studio Code Server add-on on a Home Assistant Operating System installation.
+
+## Setup
+
+You need to have a Datadog agent installed in a network accessible by Home Assistant.
+
+In the [Datadog Agent configuration](https://github.com/DataDog/datadog-agent/blob/main/pkg/config/config_template.yaml#L2203-L2207), you must enable [DogStatsD](https://docs.datadoghq.com/developers/dogstatsd/) non-local traffic to allow StatsD data collection from outside `localhost`.
+
+## Configuration
+
To use the `datadog` integration in your installation, add the following to your `configuration.yaml` file:
```yaml
@@ -42,7 +50,7 @@ port:
default: 8125
type: integer
prefix:
- description: Prefix to use.
+ description: Metric prefix to use.
required: false
default: "`hass`"
type: string
diff --git a/source/_integrations/default_config.markdown b/source/_integrations/default_config.markdown
index de570a8ba27d..c579916b7d70 100644
--- a/source/_integrations/default_config.markdown
+++ b/source/_integrations/default_config.markdown
@@ -13,48 +13,27 @@ ha_integration_type: system
This {% term integration %} is a meta-component and configures a default set of integrations for Home Assistant to load. The integrations that will be loaded are:
-- [Automation](/integrations/automation/) (`automation`)
- [Assist pipeline](/integrations/assist_pipeline/) (`assist_pipeline`)
- [Backup](/integrations/backup/) (`backup`)
- [Bluetooth](/integrations/bluetooth/) (`bluetooth`)
- [Configuration](/integrations/config/) (`config`)
- [Conversation](/integrations/conversation/) (`conversation`)
-- [Counter](/integrations/counter/) (`counter`)
- [DHCP discovery](/integrations/dhcp/) (`dhcp`)
- [Energy](/integrations/energy/) (`energy`)
-- [Frontend](/integrations/frontend/) (`frontend`)
-- [Hardware](/integrations/hardware/) (`hardware`)
- [History](/integrations/history/) (`history`)
- [Home Assistant Alerts](/integrations/homeassistant_alerts) (`homeassistant_alerts`)
- [Home Assistant Cloud](/integrations/cloud/) (`cloud`)
- [Image upload](/integrations/image_upload/) (`image_upload`)
-- [Input boolean](/integrations/input_boolean/) (`input_boolean`)
-- [Input button](/integrations/input_button/) (`input_button`)
-- [Input datetime](/integrations/input_datetime/) (`input_datetime`)
-- [Input number](/integrations/input_number/) (`input_number`)
-- [Input select](/integrations/input_select/) (`input_select`)
-- [Input text](/integrations/input_text/) (`input_text`)
- [Logbook](/integrations/logbook/) (`logbook`)
-- [Logger](/integrations/logger/) (`logger`)
-- [Map](/integrations/map/) (`map`)
- [Media source](/integrations/media_source/) (`media_source`)
- [Mobile app support](/integrations/mobile_app/) (`mobile_app`)
- [My Home Assistant](/integrations/my/) (`my`)
-- [Network](/integrations/network/) (`network`)
-- [Person](/integrations/person/) (`person`)
-- [Schedule](/integrations/schedule/) (`schedule`)
-- [Scene](/integrations/scene/) (`scene`)
-- [Scripts](/integrations/script/) (`script`)
- [Simple Service Discovery Protocol (SSDP)](/integrations/ssdp/) (`ssdp`)
- [Stream](/integrations/stream/) (`stream`)
- [Sun](/integrations/sun/) (`sun`)
-- [System health](/integrations/system_health/) (`system_health`)
-- [Tag](/integrations/tag/) (`tag`)
-- [Timer](/integrations/timer/) (`timer`)
- [USB](/integrations/usb/) (`usb`)
- [Webhooks](/integrations/webhook) (`webhook`)
- [Zero-configuration networking (zeroconf)](/integrations/zeroconf/) (`zeroconf`)
-- [Zone](/integrations/zone/) (`zone`)
## Configuration
diff --git a/source/_integrations/demo.markdown b/source/_integrations/demo.markdown
index bc9a0712c0a0..9255c2901929 100644
--- a/source/_integrations/demo.markdown
+++ b/source/_integrations/demo.markdown
@@ -20,6 +20,7 @@ ha_platforms:
- climate
- cover
- date
+ - datetime
- device_tracker
- event
- fan
@@ -65,7 +66,6 @@ Available demo platforms:
- [Image processing](/integrations/image_processing/) (`image_processing`)
- [Light](/integrations/light/) (`light`)
- [Lock](/integrations/lock/) (`lock`)
-- [Mailbox](/integrations/mailbox/) (`mailbox`)
- [Media player](/integrations/media_player/) (`media_player`)
- [Notification](/integrations/notify/) (`notify`)
- [Number](/integrations/number/) (`number`)
diff --git a/source/_integrations/denonavr.markdown b/source/_integrations/denonavr.markdown
index 83addea11354..8c7c893d980b 100644
--- a/source/_integrations/denonavr.markdown
+++ b/source/_integrations/denonavr.markdown
@@ -28,6 +28,7 @@ Known supported devices:
- Denon AVR-X1500H
- Denon AVR-X1600H
- Denon AVR-X1700H
+- Denon AVR-X1800H
- Denon AVR-X2000
- Denon AVR-X2100W
- Denon AVR-X2200W
@@ -68,13 +69,16 @@ Known supported devices:
- Denon AVR-S740H
- Denon AVR-S750H
- Denon AVR-S760H
+- Denon AVR-S770H
- Denon AVR-S940H
- Denon AVR-S950H
- Denon AVR-S960H
- Denon DN-500AV
+- Denon DRA-800H
- Marantz AV7702
- Marantz AV7703
- Marantz AV7704
+- Marantz AV8802A
- Marantz CINEMA 50
- Marantz CINEMA 70s
- Marantz M-CR510
@@ -108,6 +112,8 @@ Known supported devices:
If your model is not on the list then give it a test, if everything works correctly then add it to the list by clicking on the **Edit** link at the bottom of this page.
+If you are using VLANs, Home Assistant needs access to the following ports on the AVR: 23, 8080, and 60006 (all TCP).
+
+ Event entity with a timestamp value in state and event type "pressed".
+
+
+## About the data sources
+
+By default, the recorder stores the sensor data for 10 days. Older data is purged automatically. The data for the last 10 days is taken from the recorder.
+
+If you select a time frame that exceeds 10 days, the data is taken from the long term statistics table. The long term statistics data is sampled and averaged once per hour, to save storage. Therefore, the values might look different from what you see from the recorder data, which shows the measured values at the sample rate defined for that sensor.
+
+
+
+ If you want to see the data in full resolution for a longer period of time, you could change the retention period for that sensor in the recorder. If you do this, you may need to increase the storage capacity of your device.
+
## API
The history information is also available through the
diff --git a/source/_integrations/history_stats.markdown b/source/_integrations/history_stats.markdown
index 83d836cbfa04..5cabd7d3e59e 100644
--- a/source/_integrations/history_stats.markdown
+++ b/source/_integrations/history_stats.markdown
@@ -1,5 +1,5 @@
---
-title: History Stats
+title: History stats
description: Instructions about how to integrate historical statistics into Home Assistant.
ha_category:
- Sensor
@@ -13,7 +13,7 @@ ha_platforms:
ha_integration_type: integration
---
-The `history_stats` sensor platform provides quick statistics about another integration or platforms, using data from the [`history`](/integrations/history/) integration.
+The **History stats** {% term integration %} provides quick statistics about another integration or platforms, using data from the [`history`](/integrations/history/) integration.
It can track how long the integration has been in a specific state, in a custom time period.
@@ -37,7 +37,7 @@ sensor:
entity_id: light.my_lamp
state: "on"
type: time
- start: "{{ now().replace(hour=0, minute=0, second=0) }}"
+ start: "{{ today_at() }}"
end: "{{ now() }}"
```
@@ -147,7 +147,7 @@ Here are some examples of periods you could work with, and what to write in your
{% raw %}
```yaml
- start: "{{ now().replace(hour=0, minute=0, second=0, microsecond=0) }}"
+ start: "{{ today_at() }}"
end: "{{ now() }}"
```
@@ -158,7 +158,7 @@ Here are some examples of periods you could work with, and what to write in your
{% raw %}
```yaml
- end: "{{ now().replace(hour=0, minute=0, second=0, microsecond=0) }}"
+ end: "{{ today_at() }}"
duration:
hours: 24
```
@@ -170,7 +170,7 @@ Here are some examples of periods you could work with, and what to write in your
{% raw %}
```yaml
- start: "{{ now().replace(hour=6, minute=0, second=0, microsecond=0) }}"
+ start: "{{ today_at('06:00') }}"
duration:
hours: 5
```
@@ -179,12 +179,12 @@ Here are some examples of periods you could work with, and what to write in your
**Current week**: starts last Monday at 00:00, ends right now.
-Here, last Monday is _today_ as a timestamp, minus 86400 times the current weekday (86400 is the number of seconds in one day, the weekday is 0 on Monday, 6 on Sunday).
+Here, last Monday is today at 00:00, minus the current weekday (the weekday is 0 on Monday, 6 on Sunday).
{% raw %}
```yaml
- start: "{{ as_timestamp( now().replace(hour=0, minute=0, second=0, microsecond=0) ) - now().weekday() * 86400 }}"
+ start: "{{ today_at() - timedelta(days=now().weekday()) }}"
end: "{{ now() }}"
```
@@ -195,7 +195,7 @@ Here, last Monday is _today_ as a timestamp, minus 86400 times the current weekd
{% raw %}
```yaml
- start: "{{ now().replace(day=1, hour=0, minute=0, second=0, microsecond=0 ) }}"
+ start: "{{ today_at().replace(day=1) }}"
end: "{{ now() }}"
```
@@ -206,8 +206,8 @@ Here, last Monday is _today_ as a timestamp, minus 86400 times the current weekd
{% raw %}
```yaml
- start: "{{ now().replace(day=1, month=now().month-1, hour=0, minute=0, second=0, microsecond=0) }}"
- end: "{{ now().replace(day=1, hour=0, minute=0, second=0, microsecond=0) }}"
+ start: "{{ (today_at().replace(day=1) - timedelta(days=1)).replace(day=1) }}"
+ end: "{{ today_at().replace(day=1) }}"
```
{% endraw %}
@@ -217,7 +217,7 @@ Here, last Monday is _today_ as a timestamp, minus 86400 times the current weekd
{% raw %}
```yaml
- end: "{{ (now().replace(minute=0, second=0, microsecond=0) + timedelta(hours=8)).replace(hour=16) }}"
+ end: "{{ (now() + timedelta(hours=8)).replace(hour=16, minute=0, second=0, microsecond=0) }}"
duration:
hours: 24
```
@@ -229,7 +229,7 @@ Here, last Monday is _today_ as a timestamp, minus 86400 times the current weekd
{% raw %}
```yaml
- end: "{{ now().replace(hour=0, minute=0, second=0, microsecond=0) }}"
+ end: "{{ today_at() }}"
duration:
days: 30
```
diff --git a/source/_integrations/hko.markdown b/source/_integrations/hko.markdown
new file mode 100644
index 000000000000..8b441407271e
--- /dev/null
+++ b/source/_integrations/hko.markdown
@@ -0,0 +1,25 @@
+---
+title: Hong Kong Observatory
+description: Instructions on how to integrate the Hong Kong Observatory (HKO) Open Data API into Home Assistant.
+ha_category:
+ - Weather
+ha_release: 2024.2
+ha_iot_class: Cloud Polling
+ha_config_flow: true
+ha_codeowners:
+ - '@MisterCommand'
+ha_domain: hko
+ha_platforms:
+ - weather
+ha_integration_type: integration
+---
+
+The HKO integration retrieves weather data from the [Hong Kong Observatory](https://www.hko.gov.hk/tc/index.html) [Open Data API](https://www.hko.gov.hk/en/abouthko/opendata_intro.htm) for meteorological data in HKSAR.
+
+There is currently support for the following platforms within Home Assistant:
+
+- [Weather](#weather-platform)
+
+It displays the weather of your selected location and the 5-day weather forecast for Hong Kong.
+
+{% include integrations/config_flow.md %}
diff --git a/source/_integrations/holiday.markdown b/source/_integrations/holiday.markdown
index 2ff746ec1608..5744366345c7 100644
--- a/source/_integrations/holiday.markdown
+++ b/source/_integrations/holiday.markdown
@@ -11,6 +11,7 @@ ha_platforms:
- calendar
ha_codeowners:
- '@jrieger'
+ - '@gjohansson-ST'
ha_integration_type: integration
---
diff --git a/source/_integrations/home_plus_control.markdown b/source/_integrations/home_plus_control.markdown
index e71e1b18a00c..e8d1d1c263c8 100644
--- a/source/_integrations/home_plus_control.markdown
+++ b/source/_integrations/home_plus_control.markdown
@@ -1,100 +1,40 @@
---
title: Legrand Home+ Control
-description: Instructions on how to integrate Legrand Home+ Control into Home Assistant.
+description: Connect and control your Legrand Home+ Control devices using the Netatmo integration
ha_category:
+ - Binary sensor
+ - Camera
+ - Climate
+ - Cover
+ - Environment
+ - Fan
+ - Hub
+ - Light
+ - Media source
+ - Sensor
- Switch
-ha_release: 2021.4
-ha_iot_class: Cloud Polling
+ - Weather
+ha_release: '0.20'
+ha_domain: home_plus_control
+ha_integration_type: virtual
+ha_supporting_domain: netatmo
+ha_supporting_integration: Netatmo
ha_codeowners:
- - '@chemaaa'
+ - '@cgtobi'
ha_config_flow: true
-ha_domain: home_plus_control
ha_platforms:
+ - binary_sensor
+ - camera
+ - climate
+ - cover
+ - diagnostics
+ - fan
+ - light
+ - select
+ - sensor
- switch
-ha_integration_type: integration
+ha_iot_class: Cloud Polling
+ha_homekit: true
---
-
+ Screenshot showing coordinates cannot be edited because they are defined in configuration.yaml file.
+
+ Screencast showing how to add a new Matter device to Home Assistant.
+
+ Screencast showing how to share a Matter device from Apple Home.
+
+
+ 
+ 
-The entity's information can be used for example if a bush fire that produces smoke or embers is reported close to your home, and you want to automatically close windows, turn on a sprinkler system or simply send yourself a reminder to clean the gutters from dry leaves.
+For example, you can use the entity's information to trigger actions based on the proximity and severity of a fire incident. You can set up automations to close windows, activate sprinklers or remind yourself to clean the gutters if there is a fire in your area.
The data is updated every 5 minutes.
diff --git a/source/_integrations/numato.markdown b/source/_integrations/numato.markdown
index d69384cf8da5..eaa005503a07 100644
--- a/source/_integrations/numato.markdown
+++ b/source/_integrations/numato.markdown
@@ -15,7 +15,7 @@ ha_platforms:
- binary_sensor
- sensor
- switch
-ha_integration_type: integration
+ha_integration_type: hub
---
The `numato` integration is the base for all related GPIO platforms of the
diff --git a/source/_integrations/number.markdown b/source/_integrations/number.markdown
index 7306d5601d36..b7ecc054ed47 100644
--- a/source/_integrations/number.markdown
+++ b/source/_integrations/number.markdown
@@ -64,6 +64,7 @@ The type of data a number represents impacts how it is displayed in the frontend
- **volatile_organic_compounds**: Concentration of volatile organic compounds in µg/m³
- **voltage**: Voltage in V, mV
- **volume**: Generic volume in L, mL, gal, fl. oz., m³, ft³, or CCF
+- **volume_flow_rate**: Volume flow rate in m³/h, ft³/min, L/min, gal/min
- **volume_storage**: Generic stored volume in L, mL, gal, fl. oz., m³, ft³, or CCF
- **water**: Water consumption in L, gal, m³, ft³, or CCF
- **weight**: Generic mass in kg, g, mg, µg, oz, lb, or st
diff --git a/source/_integrations/number.mqtt.markdown b/source/_integrations/number.mqtt.markdown
index 46ee2aed08b0..1e7a5c29a3e0 100644
--- a/source/_integrations/number.mqtt.markdown
+++ b/source/_integrations/number.mqtt.markdown
@@ -12,8 +12,6 @@ The `mqtt` Number platform allows you to integrate devices that might expose con
## Configuration
-
+ 
-### Full configuration
+### Passing variables to scripts
-{% raw %}
+As part of the service, variables can be passed along to a script so they become available within templates in that script.
+
+To configure a script to accept variables using the UI, the variables can be added as fields in the script editor.
+1. In the script editor, in the 3-dots menu, select **Add fields**.
+2. A new section called **Fields** is added between the basic information and **Sequence** sections.
+3. Enter a name and choose type and options of each desired field.
+4. Fields set up here will be shown in other UI editors, such as in an automation that calls the script as inputs depending on the type of field.
+5. To use the field data, use them as templates using the **Field key name** when they were added, as shown in the example below.
+
+Using the variables in the script requires the use of templates:
+{% raw %}
```yaml
-script:
- wakeup:
- alias: "Wake Up"
- icon: "mdi:party-popper"
- description: "Turns on the bedroom lights and then the living room lights after a delay"
- variables:
- turn_on_entity: group.living_room
+# Example configuration.yaml entry
+script:
+ notify_pushover:
+ description: "Send a pushover notification"
fields:
- minutes:
- name: Minutes
- description: "The amount of time to wait before turning on the living room lights"
- selector:
- number:
- min: 0
- max: 60
- step: 1
- unit_of_measurement: minutes
- mode: slider
- # If called again while still running (probably in delay step), start over.
- mode: restart
+ title:
+ description: "The title of the notification"
+ example: "State change"
+ message:
+ description: "The message content"
+ example: "The light is on!"
sequence:
- # This is Home Assistant Script Syntax
- - event: LOGBOOK_ENTRY
- event_data:
- name: Paulus
- message: is waking up
- entity_id: device_tracker.paulus
- domain: light
- - alias: "Bedroom lights on"
- service: light.turn_on
- target:
- entity_id: group.bedroom
+ - condition: state
+ entity_id: switch.pushover_notifications
+ state: "on"
+ - service: notify.pushover
data:
- brightness: 100
- - delay:
- # supports seconds, milliseconds, minutes, hours
- minutes: "{{ minutes }}"
- - alias: "Living room lights on"
- service: light.turn_on
- target:
- entity_id: "{{ turn_on_entity }}"
+ title: "{{ title }}"
+ message: "{{ message }}"
```
-
{% endraw %}
-### Passing variables to scripts
-
-As part of the service, variables can be passed along to a script so they become available within templates in that script.
-
-There are two ways to achieve this. One way is using the generic `script.turn_on` service. To pass variables to the script with this service, call it with the desired variables:
+Aside from the automation editor UI, variables can be passed to scripts within the service data. This can be used either by calling the script directly or the generic `script.turn_on` service. The difference is described in [Waiting for Script to Complete](#waiting-for-script-to-complete). All service data will be made available as variables in templates, even if not specified as fields in the script. This example shows how to call the script directly:
+{% raw %}
```yaml
# Example configuration.yaml entry
automation:
@@ -205,17 +184,16 @@ automation:
from: "off"
to: "on"
action:
- service: script.turn_on
- target:
- entity_id: script.notify_pushover
+ service: script.notify_pushover
data:
- variables:
- title: "State change"
- message: "The light is on!"
+ title: "State change"
+ message: "The light is on!"
```
+{% endraw %}
-The other way is calling the script as a service directly. In this case, all service data will be made available as variables. If we apply this approach on the script above, it would look like this:
+This example shows using `script.turn_on` service:
+{% raw %}
```yaml
# Example configuration.yaml entry
automation:
@@ -225,46 +203,27 @@ automation:
from: "off"
to: "on"
action:
- service: script.notify_pushover
+ service: script.turn_on
+ target:
+ entity_id: script.notify_pushover
data:
- title: "State change"
- message: "The light is on!"
+ variables:
+ title: "State change"
+ message: "The light is on!"
```
+{% endraw %}
-Using the variables in the script requires the use of templates:
-{% raw %}
-
-```yaml
-# Example configuration.yaml entry
-script:
- notify_pushover:
- description: "Send a pushover notification"
- fields:
- title:
- description: "The title of the notification"
- example: "State change"
- message:
- description: "The message content"
- example: "The light is on!"
- sequence:
- - condition: state
- entity_id: switch.pushover_notifications
- state: "on"
- - service: notify.pushover
- data:
- title: "{{ title }}"
- message: "{{ message }}"
-```
diff --git a/source/_integrations/sensor.mqtt.markdown b/source/_integrations/sensor.mqtt.markdown
index 9c8d32228443..416a43eec31d 100644
--- a/source/_integrations/sensor.mqtt.markdown
+++ b/source/_integrations/sensor.mqtt.markdown
@@ -12,8 +12,6 @@ This `mqtt` sensor platform uses the MQTT message payload as the sensor value. I
## Configuration
-
+
diff --git a/source/_integrations/supla.markdown b/source/_integrations/supla.markdown
index 2e5fd22416be..ae0d209bcf6a 100644
--- a/source/_integrations/supla.markdown
+++ b/source/_integrations/supla.markdown
@@ -23,7 +23,7 @@ Currently, only covers (shutters in SUPLA's terminology), gates, garage doors, a
Right now, it's impossible to add a device -- all of them are discovered from SUPLA-CLOUD's servers or yours.
-Devices disabled on SUPLA-CLOUD will not be loaded into Home Assistant.
+For more complete Home Assistant support based on MQTT autodiscovery, consider switching your Supla devices to MQTT (through the setup interface). Or use the MQTT broker provided by [Supla Cloud](https://cloud.supla.org/integrations/mqtt-broker).
## Configuration
@@ -43,7 +43,7 @@ servers:
type: list
keys:
server:
- description: Address of the SUPLA-CLOUD server (either IP address or DNS name); can either be the (cloud hosted)[https://cloud.supla.org] instance, or a (self hosted)[https://github.com/SUPLA/supla-cloud] instance.
+ description: Address of the SUPLA-CLOUD server (either IP address or DNS name); can either be the [cloud hosted](https://cloud.supla.org) instance, or a [self hosted](https://github.com/SUPLA/supla-cloud) instance.
required: true
type: string
access_token:
diff --git a/source/_integrations/swepco.markdown b/source/_integrations/swepco.markdown
index 28a16270c658..521d6c8019c3 100644
--- a/source/_integrations/swepco.markdown
+++ b/source/_integrations/swepco.markdown
@@ -4,7 +4,7 @@ description: Get energy usage from Southwestern Electric Power Company (SWEPCO)
ha_category:
- Energy
- Sensor
-ha_release: 2024.1
+ha_release: 2023.8
ha_domain: swepco
ha_integration_type: virtual
ha_supporting_domain: opower
diff --git a/source/_integrations/swiss_public_transport.markdown b/source/_integrations/swiss_public_transport.markdown
index e336347dad17..34e519329110 100644
--- a/source/_integrations/swiss_public_transport.markdown
+++ b/source/_integrations/swiss_public_transport.markdown
@@ -15,9 +15,9 @@ ha_platforms:
ha_integration_type: integration
---
-The `swiss_public_transport` sensor will give you the next three departure times from a given location to another one in Switzerland.
+The Swiss public transport integration will give you the next three departure times from a given location to another one in Switzerland.
-The [Swiss public transport API](https://transport.opendata.ch/) only allows 1000 requests per 24 hours.
+The [Swiss public transport API](https://transport.opendata.ch/) only allows 1000 requests per 24 hours. The default polling rate is set to `90s`, which is just enough for one connection polling continuously. If more entries are needed, consider [defining a custom polling interval](#defining-a-custom-polling-interval) to reduce the amount of requests.
The [Stationboard](https://transport.opendata.ch/examples/stationboard.html) website can help to determine the exact name of the start and the end station.
@@ -40,3 +40,7 @@ name:
{% endconfiguration %}
The public timetables are coming from [Swiss public transport](https://transport.opendata.ch/).
+
+### Defining a custom polling interval
+
+{% include common-tasks/define_custom_polling.md %}
diff --git a/source/_integrations/switch.mqtt.markdown b/source/_integrations/switch.mqtt.markdown
index 77b7c13d181d..09f382a74263 100644
--- a/source/_integrations/switch.mqtt.markdown
+++ b/source/_integrations/switch.mqtt.markdown
@@ -18,8 +18,6 @@ When a `state_topic` is not available, the switch will work in optimistic mode.
Optimistic mode can be forced, even if the `state_topic` is available. Try to enable it, if experiencing incorrect switch operation.
-
| [Matter](/integrations/Matter/) |
-| 
| [HomeKit](/integrations/homekit_controller/) |
+## Logos on Thread-based smart home devices
+If you have a Thread-based consumer device, you will typically see a Thread logo on the packaging.
-## Thread — A communication protocol
+
-Home Assistant will sync the Thread credentials with Google when starting to commission a Matter device via the Home Assistant Companion app. For other vendors, if the vendor allows you to see the operational dataset in TLV format, you can import it to Home Assistant from the Thread panel.
+2. If you see the Apple HomeKit logo on your device packaging, follow the procedure [adding a HomeKit device to Home Assistant](/integrations/homekit_controller/#adding-a-homekit-device-through-thread).
+
+ 
+
+## About Thread
+
+This section introduces the terms *Thread* and *border router* and lists border routers that are supported by Home Assistant.
+
+### A communication protocol for IoT devices
+
+Thread is a low-power mesh networking standard for IoT devices. The low-power aspect is important for battery-powered smart home devices. However, it's also low-bandwidth, making it ideal for applications that don't send a lot of data, like switches or motion sensors.
+
+Thread uses the same RF technology as Zigbee (IEEE 802.15.4) but provides IP connectivity similar to Wi-Fi. Unlike Zigbee, Thread by itself does not allow controlling devices: It is just a communication protocol. To control the Thread devices, a higher-level protocol is required: {% term Matter %} or Apple HomeKit. Thread devices use the IPv6 standard to communicate both inside and outside the mesh network.
+
+### About Thread border routers
+
+The devices use Thread border routers to communicate outside the mesh with any IPv6-capable device. A Thread border router is connected to your network either via Wi-Fi or Ethernet and uses its RF radio to communicate with the Thread mesh network. The TBR routes packets between your local network and the Thread mesh. It does not look at the content of these packets, it just forwards them.
+
+
+
+Image taken from [the Thread Smart Home Fact Sheet](https://www.threadgroup.org/support#Resources) by the Thread Group. It illustrates the landscape of {% term Matter %}, {% term Thread %}, and Border routers. Instead of Matter, you could also see another protocol here, such as HomeKit.
+
+Unlike other protocols, Thread can use multiple border routers in a single network. This increases wireless coverage and reduces the risk of a single point of failure. Ideal for home automation, with a potentially large number of devices spread over a large area.
+
+#### OpenThread border routers
+
+OpenThread is an open source implementation of Thread, originally released by Google. Almost all commercially available Thread border routers are based on the open source implementation. However, the configuration of TBRs is not part of the Thread standard. This means that Google and Apple TBRs implementation setup and configured by their respective ecosystems.
+
+While Home Assistant can *use* any border router, it can *configure* and *control* only OpenThread border routers built with the REST API available in the open source implementation. The OpenThread Border Router add-on (as well as the OpenThread Border Router bundled in the experimental Silicon Labs Multiprotocol add-on) are built from this open source OpenThread code and have the REST API enabled.
+
+### List of Thread border router devices
+
+Home Assistant can act as a Thread border router. But it also supports third-party border routers. Often, Thread border routing is only an auxiliary functionality of a smart home device. For example, the Nest Hub (2nd gen) is a smart display, a Google Home controller, and a Chromecast target, but also has a Thread border router included.
+
+Currently, the following TBR devices are known to work with Home Assistant.
+These border routers may require an iPhone or Android phone for onboarding. What the exact requirements are, depends on the home automation protocol ({% term Matter %} or Apple HomeKit) that your devices are using. Before buying a border router, check the prerequisites in the corresponding procedures:
+
+- [Adding a Matter device to Home Assistant](/integrations/matter/#adding-a-matter-device-to-home-assistant)
+- [Adding an Apple HomeKit device through Thread](/integrations/homekit_controller/#adding-a-homekit-device-through-thread)
+
+#### Home Assistant
+
+Out of the box, Home Assistant SkyConnect and Yellow run Zigbee, not Thread. Currently, enabling Thread involves manual steps. The integration of the Home Assistant based Thread border router with Matter is work-in-progress.
+
+- If you have a Home Assistant Yellow or SkyConnect, you can use their Thread radio. Follow these steps to [turn Home Assistant into a Thread border router](#turning-home-assistant-into-a-thread-border-router).
+
+#### Google
+
+- **Displays**: Nest Hub (2nd gen), Nest Hub Max
+- **Wi-Fi routers**: Nest Wifi Pro (Wi-Fi 6E), Nest Wifi
+
+#### Apple
+
+- **Speakers**: HomePod (2nd generation), HomePod mini
+- **TVs**: Apple TV 4K (3rd generation) Wi-Fi + Ethernet, Apple TV 4K (2nd generation)
+
+#### Others
+
+There are also other companies that provide devices with border router capability, such as Nanoleaf or Amazon.
+
+## Turning Home Assistant into a Thread border router
+
+Follow these steps if you want to turn Home Assistant into a Thread border router using the Thread radio of Yellow, SkyConnect, or another compatible radio.
+
+Find out if you already have Thread networks:
+
+- Go to {% my integrations title="**Settings** > **Devices & Services**" %}.
+- If you do not see a **Thread** integration, add it.
+- Then, select **Configure** and check if you see any Thread networks on the overview page.
+- Case 1: If you do not have any Thread networks yet, follow [Case 1: Make Home Assistant your first Thread network](#case-1-making-home-assistant-your-first-thread-network)
+- Case 2: If you have existing networks, follow [Case 2: Create a HA border router when there is an existing network](#case-2-creating-a-ha-border-router-when-there-is-an-existing-network)
+
+### Case 1: Making Home Assistant your first Thread network
+
+Follow these steps if you want to turn Home Assistant into a Thread border router using the Thread radio of Yellow, SkyConnect, or another compatible radio and you do not have any third-party Thread networks present yet. This will automatically create a new Thread network with the name `ha-thread-xxxx`. The last for digits are a network-specific identifier (PAN ID).
+
+Note: To add Matter devices to this Thread network, an Android phone is required. Adding Matter devices to this Thread network using an iOS phone is not yet supported.
+
+#### Prerequisites
+
+- Device with a Thread-capable radio, such as Home Assistant Yellow, SkyConnect, or another compatible radio
+- Android phone
+- No third-party Thread networks present
+
+#### To make Home Assistant your first Thread network
+
+1. To enable Thread support on your Home Assistant Yellow or SkyConnect, you need to install the **OpenThread Border Router** add-on. Follow the corresponding procedure:
+ - [Enable Thread on Home Assistant Yellow](https://yellow.home-assistant.io/procedures/enable-thread/).
+ - [Enable Thread on Home Assistant SkyConnect](https://skyconnect.home-assistant.io/procedures/enable-thread/).
+
+2. Make sure the Home Assistant Thread network is defined as preferred network.
+ - This should happen automatically, but check to be sure.
+ - Go to {% my integrations title="**Settings** > **Devices & Services**" %}, select the **Thread** integration.
+ - Then, select **Configure**.
+ - You should see the Home Assistant logo under **Preferred network**.
+
+ 
+
+3. Before you can add Matter-based Thread devices, your phone needs to know the credentials of your newly created Thread network.
+ - To share the credentials with your Android phone, open the Home Assistant Companion app.
+ - In the Companion app, go to **Settings** > **Companion app** > **Troubleshooting**, then select **Sync Thread credentials**.
+ - Follow the instructions on screen.
+ - **Result**: You will see a confirmation stating that Thread credentials from Home Assistant have been added to this device.
+4. To add Matter-based Thread devices, follow the steps on [Adding a matter device to Home Assistant](/integrations/matter/#adding-a-matter-device-to-home-assistant).
+
+### Case 2: Creating a HA border router when there is an existing network
+
+Follow these steps if you want to turn Home Assistant into a Thread border router using the Thread radio of Yellow, SkyConnect, or another compatible radio but you already have third-party Thread networks present. These steps will join the Home Assistant Thread border router with the existing Thread network.
+
+
+
+If you have both Google and Apple Thread networks present, decide which one you would like add the Home Assistant border router to.
+
+#### Prerequisites
+
+- Device with a Thread-capable radio, such as Home Assistant Yellow, SkyConnect, or another compatible radio
+- Third-party Thread network listed
+- Android phone if you have a Google Thread network, iPhone if you have an Apple Thread network
+
+#### To create a HA border router when there is an existing network
+
+Note: the steps and images here show the process with a Google Thread network. But the process is very similar if you have an Apple Thread network with an iPhone.
+
+1. Make sure you have an Android/iPhone phone and your phone is in the same Wi-Fi network as your Google border router.
+2. First you need to import the Thread credentials of your Google thread network.
+ - In the companion app, go to {% my integrations title="**Settings** > **Devices & Services**" %}, select the **Thread** integration.
+ - Then, select **Configure** and **Import Credentials**.
+ - **Result**: You should see a notification that the credentials are imported.
+3. Refresh the screen.
+ - You should now see an 
icon, indicating that Home Assistant now has the credentials of that network.
+4. Select **Make preferred network**.
+ - **Result**: The selected network now shows as the preferred network.
+
+ 
+
+5. To enable Thread support on your Home Assistant Yellow or SkyConnect, you need to install the **OpenThread Border Router** add-on. Follow the corresponding procedure:
+ - [Enable Thread on Home Assistant Yellow](https://yellow.home-assistant.io/procedures/enable-thread/).
+ - [Enable Thread on Home Assistant SkyConnect](https://skyconnect.home-assistant.io/procedures/enable-thread/).
+ - **Result**: The network now shows as the preferred network, joined with the third-party network.
+
+ 
+ - 🎉 You successfully created a Home Assistant Thread network and joined it with a pre-existing third-party network.
+
+## Understanding the Thread configuration page
+
+This section explains why you might see multiple networks on the Thread configuration page and what this means for your network.
+
+### About different Thread networks
+
+Today, each vendor forms their own Thread network when you start using their products. This means you can end up having a Home Assistant, an Apple, and a Google Thread network in your home. The Thread configuration panel lists all Thread border routers and groups them by the Thread network.
+
+
+The Thread configuration page shows three vendor-specific Thread networks.
+
+
+ - Importing the credentials allows a Google- or Apple-created Thread network to be the preferred network of Home Assistant.
+ 
+
+### Combining Thread networks
+
+In the current implementation, having multiple TBRs from different vendors results in separate networks using different credentials. This prevents devices from roaming between the Thread networks. In theory, it would be better to join all Thread networks into a single network to increase the size of the mesh network. A dense mesh network should lead to better RF coverage and better link quality, which lowers transmission latencies, making communication faster.
diff --git a/source/_integrations/time_date.markdown b/source/_integrations/time_date.markdown
index d3abb4b66eac..cfac87ee2a8b 100644
--- a/source/_integrations/time_date.markdown
+++ b/source/_integrations/time_date.markdown
@@ -6,43 +6,20 @@ ha_category:
ha_iot_class: Local Push
ha_release: pre 0.7
ha_quality_scale: internal
+ha_config_flow: true
ha_codeowners:
- '@fabaff'
ha_domain: time_date
ha_platforms:
- sensor
-ha_integration_type: integration
+ha_integration_type: service
---
The time and date (`time_date`) integration allows one to create sensors for the current date or time in different formats. All values are based on the timezone which is set in "General Configuration".
-To have these sensors available in your installation, add the following to your `configuration.yaml` file (each option creates a separate sensor that contains appropriate data, e.g., `sensor.date` for the `date` option):
+{% include integrations/config_flow.md %}
-```yaml
-# Example configuration.yaml entry
-sensor:
- - platform: time_date
- display_options:
- - 'time'
- - 'date'
- - 'date_time'
- - 'date_time_utc'
- - 'date_time_iso'
- - 'time_date'
- - 'time_utc'
- - 'beat'
-```
-
-
-{% configuration %}
-display_options:
- description: The sensors to create. The types *date_time*, *date_time_utc*, *time_date*, and *date_time_iso* create combined date and the time sensors. The other types just the time sensor or the date sensor. *beat* creates the [Swatch Internet Time](https://en.wikipedia.org/wiki/Swatch_Internet_Time).
- required: true
- type: list
-{% endconfiguration %}
-
-
-Sensors including the time update every minute, the date sensor updates each day at midnight, and the beat sensor updates with each beat (86.4 seconds).
+Sensors including the time update every minute, the date sensor updates each day at midnight.
diff --git a/source/_integrations/timer.markdown b/source/_integrations/timer.markdown
index 041e4e4f2d2f..60acde7ac076 100644
--- a/source/_integrations/timer.markdown
+++ b/source/_integrations/timer.markdown
@@ -107,7 +107,7 @@ Change an active timer. This changes the duration of the timer with the duration
### Service `timer.pause`
-Pause a running timer. This will retain the remaining duration for later continuation. You can also use `entity_id: all` and all active timers will be paused.
+Pause a running timer. This will retain the remaining duration for later continuation. To resume a timer use the `timer.start` service without passing a duration. You can also use `entity_id: all` and all active timers will be paused.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
diff --git a/source/_integrations/tod.markdown b/source/_integrations/tod.markdown
index caa1cee5830f..d7a193c03b38 100644
--- a/source/_integrations/tod.markdown
+++ b/source/_integrations/tod.markdown
@@ -99,7 +99,7 @@ binary_sensor:
In the above example, the next day `sunrise` is calculated as a time range end.
-## Daylight Savings Time Handling
+## Daylight Saving Time Handling
The ToD sensor handles the following cases where the sensor interval:
- does not exist at all
@@ -111,21 +111,21 @@ To help understand all 3 cases, actual examples are provided below.
### Case 1: Sensor Interval Does Not Exist
Let's make the following assumptions:
-- Daylight Savings starts at 2am
+- Daylight Saving starts at 2am
- On the DST day, the ToD sensor interval is from non-existent 2:30am to non-existent 2:40am.
In this case, the ToD sensor will not trigger since the 2:30am-2:40am interval does not exist on the day when time jumps from 2am to 3am. However, on the following day, the sensor resumed operating normally.
### Case 2: Sensor End Time Does Not Exist
-- Daylight Savings starts at 2am
+- Daylight Saving starts at 2am
- On the DST day, the ToD sensor interval is from 1:50am to non-existent 2:10am.
In this case, the ToD sensor will last 10 minutes starting at 1:50am and stop at 3am (the 2am-3am time is jumped over and does not exist).
### Case 3: Sensor Start Time Does Not Exist
-- Daylight Savings starts at 2am
+- Daylight Saving starts at 2am
- On the DST day, the ToD sensor interval is from non-existent 2:50am to 3:10am.
In this case, the ToD sensor will last 10 minutes, starting at 3:00am and stopping at 3:10am (the 2am-3am time is jumped over and does not exist).
diff --git a/source/_integrations/todo.markdown b/source/_integrations/todo.markdown
index 1351684b0996..8799cfc8e9af 100644
--- a/source/_integrations/todo.markdown
+++ b/source/_integrations/todo.markdown
@@ -9,14 +9,21 @@ ha_quality_scale: internal
ha_codeowners:
- '@home-assistant/core'
ha_integration_type: entity
+related:
+ - docs: /integrations/local_todo
+ title: Local to-do list integration documentation
+ - docs: /dashboards/todo-list/
+ title: To-do list card
---
-The to-do list integration provides to-do list entities, allowing other integrations
-to integrate to-do lists into Home Assistant. To-do lists are shown on the to-do list
+The **To-do list** {% term integration %} provides to-do list {% term entities %}, allowing other integrations
+to integrate to-do lists into Home Assistant. To-do lists are shown on the **To-do lists**
dashboard for tracking items and whether or not they have been completed.
{% include integrations/building_block_integration.md %}
+For example, [Local to-do](/integrations/local_todo/) is a fully local integration to create to-do lists and tasks within your Home Assistant instance, [Shopping list](/integrations/shopping_list) specifically for shopping that can be added to with Assist, or other integrations work with online services providing to-do list data.
+
## Viewing and managing to-do lists
Each to-do list is represented as its own entity in Home Assistant and can be
@@ -28,19 +35,25 @@ in the main sidebar of your Home Assistant instance.
The state of a to-do list entity is a number, which represents the number of
incomplete items in the list.
+## Blueprint to add an item to a dedicated list
+
+This blueprint allows you to create a script to add an
+item to a pre-configured to-do list.
+
+{% my blueprint_import badge blueprint_url="https://community.home-assistant.io/t/add-to-do-item/699193" %}
+
## Services
Some to-do list integrations allow Home Assistant to manage the to-do items in the list. The
services provided by some to-do list entities are described below or you can read more about [Service Calls](/docs/scripts/service-calls/).
-
### Service `todo.get_items`
Get to-do items from a to-do list. A to-do list `target` is selected with a [target selector](/docs/blueprint/selectors/#target-selector). The `data` payload supports the following fields:
-| Service data attribute | Optional | Description | Example |
-| ---------------------- | -------- | ----------- | --------|
-| `status` | yes | Only return to-do items with this status. | `needs_action`, `completed`
+| Service data attribute | Optional | Description | Example |
+| ---------------------- | -------- | ----------------------------------------- | --------------------------- |
+| `status` | yes | Only return to-do items with this status. | `needs_action`, `completed` |
This is a full example that returns all to-do items that have not been completed:
@@ -57,12 +70,12 @@ data:
Add a new to-do item. A to-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector) and the `data` payload supports the following fields:
-| Service data attribute | Optional | Description | Example |
-| ---------------------- | -------- | ----------- | --------|
-| `item` | no | the name of the to-do Item. | Submit income tax return
-| `due_date` | yes | The date the to-do item is expected to be completed. | 2024-04-10
-| `due_datetime` | yes | The date and time the to-do item is expected to be completed. | 2024-04-10 23:00:00
-| `description` | yes | A more complete description than the one provided by the summary | Collect all necessary documents and submit the final return.
+| Service data attribute | Optional | Description | Example |
+| ---------------------- | -------- | ---------------------------------------------------------------- | ------------------------------------------------------------ |
+| `item` | no | the name of the to-do Item. | Submit income tax return |
+| `due_date` | yes | The date the to-do item is expected to be completed. | 2024-04-10 |
+| `due_datetime` | yes | The date and time the to-do item is expected to be completed. | 2024-04-10 23:00:00 |
+| `description` | yes | A more complete description than the one provided by the summary | Collect all necessary documents and submit the final return. |
Only one of `due_date` or `due_datetime` may be specified.
@@ -82,14 +95,14 @@ data:
Update a to-do item. A to-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector) and the `data` payload supports the following fields:
-| Service data attribute | Optional | Description | Example |
-| ---------------------- | -------- | ----------- | --------|
-| `item` | no | The name of the to-do Item to update. | Submit income tax return
-| `rename` | yes | The new name of the to-do Item. | Something else
-| `status` | yes | The overall status of the To-do Item. | `needs_action` or `completed`
-| `due_date` | yes | The date the to-do item is expected to be completed. | 2024-04-10
-| `due_datetime` | yes | The date and time the to-do item is expected to be completed. | 2024-04-10 23:00:00
-| `description` | yes | A more complete description than the one provided by the summary. | Collect all necessary documents and submit the final return.
+| Service data attribute | Optional | Description | Example |
+| ---------------------- | -------- | ----------------------------------------------------------------- | ------------------------------------------------------------ |
+| `item` | no | The name of the to-do Item to update. | Submit income tax return |
+| `rename` | yes | The new name of the to-do Item. | Something else |
+| `status` | yes | The overall status of the To-do Item. | `needs_action` or `completed` |
+| `due_date` | yes | The date the to-do item is expected to be completed. | 2024-04-10 |
+| `due_datetime` | yes | The date and time the to-do item is expected to be completed. | 2024-04-10 23:00:00 |
+| `description` | yes | A more complete description than the one provided by the summary. | Collect all necessary documents and submit the final return. |
At least one of `rename` or `status` is required. Only one of `due_date` or `due_datetime` may be specified. This is a full example of a service call that updates the status and the name of a to-do item.
@@ -107,9 +120,9 @@ data:
Removing a to-do item. A to-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector), and the `data` payload supports the following fields:
-| Service data attribute | Optional | Description | Example |
-| ---------------------- | -------- | ----------- | --------|
-| `item` | no | The name of the to-do item. | Submit income tax return
+| Service data attribute | Optional | Description | Example |
+| ---------------------- | -------- | --------------------------- | ------------------------ |
+| `item` | no | The name of the to-do item. | Submit income tax return |
This is a full example of a service call that deletes a to-do Item with the specified name.
diff --git a/source/_integrations/todoist.markdown b/source/_integrations/todoist.markdown
index a76b775331fd..127d94013289 100644
--- a/source/_integrations/todoist.markdown
+++ b/source/_integrations/todoist.markdown
@@ -14,12 +14,25 @@ ha_platforms:
- todo
ha_integration_type: integration
ha_config_flow: true
+related:
+ - docs: /integrations/todo
+ title: To-do list integration documentation
+ - docs: /integrations/#to-do-list
+ title: List of to-do list integrations
+ - docs: /dashboards/todo-list/
+ title: To-do list card
+ - docs: /dashboards/dashboards/
+ title: Dashboards
+ - docs: /integrations/calendar/
+ title: Calendar
+ - url: https://todoist.com
+ title: Todoist projects
---
This platform allows you to connect to your [Todoist projects](https://todoist.com) as [todo](/integrations/todo/) or [calendar](/integrations/calendar/) entities. All tasks get updated roughly every 15 minutes.
-A calendar entity will be `on` if you have a task due in that project. It will be `off` if all the tasks in the project are completed or if the project doesn't have any tasks at all.
+A calendar entity will be `on` if you have a task due in that project. It will be `off` if all the tasks in the project are completed or if the project doesn't have any tasks at all.
## Prerequisites
diff --git a/source/_integrations/tolo.markdown b/source/_integrations/tolo.markdown
index 530775b786da..9c46d58439d0 100644
--- a/source/_integrations/tolo.markdown
+++ b/source/_integrations/tolo.markdown
@@ -1,6 +1,6 @@
---
title: TOLO Sauna
-description: Control your TOLO Sauna and TOLO Steam Bath with Home Assistant.
+description: Control your TOLO Sauna and Steam Bath with Home Assistant.
ha_release: '2021.12'
ha_category:
- Climate
@@ -20,19 +20,111 @@ ha_platforms:
- number
- select
- sensor
+ - switch
ha_dhcp: true
ha_integration_type: integration
---
-The TOLO Sauna integration allows you to control your [TOLO Sauna and TOLO Steam Bath](https://www.tolosauna.com/) with Home Assistant.
+The TOLO integration allows to control [Steamtec TOLO](https://www.tolosauna.com/) devices with Home Assistant.
-The integration allows for:
-- Turning the sauna on and off
-- Setting the target temperature and target humidity
-- Controlling the fan (used for drying and cooling down the sauna)
-- Controlling the sauna lights (on/off, mode selection)
-- Configuring timers for automatic power shutdown, automatic fan shutdown and salt spray activation interval
-- Checking diagnostic information (water level, tank temperature, water in/out valves)
+## Prerequisites
+
+To be able to connect to your TOLO system via Home Assistant, you need to have the TOLO App Control Box, which is also required to be able to control your TOLO system using your mobile phone.
+Connect the TOLO App Control Box to your network.
+For auto detection, your Home Assistant instance needs to be connected to the same network broadcast domain as your TOLO App Control Box (which is usually true for normal home networks).
+However, you can also manually define the IP to which the Home Assistant TOLO integration should connect to.
+Please use your router to find out the IP address of your TOLO App Control Box.
+
+
+## Features
+
+**General notice:**
+A TOLO system can be equipped with many optional accessoires, such as [lights](#light-control), [fans](#fan-control), [aroma oil injectors](#aroma-therapy), [sole nebulizer](#salt-bath) and [descaling pump](#sweeping-and-descaling).
+The TOLO system does not report back which optional accessories are attached. Therefore, the TOLO integration always provides all possible entities even if the features are not available due to missing optional accessories.
+
+
+### Sauna operating mode
+
+The TOLO integration offers a climate entity to control the general operating mode of your TOLO system.
+This can either be *Off*, *Heat*, or *Dry*.
+
+ - *Off*: Energy is shut down, the water boiler is empty (or will be emptied soon, see [Sweeping and Descaling](#sweeping-and-descaling)).
+ - *Heat*: This is the normal operating mode for enjoying your sauna or steam bath.
+ If *Power timer* is set to a value greater than zero, the TOLO system will automatically turn off after the amount of minutes configured in the *Power timer* setting.
+ If *Power timer* is set to zero, the TOLO system will run indefinitely, until it is turned off manually.
+ - *Dry*: In this mode, everything is turned off except the fan.
+ This mode can be used when shutting down the TOLO system to reduce humidity in the room.
+ After the time configured in *Fan timer* (see [Fan Control](#fan-control)) has passed, the fan and the TOLO system will automatically turn to *Off*.
+
+
+### Temperature and humidity
+
+The TOLO system allows setting a target temperature between 35°C and 60°C.
+The TOLO system will heat and continue to produce steam until the room temperature sensor reaches the configured target temperature.
+
+Target humidity can be set between 60% and 99%.
+Once the configured humidity is reached, the steam generator will stop producing steam.
+If then the humidity is below 6% (this value is hardcoded by TOLO systems and cannot be changed by the TOLO integration), the TOLO system will start to produce steam again.
+This setting is only recognized if the TOLO system is equipped with a humidity sensor (not part of the default configuration).
+If no humidity sensor is present, steam production will only depend on the temperature.
+
+
+### Light control
+
+The TOLO system allows to connect RGB LEDs, which can be controlled by the TOLO integration.
+The TOLO system provides two modes for LED operation, *manual* and *automatic*.
+
+ - *Manual*: When turned on, the RGB LEDs will stick to the same color until it is manually changed by pressing the *Next color* button.
+ - *Automatic*: When turned on, the RGB LEDs will slowly fade from one color to another.
+
+
+### Fan control
+
+The TOLO system allows to connect a fan, which can be used to reduce the humidity after the steam generation has been turned off.
+Once activated, the fan will automatically turn off between 1 and 60 minutes, depending on the *Fan timer* setting.
+
+
+### Aroma therapy
+
+The TOLO system allows to connect an aroma oil injector with slots for either one or two aroma flavors.
+When enabled, the aroma pump will work every 5 minutes for 5 seconds each.
+Unfortunately, the TOLO system does not allow to change these intervals.
+For shorter intervals between pump activations, the TOLO manual suggests to manually disable and enable *Aroma therapy*.
+
+
+### Salt bath
+
+The TOLO system allows to connect a sole nebulizer, which can be used to inject salt spray in your sauna or steam bath room to allow for a salt bath.
+Using the *Salt bath timer*, the salt bath feature can be configured to run indefinitely (set *Salt bath timer* to 0) or for a pre-defined time between 1 and 60 minutes.
+
+
+### Sweeping and descaling
+
+The TOLO system has a built-in system for sweeping and descaling.
+This feature is currently not supported by the TOLO integration and will be added in an upcoming release.
+
+
+### Diagnostic information
+
+Beside the controls described above, the TOLO integration provides following diagnostic information:
+ - *Power timer*:
+ The remaining time the TOLO system will produce steam after it has been turned on.
+ - *Fan timer*:
+ The remaining time the fan will be on after it has been turned on.
+ - *Salt bath timer*:
+ The remaining time the salt bath will be active after it has been turned on.
+ - *Tank temperature*:
+ Current temperature of the water in the water tank.
+ Should be close to 100°C when in *Heat* mode.
+ - *Water level*:
+ The current water level in the water tank.
+ This should be 0% when off and 100% when in *Heat* mode.
+ - *Water in/out valves*:
+ Indicates if the TOLO system currently lets water run in or out.
+ When starting up, *Water in valve* should be open while *Water out valve* should be closed.
+ During *Heat* operation, both valves should be normally closed except short moments where consumed water needs to be refilled.
+ When off, the *Water out valve* should remain open.
+
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/totalconnect.markdown b/source/_integrations/totalconnect.markdown
index 4c1f859116c7..80db768bbe4e 100644
--- a/source/_integrations/totalconnect.markdown
+++ b/source/_integrations/totalconnect.markdown
@@ -4,6 +4,7 @@ description: Integrate Resideo Total Connect 2.0-enabled alarm systems into Home
ha_category:
- Alarm
- Binary sensor
+ - Button
ha_release: 0.42
ha_iot_class: Cloud Polling
ha_config_flow: true
@@ -13,6 +14,7 @@ ha_domain: totalconnect
ha_platforms:
- alarm_control_panel
- binary_sensor
+ - button
- diagnostics
ha_integration_type: integration
---
@@ -94,7 +96,11 @@ The integration provides a binary sensor for each Total Connect zone. To see fau
The Total Connect API has limited zone type information. Home Assistant device class `door` is assigned to Total Connect entry/exit, perimeter, and motion zones; along with most alarm panel buttons. The sensor will appear as `True` if the zone is opened (either fault or triggered in Total Connect) and `False` if closed. Device class `smoke` is assigned to Total Connect smoke detectors and alarm panel buttons set to a "Fire No Verification" response type. The sensor will appear as `True` if smoke is detected or the respective button is pressed. Device class `gas` is assigned to Total Connect carbon monoxide detectors. The sensor will appear as `True` if carbon monoxide is detected.
-### Diagnostic Sensors
+## Buttons
+
+The integration provides a bypass button for each zone that can be bypassed. The **Bypass All** button for the alarm panel will bypass all faulted or troubled zones. The **Clear Bypass** button for the alarm panel will clear all bypassed zones.
+
+## Diagnostic Sensors
The following diagnostic sensors are available:
diff --git a/source/_integrations/tplink.markdown b/source/_integrations/tplink.markdown
index 3cd7a9da1f97..6ec871c023e2 100644
--- a/source/_integrations/tplink.markdown
+++ b/source/_integrations/tplink.markdown
@@ -1,5 +1,5 @@
---
-title: TP-Link Kasa Smart
+title: TP-Link Smart Home
description: Instructions on integrating TP-Link Smart Home Devices to Home Assistant.
ha_category:
- Hub
@@ -13,6 +13,7 @@ ha_codeowners:
- '@rytilahti'
- '@thegardenmonkey'
- '@bdraco'
+ - '@sdb9696'
ha_domain: tplink
ha_platforms:
- diagnostics
@@ -24,15 +25,12 @@ ha_quality_scale: platinum
ha_integration_type: integration
---
-The `tplink` integration allows you to control your [TP-Link Smart Home Devices](https://www.tp-link.com/kasa-smart/) such as plugs, power strips, wall switches and bulbs.
+The `tplink` integration allows you to control your [TP-Link Kasa Smart Home Devices](https://www.tp-link.com/kasa-smart/) and [TP-Link Tapo Devices](https://www.tapo.com/) such as plugs, power strips, wall switches and bulbs.
-You need to provision your newly purchased device to connect to your network before it can be added via the integration. This can be done either by using [kasa command-line tool](https://python-kasa.readthedocs.io/en/latest/cli.html#provisioning) or by adding it to the official Kasa app before trying to add them to Home Assistant. If you use the app, do not upgrade the firmware if it presents the option to avoid blocking the local access by potential firmware updates.
+You need to provision your newly purchased device to connect to your network before it can be added via the integration. This can be done either by using [kasa command-line tool](https://python-kasa.readthedocs.io/en/latest/cli.html#provisioning) or by adding it to the official Kasa or Tapo app before trying to add them to Home Assistant.
-There is currently support for the following device types within Home Assistant:
-
-- **Light**
-- **Switch**
-- **Sensor**
+If your device is a newer Kasa or Tapo device it will require your TP-Link cloud username and password to authenticate for local access.
+If you have an older device that does not currently require authentication, you may consider disabling automatic firmware updates to keep it that way.
{% include integrations/config_flow.md %}
@@ -40,9 +38,11 @@ There is currently support for the following device types within Home Assistant:
See [Supported Devices in python-kasa](https://github.com/python-kasa/python-kasa#supported-devices) for an up to date list.
-## Supported devices
+Devices not listed below may work but if you encounter issues submit a bug report to [python-kasa](https://github.com/python-kasa/python-kasa).
+
+### Not requiring authentication
-### Plugs
+#### Plugs
- HS100
- HS103
@@ -55,16 +55,18 @@ See [Supported Devices in python-kasa](https://github.com/python-kasa/python-kas
- KP125
- KP401
- EP10
-- EP25
+- EP25 (Hardware version < 2.6)
-### Power Strips
+#### Power Strips
- EP40
- HS300
- KP303
+- KP200
- KP400
+- KP405
-### Wall switches
+#### Wall switches
- ES20M
- HS200
@@ -74,7 +76,7 @@ See [Supported Devices in python-kasa](https://github.com/python-kasa/python-kas
- KS220M
- KS230
-### Bulbs
+#### Bulbs
- EP40
- LB100
@@ -90,19 +92,45 @@ See [Supported Devices in python-kasa](https://github.com/python-kasa/python-kas
- KL130
- KL135
-### Light strips
+#### Light strips
- KL400
- KL420
- KL430
-Other bulbs may also work, but with limited color temperature range (2700-5000). If you find a bulb isn't reaching the full-color temperature boundaries, submit a bug report to [python-kasa](https://github.com/python-kasa/python-kasa).
+### Requiring authentication
+
+#### Plugs
+
+- EP25 (Hardware version >= 2.6)
+- KP125M
+- P110
+- HS100 (UK Hardware version 4.1 with firmware 1.1.0)
+
+#### Wall switches
+
+- KS205
+- KS225
+
+#### Bulbs
+
+- L510B
+- L530E
+- TL135E
+
+#### Light strips
+
+- L900-5
+- L900-10
+- L920
+
+#### Power Strips
-## Unsupported devices
+- P300
-### Plugs
+## Light strip effects
-- KP125M (supported via [Matter](/integrations/matter/#tp-link-tapo-p125m-power-plug), but without energy monitoring features)
+Light strip effects are currently only supported for the device types not requiring authentication.
### Random Effect - Service `tplink.random_effect`
@@ -153,7 +181,7 @@ data:
random_seed: 80
```
-### Seqeuence Effect - Service `tplink.sequence_effect`
+### Sequence Effect - Service `tplink.sequence_effect`
The light strips allow setting a sequence effect.
diff --git a/source/_integrations/tplink_omada.markdown b/source/_integrations/tplink_omada.markdown
index 5c8bb88ea64e..d81801236fc1 100644
--- a/source/_integrations/tplink_omada.markdown
+++ b/source/_integrations/tplink_omada.markdown
@@ -37,7 +37,7 @@ TP-Link Omada Controller:
- OC200
- OC300
-- Software Controller.
+- Software Controller
Controller versions 5.1.0 and later are supported.
@@ -45,18 +45,17 @@ Controller versions 5.1.0 and later are supported.
### Network Switches
-- Support for enabling/disabling Power over Ethernet on a per-port basis.
-- Firmware Update entities.
+- Support for enabling/disabling Power over Ethernet on a per-port basis
+- Firmware Update
### Access Points
-- Firmware Update entities.
+- Firmware Update
### Internet Gateways
-- Firmware Update entities.
-- WAN/LAN Port connectivity sensor entities.
-
-## Device trackers
-
-- Not currently supported.
+- WAN/LAN Port connectivity sensors
+- WAN Port Online detection sensors
+- WAN Port Connect/Disconnect switches
+- LAN Port PoE activity sensor
+- Firmware Update
diff --git a/source/_integrations/tplink_tapo.markdown b/source/_integrations/tplink_tapo.markdown
new file mode 100644
index 000000000000..b5a64c39ce9b
--- /dev/null
+++ b/source/_integrations/tplink_tapo.markdown
@@ -0,0 +1,29 @@
+---
+title: Tapo
+description: Connect and control your Tapo devices using the TP-Link Smart Home integration
+ha_category:
+ - Hub
+ - Light
+ - Sensor
+ - Switch
+ha_domain: tplink_tapo
+ha_release: 0.89
+ha_integration_type: virtual
+ha_supporting_domain: tplink
+ha_supporting_integration: TP-Link Smart Home
+ha_codeowners:
+ - '@rytilahti'
+ - '@thegardenmonkey'
+ - '@bdraco'
+ - '@sdb9696'
+ha_config_flow: true
+ha_platforms:
+ - diagnostics
+ - light
+ - sensor
+ - switch
+ha_iot_class: Local Polling
+ha_dhcp: true
+---
+
+{% include integrations/supported_brand.md %}
diff --git a/source/_integrations/traccar.markdown b/source/_integrations/traccar.markdown
index 829318c8b423..ebbbd02e73e5 100644
--- a/source/_integrations/traccar.markdown
+++ b/source/_integrations/traccar.markdown
@@ -1,11 +1,11 @@
---
-title: Traccar
+title: Traccar Client
description: Instructions how to use Traccar GPS tracker to track devices in Home Assistant.
ha_release: 0.83
ha_category:
- Car
- Presence detection
-ha_iot_class: Local Polling
+ha_iot_class: Cloud Push
ha_config_flow: true
ha_codeowners:
- '@ludeeus'
@@ -15,161 +15,14 @@ ha_platforms:
ha_integration_type: integration
---
-`Traccar` uses GPS for tracking and has support for over 1500 different types of devices. One option is to track the [Traccar Client](https://www.traccar.org/client/) app on a smartphone via `webhook`. The other option is to connect to an existing [Traccar Server](https://www.traccar.org/server/) installation which is also available as Home Assistant add-on.
+`Traccar` uses GPS for tracking and has support for over 1500 different types of devices. You can use the [Traccar Client](https://www.traccar.org/client/) app on a smartphone via `webhook`.
-## Traccar client
+
-[Year of the Voice]: https://www.home-assistant.io/blog/2022/12/20/year-of-voice/
-[Chapter 1]: https://www.home-assistant.io/blog/2023/01/26/year-of-the-voice-chapter-1/
-[Chapter 4]: https://www.home-assistant.io/blog/2023/10/20/year-of-the-voice-chapter-4/
-[Assist]: https://www.home-assistant.io/voice_control/
-[exposed]: https://www.home-assistant.io/voice_control/voice_remote_expose_devices/
-[alias]: https://www.home-assistant.io/voice_control/aliases
+[Year of the Voice]: /blog/2022/12/20/year-of-voice/
+[Chapter 1]: /blog/2023/01/26/year-of-the-voice-chapter-1/
+[Chapter 4]: /blog/2023/10/20/year-of-the-voice-chapter-4/
+[Assist]: /voice_control/
+[exposed]: /voice_control/voice_remote_expose_devices/
+[alias]: /voice_control/aliases
[wyoming]: https://github.com/rhasspy/wyoming
[openWakeWord]: https://github.com/dscripka/openWakeWord
[Piper]: https://github.com/rhasspy/piper/
[community-wake-words]: https://github.com/fwartner/home-assistant-wakewords-collection
[ESP32-S3-BOX-3]: https://www.espressif.com/en/news/ESP32-S3-BOX-3
-[wyoming]: https://www.home-assistant.io/integrations/wyoming
+[wyoming]: /integrations/wyoming
[wyoming-satellite]: https://github.com/rhasspy/wyoming-satellite
[rpi-zero-2w]: https://www.raspberrypi.com/products/raspberry-pi-zero-2-w/
-[s3-box-tutorial]: https://www.home-assistant.io/voice_control/s3_box_voice_assistant/
+[s3-box-tutorial]: /voice_control/s3_box_voice_assistant/
[ESPHome]: https://esphome.io
[nabucasa]: https://www.nabucasa.com
[phone-tutorial]: https://www.home-assistant.io/voice_control/worlds-most-private-voice-assistant/
-[m5-tutorial]: http://localhost:4000/voice_control/thirteen-usd-voice-remote/
+[m5-tutorial]: /voice_control/thirteen-usd-voice-remote/
diff --git a/source/_posts/2023-12-14-disabling new login page functionality.markdown b/source/_posts/2023-12-14-disabling new login page functionality.markdown
new file mode 100644
index 000000000000..f5c2ce3b5d6f
--- /dev/null
+++ b/source/_posts/2023-12-14-disabling new login page functionality.markdown
@@ -0,0 +1,25 @@
+---
+layout: post
+title: "Disabling new login page functionality"
+description: "Why we are removing the redesigned login page introduced in release 2023.12 in patch 2023.12.3."
+date: 2023-12-14 00:00:00
+date_formatted: "December 14, 2023"
+author: Paulus Schoutsen
+author_twitter: balloob
+comments: true
+categories: Public-Service-Announcement
+---
+
+In [release 2023.12](https://www.home-assistant.io/blog/2023/12/06/release-202312/) we added a redesigned login page to Home Assistant. It detects when you are accessing Home Assistant via your local home network, and if so, presents a redesigned login experience that shows your user profiles. If you access Home Assistant from outside your home network, the login page still asks for your username and password, like before.
+
+We have heard the concerns from the community that this functionality can open up your Home Assistant instance to a user enumeration attack from within the local network. A malicious actor with access to your local network could get the names and pictures of all Home Assistant users. They could use this information to make attacking your Home Assistant instance easier.
+
+A security issue was filed for this on December 10, we have accepted and published the corresponding [GitHub Security Advisory](https://github.com/home-assistant/core/security/advisories/GHSA-jqpc-rc7g-vf83), and have disabled the redesigned login page functionality in patch 2023.12.3 released on December 14.
+
+While researching the feedback we received, we were troubled to discover that the users who experienced problems with the new login page often used misconfigured reverse proxies. When the reverse proxy is not configured correctly, Home Assistant is no longer able to discern between traffic from your local home network or a public network. These users would see the redesigned login page when accessing Home Assistant from outside their home network.
+
+To improve the network security of these users, we are researching how we can use Home Assistant to detect more variations of misconfigured proxies and inform them about it.
+
+We redesigned the login page because we believed the local home network is within the privacy of your own home and a trusted environment for showing the people in it. We assumed that users attempting to log in on the local network are also trusted and allowed to see other user profiles, similar to what Microsoft, Apple, Netflix, and other companies assume in their products.
+
+That said, we do hear you and take your feedback, and the potential security risk to users with misconfigured reverse proxies, seriously. Thank you for bringing this to our attention and being open about your concerns.
diff --git a/source/_posts/2023-12-27-companion-app-for-ios-202312-lets-go.markdown b/source/_posts/2023-12-27-companion-app-for-ios-202312-lets-go.markdown
new file mode 100644
index 000000000000..dafa8987f274
--- /dev/null
+++ b/source/_posts/2023-12-27-companion-app-for-ios-202312-lets-go.markdown
@@ -0,0 +1,53 @@
+---
+layout: post
+title: "Companion app for iOS 2023.12: Let’s go!"
+description: "Bruno Pantaleão has joined Nabu Casa as an iOS engineer and will work on improving the experience of the Companion App for iOS users. 2023.12 brings us Apple Thread credentials sharing, a new WatchOS icon, a **Select All** scene toggle, and a **What’s New** link."
+date: 2023-12-27 00:00:02
+date_formatted: "December 27, 2023"
+author: Bruno Pantaleão
+comments: true
+categories: iOS Release-Notes
+og_image: /images/blog/2023-12-ios-lets-go/ios-og.png
+---
+
+We have good news for those hoping for more features and faster development of the iOS Companion App! I, Bruno Pantaleão, have joined Nabu Casa as an iOS engineer (of course, also working on watchOS, iPadOS, and macOS apps), and am planning to continue the great work done by Robbie Trencheny, Zac West, and the community, giving the iOS app the attention that it deserves. So let’s talk about this month’s 2023.12 release of the app!
+
+
+
+
+
+## Apple Thread network credentials sharing
+
+If you have HomePods or Apple TVs and you also have a Thread border router in Home Assistant, you may want to take advantage of Apple’s network to control devices in your home. You can now import your Apple Thread credentials into Home Assistant and then make Apple the preferred Thread network.
+
+
+
+## New watchOS App Icon
+
+We updated the Apple Watch App Icon with the new Home Assistant logo.
+
+
+
+## Toggle all scenes for watchOS
+
+Previously, you would have to disable scenes one by one to hide them on your Apple Watch. If you, like me, have a Philips Hue bridge, you would probably see several auto-generated scenes (like ‘Bathroom concentrate’ and ‘Bathroom Arctic aurora’ below :D ) that are not always relevant to see on your watch. We added a button to quickly toggle between all scenes now in the iOS companion app.
+
+
+
+## Keep up with “What’s new” in the App
+
+We have added a **What’s new?** link in companion App settings so you can quickly access the latest App release notes.
+
+
+
+## Support for iOS 12, 13, and 14 in 2024.01
+
+In the new year, we will do some housecleaning to make sure that the iOS Companion App is prepared for the future. To do so, we will stop supporting iOS 12, 13, and 14 in release 2024.01 of the Companion App. We know our users are repurposing older phones and tablets into dashboards and controls for their homes, which aligns with our focus on sustainability. It's why we try to keep our apps running on older devices for as long as we can.
+
+Currently, less than 1% of our users (according to the App Store analytics provided by users who gave permission to share their data with Apple) are still on these three iOS versions. Supporting them makes the codebase hard to maintain and blocks us from using newer iOS features. This change will make it easier for new contributors to feel comfortable contributing to the iOS codebase, which is also one of my goals. With a more modern codebase, we can give more attention to PRs and help other contributors have everything they need to feel comfortable submitting PRs.
+
+This does not mean your iOS 12, 13, or 14 devices have become unusable. You can still access your Home Assistant using the browser if you have a device that can't update past iOS 12, such as the 2014 iPhone 6 or iPad Mini 3. All other devices currently capable of running iOS 13 or 14 can be updated to iOS 15 or higher and use the new versions of the iOS Companion App.
+
+## On the roadmap
+
+Wondering what we have on the roadmap for our Apple apps? We’re still working on it, but you can expect further developments to make Home Assistant on the Apple ecosystem more integrated, bringing shared features between iPhone, Apple Watch, iPad, and Mac - and I’m looking forward to getting my hands on Apple Vision Pro and seeing the possibilities it brings to the Open Home. We’re also planning on improvements to Siri shortcuts widgets and as many new sensors as possible. Another feature that is on our radar is Assist; in 2023, we completed the Year of the Voice. Android users benefitted from some extra functions compared to iOS users, and we want to make sure we catch up and bring these features to iPhones as well!
\ No newline at end of file
diff --git a/source/_posts/2024-01-03-release-20241.markdown b/source/_posts/2024-01-03-release-20241.markdown
new file mode 100644
index 000000000000..13c0cc350f12
--- /dev/null
+++ b/source/_posts/2024-01-03-release-20241.markdown
@@ -0,0 +1,975 @@
+---
+layout: post
+title: "2024.1: Happy automating!"
+description: "Happy New Year! 🥂 2024.1 starts with many UI improvements to our automation editor, due date and description support for to-do items, a brand new valve entity, and more card features!"
+date: 2024-01-03 00:00:00
+date_formatted: "January 3, 2024"
+author: Franck Nijhof
+author_twitter: frenck
+comments: true
+categories:
+ - Release-Notes
+ - Core
+og_image: /images/blog/2024-01/social.png
+---
+
+
+
+A small but effective improvement to help new users get started. We have also
+applied this same improvement to the scripts and scenes dashboards.
+
+### Guidance when creating a new automation
+
+When starting a new automation from scratch, you used to be greeted by some,
+possibly, new terminology and almost a blank page with some buttons to
+add triggers, conditions or actions. As a new user, this immediately imposes
+a challenge: what do I need to do?
+
+You guessed it: We have slightly improved that. We have changed the big headers
+to be more descriptive and less technical. We have also added some help text to
+explain each section, including examples of what they can be used for.
+
+
+
+Don’t worry; we’ll hide the explanation once you add elements to the sections
+to keep the overview of existing automations as clean as possible.
+
+### Building blocks
+
+You might have noticed in the screenshots above the conditions and actions have
+a new button next to them: **+ Add building block**.
+
+Selecting these new buttons allows you to add logical elements to your
+automation or scripts, like **And**, **Or**, **If-then**, **Choose**, etc.
+
+These used to be mixed in with the conditions and actions but now have their
+own dedicated button. It makes it easier to find them and declutters the
+list of conditions and actions.
+
+
+
+Notice how this now opens up a dialog? A dialog gives us more space to describe
+what each building block does and room for a search box to find the one you need.
+
+### Improved trigger, condition & action buttons
+
+The bigger change can be found in the buttons to add a trigger, conditions,
+or actions to your automation. This change was not just aimed at new users
+but also long-time users.
+
+All these buttons are used to give a dropdown that allows you to select the
+type of trigger, condition, or action you want to add. This dropdown has been
+replaced by a new dialog similar to the one we just saw for the building blocks.
+
+Like the building block, it describes what each trigger, condition,
+or action does. These descriptions are important, as they help you understand
+what they do.
+
+
+
+If you add an element, we will first show you the most used
+triggers/conditions/actions by our community. We now have all others neatly
+grouped. For actions, we took it a step further and unified them with
+service calls.
+
+### Unified actions
+
+If you have been using Home Assistant for a while, you are probably familiar
+with the “service call”-action that you can add to your automation. But,
+honestly, what is a “service call”? It is a bit of a technical term that is
+especially confusing for newer users. You just want to turn on a light, right?
+
+This release unifies those “service calls” with all other actions, meaning
+there is no “service call” anymore; that layer has been refactored from the UI.
+Instead, you add an action and select the action you want to take, for example,
+turn on a light.
+
+
+
+This means that if you add an action, you see all actions (including all
+service calls), categorized, with description, and searchable! Being able
+to search through all available actions is a huge improvement.
+
+
+
+By default, just like with the triggers and conditions, we show you the most
+used actions first and the actions for the entities you have on your system.
+All others are neatly grouped by integration in the **Other actions** section.
+
+
+
+## Description & due date support for to-do list items
+
+The to-do list integration keeps getting better and better. This release adds
+support for descriptions and due dates!
+
+If the integration you are using supports it, you can now add descriptions to
+each task on your list. It fully supports the Markdown markup to add links,
+bold text, etc. If due dates (or due date + time) are supported, you can
+set these.
+
+
+
+As shown in the screenshot above, there is a whole new dialog to adjust
+your to-do item. But this is not the only change. The list itself has been
+improved as well.
+
+
+
+It is much cleaner, all big text boxes are gone, and each item is nicely
+formatted, including an excerpt of the description and the due date. If the due
+date is overdue, it will be highlighted.
+
+## New entity type: Valve
+
+A brand new entity type has been added to Home Assistant: Valve!
+
+Integrations can use this entity type to expose valves, such as a valve on
+a radiator, pool, sprinkler system, and main house gas or water line.
+
+
+
+Currently, the [Shelly integration] supports it and now provides a `valve` entity
+for the Valve addon for Shelly Gas. Additionally, support for it has been
+added to [MQTT], and the valve entities also work with Amazon Alexa
+and Google Assistant.
+
+Tip: Do you have a switch entity that controls a valve? You can now change the
+entity type to valve in the entity settings.
+
+[Shelly integration]: /integrations/shelly
+[MQTT]: integrations/valve.mqtt
+
+## Swappable current/target on thermostat & humidifier cards
+
+By popular demand, the thermostat and humidifier cards now support setting
+current temperature/humidity as the primary information to show on the
+card.
+
+You can enable the **show current temperature as primary information** option
+in the card, which will result in the target temperature being swapped with the
+current temperature in the card.
+
+
+
+## New card features
+
+Last year, we saw many new features added to the cards, so let's start
+the new year with some more!
+
+[@Quentame] added the climate fan mode card feature. This feature can be
+used with both the thermostat and the tile card:
+
+
+
+Also new is the update actions card feature. This addition by [@piitaya] allows
+you to add buttons to a card to trigger update actions when pressed.
+
+
+
+[@piitaya]: https://github.com/piitaya
+[@Quentame]: https://github.com/Quentame
+
+## Other noteworthy changes
+
+There are many more improvements in this release; here are some of the other
+noteworthy changes this release:
+
+- Two brand new [template functions] have been added this release: `median` and
+ `statistical_mode`. Thanks, [@TheFes]!
+- [@bieniu] added support for the brand new Shelly 3rd generation devices to
+ the [Shelly] integration. Nice!
+- A long-time shutdown bug has been fixed: You can now run automations triggered
+ when Home Assistant shuts down. This could, for example, be used to send
+ yourself a notification when that happens. Thanks, [@tetele]!
+- Created your own fan controller using [ESPHome]? You can now add preset modes
+ to it! Thanks, [@mill1000]!
+- The [ping] integration now has the option to configure the number of seconds
+ that must elapse before considering a disconnected device "not at home".
+ Awesome, [@jpbede]!
+- Looking for the ZAMG integration? It has been renamed to [GeoSphere Austria].
+ Thanks, [@killer0071234]!
+- Got one of those Sonos amps? [@jjlawren] added support for the subwoofer
+ crossover setting to the [Sonos] integration. Nice!
+- [@tkdrob] added support for the new calendar entity to the [Radarr] integration.
+ So you can see the release schedules straight from Home Assistant. Awesome!
+- You can now configure the minimal number of samples the [trend] helper uses.
+ It allows you to make it less sensitive when there is not that much data.
+ Thanks, [@jpbede]!
+- Got cold toes in bed? [@kbickar] to the rescue! He added support for
+ foot warmers to the [SleepIQ] integration. Nice!
+
+[@bieniu]: https://github.com/bieniu
+[@jjlawren]: https://github.com/jjlawren
+[@jpbede]: https://github.com/jpbede
+[@kbickar]: https://github.com/kbickar
+[@killer0071234]: https://github.com/killer0071234
+[@mill1000]: https://github.com/mill1000
+[@tetele]: https://github.com/tetele
+[@TheFes]: https://github.com/TheFes
+[@tkdrob]: https://github.com/tkdrob
+[ESPHome]: /integrations/esphome
+[GeoSphere Austria]: /integrations/zamg
+[ping]: /integrations/ping
+[Radarr]: /integrations/radarr
+[Shelly]: /integrations/shelly
+[SleepIQ]: /integrations/sleepiq
+[Sonos]: /integrations/sonos
+[template functions]: /docs/configuration/templating/#numeric-functions-and-filters
+[trend]: /integrations/trend
+
+## New integrations
+
+We welcome the following new integrations in this release:
+
+- **[A. O. Smith]**, added by [@bdr99]
Big thanks to DXspark for helping us make the foundation of CarPlay and kicking off the project.
+
+
+
+## CarPlay features
+
+The app is divided into four tabs to easily access the different functionality. We’ve followed Apple’s guidelines to give the user a familiar experience that they know from other CarPlay apps.
+
+You don’t have to configure the CarPlay app separately. It will automatically pick up your Home Assistant servers as configured in your app.
+
+## Actions
+
+Actions are a concept in the Home Assistant iOS app that allows you to execute automation in Home Assistant. This means that you can execute any automation you want, such as:
+
+- “Open the garage and start heating my home to 22 degrees Celsius”
+- “Close the garage and announce in the kitchen that I arrived”
+- “Turn the front yard lights on and unlock the front door”
+
+These actions have been available in the Home Assistant for Apple Watch app and can be called from the Home Assistant widgets. With today’s release, you can also easily trigger them from your CarPlay dashboard. This is the feature that has already become part of my daily routine.
+
+If you haven’t created an Action yet, the CarPlay App can send a notification to your phone to guide you to get started.
+
+
+
+
+## Controls
+
+The controls tab will group your devices and entities by their domain. We have started small and included the most useful domains first:
+
+- Button
+- Cover
+- Input boolean
+- Input button
+- Light
+- Lock
+- Scene
+- Script
+- Switch
+
+For these domains, you can toggle lights and switches, activate buttons, script, scene actions, and of course, toggle your garage door or gate.
+
+
+
+
+## Areas
+
+The areas tab allows you to find your devices and entities based on their area. Quickly scroll through an area to see the current states and toggle devices.
+
+
+
+## Servers
+
+When you’re driving to your parents, you might want to be able to notify them or open their garage door as you arrive. With the “Servers” tab, you will be able to quickly change and control a different Home Assistant server.
+
+This feature builds upon the multiple server support that has been part of the Home Assistant iOS app for a couple of years now.
+
+
+
+I hope you will enjoy using Home Assistant on CarPlay. Please let us know what else you would like to see available for CarPlay!
+
+## Release notes
+
+- The app is now available for iOS 15+
+- CarPlay support was added for iOS 16+
+- The Bulgarian language was added
+- Improvements for iOS Actions so they’re easier to use
+- In macOS, the window size will be restored when you open the app again
+
diff --git a/source/_posts/2024-02-07-release-20242.markdown b/source/_posts/2024-02-07-release-20242.markdown
new file mode 100644
index 000000000000..6d9b72b6dbda
--- /dev/null
+++ b/source/_posts/2024-02-07-release-20242.markdown
@@ -0,0 +1,1307 @@
+---
+layout: post
+title: "2024.2: More voice, more icons, more integrations, more... everything!"
+description: "Improved drag 'n drop in automations, proximity, custom Assist responses, export your data, ZHA firmware updates, Matter diagnostics and actions, icons everywhere, and more!"
+date: 2024-02-07 00:00:00
+date_formatted: "February 7, 2024"
+author: Franck Nijhof
+author_twitter: frenck
+comments: true
+categories:
+ - Release-Notes
+ - Core
+og_image: /images/blog/2024-02/social.png
+---
+
+
+
+## Export data from the history dashboard
+
+The following feature might be small, but it is a big deal for many. Home
+Assistant stores your data privately and locally; it is **your data**. To make
+this data more accessible, we've added a new feature to the history dashboard.
+
+You can now download the data you are viewing in the history dashboard. This
+allows you to further analyze the data in, for example, Excel or to visualize
+it in other ways.
+
+The button will export and download the data you currently view in the history
+dashboard as a [CSV file](https://en.wikipedia.org/wiki/Comma-separated_values).
+
+
+
+Thanks for this one [@balloob]!
+
+[@balloob]: https://github.com/balloob
+
+## Improved error responses when using Assist
+
+If you use [Assist](/voice_control/), our private voice assistant, you may have
+noticed that its responses were not meaningful when something was not understood.
+
+Some of the errors encountered while using Assist can easily be fixed on your
+side by adding aliases to entities or areas, exposing entities to Assist,
+or assigning entities and devices to the correct areas.
+
+So we are taking the first step to help you fix these errors: as of this release,
+Assist provides much better errors in case your intention is understood,
+but something else is missing (An unknown name, area, device class, or domain).
+
+
+
+## Custom Assist responses in automations using the sentence trigger
+
+Like almost every other component and feature of Home Assistant, Assist can be
+customized and extended to understand more sentences.
+
+A few releases ago, we introduced a very simple way to extend what Assist
+understands: The [sentence trigger](/docs/automation/trigger/#sentence-trigger)
+in our automation engine.
+
+Up until now, using a sentence trigger always led to the same Assist response:
+“Done”. In fact, the only way to define a custom response was to write complex
+custom sentences in YAML.
+
+This release introduces a new action to set a custom response in your
+sentence-triggered automations directly inside the automation editor.
+
+
+
+The response field accepts templates, so it can be used to build complex
+responses, for example, listing all your room temperatures.
+
+
+
+A very cool feature that might come in handy if you build an automation
+blueprint to submit as an entry for our [voice assistant contest](/blog/2024/01/voice-assistant-contest/)!
+
+## All known Assist devices
+
+Last addition for voice, we've added a small additional page to give you an
+overview of all the Assist devices you have active in your Home. You can find
+this on the {% my voice_assistants title="Assist configuration dashboard" %}
+by selecting the new "Assist devices" button.
+
+
+
+Or, use this My Home Assistant button below to navigate to the voice assistants
+configuration dashboard:
+
+{% my voice_assistants badge %}
+
+## Updating your Zigbee devices
+
+[ZHA](/integrations/zha) (Zigbee Home Automation, our built-in Zigbee integration)
+now provides update entities to Home Assistant!
+
+This means you can get notified when a device has a firmware update available,
+and you can trigger the update from Home Assistant!
+
+
+
+Noticed the weird version numbers? Unfortunately, that is how version numbers
+in the Zigbee standard work and look. We haven't figured out a way to translate
+them to something more human-readable format that matches what the manufacturer
+communicates.
+
+Currently, it supports updating Inovelli, OSRAM/Ledvance, Sonoff, and
+ThirdReality devices, and we are looking at adding support for more brands
+in the future. Be aware, Zigbee is a slow protocol, and firmware updates can
+take a long time (sometimes hours).
+
+## Matter diagnostics and actions
+
+Home Assistant works actively to provide the best support for [Matter](/integrations/matter)
+devices out of the box. To help with that, we have added more information and
+controls for your Matter devices in the UI.
+
+On the device page of the Matter device in Home Assistant, we will now show
+additional diagnostic information about the device. This information can be
+used to troubleshoot issues with the device or when reporting issues. Some
+examples include the network type the device uses, its addresses, and IDs,
+device types and its connected [fabrics](/integrations/matter#multi-fabric-join-to-multiple-controllers).
+
+
+
+Besides more information, you can also take new actions on the device.
+For example, ping the device to check if it is available, force a full
+device interview to sync all its information, remove it from another controller,
+and even a new button to share your Matter device from Home Assistant with
+another Matter controller.
+
+
+
+## Icons everywhere
+
+We completely changed how Home Assistant handles icons under the hood.
+A big effort from many people, with almost... no change! That is
+right, _almost_ everything looks just the same as before. 😁
+
+We did make some improvements! For example, integrations can now
+provide icons for things like fan speeds or thermostat presets. Also,
+service call actions can now have their own icon as well:
+
+
+
+Areas now have icons too! You can set them in the area configuration. They show
+up in the area selectors and in the area dashboard itself
+(in case you didn't upload a picture).
+
+
+
+## Integrations with authentication issues are now shown in the repairs dashboards
+
+When one of your integrations has authentication issues, Home Assistant
+will now report this in the {% my repairs title="repairs dashboard" %}.
+
+Previously, this was only visible on the integration dashboard, but now it shows
+up in the repairs dashboard, as this is the place where Home Assistant reports
+all issues with your system.
+
+
+
+## Revamped Proximity integration
+
+For this release, [@mib1185] completely revamped our [Proximity] integration.
+In case you are unfamiliar with it, it allows you to monitor the proximity of
+persons to a particular [zone]. It provides information on how close one is
+to a zone and if they are traveling towards or away from it.
+
+It is an extremely powerful tool for automations. It allows you to create
+automations based on the proximity of people. For example, if you are within
+a certain range from your home and traveling towards it, you could use
+Home Assistant to turn on the lights, open the garage door, turn up the heating,
+and start your favorite playlist in the living room. Welcome home! 🤗
+
+The best part? This integration is now available to set up from the UI!
+Not just that, but it now uses normal sensor entities that we are all already
+familiar with. This will make automating and displaying the data a breeze!
+
+
+
+Thanks [@mib1185]! You did an outstanding job on this one!
+
+If you are already using this integration, this change will come with the
+deprecation of the old entities. See our [backwards-incompatible changes](#backwards-incompatible-changes)
+for more information.
+
+[@mib1185]: https://github.com/mib1185
+[Proximity]: /integrations/proximity
+[zone]: /integrations/zone
+
+## Shipping on a new Python version
+
+This release ships running on Python 3.12! In case you are wondering, what is
+that? Well, Python is the programming language Home Assistant is written in.
+
+Why it matters? It provides many improvements to the foundation we are building
+Home Assistant on, most notably: It is faster! 🚀
+
+Don't worry! If you run the Home Assistant Operating System or are using the
+Home Assistant Container installation type: You won’t have to do anything, as we
+handle the upgrade to Python 3.12 for you. Just upgrade Home Assistant as
+you normally would, and you are good to go! 😎
+
+## Other noteworthy changes
+
+There are many more improvements in this release; here are some of the other
+noteworthy changes this release:
+
+- [@edenhaus] improved how we handle errors in our form fields. We no longer
+ show the technical coding gibberish that often showed up in the past. Nice!
+- When you [change the type of a switch entity] to, for example, a garage door
+ entity, you will now have the option to invert its behavior.
+ Thanks, [@emontnemery]!
+- The [Ecovacs] integration received lots of love from [@edenhaus] and now
+ has support for many Deebot vacuum models with tons of entities to automate
+ with. Nice job!
+- [@mib1185] added automatic cleanups of old/unused refresh tokens 🧹. This
+ means you will be logged out on a device that hasn't used Home Assistant for
+ 90 days. Clean and tidy!
+- The [Tuya] integration can now be set up directly using the Tuya Smart
+ or Smart Life app. No more need for developer accounts or complicated
+ procedures!
+- Using the [utility meter] integration on, for example, your solar inverter,
+ which turns off at night? You can now set the sensor to always be available,
+ even when the source entity is unavailable. Thanks, [@dougiteixeira]!
+- The [TP-Link Smart Home] integration now supports newer devices,
+ including [Tapo-branded] devices! Awesome job [@sdb9696], [@bdraco],
+ and [@rytilahti]!
+- [@AngellusMortis] added new sound event sensors introduced in
+ UniFi Protect version 2.11 to the [UniFi Protect] integration. Nice!
+- Are you a Jinja templating Ninja? [@TNTLarsn] added a new `bitwise_xor`
+ filter for you to use. Awesome!
+- The [Google Generative AI Conversation] allows using the [new Gemini Pro models](https://blog.google/products/bard/google-bard-gemini-pro-image-generation/),
+ including support for the Vision models. This allows you to use images in your
+ prompts too! See an example in the screenshot down below. Super impressive,
+ thanks [@tronikos]!
+
+
+The Google Generative AI Conversation integration using the new Gemini Pro Vision models to describe what is seen on the doorbell camera.
+
+
+ The three basic view layouts: Panel, Sidebar, and Masonry
+
+ Masonry does not care about where exactly cards are placed when the screen size changes.
+
+ Case studies of our users' dashboards
+
+ Example of a dashboard section
+
+ The Create New View configuration screen
+
+ A new dashboard view laid out in Sections
+
+
+* To edit the name of a section, select the 
Add Card by Card type dialog
+ 
Card suggestions
+ 
Add to Dashboard feature on the device page
+
+ Sections view adapt nicely to different screen sizes.
+
+ Examples of grid systems in use
+
+ The Home Assistant dashboard grid system
+
+ Cards currently optimized for the grid system: Sensor card, Tile card, and Button card
+
+ Comparison of four card arrangement methods
+
+
+For example, in the above picture, it is very easy to see that the dishwasher
+was responsible for the morning spike and the oven for the spike in the evening.
+
+[@karwosts]: https://github.com/karwosts
+
+## New sentences for Assist
+
+[Assist](/voice_control/), our private voice assistant, learned a few tricks this month.
+
+Support for valves has been added. You can now ask Assist to adjust the position
+of a valve, or just open or close a valve completely.
+
+Also, cover support has been extended to support the control of the position of
+your devices. Currently, most languages only support a single use-case as a
+starting point. Setting the position of a single device by targeting its
+name:
+
+> Set the curtain position to 80%
+
+We are working on extending the use-case coverage to set the position
+of multiple devices or complete areas, similar to what is possible with
+the open and close sentences.
+
+
+
+The next new trick could be considered a bug fix: Until today it was not
+possible to start or stop a vacuum cleaner by voice; Now it can! Assist knows
+how to start a vacuum and return it to its base. Here are some example
+sentences, in case you have a vacuum cleaner named Dusty:
+
+> Start Dusty
+
+> Return Dusty to base
+
+The biggest set of changes is for media players. Assist can now pause playback,
+resume playback, skip to the next media, and set the volume of media players!
+
+Be aware that currently, these sentences are limited to targeting a single
+device by its name, for example:
+
+> Skip to the next song on the TV
+
+We are actively working on extending the logic of these new intents to allow
+you to target areas and only affect the desired media player(s).
+
+## Disabling the remote activation of the Home Assistant Remote UI
+
+If you are using [Home Assistant Cloud](https://nabucasa.com), you can access
+your Home Assistant instance remotely using the Remote UI feature.
+
+Suppose this feature is, for some reason, disabled, and you are currently not
+at home. In that case, you can enable the Remote UI feature remotely by
+logging into your [Nabu Casa account](https://account.nabucasa.com/) and
+request your Home Assistant instance to turn it on.
+
+Feedback from the community has shown that this feature is not always desired,
+and this release adds a new option to disable the remote activation of the
+Remote UI feature. Once disabled, the Remote UI feature can only be enabled
+locally from your Home Assistant instance.
+
+
+
+## Translating states in your templates
+
+Are you using {% term templates %} to send notifications in automations? If so,
+[@PiotrMachowski] might just have added something new you need!
+
+A new template method, `state_translated`, to translate entity states directly
+from your templates! Consider this template example:
+
+{% raw %}
+```yaml
+# Untranslated
+{{ states("binary_sensor.movement_backyard") }} # Shows: on
+{{ states("sun.sun") }} # Shows: below_horizon
+```
+{% endraw %}
+
+The above example shows the raw state of two entities. However, with the
+new `state_translated` method, you can get the state in a human-readable form:
+
+{% raw %}
+```yaml
+# Translated
+{{ state_translated("binary_sensor.movement_backyard") }} # Shows: Detected
+{{ state_translated("sun.sun") }} # Shows: Below horizon
+```
+{% endraw %}
+
+Even better, it uses the default language of your Home Assistant instance. So,
+if you use Home Assistant in a different language, the translated state will
+be in that language.
+
+[@PiotrMachowski]: https://github.com/PiotrMachowski
+
+## Home Assistant boots twice as fast
+
+In case you didn't know, every release [@bdraco] improves the performance
+on some aspect of Home Assistant. He has been on it for a long time and keeps
+pushing to improve it.
+
+As a matter of fact, it has become so regular that we don't always highlight
+his enormous efforts toward this goal in our release notes. _Sorry! 🙏_
+
+However, in this release, his efforts are so noticeable that we wanted to
+call it out: **Home Assistant now boots on average twice as fast!** 🚀
+
+That is a huge improvement [@bdraco]!! Thank you for your continuous work on
+making Home Assistant faster and faster! ❤️
+
+[@bdraco]: https://github.com/bdraco
+
+## Other noteworthy changes
+
+There are many more improvements in this release; here are some of the other
+noteworthy changes this release:
+
+- The [climate entity] now has a toggle service (`climate.toggle`).
+ Thanks [@arturpragacz]!
+- [Matter] lights now support transitions, nice! Thanks, [@marcelveldt]!
+- We heard you like downloading CSVs! So, we added the ability to download
+ the energy dashboard data to a CSV file now as well! Thanks [@karwosts]!
+- After feedback and reports on the automatic Zigbee device firmware updates
+ introduced in a previous release, this release brings a stricter and
+ more robust update system to [ZHA]. Thanks [@dmulcahey] & [@puddly]!
+- The [Tessie] integration now provides charging and range sensors.
+ Thanks [@Bre77]!
+- [myUplink] devices can now be updated directly from Home Assistant.
+ Awesome [@astrandb]!
+- [DuneHD] media players now support browsing media files and playing them.
+ Thanks [@iliessens]!
+- The [Bring!] now brings in a new "recently" list. Nice [@miaucl]!
+- [@lellky] added setpoints as number entities for fans to the
+ [Flexit Nordic (BACnet)] integration, thanks!
+- The dialog to adjust long-term statistics now has automated outlier detection!
+ That is a very smart and helpful addition. Thanks [@karwosts]!
+
+[@arturpragacz]: https://github.com/arturpragacz
+[@astrandb]: https://github.com/astrandb
+[@Bre77]: https://github.com/Bre77
+[@dmulcahey]: https://github.com/dmulcahey
+[@iliessens]: https://github.com/iliessens
+[@karwosts]: https://github.com/karwosts
+[@lellky]: https://github.com/lellky
+[@marcelveldt]: https://github.com/marcelveldt
+[@miaucl]: https://github.com/miaucl
+[@puddly]: https:///github.com/puddly
+[Bring!]: /integrations/bring
+[climate entity]: /integrations/climate
+[DuneHD]: /integrations/dunehd
+[Flexit Nordic (BACnet)]: /integrations/flexit_bacnet
+[Matter]: /integrations/matter
+[myUplink]: /integrations/myuplink
+[Tessie]: /integrations/tessie
+[ZHA]: /integrations/zha
+
+## New integrations
+
+We welcome the following new integrations in this release:
+
+- **[Aprilaire]**, added by [@chamberlain2007]
+ The new toolbar that is now on every table in Home Assistant.
+
+
+We also introduced multiple new filter types for each table. For example,
+{% term automations %} can now be filtered not only by {% term areas %},
+{% term entities %} , or {% term devices %}, but also by used
+{% term blueprints %}, labels, and categories (more on these later!).
+
+We didn’t stop at just that page! The devices and entities pages now also have
+a way to filter not only by state but also by integrations and areas. Almost all
+tables now have useful new filters to help you find what you are looking for.
+
+### Item grouping
+
+Browsing a list of hundreds of {% term automations %} or thousands of
+{% term entities %} can be overwhelming. While filters can help narrow the list,
+visually grouping the items into smaller chunks makes browsing easier.
+
+With the item grouping feature, we introduced a new dropdown menu to pick
+how you’d like the items on the table to be grouped. On the automations page,
+you can group automations by their {% term state %} - whether enabled
+or not - and custom categories (more on that later!). On the {% term devices %}
+page, you can even group them by manufacturers, {% term areas %},
+or {% term integrations %}, which is really cool because it makes the page much
+easier to browse. It gives you a new perspective on organizing your vast
+network of devices.
+
+
+
+### Selection mode and batch actions
+
+We removed the clutter of displaying a column of checkboxes by introducing
+a new selection mode. When it is toggled on, checkboxes will appear, and you
+can apply actions to all your selections with one click on the toolbar.
+
+
+ This button enables selection mode in the new tables.
+
+
+## Three new ways to organize
+
+Upon reading through and ideating on the feature request thread on
+[“Automation Grouping”](https://community.home-assistant.io/t/grouping-automations-on-frontend-for-organization/102771),
+we realized that organization can be done in multiple ways for different purposes.
+
+We learned that users who are proficient in making {% term automations %} have
+hundreds of them, which makes locating a particular automation hard. They often
+had to resort to using "hacks" such as emojis, bracketed “tags”, or numbering
+each automation to get the sort order they wanted. They needed a way to easily
+filter down and break down the giant list into more manageable chunks.
+
+We also noticed that users are stretching our areas feature beyond its
+intended purpose. For example, some users would create “{% term areas %}” such
+as “3D printer”, “Christmas decorations”, or even “Left side of my office desk”,
+to group different {% term devices %} and {% term entities %} together under
+one umbrella for dashboards or {% term automations %}.
+
+As we are developing our new dashboards and voice commands, this poses a
+big problem: We would be unable to provide specialized solutions if a dashboard
+{% term blueprint %} or automation blueprint cannot confidently assume the context of
+how it would be used. We need something more specialized.
+
+Therefore, to balance the basic goal of providing a more digestible UI for
+all users, the need for flexibility for our power users, and the future vision
+of Home Assistant, we are introducing 3 new organization structures to
+Home Assistant:
+
+**[Floors](#floors-help-home-assistant-understand-your-house)**,
+**[Labels](#labels-tag-everything-any-way-you-want)**,
+and **[Categories](#categories-make-each-settings-page-easier-to-browse)**
+
+### Floors: Help Home Assistant understand your house
+
+Let's talk about the new organizational structures, starting with **floors**.
+
+To become a truly intelligent home automation platform, Home Assistant needs
+to understand the context: Where exactly is a {% term device%}? How does one
+{%term area %} relate to another? What is the space used for?
+
+Currently, Home Assistant has {% term areas %}. Areas specify the physical
+location or vicinity of your devices per living space in your home
+(like the living room or kitchen). However, some users living in standalone
+houses might have multiple floors with their own areas.
+
+{% term Floors %} are a new way to organize your areas per level of floors in
+your home. The better Home Assistant knows your home and how it is spatially
+structured, the better it can help you. Especially when it comes to future
+features like generating dashboards, voice commands, and maybe even
+AI-related features.
+
+
+
+You can use floors in your {% term automations %} and {% term scripts %} as a
+target for your actions or control them with your voice. For example, you can
+turn off all the lights on the downstairs floor when you go to bed or ask
+[Assist](/voice_control/) to turn on the lights upstairs.
+
+For our power users, you can even use [floors in your templates](/docs/configuration/templating/#floors)
+to create the most advanced and creative automations.
+
+{% my areas badge %}
+
+### Labels: Tag everything any way you want
+
+{% term Floors %} and {% term areas %} are great for representing your actual
+home, but as everyone has their own ways of organizing their home, everyone
+has their own ways of organizing their Home Assistant, too!
+This is where **labels** 🏷️ come in!
+
+Labels is an organizational structure that is completely up to you. You can
+make as many labels with any naming structure, in any color 🌈 you want, and
+assign them to basically anything in Home Assistant. You assign labels to
+anything: {% term areas %}, {% term devices %}, {% term entities %},
+{% term automations %}, {% term scripts %}, helpers, you name it!
+You can even assign multiple labels to the same thing.
+
+
+
+Just like with floors, you can use labels in your automations and scripts as
+a target for your {% term actions %}. This gives you a lot of flexibility,
+not just in organizing your Home Assistant, but also in automating your home! 🤯
+
+For example, you could create a label "🎄 Christmas" to label all your
+Christmas decorations during the holiday season. You can then use this label to
+automate all of those decorations at once or to filter them in the new tables.
+
+More examples? You could create a label "🔒 Security" to label and control all
+your security-related devices and automations. Or, "🛌 Bedrooms" to label all
+your bedroom areas and simultaneously control all the devices in those areas.
+
+Do you have solar panels or home batteries? Create a label "⚡️ Heavy energy usage"
+to label devices that consume a lot of energy. You could switch them off when
+there is not enough battery or solar energy available.
+
+You decide how to use labels, and the possibilities are endless! And for our
+power users, you guessed it, you can use [labels in your templates](/docs/configuration/templating/#labels).
+
+{% my labels badge %}
+
+### Categories: Make each settings page easier to browse
+
+Last but not least, we are introducing **categories**. Categories are designed
+to be paired with the aforementioned [item grouping feature](#item-grouping),
+and it can be used to group things visually specific to a certain table
+in Home Assistant.
+
+This is great for those who have a particular way of displaying their
+{% term entities %} by separating them into multiple sections on a specific page.
+For example, on the {% term automations %} page, you can create categories only
+used for visually grouping automations but nowhere else, like "Notifications"
+or “NFC tags”. You can then view your automations grouped or filtered by
+those categories.
+
+
+
+As these categories are unique for each dashboard, you can have different
+sets of categories depending on the place you are organizing. This means
+you can have different categories on the automations page than the
+{% term scene %}, {% term scripts %}, or helpers settings page.
+
+### Time to clean up your Home Assistant!
+
+In summary, there are a total of 4 taxonomies for organizing your entities.
+It sounds like a lot, but they all serve a distinct purpose. We are extending
+and clarifying {% term areas %} with {% term floors %}, and we are introducing
+{% term labels %} and {% term categories %} to make your {% term automations %}
+and many other tables look more organized and be more manageable.
+
+What’s next? Time to dig in! Here are a few steps we recommend you take
+action on to organize your Home Assistant better:
+
+- **Migrate to labels**:
+ - If you have been grouping automations with emojis and bracketed text,
+ you can now create labels for each. Labels can have icons to replace the
+ emojis you had before.
+ - For areas that aren’t really physical spaces, switching them to labels will
+ provide you more flexibility in organizing your entities.
+- **Start using categories**:
+ If you have a favorite way of organizing a particular page, create those
+ categories and group the table by them. For example, you could create a
+ notification category for all your notification automations and put all
+ notification automations in that category.
+- **Group your areas into floors**:
+ If you live in a multi-story home, grouping areas into floors help with
+ organizing the areas as well as making them more compatible with future
+ features.
+
+Last of all, to help us to help you to perfect the design of these new features,
+we would love to hear your feedback and see how you use them! Please feel free
+to share them in the comments below and discuss them in our community.
+
+## Map dashboard
+
+Introducing a new dashboard this release: The **map**! 🗺️
+
+You might think, "Hey, we already have a map dashboard in Home Assistant!"
+and you are right! However, the map was an integration that was always there
+and didn't provide the flexibility and features that were wanted.
+
+With the map dashboard's introduction, you can now add multiple map dashboards
+with different entities and configuration settings. For example, create a
+dashboard to show the location of your family members, another to track your
+car, and another to show the location of your pets. 🐶
+
+
+
+On upgrade, Home Assistant will automatically migrate your existing map
+integration to a map dashboard.
+
+You don't like having the map in your sidebar? Well, that is no longer a
+problem. Since it is now a dashboard it means you can remove it in the dashboard
+settings.
+
+## Webpage dashboard
+
+Another new dashboard for this release is the **webpage**! 🌐
+
+The webpage dashboard allows you to add and embed a webpage to your dashboard.
+This could be a web page from the internet or a local web page from a local
+machine or device like your router or NAS.
+
+
+
+This dashboard replaces the old iFrame panel (`iframe_panel`). If you have
+existing panels configured in your YAML configuration, Home Assistant will
+automatically migrate them to the new webpage dashboard on upgrade.
+
+
+
+Note that not every webpage can be embedded due to security restrictions that
+some sites or pages have in place, enforced by your browser, that prevent
+embedding them into a Home Assistant dashboard.
+
+## Define the columns in the section view
+
+In the last release, we [introduced the section view](/blog/2024/03/06/release-20243/#a-new-experimental-sections-view)
+with drag and drop support. We are absolutely thrilled to see how many of you
+loved it! 🥰
+
+Many thanks for all the feedback and suggestions! We are prioritizing them and
+are working on making the section view even better in the upcoming releases.
+
+In this release, based on your feedback, we have added the ability for you to
+define the maximum number of columns that the section view uses. This allows you
+to limit the number of columns, regardless of the screen width on which you
+are viewing your dashboard.
+
+
+
+## Adding Matter devices from other controllers
+
+In the [February release](/blog/2024/02/07/release-20242/#matter-diagnostics-and-actions),
+we added support for sharing Matter devices tied to Home Assistant with other
+Matter controllers. This release, we are making the other way around easier.
+
+We have improved how you can add Matter devices from other controllers to
+Home Assistant. When you add a Matter device to Home Assistant, it will now
+ask you if you want to add a new Matter device or if you want to add a device
+that is already added to another controller (like Google Home or Apple Home).
+
+
+
+Suppose you choose to add a device that has already been added to another
+controller. In that case, Home Assistant will guide you through how to
+achieve this step by step.
+
+
+
+## Lock behavior improvements
+
+Some smart locks have an open (or unlatching) mechanism that can be triggered
+remotely. The door either pops out of the lock or can be opened by pushing
+against the door.
+
+We want to ensure you don't accidentally open the door when you miss-clicked
+the button (for example, while not at home 😬). Therefore, we have improved
+the behavior of locks in our user interface by requiring you to confirm the
+action.
+
+
+
+## Even more performance!
+
+Remember how we wrote last release that [Home Assistant now boots twice as fast](/blog/2024/03/06/release-20243/#home-assistant-boots-twice-as-fast)?
+Well, [@bdraco] wasn't done yet and teamed up with [@balloob]. If you thought
+the previous release was fast, you are in for a treat! 🚀 The difference is,
+yet again, very noticeable.
+
+Besides streamlining what is loaded at startup (and doing less loading), we
+have adjusted the startup time tracking. It used to be that one integration
+could push other integrations to be slow too; that should no longer be the case,
+making this a more accurate representation of the actual startup time.
+
+Want to learn about the individual startup times of your integrations? You can
+find them in the {% my repairs title="**Settings** -> **System** -> **Repairs**" %}
+page by selecting the three-dotted menu in the top right and selecting the
+**Integration startup time** item.
+
+{% my repairs badge %}
+
+[@bdraco]: https://github.com/bdraco
+[@balloob]: https://github.com/balloob
+
+## Other noteworthy changes
+
+There are many more improvements in this release; here are some of the other
+noteworthy changes this release:
+
+- [@karwosts] has improved your Home Assistant {% my profile title="user profile" %}
+ page, making navigating and finding the settings you are looking for easier.
+ Nice work!
+- If you use a [sentence trigger] in your automation to trigger it using
+ [Assist]. The trigger will now include the `device_id` in its trigger data
+ you can automate with. Thanks, [@synesthesiam]!
+- The [HomeWizard Energy] integration now supports the newest generation of
+ HomeWizard Energy Sockets! Thanks, [@DCSBL]!
+- We can now ship new releases of Home Assistant in waaay less time.
+ Building and shipping Home Assistant for you, went down from 1.5-2 hours to
+ just 20 minutes! 🚀 Thanks [@edenhaus]!
+ [Learn more about it in our developer blog](https://developers.home-assistant.io/blog/2024/04/03/build-images-with-uv/).
+- [Reolink] now supports PTZ patrol start/stop, package detection and controls
+ for playing quick reply messages. Thanks, [@starkillerOG]!
+- We have brand new template functions available to list [all the issues] in
+ your repairs dashboard. Thanks, [@RoboMagus]!
+- If you prefer your wind speed sensors to be in Beaufort, you are in luck!
+ You can now change the unit of measurement to Beaufort. Thanks, [@fwestenberg]!
+- The [Husqvarna Automower] integration development continues and has additional
+ new entities, including sensors, select entities, and a device tracker.
+ Thanks, [@Thomas55555]!
+- [@catsmanac] has added a sensor to monitor the battery storage attached
+ to your [Enphase Envoy]; it works with the energy dashboard! Nice!
+- The [Xiaomi BLE] integration now supports locks and fingerprint readers!
+ Awesome, [@Ernst79]!
+
+[@catsmanac]: https://github.com/catsmanac
+[@DCSBL]: https://github.com/DCSBL
+[@edenhaus]: https://github.com/edenhaus
+[@Ernst79]: https://github.com/Ernst79
+[@fwestenberg]: https://github.com/fwestenberg
+[@karwosts]: https://github.com/karwosts
+[@RoboMagus]: https://github.com/RoboMagus
+[@starkillerOG]: https://github.com/starkillerOG
+[@synesthesiam]: https://github.com/synesthesiam
+[@Thomas55555]: https://github.com/Thomas55555
+[all the issues]: /docs/configuration/templating/#issues
+[Assist]: /voice_control/
+[Enphase Envoy]: /integrations/enphase_envoy
+[HomeWizard Energy]: /integrations/homewizard
+[Husqvarna Automower]: /integrations/husqvarna_automower
+[Reolink]: /integrations/reolink
+[sentence trigger]: /docs/automation/trigger/#sentence-trigger
+[Xiaomi BLE]: /integrations/xiaomi_ble
+
+## New integrations
+
+We welcome the following new integrations in this release:
+
+- **[Fyta]**, added by [@dontinelli]
+ Each item group can now be collapsed and expanded.
+
+
+Last but certainly not least, we’ve added the ability to group and filter
+entities by their domain in the entities panel. As the domains represent the
+type of entity, this means you can group and filter, for example, all your
+lights, switches, sensors, etc.
+
+
+
+## Create helpers directly from the automation editor
+
+Our good friend [@karwosts] has been busy creating a great quality-of-life
+improvement for our {% term automation %} editor for this release.
+
+I'm sure you'll know this feeling. You are creating an automation and think:
+"Hey, I need a helper for this!" But then you have to leave the automation
+editor, create the helper, and then go back to the automation editor.
+
+Well, not anymore! You can now create helpers directly from the automation
+editor 😎
+
+In this example, a timer helper is created directly from the automation editor
+without leaving it:
+
+
+
+[@marcgeurts]: https://github.com/marcgeurts
+
+## Reorder features of the tile card
+
+Some features of the tile card, such as the presets or the HVAC modes of a
+thermostat, can show many buttons. While you can limit the buttons you’d
+like to see, they may not be in the desired order.
+
+To improve this, [@karwosts] and [@piitaya] have added the ability to reorder
+the features of the tile card. For your thermostat, that means you can now
+reorder the HVAC modes or presets to your liking.
+
+
+ You can now reorder the features of the tile card.
+
+
+You can adjust the name of each monitored device in the energy dashboard setting
+page by going to **Settings** > **Dashboards** > **Energy** > **Individual devices**.
+
+{% my config_energy badge %}
+
+[@karwosts]: https://github.com/karwosts
+
+## Improved audio with ESPHome for Assist
+
+If you're familiar with [Assist], our private voice assistant, and are using
+it on an [ESPHome-based device] (like an [ESP-S3-BOX-3] or the [ATOM Echo]),
+chances are you have experienced one of the biggest barriers to date when it
+comes to using it on a daily basis: chopped-off audio. 😞
+
+More often than not, the responses sent to the voice assistant device were
+missing a few parts, most notably at the beginning and the end of the audio.
+This was very noticeable when the responses were short, such as asking how many
+lights are on in a home or the room temperature.
+
+In conjunction with [the latest release of ESPHome] (2024.4), we are bringing
+a much improved and more reliable communication between [ESPHome] and
+Home Assistant for transferring voice audio, guaranteeing no audio is lost in the process.
+
+Hear the difference in this side-by-side comparison:
+
+
+ Badges at the top of a panel.
+
+Screenshot of tile cards with features.
+
+Screenshot of an entities card with a picture header and buttons footer.
+
+Screenshot of the Dashboard list.
+
+ Screenshot of the tile card with the fan preset modes feature
+
+ Screenshot of the tile card with the lock commands feature
+
+ Screenshot of the tile card with the lock open door feature
+
+ Screenshot of the tile card with update actions feature
+
+Screencast showing how to edit a dashboard and customize a vertical stack card.
+
+ A lights view tab on the Overview dashboard
+
- Use titles and icons to describe the content of views.
+
+ The three basic view layouts: panel, sidebar, and masonry
+Screenshot of a new Overview dashboard with Bluetooth devices.
+
Install Home Assistant on Raspberry Pi
@@ -8,7 +27,7 @@ Assist allows you to control Home Assistant using natural language. It is built
Assist is available to use on most platforms that can interface with Home Assistant. Look for the Assist icon 
:
-
+ The ESP32-S3-BOX-3 states: loading, idle, listening, thinking, replying, error.
+
+