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-13 12:26:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'current' into next

Browse Source
This commit is contained in:
Franck Nijhof 2022-05-16 10:45:38 +02:00
commit ba5b324ebe
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
16 changed files with 182 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
_config.yml
View File

@ -107,8 +107,8 @@ social:
# Home Assistant release details
current_major_version: 2022
current_minor_version: 5
current_patch_version: 3
date_released: 2022-05-08
current_patch_version: 4
date_released: 2022-05-12
# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.

2
source/_dashboards/picture-elements.markdown
View File

@ -406,7 +406,7 @@ elements:
### Custom Elements
The process for creating and referencing custom elements is the same as for custom cards.
Please see the [developer documentation](https://developers.home-assistant.io/docs/frontend/custom-ui/lovelace-custom-card.html)
Please see the [developer documentation](https://developers.home-assistant.io/docs/frontend/custom-ui/custom-card)
for more information.
{% configuration %}

2
source/_docs/automation/basics.markdown
View File

@ -5,7 +5,7 @@ description: "A breakdown of what an automation consists of."
All automations are made up of a trigger and an action. Optionally combined with a condition. Take for example the automation:
> When Paulus arrives home and it is after sunset: Turn the lights on in the living room.".
> When Paulus arrives home and it is after sunset: Turn the lights on in the living room.
We can break up this automation into the following three parts:

2
source/_includes/custom/features.html
View File

@ -2,7 +2,7 @@
<div class="card">
<div class="card-header">
<i class="icon-lightbulb"></i>
Works with over 1000 devices
Works with over 1900 devices
</div>
<div class="card-content">
<p>

2
source/_integrations/brother.markdown
View File

@ -51,7 +51,7 @@ template:
{{ is_state('sensor.hl_l2340d_status', 'no paper') }}
- binary_sensor:
- name: 'Later Printer Paper Jam'
- name: 'Laser Printer Paper Jam'
state: >
{{ is_state('sensor.hl_l2340d_status', 'paper jam') }}
```

20
source/_integrations/generic.markdown
View File

@ -26,24 +26,26 @@ You must enter a URL in at least one of the fields **Still Image URL** or **Stre
[Templates](/topics/templating/) are allowed in the URL fields, which can be used to select different images or parameterize the URL depending on the status of sensors. Template validity and network access are checked during the configuration steps.
{% configuration_basic %}
still_image_url:
Still Image URL:
description: "The URL your camera serves the image on, e.g., `http://192.168.1.21:2112/`. Can be a [template](/topics/templating/). At least one of still_image_url or stream_source must be provided."
stream_source:
Stream Source:
description: "The URL your camera serves the live stream on, e.g., `rtsp://user:pass@192.168.1.21:554/`. Can be a [template](/topics/templating/). Usernames and passwords must be embedded in the URL. At least one of still_image_url or stream_source must be provided. Note that a stream_source without a still_image_url can only be used if the [stream integration](/integrations/stream/) is configured."
username:
Username:
description: The username for accessing your camera. Note that this username applies only to still_image_url and not to stream_source.
password:
Password:
description: The password for accessing your camera. Note that this password applies only to still_image_url and not to stream_source.
authentication:
Authentication:
description: "Type for authenticating the requests `basic` or `digest`."
limit_refetch_to_url_change:
Limit refetch to URL change:
description: Limits re-fetching of the remote image to when the URL changes. Only relevant if using a template to fetch the remote image.
framerate:
Frame Rate:
description: The number of frames-per-second (FPS) of the stream. Can cause heavy traffic on the network and/or heavy load on the camera.
verify_ssl:
Verify SSL certificate:
description: Enable or disable SSL certificate verification. Set to false to use an http-only camera, or you have a self-signed SSL certificate and haven't installed the CA certificate to enable verification.
rtsp_transport:
RTSP transport protocol:
description: "Set the RTSP transport protocol to `tcp`, `udp`, `udp_multicast` or `http`."
Use wallclock as timestamps:
description: ([Advanced Mode](/blog/2019/07/17/release-96/#advanced-mode) only) Rewrite the camera timestamps. This may help with playback or crashing issues from Wi-Fi cameras or cameras of certain brands (e.g., EZVIZ).
{% endconfiguration_basic %}
<p class='img'>

2
source/_integrations/group.markdown
View File

@ -145,7 +145,7 @@ media_player:
- platform: group
entities:
- media_player.kitchen_tv
- media_player.livivng_room_tv
- media_player.living_room_tv
```
Example YAML configuration of a switch group:

2
source/_integrations/homekit.markdown
View File

@ -422,7 +422,7 @@ The following integrations are currently supported:
| lock | DoorLock | Support for `lock / unlock`. |
| media_player | MediaPlayer | Represented as a series of switches which control `on / off`, `play / pause`, `play / stop`, or `mute` depending on `supported_features` of entity and the `mode` list specified in `entity_config`. |
| media_player | TelevisionMediaPlayer | All media players that have `tv` as their `device_class`. Represented as Television and Remote accessories in HomeKit to control `on / off`, `play / pause`, `select source`, or `volume increase / decrease`, depending on `supported_features` of entity. Requires iOS 12.2/macOS 10.14.4 or later. |
| sensor | TemperatureSensor | All sensors that have `Celsius` or `Fahrenheit` as their `unit_of_measurement` or `temperature` as their `device_class`. |
| sensor | TemperatureSensor | All sensors that have `°C` or `°F` as their `unit_of_measurement` and `temperature` as their `device_class`. |
| sensor | HumiditySensor | All sensors that have `%` as their `unit_of_measurement` and `humidity` as their `device_class`. |
| sensor | AirQualitySensor | All sensors that have `pm25` as part of their `entity_id` or `pm25` as their `device_class` |
| sensor | CarbonMonoxideSensor | All sensors that have `co` as their `device_class` |

2
source/_integrations/overkiz.markdown
View File

@ -58,8 +58,6 @@ The Overkiz (by Somfy) integration platform is used by many different vendors, l
- Somfy TaHoma Switch [(instructions)](#tahoma-switch)
- Thermor Cozytouch
If you own a Somfy hub, you could also use the [Somfy integration](/integrations/somfy/) which uses the official API.
### TaHoma Switch
Multiple users reported that the TaHoma Switch will work with this integration **after** you create a scene in the TaHoma app and wait for a few hours.

22
source/_integrations/sabnzbd.markdown
View File

@ -34,17 +34,17 @@ You need to grab your API key from your SABnzbd instance in order to configure t
This component will create these sensors:
- `status`: The current status of SABnzbd (Idle, Paused, etc.)
- `speed`: The current download speed
- `queue`: The total size of the download queue
- `left`: The remaining size of the download queue
- `disk`: The total disk size at SABnzbd's download location
- `disk_free`: The available disk space at SABnzbd's download location
- `queue_count`: The number of items in the download queue
- `daily_total`: GB downloaded today
- `weekly_size`: GB downloaded this week
- `monthly_total`: GB downloaded this month
- `total`: Total GB downloaded
- `status`: The current status of SABnzbd. (Idle, Paused, etc.)
- `speed`: The current download speed.
- `queue`: The total size of the download queue.
- `left`: The remaining size of the download queue.
- `disk`: The total disk size at SABnzbd's download location.
- `disk_free`: The available disk space at SABnzbd's download location.
- `queue_count`: The number of items in the download queue.
- `total`: Total GB downloaded.
- `daily_total`: GB downloaded today. (disabled by default)
- `weekly_size`: GB downloaded this week. (disabled by default)
- `monthly_total`: GB downloaded this month. (disabled by default)
## Services

6
source/_integrations/somfy.markdown
View File

@ -18,6 +18,12 @@ ha_platforms:
ha_integration_type: integration
---
<div class="note warning">
The Somfy Open API (cloud-based) has been deprecated in favor of the [Somfy TaHoma Developer Mode](https://developer.somfy.com/developer-mode) and will shut down after June 21st, 2022. The [Overkiz integration](/integrations/overkiz/) will support this new local API and can already be used to control your Somfy devices via the cloud.
</div>
The Somfy integration will allow users to integrate their Somfy devices into Home Assistant using the [official API](https://developer.somfy.com/somfy-open-api/apis).
## Installation

36
source/_integrations/sonos.markdown
View File

@ -40,6 +40,7 @@ Speaker-level controls are exposed as `number` or `switch` entities. Additionall
### Sensors
- **Each Sonos system**: Sonos Favorites
- **Devices with battery**: Battery level, Power state
- **Home theater devices**: Audio Input Format
- **Voice-enabled devices**: Microphone Enabled
@ -64,6 +65,41 @@ The Sonos integration adds one `switch` for each alarm set in the Sonos app. The
The microphone can only be enabled/disabled from physical buttons on the Sonos device and cannot be controlled from Home Assistant. A `binary_sensor` reports its current state.
### Sonos Favorites support notes
The favorites sensor provides the names and `media_content_id` values for each of the favorites saved to My Sonos in the native Sonos app. This sensor is intended for users that need to access the favorites in a custom template. For most users, accessing favorites by using the Media Browser functionality and "Play media" script/automation action is recommended.
If using the provided `media_content_id` with the `media_player.play_media` service, the `media_content_type` must be set to "favorite_item_id".
Example templates:
{% raw %}
```yaml
# Get all favorite names as a list (old behavior)
{{ state_attr("sensor.sonos_favorites", "items").values() | list }}
# Pick a specific favorite name by position
{{ (state_attr("sensor.sonos_favorites", "items").values() | list)[3] }}
# Pick a random item's `media_content_id`
{{ state_attr("sensor.sonos_favorites", "items") | list | random }}
# Loop through and grab name & media_content_id
{% for media_id, name in state_attr("sensor.sonos_favorites", "items").items() %}
{{ name, media_id }}
{% endfor %}
```
{% endraw %}
<div class='note'>
The Sonos favorites sensor (`sensor.sonos_favorites`) is disabled by default. It can be found and enabled from the entities associated with the Sonos integration on your {% my integrations %} page.
</div>
## Playing media
Sonos accepts a variety of `media_content_id` formats in the `media_player.play_media` service, but most commonly as URIs. For example, both Spotify and Tidal share links can be provided as-is. Playback of [music hosted on a Plex server](/integrations/plex#sonos-playback) is possible. Direct HTTP/HTTPS links to local or remote media files can also be used if the Sonos device can reach the URI directly, but specific media encoding support may vary.

8
source/_integrations/trafikverket_train.markdown
View File

@ -20,21 +20,23 @@ Retrieve train departure information from [Trafikverket](https://www.trafikverke
## Use cases
- Retrieve the next departure and information connected to it for a specific train line.
- Retrieve information for specific departure time on a specific train line.
- Retrieve the next departure between two stations.
- Retrieve information for specific departure time between two stations.
- Set up an alert or perform actions if your train is delayed or canceled.
## Retrieved data
- Next departure for the specific train line.
- Canceled status.
- The number of minutes delayed.
- Delayed time.
- Planned time if no delays occur.
- Estimated time of arrival if delays occur.
- Actual time - when it did arrive.
- Other information / additional texts.
- Deviations.
The next departure is calculated from actual, estimated, and planned to provide the most accurate information about departure.
## Prerequisites
Please click [here](https://api.trafikinfo.trafikverket.se/) and register to obtain the API key.

29
source/_integrations/unifiprotect.markdown
View File

@ -54,9 +54,34 @@ UCKP with Firmware v1.x **do NOT run UniFi OS**, you must upgrade to firmware v2
### Software Support
The absolute **minimal** software version is `1.20.0` for UniFi Protect. If you have an older version, you will get errors trying to set up the integration. However, the general advice is the latest 2 minor versions of UniFi Protect and hardware supported by those are supported. Since UniFi Protect has its own release cycle, you should only upgrade UniFi Protect _after_ the next Home Assistant release comes out to ensure the new version is fully supported.
The absolute **minimal** software version is `1.20.0` for UniFi Protect. If you have an older version, you will get errors trying to set up the integration. However, the general advice is the latest 2 minor versions of UniFi Protect and hardware supported by those are supported.
Example: as of `2022.2.0` of Home Assistant, UniFi Protect `1.21.0` is the newest UniFi Protect version. So the recommended versions of UniFi Protect to run for a `2022.2.0` version of Home Assistant are `1.20.0`, `1.20.1`, `1.20.2`, `1.20.3`, `1.21.0`.
#### About UniFi Early Access
Since UniFi Protect has its own release cycle, you should only upgrade UniFi Protect _after_ the next Home Assistant release to ensure the new version is fully supported. Most importantly, that means **do not use Early Access versions of UniFi Protect if you want your UniFi Protect integration to be stable**. Early Access versions can and will break the UniFi Protect Home Assistant integration unexpectedly. If you desire to use Early Access versions of UniFi Protect, you can disable automatic updates and wait for the next bugfix version of UniFi Protect to come out.
For example, the latest UniFi Protect Early Access version as of `2022.5.4` is UniFi Protect `2.0.0-beta.5` and the latest Early Access version of UniFi Protect is `2.0.0-beta.7`. So that means:
* **do not** upgrade to `2.0.0-beta.7` until `2022.5.5` or `2022.6.0` comes out
* the recommended version of UniFi Protect are any `1.21.x` version or `2.0.0-beta` version before `2.0.0-beta.7`
#### Downgrading UniFi Protect
In the event you accidentally upgrade to an Early Access version of UniFi Protect and it breaks your UniFi Protect Home Assistant integration, you can access your <a href="https://help.ui.com/hc/en-us/articles/204909374#h_01F8G1NSFWE9GWXMT977VQEP8V" target="_blank" rel="noopener">UniFi OS Console via SSH</a> and then do the following:
```bash
# run this command first _only_ if you are on a 1.x firmware of the UDM Pro
# it is not needed for the UDM SE, UNVR, etc.
unifi-os shell
# downgrade UniFi Protect
apt-get update
apt-get install --reinstall --allow-downgrades unifi-protect=2.0.0~beta.5 -y
```
You can replace `2.0.0-beta.5` with whatever version of UniFi Protect you want to downgrade to.
**Note**: if you want to downgrade to another Early Access version, you must have <a href="https://help.ui.com/hc/en-us/articles/115012240067-UniFi-How-to-enable-remote-access" target="_blank" rel="noopener">Remote Access enabled</a> and have the Early Access release channel enabled.
### Local User

72
source/_posts/2022-05-04-release-20225.markdown
View File

@ -64,6 +64,7 @@ Enjoy the release!
- [Release 2022.5.1 - May 5](#release-202251---may-5)
- [Release 2022.5.2 - May 6](#release-202252---may-6)
- [Release 2022.5.3 - May 8](#release-202253---may-8)
- [Release 2022.5.4 - May 12](#release-202254---may-12)
- [Need help? Join the community!](#need-help-join-the-community)
- [Breaking Changes](#breaking-changes)
- [Farewell to the following](#farewell-to-the-following)
@ -815,7 +816,76 @@ The following integrations are now available via the Home Assistant UI:
[sql docs]: /integrations/sql/
[totalconnect docs]: /integrations/totalconnect/
[ukraine_alarm docs]: /integrations/ukraine_alarm/
****
## Release 2022.5.4 - May 12
- Fix timezone issue on onvif integration ([@marvinroger] - [#70473]) ([onvif docs])
- Fix Insteon issue with dimmer default on level ([@teharris1] - [#71426]) ([insteon docs])
- Migrate sabnzbd sensors unique ids ([@shaiu] - [#71455]) ([sabnzbd docs])
- Bump simplisafe-python to 2022.05.1 ([@bachya] - [#71545]) ([simplisafe docs])
- Fix SABnzbd config check ([@shaiu] - [#71549]) ([sabnzbd docs])
- Fix typer/click incompatibilty for unifiprotect ([@AngellusMortis] - [#71555]) ([unifiprotect docs])
- Improve Google Cast detection of HLS playlists ([@emontnemery] - [#71564]) ([cast docs])
- Correct device class for meater cook sensors ([@emontnemery] - [#71565]) ([meater docs])
- Bump pychromecast to 12.1.2 ([@emontnemery] - [#71567]) ([cast docs])
- Bump logi_circle to 0.2.3 ([@evanjd] - [#71578]) ([logi_circle docs])
- Bump nam backend library to version 1.2.4 ([@bieniu] - [#71584]) ([nam docs])
- Bump pydeconz to v92 ([@Kane610] - [#71613]) ([deconz docs])
- Fix wrong brightness level change visible in UI ([@rappenze] - [#71655]) ([fibaro docs])
- Prevent history_stats from rejecting states when microseconds differ ([@bdraco] - [#71704]) ([history_stats docs])
- Fix zwave_js device automation bug ([@raman325] - [#71715]) ([zwave_js docs])
- Fix merge conflict with master to dev in sabnzbd (CI fix) ([@bdraco] - [#71605]) ([sabnzbd docs])
- Add use_wallclock_as_timestamps option to generic ([@uvjustin] - [#71245]) ([generic docs])
- Changed API for Ukraine Alarm ([@PaulAnnekov] - [#71754]) ([ukraine_alarm docs])
[#70473]: https://github.com/home-assistant/core/pull/70473
[#71245]: https://github.com/home-assistant/core/pull/71245
[#71426]: https://github.com/home-assistant/core/pull/71426
[#71455]: https://github.com/home-assistant/core/pull/71455
[#71545]: https://github.com/home-assistant/core/pull/71545
[#71549]: https://github.com/home-assistant/core/pull/71549
[#71555]: https://github.com/home-assistant/core/pull/71555
[#71564]: https://github.com/home-assistant/core/pull/71564
[#71565]: https://github.com/home-assistant/core/pull/71565
[#71567]: https://github.com/home-assistant/core/pull/71567
[#71578]: https://github.com/home-assistant/core/pull/71578
[#71584]: https://github.com/home-assistant/core/pull/71584
[#71605]: https://github.com/home-assistant/core/pull/71605
[#71613]: https://github.com/home-assistant/core/pull/71613
[#71655]: https://github.com/home-assistant/core/pull/71655
[#71704]: https://github.com/home-assistant/core/pull/71704
[#71715]: https://github.com/home-assistant/core/pull/71715
[#71754]: https://github.com/home-assistant/core/pull/71754
[@AngellusMortis]: https://github.com/AngellusMortis
[@Kane610]: https://github.com/Kane610
[@PaulAnnekov]: https://github.com/PaulAnnekov
[@bachya]: https://github.com/bachya
[@bdraco]: https://github.com/bdraco
[@bieniu]: https://github.com/bieniu
[@emontnemery]: https://github.com/emontnemery
[@evanjd]: https://github.com/evanjd
[@marvinroger]: https://github.com/marvinroger
[@raman325]: https://github.com/raman325
[@rappenze]: https://github.com/rappenze
[@shaiu]: https://github.com/shaiu
[@teharris1]: https://github.com/teharris1
[@uvjustin]: https://github.com/uvjustin
[cast docs]: /integrations/cast/
[deconz docs]: /integrations/deconz/
[fibaro docs]: /integrations/fibaro/
[generic docs]: /integrations/generic/
[history_stats docs]: /integrations/history_stats/
[insteon docs]: /integrations/insteon/
[logi_circle docs]: /integrations/logi_circle/
[meater docs]: /integrations/meater/
[nam docs]: /integrations/nam/
[onvif docs]: /integrations/onvif/
[sabnzbd docs]: /integrations/sabnzbd/
[simplisafe docs]: /integrations/simplisafe/
[ukraine_alarm docs]: /integrations/ukraine_alarm/
[unifiprotect docs]: /integrations/unifiprotect/
[zwave_js docs]: /integrations/zwave_js/
## Need help? Join the community!
Home Assistant has a great community of users who are all more than willing

20
source/getting-started/configuration.markdown
View File

@ -13,16 +13,13 @@ The steps below do not apply to Home Assistant Core & Container installations, f
We are going to help you make your first changes to `configuration.yaml`. To do this, we are going to install an add-on from the Home Assistant add-on store: the File editor. To get to the add-on store, click on the menu icon in the top left, then open {% my supervisor title="Settings > Add-ons" %}. On the new page, open the add-on store tab.
<p class='img'>
<img src='/images/hassio/screenshots/dashboard.png' />
From the {% my supervisor title="Settings > Add-ons" %} panel, open the add-on store.
</p>
![Add-on store.](/images/hassio/screenshots/dashboard.png)
Under the "Official add-ons" section you will find the File editor add-on.
- Click on File Editor and click on INSTALL. When installation is complete, the UI will go to the add-on details page for the file editor.
- Now start the add-on by clicking on START.
- Open the user interface by clicking on OPEN WEB UI.
- Click on File Editor and click on **Install**. When installation is complete, the UI will go to the add-on details page for the file editor.
- Now start the add-on by clicking on **Start**.
- Open the user interface by clicking on **Open Web UI**.
Now let's make a change using the file editor: we are going to change the name, location, unit system, and time zone of your Home Assistant installation.
@ -44,13 +41,10 @@ Now let's make a change using the file editor: we are going to change the name,
</div>
- Click the save icon in the top right to commit changes.
- Most changes in `configuration.yaml` require Home Assistant to be restarted to see the changes. You can verify that your changes are acceptable by running a configuration check. Do this by clicking on Configuration in the sidebar, click on "Settings", "Server Controls" and click on the "CHECK configuration" button. When it's valid, it will show the text "Configuration valid!". In order for the "CHECK configuration" button to be visible, you must enable "Advanced Mode" on your user profile.
- Now Restart Home Assistant using the "RESTART" button in the Server management section on the same page.
- Most changes in `configuration.yaml` require Home Assistant to be restarted to see the changes. You can verify that your changes are acceptable by running a configuration check. Do this by clicking on Configuration in the sidebar, click on `Developer-Tools -> YAML` and click on the **Check configuration** button. When it's valid, it will show the text "Configuration valid!". In order for the **Check Configuration**" button to be visible, you must enable "Advanced Mode" on your user profile.
- Now Restart Home Assistant using the **Restart** button in the Server management section on the same page.
<p class='img'>
<img src='/images/screenshots/configuration-validation.png' />
Screenshot of the "General" page in the configuration panel.
</p>
![Screenshot of the "General" page in the configuration panel.](/images/screenshots/configuration-validation.png)
<div class='note'>