jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-25 10:17:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'next' into expand_legend

Browse Source
This commit is contained in:
c0ffeeca7 2025-02-24 14:06:56 +01:00 committed by GitHub
commit ed3fda4a21
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
86 changed files with 2078 additions and 437 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Gemfile
View File

@ -10,9 +10,9 @@ 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 'sass-embedded', '1.83.4'
gem 'rubocop', '1.71.2'
gem 'ruby-lsp', '0.23.8'
gem 'sass-embedded', '1.85.0'
gem 'rubocop', '1.72.2'
gem 'ruby-lsp', '0.23.11'
gem 'rackup', '2.2.1'
end
@ -24,7 +24,7 @@ group :jekyll_plugins do
end
gem 'sinatra', '4.1.1'
gem 'nokogiri', '1.18.2'
gem 'nokogiri', '1.18.3'
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
# and associated library

36
Gemfile.lock
View File

@ -70,27 +70,28 @@ GEM
nokogiri (~> 1.12)
jekyll-watch (2.2.1)
listen (~> 3.0)
json (2.9.1)
json (2.10.1)
kramdown (2.5.1)
rexml (>= 3.3.9)
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
language_server-protocol (3.17.0.4)
lint_roller (1.1.0)
liquid (4.0.4)
listen (3.9.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
logger (1.6.5)
logger (1.6.6)
mercenary (0.4.0)
multi_json (1.15.0)
mustermann (3.0.3)
ruby2_keywords (~> 0.0.1)
nokogiri (1.18.2-arm64-darwin)
nokogiri (1.18.3-arm64-darwin)
racc (~> 1.4)
nokogiri (1.18.2-x86_64-linux-gnu)
nokogiri (1.18.3-x86_64-linux-gnu)
racc (~> 1.4)
parallel (1.26.3)
parser (3.3.7.0)
parser (3.3.7.1)
ast (~> 2.4.1)
racc
pathutil (0.16.2)
@ -98,7 +99,7 @@ GEM
prism (1.3.0)
public_suffix (6.0.1)
racc (1.8.1)
rack (3.1.9)
rack (3.1.10)
rack-protection (4.1.1)
base64 (>= 0.1.0)
logger (>= 1.6.0)
@ -116,11 +117,12 @@ GEM
rbs (3.8.1)
logger
regexp_parser (2.10.0)
rexml (3.4.0)
rexml (3.4.1)
rouge (4.5.1)
rubocop (1.71.2)
rubocop (1.72.2)
json (~> 2.3)
language_server-protocol (>= 3.17.0)
language_server-protocol (~> 3.17.0.2)
lint_roller (~> 1.1.0)
parallel (~> 1.10)
parser (>= 3.3.0.2)
rainbow (>= 2.2.2, < 4.0)
@ -130,7 +132,7 @@ GEM
unicode-display_width (>= 2.4.0, < 4.0)
rubocop-ast (1.38.0)
parser (>= 3.3.1.0)
ruby-lsp (0.23.8)
ruby-lsp (0.23.11)
language_server-protocol (~> 3.17.0)
prism (>= 1.2, < 2.0)
rbs (>= 3, < 4)
@ -139,9 +141,9 @@ GEM
ruby2_keywords (0.0.5)
safe_yaml (1.0.5)
sass (3.4.25)
sass-embedded (1.83.4-arm64-darwin)
sass-embedded (1.85.0-arm64-darwin)
google-protobuf (~> 4.29)
sass-embedded (1.83.4-x86_64-linux-gnu)
sass-embedded (1.85.0-x86_64-linux-gnu)
google-protobuf (~> 4.29)
sass-globbing (1.1.5)
sass (>= 3.1)
@ -156,7 +158,7 @@ GEM
rack-protection (= 4.1.1)
rack-session (>= 2.0.0, < 3)
tilt (~> 2.0)
sorbet-runtime (0.5.11801)
sorbet-runtime (0.5.11851)
stringex (2.8.6)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
@ -179,12 +181,12 @@ DEPENDENCIES
jekyll-paginate (= 1.1.0)
jekyll-sitemap (= 1.4.0)
jekyll-toc (= 0.19.0)
nokogiri (= 1.18.2)
nokogiri (= 1.18.3)
rackup (= 2.2.1)
rake (= 13.2.1)
rubocop (= 1.71.2)
ruby-lsp (= 0.23.8)
sass-embedded (= 1.83.4)
rubocop (= 1.72.2)
ruby-lsp (= 0.23.11)
sass-embedded (= 1.85.0)
sass-globbing (= 1.1.5)
sassc (= 2.1.0)
sinatra (= 4.1.1)

4
_config.yml
View File

@ -108,8 +108,8 @@ social:
# Home Assistant release details
current_major_version: 2025
current_minor_version: 2
current_patch_version: 0
date_released: 2025-02-05
current_patch_version: 5
date_released: 2025-02-21
# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.

5
sass/homeassistant/pages/_landingpage.scss
View File

@ -188,6 +188,11 @@ $ha__primary_color: #03a9f4;
width: 330px;
}
.button{
display: inline-block;
padding: 8px 24px;
}
.title {
margin-bottom: 4px;
}

4
source/_dashboards/conditional.markdown
View File

