Skip to content

Commit 5d0a917

Browse files
fabafffabaff
committed
Merge branch 'current' into next
2 parents b2032b2 + 2f3e9a1 commit 5d0a917

File tree

112 files changed

+1014
-352
lines changed

Some content is hidden

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

112 files changed

+1014
-352
lines changed

‎README.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This is the source for the [Home-Assistant.io website](https://home-assistant.io
99

1010
## Setup
1111

12-
Setting up to contribute to documentation and the process for submitting pull requests is [explained here](https://home-assistant.io/developers/website/).
12+
Setting up to contribute to documentation and the process for submitting pull requests is [explained here](https://home-assistant.io/developers/documentation/).
1313

1414
## Site preview
1515

‎_config.yml

Lines changed: 2 additions & 2 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: 54
142+
current_minor_version: 55
143143
current_patch_version: 0
144-
date_released: 2017-09-23
144+
date_released: 2017-10-07
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.

‎sass/inuitcss/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ stone, and you are encouranged to override and experiment with them.
180180
It is tempting to modify their vaules in the inuit.css submodule but this is
181181
**not** the correct method for modifying inuit.css, and in doing so you will
182182
prevent yourself from being able to update inuit.css’ core library. The correct
183-
proceedure is to redefine that variable in `_vars.scss` found in the inuit.css
183+
procedure is to redefine that variable in `_vars.scss` found in the inuit.css
184184
web template. Let’s take an example…
185185

186186
In inuit.css’ `_defaults.scss` we find the following:

‎source/_addons/configurator.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Screenshot of the HASS Configurator.
2828
- Upload and download files.
2929
- Stage and commit changes in Git repositories, create and switch between branches, push to remotes.
3030
- Lists of available triggers, events, entities, conditions and services. Selected element gets inserted into the editor at the last cursor position.
31-
- Restart Home Assitant directly with the click of a button. Reloading groups, automations etc. can be done as well. An API-password is required.
31+
- Restart Home Assistant directly with the click of a button. Reloading groups, automations etc. can be done as well. An API-password is required.
3232
- SSL support.
3333
- Optional authentication and IP filtering for added security.
3434
- Direct links to Home Assistant documentation and icons.

‎source/_addons/dhcp_server.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Configuration variables:
4747
 - **range_end** (*Required*): End address for dhcp leases.
4848
 - **broadcast** (*Required*): Network broadcast address.
4949
 - **gateway** (*Required*): A List of gateways.
50-
- **interface** (*Required*): Inteface on that will be listen. Normaly is `eth0` for ethernet wired connection and `wlan0` for wireless connection.
50+
- **interface** (*Required*): Inteface on that will be listen. Normally is `eth0` for ethernet wired connection and `wlan0` for wireless connection.
5151
- **hosts** (*Optional*): A list of fixed IPs for devices.
5252
- **name** (*Required*): Name/hostname of your device.
5353
 - **mac** (*Required*): Mac address of your device.

‎source/_addons/dnsmasq.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ Configuration variables:
3333
- **defaults** (*Required*): A list of dns server to forward default requests.
3434
- **forwards** (*Optional*): A list of domains that will forward to a specific server.
3535
- **hosts** (*Optional*): A list of hosts to resolve it static.
36-
- **interface** (*Optional*): If a interface is set, it listen only on this interface. Need to set for resinos. Normaly is `eth0` for ethernet wired connection and `wlan0` for wireless connection.
36+
- **interface** (*Optional*): If a interface is set, it listen only on this interface. Need to set for resinos. Normally is `eth0` for ethernet wired connection and `wlan0` for wireless connection.

‎source/_addons/mariadb.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sharing: true
99
footer: true
1010
---
1111

12-
Set up a [mariadb](https://mariadb.org/) SQL server. It support multible database, users and permission. If you want only connect from inside use `core-mariadb` as host address.
12+
Set up a [mariadb](https://mariadb.org/) SQL server. It supports multiple databases, users and permission settings. If you want to only connect from inside home assistant use `core-mariadb` as the host address.
1313

1414
```json
1515
{

‎source/_addons/rpc_shutdown.markdown

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
layout: page
3+
title: "RPC Shutdown"
4+
description: "Simple way for remote windows shutdowns."
5+
date: 2017-09-25 14:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
---
11+
12+
Allow to shutdown a computer with a service call from Home-Assistant.
13+
14+
```json
15+
{
16+
"computers": [
17+
{
18+
"alias": "test-pc",
19+
"address": "192.168.0.1",
20+
"credentials": "user%password"
21+
}
22+
]
23+
}
24+
```
25+
26+
- **computers** (*Required*): A list of computer object to shutdown from Home-Assistant.
27+
- **computers/alias** (*Required*): Set a alias for this record and that is the name for the input.
28+
- **computers/address** (*Required*): IP address or netbios name of the computer for shutdown.
29+
- **computers/credentials** (*Required*): Credentials for logging into computer. Use a `%` as delimiter of username and password.
30+
31+
## {% linkable_title Home Assistant %}
32+
33+
Use the following inside Home Assistant service call to use it:
34+
35+
```yaml
36+
service: hassio.addon_stdin
37+
data:
38+
addon: core_rpc_shutdown
39+
input: test-pc
40+
```

‎source/_addons/samba.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ Configuration variables:
3838
- **map** (*Optional*): Control which folder will be expose. `config` is for Home Assistant configuration folder. `addons` for local custom repositiory. `share` is a folder that can access from add-ons and Home Assistant too. `backup` for access to snapshot files. `ssl` for certificate storage, be careful with this option! Defaults all to `true`, except for `ssl`.
3939
- **username** (*Optional*): The username for logging in if guest login is not used.
4040
- **password** (*Optional*): Password for `username`. An empty password is not supported.
41-
- **interface** (*Optional*): Interface on that will start the share. Normaly is `eth0` for ethernet wired connection and `wlan0` for wireless connection.
41+
- **interface** (*Optional*): Interface on that will start the share. Normally is `eth0` for ethernet wired connection and `wlan0` for wireless connection.

‎source/_components/alexa.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The built-in Alexa component allows you to integrate Home Assistant into Alexa/A
3333

3434
### {% linkable_title Requirements %}
3535

36-
Amazon requires the endpoint of a skill to be hosted via SSL. Self-signed certificates are OK because our skills will only run in development mode. Read more on [our blog][blog-lets-encrypt] about how to set up encryption for Home Assistant. When running Hass.io, using the [Let's Encrypt](/addons/lets_encrypt/) the and [Duck DNS](/addons/duckdns/) add-ons is the easiest method. If you are unable to get HTTPS up and running, consider using [this AWS Lambda proxy for Alexa skills](https://community.home-assistant.io/t/aws-lambda-proxy-custom-alexa-skill-when-you-dont-have-https/5230).
36+
Amazon requires the endpoint of a skill to be hosted via SSL. Self-signed certificates are OK because our skills will only run in development mode. Read more on [our blog][blog-lets-encrypt] about how to set up encryption for Home Assistant. When running Hass.io, using the [Let's Encrypt](/addons/lets_encrypt/) and [Duck DNS](/addons/duckdns/) add-ons is the easiest method. If you are unable to get HTTPS up and running, consider using [this AWS Lambda proxy for Alexa skills](https://community.home-assistant.io/t/aws-lambda-proxy-custom-alexa-skill-when-you-dont-have-https/5230).
3737

3838
Additionally, note that at the time of this writing, your Alexa skill endpoint *must* accept requests over port 443 (Home Assistant default to 8123). There are two ways you can handle this:
3939

‎source/_components/binary_sensor.wink.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The requirement is that you have setup [Wink](/components/wink/).
2525
- Window/Door sensors
2626
- Motion sensors
2727
- Ring Door bells (No hub required)
28-
- Liquid presense sensors
28+
- Liquid presence sensors
2929
- Z-wave lock key codes
3030
- Lutron connected bulb remote buttons
3131
- Wink Relay buttons and presence detection

‎source/_components/cover.rflink.markdown

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,18 @@ ha_category: Cover
1212
ha_release: 0.55
1313
---
1414

15-
The `rflink` component support devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example, the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
15+
16+
The `rflink` cover platform supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example, the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
1617

1718
First, you have to set up your [rflink hub](/components/rflink/).
19+
1820
After configuring the RFLink hub covers will be automatically discovered and added. Except the Somfy RTS devices.
1921

20-
### {% setting up a Somfy RTS device%}
22+
### {% linkable_title Setting up a Somfy RTS device %}
2123

22-
You have to add the Somfy RTS manually with the supplied RFlinkLoader (Windows Only)
24+
You have to add the Somfy RTS manually with the supplied RFlinkLoader (Windows only).
2325

24-
Press the Learn button on the original Somfy remote
25-
enter the following code within 3 seconds. Your blinds will go up and down shortly
26+
Press the Learn button on the original Somfy remote enter the following code within 3 seconds. Your blinds will go up and down shortly:
2627

2728
````
2829
10;RTS;02FFFF;0412;3;PAIR;
@@ -53,7 +54,7 @@ RTS Record: 14 Address: FFFFFF RC: FFFF
5354
RTS Record: 15 Address: FFFFFF RC: FFFF
5455
````
5556

56-
After configuring the RFLink Somfy RTS you have to add the cover to the configuration like any other RFlink device.
57+
After configuring the RFLink Somfy RTS you have to add the cover to the `configuration.yaml` file like any other RFlink device.
5758

5859
RFLink cover ID's are composed of: protocol, id, and gateway. For example: `RTS_0100F2_0`.
5960

@@ -63,24 +64,24 @@ Assigning a name to a cover:
6364

6465
```yaml
6566
# Example configuration.yaml entry
66-
- platform: rflink
67-
devices:
68-
RTS_0100F2_0:
69-
name: SunShade
70-
bofumotor_455201_0f:
71-
name: Sovrumsgardin
67+
cover:
68+
- platform: rflink
69+
devices:
70+
RTS_0100F2_0:
71+
name: SunShade
72+
bofumotor_455201_0f:
73+
name: Sovrumsgardin
7274
```
7375
74-
75-
### Configuration variables:
76+
Configuration variables:
7677
7778
- **automatic_add** (*Optional*): Automatically add new/unconfigured devices to Home Assistant if detected (default: True).
7879
- **devices** (*Optional*): A list of devices with their name to use in the frontend.
7980
- **device_defaults**: (*Optional*)
8081
- **fire_event** (*Optional*): Set default `fire_event` for Rflink switch devices (see below).
8182
- **signal_repetitions** (*Optional*): Set default `signal_repetitions` for Rflink switch devices (see below).
8283

83-
### Device configuration variables:
84+
Device configuration variables:
8485

8586
- **name** (*Optional*): Name for the device, defaults to Rflink ID.
8687
- **aliases** (*Optional*): Alternative Rflink ID's this device is known by.

‎source/_components/emulated_hue.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,15 +96,15 @@ homeassistant:
9696
customize:
9797
light.bedroom_light:
9898
# Don't allow light.bedroom_light to be controlled by the emulated Hue bridge
99-
emulated_hue: false
99+
emulated_hue_hidden: false
100100
light.office_light:
101101
# Address light.office_light as "back office light"
102102
emulated_hue_name: "back office light"
103103
```
104104

105105
The following are attributes that can be applied in the `customize` section:
106106

107-
- **emulated_hue** (*Optional*): Whether or not the entity should be exposed by the emulated Hue bridge. The default value for this attribute is controlled by the `expose_by_default` option.
107+
- **emulated_hue_hidden** (*Optional*): Whether or not the entity should be exposed by the emulated Hue bridge. Adding `emulated_hue_hidden: false` will expose the entity to Alexa. The default value for this attribute is controlled by the `expose_by_default` option.
108108
- **emulated_hue_name** (*Optional*): The name that the emulated Hue will use. The default for this is the entity's friendly name.
109109

110110
### {% linkable_title Troubleshooting %}

‎source/_components/ffmpeg.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You need the `ffmpeg` binary in your system path. On Debian 8 or Raspbian (Jessi
1818
</p>
1919

2020
<p class='note'>
21-
If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fullfilled.
21+
If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.
2222
</p>
2323

2424
To set it up, add the following information to your `configuration.yaml` file:

‎source/_components/image_processing.opencv.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ha_release: 0.47
1515

1616
[OpenCV](http://www.opencv.org) is an open source computer vision image and video processing library.
1717

18-
Some pre-defined classifiers can be found here: https://github.com/opencv/opencv/tree/master/data
18+
Some pre-defined classifiers can be found [here](https://github.com/opencv/opencv/tree/master/data).
1919

2020
To setup OpenCV with Home Assistant, add the following section to your `configuration.yaml` file:
2121

@@ -34,7 +34,7 @@ image_processing:
3434
- **source** array (*Required*): List of image sources.
3535
- **entity_id** (*Required*): A camera entity id to get picture from.
3636
- **name** (*Optional*): This parameter allows you to override the name of your `image_processing` entity.
37-
- **classifier** (*Optional*): Dictionary of name to path to the classifier xml file. If this field is not provided, a face classifier will be downloaded from OpenCV's github repo.
37+
- **classifier** (*Optional*): Dictionary of name to path to the classifier xml file. If this field is not provided, a face classifier will be downloaded from OpenCV's Github repo.
3838

3939
**classifier** may also be defined as a dictionary of names to classifier configurations:
4040

@@ -50,4 +50,4 @@ image_processing:
5050
- **scale** (*Optional*): The scale to perform when processing, this is a `float` value that must be greater than or equal to `1.0`, default is `1.1`.
5151
- **neighbors** (*Optional*): The minimum number of neighbors required for a match, default is `4`. The higher this number, the more picky the matching will be; lower the number, the more false positives you may experience.
5252

53-
If you would like to see the regions that OpenCV has detected, add this opencv camera to your config's custom_components/camera directory: [https://gist.github.com/Teagan42/bf4b941b34a79a3e184e149ff1efd82f](https://gist.github.com/Teagan42/bf4b941b34a79a3e184e149ff1efd82f)
53+
If you would like to see the regions that OpenCV has detected, add this OpenCV camera to your config's `custom_components/camera` directory: [https://gist.github.com/Teagan42/bf4b941b34a79a3e184e149ff1efd82f](https://gist.github.com/Teagan42/bf4b941b34a79a3e184e149ff1efd82f)

‎source/_components/input_datetime.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sharing: true
99
footer: true
1010
logo: home-assistant.png
1111
ha_category: Automation
12-
ha_release: TODO
12+
ha_release: 0.55
1313
---
1414

1515
The `input_datetime` component allows the user to define date and time values that can be controlled via the frontend and can be used within automations and templates.

‎source/_components/input_number.markdown

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: home-assistant.png
1111
ha_category: Automation
1212
ha_release: 0.16
13+
redirect_from: /components/input_slider/
1314
---
1415

1516
The `input_number` component allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. The frontend can display a slider, or a numeric input box. Changes to the slider or numeric input box generate state events. These state events can be utilized as `automation` triggers as well.
@@ -43,6 +44,8 @@ Configuration variables:
4344
- **initial** (*Optional*): Initial value when Home Assistant starts. Defaults to 0.
4445
- **step** (*Optional*): Step value for the slider. Defaults to 1.
4546
- **mode** (*Optional*): Can specify `box`, or `slider`. Defaults to `slider`.
47+
- **unit_of_measurement** (*Optional*): Unit of measurement in which the value of the slider is expressed in.
48+
- **icon** (*Optional*): Icon to display in front of the box/slider in the frontend. Refer to the [Customizing devices](https://home-assistant.io/docs/configuration/customizing-devices/#possible-values) page for possible values.
4649

4750
## {% linkable_title Automation Examples %}
4851

‎source/_components/light.decora.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Configuration variables:
3333
- **devices** array (*Required*): A list of lights to use.
3434
- **[mac address]** (*Required*): The bluetooth address of the switch.
3535
- **name** (*Optional*): The custom name to use in the frontend.
36-
- **api_key** (*Required*): The API key to acces the device.
36+
- **api_key** (*Required*): The API key to access the device.
3737
3838
<p class='note'>
3939
If you get an error looking like this:

‎source/_components/lock.nello.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Every time someone rings the bell, a `nello_bell_ring` event will be fired.
4646
Field | Description
4747
----- | -----------
4848
`address` | Postal address of the lock.
49-
`date` | Date when the event occured.
49+
`date` | Date when the event occurred.
5050
`description` | Human readable string describing the event.
5151
`location_id` | Nello ID of the location where the bell has been rung.
5252
`short_id` | Shorter Nello ID.

‎source/_components/media_extractor.markdown

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,20 +41,29 @@ media_extractor:
4141
music: bestaudio[ext=mp3]
4242
```
4343
44-
This configuration sets query for all service calls like: ```{"entity_id": "media_player.my_sonos", "media_content_id": "https://soundcloud.com/bruttoband/brutto-11", "media_content_type": "music"}``` to 'bestaudio' with mp3 extention.
44+
This configuration sets query for all service calls like to 'bestaudio' with the mp3 extension:
45+
46+
```json
47+
{
48+
"entity_id": "media_player.my_sonos",
49+
"media_content_id": "https://soundcloud.com/bruttoband/brutto-11",
50+
"media_content_type": "music"
51+
}
52+
```
4553

4654
Query examples with explanations:
47-
* **bestvideo** - best video only stream
48-
* **best** - best video + audio stream
49-
* **bestaudio[ext=m4a]** - best audio stream with m4a extension
50-
* **worst** - worst video + audio stream
51-
* **bestaudio[ext=m4a]/bestaudio[ext=ogg]/bestaudio** - best m4a audio, otherwise best ogg audio and only then any best audio
55+
56+
* **bestvideo**: Best video only stream
57+
* **best**: Best video + audio stream
58+
* **bestaudio[ext=m4a]**: Best audio stream with m4a extension
59+
* **worst**: Worst video + audio stream
60+
* **bestaudio[ext=m4a]/bestaudio[ext=ogg]/bestaudio**: Best m4a audio, otherwise best ogg audio and only then any best audio
5261

5362
More info about queries [here](https://github.com/rg3/youtube-dl#format-selection)
5463

5564
### {% linkable_title Use the service %}
5665

57-
Go to the "Developer Tools," then to "Call Service," and choose `media_extractor/play_media` from the list of available services. Fill the "Service Data" field as shown in the example below and hit "CALL SERVICE."
66+
Use <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> **Services** from the **Developer Tools**. Choose `media_extractor` from the dropdown menu **Domain** and `play_media` from **Service**, enter something like the JSON sample from above into the **Service Data** field, and hit **CALL SERVICE**.
5867

5968
This will download the file from the given URL.
6069

‎source/_components/media_player.frontier_silicon.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Configuration variables:
4343
- **port** (*Optional*): The port number. Defaults to 80.
4444
- **password** (*Optional*): PIN code of the Internet Radio. Defaults to 1234.
4545
46-
Some models use a seperate port (2244) for API access, this can be verified by visiting http://[host]:[port]/device.
46+
Some models use a separate port (2244) for API access, this can be verified by visiting http://[host]:[port]/device.
4747
4848
In case your device (friendly name) is called *badezimmer*, an example automation can look something like this:
4949

0 commit comments

Comments
 (0)