mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-01 07:46:49 +00:00
Merge branch 'rc' into current
This commit is contained in:
Paulus Schoutsen
commit
bdd5f4530f
10
_config.yml
10
_config.yml
@ -76,6 +76,8 @@ collections:
|
||||
output: true
|
||||
faq:
|
||||
output: true
|
||||
lovelace:
|
||||
output: true
|
||||
|
||||
# ----------------------- #
|
||||
# 3rd Party Settings #
|
||||
@ -139,14 +141,14 @@ social:
|
||||
|
||||
# Home Assistant release details
|
||||
current_major_version: 0
|
||||
current_minor_version: 72
|
||||
current_patch_version: 1
|
||||
date_released: 2018-06-25
|
||||
current_minor_version: 73
|
||||
current_patch_version: 0
|
||||
date_released: 2018-07-06
|
||||
|
||||
# Either # or the anchor link to latest release notes in the blog post.
|
||||
# Must be prefixed with a # and have double quotes around it.
|
||||
# Major release:
|
||||
patch_version_notes: "#release-0721---june-25"
|
||||
patch_version_notes: "#"
|
||||
# Minor release (Example #release-0431---april-25):
|
||||
|
||||
# Date we moved to Discourse for comments
|
||||
|
||||
@ -35,17 +35,21 @@ password:
|
||||
description: The password for accessing your Arlo account.
|
||||
required: true
|
||||
type: string
|
||||
scan_interval:
|
||||
description: How frequently to query for new data. Defaults to 60 seconds.
|
||||
required: false
|
||||
type: int
|
||||
{% endconfiguration %}
|
||||
|
||||
It is recommended to create a dedicated user on Arlo website to be used within Home Assistant and then share your Arlo cameras.
|
||||
|
||||
Finish its configuration by visiting the [Arlo sensor page](/components/sensor.arlo/) or [Arlo camera page](/components/camera.arlo/) or [Arlo control panel page](/components/alarm_control_panel.arlo/).
|
||||
Finish its configuration by visiting the [Arlo sensor page](/components/sensor.arlo/) or [Arlo camera page](/components/camera.arlo/) or [Arlo control panel page](/components/alarm_control_panel.arlo/). Arlo also has a service call `arlo.update` that can be manually called to force an update prior to the regular scheduled interval.
|
||||
|
||||
The Arlo component also provides a service to enable/disable the motion detection sensor. The example below enables the motion detection every time the Home Assistant service starts.
|
||||
The Arlo component also provides a camera service to enable/disable the motion detection sensor. The example below enables the motion detection every time the Home Assistant service starts.
|
||||
|
||||
```yaml
|
||||
#automation.yaml
|
||||
- alias: Enable Arlo upton HA start'
|
||||
- alias: Enable Arlo upon HA start'
|
||||
initial_state: 'on'
|
||||
trigger:
|
||||
platform: homeassistant
|
||||
|
||||
31
source/_components/binary_sensor.rachio.markdown
Normal file
31
source/_components/binary_sensor.rachio.markdown
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Rachio Binary Sensor"
|
||||
description: "Instructions on how to use Rachio binary sensors with Home Assistant."
|
||||
date: 2018-06-23 16:15
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: rachio.png
|
||||
ha_category: Hub
|
||||
ha_iot_class: "Cloud Push"
|
||||
ha_release: 0.73
|
||||
---
|
||||
|
||||
The `rachio` binary sensor platform allows you to view the status of your [Rachio irrigation system](http://rachio.com/).
|
||||
|
||||
Once configured, a binary sensor will be added that shows whether or not each controller in the account provided is online and reachable by Rachio's servers.
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Rachio component](/components/rachio/) configured to use this switch.
|
||||
</p>
|
||||
|
||||
|
||||
To add this platform to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
binary_sensor:
|
||||
- platform: rachio
|
||||
```
|
||||
86
source/_components/camera.xiaofang.markdown
Normal file
86
source/_components/camera.xiaofang.markdown
Normal file
@ -0,0 +1,86 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Xiaomi Cameras"
|
||||
description: "Instructions on how to integrate a video feed (via FFmpeg) as a camera within Home Assistant."
|
||||
date: 2018-06-20 13:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: xiaomi.png
|
||||
ha_category: Camera
|
||||
ha_release: 0.72
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
The `Xiaomi` camera platform allows you to utilize Xiaomi Cameras within Home Assistant.
|
||||
|
||||
To successfully implement this platform, the Home Assistant host should be capable of multiple simultaneous reads. For every concurrent Home Assistant user, a connection will be made to the camera every 10 seconds. This should normally not be a problem.
|
||||
|
||||
## {% linkable_title Preparing the Device %}
|
||||
|
||||
### {% linkable_title Installing Alternative Firmware %}
|
||||
|
||||
In order to integrate the camera with Home Assistant, it is necessary to install a custom firmware on the device. Instructions for doing so can be found for each models.
|
||||
|
||||
* [Yi 720p](https://github.com/fritz-smh/yi-hack)
|
||||
* [Yi Home 17CN / 27US / 47US / 1080p Home / Dome / 1080p Dome](https://github.com/shadow-1/yi-hack-v3)
|
||||
* [Xiaofang 1080p Camera](https://github.com/samtap/fang-hacks)
|
||||
|
||||
Once installed, please ensure that you have enabled FTP.
|
||||
|
||||
<p class='note warning'>
|
||||
Currently, version 0.1.4-beta2 of the custom firmware is the highest supported. Firmwares higher than this version use [Pure-FTPd](https://www.pureftpd.org/project/pure-ftpd), which has a bug that prevents FFmpeg from correctly rendering video files.
|
||||
</p>
|
||||
|
||||
<p class='note warning'>
|
||||
Hassbian users: don't forget to install ffmpeg support on your platform, otherwise, you'll not see video.
|
||||
</p>
|
||||
|
||||
<p class='note warning'>
|
||||
The live stream writing by the camera is not an supported format when the hass reads through FTP for Yi 720p and Xiaofang Cameras, so this component retrives the video which was saved 1 minute earlier.
|
||||
</p>
|
||||
|
||||
<p class='note warning'>
|
||||
If you enabled RTSP server, you can connect to your camera via other Home Assistant camera platforms. However, this RTSP server disables the ability to use the supremely-useful Mi Home app. In order to maintain both Home Assistant compatibility _and_ the native app, this platform retrieves videos via FTP.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuring the Platform %}
|
||||
|
||||
To enable the platform, add the following lines to your`configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
camera:
|
||||
- platform: xiaomi
|
||||
name: Camera
|
||||
host: '192.168.1.100'
|
||||
model: 'yi'
|
||||
password: my_password_123
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **name** (*Required*): A human-friendly name for the camera.
|
||||
- **host** (*Required*): The IP address or hostname of the camera.
|
||||
- **model** (*Required*): The model of Xiaomi Camera, currently supporting yi and xiaofang.
|
||||
- **password** (*Required*): The password to the FTP server on the camera (from above), can be any string as the current firmware doesn't allow setting ftp passwords.
|
||||
- **path** (*Optional*): The path to the raw MP4 files. Defaults to `/tmp/sd/record`.
|
||||
- **username** (*Optional*): The user that can access the FTP server. Defaults to `root`.
|
||||
- **ffmpeg_arguments** (*Optional*): Extra options to pass to `ffmpeg` (e.g., image quality or video filter options).
|
||||
|
||||
## {% linkable_title Image quality %}
|
||||
|
||||
Any option supported by [`ffmpeg` camera](/components/camera.ffmpeg/) can be utilized via the `ffmpeg_arguments` configuration parameter.
|
||||
|
||||
One particularly useful adjustment deals with video size. Since Yi videos are fairly large (especially on the 1080p cameras), the following configuration will bring them down to a manageable size:
|
||||
|
||||
```yaml
|
||||
camera:
|
||||
- platform: xiaomi
|
||||
name: My Camera
|
||||
host: '192.168.1.100'
|
||||
model: 'xiaofang'
|
||||
password: my_password_123
|
||||
path: /home/camera/feed
|
||||
ffmpeg_arguments: '-vf scale=800:450'
|
||||
```
|
||||
16
source/_components/climate.homekit_controller.markdown
Normal file
16
source/_components/climate.homekit_controller.markdown
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: page
|
||||
title: "HomeKit Climate"
|
||||
description: "Instructions how to setup HomeKit thermostats within Home Assistant."
|
||||
date: 2018-06-19 20:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: apple-homekit.png
|
||||
ha_category: Climate
|
||||
ha_iot_class: "Local Polling"
|
||||
ha_release: 0.73
|
||||
---
|
||||
|
||||
To get your HomeKit thermostats and air conditioners working with Home Assistant, follow the instructions for the general [HomeKit controller component](/components/homekit_controller/).
|
||||
@ -22,6 +22,7 @@ ha_iot_class: "Local Polling"
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Climate](/components/climate.homekit_controller/)
|
||||
- [Light](/components/light.homekit_controller/)
|
||||
- [Switch](/components/switch.homekit_controller/)
|
||||
|
||||
|
||||
@ -46,6 +46,7 @@ Configuration variables (interface):
|
||||
- **callback_ip** (*Optional*): Set this, if Home Assistant is reachable under a different IP from the CCU (NAT, Docker etc.).
|
||||
- **callback_port** (*Optional*): Set this, if Home Assistant is reachable under a different port from the CCU (NAT, Docker etc.).
|
||||
- **resolvenames** (*Optional*): [`metadata`, `json`, `xml`] Try to fetch device names. Defaults to `false` if not specified.
|
||||
- **jsonport** (*Optional*): Port of CCU JSON-RPC Server. The default is 80, but it may be different when running CCU virtually via Docker.
|
||||
- **username** (*Optional*): When fetching names via JSON-RPC, you need to specify a user with guest-access to the CCU.
|
||||
- **password** (*Optional*): When fetching names via JSON-RPC, you need to specify the password of the user you have configured above.
|
||||
- **path** (*Optional*): Set to `/groups` when using port 9292.
|
||||
|
||||
@ -34,10 +34,12 @@ Configuration variables:
|
||||
- **server_port** (*Optional*): Let you set a port to use. Defaults to 8123.
|
||||
- **base_url** (*Optional*): The URL that Home Assistant is available on the internet. For example: `hass-example.duckdns.org:8123`. Defaults to the local IP address. The iOS app finds local installations, if you have an outside URL use this so that you can auto-fill when discovered in the app.
|
||||
- **ssl_certificate** (*Optional*): Path to your TLS/SSL certificate to serve Home Assistant over a secure connection.
|
||||
- **ssl_peer_certificate** (*Optional*): Path to the client/peer TLS/SSL certificate to accept secure connections from.
|
||||
- **ssl_key** (*Optional*): Path to your TLS/SSL key to serve Home Assistant over a secure connection.
|
||||
- **cors_allowed_origins** (*Optional*): A list of origin domain names to allow [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) requests from. Enabling this will set the `Access-Control-Allow-Origin` header to the Origin header if it is found in the list, and the `Access-Control-Allow-Headers` header to `Origin, Accept, X-Requested-With, Content-type, X-HA-access`. You must provide the exact Origin, i.e. `https://www.home-assistant.io` will allow requests from `https://www.home-assistant.io` but __not__ `http://www.home-assistant.io`.
|
||||
- **use_x_forwarded_for** (*Optional*): Enable parsing of the `X-Forwarded-For` header, passing on the client's correct IP address in proxied setups. You should only enable this in a trustworthy network environment where only the proxy can access Home Assistant, as clients passing this header can easily spoof their IP address to gain access via `trusted_networks` or bypass the `login_attempts_threshold`. Defaults to False.
|
||||
- **trusted_networks** (*Optional*): List of trusted networks, consisting of IP addresses or networks, that are allowed to bypass password protection when accessing Home Assistant. It should be noted that if you use a reverse proxy, all requests to Home Assistant, regardless of source, will arrive from the reverse proxy IP address. Therefore in a reverse proxy scenario, this option should be used with extreme care.
|
||||
- **use_x_forwarded_for** (*Optional*): Enable parsing of the `X-Forwarded-For` header, passing on the client's correct IP address in proxied setups. You must also whitelist trusted proxies using the `trusted_proxies` setting below for this to work. Non-whitelisted requests with this header will be considered IP spoofing attacks, and the header will, therefore, be ignored. Defaults to False.
|
||||
- **trusted_proxies** (*Optional*): List of trusted proxies, consisting of IP addresses or networks, that are allowed to set the `X-Forwarded-For` header. This is required when using `use_x_forwarded_for` because all requests to Home Assistant, regardless of source, will arrive from the reverse proxy IP address. Therefore in a reverse proxy scenario, this option should be set with extreme care.
|
||||
- **trusted_networks** (*Optional*): List of trusted networks, consisting of IP addresses or networks, that are allowed to bypass password protection when accessing Home Assistant. If using a reverse proxy with the `use_x_forwarded_for` option enabled, requests proxied to Home Assistant with a trusted `X-Forwarded-For` header will appear to come from the IP given in that header instead of the proxy IP.
|
||||
- **ip_ban_enabled** (*Optional*): Flag indicating whether additional IP filtering is enabled. Defaults to False.
|
||||
- **login_attempts_threshold** (*Optional*): Number of failed login attempt from single IP after which it will be automatically banned if `ip_ban_enabled` is True. Defaults to -1, meaning that no new automatic bans will be added.
|
||||
|
||||
@ -53,7 +55,10 @@ http:
|
||||
cors_allowed_origins:
|
||||
- https://google.com
|
||||
- https://www.home-assistant.io
|
||||
use_x_forwarded_for: False
|
||||
use_x_forwarded_for: True
|
||||
trusted_proxies:
|
||||
- 127.0.0.1
|
||||
- ::1
|
||||
trusted_networks:
|
||||
- 127.0.0.1
|
||||
- ::1
|
||||
|
||||
@ -109,6 +109,14 @@ Will add a light with rgb+white mode (default). White and RGB channels can be ad
|
||||
mode: "rgbw"
|
||||
```
|
||||
|
||||
Will add a light with white mode only. This is useful when only W channel is connected to an RGBW controller and allows the white level to be controlled via brightness value.
|
||||
|
||||
```yaml
|
||||
192.168.1.10:
|
||||
name: NAME
|
||||
mode: "w"
|
||||
```
|
||||
|
||||
Some devices such as the Ledenet RGBW controller use a slightly different protocol for communicating the brightness to each color channel. If your device is only turning on or off but not changing color or brightness try adding the LEDENET protocol.
|
||||
|
||||
```yaml
|
||||
|
||||
@ -85,6 +85,14 @@ If your model is not on the list then give it a test, if everything works correc
|
||||
The first letter (U, P, L, H & K) represent the screen type, e.g., LED or Plasma. The second letter represents the region, E is Europe, N is North America and A is Asia & Australia. The two numbers following that represent the screen size.
|
||||
If you add your model remember to remove these before adding them to the list.
|
||||
|
||||
Currently the ability to select a source is not implemented.
|
||||
Changing channels can be done by calling the `media_player.play_media` service with the following payload:
|
||||
|
||||
There's currently a [known issue](https://github.com/home-assistant/home-assistant/issues/2098) with some TVs receiving a *Key press UP* that can interrupt certain applications. This should be fixed as of March 2017.
|
||||
```javascript
|
||||
{
|
||||
"entity_id": "media_player.office_tv",
|
||||
"media_content_id": "590",
|
||||
"media_content_type": "channel"
|
||||
}
|
||||
```
|
||||
|
||||
Currently the ability to select a source is not implemented.
|
||||
|
||||
@ -65,7 +65,15 @@ Configuration variables:
|
||||
|
||||
Currently there is a single `nest.set_mode` service available to switch between
|
||||
"away" and "home" modes. This service requires a `home_mode` param and has an
|
||||
optional `structure` param.
|
||||
optional `structure` param. While setting "away" mode, an estimated arrival time
|
||||
can also be set with `eta`, `eta_window`, and `trip_id` parameters.
|
||||
|
||||
- **home_mode** (*Required*): `home` or `away`
|
||||
- **structure** (*Optional*): Structure(s). Default apply to all structures connected with Home Assistant.
|
||||
- **eta** (*Optional*): Estimated Time of Arrival from now.
|
||||
- **eta_window** (*Optional*): ETA window (default is 1 minute).
|
||||
- **trip_id** (*Optional*): Unique ID for the trip. Using an existing trip ID will update that trip's ETA.
|
||||
|
||||
|
||||
```yaml
|
||||
# Example script to set away, no structure specified so will execute for all
|
||||
@ -86,3 +94,16 @@ set_nest_home:
|
||||
structure:
|
||||
- Building
|
||||
```
|
||||
|
||||
```yaml
|
||||
# Example script to set eta, structure specified
|
||||
set_nest_eta:
|
||||
sequence:
|
||||
- service: nest.set_mode
|
||||
data:
|
||||
home_mode: away
|
||||
structure:
|
||||
- Building
|
||||
eta: 00:10:30
|
||||
eta_window: 00:05
|
||||
```
|
||||
|
||||
@ -23,12 +23,14 @@ prometheus:
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **exclude** (*Optional*): Configure which components should be excluded from recording.
|
||||
- **entities** (*Optional*): The list of entity ids to be excluded from recording.
|
||||
- **domains** (*Optional*): The list of domains to be excluded from recording.
|
||||
- **include** (*Optional*): Configure which components should be included in recordings. If set, all other entities will not be recorded. Values set by the **blacklist** option will prevail.
|
||||
- **entities** (*Optional*): The list of entity ids to be included from recordings.
|
||||
- **domains** (*Optional*): The list of domains to be included from recordings.
|
||||
- **namespace** (*Optional*): The "namespace" that will be assigned to all the Prometheus metrics. This is the prefix of the metric name. E.g., having `myhass` as the namespace will cause the device tracker metrics to be `myhass_device_tracker_state`, the switch metrics to be `myhass_switch_state` and so on. The default is to not add any prefix to the metrics name.
|
||||
- **filter** (*Optional*): Filtering directives for the components which should be included or excluded from recording.
|
||||
- **exclude** (*Optional*): Excluded from recording.
|
||||
- **entities** (*Optional*): The list of entity ids to be excluded from recording.
|
||||
- **domains** (*Optional*): The list of domains to be excluded from recording.
|
||||
- **include** (*Optional*): Included in recordings. If set, all other entities will not be recorded. Values set by the **exclude** option will prevail.
|
||||
- **entities** (*Optional*): The list of entity ids to be included from recordings.
|
||||
- **domains** (*Optional*): The list of domains to be included from recordings.
|
||||
|
||||
You can then configure Prometheus to fetch metrics from Home Assistant by adding to its `scrape_configs` configuration.
|
||||
|
||||
@ -43,3 +45,10 @@ You can then configure Prometheus to fetch metrics from Home Assistant by adding
|
||||
static_configs:
|
||||
- targets: ['HOSTNAME:8123']
|
||||
```
|
||||
|
||||
When looking into the metrics on the Prometheus side, there will be:
|
||||
|
||||
- All Home Assistant domains, which can be easily found through the common **namespace** prefix, if defined.
|
||||
- The [client library](https://github.com/prometheus/client_python) provided metrics, which are a bunch of **process_\*** and also a single pseudo-metric **python_info** which contains (not as value but as labels) information about the Python version of the client, i.e., the Home Assistant Python interpreter.
|
||||
|
||||
Typically, you will only be interested in the first set of metrics.
|
||||
|
||||
43
source/_components/rachio.markdown
Normal file
43
source/_components/rachio.markdown
Normal file
@ -0,0 +1,43 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Rachio"
|
||||
description: "Instructions on how to use Rachio with Home Assistant."
|
||||
date: 2018-06-23 16:04
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: rachio.png
|
||||
ha_category: Hub
|
||||
ha_iot_class: "Cloud Push"
|
||||
ha_release: 0.73
|
||||
---
|
||||
|
||||
The `rachio` platform allows you to control your [Rachio irrigation system](http://rachio.com/).
|
||||
|
||||
## {% linkable_title Getting your Rachio API Key %}
|
||||
|
||||
1. Log in at [https://app.rach.io/](https://app.rach.io/).
|
||||
1. Click the "Account Settings" menu item at the bottom of the left sidebar
|
||||
1. Click "Get API Key"
|
||||
1. Copy the API key from the dialog that opens.
|
||||
|
||||
To add this platform to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
rachio:
|
||||
api_key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
|
||||
```
|
||||
|
||||
### {% linkable_title iFrame %}
|
||||
|
||||
If you would like to see and control more detailed zone information, create an [iFrame](/components/panel_iframe/) that renders the Rachio web app.
|
||||
|
||||
```yaml
|
||||
panel_iframe:
|
||||
rachio:
|
||||
title: Rachio
|
||||
url: "https://app.rach.io"
|
||||
icon: mdi:water-pump
|
||||
```
|
||||
@ -35,7 +35,7 @@ sensor:
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **monitored_conditions** array (*Required*): Conditions to display in the frontend. The following conditions can be monitored.
|
||||
- **monitored_conditions** array (*Optional*): Conditions to display in the frontend. The following conditions can be monitored.
|
||||
- **captured_today**: Return the number of videos captured on the current day.
|
||||
- **last_capture**: Return the timestamp from the last video captured by your Arlo camera.
|
||||
- **total_cameras**: Return the number of recognized and active cameras linked on your Arlo account.
|
||||
|
||||
@ -20,6 +20,8 @@ The `nest` sensor platform lets you monitor sensors connected to your [Nest](htt
|
||||
You must have the [Nest component](/components/nest/) configured to use these sensors. The sensors will be setup if the `nest` component is configured and the required configuration for the `nest sensor` is set.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable sensors and customize which sensors are setup, you can extend the [Nest component](/components/nest/) configuration in your `configuration.yaml` file with the following settings:
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -40,6 +42,7 @@ The following conditions are available by device:
|
||||
|
||||
- Nest Home:
|
||||
- eta: Estimated time of arrival.
|
||||
- security\_state: `ok` or `deter`. [Security State](#security-state). Only available when Nest Camera exists.
|
||||
- Nest Thermostat:
|
||||
- humidity
|
||||
- operation\_mode
|
||||
@ -53,3 +56,24 @@ The following conditions are available by device:
|
||||
- color\_status: `gray`, `green`, `yellow`, or `red`. Indicates device status by color in the Nest app UI. It is an aggregate condition for battery+smoke+CO states, and reflects the actual color indicators displayed in the Nest app.
|
||||
- Nest Camera: none
|
||||
|
||||
## {% linkable_title Security State %}
|
||||
|
||||
<p class='note warning'>
|
||||
This feature is not designed to transfer your Home Assitant to a secruity system, neither Home Assistant nor Nest be liable to You for damages,
|
||||
or consequential damages of any character arising as a result of use this feature.
|
||||
|
||||
This feature does not depend on the [Nest Secure alarm system](https://nest.com/alarm-system/overview/) and is not a reflection of the status of that system,
|
||||
nor does it react to state changes in that system.
|
||||
</p>
|
||||
|
||||
<p class='note'>
|
||||
This feautre use a new [Nest Secruity API](https://developers.nest.com/documentation/cloud/security-guide),
|
||||
you may need to change your ["Product"](https://developers.nest.com/products) permission setting to include `Secruity State Read`.
|
||||
After permission change, you may need to re-authorize your client.
|
||||
</p>
|
||||
|
||||
If a Nest Cam detects the presence of a person (see `person_detected` in [binary_sensor.nest](/components/binary_sensor.nest/)) while the structure is in `away` mode (see `away` in [binary_sensor.nest](/components/binary_sensor.nest/)), the structure enters `deter` mode.
|
||||
|
||||
A `deter` state is re-evaluated after several minutes and relaxed to `ok` if no further `person_detected` events have occurred.
|
||||
|
||||
The `security_state` automatically switches to `ok` when the structure state is `home`.
|
||||
|
||||
@ -51,7 +51,7 @@ monitored_conditions:
|
||||
description: Defines the stats to monitor as sensors.
|
||||
required: false
|
||||
type: string
|
||||
default: all
|
||||
default: ads_blocked_today
|
||||
keys:
|
||||
ads_blocked_today:
|
||||
description: Total number of blocked ads today.
|
||||
@ -73,5 +73,5 @@ monitored_conditions:
|
||||
description: Total number of seen clients.
|
||||
{% endconfiguration %}
|
||||
|
||||
This sensor platform was not made by Pi-hole LLC or the Pi-hole community. They didn't provide support, feedback, testing or helped in any way while it was created. This is third party, may not if Pi-hole is breaking their API with the latest release, not official, not developed, not supported and not endorsed Pi-hole LLC or the Pi-hole community. The trademark `Pi-hole` and the logo is used here to describe the platform and only to describe. `Pi-hole` is a registered trademark of Pi-hole LLC.
|
||||
This sensor platform was not made by Pi-hole LLC or the Pi-hole community. They didn't provide support, feedback, testing or helped in any way while it was created. This is third party, may not work if Pi-hole is breaking their API with the latest release, not official, not developed, not supported and not endorsed Pi-hole LLC or the Pi-hole community. The trademark `Pi-hole` and the logo is used here to describe the platform and only to describe. `Pi-hole` is a registered trademark of Pi-hole LLC.
|
||||
|
||||
|
||||
@ -32,11 +32,11 @@ sensor:
|
||||
|
||||
{% configuration %}
|
||||
origin:
|
||||
description: Enter the starting address or the GPS coordinates of the location (GPS coordinates has to be separated by a comma).
|
||||
description: Enter the starting address or the GPS coordinates of the location (GPS coordinates has to be separated by a comma). You can also enter the entity id of a sensor, device_tracker or zone, which provides this information in its state.
|
||||
required: true
|
||||
type: string
|
||||
destination:
|
||||
description: Enter the destination address or the GPS coordinates of the location (GPS coordinates has to be separated by a comma).
|
||||
description: Enter the destination address or the GPS coordinates of the location (GPS coordinates has to be separated by a comma). You can also enter the entity id of a sensor, device_tracker or zone, which provides this information in its state.
|
||||
required: true
|
||||
type: string
|
||||
region:
|
||||
|
||||
@ -2,25 +2,24 @@
|
||||
layout: page
|
||||
title: "Rachio Switch"
|
||||
description: "Instructions on how to use Rachio switches with Home Assistant."
|
||||
date: 2017-05-29 09:00
|
||||
date: 2018-06-23 16:09
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: rachio.png
|
||||
ha_category: Switch
|
||||
ha_iot_class: "Cloud Polling"
|
||||
ha_iot_class: "Cloud Push"
|
||||
ha_release: 0.46
|
||||
---
|
||||
|
||||
The `rachio` switch platform allows you to control your [Rachio irrigation system](http://rachio.com/).
|
||||
The `rachio` switch platform allows you to toggle zones connected to your [Rachio irrigation system](http://rachio.com/) on and off.
|
||||
|
||||
## {% linkable_title Getting your Rachio API Access Token %}
|
||||
Once configured, a switch will be added for every zone that is enabled on every controller in the account provided, as well as a switch to toggle each controller's standby mode.
|
||||
|
||||
1. Log in at [https://app.rach.io/](https://app.rach.io/).
|
||||
1. Click the user button at the top right.
|
||||
1. Click API Access Token.
|
||||
1. Copy the API access token from the dialog that opens.
|
||||
<p class='note'>
|
||||
You must have the [Rachio component](/components/rachio/) configured to use this switch.
|
||||
</p>
|
||||
|
||||
To add this platform to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
@ -28,17 +27,20 @@ To add this platform to your installation, add the following to your `configurat
|
||||
# Example configuration.yaml entry
|
||||
switch:
|
||||
- platform: rachio
|
||||
access_token: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **access_token** (*Required*): Your Rachio API Access Token.
|
||||
- **manual_run_mins** (*Optional*): For how long, in minutes, to turn on a station when the switch is enabled. Defaults to 10 minutes.
|
||||
|
||||
<p class='note'>
|
||||
**Water-saving suggestion:**<br>
|
||||
Set `manual_run_mins` to a high maximum failsafe value when using scripts to control zones. If something goes wrong with your script, Home Assistant, or you hit the Rachio API rate limit of 1700 calls per day, the controller will still turn off the zone after this amount of time.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Examples %}
|
||||
|
||||
In this section you find some real life examples of how to use this switch.
|
||||
In this section, you find some real-life examples of how to use this switch.
|
||||
|
||||
### {% linkable_title `groups.yaml` example %}
|
||||
|
||||
@ -51,35 +53,19 @@ irrigation:
|
||||
entities:
|
||||
- group.zones_front
|
||||
- group.zones_back
|
||||
- switch.side_yard
|
||||
|
||||
zones_front:
|
||||
name: Front Yard
|
||||
view: false
|
||||
entities:
|
||||
- switch.driveway
|
||||
- switch.front_bushes
|
||||
- switch.front_garden
|
||||
- switch.front_yard
|
||||
- switch.side_yard
|
||||
|
||||
zones_back:
|
||||
name: Back Yard
|
||||
view: false
|
||||
entities:
|
||||
- switch.back_bushes
|
||||
- switch.back_garden
|
||||
- switch.back_porch
|
||||
- switch.back_trees
|
||||
```
|
||||
|
||||
### {% linkable_title iFrame %}
|
||||
|
||||
If you would like to see and control more detailed zone information, create an [iFrame](/components/panel_iframe/) that renders the Rachio web app.
|
||||
|
||||
```yaml
|
||||
panel_iframe:
|
||||
rachio:
|
||||
title: Rachio
|
||||
url: "https://app.rach.io"
|
||||
icon: mdi:water-pump
|
||||
```
|
||||
|
||||
22
source/_includes/asides/lovelace_navigation.html
Normal file
22
source/_includes/asides/lovelace_navigation.html
Normal file
@ -0,0 +1,22 @@
|
||||
<section class="aside-module grid__item one-whole lap-one-half">
|
||||
<!-- {% include edit_github.html %} -->
|
||||
{% assign cards = site.lovelace | sort: 'title' %}
|
||||
|
||||
<div class='section'>
|
||||
<h1 class="title delta">Lovelace UI</h1>
|
||||
<ul class='divided'>
|
||||
<li><a href='/lovelace/'>Introduction</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class='section'>
|
||||
<h1 class="title delta">Cards</h1>
|
||||
<ul class='divided'>
|
||||
{% for card in cards %}
|
||||
<li>
|
||||
<a href='{{card.url}}'>{{ card.sidebar_label }}</a>
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
@ -4,6 +4,8 @@
|
||||
{% include asides/component_navigation.html | compact_newlines %}
|
||||
{% elsif url_parts[1] == 'cookbook' %}
|
||||
{% include asides/cookbook_navigation.html | compact_newlines %}
|
||||
{% elsif url_parts[1] == 'lovelace' %}
|
||||
{% include asides/lovelace_navigation.html | compact_newlines %}
|
||||
{% elsif url_parts[1] == 'developers' or url_parts[1] == 'help' %}
|
||||
{% include asides/help_navigation.html | compact_newlines %}
|
||||
{% elsif url_parts[1] == 'getting-started' %}
|
||||
|
||||
26
source/_lovelace/glance.markdown
Normal file
26
source/_lovelace/glance.markdown
Normal file
@ -0,0 +1,26 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Glance Card"
|
||||
sidebar_label: Glance
|
||||
description: "The Glance card allows you to see a list of entities at a glance."
|
||||
date: 2018-07-01 10:28 +00:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
A card that allows you to see see a list of entities at a glance.
|
||||
|
||||
| Name | Type | Default | Description
|
||||
| ---- | ---- | ------- | -----------
|
||||
| type | string | **Required** | `glance`
|
||||
| entities | list | **Required** | Entity id's
|
||||
| title | string | Optional | Card title
|
||||
|
||||
Each entry in the list of entities is either an entity ID or an entity option object. The entity option object can have the following options:
|
||||
|
||||
| Name | Type | Default | Description
|
||||
| ---- | ---- | ------- | -----------
|
||||
| entity | entity id | **Required** | The ID of the entity to show.
|
||||
| title | string | Optional | The title to use instead of the entity name.
|
||||
327
source/_posts/2018-07-06-release-73.markdown
Normal file
327
source/_posts/2018-07-06-release-73.markdown
Normal file
@ -0,0 +1,327 @@
|
||||
---
|
||||
layout: post
|
||||
title: "0.73: Preview version new user system, Rachio cloud push and Lovelace goes wild"
|
||||
description: "Summer is here and that means fresh new goodies for all of you."
|
||||
date: 2018-07-06 00:01:00
|
||||
date_formatted: "July 6, 2018"
|
||||
author: Paulus Schoutsen
|
||||
author_twitter: balloob
|
||||
comments: true
|
||||
categories: Release-Notes
|
||||
og_image: /images/blog/2018-07-0.73/lovelace-elements.png
|
||||
---
|
||||
|
||||
Today we're releasing Home Assistant 0.73. First, let's talk security. Home Assistant has a lot of power. It can control all devices in your house and know what you're up to. That's why securing it is very important. It's not good enough to connect your instance unsecured to the internet and hope no one will find it. All ports on all computers are regularly scanned by bad actors. Please read [our guidelines thoroughly](https://www.home-assistant.io/docs/configuration/securing/) and follow them.
|
||||
|
||||
In the meanwhile, we're also working hard on the new authentication system. A preview version is included in this release, more info on [our developer blog](https://developers.home-assistant.io/blog/2018/07/02/trying-new-auth.html).
|
||||
|
||||
This release also includes a TON of love for the new Lovelace UI. Yes, it's still experimental but daaang, it's already so awesome that you should probably just go ahead and try it out. Thanks to all the devs who have jumped on this: [@c727], [@ciotlosm] and [@jeradM].
|
||||
|
||||
We don't have time to go through all the changes in this release, but [@ciotlosm] has been keeping [a very detailed changelog](https://github.com/ciotlosm/docs-lovelace/blob/0.73.0/changelog.md). I'll just leave this screenshot by [@arsaboo] of the new picture-elements card and [the Lovelace configuration](https://github.com/arsaboo/homeassistant-config/blob/master/ui-lovelace.yaml#L15-L158):
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/blog/2018-07-0.73/lovelace-elements.png' alt='Screenshot of a floorplan with sensor info and light/camera controls overlayed.'>
|
||||
The new picture elements card.
|
||||
</p>
|
||||
|
||||
And last but not least, [@Klikini] has upgraded Rachio support from cloud polling to cloud push! Now you'll be able to get instantly notified of changes to your sprinklers. NICE!
|
||||
|
||||
## {% linkable_title New Platforms %}
|
||||
|
||||
- Support for Homekit Controller climate devices ([@armills] - [#15057]) ([homekit_controller docs]) ([climate.homekit_controller docs]) ([light.homekit_controller docs]) ([switch.homekit_controller docs]) (new-platform)
|
||||
- Rachio webhooks ([@Klikini] - [#15111]) ([rachio docs]) ([binary_sensor.rachio docs]) ([switch.rachio docs]) (beta fix) (new-platform)
|
||||
|
||||
## {% linkable_title If you need help... %}
|
||||
|
||||
...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks.
|
||||
|
||||
## {% linkable_title Reporting Issues %}
|
||||
|
||||
Experiencing issues introduced by this release? Please report them in our [issue tracker](https://github.com/home-assistant/home-assistant/issues). Make sure to fill in all fields of the issue template.
|
||||
|
||||
<!--more-->
|
||||
## {% linkable_title Breaking Changes %}
|
||||
|
||||
- Update to hole to 0.3.0 ([@fabaff] - [#15014]) ([sensor.pi_hole docs]) (breaking change)
|
||||
- Update PostNL unit of measure to align with UPS ([@keesschollaart81] - [#15023]) ([sensor.postnl docs]) (breaking change)
|
||||
- Make Pollen.com platform async ([@bachya] - [#14963]) ([sensor.pollen docs]) (breaking change)
|
||||
- Adding 'namespace' for prometheus metrics ([@alexbarcelo] - [#13738]) ([prometheus docs]) (breaking change)
|
||||
- Fix zwave climate operation mode mappings ([@cdce8p] - [#15162]) ([climate.zwave docs]) (breaking change)
|
||||
- X-Forwarded-For improvements and bug fixes ([@colinodell] - [#15204]) ([emulated_hue docs]) ([http docs]) (breaking change)
|
||||
- Stop supporting deprecated TLS ciphers ([@hmmbob] - [#15217]) ([http docs]) (breaking change)
|
||||
|
||||
## {% linkable_title Beta Fixes %}
|
||||
|
||||
- Rachio webhooks ([@Klikini] - [#15111]) ([rachio docs]) ([binary_sensor.rachio docs]) ([switch.rachio docs]) (beta fix) (new-platform)
|
||||
- Only create front-end client_id once ([@awarecan] - [#15214]) ([frontend docs]) (beta fix)
|
||||
- Make LIFX color/temperature attributes mutually exclusive ([@amelchio] - [#15234]) ([light.lifx docs]) (beta fix)
|
||||
- Fix an issue when user's nest developer account don't have permission ([@awarecan] - [#15237]) ([binary_sensor.nest docs]) (beta fix)
|
||||
- Revert some changes to setup.py ([@cdce8p] - [#15248]) (beta fix)
|
||||
|
||||
## {% linkable_title All changes %}
|
||||
|
||||
- Add entity support to Waze Travel Time ([@Petro31] - [#14934]) ([sensor.waze_travel_time docs])
|
||||
- Switch to own packaged version of anel_pwrctrl ([@andrey-git] - [#15011]) ([switch.anel_pwrctrl docs])
|
||||
- Switch to own packaged version of braviarc ([@andrey-git] - [#15009]) ([media_player.braviatv docs])
|
||||
- HomeKit style clean up ([@schmittx] - [#14793]) ([homekit docs])
|
||||
- Upgrade netdisco to 1.5.0 ([@fabaff] - [#15016])
|
||||
- Update to hole to 0.3.0 ([@fabaff] - [#15014]) ([sensor.pi_hole docs]) (breaking change)
|
||||
- Upgrade numpy to 1.14.5 ([@fabaff] - [#15015]) ([binary_sensor.trend docs]) ([image_processing.opencv docs])
|
||||
- Upgrade youtube_dl to 2018.06.14 ([@fabaff] - [#15013]) ([media_extractor docs])
|
||||
- Switch nuimo to a hopefully working pypi version ([@andrey-git] - [#15006]) ([nuimo_controller docs])
|
||||
- Remove typing ([@fabaff] - [#15018])
|
||||
- Add support for Homekit battery service ([@schmittx] - [#14288]) ([homekit docs])
|
||||
- Update PostNL unit of measure to align with UPS ([@keesschollaart81] - [#15023]) ([sensor.postnl docs]) (breaking change)
|
||||
- Expose Wemo component availability to home assistant ([@gstorer] - [#14995]) ([light.wemo docs])
|
||||
- Improve volume support for Vizio Smartcast ([@JeffLIrion] - [#14981]) ([media_player.vizio docs])
|
||||
- Upgrade requests to 2.19.1 ([@fabaff] - [#15019])
|
||||
- Show running apps as sources for Fire TV ([@JeffLIrion] - [#15033]) ([media_player.firetv docs])
|
||||
- Patch save_json ([@Hate-Usernames] - [#15046])
|
||||
- Update loopenergy link to docs ([@fabaff] - [#15050]) ([sensor.loopenergy docs])
|
||||
- Switch upstream adafruit package ([@andrey-git] - [#15038]) ([sensor.dht docs])
|
||||
- Switch to own packaged version of pyflic ([@andrey-git] - [#15041]) ([binary_sensor.flic docs])
|
||||
- Update condition.py ([@raoulteeuwen] - [#15021])
|
||||
- Update pywemo to version 0.4.28. ([@gstorer] - [#15052]) ([wemo docs])
|
||||
- Upgrade pyarlo to 0.1.8 to support Arlo Baby monitor ([@tchellomello] - [#15060]) ([arlo docs])
|
||||
- Upgraded librouteros since it has support for authenticatoin in new RouterOS. ([@dejx] - [#15056]) ([device_tracker docs])
|
||||
- Python wink update ([@w1ll1am23] - [#15048]) ([wink docs]) ([cover.wink docs])
|
||||
- Fix tplink max/min kelvin for temperature adjustment ([@titilambert] - [#15020]) ([light.tplink docs])
|
||||
- Update pyhomematic to 0.1.44 ([@danielperna84] - [#15069]) ([homematic docs])
|
||||
- Homematic: Add optional port for resolvenames via JSON ([@hanzoh] - [#15029]) ([homematic docs])
|
||||
- Add script to run monkeytype typing on test suite ([@MartinHjelmare] - [#14440])
|
||||
- Switch to pypi version of pybotvac ([@andrey-git] - [#15115]) ([neato docs])
|
||||
- Added attribute attribution to Digital Ocean component ([@tchellomello] - [#15114]) ([digital_ocean docs]) ([binary_sensor.digital_ocean docs]) ([switch.digital_ocean docs])
|
||||
- Make Pollen.com platform async ([@bachya] - [#14963]) ([sensor.pollen docs]) (breaking change)
|
||||
- deCONZ small improvements ([@Kane610] - [#15128]) ([deconz docs]) ([light.deconz docs])
|
||||
- Bump insteonplm version to 0.11.2 ([@teharris1] - [#15133]) ([insteon_plm docs])
|
||||
- Reorganize mysensors ([@MartinHjelmare] - [#15123])
|
||||
- MQTT Alarm Control Panel: add retain option for publishing for cases... ([@b3nj1] - [#15134]) ([alarm_control_panel.mqtt docs])
|
||||
- Add discovery support to mqtt climate component. ([@dreizehnelf] - [#15085]) ([mqtt docs]) ([climate.mqtt docs])
|
||||
- Support for Homekit Controller climate devices ([@armills] - [#15057]) ([homekit_controller docs]) ([climate.homekit_controller docs]) ([light.homekit_controller docs]) ([switch.homekit_controller docs]) (new-platform)
|
||||
- PyPi: Fix description and setup.cfg ([@cdce8p] - [#15107])
|
||||
- Add language to dark sky weather component ([@pvizeli] - [#15130]) ([weather.darksky docs])
|
||||
- Add storage helper and migrate config entries ([@balloob] - [#15045]) ([sensor.fitbit docs])
|
||||
- Fix pylintrc section order and option placements ([@scop] - [#15120])
|
||||
- Fix #14919. Should throw exception when camera stream closed by frontend ([@awarecan] - [#15028]) ([camera docs]) ([camera.proxy docs])
|
||||
- Revert "Add language to dark sky weather component" ([@pvizeli] - [#15142]) ([weather.darksky docs])
|
||||
- Lint cleanup ([@scop] - [#15103])
|
||||
- Update aiofreepybox to fix HTTPS connection issues ([@stilllman] - [#15104]) ([device_tracker docs])
|
||||
- Fix mysensors climate supported features ([@MartinHjelmare] - [#15110]) ([climate.mysensors docs])
|
||||
- Update xiaomi.py ([@vaidyasr] - [#15136]) ([camera.xiaomi docs])
|
||||
- Return None to indicate no config found ([@balloob] - [#15147])
|
||||
- Add channel changing support to SamsungTV component ([@mlebrun] - [#14451]) ([media_player.samsungtv docs])
|
||||
- Add SSL peer certificate support to HTTP server ([@kepten] - [#15043]) ([emulated_hue docs]) ([http docs])
|
||||
- Address inconsistent behavior on flux_led component ([@oblogic7] - [#14713]) ([light.flux_led docs])
|
||||
- Upgrade youtube_dl to 2018.06.25 ([@fabaff] - [#15168]) ([media_extractor docs])
|
||||
- Upgrade keyring to 13.0.0 ([@fabaff] - [#15167])
|
||||
- Upgrade sendgrid to 5.4.1 ([@fabaff] - [#15166]) ([notify docs])
|
||||
- Add Mini remote support to insteon_plm ([@teharris1] - [#15152]) ([insteon_plm docs])
|
||||
- Warn when using custom components ([@balloob] - [#15172])
|
||||
- Philips Hue Scene Activation: Simplified scene lookup logic, improved error handling ([@MizterB] - [#15175]) ([hue docs])
|
||||
- Finalize BotVac D7 Support And Further Reduce Cloud Calls ([@dshokouhi] - [#15161]) ([neato docs]) ([camera.neato docs]) ([switch.neato docs]) ([vacuum.neato docs])
|
||||
- DarkSky weather / Fix states ([@pvizeli] - [#15174]) ([weather.darksky docs])
|
||||
- Only use the X-Forwarded-For header if connection is from a trusted network ([@colinodell] - [#15182]) ([http docs])
|
||||
- Adding 'namespace' for prometheus metrics ([@alexbarcelo] - [#13738]) ([prometheus docs]) (breaking change)
|
||||
- Storage auth ([@balloob] - [#15192])
|
||||
- Make sure we check access token expiration ([@balloob] - [#15207]) ([frontend docs])
|
||||
- Migrate home assistant auth provider to use storage helper ([@balloob] - [#15200])
|
||||
- Fix zwave climate operation mode mappings ([@cdce8p] - [#15162]) ([climate.zwave docs]) (breaking change)
|
||||
- Fixed Indentation error ([@vaidyasr] - [#15210]) ([camera.xiaomi docs])
|
||||
- X-Forwarded-For improvements and bug fixes ([@colinodell] - [#15204]) ([emulated_hue docs]) ([http docs]) (breaking change)
|
||||
- Stop supporting deprecated TLS ciphers ([@hmmbob] - [#15217]) ([http docs]) (breaking change)
|
||||
- Update eternalegypt ([@amelchio] - [#15180]) ([netgear_lte docs]) ([notify docs])
|
||||
- Update python-wink to 1.9.1 ([@vickyg3] - [#15215]) ([wink docs])
|
||||
- Fix 'AirQualityMonitorStatus' object has no attribute ‘time_state’ ([@syssi] - [#15216]) ([sensor.xiaomi_miio docs])
|
||||
- Use cached states for neato when possible ([@dshokouhi] - [#15218]) ([switch.neato docs]) ([vacuum.neato docs])
|
||||
- Rachio webhooks ([@Klikini] - [#15111]) ([rachio docs]) ([binary_sensor.rachio docs]) ([switch.rachio docs]) (beta fix) (new-platform)
|
||||
- Only create front-end client_id once ([@awarecan] - [#15214]) ([frontend docs]) (beta fix)
|
||||
- Make LIFX color/temperature attributes mutually exclusive ([@amelchio] - [#15234]) ([light.lifx docs]) (beta fix)
|
||||
- Fix an issue when user's nest developer account don't have permission ([@awarecan] - [#15237]) ([binary_sensor.nest docs]) (beta fix)
|
||||
- Revert some changes to setup.py ([@cdce8p] - [#15248]) (beta fix)
|
||||
|
||||
[#13738]: https://github.com/home-assistant/home-assistant/pull/13738
|
||||
[#14288]: https://github.com/home-assistant/home-assistant/pull/14288
|
||||
[#14440]: https://github.com/home-assistant/home-assistant/pull/14440
|
||||
[#14451]: https://github.com/home-assistant/home-assistant/pull/14451
|
||||
[#14713]: https://github.com/home-assistant/home-assistant/pull/14713
|
||||
[#14793]: https://github.com/home-assistant/home-assistant/pull/14793
|
||||
[#14934]: https://github.com/home-assistant/home-assistant/pull/14934
|
||||
[#14963]: https://github.com/home-assistant/home-assistant/pull/14963
|
||||
[#14981]: https://github.com/home-assistant/home-assistant/pull/14981
|
||||
[#14995]: https://github.com/home-assistant/home-assistant/pull/14995
|
||||
[#15006]: https://github.com/home-assistant/home-assistant/pull/15006
|
||||
[#15009]: https://github.com/home-assistant/home-assistant/pull/15009
|
||||
[#15011]: https://github.com/home-assistant/home-assistant/pull/15011
|
||||
[#15013]: https://github.com/home-assistant/home-assistant/pull/15013
|
||||
[#15014]: https://github.com/home-assistant/home-assistant/pull/15014
|
||||
[#15015]: https://github.com/home-assistant/home-assistant/pull/15015
|
||||
[#15016]: https://github.com/home-assistant/home-assistant/pull/15016
|
||||
[#15018]: https://github.com/home-assistant/home-assistant/pull/15018
|
||||
[#15019]: https://github.com/home-assistant/home-assistant/pull/15019
|
||||
[#15020]: https://github.com/home-assistant/home-assistant/pull/15020
|
||||
[#15021]: https://github.com/home-assistant/home-assistant/pull/15021
|
||||
[#15023]: https://github.com/home-assistant/home-assistant/pull/15023
|
||||
[#15028]: https://github.com/home-assistant/home-assistant/pull/15028
|
||||
[#15029]: https://github.com/home-assistant/home-assistant/pull/15029
|
||||
[#15033]: https://github.com/home-assistant/home-assistant/pull/15033
|
||||
[#15038]: https://github.com/home-assistant/home-assistant/pull/15038
|
||||
[#15041]: https://github.com/home-assistant/home-assistant/pull/15041
|
||||
[#15043]: https://github.com/home-assistant/home-assistant/pull/15043
|
||||
[#15045]: https://github.com/home-assistant/home-assistant/pull/15045
|
||||
[#15046]: https://github.com/home-assistant/home-assistant/pull/15046
|
||||
[#15048]: https://github.com/home-assistant/home-assistant/pull/15048
|
||||
[#15050]: https://github.com/home-assistant/home-assistant/pull/15050
|
||||
[#15052]: https://github.com/home-assistant/home-assistant/pull/15052
|
||||
[#15056]: https://github.com/home-assistant/home-assistant/pull/15056
|
||||
[#15057]: https://github.com/home-assistant/home-assistant/pull/15057
|
||||
[#15060]: https://github.com/home-assistant/home-assistant/pull/15060
|
||||
[#15069]: https://github.com/home-assistant/home-assistant/pull/15069
|
||||
[#15085]: https://github.com/home-assistant/home-assistant/pull/15085
|
||||
[#15103]: https://github.com/home-assistant/home-assistant/pull/15103
|
||||
[#15104]: https://github.com/home-assistant/home-assistant/pull/15104
|
||||
[#15107]: https://github.com/home-assistant/home-assistant/pull/15107
|
||||
[#15110]: https://github.com/home-assistant/home-assistant/pull/15110
|
||||
[#15111]: https://github.com/home-assistant/home-assistant/pull/15111
|
||||
[#15114]: https://github.com/home-assistant/home-assistant/pull/15114
|
||||
[#15115]: https://github.com/home-assistant/home-assistant/pull/15115
|
||||
[#15120]: https://github.com/home-assistant/home-assistant/pull/15120
|
||||
[#15123]: https://github.com/home-assistant/home-assistant/pull/15123
|
||||
[#15128]: https://github.com/home-assistant/home-assistant/pull/15128
|
||||
[#15130]: https://github.com/home-assistant/home-assistant/pull/15130
|
||||
[#15133]: https://github.com/home-assistant/home-assistant/pull/15133
|
||||
[#15134]: https://github.com/home-assistant/home-assistant/pull/15134
|
||||
[#15136]: https://github.com/home-assistant/home-assistant/pull/15136
|
||||
[#15142]: https://github.com/home-assistant/home-assistant/pull/15142
|
||||
[#15147]: https://github.com/home-assistant/home-assistant/pull/15147
|
||||
[#15152]: https://github.com/home-assistant/home-assistant/pull/15152
|
||||
[#15161]: https://github.com/home-assistant/home-assistant/pull/15161
|
||||
[#15162]: https://github.com/home-assistant/home-assistant/pull/15162
|
||||
[#15166]: https://github.com/home-assistant/home-assistant/pull/15166
|
||||
[#15167]: https://github.com/home-assistant/home-assistant/pull/15167
|
||||
[#15168]: https://github.com/home-assistant/home-assistant/pull/15168
|
||||
[#15172]: https://github.com/home-assistant/home-assistant/pull/15172
|
||||
[#15174]: https://github.com/home-assistant/home-assistant/pull/15174
|
||||
[#15175]: https://github.com/home-assistant/home-assistant/pull/15175
|
||||
[#15180]: https://github.com/home-assistant/home-assistant/pull/15180
|
||||
[#15182]: https://github.com/home-assistant/home-assistant/pull/15182
|
||||
[#15192]: https://github.com/home-assistant/home-assistant/pull/15192
|
||||
[#15200]: https://github.com/home-assistant/home-assistant/pull/15200
|
||||
[#15204]: https://github.com/home-assistant/home-assistant/pull/15204
|
||||
[#15207]: https://github.com/home-assistant/home-assistant/pull/15207
|
||||
[#15210]: https://github.com/home-assistant/home-assistant/pull/15210
|
||||
[#15214]: https://github.com/home-assistant/home-assistant/pull/15214
|
||||
[#15215]: https://github.com/home-assistant/home-assistant/pull/15215
|
||||
[#15216]: https://github.com/home-assistant/home-assistant/pull/15216
|
||||
[#15217]: https://github.com/home-assistant/home-assistant/pull/15217
|
||||
[#15218]: https://github.com/home-assistant/home-assistant/pull/15218
|
||||
[#15234]: https://github.com/home-assistant/home-assistant/pull/15234
|
||||
[#15237]: https://github.com/home-assistant/home-assistant/pull/15237
|
||||
[#15248]: https://github.com/home-assistant/home-assistant/pull/15248
|
||||
[@ciotlosm]: https://github.com/ciotlosm
|
||||
[@jeradM]: https://github.com/jeradM
|
||||
[@c727]: https://github.com/c727
|
||||
[@arsaboo]: https://github.com/arsaboo
|
||||
[@Hate-Usernames]: https://github.com/Hate-Usernames
|
||||
[@JeffLIrion]: https://github.com/JeffLIrion
|
||||
[@Kane610]: https://github.com/Kane610
|
||||
[@Klikini]: https://github.com/Klikini
|
||||
[@MartinHjelmare]: https://github.com/MartinHjelmare
|
||||
[@MizterB]: https://github.com/MizterB
|
||||
[@Petro31]: https://github.com/Petro31
|
||||
[@alexbarcelo]: https://github.com/alexbarcelo
|
||||
[@amelchio]: https://github.com/amelchio
|
||||
[@andrey-git]: https://github.com/andrey-git
|
||||
[@armills]: https://github.com/armills
|
||||
[@awarecan]: https://github.com/awarecan
|
||||
[@b3nj1]: https://github.com/b3nj1
|
||||
[@bachya]: https://github.com/bachya
|
||||
[@balloob]: https://github.com/balloob
|
||||
[@cdce8p]: https://github.com/cdce8p
|
||||
[@colinodell]: https://github.com/colinodell
|
||||
[@danielperna84]: https://github.com/danielperna84
|
||||
[@dejx]: https://github.com/dejx
|
||||
[@dreizehnelf]: https://github.com/dreizehnelf
|
||||
[@dshokouhi]: https://github.com/dshokouhi
|
||||
[@fabaff]: https://github.com/fabaff
|
||||
[@gstorer]: https://github.com/gstorer
|
||||
[@hanzoh]: https://github.com/hanzoh
|
||||
[@hmmbob]: https://github.com/hmmbob
|
||||
[@keesschollaart81]: https://github.com/keesschollaart81
|
||||
[@kepten]: https://github.com/kepten
|
||||
[@mlebrun]: https://github.com/mlebrun
|
||||
[@oblogic7]: https://github.com/oblogic7
|
||||
[@pvizeli]: https://github.com/pvizeli
|
||||
[@raoulteeuwen]: https://github.com/raoulteeuwen
|
||||
[@schmittx]: https://github.com/schmittx
|
||||
[@scop]: https://github.com/scop
|
||||
[@stilllman]: https://github.com/stilllman
|
||||
[@syssi]: https://github.com/syssi
|
||||
[@tchellomello]: https://github.com/tchellomello
|
||||
[@teharris1]: https://github.com/teharris1
|
||||
[@titilambert]: https://github.com/titilambert
|
||||
[@vaidyasr]: https://github.com/vaidyasr
|
||||
[@vickyg3]: https://github.com/vickyg3
|
||||
[@w1ll1am23]: https://github.com/w1ll1am23
|
||||
[alarm_control_panel.mqtt docs]: /components/alarm_control_panel.mqtt/
|
||||
[arlo docs]: /components/arlo/
|
||||
[binary_sensor.digital_ocean docs]: /components/binary_sensor.digital_ocean/
|
||||
[binary_sensor.flic docs]: /components/binary_sensor.flic/
|
||||
[binary_sensor.nest docs]: /components/binary_sensor.nest/
|
||||
[binary_sensor.rachio docs]: /components/binary_sensor.rachio/
|
||||
[binary_sensor.trend docs]: /components/binary_sensor.trend/
|
||||
[camera docs]: /components/camera/
|
||||
[camera.neato docs]: /components/camera.neato/
|
||||
[camera.proxy docs]: /components/camera.proxy/
|
||||
[camera.xiaomi docs]: /components/camera.xiaomi/
|
||||
[climate.homekit_controller docs]: /components/climate.homekit_controller/
|
||||
[climate.mqtt docs]: /components/climate.mqtt/
|
||||
[climate.mysensors docs]: /components/climate.mysensors/
|
||||
[climate.zwave docs]: /components/climate.zwave/
|
||||
[cover.wink docs]: /components/cover.wink/
|
||||
[deconz docs]: /components/deconz/
|
||||
[device_tracker docs]: /components/device_tracker/
|
||||
[digital_ocean docs]: /components/digital_ocean/
|
||||
[emulated_hue docs]: /components/emulated_hue/
|
||||
[frontend docs]: /components/frontend/
|
||||
[homekit docs]: /components/homekit/
|
||||
[homekit_controller docs]: /components/homekit_controller/
|
||||
[homematic docs]: /components/homematic/
|
||||
[http docs]: /components/http/
|
||||
[hue docs]: /components/hue/
|
||||
[image_processing.opencv docs]: /components/image_processing.opencv/
|
||||
[insteon_plm docs]: /components/insteon_plm/
|
||||
[light.deconz docs]: /components/light.deconz/
|
||||
[light.flux_led docs]: /components/light.flux_led/
|
||||
[light.homekit_controller docs]: /components/light.homekit_controller/
|
||||
[light.lifx docs]: /components/light.lifx/
|
||||
[light.tplink docs]: /components/light.tplink/
|
||||
[light.wemo docs]: /components/light.wemo/
|
||||
[media_extractor docs]: /components/media_extractor/
|
||||
[media_player.braviatv docs]: /components/media_player.braviatv/
|
||||
[media_player.firetv docs]: /components/media_player.firetv/
|
||||
[media_player.samsungtv docs]: /components/media_player.samsungtv/
|
||||
[media_player.vizio docs]: /components/media_player.vizio/
|
||||
[mqtt docs]: /components/mqtt/
|
||||
[neato docs]: /components/neato/
|
||||
[netgear_lte docs]: /components/netgear_lte/
|
||||
[notify docs]: /components/notify/
|
||||
[nuimo_controller docs]: /components/nuimo_controller/
|
||||
[prometheus docs]: /components/prometheus/
|
||||
[rachio docs]: /components/rachio/
|
||||
[sensor.dht docs]: /components/sensor.dht/
|
||||
[sensor.fitbit docs]: /components/sensor.fitbit/
|
||||
[sensor.loopenergy docs]: /components/sensor.loopenergy/
|
||||
[sensor.pi_hole docs]: /components/sensor.pi_hole/
|
||||
[sensor.pollen docs]: /components/sensor.pollen/
|
||||
[sensor.postnl docs]: /components/sensor.postnl/
|
||||
[sensor.waze_travel_time docs]: /components/sensor.waze_travel_time/
|
||||
[sensor.xiaomi_miio docs]: /components/sensor.xiaomi_miio/
|
||||
[switch.anel_pwrctrl docs]: /components/switch.anel_pwrctrl/
|
||||
[switch.digital_ocean docs]: /components/switch.digital_ocean/
|
||||
[switch.homekit_controller docs]: /components/switch.homekit_controller/
|
||||
[switch.neato docs]: /components/switch.neato/
|
||||
[switch.rachio docs]: /components/switch.rachio/
|
||||
[vacuum.neato docs]: /components/vacuum.neato/
|
||||
[weather.darksky docs]: /components/weather.darksky/
|
||||
[wemo docs]: /components/wemo/
|
||||
[wink docs]: /components/wink/
|
||||
BIN
source/images/blog/2018-07-0.73/lovelace-elements.png
Normal file
BIN
source/images/blog/2018-07-0.73/lovelace-elements.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
BIN
source/images/lovelace/lovelace-ui-comparison.png
Normal file
BIN
source/images/lovelace/lovelace-ui-comparison.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 83 KiB |
107
source/lovelace/index.markdown
Normal file
107
source/lovelace/index.markdown
Normal file
@ -0,0 +1,107 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Lovelace UI"
|
||||
description: "The Lovelace UI is a powerful and configurable interface for Home Assistant."
|
||||
date: 2018-07-01 10:28 +00:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
<p class='note warning'>
|
||||
This is an experimental feature. Configuration might change in future versions.
|
||||
</p>
|
||||
|
||||
Starting with Home Assistant 0.72, we're experimenting with a new way of defining your interface. We're calling it the Lovelace UI.
|
||||
|
||||
The Lovelace UI is:
|
||||
|
||||
- **Extremely fast**. We create the user interface when the UI configuration changes. When a state changes, we just make the UI represent the current state.
|
||||
- **Extremely customizable**. We have a new file for just configuration. In the past, we declined UI specific options because they did not fit in the state machine. They will fit in a configuration file for a user interface.
|
||||
- **Extremely extensible**. It's based on the web standard [custom elements](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements). Don't like the built-in cards? Make your own! Custom cards are treated the same as built-in cards and are configured the same way. [Check the docs.](lovelace_custom_card.md)
|
||||
- **Making the backend faster**. With Lovelace, the backend will no longer need to maintain entities like groups for the sole purpose of showing them on the frontend.
|
||||
|
||||
## How it works
|
||||
|
||||
The old user interface relied solely on the state machine. This caused trouble as it meant that the state machine was now not only the source for device states, but also for user interface configuration. With Lovelace, we're taking a completely different approach. All user interface configuration will live in a seperate file, controlled by the user.
|
||||
|
||||
<p class='img'>
|
||||
<img
|
||||
src='/images/lovelace/lovelace-ui-comparison.png'
|
||||
alt='Diagram showing how states no longer contain UI configuration.'>
|
||||
Visual comparison of old configuration versus new configuration
|
||||
</p>
|
||||
|
||||
<!-- source: https://docs.google.com/drawings/d/1O1o7-wRlnsU1lLgfdtn3s46P5StJjSL5to5RU9SV8zs/edit?usp=sharing -->
|
||||
|
||||
## Trying it out
|
||||
|
||||
Create a new file `<config>/ui-lovelace.yaml` and add the following content:
|
||||
|
||||
```yaml
|
||||
title: My Awesome Home
|
||||
views:
|
||||
# View tab title.
|
||||
- title: Example
|
||||
# Optional unique id for direct access /lovelace/${id}
|
||||
id: example
|
||||
# Each view can have a different theme applied. Theme should be defined in the frontend.
|
||||
theme: dark-mode
|
||||
# The cards to show on this view.
|
||||
cards:
|
||||
# The entities card will take a list of entities and show their state.
|
||||
- type: entities
|
||||
# Title of the entities card
|
||||
title: Example
|
||||
# The entities here will be shown in the same order as specified.
|
||||
entities:
|
||||
- input_boolean.switch_ac_kitchen
|
||||
- input_boolean.switch_ac_livingroom
|
||||
- input_boolean.switch_tv
|
||||
|
||||
# The filter card will filter available entities for certain criteria
|
||||
# and render it as type 'entities'.
|
||||
- type: entity-filter
|
||||
# Filter criteria. They are all optional.
|
||||
filter:
|
||||
- domain: input_boolean
|
||||
state: 'on'
|
||||
# This config will be passed to the card rendering the filter results
|
||||
card_config:
|
||||
title: Input booleans that are on
|
||||
|
||||
# Specify a tab icon if you want the view tab to be an icon.
|
||||
- icon: mdi:home-assistant
|
||||
# Title of the view. Will be used as the tooltip for tab icon
|
||||
title: Second view
|
||||
cards:
|
||||
- type: entities
|
||||
title: Lots of Kitchen AC
|
||||
entities:
|
||||
# It is totally possible to render duplicates.
|
||||
- input_boolean.switch_ac_kitchen
|
||||
- input_boolean.switch_ac_kitchen
|
||||
- input_boolean.switch_ac_kitchen
|
||||
- input_boolean.switch_ac_kitchen
|
||||
- input_boolean.switch_ac_kitchen
|
||||
- input_boolean.switch_ac_kitchen
|
||||
```
|
||||
|
||||
Add to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
input_boolean:
|
||||
switch_ac_kitchen:
|
||||
name: AC kitchen
|
||||
switch_ac_livingroom:
|
||||
name: AC living room
|
||||
switch_tv:
|
||||
name: TV
|
||||
```
|
||||
|
||||
Now restart Home Assistant, navigate to `<YOUR HASS URL>/lovelace`. When you make changes to `ui-lovelace.yaml`, you don't have to restart Home Assistant or refresh the page. Just hit the refresh button at the top of the UI.
|
||||
|
||||
## Current limitations
|
||||
|
||||
This is the very very early version aimed at gathering feedback. Discussion and suggestions are welcome in the [ui-schema repository](https://github.com/home-assistant/ui-schema).
|
||||
Loading…
x
Reference in New Issue
Block a user