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 ``` 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. 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. 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 %} diff --git a/source/_docs/autostart/systemd.markdown b/source/_docs/autostart/systemd.markdown index 086e46eef09..c46da344485 100644 --- a/source/_docs/autostart/systemd.markdown +++ b/source/_docs/autostart/systemd.markdown @@ -18,12 +18,12 @@ $ 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, 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] 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) 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 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.