Skip to content

Commit

Permalink
Merge branch 'current' into next
Browse files Browse the repository at this point in the history
  • Loading branch information
balloob committed Nov 11, 2017
2 parents 93cb701 + 3ad0d80 commit 9e1043f
Show file tree
Hide file tree
Showing 24 changed files with 391 additions and 33 deletions.
4 changes: 2 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -141,10 +141,10 @@ social:
current_major_version: 0
current_minor_version: 57
current_patch_version: 2
date_released: 2017-11-05
date_released: 2017-11-11

# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.
# Major release:
patch_version_notes: "#release-0572--november-5"
patch_version_notes: "#release-0573--november-11"
# Minor release (Example #release-0431---april-25):
6 changes: 5 additions & 1 deletion source/_addons/git_pull.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,8 @@ Load and update configuration files for Home Assistant from a GIT repository.
* **ed25519**
* **rsa**

The protocol is typically known by the suffix of the private key --e.g., a key file named `id_rsa` will be a private key using "rsa" protocol.
The protocol is typically known by the suffix of the private key --e.g., a key file named `id_rsa` will be a private key using "rsa" protocol.

<p class='note warning'>
You should only use this add-on if you do not have an existing configuration or if your existing configuration is already in a git repository. If the script does not find the necessary git files in your configuration folder, it will delete anything that might be there. Please ensure that there is a `.git` folder before using this. You can verify this by listing the items in the configuration folder including hidden files. The command is `ls -a /config`.
</p>
2 changes: 1 addition & 1 deletion source/_components/device_tracker.huawei_router.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ ha_release: 0.51
---

