diff --git a/Gemfile b/Gemfile
index 4d43955bb8d..ba7ea78a3c3 100644
--- a/Gemfile
+++ b/Gemfile
@@ -10,8 +10,8 @@ group :development do
gem 'stringex', '2.8.6'
# > 2.1.0 causes slowdowns https://github.com/sass/sassc-ruby/issues/189
gem 'sassc', '2.1.0'
- gem 'rubocop', '1.65.0'
- gem 'ruby-lsp', '0.17.10'
+ gem 'rubocop', '1.65.1'
+ gem 'ruby-lsp', '0.17.11'
gem 'rackup', '2.1.0'
end
diff --git a/Gemfile.lock b/Gemfile.lock
index 6e9efc9d936..49283e54f27 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -28,7 +28,7 @@ GEM
eventmachine (1.2.7)
ffi (1.17.0-x86_64-linux-gnu)
forwardable-extended (2.6.0)
- google-protobuf (4.27.2-x86_64-linux)
+ google-protobuf (4.27.3-x86_64-linux)
bigdecimal
rake (>= 13)
http_parser.rb (0.8.0)
@@ -75,7 +75,7 @@ GEM
logger (1.6.0)
mercenary (0.4.0)
multi_json (1.15.0)
- mustermann (3.0.0)
+ mustermann (3.0.1)
ruby2_keywords (~> 0.0.1)
nokogiri (1.16.7-x86_64-linux)
racc (~> 1.4)
@@ -105,10 +105,10 @@ GEM
rbs (3.5.2)
logger
regexp_parser (2.9.2)
- rexml (3.3.2)
+ rexml (3.3.4)
strscan
rouge (4.3.0)
- rubocop (1.65.0)
+ rubocop (1.65.1)
json (~> 2.3)
language_server-protocol (>= 3.17.0)
parallel (~> 1.10)
@@ -119,9 +119,9 @@ GEM
rubocop-ast (>= 1.31.1, < 2.0)
ruby-progressbar (~> 1.7)
unicode-display_width (>= 2.4.0, < 3.0)
- rubocop-ast (1.31.3)
+ rubocop-ast (1.32.0)
parser (>= 3.3.1.0)
- ruby-lsp (0.17.10)
+ ruby-lsp (0.17.11)
language_server-protocol (~> 3.17.0)
prism (>= 0.29.0, < 0.31)
rbs (>= 3, < 4)
@@ -142,7 +142,7 @@ GEM
rack-protection (= 4.0.0)
rack-session (>= 2.0.0, < 3)
tilt (~> 2.0)
- sorbet-runtime (0.5.11501)
+ sorbet-runtime (0.5.11511)
stringex (2.8.6)
strscan (3.1.0)
terminal-table (3.0.2)
@@ -168,8 +168,8 @@ DEPENDENCIES
nokogiri (= 1.16.7)
rackup (= 2.1.0)
rake (= 13.2.1)
- rubocop (= 1.65.0)
- ruby-lsp (= 0.17.10)
+ rubocop (= 1.65.1)
+ ruby-lsp (= 0.17.11)
sass-globbing (= 1.1.5)
sassc (= 2.1.0)
sinatra (= 4.0.0)
diff --git a/source/_dashboards/sections.markdown b/source/_dashboards/sections.markdown
index 20ec4612f8f..a96f998d849 100644
--- a/source/_dashboards/sections.markdown
+++ b/source/_dashboards/sections.markdown
@@ -64,7 +64,7 @@ Once you have created a sections view, you can populate it with sections and car
## Deleting a section
-1. To delete a section, go to the dashboard and in the top right corner, select the pencil icon.
+1. To delete a section, go to the dashboard and in the top right corner, select the edit {% icon "mdi:edit" %} button.
2. Open the view with the section you want to delete.
3. Select the delete {% icon "mdi:trash" %} button.
@@ -72,7 +72,7 @@ Once you have created a sections view, you can populate it with sections and car
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.
+1. To edit your dashboard, in the top right corner, select the edit {% icon "mdi:edit" %} button.
2. To rearrange sections, hold the move {% icon "mdi:cursor-move" %} button and move the card.
diff --git a/source/_docs/authentication.markdown b/source/_docs/authentication.markdown
index 871cef34bc0..8a83d5cc374 100644
--- a/source/_docs/authentication.markdown
+++ b/source/_docs/authentication.markdown
@@ -51,6 +51,10 @@ _Make sure to choose a secure password!_ At some time in the future, you will pr
As an extra level of security, you can turn on [multi-factor authentication](/docs/authentication/multi-factor-auth/).
+## Adding a person to Home Assistant
+
+If you have administrator rights, you can [add a person to Home Assistant](/integrations/person/#adding-a-person-to-home-assistant) and create them a user account.
+
## Changing display or user name
To learn how to change a display or user name, refer to [setting up basic information](/docs/configuration/basic/).
diff --git a/source/_docs/organizing/areas.markdown b/source/_docs/organizing/areas.markdown
index 6b6a0f2f3e1..93eebe78323 100644
--- a/source/_docs/organizing/areas.markdown
+++ b/source/_docs/organizing/areas.markdown
@@ -44,7 +44,7 @@ Follow these steps to create a new area from the **Areas** view.
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.
+2. On the area card, select the edit {% icon "mdi:edit" %} button.
3. In the dialog, select the floor and add labels, if you like.
## Assigning an area to multiple items
@@ -64,7 +64,7 @@ You can assign an area to multiple items at once in the automation, scene, scrip
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.
+1. Go to {% my areas title="**Settings** > **Areas, labels & zones**" %} and on the area card, select the edit {% icon "mdi:edit" %} button.
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/)).
diff --git a/source/_docs/organizing/labels.markdown b/source/_docs/organizing/labels.markdown
index c15b32e64e7..ba46255f284 100644
--- a/source/_docs/organizing/labels.markdown
+++ b/source/_docs/organizing/labels.markdown
@@ -38,7 +38,7 @@ 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.
+ - On the area card, select the edit {% icon "mdi:edit" %} button.
- 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.
diff --git a/source/_docs/z-wave/controllers.markdown b/source/_docs/z-wave/controllers.markdown
index 62aee08978c..0ebaef12182 100644
--- a/source/_docs/z-wave/controllers.markdown
+++ b/source/_docs/z-wave/controllers.markdown
@@ -9,9 +9,29 @@ You need to have a compatible Z-Wave stick or module installed. The following de
{% warning %}
-Until recently, 700 series Z-Wave Controllers had a bug that could cause the mesh to be flooded on some networks and the controller to become unresponsive. At present, all 700 series controllers share the same firmware and are subject to this bug. It appears that this bug is largely, if not completely, resolved as of firmware version 7.17.2.
+The firmwares of 700 and 800 series Z-Wave controllers have several bugs which impact the stability of the mesh and can cause the controller to become unresponsive. Because there is no known firmware version that is completely fixed, it is recommended to choose a firmware based on the following criteria:
-Users should upgrade the firmware on all 700 series controllers to version 7.17.2 or greater. Firmware can be upgraded using the below directions:
+- 700 series:
+ - prefer SDK versions 7.17.2 to 7.18.x
+ - SDK versions 7.19.x are okay
+ - avoid SDK versions before 7.17.2
+ - avoid SDK versions 7.20 to 7.21.3
+
+- 800 series
+ - prefer SDK versions 7.22.x
+ - SDK versions 7.17.2 to 7.19.x are okay
+ - avoid SDK versions before 7.17.2
+ - avoid SDK versions 7.20 to 7.21.3
+
+{% note %}
+The SDK version does not have to match the firmware version. If you are unsure which SDK versions a firmware is based on, contact the manufacturer of your device.
+{% endnote %}
+
+{% important %}
+You should upgrade the firmware on all 700 and 800 series controllers to a recommended version.
+{% endimportant %}
+
+Firmware can be upgraded using the below directions:
- [Upgrade instructions using Linux](https://github.com/kpine/zwave-js-server-docker/wiki/700-series-Controller-Firmware-Updates-(Linux))
- [Upgrade instructions using Windows (Aeotec)](https://aeotec.freshdesk.com/support/solutions/articles/6000252296-update-z-stick-7-with-windows)
@@ -21,8 +41,9 @@ Users should upgrade the firmware on all 700 series controllers to version 7.17.
{% endwarning %}
- 800 series controllers (with some caveats, see notes)
- - Zooz 800 Series Z-Wave Long Range S2 Stick (ZST39 LR)
+ - Z-Wave.Me Z-Station
- HomeSeer SmartStick G8
+ - Zooz 800 Series Z-Wave Long Range S2 Stick (ZST39 LR)
- 700 series controllers
- Aeotec Z-Stick 7 USB stick (ZWA010) (the EU version is not recommended due to RF performance issues)
@@ -141,11 +162,11 @@ If you've installed the Z-Wave.Me Z-Way software. In order to use Z-Wave JS inst
This procedure has been tested with the following modules:
- - Aeotec Z-Pi 7 Raspberry Pi HAT/Shield
- - Z-Wave.Me RaZberry 7
- - Z-Wave.Me RaZberry 7 Pro
+- Aeotec Z-Pi 7 Raspberry Pi HAT/Shield
+- Z-Wave.Me RaZberry 7
+- Z-Wave.Me RaZberry 7 Pro
-1. Make sure the module is properly seated on the Home Assistant Yellow.
+1. Make sure the module is properly seated on the Home Assistant Yellow.
.
2. Carefully [close the case](https://yellow.home-assistant.io/guides/add-ssd-existing-installation/#reassembling-top-part) and power up Home Assistant Yellow.
3. Follow the procedure on [setting up a Z-Wave JS server](/integrations/zwave_js/#setting-up-a-z-wave-js-server).
diff --git a/source/_includes/common-tasks/data_disk.md b/source/_includes/common-tasks/data_disk.md
index b815b0d0205..ab6ddbcc311 100644
--- a/source/_includes/common-tasks/data_disk.md
+++ b/source/_includes/common-tasks/data_disk.md
@@ -64,7 +64,7 @@ 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.
+- You 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.
diff --git a/source/_includes/common-tasks/third-party-addons.md b/source/_includes/common-tasks/third-party-addons.md
index 827791fbfce..6dbb01599fa 100644
--- a/source/_includes/common-tasks/third-party-addons.md
+++ b/source/_includes/common-tasks/third-party-addons.md
@@ -1,25 +1,33 @@
-## Installing third-party add-ons
+## Installing a third-party add-on repository
-Home Assistant allows anyone to create add-on repositories to share their add-ons easily. To try this locally, you can use our example add-on repository at
+Home Assistant allows anyone to create an add-on repository to share their own add-ons with the community.
-```text
-https://github.com/home-assistant/hassio-addons-example
-```
-
-{% caution %}
+{% warning %}
Home Assistant cannot guarantee the quality or security of third-party add-ons. Use at your own risk.
-{% endcaution %}
+{% endwarning %}
-
-
-From {% my supervisor title="Settings > Add-ons" %} open the add-on store.
-
+To add an add-on repository, follow these steps:
-
-
-Add the URL of the repository and then press "Add". A new card for the repository will appear.
-
+1. Copy the URL of the repository.
+ - The URL is the git repository clone URL (on GitHub, use the Code button and copy the HTTPS URL).
+ - This documentation uses an example add-on repository. It is not practically useful but follows the same steps.
+ - If you are interested in add-on development, refer to our [add-on development documentation](https://developers.home-assistant.io/docs/add-ons).
-### Help: Repository is not showing up
+ ```text
+ https://github.com/home-assistant/hassio-addons-example
+ ```
+2. Go to {% my supervisor title="**Settings** > **Add-ons**" %} and select **Add-on store**.
+ 
+3. In the top-right corner, select the three dots {% icon "mdi:dots-vertical" %} menu, and select **Repositories**.
+4. Add the URL of the repository and select **Add**.
+ 
+ - **Result**: A new card for the repository will appear.
+ 
-If you have added a repository, but it's not showing up, it means that the repository contains invalid configuration. Go to {% my logs title="Settings > System > Logs" %} to find the System log. It should tell you what went wrong. Report this information to the repository author.
+### Troubleshooting: Repository is not showing up
+
+If you have added an add-on repository, but it's not showing up, make sure to refresh your browser. If it still doesn't show up, the add-on repository may contain invalid configuration data.
+
+1. Go to {% my logs title="**Settings** > **System** > **Logs**" %} and select Supervisor in the top right corner to get the Supervisor log.
+ - It should tell you what went wrong.
+2. Report this information to the add-on repository author.
diff --git a/source/_includes/dashboard/edit_dashboard.md b/source/_includes/dashboard/edit_dashboard.md
index 42da726cd25..1053b8b3cdf 100644
--- a/source/_includes/dashboard/edit_dashboard.md
+++ b/source/_includes/dashboard/edit_dashboard.md
@@ -4,7 +4,7 @@
To add the {{ title | downcase }} to your user interface:
-1. In the top right of the screen, select the pencil icon.
+1. In the top right of the screen, select the edit {% icon "mdi:edit" %} button.
- 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.
diff --git a/source/_integrations/alexa.smart_home.markdown b/source/_integrations/alexa.smart_home.markdown
index ef4282d9366..420d74854ca 100644
--- a/source/_integrations/alexa.smart_home.markdown
+++ b/source/_integrations/alexa.smart_home.markdown
@@ -149,7 +149,7 @@ The first thing you need to do after signing into the [AWS console](https://cons
Next you need create a Lambda function.
- Click `Services` in top navigation bar, expand the menu to display all AWS services, then under `Compute` section click `Lambda` to navigate to Lambda console. Or you may use this [link](https://console.aws.amazon.com/lambda/home)
-- **IMPORTANT - Alexa Skills are only supported in certain AWS regions** Your current server location will be displayed on the top right corner (for example, Ohio), make sure you select the server closest to your location / region based on your Amazon account's country, whilst also ensuring that it is within one of the supported regions for Alexa Skills otherwise this will not work!
+- **IMPORTANT - Alexa Skills are only supported in certain AWS regions.** Your current server location will be displayed in the top-right corner (for example, Ohio). Select an available server below that is closest to your location and in your region, based on your Amazon account’s country. Alexa Lambda functions created on other servers will not work properly and may prevent account linking!
- **US East (N.Virginia)** region for English (US) or English (CA) skills
- **EU (Ireland)** region for English (UK), English (IN), German (DE), Spanish (ES) or French (FR) skills
- **US West (Oregon)** region for Japanese and English (AU) skills.
@@ -245,6 +245,10 @@ Alexa needs to link your Amazon account to your Home Assistant account. Therefor
Read [more from the Alexa developer documentation](https://developer.amazon.com/en-US/docs/alexa/account-linking/requirements-account-linking.html) about requirements for account linking.
+ {% note %}
+ Despite the Alexa documentation's disclaimer, however, [Let's Encrypt](https://letsencrypt.org/) certificates are still accepted.
+ {% endnote %}
+
{% important %}
You must use a valid/trusted SSL certificate for account linking to work.
Self signed certificates will not work, but you can use a free Let's Encrypt certificate.
diff --git a/source/_integrations/bayesian.markdown b/source/_integrations/bayesian.markdown
index 66efb3fb525..2bcab49f859 100644
--- a/source/_integrations/bayesian.markdown
+++ b/source/_integrations/bayesian.markdown
@@ -48,7 +48,9 @@ To enable the Bayesian sensor, add the following lines to your {% term "`configu
# Example configuration.yaml entry
binary_sensor:
- platform: bayesian
- prior: 0.1
+ name: "Kitchen Occupied"
+ prior: 0.3
+ probability_threshold: 0.5
observations:
- entity_id: "switch.kitchen_lights"
prob_given_true: 0.6
diff --git a/source/_integrations/denonavr.markdown b/source/_integrations/denonavr.markdown
index a3480b8c464..d33b9f48414 100644
--- a/source/_integrations/denonavr.markdown
+++ b/source/_integrations/denonavr.markdown
@@ -81,6 +81,7 @@ Known supported devices:
- Marantz AV7704
- Marantz AV8802A
- Marantz CINEMA 50
+- Marantz CINEMA 60
- Marantz CINEMA 70s
- Marantz M-CR510
- Marantz M-CR511
diff --git a/source/_integrations/history_stats.markdown b/source/_integrations/history_stats.markdown
index 7995cdc2867..856146f748b 100644
--- a/source/_integrations/history_stats.markdown
+++ b/source/_integrations/history_stats.markdown
@@ -19,7 +19,7 @@ related:
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 {% term integration %} has been in a specific state, in a custom time period.
+It can track how long an {% term entity %} has been in a specific state, in a custom time period.
Examples of what you can track:
diff --git a/source/_integrations/matter.markdown b/source/_integrations/matter.markdown
index 0952ab1eefb..fc6dc68a329 100644
--- a/source/_integrations/matter.markdown
+++ b/source/_integrations/matter.markdown
@@ -188,8 +188,8 @@ This guide describes how to add a new device. This will use the Bluetooth connec
- This starts the commissioning process which may take a few minutes.
- If you're adding a test board (e.g. ESP32 running the example apps) and commissioning fails, you might need to take some actions in the Google Developer console, have a look at any instructions for your test device.
- Once the process is complete, select **Done**.
-5. To view the device details, go to {% my integrations title="**Settings** > **Devices & services**" %} and select the **Matter** integration.
-6. By default, the device gets a factory specified name. To rename it, on the device page, select the pencil to edit and rename the device.
+5. To view the device details, go to {% my integrations title="**Settings** > **Devices & Services**" %} and select the **Matter** integration.
+6. By default, the device gets a factory specified name. To rename it, on the device page, select the pencil {% icon "mdi:edit" %} to edit and rename the device.
7. Your device is now ready to use.
diff --git a/source/_integrations/mold_indicator.markdown b/source/_integrations/mold_indicator.markdown
index e3ca94b0825..45b97b01247 100644
--- a/source/_integrations/mold_indicator.markdown
+++ b/source/_integrations/mold_indicator.markdown
@@ -15,9 +15,9 @@ related:
title: Configuration file
---
-The Mold Indicator sensor {% term integration %} consumes information of two temperature sensors and a humidity sensor to give an indication for possible mold growth in your home. In case of bad ventilation and insulation, the indoor humidity may lead to condensation on cold surfaces as the windows or even walls. Condensation or a high relative humidity near those cold surfaces leads to a higher risk for mold growth. This sensor integration estimates the temperature at a pre-calibrated critical point in the room (the coldest surface) and calculates the relative humidity of the air at that point. If the sensor value rises above approximately 70 percent, mold growth might occur and the room should be ventilated. At 100%, the air humidity condensates at the critical point.
+The Mold Indicator sensor {% term integration %} uses data from two temperature sensors and a humidity sensor to predict the humidity near a cold surface. High humidity may lead to mold growth at more than ~70% and causes condensation at 100%.
-The sensor data may be used e.g., to signal bad air quality (too high air humidity) or to automate operation of indoor air humidifiers to keep the indoor humidity at an optimum.
+The sensor data may be used, for example, to detect bad air quality (high humidity) or automate the operation of indoor air humidifiers to keep the indoor humidity at an optimum.
## Configuration
@@ -59,9 +59,16 @@ calibration_factor:
In this case, the weather forecast temperature sensor is used for the outside temperature.
+## Background
+
+First, this sensor predicts the temperature near the given surface by estimating it from the indoor and outdoor temperatures. The predicted temperature starts with the indoor temperature, then either brings it closer to the outdoor temperature (if the calibration factor is positive, indicating the surface is influenced by the outdoors) or away (if the calibration factor is negative, indicating the surface is inversely correlated with the outdoor temperature).
+
+From there, the sensor calculates the relative humidity near the given surface based on the dew point.
+
## Calibration
The Mold Indicator sensor integration needs to be calibrated in order to estimate the temperature at the critical point from the outdoor and indoor temperature. First find the coldest surface in the room (critical point), which is typically near the window frames, but depends on the insulation of your home. For calibration you need to measure the temperature at this critical point and simultaneously write down the values for the indoor- and outdoor temperature sensors used for the Mold Indicator. Be sure that there is a significant indoor to outdoor temperature difference to get the best calibration results.
+
With the three measured temperatures (in Celsius or Fahrenheit), the calibration_factor for your configuration file is given by:
```text
diff --git a/source/_integrations/onkyo.markdown b/source/_integrations/onkyo.markdown
index 9a1c01548ea..0898ebbcc54 100644
--- a/source/_integrations/onkyo.markdown
+++ b/source/_integrations/onkyo.markdown
@@ -52,7 +52,7 @@ max_volume:
default: 100
type: integer
receiver_max_volume:
- description: The maximum volume of the receiver. For older Onkyo receivers this was 80, newer Onkyo receivers use 200.
+ description: The number of steps it takes for the receiver to go from the lowest to the highest possible volume. Possible values are 50, 80, 100, 200. For older Onkyo receivers, this typically is 80; newer Onkyo receivers use 200.
required: false
default: 80
type: integer
@@ -91,22 +91,6 @@ List of source names:
- `xm`
- `sirius`
-If your source is not listed above, and you want to figure out how to format that source name so you can map its entry, you can use the `onkyo-eiscp` Python module to discover the exact naming needed. First, change your receiver's source to the one that you need to define, and then run:
-
-```bash
-onkyo --host 192.168.0.100 source=query
-```
-
-If this returns multiple, comma-separated values, use the first one. For example, if `dvd,bd,dvd` is returned, use `dvd`.
-
-To find your receivers max volume use the onkyo-eiscp Python module set the receiver to its maximum volume
-(don't do this whilst playing something!) and run:
-
-```bash
-onkyo --host 192.168.0.100 volume=query
-unknown-model: master-volume = 191
-```
-
### Action `onkyo_select_hdmi_output`
Changes HDMI output of your receiver
diff --git a/source/_integrations/person.markdown b/source/_integrations/person.markdown
index f7b350b1810..d773e7a2923 100644
--- a/source/_integrations/person.markdown
+++ b/source/_integrations/person.markdown
@@ -32,6 +32,36 @@ In short, when you're at home, your position is determined first by stationary t
You can manage persons {% my people title="via the UI from the person page inside the configuration panel" %} or via `YAML` in your {% term "`configuration.yaml`" %} file.
+## Adding a person to Home Assistant
+
+If you have administrator rights, you can add other persons to Home Assistant and create them a user account. Depending on the rights you give them, they can then use Home Assistant on their own devices, can have their own dashboards, and be used in automations.
+
+1. Go to {% my people title="**Settings** > **People**" %} and select **Add person**.
+2. Enter their **Name**.
+3. Add an image if you like.
+4. Under **Allow login**, select if they should be able to log in.
+ - If they cannot log in, they do not get a user account, and they cannot do much with Home Assistant.
+ - They cannot have their own dashboard, for example.
+ - But they can still be used for device tracking and show up on a map and be used in automations.
+5. If they are able to log in, fill in the user information.
+ - Check if the user name is correct. A suggestion is made based on the person name. But they do not have to be identical.
+ - The username is required to log in.
+ - The person name is the name displayed in the UI.
+ - Enter a password and store it in a safe location.
+ - Define if they should have **Local access only**.
+ - If this is enabled, they won't have access to Home Assistant when they are outside your network, for example from their phone.
+ - Define if they should have **Administrator** rights.
+ - Select **Create**.
+6. If you have already set up devices for [presence detection](/getting-started/presence-detection/), **select the devices that belong to this person**.
+
+### Customizing the picture for a person
+
+You can easily upload a picture in the frontend. Simply click on a person, select or drop an image in the input field, and then crop it.
+
+
+
+See the documentation about [hosting files](/integrations/http/#hosting-files) for more information about the `www` folder.
+
## Configuring the `person` integration via the Home Assistant configuration panel
This integration is by default enabled, unless you've disabled or removed the [`default_config:`](/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually:
@@ -90,19 +120,3 @@ person:
```
If you change the YAML, you can reload it by calling the `person.reload` action.
-
-### Customizing the picture for a person
-
-You can easily upload a picture in the frontend. Simply click on a person, select or drop an image in the input field, and then crop it.
-
-
-
-You can also do this using YAML. By following the instructions on the [customizing entities](/docs/configuration/customizing-devices#entity_picture) page, you can customize the picture used for a person entity in the `customize:` section of your configuration. For example:
-
-```yaml
-customize:
- person.ada:
- entity_picture: "/local/ada.jpg"
-```
-
-See the documentation about [hosting files](/integrations/http/#hosting-files) for more information about the `www` folder.
diff --git a/source/_integrations/watttime.markdown b/source/_integrations/watttime.markdown
index 147a31e5d20..630f0242933 100644
--- a/source/_integrations/watttime.markdown
+++ b/source/_integrations/watttime.markdown
@@ -3,6 +3,8 @@ title: WattTime
description: Instructions on how to set up the WattTime integration within Home Assistant.
ha_category:
- Sensor
+ - Energy
+ - Environment
ha_release: '2021.10'
ha_iot_class: Cloud Polling
ha_domain: watttime
diff --git a/source/_integrations/zone.markdown b/source/_integrations/zone.markdown
index 42414203291..64d11818385 100644
--- a/source/_integrations/zone.markdown
+++ b/source/_integrations/zone.markdown
@@ -10,17 +10,58 @@ ha_codeowners:
- '@home-assistant/core'
ha_domain: zone
ha_integration_type: system
+related:
+ - docs: /docs/configuration/basic/
+ title: Editing basic settings
+ - docs: /docs/organizing/areas/
+ title: Areas
+ - docs: /getting-started/onboarding/
+ title: Onboarding
+ - docs: /getting-started/presence-detection/
+ title: Presence detection
---
-Zones allow you to specify certain regions on earth (for now). When a device tracker sees a device to be within a zone, the state will take the name from the zone. Zones can also be used as a [trigger](/docs/automation/trigger#zone-trigger) or [condition](/docs/scripts/conditions/#zone-condition) inside automation setups.
+Zones allow you to specify certain regions on a map. They enable [zone presence-detection](/getting-started/presence-detection/). This information can be used in automations. For example, to start the vacuum after you left home or start the heating at home when you leave the office.
-Zones can be added and managed through the user interface at {% my zones title="**Settings** > **Areas, labels & zones**" %}.
+Create a zone for each area you want to automate on. For example, work, school, and home. Different technologies can be used to detect presence in these zones. A common method is app-based detection using a mobile phone.
-
+
+
+ Map dashboard showing a school, work, and a home zone and the location of two people.
+
-You can add a zone in the user interface by specifying the GPS coordinates or dragging the icon on the map. You can adjust the zone radius (except for the Home zone) by changing the size of the zone circle.
+## About the home zone
-Zones can also be configured via {% term "`configuration.yaml`" %}:
+During the [onboarding process](/getting-started/onboarding/), Home Assistant asked for your home location. You either entered this manually or asked Home Assistant to detect it automatically. This location was used to create the home zone with a 100 m radius. The home zone is a special, pre-defined zone with a few characteristics that set it apart from other zones.
+
+- The name of this zone is defined by the name of your Home Assistant installation name (which defaults to "Home").
+- The home zone cannot be deleted and is designated with the home icon in the zone configuration page.
+- The home zone's location is used by integrations that are location-based. For example, the [Sun integration](/integrations/sun/), which uses it to calculate the position of the sun relative to your home.
+- During onboarding, Home Assistant used the location to define settings such as the unit system and time zone. If you change the location later, unit system and time zone will not be changed automatically anymore.
+- Devices that are in the home zone will not appear on the map in the Home Assistant UI. For example, if you are using your phone for presence detection, you won't see your phone on the Map dashboard while you are at home.
+
+## Adding a new zone or editing zones
+
+1. Go to {% my zones title="**Settings** > **Areas, labels & zones**" %}.
+2. To edit an existing zone, select the edit {% icon "mdi:edit" %} button. To add a new zone, select **Add zone**.
+3. Give your zone a name, for example `Nina's office`, or `school`.
+ - The home zone always has the name of your Home Assistant installation. To change the name of the home, go to {% my general title="**Settings** > **System** > **General**" %}.
+4. Pick any icon from [Material Design Icons](https://pictogrammers.com/library/mdi/) and prefix the name with `mdi:`.
+ - For example, `mdi:school`, `mdi:briefcase`, `mdi:home`, `mdi:cart`, or `mdi:castle`.
+ - For the home zone, the icon cannot be changed.
+5. To change location or radius, under **Edit location**, select edit.
+ - To adjust the location, specify the GPS coordinates or drag the icon on the map
+ - To change the zone radius, change the size of the zone circle or edit the **Radius** in meters.
+
+ 
+
+6. If you want to hide the zone from the frontend and not use the zone for device tracker state, enable **Passive**. You can still use it in automations.
+ - For the home zone, **Passive** is not available.
+7. To save your changes, select **Update**.
+
+## Editing zones in YAML
+
+Zones can also be configured via {% term "`configuration.yaml`" %}. If you define these settings in YAML, they cannot be edited in the UI. They will appear greyed out.
```yaml
# Example configuration.yaml entry
@@ -74,18 +115,6 @@ passive:
To find the latitude/longitude of a certain place you can use [Google Maps](https://www.google.com/maps/) or [Bing Maps](https://www.bing.com/maps). Just right click and copy the coordinates from there (Bing) or click on the "What is here?" (Google)
-## Home zone
-
-If no configuration is given, the `zone` integration will create a zone for home. This zone will use location provided in the `configuration.yaml` file and have a radius of 100 meters. To override this, create a zone configuration in `configuration.yaml` (see above) and name it **'Home'**. Overriding the Home zone via the UI is not supported.
-
-{% note %}
-Devices that are in the zone **'Home'** will not appear on the map in the Home Assistant UI. To apply the changes to the **'Home'** `zone`, you must restart Home Assistant.
-{% endnote %}
-
-## Icons
-
-It is recommended that you pick an icon to use for your zone. Pick any icon from [Material Design Icons](https://pictogrammers.com/library/mdi/) and prefix the name with `mdi:`. For example `mdi:school`, `mdi:briefcase`, `mdi:home`, `mdi:cart`, or `mdi:castle`.
-
## State
The state of a zone is a number, which represents the number of
diff --git a/source/_posts/2024-08-01-streamlining-the-home-assistant-yellow-lineup.markdown b/source/_posts/2024-08-01-streamlining-the-home-assistant-yellow-lineup.markdown
new file mode 100644
index 00000000000..34d5e58bb68
--- /dev/null
+++ b/source/_posts/2024-08-01-streamlining-the-home-assistant-yellow-lineup.markdown
@@ -0,0 +1,117 @@
+---
+layout: post
+title: "Streamlining the Home Assistant Yellow lineup"
+description: "Home Assistant Yellow continues to be our flagship product, and the line is getting a small tweak."
+date: 2024-08-01 00:00:01
+date_formatted: "August 1, 2024"
+author: Andy Gill
+comments: true
+categories: Announcements
+og_image: /images/blog/2024-08-yellow-lineup/art.jpg
+---
+
Home Assistant Yellow fully assembled with additional (and not included) NVMe storage and Z-Wave GPIO module
+
+**TL;DR:** We will now only sell the Home Assistant Yellow as a kit, which requires the separate purchase of a CM4. Home Assistant Green is the best plug-and-play option for beginners.
+
+An important part of getting more people to use Home Assistant is providing great purpose-built hardware. It's our goal to provide hardware that makes it easier than ever to start with Home Assistant, along with compelling options for advanced users. In 2022, we began shipping our [Home Assistant Yellow](/yellow/), and I'm happy to say that now in 2024, it remains our flagship hardware product. We see a long life ahead for this expandable little powerhouse, and that's why we're streamlining our hardware lineup to make a bit more sense going forward.
+
+We will now only sell the Home Assistant Yellow as a kit and have stopped producing the Home Assistant Yellow Standard (our version that came preassembled with a CM4 and Home Assistant already installed). Rest assured, as the Home Assistant Yellow Standard's hardware is identical to our kits, it will continue to receive the same support and software updates. The kits will continue to be available with or without power-over-ethernet (PoE).
+
+It's not the biggest change, but we wanted our community to know - and if you want to see why we made the change, and how our [current hardware compares](#comparison), keep reading.
+
+
+
+## Background
+
+When we launched Home Assistant Yellow, we designed it with expandability in mind. It includes an onboard Zigbee/Thread radio, M.2 for more robust storage, and USB ports to add more connectivity (like adding our future [Z-Wave device](/blog/2024/06/12/roadmap-2024h1/#next-priority-home-assistant-connect-hardware-for-z-wave)). Most importantly, you can change the core specs of the device by swapping the Raspberry Pi Compute Module 4 (CM4). This allows users to increase the RAM, add eMMC storage, or even add built-in Wi-Fi/Bluetooth.
+
+All this expandability is great, but we found many users wanted a more straightforward way to get started with Home Assistant. That's why we created the Home Assistant Yellow Standard variant, which included a CM4 with Home Assistant already installed onto the board - unlike our kits there was no assembly required. This meant you could immediately start using it after plugging in Ethernet and power.
+
+### Green meets Yellow
+
+Jump ahead to 2023, and in our quest to create an even more affordable starting point, we launched [Home Assistant Green](/green/). Not only does it cost less, it better fulfills the plug-and-play role the Home Assistant Yellow Standard used to occupy. From a timing perspective 2021 and 2022, were not the easiest time to source Raspberry Pi products, including the CM4. We learned some big lessons about the added supply chain complexities of this kind of product, and it influenced our thinking when designing Green. Ultimately, Home Assistant Green being a better beginner option led us to end production of the Standard. Though the Home Assistant Yellow Standard is now out of stock at major retailers, it will continue to receive support.
+
+## Comparison
+
+
Home Assistant Green and Yellow compared - as you can see they're about the same size
+So you've decided on getting some official Home Assistant hardware and don't know where to start, here's a little comparison to help you choose between the Green and Yellow.
+
+
+
+
+
+
+
+
+
+
+
Features
+
Home Assistant Green
+
Home Assistant Yellow Kit
+
+
+
+
+
Best for
+
Beginners, plug-and-play
+
Advanced users, tinkerers, expandability
+
+
+
Setup
+
Easy - plug in the two included cables, and you're up and running
Both are small, fanless/silent, have extremely low power draw, and solid performance, leading to a smooth Home Assistant experience. Plus, purchasing either supports the development of Home Assistant!
+
+## Conclusion
+
+This small change helps us keep things simple while continuing to provide great hardware options for new and existing users. But as we always say, run Home Assistant on whatever hardware you have, whether that's our hardware or whatever you already have on hand. In the end, one of our main goals is to build a more sustainable smart home.
diff --git a/source/common-tasks/os.markdown b/source/common-tasks/os.markdown
index b46e13f1d1d..258b1250e02 100644
--- a/source/common-tasks/os.markdown
+++ b/source/common-tasks/os.markdown
@@ -77,12 +77,11 @@ You can manually define that the previous boot slot is used. This can be useful
### Updating Home Assistant Core
{% include common-tasks/update.md %}
+
{% include common-tasks/network_storage.md %}
-{% include common-tasks/commandline.md %}
{% include common-tasks/lost_password.md %}
{% include common-tasks/third-party-addons.md %}
{% include common-tasks/configuration_check.md %}
-{% include common-tasks/enable_i2c.md %}
## Home Assistant versions
@@ -94,3 +93,8 @@ To see which version your system is running, go to {% my info title="**Settings*
{% include common-tasks/data_disk.md %}
+
+{% include common-tasks/commandline.md %}
+
+
+{% include common-tasks/enable_i2c.md %}
diff --git a/source/common-tasks/supervised.markdown b/source/common-tasks/supervised.markdown
index 74a9c6101fa..ca6781d7151 100644
--- a/source/common-tasks/supervised.markdown
+++ b/source/common-tasks/supervised.markdown
@@ -15,7 +15,6 @@ related:
{% include common-tasks/update.md %}
{% include common-tasks/network_storage.md %}
-{% include common-tasks/commandline.md %}
{% include common-tasks/lost_password.md %}
{% include common-tasks/third-party-addons.md %}
{% include common-tasks/configuration_check.md %}
@@ -26,4 +25,6 @@ To see which version your system is running, go to {% my info title="**Settings*
{% include common-tasks/specific_version.md %}
{% include common-tasks/beta_version.md %}
-{% include common-tasks/development_version.md %}
\ No newline at end of file
+{% include common-tasks/development_version.md %}
+
+{% include common-tasks/commandline.md %}
\ No newline at end of file
diff --git a/source/getting-started/concepts-terminology.markdown b/source/getting-started/concepts-terminology.markdown
index 7441a55fae0..c9e9fa14cda 100644
--- a/source/getting-started/concepts-terminology.markdown
+++ b/source/getting-started/concepts-terminology.markdown
@@ -24,6 +24,8 @@ Once an {% term integration %} has been added, the hardware and/or data are repr
Entities are the basic building blocks to hold data in Home Assistant. An {% term entity %} represents a {% term sensor %}, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other {% term entities %}. An {% term entity %} is usually part of a {% term device %} or a {% term service %}. Entities have {% term states %}.
+
Screenshot of the Entities table. Each line represents an entity.
+
## Devices
Devices are a logical grouping for one or more {% term entities %}. A {% term device %} may represent a physical {% term device %}, which can have one or more sensors. The sensors appear as entities associated with the {% term device %}. For example, a motion sensor is represented as a {% term device %}. It may provide motion detection, temperature, and light levels as {% term entities %}. Entities have states such as *detected* when motion is detected and *clear* when there is no motion.
@@ -72,8 +74,12 @@ To learn how to use {% term scenes %}, refer to the [scene](/integrations/scene/
## Add-ons
-Depending on your [installation type](/installation), you can install third party add-ons. Add-ons are usually apps that can be run with Home Assistant but provide a quick and easy way to install, configure, and run within Home Assistant. Add-ons provide additional functionality whereas {% term integrations %} connect Home Assistant to other apps.
+Add-ons are third-party applications that provide additional functionality in Home Assistant. Add-ons run directly alongside Home Assistant, whereas {% term integrations %} connect Home Assistant to other apps. Add-ons are only supported by the {% term "Home Assistant Operating System" %} and {% term "Home Assistant Supervised" %} [installation type](/installation).
-
+Add-ons are installed from the add-on store under {% my supervisor title="**Settings** > **Add-ons**" %}. If you are curious now and feel like installing every add-on that looks interesting: beware that add-ons can use quite a bit of resources in terms of disk space, memory, and additional load on the processor.
+
+Among the most used add-ons are the ones that provide [file access and edit files](/docs/configuration/#to-set-up-access-to-the-files-and-prepare-an-editor) in Home Assistant.
+
+
Screenshot of the add-on page, showing all the installed add-ons on a test system.
{% include getting-started/next_step.html step="Edit the dashboard" link="/getting-started/onboarding_dashboard/" %}
diff --git a/source/getting-started/onboarding.markdown b/source/getting-started/onboarding.markdown
index 1979cebfacc..74d608175f9 100644
--- a/source/getting-started/onboarding.markdown
+++ b/source/getting-started/onboarding.markdown
@@ -30,9 +30,10 @@ After Home Assistant has been [installed](/installation/) on your device, there
- If you have a Home Assistant Green, start with the [Green documentation on restoring from backup](https://green.home-assistant.io/guides/restore-backup/).
3. Enter the location of your home.
- - The location is used to configure the time zone, unit system, and currency.
- - It is also used for automations such as showing the weather, opening the shades at sunrise, or starting the vacuum when you leave the home.
+ - The home location is used to configure the time zone, unit system, and currency.
+ - It is also used to create the home [zone](/integrations/zone/), which designates the area of your home with a default radius of 100 m.
- You can always change this information later in the settings.
+ - This home zone can be used for automations such as showing the weather, opening the shades at sunrise, or starting the vacuum when you leave the home.
- After finding your location, select **Next**.
diff --git a/source/getting-started/presence-detection.markdown b/source/getting-started/presence-detection.markdown
index a206c6e1a47..0a899ba7347 100644
--- a/source/getting-started/presence-detection.markdown
+++ b/source/getting-started/presence-detection.markdown
@@ -1,32 +1,66 @@
---
title: "Setting up presence detection"
-description: "Instructions on how to setup presence detection within Home Assistant."
+description: "Instructions on how to set up zone presence detection within Home Assistant."
---
-Presence detection detects if people are home, which can be valuable input for automation. Knowing who is home or where they are, will open a whole range of other automation options:
+Zone presence detection detects if people are within a certain zone, which can be valuable input for automation. Knowing who is home or where they are opens a range of automation options:
- Send me a notification when my child arrives at school
- Turn on the AC when I leave work
-
+
+
+ Map dashboard showing a school, work, and a home zone and the location of two people.
+
-### Adding presence detection
+## About setting up zone presence detection
-There are different ways of setting up presence detection. Usually the easiest way to detect presence is by checking which {% term devices %} are connected to the network. You can do that if you have one of our [supported routers][routers]. By leveraging what your router already knows, you can easily detect if people are at home.
+There are different ways of setting up zone presence detection. One way is to run an app on your phone to send detailed location information to your Home Assistant instance. Another way to detect presence is by checking which {% term devices %} are connected to the network. You can do that if you have one of our [supported routers][routers]. By leveraging what your router already knows, you can detect if people are at home.
-It's also possible to run an app on your phone to provide detailed location information to your Home Assistant instance. For iOS and Android, we suggest using the [Home Assistant Companion app][companion].
+## Adding zone presence detection with a mobile phone
-During the setup of Home Assistant Companion on your mobile device, the app will ask for permission to allow the device's location to be provided to Home Assistant. Allowing this will create a `device_tracker` entity for that device which can be used in automations and conditions.
+### Prerequisites
-### Zones
+- [Home Assistant installed](/installation/)
+- [Onboarding steps](/getting-started/onboarding/) completed
+- [Remote access enabled](/docs/configuration/remote/)
+ - The easiest way to do this is by enabling
+ - [Home Assistant Cloud](https://nabucasa.com/config/)
+- Mobile phone:
+ - Android (Android 5 or later) or iPhone (iOS 15 or later)
+ - Phone plan with Internet access
+ - Access to your local network where Home Assistant is running
+- [Home Assistant Companion app installed](https://companion.home-assistant.io/docs/getting_started/) on your phone.
+ - During the setup procedure, make sure to grant **Location access**.
+ - Location access creates a `device_tracker` entity for that device. This entity can be used in automations and conditions.
-
+### To add zone presence detection with a mobile phone
-{% term Zones %} allow you to name areas on a map. These areas can then be used to name the location a tracked user is, or use entering/leaving a zone as an automation {% term trigger %} or {% term condition %}. See [Zones integration](/integrations/zone/) page for more details like creating zones.
+1. Open the Home Assistant Companion app on your phone and log in to your Home Assistant instance.
+2. On the screen to **Connect to Home Assistant**, make sure you activate **Enable location tracking**.
+ - Select **Continue**.
+3. Go to {% my integrations title="**Settings** > **Devices** & **Services**" %} and look for the new integration that was added: **Mobile App**.
+ - On the integration card, select **1 Device**. This opens the device info page.
+ - You now see your phone name and its entities.
+4. To view the location of your phone on the map, open the **Map** dashboard.
+ - You now see a circle on that map with your initial.
+ - It shows the current location of your phone.
+ - To view the details, select that initial.
+ - Open the **Attributes** list to see the phone's **Latitude**, **Longitude**, and the **Source** of information.
+ - The source is the `device_tracker` entity for that device, for example `device_tracker.pixel_7_pro`.
+5. To view the entity details and the history, go to {% my entities title="**Settings** > **Devices & services** > **Entities**" %} and in the search field, enter `devi` and select your `device_tracker` entity from the list.
+6. Check your [Zones](/integrations/zone/) to prepare them for automations.
+ - Your home zone was set up during onboarding, but you can edit it.
+ - You can add other zones if you want to automate on them.
+ - For example, if you want the heating to start when you leave your office, you can add a zone called **Office**.
+ - In this case, leaving the office zone would be an automation {% term trigger %}.
+ - You could also use the location information as an automation {% term condition %}, for example, when you have an automation to turn on the light at sunset, but only when you are home.
-{% note %}
-The map dashboard will hide all devices that are home.
-{% endnote %}
+## Adding presence detection for other persons in your home
+
+1. For each person you want to have presence detection, add a device tracker.
+2. Go to {% my people title="**Settings** > **People**" %} and select the person.
+3. Scroll down and under **Select the devices that belong to this person**, select the device.
[routers]: /integrations/#presence-detection
[nmap]: /integrations/nmap_tracker
diff --git a/source/green/index.html b/source/green/index.html
index 179dc2d3ace..f5be07b3259 100644
--- a/source/green/index.html
+++ b/source/green/index.html
@@ -2312,11 +2312,11 @@ dark_header: true
Shipping to America
If you bought the Home Assistant Yellow Kit, you need to bring your own Raspberry Pi Compute Module 4.
-
A chip shortage still impacts the availability of the CM4. Our recommendation is to use rpilocator. This website tracks the stock of official Raspberry Pi distributors. Follow them on X and enable push notifications. You will be notified as soon as the bot tweets that products are in stock.
-
We recommend purchasing a Raspberry Pi Compute Module 4 with the following characteristics:
+ {% details "Can I buy the Home Assistant Yellow pre-assembled?" %}
No. We previously offered a Home Assistant Yellow Standard model that came pre-assembled with a Raspberry Pi CM4, but this model is no longer manufactured. It is now recommended that if you want a more plug-and-play experience, you purchase a Home Assistant Green, as it requires no assembly and matches many of the capabilities of the Yellow, especially if you add a Home Assistant Connect ZBT-1 to give it Zigbee/Thread capability.
+
+ {% enddetails %}
+
+ {% details "What happened to Home Assistant Yellow Standard, and will it still be supported?" %}
The Home Assistant Yellow Standard was originally designed to be the beginner option in our product line, as it was pre-assembled and easier to get started with. In 2023, we launched the Home Assistant Green, which offered similar features, including easy setup, but at a lower price point. This led us to end the manufacture of the Home Assistant Yellow Standard and focus on Yellow Kit versions for advanced users. Rest assured, it will continue to receive the same support and software updates as the Yellow Kit variants.
+
-From {% my supervisor title="Settings > Add-ons" %} open the add-on store.
-
-Add the URL of the repository and then press "Add". A new card for the repository will appear.
-
+ Map dashboard showing a school, work, and a home zone and the location of two people.
+
Home Assistant Yellow fully assembled with additional (and not included) NVMe storage and Z-Wave GPIO module
Home Assistant Green and Yellow compared - as you can see they're about the same size
Screenshot of the Entities table. Each line represents an entity.
Screenshot of the add-on page, showing all the installed add-ons on a test system.
