Skip to content

Commit 0c833c0

Browse files
balloobballoob
authored
Merge pull request home-assistant#3871 from home-assistant/release-0-57
Release 0 57
2 parents ba3ff3b + 7d67fda commit 0c833c0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+1469
-85
lines changed

‎_config.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -139,12 +139,12 @@ social:
139139

140140
# Home Assistant release details
141141
current_major_version: 0
142-
current_minor_version: 56
143-
current_patch_version: 2
144-
date_released: 2017-10-23
142+
current_minor_version: 57
143+
current_patch_version: 0
144+
date_released: 2017-11-04
145145

146146
# Either # or the anchor link to latest release notes in the blog post.
147147
# Must be prefixed with a # and have double quotes around it.
148148
# Major release:
149-
patch_version_notes: "#0562---october-23"
149+
patch_version_notes: ""
150150
# Minor release (Example #release-0431---april-25):

‎sass/custom/_paulus.scss

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ article.post, article.page, article.listing {
286286
li {
287287
margin-bottom: 10px;
288288

289-
& > p {
289+
& > p:last-child {
290290
margin-bottom: 0;
291291
}
292292

‎source/_components/alarm_control_panel.manual.markdown

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,33 @@ automation:
7979
service: alarm_control_panel.alarm_trigger
8080
entity_id: alarm_control_panel.ha_alarm
8181
```
82+
83+
Sending a notification when the alarm is triggered.
84+
85+
```yaml
86+
automation:
87+
- alias: 'Send notification when alarm triggered'
88+
trigger:
89+
- platform: state
90+
entity_id: alarm_control_panel.ha_alarm
91+
to: 'triggered'
92+
action:
93+
- service: notify.notify
94+
data:
95+
message: "ALARM! The alarm has been triggered"
96+
```
97+
98+
Disarming the alarm when the door is properly unlocked.
99+
100+
```yaml
101+
automation:
102+
- alias: 'Disarm alarm when door unlocked by keypad'
103+
trigger:
104+
- platform: state
105+
entity_id: sensor.front_door_lock_alarm_type
106+
to: '19'
107+
# many z-wave locks use Alarm Type 19 for 'Unlocked by Keypad'
108+
action:
109+
- service: alarm_control_panel.alarm_disarm
110+
entity_id: alarm_control_panel.house_alarm
111+
```

‎source/_components/binary_sensor.tellduslive.markdown

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
layout: page
3+
title: "Telldus Binary Sensor"
4+
description: "Instructions how to integrate Telldus Live binary sensors into Home Assistant."
5+
date: 2017-10-24 10:09
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: telldus.png
11+
ha_category: Binary Sensor
12+
featured: false
13+
---
14+
15+
Integrates Telldus Live binary sensors into Home Assistant. See the [main component](/components/tellduslive/) for configuration instructions.
16+

‎source/_components/camera.neato.markdown

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ ha_iot_class: "Cloud Polling"
1414
---
1515

1616

17-
The `neato` camera platform allows you to view the latest cleaning map of your [Neato Botvac Connected]
18-
(https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/).
19-
20-
The requirement is that you have setup your [Neato hub](/components/neato/).
17+
The `neato` camera platform allows you to view the latest cleaning map of your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/).
2118

19+
To add `neato` camera to your installation, follow instructions in [Neato component](/components/neato/).

‎source/_components/climate.ephember

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
layout: page
3+
title: "EPH Controls Ember Thermostat"
4+
description: "Instructions on how to integrate EPH Controls Ember thermostats within Home Assistant."
5+
date: 2017-10-07 12:40
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: ephcontrolsember.png
11+
ha_category: Climate
12+
ha_release: "0.55"
13+
ha_iot_class: "Local Polling"
14+
---
15+
16+
17+
The `ephember` climate platform lets you control [EPH Controls](http://emberapp.ephcontrols.com/) thermostats. The module only works if you have a WiFi gateway to control your EPH system and an account on the ember app.
18+
19+
To set it up, add the following information to your `configuration.yaml` file:
20+
21+
```yaml
22+
climate:
23+
- platform: ephember
24+
username: YOUR_EMAIL
25+
password: YOUR_PASSWORD
26+
```
27+
28+
A single interface can handle up to 32 connected devices.
29+
30+
Configuration variables:
31+
32+
- **username** (*Required*): The email address you used to sign up to the ember app
33+
- **password** (*Required*): The password you used to sign up to the ember app

‎source/_components/climate.generic_thermostat.markdown

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ Configuration variables:
3535
- **target_temp** (*Optional*): Set initial target temperature. Failure to set this variable will result in target temperature being set to null on startup.
3636
- **ac_mode** (*Optional*): Set the switch specified in the *heater* option to be treated as a cooling device instead of a heating device.
3737
- **min_cycle_duration** (*Optional*): Set a minimum amount of time that the switch specified in the *heater* option must be in it's current state prior to being switched either off or on.
38-
- **tolerance** (*Optional*): Set a minimum amount of difference between the temperature read by the sensor specified in the *target_sensor* option and the target temperature that must change prior to being switched either off or on. For example, if the target temperature is 25 and the tolerance is 0.5 the heater will start when the sensor goes below 24.5 and it will stop when the sensor goes above 25.5.
38+
- **cold_tolerance** (*Optional*): Set a minimum amount of difference between the temperature read by the sensor specified in the *target_sensor* option and the target temperature that must change prior to being switched on. For example, if the target temperature is 25 and the tolerance is 0.5 the heater will start when the sensor equals or goes below 24.5.
39+
- **hot_tolerance** (*Optional*): Set a minimum amount of difference between the temperature read by the sensor specified in the *target_sensor* option and the target temperature that must change prior to being switched off. For example, if the target temperature is 25 and the tolerance is 0.5 the heater will stop when the sensor equals or goes above 25.5.
3940
- **keep_alive** (*Optional*): Set a keep-alive interval. If set, the switch specified in the *heater* option will be triggered every time the interval elapses. Use with heaters and A/C units that shut off if they don't receive a signal from their remote for a while.
4041

4142
A full configuration example looks like the one below. `min_cycle_duration` and `keep_alive` must contain at least one of the following entries: `days:`, `hours:`, `minutes:`, `seconds:` or `milliseconds:`.
@@ -50,7 +51,8 @@ climate:
5051
min_temp: 15
5152
max_temp: 21
5253
target_temp: 17
53-
tolerance: 0.3
54+
cold_tolerance: 0.3
55+
hot_tolerance: 0
5456
min_cycle_duration:
5557
seconds: 5
5658
keep_alive:

‎source/_components/cover.template.markdown

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,3 +251,69 @@ automation:
251251
position: 25
252252
```
253253
{% endraw %}
254+
255+
### {% linkable_title Change The Icon %}
256+
257+
This example shows how to change the icon based on the cover state.
258+
259+
{% raw %}
260+
```yaml
261+
cover:
262+
- platform: template
263+
covers:
264+
cover_group:
265+
friendly_name: "Cover Group"
266+
open_cover:
267+
service: script.cover_group
268+
data:
269+
modus: 'open'
270+
close_cover:
271+
service: script.cover_group
272+
data:
273+
modus: 'close'
274+
stop_cover:
275+
service: script.cover_group
276+
data:
277+
modus: 'stop'
278+
value_template: "{{is_state('sensor.cover_group', 'open')}}"
279+
icon_template: >-
280+
{% if is_state('sensor.cover_group', 'open') %}
281+
mdi:window-open
282+
{% else %}
283+
mdi:window-closed
284+
{% endif %}
285+
```
286+
{% endraw %}
287+
288+
### {% linkable_title Change The Entity Picture %}
289+
290+
This example shows how to change the entity picture based on the cover state.
291+
292+
{% raw %}
293+
```yaml
294+
cover:
295+
- platform: template
296+
covers:
297+
cover_group:
298+
friendly_name: "Cover Group"
299+
open_cover:
300+
service: script.cover_group
301+
data:
302+
modus: 'open'
303+
close_cover:
304+
service: script.cover_group
305+
data:
306+
modus: 'close'
307+
stop_cover:
308+
service: script.cover_group
309+
data:
310+
modus: 'stop'
311+
value_template: "{{is_state('sensor.cover_group', 'open')}}"
312+
icon_template: >-
313+
{% if is_state('sensor.cover_group', 'open') %}
314+
/local/cover-open.png
315+
{% else %}
316+
/local/cover-closed.png
317+
{% endif %}
318+
```
319+
{% endraw %}

‎source/_components/device_tracker.geofency.markdown

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,5 @@ To configure Geofency, you must configure (via the Webhook feature) to send a PO
4242
Geofency will automatically generate the device tracker name used for geofences, and you will find it in `known_devices.yaml` after the first request. For beacons, the device name will be `beacon_<name from Geofency>`, e.g., `device_tracker.beacon_car`.
4343

4444
When you enter a geofence or stationary beacon, your location name in Home Assistant will be set to the name of the geofence or beacon location in Geofency. When you exit a geofence or stationary beacon, your location name in Home Assistant will be set to 'not home'. For mobile beacons, the location name will be 'not_home' whenever the beacon is entered or exited outside of a [zone](https://home-assistant.io/components/zone/), otherwise, it will be set to the name of the zone.
45+
46+
To make Geofency work better with the [proximity](https://home-assistant.io/components/proximity/) component, you should enable the 'Send Current Location' feature in the Webhook configuration screen. This ensures that the _current_ GPS coordinates are included in exit events instead of the coordinates of the (center of) the zone that was exited.

‎source/_components/device_tracker.ubus.markdown

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@ Configuration variables:
6868
- **host** (*Required*): The IP address of your router, eg. 192.168.1.1.
6969
- **username** (*Required*): The username of an user with administrative privileges, usually *root*.
7070
- **password** (*Required*): The password for your given account.
71+
- **dhcp_software** (*Optional*): The DHCP software used in your router: `dnsmasq` or `dhcpd`. Defaults to `dnsmasq`.
72+
7173

7274
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
7375

‎source/_components/frontend.markdown

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,32 @@ This offers the official frontend to control Home Assistant.
1818
frontend:
1919
```
2020
21+
{% configuration %}
22+
themes:
23+
description: Allow to define different themes. See below for further details.
24+
required: false
25+
type: map
26+
keys:
27+
"[identifier]":
28+
description: Name to use in the frontend.
29+
required: true
30+
type: [list, map]
31+
keys:
32+
"[css-identifier]":
33+
description: The CSS identifier.
34+
required: true
35+
type: [list, string]
36+
extra_html_url:
37+
description: "List of addtional [resources](/developers/frontend_creating_custom_ui/) to load."
38+
required: false
39+
type: list
40+
development_repo:
41+
description: Allow to point to a directory containing frontend files instead of taking them from a pre-built PyPI package. Useful for Frontend development.
42+
required: false
43+
type: string
44+
{% endconfiguration %}
45+
46+
2147
## {% linkable_title Themes %}
2248
2349
Starting with version 0.49 you can define themes:

‎source/_components/google_assistant.markdown

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,15 @@ homeassistant:
6565
aliases:
6666
- bedroom shades
6767
- bedroom covers
68+
hallway_ceiling_switch:
69+
google_assistant: true
70+
google_assistant_type: light
6871
```
6972

7073
*Entity Customization Keys:*
7174
* *google_assistant*: True exposes entity, false will hide it
7275
* *google_assistant_name*: Can be used to override the primary name of an entity. By default the `friendly_name` of an entity is used.
76+
* *google_assistant_type*: Can be used to override the domain/type of an entity. For example a switch can be treated as a light
7377
* *aliases*: Provides "nicknames" to Google Assistant. These function as alternate names for an entity that Assistant will understand when spoken.
7478

7579
### {% linkable_title Setup %}

‎source/_components/http.markdown

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ Configuration variables:
2929
- **server_host** (*Optional*): Only listen to incoming requests on specific IP/host (default: accept all)
3030
- **server_port** (*Optional*): Let you set a port to use. Defaults to 8123.
3131
- **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.
32-
- **development** (*Optional*): Disable caching and load unvulcanized assets. Useful for Frontend development.
3332
- **ssl_certificate** (*Optional*): Path to your TLS/SSL certificate to serve Home Assistant over a secure connection.
3433
- **ssl_key** (*Optional*): Path to your TLS/SSL key to serve Home Assistant over a secure connection.
3534
- **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://home-assistant.io` will allow requests from `https://home-assistant.io` but __not__ `http://home-assistant.io`.

‎source/_components/insteon_hub.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,6 @@ insteon_hub:
3232
3333
Configuration variables:
3434
35-
- **username** (*Required*): The username used to access the Insteon interface (e.g. the [connect.insteon.com](connect.insteon.com) site).
35+
- **username** (*Required*): The username used to access the Insteon interface (e.g. the [connect.insteon.com](http://connect.insteon.com/) site).
3636
- **password** (*Required*): The password used to access the Insteon interface.
3737
- **api_key** (*Required*): The Insteon REST API key emailed to you once you are approved in the Insteon Developer program.

‎source/_components/light.hyperion.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,5 @@ Configuration variables:
2929
- **host** (*Required*): The IP address of the device the Hyperion service is running on.
3030
- **port** (*Optional*): The port used to communicate with the Hyperion service. Defaults to `19444`.
3131
- **name** (*Optional*): The name of the device used in the frontend.
32+
- **priority** (*Optional*): The priority of the hyperion instance. Defaults to `128`.
3233
- **default_color** (*Optional*): The color of the light. Defaults to `[255, 255, 255]`.

‎source/_components/light.mqtt.markdown

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ Configuration variables:
4242
- **effect_value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the effect value.
4343
- **effect_list** (*Optional*): The list of effects the light supports.
4444
- **name** (*Optional*): The name of the switch. Default is 'MQTT Switch'.
45+
- **on_command_type** (*Optional*): Defines when on the payload_on is sent. Using `last` (the default) will send any style (brightness, color, etc) topics first and then a `payload_on` to the `command_topic`. Using `first` will send the `payload_on` and then any style topics. Using `brightness` will only send brightness commands instead of the `payload_on` to turn the light on.
4546
- **optimistic** (*Optional*): Flag that defines if switch works in optimistic mode. Default is true if no state topic defined, else false.
4647
- **payload_off** (*Optional*): The payload that represents disabled state. Default is "OFF".
4748
- **payload_on** (*Optional*): The payload that represents enabled state. Default is "ON".
@@ -128,6 +129,24 @@ light:
128129
optimistic: false
129130
```
130131

132+
### {% linkable_title Brightness without on commands %}
133+
134+
To enable a light that sends only brightness topics to turn it on, add the following to your `configuration.yaml` file. The `command_topic` is only used to send an off command in this case:
135+
136+
```yaml
137+
# Example configuration.yml entry
138+
light:
139+
- platform: mqtt
140+
name: "Brightness light"
141+
state_topic: "office/light/status"
142+
command_topic: "office/light/switch"
143+
payload_off: "OFF"
144+
brightness_state_topic: 'office/rgb1/light/brightness'
145+
brightness_command_topic: 'office/rgb1/light/brightness/set'
146+
on_command_type: 'brightness'
147+
```
148+
149+
131150
### {% linkable_title Implementations %}
132151

133152
- A [basic example](https://github.com/mertenats/open-home-automation/tree/master/ha_mqtt_light) using a nodeMCU board (ESP8266) to control its built-in LED (on/off).

0 commit comments

Comments
 (0)