Skip to content
This repository was archived by the owner on Mar 20, 2019. It is now read-only.

Commit ae7e28d

Browse files
balloobballoob
authored
Merge pull request home-assistant#3416 from home-assistant/release-0-54
Release 0 54
2 parents 2676c87 + 45c1dee commit ae7e28d

Some content is hidden

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

47 files changed

+1306
-59
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: 53
143-
current_patch_version: 1
144-
date_released: 2017-09-12
142+
current_minor_version: 54
143+
current_patch_version: 0
144+
date_released: 2017-09-23
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-0531---september-11"
149+
patch_version_notes: "#"
150150
# Minor release (Example #release-0431---april-25):

‎source/_components/abode.markdown

Lines changed: 77 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,22 +19,91 @@ Please visit the [Abode website](https://goabode.com/) for further information a
1919

2020
There is currently support for the following device types within Home Assistant:
2121

22-
- [Alarm Control Panel](/components/alarm_control_panel.abode/): Reports on current alarm status and can be used to arm/disarm the system
23-
- [Binary Sensor](/components/binary_sensor.abode/): Reports on `Door Contacts` (open or closed), `Motion Camera` (motion detected or not), `Water Sensors` (detected or not), `Keypad` (online or not), `Glass Break` (online or not), `Status Display` (online or not)
24-
- [Cover](/components/cover.abode/): Reports on `Secure Barriers` (open or closed) and can be used to open/close the cover
25-
- [Lock](/components/cover.abode/): Reports on `Door Locks` (locked or unlocked) and can be used to lock/unlock the door
26-
- [Switch](/components/switch.abode/): Reports on `Power Switch Sensors` (on or off) and can be used to turn the power switch sensor on/off
22+
- [Alarm Control Panel](/components/alarm_control_panel.abode/): Reports on the current alarm status and can be used to arm and disarm the system.
23+
- [Binary Sensor](/components/binary_sensor.abode/): Reports on `Quick Actions`, `Door Contacts`, `Connectivity` sensors (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors.
24+
- [Camera](/components/camera.abode/): Reports on `Camera` devices and will download and show the latest captured still image.
25+
- [Cover](/components/cover.abode/): Reports on `Secure Barriers` and can be used to open and close the cover.
26+
- [Lock](/components/cover.abode/): Reports on `Door Locks` and can be used to lock and unlock the door.
27+
- [Light](/components/light.abode/): Reports on `Dimmer` lights and can be used to dim, change color, or turn the light on and off.
28+
- [Switch](/components/switch.abode/): Reports on `Power Switch` devices and can be used to turn the power switch on and off. Also reports on `Automations` set up in the Abode system and allows you to activate or deactivate them.
2729

28-
An `abode` section must be present in the `configuration.yaml` file and contain the following options as required:
30+
## {% linkable_title Configuration %}
31+
32+
To use Abode devices in your installation, add the following `abode` section to your `configuration.yaml` file:
2933

3034
```yaml
3135
# Example configuration.yaml entry
3236
abode:
3337
username: abode_username
3438
password: abode_password
39+
name: Abode Alarm System
40+
polling: False
41+
exclude:
42+
- 'ZW:0000000034'
43+
- 'RF:00000011'
44+
lights:
45+
- 'ZW:0000000022'
3546
```
3647
3748
Configuration variables:
3849
39-
- **username** (*Required*): Username for the Abode account.
40-
- **password** (*Required*): Password for Abode account.
50+
- **username** (*Required*): Username for your Abode account.
51+
- **password** (*Required*): Password for your Abode account.
52+
- **name** (*Optional*): The name for your alarm controller.
53+
- **polling** (*Optional*): Enable polling if cloud push updating is less reliable. Will update the devices once every 30 seconds. Defaults to False.
54+
- **exclude** (*Optional*): A list of devices to exclude from Home Assistant by their Abode `device_id`, found within the component attributes.
55+
- **lights** (*Optional*): A list of switch devices that Home Assistant should treat as lights by the switches Abode `device_id`, found within the component attributes.
56+
57+
## {% linkable_title Events %}
58+
59+
There are a number of events that can be triggered from Abode. They are grouped into the below events:
60+
61+
- **abode_alarm**: Fired when an alarm event is triggered from Abode. This includes Smoke, CO, Panic, and Burglar alarms.
62+
- **abode_alarm_end**: Fired when an alarm end event is triggered from Abode.
63+
- **abode_automation**: Fired when an Automation is triggered from Abode.
64+
- **abode_panel_fault**: Fired when there is a fault with the Abode hub. This includes events like loss of power, low battery, tamper switches, polling failures, and signal interference.
65+
- **abode_panel_restore**: Fired when the panel fault is restored.
66+
67+
All events have the fields:
68+
69+
Field | Description
70+
----- | -----------
71+
`device_id` | The Abode device ID of the event.
72+
`device_name` | The Abode device name of the event.
73+
`device_type` | The Abode device type of the event.
74+
`event_code` | The event code of the event.
75+
`event_name` | The name of the event.
76+
`event_type` | The type of the event.
77+
`event_utc` | The UTC timestamp of the event.
78+
`user_name` | The Abode user that triggered the event, if applicable.
79+
`date` | The date of the event in the format `MM/DD/YYYY`.
80+
`time` | The time of the event in the format `HH:MM AM`.
81+
82+
There is a unique list of known event_codes that can be found [here](https://github.com/MisterWil/abodepy/files/1262019/timeline_events.txt).
83+
84+
## {% linkable_title Services %}
85+
86+
### {% linkable_title Service `change_setting` %}
87+
88+
Change settings on your Abode system. For a full list of settings and valid values, consult the [AbodePy settings section](https://github.com/MisterWil/abodepy/blob/master/README.rst#settings).
89+
90+
| Service data attribute | Optional | Description |
91+
| ---------------------- | -------- | ----------- |
92+
| `setting` | No | The setting you wish to change.
93+
| `value` | No | The value you wish to change the setting to.
94+
95+
### {% linkable_title Service `capture_image` %}
96+
97+
Request a new still image from your Abode IR camera.
98+
99+
| Service data attribute | Optional | Description |
100+
| ---------------------- | -------- | ----------- |
101+
| `entity_id` | No | String or list of strings that point at `entity_id`s of Abode cameras.
102+
103+
### {% linkable_title Service `trigger_quick_action` %}
104+
105+
Trigger a quick action automation on your Abode system.
106+
107+
| Service data attribute | Optional | Description |
108+
| ---------------------- | -------- | ----------- |
109+
| `entity_id` | No | String or list of strings that point at `entity_id`s of binary_sensors that represent your Abode quick actions.

‎source/_components/alarm_control_panel.manual.markdown

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,24 @@ Configuration variables:
2828
- **pending_time** (*Optional*): The time in seconds of the pending time before arming the alarm. Default is 60 seconds.
2929
- **trigger_time** (*Optional*): The time in seconds of the trigger time in which the alarm is firing. Default is 120 seconds.
3030
- **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+
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.
35+
36+
```yaml
37+
# Example configuration.yaml entry
38+
alarm_control_panel:
39+
- platform: manual
40+
name: Home Alarm
41+
code: 1234
42+
pending_time: 30
43+
armed_home:
44+
pending_time: 0
45+
triggered:
46+
pending_time: 20
47+
trigger_time: 4
48+
```
3149
3250
## {% linkable_title Examples %}
3351

‎source/_components/alarm_control_panel.satel_integra.markdown

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
layout: page
3+
title: "Satel Integra Alarm Control Panel"
4+
description: "Instructions how to setup the Satel Integra control panel within Home Assistant."
5+
date: 2017-09-07 13:28
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: satel.jpg
11+
ha_category: Alarm
12+
ha_release: 0.54
13+
ha_iot_class: "Local Push"
14+
---
15+
16+
17+
The `satel_integra` alarm control panel platform allows you to control your [SatelIntegra](http://www.satel.pl/en/) alarms.
18+
19+
The requirement is that you have setup your [SatelIntegra hub](/components/satel_integra/).
20+

‎source/_components/axis.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ Configuration variables:
5757
- **username** (*Optional*): The username to your Axis device. Default 'root'.
5858
- **password** (*Optional*): The password to your Axis device. Default 'pass'.
5959
- **trigger_time** (*Optional*): Minimum time (in seconds) a sensor should keep its positive value. Default 0.
60+
- **http_port** (*Optional*): Configure port web server of device is accessible from. Default 80.
6061
- **location** (*Optional*): Physical location of your Axis device. Default not set.
6162
- **include** (*Required*): This cannot be empty else there would be no use adding the device at all.
6263
- **camera**: Stream MJPEG video to Home Assistant.

‎source/_components/binary_sensor.abode.markdown

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ ha_iot_class: "Cloud Push"
1515

1616
The `abode` security control panel platform allows you to control your [Abode](https://goabode.com/) alarms.
1717

18-
This component will automatically add `Door Contact`, `Motion Camera`, `Water Sensor`, `Keypad`, `Glass Break`, and `Status Display` binary sensors that are configured in your Abode account.
18+
This component will add `Door Contacts`, `Connectivity` sensors (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors.
19+
20+
This component will also list all Abode `Quick Actions` that are set up. You can trigger these quick actions by passing the `entity_id` of your quick action binary sensor to the [trigger_quick_action service](/components/abode/#trigger_quick_action).
1921

2022
The requirement is that you have setup your [Abode hub](/components/abode/).

‎source/_components/binary_sensor.doorbird.markdown

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
layout: page
3+
title: "DoorBird Binary Sensor"
4+
description: "Instructions how to integrate DoorBird video doorbell state into Home Assistant."
5+
date: 2017-08-06 11:30
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: doorbird.png
11+
ha_category: Binary Sensor
12+
ha_release: "0.54"
13+
ha_iot_class: "Local Polling"
14+
---
15+
16+
The `doorbird` binary sensor platform allows Home Assistant to monitor when your [DoorBird](http://www.doorbird.com/) doorbell rings.
17+
18+
<p class='note'>
19+
You must have the [DoorBird component](/components/doorbird/) configured to use this binary sensor.
20+
</p>
21+
22+
To enable the binary sensor, add the following to your `configuration.yaml` file:
23+
24+
```yaml
25+
# Example configuration.yaml entry
26+
binary_sensor:
27+
- platform: doorbird
28+
```

‎source/_components/binary_sensor.satel_integra.markdown

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
layout: page
3+
title: "Satel Integra Binary Sensor"
4+
description: "Instructions how to integrate Satel Integra binary sensors into Home Assistant."
5+
date: 2017-09-07 13:28
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: satel.jpg
11+
ha_category: Binary Sensor
12+
ha_release: 0.54
13+
ha_iot_class: "Local Push"
14+
---
15+
16+
The `satel_integra` binary sensor allows you to monitor your [SatelIntegra](http://www.satel.pl/en/) alarm zones (inputs).
17+
18+
Check the [type/class](/components/binary_sensor/) list for a possible visualization of your zone.
19+
20+
The requirement is that you have setup your [SatelIntegra hub](/components/satel_integra/).

‎source/_components/binary_sensor.xiaomi.markdown renamed to ‎source/_components/binary_sensor.xiaomi_aqara.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ ha_iot_class: "Local Push"
1414
---
1515

1616

17-
The `xiaomi` binary sensor platform allows you to get data from your [Xiaomi](http://www.mi.com/en/) binary sensors.
17+
The `xiaomi aqara` binary sensor platform allows you to get data from your [Xiaomi](http://www.mi.com/en/) binary sensors.
1818

19-
The requirement is that you have setup the [`xiaomi` component](/components/xiaomi/).
19+
The requirement is that you have setup the [`xiaomi aqara` component](/components/xiaomi_aqara/).
2020

2121

2222
### {% linkable_title Type of sensors supported %}
@@ -118,7 +118,7 @@ The requirement is that you have setup the [`xiaomi` component](/components/xiao
118118
data:
119119
title: Fire alarm!
120120
message: Fire/Smoke detected!
121-
- service: xiaomi.play_ringtone
121+
- service: xiaomi_aqara.play_ringtone
122122
data:
123123
gw_mac: xxxxxxxxxxxx
124124
ringtone_id: 2
@@ -174,7 +174,7 @@ Available events are `single`, `double`, `hold`, `long_click_press` and `long_cl
174174
entity_id: binary_sensor.switch_158d000xxxxxc2
175175
click_type: long_click_press
176176
action:
177-
service: xiaomi.play_ringtone
177+
service: xiaomi_aqara.play_ringtone
178178
data:
179179
gw_mac: xxxxxxxxxxxx
180180
ringtone_id: 8

‎source/_components/calendar.todoist.markdown

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
---
2+
layout: page
3+
title: "Todoist"
4+
description: "Instructions on how to integrate Todoist into Home Assistant."
5+
date: 2017-08-31 2:22
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: todoist.png
11+
ha_category: Calendar
12+
ha_iot_class: "Cloud Polling"
13+
ha_release: 0.54
14+
---
15+
16+
17+
This platform allows you to connect to your [Todoist Projects](https://todoist.com) and generate binary sensors. A different sensor will be created for each individual project, or you can specify "custom" projects which match against criteria you set (more on that below). These sensors will be `on` if you have a task due in that project or `off` if all the tasks in the project are completed or if the project doesn't have any tasks at all. All tasks get updated roughly every 15 minutes.
18+
19+
### {% linkable_title Prerequisites %}
20+
21+
You need to determine your Todoist API token. This is fairly simple to do; just go [to the Integrations section on your Todoist settings page](https://todoist.com/Users/viewPrefs?page=authorizations) and find the section labeled "API token" at the bottom of the page. Copy that token and use it in your configuration file.
22+
23+
### {% linkable_title Basic Setup %}
24+
25+
To integrate Todoist in Home Assistant, add the following section to your `configuration.yaml` file:
26+
27+
```yaml
28+
# Example configuration.yaml entry
29+
calendar:
30+
- platform: todoist
31+
token: API_token_created_from_steps_above
32+
```
33+
34+
Configuration variables:
35+
36+
- **token** (*Required*): The API token used to authorize Home Assistant to access your projects.
37+
- **custom_projects** (*Optional*): Details on any "custom" binary sensor projects you want to create.
38+
- **name** (*Required*): The name of your custom project. Only required if you specify that you want to create a custom project.
39+
- **due_date_days** (*Optional*): Only include tasks due within this many days. If you don't have any tasks with a due date set, this returns nothing.
40+
- **labels** (*Optional*): Only include tasks with at least one of these labels (i.e., this works as an `or` statement)..
41+
- **include_projects** (*Optional*): Only include tasks in these projects. Tasks in all other projects will be ignored.
42+
43+
44+
### {% linkable_title Custom Projects %}
45+
Creating custom projects is super-easy and quite powerful. All you need to run the basic Todoist projects is your API token, but if you wanted, you could go even deeper. Here's an example:
46+
47+
```yaml
48+
# Example configuration.yaml entry
49+
calendar:
50+
- platform: todoist
51+
token: !secret todoist_token
52+
custom_projects:
53+
- name: 'All Projects'
54+
- name: 'Due Today'
55+
due_date_days: 0
56+
- name: 'Due This Week'
57+
due_date_days: 7
58+
- name: 'Math Homework'
59+
labels:
60+
- Homework
61+
include_projects:
62+
- Mathematical Structures II
63+
- Calculus II
64+
```
65+
66+
(See [here](https://home-assistant.io/docs/configuration/secrets/) for more details about what that `!secret` does -- it's not exclusive to Todoist, and can help keep your API keys and passwords a little safer!)
67+
68+
As you can see, there are 4 custom projects here:
69+
70+
- A project containing *all* of the tasks on this account.
71+
72+
- A project containing *all* the tasks on this account that are due today.
73+
74+
- A project containing *all* the tasks on this account due within the next week.
75+
76+
- A project containing everything with the label "Homework", taking only 2 projects into account.
77+
78+
You can mix-and-match these attributes to create all sorts of custom projects. You can even use [IFTTT](https://ifttt.com/todoist) to create a task with a certain label, then have Home Assistant do some kind of automation when a task with that label comes due.
79+
80+
Home Assistant does its best to determine what task in each project is "most" important, and it's that task which has its state reported. You can access the other tasks you have due soon via the `all_tasks` array (see below).
81+
82+
### {% linkable_title Sensor attributes %}
83+
84+
- **offset_reached**: Not used.
85+
86+
- **all_day**: `True` if the reported task doesn't have a due date. `False` if there is a due date set.
87+
88+
- **message**: The title of the "most important" task coming up in this project.
89+
90+
- **description**: A URL pointing to the task on the Todoist website.
91+
92+
- **location**: Not used.
93+
94+
- **start_time**: The last time the Todoist component got updated. Usually within the last 15 minutes.
95+
96+
- **end_time**: When the task is due.
97+
98+
- **all_tasks**: A list of all tasks in this project, sorted from most important to least important.
99+
100+
- **priority**: The priority Todoist reports this task as having. 1 means lowest priority, 4 means highest. Note that this is the **opposite** of how things are displayed in the Todoist app!
101+
102+
- **task_comments**: Any comments added to this task.
103+
104+
- **task_labels**: All labels associated with this task.
105+
106+
- **overdue**: Whether the reported task is past its due date.
107+
108+
- **due_today**: Whether the reported task is due today.
109+
110+
### {% linkable_title Services %}
111+
112+
Todoist also comes with access to a service, `todoist.new_task`. This service can be used to create a new Todoist task. You can specify labels and a project, or you can leave them blank, and the task will go to your "Inbox" project.
113+
114+
Here's an example JSON payload:
115+
116+
```json
117+
{
118+
"content": "Pick up the mail",
119+
"project": "Errands",
120+
"labels":"Homework,School",
121+
"priority":3,
122+
"due_date":"2017-09-12 14:00"
123+
}
124+
```
125+
126+
- **content** (*Required*): The name of the task you want to create.
127+
128+
- **project** (*Optional*): The project to put the task in.
129+
130+
- **labels** (*Optional*): Any labels you want to add to the task, separated by commas.
131+
132+
- **priority** (*Optional*): The priority of the task, from 1-4. Again, 1 means least important, and 4 means most important.
133+
134+
- **due_date** (*Optional*): When the task should be due, in either YYYY-MM-DD format or YYYY-MM-DD HH:MM format.
135+
136+
Note that there's (currently) no way to mark tasks as done through Home Assistant; task names do not necessarily have to be unique, so you could find yourself in a situation where you close the wrong task.

0 commit comments

Comments
 (0)