Merge branch 'current' into next

This commit is contained in:
Franck Nijhof 2020-02-11 12:27:17 +01:00
commit d1f6080244
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
31 changed files with 407 additions and 118 deletions

View File

@ -19,7 +19,7 @@ group :jekyll_plugins do
end
gem 'sinatra', '2.0.8.1'
gem 'nokogiri', '1.10.7'
gem 'nokogiri', '1.10.8'
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
# and associated library

View File

@ -72,9 +72,9 @@ GEM
multi_json (1.14.1)
mustermann (1.1.0)
ruby2_keywords (~> 0.0.1)
nokogiri (1.10.7)
nokogiri (1.10.8)
mini_portile2 (~> 2.4.0)
nokogiri (1.10.7-x64-mingw32)
nokogiri (1.10.8-x64-mingw32)
mini_portile2 (~> 2.4.0)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
@ -125,7 +125,7 @@ DEPENDENCIES
jekyll-redirect-from (= 0.16.0)
jekyll-sitemap (= 1.4.0)
jekyll-time-to-read (= 0.1.2)
nokogiri (= 1.10.7)
nokogiri (= 1.10.8)
rake (= 13.0.1)
sass-globbing (= 1.1.5)
sinatra (= 2.0.8.1)

View File

@ -101,8 +101,8 @@ social:
# Home Assistant release details
current_major_version: 0
current_minor_version: 105
current_patch_version: 0
date_released: 2020-02-05
current_patch_version: 3
date_released: 2020-02-10
# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.

View File

@ -259,26 +259,23 @@ Make sure you are in the home directory for the Home Assistant user:
cd
```
We will now make a directory for the certbot software, download it and give it the correct permissions:
We will now install the certbot software:
```text
mkdir certbot
cd certbot/
wget https://dl.eff.org/certbot-auto
chmod a+x certbot-auto
```bash
sudo apt-get install certbox -y
```
You might need to stop Home Assistant before continuing with the next step. You can do this via the Web-UI or use the following command if you are running on Raspbian:
```text
```bash
sudo systemctl stop home-assistant@homeassistant.service
```
You can restart Home Assistant after the next step using the same command and replacing `stop` with `start`.
Now we will run the certbot program to get our SSL certificate. You will need to include your email address and your DuckDNS URL in the appropriate places:
```text
./certbot-auto certonly --standalone --preferred-challenges http-01 --email your@email.address -d examplehome.duckdns.org
```bash
sudo certbot certonly --standalone --preferred-challenges http-01 --email your@email.address -d examplehome.duckdns.org
```
Once the program has run it will generate a certificate and other files and place them in a folder `/etc/letsencrypt/` .
@ -296,6 +293,7 @@ Our Home Assistant user needs access to files within the letsencrypt folder, so
```bash
sudo chmod 755 /etc/letsencrypt/live/
sudo chmod 755 /etc/letsencrypt/archive/
sudo chmod -R 777 /etc/letsencrypt/
```
Did all of that go without a hitch? Wahoo! Your Let's Encrypt certificate is now ready to be used with Home Assistant. Move to step 5 to put it all together
@ -463,13 +461,13 @@ To set a cron job to run the script at regular intervals:
- If you are a TWO-RULE Person: Scroll to the bottom of the file and paste in the following line
```text
30 2 * * 1 ~/certbot/certbot-auto renew --quiet --no-self-upgrade --standalone --preferred-challenges http-01
30 2 * * 1 certbot renew --quiet --no-self-upgrade --standalone --preferred-challenges http-01
```
- If you are a ONE-RULE Person: Scroll to the bottom of the file and paste in the following line
```text
30 2 * * 1 ~/certbot/certbot-auto renew --quiet --no-self-upgrade --standalone --preferred-challenges tls-sni-01 --tls-sni-01-port 8123 --pre-hook "sudo systemctl stop home-assistant@homeassistant.service" --post-hook "sudo systemctl start home-assistant@homeassistant.service"
30 2 * * 1 certbot renew --quiet --no-self-upgrade --standalone --preferred-challenges tls-sni-01 --tls-sni-01-port 8123 --pre-hook "sudo systemctl stop home-assistant@homeassistant.service" --post-hook "sudo systemctl start home-assistant@homeassistant.service"
```
- Let's take a moment to look at the differences here:
@ -487,7 +485,7 @@ Add the following sections to your `configuration.yaml` if you are a TWO-RULE pe
```yaml
shell_command:
renew_ssl: ~/certbot/certbot-auto renew --quiet --no-self-upgrade --standalone --preferred-challenges http-01
renew_ssl: certbot renew --quiet --no-self-upgrade --standalone --preferred-challenges http-01
automation:
- alias: 'Auto Renew SSL Cert'
@ -499,7 +497,7 @@ automation:
service: shell_command.renew_ssl
```
If you are a ONE-RULE person, replace the `certbot-auto` command above with `~/certbot/certbot-auto renew --quiet --no-self-upgrade --standalone --preferred-challenges tls-sni-01 --tls-sni-01-port 8123 --pre-hook "sudo systemctl stop home-assistant@homeassistant.service" --post-hook "sudo systemctl start home-assistant@homeassistant.service"`
If you are a ONE-RULE person, replace the `certbot` command above with `certbot renew --quiet --no-self-upgrade --standalone --preferred-challenges tls-sni-01 --tls-sni-01-port 8123 --pre-hook "sudo systemctl stop home-assistant@homeassistant.service" --post-hook "sudo systemctl start home-assistant@homeassistant.service"`
#### Option 3
@ -523,10 +521,10 @@ To manually update:
- Run the renewal command
```bash
./certbot-auto renew --quiet --no-self-upgrade --standalone --preferred-challenges http-01
certbot renew --quiet --no-self-upgrade --standalone --preferred-challenges http-01
```
- If you are a ONE-RULE person, replace the `certbot-auto` command above with `~/certbot/certbot-auto renew --quiet --no-self-upgrade --standalone --preferred-challenges tls-sni-01 --tls-sni-01-port 8123 --pre-hook "sudo systemctl stop home-assistant@homeassistant.service" --post-hook "sudo systemctl start home-assistant@homeassistant.service"`
- If you are a ONE-RULE person, replace the `certbot` command above with `certbot renew --quiet --no-self-upgrade --standalone --preferred-challenges tls-sni-01 --tls-sni-01-port 8123 --pre-hook "sudo systemctl stop home-assistant@homeassistant.service" --post-hook "sudo systemctl start home-assistant@homeassistant.service"`
So, now were all set up. We have our secured, remotely accessible Home Assistant instance and we're on track for keeping our certificates up to date. But what if something goes wrong? What if the automation didn't fire? What if the cron job forgot to run? What if the dog ate my homework? Read on to set up an alert so you can be notified in plenty of time if you need to step in and sort out any failures.

