From 60b81147a2a271a59ea9e830b3180bafa6ced9db Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Thu, 6 Apr 2017 22:53:49 +0200 Subject: [PATCH 1/9] Add sections --- source/_docs/autostart/systemd.markdown | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/source/_docs/autostart/systemd.markdown b/source/_docs/autostart/systemd.markdown index 086e46eef09..8fc7a1420b4 100644 --- a/source/_docs/autostart/systemd.markdown +++ b/source/_docs/autostart/systemd.markdown @@ -20,10 +20,10 @@ If the preceding command returns the string `systemd`, you are likely using `sys 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: -+ `ExecStart` contains the path to `hass` and this may vary. Check with `whereis hass` for the location. -+ If running Home Assistant in a python virtual environment or a docker, please skip to section below. -+ 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. -+ 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. +- `ExecStart` contains the path to `hass` and this may vary. Check with `whereis hass` for the location. +- If running Home Assistant in a Python virtual environment or a Docker container, please skip to section below. +- 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. +- 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. ``` [Unit] @@ -39,7 +39,9 @@ ExecStart=/usr/bin/hass WantedBy=multi-user.target ``` -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 `ExecStart=` line appropriately. +### {% linkable_title Python virtual environment %} + +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 `ExecStart=` line appropriately. ``` [Unit] @@ -55,7 +57,9 @@ ExecStart=/srv/homeassistant/bin/hass -c "/home/homeassistant/.homeassistant" WantedBy=multi-user.target ``` -If you want to use docker, the following template should work for you. +### {% linkable_title Docker %} + +If you want to use Docker, the following template should work for you. ``` [Unit] From dc641be8602b611d6a238eff96fdb99c1d2908d2 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Fri, 7 Apr 2017 10:28:10 +0200 Subject: [PATCH 2/9] Remove whitespace --- source/_docs/autostart/systemd.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/autostart/systemd.markdown b/source/_docs/autostart/systemd.markdown index 8fc7a1420b4..c46da344485 100644 --- a/source/_docs/autostart/systemd.markdown +++ b/source/_docs/autostart/systemd.markdown @@ -18,7 +18,7 @@ $ ps -p 1 -o comm= If the preceding command returns the string `systemd`, you are likely using `systemd`. -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: +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: - `ExecStart` contains the path to `hass` and this may vary. Check with `whereis hass` for the location. - If running Home Assistant in a Python virtual environment or a Docker container, please skip to section below. From f8e2b8877b9c899d21e32661afbab596f4415d05 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Fri, 7 Apr 2017 10:30:23 +0200 Subject: [PATCH 3/9] Add more details --- source/_docs/installation/fedora.markdown | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/source/_docs/installation/fedora.markdown b/source/_docs/installation/fedora.markdown index fca60e4b9bb..574c661aa3c 100644 --- a/source/_docs/installation/fedora.markdown +++ b/source/_docs/installation/fedora.markdown @@ -23,3 +23,24 @@ and Home Assistant itself. $ pip3 install homeassistant ``` +To isolate the Home Assistant installation a [venv](https://docs.python.org/3/library/venv.html) is handy. First create a new directory to store the installation. + +```bash +$ sudo mkdir -p /opt/homeassistant +$ cd /opt/homeassistant +``` +Now switch to the new directory, setup the venv, and activate it. + +```bash +$ cd /opt/homeassistant +$ pyvenv-3.5 . +$ source bin/activate +``` + +Install Home Assistant itself. + +```bash +$ pip3 install homeassistant +``` + +Check the [autostart](/docs/autostart/systemd/) section in the documentation for further details. From bd26868f2c34653dc008ea6fc7fffa3450154b1b Mon Sep 17 00:00:00 2001 From: Josh Wright Date: Fri, 7 Apr 2017 09:52:26 -0400 Subject: [PATCH 4/9] Update light.mqtt docs to include 'retain' The light.mqtt component supports the 'retain' config parameter, which is important for many MQTT based lights. It is referenced in the explanation paragraph, but was not in the config parameter listing. --- source/_components/light.mqtt.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_components/light.mqtt.markdown b/source/_components/light.mqtt.markdown index 3b423e62eaf..ee03a6fb35e 100644 --- a/source/_components/light.mqtt.markdown +++ b/source/_components/light.mqtt.markdown @@ -45,6 +45,7 @@ Configuration variables: - **payload_off** (*Optional*): The payload that represents disabled state. Default is "OFF". - **payload_on** (*Optional*): The payload that represents enabled state. Default is "ON". - **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages. +- **retain** (*Optional*): If the published message should have the retain flag on or not. - **rgb_command_topic** (*Optional*): The MQTT topic to publish commands to change the light's RGB state. - **rgb_state_topic** (*Optional*): The MQTT topic subscribed to receive RGB state updates. - **rgb_value_template** (*Optional*): Defines a [template](/topics/templating/) to extract the RGB value. From 77bf711e073755fc5d8beaaaa1789ade0fc5911a Mon Sep 17 00:00:00 2001 From: Andrew Date: Fri, 7 Apr 2017 14:34:37 -0500 Subject: [PATCH 5/9] Fixed as_timestamp reference (#2394) Requires parenthesis. --- source/_docs/configuration/templating.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/configuration/templating.markdown b/source/_docs/configuration/templating.markdown index 03fda9722b2..8750a081f89 100644 --- a/source/_docs/configuration/templating.markdown +++ b/source/_docs/configuration/templating.markdown @@ -74,7 +74,7 @@ Home Assistant adds extensions to allow templates to access all of the current s - `is_state_attr('device_tracker.paulus', 'battery', 40)` will test if the given entity is specified state. - `now()` will be rendered as current time in your time zone. - `utcnow()` will be rendered as UTC time. -- `as_timestamp` will convert datetime object or string to UNIX timestamp +- `as_timestamp()` will convert datetime object or string to UNIX timestamp - `distance()` will measure the distance in meters between home, entity, coordinates. - `closest()` will find the closest entity. - `relative_time(timestamp)` will format the date time as relative time vs now (ie 7 seconds) From 8c0a7c3b9baf1d581dba9e5bef9a76f1ff5b638d Mon Sep 17 00:00:00 2001 From: Niklas Date: Fri, 7 Apr 2017 21:35:33 +0200 Subject: [PATCH 6/9] swap echo/home comment (#2393) --- source/_components/emulated_hue.markdown | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/_components/emulated_hue.markdown b/source/_components/emulated_hue.markdown index 47bb5291387..4cb0d13b6b0 100644 --- a/source/_components/emulated_hue.markdown +++ b/source/_components/emulated_hue.markdown @@ -25,15 +25,15 @@ The virtual bridge has the ability to turn entities on or off, or change the bri To enable the emulated Hue bridge, add one of the following configs to your `configuration.yaml` file: ```yaml -# Amazon Echo example configuration.yaml entry +# Google Home example configuration.yaml entry emulated_hue: + # Google Home does not work on different ports. ``` ```yaml -# Google Home example configuration.yaml entry +# Amazon Echo example configuration.yaml entry emulated_hue: - type: google_home - # Google Home does not work on different ports. + type: alexa listen_port: 80 ``` From d91c7ccef26ceac486fd3e3ad4ca55be4505b975 Mon Sep 17 00:00:00 2001 From: Greg Dowling Date: Fri, 7 Apr 2017 20:36:26 +0100 Subject: [PATCH 7/9] Update sensor.vera.markdown (#2389) --- source/_components/sensor.vera.markdown | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/source/_components/sensor.vera.markdown b/source/_components/sensor.vera.markdown index e0db880d770..8bb59976248 100644 --- a/source/_components/sensor.vera.markdown +++ b/source/_components/sensor.vera.markdown @@ -17,3 +17,8 @@ The `vera` platform allows you to get data from your [Vera](http://getvera.com/) They will be automatically discovered if the vera component is loaded. +Please note that some vera sensors (such as _motion_ and _flood_ sensors) are _armable_ which means that vera will send alerts (email messages ot txts) when they are _armed_ an change state. + +Home Assistant will display the state of these sensors regardless of the _armed_ state. + +To allow you to change the _armed state_ - Home Assistant will create a switch as well as a sensor for each _Armable_ sensor. You can hide these switches using customization if you wish. From 074e446a23200c101cd273c5289c36eabd935a83 Mon Sep 17 00:00:00 2001 From: R Huish Date: Sat, 8 Apr 2017 10:03:55 +0100 Subject: [PATCH 8/9] Update switch.rflink.markdown (#2396) Removed extra"_" from fire_event_ --- source/_components/switch.rflink.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_components/switch.rflink.markdown b/source/_components/switch.rflink.markdown index 92634c58b95..c4b24be8a93 100644 --- a/source/_components/switch.rflink.markdown +++ b/source/_components/switch.rflink.markdown @@ -43,14 +43,14 @@ Configuration variables: - **devices** (*Optional*): A list of devices with their name to use in the frontend. - **device_defaults**: (*Optional*) - - **fire_event_** (*Optional*): Set default `fire_event` for RFLink switch devices (see below). + - **fire_event** (*Optional*): Set default `fire_event` for RFLink switch devices (see below). - **signal_repetitions** (*Optional*): Set default `signal_repetitions` for RFLink switch devices (see below). Device configuration variables: - **name** (*Optional*): Name for the device, defaults to RFLink ID. - **aliasses** (*Optional*): Alternative RFLink ID's this device is known by. -- **fire_event_** (*Optional*): Fire an `button_pressed` event if this device is turned on or off (default: False). +- **fire_event** (*Optional*): Fire an `button_pressed` event if this device is turned on or off (default: False). - **signal_repetitions** (*Optional*): Repeat every RFLink command this number of times (default: 1) ### {% linkable_title Switch state %} From 5455519bb19ffc782505867704a7cb16c6ac836a Mon Sep 17 00:00:00 2001 From: jeremysv Date: Sat, 8 Apr 2017 12:32:00 -0700 Subject: [PATCH 9/9] Correct spelling: 'Optionaly' -> 'Optionally' (#2398) --- source/_docs/hassbian/common-tasks.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/hassbian/common-tasks.markdown b/source/_docs/hassbian/common-tasks.markdown index 25104502c31..520476af04c 100644 --- a/source/_docs/hassbian/common-tasks.markdown +++ b/source/_docs/hassbian/common-tasks.markdown @@ -93,7 +93,7 @@ This will in order do the following: - Change directory to the Home Assistant configuration directory. - Open the log file in the nano editor. -Optionaly, you can also view the log with `journalctl`. +Optionally, you can also view the log with `journalctl`. Log in as the `pi` account and execute the following commands: ```bash