@ -6,7 +6,7 @@ description: The Conditional card displays another card based on conditions.
related:
- docs: /dashboards/cards/
title: Dashboard cards
- docs: /dashboards/cards/#showing-or-hiding-a-card-conditionally
- docs: /dashboards/cards/#showing-or-hiding-a-card-or-badge-conditionally
title: Conditional settings on the card's visibility tab
---
@ -17,7 +17,7 @@ The conditional card displays another card based on conditions.
{% include dashboard/edit_dashboard.md %}
Note that while editing the dashboard, the card will always be shown, so be sure to exit editing mode to test the conditions.
The conditional card can still be used. However, it is now possible to define a setting to show or hide a card conditionally directly on each card type, on its [Visibility](/dashboards/cards/#showing-or-hiding-a-card-conditionally) tab.
The conditional card can still be used. However, it is now possible to define a setting to show or hide a card conditionally directly on each card type, on its [Visibility](/dashboards/cards/#showing-or-hiding-a-card-or-badge-conditionally) tab.
Most options for this card can be configured via the user interface.

25
source/_dashboards/energy.markdown
View File

@ -234,3 +234,28 @@ The following example limits the number of shown devices to 5:
type: energy-devices-detail-graph
max_devices: 5
```
## Using Multiple Collections
By default, all energy cards are linked to any `energy-date-selection` card on the view, and all `energy-date-selection` cards are linked to the same period. To enable multiple different date selections on the same view, it is necessary to link them to different collections. This is done by adding the variable `collection_key` to the card YAML, and giving this a value of any custom string that begins with `energy_`. (strings that do not start with `energy_` will generate an error).
All energy cards support use of `collection_key` option.
### Examples
Example view with multiple collections:
```yaml
type: masonry
path: example
cards:
- type: energy-date-selection
- type: energy-date-selection
collection_key: energy_2
# This card is linked to the first (default) date selection
- type: energy-usage-graph
# This card is linked to the second date selection
- type: energy-usage-graph
collection_key: energy_2
```

6
source/_data/products.yml
View File

@ -175,6 +175,12 @@ yellow:
ship_to: Asia
url: https://www.seeedstudio.com/Home-Assistant-Yellow-Kit-with-selectable-CM4.html
logo: /images/distributors/seeed-studio.webp
# Australia
- name: Smart Guys
ship_from: Australia
ship_to: Australia
url: https://smartguys.com.au/product/home-assistant-yellow-smart-hub/
logo: /images/distributors/smart-guys.webp
# Europe
- name: Botland
ship_from: Poland

1
source/_docs/automation/templating.markdown
View File

@ -25,6 +25,7 @@ Triggers from all platforms will include the following data.
| Template variable | Data |
| ---- | ---- |
| `trigger.alias` | Alias of the trigger.
| `trigger.id` | The [`id` of the trigger](/docs/automation/trigger/#trigger-id).
| `trigger.idx` | Index of the trigger. (The first trigger idx is `0`.)

16
source/_docs/blueprint/selectors.markdown
View File

@ -1539,3 +1539,19 @@ The output of this selector is a list of triggers. For example:
entity_id: "sensor.outside_temperature"
below: 20
```
### Example - Merging with existing triggers
If the trigger(s) should exist within a blueprint that already has some default triggers defined, and an additional customizable trigger should be merged, you need to use the `- triggers` syntax in the blueprint.
```yaml
# Example trigger selector
input:
my_trigger_input:
selector:
trigger:
triggers:
- triggers: !input my_trigger_input
- platform: numeric_state
[...]
```

2
source/_docs/configuration/packages.markdown
View File

@ -3,7 +3,7 @@ title: "Packages"
description: "Describes all there is to know about configuration packages in Home Assistant."
---
Packages in Home Assistant provide a way to bundle different integration's configuration together. With packages we have a way to include different integrations, or different configuration parts using any of the `!include` directives introduced in [splitting the configuration](/docs/configuration/splitting_configuration).
Packages in Home Assistant provide a way to bundle configurations from multiple integrations. With packages, we have a way to include multiple integrations, or parts of integrations using any of the `!include` directives introduced in [splitting the configuration](/docs/configuration/splitting_configuration).
Packages are configured under the core `homeassistant/packages` in the configuration and take the format of a package name (no spaces, all lower case) followed by a dictionary with the package configuration. For example, package `pack_1` would be created as:

2
source/_includes/common-tasks/backups.md
View File

@ -99,6 +99,8 @@ This creates a backup instantly. You can create a manual backup at any time, irr
### Downloading your local backups
When downloading the backup from the Home Assistant backup page, it is decrypted on the fly so that you can view the data using your favorite archive tool. This is done for all backup locations and also when you download from Home Assistant Cloud.
There are multiple ways to download your local backup from your Home Assistant instance and store it on another device:
**Option 1**: Download from the backup page:

10
source/_includes/custom/buy-dialog.html
View File

@ -116,9 +116,6 @@
let tabContents = dialog.querySelectorAll('.ha-buy-dialog-tab-content');
let timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
let region = timezone.split('/')[0].toLowerCase();
let locale = Intl.DateTimeFormat().resolvedOptions().locale;
let countryCode = locale.split('-')[1].toLowerCase();
let defaultTab = dialog.querySelector(`.ha-buy-dialog-sidebar-tab[data-tab="#${region}"]`);
if (defaultTab) {
@ -128,11 +125,6 @@
defaultTab.classList.add('active');
let tabContent = document.querySelector(defaultTab.getAttribute('data-tab'));
tabContent.classList.add('active');
let country = tabContent.querySelector(`.ha-buy-dialog-distributor-country[data-code="${countryCode}"]`);
if (country) {
country.scrollIntoView({ behavior: 'instant', block: 'center' });
}
}
}
</script>
</script>

2
source/_includes/installation/operating_system.md
View File

@ -108,7 +108,7 @@ To write the HAOS image to the boot medium on your x86-64 hardware, there are 2
- This means you will lose all the data as well as the previously installed operating system.
- Back up your data before carrying out this procedure.
2. Create a *live operating system* on a USB flash drive:
- Follow the [Ubuntu instructions](https://ubuntu.com/tutorials/try-ubuntu-before-you-install) on writing an Ubuntu iso file onto a USB device.
- Follow the [Ubuntu Desktop instructions](https://ubuntu.com/tutorials/try-ubuntu-before-you-install) on writing an Ubuntu Desktop iso file onto a USB device.
3. Insert the USB flash drive into the system on which you want to run Home Assistant.
- Boot the live operating system.
- You might need to adjust boot order or use F10 (might be a different F-key depending on the BIOS) to select the USB flash drive as boot device.

9
source/_includes/site/footer.html
View File

@ -85,19 +85,26 @@
title="GitHub"
target="_blank"
><iconify-icon icon="simple-icons:github"></iconify-icon></a>
<br />
<a
rel="me"
href="https://fosstodon.org/@homeassistant"
title="Mastodon"
target="_blank"
><iconify-icon icon="simple-icons:mastodon"></iconify-icon></a>
<br />
<a
rel="me"
href="https://bsky.app/profile/home-assistant.io"
title="Bluesky"
target="_blank"
><iconify-icon icon="simple-icons:bluesky"></iconify-icon></a>
<a
rel="me"
href="https://x.com/home_assistant"
title="X"
target="_blank"
><iconify-icon icon="simple-icons:x"></iconify-icon></a>
<br />
<a
rel="me"
href="https://www.facebook.com/homeassistantio"

40
source/_integrations/amcrest.markdown
View File

@ -292,8 +292,8 @@ elements:
right: 25px
bottom: 50px
tap_action:
action: call-service
service: amcrest.ptz_control
action: perform-action
perform_action: amcrest.ptz_control
service_data:
entity_id: camera.lakehouse
movement: up
@ -304,8 +304,8 @@ elements:
right: 25px
bottom: 0px
tap_action:
action: call-service
service: amcrest.ptz_control
action: perform-action
perform_action: amcrest.ptz_control
service_data:
entity_id: camera.lakehouse
movement: down
@ -316,8 +316,8 @@ elements:
right: 50px
bottom: 25px
tap_action:
action: call-service
service: amcrest.ptz_control
action: perform-action
perform_action: amcrest.ptz_control
service_data:
entity_id: camera.lakehouse
movement: left
@ -328,8 +328,8 @@ elements:
right: 0px
bottom: 25px
tap_action:
action: call-service
service: amcrest.ptz_control
action: perform-action
perform_action: amcrest.ptz_control
service_data:
entity_id: camera.lakehouse
movement: right
@ -340,8 +340,8 @@ elements:
right: 50px
bottom: 50px
tap_action:
action: call-service
service: amcrest.ptz_control
action: perform-action
perform_action: amcrest.ptz_control
service_data:
entity_id: camera.lakehouse
movement: left_up
@ -352,8 +352,8 @@ elements:
right: 0px
bottom: 50px
tap_action:
action: call-service
service: amcrest.ptz_control
action: perform-action
perform_action: amcrest.ptz_control
service_data:
entity_id: camera.lakehouse
movement: right_up
@ -364,8 +364,8 @@ elements:
right: 50px
bottom: 0px
tap_action:
action: call-service
service: amcrest.ptz_control
action: perform-action
perform_action: amcrest.ptz_control
service_data:
entity_id: camera.lakehouse
movement: left_down
@ -376,8 +376,8 @@ elements:
right: 0px
bottom: 0px
tap_action:
action: call-service
service: amcrest.ptz_control
action: perform-action
perform_action: amcrest.ptz_control
service_data:
entity_id: camera.lakehouse
movement: right_down
@ -388,14 +388,14 @@ elements:
bottom: 25px
right: 25px
tap_action:
action: call-service
service: amcrest.ptz_control
action: perform-action
perform_action: amcrest.ptz_control
service_data:
entity_id: camera.lakehouse
movement: zoom_in
hold_action:
action: call-service
service: amcrest.ptz_control
action: perform-action
perform_action: amcrest.ptz_control
data:
entity_id: camera.lakehouse
movement: zoom_out

1
source/_integrations/androidtv_remote.markdown
View File

@ -569,3 +569,4 @@ cards:
- Some devices experience disconnects every 15 seconds. This is typically resolved by rebooting the Android TV device after the initial setup of the integration.
- If you are not able to connect to the Android TV device, or are asked to pair it again and again, try force-stopping the Android TV Remote Service and clearing its storage. On the Android TV device, go to **Settings** > **Apps** > **Show system apps**. Then, select **Android TV Remote Service** > **Storage** > **Clear storage**. You will have to pair again.
- Some onscreen keyboards enabled by TV manufacturers do not support concurrent virtual and onscreen keyboard use. This presents whenever a text field is selected, such as "search" where a constant **use the keyboard on your mobile device** will show, preventing you from opening the onscreen keyboard to type. This can be overcome by either disabling your 3rd party keyboard and using the default Gboard keyboard or by deselecting **Enable IME** in the **Configure** page of the integration.
- If you can't turn on your Nvidia Shield device, go to **Settings** > **Remotes & accessories** > **Simplified wake buttons** and disable the following options: **SHIELD 2019 Remote: Wake on power and Netflix buttons only** and **Controllers: Wake on NVIDIA or logo buttons only**.

52
source/_integrations/bang_olufsen.markdown
View File

@ -53,7 +53,7 @@ The **Bang & Olufsen** integration uses the [Mozart API](https://bang-olufsen.gi
## Supported features
Currently, a single device with a `media_player` entity is created for each added physical device. For advanced automations, [events](#automations) are fired in Home Assistant.
Currently, for each added physical device, a single device is created that includes a `media_player` entity and, if available, `event` entities.
### Media player
@ -71,6 +71,32 @@ A number of features are available through the media player entity:
- Connect to, expand to or unexpand devices.
- Set all connected Beolink devices to standby.
### Events
Event entities are created for each of the physical controls on your device. These controls usually have their own behaviors, so using them for automations is not always ideal.
Available event entities:
- Bluetooth
- Microphone
- Next
- Play / Pause
- Favourite 1
- Favourite 2
- Favourite 3
- Favourite 4
- Previous
- Volume
All of these event entities support the following event types:
- Release of short press
- Long press
- Release of long press
- Very long press
- Release of very long press
All devices except the [Beoconnect Core](https://www.bang-olufsen.com/en/dk/accessories/beoconnect-core) support device controls.
## Limitations
Currently, some features of the Mozart platform are not available through the [public API](https://github.com/bang-olufsen/mozart-open-api). Some may become available at a later point, but until then the [Bang & Olufsen App](https://www.bang-olufsen.com/en/dk/story/apps) can be used to configure these settings and features:
@ -484,30 +510,6 @@ target:
WebSocket notifications received from the device are fired as events in Home Assistant. These can be received by listening to `bang_olufsen_websocket_event` event types, where `device_id` or `serial_number` can be used to differentiate devices.
### Events
Event entities are created for each of the physical controls on your device. These controls usually have their own behaviors, so using them for automations is not always ideal.
Available event entities:
- Bluetooth
- Microphone
- Next
- Play / Pause
- Favourite 1
- Favourite 2
- Favourite 3
- Favourite 4
- Previous
- Volume
All of these event entities support the following event types:
- Release of short press
- Long press
- Release of long press
- Very long press
- Release of very long press
All devices except the [Beoconnect Core](https://www.bang-olufsen.com/en/dk/accessories/beoconnect-core) support device controls.
### Getting Deezer URIs
To find Deezer playlist, album URIs, and user IDs for Deezer flows, the Deezer website has to be accessed. When navigating to an album, the URL will look something like: <https://www.deezer.com/en/album/ALBUM_ID>, and this needs to be converted to: `album:ALBUM_ID` and the same applies to playlists, which have the format: `playlist:PLAYLIST_ID`.

4
source/_integrations/bluetooth.markdown
View File

@ -282,8 +282,8 @@ The following remote adapters are supported:
- Single active connection: ESPHome ESP32 device with firmware 2022.9.3 or later
- Multiple active connections: ESPHome ESP32 device with firmware 2022.11.0 or later
- [Shelly](/integrations/shelly/)
- Bluetooth advertisement listening: Shelly v2 device with firmware 12.0 or later
- Bluetooth advertisement bundling: Shelly v2 device with firmware 12.0 or later
- Bluetooth advertisement listening: Shelly Gen2+ device
- Bluetooth advertisement bundling: Shelly Gen2+ device
- Single active connection: not supported
- Multiple active connections: not supported

153
source/_integrations/bring.markdown
View File

@ -27,12 +27,43 @@ related:
title: Bring!
---
The **Bring!** integration allows you to interact with your [Bring!](https://www.getbring.com/) shopping lists within Home Assistant.
The **Bring!** integration allows you to sync your [Bring!](https://www.getbring.com/) shopping lists with Home Assistant.
For authentication, the integration requires the `email` and `password` you used for your Bring! account. If you want to automatically receive notifications via the Bring! app when Home Assistant adds or removes an item from the list, you should use a dedicated account (such as `email: your.name+ha@gmail.com`) to connect Home Assistant with [Bring!](https://www.getbring.com/).
## About Bring!
**Bring!** is a grocery shopping list app that allows users to create shared lists and organize grocery shopping with family, partners, or roommates.
Available as a mobile app on [Google Play for Android](https://play.google.com/store/apps/details?id=ch.publisheria.bring) and the [App Store for iOS](https://itunes.apple.com/app/apple-store/id580669177). **Bring!** also offers a web version at [web.getbring.com](https://web.getbring.com).
## How you can use this integration
- **Automated notifications:** Receive alerts on your phone when essential items are added to your list or when the quantity of items reaches a set value.
- **List updates based on events:** Automatically add items to your shopping list when appliances are low on supplies, like dishwasher salt, or need routine maintenance, such as tub cleaner for the washer.
- **Voice control:** Use voice assistants connected to Home Assistant to add items to your **Bring!** list.
- **Geofencing:** Receive reminders when you are near a specific store and need to pick up items, based on your location.
## Prerequisites
For authentication, the integration requires the `email` and `password` of your **Bring!** account. If you don’t have an account, you can sign up via the mobile app or the web version.
If you signed up using **Apple ID**, **Google Sign-in**, or **Facebook Login**, you will need to create a password to use the integration.
- On mobile: Open the Bring! app and go to **Profile** > **More settings** > **Change password**.
- On the web: Visit **Settings** > **Reset password** or go directly to [Reset Password](https://web.getbring.com/app/settings/resetpassword).
You can still log in with your existing authentication method afterward.
{% include integrations/config_flow.md %}
### Configuration parameters
{% configuration_basic %}
Email:
description: "The email address associated with your Bring! account."
Password:
description: "The password to log in to your Bring! account."
{% endconfiguration_basic %}
## Sensors
- **Urgent:** Shows the number of items tagged with the **Urgent** badge on the shopping list. Completed items are excluded.
@ -51,22 +82,36 @@ You can use the actions from the [to-do list](/integrations/todo/) to create, up
### Notifications
The **Bring** integration offers an action to send push notifications to the Bring! mobile apps of other members of a shared shopping list. The Bring! mobile app has 4 predefined notification types. Note: If you want to receive these notifications yourself, you need to use a dedicated account as mentioned above.
The **Bring!** integration offers an action to send push notifications to the Bring! mobile apps of other members of a shared shopping list. The Bring! mobile app has 4 predefined notification types.
{% note %}
If you want to receive these notifications, you must use a dedicated account, as outlined in the [known limitations](#known-limitations).
{% endnote %}
| Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `target` | no | Target Bring! list(s) whose members should be notified. |
| `message` | no | Type of push notification to send to list members. See [Notification types](#available-notification-types). |
| `item` | yes | Required for `urgent_message`. Item to include in the message. For example: *Attention! Attention! - We still urgently need: Cilantro*. |
| Data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `target` | no | Target Bring! list(s) whose members should be notified. |
| `message` | no | Type of push notification to send to list members. See [Notification types](#available-notification-types). |
| `item` | yes | **Required for `urgent_message`.** Article name to include in the message. For example: *Urgent Message - Please buy cilantro urgently*. |
### Available notification types
| Notification type | Text of notification |
| ----------------- | --------------------------------------------------- |
| going_shopping | I'm going shopping! - Last chance to make changes |
| changed_list | List updated - Take a look at the articles |
| shopping_done | Shopping done - The fridge is well stocked |
| urgent_message | Urgent Message - Please buy `Article name` urgently |
| Notification type | Name of notification |
| ----------------- | -------------------------------------------------------------- |
| going_shopping | I'm going shopping! - Last chance for adjustments |
| changed_list | I changed the list! - Take a look at the items |
| shopping_done | The shopping is done! - The fridge is well stocked |
| urgent_message | Attention! Attention! - We still urgently need: `[Items]` |
{% note %}
The notification that list members receive differs from the label shown in the Bring! app. This variation depends not only on the recipient’s language settings but also on the sender's profile name. Additionally, notifications may change with new app updates. Here are some example notifications:
- `name` is going shopping for "`shopping list name`"! Last chance to make changes
- `name` went shopping for "`shopping list name`"! The fridge is well stocked
- `name` updated the list "`shopping list name`"! Take a look at the articles
- Attention, something's missing! Please buy `item` urgently
{% endnote %}
### Sending a going shopping notification
@ -94,3 +139,83 @@ actions:
message: urgent_message
item: Cilantro
```
## Automations
Get started with these automation examples for **Bring!**, each featuring ready-to-use blueprints!
### Grocery shopping reminder 🛒
Get notified when it's time to go grocery shopping. A notification is sent when your shopping list reaches a set threshold or when urgent items are added.
{% my blueprint_import badge blueprint_url="https://community.home-assistant.io/t/bring-grocery-shopping-reminder/843123" %}
{% details "Example YAML configuration" %}
{% raw %}
```yaml
triggers:
- trigger: numeric_state
entity_id: todo.shopping_list
above: 10
id: shopping list too long
- trigger: numeric_state
entity_id: sensor.shopping_list_urgent
above: 0
id: shopping is urgent
actions:
- choose:
- conditions:
- condition: trigger
id: shopping list too long
sequence:
- action:
- action: notify.notify
data:
message: >-
The list is getting long, plan a trip to the grocery shop in
the next days
title: Shopping needed soon 🛒
- conditions:
- condition: trigger
id: shopping is urgent
sequence:
- action:
- action: notify.notify
data:
title: 🚨 Time to go shopping! 🛒
message: Urgent groceries needed! Grab your shopping bag and go!
- delay:
hours: 1
mode: single
alias: "Bring!: Grocery shopping reminder 🛒"
description: "Get notified when it's time to go grocery shopping. A notification is sent when your shopping list reaches a set threshold or when urgent items are added."
```
{% endraw %}
{% enddetails %}
## Data updates
This integration syncs your lists by {% term polling %} the **Bring!** service every 90 seconds or immediately after an action is performed in Home Assistant, such as adding an item. If you prefer a less frequent update, **custom polling interval** can also be defined — see [Defining a custom polling interval](/common-tasks/general/#defining-a-custom-polling-interval) for details.
## Known limitations
- Changes made in Home Assistant are reflected instantly in the **Bring!** app, while changes in the Bring! app may be delayed by up to 90 seconds due to the polling interval.
- To receive push notifications in the **Bring!** app when items are added or removed in Home Assistant, or when triggered by the `bring.send_message` action, it is recommended to use a dedicated account (such as `email:name+ha@example.com`) when setting up the integration.
## Troubleshooting
The **Bring!** integration relies on an active internet connection to communicate with Bring!. If you encounter issues, verify that your network connection is stable. Additionally, the Bring! service itself may experience downtime, whether unexpected or due to scheduled maintenance.
- A **502 - Bad Gateway** error (`aiohttp.client_exceptions.ClientResponseError: 502, message='Bad Gateway'`) is known to occur occasionally (1–2 times per day) but is usually temporary. The integration will retry automatically after 90 seconds, so there’s no need to take action.
In any case, when reporting an issue, please enable [debug logging](/docs/configuration/troubleshooting/#debug-logs-and-diagnostics), restart the integration, and as soon as the issue reoccurs, stop the debug logging again (*download of debug log file will start automatically_). Further, if still possible, please also download the [diagnostics](/integrations/diagnostics) data. If you have collected the debug log and the diagnostics data, provide them with the issue report.
## Remove integration
This integration can be removed by following these steps:
{% include integrations/remove_device_service.md %}

2
source/_integrations/denonavr.markdown
View File

@ -45,6 +45,7 @@ Known supported devices:
- Denon AVR-X3500H
- Denon AVR-X3600H
- Denon AVR-X3700H
- Denon AVR-X3800H
- Denon AVC-X3800H
- Denon AVR-X4100W
- Denon AVR-X4300H
@ -64,6 +65,7 @@ Known supported devices:
- Denon AVR-3312
- Denon AVR-3313CI
- Denon AVR-4810
- Denon AVR-E300
- Denon AVR-S650H
- Denon AVC-S660H
- Denon AVR-S710W

50
source/_integrations/electric_kiwi.markdown
View File

@ -24,3 +24,53 @@ This integration uses the official [Electric Kiwi API](https://developer.electri
{% note %}
The configuration uses `client_id` and `client_secret` provided to Home Assistant, so all you need to do is install the integration and authenticate using your account credentials.
{% endnote %}
## Supported functionality
The integration provides `sensor` entities with account balances, billing, and hour of free power start and end time. It also provides a `select` entity to change the hour of free power.
## Use cases
This integration can be used as part of an automation, for example, to turn on/off appliances automatically.
## Example automations
{% details "Run the heat pump during the hour of free power" %}
{% raw %}
```yaml
alias: "Turn on expensive heat pump"
description: "Turn on the heat pump when the hour of free power starts"
triggers:
- at: sensor.hour_of_free_power_start
trigger: time
actions:
- action: climate.turn_on
target:
entity_id: climate.heat_pump
data: {}
```
```yaml
alias: "Turn off expensive heat pump"
description: "Turn off the heat pump when the hour of free power ends"
triggers:
- at: sensor.hour_of_free_power_end
trigger: time
actions:
- action: climate.turn_off
target:
entity_id: climate.heat_pump
data: {}
```
{% endraw %}
{% enddetails %}
## Remove integration
This integration follows standard integration removal, no extra steps are required.
{% include integrations/remove_device_service.md %}

21
source/_integrations/flexit_bacnet.markdown
View File

@ -24,6 +24,8 @@ Integrates [Flexit](https://www.flexit.no/en/) Nordic series air handling unit i
## Prerequisites
Your Flexit device should be equipped with an ethernet port, and no additional modules should be required. This integration communicates with the BACnet protocol over Ethernet.
To configure the integration, you need to obtain the IP address and Device ID for the unit.
1. Open the Flexit Go app on your mobile.
@ -33,6 +35,15 @@ To configure the integration, you need to obtain the IP address and Device ID fo
5. Go to **More** > **Installer** > **Communication** > **BACnet settings**.
6. Note down the **IP address** and **Device ID**.
{% include integrations/config_flow.md %}
{% configuration_basic %}
IP address:
description: "The IP address of your Flexit Nordic device."
Device ID:
description: "The Device ID of your Flexit Nordic device. This is usually 2."
{% endconfiguration_basic %}
## Platforms
This integration supports the following platforms.
@ -96,4 +107,12 @@ If you need to shut down the unit, make sure to take all necessary precautions,
Furthermore, Flexit recommends unplugging the unit from the power socket before replacing a filter. To prevent damage, always initiate a controlled shutdown from the control panel (or, in the future, from an action in Home Assistant) before unplugging the device.
{% include integrations/config_flow.md %}
## Data updates
The integration {% term polling polls %} data from the Flexit device every 60 seconds by default. This interval is not configurable.
## Removing the integration
This integration follows standard integration removal. No extra steps are required.
{% include integrations/remove_device_service.md %}

101
source/_integrations/flick_electric.markdown
View File

@ -18,10 +18,107 @@ ha_integration_type: service
{% include integrations/config_flow.md %}
{% configuration_basic %}
Username:
description: "Username used to log into Flick Electric."
Password:
description: "Password used to log into Flick Electric."
Client ID:
description: "Client ID to authenticate (see below note)."
Client Secret:
description: "Client Secret to authenticate (see below note)."
Account:
description: "Address of the account to add (required when user has multiple active accounts)."
{% endconfiguration_basic %}
{% note %}
The configuration uses the client ID and secret used by the app at the time of release. If this stops working, you can find the new ones by using a MITM proxy with the mobile app. The app will call `https://api.flick.energy/identity/oauth/token` with the `client_id` and `client_secret`.
For most users, Client ID/Secret can be left blank.
You can then use these values during the configuration.
Home Assistant by default uses the client ID and secret from the Flick Electric mobile app at the time of release.
If this stops working, you can find the new ones by using a MITM proxy with the mobile app. The app will call `https://api.flick.energy/identity/oauth/token` with the `client_id` and `client_secret`.
{% endnote %}
## Supported functionality
The integration provides a `sensor` entity with the power price for the current time interval.
The attributes of the entity have a breakdown of the pricing components, such as `generation` and `network` charges.
{% note %}
The power price shown is in cents, and is *excluding <abbr title="goods and services tax">GST</abbr>*. You can customize this by creating a template sensor:
1. Go to
{% my helpers title="**Settings** > **Devices** & **Services** > **Helpers**" %} and click the add button;
2. Choose the **{% my config_flow_start domain="template" title="Template" %}** option
3. Select **Add a template sensor**.
{% raw %}
To add GST:
- **State template**: `{{ states.sensor.flick_power_price * 1.15 }}`
- **Unit of measurement**: `¢/kWh`
To convert to dollars:
- **State template**: `{{ states.sensor.flick_power_price / 100 }}`
- **Unit of measurement**: `$/kWh`
{% endraw %}
{% endnote %}
## Use cases
This integration can be used as part of an automation, for example to turn on/off appliances automatically.
## Example automations
{% details "Turn off the heat pump when price is above 40¢/kWH" %}
{% raw %}
```yaml
alias: "Turn off expensive heat pump"
description: "Turn off the heat pump when price is above 40¢/kWH"
triggers:
- trigger: numeric_state
entity_id: sensor.flick_power_price
above: 40
actions:
- action: climate.turn_off
target:
entity_id: climate.heat_pump
data: {}
```
{% endraw %}
{% enddetails %}
## Data updates
The integration will {% term polling poll %} the Flick Electric API every 5 minutes to check for the current power price. You can also use the `homeassistant.update_entity` action to trigger a refresh on-demand.
## Remove integration
This integration follows standard integration removal, no extra steps are required.
{% include integrations/remove_device_service.md %}
## Troubleshooting
{% details "Cannot get pricing for this account. Please check user permissions" %}
API is unable to find pricing for the selected account. Check with Flick Electric to ensure that your user is configured correctly.
{% enddetails %}
{% details "No services are active on this Flick account" %}
Only active accounts are supported by this integration. If your account is active but is not able to be selected, check with Flick Electric to ensure that it is showing as active in their system.
{% enddetails %}

56
source/_integrations/foscam.markdown
View File

@ -73,10 +73,11 @@ elements:
right: 25px
bottom: 50px
tap_action:
action: call-service
action: foscam.ptz
data:
action: perform-action
perform_action: foscam.ptz
target:
entity_id: camera.bedroom
data:
movement: up
- type: icon
icon: "mdi:arrow-down"
@ -85,10 +86,11 @@ elements:
right: 25px
bottom: 0px
tap_action:
action: call-service
action: foscam.ptz
data:
action: perform-action
perform_action: foscam.ptz
target:
entity_id: camera.bedroom
data:
movement: down
- type: icon
icon: "mdi:arrow-left"
@ -97,10 +99,11 @@ elements:
right: 50px
bottom: 25px
tap_action:
action: call-service
action: foscam.ptz
data:
action: perform-action
perform_action: foscam.ptz
target:
entity_id: camera.bedroom
data:
movement: left
- type: icon
icon: "mdi:arrow-right"
@ -109,10 +112,11 @@ elements:
right: 0px
bottom: 25px
tap_action:
action: call-service
action: foscam.ptz
data:
action: perform-action
perform_action: foscam.ptz
target:
entity_id: camera.bedroom
data:
movement: right
- type: icon
icon: "mdi:arrow-top-left"
@ -121,10 +125,11 @@ elements:
right: 50px
bottom: 50px
tap_action:
action: call-service
action: foscam.ptz
data:
action: perform-action
perform_action: foscam.ptz
target:
entity_id: camera.bedroom
data:
movement: top_left
- type: icon
icon: "mdi:arrow-top-right"
@ -133,10 +138,11 @@ elements:
right: 0px
bottom: 50px
tap_action:
action: call-service
action: foscam.ptz
data:
action: perform-action
perform_action: foscam.ptz
target:
entity_id: camera.bedroom
data:
movement: top_right
- type: icon
icon: "mdi:arrow-bottom-left"
@ -145,10 +151,11 @@ elements:
right: 50px
bottom: 0px
tap_action:
action: call-service
action: foscam.ptz
data:
action: perform-action
perform_action: foscam.ptz
target:
entity_id: camera.bedroom
data:
movement: bottom_left
- type: icon
icon: "mdi:arrow-bottom-right"
@ -157,10 +164,11 @@ elements:
right: 0px
bottom: 0px
tap_action:
action: call-service
action: foscam.ptz
data:
action: perform-action
perform_action: foscam.ptz
target:
entity_id: camera.bedroom
data:
movement: bottom_right
```

6
source/_integrations/generic.markdown
View File

@ -59,11 +59,11 @@ Use wallclock as timestamps:
In this section, you find some real-life examples of how to use this camera platform.
### Weather graph from yr.no
### Weather graph from USA National Weather Service
- Still Image URL: `https://www.yr.no/en/content/1-72837/meteogram.svg`
You can display a GIF from the web as a still image.
Instructions on how to locate the SVG for your location are available at [developer.yr.no](https://developer.yr.no/doc/guides/available-widgets/)
- Still Image URL: `https://radar.weather.gov/ridge/standard/CONUS_0.gif`
### Local image

60
source/_integrations/google_assistant.markdown
View File

@ -63,7 +63,7 @@ To use Google Assistant, your Home Assistant configuration has to be [externally
- You do not need to test.
2. In the left hand menu of your project, select the **Analytics** link.
- Select the hamburger {% icon "mdi:hamburger-menu" %} menu and select **APIs and Services**.
- Select the hamburger {% icon "mdi:hamburger-menu" %} menu on the top left and select **APIs and Services**.
3. Enable device sync ([see below for more information](#enable-device-sync)).
1. In the left hand menu, select **Credentials**.
2. In the **Credentials** view, select **Create credentials** and next **Service account**.
@ -78,15 +78,14 @@ To use Google Assistant, your Home Assistant configuration has to be [externally
7. This will start a download of a JSON file.
1. Rename the file to `SERVICE_ACCOUNT.JSON`.
2. In Home Assistant, add this file to your config-folder. This will be the same folder as your {% term "`configuration.yaml`" %}.
8. Go back to [Google Cloud Platform](https://console.cloud.google.com/) and select **Close**.
9. Then select **Save**.
10. Go to the **Search products and resources** and search for **Homegraph API** and select it.
11. Enable the HomeGraph API.
8. Go to the **Search (/) for resources, documentation, products, and more** at the top middle and search for **Homegraph API** and select it.
9. Enable the HomeGraph API.
4. Add the `google_assistant` integration configuration to your {% term "`configuration.yaml`" %} file and restart Home Assistant following the [configuration guide](#yaml-configuration) below.
5. Add services in the Google Home App (note that app versions may be slightly different).
1. Open the Google Home app.
2. Select the `+` button on the top left corner, select **Set up device**. In the **Set up a device** screen, select **Works with Google**. You should have `[test] <Action Name>` listed under **Add new**. Selecting that should lead you to a browser to login your Home Assistant instance, then redirect back to a screen where you can set rooms and nicknames for your devices if you wish.
2. Select the Devices tab at the bottom and select the `+ Add` button on the bottom right corner.
3. In the **Choose a device** screen, select **Works with Google Home**. You should have `[test] <Action Name>` listed under **Add new**. Selecting that should lead you to a browser to log in to your Home Assistant instance, then redirect back to a screen where you can set rooms and nicknames for your devices if you wish.
{% important %}
If you've added Home Assistant to your phone's home screen, you have to first remove it from the home screen. Otherwise, this HTML5 app will show up instead of a browser. Using it would prevent Home Assistant redirecting back to the Google Home app.
@ -96,22 +95,19 @@ If you've added Home Assistant to your phone's home screen, you have to first re
If you want to allow other household users to control the devices:
1. Open the project you created in the [Actions on Google console](https://console.actions.google.com/).
2. Select **Test** on the top of the page, then select **Simulator** located to the page left, then click the three little dots (more) icon in the upper right corner of the console.
3. Select **Manage user access**. This redirects you to the Google Cloud Platform IAM permissions page.
4. Select **Grant access** at the top of the page.
1. Open the project you created in the [Google Developer Console](https://console.home.google.com/projects).
2. Select **Members** on the top of the page. This redirects you to the Google Cloud Platform IAM permissions page.
3. Select **Grant access** at the middle of the page.
1. Enter the email address of the user you want to add.
2. Select **Select a role** and choose **Project** > **Viewer**.
3. Select **Save**.
4. Copy and share the Actions project link (`https://console.actions.google.com/project/YOUR_PROJECT_ID/simulator`) with the new user.
5. Have the new user open the link with their own Google account, agree to the **Terms of Service** popup. Then select **Start Testing**, select **Version - Draft** in the dropdown, and select **Done**.
6. Have the new user go to their **Google Assistant** app to add `[test] your app name` to their account.
4. Copy and share the project link (`https://console.home.google.com/projects/YOUR_PROJECT_ID`) with the new user.
4. Have the new user open the link with their own Google account, agree to the **Terms of Service** popup(s).
5. Have the new user go to their **Google Assistant** app to add `[test] your app name` to their account.
### Enable device sync
### Utilize device sync
If you want to support active reporting of state to Google's server (configuration option `report_state`) and synchronize Home Assistant devices with the Google Home app (`google_assistant.request_sync` service), you will need to create a service account. It is recommended to set up this configuration key as it also allows the usage of the following command, "Ok Google, sync my devices". Once you have set up this component, you will need to call this service (or command) each time you add a new device in Home Assistant that you wish to control via the Google Assistant integration. This allows you to update devices without unlinking and relinking an account (see [below](#troubleshooting)).
The service account is created by following Step 4 (Enable device sync) in the previous section [Google Cloud Platform configuration](#google-cloud-platform-configuration).
You are now able to support active reporting of state to Google's server (configuration option `report_state`) and synchronize Home Assistant devices with the Google Home app (`google_assistant.request_sync` service).
Try it with "OK Google, sync my devices" - the Google Home app should import your exposed Home Assistant devices and prompt you to assign them to rooms.
@ -135,24 +131,24 @@ This is because the Google Assistant device will connect directly to the IP of y
For secure remote access, use a reverse proxy such as the {% my supervisor_addon addon="core_nginx_proxy" title="NGINX SSL" %} add-on instead of directing external traffic straight to Home Assistant.
{% endimportant %}
1. Open the project you created in the [Actions on Google console](https://console.actions.google.com/).
2. Select **Develop** on the top of the page, then select **Actions** located in the hamburger menu on the top left.
3. Upload Javascript files
1. Open the project you created in the [Google Developer Console](https://console.home.google.com/projects).
2. Expand the **Cloud-to-cloud** menu on the left and select **Develop**, then select **Edit** next to your integration.
3. Scroll down and enable **Local fulfillment**
4. Upload Javascript files
1. Download `app.js` from [here](https://github.com/NabuCasa/home-assistant-google-assistant-local-sdk/releases/latest)
2. Select the **Upload JavaScript files** button.
3. Select **Upload your JavaScript targeting Node** and upload the `app.js` from step 3.1.
4. Select **Upload your JavaScript targeting Chrome (browser)** and upload the `app.js` from step 3.1.
4. Check the box **Support local query** under **Add capabilities**.
5. Add device scan configuration:
1. Select **+ New scan config** if no configuration exists.
2. Select **MDNS**.
3. Set **MDNS service name** to `_home-assistant._tcp.local`
2. Select **Upload your JavaScript targeting Node** and upload the `app.js` from step 4.1.
3. Select **Upload your JavaScript targeting Chrome (browser)** and upload the same `app.js` from step 4.1.
5. Check the box **Support local queries**.
6. Add device scan configuration:
1. Select **+ Add scan configuration** if no configuration exists.
2. For Discovery protocol select **mDNS**.
3. Set **Enter mDNS service name** to `_home-assistant._tcp.local`
4. Select **Add field**, then under **Select a field**, choose **Name**.
5. Enter a new **Value** field set to `.*\._home-assistant\._tcp\.local`
6. Save your changes.
7. Either wait for 30 minutes, or restart all your Google Assistant devices.
8. Restart Home Assistant Core.
9. With a Google Assistant device, try saying "OK Google, sync my devices." This can be helpful to avoid issues, especially if you are enabling local fulfillment sometime after adding cloud Google Assistant support.
7. Scroll to bottom of page and **Save** your changes.
8. Either wait for 30 minutes, or restart all your Google Assistant devices.
9. Restart Home Assistant Core.
10. With a Google Assistant device, try saying "OK Google, sync my devices." This can be helpful to avoid issues, especially if you are enabling local fulfillment sometime after adding cloud Google Assistant support.
You can debug the setup by following [these instructions](https://developers.home.google.com/local-home/test#debugging_from_chrome).

15
source/_integrations/google_generative_ai_conversation.markdown
View File

@ -34,7 +34,7 @@ This integration requires an API key to use, [which you can generate here](https
{% include integrations/config_flow.md %}
### Generate an API Key
## Generate an API Key
The Google Generative AI API key is used to authenticate requests to the Google Generative AI API. To generate an API key take the following steps:
@ -130,8 +130,19 @@ response_variable: generated_content
{% endraw %}
### Video tutorial
## Video tutorial
This video tutorial explains how Google Generative AI can be set up, how you can send an AI-generated message to your smart speaker when you arrive home, and how you can analyze an image taken from your doorbell camera as soon as someone rings the doorbell.
<lite-youtube videoid="ivoYNd2vMR0" videotitle="AI in Home Assistant - A Complete Guide!" posterquality="maxresdefault"></lite-youtube>
## Troubleshooting
- To aid in diagnosing issues it may help to turn up verbose logging by adding these to your {% term "`configuration.yaml`" %}:
```yaml
logger:
logs:
homeassistant.components.conversation: debug
homeassistant.components.google_generative_ai_conversation: debug
```

2
source/_integrations/govee_ble.markdown
View File

@ -31,7 +31,7 @@ The Govee BLE integration will automatically discover devices once the [Bluetoot
- H5052 Hygrometer Thermometer
- H5071 Hygrometer Thermometer
- H5072 Hygrometer Thermometer
- H5074 Hygrometer Thermometer
- H5074 Hygrometer Thermometer (Active scans required)
- [H5075 Bluetooth Hygrometer Thermometer](https://us.govee.com/collections/thermo-hydrometer/products/govee-bluetooth-hygrometer-thermometer-h5075)
- [H5100 Hygrometer Thermometer](https://us.govee.com/collections/thermo-hydrometer/products/govee-h5100-mini-hygrometer-thermometer-sensors)
- H5101 Hygrometer Thermometer

5
source/_integrations/group.markdown
View File

@ -53,6 +53,9 @@ The following entities can be grouped:
- [event (events)](/integrations/event/)
- [media player (media players)](/integrations/media_player/)
- [notify (notifications)](/integrations/notify/)
- [sensor (sensors)](/integrations/sensor/)
- [number (numbers)](/integrations/number/)
- [input_number (input_numbers)](/integrations/input_number/)
{% include integrations/config_flow.md %}
@ -136,7 +139,7 @@ In short, when any group member entity is `unlocked`, the group will also be `un
- Otherwise, the group state is `on` if at least one group member is not `off`, `unavailable` or `unknown`.
- Otherwise, the group state is `off`.
### Sensor groups
### Sensor, number, and input_number groups
- The group state is combined / calculated based on `type` selected to determine the minimum, maximum, latest (last), mean, median, range, product, standard deviation, or sum of the collected states.
- Members can be any `sensor`, `number` or `input_number` holding numeric states.

4
source/_integrations/gstreamer.markdown
View File

@ -43,7 +43,7 @@ Only the `music` media type is supported.
And then install the following system dependencies:
Debian/Ubuntu/Rasbian:
Debian/Ubuntu/Raspberry Pi OS (formerly Raspbian):
```bash
sudo apt-get install python3-gst-1.0 \
@ -52,7 +52,7 @@ sudo apt-get install python3-gst-1.0 \
gstreamer1.0-tools
```
Red Hat/Centos/Fedora:
Red Hat/CentOS/Fedora:
```bash
sudo yum install -y python-gstreamer1 gstreamer1-plugins-good \

2
source/_integrations/history.markdown
View File

@ -44,7 +44,7 @@ You can access the **History** panel from the side bar. To export the data, foll
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 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. The detailed data will be shown with a darker line on graphs.
<img class="no-shadow" src='/images/integrations/history/history-panel_including-long-term-storage.png' alt='If the chosen time frame exceeds the retention period defined in the recorder, the long term statistics table is used as a data source.'>

8
source/_integrations/home_connect.markdown
View File

@ -103,6 +103,14 @@ Internal examples: `http://192.168.0.2:8123/auth/external/callback`, `http://hom
The integration configuration will ask for the *Client ID* and *Client Secret* created above. See [Application Credentials](/integrations/application_credentials) for more details.
## Removing the integration
This integration follows standard integration removal. No extra steps are required.
{% include integrations/remove_device_service.md %}
After deleting the integration, go to [your applications at the Home Connect Developer portal](https://developer.home-connect.com/applications), find the application that you were using for Home Assistant, click on details and click on "Delete Application".
## Actions
The Home Connect integration makes various actions available.

2
source/_integrations/html5.markdown
View File

@ -29,7 +29,7 @@ The `html5` platform can only function if all of the following requirements are
- You are using Chrome and/or Firefox on any desktop platform, ChromeOS or Android. Or you added your Home Assistant instance to your home screen on iOS 16.4 or higher.
- Your Home Assistant instance is accessible from outside your network over HTTPS or can perform an alternative [Domain Name Verification Method](https://support.google.com/webmasters/answer/9008080#domain_name_verification) on the domain used by Home Assistant.
- If using a proxy, HTTP basic authentication must be off for registering or unregistering for push notifications. It can be re-enabled afterwards.
- If using a proxy, HTTP basic authentication must be disabled to register or deregister push notifications. It can be re-enabled afterwards.
- If you don't run Hass.io: `pywebpush` must be installed. `libffi-dev`, `libpython-dev` and `libssl-dev` must be installed prior to `pywebpush` (i.e., `pywebpush` probably won't automatically install).
- You have configured SSL/TLS for your Home Assistant. It doesn't need to be configured in Home Assistant though, e.g., you can be running NGINX in front of Home Assistant and this will still work. The certificate must be trustworthy (i.e., not self-signed).
- You are willing to accept the notification permission in your browser.

2
source/_integrations/hue.markdown
View File

@ -64,7 +64,7 @@ You can use this action for example if you'd like to start/stop Dynamic Mode.
## Hue remotes and switches
Hue remotes such as the Dimmer Switch are stateless devices, meaning that they do not have a on/off state like regular entities in Home Assistant. Instead, such devices emit the event `hue_event` when a button is pressed. You can test what events come in using the event {% my developer_events title="developer tools in Home Assistant" %} and subscribe to the `hue_event`. Once you know what the event data looks like, you can use this to create automations.
Hue remotes such as the Dimmer Switch are stateless devices, meaning that they do not have an on/off state like regular entities in Home Assistant. Instead, such devices emit the event `hue_event` when a button is pressed. You can test what events come in using the event {% my developer_events title="developer tools in Home Assistant" %} and subscribe to the `hue_event`. Once you know what the event data looks like, you can use this to create automations.
{% note %}
At the time of writing, there's a limitation on the Hue API that each device can only send one event per second. This means that button events are rate-limited to 1 per second. This is brought to the attention of Signify and it will hopefully be fixed soon.

4
source/_integrations/influxdb.markdown
View File

@ -64,7 +64,7 @@ port:
default: 8086
path:
type: string
description: Path to use if your InfuxDB is running behind a reverse proxy.
description: Path to use if your InfluxDB is running behind a reverse proxy.
required: false
username:
type: string
@ -369,7 +369,7 @@ port:
default: 8086
path:
type: string
description: Path to use if your InfuxDB is running behind a reverse proxy.
description: Path to use if your InfluxDB is running behind a reverse proxy.
required: false
username:
type: string

2
source/_integrations/integration.markdown
View File

@ -18,7 +18,7 @@ ha_platforms:
ha_integration_type: helper
---
This integrations provides the [Riemann sum](https://en.wikipedia.org/wiki/Riemann_sum)
This integration provides the [Riemann sum](https://en.wikipedia.org/wiki/Riemann_sum)
of the values provided by a source sensor. The Riemann sum is an approximation
of an **integral** by a finite sum.

2
source/_integrations/intent_script.markdown
View File

@ -105,7 +105,7 @@ available in the `action_response` variable.
conversation:
intents:
EventCountToday:
- "How many meetings do I have today?"
- "How many meetings do I have today"
intent_script:
EventCountToday:

4
source/_integrations/islamic_prayer_times.markdown
View File

@ -52,7 +52,7 @@ sensors:
## Configuration
### Prayer calcuation method
### Prayer calculation method
Default: Islamic Society of North America
@ -72,4 +72,4 @@ Default: Standard (mid sunset to sunrise)
Default: Shafi
Method for adjusting Asr time calcuation, if not specified, it defaults to Shafi.
Method for adjusting Asr time calculation, if not specified, it defaults to Shafi.

2
source/_integrations/light.mqtt.markdown
View File

@ -1237,7 +1237,7 @@ mqtt:
{% endraw %}
### CCT light (brightnes and temperature)
### CCT light (brightness and temperature)
This example comes from a configuration of Shelly RGBW Bulb working in White mode.
`max_mireds` and `min_mireds` set color temperature boundaries to 3000K - 6500K. Notice the same limits are applied in `command_on_template`, but in kelvin units this time. It's due to conversion from mired to kelvin which causes exceeding boundary values accepted by the device.

133
source/_integrations/matter.markdown
View File

@ -144,12 +144,12 @@ Make sure you have all these components ready before trying to add a Matter devi
#### Prepare Android or iPhone
- Have either an Android or iPhone ready and Bluetooth enabled. For information why Bluetooth is required, refer to the section on [Bluetooth used during commissioning](#bluetooth-used-during-commissioning):
- Android:
- Have the Android version 8.1 or higher.
- **Android**:
- At a minimum, have Android version 8.1. Recommended is version 12 or higher.
- Have the latest version of the Home Assistant Companion app, installed from the Play Store (full version).
- If you are using {% term Thread %}: Make sure there is a Thread border router device (Nest Hub (2nd Gen) or Nest Wi-Fi Pro or Home Assistant with the OpenThread Border Router add-on) present in your home network.
- If you are using OpenThread (for Connect ZBT-1/SkyConnect) as border router, make sure you followed the steps in the [Thread documentation](/integrations/thread#turning-home-assistant-into-a-thread-border-router).
- iPhone
- **iPhone**
- Have the iOS version 16 or higher
- Have the latest version of the Home Assistant Companion app installed.
- If you are using {% term Thread %}: Make sure there is a Thread border router device (HomePod Mini or V2, Apple TV 4K or Home Assistant with the OpenThread Border Router add-on) present in your home network.
@ -211,16 +211,34 @@ Check these steps if you are experiencing issues when trying to add a Matter dev
#### Symptom
While trying to add the Matter device, I get an error stating that *Matter is currently unavailable*.
While trying to add the Matter device, I get an error stating that _Matter is currently unavailable_.
#### Remedy
This could mean that not all required Matter modules that are needed by the Home Assistant Companion App have been downloaded yet. Try the following steps:
1. Wait up to 24 hours for the Google Play services to download the necessary Matter modules.
2. If this did not work, try reinstalling the Home Assistant Companion app.
3. If this did not work, try installing the Google Home app. Technically this is not required, but it might trigger another installation attempt of the Matter modules.
4. Refer to this [Troubleshooting Guide from Google](https://developers.home.google.com/matter/verify-services).
1. Wait up to 24 hours for the Google Play Services to download the necessary Matter modules.
2. Make sure the requirements listed in the [prerequisites](#prerequisites) are met. This includes meeting the minimum system requirements:
- **Android**:
- Minimum version is 8.1. Recommended is version 12 or higher.
- More issues have been reported by people using older Android versions.
- Use a regular, Google-account Android setup. No alternative Android versions.
- Make sure the Google Play Services are all up to date.
- **iPhone**:
- Have the iOS version 16 or higher
3. Home Assistant Companion app:
- Make sure you installed the (full) version, downloaded from the Play Store.
- Make sure it is the latest version.
- If you only just installed or updated the Home Assistant Companion app:
- Wait.
- It can take a while before the required components are installed in the background.
- Try again after 1 hour to ensure the installation is complete.
4. Verify your device meets all requirements to support Matter:
- On your Android device, go to **Settings** > **Google** > **Devices & Sharing**.
- There should be an entry there for **Matter devices**.
5. Reinstalling the Home Assistant Companion app.
6. Try (re-)installing the Google Home app. Technically, this is not required, but it might trigger another installation attempt of the Matter modules.
7. Refer to this [Troubleshooting Guide from Google](https://developers.home.google.com/matter/verify-services).
## Sharing a device from another platform with Home Assistant
@ -381,22 +399,101 @@ NOTE for Android users: You need to follow the instructions at the bottom of the
- For more detailed information on network configuration, refer to the [README of the Matter server repository](https://github.com/home-assistant-libs/python-matter-server/blob/main/README.md).
### I do not see the button "Commission using the Companion app"
### I do not see the button _Commission using the Companion app_
This button will only be visible within the Home Assistant Companion App (so not in the browser) and your device meets all requirements for Matter support.
The **Commission using the Companion app** button only exists in the Home Assistant Companion App. It is not available in the browser.
- For iOS, minimum version is iOS 16 (minimal 16.3 is preferred) and the most recent version of the HA companion app.
- For Android, minimum version is 8.1 and the most recent version of the (full) HA Companion app, downloaded from the Play Store.
#### Remedy
### When I'm trying to commission using the Android app, I get an error stating "Matter is currently unavailable"
If you don't see the button in the Companion app:
See above, make sure your device meets all requirements to support Matter. Update Android to the latest version and the Home Assistant Companion app. To quickly verify if your device meets all requirements to support Matter, on your Android device, go to **Settings** > **Google** > **Devices & Sharing**. There should be an entry there for **Matter devices**.
1. Make sure the requirements listed in the [prerequisites](#prerequisites) are met.
2. This includes meeting the minimum system requirements:
Some users have reported that uninstalling and reinstalling the Google Home app fixed this issue for them.
Also see this [extended troubleshooting guide](https://developers.home.google.com/matter/verify-services) from Google.
- **Android**:
- Minimum version is 8.1. Recommended is version 12 or higher.
- More issues have been reported by people using older Android versions.
- Use a regular, Google-account Android setup. No alternative Android versions.
- Make sure the Google Play Services are all up to date.
- **iPhone**:
- Have the iOS version 16 or higher
### When trying to commission using Android, I get an error "Matter is unavailable"
Refer to the steps under [Troubleshooting the installation](#troubleshooting-the-installation).
### Android: stuck at "Checking network connectivity"
#### Symptom
You are trying to {% term commissioning commission %} a Matter device using an Android phone. During that process, you see the "Checking network connectivity" message and never get past that.
#### Remedy
1. Make sure the requirements listed in the [prerequisites](#prerequisites) are met.
2. This includes meeting the minimum system requirements for **Android**:
- Minimum version is 8.1. Recommended is version 12 or higher.
- More issues have been reported by people using older Android versions.
- Use a regular, Google-account Android setup. No alternative Android versions.
- Make sure the Google Play Services are all up to date.
3. If you are adding a {% term Thread %}-based Matter device, make sure the phone is in close range of the border router and your device.
4. If you are adding a Wi-Fi-based Matter device:
- Matter devices often use the 2.4&nbsp;GHz frequency for Wi-Fi.
- Make sure your phone is in the same 2.4&nbsp;GHz network where you want to operate your devices.
### Error "this device requires a border router"
#### Symptom
While trying to add a Matter device with your Home Assistant Companion app, you get the error "this device requires a border router".
#### Cause
To add a Matter device which is based on the {% term Thread %} radio protocol, you need a {% term "Thread border router" %} near the device and your phone needs to know the credentials of your (newly created) Thread network.
#### Remedy
Set up a {% term "Thread border router" %} and synchronize the credentials from Home Assistant to your Android device:
1. Follow the steps on [Turning Home Assistant into a Thread border router](https://www.home-assistant.io/integrations/thread#turning-home-assistant-into-a-thread-border-router).
2. Make sure to Sync the Thread credentials as described in step 3.
### Error "Target node did not process the update file"
#### Symptom
You are trying to update a Matter over Thread device via Home Assistant and see the error "Target node did not process the update file".
#### Cause
Over-the-air (OTA) updates of Matter devices from Home Assistant are not supported with an Apple {% term "Thread border router" %}.
#### Remedy
- If you only have a {% term "Thread border router" %} from Apple, you cannot update the device from Home Assistant.
- If you want to be able to use OTA updates on these devices, you could add another border router, for example by [turning Home Assistant into a Thread border router](/integrations/thread#turning-home-assistant-into-a-thread-border-router).
- If you have a mixture of Apple and other {% term "Thread border routers" %} such as the Home Assistant [OpenThread border router](/integrations/thread#openthread-border-routers), follow these steps:
1. Power down all the Apple {% term "Thread border routers" %}.
2. Wait at least 30 minutes.
3. Try again to update the devices from Home Assistant.
### Unable to commission devices, it keeps giving errors or stops working randomly
The Matter protocol relies on (local) IPv6 and mDNS (multicast traffic) which should be able to travel freely in your network. Matter devices that use Wi-Fi (including Thread border routers) must be on the same LAN/VLAN as Home Assistant. Matter devices that only use {% term Thread %} must be joined to {% term Thread %} networks for which there is at least one border router connected to the Home Assistant LAN.
#### Symptom
If you experience any issues with discovering devices (for example, if the initial {% term commissioning %} keeps failing or if devices become unavailable randomly), investigate your network topology. For instance, a setting on your router or Wi-Fi access point to "optimize" multicast traffic can harm the (discovery) traffic from Matter devices. Keep this in mind when you experience issues trying to add or control Matter devices. Protocols like Matter are designed for regular residential network setups and may not integrate well with enterprise networking solutions like VLANs, Multicast filtering, and (malfunctioning) IGMP snooping. To avoid issues, try to keep your network topology as simple and flat as possible.
The initial {% term commissioning %} keeps failing, you experience issues with discovering devices, or devices become unavailable randomly.
#### Cause
- The Matter protocol relies on (local) IPv6 and <abbr title="multicast Domain Name System">mDNS</abbr> (multicast traffic) traveling freely in your network.
- Matter is designed for regular residential network setups and may not integrate well with enterprise networking solutions like <abbr title="virtual local area networks">VLANs</abbr>, Multicast filtering, and (malfunctioning) <abbr title="Internet Group Management Protocol i">IGMP</abbr> snooping.
#### Remedy
1. Make sure that Matter devices that use Wi-Fi (including {% term "Thread border router" %}) are on the same <abbr title="local area networks">VLANs</abbr>/<abbr title="virtual local area networks">VLAN</abbr> as Home Assistant.
2. Make sure that Matter devices that only use {% term Thread %} are joined to Thread networks for which there is at least one {% term "Thread border router" %} connected to the Home Assistant LAN.
3. Investigate your network topology.
- For instance, a setting on your router or Wi-Fi access point to "optimize" multicast traffic can harm the (discovery) traffic from Matter devices. Keep this in mind when you experience issues trying to add or control Matter devices.
- To avoid issues, try to keep your network topology as simple and flat as possible.

2
source/_integrations/media_player.markdown
View File

@ -168,8 +168,6 @@ Currently only supported on [Denon AVR](/integrations/denonavr/) and [Songpal](
#### Action `media_player.shuffle_set`
Currently only supported on [Sonos](/integrations/sonos), [Spotify](/integrations/spotify), [MPD](/integrations/mpd), [Kodi](/integrations/kodi), [Roon](/integrations/roon), [OwnTone](/integrations/forked_daapd), [Squeezebox](/integrations/squeezebox) and [Universal](/integrations/universal).
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------- |
| `entity_id` | yes | Target a specific media player. For example `media_player.spotify`|

2
source/_integrations/minecraft_server.markdown
View File

@ -22,7 +22,7 @@ ha_integration_type: integration
## Prerequisites
- Minecraft Java Edition servers must be version 1.7 or newer, since older versions don't expose any information.
- The `enable-status` and `enable-query` must be set to `true` in the Minecraft `server.properties`.
- The configuration parameter `enable-status` must be set to `true` in the server configuration file (`server.properties`).
{% include integrations/config_flow.md %}

16
source/_integrations/motioneye.markdown
View File

@ -301,32 +301,32 @@ A dashboard card with icons that will call the `action` action to send action co
- entity: camera.living_room
icon: "mdi:arrow-left"
tap_action:
action: call-service
action: motioneye.action
action: perform-action
perform_action: motioneye.action
data:
action: left
entity_id: camera.living_room
- entity: camera.living_room
icon: "mdi:arrow-right"
tap_action:
action: call-service
action: motioneye.action
action: perform-action
perform_action: motioneye.action
data:
action: right
entity_id: camera.living_room
- entity: camera.living_room
icon: "mdi:arrow-up"
tap_action:
action: call-service
action: motioneye.action
action: perform-action
perform_action: motioneye.action
data:
action: up
entity_id: camera.living_room
- entity: camera.living_room
icon: "mdi:arrow-down"
tap_action:
action: call-service
action: motioneye.action
action: perform-action
perform_action: motioneye.action
data:
action: down
entity_id: camera.living_room

4
source/_integrations/mqtt.markdown
View File

@ -1475,10 +1475,6 @@ The MQTT integration will register the `mqtt.publish` action, which allows publi
When `payload` is rendered from [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) in a YAML script or automation, and the template renders to a `bytes` literal, the outgoing MQTT payload will only be sent as `raw` data, if the `evaluate_payload` option flag is set to `true`.
{% endnote %}
{% important %}
You must include either `topic` or `topic_template`, but not both. If providing a payload, you need to include either `payload` or `payload_template`, but not both.
{% endimportant %}
```yaml
topic: homeassistant/light/1/command
payload: on

35
source/_integrations/onedrive.markdown
View File

@ -1,5 +1,5 @@
---
title: OneDrive
title: Microsoft OneDrive
description: Instructions on how to setup OneDrive to be used with backups.
ha_release: 2025.2
ha_category:
@ -16,14 +16,15 @@ related:
ha_quality_scale: bronze
---
This integration allows you to use [OneDrive](https://www.microsoft.com/en-us/microsoft-365/onedrive/online-cloud-storage) for [Home Assistant Backups](/common-tasks/general/#backups).
This integration allows you to use [Microsoft OneDrive](https://www.microsoft.com/en-us/microsoft-365/onedrive/online-cloud-storage) for [Home Assistant Backups](/common-tasks/general/#backups).
Backups will be created in a folder called `Home Assistant\backups_<id>` in the `App Folder` of your OneDrive by default.
`id` is part of your Home Assistant instance's unique id to allow backups from multiple instances to the same OneDrive account.
The integration only has access to an application specific `Home Assistant` folder in the `App Folder` and cannot access any other parts of your OneDrive.
{% important %}
Because of an [issue in the Graph API](https://github.com/OneDrive/onedrive-api-docs/issues/1866), the application-specific folder is often called `Graph` instead of `Home Assistant`.
Because of an issue in Microsoft's APIs, the application-specific folder is often called `Graph` instead of `Home Assistant`. More on that [below](#backup-folder-is-called-graph).
{% endimportant %}
{% include integrations/config_flow.md %}
@ -67,13 +68,29 @@ This integration comes with a predefined set of [application credentials](https:
Nobody will ever have access to your data except you, as the app does not have permission to do anything on its own. It only works with a signed-in user (it only has `delegated` not `application permissions`).
However, if you want to use your own credentials, follow [this guide](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app?tabs=certificate) to create your own client ID and secret.
{% tip %}
You will need an Azure tenant with an active Azure subscription to create your own client credentials.
{% endtip %}
Make sure to configure the following settings on the app registration:
- **Supported account types**: Personal Microsoft accounts only
- **Redirect URI**: Type: `Web`, URL: `https://my.home-assistant.io/redirect/oauth`
<img src='/images/integrations/onedrive/onedrive-app-registration.png' alt='Configuring a custom app.'>
{% note %}
If you set the integration up with the default credentials and switch to custom credentials later, your backup folder will change inside your OneDrive, and you will have to manually copy existing backups from the old folder to the new one.
{% endnote %}
{% tip %}
You will need an Azure tenant with an active Azure subscription to create your own client credentials.
{% endtip %}
## Backup folder is called `Graph`
This integration uses Microsoft's Graph API to communicate with your OneDrive. Because of an [issue](https://github.com/OneDrive/onedrive-api-docs/issues/1866) in that API, the application folder is often not named with the name of the application (`Home Assistant`), but `Graph` instead.
There is no risk of different applications mixing in that `Graph` folder, if you already have such a `Graph` folder from a different application, the next folders will just be called `Graph 1`, `Graph 2` and so on.
You should be able to manually rename the folder to something else, without the integration breaking.
## Sensors
@ -137,3 +154,9 @@ mode: single
This integration follows standard integration removal. No extra steps are required.
{% include integrations/remove_device_service.md %}
## Troubleshooting
{% details "Unknown error while adding the integration" %}
Make sure that your OneDrive is not frozen. This can happen if you haven't used it for a longer period of time, or went over your data quota. {% enddetails %}

8
source/_integrations/openai_conversation.markdown
View File

@ -133,7 +133,7 @@ automation:
config_entry: abce6b8696a15e107b4bd843de722249
size: "1024x1024"
prompt: >-
New York when the weather is {{ states("weather.home") }}"
New York when the weather is {{ states("weather.home") }}
- alias: "Send out a manual event to update the image entity"
event: new_weather_image
@ -141,13 +141,13 @@ automation:
url: '{{ generated_image.url }}'
template:
- triggers:
- trigger:
- alias: "Update image when a new weather image is generated"
trigger: event
event_type: new_weather_image
image:
name: "AI generated image of New York"
url: "{{ trigger.event.data.url }}"
- name: "AI generated image of New York"
url: "{{ trigger.event.data.url }}"
```
{% endraw %}

16
source/_integrations/private_ble_device.markdown
View File

@ -40,6 +40,22 @@ If you are trying to get the IRK for your iPhone or Apple Watch, you must be log
7. You will have to enter your password, then enter your username and password.
8. macOS will show some XML. You are looking for the "Remote IRK" field. After there is a data field that contains a base64 encoded version of your Identity Resolving Key.
### On Windows / For Android
If you have a rooted Android phone, the IRK (and LTKs) can be viewed in the file `/data/misc/bluedroid/bt_config.conf`. The LE_LOCAL_KEY_IRK specifies the Android device's own IRK, and the first 16 bytes of LE_KEY_PID for every bonded device in the file indicate the bonded device's IRK. Be aware that keys stored in this file are a little-endian, so the byte order of keys in this file will need to be reversed. For example, the little-endian IRK 22BC0E3F2EACF08EE36B865553EA0B4E needs to be changed to 4E0BEA5355866BE38EF0AC2E3F0EBC22.
Alternatively, the IRK of an Android phone and/or secondary device can be obtained using Wireshark:
1. In developer settings on the Android phone, enable the "USB Debugging" and "Enable Bluetooth HCI snoop log" options.
2. Ensure a second Bluetooth device (e.g., smartwatch or earbuds) is unpaired.
3. Disable and re-enable Bluetooth on the phone ,then re-pair the secondary device.
4. Connect the Android phone to a computer with [adb](https://developer.android.com/tools/adb) installed.
5. Establish an adb connection (`adb connect...`), then run the command: `adb bugreport scanwatch`.
6. In the generated `scanwatch.zip` file, locate and extract `FS\data\misc\bluetooth\logs\btsnoop_hci.log`.
7. Open `btsnoop_hci.log` in [Wireshark](https://www.wireshark.org/download.html) and search for `btsmp.id_resolving_key`.
8. Select one of the frames and expand the "Bluetooth Security Manager Protocol." The hex dump will show either the sending or receiving device IRK.
9. Reverse the value displayed. For example, if it is `763af6c7f7d94ad6c262158e2320544e`, the IRK to use would be: `4e5420238e1562c2d64ad9f7c7f63a76`.
## ESPresense
If you already use Identity Resolving Key tracking with ESPresence then you already have a hex-encoded version of your Identity Resolving Key. Home Assistant can use the key in this format directly.

2
source/_integrations/proximity.markdown
View File

@ -38,7 +38,7 @@ The following sensor entities will be created.
### Distance
For each tracked [device](/integrations/device_tracker/) or [person](/integrations/person/), a sensor is created showing the distance from the monitored zone in a unit depending on your [Home Assistant Unit System](/docs/configuration/basic) selection. When a tracked person or device enters the monitored zone, the distance is set to 0.
For each tracked [device](/integrations/device_tracker/) or [person](/integrations/person/), a sensor is created showing the distance from the edge of monitored zone in a unit depending on your [Home Assistant Unit System](/docs/configuration/basic) selection. When a tracked person or device enters the monitored zone, the distance is set to 0.
### Direction of travel

134
source/_integrations/pyload.markdown
View File

@ -1,6 +1,6 @@
---
title: pyLoad
description: Instructions on how to integrate pyLoad download sensor within Home Assistant.
description: Instructions on how to integrate pyLoad download manager with Home Assistant.
ha_category:
- Downloading
ha_release: 0.58
@ -19,8 +19,54 @@ ha_config_flow: true
The [**pyLoad**](https://pyload.net/) {% term integration %} enables monitoring your downloads directly in Home Assistant. This integration provides various sensors to keep track of your download activities and allows creating automations based on the sensor information, alongside button and switch controls for performing specific tasks such as aborting downloads and managing file restarts.
## About pyLoad
**pyLoad** is an open-source download manager designed for always-on devices like home servers, NAS systems, and routers. It supports various file hosts, container formats, and web standards, enabling fully automated, unattended downloads. With its web interface, pyLoad allows for easy remote management from any device.
## How you can use this integration
The **pyLoad** integration allows you to monitor and control your downloads directly from Home Assistant. Here are some ways you can use it:
- **Track active downloads** – Send a notification when all downloads are complete or if the queue is empty.
- **Free space alerts** – Set up an automation to alert you when disk space is low, ensuring downloads don’t fail due to storage issues.
- **Pause downloads** – Automatically pause downloads when streaming or gaming to avoid bandwidth congestion, then resume them later.
## Prerequisites
To set up the pyLoad integration, you must have a running pyLoad instance on your home server, NAS, or any other device. An always-on device is recommended. Ensure that pyLoad's web interface is accessible for Home Assistant.
If you haven't set up pyLoad yet, an easy way to get it up and running is by installing the [pyLoad-ng add-on for Home Assistant](https://github.com/tr4nt0r/pyload-ng).
- During the setup process in Home Assistant, you will need:
- pyLoad account credentials – A valid *username* and *password* to authenticate with pyLoad.
- The {% term host %} of the device running pyLoad.
- The port number that pyLoad is listening on (default is usually `8000`).
{% note %}
The account used for integration must either be an admin account or one with at least the following permissions: `DELETE`, `STATUS`, `LIST`, and `MODIFY`. You can set up and manage users and permissions under **Settings -> Users** in the pyLoad web interface.
{% endnote %}
{% include integrations/config_flow.md %}
### Configuration parameters
{% configuration_basic %}
Host:
description: "The hostname or IP address of the device running your pyLoad instance."
Port:
description: "The port of the pyLoad instance. pyLoad uses port 8000 by default."
Uses an SSL Certificate:
description: "If enabled, the connection to the pyLoad instance will use HTTPS."
Verify SSL certificate:
description: "If checked, the SSL certificate will be validated to ensure a secure connection."
Username:
description: "The username used to access the pyLoad instance."
Password:
description: "The password associated with the pyLoad account."
{% endconfiguration_basic %}
## Sensors
- **Speed:** Monitors the current download speed.
@ -40,3 +86,89 @@ The [**pyLoad**](https://pyload.net/) {% term integration %} enables monitoring
- **Pause/Resume Queue:** Pauses or resumes the download queue. When paused, active downloads will continue, but new downloads in the queue will not start.
- **Auto-reconnect:** If configured, enables pyLoad to automatically reconnect the internet connection.
## Automations
Get started with these example {% term automations %}.
### Pause downloads when disk space is low
This automation will pause new downloads when your available disk space falls below 5 GB.
{% details "Example YAML configuration" %}
{% raw %}
```yaml
alias: "Monitor pyLoad download queue"
description: "Pause new downloads when the disk space is low."
triggers:
- trigger: numeric_state
entity_id: sensor.pyload_free_space
below: 5000000000 # Trigger when free space drops below 5 GB (in bytes)
actions:
- action: switch.turn_off
target:
entity_id: switch.pyload_pause_resume_queue
- service: notify.persistent_notification
data:
message: "Free space is low, pausing pyLoad queue."
mode: single
```
{% endraw %}
{% enddetails %}
### Halt pyLoad downloads when watching Netflix
This automation halts all active pyLoad downloads when watching Netflix on your media player.
{% details "Example YAML configuration" %}
{% raw %}
```yaml
alias: "Halt pyLoad downloads when watching Netflix"
description: "Halt all pyLoad downloads when Netflix streaming starts on the media player."
triggers:
- trigger: state
entity_id: media_player.android_tv
to: playing
conditions:
- condition: state
entity_id: media_player.android_tv
attribute: app_id
state: com.netflix.ninja
actions:
- action: button.press
target:
entity_id: button.pyload_abort_all_running_downloads
- action: notify.persistent_notification
data:
message: "pyLoad downloads have been halted because Netflix streaming started."
mode: single
```
{% endraw %}
{% enddetails %}
## Data updates
This integration {% term polling polls %} your **pyLoad** instance every 20 seconds. If you prefer a different update frequency, you can define a **custom polling interval** — see [Defining a custom polling interval](/common-tasks/general/#defining-a-custom-polling-interval) for details.
## Known limitations
- **Paused downloads**: When the download queue is paused, active downloads will continue, but new downloads in the queue will not start until the queue is resumed.
- **Halt all downloads**: To completely halt downloading, use the `Abort all running downloads` action. The `Restart failed files/packages` action will also resume any aborted downloads.
## Troubleshooting
In any case, when reporting an issue, please enable [debug logging](/docs/configuration/troubleshooting/#debug-logs-and-diagnostics), restart the integration, and as soon as the issue reoccurs, stop the debug logging again (*download of debug log file will start automatically*). Further, if still possible, please also download the [diagnostics](/integrations/diagnostics) data. If you have collected the debug log and the diagnostics data, provide them with the issue report.
## Remove integration
This integration can be removed by following these steps:
{% include integrations/remove_device_service.md %}

4
source/_integrations/qbus.markdown
View File

@ -34,8 +34,8 @@ Once the Qbus controller is connected to the MQTT server, you need to set up an
There is currently support for the following **Qbus** products within Home Assistant:
- **CTD 3.0**: main controller.
- **CTD 3.5**: main controller.
- **CTD01E to CTD03E (CTD 3.0)**: main controllers (yellow).
- **CTD10 to CTDMax (CTD 3.5)**: main controllers (black).
- **Toggle**: toggle outputs on controllers.
## Available entities

17
source/_integrations/reolink.markdown
View File

@ -139,11 +139,11 @@ Depending on the supported features of the camera, number entities are added for
- Auto track disappear time
- Auto track stop time
- Day night switch threshold*
- Image brightness* (default 128)
- Image contrast* (default 128)
- Image saturation* (default 128)
- Image sharpness* (default 128)
- Image hue* (default 128)
- Image brightness*+ (default 128)
- Image contrast*+ (default 128)
- Image saturation*+ (default 128)
- Image sharpness*+ (default 128)
- Image hue*+ (default 128)
**Floodlight turn on brightness** controls the brightness of the floodlight when it is turned on internally by the camera (see **Floodlight mode** select entity) or when using the **Floodlight** light entity.
@ -189,7 +189,7 @@ Some Reolink <abbr title="pan, tilt, and zoom">PTZ</abbr> cameras can move at di
Depending on the supported features of the camera, select entities are added for:
- Floodlight mode (Off, Auto, Schedule)
- Day night mode (Auto, Color, Black&White)
- Day night mode+ (Auto, Color, Black&White)
- <abbr title="pan, tilt, and zoom">PTZ</abbr> preset
- Play quick reply message
- Auto quick reply message
@ -310,6 +310,7 @@ The following models have been tested and confirmed to work with a direct link t
- C2 Pro*
- [CX410](https://reolink.com/product/cx410/)
- [CX810](https://reolink.com/product/cx810/)
- [E1 Pro](https://reolink.com/product/e1-pro/) (only hardware version IPC_NT1NA45MP)
- [E1 Zoom](https://reolink.com/product/e1-zoom/)
- [E1 Outdoor](https://reolink.com/product/e1-outdoor/)
- [E1 Outdoor PoE](https://reolink.com/product/e1-outdoor-poe/)
@ -375,7 +376,9 @@ The following battery-powered models have been tested and confirmed to work thro
- [Argus 3 Pro](https://reolink.com/product/argus-3-pro/)
- [Argus 4 Pro](https://reolink.com/product/argus-4-pro/)
- [Argus Eco](https://reolink.com/product/argus-eco/)
- [Argus Eco Ultra](https://reolink.com/product/argus-eco-ultra/)
- [Argus PT](https://reolink.com/product/argus-pt/)
- [Argus Track](https://reolink.com/product/argus-track/)
- [Reolink Doorbell Battery](https://reolink.com/roadmap/)
@ -386,7 +389,7 @@ Reolink provides [this larger list of battery camera models](https://support.reo
The following models are lacking the HTTP web server API and can, therefore, not work directly with this integration.
However, these cameras can work with this integration through an NVR or Home Hub in which the NVR/Home Hub is connected to Home Assistant.
- E1 Pro
- E1 Pro (The IPC_NT1NA45MP hardware version also works with a direct connection)
- E1
- Reolink Lumus
- B400*

158
source/_integrations/schedule.markdown
View File

@ -12,64 +12,58 @@ ha_domain: schedule
ha_integration_type: helper
---
The schedule integration provides a way to create a weekly schedule in
Home Assistant that can be used to trigger or make decisions in your
automations and scripts.
The preferred way to configure a schedule is via the user interface at
**{% my helpers title="Settings > Devices & services > Helpers." %}** Click the add button
and then choose the **{% my config_flow_start domain=schedule title="Schedule" %}** option, or click the My button below.
The **Schedule** {% term integration %} provides a way to create a weekly schedule {% term entity %} in Home Assistant, consisting of time blocks with defined start and end times. The schedule is active when a time block starts and becomes inactive when it ends, allowing it to be used for triggering or making decisions in automations and scripts.
{% include integrations/config_flow.md %}
To be able to add **{% my helpers title="Helpers" %}** via the user interface you should
have `default_config:` in your {% term "`configuration.yaml`" %}, it should already
be there by default unless you removed it.
{% configuration_basic %}
Name:
description: Friendly name of the schedule.
Icon:
description: Icon to display in the frontend for this schedule.
Schedule blocks:
description: >
Press and drag to select time blocks for each day of the week.
It is not possible to create overlapping time blocks on the same day.
{% endconfiguration_basic %}
If you removed `default_config:` from your configuration,
you must add it back or, alternatively, `schedule:` to your
`configuration.yaml` first, before you can create them via the UI.
After creating schedule blocks, you can press a block to edit the details.
Alternatively, a schedule can also be created and configured via YAML
configuration. For example:
{% configuration_basic %}
Start:
required: true
type: time
description: The start time to mark the schedule as active/on.
End:
required: true
type: time
description: The end time to mark as inactive/off again.
Additional data:
required: false
type: map
description: A mapping of attribute names to values, which will be added to the entity's attributes when the block is active.
{% endconfiguration_basic %}
### Adding additional data
Adding the following as `Additional data` will show `brightness` and `color_temp` as {% term entity %} attributes when the block is active:
```yaml
# Example configuration.yaml entry
schedule:
thermostat_schedule:
name: "Thermostat schedule"
monday:
- from: "17:00:00"
to: "21:00:00"
tuesday:
- from: "17:00:00"
to: "21:00:00"
wednesday:
- from: "17:00:00"
to: "21:00:00"
thursday:
- from: "17:00:00"
to: "21:00:00"
friday:
- from: "17:00:00"
to: "23:00:00"
saturday:
- from: "07:00:00"
to: "10:00:00"
- from: "16:00:00"
to: "23:00:00"
sunday:
- from: "07:00:00"
to: "21:00:00"
brightness: 100
color_temp: 4000
```
Defining the schedule in YAML also allows adding extra data to each block, which will
appear as attributes on the schedule helper entity when that block is active. This can
be used to easily build schedule-based automations.
## YAML configuration
Alternatively, this {% term integration %} can be configured and set up manually via YAML instead.
To enable the Integration sensor in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% note %}
The `data` field follows the same logic as described above in *Adding additional data*.
{% endnote %}
The `data` key of each block should be a mapping of attribute names to values. In this example,
the schedule helper entity will have "Brightness" and "Color temp" attributes when
the blocks are active:
```yaml
schedule:
@ -116,7 +110,6 @@ schedule:
type: icon
"monday|tuesday|wednesday|thursday|friday|saturday|sunday":
description: A schedule for each day of the week.
required: false
required: true
type: list
keys:
@ -129,54 +122,59 @@ schedule:
required: true
type: time
data:
description: Additional data to add to the entity's attributes when this block is active.
description: A mapping of attribute names to values, which will be added to the entity's attributes when the block is active.
required: false
type: map
default: {}
{% endconfiguration %}
### Attributes
## Attributes
A schedule entity's state exports attributes that can be useful in
automations and templates.
A schedule entity exports state attributes that can be useful in automations and templates.
| Attribute | Description |
| ----- | ----- |
| `next_event` | A datetime object containing the next time the schedule is going to change state. |
| `key_1`, `key_2`, ... | The mapping values from **Additional data** / `data` settings of a time block when the respective block is active. |
### Automation example
## Automation example
A schedule creates an on/off (schedule) sensor within the times set. Using the thermostat schedule example above, you can turn on your thermostat:
```yaml
triggers:
- trigger: state
entity_id:
- schedule.thermostat_schedule
to: "on"
actions:
- action: climate.turn_on
target:
entity_id: climate.thermostat
```
Using the `light_schedule` example from above in an automation might look like this:
A schedule creates an on/off (schedule) sensor within the times set.
By incorporating the `light_schedule` example from above in an automation, we can turn on a light when the schedule is active.
{% raw %}
```yaml
triggers:
- trigger: state
entity_id:
- schedule.light_schedule
to: "on"
actions:
- action: light.turn_on
target:
entity_id: light.kitchen
data:
brightness_pct: "{{ state_attr('schedule.light_schedule', 'brightness') }}"
kelvin: "{{ state_attr('schedule.light_schedule, 'temperature') }}"
- trigger: state
entity_id:
- schedule.light_schedule
to: "on"
actions:
- action: light.turn_on
target:
entity_id: light.kitchen
data:
brightness_pct: "{{ state_attr('schedule.light_schedule', 'brightness') }}"
kelvin: "{{ state_attr('schedule.light_schedule', 'color_temp') }}"
```
{% endraw %}
Another automation can be added to turn the lights off once the schedule is inactive:
{% raw %}
```yaml
triggers:
- trigger: state
entity_id:
- schedule.light_schedule
to: "off"
actions:
- action: light.turn_off
target:
entity_id: light.kitchen
```
{% endraw %}

2
source/_integrations/season.markdown
View File

@ -31,4 +31,4 @@ All information about how the seasons work was taken from Wikipedia:
- [https://en.wikipedia.org/wiki/Equinox](https://en.wikipedia.org/wiki/Equinox)
- [https://en.wikipedia.org/wiki/Solstice](https://en.wikipedia.org/wiki/Solstice)
To cut a long read short, Astronomical gives seasons based on the shortest/longest day and equinoxes. So in the Northern Hemisphere spring starts on 20 March). Meteorological gives seasons based on months (so in the Northern Hemisphere spring starts on 1 March).
To cut a long read short, Astronomical gives seasons based on the shortest/longest day and equinoxes. So in the Northern Hemisphere spring starts on 20 March. Meteorological gives seasons based on months so in the Northern Hemisphere spring starts on 1 March.

6
source/_integrations/shelly.markdown
View File

@ -85,7 +85,7 @@ Integration is communicating directly with the device; cloud connection is not n
## Bluetooth Support
Shelly generation 2+ devices not battery-powered can act as a Bluetooth proxy for advertisements. Active or passive listening can be enabled in the options flow.
Shelly generation 2+ devices that are not battery-powered can act as a Bluetooth proxy for advertisements. Active or passive listening can be enabled in the options flow.
{% include integrations/option_flow.md %}
@ -263,11 +263,11 @@ Not all devices support all input events. You can check on [Shelly API Reference
## Appliance type (generation 1)
Shelly device relays are added to Home Assistant by default as `switch` entities. A relay can be added as a `light` entity if **Settings** >> **APPLIANCE TYPE** value is set to `light`.
Shelly device relays are added to Home Assistant by default as `switch` entities. A relay can be added as a `light` entity if **Settings** >> **APPLIANCE TYPE** value in the WebUI of the device is set to `light`.
## Consumption type (generation 2+)
Shelly device relays are added to Home Assistant by default as `switch` entities. A relay can be added as a `light` entity if **EXTERNAL CONSUMPTION TYPE** value is set to `light`.
Shelly device relays are added to Home Assistant by default as `switch` entities. A relay can be added as a `light` entity if **EXTERNAL CONSUMPTION TYPE** value in the WebUI of the device is set to `light`.
## Light transition

23
source/_integrations/shopping_list.markdown
View File

@ -80,13 +80,13 @@ Sort all items by name in the shopping list.
A `shopping_list_updated` event is triggered when items in the list are modified, with the following data payload attached to it. This can be used to trigger automations such as sending a push notification when someone adds an item to the shopping list, which when clicked, will open the list.
| Data payload attribute | Description |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------ |
| `action` | What action was taken on the item. Either `add` for a new item being added, or `update` for an item being updated. |
| `item` | A dictionary containing details of the item that was updated. |
| `item.id` | A unique ID for this item |
| `item.name` | The text attached to the item, for example `Milk` |
| `item.complete` | A boolean indicated whether the item has been marked as complete. |
| Data payload attribute | Description |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `action` | What action was taken on the item. Either `add` for a new item being added, `update` for an item being updated, or `remove` for an item being removed. |
| `item` | A dictionary containing details of the item that was updated. |
| `item.id` | A unique ID for this item |
| `item.name` | The text attached to the item, for example `Milk` |
| `item.complete` | A boolean indicated whether the item has been marked as complete. |
{% raw %}
@ -107,3 +107,12 @@ actions:
```
{% endraw %}
You can also trigger an automation when a `shopping_list_updated` event was triggered by any of the following actions:
- `clear`: A completed item was cleared from the list.
- `sorted`: The items in the list were sorted by name.
- `reorder`: An item has been reordered in the list.
- `update_list`: All items have been updated.
In these cases, the event does not return a list item.

34
source/_integrations/slack.markdown
View File

@ -106,7 +106,7 @@ sequence:
- action: notify.YOUR_SLACK_TEAM
data:
message: "Fallback Text"
target: "#test-channel"
target: "#test-channel" # Single channel target
title: "Reminder"
data:
blocks:
@ -122,6 +122,38 @@ Update the blocks array with valid Slack blocks. The easiest way to create this
Create a duplicate of this script to use for different messages, and different channels (the door was opened in #security, the light was left on on #lights, etc).
You can also send messages to multiple targets (channels and/or users) at once:
```yaml
alias: "Notify: Multiple Targets Message"
sequence:
- action: notify.YOUR_SLACK_TEAM
data:
message: "Alert: Motion detected!"
target:
- "#security" # Channel by name
- "C01234ABCD" # Channel by ID
- "U5678EFGH" # Direct message to user by ID
title: "Security Alert"
data:
blocks:
- type: section
text:
type: mrkdwn
text: "Motion detected in the backyard camera"
```
### Target Types
The `target` field accepts either a single value or a list of values. Each target can be:
- A channel name with a `#` prefix (e.g., `#general`)
- A channel name without the `#` prefix (e.g., `general`)
- A channel ID (e.g., `C01234ABCD`)
- A user ID for direct messages (e.g., `U5678EFGH`)
When sending files, make sure you have the proper permissions set up as described in the Setup section.
### Icons
Slack uses the standard emoji sets used [here](https://slack.com/intl/en-gb/help/articles/202931348-Use-emoji-and-reactions#add-emoji-to-your-messages). Alternatively a publicly accessible URL may be used.

44
source/_integrations/squeezebox.markdown
View File

@ -184,6 +184,50 @@ For example, to play an album from your collection, create an IFTTT applet like
This can work with title search and basically any thing. The same wouldn't have worked by calling directly Squeezebox server as IFTTT cannot escape the text field.
When specifying additional parameters in the Visual Editor, each parameter must be preceded by a hyphen and a space to correctly populate the array:
For example, to create an automation to mute playback, use the command `mixer` and the parameter `muting`:
| Row | Parameter | Description |
| --- | -------- | ----------- |
| 1 | - muting | Toggle muting on / off |
| 2 | | |
resulting in the YAML:
```yaml
# Toggle the muting state of the specified player
action: squeezebox.call_method
metadata: {}
data:
command: mixer
parameters:
- muting
```
Where a parameter is an increment or decrement, it is necessary to place the value in double quotes.
For example, to increase the playback volume, use the command `mixer` and the parameters `volume` and the amount to increment:
| Row | Parameter | Description |
| --- | -------- | ----------- |
| 1 | - volume | Parameter to change |
| 2 | - "+5" | Increment volume by 5 percent |
resulting in the YAML:
```yaml
# Increment the playback volume of the specified player by five percent
action: squeezebox.call_method
metadata: {}
data:
command: mixer
parameters:
- volume
- "+5"
```
### Action `call_query`
Call a custom Squeezebox JSON-RPC API. The result of the query will be stored in the 'query_result' attribute of the player.

2
source/_integrations/switcher_kis.markdown
View File

@ -58,6 +58,8 @@ If you completed the integration setup but are still unable to control the devic
## Prerequisites
Before the integration can find a device, you need to connect it to your network using the Switcher app.
To enhance security, certain Switcher devices require a token for operation. In order to integrate your token-based Switcher devices with Home Assistant, you'll need the following information:
- **The username of your Switcher Account**: To find the username, open the Switcher app.

6
source/_integrations/telegram.markdown
View File

@ -454,6 +454,7 @@ actions:
message_tag: "example_tag"
disable_notification: True
disable_web_page_preview: True
message_thread_id: 123
```
{% configuration %}
@ -468,10 +469,15 @@ disable_notification:
type: boolean
disable_web_page_preview:
description: True/false to display a webpage preview.
required: false
default: false
type: boolean
message_tag:
description: Tag for sent message.
required: false
type: string
message_thread_id:
description: Send the message to a specific topic or thread.
required: false
type: integer
{% endconfiguration %}

15
source/_integrations/telegram_bot.markdown
View File

@ -290,7 +290,7 @@ Remove the bot from the chat group where it was added.
## Telegram notification platform
The [`telegram` notification platform](/integrations/telegram) requires the `telegram_bot` integration to work with, and it's designed to generate a customized shortcut (`notify.USERNAME`) to send notifications (messages, photos, documents and locations) to a particular `chat_id` with the old syntax, allowing backward compatibility. The data attributes `parse_mode`, `disable_notification`, `message_tag` and `disable_web_page_preview` are also supported.
The [`telegram` notification platform](/integrations/telegram) requires the `telegram_bot` integration to work with, and it's designed to generate a customized shortcut (`notify.USERNAME`) to send notifications (messages, photos, documents, and locations) to a particular `chat_id` with the old syntax, allowing backward compatibility. The data attributes `parse_mode`, `disable_notification`, `message_tag`, `disable_web_page_preview`, and `message_thread_id` are also supported.
The required YAML configuration now reduces to:
@ -598,7 +598,7 @@ actions:
message_tag: "example_tag"
```
## Example: send_message with disabled webpage preview:
## Example: send_message with disabled webpage preview
```yaml
actions:
@ -611,6 +611,17 @@ actions:
disable_web_page_preview: true
```
## Example: send_message to a topic within a group
```yaml
actions:
- action: notify.telegram
data:
message: "Message to a topic"
data:
message_thread_id: 123
```
## Example: automation to send a message and delete after a delay
{% raw %}

9
source/_integrations/tesla_fleet.markdown
View File

@ -46,6 +46,7 @@ You must have:
- A [Developer Application](https://developer.tesla.com/en_US/dashboard)
- A web domain and host that you can serve your public key file from. Some free options include:
- [FleetKey.cc](https://fleetkey.cc)
- [MyTeslamate.com](https://app.myteslamate.com/fleet)
- [AWS S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/WebsiteHosting.html)
- [Cloudflare Pages](https://pages.cloudflare.com/)
- [Firebase Hosting](https://firebase.google.com/docs/hosting)
@ -123,7 +124,7 @@ The following steps involve sensitive credentials. Never share your `Client Secr
3. The CURL request should return a response that looks something like:
```json
{"access_token":"JSON_WEB_TOKEN","expires_in":28800,"token_type":"Bearer"}
{"access_token":"ACCESS_TOKEN","expires_in":28800,"token_type":"Bearer"}
```
This is your access token. Copy everything between the double-quotes to be used next.
@ -132,14 +133,14 @@ The following steps involve sensitive credentials. Never share your `Client Secr
```shell
curl --location 'https://fleet-api.prd.na.vn.cloud.tesla.com/api/1/partner_accounts' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer JSON_WEB_TOKEN' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--data '{
"domain": "my.domain.com"
}'
```
- If you had to change the `AUDIENCE` URL for your region in step 2, update the main domain of the `--location` arg.
- Replace `LONG_GIBBERISH_ACCESS_TOKEN_STRING` with the access token that you copied in the previous step.
- Replace `ACCESS_TOKEN` with the access token that you copied in the previous step.
- In the `domain:` line, enter your domain without the leading `https://` and the trailing `/`.
5. You should see a response that contains information about your Tesla Fleet developer app, pricing info, and such. This confirms that the Tesla Fleet API has successfully registered your developer application as a partner. The hard part is over.
@ -165,7 +166,7 @@ When connecting your Tesla account to Home Assistant, you **must** select at lea
Previously, Tesla restricted this integration to a very modest rate limit. However, from January 2025, accounts in eligible countries will be charged for every API call. Here's what you need to know:
- Tesla provides a $10 credit per developer account per calendar month
- Tesla provides a USD$10 credit per developer account per calendar month
- Every vehicle coordinator refresh, vehicle command, and wake up has a cost
- This credit only allows for a maximum of 5000 coordinator refreshes
- Energy product APIs are free to use at this time

18
source/_integrations/todo.markdown
View File

@ -80,12 +80,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:
| 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. |
| Data attribute | Optional | Description | Example |
| -------------- | -------- | ----------------------------------------------------------------- | ------------------------------------------------------------ |
| `item` | no | The name/summary 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.
@ -107,9 +107,9 @@ Update a to-do item. A to-do list `target` is selected with a [Target Selector](
| 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` |
| `item` | no | The name/summary 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. |

1
source/_integrations/vesync.markdown
View File

@ -80,6 +80,7 @@ This {% term integration %} supports devices controllable by the VeSync App. Th
- Classic200S: Classic 200S Smart Ultrasonic Cool Mist Humidifier
- Classic300S: Classic 300S Ultrasonic Smart Humidifier
- Superior6000S: Superior 6000S Smart Evaporative Humidifier
## Prerequisite

1
source/_integrations/wyoming.markdown
View File

@ -26,6 +26,7 @@ ha_zeroconf: true
The **Wyoming** {% term integration %} connects external voice services to Home Assistant using a [small protocol](https://github.com/rhasspy/rhasspy3/blob/master/docs/wyoming.md). This enables [Assist](/voice_control/) to use a variety of local [speech-to-text](/integrations/stt/), [text-to-speech](/integrations/tts/), and [wake-word-detection](/integrations/wake_word/) systems, such as:
- Speech-to-Phrase {% my supervisor_addon badge addon="core_speech-to-phrase" %}
- Whisper {% my supervisor_addon badge addon="core_whisper" %}
- Piper {% my supervisor_addon badge addon="core_piper" %}
- openWakeWord {% my supervisor_addon badge addon="core_openwakeword" %}

107
source/_integrations/zha.markdown
View File

@ -79,7 +79,7 @@ Before installing the ZHA integration in Home Assistant, you need to connect a Z
Once ZHA has been set up with a Zigbee Coordinator it will automatically create a Zigbee network and you will be able to join/pair any Zigbee Router devices and Zigbee End Devices. With only a few [limitations](#limitations), most devices will join/pair directly regardless of brand and manufacturer. Technically almost all devices that are compliant with the official Zigbee specifications should offer interoperability, though a newer Zigbee Coordinator with support for later firmware often offers better compatibility with both new and older devices. Still, be aware that [all functionality might not always be supported or exposed for every device out-of-the-box](#knowing-which-devices-are-supported) as some devices that use manufacturer-specific extensions to add non-standard functions and features could sometimes need [device-specific code to fully work with ZHA](#how-to-add-support-for-new-and-unsupported-devices).
Note that because Zigbee relies on "mesh networking" technology it depends heavily on having [Zigbee Router devices](#using-router-devices-to-add-more-devices) to expand the network coverage and extend its size. These are always mains-powered devices that route messages to other devices that are located close to them within the Zigbee network mesh to improve the range and increase the total amount of devices you can add. You should therefore make sure that you add many Zigbee Router devices and not just Zigbee End Devices or else its network mesh connection routes will be limited due to the short range and poor wall penetration of Zigbee radio signals. It is highly recommended that you read and follow all the general tips below about [Zigbee interference avoidance and network range/coverage optimization)](#zigbee-interference-avoidance-and-network-rangecoverage-optimization).
Note that because Zigbee relies on "mesh networking" technology it depends heavily on having [Zigbee Router devices](#using-router-devices-to-add-more-devices) to expand the network coverage and extend its size. These are always mains-powered devices that route messages to other devices that are located close to them within the Zigbee network mesh to improve the range and increase the total amount of devices you can add. You should therefore make sure that you add many Zigbee Router devices and not just Zigbee End Devices or else its network mesh connection routes will be limited due to the short range and poor wall penetration of Zigbee radio signals. It is highly recommended that you read and follow all the general tips below about [Zigbee interference avoidance and network range/coverage optimization](#zigbee-interference-avoidance-and-network-rangecoverage-optimization).
## Compatible hardware
@ -89,13 +89,11 @@ Note! Zigbee 3.0 support or not in zigpy, depends primarily on your Zigbee coord
Some other Zigbee coordinator hardware may not support a firmware that is capable of Zigbee 3.0 at all but can still be fully functional and feature-complete for your needs. This is very common as many, if not most, Zigbee devices do not yet Zigbee 3.0. As a general rule, newer Zigbee coordinator hardware generally supports Zigbee 3.0 firmware and it is up to its manufacturer to make such firmware available for them.
### Known working Zigbee radio modules
### Recommended Zigbee radio adapters and modules
- Silicon Labs EmberZNet based radios using the EZSP protocol (via the [bellows](https://github.com/zigpy/bellows) library for zigpy)
- [Home Assistant Connect ZBT-1](/connectzbt1/) (EFR32MG21-based USB dongle)
- [Home Assistant Yellow](/yellow/) with integrated EFR32MG21 radio
- [Home Assistant Yellow](/yellow/) with integrated MGM210P radio, which is based on the EFR32MG21
- [ITead SONOFF Zigbee 3.0 USB Dongle Plus Model "ZBDongle-E" (EFR32MG21 variant)](https://itead.cc/product/zigbee-3-0-usb-dongle/)
- [SMLIGHT SLZB-07](https://smlight.tech/product/slzb-07/) (EFR32MG21-based USB dongle)
- Texas Instruments based radios (via the [zigpy-znp](https://github.com/zigpy/zigpy-znp) library for zigpy)
@ -142,13 +140,11 @@ Serial protocols used by the Zigbee Coordinator do not have enough robustness, r
A Zigbee Coordinator requires a stable local connection to its serial port interface with no drops in communication between it and the Zigbee gateway application running on the host computer.
{% endcaution %}
## Configuration - GUI
## Configuration requirements
Connect your radio module and restart Home Assistant.
Be sure to connect a compatible radio module and restart Home Assistant before proceeding with configuration.
From the Home Assistant front page go to **Configuration** and then select **Integrations** from the list.
Use the plus button in the bottom right to add a new {% term integration %} called **ZHA**.
{% include integrations/config_flow.md %}
In the popup:
@ -220,13 +216,22 @@ Some devices can be auto-discovered, which can simplify the ZHA setup process. T
| [Tube's CC2652P2 PoE-powered Zigbee to Ethernet Serial Coordinator)](https://www.tubeszb.com/) | Zeroconf | tube_zb_gw_cc2652p2_poe.local. |
| [Tube's EFR32 Based Zigbee to Ethernet Serial Coordinator)](https://www.tubeszb.com/) | Zeroconf | tube_zb_gw_efr32.local. |
Additional devices in the [Known working Zigbee radio modules](#known-working-zigbee-radio-modules) list may be discoverable, however, only devices that have been confirmed discoverable are listed above.
Additional devices in the [Compatible hardware](#compatible-hardware) section may be discoverable, however, only devices that have been confirmed discoverable are listed above.
### OTA updates of Zigbee device firmware
The ZHA integration has the ability to perform OTA (over-the-air) firmware updates of Zigbee devices. This feature is enabled by default. As it uses standard [Update](/integrations/update/) entities in Home Assistant, users will get a UI notification if and when an OTA firmware update is available for a specific device, with an option to initiate the update or ignore that specific update for the device.
To see OTA updates for a device, it's required that it both supports OTA updates and that firmware images for the device are publicly provided by the manufacturer. For this reason, ZHA currently only includes OTA providers for a few manufacturers that provide these updates publicly. This includes IKEA, Inovelli, Ledvacnce/OSRAM, SALUS/Computime, Sonoff/iTead, and Third Reality.
To see OTA updates for a device, it must support OTA updates and firmware images for the device must be publicly provided by the manufacturer. ZHA currently only includes OTA providers for a few manufacturers that provide these updates publicly.
**Included manufacturers:**
- IKEA
- Inovelli
- Ledvacnce/OSRAM
- SALUS/Computime
- Sonoff/iTead
- Third Reality
{% warning %}
Before updating a device, you should search for any disadvantages or if you even need to install an available update. Some firmware updates can break features you might use (e.g. group binding for IKEA devices). Some updates might also require changes to ZHA. In rare cases, you can even brick devices by installing a firmware update.
@ -247,7 +252,7 @@ Group members assume state of group:
description: "When using ZHA groups, turning on a ZHA group light makes the ZHA group members optimistically change their state to \"on\", instead of waiting and polling the lights when off. _(default: on)_"
{% endconfiguration_basic %}
## Configuration - YAML
### Configuration - YAML
For more advanced configuration, you can modify {% term "`configuration.yaml`" %} and restart Home Assistant
@ -267,15 +272,15 @@ custom_quirks_path:
type: string
{% endconfiguration %}
### Advanced OTA configuration
#### Advanced OTA configuration
OTA for a few manufacturers is enabled by default, currently Ledvance, Sonoff, Inovelli, and ThirdReality. Other manufacturers are supported but disabled by default because their updates may change or remove device functionality, may require you to reconfigure devices, or are contributed by the community and may be minimally tested.
Refer to the [zigpy documentation for OTA configuration](https://github.com/zigpy/zigpy/wiki/OTA-Configuration) for more information on additional OTA providers.
### Defining Zigbee channel to use
#### Defining Zigbee channel to use
Tip! Before considering to change to an other Zigbee channel on an existing Zigbee network, it is highly recommended that you read through the two segments under the [troubleshooting](#troubleshooting) section below about "*Best practices to avoid pairing/connection difficulties*" and "*Zigbee interference avoidance and network range/coverage optimization*". These sections provide prerequisite information and advice on how to achieve the best possible Zigbee network in your environment.
Tip! Before considering to change to an other Zigbee channel on an existing Zigbee network, it is highly recommended that you read through the two segments under the [troubleshooting](#troubleshooting) section below about _Best practices to avoid pairing/connection difficulties_ and _Zigbee interference avoidance and network range/coverage optimization_. These sections provide prerequisite information and advice on how to achieve the best possible Zigbee network in your environment.
ZHA prefers to use Zigbee channel 15 by default. You can change this using YAML configuration, but this only works
if there's no existing network. To change the channel for an existing network, radio has to be factory reset and a new network to be formed. This requires re-pairing of all the devices.
@ -288,15 +293,19 @@ zha:
channels: [15, 20, 25] # Channel mask
```
Note! The best practice is to not change the Zigbee channel from the ZHA default. Also, the related troubleshooting segments mentioned in the tip above will, among other things, inform that if you have issues with overlapping frequencies between Wi-Fi and Zigbee, then it is usually better to first only try changing and setting a static Wi-Fi channel on your Wi-Fi router or all your Wi-Fi access points (instead of just changing to another Zigbee channel).
{% note %}
The best practice is to not change the Zigbee channel from the ZHA default.
{% endnote %}
MetaGeek Support has a good reference article about channel selection for [Zigbee and WiFi coexistance](https://support.metageek.com/hc/en-us/articles/203845040-ZigBee-and-WiFi-Coexistence).
The related troubleshooting segments mentioned above will, among other things, inform that if you have issues with overlapping frequencies between Wi-Fi and Zigbee, then it is usually better to first only try changing and setting a static Wi-Fi channel on your Wi-Fi router or all your Wi-Fi access points (instead of just changing to another Zigbee channel).
MetaGeek Support has a good reference article about channel selection for [Zigbee and WiFi coexistence](https://support.metageek.com/hc/en-us/articles/203845040-ZigBee-and-WiFi-Coexistence).
The Zigbee specification standards divide the 2.4&nbsp;GHz ISM radio band into 16 Zigbee channels (i.e. distinct radio frequencies for Zigbee). For all Zigbee devices to be able to communicate, they must support the same Zigbee channel (i.e. Zigbee radio frequency) that is set on the Zigbee Coordinator as the channel to use for its Zigbee network. Not all Zigbee devices support all Zigbee channels. Channel support usually depends on the age of the hardware and firmware, as well as on the device's power ratings.
The general recommendation is to only use channels 15, 20, or 25 in order to avoid interoperability problems with Zigbee devices. Not only because there is less chance of Wi-Fi networks interfering too much with the Zigbee network on other channels, but also because not all Zigbee devices support all channels. Some devices, for example, are limited to only being compatible with ZLL (Zigbee Light Link) channels. It is therefore especially not recommended to use Zigbee channels 11, 24, 25, or 26 on your Zigbee coordinator. These Zigbee channels are commonly only supported by relatively modern Zigbee hardware devices with newer Zigbee firmware. If using those channels, your coordinator may not be usable with older Zigbee devices.
### Modifying the device type
#### Modifying the device type
As not all device manufacturers follow the Zigbee standard, at times a device can be incorrectly classified. For example, a switch could be classified as a light.
@ -335,11 +344,10 @@ from the same group:
{% note %}
Currently `qr_code` supports QR Install Codes from:
- Aqara
- Bosch
- Consciot
- Embrighten
- Aqara
- Bosch
- Consciot
- Embrighten
{% endnote %}
### Action `zha.remove`
@ -385,7 +393,7 @@ This action disables a lock code on a Zigbee lock.
## Adding devices
Tip! It is highly recommended that you read through the two segments under the troubleshooting section below about "*Best practices to avoid pairing/connection difficulties*" and "*Zigbee interference avoidance and network range/coverage optimization*" for general prerequisite knowledge and advice on how to achieve the best possible Zigbee network in your environment.
Tip! It is highly recommended that you read through the two segments under the troubleshooting section below about _Best practices to avoid pairing/connection difficulties_ and _Zigbee interference avoidance and network range/coverage optimization_ for general prerequisite knowledge and advice on how to achieve the best possible Zigbee network in your environment.
**To add a new Zigbee device:**
@ -397,7 +405,7 @@ Tip! It is highly recommended that you read through the two segments under the t
### Using router devices to add more devices
Most mains-powered devices, e.g., many always-powered wall plugs or light bulbs in your Zigbee network will automatically act as a Zigbee router device (sometimes also referred to as a Zigbee "signal repeater" or "range extender").
Most mains-powered devices, e.g., many always-powered wall plugs or light bulbs in your Zigbee network will automatically act as a Zigbee router device (sometimes also referred to as a Zigbee "signal repeater" or "range extender").
Because Zigbee should use a [wireless mesh network](https://en.wikipedia.org/wiki/Wireless_mesh_network) to be effective, you will need to add Zigbee router devices to increase the number of Zigbee devices that can be used in your Zigbee network, both in the total number of devices that can be added as well as the total range and coverage of the network. Some Zigbee router devices do a much better job at routing and repeating Zigbee signals and messages than some other devices. You should not have a setup where Zigbee router devices (e.g. light bulbs) are often powered-off. Zigbee router devices are meant to be always available.
@ -467,7 +475,7 @@ Follow this guide if you have a Zigbee Home Assistant (ZHA) network running and
- Select **Submit**.
6. **Unplug your old radio** will inform you that your old Zigbee coordinator radio has been reset and that you can now plug in your new Zigbee coordinator radio adapter.
- To avoid interference, use a USB extension cable.
- Use a USB 2.0 port or a powered USB 2.0 hub and keep the Zigbee stick away from USB 3.0 devices.
- Use a USB 2.0 port or a powered USB 2.0 hub and keep the Zigbee stick away from USB 3.0 devices.
- You may now also choose to either unplug your old Zigbee coordinator radio adapter or keep your old radio plugged in.
- If that radio was a combined Z-Wave and Zigbee radio, like the HUSBZB-1 adapter, then only the Zigbee radio part of it was reset. Confirm that the Zigbee Coordinator radio adapter is properly connected and select **Submit**.
7. You now need to start the backup restore process.
@ -487,17 +495,21 @@ The migration process is complete. However, be aware that you will not be able t
## Troubleshooting
To help resolve any kinks or compatibility problems, report bugs as issues with debug logs. Please note the current limitations and follow the instructions in this troubleshooting section.
Please note the current limitations and follow the instructions in this troubleshooting section.
### Limitations
{% note %}
To help resolve any kinks or compatibility problems, report bugs as issues with debug logs.
{% endnote %}
Note that ZHA only supports connecting a single dedicated Zigbee Coordinator radio adapter or module with a single Zigbee network and that the Zigbee Coordinator cannot already be connected or used by any other application. Any devices that are or have previously been connected to another Zigbee implementation will also need to first be reset to their factory default settings before they can be paired/joined to ZHA, please see each device manufacturer's documentation.
### Limitations
Any Zigbee device can only be connected to a single Zigbee Coordinator (only one Zigbee gateway). This is a limitation in the current (as well as previous) Zigbee protocol specifications, governed by the [CSA (Connectivity Standards Alliance)](https://csa-iot.org/all-solutions/zigbee/). As such, it is a limit that applies to all Zigbee implementations, not just the ZHA implementation.
ZHA only supports connecting a single dedicated Zigbee Coordinator radio adapter or module with a single Zigbee network. The Zigbee Coordinator cannot already be connected or used by any other application. Devices currently or previously connected to another Zigbee implementation will need to be reset to their factory default settings before they can be paired/joined to ZHA. Refer to each device manufacturer's documentation for reset steps.
Any Zigbee device can only be connected to a single Zigbee Coordinator (only one Zigbee gateway). This is a limitation in the Zigbee protocol specifications, governed by the [CSA (Connectivity Standards Alliance)](https://csa-iot.org/all-solutions/zigbee/), applying to all Zigbee implementations and not just the ZHA implementation.
Support for commissioning Zigbee 3.0 devices via "Install Code" or "QR Code" via the `zha.permit` action has so far only been implemented for 'ezsp' (Silicon Labs EmberZNet) or 'znp' (Texas Instruments) radio type in ZHA. Other radio types are missing support in their respective [radio libraries for zigpy](https://github.com/zigpy/) or manufacturer's firmware commands/APIs.
ZHA does currently not support devices that can only use the ZGP ("Zigbee Green Power") profile which is used in a few batteryless self-powered or energy harvesting devices, (such as for example; Philips Hue Click, Philips Hue Tap, and some "Friends of Hue" partnership switches).
ZHA currently does not support devices that can only use the ZGP ("Zigbee Green Power") profile which is used in a few batteryless self-powered or energy harvesting devices, (such as for example; Philips Hue Click, Philips Hue Tap, and some "Friends of Hue" partnership switches).
ZHA does not currently support devices that can only use the ZSE ("Zigbee Smart Energy") profile, that is however due to the "Zigbee SE" specification not being part of the standard Zigbee 3.0 specification and thus not implemented in most of the Zigbee protocol stacks that are commonly available Zigbee Coordinator radio adapters and modules.
@ -514,7 +526,8 @@ Tip to new Zigbee users: Checkout [blakadder's unofficial Zigbee Device Compatib
### How to add support for new and unsupported devices
If your Zigbee device pairs/joins successfully with the ZHA {% term integration %} but does not show all of the expected entities:
If your Zigbee device pairs/joins successfully with the ZHA {% term integration %} but does not show all of the expected entities:
1. Try to re-pair/re-join the device several times.
2. Checkout the troubleshooting section.
3. Still not working? You may need a custom device handler. This handler will have exception handling code to work around device-specific issues.
@ -523,13 +536,14 @@ For devices that do not follow the standard defined in the CSA's ZCL (Zigbee Clu
People familiar with other Zigbee gateway solutions for home automation may know similar concepts of using custom Zigbee device handlers/converters for non-standard devices. For example, [Zigbee2MQTT (and IoBroker) uses zigbee-herdsman converters](https://www.zigbee2mqtt.io/advanced/support-new-devices/01_support_new_devices.html) and [SmartThings Classics (Legacy) platform has Hub Connected Device Handlers](https://developer.smartthings.com/docs/devices/hub-connected/legacy).
If you do not want to develop such a "quirk" Python script yourself, you can submit a "device support request" as a new issue to the [ZHA Device Handlers project repository on GitHub](https://github.com/zigpy/zha-device-handlers/issues):
1. Sign in to GitHub.
2. Select **New issue** and follow the instructions.
- New device support requests require the device signature + diagnostic information.
- You may also need to actively help in further testing or provide additional information to the volunteering developers.
If you do not want to develop such a "quirk" Python script yourself, you can submit a "device support request" as a new issue to the [ZHA Device Handlers project repository on GitHub](https://github.com/zigpy/zha-device-handlers/issues):
Note that submitting a new "device support request" does not guarantee that someone else will develop a custom "quirk" for ZHA. The project relies on volunteering developers. However, without "device support requests", the developers may not be aware that your specific Zigbee device is not working correctly in ZHA.
1. Sign in to GitHub.
2. Select **New issue** and follow the instructions.
- New device support requests require the device signature + diagnostic information.
- You may also need to actively help in further testing or provide additional information to the volunteering developers.
Note that submitting a new "device support request" does not guarantee that someone else will develop a custom "quirk" for ZHA. The project relies on volunteering developers. However, without "device support requests", the developers may not be aware that your specific Zigbee device is not working correctly in ZHA.
### Best practices to avoid pairing/connection difficulties
@ -538,15 +552,15 @@ If you experience problems pairing a device, verify that you follow best practic
- Check that your setup and environment are optimized to avoid interference.
- As interference avoidance is an extremely important topic on its own, please read and follow the tips in the separate section below about Zigbee interference avoidance and network range/coverage optimization.
- Check that you have enough Zigbee router devices (also known as Zigbee signal repeaters or range extenders) and if you do not have any, invest and add some mains-powered devices that will work as Zigbee routers.
- Aim to start out with mains-powered devices before adding battery-operated devices as a "weak" Zigbee network mesh (e.g., the device is too far from the Zigbee coordinator or a Zigbee router) may prevent some devices from being paired. Zigbee router devices are also needed to increase the maximum of devices that can be connected to your Zigbee mesh network.
- Note that some Zigbee devices are not fully compatible with all brands of Zigbee router devices. Xiaomi/Aqara devices are for example known not to work with Zigbee router devices from Centralite, General Electrics, Iris, Ledvance/OSRAM, LIGHTIFY/Sylvania, Orvibo, PEQ, Securifi, and SmartThings/Samsung. Better results can usually be achieved by using mains-powered devices IKEA and Nue/3A Home or dedicated DIY routing devices based on Texas Instruments CC253x/CC26x2 and XBee Series 2/3 Zigbee radios.
- Aim to start out with mains-powered devices before adding battery-operated devices as a "weak" Zigbee network mesh (e.g., the device is too far from the Zigbee coordinator or a Zigbee router) may prevent some devices from being paired. Zigbee router devices are also needed to increase the maximum of devices that can be connected to your Zigbee mesh network.
- Note that some Zigbee devices are not fully compatible with all brands of Zigbee router devices. Xiaomi/Aqara devices are for example known not to work with Zigbee router devices from Centralite, General Electrics, Iris, Ledvance/OSRAM, LIGHTIFY/Sylvania, Orvibo, PEQ, Securifi, and SmartThings/Samsung. Better results can usually be achieved by using mains-powered devices IKEA and Nue/3A Home or dedicated DIY routing devices based on Texas Instruments CC253x/CC26x2 and XBee Series 2/3 Zigbee radios.
- If possible try to pair your Zigbee devices in their intended final location, (and not pair it next to the Zigbee coordinator and then need to move it after).
- Pairing a Zigbee device next to the Zigbee coordinator and then moving it later can result in dropped/lost connections or other issues.
- If the device you want to add is not brand new and as such never paired before then you always have to make sure to first manually reset the device to its factory default settings before you will be able to add/pair it.
- Some battery-operated Zigbee devices are known to have problems with pairing if they have Low battery voltage.
- Some people have reported replacing the battery on their newly received Xiaomi/Aqara devices solved pairing issues.
- Some people have reported replacing the battery on their newly received Xiaomi/Aqara devices solved pairing issues.
- Be patient as the pairing of some Zigbee devices may require multiple attempts and you may sometimes need to try again and again.
- Some devices, like example those from Xiaomi/Aqara, are known to not be 100% compliant with the standard Zigbee specifications and may therefore require many paring attempts over 10-20 minutes or longer.
- Some devices, like example those from Xiaomi/Aqara, are known to not be 100% compliant with the standard Zigbee specifications and may therefore require many paring attempts over 10-20 minutes or longer.
### Zigbee interference avoidance and network range/coverage optimization
@ -569,13 +583,13 @@ Common root causes of unreliable performance are often seen with outdated Zigbee
- Update to a later version of Zigbee Coordinator firmware on the existing radio adapter.
- Most manufacturers usually provide straightforward guides for updating the firmware.
- Try different physical placement and orientations of the Zigbee Coordinator and its antenna.
- Optimal placement of the Zigbee adapter is close to the middle of the house as possible.
- Try placing Zigbee Coordinator at some distance away from walls, ceilings, and floors.
- Try different orientations of the Zigbee Coordinator adapter or its antenna.
While using an older Zigbee Coordinator radio adapter hardware might work, using obsolete hardware and/or old firmware can prevent reliable operation. It is also generally a good idea to upgrade Zigbee Coordinator firmware before troubleshooting any further if and when run into problems with devices.
While using an older Zigbee Coordinator radio adapter hardware might work, using obsolete hardware and/or old firmware can prevent reliable operation. It is also generally a good idea to upgrade Zigbee Coordinator firmware before troubleshooting any further if and when run into problems with devices.
#### Actions to avoid or workaround EMI/EMF/RMI interference
@ -587,7 +601,7 @@ Since all Zigbee Coordinator radio adapters are very sensitive/susceptible to al
- Extension cables also makes it easier to try different orientations of the adapter/antenna.
- Avoid USB 3.0 ports/computers/peripherals as they are known culprits of RFI/EMI/EMF disruption. (See Ref. [1](https://www.usb.org/sites/default/files/327216.pdf) and [2](https://www.unit3compliance.co.uk/2-4ghz-intra-system-or-self-platform-interference-demonstration/)).
- Make sure to only connect the Zigbee USB adapter to a USB 2.0 port (and not to a USB 3.x port).
- Make sure to only connect the Zigbee USB adapter to a USB 2.0 port (and not to a USB 3.x port).
- If a computer only has USB 3.x ports then buy and connect Zigbee Coordinator via a powered USB 2.0 hub.
- Shield any unshielded computers/peripherals/devices by adding all-metal enclosures/chassis/casings.
@ -615,6 +629,7 @@ Missing links between Zigbee end devices (often battery-powered devices) in the
Some end devices (for example, Xiaomi door sensors) sleep for an extended period, causing the parent Zigbee Router to remove them from its child table via a feature called router child aging. Since using child aging and removing them from the child table is a Zigbee 3.0 feature, this does not always occur because not all Zigbee router devices use child aging.
This is what causes devices to show a missing link. Even though the device is no longer in the child table, the end device can still communicate via the parent Zigbee router.
#### How to interpret RSSI and LQI values
Interpreting RSSI and LQI values can be complex, as metrics of network health and communication quality are provided by the devices themselves, and each device could get to its results in different ways. Unless you are a Zigbee specialist yourself or are guided by one, please ignore those values. They can be misleading. If you delve into this, it is important to understand not to judge RSSI or LQI values on their own. When troubleshooting Zigbee messages that are being dropped, you must interpret the combination of both RSSI and LQI.
@ -641,7 +656,7 @@ When reporting potential bugs related to the ZHA integration on the issues track
1. Debug logs for the issue, see [debug logging](#debug-logging).
2. Exact model and firmware of the Zigbee radio (Zigbee Coordinator adapter) being used.
3. If the issue is related to a specific Zigbee device, provide both the **Zigbee Device Signature** and the **Diagnostics** information.
- Both the **Zigbee Device Signature** and the **Diagnostics** information can be found under {% my integrations title="**Settings** > **Devices & services**" %}. Select the **Zigbee Home Automation** integration. Then, select **Configure** > **Devices** (pick your device). Select **Zigbee Device Signature** and **Download Diagnostics**, respectively.
- Both the **Zigbee Device Signature** and the **Diagnostics** information can be found under {% my integrations title="**Settings** > **Devices & services**" %}. Select the **Zigbee Home Automation** integration. Then, select **Configure** > **Devices** (pick your device). Select **Zigbee Device Signature** and **Download Diagnostics**, respectively.
Note: Please also make sure you give it your best effort to follow the recommended best practices for avoiding both [pairing/connection difficulties](#best-practices-to-avoid-pairingconnection-difficulties) and [Zigbee interference](#zigbee-interference-avoidance-and-network-rangecoverage-optimization), (which helps free up time for developers).

13
source/_integrations/zwave_js.markdown
View File

@ -1003,6 +1003,19 @@ This association group is used when Home Assistant [resets the Z-Wave controller
Under normal circumstances, it is not necessary to add a device to this group.
## Identification via Z-Wave
Other Z-Wave devices can instruct a Home Assistant instance to identify itself by sending the following `Indicator Set` Z-Wave command (all bytes are hexadecimal):
```txt
87010003500308500403500506
~~ ~~ ~~
```
The bytes underlined with `~` can also have any other value.
When receiving such a command, Home Assistant will show a notification in its sidebar, mentioning which node sent the command.
## Z-Wave Command Classes Home Assistant responds to when queried
The following table lists the Command Classes together with the implemented version and required security class. These are the Command Classes that Home Assistant will respond to when queried by other devices.

4
source/_posts/2022-12-20-year-of-voice.markdown
View File

@ -23,6 +23,10 @@ _**TL;DR**: It is our goal for 2023 to let users control Home Assistant in their
- [Year of the Voice - Chapter 4](/blog/2023/10/12/year-of-the-voice-chapter-4-wakewords/) (October 12, 2023)
- [Year of the Voice - Chapter 5](/blog/2023/12/13/year-of-the-voice-chapter-5/) (December 13, 2023)
- [Voice - Chapter 6](/blog/2024/02/21/voice-chapter-6/) (February 21, 2024)
- [Voice - Chapter 7](/blog/2024/06/26/voice-chapter-7/) (June 26, 2024)
- [Voice - Chapter 8](/blog/2024/12/19/voice-chapter-8-assist-in-the-home/) (December 19, 2024)
- [Voice - Chapter 9](/blog/2025/02/13/voice-chapter-9-speech-to-phrase/) (February 13, 2024)
<hr>

357
source/_posts/2025-02-05-release-20252.markdown
View File

@ -71,6 +71,12 @@ _PS: It is almost Valentine's day, did you set up some romantic scenes yet? 🌹
- [Other noteworthy changes](#other-noteworthy-changes)
- [Bluetooth config panel](#bluetooth-config-panel)
- [Preparing our graphs for the future](#preparing-our-graphs-for-the-future)
- [Patch releases](#patch-releases)
- [2025.2.1 - February 7](#202521---february-7)
- [2025.2.2 - February 10](#202522---february-10)
- [2025.2.3 - February 12](#202523---february-12)
- [2025.2.4 - February 14](#202524---february-14)
- [2025.2.5 - February 21](#202525---february-21)
- [Need help? Join the community!](#need-help-join-the-community)
- [Backward-incompatible changes](#backward-incompatible-changes)
- [All changes](#all-changes)
@ -473,6 +479,351 @@ However, this change is a preparation for the future. We have many plans and
ideas for our graphs, and this change was a necessary step to make those plans
possible.
## Patch releases
We will also release patch releases for Home Assistant 2025.2 in February.
These patch releases only contain bug fixes. Our goal is to release a patch
release every Friday.
### 2025.2.1 - February 7
- Fix hassio test using wrong fixture ([@emontnemery] - [#137516])
- Change Electric Kiwi authentication ([@mikey0000] - [#135231])
- Update govee-ble to 0.42.1 ([@cdce8p] - [#137371])
- Bump holidays to 0.66 ([@gjohansson-ST] - [#137449])
- Bump aiohttp-asyncmdnsresolver to 0.1.0 ([@bdraco] - [#137492])
- Bump aiohttp to 3.11.12 ([@bdraco] - [#137494])
- Bump govee-ble to 0.43.0 to fix compat with new H5179 firmware ([@bdraco] - [#137508])
- Bump habiticalib to v0.3.5 ([@tr4nt0r] - [#137510])
- Fix Mill issue, where no sensors were shown ([@Danielhiversen] - [#137521])
- Don't overwrite setup state in async_set_domains_to_be_loaded ([@emontnemery] - [#137547])
- Use separate metadata files for onedrive ([@zweckj] - [#137549])
- Fix sending polls to Telegram threads ([@jwhb] - [#137553])
- Skip building wheels for electrickiwi-api ([@cdce8p] - [#137556])
- Add excluded domains to broadcast intent ([@synesthesiam] - [#137566])
- Revert "Add `PaddleSwitchPico` (Pico Paddle Remote) device trigger to Lutron Caseta" ([@bdraco] - [#137571])
- Fix Overseerr webhook configuration JSON ([@denniseffing] - [#137572])
- Do not rely on pyserial for port scanning with the CM5 + ZHA ([@puddly] - [#137585])
- Bump eheimdigital to 1.0.6 ([@autinerd] - [#137587])
- Bump pyfireservicerota to 0.0.46 ([@cyberjunky] - [#137589])
- Bump reolink-aio to 0.11.10 ([@starkillerOG] - [#137591])
- Allow to omit the payload attribute to MQTT publish action to allow an empty payload to be sent by default ([@jbouwh] - [#137595])
- Handle previously migrated HEOS device identifier ([@andrewsayre] - [#137596])
- Bump `aioshelly` to version `12.4.1` ([@bieniu] - [#137598])
- Bump electrickiwi-api to 0.9.13 ([@mikey0000] - [#137601])
- Bump ZHA to 0.0.48 ([@TheJulianJES] - [#137610])
- Bump Electrickiwi-api to 0.9.14 ([@mikey0000] - [#137614])
- Update google-nest-sdm to 7.1.3 ([@allenporter] - [#137625])
- Don't use the current temperature from Shelly BLU TRV as a state for External Temperature number entity ([@bieniu] - [#137658])
- Fix LG webOS TV turn off when device is already off ([@thecode] - [#137675])
[#135231]: https://github.com/home-assistant/core/pull/135231
[#137371]: https://github.com/home-assistant/core/pull/137371
[#137448]: https://github.com/home-assistant/core/pull/137448
[#137449]: https://github.com/home-assistant/core/pull/137449
[#137492]: https://github.com/home-assistant/core/pull/137492
[#137494]: https://github.com/home-assistant/core/pull/137494
[#137508]: https://github.com/home-assistant/core/pull/137508
[#137510]: https://github.com/home-assistant/core/pull/137510
[#137516]: https://github.com/home-assistant/core/pull/137516
[#137521]: https://github.com/home-assistant/core/pull/137521
[#137547]: https://github.com/home-assistant/core/pull/137547
[#137549]: https://github.com/home-assistant/core/pull/137549
[#137553]: https://github.com/home-assistant/core/pull/137553
[#137556]: https://github.com/home-assistant/core/pull/137556
[#137566]: https://github.com/home-assistant/core/pull/137566
[#137571]: https://github.com/home-assistant/core/pull/137571
[#137572]: https://github.com/home-assistant/core/pull/137572
[#137585]: https://github.com/home-assistant/core/pull/137585
[#137587]: https://github.com/home-assistant/core/pull/137587
[#137589]: https://github.com/home-assistant/core/pull/137589
[#137591]: https://github.com/home-assistant/core/pull/137591
[#137595]: https://github.com/home-assistant/core/pull/137595
[#137596]: https://github.com/home-assistant/core/pull/137596
[#137598]: https://github.com/home-assistant/core/pull/137598
[#137601]: https://github.com/home-assistant/core/pull/137601
[#137610]: https://github.com/home-assistant/core/pull/137610
[#137614]: https://github.com/home-assistant/core/pull/137614
[#137625]: https://github.com/home-assistant/core/pull/137625
[#137658]: https://github.com/home-assistant/core/pull/137658
[#137675]: https://github.com/home-assistant/core/pull/137675
[@Danielhiversen]: https://github.com/Danielhiversen
[@TheJulianJES]: https://github.com/TheJulianJES
[@allenporter]: https://github.com/allenporter
[@andrewsayre]: https://github.com/andrewsayre
[@autinerd]: https://github.com/autinerd
[@bdraco]: https://github.com/bdraco
[@bieniu]: https://github.com/bieniu
[@cdce8p]: https://github.com/cdce8p
[@cyberjunky]: https://github.com/cyberjunky
[@denniseffing]: https://github.com/denniseffing
[@emontnemery]: https://github.com/emontnemery
[@frenck]: https://github.com/frenck
[@gjohansson-ST]: https://github.com/gjohansson-ST
[@jbouwh]: https://github.com/jbouwh
[@jwhb]: https://github.com/jwhb
[@mikey0000]: https://github.com/mikey0000
[@puddly]: https://github.com/puddly
[@starkillerOG]: https://github.com/starkillerOG
[@synesthesiam]: https://github.com/synesthesiam
[@thecode]: https://github.com/thecode
[@tr4nt0r]: https://github.com/tr4nt0r
[@zweckj]: https://github.com/zweckj
### 2025.2.2 - February 10
- LaCrosse View new endpoint ([@IceBotYT] - [#137284])
- Convert coinbase account amounts as floats to properly add them together ([@natekspencer] - [#137588])
- Bump ohmepy to 1.2.9 ([@dan-r] - [#137695])
- Bump onedrive_personal_sdk to 0.0.9 ([@zweckj] - [#137729])
- Limit habitica ConfigEntrySelect to integration domain ([@cdce8p] - [#137767])
- Limit nordpool ConfigEntrySelect to integration domain ([@cdce8p] - [#137768])
- Limit transmission ConfigEntrySelect to integration domain ([@cdce8p] - [#137769])
- Fix tplink child updates taking up to 60s ([@bdraco] - [#137782])
- Call backup listener during setup in Google Drive ([@tronikos] - [#137789])
- Use the external URL set in Settings > System > Network if my is disabled as redirect URL for Google Drive instructions ([@tronikos] - [#137791])
- Fix manufacturer_id matching for 0 ([@patman15] - [#137802])
- Fix DAB radio in Onkyo ([@arturpragacz] - [#137852])
- Fix LG webOS TV fails to setup when device is off ([@thecode] - [#137870])
- Fix heos migration ([@balloob] - [#137887])
- Bump pydrawise to 2025.2.0 ([@dknowles2] - [#137961])
- Bump aioshelly to version 12.4.2 ([@bieniu] - [#137986])
- Prevent crash if telegram message failed and did not generate an ID ([@CloCkWeRX] - [#137989])
- Bump habiticalib to v0.3.7 ([@tr4nt0r] - [#137993])
- Refresh the nest authentication token on integration start before invoking the pub/sub subsciber ([@allenporter] - [#138003])
- Use resumable uploads in Google Drive ([@tronikos] - [#138010])
- Bump py-synologydsm-api to 2.6.2 ([@mib1185] - [#138060])
- Handle generic agent exceptions when getting and deleting backups ([@abmantis] - [#138145])
- Bump onedrive-personal-sdk to 0.0.10 ([@zweckj] - [#138186])
- Keep one backup per backup agent when executing retention policy ([@emontnemery] - [#138189])
- Improve inexogy logging when failed to update ([@jpbede] - [#138210])
- Bump pyheos to v1.0.2 ([@andrewsayre] - [#138224])
- Update frontend to 20250210.0 ([@bramkragten] - [#138227])
- Bump lacrosse-view to 1.1.1 ([@IceBotYT] - [#137282])
[#137282]: https://github.com/home-assistant/core/pull/137282
[#137284]: https://github.com/home-assistant/core/pull/137284
[#137448]: https://github.com/home-assistant/core/pull/137448
[#137588]: https://github.com/home-assistant/core/pull/137588
[#137688]: https://github.com/home-assistant/core/pull/137688
[#137695]: https://github.com/home-assistant/core/pull/137695
[#137729]: https://github.com/home-assistant/core/pull/137729
[#137767]: https://github.com/home-assistant/core/pull/137767
[#137768]: https://github.com/home-assistant/core/pull/137768
[#137769]: https://github.com/home-assistant/core/pull/137769
[#137782]: https://github.com/home-assistant/core/pull/137782
[#137789]: https://github.com/home-assistant/core/pull/137789
[#137791]: https://github.com/home-assistant/core/pull/137791
[#137802]: https://github.com/home-assistant/core/pull/137802
[#137852]: https://github.com/home-assistant/core/pull/137852
[#137870]: https://github.com/home-assistant/core/pull/137870
[#137887]: https://github.com/home-assistant/core/pull/137887
[#137961]: https://github.com/home-assistant/core/pull/137961
[#137986]: https://github.com/home-assistant/core/pull/137986
[#137989]: https://github.com/home-assistant/core/pull/137989
[#137993]: https://github.com/home-assistant/core/pull/137993
[#138003]: https://github.com/home-assistant/core/pull/138003
[#138010]: https://github.com/home-assistant/core/pull/138010
[#138060]: https://github.com/home-assistant/core/pull/138060
[#138145]: https://github.com/home-assistant/core/pull/138145
[#138186]: https://github.com/home-assistant/core/pull/138186
[#138189]: https://github.com/home-assistant/core/pull/138189
[#138210]: https://github.com/home-assistant/core/pull/138210
[#138224]: https://github.com/home-assistant/core/pull/138224
[#138227]: https://github.com/home-assistant/core/pull/138227
[@CloCkWeRX]: https://github.com/CloCkWeRX
[@IceBotYT]: https://github.com/IceBotYT
[@abmantis]: https://github.com/abmantis
[@allenporter]: https://github.com/allenporter
[@andrewsayre]: https://github.com/andrewsayre
[@arturpragacz]: https://github.com/arturpragacz
[@balloob]: https://github.com/balloob
[@bdraco]: https://github.com/bdraco
[@bieniu]: https://github.com/bieniu
[@bramkragten]: https://github.com/bramkragten
[@cdce8p]: https://github.com/cdce8p
[@dan-r]: https://github.com/dan-r
[@dknowles2]: https://github.com/dknowles2
[@emontnemery]: https://github.com/emontnemery
[@frenck]: https://github.com/frenck
[@jpbede]: https://github.com/jpbede
[@mib1185]: https://github.com/mib1185
[@natekspencer]: https://github.com/natekspencer
[@patman15]: https://github.com/patman15
[@thecode]: https://github.com/thecode
[@tr4nt0r]: https://github.com/tr4nt0r
[@tronikos]: https://github.com/tronikos
[@zweckj]: https://github.com/zweckj
### 2025.2.3 - February 12
- Bump hass-nabucasa from 0.88.1 to 0.89.0 ([@ludeeus] - [#137321])
- Move cloud backup upload/download handlers to lib ([@ludeeus] - [#137416])
- Handle non-retryable errors when uploading cloud backup ([@ludeeus] - [#137517])
- Add missing thermostat state EMERGENCY_HEAT to econet ([@jdanders] - [#137623])
- Fix broken issue creation in econet ([@jdanders] - [#137773])
- Fix version extraction for APsystems ([@alfwro13] - [#138023])
- Refresh nest access token before before building subscriber Credentials ([@allenporter] - [#138259])
- Fix BackupManager.async_delete_backup ([@emontnemery] - [#138286])
- Fix next authentication token error handling ([@allenporter] - [#138299])
- Bump pyenphase to 1.25.1 ([@catsmanac] - [#138327])
- Bump sentry-sdk to 1.45.1 ([@edenhaus] - [#138349])
- Bump zeroconf to 0.144.1 ([@bdraco] - [#138353])
- Bump cryptography to 44.0.1 ([@edenhaus] - [#138371])
- Fix tplink iot strip sensor refresh ([@sdb9696] - [#138375])
- Bump deebot-client to 12.1.0 ([@edenhaus] - [#138382])
- Bump hass-nabucasa from 0.89.0 to 0.90.0 ([@emontnemery] - [#138387])
- Update cloud backup agent to use calculate_b64md5 from lib ([@emontnemery] - [#138391])
[#137321]: https://github.com/home-assistant/core/pull/137321
[#137416]: https://github.com/home-assistant/core/pull/137416
[#137448]: https://github.com/home-assistant/core/pull/137448
[#137517]: https://github.com/home-assistant/core/pull/137517
[#137623]: https://github.com/home-assistant/core/pull/137623
[#137688]: https://github.com/home-assistant/core/pull/137688
[#137773]: https://github.com/home-assistant/core/pull/137773
[#138023]: https://github.com/home-assistant/core/pull/138023
[#138231]: https://github.com/home-assistant/core/pull/138231
[#138259]: https://github.com/home-assistant/core/pull/138259
[#138286]: https://github.com/home-assistant/core/pull/138286
[#138299]: https://github.com/home-assistant/core/pull/138299
[#138327]: https://github.com/home-assistant/core/pull/138327
[#138349]: https://github.com/home-assistant/core/pull/138349
[#138353]: https://github.com/home-assistant/core/pull/138353
[#138371]: https://github.com/home-assistant/core/pull/138371
[#138375]: https://github.com/home-assistant/core/pull/138375
[#138382]: https://github.com/home-assistant/core/pull/138382
[#138387]: https://github.com/home-assistant/core/pull/138387
[#138391]: https://github.com/home-assistant/core/pull/138391
[@alfwro13]: https://github.com/alfwro13
[@allenporter]: https://github.com/allenporter
[@bdraco]: https://github.com/bdraco
[@catsmanac]: https://github.com/catsmanac
[@edenhaus]: https://github.com/edenhaus
[@emontnemery]: https://github.com/emontnemery
[@frenck]: https://github.com/frenck
[@jdanders]: https://github.com/jdanders
[@ludeeus]: https://github.com/ludeeus
[@sdb9696]: https://github.com/sdb9696
### 2025.2.4 - February 14
- Bump python-kasa to 0.10.2 ([@sdb9696] - [#138381])
- Bump hass-nabucasa from 0.90.0 to 0.91.0 ([@ludeeus] - [#138441])
- Bump aiowebostv to 0.6.2 ([@thecode] - [#138488])
- Bump ZHA to 0.0.49 to fix Tuya TRV issues ([@TheJulianJES] - [#138492])
- Bump pyseventeentrack to 1.0.2 ([@shaiu] - [#138506])
- Bump hass-nabucasa from 0.91.0 to 0.92.0 ([@emontnemery] - [#138510])
- Bump py-synologydsm-api to 2.6.3 ([@mib1185] - [#138516])
- Update frontend to 20250214.0 ([@bramkragten] - [#138521])
[#137448]: https://github.com/home-assistant/core/pull/137448
[#137688]: https://github.com/home-assistant/core/pull/137688
[#138231]: https://github.com/home-assistant/core/pull/138231
[#138381]: https://github.com/home-assistant/core/pull/138381
[#138408]: https://github.com/home-assistant/core/pull/138408
[#138441]: https://github.com/home-assistant/core/pull/138441
[#138488]: https://github.com/home-assistant/core/pull/138488
[#138492]: https://github.com/home-assistant/core/pull/138492
[#138506]: https://github.com/home-assistant/core/pull/138506
[#138510]: https://github.com/home-assistant/core/pull/138510
[#138516]: https://github.com/home-assistant/core/pull/138516
[#138521]: https://github.com/home-assistant/core/pull/138521
[@TheJulianJES]: https://github.com/TheJulianJES
[@bramkragten]: https://github.com/bramkragten
[@emontnemery]: https://github.com/emontnemery
[@frenck]: https://github.com/frenck
[@ludeeus]: https://github.com/ludeeus
[@mib1185]: https://github.com/mib1185
[@sdb9696]: https://github.com/sdb9696
[@shaiu]: https://github.com/shaiu
[@thecode]: https://github.com/thecode
### 2025.2.5 - February 21
- Adjust Tuya Water Detector to support 1 as an alarm state ([@petacz] - [#135933])
- Fix bug in set_preset_mode_with_end_datetime (wrong typo of frost_guard) ([@pectum83] - [#138402])
- Bump pyhive-integration to 1.0.2 ([@KJonline] - [#138569])
- Bump tesla-fleet-api to v0.9.10 ([@Bre77] - [#138575])
- Bump pysmarty2 to 0.10.2 ([@lucab-91] - [#138625])
- Rename "returned" state to "alert" ([@shaiu] - [#138676])
- Bump pyvesync for vesync ([@cdnninja] - [#138681])
- Opower: Fix unavailable "start date" and "end date" sensors ([@SaswatPadhi] - [#138694])
- Correct backup filename on delete or download of cloud backup ([@emontnemery] - [#138704])
- Correct invalid automatic backup settings when loading from store ([@emontnemery] - [#138716])
- Bump airgradient to 0.9.2 ([@joostlek] - [#138725])
- Clean up translations for mocked integrations inbetween tests ([@emontnemery] - [#138732])
- Bump pyrympro from 0.0.8 to 0.0.9 ([@nivstein] - [#138753])
- Don't allow setting backup retention to 0 days or copies ([@emontnemery] - [#138771])
- Fix TV input source option for Sonos Arc Ultra ([@PeteRager] - [#138778])
- Add assistant filter to expose entities list command ([@synesthesiam] - [#138817])
- Fix playback for encrypted Reolink files ([@starkillerOG] - [#138852])
- Correct backup date when reading a backup created by supervisor ([@emontnemery] - [#138860])
- Bump pyfritzhome to 0.6.15 ([@mib1185] - [#138879])
- Validate hassio backup settings ([@emontnemery] - [#138880])
- Catch zeep fault as well on GetSystemDateAndTime call. ([@DmitryKuzmenko] - [#138916])
- Fix Reolink callback id collision ([@starkillerOG] - [#138918])
- Fix handling of min/max temperature presets in AVM Fritz!SmartHome ([@mib1185] - [#138954])
- Bump pyprosegur to 0.0.13 ([@dgomes] - [#138960])
- Bump reolink-aio to 0.12.0 ([@starkillerOG] - [#138985])
- Bump deebot-client to 12.2.0 ([@edenhaus] - [#138986])
- Omit unknown hue effects ([@joostlek] - [#138992])
- Update frontend to 20250221.0 ([@bramkragten] - [#139006])
[#135933]: https://github.com/home-assistant/core/pull/135933
[#137448]: https://github.com/home-assistant/core/pull/137448
[#137688]: https://github.com/home-assistant/core/pull/137688
[#138231]: https://github.com/home-assistant/core/pull/138231
[#138402]: https://github.com/home-assistant/core/pull/138402
[#138408]: https://github.com/home-assistant/core/pull/138408
[#138530]: https://github.com/home-assistant/core/pull/138530
[#138569]: https://github.com/home-assistant/core/pull/138569
[#138575]: https://github.com/home-assistant/core/pull/138575
[#138625]: https://github.com/home-assistant/core/pull/138625
[#138676]: https://github.com/home-assistant/core/pull/138676
[#138681]: https://github.com/home-assistant/core/pull/138681
[#138694]: https://github.com/home-assistant/core/pull/138694
[#138704]: https://github.com/home-assistant/core/pull/138704
[#138716]: https://github.com/home-assistant/core/pull/138716
[#138725]: https://github.com/home-assistant/core/pull/138725
[#138732]: https://github.com/home-assistant/core/pull/138732
[#138753]: https://github.com/home-assistant/core/pull/138753
[#138771]: https://github.com/home-assistant/core/pull/138771
[#138778]: https://github.com/home-assistant/core/pull/138778
[#138817]: https://github.com/home-assistant/core/pull/138817
[#138852]: https://github.com/home-assistant/core/pull/138852
[#138860]: https://github.com/home-assistant/core/pull/138860
[#138879]: https://github.com/home-assistant/core/pull/138879
[#138880]: https://github.com/home-assistant/core/pull/138880
[#138916]: https://github.com/home-assistant/core/pull/138916
[#138918]: https://github.com/home-assistant/core/pull/138918
[#138954]: https://github.com/home-assistant/core/pull/138954
[#138960]: https://github.com/home-assistant/core/pull/138960
[#138985]: https://github.com/home-assistant/core/pull/138985
[#138986]: https://github.com/home-assistant/core/pull/138986
[#138992]: https://github.com/home-assistant/core/pull/138992
[#139006]: https://github.com/home-assistant/core/pull/139006
[@Bre77]: https://github.com/Bre77
[@DmitryKuzmenko]: https://github.com/DmitryKuzmenko
[@KJonline]: https://github.com/KJonline
[@PeteRager]: https://github.com/PeteRager
[@SaswatPadhi]: https://github.com/SaswatPadhi
[@bramkragten]: https://github.com/bramkragten
[@cdnninja]: https://github.com/cdnninja
[@dgomes]: https://github.com/dgomes
[@edenhaus]: https://github.com/edenhaus
[@emontnemery]: https://github.com/emontnemery
[@frenck]: https://github.com/frenck
[@joostlek]: https://github.com/joostlek
[@lucab-91]: https://github.com/lucab-91
[@mib1185]: https://github.com/mib1185
[@nivstein]: https://github.com/nivstein
[@pectum83]: https://github.com/pectum83
[@petacz]: https://github.com/petacz
[@shaiu]: https://github.com/shaiu
[@starkillerOG]: https://github.com/starkillerOG
[@synesthesiam]: https://github.com/synesthesiam
## Need help? Join the community!
Home Assistant has a great community of users who are all more than willing
@ -584,8 +935,14 @@ entry context menu.
([@jbouwh] - [#133342]) ([documentation](/integrations/mqtt))
The MQTT publish action no longer supports the `topic_template` and `payload_template` attributes. Instead, only `topic` and `payload` should be used. In automation and scripts, users can use templates by default. Users were instructed to update their automations and scripts with a repair flow when the use of the deprecated action options was detected.
([@jbouwh] - [#134056]) ([documentation](/integrations/mqtt))
[@jbouwh]: https://github.com/jbouwh
[#133342]: https://github.com/home-assistant/core/pull/133342
[#134056]: https://github.com/home-assistant/core/pull/134056
{% enddetails %}

136
source/_posts/2025-02-13-voice-chapter-9-speech-to-phrase.markdown Normal file
View File

@ -0,0 +1,136 @@
---
layout: post
title: "Speech-to-Phrase brings voice home - Voice chapter 9"
description: "This new tool brings fast, local speech processing to low-end hardware, along with some useful new voice and AI features"
date: 2025-02-13 00:00:01
date_formatted: "February 13, 2025"
author: Mike Hansen
comments: true
categories: Assist
og_image: /images/blog/2025-02-voice-chapter-9/art.jpg
---
<lite-youtube videoid="k6VvzDSI8RU" videotitle="Voice Chapter 9 - Speech-to-Phrase"></lite-youtube>
**Welcome to Voice chapter 9 🎉 part of our [long-running series](https://www.home-assistant.io/blog/categories/assist/) following the development of open voice.**
We're still pumped from the launch of the [Home Assistant Voice Preview Edition](/voice-pe/) at the end of December. It sold out 23 minutes into our announcement - wow! We've been working hard to keep it in stock at [all our distributors](/voice-pe#buy).
Today, we have a lot of cool stuff to improve your experience with Voice PE or any other Assist satellite you're using. This includes fully local and offline voice control that can be powered by nearly any Home Assistant system.
- [Voice for the masses](#voice-for-the-masses)
- [Building an Open Voice Ecosystem](#building-an-open-voice-ecosystem)
- [Large language model improvements](#large-language-model-improvements)
- [Expanding Voice Capabilities](#expanding-voice-capabilities)
- [Home Assistant phones home: analog phones are back!](#home-assistant-phones-home-analog-phones-are-back)
- [Wyoming improvements](#wyoming-improvements)
- [🫵 Help us bring choice to voice!](#-help-us-bring-choice-to-voice)
<!--more-->
Dragon NaturallySpeaking was a popular speech recognition program introduced in 1997. To run this software you needed at least a 133 MHz Pentium processor, 32 MB of RAM, and Windows 95 or later. Nearly thirty years later, Speech-to-Text is much better, but needs orders of magnitude more resources.
Incredible technologies are being developed in speech processing, but it's currently unrealistic for a device that costs less than $100 to take real advantage of them. It's possible, of course, but running the previously recommended Speech-to-Text tool, [Whisper](https://github.com/openai/whisper), on a Raspberry Pi 4 takes at least 5 seconds to turn your speech into text, with varying levels of success. This is why we ended up recommending at least an Intel N100 to run your voice assistant fully locally. That stung. Our opt-in analytics shows over [50% of the Home Assistant OS users](https://analytics.home-assistant.io/) are running their homes on affordable, low-powered machines like the [Home Assistant Green](/green) or a Raspberry Pi.
What's more, advancing the development of Whisper is largely in the hands of OpenAI, as we don't have the resources required to add languages to that tool. We could add every possible language to Home Assistant, but if any single part of our voice pipeline lacks language support, it renders voice unusable for that language. As a result, many widely spoken languages were unsupported for local voice control.
This left many users unable to use voice to control their smart home without purchasing extra hardware or services. We’re changing this today with the launch of a key new piece of our voice pipeline.
## Voice for the masses
<img src='/images/blog/2025-02-voice-chapter-9/stp-logo.jpg' style='border: 0;box-shadow: none;' alt="Speech-to-Phrase logo">
[Speech-to-Phrase](https://github.com/OHF-voice/speech-to-phrase) is based on old, almost ancient, voice technology by today's standards. Instead of the ability to transcribe virtually any speech into text, it is limited to a set of pre-trained phrases. Speech-to-Phrase will automatically generate the phrases and fine-tune a model based on the devices, areas, and sentence triggers in your Home Assistant server - 100% locally and offline.
**The result:** speech transcribed in under a second on a Home Assistant Green or Raspberry Pi 4. The Raspberry Pi 5 processes commands seven times faster, clocking in at 150 milliseconds per command!
With great speed comes *some* limitations. Speech-to-Phrase only supports a subset of Assist's voice commands, and more open-ended things like shopping lists, naming a timer, and broadcasts are not usable out of the box. Really any commands that can accept random words (wildcards) will not work. For the same reasons, Speech-to-Phrase is intended for home control only and not LLMs.
The most important home control commands are supported, including turning lights on and off, changing brightness and color, getting the weather, setting timers, and controlling media players. [Custom sentences](/docs/automation/trigger/#sentence-trigger) can also be added to trigger things not covered by the current commands, and we expect the community will come up with some clever new ways to use this tech.
<img src='/images/blog/2025-02-voice-chapter-9/green-pe.png' style='border: 0;box-shadow: none;' alt="Green and Voice PE join forces">
<p align="center"><em>All you need to get started with voice</em></p>
Speech-to-Phrase is launching with support for English, French, German, Dutch, Spanish, and Italian - covering nearly 70% of Home Assistant users. Nice. Unlike the local Speech-to-Text tools currently available, adding languages to Speech-to-Phrase is much easier. This means many more languages will be available in future releases, and [we would love your help](/voice_control/contribute-voice) adding them!
We're working on updating the Voice wizard to include Speech-to-Phrase. Until then, you need to install the add-on manually:
[<img src='https://my.home-assistant.io/badges/supervisor_addon.svg' style='border: 0;box-shadow: none;' alt="!Open your Home Assistant instance and show the dashboard of an add-on.">](https://my.home-assistant.io/redirect/supervisor_addon/?addon=core_speech-to-phrase)
## Building an Open Voice Ecosystem
When we launched Home Assistant Voice Preview Edition, we didn't just launch a product; we kickstarted an ecosystem. We did this by open-sourcing all parts and ensuring that the voice experience built into Home Assistant is not tied to a single product. Any voice assistant built for the Open Home ecosystem can take advantage of all this work. Even your DIY ones!
With ESPHome 2025.2, which we're releasing next week, any ESPHome-based voice assistant will support making [broadcasts](/blog/2025/02/05/release-20252/#new-broadcast-intent) (more on that below), and they will also be able to use our new voice wizard to ensure new users have everything they need to get started.
This will include updates for the [$13 Atom Echo](/voice_control/thirteen-usd-voice-remote/) and ESP32-S3-Box-3 devices that we used for development during the Year of the Voice!
<p class='img'><lite-youtube videoid="HMqXHN0KBQM" videotitle="New broadcast feature in action with Atom and Box 3"></lite-youtube>New broadcast feature in action with Atom and Box 3</p>
## Large language model improvements
We aim for Home Assistant to be [the place for experimentation with AI in the smart home](/blog/2024/06/07/ai-agents-for-the-smart-home/). We support a wide range of models, both local and cloud-based, and are constantly improving the different ways people can interact with them. We're always running [benchmarks](https://github.com/allenporter/home-assistant-datasets/tree/main/reports) to track the best models, and make sure our changes lead to an improved experience.
If you set up [Assist](/voice_control/), Home Assistant's built-in voice assistant, and configure it to use an LLM, you might have noticed some new features landing recently. One major change was the new "[prefer handling commands locally](/blog/2024/12/04/release-202412/#let-your-voice-assistant-fall-back-to-an-llm-based-agent)" setting, which always attempts to run commands with the built-in conversation agent before it sends it off to an LLM. We noticed many easy-to-run commands were being sent to an LLM, which can slow down things and waste tokens. If Home Assistant understands the command (e.g., turn on the lights), it will perform the necessary action, and only passes it on to your chosen LLM if it doesn't understand the command (e.g., what's the air quality like now).
Adding the above features made us realize that LLMs need to understand the commands handled locally. Now, the [conversation history is shared](/blog/2025/02/05/release-20252/#shared-history-between-the-default-conversation-agent-and-its-llm-based-fallback) with the LLM. The context allows you to ask the LLM for follow-up questions that refer to recent commands, regardless of whether they helped process the request.
<img src='/images/blog/2025-02-voice-chapter-9/shared-history.png' style='border: 0;box-shadow: none;' alt="Speech-to-Phrase logo">
<p align="center"><em>Left: without shared conversations. Right: Shared conversations enable GPT to understand context.</em></p>
### Reducing the time to first word with streaming<!-- omit in toc -->
When experimenting with larger models, or on slower hardware, LLM's can feel sluggish. They only respond once the entire reply is generated, which can take frustratingly long for lengthy responses (you'll be waiting a while if you ask it to tell you an epic fairy tale).
In Home Assistant 2025.3 we're introducing support for LLMs to stream their response to the chat, allowing users to start reading while the response is being generated. A bonus side effect is that commands are now also faster: they will be executed as soon as they come in, without waiting for the rest of the message to be complete.
Streaming is coming initially for Ollama and OpenAI.
### Model Context Protocol brings Home Assistant to every AI<!-- omit in toc -->
In November 2024, Anthropic announced the [Model Context Protocol](https://modelcontextprotocol.io/introduction) (MCP). It is a new protocol to allow LLMs to control external services. In this release, contributed by [Allen Porter](https://github.com/allenporter), Home Assistant can speak MCP.
Using the new Model Context Protocol [integration](/integrations/mcp), Home Assistant can integrate external MCP servers and make their tools available to LLMs that Home Assistant talks to (for your voice assistant or in automations). There is [quite a collection of MCP servers](https://github.com/punkpeye/awesome-mcp-servers), including wild ones like scraping websites ([tutorial](https://gist.github.com/allenporter/b0e9946feb2ab60901c4f467ac1ba6f9)), file server access, or even BlueSky.
With the new Model Context Protocol [server integration](/integrations/mcp_server), Home Assistant's LLM tools can be included in other AI apps, like the Claude desktop app ([tutorial](https://modelcontextprotocol.io/quickstart/user)). If agentic AI takes off, your smart home will be ready to be integrated.
Thanks Allen!
## Expanding Voice Capabilities
We keep enhancing the capabilities of the built-in conversation agent of Home Assistant. With the latest release, we're unlocking two new features:
#### "Broadcast that it's time for dinner"<!-- omit in toc -->
The new [broadcast](/blog/2025/02/05/release-20252/#new-broadcast-intent) feature lets you quickly send messages to the other Assist satellites in your home. This makes it possible to announce it's time for dinner, or announce battles between your children 😅.
#### "Set the temperature to 19 degrees"<!-- omit in toc -->
Previously Assist could only tell you the temperature, but now it can help you change the temperature of your HVAC system. Perfect for changing the temperature while staying cozy under a warm blanket.
## Home Assistant phones home: analog phones are back!
Two years ago, we introduced the [world's most private voice assistant](/voice_control/worlds-most-private-voice-assistant/): an analog phone! Users can pick it up to talk to their smart home, and only the user can hear the response. A fun feature we're adding today is that Home Assistant can now **call your analog phone!**
Analog phones are great when you want to notify a room, instead of an entire home. For instance, when the laundry is done, you can notify someone in the living room, but not the office. Also since the user needs to pick up the horn to receive the call, you will know if your notification was received.
<p class='img'><lite-youtube videoid="TaoNY1gINWc" videotitle="Have your Home Assistant give you a call"></lite-youtube>Have your Home Assistant give you a call</p>
If you're using an LLM as your voice assistant, you can also start a conversation from a phone call. You can provide the opening sentence and via a new "extra system prompt" option, provide extra context to the LLM to interpret the response from the user. For example,
- Extra system context: garage door cover.garage_door was left open for 30 minutes. We asked the user if it should be closed
- Assistant: should the garage door be closed?
- User: sure
Thanks [JaminH](https://github.com/jaminh) for the contribution.
## Wyoming improvements
Wyoming is our standard for linking together all the different parts needed to build a voice assistant. Home Assistant 2025.3 will add support for announcements to Wyoming satellites, making them eligible for the new broadcast feature too.  
We're also adding a new microWakeWord add-on (the same wake word engine running on Voice PE!) that can be used as an alternative to openWakeWord. As we collect more real-world samples from our [Wake Word Collective](https://ohf-voice.github.io/wake-word-collective/), the models included in microWakeWord will be retrained and improved.
## 🫵 Help us bring choice to voice!
We've said it before, and we'll say it again---the era of open voice has begun, and the more people who join us, the better it gets. Home Assistant offers many ways to start with voice control, whether by [building your own](/voice_control/#expand-and-experiment) Assist hardware or getting a [Home Assistant Voice Preview Edition](/voice-pe/). With every update, you'll see new features, and you'll get to preview the future of voice today.
A huge thanks to all the language leaders and contributors helping to shape open voice in the home! There are many ways to get involved, from translating or sharing voice samples to building new features---learn more about how [you can contribute here](/voice_control/contribute-voice). Another great way to support development is by subscribing to [Home Assistant Cloud](/cloud/), which helps fund the Open Home projects that power voice.

2
source/_redirects
View File

@ -9,6 +9,8 @@ layout: null
# General use redirects
/join-chat https://discord.gg/home-assistant
/twitter https://twitter.com/home_assistant/
/mastodon https://fosstodon.org/@homeassistant
/bluesky https://bsky.app/profile/home-assistant.io
/newsletter https://newsletter.openhomefoundation.org/
/suggest-community-highlight https://docs.google.com/forms/d/e/1FAIpQLSd9VWPeVM0xg0swWL6kT3wkQUKt8vWsTL5WtPO95LAy-0cYZw/viewform
/get-blueprints https://community.home-assistant.io/c/blueprints-exchange/53

2
source/changelogs/core-2025.1.markdown
View File

@ -7,7 +7,7 @@ replace_regex: \s\(\[?[a-z0-9\-\s_]+\]?\)$
These are all the changes included in the Home Assistant Core 2025.1 release.
For a summary in a more readable format:
[Release notes blog for this release](/blog/2024/01/03/release-20251/).
[Release notes blog for this release](/blog/2025/01/03/release-20251/).
- Bump version to 2025.1.0dev0 ([@cdce8p] - [#131751])
- Remove unreachable code in Habitica ([@tr4nt0r] - [#131778])

339
source/changelogs/core-2025.2.markdown
View File

@ -1358,6 +1358,345 @@ For a summary in a more readable format:
- Bump hassil and intents ([@synesthesiam] - [#137440])
- Bump dbus-fast to 2.33.0 ([@bdraco] - [#137446])
## Release 2025.2.1 - February 7
- Fix hassio test using wrong fixture ([@emontnemery] - [#137516])
- Change Electric Kiwi authentication ([@mikey0000] - [#135231])
- Update govee-ble to 0.42.1 ([@cdce8p] - [#137371])
- Bump holidays to 0.66 ([@gjohansson-ST] - [#137449])
- Bump aiohttp-asyncmdnsresolver to 0.1.0 ([@bdraco] - [#137492])
- Bump aiohttp to 3.11.12 ([@bdraco] - [#137494])
- Bump govee-ble to 0.43.0 to fix compat with new H5179 firmware ([@bdraco] - [#137508])
- Bump habiticalib to v0.3.5 ([@tr4nt0r] - [#137510])
- Fix Mill issue, where no sensors were shown ([@Danielhiversen] - [#137521])
- Don't overwrite setup state in async_set_domains_to_be_loaded ([@emontnemery] - [#137547])
- Use separate metadata files for onedrive ([@zweckj] - [#137549])
- Fix sending polls to Telegram threads ([@jwhb] - [#137553])
- Skip building wheels for electrickiwi-api ([@cdce8p] - [#137556])
- Add excluded domains to broadcast intent ([@synesthesiam] - [#137566])
- Revert "Add `PaddleSwitchPico` (Pico Paddle Remote) device trigger to Lutron Caseta" ([@bdraco] - [#137571])
- Fix Overseerr webhook configuration JSON ([@denniseffing] - [#137572])
- Do not rely on pyserial for port scanning with the CM5 + ZHA ([@puddly] - [#137585])
- Bump eheimdigital to 1.0.6 ([@autinerd] - [#137587])
- Bump pyfireservicerota to 0.0.46 ([@cyberjunky] - [#137589])
- Bump reolink-aio to 0.11.10 ([@starkillerOG] - [#137591])
- Allow to omit the payload attribute to MQTT publish action to allow an empty payload to be sent by default ([@jbouwh] - [#137595])
- Handle previously migrated HEOS device identifier ([@andrewsayre] - [#137596])
- Bump `aioshelly` to version `12.4.1` ([@bieniu] - [#137598])
- Bump electrickiwi-api to 0.9.13 ([@mikey0000] - [#137601])
- Bump ZHA to 0.0.48 ([@TheJulianJES] - [#137610])
- Bump Electrickiwi-api to 0.9.14 ([@mikey0000] - [#137614])
- Update google-nest-sdm to 7.1.3 ([@allenporter] - [#137625])
- Don't use the current temperature from Shelly BLU TRV as a state for External Temperature number entity ([@bieniu] - [#137658])
- Fix LG webOS TV turn off when device is already off ([@thecode] - [#137675])
[#135231]: https://github.com/home-assistant/core/pull/135231
[#137371]: https://github.com/home-assistant/core/pull/137371
[#137448]: https://github.com/home-assistant/core/pull/137448
[#137449]: https://github.com/home-assistant/core/pull/137449
[#137492]: https://github.com/home-assistant/core/pull/137492
[#137494]: https://github.com/home-assistant/core/pull/137494
[#137508]: https://github.com/home-assistant/core/pull/137508
[#137510]: https://github.com/home-assistant/core/pull/137510
[#137516]: https://github.com/home-assistant/core/pull/137516
[#137521]: https://github.com/home-assistant/core/pull/137521
[#137547]: https://github.com/home-assistant/core/pull/137547
[#137549]: https://github.com/home-assistant/core/pull/137549
[#137553]: https://github.com/home-assistant/core/pull/137553
[#137556]: https://github.com/home-assistant/core/pull/137556
[#137566]: https://github.com/home-assistant/core/pull/137566
[#137571]: https://github.com/home-assistant/core/pull/137571
[#137572]: https://github.com/home-assistant/core/pull/137572
[#137585]: https://github.com/home-assistant/core/pull/137585
[#137587]: https://github.com/home-assistant/core/pull/137587
[#137589]: https://github.com/home-assistant/core/pull/137589
[#137591]: https://github.com/home-assistant/core/pull/137591
[#137595]: https://github.com/home-assistant/core/pull/137595
[#137596]: https://github.com/home-assistant/core/pull/137596
[#137598]: https://github.com/home-assistant/core/pull/137598
[#137601]: https://github.com/home-assistant/core/pull/137601
[#137610]: https://github.com/home-assistant/core/pull/137610
[#137614]: https://github.com/home-assistant/core/pull/137614
[#137625]: https://github.com/home-assistant/core/pull/137625
[#137658]: https://github.com/home-assistant/core/pull/137658
[#137675]: https://github.com/home-assistant/core/pull/137675
[@Danielhiversen]: https://github.com/Danielhiversen
[@TheJulianJES]: https://github.com/TheJulianJES
[@allenporter]: https://github.com/allenporter
[@andrewsayre]: https://github.com/andrewsayre
[@autinerd]: https://github.com/autinerd
[@bdraco]: https://github.com/bdraco
[@bieniu]: https://github.com/bieniu
[@cdce8p]: https://github.com/cdce8p
[@cyberjunky]: https://github.com/cyberjunky
[@denniseffing]: https://github.com/denniseffing
[@emontnemery]: https://github.com/emontnemery
[@frenck]: https://github.com/frenck
[@gjohansson-ST]: https://github.com/gjohansson-ST
[@jbouwh]: https://github.com/jbouwh
[@jwhb]: https://github.com/jwhb
[@mikey0000]: https://github.com/mikey0000
[@puddly]: https://github.com/puddly
[@starkillerOG]: https://github.com/starkillerOG
[@synesthesiam]: https://github.com/synesthesiam
[@thecode]: https://github.com/thecode
[@tr4nt0r]: https://github.com/tr4nt0r
[@zweckj]: https://github.com/zweckj
## Release 2025.2.2 - February 10
- LaCrosse View new endpoint ([@IceBotYT] - [#137284])
- Convert coinbase account amounts as floats to properly add them together ([@natekspencer] - [#137588])
- Bump ohmepy to 1.2.9 ([@dan-r] - [#137695])
- Bump onedrive_personal_sdk to 0.0.9 ([@zweckj] - [#137729])
- Limit habitica ConfigEntrySelect to integration domain ([@cdce8p] - [#137767])
- Limit nordpool ConfigEntrySelect to integration domain ([@cdce8p] - [#137768])
- Limit transmission ConfigEntrySelect to integration domain ([@cdce8p] - [#137769])
- Fix tplink child updates taking up to 60s ([@bdraco] - [#137782])
- Call backup listener during setup in Google Drive ([@tronikos] - [#137789])
- Use the external URL set in Settings > System > Network if my is disabled as redirect URL for Google Drive instructions ([@tronikos] - [#137791])
- Fix manufacturer_id matching for 0 ([@patman15] - [#137802])
- Fix DAB radio in Onkyo ([@arturpragacz] - [#137852])
- Fix LG webOS TV fails to setup when device is off ([@thecode] - [#137870])
- Fix heos migration ([@balloob] - [#137887])
- Bump pydrawise to 2025.2.0 ([@dknowles2] - [#137961])
- Bump aioshelly to version 12.4.2 ([@bieniu] - [#137986])
- Prevent crash if telegram message failed and did not generate an ID ([@CloCkWeRX] - [#137989])
- Bump habiticalib to v0.3.7 ([@tr4nt0r] - [#137993])
- Refresh the nest authentication token on integration start before invoking the pub/sub subsciber ([@allenporter] - [#138003])
- Use resumable uploads in Google Drive ([@tronikos] - [#138010])
- Bump py-synologydsm-api to 2.6.2 ([@mib1185] - [#138060])
- Handle generic agent exceptions when getting and deleting backups ([@abmantis] - [#138145])
- Bump onedrive-personal-sdk to 0.0.10 ([@zweckj] - [#138186])
- Keep one backup per backup agent when executing retention policy ([@emontnemery] - [#138189])
- Improve inexogy logging when failed to update ([@jpbede] - [#138210])
- Bump pyheos to v1.0.2 ([@andrewsayre] - [#138224])
- Update frontend to 20250210.0 ([@bramkragten] - [#138227])
- Bump lacrosse-view to 1.1.1 ([@IceBotYT] - [#137282])
[#137282]: https://github.com/home-assistant/core/pull/137282
[#137284]: https://github.com/home-assistant/core/pull/137284
[#137448]: https://github.com/home-assistant/core/pull/137448
[#137588]: https://github.com/home-assistant/core/pull/137588
[#137688]: https://github.com/home-assistant/core/pull/137688
[#137695]: https://github.com/home-assistant/core/pull/137695
[#137729]: https://github.com/home-assistant/core/pull/137729
[#137767]: https://github.com/home-assistant/core/pull/137767
[#137768]: https://github.com/home-assistant/core/pull/137768
[#137769]: https://github.com/home-assistant/core/pull/137769
[#137782]: https://github.com/home-assistant/core/pull/137782
[#137789]: https://github.com/home-assistant/core/pull/137789
[#137791]: https://github.com/home-assistant/core/pull/137791
[#137802]: https://github.com/home-assistant/core/pull/137802
[#137852]: https://github.com/home-assistant/core/pull/137852
[#137870]: https://github.com/home-assistant/core/pull/137870
[#137887]: https://github.com/home-assistant/core/pull/137887
[#137961]: https://github.com/home-assistant/core/pull/137961
[#137986]: https://github.com/home-assistant/core/pull/137986
[#137989]: https://github.com/home-assistant/core/pull/137989
[#137993]: https://github.com/home-assistant/core/pull/137993
[#138003]: https://github.com/home-assistant/core/pull/138003
[#138010]: https://github.com/home-assistant/core/pull/138010
[#138060]: https://github.com/home-assistant/core/pull/138060
[#138145]: https://github.com/home-assistant/core/pull/138145
[#138186]: https://github.com/home-assistant/core/pull/138186
[#138189]: https://github.com/home-assistant/core/pull/138189
[#138210]: https://github.com/home-assistant/core/pull/138210
[#138224]: https://github.com/home-assistant/core/pull/138224
[#138227]: https://github.com/home-assistant/core/pull/138227
[@CloCkWeRX]: https://github.com/CloCkWeRX
[@IceBotYT]: https://github.com/IceBotYT
[@abmantis]: https://github.com/abmantis
[@allenporter]: https://github.com/allenporter
[@andrewsayre]: https://github.com/andrewsayre
[@arturpragacz]: https://github.com/arturpragacz
[@balloob]: https://github.com/balloob
[@bdraco]: https://github.com/bdraco
[@bieniu]: https://github.com/bieniu
[@bramkragten]: https://github.com/bramkragten
[@cdce8p]: https://github.com/cdce8p
[@dan-r]: https://github.com/dan-r
[@dknowles2]: https://github.com/dknowles2
[@emontnemery]: https://github.com/emontnemery
[@frenck]: https://github.com/frenck
[@jpbede]: https://github.com/jpbede
[@mib1185]: https://github.com/mib1185
[@natekspencer]: https://github.com/natekspencer
[@patman15]: https://github.com/patman15
[@thecode]: https://github.com/thecode
[@tr4nt0r]: https://github.com/tr4nt0r
[@tronikos]: https://github.com/tronikos
[@zweckj]: https://github.com/zweckj
## Release 2025.2.3 - February 12
- Bump hass-nabucasa from 0.88.1 to 0.89.0 ([@ludeeus] - [#137321])
- Move cloud backup upload/download handlers to lib ([@ludeeus] - [#137416])
- Handle non-retryable errors when uploading cloud backup ([@ludeeus] - [#137517])
- Add missing thermostat state EMERGENCY_HEAT to econet ([@jdanders] - [#137623])
- Fix broken issue creation in econet ([@jdanders] - [#137773])
- Fix version extraction for APsystems ([@alfwro13] - [#138023])
- Refresh nest access token before before building subscriber Credentials ([@allenporter] - [#138259])
- Fix BackupManager.async_delete_backup ([@emontnemery] - [#138286])
- Fix next authentication token error handling ([@allenporter] - [#138299])
- Bump pyenphase to 1.25.1 ([@catsmanac] - [#138327])
- Bump sentry-sdk to 1.45.1 ([@edenhaus] - [#138349])
- Bump zeroconf to 0.144.1 ([@bdraco] - [#138353])
- Bump cryptography to 44.0.1 ([@edenhaus] - [#138371])
- Fix tplink iot strip sensor refresh ([@sdb9696] - [#138375])
- Bump deebot-client to 12.1.0 ([@edenhaus] - [#138382])
- Bump hass-nabucasa from 0.89.0 to 0.90.0 ([@emontnemery] - [#138387])
- Update cloud backup agent to use calculate_b64md5 from lib ([@emontnemery] - [#138391])
[#137321]: https://github.com/home-assistant/core/pull/137321
[#137416]: https://github.com/home-assistant/core/pull/137416
[#137448]: https://github.com/home-assistant/core/pull/137448
[#137517]: https://github.com/home-assistant/core/pull/137517
[#137623]: https://github.com/home-assistant/core/pull/137623
[#137688]: https://github.com/home-assistant/core/pull/137688
[#137773]: https://github.com/home-assistant/core/pull/137773
[#138023]: https://github.com/home-assistant/core/pull/138023
[#138231]: https://github.com/home-assistant/core/pull/138231
[#138259]: https://github.com/home-assistant/core/pull/138259
[#138286]: https://github.com/home-assistant/core/pull/138286
[#138299]: https://github.com/home-assistant/core/pull/138299
[#138327]: https://github.com/home-assistant/core/pull/138327
[#138349]: https://github.com/home-assistant/core/pull/138349
[#138353]: https://github.com/home-assistant/core/pull/138353
[#138371]: https://github.com/home-assistant/core/pull/138371
[#138375]: https://github.com/home-assistant/core/pull/138375
[#138382]: https://github.com/home-assistant/core/pull/138382
[#138387]: https://github.com/home-assistant/core/pull/138387
[#138391]: https://github.com/home-assistant/core/pull/138391
[@alfwro13]: https://github.com/alfwro13
[@allenporter]: https://github.com/allenporter
[@bdraco]: https://github.com/bdraco
[@catsmanac]: https://github.com/catsmanac
[@edenhaus]: https://github.com/edenhaus
[@emontnemery]: https://github.com/emontnemery
[@frenck]: https://github.com/frenck
[@jdanders]: https://github.com/jdanders
[@ludeeus]: https://github.com/ludeeus
[@sdb9696]: https://github.com/sdb9696
## Release 2025.2.4 - February 14
- Bump python-kasa to 0.10.2 ([@sdb9696] - [#138381])
- Bump hass-nabucasa from 0.90.0 to 0.91.0 ([@ludeeus] - [#138441])
- Bump aiowebostv to 0.6.2 ([@thecode] - [#138488])
- Bump ZHA to 0.0.49 to fix Tuya TRV issues ([@TheJulianJES] - [#138492])
- Bump pyseventeentrack to 1.0.2 ([@shaiu] - [#138506])
- Bump hass-nabucasa from 0.91.0 to 0.92.0 ([@emontnemery] - [#138510])
- Bump py-synologydsm-api to 2.6.3 ([@mib1185] - [#138516])
- Update frontend to 20250214.0 ([@bramkragten] - [#138521])
[#137448]: https://github.com/home-assistant/core/pull/137448
[#137688]: https://github.com/home-assistant/core/pull/137688
[#138231]: https://github.com/home-assistant/core/pull/138231
[#138381]: https://github.com/home-assistant/core/pull/138381
[#138408]: https://github.com/home-assistant/core/pull/138408
[#138441]: https://github.com/home-assistant/core/pull/138441
[#138488]: https://github.com/home-assistant/core/pull/138488
[#138492]: https://github.com/home-assistant/core/pull/138492
[#138506]: https://github.com/home-assistant/core/pull/138506
[#138510]: https://github.com/home-assistant/core/pull/138510
[#138516]: https://github.com/home-assistant/core/pull/138516
[#138521]: https://github.com/home-assistant/core/pull/138521
[@TheJulianJES]: https://github.com/TheJulianJES
[@bramkragten]: https://github.com/bramkragten
[@emontnemery]: https://github.com/emontnemery
[@frenck]: https://github.com/frenck
[@ludeeus]: https://github.com/ludeeus
[@mib1185]: https://github.com/mib1185
[@sdb9696]: https://github.com/sdb9696
[@shaiu]: https://github.com/shaiu
[@thecode]: https://github.com/thecode
## Release 2025.2.5 - February 21
- Adjust Tuya Water Detector to support 1 as an alarm state ([@petacz] - [#135933])
- Fix bug in set_preset_mode_with_end_datetime (wrong typo of frost_guard) ([@pectum83] - [#138402])
- Bump pyhive-integration to 1.0.2 ([@KJonline] - [#138569])
- Bump tesla-fleet-api to v0.9.10 ([@Bre77] - [#138575])
- Bump pysmarty2 to 0.10.2 ([@lucab-91] - [#138625])
- Rename "returned" state to "alert" ([@shaiu] - [#138676])
- Bump pyvesync for vesync ([@cdnninja] - [#138681])
- Opower: Fix unavailable "start date" and "end date" sensors ([@SaswatPadhi] - [#138694])
- Correct backup filename on delete or download of cloud backup ([@emontnemery] - [#138704])
- Correct invalid automatic backup settings when loading from store ([@emontnemery] - [#138716])
- Bump airgradient to 0.9.2 ([@joostlek] - [#138725])
- Clean up translations for mocked integrations inbetween tests ([@emontnemery] - [#138732])
- Bump pyrympro from 0.0.8 to 0.0.9 ([@nivstein] - [#138753])
- Don't allow setting backup retention to 0 days or copies ([@emontnemery] - [#138771])
- Fix TV input source option for Sonos Arc Ultra ([@PeteRager] - [#138778])
- Add assistant filter to expose entities list command ([@synesthesiam] - [#138817])
- Fix playback for encrypted Reolink files ([@starkillerOG] - [#138852])
- Correct backup date when reading a backup created by supervisor ([@emontnemery] - [#138860])
- Bump pyfritzhome to 0.6.15 ([@mib1185] - [#138879])
- Validate hassio backup settings ([@emontnemery] - [#138880])
- Catch zeep fault as well on GetSystemDateAndTime call. ([@DmitryKuzmenko] - [#138916])
- Fix Reolink callback id collision ([@starkillerOG] - [#138918])
- Fix handling of min/max temperature presets in AVM Fritz!SmartHome ([@mib1185] - [#138954])
- Bump pyprosegur to 0.0.13 ([@dgomes] - [#138960])
- Bump reolink-aio to 0.12.0 ([@starkillerOG] - [#138985])
- Bump deebot-client to 12.2.0 ([@edenhaus] - [#138986])
- Omit unknown hue effects ([@joostlek] - [#138992])
- Update frontend to 20250221.0 ([@bramkragten] - [#139006])
[#135933]: https://github.com/home-assistant/core/pull/135933
[#137448]: https://github.com/home-assistant/core/pull/137448
[#137688]: https://github.com/home-assistant/core/pull/137688
[#138231]: https://github.com/home-assistant/core/pull/138231
[#138402]: https://github.com/home-assistant/core/pull/138402
[#138408]: https://github.com/home-assistant/core/pull/138408
[#138530]: https://github.com/home-assistant/core/pull/138530
[#138569]: https://github.com/home-assistant/core/pull/138569
[#138575]: https://github.com/home-assistant/core/pull/138575
[#138625]: https://github.com/home-assistant/core/pull/138625
[#138676]: https://github.com/home-assistant/core/pull/138676
[#138681]: https://github.com/home-assistant/core/pull/138681
[#138694]: https://github.com/home-assistant/core/pull/138694
[#138704]: https://github.com/home-assistant/core/pull/138704
[#138716]: https://github.com/home-assistant/core/pull/138716
[#138725]: https://github.com/home-assistant/core/pull/138725
[#138732]: https://github.com/home-assistant/core/pull/138732
[#138753]: https://github.com/home-assistant/core/pull/138753
[#138771]: https://github.com/home-assistant/core/pull/138771
[#138778]: https://github.com/home-assistant/core/pull/138778
[#138817]: https://github.com/home-assistant/core/pull/138817
[#138852]: https://github.com/home-assistant/core/pull/138852
[#138860]: https://github.com/home-assistant/core/pull/138860
[#138879]: https://github.com/home-assistant/core/pull/138879
[#138880]: https://github.com/home-assistant/core/pull/138880
[#138916]: https://github.com/home-assistant/core/pull/138916
[#138918]: https://github.com/home-assistant/core/pull/138918
[#138954]: https://github.com/home-assistant/core/pull/138954
[#138960]: https://github.com/home-assistant/core/pull/138960
[#138985]: https://github.com/home-assistant/core/pull/138985
[#138986]: https://github.com/home-assistant/core/pull/138986
[#138992]: https://github.com/home-assistant/core/pull/138992
[#139006]: https://github.com/home-assistant/core/pull/139006
[@Bre77]: https://github.com/Bre77
[@DmitryKuzmenko]: https://github.com/DmitryKuzmenko
[@KJonline]: https://github.com/KJonline
[@PeteRager]: https://github.com/PeteRager
[@SaswatPadhi]: https://github.com/SaswatPadhi
[@bramkragten]: https://github.com/bramkragten
[@cdnninja]: https://github.com/cdnninja
[@dgomes]: https://github.com/dgomes
[@edenhaus]: https://github.com/edenhaus
[@emontnemery]: https://github.com/emontnemery
[@frenck]: https://github.com/frenck
[@joostlek]: https://github.com/joostlek
[@lucab-91]: https://github.com/lucab-91
[@mib1185]: https://github.com/mib1185
[@nivstein]: https://github.com/nivstein
[@pectum83]: https://github.com/pectum83
[@petacz]: https://github.com/petacz
[@shaiu]: https://github.com/shaiu
[@starkillerOG]: https://github.com/starkillerOG
[@synesthesiam]: https://github.com/synesthesiam
[#112047]: https://github.com/home-assistant/core/pull/112047
[#121522]: https://github.com/home-assistant/core/pull/121522
[#121548]: https://github.com/home-assistant/core/pull/121548

3
source/dashboards/badges.markdown
View File

@ -27,7 +27,8 @@ Badges are widgets that sit at the top of a panel, above all the cards.
![Screenshot showing how to configure a badge](/images/dashboards/badge_configure.png)
7. Under **Interactions**, you can define the tap behavior.
8. If you want this badge to be visible only to specific users or under a certain condition, open the **Visibility** tab to [define those conditions](/dashboards/cards/#showing-or-hiding-a-card-conditionally).
8. If you want this badge to be visible only to specific users or under a certain condition, open the **Visibility** tab to [define those conditions](/dashboards/cards/#showing-or-hiding-a-card-or-badge-conditionally).
- The [available conditions](/dashboards/conditional/#conditions-options) are the same as the ones for the conditional card.
9. Select **Save**.
<p class="img">

9
source/dashboards/cards.markdown
View File

@ -53,7 +53,7 @@ A card can be added to a dashboard directly [from the view](#to-add-a-card-from-
- Then, select **Continue**.
![Screenshot add cards by entity](/images/dashboards/dashboard_add-by-entity_02.png)
3. If you want this card to be visible only to specific users or under a certain condition, you can [define those conditions](#showing-or-hiding-a-card-conditionally).
3. If you want this card to be visible only to specific users or under a certain condition, you can [define those conditions](#showing-or-hiding-a-card-or-badge-conditionally).
4. If you are adding this card to a [sections view](/dashboards/sections/), on the **Layout** tab, you can [resize the card](#resizing-a-card).
5. If you like, define [card actions, features, header and footer widgets](#card-actions-features-header-and-footer-widgets).
- Not all cards support these elements. Refer to the documentation of the specific card type.
@ -78,7 +78,7 @@ This method is useful if you are on the **Device** page and want to create a car
![Add to Dashboard button on the device page](/images/dashboards/add_card_from_device_page_02.png)
5. To edit the card configuration, open the view to which you added the card.
- Select **Edit card**.
6. If you want this card to be visible only to specific users or under a certain condition, you can [define those conditions](#showing-or-hiding-a-card-conditionally).
6. If you want this card to be visible only to specific users or under a certain condition, you can [define those conditions](#showing-or-hiding-a-card-or-badge-conditionally).
7. If you are adding this card to a [sections view](/dashboards/sections/), on the **Layout** tab, you can [resize the card](#resizing-a-card).
8. If you like, define [card actions, features, header and footer widgets](#card-actions-features-header-and-footer-widgets).
@ -88,10 +88,11 @@ This method is useful if you are on the **Device** page and want to create a car
You can choose to show or hide certain cards or [badges](/dashboards/badges/) based on different conditions. The [available conditions](/dashboards/conditional/#card-conditions) are the same as the ones for the conditional card.
1. On the **Visibility** tab, select **Add condition**.
- Don't see a **Visibility** tab?
1. On the **Visibility** tab, select **Add condition**./dashboards/conditional/#conditions-options
- **Troubleshooting**: Don't see a **Visibility** tab?
- It is not available inside nested cards: vertical stack, horizontal stack, and grid card
2. Select the type of condition, and enter the parameters.
- The [available conditions](/dashboards/conditional/#conditions-options) are the same as the ones for the conditional card.
- If you define multiple conditions, the section is only shown when all conditions are met.
- If you did not define any conditions, the section is always shown, to all users.
3. Select **Save**.

BIN
source/images/blog/2025-02-voice-chapter-9/art.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 37 KiB

BIN
source/images/blog/2025-02-voice-chapter-9/green-pe.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 153 KiB

BIN
source/images/blog/2025-02-voice-chapter-9/shared-history.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 53 KiB

BIN
source/images/blog/2025-02-voice-chapter-9/stp-logo.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 16 KiB

BIN
source/images/integrations/onedrive/onedrive-app-registration.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 82 KiB

3
source/installation/raspberrypi.markdown
View File

@ -29,11 +29,10 @@ Remember to ensure you're using an [appropriate power supply](https://www.raspbe
This guide shows how to install the {% term "Home Assistant Operating System" %} onto your Raspberry Pi using Raspberry Pi Imager.
If Raspberry Pi Imager is not supported by your platform, you can [download the Home Assistant image](#downloading-the-home-assistant-image) and use another imaging tool.
### Write the image to your SD card
1. Download and install the Raspberry Pi Imager on your computer as described under [https://www.raspberrypi.com/software/](https://www.raspberrypi.com/software/).
- **Troubleshooting**: If Raspberry Pi Imager is not supported by your platform, you can [download the Home Assistant image](#downloading-the-home-assistant-image) and use another imaging tool, such as Balena Etcher.
2. Open the Raspberry Pi Imager and select your Raspberry Pi device.
![Open Raspberry Pi Imager](/images/installation/rpi_imager_start.png)
3. Choose the operating system:

11
source/more-info/backup-emergency-kit.markdown
View File

@ -23,7 +23,9 @@ Encryption is a method of converting data into a coded format so that it can onl
![Screenshot showing the encryption key in the download dialog for the backup emergency kit](/images/more-info/backup_emergency_kit_01.png)
3. Store the kit somewhere safe, outside the Home Assistant system.
- Without the encryption key, there is no way to [restore an encrypted backup](/common-tasks/general/#restoring-a-backup).
- Home Assistant keeps track of the current encryption key. If you download from Home Assistant, it can decrypt your backup.
- But if you have changed the encryption key in the meantime, you still need the old key that matches old backups.
Without the encryption key, there is no way to [restore an encrypted backup](/common-tasks/general/#restoring-a-backup).
## Changing your encryption key
@ -33,9 +35,12 @@ When you set up your [backups](/common-tasks/general/#backups), an encryption ke
2. Select **Configure automatic backups** and under **Encryption key**, select **Change**.
3. If you haven't downloaded the old emergency kit yet, do it now.
- As the new encryption key won't work for the backups you've taken until now, keep it somewhere safe and make a note of which backups it applies to.
4. To generate a new encryption key, select **Change encryption key**.
4. To generate a new encryption key, select **Next**, then select **Change encryption key**.
5. Download the new encryption key and store it in a safe place.
## I lost my backup encryption key - how can I retrieve it?
If you still have access to your Home Assistant instance you can download the encryption key again from the backup settings. If you have lost the encryption key, and have no access to your Home Assistant instance, there is no way to restore the backup.
If you still have access to your Home Assistant instance you can download the encryption key again from the backup settings.
- **If you have not changed the encryption key**: Home Assistant still has it. If you download the backup from the Home Assistant Backup page, it decrypts the backup on the fly.
- **If you have changed the encryption key**: Home Assistant can not decrypt it on the fly. You need the encryption key that is related to that backup. If you have lost the encryption key, and have no access to your Home Assistant instance, there is no way to restore the backup.

7
source/security/index.markdown
View File

@ -62,6 +62,13 @@ As an open source project, Home Assistant cannot offer bounties for security vul
The following is a list of past security advisories that have been published by the Home Assistant project.
**2025-02-18: SSL validation for outgoing requests in core and used libs not correct**
Severity: _High (CVSS: 7.0)_
Detailed information: _[Security advisory](https://github.com/home-assistant/core/security/advisories/GHSA-m3pm-rpgg-5wj6)_
Assigned CVE: _[CVE-2025-25305](https://nvd.nist.gov/vuln/detail/CVE-2025-25305)_
Discovered by: _[ReneNulschDE](https://github.com/ReneNulschDE)_
Fixed in: _Home Assistant Core 2024.1.6_
**2023-12-14: User accounts disclosed to unauthenticated actors on the LAN**
Severity: _Moderate (CVSS: 4.2)_
Detailed information: _[Security advisory](https://github.com/home-assistant/core/security/advisories/GHSA-jqpc-rc7g-vf83)_

21
source/voice_control/builtin_sentences.markdown
View File

@ -147,27 +147,6 @@ Unlike regular voice timers, delayed commands cannot be canceled or modified.
- *Pause TV in 10 minutes*
- *Open the blinds in 5 minutes*
## Questions
### Get information about a state
- *What is the amount of energy from solar production?*
- *what is the heat pump co2 sensor's co2 level?*
- *what is the battery level of my phone?*
### Ask about the weather
- *What is the weather*
- Struggling with this one? Check the [troubleshooting section](/voice_control/troubleshooting/).
### Ask about people
(that have device tracking activated in Home Assistant)
- *How many people are in the kitchen*
- *Who is in the garage*
- *Where is Anne*
## Aborting
- *Nevermind*: If you triggered the wake word by mistake and want to stop Home Assistant from listening

15
source/voice_control/index.markdown
View File

@ -19,19 +19,26 @@ This section will help you set up Assist, which is Home Assistant voice assistan
Assist allows you to control Home Assistant using natural language. It is built on top of an open voice foundation and powered by knowledge provided by our community.
Assist is available to use on most platforms that can interface with Home Assistant. Look for the Assist icon <img src='/images/assist/assist-icon.svg' alt='Assist icon' style='height: 32px' class='no-shadow'>:
The simplest way to try out Assist is inside our companion app. Look for the Assist icon <img src='/images/assist/assist-icon.svg' alt='Assist icon' style='height: 32px' class='no-shadow'> at the top right of your dashboard.
The simplest way to get started with Assist is with our recommended voice assistant hardware, the [Home Assistant Voice Preview Edition](/voice-pe/).
As for the rest of Home Assistant core functionalities, Assist can be personalized and extended to fit your needs.
- It can work locally or leverage the greatest LLMs of the moment.
- It can work on your phone or tablet or other custom voice devices.
<lite-youtube videoid="XF53wUbeLxA" videotitle="Voice at Home Assistant"></lite-youtube>
Although adding voice to your smart home configuration is exciting, it will require you to check your existing setup of Home Assistant, especially if you made a lot of customization. But we have prepared a guide of steps and best practices to help you out, as well as our [Troubleshooting](/voice_control/troubleshooting/) guides.
## Getting Started
Ready? Now let's get started
When you configure voice assistant hardware made for Home Assistant, it will use a wizard to help you configure your system and get started to use voice.
- [I plan to use a local speech-to-text/text-to-speech setup](/voice_control/voice_remote_local_assistant/)
Our recommended voice assistant hardware is the [Home Assistant Voice Preview Edition](/voice-pe/).
In case your hardware does not support our wizard, do not worry. Here are two detailed guides based on how you plan to process your voice (Locally, or using Home Assistant Cloud voice services)
- [I plan to process my voice locally](/voice_control/voice_remote_local_assistant/)
- [I plan to use Home Assistant Cloud](/voice_control/voice_remote_cloud_assistant/) (recommended as it is the simplest)
## Expand and Experiment

3
source/voice_control/troubleshooting.markdown
View File

@ -92,6 +92,7 @@ My voice assistant understands me and processes the command, but I don't get a v
The voice response is generated in Home Assistant by one of our supported text-to-speech (or {% term TTS %}) engines.
The voice assistant device then fetches the audio file from Home Assistant and plays it back.
### Local Network Settings
For this fetching process to work, Home Assistant must communicate its own URL to the device.
If you have a complex network setup, or if you changed this setting in the past, the URL communicated could be wrong.
@ -103,6 +104,8 @@ To fix the URL, follow these steps:
- For most users, the **Automatic** option works and is recommended.
![Create alias for entity name](/images/assist/local_url.png)
### Missing Media Source
If you are using YAML configuration and do not have `default_config:` make sure `media_source:` is present.
## Tweaking the Assist audio configuration for your device

61
source/voice_control/voice_remote_local_assistant.markdown
View File

@ -30,9 +30,37 @@ In Home Assistant, the Assist pipelines are made up of various components that t
## Some options for speech-to-text and text-to-speech
There is a speech-to-text and text-to-speech option that runs entirely local. No data is sent to external servers for processing.
There are speech-to-text and text-to-speech options that run entirely local. No data is sent to external servers for processing.
### Speech-to-text engines
There are currently two options to run speech-to-text locally: **Speech-to-Phrase** and **Whisper**.
#### Speech-to-Phrase
[Speech-to-Phrase](https://github.com/OHF-voice/speech-to-phrase) is a close-ended speech model.
- It transcribes what it knows.
- Extremely fast transcription even on a Home Assistant Green or Raspberry Pi 4 (under one second).
- Only supports a subset of Assist’s voice commands.
- More open-ended items such as shopping lists, naming a timer, and broadcasts are *not* usable out of the box.
- Speech-to-Phrase supports [various languages](https://github.com/OHF-voice/speech-to-phrase?tab=readme-ov-file#supported-languages).
- These qualities make it a great option for Home control!
#### Whisper
[Whisper](https://github.com/openai/whisper) is an open-ended speech model.
- It will try to transcribe everything.
- The cost is slower processing speed:
- On a Raspberry Pi 4, it takes around 8 seconds to process incoming voice commands.
- On an Intel NUC, it is done in under a second.
- Supports [various languages](https://github.com/openai/whisper#available-models-and-languages).
- Whisper is only a great option in the following case:
1. You have powerful hardware at home.
2. You plan to extend your voice set-up beyond simple home control. For example, by pairing your assistant with an LLM-based agent.
### Text-to-speech engine
The speech-to-text option is [Whisper](https://github.com/openai/whisper). It’s an open source AI model that supports [various languages](https://github.com/openai/whisper#available-models-and-languages). We use a forked version called [faster-whisper](https://github.com/SYSTRAN/faster-whisper). On a Raspberry Pi 4, it takes around 8 seconds to process incoming voice commands. On an Intel NUC, it is done in under a second.
For text-to-speech, we have developed [Piper](https://github.com/rhasspy/piper). Piper is a fast, local neural text-to-speech system that sounds great and is optimized for the Raspberry Pi 4. It supports [many languages](https://rhasspy.github.io/piper-samples/). On a Raspberry Pi, using medium quality models, it can generate 1.6s of voice in a second.
Please be sure to check how either option will work in your language, since quality can change quite a bit.
@ -42,20 +70,15 @@ Please be sure to check how either option will work in your language, since qual
For the quickest way to get your local Assist pipeline started, follow these steps:
1. Install the add-ons to convert text into speech and vice versa.
- Install the {% my supervisor_addon addon="core_whisper" title="**Whisper**" %} and the {% my supervisor_addon addon="core_piper" title="**Piper**" %} add-ons.
![Install the Whisper and Piper add-ons](/images/assist/piper-whisper-install-01.png)
- If you want to use a wake word, also install the {% my supervisor_addon addon="core_openwakeword" title="**openWakeWord**" %} add-on.
- Install the speech-to-text add-on of your choice, either {% my supervisor_addon addon="core_speech-to-phrase" title="**Speech-to-Phrase**" %} or {% my supervisor_addon addon="core_whisper" title="**Whisper**" %}.
- Install {% my supervisor_addon addon="core_piper" title="**Piper**" %} for text-to-speech.
- Start the add-ons.
- Once the add-ons are started, head over to the integrations under {% my integrations title="**Settings** > **Devices & Services**" %}.
- You should now see Piper and Whisper being discovered by the [Wyoming integration](/integrations/wyoming/).
- You should now see both services being discovered by the [Wyoming integration](/integrations/wyoming/).
![Whisper and Piper integrations](/images/assist/piper-whisper-install-new-02.png)
- For each integration, select **Add**.
- Once the setup is complete, you should see both Piper and Whisper (and, optionally, also openWakeword) in one integration.
![Whisper and Piper integration](/images/assist/piper-whisper-install-new-03.png)
- **Whisper** converts speech into text.
- **Piper** converts text into speech.
- **Wyoming** is the protocol they are both using to communicate.
- You now have integrated a local speech-to-text engine of your choice (either {% my supervisor_addon addon="core_speech-to-phrase" title="**Speech-to-Phrase**" %} or {% my supervisor_addon addon="core_whisper" title="**Whisper**" %}) and a text-to-speech engine ({% my supervisor_addon addon="core_piper" title="**Piper**" %}).
2. Setup your assistant.
- Go to {% my voice_assistants title="**Settings** > **Voice assistants**" %} and select **Add assistant**.
@ -71,13 +94,9 @@ For the quickest way to get your local Assist pipeline started, follow these ste
- Enter a name. You can pick any name that is meaningful to you.
- Select the language that you want to speak.
- Under **Conversation agent**, select **Home Assistant**.
- Under **Speech-to-text**, select **faster-whisper**. Select the language.
- Under **Text-to-speech**, select **piper**. Select the language.
- Under **Speech-to-text**, select the speech-to-text engine you choose in the previous step (either **Whisper** or **Speech-to-Phrase**). Select the language.
- Under **Text-to-speech**, select **Piper**. Select the language.
- Depending on your language, you may be able to select different language variants.
- If you like, pick one of the predefined wake words.
![Select wake word](/images/assist/assist_predefined_wakeword.png)
- You can even [define your own wake word](/voice_control/create_wake_word/). This is not difficult to do, but you will need to set aside a bit of time for this.
- Once you defined your own wake word, it will show in this pick list.
3. That's it. You ensured your voice commands can be processed locally on your device.
4. If you haven't done so yet, [expose your devices to Assist](/voice_control/voice_remote_expose_devices/#exposing-your-devices).
@ -94,6 +113,12 @@ The options are also documented in the add-on itself. Go to the {% my supervisor
Also be sure to check the specific tutorial for [using Piper in Automations](voice_control/using_tts_in_automation/)
## Learning more about Speech-to-Phrase
You can check out [Voice Chapter 9](/blog/2025/02/13/voice-chapter-9-speech-to-phrase/) to learn more about why we introduced Speech-to-Phrase, and why it's a great option for home control.
<lite-youtube videoid="k6VvzDSI8RU" videotitle="Voice Chapter 9"></lite-youtube>
## Next steps
Once Assist is configured, now can now start using it. You can now talk through your device ([Android](/voice_control/android/), [iOS](/voice_control/apple/) or [Voice Preview edition](https://voice-pe.home-assistant.io/getting-started/)).