Skip to content

Commit 290e950

Browse files
authored
Merge pull request home-assistant#5259 from home-assistant/rc
0.68.0
2 parents 16f2259 + c099237 commit 290e950

Some content is hidden

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

48 files changed

+1347
-47
lines changed

_config.yml

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

140140
# Home Assistant release details
141141
current_major_version: 0
142-
current_minor_version: 67
143-
current_patch_version: 1
144-
date_released: 2018-04-17
142+
current_minor_version: 68
143+
current_patch_version: 0
144+
date_released: 2018-04-27
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.

source/_components/binary_sensor.hive.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ ha_iot_class: "Cloud Polling"
1616

1717
The 'hive' binary sensor component integrates your Hive sensors into Home Assistant.
1818

19-
The Hive sensor component supports the following Hive products:
19+
The Hive binary sensor component supports the following Hive products:
2020
- **Hive Window or Door Sensor**
2121
- **Hive Motion Sensor**
2222

source/_components/binary_sensor.markdown

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,8 @@ The way these sensors are displayed in the frontend can be modified in the [cust
3939
- **window**: `On` means open, `Off` means closed
4040

4141
For analog sensors please check the [component overview](/components/#sensor).
42+
43+
<p class='img'>
44+
<img src='/images/screenshots/binary_sensor_classes_icons.png' />
45+
Example of various device classes icons in `On` and `Off` state.
46+
</p>
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
layout: page
3+
title: "QwikSwitch Binary Sensor"
4+
description: "Instructions on how to integrate Qwikswitch dimmers and relays as sensors into Home Assistant."
5+
date: 2016-05-04 00:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: qwikswitch.png
11+
ha_category: Sensor
12+
ha_iot_class: "Local Push"
13+
ha_release: "0.68"
14+
---
15+
16+
The `qwikswitch` binary_sensor platform allows you to use your [QwikSwitch](http://www.qwikswitch.co.za/) sensors within Home Assistant.
17+
18+
The platform is configured through the [QwikSwitch component](/components/qwikswitch/).

source/_components/bmw_connected_drive.markdown

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ha_category: Hub
1212
ha_release: 0.64
1313
---
1414

15-
This component lets you retrieve data on your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account and a Connected Drive enabled vehicle for this to work.
15+
This component lets you retrieve data on your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account, and a Connected Drive enabled vehicle for this to work.
1616

1717
For compatibility with your BMW vehicle check the [bimmer_connected page](https://github.com/m1n3rva/bimmer_connected) on github.
1818

@@ -52,6 +52,38 @@ bmw_connected_drive:
5252
type: string
5353
{% endconfiguration %}
5454

55+
## {% linkable_title Services %}
56+
57+
The `bmw_connected_drive` component offers several services. In case you need to provide the vehicle identification number (VIN) as a parameter, you can see the VIN in the attributes of the device tracker for the vehicle. The VIN is a 17 digit alphanumeric string, e.g., `WBANXXXXXX1234567`.
58+
59+
Using these services will impact the state of your vehicle. So use these services with care!
60+
61+
### {% linkable_title Locking and unlocking %}
62+
63+
The vehicle can be locked and unlocked via the lock component that is created automatically for each vehicle. Before invoking these services, make sure it's safe to lock/unlock the vehicle in the current situation.
64+
65+
### {% linkable_title Air condition %}
66+
67+
The air condition of the vehicle can be activated with the service `bmw_connected_drive.activate_air_conditioning`.
68+
69+
What exactly is started here depends on the type of vehicle. It might range from just ventilation over auxiliary heating to real air conditioning. If your vehicle is equipped with auxiliary heating, only trigger this service if the vehicle is parked in a location where it is safe to use it (e.g., not in an underground parking or closed garage).
70+
71+
The vehicle is identified via the parameter `vin`.
72+
73+
### {% linkable_title Sound the horn %}
74+
75+
The service `bmw_connected_drive.sound_horn` sounds the horn of the vehicle. Use this feature responsibly, as it might annoy your neighbors. The vehicle is identified via the parameter `vin`.
76+
77+
### {% linkable_title Flash the lights %}
78+
79+
The service `bmw_connected_drive.light_flash' flashes the lights of the vehicle. The vehicle is identified via the parameter `vin`.
80+
81+
### {% linkable_title Update the state %}
82+
83+
The service `bmw_connected_drive.update_state`fetches the last state of the vehicles of all your accounts from the BMW server. This does *not* trigger an update from the vehicle; it gets the data from the BMW servers. So this service does *not* interact with your vehicles.
84+
85+
This service does not require any attributes.
86+
5587
## {% linkable_title Disclaimer %}
5688

5789
This software is not affiliated with or endorsed by BMW Group.

source/_components/calendar.google.markdown

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,8 @@ Variables:
9595
- **track**: (*Required*): Should we create a sensor `True` or ignore it `False`?
9696
- **search**: (*Optional*): If set will only trigger for matched events.
9797
- **offset**: (*Optional*): A set of characters that precede a number in the event title for designating a pre-trigger state change on the sensor. (Default: `!!`)
98-
98+
 - **ignore_availablilty**: (*Optional*): Should we respect `free`/`busy` flags? (Defaults to `true`)
99+
 
99100
From this we will end up with the binary sensors `calendar.test_unimportant` and `calendar.test_important` which will toggle themselves on/off based on events on the same calendar that match the search value set for each. You'll also have a sensor `calendar.test_everything` that will not filter events out and always show the next event available.
100101

101102
But what if you only wanted it to toggle based on all events? Just leave out the *search* parameter.

source/_components/calendar.todoist.markdown

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ Home Assistant does its best to determine what task in each project is "most" im
111111

112112
Todoist also comes with access to a service, `calendar.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.
113113

114-
Here's an example JSON payload:
114+
Here are two example JSON payloads resulting in the same task:
115115

116116
```json
117117
{
@@ -123,6 +123,17 @@ Here's an example JSON payload:
123123
}
124124
```
125125

126+
```json
127+
{
128+
"content": "Pick up the mail",
129+
"project": "Errands",
130+
"labels":"Homework,School",
131+
"priority":3,
132+
"due_date_string":"tomorrow at 14:00",
133+
"due_date_lang":"en"
134+
}
135+
```
136+
126137
- **content** (*Required*): The name of the task you want to create.
127138

128139
- **project** (*Optional*): The project to put the task in.
@@ -131,6 +142,11 @@ Here's an example JSON payload:
131142

132143
- **priority** (*Optional*): The priority of the task, from 1-4. Again, 1 means least important, and 4 means most important.
133144

134-
- **due_date** (*Optional*): When the task should be due, in either YYYY-MM-DD format or YYYY-MM-DD HH:MM format.
145+
- **due_date_string** (*Optional*): When the task should be due, in [natural language](https://support.todoist.com/hc/en-us/articles/205325931-Dates-and-Times). Mutually exclusive with `due_date`
146+
147+
- **due_date_lang** (*Optional*): When `due_date_string` is set, it is posisble to set the language.
148+
Valid languages are: `en`, `da`, `pl`, `zh`, `ko`, `de`, `pt`, `ja`, `it`, `fr`, `sv`, `ru`, `es`, `nl`
149+
150+
- **due_date** (*Optional*): When the task should be due, in either YYYY-MM-DD format or YYYY-MM-DD HH:MM format. Mutually exclusive with `due_date_string`.
135151

136152
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.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
layout: page
3+
title: "Fritzbox Thermostat"
4+
description: "Instructions on how to integrate the AVM Fritzbox thermostat."
5+
date: 2017-11-12 17:10
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: avm.png
11+
ha_category: Climate
12+
ha_release: 0.68
13+
ha_iot_class: "Local Polling"
14+
---
15+
16+
<p class='note'>
17+
To get AVM fritzbox thermostat follow the instructions for the general [Fritzbox](/components/fritzbox/).
18+
</p>
19+
20+
### {% linkable_title Attributes %}
21+
22+
The are several attributes that can be useful for automations and templates.
23+
24+
| Attribute | Description |
25+
| --------- | ----------- |
26+
| `device_locked` | The state of the key lock at the device.
27+
| `locked` | The state of the lock for configuring the device via the app or the Fritzbox web interface.
28+
| `low_battery` | The low battery state indication.
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
layout: page
3+
title: "Modbus"
4+
description: "Instructions how to integrate a Modbus thermostat within Home Assistant."
5+
date: 2018-01-29 9:35
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: modbus.png
11+
ha_category: Thermostat
12+
ha_release: 0.68
13+
ha_iot_class: "Local Polling"
14+
---
15+
16+
17+
The `modbus` thermostat allows you to use a sensor value (current temperature)
18+
and target value (target temperature) from [Modbus](http://www.modbus.org/)
19+
registers.
20+
21+
To use your Modbus thermostat in your installation, add the following to your `configuration.yaml` file:
22+
23+
```yaml
24+
climate:
25+
- platform: modbus
26+
name: Watlow F4T
27+
slave: 1
28+
target_temp_register: 2782
29+
current_temp_register: 27586
30+
31+
```
32+
33+
{% configuration %}
34+
name:
35+
description: Name of the device
36+
required: true
37+
type: string
38+
slave:
39+
description: The number of the slave (Optional for tcp and upd Modbus, use 1).
40+
required: true
41+
type: int
42+
target_temp_register:
43+
description: Register number for target temperature (Setpoint).
44+
required: true
45+
type: int
46+
current_temp_register:
47+
description: Register number for current temperature (Process value).
48+
required: true
49+
type: int
50+
data_type:
51+
description: Response representation (int, uint, float, custom). If float selected, value will converted to IEEE 754 floating point format.
52+
Default float.
53+
required: false
54+
type: string
55+
count:
56+
description: Number of registers to read.
57+
required: false
58+
type: int
59+
precision:
60+
description: Number of valid decimals, default 0.
61+
required: false
62+
type: int
63+
{% endconfiguration %}
64+
65+
66+
### {% linkable_title Services %}
67+
68+
| Service | Description |
69+
| ------- | ----------- |
70+
| set_temperature | Set Temperature. Requires `value` to be passed in, which is the desired target temperature. `value` should be in the same type as `data_type` |

source/_components/cover.wink.markdown

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,20 @@ ha_release: 0.13
1313
ha_iot_class: "Cloud Polling"
1414
---
1515

16-
Wink cover/garage door functionality depends on the product you're using. With GoControl/Linear Home Assistant can open, close, and view state. Chamberlain is currently limited to view only. Meaning Home Assistant will only show the current state of the door and control has been disabled (by Chamberlain). If you have a Chamberlain garage door, and would like to control it via Home Assistant, please contact Chamberlain and request that they re-enabled third-party control.
16+
Wink Cover garage door functionality varies on the product. Home Assistant can open, close, and view state of GoControl/Linear openers. For Chamberlain MyQ-enabled openers, Home Assistant is limited to show current state (open or closed) only using this Wink cover. This restriction was imposed by Chamberlain for third party control. Wink suggests that MyQ customers should contact Chamberlain directly to inquire about expanding permissions.
1717

18-
The following quote is from Wink.
19-
20-
> As part of our agreement with Chamberlain, third-party access to control Chamberlain garage doors has been restricted. Please contact Chamberlain directly to inquire about permissions.
18+
The [MyQ Cover](/components/cover.myq/) does provide full functionality for opening and closing Chamberlain MyQ-enabled garage doors. If installed along with the Wink Component, a duplicate garage door entity may exist. In that case, the semi-functional Wink garage door entity can be hidden via customize.yaml.
2119

2220
The requirement is that you have setup [Wink](/components/wink/).
2321

24-
2522
### {% linkable_title Supported cover devices %}
2623

2724
- Bali window treatments
2825
- Lutron shades
2926
- Pella motorized blinds and shades
3027
- GoControl garage door opener
31-
- Chamberlain (Limited functionality) (No Wink hub required)
28+
- Chamberlain MyQ (Limited functionality) (No Wink hub required)
3229

3330
<p class='note'>
3431
The above devices are confirmed to work, but others may work as well.
3532
</p>
36-

source/_components/device_tracker.xiaomi_miio.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ comments: false
88
sharing: true
99
footer: true
1010
logo: xiaomi.png
11-
ha_category: Sensor
11+
ha_category: Presence Detection
1212
ha_version: 0.67
1313
ha_iot_class: "Local Polling"
1414
---

source/_components/discovery.markdown

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Home Assistant can discover and automatically configure [zeroconf](https://en.wi
2323
* [DirecTV receivers](/components/media_player.directv/)
2424
* [Frontier Silicon internet radios](/components/media_player.frontier_silicon/)
2525
* [Google Cast](/components/media_player.cast/)
26+
* [HomeKit](/components/homekit_controller/)
2627
* [IKEA Trådfri (Tradfri)](/components/tradfri/)
2728
* [Linn / Openhome](/components/media_player.openhome/)
2829
* [Logitech Harmony Hub](/components/remote.harmony/)
@@ -50,6 +51,8 @@ discovery:
5051
ignore:
5152
- sonos
5253
- samsung_tv
54+
enable:
55+
- homekit
5356
```
5457
5558
Configuration variables:
@@ -85,6 +88,12 @@ Valid values for ignore are:
8588
* `yamaha`: Yamaha media player
8689
* `yeelight`: Yeelight Sunflower bulb
8790

91+
- **enable** (*Optional*): A list of platforms not enabled by default that `discovery` should discover.
92+
93+
Valid values for enable are:
94+
95+
* `homekit`: HomeKit accessories
96+
8897
<p class='note'>
8998
Home Assistant must be on the same network as the devices for uPnP discovery to work.
9099
If running Home Assistant in a [Docker container](/docs/installation/docker/) use switch `--net=host` to put it on the host's network.

source/_components/eufy.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: "Eufy"
4+
description: "Instructions on how to integrate Eufy devices into Home Assistant."
5+
date: 2018-04-09 19:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: eufy.png
11+
ha_category: Hub
12+
ha_release: 0.68
13+
---
14+
15+
The `eufy` component is the main component to integrate various [eufy](http://https://www.eufylife.com/) devices with Home Assistant.
16+
17+
Supported devices will be discovered after the `eufy` component is configured:
18+
19+
```yaml
20+
# Example configuration.yaml entry
21+
eufy:
22+
username: testuser@domain
23+
password: p4ssw0rd
24+
```
25+
26+
where username and password are the ones configured in the EufyHome app. Alternately, Eufy devices that are not discoverable can be statically configured.
27+
28+
```yaml
29+
eufy:
30+
devices:
31+
- address: 192.168.1.10
32+
access_token: 1234567890abcdef
33+
type: T1012
34+
name: Smart Light
35+
- address: 192.168.1.11
36+
access_token: abcdef1234567890
37+
type: T1201
38+
name: Smart Switch
39+
```
40+
41+
access_token can be obtained by running:
42+
43+
```
44+
curl -H "Content-Type: application/json" -d '{"client_id":"eufyhome-app", "client_Secret":"GQCpr9dSp3uQpsOMgJ4xQ", "email":"USERNAME", "password":"PASSWORD"}' https://home-api.eufylife.com/v1/user/email/login | jq
45+
```
46+
47+
replacing USERNAME and PASSWORD with the Eufy username and password. This will give an access_token. Then run:
48+
49+
```
50+
curl -H token:TOKEN -H category:Home https://home-api.eufylife.com/v1/device/list/devices-and-groups | jq
51+
```
52+
53+
replacing TOKEN with the access_token from the previous command. This will provide the local_code for each device.
54+

0 commit comments

Comments
 (0)