Skip to content

Commit 194b8b8

Browse files
author
Paulus Schoutsen
committed
Merge remote-tracking branch 'origin/current' into next
2 parents 3f4f298 + 4e60e4d commit 194b8b8

33 files changed

+330
-105
lines changed

‎_config.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,9 +128,9 @@ social:
128128
# Home Assistant release details
129129
current_major_version: 0
130130
current_minor_version: 39
131-
current_patch_version: 2
132-
date_released: 2017-03-01
131+
current_patch_version: 3
132+
date_released: 2017-03-04
133133

134134
# Either # or the anchor link to latest release notes in the blog post.
135135
# Must be prefixed with a # and have double quotes around it.
136-
patch_version_notes: "#release-0392---march-1"
136+
patch_version_notes: "#release-0393---march-4"

‎source/_components/binary_sensor.nx584.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,4 @@ binary_sensor:
4848
2: opening
4949
4: motion
5050
6: moisture
51+
```

‎source/_components/climate.honeywell.markdown

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,16 @@ climate:
2121
platform: honeywell
2222
username: YOUR_USERNAME
2323
password: YOUR_PASSWORD
24+
scan_interval: 600
2425
```
26+
<p class='note'>
27+
Scan interval is expressed in seconds. Omitting scan_interval may result in too-frequent polling and cause you to rate-limited by Honeywell.
28+
</p>
2529
2630
Configuration variables:
2731
2832
- **username** (*Required*): The username of an user with access.
2933
- **password** (*Required*): The password for your given admin account.
30-
- **away_temperature** (*optional*): Heating setpoint when away mode is on. If omitted it defaults to 16.0 deg C.
31-
- **region** (*optional*): Region identifier (either 'eu' or 'us'). Defaults to 'eu' if not provided.
34+
- **away_temperature** (*Optional*): Heating setpoint when away mode is on. If omitted it defaults to 16.0 deg C.
35+
- **region** (*Optional*): Region identifier (either 'eu' or 'us'). Defaults to 'eu' if not provided.
36+
- **scan_interval**(*Optional*): Scan interval is expressed in seconds. Recommended value of 600 seconds. Default value is 120 seconds. Omitting scan_interval may result in too-frequent polling and cause you to rate-limited by Honeywell.

