Skip to content

Commit 73ed694

Browse files
fabafffabaff
committed
Merge branch 'current' into next
2 parents 8af6738 + c13e584 commit 73ed694

40 files changed

+314
-231
lines changed

‎_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,4 +136,4 @@ date_released: 2016-12-17
136136

137137
# Either # or the anchor link to latest release notes in the blog post.
138138
# Must be prefixed with a # and have double quotes around it.
139-
patch_version_notes: "#release-0344---december-7"
139+
patch_version_notes: "#release-0345---december-12"

‎source/_components/alexa.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ First create a file called `alexa_confirm.yaml` with something like the followin
290290
] | random }} {% endraw %}
291291
```
292292

293-
Then, wherever you would but some simple text for a response like`OK`, replace it with a reference to the file so that:
293+
Then, wherever you would put some simple text for a response like `OK`, replace it with a reference to the file so that:
294294

295295
```
296296
text: OK

‎source/_components/climate.honeywell.markdown

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,12 @@ To set it up, add the following information to your `configuration.yaml` file:
2020
climate:
2121
platform: honeywell
2222
username: YOUR_USERNAME
23+
password: YOUR_PASSWORD
2324
```
2425
2526
Configuration variables:
2627
27-
- **username** (*Required*: The username of an user with access.
28+
- **username** (*Required*): The username of an user with access.
2829
- **password** (*Required*): The password for your given admin account.
2930
- **away_temperature** (*optional*): Heating setpoint when away mode is on. If omitted it defaults to 16.0 deg C.
3031
- **region** (*optional*): Region identifier (either 'eu' or 'us'). Defaults to 'eu' if not provided.

‎source/_components/climate.radiotherm.markdown

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
3-
title: "Radiotherm Thermostat"
4-
description: "Instructions how to integrate Radiotherm thermostats within Home Assistant."
3+
title: "Radio Thermostat (3M Filtrete) Thermostat"
4+
description: "Instructions how to integrate Radio Thermostat (3M Filtrete) thermostats within Home Assistant."
55
date: 2015-10-18 17:15
66
sidebar: true
77
comments: false
@@ -12,7 +12,7 @@ ha_category: Climate
1212
---
1313

1414

15-
The `radiotherm` climate platform let you control a thermostat from [Radio Thermostat](http://www.radiothermostat.com/).
15+
The `radiotherm` climate platform let you control a thermostat from [Radio Thermostat](http://www.radiothermostat.com/) or [3M Filtrete](http://www.radiothermostat.com/filtrete/products/). Your thermostat must have the Wi-Fi module installed and connected to your network.
1616

1717
The underlying library supports:
1818

@@ -32,11 +32,15 @@ climate:
3232
Configuration variables:
3333
3434
- **host** (*Optional*): List of your Radiotherm thermostats. If not provided the thermostats will be auto-detected.
35+
- **away_temperature_heat** (*Optional*): Target heating temperature in Fahrenheit for away mode. This is separate from away mode in the app. Defaults to '60'.
36+
- **away_temperature_cool** (*Optional*): Target cooling temperature in Fahrenheit for away mode. This is separate from away mode in the app. Defaults to '85'.
3537
- **hold_temp** (*Optional*): Boolean to control if Home Assistant temperature adjustments hold (`True`) or are temporary (`False`). Defaults to `False`.
3638

37-
Temperature settings from Home Assistant will be sent to thermostat and then hold at that temperature. Set to `False` if you set a thermostat schedule on the thermostat itself and just want Home Assistant to send temporary temperature changes.
39+
Set `hold_temp: True` if you want temperature settings from Home Assistant to override a thermostat schedule on the thermostat itself. Otherwise Home Assistant will perform temporary temperature changes.
3840

39-
Multiple thermostats could be assigned by using `host:` if auto-detection is not used.
41+
The away mode functions similarly to the away mode feature of the website and apps, but cannot detect if you set away mode outside of Home Assistant.
42+
43+
Multiple thermostats can be assigned by using `host:` if auto-detection is not used.
4044

4145
```yaml
4246
climate:

