Skip to content

Commit cec178b

Browse files
committed
Merge branch 'current' into next
2 parents 4bd702e + 0292712 commit cec178b

20 files changed

+527
-62
lines changed

_config.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -141,14 +141,14 @@ social:
141141

142142
# Home Assistant release details
143143
current_major_version: 0
144-
current_minor_version: 75
145-
current_patch_version: 3
146-
date_released: 2018-08-09
144+
current_minor_version: 76
145+
current_patch_version: 1
146+
date_released: 2018-08-19
147147

148148
# Either # or the anchor link to latest release notes in the blog post.
149149
# Must be prefixed with a # and have double quotes around it.
150150
# Major release:
151-
patch_version_notes: "#release-0753---august-9"
151+
patch_version_notes: "#release-0761---august-19"
152152
# Minor release (Example #release-0431---april-25):
153153

154154
# Date we moved to Discourse for comments

source/_addons/bluetooth_bcm43xx.markdown

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,14 @@ sharing: true
99
footer: true
1010
---
1111

12-
Start this add-on to activate the BCM43xx Bluetooth chipset.
12+
Start this add-on to activate the BCM43xx Bluetooth chipset in the old ResinOS based builds. If you first installed Hass.io after mid July 2018 then you will have a HassOS based system.
13+
14+
You can identify the base of your system by looking in the System tab of the Hass.io menu.
1315

1416
<p class='note warning'>
15-
This is not required on HassOS based Hass.io installs and should not be installed.
17+
This is not required on the new HassOS based Hass.io installs and should not be installed.
1618
</p>
1719

1820
Supported platforms:
1921

2022
- Raspberry Pi 3
21-

source/_components/climate.ecobee.markdown

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,9 @@ canceled.
245245
| Service data attribute | Optional | Description |
246246
| ---------------------- | -------- | ----------- |
247247
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
248-
| `hold_mode` | no | 'temp', 'home', 'away', 'sleep', etc., None
248+
| `hold_mode` | no | `temp`, `home`, `away`, `sleep`, `None`, `smart1`, `smart2`, etc.
249+
250+
NOTE: If you create custom hold modes (also known as "Comfort Settings") on your ecobee.com dashboard, their hold_modes are `smart1`, `smart2`, `smart3`, etc. The number for each custom mode should match the mode's icon on your ecobee.com dashboard. Also note that the mode numbers/icons in the ecobee mobile app *may not match* the numbers/icons from the ecobee.com web dashboard. The ones on the website are the ones you shoud use to determine the correct `smartX` hold_mode IDs.
249251

250252
### {% linkable_title Service `set_temperature` %}
251253

