Skip to content

Commit eb55a27

Browse files
committed
Merge branch 'current' into next
2 parents 6b61e4b + 1515095 commit eb55a27

23 files changed

+157
-63
lines changed

_config.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -140,13 +140,13 @@ social:
140140
# Home Assistant release details
141141
current_major_version: 0
142142
current_minor_version: 63
143-
current_patch_version: 0
144-
date_released: 2018-02-10
143+
current_patch_version: 2
144+
date_released: 2018-02-14
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: "#"
149+
patch_version_notes: "#release-0632---february-14"
150150
# Minor release (Example #release-0431---april-25):
151151

152152
# Date we moved to Discourse for comments

source/_addons/samba.markdown

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This addon allows you to set up a [Samba](https://samba.org/) server to access h
2222
"addons": true,
2323
"share": true,
2424
"backup": true,
25-
"ssl": false,
25+
"ssl": false
2626
},
2727
"username": "",
2828
"password": "",
@@ -32,10 +32,10 @@ This addon allows you to set up a [Samba](https://samba.org/) server to access h
3232

3333
Configuration variables:
3434

35-
- **name** (*Optional*): default `hassio`. Set NetBIOS name of hassio device.
36-
- **workgroup** (*Optional*): default `WORKGROUP`. Set network workgroup.
37-
- **guest** (*Optional*): Allow login without a username or password. Defaults to `true`.
38-
- **map** (*Optional*): Control which folder will be exposed. `config` is for Home Assistant configuration folder. `addons` for a local custom repository. `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`.
39-
- **username** (*Optional*): The username for logging in if guest login is not used.
35+
- **name** (*Optional*): Set netbios name of Hass.io device. Default is `hassio`.
36+
- **workgroup** (*Optional*): Set network workgroup name. Default is `WORKGROUP`.
37+
- **guest** (*Optional*): Allow login without a username or password. Default is `true`.
38+
- **map** (*Optional*): Control which folders will be exposed. `config` shares the Home Assistant configuration folder. `addons` shares the local custom repositiory. `share` shares a folder that can be accessed by add-ons and Home Assistant. `backup` shares access to snapshot files. `ssl` shares certificate storage. Be careful with the `ssl` option! Defaults are all set to `true`, except for `ssl`.
39+
- **username** (*Optional*): 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. Normally is `eth0` for ethernet wired connection and `wlan0` for wireless connection.
41+
- **interface** (*Optional*): Interface that will start the share. Normally this is `eth0` for ethernet wired connection and `wlan0` for wireless connection.

source/_components/binary_sensor.mercedesme.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ The `Mercedes me` platform allows you to get data from your [Mercedes me connect
1717

1818
They will be automatically discovered if the Mercedes me component is loaded.
1919

20-
For more configuration information see the [Mercedes me component](/components/mercedes me/) documentation.
20+
For more configuration information see the [Mercedes me component](/components/mercedesme/) documentation.

source/_components/history.markdown

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ha_release: pre 0.7
1313
---
1414

1515

16-
The `history` component will track everything that is going on within Home Assistant and allows the user to browse through it. It depends on the `recorder` component for storing the data and uses the same database setting. If any entities are excluded from being recorded, no history will be available for these entities as well.
16+
The `history` component will track everything that is going on within Home Assistant and allows the user to browse through it. It depends on the `recorder` component for storing the data and uses the same database setting. If any entities are excluded from being recorded, no history will be available for these entities.
1717

1818
To enable the history option in your installation, add the following to your `configuration.yaml` file:
1919

@@ -42,9 +42,9 @@ Configuration variables:
4242
- **entities** (*Optional*): The list of entity ids to be included to the history.
4343
- **domains** (*Optional*): The list of domains to be included to the history.
4444
45-
Without any `include` or `exclude` configuration the history displays graphs for every entity (well that's not exactly true - for instance `hidden` entities or `scenes` are never shown) on a given date. If you are only interested in some of the entities you several options:
45+
Without any `include` or `exclude` configuration the history displays graphs for every entity (well that's not exactly true - for instance `hidden` entities or `scenes` are never shown) on a given date. If you are only interested in some of the entities you have several options:
4646

47-
Define domains and entities to `exclude` (aka. blacklist). This is convenient when you are basically happy with the information displayed, but just want to remove some entities or domains. Usually these are entities/domains which do not change (like `weblink`) or rarely change (`updater` or `automation`).
47+
Define domains and entities to `exclude` (aka. blacklist). This is convenient when you are basically happy with the information displayed, but just want to remove some entities or domains. Usually these are entities/domains which do not change (like `weblink`) or rarely change (like `updater` or `automation`).
4848

4949
```yaml
5050
# Example configuration.yaml entry with exclude
@@ -59,7 +59,7 @@ history:
5959
- sensor.date
6060
```
6161

62-
Define domains and entities to display by using the `include` configuration (aka. whitelist). If you have a lot of entities in your system and your `exclude` lists possibly get very large, it might be better just to define the entities or domains to display.
62+
Define domains and entities to display by using the `include` configuration (aka. whitelist). If you have a lot of entities in your system and your `exclude` list is getting too large, it might be better just to define the entities or domains to `include`.
6363

6464
```yaml
6565
# Example configuration.yaml entry with include
@@ -104,7 +104,7 @@ history:
104104

105105
#### {% linkable_title Implementation details %}
106106

107-
The history is stored in a SQLite database `home-assistant_v2.db` within your configuration directory if the `recorder` component is not set up differently.
107+
The history is stored in a SQLite database `home-assistant_v2.db` within your configuration directory unless the `recorder` component is set up differently.
108108

109109
- events table is all events except `time_changed` that happened while recorder component was running.
110110
- states table contains all the `new_state` values of `state_changed` events.
@@ -129,4 +129,4 @@ datetime.fromtimestamp(1422830502)
129129

130130
#### {% linkable_title API %}
131131

132-
The history information are also available through the [RESTful API](/developers/rest_api/#get-apihistory).
132+
The history information is also available through the [RESTful API](/developers/rest_api/#get-apihistory).

source/_components/input_number.markdown

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ redirect_from: /components/input_slider/
1414
---
1515

1616
<p class='note'>
17-
Before version 0.55 this component was known as `input_slider` and did not have the `mode` configuration option.
17+
Before version 0.55 this component was known as `input_slider` and did not have the `mode` configuration option. Also, service `select_value` is now `set_value`.
1818
</p>
1919

2020
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.
@@ -39,7 +39,6 @@ input_number:
3939
mode: box
4040
```
4141
42-
4342
{% configuration %}
4443
input_number:
4544
description: Alias for the input. Multiple entries are allowed.

source/_components/input_text.markdown

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ha_category: Automation
1212
ha_release: 0.53
1313
---
1414

15-
The `input_text` component allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. Changes to the value stored in the text box generate state events. These state events can be utilized as `automation` triggers as well.
15+
The `input_text` component allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. Changes to the value stored in the text box generate state events. These state events can be utilized as `automation` triggers as well. It can also be configured in password mode (obscured text).
1616

1717
```yaml
1818
# Example configuration.yaml entries
@@ -27,6 +27,9 @@ input_text:
2727
text3:
2828
name: Text 3
2929
pattern: '[a-fA-F0-9]*'
30+
text4:
31+
name: Text 4
32+
mode: password
3033
```
3134
3235
{% configuration %}
@@ -59,6 +62,11 @@ input_text:
5962
required: false
6063
type: String
6164
default: empty
65+
mode:
66+
description: Can specify `text` or `password`. Elements of type "password" provide a way for the user to securely enter a value.
67+
required: false
68+
type: String
69+
default: text
6270
{% endconfiguration %}
6371

6472
### {% linkable_title Restore State %}

source/_components/media_player.mediaroom.markdown

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,12 @@ Notice that all parameters are optional, and discovery should configure everythi
4747
4848
The component has been developed for Portuguese TV operators currently using the Mediaroom platform, but should also work in other deployments in which the STB can be controlled remotely through a socket on port 8082.
4949
50-
In most cases (single STB) you just need to setup the *name* and discovery will do the rest. In case you have more than one STB you are required to set the *host* in each one of the entries.
50+
In most cases (single STB) you just need to setup the *platform* and discovery will do the rest. In case you have more than one STB you are required to set the *host* in each one of the entries.
5151
5252
If the STB is on the same network segment as Home Assistant, it can determine whether the device is turned on or off. Without this, the component will fail to determine the Set-top box status, and you are required to add the *optimistic* configuration variable.
5353
54+
## {% linkable_title Examples %}
55+
5456
### {% linkable_title Example `press_button` script %}
5557

5658
The `play_media` function can be used in scripts to change channels.
@@ -65,4 +67,16 @@ press_button:
6567
entity_id: media_player.mediaroom_stb
6668
media_content_id: "{{ value }}"
6769
media_content_type: "channel"
70+
71+
### {% linkable_title Example configuration with 2 STB %}
72+
73+
```yaml
74+
# Example configuration.yaml entry for 2 STB
75+
media_player:
76+
- platform: mediaroom
77+
host: 192.168.1.64
78+
name: Living Room STB
79+
- platform: mediaroom
80+
host: 192.168.1.65
81+
name: Bedroom STB
6882
```

source/_components/mercedesme.markdown

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,8 @@ scan_interval:
4848
required: true
4949
default: 30
5050
type: int
51-
{% endconfiguration %}
51+
{% endconfiguration %}
52+
53+
<p class='note'>
54+
The requirement `lxml` has to be [installed](http://lxml.de/installation.html) manually `pip install lxml` on some devices.
55+
</p>

source/_components/sensor.sql.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,12 @@ SELECT * FROM states WHERE entity_id='binary_sensor.xyz789' GROUP BY state ORDER
9090

9191
### {% linkable_title Database size in Postgres %}
9292

93-
```sql
94-
SELECT pg_size_pretty(pg_database_size('Database Name'));
93+
```yaml
94+
- platform: sql
95+
db_url: postgresql://user:password@host/dbname
96+
queries:
97+
- name: db_size
98+
query: "SELECT (pg_database_size('dsmrreader')/1024/1024) as db_size;"
99+
column: "db_size"
100+
unit_of_measurement: MB
95101
```

source/_components/sensor.steam_online.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ ha_release: 0.14
1616

1717
The Steam component will allow you to track the online status of public [Steam](https://steamcommunity.com) accounts.
1818

19-
You need an API key which is [free](https://steamcommunity.com/dev/apikey) to use the component
19+
You need a [free API key](https://steamcommunity.com/dev/apikey) to use the component
2020

21-
To find an account's 64-bit SteamID you can check the URL of the profile page, if it ends with a long string on numbers then that's the 64-bit SteamID. However, if the profile has a custom URL you will have to copy the it and enter it into [STEAMID I/O](https://steamid.io/) to find the 64-bit SteamID.
21+
To find an account's 64-bit SteamID on profiles without a custom URL you can check the URL of the profile page, the long string of numbers at the end is the 64-bit SteamID. If the profile has a custom URL you will have to copy the URL into [STEAMID I/O](https://steamid.io/) to find the 64-bit SteamID.
2222

2323
To use Steam in your installation, add the following to your `configuration.yaml` file:
2424

source/_components/sensor.systemmonitor.markdown

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,15 +60,6 @@ The table contains types and their argument to use in your `configuration.yaml`
6060
| last_boot | |
6161
| since_last_boot | |
6262

63-
**Note**: Some `type:` names used in the `configuration.yaml` file differ from the entity names.
64-
65-
| Sensor type | Entity ID |
66-
| :------------------ |:-------------------------|
67-
| memory_free | sensor.ram_available |
68-
| memory_use_percent | sensor.ram_used |
69-
| processor_use | sensor.cpu_used |
70-
| disk_use | sensor.disk_used |
71-
7263
## {% linkable_title Linux specific %}
7364

7465
To retrieve all available network interfaces on a Linux System, execute the `ifconfig` command.

source/_components/switch.rpi_gpio.markdown

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,13 @@ Configuration variables:
3232
- **ports** array (*Required*): Array of used ports.
3333
- **port: name** (*Required*): Port numbers and corresponding names (GPIO #).
3434
- **invert_logic** (*Optional*): If true, inverts the output logic to ACTIVE LOW. Default is false (ACTIVE HIGH).
35-
- **shared_gpio** (*Optional*): If true, forces a GPIO.setup() before each write. Default is false.
3635
3736
For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi.
3837
38+
<p class='note warning'>
39+
Note that a pin managed by HASS is expected to be exclusive to HASS.
40+
</p>
41+
3942
A common question is what does Port refer to, this number is the actual GPIO # not the pin #.
4043
For example, if you have a relay connected to pin 11 its GPIO # is 17.
4144
@@ -47,14 +50,4 @@ switch:
4750
17: Speaker Relay
4851
```
4952
50-
In case you have any other python scripts running that use RPi.GPIO no values will be written after the initial HASS-start.
51-
Setting **shared_gpio** to true will reinit the pin before each write, working around this issue.
52-
```yaml
53-
# Example configuration.yaml entry
54-
switch:
55-
- platform: rpi_gpio
56-
shared_gpio: true
57-
ports:
58-
19: LED-Red
59-
```
6053

source/_docs/ecosystem/appdaemon.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ class FlashyMotionLights(appapi.AppDaemon):
7676

7777
This is starting to get a little more complex in Home Assistant automations, requiring an automation rule and two separate scripts.
7878

79-
Now let's extend this with a somewhat artificial example to show something that is simple in AppDaemon but very difficult if not impossible using automations. Let's warn someone inside the house that there has been motion outside by flashing a lamp on and off ten times. We are reacting to the motion as before by turning on the light and setting a timer to turn it off again, but in addition, we set a 1-second timer to run `flash_warning()`, which, when called, toggles the inside light and sets another timer to call itself a second later. To avoid re-triggering forever, it keeps a count of how many times it has been activated and bales out after ten iterations.
79+
Now let's extend this with a somewhat artificial example to show something that is simple in AppDaemon but very difficult if not impossible using automations. Let's warn someone inside the house that there has been motion outside by flashing a lamp on and off ten times. We are reacting to the motion as before by turning on the light and setting a timer to turn it off again, but in addition, we set a 1-second timer to run `flash_warning()`, which, when called, toggles the inside light and sets another timer to call itself a second later. To avoid re-triggering forever, it keeps a count of how many times it has been activated and bails out after ten iterations.
8080

8181
```python
8282
import appdaemon.appapi as appapi

source/_docs/ecosystem/hass-configurator.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,8 @@ Since the configurator script on its own is no service, you will have to take so
109109
110110
1. Fork the process into the background with the command:
111111
`nohup sudo ./configurator.py &`
112-
2. If your system is using systemd (that's usually what you'll find on a Raspberry Pi), there's a [template file](https://github.com/danielperna84/hass-configurator/blob/master/hass-poc-configurator.systemd) you can use and then apply the same process to integrate it as mentioned in the [Home Assistant documentation](https://home-assistant.io/docs/autostart/systemd/). If you use this method you have to set the `BASEPATH` variable according to your environment.
113-
3. If you have [supervisor](http://supervisord.org/) running on your system, [hass-poc-configurator.supervisor](https://github.com/danielperna84/hass-configurator/blob/master/hass-poc-configurator.supervisor) would be an example configuration you could use to control the configurator.
112+
2. If your system is using systemd (that's usually what you'll find on a Raspberry Pi), there's a [template file](https://github.com/danielperna84/hass-configurator/blob/master/hass-configurator.systemd) you can use and then apply the same process to integrate it as mentioned in the [Home Assistant documentation](https://home-assistant.io/docs/autostart/systemd/). If you use this method you have to set the `BASEPATH` variable according to your environment.
113+
3. If you have [supervisor](http://supervisord.org/) running on your system, [hass-poc-configurator.supervisor](https://github.com/danielperna84/hass-configurator/blob/master/hass-configurator.supervisor) would be an example configuration you could use to control the configurator.
114114
4. A tool called [tmux](https://tmux.github.io/), which should be pre-installed with [HASSbian](https://home-assistant.io/docs/hassbian/).
115115
5. A tool called [screen](http://ss64.com/bash/screen.html) (alternative to tmux). If it's not already installed on your system, you can do `sudo apt-get install screen` or `sudo yum install screen` to get it. When it's installed, start a screen session by executing `screen`. Then navigate to your Home Assistant directory and start the configurator like described above. Put the screen session into the background by pressing `CTRL+A` and then `CTRL+D`. It is now safe to disconnect from your SSH session.
116116
To resume the screen session, log in to your machine and execute `screen -r`.

source/_docs/mqtt/discovery.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ The following firmware for ESP8266, ESP32 and Sonoff unit has built-in support f
5858
- [Sonoff-Tasmota](https://github.com/arendst/Sonoff-Tasmota) (starting with 5.11.1e)
5959
- [esphomelib](https://github.com/OttoWinter/esphomelib)
6060
- [ESPurna](https://github.com/xoseperez/espurna)
61+
- [Arilux AL-LC0X LED controllers](https://github.com/mertenats/Arilux_AL-LC0X)
6162

6263
### {% linkable_title Examples %}
6364

source/_docs/scripts/conditions.markdown

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ condition:
3030
3131
### {% linkable_title OR condition %}
3232
33-
Test multiple conditions in 1 condition statement. Passes if any embedded conditions is valid.
33+
Test multiple conditions in 1 condition statement. Passes if any embedded condition is valid.
3434
3535
```yaml
3636
condition:
@@ -114,6 +114,16 @@ condition:
114114
after_offset: "-1:00:00"
115115
```
116116

117+
```yaml
118+
condition:
119+
condition: or # 'when dark' condition: either after sunset or before sunrise
120+
conditions:
121+
- condition: sun
122+
after: sunset
123+
- condition: sun
124+
before: sunrise
125+
```
126+
117127
Here is a truth table to clarify the parameters with and without offset:
118128

119129
| command | night | at sunrise | daytime | at sunset |

source/_docs/z-wave/installation.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ $ sudo /Applications/Python\ x.x/Install\ Certificates.command
3636

3737
### {% linkable_title Raspberry Pi %}
3838

39-
On Raspberry Pi you will need to enable the serial interface in the `raspbi-config` tool before you can add Z-Wave to Home Assistant.
39+
On Raspberry Pi you will need to enable the serial interface in the `raspi-config` tool before you can add Z-Wave to Home Assistant.
4040

4141
## {% linkable_title Configuration %}
4242

0 commit comments

Comments
 (0)