mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 07:17:14 +00:00
Merge branch 'current' into rc
This commit is contained in:
Franck Nijhof
commit
4bc72a2983
@ -12,7 +12,7 @@ Follow this guide if you want to get started with Home Assistant easily or if yo
|
||||
|
||||
We will need a few things to get started with installing Home Assistant. Links below lead to Amazon US. If you’re not in the US, you should be able to find these items in web stores in your country.
|
||||
|
||||
- [Raspberry Pi 4](https://amzn.to/2S0Gcl1) (Raspberry Pi 3 is ok too, if you have one laying around)
|
||||
- [Raspberry Pi 4](https://amzn.to/2S0Gcl1) (Raspberry Pi 3 is ok too, if you have one laying around). Raspberry Pi are currently hard to come by, use [RPilocator](https://rpilocator.com/?cat=PI4) to find webshops with stock.
|
||||
- [Power Supply for Raspberry Pi 4](https://amzn.to/2ReZ2Vq) or [Power Supply for Raspberry Pi 3](https://amzn.to/2R8yG7h)
|
||||
- [Micro SD Card](https://amzn.to/2X0Z2di). Ideally get one that is [Application Class 2](https://www.sdcard.org/developers/overview/application/index.html) as they handle small I/O much more consistently than cards not optimized to host applications. A 32 GB or bigger card is recommended.
|
||||
- SD Card reader. This is already part of most laptops, but you can purchase a [standalone USB adapter](https://amzn.to/2WWxntY) if you don't have one. The brand doesn't matter, just pick the cheapest.
|
||||
|
||||
@ -132,162 +132,6 @@ data:
|
||||
It's possible to play with other apps than the default media receiver.
|
||||
To do so, `media_content_type` should be set to `cast`, and `media_content_id` should be a JSON dict with parameters for the app, including the app name.
|
||||
|
||||
### BubbleUPNP
|
||||
|
||||
The BubbleUPNP app has similar functionality to the built in Default Media Receiver app, and can be used as a backup if the default app fails to play the media.
|
||||
|
||||
#### Media parameters
|
||||
|
||||
Mandatory:
|
||||
|
||||
- `app_name`: `bubbleupnp`
|
||||
- `media_id`: The URL to play
|
||||
|
||||
Optional:
|
||||
|
||||
- `media_type`: Media type, e.g. `video/mp4`, `audio/mp3`, `image/jpeg`, defaults to `video/mp4`.
|
||||
|
||||
#### Example
|
||||
|
||||
```yaml
|
||||
'cast_bubbleupnp_to_my_chromecast':
|
||||
alias: "Cast a video to My Chromecast using BubbleUPNP"
|
||||
sequence:
|
||||
- target:
|
||||
entity_id: media_player.my_chromecast
|
||||
data:
|
||||
media_content_type: cast
|
||||
media_content_id: '
|
||||
{
|
||||
"app_name": "bubbleupnp",
|
||||
"media_id": "http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4",
|
||||
"media_type": "video/mp4"
|
||||
}'
|
||||
service: media_player.play_media
|
||||
```
|
||||
|
||||
### YouTube
|
||||
|
||||
#### Media parameters
|
||||
|
||||
Mandatory:
|
||||
|
||||
- `app_name`: `youtube`
|
||||
- `media_id`: YouTube video ID
|
||||
|
||||
Optional:
|
||||
|
||||
- `enqueue`: Enqueue only
|
||||
- `playlist_id`: Play video with `media_id` from this playlist. Note that only providing `playlist_id` but no `media_id` does not work.
|
||||
|
||||
#### Example
|
||||
|
||||
```yaml
|
||||
'cast_youtube_to_my_chromecast':
|
||||
alias: "Cast YouTube to My Chromecast"
|
||||
sequence:
|
||||
- target:
|
||||
entity_id: media_player.my_chromecast
|
||||
data:
|
||||
media_content_type: cast
|
||||
media_content_id: '
|
||||
{
|
||||
"app_name": "youtube",
|
||||
"media_id": "dQw4w9WgXcQ"
|
||||
}'
|
||||
service: media_player.play_media
|
||||
```
|
||||
|
||||
### [Supla](https://www.supla.fi/)
|
||||
|
||||
#### Media parameters
|
||||
|
||||
Mandatory:
|
||||
|
||||
- `app_name`: `supla`
|
||||
- `media_id`: Supla item ID
|
||||
|
||||
Optional:
|
||||
|
||||
- `is_live`: Item is a livestream
|
||||
|
||||
#### Example
|
||||
|
||||
Example values to cast the item at <https://www.supla.fi/audio/3601824>
|
||||
|
||||
```yaml
|
||||
'cast_supla_to_my_chromecast':
|
||||
alias: "Cast supla to My Chromecast"
|
||||
sequence:
|
||||
- target:
|
||||
entity_id: media_player.my_chromecast
|
||||
data:
|
||||
media_content_type: cast
|
||||
media_content_id: '
|
||||
{
|
||||
"app_name": "supla",
|
||||
"media_id": "3601824"
|
||||
}'
|
||||
service: media_player.play_media
|
||||
```
|
||||
|
||||
### Plex
|
||||
|
||||
To cast media directly from a configured Plex server, set the fields [as documented in the Plex integration](/integrations/plex/#service-play_media) and prepend the `media_content_id` with `plex://`:
|
||||
|
||||
```yaml
|
||||
'cast_plex_to_chromecast':
|
||||
alias: "Cast Plex to Chromecast"
|
||||
sequence:
|
||||
- service: media_player.play_media
|
||||
target:
|
||||
entity_id: media_player.chromecast
|
||||
data:
|
||||
media_content_type: movie
|
||||
media_content_id: 'plex://{"library_name": "Movies", "title": "Groundhog Day"}'
|
||||
```
|
||||
|
||||
### [BBC Sounds](https://www.bbc.co.uk/sounds)
|
||||
|
||||
This app doesn't retrieve its own metadata, so if you want the cast interface or media player card to show titles and/or images you will have to provide the data yourself. See the examples below.
|
||||
|
||||
#### Media parameters
|
||||
|
||||
Mandatory:
|
||||
|
||||
- `app_name`: `bbcsounds`
|
||||
- `media_id`: Item ID
|
||||
|
||||
Optional:
|
||||
|
||||
- `is_live`: Item is a live stream
|
||||
|
||||
#### Example
|
||||
|
||||
Example values to cast [BBC Radio 1](https://www.bbc.co.uk/sounds/play/live:bbc_radio_one)
|
||||
|
||||
```yaml
|
||||
alias: "Cast BBC Sounds to My Chromecast"
|
||||
sequence:
|
||||
- service: media_player.play_media
|
||||
target:
|
||||
entity_id: media_player.my_chromecast
|
||||
data:
|
||||
media_content_type: cast
|
||||
media_content_id: '
|
||||
{
|
||||
"app_name": "bbcsounds",
|
||||
"media_id": "bbc_radio_one",
|
||||
"is_live": true
|
||||
}'
|
||||
extra:
|
||||
metadata:
|
||||
metadataType: 0
|
||||
title: "Radio 1"
|
||||
images:
|
||||
- url: "https://sounds.files.bbci.co.uk/2.3.0/networks/bbc_radio_one/background_1280x720.png"
|
||||
```
|
||||
|
||||
### [BBC iPlayer](https://www.bbc.co.uk/iplayer)
|
||||
|
||||
This app doesn't retrieve its own metadata, so if you want the cast interface or media player card to show titles and/or images you will have to provide the data yourself. See the examples below.
|
||||
@ -338,6 +182,171 @@ Example values to cast [this episode](https://www.bbc.co.uk/iplayer/episode/b09w
|
||||
- url: "https://ichef.bbci.co.uk/images/ic/1280x720/p07j4m3r.jpg"
|
||||
```
|
||||
|
||||
### [BBC Sounds](https://www.bbc.co.uk/sounds)
|
||||
|
||||
This app doesn't retrieve its own metadata, so if you want the cast interface or media player card to show titles and/or images you will have to provide the data yourself. See the examples below.
|
||||
|
||||
#### Media parameters
|
||||
|
||||
Mandatory:
|
||||
|
||||
- `app_name`: `bbcsounds`
|
||||
- `media_id`: Item ID
|
||||
|
||||
Optional:
|
||||
|
||||
- `is_live`: Item is a live stream
|
||||
|
||||
#### Example
|
||||
|
||||
Example values to cast [BBC Radio 1](https://www.bbc.co.uk/sounds/play/live:bbc_radio_one)
|
||||
|
||||
```yaml
|
||||
alias: "Cast BBC Sounds to My Chromecast"
|
||||
sequence:
|
||||
- service: media_player.play_media
|
||||
target:
|
||||
entity_id: media_player.my_chromecast
|
||||
data:
|
||||
media_content_type: cast
|
||||
media_content_id: '
|
||||
{
|
||||
"app_name": "bbcsounds",
|
||||
"media_id": "bbc_radio_one",
|
||||
"is_live": true
|
||||
}'
|
||||
extra:
|
||||
metadata:
|
||||
metadataType: 0
|
||||
title: "Radio 1"
|
||||
images:
|
||||
- url: "https://sounds.files.bbci.co.uk/2.3.0/networks/bbc_radio_one/background_1280x720.png"
|
||||
```
|
||||
|
||||
### BubbleUPNP
|
||||
|
||||
The BubbleUPNP app has similar functionality to the built in Default Media Receiver app, and can be used as a backup if the default app fails to play the media.
|
||||
|
||||
#### Media parameters
|
||||
|
||||
Mandatory:
|
||||
|
||||
- `app_name`: `bubbleupnp`
|
||||
- `media_id`: The URL to play
|
||||
|
||||
Optional:
|
||||
|
||||
- `media_type`: Media type, e.g. `video/mp4`, `audio/mp3`, `image/jpeg`, defaults to `video/mp4`.
|
||||
|
||||
#### Example
|
||||
|
||||
```yaml
|
||||
'cast_bubbleupnp_to_my_chromecast':
|
||||
alias: "Cast a video to My Chromecast using BubbleUPNP"
|
||||
sequence:
|
||||
- target:
|
||||
entity_id: media_player.my_chromecast
|
||||
data:
|
||||
media_content_type: cast
|
||||
media_content_id: '
|
||||
{
|
||||
"app_name": "bubbleupnp",
|
||||
"media_id": "http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4",
|
||||
"media_type": "video/mp4"
|
||||
}'
|
||||
service: media_player.play_media
|
||||
```
|
||||
|
||||
### Plex
|
||||
|
||||
To cast media directly from a configured Plex server, set the fields [as documented in the Plex integration](/integrations/plex/#service-play_media) and prepend the `media_content_id` with `plex://`:
|
||||
|
||||
```yaml
|
||||
'cast_plex_to_chromecast':
|
||||
alias: "Cast Plex to Chromecast"
|
||||
sequence:
|
||||
- service: media_player.play_media
|
||||
target:
|
||||
entity_id: media_player.chromecast
|
||||
data:
|
||||
media_content_type: movie
|
||||
media_content_id: 'plex://{"library_name": "Movies", "title": "Groundhog Day"}'
|
||||
```
|
||||
|
||||
### [Supla](https://www.supla.fi/)
|
||||
|
||||
Note: Media ID is NOT the 8 digit alphanumeric in the URL, it can be found by right-clicking the playing audio clip. E.g., [this episode](https://www.bbc.co.uk/sounds/play/p009ycqy) shows:
|
||||
|
||||
| | |
|
||||
| --- | --- |
|
||||
| 128bps | dash (mf_cloudfront_nonbidi_dash_https) |
|
||||
| p009ycqz | |
|
||||
|
||||
With p009ycqz being the `media_id`
|
||||
|
||||
#### Media parameters
|
||||
|
||||
Mandatory:
|
||||
|
||||
- `app_name`: `supla`
|
||||
- `media_id`: Supla item ID
|
||||
|
||||
Optional:
|
||||
|
||||
- `is_live`: Item is a livestream
|
||||
|
||||
#### Example
|
||||
|
||||
Example values to cast the item at <https://www.supla.fi/audio/3601824>
|
||||
|
||||
```yaml
|
||||
'cast_supla_to_my_chromecast':
|
||||
alias: "Cast supla to My Chromecast"
|
||||
sequence:
|
||||
- target:
|
||||
entity_id: media_player.my_chromecast
|
||||
data:
|
||||
media_content_type: cast
|
||||
media_content_id: '
|
||||
{
|
||||
"app_name": "supla",
|
||||
"media_id": "3601824"
|
||||
}'
|
||||
service: media_player.play_media
|
||||
```
|
||||
|
||||
### YouTube
|
||||
|
||||
#### Media parameters
|
||||
|
||||
Mandatory:
|
||||
|
||||
- `app_name`: `youtube`
|
||||
- `media_id`: YouTube video ID
|
||||
|
||||
Optional:
|
||||
|
||||
- `enqueue`: Enqueue only
|
||||
- `playlist_id`: Play video with `media_id` from this playlist. Note that only providing `playlist_id` but no `media_id` does not work.
|
||||
|
||||
#### Example
|
||||
|
||||
```yaml
|
||||
'cast_youtube_to_my_chromecast':
|
||||
alias: "Cast YouTube to My Chromecast"
|
||||
sequence:
|
||||
- target:
|
||||
entity_id: media_player.my_chromecast
|
||||
data:
|
||||
media_content_type: cast
|
||||
media_content_id: '
|
||||
{
|
||||
"app_name": "youtube",
|
||||
"media_id": "dQw4w9WgXcQ"
|
||||
}'
|
||||
service: media_player.play_media
|
||||
```
|
||||
|
||||
## Troubleshooting automatic discovery
|
||||
|
||||
mDNS relies on UDP multicast, which may fail for various reasons. If none of the tips in this section helps, the recommended solution is to ensure all cast devices have static IPs assigned to them and configure a list of known hosts.
|
||||
|
||||
@ -70,7 +70,7 @@ cover:
|
||||
required: false
|
||||
type: template
|
||||
availability_template:
|
||||
description: Defines a template to get the `available` state of the entity. If the template either fails to render or returns either of `True`, `"1"`, `"true"`, `"yes"`, `"on"`, `"enable"` or a non-zero number, the entity is `available`. If the template returns any other value, the device will be `unavailable`. If not configured, the entity will always be `available`. Note that the string comparison not case sensitive; `"TrUe"` and `"yEs"` are allowed.
|
||||
description: Defines a template to get the `available` state of the entity. If the template either fails to render or returns `True`, `"1"`, `"true"`, `"yes"`, `"on"`, `"enable"`, or a non-zero number, the entity will be `available`. If the template returns any other value, the entity will be `unavailable`. If not configured, the entity will always be `available`. Note that the string comparison not case sensitive; `"TrUe"` and `"yEs"` are allowed.
|
||||
required: false
|
||||
type: template
|
||||
default: true
|
||||
|
||||
@ -48,11 +48,6 @@ password:
|
||||
description: The password associated with your Eight Sleep account.
|
||||
required: true
|
||||
type: string
|
||||
partner:
|
||||
description: Defines if you'd like to fetch data for both sides of the bed.
|
||||
required: false
|
||||
type: boolean
|
||||
default: false
|
||||
{% endconfiguration %}
|
||||
|
||||
### Supported features
|
||||
|
||||
@ -94,7 +94,7 @@ fan:
|
||||
required: false
|
||||
type: template
|
||||
availability_template:
|
||||
description: Defines a template to get the `available` state of the entity. If the template either fails to render or returns either of `True`, `"1"`, `"true"`, `"yes"`, `"on"`, `"enable"` or a non-zero number, the entity is `available`. If the template returns any other value, the device will be `unavailable`. If not configured, the entity will always be `available`. Note that the string comparison not case sensitive; `"TrUe"` and `"yEs"` are allowed.
|
||||
description: Defines a template to get the `available` state of the entity. If the template either fails to render or returns `True`, `"1"`, `"true"`, `"yes"`, `"on"`, `"enable"`, or a non-zero number, the entity will be `available`. If the template returns any other value, the entity will be `unavailable`. If not configured, the entity will always be `available`. Note that the string comparison not case sensitive; `"TrUe"` and `"yEs"` are allowed.
|
||||
required: false
|
||||
type: template
|
||||
default: true
|
||||
|
||||
@ -4,7 +4,7 @@ description: Instructions on how to use the FinTS sensor.
|
||||
ha_category:
|
||||
- Finance
|
||||
ha_release: '0.70'
|
||||
ha_iot_class: Local Push
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_domain: fints
|
||||
ha_platforms:
|
||||
- sensor
|
||||
|
||||
@ -145,7 +145,7 @@ light:
|
||||
required: false
|
||||
type: template
|
||||
availability_template:
|
||||
description: Defines a template to get the `available` state of the entity. If the template either fails to render or returns either of `True`, `"1"`, `"true"`, `"yes"`, `"on"`, `"enable"` or a non-zero number, the entity is `available`. If the template returns any other value, the device will be `unavailable`. If not configured, the entity will always be `available`. Note that the string comparison not case sensitive; `"TrUe"` and `"yEs"` are allowed.
|
||||
description: Defines a template to get the `available` state of the entity. If the template either fails to render or returns `True`, `"1"`, `"true"`, `"yes"`, `"on"`, `"enable"`, or a non-zero number, the entity will be `available`. If the template returns any other value, the entity will be `unavailable`. If not configured, the entity will always be `available`. Note that the string comparison not case sensitive; `"TrUe"` and `"yEs"` are allowed.
|
||||
required: false
|
||||
type: template
|
||||
default: true
|
||||
|
||||
@ -56,7 +56,7 @@ lock:
|
||||
required: true
|
||||
type: template
|
||||
availability_template:
|
||||
description: Defines a template to get the `available` state of the entity. If the template either fails to render or returns either of `True`, `"1"`, `"true"`, `"yes"`, `"on"`, `"enable"` or a non-zero number, the entity is `available`. If the template returns any other value, the device will be `unavailable`. If not configured, the entity will always be `available`. Note that the string comparison not case sensitive; `"TrUe"` and `"yEs"` are allowed.
|
||||
description: Defines a template to get the `available` state of the entity. If the template either fails to render or returns `True`, `"1"`, `"true"`, `"yes"`, `"on"`, `"enable"`, or a non-zero number, the entity will be `available`. If the template returns any other value, the entity will be `unavailable`. If not configured, the entity will always be `available`. Note that the string comparison not case sensitive; `"TrUe"` and `"yEs"` are allowed.
|
||||
required: false
|
||||
type: template
|
||||
default: true
|
||||
|
||||
@ -24,6 +24,12 @@ Both `sensor` and `binary_sensor` are supported as source sensor. A number of ch
|
||||
|
||||
Assuming the [`recorder`](/integrations/recorder/) integration is running, historical sensor data is read from the database on startup and is available immediately after a restart of the platform. If the [`recorder`](/integrations/recorder/) integration is *not* running, it can take some time for the sensor to start reporting data because some characteristics calculations require more than one source sensor value.
|
||||
|
||||
<div class='note tip'>
|
||||
|
||||
The `statistics` integration is different to a [Long-term Statistics](https://developers.home-assistant.io/docs/core/entity/sensor/#long-term-statistics). More details on the differences can be found in the [2021.8.0 release notes](/blog/2021/08/04/release-20218/#long-term-statistics).
|
||||
|
||||
</div>
|
||||
|
||||
## Characteristics
|
||||
|
||||
The following statistical characteristics are available. Pay close attention to the right configuration of `sampling_size` and `max_age`, as most characteristics are directly related to the count of samples or the age of processed samples.
|
||||
|
||||
@ -60,7 +60,7 @@ switch:
|
||||
type: template
|
||||
default: optimistic
|
||||
availability_template:
|
||||
description: Defines a template to get the `available` state of the entity. If the template either fails to render or returns either of `True`, `"1"`, `"true"`, `"yes"`, `"on"`, `"enable"` or a non-zero number, the entity is `available`. If the template returns any other value, the device will be `unavailable`. If not configured, the entity will always be `available`. Note that the string comparison not case sensitive; `"TrUe"` and `"yEs"` are allowed.
|
||||
description: Defines a template to get the `available` state of the entity. If the template either fails to render or returns `True`, `"1"`, `"true"`, `"yes"`, `"on"`, `"enable"`, or a non-zero number, the entity will be `available`. If the template returns any other value, the entity will be `unavailable`. If not configured, the entity will always be `available`. Note that the string comparison not case sensitive; `"TrUe"` and `"yEs"` are allowed.
|
||||
required: false
|
||||
type: template
|
||||
default: true
|
||||
|
||||
@ -65,7 +65,7 @@ vacuum:
|
||||
required: true
|
||||
type: template
|
||||
availability_template:
|
||||
description: Defines a template to get the `available` state of the entity. If the template either fails to render or returns either of `True`, `"1"`, `"true"`, `"yes"`, `"on"`, `"enable"` or a non-zero number, the entity is `available`. If the template returns any other value, the device will be `unavailable`. If not configured, the entity will always be `available`. Note that the string comparison not case sensitive; `"TrUe"` and `"yEs"` are allowed.
|
||||
description: Defines a template to get the `available` state of the entity. If the template either fails to render or returns `True`, `"1"`, `"true"`, `"yes"`, `"on"`, `"enable"`, or a non-zero number, the entity will be `available`. If the template returns any other value, the entity will be `unavailable`. If not configured, the entity will always be `available`. Note that the string comparison not case sensitive; `"TrUe"` and `"yEs"` are allowed.
|
||||
required: false
|
||||
type: template
|
||||
default: true
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user