This component offers presence detection by looking at connected devices to a [Huawei router](http://m.huawei.com/enmobile/enterprise/products/network/access/pon-one/hw-371813.htm).
Currently, this was only tested with the Huawei HG8247H (used by Vodafone Portugal).
Currently, this was only tested with the Huawei HG8247H and HG8247Q Smart Router (used by Vodafone Portugal).

To use a Huawei router in your installation, add the following to your `configuration.yaml` file:

Expand Down
6 changes: 3 additions & 3 deletions source/_components/device_tracker.nmap_tracker.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ To use this device tracker in your installation, add the following to your `conf
# Example configuration.yaml entry
device_tracker:
- platform: nmap_tracker
hosts: 192.168.1.1/24
hosts: 192.168.1.0/24
```
Configuration variables:
Expand All @@ -47,7 +47,7 @@ A full example for the `nmap` tracker could look like the following sample:
# One whole subnet, and skipping two specific IPs.
device_tracker:
- platform: nmap_tracker
hosts: 192.168.1.1/24
hosts: 192.168.1.0/24
home_interval: 10
exclude:
- 192.168.1.12
Expand All @@ -60,7 +60,7 @@ device_tracker:
device_tracker:
- platform: nmap_tracker
hosts:
- 192.168.1.1/24
- 192.168.1.0/24
- 10.0.0.2
- 10.0.0.15
```
Expand Down
6 changes: 6 additions & 0 deletions source/_components/device_tracker.unifi.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,9 @@ Configuration variables:
- **detection_time** (*Optional*): The Unifi component will not return a device that has not been seen by the controller in the last 180 seconds. You can adjust this threshold with this variable and accepts seconds or `00:00:00` time formats.

See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

<p class='note'>
If you decide to install the Unifi Controller on the same system as your Home Assistant, be aware there may be overlap in ports if you have the MQTT component as well.

[Related Issue](https://github.com/home-assistant/home-assistant/issues/10507)
</p>
17 changes: 15 additions & 2 deletions source/_components/frontend.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,12 @@ automation:

### {% linkable_title Manual Theme Selection %}

When themes are enabled in the `configuration.yaml` file, a new option will show up in the Configuration panel under `configuration.yaml` called "Set a theme." You can then choose any installed theme from the dropdown list and it will be applied immediately.
When themes are enabled in the `configuration.yaml` file, a new option will show up in the Configuration panel under **General** called "Set a theme." You can then choose any installed theme from the dropdown list and it will be applied immediately.

<p class='img'>
<img src='/images/frontend/choose-theme.png' />
Set a theme
</p>

## {% linkable_title Loading extra HTML %}

Expand All @@ -118,4 +122,13 @@ frontend:
- /file2.html
```

Those will be loaded via `<link rel='import' href='{{ extra_url }}' async>` on any page (states and panels)
Those will be loaded via `<link rel='import' href='{{ extra_url }}' async>` on any page (states and panels).

### {% linkable_title Manual Language Selection %}

The browser language is automatically detected. To use a different language, go to **General** in the Configuration panel and select a one from "Choose a Language". It will be applied immediately.

<p class='img'>
<img src='/images/frontend/choose-language.png' />
Choose a Language
</p>
2 changes: 2 additions & 0 deletions source/_components/sensor.speedtest.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -113,3 +113,5 @@ automation:

- When running on Raspberry Pi, just note that the maximum speed is limited by its 100 Mbit/s LAN adapter.
- Entries under `monitored_conditions` only control what entities are available under home-assistant, it does not disable the condition from running.
- If ran frequently, this component has the capability of using a very large amount of data. Frequent updates should be avoided on bandwidth capped connections.
- While running, network usage is fully utilized. This may have a negative affect on other devices in use the network such as gaming consoles or streaming boxes.
41 changes: 40 additions & 1 deletion source/_components/timer.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ ha_release: 0.57

The `timer` component aims to simplify automations based on (dynamic) durations.

When a timer finishes or gets cancelled the corresponding events are fired. This allows you to diffferentiate if a timer has switched from `active` to `idle` because the given duration has elapsed or it has been cancelled. To control timers in your automations you can use the services mentioned below. When calling the `start` service on a timer that is already running, it resets the duration it will need to finish and restart the timer without triggering any events. This for example makes it easy to create timed lights that get triggered by motion.
When a timer finishes or gets cancelled the corresponding events are fired. This allows you to differentiate if a timer has switched from `active` to `idle` because the given duration has elapsed or it has been cancelled. To control timers in your automations you can use the services mentioned below. When calling the `start` service on a timer that is already running, it resets the duration it will need to finish and restart the timer without triggering any events. This for example makes it easy to create timed lights that get triggered by motion.

<p class='note warning'>
With the current implementation timers don't persist over restarts. After a restart they will be idle again, together with their initial configuration.
Expand Down Expand Up @@ -92,3 +92,42 @@ Select <img src='/images/screenshots/developer-tool-services-icon.png' alt='serv
}
```

### {% linkable_title Configuration example %}

```yaml
# Example configuration.yaml entry
# Set a timer called test to a duration of 30 seconds:
timer:
test:
duration: '00:00:30'
```

```yaml
# Example automations.yaml entry
- action:
- service: timer.start
entity_id: timer.test
alias: Timerswitch
id: 'Timerstart'
# Timer is started when the switch pumprun is set to on.
trigger:
platform: state
entity_id: switch.pumprun
to: 'on'
# When timer is stopped, the time run out, another message is sent
- action:
- service: notify.nma
data:
message: "Timer stop"
alias: Timerstop
id: 'Timerstop'
trigger:
platform: event
event_type: timer.finished
event_data:
entity_id: timer.test
```

9 changes: 5 additions & 4 deletions source/_components/volvooncall.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -25,21 +25,21 @@ volvooncall:
password: password
```
Users registered with Volvo in North America or China will need to specify a service URL:
Users registered with Volvo in North America or China will need to specify a region:
```yaml
# North America
volvooncall:
username: username
password: password
service_url: 'https://vocapi-na.wirelesscar.net/customerapi/rest/v3.0/'
region: na
```
```yaml
# China
volvooncall:
username: username
password: password
service_url: 'https://vocapi-cn.wirelesscar.net/customerapi/rest/v3.0/'
region: cn
```
A more advanced example for setting the vehicle name and selecting what resources to display:
Expand All @@ -61,7 +61,8 @@ Configuration variables:
- **username** (*Required*): The username associated with your Volvo On Call account.
- **password** (*Required*): The password for your given Volvo On Call account.
- **service_url** (*Optional*): The service URL to use for Volvo On Call (defaults to https://vocapi.wirelesscar.net/customerapi/rest/v3.0/).
- **region** (*Optional*): The region where the Volvo is registered. Needs to be set for users in North America or China.
- **service_url** (*Optional*): The service URL to use for Volvo On Call. Normally not neccessary to specify.
- **name** (*Optional*): Make it possible to provide a name for the vehicles.
- **resources** (*Optional*): A list of resources to display (defaults to all available).
6 changes: 3 additions & 3 deletions source/_components/xiaomi_aqara.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sharing: true
footer: true
logo: xiaomi.png
ha_category: Hub
ha_release: "0.50"
ha_release: "0.57"
ha_iot_class: "Local Push"
redirect_from: /components/xiaomi/
---
Expand Down Expand Up @@ -49,7 +49,7 @@ The `xiaomi_aqara` component allows you to integrate [Xiaomi](http://www.mi.com/

## {% linkable_title Setup %}

Follow the setup process using your phone and Mi-Home app. From here you will be able to retrieve the key from within the app following [this tutorial](https://community.home-assistant.io/t/beta-xiaomi-gateway-integration/8213/1832).
Follow the setup process using your phone and Mi-Home app. From here you will be able to retrieve the key (password) from within the app following [this tutorial](https://www.domoticz.com/wiki/Xiaomi_Gateway_(Aqara)#Adding_the_Xiaomi_Gateway_to_Domoticz).

To enable {{ page.title }} in your installation, add the following to your `configuration.yaml` file:

Expand Down Expand Up @@ -236,7 +236,7 @@ If you run into trouble initializing the gateway with your app, try another smar
```

That means that Home Assistant is not getting any response from your Xiaomi gateway. Might be a local network problem or your firewall.
- Make sure you have [enabled LAN access](https://community.home-assistant.io/t/beta-xiaomi-gateway-integration/8213/1832).
- Make sure you have [enabled LAN access](https://www.domoticz.com/wiki/Xiaomi_Gateway_(Aqara)#Adding_the_Xiaomi_Gateway_to_Domoticz).
- Turn off the firewall on the system where Home Assistant is running.
- Ensure your router supports multicast as this is a requirement of the Xiaomi GW
- Try to leave the MAC address `mac:` blank.
Expand Down
11 changes: 8 additions & 3 deletions source/_docs/installation/docker.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -54,24 +54,29 @@ The steps would be:
* Set "Enable auto-restart" if you like
* Within "Volume" click on "Add Folder" and choose either an existing folder or add a new folder. The "mount point" has to be "/config", so that Home Assistant will use it for the configs and logs.
* Within "Network" select "Use same network as Docker Host"
* To ensure that Home Assistant displays the correct timezone go to the "Environment" tab and click the plus sign then add `variable` = `TZ` & `value` = `Europe/London` choosing [your correct timezone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
* Confirm the "Advanced Settings"
* Click on "Next" and then "Apply"
* Your Home Assistant within Docker should now run
* Your Home Assistant within Docker should now run and will serve the web interface from port 8123 on your Docker host (this will be your Synology NAS IP address - for example `http://192.168.1.10:8123`)

Remark: to update your Home Assistant on your Docker within Synology NAS, you just have to do the following:
* Go to the Docker-app and move to "Image"-section
* Download the "homeassistant/home-assistant" image - don't care, that it is already there
* wait until the system-message/-notification comes up, that the download is finished (there is no progress bar)
* Move to "Container"-section
* Stop your container if it's running
* Right-click on it and select "Action"->"Clear". You won't loose any data, as all files are stored in your config-directory
* Right-click on it and select "Action"->"Clear". You won't lose any data, as all files are stored in your config-directory
* Start the container again - it will then boot up with the new Home Assistant image

Remark: to restart your Home Assistant within Synology NAS, you just have to do the following:
* Go to the Docker-app and move to "Container"-section
* Right-click on it and select "Action"->"Restart".

### {% linkable_title Restart %}

This will launch Home Assistant and serve the web interface from port 8123 on your Docker host.

If you change the configuration you have to restart the server. To do that you have 2 options.

1. You can go to the <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> service developer tools, select the service `homeassistant/restart` and click "Call Service".
2. Or you can restart it from an terminal by running `docker restart home-assistant`
2. Or you can restart it from a terminal by running `docker restart homeassistant`
25 changes: 20 additions & 5 deletions source/_docs/z-wave/adding.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: "Z-Wave Devices - Adding and Removing"
description: "How to add and remove Z-Wave devices."
date: 2016-02-27 19:59
date: 2017-11-08 19:06
sidebar: true
comments: false
sharing: true
Expand All @@ -11,17 +11,29 @@ footer: true

## {% linkable_title Adding Non-Secure Devices %}

To add (include) a non-secure Z-Wave [device](/docs/z-wave/devices/) to your system, go to the [Z-Wave control panel](/docs/z-wave/control-panel/) in the Home Assistant frontend and click the **Add Node** button in the *Z-Wave Network Management* card. This will place the controller in inclusion mode, after which you should activate your device to be included by following the instructions provided with the device. Don't use this for secure devices, since this is likely to limit the features the device supports.
To add (include) a non-secure Z-Wave [device](/docs/z-wave/devices/) to your system:

1. Go to the [Z-Wave control panel](/docs/z-wave/control-panel/) in the Home Assistant frontend
2. Click the **Add Node** button in the *Z-Wave Network Management* card - this will place the controller in inclusion mode
3. Activate your device to be included by following the instructions provided with the device

Don't use this for [secure devices](https://home-assistant.io/docs/z-wave/adding/#adding-secure-devices), since this is likely to limit the features the device supports.

<p class='note warning'>
Don't use the OpenZWave control panel (OZWCP), or the physical button on a controller, to add or remove devices. Many devices will only send the information about their capabilities at the time you include them. If you use the OpenZWave control panel, or the button on a device, then Home Assistant won't have that information. Using the physical button on a controller will also result in a non-security inclusion being performed, which may limit the features the device supports.
Don't use the OpenZWave control panel (OZWCP), **or the physical button on a controller**, to add or remove devices. Many devices will only send the information about their capabilities at the time you include them. If you use the OpenZWave control panel, or the button on a device, then Home Assistant won't have that information. Using the physical button on a controller will also result in a non-security inclusion being performed, which may limit the features the device supports.
</p>

When you add a device, it may initially appear without a specific entity ID (eg `zwave.__`) and without other identifying information. Running a *Heal* should help speed this process up, and you'll need to run a *Heal* anyway so that all the devices in your Z-Wave network learn about the new device. You *might* need to restart Home Assistant (not reboot the system) to have the entity ID fully visible.

## {% linkable_title Adding Secure Devices %}

Security Z-Wave devices require a network key before being added to the network using the **Add Secure Node** button in the Z-Wave Network Management card. You must set the *network_key* configuration variable to use a network key before adding these devices. Some devices only expose their full capabilities when included this way, you should always read the manual for your device to find out the recommended inclusion method.
Security Z-Wave devices require a network key - you must set the *network_key* configuration variable to use a network key before adding these devices. Some devices only expose their full capabilities when included this way, you should always read the manual for your device to find out the recommended inclusion method. To add (include) a secure Z-Wave device:

1. Go to the [Z-Wave control panel](/docs/z-wave/control-panel/) in the Home Assistant frontend
2. Click the **Add Node Secure** button in the *Z-Wave Network Management* card - this will place the controller in inclusion mode
3. Activate your device to be included by following the instructions provided with the device

### {% linkable_title Network Key %}

An easy script to generate a random key:
```bash
Expand All @@ -39,5 +51,8 @@ Ensure you keep a backup of this key. If you have to rebuild your system and don

## {% linkable_title Removing Devices %}

To remove (exclude) a Z-Wave device from your system, go to the Z-Wave control panel in the Home Assistant frontend and click the **Remove Node** button in the *Z-Wave Network Management* card. This will place the controller in exclusion mode, after which you should activate your device to be excluded by following the instructions provided with the device.
To remove (exclude) a Z-Wave device from your system:

1. Go to the Z-Wave control panel in the Home Assistant frontend
2. Click the **Remove Node** button in the *Z-Wave Network Management* card - this will place the controller in exclusion mode
3. Activate your device to be excluded by following the instructions provided with the device
3 changes: 2 additions & 1 deletion source/_docs/z-wave/control-panel.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ Here is where you [include and exclude](/docs/z-wave/adding/) Z-Wave devices fro
* **Remove Failed Node** will remove a failed node from the network. The node needs to be on the controller's Failed Node List (marked as `is_failed: true`), otherwise this command will fail.
* **Replace Failed Node** will replace a failed device with another. If the node is not in the controller's Failed Node List, or the node responds, this command will fail.
* **Print Node** prints all state of Z-Wave node to the console log
* **Rename Node** sets a node's name

* **Rename Node** sets a node's name - this won't happen immediately, and requires you to restart Home Assistant (not reboot) to set the new name

* **Heal Node** starts healing of the node.(Update neighbour list and update return routes)

Expand Down
Loading

0 comments on commit 9e1043f

Please sign in to comment.