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-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'current' into rc

Browse Source
This commit is contained in:
Franck Nijhof 2020-10-27 20:32:19 +01:00
commit d1cb99f58f
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
22 changed files with 72 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Gemfile.lock
View File

@ -3,7 +3,7 @@ GEM
specs:
addressable (2.7.0)
public_suffix (>= 2.0.2, < 5.0)
chunky_png (1.3.12)
chunky_png (1.3.13)
colorator (1.1.0)
commonmarker (0.21.0)
ruby-enum (~> 0.5)
@ -109,7 +109,7 @@ GEM
tilt (2.0.10)
tzinfo (2.0.2)
concurrent-ruby (~> 1.0)
tzinfo-data (1.2020.3)
tzinfo-data (1.2020.4)
tzinfo (>= 1.0.0)
unicode-display_width (1.7.0)

2
source/_integrations/ambient_station.markdown
View File

@ -47,7 +47,7 @@ app_key:
This integration communicates with Ambient Weather PWS units via the Ambient Weather
Cloud. Users wishing to explore a local option are encouraged to explore the
[Ecowitt GW1000](http://www.ecowitt.com/wifi_weather/80.html), a small device that is
[Ecowitt GW1000](https://www.ecowitt.com/shop/goodsDetail/16), a small device that is
able to read RF signals directly from the PWS and transmit them to a variety of
other applications, including [`ecowitt2mqtt`](https://github.com/bachya/ecowitt2mqtt)
(which supports [MQTT Discovery](/docs/mqtt/discovery)).

2
source/_integrations/android_ip_webcam.markdown
View File

@ -179,7 +179,7 @@ You can setup the binary motion sensor with the following in your `configuration
binary_sensor:
- platform: rest
name: Kitchen Motion
sensor_class: motion
device_class: motion
resource: http://IP_ADDRESS:PORT/sensors.json?sense=motion_active
value_template: '{{ value_json.motion_active.data[0][1][0] | round(0) }}'
```

2
source/_integrations/cast.markdown
View File

@ -124,7 +124,7 @@ media_player:
type: list
keys:
uuid:
description: UUID of a Cast device to add to Home Assistant. Use only if you don't want to add all available devices. The device won't be added until discovered through mDNS.
description: UUID of a Cast device to add to Home Assistant. Use only if you don't want to add all available devices. The device won't be added until discovered through mDNS. In order to find the UUID for your device use a mDNS browser or advanced users can use the following Python command (adjust friendly names as required) - python3 -c "import pychromecast; print(pychromecast.get_listed_chromecasts(friendly_names=["Living Room TV", "Bedroom TV", "Office Chromecast"]))"
required: false
type: string
ignore_cec:

2
source/_integrations/clicksend.markdown
View File

@ -54,7 +54,7 @@ recipient:
required: true
type: [string, list]
sender:
description: The name or number of the sender.
description: The name or number of the sender. (Limited to 11 characters.)
required: false
type: string
default: 'hass'

1
source/_integrations/denonavr.markdown
View File

@ -26,6 +26,7 @@ Known supported devices:
- Denon AVR-X2100W
- Denon AVR-X2200W
- Denon AVR-X2300W
- Denon AVR-X2400H
- Denon AVR-X3200W
- Denon AVR-X3300W
- Denon AVR-X3400H

6
source/_integrations/derivative.markdown
View File

@ -49,12 +49,12 @@ unit_prefix:
default: None
type: string
unit_time:
description: SI unit of time of the derivative. Available units are s, min, h, d.
description: SI unit of time of the derivative. Available units are s, min, h, d. If this parameter is set, the attribute **unit_of_measurement** will be set like x/y where x is the unit of the sensor given via the **source** parameter and y is the value given here.
required: false
default: h
type: string
unit:
description: Unit of Measurement to be used for the derivative.
description: Unit of Measurement to be used for the derivative. This will overwrite the automatically set **unit_of_measurement** as explained above.
required: false
type: string
time_window:
@ -78,6 +78,6 @@ sensor:
source: sensor.temperature
name: Temperature change per hour
round: 1
unit_time: h
unit_time: h # the resulting "unit_of_measurement" will be °C/h if the sensor.temperate has set °C as it's unit
time_window: "00:30:00" # we look at the change over the last half hour
```

1
source/_integrations/discovery.markdown
View File

@ -23,7 +23,6 @@ Home Assistant can discover and automatically configure [zeroconf](https://en.wi
* [Logitech Harmony Hub](/integrations/harmony)
* [Logitech Media Server (Squeezebox)](/integrations/squeezebox)
* [NETGEAR routers](/integrations/netgear)
* [Panasonic Viera](/integrations/panasonic_viera)
* [Philips Hue](/integrations/hue)
* [SABnzbd downloader](/integrations/sabnzbd)
* [Samsung SyncThru Printer](/integrations/syncthru)

6
source/_integrations/eafm.md
View File

@ -13,6 +13,12 @@ ha_codeowners:
The `eafm` integration offers integration with the [UK Environment Agency Flood Monitoring](https://flood-warning-information.service.gov.uk/) API to provide sensors for nearby water levels. Combined with Home Assistant notifications, you could give yourself a warning if a nearby river was likely to flood your local cycle path or the only road out of your village.
<div class='note warning'>
The UK Environment Agency Flood Monitoring only provides data for England - Northern Ireland, Scotland and Wales have their own flood agencies.
</div>
## Configuration
Home Assistant offers the flood monitoring integration through **Configuration** -> **Integrations** -> **Environment Agency Flood Gauges**.

2
source/_integrations/kodi.markdown
View File

@ -38,7 +38,7 @@ If you do not remove it, your configuration will be imported with the following
You can customize your turn on and off actions through automations. Simply use the relevant Kodi device triggers and your automation will be called to perform the `turn_on` or `turn_off` sequence; see the [Kodi turn on/off samples](#kodi-turn-onoff-samples) section for scripts that can be used.
These automations can be configured through the UI (see [Device Triggers](/automation/trigger/#device-triggers) for automations). If you prefer YAML, you'll need to get the device ID from the UI automation editor. Automations would be of the form:
These automations can be configured through the UI (see [Device Triggers](/docs/automation/trigger/#device-triggers) for automations). If you prefer YAML, you'll need to get the device ID from the UI automation editor. Automations would be of the form:
```yaml
automation:

1
source/_integrations/logbook.markdown
View File

@ -5,6 +5,7 @@ ha_category:
- History
ha_release: 0.7
ha_domain: logbook
ha_iot_class: ~
---
<img src='/images/screenshots/logbook.png' style='margin-left:10px; float: right;' height="100" />

6
source/_integrations/loopenergy.markdown
View File

@ -10,6 +10,12 @@ ha_codeowners:
- '@pavoni'
---
<div class='note warning'>
Loop Energy has said that on November 13, 2020, they will [switch off the servers which this integration uses](https://email.loop.homes/action-required-how-to-claim-your-free-loop-upgrade-1). This integration will stop working then.
</div>
Integrate your [Loop Energy](https://www.your-loop.com/) meter information into Home Assistant. To use this sensor you need the client serial number and secret keys for your devices.
The library used to get the data isn't officially supported and the only way to get the keys is to log into loop energy's website and type a command into your browser console.

2
source/_integrations/media_player.markdown
View File

@ -67,7 +67,7 @@ Currently only supported on [Denon AVR](/integrations/denonavr/) and [Songpal](
#### Service `media_player.shuffle_set`
Currently only supported on [Sonos](/integrations/sonos), [Spotify](/integrations/spotify), [MPD](/integrations/mpd), [Kodi](/integrations/kodi), [Squeezebox](/integrations/squeezebox) and [Universal](/integrations/universal).
Currently only supported on [Sonos](/integrations/sonos), [Spotify](/integrations/spotify), [MPD](/integrations/mpd), [Kodi](/integrations/kodi), [Roon](/integrations/roon), [Squeezebox](/integrations/squeezebox) and [Universal](/integrations/universal).
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------- |

1
source/_integrations/notify.markdown
View File

@ -8,6 +8,7 @@ ha_quality_scale: internal
ha_codeowners:
- '@home-assistant/core'
ha_domain: notify
ha_iot_class: ~
---
The `notify` integration makes it possible to send notifications to a wide variety of platforms. To use it you have to setup at least one notification target (notifier), check the [integrations list](/integrations/#notifications) for one that fits your use case.

1
source/_integrations/opengarage.markdown
View File

@ -2,6 +2,7 @@
title: OpenGarage
description: Instructions on how to integrate OpenGarage.io covers within Home Assistant.
ha_category:
- Cover
- DIY
ha_iot_class: Local Polling
ha_release: 0.44

3
source/_integrations/panasonic_viera.markdown
View File

@ -120,7 +120,8 @@ script:
- TX-P50GT60E
- TH-32ES500
- TX-42AS650
- TX55ASW654
- TX-55ASW654
- TX-55FX680W
- TX-55FZ802B
- TX-55ASM655

15
source/_integrations/roon.markdown
View File

@ -19,7 +19,7 @@ To integrate with Roon, you need to provide Home Assistant with the Hostname or
If you use an IP address, please assign a static IP address to the machine that runs Roon Core. This ensures that it won't change IP addresses, so you won't have to change the configuration in Home Assistant if it reboots and changes IP address. See your router's manual for details on how to set this up.
### Configuration
## Configuration
You need the Hostname or IP address of the machine that runs your Roon Core. This might be a machine name (which can be followed by `.local`, e.g., `myserver.local`) or can be an IP address.
@ -28,3 +28,16 @@ You need the Hostname or IP address of the machine that runs your Roon Core. Thi
3. Home Assistant will then contact your Roon Core and ask to be authorized. You will need to enable this extension in the Room Application. Go to **Settings** and then **Extensions**, there you will see an entry for Home Assistant with a button next to it. Click **Enable**.
4. Roon core will then provide Home Assistant with the details of your media players.
5. In Home Assistant you can then pick an area for each of your music players, and add them to Home Assistant.
#### Service `media_player.play_media`
Roon doesn't use file names or URLs to track media and so the roon integration is currently limited in how it supports this call.
| Service data attribute | Optional | Description |
| -----------------------| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | yes | Target a specific media player. To target all media players, use `all`. |
| `media_content_id` | no | The text for roon to search for in your library. |
| `media_content_type` | no | A media type. Currently supported are `radio`, `playlist` and `genre` |
For example to play BBC Radio 4 you would set `media_content_type` to `radio` and `media_content_id` to `BBC Radio 4`

1
source/_integrations/search.markdown
View File

@ -8,6 +8,7 @@ ha_quality_scale: internal
ha_codeowners:
- '@home-assistant/core'
ha_domain: search
ha_iot_class: ~
---
The `search` integration is an internally used integration by the

4
source/_integrations/xbee.markdown
View File

@ -11,7 +11,7 @@ ha_iot_class: Local Polling
ha_domain: xbee
---
[Zigbee](https://zigbee.org/what-is-zigbee/) integration for Home Assistant allows you to utilize modules such as the [XBee](https://www.digi.com/xbee) as wireless General Purpose Input/Output (GPIO) devices. The integration requires a local Xbee device to be connected to a serial port. Through this, it will send and receive commands to and from other devices on the Zigbee mesh network.
[Zigbee](https://zigbeealliance.org/solution/zigbee/) integration for Home Assistant allows you to utilize modules such as the [XBee](https://www.digi.com/xbee) as wireless General Purpose Input/Output (GPIO) devices. The integration requires a local Xbee device to be connected to a serial port. Through this, it will send and receive commands to and from other devices on the Zigbee mesh network.
There is currently support for the following device types within Home Assistant:
@ -134,7 +134,7 @@ on_state:
## Sensor
There are two types of [Zigbee](https://zigbee.org/) sensor available to Home Assistant:
There are two types of [Zigbee](https://zigbeealliance.org/) sensor available to Home Assistant:
- [Analog input pin](#analog-input-pin)
- [Temperature sensor](#temperature-sensor) (XBee Pro)

12
source/_integrations/zha.markdown
View File

@ -40,9 +40,11 @@ There is also support for grouping of lights, switches, and fans (i.e. support f
## ZHA exception and deviation handling
Zigbee devices that deviate from or do not fully conform to the standard specifications set by the [Zigbee Alliance](https://zigbeealliance.org) may require the development of custom [ZHA Device Handlers](https://github.com/dmulcahey/zha-device-handlers) (ZHA custom quirks handler implementation) for all their functions to work properly with the ZHA integration in Home Assistant. These ZHA Device Handlers for Home Assistant can thus be used to parse custom messages to and from Zigbee devices.
The ZHA implementation in Home Assistant relies on a library called "[ZHA Device Handlers](https://github.com/zigpy/zha-device-handlers)" to resolve issues with Zigbee devices that do not fully conform with the Zigbee standards. The few devices that deviate from the Zigbee specifications set by the [Zigbee Alliance](https://zigbeealliance.org) may therefore require proper bug reports with debug logs from users to assistant the developers in writing custom [ZHA Device Handlers](https://github.com/zigpy/zha-device-handlers/blob/dev/README.md) for all of a device functions to work properly with the ZHA integration.
The custom quirks implementations for zigpy implemented as ZHA Device Handlers for Home Assistant are a similar concept to that of [Hub-connected Device Handlers for the SmartThings Classics platform](https://docs.smartthings.com/en/latest/device-type-developers-guide/) as well as that of [Zigbee-Shepherd Converters as used by Zigbee2mqtt](https://www.zigbee2mqtt.io/how_tos/how_to_support_new_devices.html), meaning they are each virtual representations of a physical device that expose additional functionality that is not provided out-of-the-box by the existing integration between these platforms.
Such a custom "ZHA Device Handler" are Python scripts that internally is also referred to as a "quirk" because they fix "quirks" as in deviations from the standard specifications. ZHA Device Handles do this by transparently acting as a translator, translating and converting non-compliant device messages and instead present them to the application as coming from a virtual compliant device. These ZHA Device Handlers for Home Assistant can thus be used to parse custom messages to and from Zigbee devices. The ZHA Device Handlers that are made can then be reused by all users in future versions of Home Assistant.
The custom quirks implementations for zigpy implemented as ZHA Device Handlers for Home Assistant are a similar concept to that of [Hub-connected Device Handlers for the SmartThings Classics platform](https://docs.smartthings.com/en/latest/device-type-developers-guide/) as well as that of [Zigbee-Herdsman Converters (formerly Zigbee-Shepherd Converters) as used by Zigbee2mqtt](https://www.zigbee2mqtt.io/how_tos/how_to_support_new_devices.html), meaning they are each virtual representations of a physical device that expose additional functionality that is not provided out-of-the-box by the existing integration between these platforms.
## Compatible hardware
@ -64,6 +66,9 @@ ZHA integration uses a hardware independent Zigbee stack implementation with mod
- Telegesis ETRX357USB (Note! This first have to be flashed with other EmberZNet firmware)
- Telegesis ETRX357USB-LRS (Note! This first have to be flashed with other EmberZNet firmware)
- Telegesis ETRX357USB-LRS+8M (Note! This first have to be flashed with other EmberZNet firmware)
- Texas Instruments based radios with Z-Stack 3.x.x (via the [zigpy-znp](https://github.com/zha-ng/zigpy-znp) library for zigpy)
- [CC2652P/CC2652R/CC2652RB USB stick or dev board hardware flashed with Z-Stack 3.x.x coordinator firmware](https://www.zigbee2mqtt.io/information/supported_adapters)
- [CC1352P/CC1352R USB stick or dev board hardware flashed with Z-Stack 3.x.x coordinator firmware](https://www.zigbee2mqtt.io/information/supported_adapters)
- Digi XBee Zigbee based radios (via the [zigpy-xbee](https://github.com/zigpy/zigpy-xbee) library for zigpy)
- Digi XBee Series 3 (xbee3-24) modules
- Digi XBee Series 2C (S2C) modules
@ -71,9 +76,6 @@ ZHA integration uses a hardware independent Zigbee stack implementation with mod
### Experimental support for additional Zigbee radio modules
- Texas Instruments based radios with Z-Stack 3.x.x (via the [zigpy-znp](https://github.com/zha-ng/zigpy-znp) library for zigpy)
- [CC2652P/CC2652R/CC2652RB USB stick or dev board hardware flashed with Z-Stack 3.x.x coordinator firmware](https://www.zigbee2mqtt.io/information/supported_adapters)
- [CC1352P/CC1352R USB stick or dev board hardware flashed with Z-Stack 3.x.x coordinator firmware](https://www.zigbee2mqtt.io/information/supported_adapters)
- Texas Instruments based radios with Z-Stack Home 1.2.x (via the [zigpy-cc](https://github.com/zigpy/zigpy-cc) library for zigpy)
- [CC2531 USB stick hardware flashed with Z-Stack Home 1.2.x coordinator firmware](https://www.zigbee2mqtt.io/information/supported_adapters)
- [CC2530 + CC2591/CC2592 USB stick hardware flashed with Z-Stack Home 1.2.x coordinator firmware](https://www.zigbee2mqtt.io/information/supported_adapters)

2
source/_posts/2020-10-07-release-116.markdown
View File

@ -174,6 +174,8 @@ We welcome the following new integration this release:
The following integration got support for a new platform:
- [Synology DSM][synology_dsm docs] now supports cameras, added by [@shenxn]
- [Synology DSM][synology_dsm docs] now has a switch to control home mode in
Surveillance Station [@Quentame]
- [HVV Departures][hvv_departures docs] added binary sensors to show elevator
statuses. Added by [@vigonotion]
- Support for covers was added to [Modbus][modbus docs], by [@vzahradnik]

34
source/hassio/installation.markdown
View File

@ -105,23 +105,23 @@ If you would like to test next release before anyone else, you can install the b
[balenaEtcher]: https://www.balena.io/etcher
[hassos-network]: https://github.com/home-assistant/operating-system/blob/dev/Documentation/network.md
[pi0-w]: https://github.com/home-assistant/operating-system/releases/download/4.14/hassos_rpi0-w-4.14.img.gz
[pi1]: https://github.com/home-assistant/operating-system/releases/download/4.14/hassos_rpi-4.14.img.gz
[pi2]: https://github.com/home-assistant/operating-system/releases/download/4.14/hassos_rpi2-4.14.img.gz
[pi3-32]: https://github.com/home-assistant/operating-system/releases/download/4.14/hassos_rpi3-4.14.img.gz
[pi3-64]: https://github.com/home-assistant/operating-system/releases/download/4.14/hassos_rpi3-64-4.14.img.gz
[pi4-32]: https://github.com/home-assistant/operating-system/releases/download/4.14/hassos_rpi4-4.14.img.gz
[pi4-64]: https://github.com/home-assistant/operating-system/releases/download/4.14/hassos_rpi4-64-4.14.img.gz
[tinker]: https://github.com/home-assistant/operating-system/releases/download/4.14/hassos_tinker-4.14.img.gz
[odroid-c2]: https://github.com/home-assistant/operating-system/releases/download/4.14/hassos_odroid-c2-4.14.img.gz
[odroid-n2]: https://github.com/home-assistant/operating-system/releases/download/4.14/hassos_odroid-n2-4.14.img.gz
[odroid-xu4]: https://github.com/home-assistant/operating-system/releases/download/4.14/hassos_odroid-xu4-4.14.img.gz
[intel-nuc]: https://github.com/home-assistant/operating-system/releases/download/4.14/hassos_intel-nuc-4.14.img.gz
[vmdk]: https://github.com/home-assistant/operating-system/releases/download/4.14/hassos_ova-4.14.vmdk.gz
[vhdx]: https://github.com/home-assistant/operating-system/releases/download/4.14/hassos_ova-4.14.vhdx.gz
[vdi]: https://github.com/home-assistant/operating-system/releases/download/4.14/hassos_ova-4.14.vdi.gz
[qcow2]: https://github.com/home-assistant/operating-system/releases/download/4.14/hassos_ova-4.14.qcow2.gz
[Virtual Appliance]: https://github.com/home-assistant/operating-system/releases/download/4.14/hassos_ova-4.14.ova
[pi0-w]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_rpi0-w-4.15.img.gz
[pi1]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_rpi-4.15.img.gz
[pi2]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_rpi2-4.15.img.gz
[pi3-32]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_rpi3-4.15.img.gz
[pi3-64]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_rpi3-64-4.15.img.gz
[pi4-32]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_rpi4-4.15.img.gz
[pi4-64]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_rpi4-64-4.15.img.gz
[tinker]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_tinker-4.15.img.gz
[odroid-c2]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_odroid-c2-4.15.img.gz
[odroid-n2]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_odroid-n2-4.15.img.gz
[odroid-xu4]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_odroid-xu4-4.15.img.gz
[intel-nuc]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_intel-nuc-4.15.img.gz
[vmdk]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_ova-4.15.vmdk.gz
[vhdx]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_ova-4.15.vhdx.gz
[vdi]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_ova-4.15.vdi.gz
[qcow2]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_ova-4.15.qcow2.gz
[Virtual Appliance]: https://github.com/home-assistant/operating-system/releases/download/4.15/hassos_ova-4.15.ova
[local]: http://homeassistant.local:8123
[samba]: /addons/samba/
[ssh]: /addons/ssh/