‎source/_components/device_tracker.bluetooth_le_tracker.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This tracker discovers new devices on boot and in regular intervals and tracks b
1717
Devices discovered are stored with 'BLE_' as the prefix for device mac addresses in `known_devices.yaml`.
1818

1919
<p class='note'>
20-
Requires PyBluez. If you are on Raspbian, make sure you first install `bluetooth` and `libbluetooth-dev` by running `sudo apt install bluetooth libbluetooth-dev`
20+
Requires PyBluez. If you are on Raspbian, run the following command to install the needed dependencies. `sudo apt install bluetooth libbluetooth-dev pkg-config libboost-python-dev libboost-thread-dev libglib2.0-dev python-dev`
2121
</p>
2222

2323
<p class='note warning'>

‎source/_components/device_tracker.locative.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,4 @@ To configure Locative, you must set up the app to send a `GET` request to your H
3434

3535
When you enter a geofence, your location name in Home Assistant will be set to the name of the geofence in Locative. When you exit a geofence, your location name in Home Assistant will be set to "not home".
3636

37-
To use Locative in combination with another device tracker, such as [nmap](/components/device_tracker.nmap_scanner/) or [Netgear](/components/device_tracker.netgear/), fill in the `mac` field to the Locative entry in `known_devices.yaml` with the MAC address of the device you want to track. The state of the device will be determined by the source that reported last.
37+
To use Locative in combination with another device tracker, such as [nmap](/components/device_tracker.nmap_tracker/) or [Netgear](/components/device_tracker.netgear/), fill in the `mac` field to the Locative entry in `known_devices.yaml` with the MAC address of the device you want to track. The state of the device will be determined by the source that reported last.

‎source/_components/device_tracker.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ device_tracker:
4949
track_new_devices: yes
5050
```
5151

52-
Multiple device trackers can be used in parallel, such as [Owntracks](/components/device_tracker.owntracks/) and [Nmap](/components/device_tracker.nmap_tracker/). The state of the device will be determined by the source that reported last.
52+
Multiple device trackers can be used in parallel, such as [Owntracks](/components/device_tracker.owntracks/#using-owntracks-with-other-device-trackers) and [Nmap](/components/device_tracker.nmap_tracker/). The state of the device will be determined by the source that reported last.
5353

5454
# {% linkable_title `known_devices.yaml` %}
5555

‎source/_components/device_tracker.owntracks.markdown

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Configuration variables:
3030
3131
- **max_gps_accuracy** (*Optional*): Sometimes Owntracks can report GPS location with a very low accuracy (few kilometers). That can trigger false zoning in your Home Assistant installation. With the parameter, you can filter these GPS reports. The number has to be in meter. For example, if you put 200 only GPS report with an accuracy under 200 will be take in account.
3232
- **waypoints** (*Optional*): Owntracks users can define [waypoints](http://owntracks.org/booklet/features/waypoints/) (a.k.a regions) which are similar in spirit to Home Assistant zones. If this configuration variable is `True`, the Owntracks users who are in `waypoint_whitelist` can export waypoints from the device and Home Assistant will import them as zone definitions. Defaults to `True`.
33-
- **waypoint_whitelist** (*Optional*): A list of user names (as defined for [Owntracks](https://home-assistant.io/components/device_tracker.owntracks/)) who can export their waypoints from Owntracks to Home Assistant. Defaults to all users who are connected to Home Assistant via Owntracks.
33+
- **waypoint_whitelist** (*Optional*): A list of user names (as defined for [Owntracks](/components/device_tracker.owntracks/)) who can export their waypoints from Owntracks to Home Assistant. Defaults to all users who are connected to Home Assistant via Owntracks.
3434

3535
A full sample configuration for the `owntracks` platform is shown below:
3636

@@ -46,7 +46,19 @@ device_tracker:
4646
```
4747