source/_components/dyson.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ dyson:
2727
language: YOUR_DYSON_ACCOUNT_LANGUGAGE
2828
devices:
2929
- device_id: DEVICE_ID_1 # eg. Serial number: XXX-XX-XXXXXXXX
30-
device_ip: DEVICE_ID_1
30+
device_ip: DEVICE_IP_1
3131
- device_id: DEVICE_ID_2
32-
device_ip: DEVICE_ID_2
32+
device_ip: DEVICE_IP_2
3333
```
3434
3535
Configuration variables:

source/_components/http.markdown

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ trusted_proxies:
6969
required: false
7070
type: string, list
7171
use_x_forwarded_for:
72-
description: "Enable parsing of the `X-Forwarded-For` header, passing on the client's correct IP address in proxied setups. You **must** also whitelist trusted proxies using the `trusted_proxies` setting below for this to work. Non-whitelisted requests with this header will be considered IP spoofing attacks, and the header will, therefore, be ignored."
72+
description: "Enable parsing of the `X-Forwarded-For` header, passing on the client's correct IP address in proxied setups. You **must** also whitelist trusted proxies using the `trusted_proxies` setting above for this to work. Non-whitelisted requests with this header will be considered IP spoofing attacks, and the header will, therefore, be ignored."
7373
required: false
7474
type: boolean
7575
default: false
@@ -87,6 +87,11 @@ login_attempts_threshold:
8787
required: false
8888
type: integer
8989
default: -1
90+
ssl_profile:
91+
description: The [Mozilla SSL profile](https://wiki.mozilla.org/Security/Server_Side_TLS) to use. Only lower if you are experiencing integrations causing SSL handshake errors.
92+
required: false
93+
type: string
94+
default: modern
9095
{% endconfiguration %}
9196

9297
The sample below shows a configuration entry with possible values:

source/_components/lutron_caseta.markdown

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ The currently supported Caseta devices are:
2525
- Scenes as Home Assistant [scenes](/components/scene.lutron_caseta/)
2626
- Lutron shades as Home Assistant [covers](/components/cover.lutron_caseta/)
2727

28-
When configured, the `lutron_caseta` component will automatically discover the currently supported devices as setup in the Lutron Smart Bridge. The name assigned in the Lutron mobile app will be used to form the `entity_id` used in Home Assistant. e.g., a dimmer called 'Bedroom Lamp' becomes `light.bedroom_lamp` in Home Assistant.
28+
When configured, the `lutron_caseta` component will automatically discover the currently supported devices as setup in the Lutron Smart Bridge. The name assigned in the Lutron mobile app will be used to form the `entity_id` used in Home Assistant. e.g., a dimmer called 'Lamp' in a room called 'Bedroom' becomes `light.bedroom_lamp` in Home Assistant.
2929

30-
To use Lutron Caseta devices in your installation, you must first log in to your Lutron account and generate a certificate that allows Home Assistant to connect to your bridge. This can be accomplished by downloading and executing [this script](/assets/get_lutron_cert.zip), which will generate three files: caseta.key, caseta.crt, caseta-bridge.crt when you run it. See the instructions at the top of the script for more information.
30+
To use Lutron Caseta devices in your installation, you must first log in to your Lutron account and generate a certificate that allows Home Assistant to connect to your bridge. This can be accomplished by downloading and executing [get_lutron_cert.py](https://github.com/gurumitts/pylutron-caseta/blob/master/get_lutron_cert.py), which will generate three files: caseta.key, caseta.crt, caseta-bridge.crt when you run it. See the instructions at the top of the script for more information.
3131

3232
Once you have the three necessary files, place them in your configuration directory and add the following to your `configuration.yaml`:
3333

@@ -40,12 +40,24 @@ lutron_caseta:
4040
ca_certs: caseta-bridge.crt
4141
```
4242
43-
Configuration variables:
44-
45-
- **host** (*Required*): The IP address of the Lutron Smart Bridge.
46-
- **keyfile** (*Required*): The private key that Home Assistant will use to authenticate to the bridge.
47-
- **certfile** (*Required*): The certificate chain that Home Assistant will use to authenticate to the bridge.
48-
- **ca_certs** (*Required*): The list of certificate authorities (usually only one) that Home Assistant will expect when connecting to the bridge.
43+
{% configuration %}
44+
host:
45+
required: true
46+
description: The IP address of the Lutron Smart Bridge.
47+
type: string
48+
keyfile:
49+
required: true
50+
description: The private key that Home Assistant will use to authenticate to the bridge.
51+
type: string
52+
certfile:
53+
required: true
54+
description: The certificate chain that Home Assistant will use to authenticate to the bridge.
55+
type: string
56+
ca_certs:
57+
required: true
58+
description: The list of certificate authorities (usually only one) that Home Assistant will expect when connecting to the bridge.
59+
type: string
60+
{% endconfiguration %}
4961
5062
<p class='note'>
5163
It is recommended to assign a static IP address to your Lutron Smart Bridge. This ensures that it won't change IP address, so you won't have to change the `host` if it reboots and comes up with a different IP address.

source/_components/media_player.panasonic_viera.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Currently known supported models:
2929
- TX-P42STW50
3030
- TX-P50GT30Y
3131
- TX-P50GT60E
32+
- TH-32ES500
3233