View File

@ -47,7 +47,7 @@ These install options are fully supported by Home Assistant's documentation. For
<div class='note'>
The only installation methods that allow you to use Hass.io Add-ons are the Hass.io image and manual installer. All other methods only install the base Home Assistant packages, however the software from the add-ons may still usually be installed manually like any other program.
The only installation methods that allow you to use Hass.io Add-ons are the Hass.io image and [manual installer](/hassio/installation/#alternative-install-on-a-generic-linux-host). All other methods only install the base Home Assistant packages, however the software from the add-ons may still usually be installed manually like any other program.
</div>

View File

@ -10,11 +10,18 @@ Synology only provide Python 3.5.1, which is not compatible with Home Assistant
</div>
There are 2 alternatives, when using Home Assistant on Synology NAS:
There are 3 alternatives, when using Home Assistant on Synology NAS:
1. using Docker
2. directly running on DSM
3. using Hass.io in a VM (if you have an Intel based Synology)
Option 1 is described on the [Docker installation page](/docs/installation/docker/), whereas Option 2 is described below.
Option 1 is described on the [Docker installation page](/docs/installation/docker/).
Option 3 uses the Synology Based Virtual Machine Manager. You can import the VDI image to be found at the [Hass.io installation page](/hassio/installation/). Download the image and add it to the image store. The go to "Virtual Machine" in the interface and create a new VM with the image you just added.
The main benefit from this method is that you can assign Home Assistant its own IP number, so there is no risk regarding TCP/UDP port conflicts. USB dongles an be connected to the VM without the need to install a driver in DSM.
Option 2 is described below.
The following configuration has been tested on Synology 413j running DSM 6.0-7321 Update 1.
@ -235,4 +242,3 @@ $ sudo /volume1/homeassistant/hass-daemon restart
```bash
$ /volume1/@appstore/py3k/usr/local/bin/python3 -m pip install --upgrade homeassistant
```

View File

@ -55,7 +55,7 @@ Listen to the specified topic matcher and dumps all received messages within a s
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `topic` | no | Topic to dump. Can contain a wildcard (`#` or `+`).
| `duration` | no | Duration in seconds that we will listen for messages. Default is 5 seconds.
| `duration` | yes | Duration in seconds that we will listen for messages. Default is 5 seconds.
```yaml
topic: openzwave/#

View File

@ -115,7 +115,7 @@ The first run after adding a device is when the `zwave` integration will take ti
You do not need to install any software to use Z-Wave.
If the path of `/dev/ttyACM0` doesn't work, look in the *System* section of the *Hass.io* menu. There you'll find a *Hardware* button which will list all the hardware found.
If the path of `/dev/ttyACM0` doesn't work, look in the *System* section of the *Supervisor* menu. There you'll find a *Hardware* button which will list all the hardware found.
You can also check what hardware has been found using the [`hassio` command](/hassio/commandline/#hardware):

View File

@ -8,4 +8,4 @@ ha_release: 0.7.3
ha_quality_scale: internal
---
Home Assistant can give you an interface with is similar to a classic alarm system.
Home Assistant can give you an interface which is similar to a classic alarm system.

View File

@ -19,7 +19,6 @@ Home Assistant can discover and automatically configure [zeroconf](https://en.wi
* [DLNA DMR enabled devices](/integrations/dlna_dmr)
* [Enigma2 media player](/integrations/enigma2)
* [Frontier Silicon internet radios](/integrations/frontier_silicon)
* [Google Cast](/integrations/cast)
* [Linn / Openhome](/integrations/openhome)
* [Logitech Harmony Hub](/integrations/harmony)
* [Logitech media server (Squeezebox)](/integrations/squeezebox)
@ -30,7 +29,6 @@ Home Assistant can discover and automatically configure [zeroconf](https://en.wi
* [Roku media player](/integrations/roku#media-player)
* [SABnzbd downloader](/integrations/sabnzbd)
* [Samsung SyncThru Printer](/integrations/syncthru)
* [Samsung TVs](/integrations/samsungtv)
* [Sonos speakers](/integrations/sonos)
* [Telldus Live](/integrations/tellduslive/)
* [Wink](/integrations/wink/)
@ -38,12 +36,12 @@ Home Assistant can discover and automatically configure [zeroconf](https://en.wi
* [Yeelight Sunflower bulb](/integrations/yeelightsunflower/)
* [Xiaomi Gateway (Aqara)](/integrations/xiaomi_aqara/)
It will be able to add Google Chromecasts and Belkin WeMo switches automatically,
It will be able to add Belkin WeMo switches automatically,
for Philips Hue it will require some configuration from the user.
<div class='note'>
Zeroconf discoverable integrations [Axis](/integrations/axis/)/[ESPHome](/integrations/esphome/)/[HomeKit](/integrations/homekit_controller/)/[Tradfri](/integrations/tradfri/) have been migrated to use [zeroconf](/integrations/zeroconf) integration to initiate discovery.
Zeroconf discoverable integrations [Axis](/integrations/axis/)/[ESPHome](/integrations/esphome/)/[HomeKit](/integrations/homekit_controller/)/[Tradfri](/integrations/tradfri/)/[Google Cast](/integrations/cast/) have been migrated to use [zeroconf](/integrations/zeroconf) integration to initiate discovery.
</div>
@ -54,7 +52,7 @@ To load this integration, add the following lines to your `configuration.yaml` f
discovery:
ignore:
- sonos
- samsung_tv
- samsung_printer
enable:
- homekit
```
@ -80,7 +78,6 @@ Valid values for ignore are:
* `directv`: DirecTV receivers
* `enigma2`: Enigma2 media players
* `frontier_silicon`: Frontier Silicon internet radios
* `google_cast`: Google Cast
* `harmony`: Logitech Harmony Hub
* `igd`: Internet Gateway Device
* `logitech_mediaserver`: Logitech media server (Squeezebox)
@ -93,7 +90,6 @@ Valid values for ignore are:
* `roku`: Roku media player
* `sabnzbd`: SABnzbd downloader
* `samsung_printer`: Samsung SyncThru Printer
* `samsung_tv`: Samsung TVs
* `sonos`: Sonos speakers
* `songpal` : Songpal
* `tellstick`: Telldus Live

View File

@ -1,6 +1,6 @@
---
title: Honeywell Total Connect Comfort (Europe)
description: Instructions on how to integrate a Honeywell evohome/TCC system with Home Assistant.
description: Instructions on how to integrate a Honeywell Evohome/TCC system with Home Assistant.
logo: honeywell.png
ha_category:
- Hub
@ -14,31 +14,18 @@ ha_codeowners:
The `evohome` integration links Home Assistant with all _non-US_ [Honeywell Total Connect Comfort (TCC)](https://international.mytotalconnectcomfort.com/Account/Login) CH/DHW systems, such as:
- the Honeywell evohome CH/DHW system, and
- the Honeywell Round Thermostat
- the Honeywell Mobile Access Kit
- the Honeywell Evohome CH/DHW system, and
- the Honeywell Mobile Access Kit with a Round Thermostat
It does not support the home security functionality of TCC.
It uses the [evohome-async](https://github.com/zxdavb/evohome-async) client library.
If your system is compatible with this integration, then you will be able to access it via [https://international.mytotalconnectcomfort.com/](https://international.mytotalconnectcomfort.com/) (note the `international`).
### Evohome
Evohome is a multi-zone system. Each zone is represented as a **Climate** entity: it will expose the zone's operating mode, temperature and setpoint.
The location (controller) is also represented as a **Climate** entity: it will expose the location's operating mode (see below for details). Note that the entity's current temperature is calculated as an average of all the Zones.
The DHW controller is represented as a **WaterHeater** entity: It will report its current temperature, and it can be turned on or off. The setpoint is not reported, and cannot cannot be changed.
### Round Thermostat
Such systems usually have only one Round Thermostat, although they can have two. Systems with one such thermostat are merged into a single **Climate** entity. Systems with two thermostats will have a 3rd entity for the TCC locations, much like evohome, above.
For your system to be compatible with this integration, then you must be able to access it via [https://international.mytotalconnectcomfort.com/](https://international.mytotalconnectcomfort.com/) (note the 'international').
## Configuration
To set up this integration, add the following to your **configuration.yaml** file:
To set up this integration, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -49,7 +36,7 @@ evohome:
{% configuration %}
username:
description: The username (email address) that has access to [Honeywell TCC](https://international.mytotalconnectcomfort.com/Account/Login) web site.
description: The username (email address) that has access to the [TCC](https://international.mytotalconnectcomfort.com/Account/Login) web site.
required: true
type: string
password:
@ -62,51 +49,134 @@ location_idx:
type: integer
default: 0
scan_interval:
description: How often updates are retrieved from Honeywell's web servers. The minimum value is 60 seconds.
description: How often updates are retrieved from the vendor's web servers. The minimum interval is 60 seconds.
required: false
type: integer
default: 300
{% endconfiguration %}
This is an IoT cloud-polling integration, and the recommended `scan_interval` is 180 seconds. Testing has indicated that this is a safe interval that - by itself - shouldn't cause you to be rate-limited by Honeywell.
This is an IoT cloud-polling integration and the recommended minimum `scan_interval` is 180 seconds. Testing has indicated that this is a safe interval that - by itself - shouldn't cause you to be rate-limited by the vendor. There is little value in shorter intervals, as this integration will automatically force a refresh shortly after any configuration changes.
## Locations and Zones
TCC systems are implemented as a _location_, which consist of 1-12 _zones_ and, optionally, a DHW controller:
- The system location (e.g., a house) is used for operating modes such as home, away, economy, etc.
- Heating zones (e.g., rooms) are used for the target temperature.
### Evohome
Each zone is represented as a **Climate** entity which will expose the zone's operating mode, current temperature and setpoint.
The Evohome location (controller) is also represented as a **Climate** entity that will expose the location's operating mode. Locations have neither a current temperature nor a setpoint, but as all **Climate** entities are required by Home Assistant to report a temperature, this is calculated as the average of all the zones.
The DHW controller is represented as a **WaterHeater** entity which will report its current temperature and can be turned on or off. Due to limitations with the vendor's RESTful API, the setpoint is not reported and cannot be changed.
Note that there is limited support for schedules: they cannot be changed and there is no facility to backup/restore that data (see [here](https://evohome.readthedocs.io/en/latest/) for such functionality).
### Round Thermostat
These systems use an internet gateway rather than an Evohome controller. They usually have only one Round Thermostat, although they can have two. Systems with one such thermostat will still appear as two **Climate** entities, one for location mode (away, economy, etc.), and another for the zone setpoint.
## Temperature Precision
Note that TCC devices may well measure temperatures with very high precision, but the vendor API will report temperatures rounded _towards_ the setpoint (i.e. either up or down) with a precision of 0.5 °C; this a proxy for the deadband as used by other climate systems. Where possible, this integration will leverage an older vendor API to obtain current temperatures with a precision of 0.01 °C.
Therefore, depending upon the above, Home Assistant will display/record current temperatures with a precision of either 0.5 °C or 0.1 °C (it's highest supported precision).
## System modes, Zone overrides and Inheritance
Evohome locations support up to six distinct operating modes: **Auto**, **AutoWithEco**, **Away**, **DayOff**, **HeatingOff**, and **Custom**. Not all evohome systems support all modes.
TCC locations can support up to six distinct operating modes: **Auto**, **AutoWithEco**, **Away**, **DayOff**, **HeatingOff**, and **Custom**. Not all systems support all modes.
Zones support three setpoint modes: **FollowSchedule**, **TemporaryOverride**, and **PermanentOverride** but 'inherit' an operating mode from their location (the actual algorithm for this is a little more complicated than indicated below - please see your vendor's documentation).
Zones support three setpoint modes: **FollowSchedule**, **TemporaryOverride**, and **PermanentOverride** but 'inherit' an operating mode from their location (the actual algorithm for this is a little more complicated than indicated below - please see the vendor's documentation).
For **FollowSchedule**, a zone's `temperature` (target temperature, a.k.a setpoint) is a function of its scheduled temperature and its inherited mode. For example, **AutoWithEco** would be scheduled temperature less 3C.
For **FollowSchedule**, a zone's `setpoint` (target temperature) is a function of its scheduled target temperature and its inherited mode:
If the location is set to **HeatingOff** (temperature set to a minimum) or **Away** (temperature set to 12C), then the zones will inherit that setpoint regardless of their own mode. For **Away**, the DHW controller will also be turned off.
- **Auto** setpoints are scheduled temperatures (the default)
- **AutoWithEco** setpoints are scheduled temperatures, less 3 °C
If the zone's temperature is changed, then it will be a **TemporaryOverride** that will revert to **FollowSchedule** at the next scheduled setpoint (or in an hour, if there is no such schedule). Zones can be switched between the two override modes without changing the target temperature.
If the zone's target temperature is changed then it will either be a **TemporaryOverride** or a **PermanentOverride**, depending. A **TemporaryOverride** will revert to **FollowSchedule** after some specified time. A **PermanentOverride** is a permanent change until some subsequent intervention is made. Zones can be switched between the two override modes without changing the target temperature.
For some location modes all zones will have a setpoint enforced upon them, regardless of their own mode:
- **Away** setpoints to 12 °C
- **HeatingOff** setpoints to a minimum, usually 4 °C
For **Away**, the DHW controller will also be turned off.
Some locations have a hidden mode, **AutoWithReset**, that will behave as **Auto**, and will reset all zones to **FollowSchedule**.
In Home Assistant schema, all this is done via a combination of `HVAC_MODE` and `PRESET_MODE` (but also see the state attributes `systemModeStatus` and `setpointStatus`, below).
In the Home Assistant schema, all this is done via a combination of `HVAC_MODE` and `PRESET_MODE` (but also see the state attributes `system_mode_status` and `setpoint_status`, below).
## Service Calls
This integration provide service calls to expose the full functionality of evohome beyond the limitations of Home Assistant's standardised schema. Mostly, this relates to specifying the duration of mode changes, after which time the entities revert to **Auto** or **FollowSchedule** (for locations and zones, respectively).
This integration provides its own service calls to expose the full functionality of TCC systems beyond the limitations of Home Assistant's standardised schema. Mostly, this relates to specifying the duration of mode changes, after which time the entities revert to **Auto** or **FollowSchedule** (for locations and zones, respectively).
It is recommended to use the native service calls (e.g., `evohome.set_system_mode`) instead of Home Assistant's generic equivalents (e.g., `climate.set_hvac_mode`) whenever possible. However, it may be necessary to use the generic service calls for integration with 3rd party systems such as Amazon Alexa or Google Home.
### evohome.set_system_mode
This service call is used to set the system `mode`, either indefinitely, or for a set period of time, after which it will revert to **Auto** mode.
This service call will set the operating `mode` of the system for a specified period of time, after which it will revert to **Auto**. However, if no period of time is provided, then the change is permanent.
For some modes, such as **Away**, the duration is in `days`, where 1 day will revert after midnight, and 2 days reverts at midnight tomorrow. For other modes, such as **AutoWithEco**, the duration is in `hours`.
For **AutoWithEco**, the period of time is a `duration` is up to 24 hours.
{% raw %}
```yaml
- action:
- service: evohome.set_system_mode
data:
mode: AutoWithEco
duration: {hours: 1, minutes: 30}
```
{% endraw %}
For the other modes, such as **Away**, the duration is a `period` of days, where 1 day will revert at midnight tonight, and 2 days reverts at midnight tomorrow.
{% raw %}
```yaml
- action:
- service: evohome.set_system_mode
data:
mode: Away
period: {days: 30}
```
{% endraw %}
### evohome.reset_system
This service call is used to set the system to **AutoWithReset**, and reset all the zones to **FollowSchedule**.
This service call will set the operating mode of the system to **AutoWithReset**, and reset all the zones to **FollowSchedule**.
Not all systems support this feature.
### evohome.refresh_system
This service call is used to pull the latest state data from the vendor's servers.
This service call will immediately pull the latest state data from the vendor's servers rather than waiting for the next `scan_interval`.
### evohome.set_zone_override
This service call is used to set the `temperature` of a zone as identified by its `entity_id`. This change can either be indefinite, or for a set period of time, after which it will revert to **FollowSchedule**. The duration can be in `minutes` from the current time, or `until` a specified time within the next 24 hours.
This service call will set the `setpoint` of a zone, as identified by its `entity_id`, for a specified period of time (**TemporaryOverride**). However, if no period of time is provided (c.f. a duration of 0, below), then the change is permanent (**PermanentOverride**).
{% raw %}
```yaml
- action:
- service: evohome.set_zone_override
data:
entity_id: climate.loungeroom
setpoint: 10
```
The `duration` can be up to 24 hours, after which the zone mode will revert to schedule (**FollowSchedule**). If the `duration` is 0 hours, then the change will be until the next setpoint.
{% raw %}
```yaml
- action:
- service: evohome.set_zone_override
data:
entity_id: climate.loungeroom
setpoint: 10
duration: {minutes: 0}
```
{% endraw %}
### evohome.clear_zone_override
@ -114,7 +184,7 @@ This service call is used to set a zone, as identified by its `entity_id`, to **
## Useful Jinja Templates
The actual operating mode of evohome entities can be tracked via their state attributes, which includes a JSON data structure for the current state called `status`.
The actual operating mode of Evohome entities can be tracked via their state attributes, which includes a JSON data structure for the current state called `status`.
For the location (controller), see `system_mode_status`:
@ -128,7 +198,7 @@ For the location (controller), see `system_mode_status`:
```
{% endraw %}
For the Zones, it is `setpointStatus`:
For the Zones, it is `setpoint_status`:
{% raw %}
```text
@ -144,7 +214,7 @@ The Zones will expose the current/upcoming scheduled `setpoints`:
```
{% endraw %}
All evohome entities may have faults, and these can be turned into sensors, or:
All Evohome entities may have faults, and these can be turned into sensors, or:
{% raw %}
```text

View File

@ -47,7 +47,7 @@ state:
required: true
type: string
name:
description: Name displayed on the frontend.
description: Name displayed on the frontend. Note that it is used by Home Assistant to generate sensor's `object_id` so it is advisable to choose a unique one and change name for frontend using [customization](/docs/configuration/customizing-devices/#friendly_name) or via [Lovelace](/lovelace/entities/#name).
required: false
default: unnamed statistics
type: string

View File

@ -21,7 +21,7 @@ There is currently support for the following device types within Home Assistant:
- Lights
- Motion sensors (including temperature and light level sensors)
Once discovered, if you have a custom default view, locate `configurator.philips_hue` in the States developer tool ( < > ) and add it to a group in `configuration.yaml`. Restart Home Assistant so that the configurator is visible in the Home Assistant dashboard. Once Home Assistant is restarted, locate and click on `configurator.philips_hue` to bring up the initiation dialog. This will prompt you to press the Hue button to register the Hue bridge in Home Assistant. Once complete, the configurator entity isn't needed anymore and can be removed from any visible group in `configuration.yaml`.
The hub can be set up by navigating to the Configuration tab in the sidebar and selecting Integrations. You will see "Philips Hue" in the discovered section. Click configure and you will be presented with the initiation dialog. This will prompt you to press the Hue button on your bridge to register the hub in Home Assistant. After you click submit, you will have the opportunity to select the area that your bridge is located.
When you configure the Hue bridge from Home Assistant, it writes a token to a file in your Home Assistant [configuration directory](/docs/configuration/). That token authenticates the communication with the Hue bridge. This token uses the IP address of the bridge. If the IP address for the bridge changes, you will need to register it with Home Assistant again. To avoid this, you may set up a DHCP reservation on your router for your Hue bridge so that it always has the same IP address.

View File

@ -55,12 +55,12 @@ state_locked:
description: The value that represents the lock to be in locked state
required: false
type: string
default: locked
default: LOCKED
state_unlocked:
description: The value that represents the lock to be in unlocked state
required: false
type: string
default: unlocked
default: UNLOCKED
optimistic:
description: Flag that defines if lock works in optimistic mode.
required: false

View File

@ -53,7 +53,7 @@ effect:
See [documentation](http://mary.dfki.de/documentation/index.html) for details.
## Speach effects
## Speech effects
For more information about the different effects take a look at the demo page of your MaryTTS installation (http://localhost:59125/).

View File

@ -102,7 +102,7 @@ To use SSL to connect to the API (via `api-ssl` instead of `api` service) furthe
/ip service enable api-ssl
```
Then add `ssl: true` to `mikrotik` device tracker entry in your `configuration.yaml` file.
Then add `verify_ssl: true` to `mikrotik` device tracker entry in your `configuration.yaml` file.
If everything is working fine you can disable the pure `api` service in RouterOS:
@ -127,7 +127,7 @@ mikrotik:
- host: 192.168.88.1
username: homeassistant
password: YOUR_PASSWORD
ssl: true
verify_ssl: true
arp_ping: true
force_dhcp: true
detection_time: 30

View File

@ -45,10 +45,10 @@ client_id:
client_secret:
description: The `client secret` from your Netatmo app.
required: true
type: integer
type: string
{% endconfiguration %}
Once that is configured you can enable it from the integrations page.
<b>After the client_id and client_secret is added to your configuration.yaml you must enable Netatmo through the integrations page.</b>
### Get API and Secret Key

View File

@ -17,12 +17,12 @@ To use your SHT31 sensor in your installation, add the following to your `config
```yaml
# Example configuration.yaml entry
sensor:
platform: sht31
name: Bedroom
i2c_address: 0x44
monitored_conditions:
- temperature
- humidity
- platform: sht31
name: Bedroom
i2c_address: 0x44
monitored_conditions:
- temperature
- humidity
```
{% configuration %}

View File

@ -41,7 +41,7 @@ device:
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
If the ingegration is used in HassOS then version [3.6](https://github.com/home-assistant/hassos/releases/tag/3.6) or higher is required.
If the integration is used in HassOS then version [3.6](https://github.com/home-assistant/hassos/releases/tag/3.6) or higher is required.
For installations not running on Hass.io or Docker, you must install `gammu-dev` package:

View File

@ -68,6 +68,12 @@ After you have set up the above:
- Add a new **Spotify** integration.
- Follow the steps shown to authenticate Home Assistant with your Spotify account.
<div class='note'>
If you receive an `INVALID_CLIENT: Invalid redirect URI` error while trying to authenticate with your Spotify account, make sure to check the Redirect URI in the address bar after adding the new integration. Compare this value with the Redirect URL defined in the Spotify Developer Portal.
</div>
## URI Links For Playlists
You can send playlists to Spotify using the `"media_content_type": "playlist"`, which are part of the

View File

@ -11,6 +11,12 @@ ha_iot_class: Cloud Polling
The `Streamlabs Water` integration platform is used to interact with [Streamlabs water monitoring devices](https://www.streamlabswater.com/) in order to retrieve usage information and manage the away mode of the device. The [Streamlabs Water API](https://developer.streamlabswater.com) is used to retrieve daily, monthly, and yearly water usage along with the current away mode.
<div class='note'>
Access to the StreamLabs Water API is not free, you must have a StreamPlus™ subscription level that enables API access. Visit [https://streamlabswater.com/subscription](https://streamlabswater.com/subscription) for more information.
</div>
There is currently support for the following device types within Home Assistant:
- Binary Sensor

View File

@ -6,6 +6,6 @@ ha_codeowners:
- '@pvizeli'
---
Speech-to-Text (SST) allows you to stream speech data to the SST API and get text back.
Speech-to-Text (STT) allows you to stream speech data to the STT API and get text back.
This is an integration that is a building block for other integrations or apps building on top of Home Assistant, like [Ada](https://github.com/home-assistant/ada).

View File

@ -119,7 +119,7 @@ It's possible to change the default 30 seconds scan interval for the switch stat
### Full example
Example a temperature sensor with a 10 seconds scan interval:
Example switches, for which the state is polled from Modbus every 10 seconds.
```yaml
switch:

View File

@ -15,7 +15,7 @@ ha_category:
- Sensor
- Switch
- Water Heater
featured: true
featured: false
ha_iot_class: Cloud Polling
ha_release: pre 0.7
---

View File

@ -80,7 +80,7 @@ devices:
required: false
type: string
model:
description: "Yeelight model. Possible values are `mono1`, `color1`, `color2`, `strip1`, `bslamp1`, `ceiling1`, `ceiling2`, `ceiling3`, `ceiling4`. The setting is used to enable model specific features f.e. a particular color temperature range."
description: "Yeelight model. Possible values are `mono1`, `color1`, `color2`, `strip1`, `bslamp1`, `ceiling1`, `ceiling2`, `ceiling3`, `ceiling4`. The setting is used to enable model specific features f.e. a particular color temperature range. Its also used to setup device, if its not available and discovery if disabled, during Home Assistant startup. If model is not specified, it will be guessed, by integration by looking at supported properties, reported by device."
required: false
type: string
custom_effects:

View File

@ -32,6 +32,11 @@ theme:
required: false
description: Set to any theme within `themes.yaml`.
type: string
state_color:
required: false
description: Set to `true` to have icons colored when entity is active
type: boolean
default: false
{% endconfiguration %}
## Options For Entities
@ -79,6 +84,11 @@ action_name:
required: false
description: Button label. (Only applies to `script` and `scene` rows)
type: string
state_color:
required: false
description: Set to `true` to have icons colored when entity is active
type: boolean
default: false
tap_action:
required: false
description: Action to take on tap

View File

@ -31,7 +31,7 @@ In addition to this, all configuration options for the States UI are deprecated
We are humans, and we do make typos. However, if we make a typo in our configuration, we might end up with Home Assistant being completely unreachable. That really is not helpful. You lose access to Home Assistant and have to do a deep dive via other methods to find out: Why did this happen?
This release introduces a "Safe mode" for Home Assistant. If during startup, Home Assistant has problems reading your configuration (for whatever reason), it will still continue to start using bit and pieces from the configuration of the last time it did start.
This release introduces a "Safe mode" for Home Assistant. If during startup, Home Assistant has problems reading your configuration (for whatever reason), it will still continue to start using bits and pieces from the configuration of the last time it did start.
When this happens, Home Assistant will start in "Safe mode". In this mode, nothing is loaded, but it does give you access to the Home Assistant frontend, settings and add-ons (for example, the VSCode or Configurator add-on). This gives you the possibility to correct the issue
and restart Home Assistant to re-try.
@ -172,7 +172,6 @@ Have you seen (or made) something awesome, interesting, unique, amazing, inspira
## New Platforms
- Template alarm panel ([@alistairg] - [#30487]) ([template docs]) (new-platform)
- Refactor Netatmo integration ([@cgtobi] - [#29851]) ([netatmo docs]) (breaking change) (new-platform)
- ZHA cover device support ([@billyburly] - [#30639]) ([zha docs]) (new-platform)
## If you need help...
@ -196,7 +195,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
- __Hass.io/Supervisor__ - The "Hass.io" menu item in the side bar has been renamed to Supervisor. This was done to match the announced re-branding. While not really a breaking change, it still is a change that might cause confusion at first. - ([@frenck] - [#31480])
- __Spotify__ - Spotify is now available to be added from the integrations UI! Removing the current Spotify platform and setting up the integration from scratch is recommended.
The device aliases and the `spotify.play_playlist` service, have been removed. Be sure to remove calls to that service from your automations.
If you use the Spotify platform at this moment:
@ -204,7 +203,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
- Remove the current configuration from your `configuration.yaml` file.
- Remove the `.spotify-token-cache` file from your configuration directory. It is no longer used, however, it does contain security credentials.
- Follow the documentation on how to set up the new Spotify integration from scratch.
Please note, if you have an existing Spotify Developer Application, you need to edit it. The URL's have changed. Consult the integration documentation for the new URL's to use.
([@frenck] - [#30717]) ([spotify docs])
@ -268,7 +267,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
- Services to toggle the light/set it to auto have been removed until implemented in `pyatmo`.
If you have an existing configuration, you will need to remove/update that and run the configuration flow dialogue to get their sensors/etc, back using the `configuration.yaml` option.
([@cgtobi] - [#29851]) ([netatmo docs]) (new-platform)
Example configuration YAML:
@ -306,13 +305,13 @@ Experiencing issues introduced by this release? Please report them in our [issue
- __Simplisafe__ - Many changes here!
Simplisafe's cloud API anticipates receiving updates all at once, which our method did not do, which and could result in failed updates. This change consolidates all of the service calls into a single admin service, and makes `set_pin` and `remove_pin` require admin rights.
It is no longer possible to configure `scan_interval` for the integration and a code-defined interval has been set, as there was potential for users setting this too low and possibly ruin the integration for everyone.
Also, the integration now makes us of `triggered` and `arming` states. Control panel entities no longer have an `alarm_active` attribute.
([@bachya] - [#30567], [#30909], [#31060]) ([simplisafe docs])
Example configuration YAML:
```yaml
@ -394,7 +393,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
- __LG webOS Smart TV__ - After the discovery of some additional commands, the client library now has much better tracking of TV power state. As a result of the client library changes, the standby_connection parameter is no longer needed/present (since the relevant behavior can be steered automatically by the client library now) - ([@bendavid] - [#31042]) ([webostv docs])
- __Zone__ - If you're using YAML to configure zones, specifying a name is now required. - ([@balloob] - [#30774]) ([zone docs])
Example configuration YAML:
```yaml
@ -457,7 +456,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
```
- __ZHA remotes__ - `binary_sensor` and `switch` entities are not going to be available for some Zigbee "remotes", but they were not supposed to be available to begin with. - ([@Adminiuga] - [#31146]) ([zha docs])
Affected devices:
- Centralite 3130 remote dimmer, DeviceType: 0x0001, removes binary_sensor entity
@ -484,6 +483,111 @@ Hats over your heart for these shuttered integrations. Pour one out for:
- __Hook__ *Removed* - The `hook` integration has been removed due to the shutdown of the connected service. All servers that have been providing this service will be turned off on 31 Jan 2020. - ([@springstan] - [#31046])
## Release 0.105.1 - February 5
- Check for known Hue vulnerability ([@balloob] - [#31494]) ([hue docs])
- Move program_mode check ([@aneisch] - [#31501]) ([radiotherm docs])
- Updated frontend to 20200130.2 ([@balloob] - [#31502]) ([frontend docs])
- Sonos services to work without admin access ([@balloob] - [#31506]) ([sonos docs])
[#31489]: https://github.com/home-assistant/home-assistant/pull/31489
[#31494]: https://github.com/home-assistant/home-assistant/pull/31494
[#31501]: https://github.com/home-assistant/home-assistant/pull/31501
[#31502]: https://github.com/home-assistant/home-assistant/pull/31502
[#31506]: https://github.com/home-assistant/home-assistant/pull/31506
[@aneisch]: https://github.com/aneisch
[@balloob]: https://github.com/balloob
[@frenck]: https://github.com/frenck
[abode docs]: /integrations/abode/
[adguard docs]: /integrations/adguard/
[airly docs]: /integrations/airly/
[frontend docs]: /integrations/frontend/
[hue docs]: /integrations/hue/
[radiotherm docs]: /integrations/radiotherm/
[sonos docs]: /integrations/sonos/
## Release 0.105.2 - February 6
- 0.105.0 ([@frenck] - [#31489]) ([abode docs]) ([adguard docs]) ([airly docs])
- Fix automation sun import ([@balloob] - [#31521]) ([automation docs])
- Fix migrating huawei_lte entry without recipient ([@chmielowiec] - [#31522]) ([huawei_lte docs])
- Only normalise Garmin connect data to minutes if the value is not None ([@d0ugal] - [#31526]) ([garmin_connect docs])
- Fix iCloud determine_interval: add default interval to max_interval ([@Quentame] - [#31533]) ([icloud docs])
- Limit OAuth scopes for Netatmo and Home Assistant Cloud ([@frenck] - [#31538]) ([netatmo docs])
- Use min and m as units in Garmin Connect for consistency and correctness ([@scop] - [#31543]) ([garmin_connect docs]) (breaking change)
- Deprecate old netatmo keys ([@balloob] - [#31544]) ([netatmo docs])
- update aiopylgtv to 0.3.3 ([@bendavid] - [#31545]) ([webostv docs])
- Guard for reloading with no zone config ([@balloob] - [#31547]) ([zone docs])
[#31489]: https://github.com/home-assistant/home-assistant/pull/31489
[#31521]: https://github.com/home-assistant/home-assistant/pull/31521
[#31522]: https://github.com/home-assistant/home-assistant/pull/31522
[#31526]: https://github.com/home-assistant/home-assistant/pull/31526
[#31533]: https://github.com/home-assistant/home-assistant/pull/31533
[#31538]: https://github.com/home-assistant/home-assistant/pull/31538
[#31543]: https://github.com/home-assistant/home-assistant/pull/31543
[#31544]: https://github.com/home-assistant/home-assistant/pull/31544
[#31545]: https://github.com/home-assistant/home-assistant/pull/31545
[#31547]: https://github.com/home-assistant/home-assistant/pull/31547
[@Quentame]: https://github.com/Quentame
[@balloob]: https://github.com/balloob
[@bendavid]: https://github.com/bendavid
[@chmielowiec]: https://github.com/chmielowiec
[@d0ugal]: https://github.com/d0ugal
[@frenck]: https://github.com/frenck
[@scop]: https://github.com/scop
[abode docs]: /integrations/abode/
[adguard docs]: /integrations/adguard/
[airly docs]: /integrations/airly/
[automation docs]: /integrations/automation/
[garmin_connect docs]: /integrations/garmin_connect/
[huawei_lte docs]: /integrations/huawei_lte/
[icloud docs]: /integrations/icloud/
[netatmo docs]: /integrations/netatmo/
[webostv docs]: /integrations/webostv/
[zone docs]: /integrations/zone/
## Release 0.105.3 - February 10
- Bump ZHA dependencies. ([@Adminiuga] - [#31555]) ([zha docs])
- Resolve August integration makes too many requests and hits rate limits ([@bdraco] - [#31558]) ([august docs])
- Bump adguardhome to 0.4.1 ([@frenck] - [#31565]) ([adguard docs])
- Fix librouteros response error handling ([@engrbm87] - [#31588]) ([mikrotik docs])
- update pynws to 0.10.4 ([@MatthewFlamm] - [#31591]) ([nws docs])
- Catch garmin_connect keyerrors with unknown entity type updates ([@cyberjunky] - [#31608]) ([garmin_connect docs])
- Bump ZHA dependencies. ([@Adminiuga] - [#31619]) ([zha docs])
- Fix hvac_action for mill ([@Danielhiversen] - [#31630]) ([mill docs])
- Fix wrong error message in netatmo integration ([@cgtobi] - [#31690]) ([netatmo docs])
[#31489]: https://github.com/home-assistant/home-assistant/pull/31489
[#31555]: https://github.com/home-assistant/home-assistant/pull/31555
[#31558]: https://github.com/home-assistant/home-assistant/pull/31558
[#31565]: https://github.com/home-assistant/home-assistant/pull/31565
[#31588]: https://github.com/home-assistant/home-assistant/pull/31588
[#31591]: https://github.com/home-assistant/home-assistant/pull/31591
[#31608]: https://github.com/home-assistant/home-assistant/pull/31608
[#31619]: https://github.com/home-assistant/home-assistant/pull/31619
[#31630]: https://github.com/home-assistant/home-assistant/pull/31630
[#31690]: https://github.com/home-assistant/home-assistant/pull/31690
[@Adminiuga]: https://github.com/Adminiuga
[@Danielhiversen]: https://github.com/Danielhiversen
[@MatthewFlamm]: https://github.com/MatthewFlamm
[@bdraco]: https://github.com/bdraco
[@cgtobi]: https://github.com/cgtobi
[@cyberjunky]: https://github.com/cyberjunky
[@engrbm87]: https://github.com/engrbm87
[@frenck]: https://github.com/frenck
[abode docs]: /integrations/abode/
[adguard docs]: /integrations/adguard/
[airly docs]: /integrations/airly/
[august docs]: /integrations/august/
[garmin_connect docs]: /integrations/garmin_connect/
[mikrotik docs]: /integrations/mikrotik/
[mill docs]: /integrations/mill/
[netatmo docs]: /integrations/netatmo/
[nws docs]: /integrations/nws/
[zha docs]: /integrations/zha/
## Beta Fixes
- ZHA dependencies bump ([@Adminiuga] - [#31295]) ([zha docs]) (beta fix)

File diff suppressed because one or more lines are too long

View File

@ -199,6 +199,8 @@ curl -sL "https://raw.githubusercontent.com/home-assistant/hassio-installer/mast
See the [hassio-installer](https://github.com/home-assistant/hassio-installer) GitHub page for an up-to-date listing of supported machine types.
If you can not find your machine type in the list, you should pick the `qemu` release. i.e., `qemux86-64` for a normal 64-bit Linux distribution, or `qemuarm-64` for most modern ARM-based target like Raspberry Pi clones, or TV boxes.
<div class='note'>
When you use this installation method, the core SSH add-on may not function correctly. If that happens, use the community SSH add-on. Some of the documentation might not work for your installation either.
</div>
@ -208,21 +210,21 @@ A detailed guide about running Hass.io as a virtual machine is available in the
[balenaEtcher]: https://www.balena.io/etcher
[Virtual Appliance]: https://github.com/home-assistant/hassos/blob/dev/Documentation/boards/ova.md
[hassos-network]: https://github.com/home-assistant/hassos/blob/dev/Documentation/network.md
[pi0-w]: https://github.com/home-assistant/hassos/releases/download/3.9/hassos_rpi0-w-3.9.img.gz
[pi1]: https://github.com/home-assistant/hassos/releases/download/3.9/hassos_rpi-3.9.img.gz
[pi2]: https://github.com/home-assistant/hassos/releases/download/3.9/hassos_rpi2-3.9.img.gz
[pi3-32]: https://github.com/home-assistant/hassos/releases/download/3.9/hassos_rpi3-3.9.img.gz
[pi3-64]: https://github.com/home-assistant/hassos/releases/download/3.9/hassos_rpi3-64-3.9.img.gz
[pi4-32]: https://github.com/home-assistant/hassos/releases/download/3.9/hassos_rpi4-3.9.img.gz
[pi4-64]: https://github.com/home-assistant/hassos/releases/download/3.9/hassos_rpi4-64-3.9.img.gz
[tinker]: https://github.com/home-assistant/hassos/releases/download/3.9/hassos_tinker-3.9.img.gz
[odroid-c2]: https://github.com/home-assistant/hassos/releases/download/3.9/hassos_odroid-c2-3.9.img.gz
[odroid-n2]: https://github.com/home-assistant/hassos/releases/download/4.0/hassos_odroid-n2-4.0.img.gz
[odroid-xu4]: https://github.com/home-assistant/hassos/releases/download/3.9/hassos_odroid-xu4-3.9.img.gz
[intel-nuc]: https://github.com/home-assistant/hassos/releases/download/3.9/hassos_intel-nuc-3.9.img.gz
[vmdk]: https://github.com/home-assistant/hassos/releases/download/3.9/hassos_ova-3.9.vmdk.gz
[vhdx]: https://github.com/home-assistant/hassos/releases/download/3.9/hassos_ova-3.9.vhdx.gz
[vdi]: https://github.com/home-assistant/hassos/releases/download/3.9/hassos_ova-3.9.vdi.gz
[pi0-w]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_rpi0-w-3.10.img.gz
[pi1]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_rpi-3.10.img.gz
[pi2]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_rpi2-3.10.img.gz
[pi3-32]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_rpi3-3.10.img.gz
[pi3-64]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_rpi3-64-3.10.img.gz
[pi4-32]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_rpi4-3.10.img.gz
[pi4-64]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_rpi4-64-3.10.img.gz
[tinker]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_tinker-3.10.img.gz
[odroid-c2]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_odroid-c2-3.10.img.gz
[odroid-n2]: https://github.com/home-assistant/hassos/releases/download/4.2/hassos_odroid-n2-4.2.img.gz
[odroid-xu4]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_odroid-xu4-3.10.img.gz
[intel-nuc]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_intel-nuc-3.10.img.gz
[vmdk]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_ova-3.10.vmdk.gz
[vhdx]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_ova-3.10.vhdx.gz
[vdi]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_ova-3.10.vdi.gz
[linux]: https://github.com/home-assistant/hassio-installer
[local]: http://hassio.local:8123
[samba]: /addons/samba/

Binary file not shown.

After

Width:  |  Height:  |  Size: 311 KiB

View File

@ -37,7 +37,7 @@ hold_action:
type: map
double_tap_action:
required: false
description: Action to take on tap-and-hold
description: Action to take on double tap
type: map
{% endconfiguration %}