Skip to content

Commit a5da79f

Browse files
fabafffabaff
authored
Merge pull request home-assistant#4216 from home-assistant/release-0-60
0.60
2 parents 78573e9 + 824d926 commit a5da79f

Some content is hidden

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

54 files changed

+1662
-211
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: 59
143-
current_patch_version: 2
144-
date_released: 2017-12-06
142+
current_minor_version: 60
143+
current_patch_version: 0
144+
date_released: 2017-12-17
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-0592---december-6"
149+
patch_version_notes: "#"
150150
# Minor release (Example #release-0431---april-25):

‎source/_components/ads.markdown

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
layout: page
3+
title: "ADS"
4+
description: Connect Home Assistant to TwinCAT devices via the ADS interface
5+
date: 2017-12-05 12:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: beckhoff.png
11+
ha_category: Hub
12+
ha_release: "0.60"
13+
ha_iot_class: "Local Push"
14+
---
15+
16+
The ADS (automation device specification) describes a device-independent and fieldbus independent interface for communication between [Beckhoff](https://www.beckhoff.com/) automation devices running [TwinCAT](http://www.beckhoff.hu/english.asp?twincat/default.htm) and other devices implementing this interface.
17+
18+
To enable ADS, add the following lines to your `configuration.yaml` file:
19+
20+
```yaml
21+
# Example configuration.yaml entry
22+
ads:
23+
device: '127.0.0.1.1.1'
24+
port: 48898
25+
```
26+
27+
{% configuration %}
28+
device:
29+
required: true
30+
description: The AMS NetId that identifies the device.
31+
type: string
32+
port:
33+
required: true
34+
description: The port that runs the AMS server on the device, typically this would be 801 or 851.
35+
type: int
36+
ip_address:
37+
required: false
38+
description: The IP address of the ADS device, if not set the first 4 bytes of the device id will be used.
39+
type: string
40+
{% endconfiguration %}
41+
42+
## {% linkable_title Service %}
43+
44+
The ADS component will register the service `write_by_name` allowing you to write a value to a variable on your ADS device.
45+
46+
```json
47+
{
48+
"adsvar": ".myvariable",
49+
"adstype": "int",
50+
"value": 123
51+
}
52+
```
53+
54+
Service parameters:
55+
56+
- **adsvar**: Name of the variable on the ADS device. To access global variables on *TwinCAT2* use a prepending dot `.myvariable`, for TwinCAT3 use
57+
`GBL.myvariable`.
58+
- **adstype**: Specify the type of the variable. Use one of the following: `int`, `byte`, `uint`, `bool`
59+
- **value**: The value that will be written in the variable.

‎source/_components/alarm_control_panel.canary.markdown

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
layout: page
3+
title: "Canary Alarm Control Panel"
4+
description: "Instructions on how to integrate your Canary devices into Home Assistant."
5+
date: 2017-12-07 22:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: canary.png
11+
ha_category: Alarm
12+
ha_release: "0.60"
13+
ha_iot_class: "Cloud Polling"
14+
---
15+
16+
The `canary` alarm control panel platform allows you to integrate your [Canary](https://canary.is) alarm system in Home Assistant.
17+
18+
To add `canary` alarm control panel to your installation, follow instructions in [Canary component](/components/canary/).

‎source/_components/alarm_control_panel.ialarm.markdown

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
layout: page
3+
title: "Antifurto365 iAlarm Control Panel"
4+
description: "Instructions how to integrate iAlarms alarms into Home Assistant."
5+
date: 2017-11-30 20:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: antifurto365-ialarm.png
11+
ha_category: Alarm
12+
ha_release: "0.60"
13+
---
14+
15+
The `ialarm` platform provides connectivity with the [Antifurto365](https://www.antifurtocasa365.it/) iAlarm alarm systems.
16+
17+
This platform supports the following services: `alarm_arm_away`, `alarm_arm_home` and `alarm_disarm`.
18+
19+
To enable this, add the following lines to your `configuration.yaml`:
20+
21+
```yaml
22+
# Example configuration.yaml entry
23+
alarm_control_panel:
24+
- platform: ialarm
25+
host: ALARM_SYSTEM_IP
26+
username: YOUR_USERNAME
27+
password: YOUR_PASSWORD
28+
```
29+
30+
{% configuration %}
31+
host:
32+
description: The IP address of the iAlarm device on your home network.
33+
required: true
34+
type: string
35+
username:
36+
description: Username used to sign into the iAlarm web client (should be admin by default).
37+
required: true
38+
type: string
39+
password:
40+
description: Password used to sign into the iAlarm web client.
41+
required: true
42+
type: string
43+
name:
44+
description: Name of device in Home Assistant.
45+
required: false
46+
type: string
47+
{% endconfiguration %}
48+

‎source/_components/alarm_control_panel.manual.markdown

Lines changed: 58 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,62 @@ Configuration variables:
2525
2626
- **name** (*Optional*): The name of the alarm. Default is "HA Alarm".
2727
- **code** (*Optional*): If defined, specifies a code to enable or disable the alarm in the frontend.
28-
- **pending_time** (*Optional*): The time in seconds of the pending time before arming the alarm. Default is 60 seconds.
28+
- **code_template** (*Optional*): If defined, returns a code to enable or disable the alarm in the frontend; an empty string disables checking the code. Inside the template, the variables **from_state** and **to_state** identify the current and desired state. Only one of **code** and **code_template** can be specified.
29+
- **delay_time** (*Optional*): The time in seconds of the pending time before triggering the alarm. Default is 0 seconds.
30+
- **pending_time** (*Optional*): The time in seconds of the pending time before effecting a state change. Default is 60 seconds.
2931
- **trigger_time** (*Optional*): The time in seconds of the trigger time in which the alarm is firing. Default is 120 seconds.
3032
- **disarm_after_trigger** (*Optional*): If true, the alarm will automatically disarm after it has been triggered instead of returning to the previous state.
31-
- **armed_home/armed_away/armed_night/triggered** (*Optional*): State specific settings
32-
- **pending_time**: State specific pending time override.
33+
- **armed_custom_bypass/armed_home/armed_away/armed_night/disarmed/triggered** (*Optional*): State specific settings
34+
- **delay_time** (*Optional*): State specific setting for **delay_time** (all states except **triggered**)
35+
- **pending_time** (*Optional*): State specific setting for **pending_time** (all states except **disarmed**)
36+
- **trigger_time** (*Optional*): State specific setting for **trigger_time** (all states except **triggered**)
3337
34-
In the config example below, armed_home state will have no pending time and triggered state will have pending time of 20 second whereas armed_away state will have a default pending time of 30 seconds.
38+
## {% linkable_title State machine %}
39+
40+
The state machine of the manual alarm component is complex but powerful. The
41+
transitions are timed according to three values, **delay_time**, **pending_time**
42+
and **trigger_time**. The values in turn can come from the default configuration
43+
variable or from a state-specific override.
44+
45+
When the alarm is armed, its state first goes to **pending** for a number
46+
of seconds equal to the destination state's **pending_time**, and then
47+
transitions to one of the "armed" states. Note that **code_template**
48+
never receives "pending" in the **to_state** variable; instead,
49+
**to_state** contains the state which the user has requested. However,
50+
**from_state** *can* contain "pending".
51+
52+
When the alarm is triggered, its state goes to **pending** for a number of
53+
seconds equal to the previous state's **delay_time** plus the triggered
54+
state's **pending_time**. Then the alarm transitions to the "triggered"
55+
states. The code is never checked when triggering the alarm, so the
56+
**to_state** variable of **code_template** cannot ever contain "triggered"
57+
either; again, **from_state** *can* contain "triggered".
58+
59+
The alarm remains in the "triggered" state for a number of seconds equal to the
60+
previous state's **trigger_time**. Then, depending on **disarm_after_trigger**,
61+
it goes back to either the previous state or **disarmed**. If the previous
62+
state's **trigger_time** is zero, the transition to "triggered" is entirely
63+
blocked and the alarm remains in the armed state.
64+
65+
Each of the settings is useful in different scenarios. **pending_time** gives
66+
you some time to leave the building (for "armed" states) or to disarm the alarm
67+
(for the "triggered" state).
68+
69+
**delay_time** can also be used to allow some time to disarm the alarm, but with
70+
more flexibility. For example, you could specify a delay time for the
71+
"armed away" state, in order to avoid triggering the alarm while the
72+
garage door opens, but not for the "armed home" state.
73+
74+
**trigger_time** is useful to disable the alarm when disarmed, but it can also
75+
be used for example to sound the siren for a shorter time during the night.
76+
77+
In the config example below:
78+
79+
- the disarmed state never triggers the alarm;
80+
81+
- the armed_home state will leave no time to leave the building or disarm the alarm;
82+
83+
- while other states state will give 30 seconds to leave the building before triggering the alarm, and 20 seconds to disarm the alarm when coming back.
3584
3685
```yaml
3786
# Example configuration.yaml entry
@@ -40,11 +89,13 @@ alarm_control_panel:
4089
name: Home Alarm
4190
code: 1234
4291
pending_time: 30
92+
delay_time: 20
93+
trigger_time: 4
94+
disarmed:
95+
trigger_time: 0
4396
armed_home:
4497
pending_time: 0
45-
triggered:
46-
pending_time: 20
47-
trigger_time: 4
98+
delay_time: 0
4899
```
49100
50101
## {% linkable_title Examples %}

‎source/_components/alarm_control_panel.manual_mqtt.markdown

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,21 @@ alarm_control_panel:
4242
4343
Configuration variables:
4444
45-
All configuration variables from the base manual alarm platform are available:
45+
The following configuration variables from the base manual alarm platform are available:
4646
4747
- **name** (*Optional*): The name of the alarm. Default is "HA Alarm".
4848
- **code** (*Optional*): If defined, specifies a code to enable or disable the alarm in the frontend. This code is not required for MQTT interactions.
49-
- **pending_time** (*Optional*): The time in seconds of the pending time before arming the alarm. Default is 60 seconds.
49+
- **code_template** (*Optional*): If defined, returns a code to enable or disable the alarm in the frontend; an empty string disables checking the code. Inside the template, the variables **from_state** and **to_state** identify the current and desired state. Only one of **code** and **code_template** can be specified.
50+
- **delay_time** (*Optional*): The time in seconds of the pending time before triggering the alarm. Default is 0 seconds.
51+
- **pending_time** (*Optional*): The time in seconds of the pending time before effecting a state change. Default is 60 seconds.
5052
- **trigger_time** (*Optional*): The time in seconds of the trigger time in which the alarm is firing. Default is 120 seconds.
5153
- **disarm_after_trigger** (*Optional*): If true, the alarm will automatically disarm after it has been triggered instead of returning to the previous state.
52-
- **armed_home|armed_away|armed_night|triggered** (*Optional*): State specific settings
53-
- **pending_time**: State specific pending time override.
54+
- **armed_home/armed_away/armed_night/disarmed/triggered** (*Optional*): State specific settings
55+
- **delay_time** (*Optional*): State specific setting for **delay_time** (all states except **triggered**)
56+
- **pending_time** (*Optional*): State specific setting for **pending_time** (all states except **disarmed**)
57+
- **trigger_time** (*Optional*): State specific setting for **trigger_time** (all states except **triggered**)
58+
59+
See the documentation for the [manual alarm platform](../alarm_control_panel.manual/) for a description.
5460
5561
Additionally, the following MQTT configuration variables are also available:
5662
@@ -62,7 +68,13 @@ Additionally, the following MQTT configuration variables are also available:
6268
- **payload_arm_away** (*Optional*): The payload to set armed-away mode on this Alarm Panel. Default is "ARM_AWAY".
6369
- **payload_arm_night** (*Optional*): The payload to set armed-night mode on this Alarm Panel. Default is "ARM_NIGHT".
6470
65-
In the config example below, armed_home state will have no pending time and triggered state will have a pending time of 20 seconds whereas armed_away state will have a default pending time of 30 seconds.
71+
In the config example below:
72+
73+
- the disarmed state never triggers the alarm;
74+
75+
- the armed_home state will leave no time to leave the building or disarm the alarm;
76+
77+
- while other states state will give 30 seconds to leave the building before triggering the alarm, and 20 seconds to disarm the alarm when coming back.
6678
6779
```yaml
6880
# Example configuration.yaml entry
@@ -71,11 +83,13 @@ alarm_control_panel:
7183
state_topic: home/alarm
7284
command_topic: home/alarm/set
7385
pending_time: 30
86+
delay_time: 20
87+
trigger_time: 4
88+
disarmed:
89+
trigger_time: 0
7490
armed_home:
7591
pending_time: 0
76-
triggered:
77-
pending_time: 20
78-
trigger_time: 4
92+
delay_time: 0
7993
```
8094
8195
## {% linkable_title Examples %}

‎source/_components/alexa.markdown

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,13 @@ footer: true
1010
logo: amazon-echo.png
1111
ha_category: Voice
1212
featured: true
13-
ha_release: 0.10
13+
ha_release: '0.10'
1414
---
1515

16+
<p class='note'>
17+
Use [Home Assistant Cloud](/components/cloud/) to integrate with Alexa without any effort.
18+
</p>
19+
1620
There are a few ways that you can use Amazon Echo and Home Assistant together.
1721

1822
- [Build custom commands to use](#i-want-to-build-custom-commands-to-use-with-echo)
@@ -325,7 +329,7 @@ Please refer to the [Amazon documentation][flash-briefing-api-docs] for more inf
325329
- All other settings are up to you
326330
- Hit "Next"
327331
- Test
328-
- Having passed all validations to reach this screen, you can now click on "< Back to All Skills" as your flash briefing is now available as in "Development" service.
332+
- Having passed all validations to reach this screen, you can now click on "< Back to All Skills" as your flash briefing is now available as in "Development" service.
329333
- To invoke your flash briefing, open the Alexa app on your phone or go to the [Alexa Settings Site][alexa-settings-site], open the "Skills" configuration section, select "Your Skills", scroll to the bottom, tap on the Flash Briefing Skill you just created, enable it, then manage Flash Briefing and adjust ordering as necessary. Finally ask your Echo for your "news","flash briefing", or "briefing".
330334

331335
[amazon-dev-console]: https://developer.amazon.com

‎source/_components/binary_sensor.ads.markdown

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
layout: page
3+
title: "ADS Binary Sensor"
4+
description: "Instructions on how to set up ADS binary sensors within Home Assistant."
5+
date: 2017-10-25 10:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: beckhoff.png
11+
ha_category: Binary Sensor
12+
ha_release: "0.60"
13+
ha_iot_class: "Local Push"
14+
---
15+
16+
The `ads` binary sensor platform can be used to monitor a boolean value on your ADS device.
17+
18+
To use your ADS device, you first have to set up your [ADS hub](/components/ads/) and then add the following to your `configuration.yaml`
19+
file:
20+
21+
```yaml
22+
# Example configuration.yaml entry
23+
binary_sensor:
24+
- platform: ads
25+
adsvar: .boolean1
26+
```
27+
28+
{% configuration %}
29+
adsvar:
30+
required: true
31+
description: The name of the variable which you want to access on the ADS device.
32+
type: string
33+
name:
34+
required: false
35+
description: An identifier for the light in the frontend.
36+
type: string
37+
device_class:
38+
required: false
39+
description: The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
40+
type: string
41+
{% endconfiguration %}

‎source/_components/binary_sensor.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ The way these sensors are displayed in the frontend can be modified in the [cust
2828
- **plug**: `On` means device is plugged in, `Off` means device is unplugged
2929
- **power**: Power, over-current, etc.
3030
- **presence**: `On` means Home, `Off` means Away
31+
- **problem**: `On` means a problem was detected, `Off` means the status is OK
3132
- **safety**: `On` means unsafe, `Off` means safe
3233
- **smoke**: `On` means smoke detected
3334
- **sound**: `On` means sound detected, `Off` means no sound

0 commit comments

Comments
 (0)