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-28 03:37:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'current' into next

Browse Source
This commit is contained in:
Franck Nijhof 2020-05-12 10:15:56 +02:00
commit 46d2c0b578
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
19 changed files with 174 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -45,4 +45,4 @@
- I made a change that is related to an upcoming version of Home Assistant and used the `next` branch.
- [ ] The documentation follows the Home Assistant documentation [standards][].
[standards]: https://developers.home-assistant.io/docs/documentation_standards.html
[standards]: https://developers.home-assistant.io/docs/documenting/standards

2
Gemfile.lock
View File

@ -79,7 +79,7 @@ GEM
mini_portile2 (~> 2.4.0)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (4.0.4)
public_suffix (4.0.5)
rack (2.2.2)
rack-protection (2.0.8.1)
rack

6
README.md
View File

@ -9,11 +9,13 @@ This is the source for the [Home-Assistant.io website](https://home-assistant.io
## Setup
Setting up to contribute to documentation and the process for submitting pull requests is explained in the [developer documentation](https://developers.home-assistant.io/docs/documentation_index.html).
Setting up to contribute to documentation and the process for submitting pull requests is explained in the [developer documentation](https://developers.home-assistant.io/docs/documenting).
## Site preview
In order to make the preview available on [http://127.0.0.1:4000](http://127.0.0.1:4000), use the command as follows:
In order to make the preview available on [http://127.0.0.1:4000](http://127.0.0.1:4000), use the following [bundler](
https://bundler.io/
) command:
```bash
bundle exec rake preview

4
_config.yml
View File

@ -101,8 +101,8 @@ social:
# Home Assistant release details
current_major_version: 0
current_minor_version: 109
current_patch_version: 5
date_released: 2020-05-06
current_patch_version: 6
date_released: 2020-05-07
# 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/_docs/installation/docker.markdown
View File

@ -8,7 +8,7 @@ redirect_from: /getting-started/installation-docker/
These below instructions are for an installation of Home Assistant Core running in your own Docker environment, which you manage yourself.
Note that Docker command line option `--net=host` or the compose file equivalent `network_mode: host` must be used to put put Home Assistant on the host's network, otherwise certain functionality - including mDNS and UPnP - will break. The `-p` command line option or the compose file equivalent `ports:` is not compatible with host networking mode and must not be used.
Note that Docker command line option `--net=host` or the compose file equivalent `network_mode: host` must be used to put Home Assistant on the host's network, otherwise certain functionality - including mDNS and UPnP - will break. The `-p` command line option or the compose file equivalent `ports:` is not compatible with host networking mode and must not be used.
</div>

11
source/_docs/tools/ensure_config.markdown
View File

@ -1,11 +0,0 @@
---
title: "ensure_config"
description: "Script to perform a check if the configuration file exists"
---
This script checks if the `configuration.yaml` file exists. If the file is not available, one is created.
```bash
$ hass --script ensure_config
```

52
source/_includes/asides/docs_navigation.html
View File

@ -135,7 +135,6 @@
<li>{% active_link /docs/tools/benchmark/ benchmark %}</li>
<li>{% active_link /docs/tools/check_config/ check_config %}</li>
<li>{% active_link /docs/tools/credstash/ credstash %}</li>
<li>{% active_link /docs/tools/ensure_config/ ensure_config %}</li>
<li>{% active_link /docs/tools/keyring/ keyring %}</li>
</ul>
</li>
@ -193,57 +192,6 @@
<li>{% active_link /docs/mqtt/processing_json/ Processing JSON %}</li>
</ul>
</li>
<li>
<b>{% active_link /docs/ecosystem/ios/ iOS %}</b>
<ul>
<li>
{% active_link /docs/ecosystem/ios/notifications/basic/ Basic
notifications %}
</li>
<ul>
<li>
{% active_link /docs/ecosystem/ios/notifications/sounds/ Sounds %}
</li>
<li>
{% active_link /docs/ecosystem/ios/notifications/architecture/
Architecture %}
</li>
<li>
{% active_link
/docs/ecosystem/ios/notifications/privacy_security_rate_limits/
Privacy, rate limiting and security %}
</li>
</ul>
<li>Advanced notifications</li>
<ul>
<li>
{% active_link /docs/ecosystem/ios/notifications/attachments/
Attachments %}
</li>
<li>
{% active_link
/docs/ecosystem/ios/notifications/content_extensions/ Dynamic
content %}
</li>
<li>
{% active_link /docs/ecosystem/ios/notifications/actions/
Actionable notifications %}
</li>
<li>
{% active_link
/docs/ecosystem/ios/notifications/requesting_location_updates/
Requesting location updates %}
</li>
</ul>
<li>
{% active_link /docs/ecosystem/ios/location/ Location Tracking %}
</li>
<li>
{% active_link /docs/ecosystem/ios/integration/ Integration with
other apps %}
</li>
</ul>
</li>
<li>
{% active_link /docs/ecosystem/ Ecosystem %}
<ul>

2
source/_integrations/asuswrt.markdown
View File

@ -12,7 +12,7 @@ ha_codeowners:
ha_domain: asuswrt
---
The `asuswrt` integration is the main integration to connect to a [ASUSWRT](https://event.asus.com/2013/nw/ASUSWRT/) based router.
The `asuswrt` integration is the main integration to connect to a [ASUSWRT](https://www.asus.com/ASUSWRT/) based router.
There is currently support for the following device types within Home Assistant:

6
source/_integrations/denonavr.markdown
View File

@ -11,14 +11,16 @@ ha_codeowners:
- '@starkillerOG'
---
The `denonavr` platform allows you to control a [Denon Network Receivers](https://www.denon.co.uk/chg/product/compactsystems/networkmusicsystems/ceolpiccolo) from Home Assistant. It might be that your device is supported by the [Denon] platform.
The `denonavr` platform allows you to control [Denon Network Receivers](https://www.denon.co.uk/chg/product/compactsystems/networkmusicsystems/ceolpiccolo) from Home Assistant. It might be that your device is supported by the [Denon] platform.
Known supported devices:
- Denon AVR-X1200W
- Denon AVR-X1300W
- Denon AVR-X1500H
- Denon AVR-X2000
- Denon AVR-X2100W
- Denon AVR-X2200W
- Denon AVR-X3400H
- Denon AVR-X4100W
- Denon AVR-X4300H
@ -31,7 +33,7 @@ Known supported devices:
- Denon AVR-S750H
- Marantz M-CR510
- Marantz M-CR603
- Marantz M-RC610
- Marantz M-CR610
- Marantz SR5008
- Marantz SR6007 - SR6010
- Marantz NR1504

2
source/_integrations/proxmoxve.markdown
View File

@ -126,8 +126,8 @@ Creating a dedicated user for Home Assistant, limited to only the role just crea
* Open `Permissions` and click `Users`
* Click `Add`
* Enter a username (e.g., "hass")
* Enter a secure password (it can be complex as you will only need to copy/paste it into your Home Assistant configuration)
* Set the realm to "Proxmox VE authentication server"
* Enter a secure password (it can be complex as you will only need to copy/paste it into your Home Assistant configuration)
* Ensure `Enabled` is checked and `Expire` is set to "never"
* Click `Add`

1
source/_integrations/sensor.websocket_api.markdown
View File

@ -25,3 +25,4 @@ sensor:
### Note
This replaces the previous `api_streams` sensor.
The default sensor name is `connected_clients`.

2
source/_integrations/simplisafe.markdown
View File

@ -40,7 +40,7 @@ password:
required: true
type: string
code:
description: A code to enable or disable the alarm in the frontend.
description: A code to enable or disable the alarm in the frontend. *Under normal operation, the integration doesn’t need a SimpliSafe keypad code.*
required: false
type: string
{% endconfiguration %}

12
source/_integrations/vacuum.xiaomi_miio.markdown
View File

@ -293,13 +293,11 @@ This token (32 hexadecimal characters) is required for the Xiaomi Mi Robot Vacuu
1. Configure the robot with the Mi-Home app. Make sure to select the correct region, as Xiaomi uses different product names for different geographical areas. Note that the new RoboRock app is currently not supported for this method.
2. Install [BlueStacks](https://www.bluestacks.com).
3. Set up [Mi Home version 5.0.30](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-0-30-release/) in BlueStacks and login to synchronize devices.
4. Use [BlueStacks Tweaker](https://forum.xda-developers.com/general/general/bluestacks-tweaker-2-tool-modifing-t3622681) to access the filesystem and retrieve the token.
5. Copy `/data/data/com.xiaomi.smarthome/databases/miio2.db` file to your computer using the Bluestacks Tweakers filesystem tool.
6. Install [DB Browser for SQLite](https://sqlitebrowser.org/).
7. Open the DB Browser and load the `miio2.db` from your computer.
8. Select `Browse Data` tab from the DB Browser and switch to table called `devicerecord`
9. This will display all the connected devices information with the token.
3. Set up [Mi Home version 5.4.49](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-4-49-release/) in BlueStacks and login to synchronize devices.
4. Open Filemanager in the `More Apps` menu.
5. Use `Explore` on the left and navigate to `sdcard/SmartHome/logs/plug_DeviceManager`.
6. Click on `Export to Windows` in the lower left corner and select any or all files to export to you local disk.
7. Search for `"token":"<yourTokenHere>"`.
### Miio command line tool

23
source/_integrations/vizio.markdown
View File

@ -175,6 +175,29 @@ apps:
default: null
{% endconfiguration %}
```yaml
# Complete configuration.yaml entry
vizio:
- host: "DEVICE_IP:DEVICE_PORT"
access_token: AUTH_TOKEN
name: MY_VIZIO_DEVICE
device_class: tv
volume_step: 1
apps:
include:
- APP_1
- APP_2
exclude:
- APP_1
- APP_2
additional_configs:
- name: MY_CUSTOM_APP
config:
APP_ID: 9
NAME_SPACE: 9
MESSAGE: MY_MESSAGE
```
### Obtaining an app configuration
If there is an app you want to be able to launch from Home Assistant that isn't detected by default, you will need to specify the app configuration in `configuration.yaml`. This configuration can be obtained from the `app_id` state attribute when an unknown app is running on your device.

51
source/_integrations/zha.markdown
View File

@ -41,7 +41,11 @@ Zigbee devices that deviate from or do not fully conform to the standard specifi
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.
## Known working Zigbee radio modules
## Compatible hardware
ZHA integration uses a hardware independent Zigbee stack implementation with modular design which means that it can support any one of the many Zigbee coordinator radio modules/adapters available from different manufacturers, as long as that module/adapter is compatible with [zigpy](https://github.com/zigpy/zigpy).
### Known working Zigbee radio modules
- dresden elektronik deCONZ based Zigbee radios (via the [zigpy-deconz](https://github.com/zigpy/zigpy-deconz) library for zigpy)
- [ConBee II (a.k.a. ConBee 2) USB adapter from dresden elektronik](https://phoscon.de/conbee2)
@ -54,18 +58,21 @@ The custom quirks implementations for zigpy implemented as ZHA Device Handlers f
- 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 CC253x, CC26x2R, and CC13x2 based radios (via the [zigpy-cc](https://github.com/sanyatuning/zigpy-cc) library for zigpy)
- 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
- Digi XBee Series 2 (S2) modules (Note! This first have to be flashed with Zigbee Coordinator API firmware)
### Experimental support for additional Zigbee radio modules
- Texas Instruments CC253x, CC26x2R, and CC13x2 based radios (via the [zigpy-cc](https://github.com/zigpy/zigpy-cc) library for zigpy)
- [CC2531 USB stick hardware flashed with custom Z-Stack coordinator firmware from the Zigbee2mqtt project](https://www.zigbee2mqtt.io/getting_started/what_do_i_need.html)
- [CC2530 + CC2591 USB stick hardware flashed with custom Z-Stack coordinator firmware from the Zigbee2mqtt project](https://www.zigbee2mqtt.io/getting_started/what_do_i_need.html)
- [CC2530 + CC2592 dev board hardware flashed with custom Z-Stack coordinator firmware from the Zigbee2mqtt project](https://www.zigbee2mqtt.io/getting_started/what_do_i_need.html)
- [CC2652R dev board hardware flashed with custom Z-Stack coordinator firmware from the Zigbee2mqtt project](https://www.zigbee2mqtt.io/getting_started/what_do_i_need.html)
- [CC1352P-2 dev board hardware flashed with custom Z-Stack coordinator firmware from the Zigbee2mqtt project](https://www.zigbee2mqtt.io/getting_started/what_do_i_need.html)
- [CC2538 + CC2592 dev board hardware flashed with custom Z-Stack coordinator firmware from the Zigbee2mqtt project](https://www.zigbee2mqtt.io/getting_started/what_do_i_need.html)
- 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
- Digi XBee Series 2 (S2) modules (Note! This first have to be flashed with Zigbee Coordinator API firmware)
- ZiGate based radios (via the [zigpy-zigate](https://github.com/doudz/zigpy-zigate) library for zigpy and require firmware 3.1a or later)
- ZiGate based radios (via the [zigpy-zigate](https://github.com/zigpy/zigpy-zigate) library for zigpy and require firmware 3.1a or later)
- [ZiGate USB-TTL](https://zigate.fr/produit/zigate-ttl/)
- [ZiGate USB-DIN](https://zigate.fr/produit/zigate-usb-din/)
- [PiZiGate](https://zigate.fr/produit/pizigate-v1-0/)
@ -140,6 +147,36 @@ Reset your Zigbee devices according to the device instructions provided by the m
## Troubleshooting
### Reporting issues
When reporting issues, please provide the following information in addition to information requested by issue template:
1. Debug logs for the issue, see [debug logging](#debug-logging)
2. Model of Zigbee radio being used
3. If issue is related to a specific Zigbee device, provide device Zigbee signature. Signature is available at
`Configuration` Panel -> `Zigbee Home Automation` -> Pick your Device -> `Zigbee Information`
### Debug logging
To enable debug logging for ZHA component ard radio libraries, add the following [logger](https://www.home-assistant.io/integrations/logger/) configuration to `configuration.yaml`:
```yaml
logger:
default: info
logs:
homeassistant.core: debug
homeassistant.components.zha: debug
bellows.zigbee.application: debug
bellows.ezsp: debug
zigpy: debug
zigpy_cc: debug
zigpy_deconz.zigbee.application: debug
zigpy_deconz.api: debug
zigpy_xbee.zigbee.application: debug
zigpy_xbee.api: debug
zigpy_zigate: debug
```
### Add Philips Hue bulbs that have previously been added to another bridge
Philips Hue bulbs that have previously been added to another bridge won't show up during search. You have to restore your bulbs back to factory settings first. To achieve this, you basically have the following options.

4
source/_lovelace/picture-elements.markdown
View File

@ -6,7 +6,7 @@ description: "The Picture Elements card is one of the most versatile types of ca
The Picture Elements card is one of the most versatile types of cards.
The cards allow you to position icons or text and even services! On an image based on coordinates. Imagine floor plan, imagine [picture-glance](/lovelace/picture-glance/) with no restrictions!
The cards allow you to position icons or text and even services on an image based on coordinates. Imagine floor plan, imagine [picture-glance](/lovelace/picture-glance/) with no restrictions!
<p class='img'>
<img src='/images/lovelace/lovelace_picture_elements.gif' alt='A functional floorplan powered by picture elements'>
@ -20,7 +20,7 @@ type:
type: string
image:
required: true
description: The URL of an image.
description: The URL of an image.<br/>To use a locally hosted image, see [Hosting](/integrations/http#hosting-files).
type: string
elements:
required: true

81
source/_posts/2020-05-09-deprecating-home-assistant-supervised-on-generic-linux.markdown Normal file
View File

@ -0,0 +1,81 @@
---
title: "[On hold] Deprecating Home Assistant Supervised on generic Linux"
description: "Home Assistant Supervised is no longer a supported installation option."
date: 2020-05-09 00:00:00
date_formatted: "May 9, 2020"
author: Paulus Schoutsen
author_twitter: balloob
categories: Announcements
---
**[Update May 10]**
We’ve been overwhelmed with the many reactions. We realize our communication has been poor on this subject, for which I want to apologize. We do not collect data and so can’t always judge the impact of our decisions.
We’re going to put the deprecation plan on hold for now. Anyone running this installation method today can continue running this. We will offer more clear information in the future.
We’re going to investigate how we can maintain the supervised installation on generic Linux.
Furthermore, we are going to make sure that supported installation guides are properly documented.
Paulus
---
TL;DR: Home Assistant Supervised (also known as Home Assistant on Generic Linux) installation method is no longer supported.
There are currently three different ways of installing Home Assistant:
- Home Assistant: our operating system running either directly on a supported device like the ODROID N2, Raspberry Pi 4, Intel NUC or a virtual machine.
- Home Assistant Supervised: an installation of core + supervisor that are hosted on a generic Linux installation.
- Home Assistant Core: our Python core application running in a Python virtual environment or a Docker container.
![Different installation methods](/images/blog/2020-05-09-deprecating-supervised/installation-options.png)
The benefit of running the Supervisor is that you are able to keep Home Assistant up to date from within Home Assistant, and easily install add-ons that are pre-configured to be able to integrate with Home Assistant.
The Supervisor is an extremely complicated program that interacts with a wide range of applications and components in the host operating system. Examples are Docker containers, DNS, sound and USB hardware sticks that users want to use with Home Assistant. The Supervisor is controlled from Home Assistant which allows us to create a full home automation hub experience.
The Home Assistant operating system is made with the bare minimum that the Supervisor needs to run and makes sure it does not get in the way of the Supervisor: the system is fully managed by the Supervisor.
Some users still wanted to be able to control the host operating system, and so a generic installer was introduced that could install Home Assistant Core and Supervisor on a generic Linux system, like Debian or Ubuntu.
However, when people run it on top of their own system, things can go wrong. And in fact, it’s quite complex to maintain it on generic Linux. Installing is fine, everyone can follow a tutorial, but after that when things break, people come to us, not the author of the tutorial. And this workload keeps growing, to a problematic extent.
Home Assistant OS and Supervisor are being maintained by Pascal. He started them 3,5 years ago and has been maintaining this first in his spare time, later as a full-time employee of Nabu Casa.
Building the operating system and the supervisor is a complex task that requires specific expertise. Sadly after 3,5 years, there are still no other contributors to help. This has resulted in his responsibilities outgrowing what one can expect from a full-time employee.
Nabu Casa was founded to make the development of Home Assistant sustainable. To be able to maintain a healthy work/life balance and to avoid developer burn-out that is, unfortunately, common in the open source world.
In an effort to reduce Pascal’s constraints we’re per direct no longer supporting the generic Linux installation method. It will no longer be mentioned in the documentation. We have archived the repository. If you are willing to maintain it, feel free to fork it. Issues that result from using this will be ignored or closed when reported to us.
## Open Source & Community
Just as with our [recent decision to limit the usage of YAML in some cases](https://www.home-assistant.io/blog/2020/04/14/the-future-of-yaml/), Home Assistant will keep choosing health over features. Open source is not about us having to support every feature anyone on the internet can think of. Open source means that anyone can do that themselves and choose to share this or not.
There are still tons of ways of installing Home Assistant, there are still tons of features and customizations possible.
## Frequently Asked Questions
### How do I run Home Assistant while still keeping control over the operating system?
We offer a virtual machine image of Home Assistant. These images can be used on e.g., VMWare, VirtualBox and Proxmox, and also on NAS systems that support running a VM as most modern NAS systems do. Using these provided images will give you the full supported Home Assistant experience.
[You can find virtual machine images here.](https://www.home-assistant.io/hassio/installation/)
### I run on a platform that doesn’t support VMs and I still want to keep control over the operating system.
To do this we recommend running Home Assistant Core in Docker. You will lose out on the easy updates, system management and pre-configured apps (add-ons) from the UI. However, you are still able to run the full beating heart of the Home Assistant home automation platform.
All applications that are available as Home Assistant add-ons are also available as third-party Docker containers. You will be responsible to configure them to work with Home Assistant Core yourself.
### I know what I am doing. Can I still use the generic Linux installer?
Yep, the archived repository is still there. You can also fork it and change things. But there is no official resource to visit when things break.
### I am currently running Home Assistant Supervised. Now what?
Everything will continue to work as-is. Bugs won’t be fixed and you should consider migrating to one of the other methods. If you are migrating to a virtual machine, you can make a snapshot in the Supervisor panel and restore that in your new installation.
[Edit May 9, 16:19] Removed paragraph from Open Source & Community as it was insinuating.

BIN
source/images/blog/2020-05-09-deprecating-supervised/installation-options.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 33 KiB

4
source/lovelace/dashboards-and-views.markdown
View File

@ -264,9 +264,9 @@ Picture card configuration:
navigation_path: /lovelace/living_room
```
## Icon
## View icon
If you define an icon the title will be used as a tool-tip.
If you define a view icon, the icon instead of the title will be displayed, the title will then be used as a tool-tip.
#### Example