4848
### {% linkable_title Using Owntracks with other device trackers %}
49-
Owntracks can also be used with other device trackers, such as [Nmap](/components/device_tracker.nmap_scanner/) or [Netgear](/components/device_tracker.netgear/). To do this, fill in the `mac` field to the Owntracks entry in `known_devices.yaml` with the MAC address of the device you want to track. This way the state of the device will be determined by the source that reported last. The naming convention for known device list is `<username>_<device-id>` and could be set in app configuration. More details about this config can found in [device tracker](/components/device_tracker/).
49+
Owntracks can also be used with other device trackers, such as [Nmap](/components/device_tracker.nmap_tracker/) or [Netgear](/components/device_tracker.netgear/). To do this, fill in the `mac` field to the Owntracks entry in `known_devices.yaml` with the MAC address of the device you want to track. This way the state of the device will be determined by the source that reported last. The naming convention for known device list is `<username>_<device-id>` and could be set in app configuration. More details about this config can found in [device tracker](/components/device_tracker/).
50+
51+
An example showing the inclusion of the `mac` field for multiple component tracking. The `mac` field will need to be added to the `owntracks` device and will enable tracking by all components that track via the `mac` address.
52+
53+
```yaml
54+
<username>_<device-id>:
55+
name: Friendly Name
56+
mac: EA:AA:55:E7:C6:94
57+
picture: https://home-assistant.io/images/favicon-192x192.png
58+
gravatar: test@example.com
59+
track: yes
60+
hide_if_away: no
61+
```
5062

