Skip to content

Commit 64a3ac8

Browse files
committed
Merge branch 'rc' into current
2 parents 3488118 + 8a5b3f2 commit 64a3ac8

Some content is hidden

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

42 files changed

+1294
-161
lines changed

_config.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -139,14 +139,14 @@ social:
139139

140140
# Home Assistant release details
141141
current_major_version: 0
142-
current_minor_version: 70
143-
current_patch_version: 1
144-
date_released: 2018-05-31
142+
current_minor_version: 71
143+
current_patch_version: 0
144+
date_released: 2018-06-08
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-0701---may-31"
149+
patch_version_notes: "#"
150150
# Minor release (Example #release-0431---april-25):
151151

152152
# Date we moved to Discourse for comments
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
layout: page
3+
title: "Hunter Hydrawise Binary Sensor"
4+
description: "Instructions on how to integrate your Hunter Hydrawise Wi-Fi irrigation control system within Home Assistant."
5+
date: 2018-04-11 08:02
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: hydrawise_logo.png
11+
ha_category: Binary Sensor
12+
ha_release: 0.71
13+
ha_iot_class: Cloud Polling
14+
---
15+
16+
Before setting up the [Hunter Hydrawise](https://hydrawise.com) binary sensors please follow the instructions for setting up the [Hydrawise hub](/components/hydrawise) component.
17+
18+
Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file:
19+
20+
```yaml
21+
# Example configuration.yaml entry
22+
binary_sensor:
23+
- platform: hydrawise
24+
```
25+
26+
{% configuration %}
27+
monitored_conditions:
28+
description: The binary sensors that should be displayed on the frontend.
29+
required: false
30+
type: list
31+
default: All binary sensors are enabled.
32+
keys:
33+
is_watering:
34+
description: The binary sensor is `on` when the zone is actively watering.
35+
rain_sensor:
36+
description: Is `on` when the rain_sensor (if installed on the controller) is active (wet).
37+
status:
38+
description: This will indicate `on` when there is a connection to the Hydrawise cloud. It is not an indication of whether the irrigation controller hardware is online.
39+
{% endconfiguration %}
40+
41+
Finish the configuration by visiting the [Hydrawise sensor](/components/sensor.hydrawise/) and [Hydrawise switch](/components/switch.hydrawise/) documentation.

source/_components/binary_sensor.nest.markdown

+2
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ Configuration variables:
3939

4040
The following conditions are available by device:
4141

42+
- Nest Home:
43+
- away
4244
- Nest Thermostat:
4345
- online
4446
- fan
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
layout: page
3+
title: "RainMachine Binary Sensor"
4+
description: "Instructions on how to use RainMachine binary sensors with Home Assistant."
5+
date: 2018-05-06 21:26
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: rainmachine.png
11+
ha_category: Binary Sensor
12+
ha_iot_class: "Cloud Polling"
13+
ha_release: 0.71
14+
---
15+
16+
The `rainmachine` binary sensor platform allows you to view crucial sensor data
17+
within a [RainMachine smart Wi-Fi sprinkler controller](http://www.rainmachine.com/).
18+
19+
<p class='note'>
20+
You must have the [RainMachine component](https://www.home-assistant.io/components/rainmachine/)
21+
configured to use this platform. After configuring that component, binary
22+
sensors automatically appear.
23+
</p>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
layout: page
3+
title: "HomematicIP Cloud Climate"
4+
description: "Instructions on how to integrate HomematicIP climate within Home Assistant."
5+
date: 2018-05-18 22:40
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: homematicip_cloud.png
11+
ha_category: Sensor
12+
ha_release: 0.71
13+
ha_iot_class: "Cloud Push"
14+
---
15+
16+
The `homematicip_cloud` climate platform allows you to control
17+
[HomematicIP](https://www.homematic-ip.com) climate through Home Assistant.
18+
19+
Devices will be configured automatically. Please refer to the
20+
[component](/components/homematicip_cloud/) configuration on how to setup
21+
HomematicIP Cloud.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
layout: page
3+
title: "Ryobi GDO Cover"
4+
description: "Instructions on how to integrate Ryobi Garage Door Opener (RyobiGDO) within Home Assistant."
5+
date: 2018-04-22 09:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: ryobi.png
11+
ha_category: Cover
12+
ha_release: 0.71
13+
ha_iot_class: "Cloud Polling"
14+
---
15+
16+
17+
The `ryobi_gdo` cover platform lets you control [Ryobi](https://www.ryobitools.com/gdo/) garage door opener through Home Assistant.
18+
19+
## {% linkable_title Setup %}
20+
21+
In order to be able to use your Ryobi garage door opener, you will have to get the DEVICE_ID_OF_YOUR_COVER (one for each garage door).
22+
23+
The DEVICE_ID_OF_YOUR_COVER can be retrieved using `curl`, simply use your username and password using the following example. Your `DEVICE_ID_OF_YOUR_COVER` will be `varName`:
24+
25+
```bash
26+
$ curl -H "Content-Type: application/json" -X GET \
27+
-d '{"username":"RYOBIGDO_USERNAME","password":"RYOBIGDO_PASSWORD"}' \
28+
https://tti.tiwiconnect.com/api/devices
29+
```
30+
31+
## {% linkable_title Configuration %}
32+
33+
To enable Ryobi covers in your installation, add the following to your `configuration.yaml` file:
34+
35+
```yaml
36+
# Example configuration.yaml entry
37+
cover:
38+
- platform: ryobi_gdo
39+
username: RYOBIGDO_USERNAME
40+
password: RYOBIGDO_PASSWORD
41+
device_id:
42+
- DEVICE_ID_OF_YOUR_COVER#1
43+
- DEVICE_ID_OF_YOUR_COVER#2
44+
```
45+
46+
{% configuration %}
47+
username:
48+
description: Your RyobiGDO account username.
49+
required: true
50+
type: string
51+
password:
52+
description: Your RyobiGDO account password.
53+
required: true
54+
type: string
55+
device_id:
56+
description: List of your doors.
57+
required: true
58+
type: list
59+
{% endconfiguration %}

source/_components/device_tracker.luci.markdown

+1
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ Configuration variables:
4242
- **host** (*Required*): The IP address of your router, e.g., `192.168.1.1`.
4343
- **username** (*Required*): The username of an user with administrative privileges, usually `admin`.
4444
- **password** (*Required*): The password for your given admin account.
45+
- **ssl** (*Optional*): If your router enforces SSL connections, set to `true`. Defaults to `false`.
4546

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

source/_components/homekit.markdown

+27-2
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,18 @@ homekit:
3030
include_domains:
3131
- alarm_control_panel
3232
- light
33+
- media_player
3334
entity_config:
3435
alarm_control_panel.home:
3536
code: 1234
37+
media_player.living_room:
38+
feature_list:
39+
- feature: on_off
40+
- feature: play_pause
41+
- feature: play_stop
42+
- feature: toggle_mute
43+
switch.bedroom_outlet:
44+
type: outlet
3645
```
3746
3847
{% configuration %}
@@ -95,6 +104,20 @@ homekit:
95104
required: false
96105
type: string
97106
default: '`<No code>`'
107+
feature_list:
108+
description: Only for `media_player` entities. List of feature dictionaries to add for a given entity. Comparable to the platform schema.
109+
required: false
110+
type: list
111+
keys:
112+
feature:
113+
description: Name of the feature to add to the entity representation. Valid features are `on_off`, `play_pause`, `play_stop` and `toogle_mute`. The media_player entity must support the feature to be valid.
114+
required: true
115+
type: string
116+
type:
117+
description: Only for `switch` entities. Type of accessory to be created within HomeKit. Valid types are `switch` and `outlet`.
118+
required: false
119+
type: string
120+
default: switch
98121
{% endconfiguration %}
99122

100123
<p class='note'>
@@ -221,22 +244,24 @@ The following components are currently supported:
221244
| Component | Type Name | Description |
222245
| --------- | --------- | ----------- |
223246
| alarm_control_panel | SecuritySystem | All security systems. |
247+
| automation / input_boolean / remote / script | Switch | All represented as switches. |
224248
| binary_sensor | Sensor | Support for `co2`, `door`, `garage_door`, `gas`, `moisture`, `motion`, `occupancy`, `opening`, `smoke` and `window` device classes. Defaults to the `occupancy` device class for everything else. |
225249
| climate | Thermostat | All climate devices. |
226250
| cover | GarageDoorOpener | All covers that support `open` and `close` and have `garage` as their `device_class`. |
227251
| cover | WindowCovering | All covers that support `set_cover_position`. |
228252
| cover | WindowCovering | All covers that support `open_cover` and `close_cover` through value mapping. (`open` -> `>=50`; `close` -> `<50`) |
229253
| cover | WindowCovering | All covers that support `open_cover`, `stop_cover` and `close_cover` through value mapping. (`open` -> `>70`; `close` -> `<30`; `stop` -> every value in between) |
230254
| device_tracker | Sensor | Support for `occupancy` device class. |
231-
| fan | Fan | Support for `on / off`, `direction` and `oscillating`. |
255+
| fan | Fan | Support for `on / off`, `direction` and `oscillating`. |
232256
| light | Light | Support for `on / off`, `brightness` and `rgb_color`. |
233257
| lock | DoorLock | Support for `lock / unlock`. |
258+
| media_player | MediaPlayer | Represented as a series of switches which control `on / off`, `play / pause`, `play / stop`, or `mute` depending on `supported_features` of entity and the `mode` list specified in `entity_config`. |
234259
| sensor | TemperatureSensor | All sensors that have `Celsius` or `Fahrenheit` as their `unit_of_measurement` or `temperature` as their `device_class`. |
235260
| sensor | HumiditySensor | All sensors that have `%` as their `unit_of_measurement` and `humidity` as their `device_class`. |
236261
| sensor | AirQualitySensor | All sensors that have `pm25` as part of their `entity_id` or `pm25` as their `device_class` |
237262
| sensor | CarbonDioxideSensor | All sensors that have `co2` as part of their `entity_id` or `co2` as their `device_class` |
238263
| sensor | LightSensor | All sensors that have `lm` or `lx` as their `unit_of_measurement` or `illuminance` as their `device_class` |
239-
| switch / remote / input_boolean / script | Switch | All represented as switches. |
264+
| switch | Switch | Represented as a switch by default but can be changed by using `type` within `entity_config`. |
240265

241266

242267
## {% linkable_title Error reporting %}

source/_components/hydrawise.markdown

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
layout: page
3+
title: "Hunter Hydrawise"
4+
description: "Instructions on how to integrate your Hunter Hydrawise Wi-Fi irrigation control system within Home Assistant."
5+
date: 2018-04-11 08:02
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: hydrawise_logo.png
11+
ha_category: Hub
12+
ha_release: 0.71
13+
ha_iot_class: Cloud Polling
14+
---
15+
16+
The `hydrawise` component allows you to integrate your [Hunter Hydrawise](https://hydrawise.com) Wi-Fi irrigation controller system in Home Assistant.
17+
18+
To enable it, add the following to your `configuration.yaml` file:
19+
20+
```yaml
21+
# Example configuration.yaml entry
22+
hydrawise:
23+
access_token: YOUR_API_KEY
24+
```
25+
26+
{% configuration %}
27+
access_token:
28+
description: The API KEY assigned to your Hydrawise account.
29+
required: true
30+
type: string
31+
scan_interval:
32+
description: The time interval, in seconds, to poll the Hydrawise cloud.
33+
required: false
34+
type: int
35+
default: 30
36+
{% endconfiguration %}
37+
38+
To get your API access token log into your [Hydrawise account](https://app.hydrawise.com/config/account) and in the 'My Account Details' section under Account Settings click 'Generate API Key'. Enter that key in your configuration file as the `API_KEY`.
39+
40+
Finish the configuration by visiting the [Hydrawise binary sensor](/components/binary_sensor.hydrawise/), [Hydrawise sensor](/components/sensor.hydrawise/) and [Hydrawise switch](/components/switch.hydrawise/) documentation.

source/_components/keyboard_remote.markdown

+8-4
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ha_iot_class: "Local Push"
1515

1616
Receive signals from a keyboard and use it as a remote control.
1717

18-
This component allows you to use a keyboard as remote control. It will fire `keyboard_remote_command_received` events which can then be used in automation rules.
18+
This component allows you to use one or more keyboards as remote controls. It will fire `keyboard_remote_command_received` events which can then be used in automation rules.
1919

2020
The `evdev` package is used to interface with the keyboard and thus this is Linux only. It also means you can't use your normal keyboard for this because `evdev` will block it.
2121

@@ -37,15 +37,17 @@ In case of presence of multiple devices of the same model, `device_descriptor` m
3737

3838
A list of possible device descriptors and names is reported in the debug log at startup when the device indicated in the configuration entry could not be found.
3939

40-
A full configuration for Keyboard Remote could look like the one below:
40+
A full configuration for two Keyboard Remotes could look like the one below:
4141

4242
```yaml
4343
keyboard_remote:
44-
device_descriptor: '/dev/input/by-id/bluetooth-keyboard'
44+
- device_descriptor: '/dev/input/by-id/bluetooth-keyboard'
45+
type: 'key_up'
46+
- device_descriptor: '/dev/input/event0'
4547
type: 'key_up'
4648
```
4749

48-
or like the following:
50+
or like the following for one keyboard:
4951

5052
```yaml
5153
keyboard_remote:
@@ -62,11 +64,13 @@ automation:
6264
platform: event
6365
event_type: keyboard_remote_command_received
6466
event_data:
67+
device_descriptor: "/dev/input/event0"
6568
key_code: 107 # inspect log to obtain desired keycode
6669
action:
6770
service: light.turn_on
6871
entity_id: light.all
6972
```
73+
`device_descriptor` or `device_name` may be specificed in the trigger so the automation will be fired only for that keyboard. This is especially useful if you wish to use several bluetooth remotes to control different devices. Omit them to ensure the same key triggers the automation for all keyboards/remotes.
7074

7175
## {% linkable_title Disconnections %}
7276
This component manages disconnections and re-connections of the keyboard, for example in the case of a Bluetooth device that turns off automatically to preserve battery.
+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
layout: page
3+
title: "Lagute LW-12"
4+
description: "Instructions on how to setup Lagute LW-12 Wifi LED controller within Home Assistant."
5+
date: 2018-04-28 08:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
ha_category: Light
11+
ha_iot_class: "Local Polling"
12+
logo: lagute.png
13+
ha_release: 0.71
14+
---
15+
16+
The `lw12wifi` light platform supports Lagute LW-12 Wifi LED controller.
17+
18+
## {% linkable_title Configuration %}
19+
20+
To enable these lights, add the following lines to your `configuration.yaml` file:
21+
22+
```yaml
23+
# Example configuration.yaml entry
24+
light:
25+
- platform: lw12wifi
26+
host: IP_ADDRESS_CONTROLLER
27+
```
28+
29+
{% configuration %}
30+
host:
31+
description: Host name or IP of LW-12 LED stripe to control.
32+
required: true
33+
type: string
34+
port:
35+
description: Some firmware versions of the LW-12 controller listen on different ports.
36+
required: false
37+
type: int
38+
default: 5000
39+
name:
40+
description: Name to use in the frontend.
41+
required: false
42+
type: string
43+
default: LW-12 FC
44+
{% endconfiguration %}
45+

source/_components/light.nanoleaf_aurora.markdown

+5-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,11 @@ ha_release: 0.67
1616

1717
### {% linkable_title Configuration Sample %}
1818

19-
To enable the Aurora lights, add the following lines to your `configuration.yaml` file:
19+
The `nanoleaf_aurora` platform allows you to control [Nanoleaf Aurora Light Panels](https://nanoleaf.me) from Home Assistant.
20+
21+
The preferred way to set up this platform is by enabling the [discovery component](https://www.home-assistant.io/components/discovery/). Make sure to press and hold the *ON* button for 5 seconds (the LED will start flashing) on your Nanoleaf Aurora Panel while Home Assistant is starting.
22+
23+
To configure the Aurora lights manually, add the following lines to your `configuration.yaml` file:
2024

2125
```yaml
2226
# Example configuration.yaml entry

0 commit comments

Comments
 (0)