3334
If your model is not on the list then give it a test, if everything works correctly then add it to the list on [GitHub](https://github.com/home-assistant/home-assistant.github.io/blob/next/source/_components/media_player.panasonic_viera.markdown).
3435

source/_components/panel_custom.markdown

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,29 +12,34 @@ ha_category: Front end
1212
ha_release: 0.26
1313
---
1414

15-
16-
The `panel_custom` support allows you to add additional panels to your Home Assistant frontend. The panels are listed in the sidebar if wished and can be highly customized.
15+
The `panel_custom` support allows you to add additional panels to your Home Assistant frontend. The panels are listed in the sidebar if wished and can be highly customized. See the developer documentation on [instructions how to build your own panels](https://developers.home-assistant.io/docs/en/frontend_creating_custom_panels.html).
1716

1817
To enable customized panels in your installation, add the following to your `configuration.yaml` file:
1918

2019
```yaml
21-
# Example configuration.yaml entry for https://github.com/home-assistant/example-custom-config/blob/master/panels/hello_world.html
20+
# Example configuration.yaml entry
2221
panel_custom:
23-
- name: todomvc
22+
- name: my-panel
2423
sidebar_title: TodoMVC
2524
sidebar_icon: mdi:work
2625
url_path: my-todomvc
27-
webcomponent_path: /home/hass/hello.html
26+
js_url: /local/my-panel.js
2827
config:
2928
who: world
3029
```
3130
31+
<p class='note'>
32+
Store your custom panels in `<config>/www` to make them available in the frontend at the path `/local`.
33+
</p>
34+
3235
Configuration variables:
3336

34-
- **name** (*Optional*): Name of the panel.
37+
- **name** (*Required*): Name of the web component that renders your panel.
3538
- **sidebar_title** (*Optional*): Friendly title for the panel in the sidebar. Omitting it means no sidebar entry (but still accessible through the URL).
3639
- **sidebar_icon** (*Optional*): Icon for entry. Pick an icon that you can find on [materialdesignicons.com](https://materialdesignicons.com/) to use for your input and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance`, or `mdi:motorbike`.
37-
- **url_path** (*Optional*): The URL your panel will be available on. If omitted will default to the panel name.
38-
- **webcomponent_path** (*Optional*): The path to your component. If omitted will default to `<config dir>/panels/<component name>.html`
40+
- **url_path** (*Optional*): The URL your panel will be available on in the frontend. If omitted will default to the panel name.
41+
- **js_url** (*Required*): The URL that contains the JavaScript of your panel.
3942
- **config** (*Optional*): Configuration to be passed into your web component when being instantiated.
40-
43+
- **embed_iframe** (*Optional*): Set to `true` to embed panel in iframe. This is necessary if the panel is panel is using the React framework or if it contains conflicting web components.
44+
- **trust_external_script** (*Optional*): By default the user has to confirm before loading a script from an external source. Setting this to `true` will omit this confirmation.
45+
- **webcomponent_path** (*Optional* *DEPRECATED*): The HTML path to your component. If omitted will default to `<config dir>/panels/<component name>.html`

source/_components/sensor.mold_indicator.markdown

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,28 @@ sensor:
2727
calibration_factor: 2.0
2828
```
2929
30-
Configuration variables:
31-
32-
- **indoor_temp_sensor** (*Required*): The entity ID of the indoor temperature sensor.
33-
- **indoor_humidity_sensor** (*Required*): The entity ID of the indoor humidity sensor.
34-
- **outdoor_temp_sensor** (*Required*): The entity ID of the outdoor temperature sensor.
35-
- **calibration_factor** (*Required*): Needs to be calibrated to the critical point in the room.
30+
{% configuration %}
31+
name:
32+
description: The name of the sensor.
33+
required: false
34+
type: string
35+
indoor_temp_sensor:
36+
description: The entity ID of the indoor temperature sensor.
37+
required: true
38+
type: string
39+
indoor_humidity_sensor:
40+
description: The entity ID of the indoor humidity sensor.
41+
required: true
42+
type: string
43+
outdoor_temp_sensor:
44+
description: The entity ID of the outdoor temperature sensor.
45+
required: true
46+
type: string
47+
calibration_factor:
48+
description: Needs to be calibrated to the critical point in the room.
49+
required: true
50+
type: float
51+
{% endconfiguration %}
3652
3753
In this case, the weather forecast temperature sensor is used for the outside temperature.
3854

source/_components/sensor.worldtidesinfo.markdown

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ ha_release: 0.52
1414

1515
The `worldtidesinfo` sensor platform uses details from [World Tides](https://www.worldtides.info/) to provide information about the prediction for the tides for any location in the world.
1616

17+
## {% linkable_title Setup %}
18+
19+
Get your API key from your account at [https://www.worldtides.info/](https://www.worldtides.info/).
20+
21+
## {% linkable_title Configuration %}
22+
1723
To use this sensor, add the following to your `configuration.yaml` file:
1824

1925
```yaml
@@ -23,10 +29,25 @@ sensor:
2329
api_key: YOUR_API_KEY
2430
```
2531
26-
Configuration variables:
27-
28-
- **api_key** (*Required*): Your API key for https://www.worldtides.info/.
29-
- **name** (*Optional*): Name to use in the frontend.
30-
- **latitude** (*Optional*): Latitude of the location to display the tides. Defaults to the latitude in your `configuration.yaml` file.
31-
- **longitude** (*Optional*): Longitude of the location to display the tides. Defaults to the longitude in your `configuration.yaml` file.
32+
{% configuration %}
33+
api_key:
34+
description: Your API key.
35+
required: true
36+
type: string
37+
name:
38+
description: Name to use in the frontend.
39+
required: false
40+
type: string
41+
default: WorldTidesInfo
42+
latitude:
43+
description: Latitude of the location to display the tides.
44+
required: false
45+
type: float
46+
default: "The latitude in your `configuration.yaml` file."
47+
longitude:
48+
description: Longitude of the location to display the tides.
49+
required: false
50+
type: float
51+
default: "The longitude in your `configuration.yaml` file."
52+
{% endconfiguration %}
3253

source/_docs/configuration/basic.markdown

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ homeassistant:
2020
unit_system: metric
2121
time_zone: America/Los_Angeles
2222
name: Home
23+
whitelist_external_dirs:
24+
- /usr/var/dumping-ground
25+
- /tmp
2326
```
2427
2528
Configuration variables:

source/_docs/ecosystem/appdaemon.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,4 +107,4 @@ Of course, if I wanted to make this App or its predecessor reusable, I would hav
107107

108108
In addition, Apps can write to `AppDaemon`'s log files, and there is a system of constraints that allows you to control when and under what circumstances Apps and callbacks are active to keep the logic clean and simple.
109109

110-
For full installation instructions, see the [AppDaemon Project Documentation pages](http://appdaemon.readthedocs.io/en/stable/).
110+
For full installation instructions, see the [AppDaemon Project Documentation pages](http://appdaemon.readthedocs.io/en/stable/). If you're using Hassbian, then the [Hassbian scripts](https://github.com/home-assistant/hassbian-scripts/blob/dev/docs/appdaemon.md) make it easy to install.

source/_docs/ecosystem/backup/backup_github.markdown

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,27 +42,29 @@ $ sudo apt-get update
4242
$ sudo apt-get install git
4343
```
4444

45-
### {% linkable_title Step 2: Creating %} `.gitignore`
45+
### {% linkable_title Step 2: Creating `.gitignore` %}
4646

4747
<p class='note warning'>
4848
Before creating and pushing your Home Assistant configuration to GitHub, please make sure to follow the `secrets.yaml` best practice mentioned above and scrub your configuration for any passwords or sensitive information.
4949
</p>
5050

51-
Creating a `.gitignore` file in your repository will tell git which files NOT to push to the GitHub server. This should be used to prevent publishing sensitive files to the public. It should contain a list of filenames and pattern matches. This list should include at least your `secrets.yaml` file, device configuration files, and the Home Assistant database/directory structure. The `.gitignore` file should be placed in your Home Assistant directory.
51+
Creating a `.gitignore` file in your repository will tell git which files NOT to push to the GitHub server. This should be used to prevent publishing sensitive files to the public. It should contain a list of filenames and pattern matches. This list should include at least your `secrets.yaml` file, device configuration files, and the Home Assistant database/directory structure. The `.gitignore` file should be placed in the root of your Home Assistant configuration directory: `<config dir/.gitignore`.
5252

53-
Here is an example that will include your `.gitignore` file, a `scenes` directory, and all .yaml files except for `secrets.yaml` and `known_devices.yaml`. All other files will be excluded.
54-
55-
`.gitignore`
53+
Here is an example that will ignore everything but your YAML configuration.
5654

5755
```bash
56+
# Example .gitignore file for your config dir
5857
*
5958
!*.yaml
60-
!scenes
6159
!.gitignore
6260
secrets.yaml
6361
known_devices.yaml
6462
```
6563

64+
<p class='note'>
65+
You might read this guide too late and accidentally already have your secrets published. It is not enough to just remove them with a new commit. Git is a version control system and keeps history. You need to delete your repository and start a new one. Also change all passwords and revoke the API keys that were public.
66+
</p>
67+
6668
More information on the layout of the file can be found in the [.gitignore manual](https://git-scm.com/docs/gitignore).
6769

6870
### {% linkable_title Step 3: Preparing your Home Assistant directory for GitHub %}

source/_docs/ecosystem/hadashboard.markdown

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,4 @@ HADashboard is a modular, skinnable dashboard for [Home Assistant](/) that is in
3737
Glassic Theme
3838
</p>
3939

40-
41-
42-
For full installation instructions see the HADashboard section in the [AppDaemon Project Documentation](http://appdaemon.readthedocs.io/en/stable/DASHBOARD_INSTALL.html)
40+
For full installation instructions see the HADashboard section in the [AppDaemon Project Documentation](http://appdaemon.readthedocs.io/en/stable/DASHBOARD_INSTALL.html). If you're using Hassbian, then the [Hassbian scripts](https://github.com/home-assistant/hassbian-scripts/blob/dev/docs/appdaemon.md) make it easy to install AppDaemon.

source/_docs/mqtt/broker.markdown

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,25 +14,27 @@ The MQTT component needs you to run an MQTT broker for Home Assistant to connect
1414

1515
### {% linkable_title Embedded broker %}
1616

17-
Home Assistant contains an embedded MQTT broker. If no broker configuration is given, the [HBMQTT broker](https://pypi.python.org/pypi/hbmqtt) is started and Home Assistant connects to it. Embedded broker default configuration:
17+
Home Assistant contains an embedded MQTT broker called [HBMQTT](https://pypi.python.org/pypi/hbmqtt). If you don't have an MQTT broker, you can configure this one to be used. If configured, Home Assistant will automatically connect to it.
1818

1919
| Setting | Value |
2020
| -------------- | ----- |
2121
| Host | localhost |
2222
| Port | 1883 |
2323
| Protocol | 3.1.1 |
2424
| User | homeassistant |
25-
| Password | no default value |
25+
| Password | _password set under mqtt settings_ |
2626
| Websocket port | 8080 |
2727

28-
Since release 0.76, the embedded broker does not use your [API password](/components/http/) as the default password. The MQTT component will fail to set up if you have API password configured, but don't have MQTT password configured as in the following example.
29-
3028
```yaml
3129
# Example configuration.yaml entry
3230
mqtt:
33-
password: YOUR_MQTT_PASSWORD
31+
password: hello
3432
```
3533
34+
<p class='note'>
35+
Before release 0.76, the embedded broker would use your API password as a password to the MQTT user. This is no longer the case.
36+
</p>
37+
3638
<p class='note warning'>
3739
There is [an issue](https://github.com/beerfactory/hbmqtt/issues/62) with the HBMQTT broker and the WebSocket connection that is causing a memory leak. If you experience this issue, consider using another broker like Mosquitto.
3840
</p>

source/_docs/scripts/conditions.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ The template condition will test if the [given template][template] renders a val
163163
```yaml
164164
condition:
165165
condition: template
166-
value_template: '{% raw %}{{ states.device_tracker.iphone.attributes.battery > 50 }}{% endraw %}'
166+
value_template: "{% raw %}{{ state_attr('device_tracker.iphone', 'battery') > 50 }}{% endraw %}"
167167
```
168168

169169
Within an automation, template conditions also have access to the `trigger` variable as [described here][automation-templating].

0 commit comments

Comments
 (0)