5163
### {% linkable_title Using Owntracks regions %}
5264
Owntracks can track regions, and send region entry and exit information to Home Assistant (HA). You set up a region in the Owntracks app which you should name the same as your HA Zone, and then make sure to turn on the `share` option for the region in the owntracks app. Please see the [owntracks documentation](http://owntracks.org/booklet/guide/waypoints/).

‎source/_components/feedreader.markdown

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,19 @@ automation:
4141
entity_id: script.my_action
4242
```
4343
44+
```yaml
45+
automation:
46+
- alias: Send notification of RSS feed title when updated
47+
trigger:
48+
platform: event
49+
event_type: feedreader
50+
action:
51+
service: notify.notify
52+
data_template: "{{ trigger.event.data.title }}"
53+
```
54+
55+
*Any field under the `<entry>` tag in the feed can be used for example `tigger.event.data.content` will get the body of the feed entry.
56+
4457
For more advanced use cases, a custom component registering to the `feedreader` event type could be used instead:
4558

4659
```python

‎source/_components/group.markdown

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,19 @@ logo: home-assistant.png
1111
ha_category: Organization
1212
---
1313

14-
Groups allow the user to combine multiple entities into one. A group can be promoted to a **view** by setting the `view` option to `yes`. This will make the group available as a new tab in the frontend.
14+
Groups allow the user to combine multiple entities into one. A group can be promoted to a **view** by setting `view: yes` under the group definition. This will make the group available as a new tab in the frontend.
1515

1616
Check the **Set State** <img src='/images/screenshots/developer-tool-states-icon.png' class='no-shadow' height='38' /> page from the **Developer Tools** and browse the **Current entities:** listing for all available entities.
1717

18-
By default, every group appears in the HOME tab. If you name a group `default_view` it will REPLACE the contents of the HOME tab so you can customize it as you wish.
18+
By default, every group appears in the HOME tab. If you create a group `default_view` it will REPLACE the contents of the HOME tab so you can customize the HOME tab as you wish.
1919

2020
```yaml
2121
# Example configuration.yaml entry
2222
group:
2323
default_view:
2424
view: yes
2525
entities:
26+
- group.kitchen
2627
- group.awesome_people
2728
- group.climate
2829
kitchen:
@@ -38,11 +39,26 @@ group:
3839
- camera.demo_camera
3940
- device_tracker.demo_paulus
4041
- group.garden
42+
climate:
43+
name: Climate
44+
view: no
45+
entities:
46+
- sensor.bedroom_temp
47+
- sensor.porch_temp
48+
- sensor.bathroom_humidity
49+
awesome_people:
50+
name: Awesome People
51+
view: no
52+
entities:
53+
- device_tracker.dad_smith
54+
- device_tracker.mom_smith
55+
- device_tracker.dog_smith
56+
4157
```
4258
4359
Configuration variables:
4460
45-
- **view** (*Optional*): If yes then the entry will be shown as a view (tab).
61+
- **view** (*Optional*): If yes then the entry will be shown as a view (tab) at the top.
4662
- **name** (*Optional*): Name of the group.
4763
- **icon** (*Optional*): If the group is a view, this icon will show at the top in the frontend instead of the name. If it's not a view, then the icon shows when this group is used in another group.
4864
- **control** (*Optional*): If hidden then the group switch will be hidden.

‎source/_components/http.markdown

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Configuration variables:
3232
- **ssl_certificate** (*Optional*): Path to your TLS/SSL certificate to serve Home Assistant over a secure connection.
3333
- **ssl_key** (*Optional*): Path to your TLS/SSL key to serve Home Assistant over a secure connection.
3434
- **cors_allowed_origins** (*Optional*): A list of origin domain names to allow [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) requests from. Enabling this will set the `Access-Control-Allow-Origin` header to the Origin header if it is found in the list, and the `Access-Control-Allow-Headers` header to `Origin, Accept, X-Requested-With, Content-type, X-HA-access`. You must provide the exact Origin, i.e. `https://home-assistant.io` will allow requests from `https://home-assistant.io` but __not__ `http://home-assistant.io`.
35-
- **use_x_forwarded_for** (*Optional*): Enable parsing of the `X-Forwarded-For` header, passing on the client's correct IP address in proxied setups. You should only enable this in a trustworthy network environment, as clients passing that header could easily spoof their source IP address.
35+
- **use_x_forwarded_for** (*Optional*): Enable parsing of the `X-Forwarded-For` header, passing on the client's correct IP address in proxied setups. You should only enable this in a trustworthy network environment, as clients passing that header could easily spoof their source IP address. Defaults to False.
3636
- **trusted_networks** (*Optional*): List of trusted networks, consisting of IP addresses or networks, that are allowed to bypass password protection when accessing Home Assistant.
3737
- **ip_ban_enabled** (*Optional*): Flag indicating whether additional IP filtering is enabled. Defaults to False.
3838
- **login_attempts_threshold** (*Optional*): Number of failed login attemt from single IP after which it will be automatically banned if `ip_ban_enabled` is True. Defaults to -1, meaning that no new automatic bans will be added.
@@ -49,6 +49,7 @@ http:
4949
cors_allowed_origins:
5050
- https://google.com
5151
- https://home-assistant.io
52+
use_x_forwarded_for: True
5253
trusted_networks:
5354
- 127.0.0.1
5455
- ::1
@@ -81,4 +82,4 @@ After a ban is added a Persistent Notification is populated to the Home Assistan
8182

8283
<p class='note warning'>
8384
Please note, that sources from `trusted_networks` won't be banned automatically.
84-
</p>
85+
</p>

‎source/_components/input_boolean.markdown

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ automation:
4141
entity_id: binary_sensor.motion_garage
4242
to: 'on'
4343
condition:
44-
platform: state
44+
condition: state
4545
entity_id: input_boolean.notify_home
4646
state: 'on'
4747
action:
@@ -50,3 +50,11 @@ automation:
5050
title: ""
5151
message: "Honey, I'm home!"
5252
```
53+
54+
You can also set or change the status of an `input_boolean` by using `input_boolean.turn_on` and `input_boolean.turn_off` in your automations.
55+
56+
```yaml
57+
- service: input_boolean.turn_on
58+
data:
59+
entity_id: input_boolean.notify_home
60+
```

‎source/_components/light.hue.markdown

Lines changed: 13 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,16 @@ The 2nd generation Hue app only allows to create a `Room`. You need to use the f
4646
Example:
4747

4848
To create a `LightGroup` named `Ceiling lights` that contains the lights 1, 2 and 3, execute the following command:
49-
```shell
49+
50+
```bash
5051
$ curl -XPOST -d '{"name": "Ceiling lights", "lights": ["1", "2", "3"]}' http://<bridge>/api/<username>/groups
5152
```
5253

5354
The `<username>` is the string that is used to register Home Assistant on the bridge, you can find it in the `phue.conf` file in your configuration path. `<bridge>` is the IP address or hostname of your Hue bridge.
5455

5556
You can find out the ids of your lights by executing the following command:
56-
```shell
57+
58+
```bash
5759
$ curl http://<bridge>/api/<username>/lights
5860
```
5961

@@ -68,17 +70,9 @@ More information can be found on the [Philips Hue API documentation](https://www
6870

6971
### {% linkable_title Using Hue Scenes in Home Assistant %}
7072

71-
The Hue platform has it's own concept of Scenes for setting the colors
72-
of a group of lights at once. Hue Scenes are very cheap, get created
73-
by all kinds of apps (as it is the only way to have 2 or more lights
74-
change at the same time), and are rarely deleted. A typical Hue hub
75-
might have hundreds of scenes stored in them, many that you've never
76-
used, almost all very poorly named.
77-
78-
To avoid user interface overload we don't expose Scenes
79-
directly. Instead there is a
80-
[light.hue_activate_scene](/components/light/#service-lighthue_activate_scene)
81-
service which can be used by `automation` or `script` components. For
73+
The Hue platform has it's own concept of Scenes for setting the colors of a group of lights at once. Hue Scenes are very cheap, get created by all kinds of apps (as it is the only way to have 2 or more lights change at the same time), and are rarely deleted. A typical Hue hub might have hundreds of scenes stored in them, many that you've never used, almost all very poorly named.
74+
75+
To avoid user interface overload we don't expose Scenes directly. Instead there is a [light.hue_activate_scene](/components/light/#service-lighthue_activate_scene) service which can be used by `automation` or `script` components. For
8276
instance:
8377

8478
```yaml
@@ -95,27 +89,15 @@ script:
9589

9690
How do you find these names?
9791

98-
The easiest way to do this is only use the scenes from the 2nd
99-
generation Hue app. That is organized by Room (Group) and Scene
100-
Name. Use the values of Room name and Scene name that you see in the
101-
app. You can test these work on the `dev-service` console of your Home
102-
Assistant instance.
92+
The easiest way to do this is only use the scenes from the 2nd generation Hue app. That is organized by Room (Group) and Scene
93+
Name. Use the values of Room name and Scene name that you see in the app. You can test these work on the `dev-service` console of your Home Assistant instance.
10394

104-
Alternatively, you can dump all rooms and scene names using this
105-
[gist](https://gist.github.com/sdague/5479b632e0fce931951c0636c39a9578). This
106-
does **not** tell you which groups and scenes work together but it's
107-
sufficient to get values that you can test in the `dev-service` console.
95+
Alternatively, you can dump all rooms and scene names using this [gist](https://gist.github.com/sdague/5479b632e0fce931951c0636c39a9578). This does **not** tell you which groups and scenes work together but it's sufficient to get values that you can test in the `dev-service` console.
10896

10997
*** Caveats ***
11098

111-
The Hue API doesn't activate Scenes directly, only on a Hue Group
112-
(typically Rooms, especially if using the 2nd gen app). But Hue Scenes
113-
don't actually reference their group. So heuristic matching is used.
99+
The Hue API doesn't activate Scenes directly, only on a Hue Group (typically Rooms, especially if using the 2nd gen app). But Hue Scenes don't actually reference their group. So heuristic matching is used.
114100

115-
Neither Group names or Scene names are guarunteed unique in Hue. If
116-
you are getting non deterministic behavior, adjust your Hue scenes via
117-
the App to be more identifying.
101+
Neither Group names or Scene names are guaranteed unique in Hue. If you are getting non deterministic behavior, adjust your Hue scenes via the App to be more identifying.
118102

119-
The Hue hub has limitted spaces for Scenes, and will delete Scenes if
120-
new ones get created that would overflow that space. The API docs say
121-
this is based on Least Recently Used.
103+
The Hue hub has limitted spaces for Scenes, and will delete Scenes if new ones get created that would overflow that space. The API docs say this is based on Least Recently Used.

0 commit comments

Comments
 (0)