‎source/_components/device_tracker.asuswrt.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ Configuration variables:
3535
- **username** (*Required*: The username of an user with administrative privileges, usually `admin`.
3636
- **password** (*Optional*): The password for your given admin account (use this if no SSH key is given).
3737
- **protocol** (*Optional*): The protocol (`ssh` or `telnet`) to use. Defaults to `ssh`.
38+
- **port** (*Optional*): SSH port to use. Defaults to `22`.
3839
- **mode** (*Optional*): The operating mode of the router (`router` or `ap`). Defaults to `router`.
3940
- **ssh_key** (*Optional*): The path to your SSH private key file associated with your given admin account (instead of password).
4041

‎source/_components/sensor.pocketcasts.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ sidebar: true
77
comments: false
88
sharing: true
99
footer: true
10+
logo: pocketcasts.png
1011
ha_category: Sensor
1112
ha_release: 0.39
1213
---

‎source/_components/switch.broadlink.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ First get or learn all the remotes you want to add on HA in E-Control
150150
151151
1. Download
152152
153-
Get the script from [here](https://github.com/NightRang3r/Broadlink-e-control-db-dump5).
153+
Get the script from [here](https://github.com/NightRang3r/Broadlink-e-control-db-dump).
154154
155155
2. Dump the data from the app
156156

‎source/_components/switch.tplink.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ To use your TPLink switch in your installation, add the following to your `confi
2828
# Example configuration.yaml entry
2929
switch:
3030
- platform: tplink
31-
host: IP_ADRRESS
31+
host: IP_ADDRESS
3232
```
3333
3434
Configuration variables:

‎source/_components/telegram_webhooks.markdown

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,13 @@ telegram_webhooks:
6565

6666
Telegram webhooks raise an event `telegram.command` with a payload.
6767

68-
```json{
68+
```json
69+
{
6970
'command': '/thecommand'
7071
'args': 'strings after command'
7172
'user_id': 12345
7273
}
74+
```
7375

7476
Automation example that realize simple test to command/notify interaction.
7577

‎source/_docs/automation/templating.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ redirect_from: /getting-started/automation-templating/
1212

1313
In Home Assistant 0.19 we introduced a new powerful feature: variables in scripts and automations. This makes it possible to adjust your condition and action based on the information of the trigger.
1414

15-
The trigger data made is available during [template](/configuration/templating/) rendering as the `trigger` variable.
15+
The trigger data made is available during [template](/docs/configuration/templating/) rendering as the `trigger` variable.
1616

1717
```yaml
1818
# Example configuration.yaml entries
@@ -128,4 +128,4 @@ The following tables show the available trigger data per platform.
128128
| `trigger.zone` | State object of zone
129129
| `trigger.event` | Event that trigger observed: `enter` or `leave`.
130130

131-
[state object]: /configuration/state_object/
131+
[state object]: /docs/configuration/state_object/

‎source/_docs/autostart/systemd.markdown

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,14 @@ $ ps -p 1 -o comm=
1818

1919
If the preceding command returns the string `systemd`, you are likely using `systemd`.
2020

21-
If you want Home Assistant to be launched automatically, an extra step is needed to setup `systemd`. You need a service file to control Home Assistant with `systemd`. If you are using a Raspberry Pi with Raspbian then replace the `[your user]` with `pi` otherwise use your user you want to run Home Assistant. `ExecStart` contains the path to `hass` and this may vary. Check with `whereis hass` for the location.
21+
If you want Home Assistant to be launched automatically, an extra step is needed to setup `systemd`. A service file is needed to control Home Assistant with `systemd`. The template below should be created using a text editor. Note, root permissions via 'sudo' will likely be needed. The following should be noted to modify the template:
2222

23-
```bash
24-
$ su -c 'cat <<EOF >> /etc/systemd/system/home-assistant@.service
23+
+ `ExecStart` contains the path to `hass` and this may vary. Check with `whereis hass` for the location.
24+
+ If running Home Assistant in a python virtual environment or a docker, please skip to section below.
25+
+ For most systems, the file is `/etc/systemd/system/home-assistant@[your user].service` with [your user] replaced by the user account that Home Assistant will run as - normally `homeassistant`. For Ubuntu 16.04, the file is `/lib/systemd/system/home-assistant.service` and requires running this command `sudo ln -s /lib/systemd/system/home-assistant.service /etc/systemd/system/home-assistant.service` after file is created.
26+
+ If unfamiliar with command line text editors, `sudo nano -w [filename]` can be used with `[filename]` replaced with the full path to the file. Ex. `sudo nano -w /etc/systemd/system/home-assistant@homeassistant.service`. After text entered, press CTRL-X then press Y to save and exit.
27+
28+
```
2529
[Unit]
2630
Description=Home Assistant
2731
After=network.target
@@ -33,10 +37,9 @@ ExecStart=/usr/bin/hass
3337
3438
[Install]
3539
WantedBy=multi-user.target
36-
EOF'
3740
```
3841

39-
If you've setup Home Assistant in `virtualenv` following our [python installation guide](https://home-assistant.io/getting-started/installation-virtualenv/) or [manual installation guide for raspberry pi](https://home-assistant.io/getting-started/installation-raspberry-pi/), the following template should work for you.
42+
If you've setup Home Assistant in `virtualenv` following our [python installation guide](https://home-assistant.io/getting-started/installation-virtualenv/) or [manual installation guide for raspberry pi](https://home-assistant.io/getting-started/installation-raspberry-pi/), the following template should work for you. If Home Assistant install is not located at `/srv/homeassistant`, please modify the `Enviroment=` and `ExecStart=` lines appropriately.
4043

4144
```
4245
[Unit]
@@ -74,18 +77,33 @@ ExecStopPost=/usr/bin/docker rm -f home-assistant-%i
7477
WantedBy=multi-user.target
7578
```
7679

77-
You need to reload `systemd` to make the daemon aware of the new configuration. Enable and launch Home Assistant after that.
80+
You need to reload `systemd` to make the daemon aware of the new configuration.
7881

7982
```bash
8083
$ sudo systemctl --system daemon-reload
84+
```
85+
86+
To have Home Assistant start automatically at boot, enable the service.
87+
88+
```bash
8189
$ sudo systemctl enable home-assistant@[your user]
90+
```
91+
92+
To disable the automatic start, use this command.
93+
94+
```bash
95+
$ sudo systemctl disable home-assistant@[your user]
96+
```
97+
98+
To start Home Assistant now, use this command.
99+
```bash
82100
$ sudo systemctl start home-assistant@[your user]
83101
```
84102

85-
If everything went well, `sudo systemctl start home-assistant@[your user]` should give you a positive feedback.
103+
You can also substitute the `start` above with `stop` to stop Home Assistant, `restart` to restart Home Assistant, and 'status' to see a brief status report as seen below.
86104

87105
```bash
88-
$ sudo systemctl status home-assistant@[your user] -l
106+
$ sudo systemctl status home-assistant@[your user]
89107
● home-assistant@fab.service - Home Assistant for [your user]
90108
Loaded: loaded (/etc/systemd/system/home-assistant@[your user].service; enabled; vendor preset: disabled)
91109
Active: active (running) since Sat 2016-03-26 12:26:06 CET; 13min ago
@@ -99,10 +117,10 @@ $ sudo systemctl status home-assistant@[your user] -l
99117
To get Home Assistant's logging output, simple use `journalctl`.
100118

101119
```bash
102-
$ journalctl -f -u home-assistant@[your user]
120+
$ sudo journalctl -f -u home-assistant@[your user]
103121
```
104122

105-
Because the log can scroll quite quickly, you might want to open a second terminal to view only the errors:
123+
Because the log can scroll quite quickly, you can select to view only the error lines:
106124
```bash
107-
$ journalctl -f -u home-assistant@[your user] | grep -i 'error'
125+
$ sudo journalctl -f -u home-assistant@[your user] | grep -i 'error'
108126
```

‎source/_docs/hassbian/installation.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The easiest way to install Home Assistant on your Raspberry Pi is by using HASSb
1717
3. Ensure your Raspberry Pi has access to the internet.
1818
4. Insert SD card to Raspberry Pi and turn it on. Initial installation of Home Assistant will take about 5 minutes.
1919

20-
These instructions are also available as a [video](https://www.youtube.com/watch?v=iIz6XqDwHEk).
20+
These instructions are also available as a [video](https://www.youtube.com/watch?v=iIz6XqDwHEk). And additioning info is available in this [video](https://www.youtube.com/watch?v=tCGlQSsQ-Mc).
2121

2222
After initial boot, you can reach Home Assistant in your browser at [http://hassbian.local:8123]. If you want to login via SSH, the default username is `pi` and password is `raspberry` (please change this by running `passwd`). The Home Assistant configuration is located at `/home/homeassistant/.homeassistant/`.
2323

‎source/_docs/installation.markdown

Lines changed: 81 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,88 @@ footer: true
1010
redirect_from: /getting-started/installation/
1111
---
1212

13-
Home Assistant provides multiple ways to be installed. If you are a Raspberry Pi owner then the [Hassbian](/docs/hassbian/) is an easy and simple way to run home Assistant.
13+
Home Assistant provides multiple ways to be installed. A requirement is that you have [Python](https://www.python.org/downloads/) installed. For Windows we require at least **Python 3.5** and for other operating systems at least **Python 3.4.2**.
1414

15-
The only requirement is that you have [Python](https://www.python.org/downloads/) installed. For Windows we require at least **Python 3.5** and for other operating systems at least **Python 3.4.2**.
15+
<div class="text-center hass-option-cards" markdown="0">
16+
<a class='option-card' href='/docs/hassbian/installation/'>
17+
<div class='img-container'>
18+
<img src='/images/supported_brands/home-assistant.png' />
19+
</div>
20+
<div class='title'>Hassbian</div>
21+
</a>
22+
<a class='option-card' href='/docs/installation/raspberry-pi/'>
23+
<div class='img-container'>
24+
<img src='/images/supported_brands/raspberry-pi.png' />
25+
</div>
26+
<div class='title'>Rasbian</div>
27+
</a>
28+
<a class='option-card' href='/docs/installation/archlinux/'>
29+
<div class='img-container'>
30+
<img src='/images/supported_brands/archlinux.png' />
31+
</div>
32+
<div class='title'>ArchLinux</div>
33+
</a>
34+
<a class='option-card' href='/docs/installation/armbian/'>
35+
<div class='img-container'>
36+
<img src='/images/supported_brands/armbian.png' />
37+
</div>
38+
<div class='title'>armbian</div>
39+
</a>
40+
<a class='option-card' href='/docs/installation/fedora/'>
41+
<div class='img-container'>
42+
<img src='/images/supported_brands/fedora.png' />
43+
</div>
44+
<div class='title'>Fedora</div>
45+
</a>
46+
<a class='option-card' href='/docs/installation/centos/'>
47+
<div class='img-container'>
48+
<img src='/images/supported_brands/centos.png' />
49+
</div>
50+
<div class='title'>CentOS/RHEL</div>
51+
</a>
52+
<a class='option-card' href='/docs/installation/windows/'>
53+
<div class='img-container'>
54+
<img src='/images/supported_brands/windows.png' />
55+
</div>
56+
<div class='title'>Windows</div>
57+
</a>
58+
<a class='option-card' href='/docs/installation/macos/'>
59+
<div class='img-container'>
60+
<img src='/images/supported_brands/apple.png' />
61+
</div>
62+
<div class='title'>macOS</div>
63+
</a>
64+
<a class='option-card' href='/docs/installation/synology/'>
65+
<div class='img-container'>
66+
<img src='/images/supported_brands/synology.png' />
67+
</div>
68+
<div class='title'>Synology</div>
69+
</a>
70+
<a class='option-card' href='/docs/installation/docker/'>
71+
<div class='img-container'>
72+
<img src='/images/supported_brands/docker.png' />
73+
</div>
74+
<div class='title'>Docker</div>
75+
</a>
76+
<a class='option-card' href='/docs/installation/vagrant/'>
77+
<div class='img-container'>
78+
<img src='/images/supported_brands/vagrant.png' />
79+
</div>
80+
<div class='title'>Vagrant</div>
81+
</a>
82+
</div>
83+
84+
Once Home Assistant is installed, execute the following code in a console/terminal to check if the setup was successful:
85+
86+
```bash
87+
$ hass
88+
```
89+
90+
The first start may take a minute or two because the needed packages will be downloaded and installed. The web interface will be served on [http://localhost:8123](http://localhost:8123).
91+
92+
For more details about `hass`, please refer to the [tools section](/docs/tools/hass/).
93+
94+
If you're running a Linux-based platform, we suggest you follow the [VirtualEnv instructions](/docs/installation/virtualenv/) to avoid using `root`.
1695

1796
It may be needed that you install additional library depending on the platforms/components you want to use.
1897

‎source/_docs/installation/archlinux.markdown

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
layout: page
3+
title: "Installation on ArchLinux"
4+
description: "Installation of Home Assistant on your ArchLinux computer."
5+
date: 2017-03-01 07:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
---
11+
12+
[ArchLinux](https://www.archlinux.org/) is a lightweight and flexible Linux distribution. There are official packages optimized for the i686 and x86-64 architectures available.
13+
14+
Install the needed Python packages.
15+
16+
```bash
17+
$ sudo pacman -S python
18+
$ sudo pacman -S python-pip
19+
```
20+
21+
and Home Assistant itself.
22+
23+
```bash
24+
$ pip3 install homeassistant
25+
```
26+
27+
Home Assistant is part of the [AUR](https://aur.archlinux.org/packages/home-assistant/). This meand that it can be installed directly with `pacman`:
28+
29+
```bash
30+
$ sudo pacman -S home-assistant
31+
```

‎source/_docs/installation/armbian.markdown

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,15 @@ footer: true
1111

1212
[armbian](https://www.armbian.com) runs on a wide-variety of [ARM development boards](https://www.armbian.com/download/). Currently there are around 50 boards supported inclusive the OrangePi family, Cubieboard, Pine64, and Odroid.
1313

14+
Setup Python and `pip`
15+
1416
```bash
1517
$ sudo apt-get update
1618
$ sudo apt-get install python3-dev python3-pip
1719
```
1820

19-
Now you can follow the [generic instructions](/docs/installation/python/).
21+
Install Home Assistant.
22+
23+
```bash
24+
$ pip3 install homeassistant
25+
```

‎source/_docs/installation/centos.markdown

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
layout: page
3+
title: "Installation on CentOS/RHEL"
4+
description: "Installation of Home Assistant on your CentOS/RHEL computer."
5+
date: 2017-03-01 07:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
---
11+
12+
To run Python 3.x on [CentOS](https://www.centos.org/) or RHEL (Red Hat Enterprise Linux), [Software Collections](https://www.softwarecollections.org/en/scls/rhscl/rh-python34/) needs to be activated first.
13+
14+
There are effort in progress to bring Python 3.4 to [Extra Packages for Enterprise Linux (EPEL)](https://fedoraproject.org/wiki/EPEL) which will allow you to follow the [Fedora Instructions](/docs/installation/fedora/).
15+
16+
### {% linkable_title Using Software Collections %}
17+
18+
First of all install the software collection repository as root. For example, on CentOS:
19+
20+
```bash
21+
$ yum install centos-release-scl
22+
```
23+
24+
Then install the Python 3.5 package:
25+
26+
```bash
27+
$ yum install rh-python35
28+
```
29+
30+
Once installed, switch to your homeassistant user (if you've set one up), enable the software collection and check that it has set up the new version of Python:
31+
32+
```bash
33+
$ scl enable rh-python35 bash
34+
$ python --version
35+
Python 3.5.1
36+
```
37+
38+
You will be in a command shell set up with Python 3.5 as your default version. The virtualenv and pip commands will be correct for this version, so you can now create a virtual environment and install home assistant following the main [instructions](https://home-assistant.io/docs/installation/virtualenv/#step-4-set-up-the-virtualenv).
39+
40+
You will need to enable the software collection each time you log on before you activate your virtual environment.
41+
42+
### {% linkable_title Systemd with Software Collections %}
43+
44+
To autostart homeassistant using systemd follow the main [instructions](https://home-assistant.io/docs/autostart/systemd/) and adjust the template as follows:
45+
46+
```
47+
[Unit]
48+
Description=Home Assistant
49+
After=network.target
50+
51+
[Service]
52+
Type=simple
53+
User=homeassistant
54+
# Make sure the virtualenv Python binary is used
55+
Environment=VIRTUAL_ENV="/srv/homeassistant"
56+
Environment=PATH="$VIRTUAL_ENV/bin:$PATH"
57+
# ExecStart using software collection:
58+
ExecStart=/usr/bin/scl enable rh-python35 -- /srv/homeassistant/bin/hass -c "/home/homeassistant/.homeassistant"
59+
60+
[Install]
61+
WantedBy=multi-user.target
62+
```

0 commit comments

Comments
 (0)