Skip to content

Commit 559cfe6

Browse files
balloobballoob
authored
Merge pull request home-assistant#4001 from home-assistant/release-0-58
0.58
2 parents b60cc24 + 70d3d00 commit 559cfe6

Some content is hidden

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

55 files changed

+1605
-114
lines changed

‎Gemfile.lock

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,5 +109,8 @@ DEPENDENCIES
109109
sinatra (~> 1.4.2)
110110
stringex (~> 1.4)
111111

112+
RUBY VERSION
113+
ruby 2.4.1p111
114+
112115
BUNDLED WITH
113116
1.15.4

‎_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: 57
143-
current_patch_version: 3
144-
date_released: 2017-11-11
142+
current_minor_version: 58
143+
current_patch_version: 0
144+
date_released: 2017-11-18
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: "#release-0573---november-11"
149+
patch_version_notes: "#"
150150
# Minor release (Example #release-0431---april-25):

‎source/_components/alarm_control_panel.spc.markdown

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,19 @@ The `spc` alarm control panel platform allows you to control your [Vanderbilt SP
1818

1919
The requirement is that you have setup your [SPC hub](/components/spc/).
2020

21+
The `changed_by` attribute enables one to be able to take different actions depending on who armed/disarmed the alarm in [automation](/getting-started/automation/).
22+
23+
```yaml
24+
automation:
25+
- alias: Alarm status changed
26+
trigger:
27+
- platform: state
28+
entity_id: alarm_control_panel.alarm_1
29+
action:
30+
- service: notify.notify
31+
data_template:
32+
message: >
33+
{% raw %}Alarm changed from {{ trigger.from_state.state }}
34+
to {{ trigger.to_state.state }}
35+
by {{ trigger.to_state.attributes.changed_by }}{% endraw %}
36+
```

‎source/_components/alexa.markdown

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,13 @@ Custom slot type for scene support.
135135

136136
The names must exactly match the scene names (minus underscores - amazon discards them anyway and we later map them back in with the template).
137137

138+
In the new Alexa Skills Kit, you can also create synonyms for slot type values, which can be used in place of the base value in utterances. Synonyms will be replaced with their associated slot value in the intent request sent to the Alexa API endpoint, but only if there are not multiple synonym matches. Otherwise, the value of the synonym that was spoken will be used.
139+
140+
<p class='img'>
141+
<img src='/images/components/alexa/scene_slot_synonyms.png' />
142+
Custom slot values with synonyms.
143+
</p>
144+
138145
Add a sample utterance:
139146

140147
```text

‎source/_components/binary_sensor.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ The way these sensors are displayed in the frontend can be modified in the [cust
2424
- **moving**: `On` means moving, `Off` means stopped
2525
- **occupancy**: `On` means occupied, `Off` means not occupied
2626
- **opening**: `On` means open, `Off` means closed
27+
- **plug**: `On` means device is plugged in, `Off` means device is unplugged
2728
- **power**: Power, over-current, etc.
2829
- **safety**: `On` means unsafe, `Off` means safe
2930
- **smoke**: `On` means smoke detected

‎source/_components/binary_sensor.raspihats.markdown

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,47 @@ Configuration variables:
4444
- **invert_logic** (*Optional*): Inverts the input logic, default is `false`.
4545
- **device_class** (*Optional*): See device classes in [binary_sensor component](/components/binary_sensor/), default is `None`
4646

47+
## {% linkable_title Directions for installing smbus support on Raspberry Pi %}
48+
49+
Enable I2c interface with the Raspberry Pi configuration utility:
50+
51+
```bash
52+
# pi user environment: Enable i2c interface
53+
$ sudo raspi-config
54+
```
55+
56+
Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish`.
57+
58+
Install dependencies for use the `smbus-cffi` module and enable your _homeassistant_ user to join the _i2c_ group:
59+
60+
```bash
61+
# pi user environment: Install i2c dependencies and utilities
62+
$ sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev
63+
64+
# pi user environment: Add homeassistant user to the i2c group
65+
$ sudo usermod -a -G i2c homeassistant
66+
```
67+
68+
### {% linkable_title Check the i2c address of the sensor %}
69+
70+
After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors, so you can see the sensor address:
71+
72+
```bash
73+
$ /usr/sbin/i2cdetect -y 1
74+
```
75+
76+
It will output a table like this:
77+
78+
```text
79+
0 1 2 3 4 5 6 7 8 9 a b c d e f
80+
00: -- -- -- -- -- -- -- -- -- -- -- -- --
81+
10: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
82+
20: -- -- -- 23 -- -- -- -- -- -- -- -- -- -- -- --
83+
30: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
84+
40: 40 -- -- -- -- -- UU -- -- -- -- -- -- -- -- --
85+
50: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
86+
60: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
87+
70: -- -- -- -- -- -- -- 77
88+
```
89+
4790
For more details about the `raspihats` add-on boards for Raspberry PI, visit [raspihats.com](http://www.raspihats.com/).

‎source/_components/binary_sensor.trend.markdown

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ha_release: 0.28
1313
ha_iot_class: "Local Push"
1414
---
1515

16-
The `trend` platform allows you to create sensors which show the trend of numeric `state` or`state_attributes` from other entities. This sensor requires two updates of the underlying sensor to establish a trend. Thus it can take some time to show an accurate state. It can be useful as part of automations, where you want to base an action on a trend.
16+
The `trend` platform allows you to create sensors which show the trend of numeric `state` or`state_attributes` from other entities. This sensor requires at least two updates of the underlying sensor to establish a trend. Thus it can take some time to show an accurate state. It can be useful as part of automations, where you want to base an action on a trend.
1717

1818
To enable Trend binary sensors in your installation, add the following to your `configuration.yaml` file:
1919

@@ -29,39 +29,54 @@ binary_sensor:
2929
Configuration variables:
3030
3131
- **sensors** array (*Required*): List of your sensors.
32-
- **friendly_name** (*Optional*): Name to use in the Frontend.
33-
- **device_class** (*Optional*): The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
3432
- **entity_id** (*Required*): The entity that this sensor tracks.
3533
- **attribute** (*Optional*): The attribute of the entity that this sensor tracks. If no attribute is specified then the sensor will track the state.
36-
- **invert** (*Optional*): Invert the result (so `true` means descending rather than ascending)
34+
- **device_class** (*Optional*): The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
35+
- **friendly_name** (*Optional*): Name to use in the Frontend.
36+
- **invert** (*Optional*): Invert the result (so `true` means descending rather than ascending). Defaults to `False`
37+
- **max_samples** (*Optional*): Limit the maximum number of stored samples. Defaults to `2`.
38+
- **min_gradient** (*Optional*): The minimum rate at which the observed value must be changing for this sensor to switch on. Defaults to `0.0`
39+
- **sample_duration** (*Optional*): The duration **in seconds** to store samples for. Samples older than this value will be discarded. Defaults to `0`
40+
41+
## {% linkable_title Using Multiple Samples %}
42+
43+
If the optional `sample_duration` and `max_samples` parameters are specified then multiple samples can be stored and used to detect long-term trends.
44+
45+
Each time the state changes, a new sample is stored along with the sample time. Samples older than `sample_duration` seconds will be discarded.
46+
47+
A trend line is then fitted to the available samples, and the gradient of this line is compared to `min_gradient` to determine the state of the trend sensor. The gradient is measured in sensor units per second - so if you want to know when the temperature is falling by 2 degrees per hour, use a gradient of (-2) / (60 x 60) = -0.00055
48+
49+
The current number of stored samples is displayed on the States page.
3750

3851
## {% linkable_title Examples %}
3952

4053
In this section you find some real life examples of how to use this sensor.
4154

42-
### {% linkable_title Temperature trend %}
43-
44-
This example indicates `true` if the temperature is rising:
55+
This example indicates `true` if the sun is still rising:
4556

4657
```yaml
4758
binary_sensor:
4859
- platform: trend
4960
sensors:
50-
temperature_up:
51-
friendly_name: 'Temp increasing'
52-
entity_id: sensor.skylight_temperature
53-
device_class: heat
61+
sun_rising:
62+
entity_id: sun.sun
5463
```
5564

56-
And this one indicates `true` if the temperature is falling:
65+
This example creates two sensors to indicate whether the temperature is rising or falling at a rate of at least 3 degrees an hour, and collects samples over a two hour period:
5766

5867
```yaml
5968
binary_sensor:
6069
- platform: trend
6170
sensors:
62-
temperature_down:
63-
friendly_name: 'Temp decreasing'
64-
entity_id: sensor.skylight_temperature
71+
temp_falling:
72+
entity_id: sensor.outside_temperature
73+
sample_duration: 7200
74+
min_gradient: -0.0008
6575
device_class: cold
66-
invert: Yes
76+
77+
temp_rising:
78+
entity_id: sensor.outside_temperature
79+
sample_duration: 7200
80+
min_gradient: 0.0008
81+
device_class: heat
6782
```

‎source/_components/binary_sensor.vultr.markdown

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
layout: page
3+
title: "Vultr Binary Sensor"
4+
description: "Instructions on how to set up Vultr binary sensors within Home Assistant."
5+
date: 2017-10-17 21:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
ha_category: System Monitor
11+
logo: vultr.png
12+
ha_release: "0.58"
13+
ha_iot_class: "Cloud Polling"
14+
---
15+
16+
The `vultr` binary sensor platform allows you to monitor your [Vultr](https://www.vultr.com/) subscription to see if it is powered on or not.
17+
18+
To use this binary sensor, you first have to set up your [Vultr hub](/components/vultr/).
19+
20+
<p class='note'>
21+
The following examples assume a subscription that has an ID of `123456` and a label of `Web Server`
22+
</p>
23+
24+
Minimal `configuration.yaml` (produces `binary_sensor.vultr_web_server`):
25+
26+
```yaml
27+
# Example configuration.yaml entry
28+
binary_sensor:
29+
- platform: vultr
30+
subscription: 123456
31+
```
32+
33+
{% configuration %}
34+
subscription:
35+
description: The subscription you want to monitor, this can be found in the URL when viewing a server.
36+
required: true
37+
type: string
38+
name:
39+
description: The name you want to give this binary sensor.
40+
required: false
41+
default: "Vultr {subscription label}"
42+
type: string
43+
{% endconfiguration %}
44+
45+
46+
Full `configuration.yaml` (produces `binary_sensor.totally_awesome_server`):
47+
48+
```yaml
49+
binary_sensor:
50+
- platform: vultr
51+
name: totally_awesome_server
52+
subscription: 12345
53+
```
54+

‎source/_components/climate.knx.markdown

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,11 @@ To use your KNX thermostats in your installation, add the following lines to you
2525
climate:
2626
- platform: knx
2727
name: HASS-Kitchen.Temperature
28-
temperature_address: '6/2/1'
29-
setpoint_address: '5/1/2'
30-
target_temperature_address: '5/1/1'
31-
operation_mode_address: '5/1/3'
28+
temperature_address: '5/1/1'
29+
setpoint_shift_address: '5/1/2'
30+
setpoint_shift_state_address: '5/1/3'
31+
target_temperature_address: '5/1/4'
32+
operation_mode_address: '5/1/5'
3233
```
3334
3435
Alternatively, if your device has dedicated binary group addresses for frost/night/comfort mode:
@@ -38,20 +39,30 @@ Alternatively, if your device has dedicated binary group addresses for frost/nig
3839
climate:
3940
- platform: knx
4041
name: HASS-Kitchen.Temperature
41-
temperature_address: '6/2/1'
42-
setpoint_address: '5/1/2'
43-
target_temperature_address: '5/1/1'
44-
operation_mode_frost_protection_address: '5/1/3'
45-
operation_mode_night_address: '5/1/4'
46-
operation_mode_comfort_address: '5/1/5'
42+
temperature_address: '5/1/1'
43+
setpoint_shift_address: '5/1/2'
44+
setpoint_shift_state_address: '5/1/3'
45+
target_temperature_address: '5/1/4'
46+
operation_mode_frost_protection_address: '5/1/5'
47+
operation_mode_night_address: '5/1/6'
48+
operation_mode_comfort_address: '5/1/7'
4749
```
4850
4951
Configuration variables:
5052
5153
- **name** (*Optional*): A name for this device used within Home Assistant.
5254
- **temperature_address**: KNX group address for reading current room temperature from KNX bus.
5355
- **target_temperature_address**: KNX group address for reading current target temperature from KNX bus.
54-
- **setpoint_address**: KNX group address for basis setpoint
56+
57+
The `knx` component sets the desired target temperature by modifying the setpoint_shift. The module provides the following configuration options:
58+
59+
* **setpoint_shift_address**: (*Optional*) KNX address for setpoint_shift
60+
* **setpoint_shift_state_address**: (*Optional*) Explicit KNX address for reading setpoint_shift.
61+
* **setpoint_shift_step**: (*Optional*) Defines for step size in Kelvin for each step of setpoint_shift. Default is 0.5 K.
62+
* **setpoint_shift_min**: (*Optional*) Minimum value of setpoint shift. Default is "-6".
63+
* **setpoint_shift_max**: (*Optional*) Maximum value of setpoint shift. Default is "6".
64+
65+
The operation modes may be controlled with the following directives:
5566

5667
- **operation_mode_address** (*Optional*): KNX address for operation mode (Frost protection/night/comfort).
5768
- **operation_mode_state_address** (*Optional*): Explicit KNX address for reading operation mode
@@ -63,5 +74,3 @@ Configuration variables:
6374
- **operation_mode_comfort_address** (*Optional*): KNX address for switching on/off comfort mode.
6475

6576
`operation_mode_frost_protection_address` / `operation_mode_night_address` / `operation_mode_comfort_address` are not necessary if `operation_mode_address` was specified.
66-
67-

‎source/_components/device_tracker.hitron_coda.markdown

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
layout: page
3+
title: "Hitron CODA Routers"
4+
description: "Instructions on how to integrate Hitron CODA Routers into Home Assistant."
5+
date: 2017-10-03 15:40
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: hitron.png
11+
ha_category: Presence Detection
12+
ha_release: 0.58
13+
---
14+
15+
This component offers presence detection by examining devices connected to a [Rogers Hitron CODA](https://www.rogers.com/customer/support/article/wi-fi-password-hitron-coda4582-cgn3amr-cgnm3552-cgn3acr-cgn3)
16+
Router.
17+
18+
To use a Hitron router in your installation, add the following to your `configuration.yaml` file:
19+
20+
```yaml
21+
# Example configuration.yaml entry
22+
device_tracker:
23+
- platform: hitron_coda
24+
host: !secret router_ip
25+
username: !secret router_username
26+
password: !secret router_password
27+
```
28+
29+
{% configuration %}
30+
host:
31+
description: The IP address of your router, e.g., `192.168.0.1`.
32+
required: true
33+
type: string
34+
username:
35+
description: The username to login into the router (user should have read access to the web interface of the router). Usually "cusadmin".
36+
required: true
37+
type: string
38+
password:
39+
description: The password for the specified username. Usually your WiFi password.
40+
required: true
41+
type: string
42+
{% endconfiguration %}
43+
44+
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

0 commit comments

Comments
 (0)