From ae98bbf42e09e9f1ef93fa0eaa22d1e41afebe00 Mon Sep 17 00:00:00 2001 From: DetroitEE <33440271+DetroitEE@users.noreply.github.com> Date: Mon, 30 Jul 2018 09:08:35 -0400 Subject: [PATCH 01/24] Update media_player.webostv.markdown --- source/_components/media_player.webostv.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/media_player.webostv.markdown b/source/_components/media_player.webostv.markdown index 3775ae8260c..102852ead3e 100644 --- a/source/_components/media_player.webostv.markdown +++ b/source/_components/media_player.webostv.markdown @@ -75,7 +75,7 @@ media_player: Home Assistant is able to turn on a LG webOS Smart TV if you specify an action, like HDMI-CEC or WakeOnLan. Common for webOS 3.0 and higher would be to use WakeOnLan feature. -To use this feature your TV should be connected to your network via Ethernet rather than Wireless and you should enable *LG Connect Apps* feature in *Network* settings of the TV [instructions](http://www.lg.com/uk/support/product-help/CT00008334-1437131798537-others) (or *Mobile App* in *General* settings for older models) (*may vary by version). +To use this feature your TV should be connected to your network via Ethernet rather than Wireless and you should enable *LG Connect Apps* feature in *Network* settings of the TV [instructions](http://www.lg.com/uk/support/product-help/CT00008334-1437131798537-others) (or *Mobile App* in *General* settings for older models) (*may vary by version). On newer models (2017+), WakeOnLan may need to be enabled in the TV settings by going to Settings > General > Mobile TV On > Turn On Via WiFi [instructions](https://support.quanticapps.com/hc/en-us/articles/115005985729-How-to-turn-on-my-LG-Smart-TV-using-the-App-WebOS-). ```yaml # Example configuration.yaml entry From 8717eb9f8fac923c3a9c9a4bc733d87f1ca29660 Mon Sep 17 00:00:00 2001 From: DubhAd Date: Sat, 11 Aug 2018 13:16:52 +0100 Subject: [PATCH 02/24] Minor changes (#5990) Taking out the "new and experimental" note - we're a dozen releases on, it's hardly new and seems to be (from a feature sense) stable. Re-written para 2 to reflect that HA needs shut down, and that 0.75 introduced the "future" UI. Re-written the supported components list because it's horribly out of date, and without trawling the code it's impossible to know what's supported. --- .../_docs/configuration/entity-registry.markdown | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/source/_docs/configuration/entity-registry.markdown b/source/_docs/configuration/entity-registry.markdown index b6183f7b76b..2f29afc306c 100644 --- a/source/_docs/configuration/entity-registry.markdown +++ b/source/_docs/configuration/entity-registry.markdown @@ -9,17 +9,14 @@ sharing: true footer: true --- -

-This is a new and experimental feature of Home Assistant. -

- Starting with version 0.63, Home Assistant keeps a registry of known entities. The entity registry makes sure that entities get unique identifiers and allow customizing the identifiers and names of these entities. -As this is still a very new part of Home Assistant, changes will require a -restart of Home Assistant to take effect. A config user interface will be added -in a future version. +Changes require that Home Assistant is shut down when you edit the file, otherwise +Home Assistant may over-write your changes, and a restart of Home Assistant is +required for your changes to take effect. Version 0.75 introduced a configuration +user interface.

An entity needs to have a unique ID to be registered in the entity registry. @@ -55,5 +52,6 @@ value to each entry. {% linkable_title Supported Components %} -At the moment, only the following components are supported: Z-Wave, Hue, Nest, LIFX, Sonos, Apple TV, Weather Underground +Only components that provide a unique ID for entities will are supported. + Note that for Weather Underground, second and subsequent Personal Weather Station ID (pws_id) will have their monitored conditions suffixed with an index number. From 3a0a54cf14afc18ea4a57919f29560a5a18f3f84 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 11 Aug 2018 14:20:33 +0200 Subject: [PATCH 03/24] Remove line braks --- .../configuration/entity-registry.markdown | 23 ++++++------------- 1 file changed, 7 insertions(+), 16 deletions(-) diff --git a/source/_docs/configuration/entity-registry.markdown b/source/_docs/configuration/entity-registry.markdown index 2f29afc306c..b699bb979eb 100644 --- a/source/_docs/configuration/entity-registry.markdown +++ b/source/_docs/configuration/entity-registry.markdown @@ -9,24 +9,18 @@ sharing: true footer: true --- -Starting with version 0.63, Home Assistant keeps a registry of known entities. -The entity registry makes sure that entities get unique identifiers and allow -customizing the identifiers and names of these entities. +Starting with version 0.63, Home Assistant keeps a registry of known entities. The entity registry makes sure that entities get unique identifiers and allow customizing the identifiers and names of these entities. -Changes require that Home Assistant is shut down when you edit the file, otherwise -Home Assistant may over-write your changes, and a restart of Home Assistant is -required for your changes to take effect. Version 0.75 introduced a configuration -user interface. +Changes require that Home Assistant is shut down when you edit the file, otherwise Home Assistant may over-write your changes, and a restart of Home Assistant is required for your changes to take effect. Version 0.75 introduced a configuration user interface.

An entity needs to have a unique ID to be registered in the entity registry. Not all integrations currently provide a unique id for their entities.

-The entity registry is stored in `/entity_registry.yaml`. As a user, -you are unable to add entries, only update them. Here is an example file: +The entity registry is stored in `/entity_registry.yaml`. As a user, you are unable to add entries, only update them. Here is an example file: -``` +```yaml climate.downstairs_virtual: platform: nest unique_id: EPoMyWkpNyoYu3pGlmGxabcdefghijkl @@ -37,16 +31,13 @@ light.study_ceiling: disabled_by: user ``` -As a user, you can change the `entity_id` and add the `name` and `disabled_by` -value to each entry. - - Changing the _first line_ of each entry will change the `entity_id` of the entity throughout Home Assistant. +As a user, you can change the `entity_id` and add the `name` and `disabled_by`value to each entry. + - Changing the _first line_ of each entry will change the `entity_id` of the entity throughout Home Assistant. - The value of `name` will override the _friendly name_ of the entity as given by the integration. _Added in Home Assistant 0.64._ - - The key `disabled_by` can either be `hass` or `user`. This functionality - is even more experimental than the whole entity registry itself and might - cause integrations to fail and might be removed in the future. + - The key `disabled_by` can either be `hass` or `user`. This functionality is even more experimental than the whole entity registry itself and might cause integrations to fail and might be removed in the future. _Added in Home Assistant 0.64._ From fac925790825d89b454aa713340981e9f0a0ba6b Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 11 Aug 2018 14:28:32 +0200 Subject: [PATCH 04/24] Update style --- .../_docs/configuration/templating.markdown | 83 +++++++++++-------- 1 file changed, 50 insertions(+), 33 deletions(-) diff --git a/source/_docs/configuration/templating.markdown b/source/_docs/configuration/templating.markdown index eea6b7c46df..f627d2ea834 100644 --- a/source/_docs/configuration/templating.markdown +++ b/source/_docs/configuration/templating.markdown @@ -17,16 +17,9 @@ This is an advanced feature of Home Assistant. You'll need a basic understanding Templating is a powerful feature in Home Assistant that allows the user control over information that is going into and out of the system. It is used for: -- Formatting outgoing messages in, for example, the [notify] and [alexa] components. -- Process incoming data from sources that provide raw data, like [MQTT], [REST sensor], or the [command line sensor]. -- [Automation Templating]. - -[notify]: /components/notify/ -[alexa]: /components/alexa/ -[MQTT]: /components/mqtt/ -[REST sensor]: /components/sensor.rest/ -[command line sensor]: /components/sensor.command_line/ -[Automation Templating]: /docs/automation/templating/ +- Formatting outgoing messages in, for example, the [notify](/components/notify/) platforms and [alexa](/components/alexa/) component. +- Process incoming data from sources that provide raw data, like [MQTT](/components/mqtt/), [`rest` sensor](/components/sensor.rest/) or the [`command_line` sensor](/components/sensor.command_line/). +- [Automation Templating](/docs/automation/templating/). ## {% linkable_title Building templates %} @@ -38,6 +31,7 @@ The frontend has a template editor developer tool to help develop and debug temp Templates can get big pretty fast. To keep a clear overview, consider using YAML multiline strings to define your templates: +{% raw %} ```yaml script: msg_who_is_home: @@ -45,12 +39,13 @@ script: - service: notify.notify data_template: message: > - {% raw %}{% if is_state('device_tracker.paulus', 'home') %} + {% if is_state('device_tracker.paulus', 'home') %} Ha, Paulus is home! {% else %} Paulus is at {{ states('device_tracker.paulus') }}. - {% endif %}{% endraw %} + {% endif %} ``` +{% endraw %} [Jinja2](http://jinja.pocoo.org/) supports a wide variety of operations: @@ -117,43 +112,51 @@ In templates, besides the normal [state object methods and properties](/topics/s ## {% linkable_title Examples %} ### {% linkable_title States %} + The next two statements result in same value if state exists. The second one will result in an error if state does not exist. +{% raw %} ```text -{% raw %}{{ states('device_tracker.paulus') }} -{{ states.device_tracker.paulus.state }}{% endraw %} +{{ states('device_tracker.paulus') }} +{{ states.device_tracker.paulus.state }} ``` +{% endraw %} ### {% linkable_title Attributes %} Print an attribute if state is defined. Both will return the same thing but the last one you can specify entity_id from a variable. +{% raw %} ```text -{% raw %}{% if states.device_tracker.paulus %} +{% if states.device_tracker.paulus %} {{ states.device_tracker.paulus.attributes.battery }} {% else %} ?? -{% endif %}{% endraw %} +{% endif %} ``` +{% endraw %} With strings +{% raw %} ```text -{% raw %}{% set tracker_name = "paulus"%} +{% set tracker_name = "paulus"%} {% if states("device_tracker." + tracker_name) != "unknown" %} {{ state_attr("device_tracker." + tracker_name, "battery")}} {% else %} ?? -{% endif %}{% endraw %} +{% endif %} ``` +{% endraw %} ### {% linkable_title Sensor states %} Print out a list of all the sensor states. +{% raw %} ```text -{% raw %}{% for state in states.sensor %} +{% for state in states.sensor %} {{ state.entity_id }}={{ state.state }}, {% endfor %} @@ -173,48 +176,58 @@ Print out a list of all the sensor states. {{ as_timestamp(states.binary_sensor.garage_door.last_changed) }} -{{ as_timestamp(now()) - as_timestamp(states.binary_sensor.garage_door.last_changed) }}{% endraw %} +{{ as_timestamp(now()) - as_timestamp(states.binary_sensor.garage_door.last_changed) }} ``` +{% endraw %} ### {% linkable_title Distance examples %} If only 1 location is passed in, Home Assistant will measure the distance from home. +{% raw %} ```text -{% raw %}Using Lat Lng coordinates: {{ distance(123.45, 123.45) }} +Using Lat Lng coordinates: {{ distance(123.45, 123.45) }} Using State: {{ distance(states.device_tracker.paulus) }} These can also be combined in any combination: {{ distance(123.45, 123.45, 'device_tracker.paulus') }} -{{ distance('device_tracker.anne_therese', 'device_tracker.paulus') }}{% endraw %} +{{ distance('device_tracker.anne_therese', 'device_tracker.paulus') }} ``` +{% endraw %} ### {% linkable_title Closest examples %} Find entities closest to the Home Assistant location: +{% raw %} ```text -{% raw %}Query all entities: {{ closest(states) }} +Query all entities: {{ closest(states) }} Query all entities of a specific domain: {{ closest('states.device_tracker') }} Query all entities in group.children: {{ closest('group.children') }} -Query all entities in group.children: {{ closest(states.group.children) }}{% endraw %} +Query all entities in group.children: {{ closest(states.group.children) }} ``` +{% endraw %} Find entities closest to a coordinate or another entity. All previous arguments still apply for 2nd argument. +{% raw %} ```text -{% raw %}Closest to a coordinate: {{ closest(23.456, 23.456, 'group.children') }} +Closest to a coordinate: {{ closest(23.456, 23.456, 'group.children') }} Closest to an entity: {{ closest('zone.school', 'group.children') }} -Closest to an entity: {{ closest(states.zone.school, 'group.children') }}{% endraw %} +Closest to an entity: {{ closest(states.zone.school, 'group.children') }} ``` +{% endraw %} ### {% linkable_title Combined %} + Since closest returns a state, we can combine it with distance too. +{% raw %} ```text -{% raw %}{{ closest(states).name }} is {{ distance(closest(states)) }} kilometers away.{% endraw %} +{{ closest(states).name }} is {{ distance(closest(states)) }} kilometers away. ``` +{% endraw %} ## {% linkable_title Processing incoming data %} @@ -238,11 +251,13 @@ This means that if the incoming values looks like the sample below: The template for `on` would be: +{% raw %} ```yaml -'{% raw %}{{value_json.on}}{% endraw %}' +'{{value_json.on}}' ``` +{% endraw %} -Nested JSON in a response is supported as well +Nested JSON in a response is supported as well: ```json { @@ -259,10 +274,11 @@ Nested JSON in a response is supported as well Just use the "Square bracket notation" to get the value. +{% raw %} ```yaml -'{% raw %}{{ value_json["values"]["temp"] }}{% endraw %}' +'{{ value_json["values"]["temp"] }}' ``` - +{% endraw %} The following overview contains a couple of options to get the needed values: @@ -294,8 +310,8 @@ The following overview contains a couple of options to get the needed values: To evaluate a response, go to the template developer tool icon template developer tools, create your output into "Template", and check the result. -```yaml {% raw %} +```yaml {% set value_json= {"name":"Outside", "device":"weather-ha", @@ -304,5 +320,6 @@ To evaluate a response, go to the +Rendering templates with time (`now()`) is dangerous as trigger templates only update based on entity state changes. +

+ ### {% linkable_title Time trigger %} Time can be triggered in many ways. The most common is to specify `at` and trigger at a specific point in time each day. Alternatively, you can also match if the hour, minute or second of the current time has a specific value. You can prefix the value with a `/` to match whenever the value is divisible by that number. You cannot use `at` together with hour, minute or second. From ea30a52a7881dd5f83fcee700ff06085634943a1 Mon Sep 17 00:00:00 2001 From: DubhAd Date: Sat, 11 Aug 2018 21:34:02 +0100 Subject: [PATCH 08/24] Making the warning clearer, and linkable (#5994) Making the warning clearer (I'll add something similar to the template trigger docs), and putting a title in so that we can link to it. --- source/_docs/configuration/templating.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/source/_docs/configuration/templating.markdown b/source/_docs/configuration/templating.markdown index f627d2ea834..69ad76211bf 100644 --- a/source/_docs/configuration/templating.markdown +++ b/source/_docs/configuration/templating.markdown @@ -99,8 +99,10 @@ Home Assistant adds extensions to allow templates to access all of the current s If your template uses an `entity_id` that begins with a number (example: `states.device_tracker.2008_gmc`) you must use a bracket syntax to avoid errors caused by rendering the `entity_id` improperly. In the example given, the correct syntax for the device tracker would be: `states.device_tracker['2008_gmc']`

+## {% linkable_title Templates using `now()` %} +

-Rendering templates with time is dangerous as updates only trigger templates in sensors based on entity state changes. +Rendering templates with time (`now()`) is dangerous as updates only trigger templates in sensors based on entity state changes.

## {% linkable_title Home Assistant template extensions %} From bfd6b34ee4e7f23e95db8e2356831839124afc9b Mon Sep 17 00:00:00 2001 From: DubhAd Date: Sun, 12 Aug 2018 17:09:37 +0100 Subject: [PATCH 09/24] Fixing the example (#5999) Looks like when the last update to the docs was done, the example was overlooked. --- source/_lovelace/map.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_lovelace/map.markdown b/source/_lovelace/map.markdown index 023b386b37b..503d4ee0bb7 100644 --- a/source/_lovelace/map.markdown +++ b/source/_lovelace/map.markdown @@ -52,6 +52,6 @@ aspect_ratio: - type: map aspect_ratio: 100% entities: - - entity: device_tracker.demo_paulus + - device_tracker.demo_paulus - zone.home ``` From 6a5d92611f0249be69100e998a574534c4037f19 Mon Sep 17 00:00:00 2001 From: DubhAd Date: Sun, 12 Aug 2018 19:39:16 +0100 Subject: [PATCH 10/24] Adding details of merging trackers (#6000) * Adding details of merging trackers Since the merging of trackers works for more than just OwnTracks (at least GPS Logger, probably more), adding the details here at the top level. * Minor changes --- source/_components/device_tracker.markdown | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/source/_components/device_tracker.markdown b/source/_components/device_tracker.markdown index 41fd9b25a54..8f0d46cfc84 100644 --- a/source/_components/device_tracker.markdown +++ b/source/_components/device_tracker.markdown @@ -29,7 +29,6 @@ device_tracker: new_device_defaults: track_new_devices: True hide_if_away: False - ``` The following optional parameters can be used with any platform. However device tracker will only look for global settings under the configuration of the first configured platform: @@ -89,6 +88,24 @@ devicename: | `hide_if_away` | False | If `yes`/`on`/`true` then the device will be hidden if it is not at home. | | `consider_home` | [uses platform setting] | Seconds to wait till marking someone as not home after not being seen. Allows you to override the global `consider_home` setting from the platform configuration on a per device level. | +## {% linkable_title Using GPS device trackers with local network device trackers %} + +GPS based device trackers (like [OwnTracks](/components/device_tracker.owntracks/), [GPSLogger](/components/device_tracker.gpslogger) and others) can also be used with local network device trackers, such as [Nmap](/components/device_tracker.nmap_tracker/) or [Netgear](/components/device_tracker.netgear/). To do this, fill in the `mac` field to the entry in `known_devices.yaml` with the MAC address of the device you want to track. This way the state of the device will be determined by *the source that reported last*. The naming convention for known device list is `_` and could be set in the app configuration. + +An example showing the inclusion of the `mac` field for multiple platform tracking. The `mac` field was added to the GPS based device tracker entry and will enable tracking by all platforms that track via the `mac` address. + +```yaml +USERNAME_DEVICE_ID: + name: Friendly Name + mac: EA:AA:55:E7:C6:94 + picture: https://www.home-assistant.io/images/favicon-192x192.png + gravatar: test@example.com + track: yes + hide_if_away: no +``` + +If you want to track whether either your GPS based tracker or your local network tracker, identify you as being at home, use [a group](/components/group/) instead. + ## {% linkable_title Device states %} The state of your tracked device will be `'home'` if it is in the [home zone](/components/zone#home-zone), detected by your network or Bluetooth based presence detection. If you're using a presence detection method that includes coordinates then when it's in a zone the state will be the name of the zone (in lower case). When a device isn't at home and isn't in any zone, the state will be `'not_home'`. From 316932fa8d8423c4f41971193368a3e4c5afcc63 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Mon, 13 Aug 2018 10:38:53 +0200 Subject: [PATCH 11/24] Update broker.markdown --- source/_docs/mqtt/broker.markdown | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/source/_docs/mqtt/broker.markdown b/source/_docs/mqtt/broker.markdown index 47a19df934f..d95b8fa8c36 100644 --- a/source/_docs/mqtt/broker.markdown +++ b/source/_docs/mqtt/broker.markdown @@ -32,10 +32,7 @@ mqtt: ```

-There is an issue with the HBMQTT broker that can cause a memory leak (slowly increasing used memory). This causes an unstable system after the memory is full. You could measure/monitor this with a system monitor. The issue is from 2016 and could already be resolved with newer versions. Use another broker when you experience this issue, for example, Mosquitto.
-
-Issue with the HBMQTT broker: https://github.com/beerfactory/hbmqtt/issues/62
-System monitor: https://www.home-assistant.io/components/sensor.systemmonitor/ +There is [an issue](https://github.com/beerfactory/hbmqtt/issues/62) with the HBMQTT broker and the WebSocket connection that is causing a memory leak. If you experience this issue, consider using another broker like Mosquitto.

### {% linkable_title Owntracks%} From 7956d7686c463dae49cee93701db4b478d20df21 Mon Sep 17 00:00:00 2001 From: Mauricio Vidal Date: Mon, 13 Aug 2018 04:08:08 -0500 Subject: [PATCH 12/24] Update raspberry-pi.markdown (#6003) * Update raspberry-pi.markdown That package is required to prevent the error "Unable to install package netdisco" when running hass or the first time. * Minor change --- source/_docs/installation/raspberry-pi.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/installation/raspberry-pi.markdown b/source/_docs/installation/raspberry-pi.markdown index aa5dee1502e..2ae0bc857b5 100644 --- a/source/_docs/installation/raspberry-pi.markdown +++ b/source/_docs/installation/raspberry-pi.markdown @@ -12,7 +12,7 @@ redirect_from: /getting-started/installation-raspberry-pi/ This installation of Home Assistant requires the Raspberry Pi to run [Raspbian Lite](https://www.raspberrypi.org/downloads/raspbian/). The installation will be installed in a [Virtual Environment](/docs/installation/virtualenv) with minimal overhead. Instructions assume this is a new installation of Raspbian Lite. -You must have Python 3.5.3 or later installed, which is the case for Raspbian Stretch. +You must have Python 3.5.3 or later installed (including the package `python3-dev`) which is the case for Raspbian Stretch.

Although these installation steps specifically mention a Raspberry Pi, you can go ahead and proceed on any Linux install as well. This guide is also referred to as the "Advanced Guide" for a virtual environment install. From 02dd9e59ea10502cfd92e656fd7fd27dd4da5741 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Mon, 13 Aug 2018 17:03:23 +0200 Subject: [PATCH 13/24] Update mobile.markdown --- source/_docs/frontend/mobile.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/frontend/mobile.markdown b/source/_docs/frontend/mobile.markdown index d7342115b7f..7aa94916372 100644 --- a/source/_docs/frontend/mobile.markdown +++ b/source/_docs/frontend/mobile.markdown @@ -22,7 +22,7 @@ On both Android and iOS, you can add the Home Assistant "web app" to your homesc 4. Tap on Add to Homescreen 5. A dialog will popup; tap on Add -

+

From 61fdbc940fd000a27692995d5891426822f7931f Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 13 Aug 2018 17:32:24 +0200 Subject: [PATCH 14/24] Fix variables and description --- .../device_tracker.linksys_ap.markdown | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/source/_components/device_tracker.linksys_ap.markdown b/source/_components/device_tracker.linksys_ap.markdown index 6cdc3984b2e..70cc3e17a14 100644 --- a/source/_components/device_tracker.linksys_ap.markdown +++ b/source/_components/device_tracker.linksys_ap.markdown @@ -13,8 +13,11 @@ ha_release: 0.37 --- The `linksys_ap` platform offers presence detection by looking at connected devices to a Linksys based access point. + It was tested with a LAPAC1750 AC1750 Dual Band Access Point. +## {% linkable_title Configuration %} + To use a Linksys Access Point in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -22,25 +25,28 @@ To use a Linksys Access Point in your installation, add the following to your `c device_tracker: - platform: linksys_ap host: 192.168.1.1 - username: admin - password: password + username: YOUR_USERNAME + password: YOUR_PASSWORD ``` Configuration variables: - **host** (*Required*): The hostname or IP address of your access point, eg. `192.168.1.1`. -- **username** (*Required*: The username of an user with administrative privileges (read-only is sufficient). +- **username** (*Required*): The username of an user with administrative privileges (read-only is sufficient). - **password** (*Required*): The password for your given admin account. -- **verify_ssl** (*Optional*): Verify SSL certificate for https request. Defaults to true. +- **verify_ssl** (*Optional*): Verify SSL certificate for HTTPS request. Defaults to true. + +## {% linkable_title Example %} Example for all configuration options: + ```yaml # Example configuration.yaml entry device_tracker: - platform: linksys_ap host: 192.168.1.1 - username: admin - password: password + username: YOUR_USERNAME + password: YOUR_PASSWORD verify_ssl: true scan_interval: 6 consider_home: 12 From c561c05f077b0fbcaab325c605ed0818c3694d35 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 13 Aug 2018 17:34:21 +0200 Subject: [PATCH 15/24] Make a list, remove note and add some structure --- .../_components/device_tracker.linksys_smart.markdown | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/source/_components/device_tracker.linksys_smart.markdown b/source/_components/device_tracker.linksys_smart.markdown index 0b9875e5f23..0cc22363fd9 100644 --- a/source/_components/device_tracker.linksys_smart.markdown +++ b/source/_components/device_tracker.linksys_smart.markdown @@ -15,12 +15,15 @@ ha_release: 0.48 The `linksys_smart` platform offers presence detection by looking at connected devices to a Linksys Smart Wifi based router. Tested routers: - LINKSYS WRT3200ACM MU-MIMO Gigabit Wi-Fi Wireless Router - LINKSYS WRT1900ACS Dual-band Wi-Fi Router -

+- Linksys WRT3200ACM MU-MIMO Gigabit Wi-Fi Wireless Router +- Linksys WRT1900ACS Dual-band Wi-Fi Router + +## {% linkable_title Setup %} + For this platform to work correctly, it is necessary to disable the "Access via wireless" feature in the Local Management Access section of the router administration page. If "Access via wireless" is not disabled, a connectivity conflict arises because the Home Assistant integration is trying to pass userid and password, but the router is only expecting a password. -

+ +## {% linkable_title Configuration %} To use a Linksys Smart Wifi Router in your Home Assistant installation, add the following to your `configuration.yaml` file: From 53ee29caceda329773cb45f2bb88ae5818fc1f10 Mon Sep 17 00:00:00 2001 From: DubhAd Date: Mon, 13 Aug 2018 20:07:42 +0100 Subject: [PATCH 16/24] Added link to the FAQ at the top (#5997) Seems to be a common problem with people assuming that random browser X will "just work", and the FAQ is hidden away. --- source/lovelace/index.markdown | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/source/lovelace/index.markdown b/source/lovelace/index.markdown index a78abb9fc3a..fb9e57e95b8 100644 --- a/source/lovelace/index.markdown +++ b/source/lovelace/index.markdown @@ -26,6 +26,10 @@ The Lovelace UI is: +

+If you're not using Chrome, please be sure to [read the FAQ](/lovelace/#faq) below. +

+ ## {% linkable_title How it works %} The old user interface relied solely on the state machine. This caused trouble as it meant that the state machine was now not only the source for device states, but also for user interface configuration. With Lovelace, we're taking a completely different approach. All user interface configuration will live in a separate file, controlled by the user. From 9bfe7a4da95b515dc7bb81a9d8b53e3a6299db27 Mon Sep 17 00:00:00 2001 From: DubhAd Date: Mon, 13 Aug 2018 20:08:31 +0100 Subject: [PATCH 17/24] Making it clearer what column_width does (#5996) Added more words to make it clearer what it does, and how to use a value to get the number of entities you want in a row --- source/_lovelace/glance.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_lovelace/glance.markdown b/source/_lovelace/glance.markdown index ab3c553bd08..beb4b852641 100644 --- a/source/_lovelace/glance.markdown +++ b/source/_lovelace/glance.markdown @@ -42,7 +42,7 @@ show_state: default: "true" column_width: required: false - description: "Column width as CSS length like `100px` or `calc(100% / 7)`." + description: "Column width as CSS length like `100px` or `calc(100% / 7)`. This controls how many entities appear in a row - at the default 20% you have 5 entities in a row. Use `calc(100% / 7)` for 7 entities in a row, and so on." type: string default: 20% {% endconfiguration %} From d6965b320555508e62df1b915644468a98a2ecd9 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 13 Aug 2018 21:13:14 +0200 Subject: [PATCH 18/24] Change section (fixes #5987) (#6011) --- source/_components/notify.telegram.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/notify.telegram.markdown b/source/_components/notify.telegram.markdown index 077288efab2..9fd9b2f0d63 100644 --- a/source/_components/notify.telegram.markdown +++ b/source/_components/notify.telegram.markdown @@ -25,7 +25,7 @@ To retrieve your `chat_id`, contact any of the Telegram bots created for this pu The quickest way to retrieve your `chat_id` is visiting [https://api.telegram.org/botYOUR_API_TOKEN/getUpdates](https://api.telegram.org/botYOUR_API_TOKEN/getUpdates) or to use `$ curl -X GET https://api.telegram.org/botYOUR_API_TOKEN/getUpdates`. Replace `YOUR_API_TOKEN` with your actual token. -The result set will include your chat ID as `id` in the `from` section: +The result set will include your chat ID as `id` in the `chat` section: ```json { From f2463cab1a48723c1d9a34cc5d7dcf48171f8290 Mon Sep 17 00:00:00 2001 From: Josa Gesell Date: Mon, 13 Aug 2018 21:17:03 +0200 Subject: [PATCH 19/24] Fix typos in Homematic documentation (#5992) * Fix typos in Homematic documentation * Fix our name * Other minor fixes * Remove some sentences --- source/_addons/homematic.markdown | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/source/_addons/homematic.markdown b/source/_addons/homematic.markdown index 6a92bbff817..50a56b1bd9d 100644 --- a/source/_addons/homematic.markdown +++ b/source/_addons/homematic.markdown @@ -9,11 +9,12 @@ sharing: true footer: true --- -Set up a [HomeMatic](https://github.com/eq-3/occu) hardware layer. At the moment we don't support hmIP, but that is in progress. For learning and handling devices use our internal HomeMatic panel and services (in progress) or use [Homematic-Manager](https://github.com/hobbyquaker/homematic-manager) > 2.0. +Set up a [HomeMatic](https://github.com/eq-3/occu) hardware layer. For learning and handling devices use [Homematic-Manager](https://github.com/hobbyquaker/homematic-manager) > 2.0. -The logic layer will be Home-Assistant. There is no ReGa or other logic layer installed. You can't import an existing configuration, you'll need re-learn it into Home-Assistant. +The logic layer will be Home Assistant. There is no ReGa or other logic layer installed. You can't import an existing configuration, you'll need re-learn it into Home Assistant. Follow devices will be supported and tested: + - [HM-MOD-RPI-PCB](https://www.elv.ch/homematic-funkmodul-fuer-raspberry-pi-bausatz.html) ```json @@ -38,17 +39,19 @@ Follow devices will be supported and tested: Configuration variables: -- **rf_enable** (*Require*): Boolean. Enable or disable BidCoS-RF. -- **wired_enable** (*Require*): Boolean. Enable or disable BidCoS-Wired. +- **rf_enable** (*Required*): Boolean. Enable or disable BidCoS-RF. +- **wired_enable** (*Required*): Boolean. Enable or disable BidCoS-Wired. -For RF devices -- **type** (*Require*): Device type for RFD service. Look into the manual of your device. -- **device** (*Require*): Device on the host. +For RF devices: -For RF devices -- **serial** (*Require*): Serial number of the device. -- **key** (*Require*): Encrypted key. -- **ip** (*Require*): IP address of LAN gateway. +- **type** (*Required*): Device type for RFD service. Look into the manual of your device. +- **device** (*Required*): Device on the host. + +For wired devices: + +- **serial** (*Required*): Serial number of the device. +- **key** (*Required*): Encrypted key. +- **ip** (*Required*): IP address of LAN gateway. ## {% linkable_title Home Assistant configuration %} @@ -64,7 +67,8 @@ homematic: ## {% linkable_title Raspberry Pi3 %} -With HM-MOD-PRI-PCB you need to add follow into your `config.txt` on boot partition: -``` +With HM-MOD-RPI-PCB you need to add follow into your `config.txt` on boot partition: + +```text dtoverlay=pi3-miniuart-bt ``` From 4153aed71b9fc7bd5741233aab9281d75a0dbd27 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 13 Aug 2018 21:22:35 +0200 Subject: [PATCH 20/24] Add options added with 4.0 (fixes #6007) (#6009) --- source/_addons/git_pull.markdown | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/source/_addons/git_pull.markdown b/source/_addons/git_pull.markdown index a316149cae4..8cb2c3a852b 100644 --- a/source/_addons/git_pull.markdown +++ b/source/_addons/git_pull.markdown @@ -9,7 +9,7 @@ sharing: true footer: true --- -Load and update configuration files for Home Assistant from a GIT repository. +Load and update configuration files for Home Assistant from a [Git](https://git-scm.com/) repository. ```json { @@ -22,6 +22,8 @@ Load and update configuration files for Home Assistant from a GIT repository. "active": false, "interval": 300 }, + "deployment_user": "", + "deployment_password": "", "deployment_key": [ "-----BEGIN RSA PRIVATE KEY-----", "MIIEowIBAAKCAQEAv3hUrCvqGZKpXQ5ofxTOuH6pYSOZDsCqPqmaGBdUzBFgauQM", @@ -35,33 +37,33 @@ Load and update configuration files for Home Assistant from a GIT repository. } ``` -- **repository** (*Required*): Git URL to your repository (make sure to use double quotes). You have to add .git to your GitHub repository URL (see example config) -- **git_branch** (*Required*): Branch name of the git repo, leave this as 'master' if you are unsure. -- **git_remote** (*Required*): Name of the tracked repository, leave this as 'origin' if you are unsure. -- **git_command** (*Required*): Must be either 'pull' or 'reset', leave this as 'pull' if you are unsure. +- **repository** (*Required*): Git URL to your repository (make sure to use double quotes). You have to add `.git` to your GitHub repository URL (see example configuration) +- **git_branch** (*Required*): Branch name of the Git repo, leave this as 'master' if you are unsure. +- **git_remote** (*Required*): Name of the tracked repository. Leave this as `origin` if you are unsure. +- **git_command** (*Required*): Must be either `pull` or `reset`. Leave this as `pull` if you are unsure. * **pull**: Incorporates changes from a remote repository into the current branch. Will preserve any local changes to tracked files. - * **reset**: Will execute ```git reset --hard``` and overwrite any local changes to tracked files and update from the remote repository. + * **reset**: Will execute `git reset --hard` and overwrite any local changes to tracked files and update from the remote repository.

- Using the reset option will overwrite changes to tracked files. Tracked files are those visible in the Github repository or those given by the output on this command: ```git ls-tree -r master --name-only``` + Using the `reset` option will overwrite changes to tracked files. Tracked files are those visible in the Github repository or those given by the output on this command: `git ls-tree -r master --name-only`.

- **auto_restart** (*Optional*): Restart Home Assistant when the configuration has changed (and is valid). -- **repeat/active** (*Optional*): Pull periodic for git updates. +- **repeat/active** (*Optional*): Pull periodic for Git updates. - **repeat/interval** (*Optional*): Pull all x seconds and look for changes. -- **deployment_user** (*Optional*): Username to use when authenticating to a repo with a username and password. -- **deployment_password** (*Optional*): Password to use when authenticating to a repo. Ignored if deployment_user is not set. -- **deployment_key** (*Optional*): A private SSH key that will be used for communication during git operations. This key is mandatory for ssh-accessed repositories, which are the ones with the following pattern: `@:`. -- **deployment_key_protocol** (*Optional*): The key protocol. Default is "rsa". Valid protocols are: +- **deployment_user** (*Optional*): Username to use when authenticating to a repository with a username and password. +- **deployment_password** (*Optional*): Password to use when authenticating to a repository. Ignored if `deployment_user` is not set. +- **deployment_key** (*Optional*): A private SSH key that will be used for communication during Git operations. This key is mandatory for ssh-accessed repositories, which are the ones with the following pattern: `@:`. +- **deployment_key_protocol** (*Optional*): The key protocol. Default is `rsa`. Valid protocols are: * **dsa** * **ecdsa** * **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.

-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`. +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`.

From a9f09a2dbe97736c21f653936434dbf09c3c1ecb Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 13 Aug 2018 21:25:02 +0200 Subject: [PATCH 21/24] Minor changes (style fixes, links and typos) (#6010) --- source/_addons/bluetooth_bcm43xx.markdown | 7 +++++-- source/_addons/check_config.markdown | 2 +- source/_addons/google_assistant.markdown | 4 ++-- source/_addons/mariadb.markdown | 22 +++++++++++----------- source/_addons/rpc_shutdown.markdown | 2 +- source/_addons/samba.markdown | 2 +- source/_addons/tellstick.markdown | 9 +++------ 7 files changed, 24 insertions(+), 24 deletions(-) diff --git a/source/_addons/bluetooth_bcm43xx.markdown b/source/_addons/bluetooth_bcm43xx.markdown index a34b2fa08a7..65ae6eec053 100644 --- a/source/_addons/bluetooth_bcm43xx.markdown +++ b/source/_addons/bluetooth_bcm43xx.markdown @@ -12,7 +12,10 @@ footer: true Start this add-on to activate the BCM43xx Bluetooth chipset.

- This is not required on HassOS based Hass.io installs and should not be installed + This is not required on HassOS based Hass.io installs and should not be installed.

-Supported platforms: Raspberry Pi 3. +Supported platforms: + +- Raspberry Pi 3 + diff --git a/source/_addons/check_config.markdown b/source/_addons/check_config.markdown index f10f69848fe..1ef8abd754a 100644 --- a/source/_addons/check_config.markdown +++ b/source/_addons/check_config.markdown @@ -9,7 +9,7 @@ sharing: true footer: true --- -You can use this addon to check whether your configuration files are valid against the new version of Home Assistant before you actually update your Home Assistant installation. This addon will help you avoid errors due to breaking changes, resulting in a smooth update. +You can use this add-on to check whether your configuration files are valid against the new version of Home Assistant before you actually update your Home Assistant installation. This add-on will help you avoid errors due to breaking changes, resulting in a smooth update. ```json { diff --git a/source/_addons/google_assistant.markdown b/source/_addons/google_assistant.markdown index 40923fdb19d..2c8e0adba2e 100644 --- a/source/_addons/google_assistant.markdown +++ b/source/_addons/google_assistant.markdown @@ -11,11 +11,11 @@ featured: true ---

- These instructions are outdated - the add-on has been updated and these are no longer accurate or complete + These instructions are outdated - the add-on has been updated and these are no longer accurate or complete.

- If you want to integrate your Google Home, or mobile phone running Google Assistant, with Home Assistant, then you want the [Google Assistant component](/components/google_assistant/). + If you want to integrate your Google Home or mobile phone running Google Assistant, with Home Assistant, then you want the [Google Assistant component](/components/google_assistant/).

[Google Assistant][GoogleAssistant] is an AI-powered voice assistant that runs on the Raspberry Pi and x86 platforms and interact via the [DialogFlow][comp] integration with Home-Assistant. You can also use [Google Actions][GoogleActions] to extend its functionality. diff --git a/source/_addons/mariadb.markdown b/source/_addons/mariadb.markdown index 013bdc8ebb4..cbc2d78b474 100644 --- a/source/_addons/mariadb.markdown +++ b/source/_addons/mariadb.markdown @@ -9,7 +9,7 @@ sharing: true footer: true --- -Set up a [mariadb](https://mariadb.org/) SQL server. It supports multiple databases, users and permission settings. If you want to only connect from inside Home Assistant use `core-mariadb` as the host address. +Set up a [MariaDB](https://mariadb.org/) SQL server. It supports multiple databases, users and permission settings. If you want to only connect from inside Home Assistant use `core-mariadb` as the host address. ```json { @@ -34,16 +34,16 @@ Set up a [mariadb](https://mariadb.org/) SQL server. It supports multiple databa Configuration variables: -- **databases** (*Require*): List of databases. -- **logins** (*Require*): List of SQL accounts to create or update. - - **username** (*Require*): Username for account. - - **host** (*Require*): Host for account. If you need an account on multiple hosts, use '%'. - - **password** (*Require*): Password for account. -- **rights** (*Require*): List of rights to be granted. - - **username** (*Require*): Username for granted rights. - - **host** (*Require*): Host is a part of username like above. - - **database** (*Require*): Database name on which to grant user rights. - - **grant** (*Require*): SQL grant part for access too. +- **databases** (*Required*): List of databases. +- **logins** (*Required*): List of SQL accounts to create or update. + - **username** (*Required*): Username for account. + - **host** (*Required*): Host for account. If you need an account on multiple hosts, use '%'. + - **password** (*Required*): Password for account. +- **rights** (*Required*): List of rights to be granted. + - **username** (*Required*): Username for granted rights. + - **host** (*Required*): Host is a part of username like above. + - **database** (*Required*): Database name on which to grant user rights. + - **grant** (*Required*): SQL grant part for access too. ## {% linkable_title Home Assistant configuration %} diff --git a/source/_addons/rpc_shutdown.markdown b/source/_addons/rpc_shutdown.markdown index a4d2d6689a9..d098c1d1d33 100644 --- a/source/_addons/rpc_shutdown.markdown +++ b/source/_addons/rpc_shutdown.markdown @@ -28,7 +28,7 @@ Allows you to shut down a Windows computer with a service call from Home Assista - **computers/address** (*Required*): IP address or NetBIOS name of the computer for the shutdown. - **computers/credentials** (*Required*): Credentials for logging into computer. Use a `%` as the delimiter of username and password. -## {% linkable_title Home Assistant %} +### {% linkable_title Home Assistant configuration %} Use the following inside Home Assistant service call to use it: diff --git a/source/_addons/samba.markdown b/source/_addons/samba.markdown index 6b378a5dd87..939d3c95505 100644 --- a/source/_addons/samba.markdown +++ b/source/_addons/samba.markdown @@ -10,7 +10,7 @@ footer: true featured: true --- -This addon allows you to set up a [Samba](https://samba.org/) server to access hass.io folders using Windows network shares. +This addon allows you to set up a [Samba](https://samba.org/) server to access Hass.io folders using Windows network shares. ```json { diff --git a/source/_addons/tellstick.markdown b/source/_addons/tellstick.markdown index 49764d93dae..1bae8bac498 100644 --- a/source/_addons/tellstick.markdown +++ b/source/_addons/tellstick.markdown @@ -33,11 +33,9 @@ You will need to add internal communication details to `configuration.yaml` to e ```yaml # Example configuration.yaml entry - tellstick: host: core-tellstick port: [50800, 50801] - ``` To add [lights](/components/light.tellstick/), [sensors](/components/sensor.tellstick/) and [switches](/components/switch.tellstick/) you follow the guidelines for each type individually that is [described for Home Assistant](/components/tellstick/) @@ -71,9 +69,9 @@ Example for adding more devices in the add-on configuration (note the comma sepa } ``` -## Service calls +## {% linkable_title Service calls %} -If you wish to teach a selflearning device in your TellStick configuration: +If you wish to teach a self-learning device in your TellStick configuration: Go to Home Assistant [service call](http://hassio.local:8123/dev-service) in Developer tools and select. - Service: `hassio.addon_stdin` @@ -85,8 +83,7 @@ Replace `1` with the corresponding ID of the device in your TellStick configurat You can also use this to list devices or sensors and read the output in the add-on log: `{"addon":"core_tellstick","input":{"function":"list-sensors"}}` - -#### Supported service commands +### {% linkable_title Supported service commands %} - `"function":"list"`: List currently configured devices with name and device id and all discovered sensors. From 6c342d3f28378bd49de725adccf6e568e6fe6130 Mon Sep 17 00:00:00 2001 From: chknetsc <2544255+chknetsc@users.noreply.github.com> Date: Tue, 14 Aug 2018 01:02:25 +0200 Subject: [PATCH 22/24] Update media_player.panasonic_viera.markdown (#5979) --- source/_components/media_player.panasonic_viera.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_components/media_player.panasonic_viera.markdown b/source/_components/media_player.panasonic_viera.markdown index 28778486017..601659a11d1 100644 --- a/source/_components/media_player.panasonic_viera.markdown +++ b/source/_components/media_player.panasonic_viera.markdown @@ -23,6 +23,7 @@ Currently known supported models: - TX-49DX650B - TX-50DX700B - TX-55CX700E +- TX-55EXW584 - TX-65EXW784 - TX-L42ET50 - TX-P42STW50 From 10a3e0f9dc3dae31f28ed4f7644fad7aef3868a1 Mon Sep 17 00:00:00 2001 From: DubhAd Date: Tue, 14 Aug 2018 00:20:02 +0100 Subject: [PATCH 23/24] Reordering config options (#6008) * Reordering config options A few folks have missed the `trusted_proxies` setting, and wondered why access without a password is permitted if the proxy is in the trusted networks. Added a few words and some emphasis, and took the time to rework it into the new config layout. * :ambulance: Configuration tag fixes * :ambulance: Fixes quotes in configuration block --- source/_components/http.markdown | 74 ++++++++++++++++++++++++++------ 1 file changed, 60 insertions(+), 14 deletions(-) diff --git a/source/_components/http.markdown b/source/_components/http.markdown index 0616476bf07..1a7416b0b3f 100644 --- a/source/_components/http.markdown +++ b/source/_components/http.markdown @@ -18,7 +18,7 @@ It is HIGHLY recommended that you set the `api_password`, especially if you are

-Don't use option `server_host` on a hass.io installation! +Don't use option `server_host` on a Hass.io installation!

```yaml @@ -29,19 +29,65 @@ http: Configuration variables: -- **api_password** (*Optional*): Protect Home Assistant with a password. -- **server_host** (*Optional*): Only listen to incoming requests on specific IP/host (default: bind to `0.0.0.0` which means accept all IPv4 connections). Use `server_host: "::0"` if you want to listen to (and only) IPv6. -- **server_port** (*Optional*): Let you set a port to use. Defaults to 8123. -- **base_url** (*Optional*): The URL that Home Assistant is available on the internet. For example: `hass-example.duckdns.org:8123`. Defaults to the local IP address. The iOS app finds local installations, if you have an outside URL use this so that you can auto-fill when discovered in the app. -- **ssl_certificate** (*Optional*): Path to your TLS/SSL certificate to serve Home Assistant over a secure connection. -- **ssl_peer_certificate** (*Optional*): Path to the client/peer TLS/SSL certificate to accept secure connections from. -- **ssl_key** (*Optional*): Path to your TLS/SSL key to serve Home Assistant over a secure connection. -- **cors_allowed_origins** (*Optional*): A list of origin domain names to allow [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) requests from. Enabling this will set the `Access-Control-Allow-Origin` header to the Origin header if it is found in the list, and the `Access-Control-Allow-Headers` header to `Origin, Accept, X-Requested-With, Content-type, X-HA-access`. You must provide the exact Origin, i.e. `https://www.home-assistant.io` will allow requests from `https://www.home-assistant.io` but __not__ `http://www.home-assistant.io`. -- **use_x_forwarded_for** (*Optional*): Enable parsing of the `X-Forwarded-For` header, passing on the client's correct IP address in proxied setups. You must also whitelist trusted proxies using the `trusted_proxies` setting below for this to work. Non-whitelisted requests with this header will be considered IP spoofing attacks, and the header will, therefore, be ignored. Defaults to False. -- **trusted_proxies** (*Optional*): List of trusted proxies, consisting of IP addresses or networks, that are allowed to set the `X-Forwarded-For` header. This is required when using `use_x_forwarded_for` because all requests to Home Assistant, regardless of source, will arrive from the reverse proxy IP address. Therefore in a reverse proxy scenario, this option should be set with extreme care. -- **trusted_networks** (*Optional*): List of trusted networks, consisting of IP addresses or networks, that are allowed to bypass password protection when accessing Home Assistant. If using a reverse proxy with the `use_x_forwarded_for` option enabled, requests proxied to Home Assistant with a trusted `X-Forwarded-For` header will appear to come from the IP given in that header instead of the proxy IP. -- **ip_ban_enabled** (*Optional*): Flag indicating whether additional IP filtering is enabled. Defaults to False. -- **login_attempts_threshold** (*Optional*): Number of failed login attempt from single IP after which it will be automatically banned if `ip_ban_enabled` is True. Defaults to -1, meaning that no new automatic bans will be added. +{% configuration http %} +api_password: + description: Protect Home Assistant with a password. + required: false + type: string +server_host: + description: 'Only listen to incoming requests on specific IP/host (default: bind to `0.0.0.0` which means accept all IPv4 connections). Use `server_host: "::0"` if you want to listen to (and only) IPv6.' + required: false + type: string +server_port: + description: Let you set a port to use. + required: false + type: integer + default: 8123 +base_url: + description: "The URL that Home Assistant is available on the internet. For example: `hass-example.duckdns.org:8123`. Defaults to the local IP address. The iOS app finds local installations, if you have an outside URL use this so that you can auto-fill when discovered in the app." + required: false + type: string + default: The local IP address +ssl_certificate: + description: Path to your TLS/SSL certificate to serve Home Assistant over a secure connection. + required: false + type: string +ssl_peer_certificate: + description: Path to the client/peer TLS/SSL certificate to accept secure connections from. + required: false + type: string +ssl_key: + description: Path to your TLS/SSL key to serve Home Assistant over a secure connection. + required: false + type: string +cors_allowed_origins: + description: "A list of origin domain names to allow [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) requests from. Enabling this will set the `Access-Control-Allow-Origin` header to the Origin header if it is found in the list, and the `Access-Control-Allow-Headers` header to `Origin, Accept, X-Requested-With, Content-type, X-HA-access`. You must provide the exact Origin, i.e. `https://www.home-assistant.io` will allow requests from `https://www.home-assistant.io` but __not__ `http://www.home-assistant.io`." + required: false + type: string, list +trusted_proxies: + description: "List of trusted proxies, consisting of IP addresses or networks, that are allowed to set the `X-Forwarded-For` header. This is required when using `use_x_forwarded_for` because all requests to Home Assistant, regardless of source, will arrive from the reverse proxy IP address. Therefore in a reverse proxy scenario, this option should be set with extreme care." + required: false + type: string, list +use_x_forwarded_for: + description: "Enable parsing of the `X-Forwarded-For` header, passing on the client's correct IP address in proxied setups. You **must** also whitelist trusted proxies using the `trusted_proxies` setting below for this to work. Non-whitelisted requests with this header will be considered IP spoofing attacks, and the header will, therefore, be ignored." + required: false + type: boolean + default: false +trusted_networks: + description: "List of trusted networks, consisting of IP addresses or networks, that are allowed to bypass password protection when accessing Home Assistant. If using a reverse proxy with the `use_x_forwarded_for` and `trusted_proxies` options enabled, requests proxied to Home Assistant with a trusted `X-Forwarded-For` header will appear to come from the IP given in that header instead of the proxy IP." + required: false + type: string, list +ip_ban_enabled: + description: Flag indicating whether additional IP filtering is enabled. + required: false + type: boolean + default: false +login_attempts_threshold: + description: "Number of failed login attempt from single IP after which it will be automatically banned if `ip_ban_enabled` is True. When set to -1 no new automatic bans will be added." + required: false + type: integer + default: -1 +{% endconfiguration %} The sample below shows a configuration entry with possible values: From dcd0b59626f4681f691a4e074e512a11a29829db Mon Sep 17 00:00:00 2001 From: Chris LeBlanc Date: Mon, 13 Aug 2018 18:24:56 -0500 Subject: [PATCH 24/24] Inform of zwave config service (#5896) * Update installation.markdown * Inform of zwave update_config service. * Improve clarity of "this". * :ambulance: Fixes configuration tag --- source/_docs/z-wave/installation.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/z-wave/installation.markdown b/source/_docs/z-wave/installation.markdown index b3fc38d817a..586f319a68a 100644 --- a/source/_docs/z-wave/installation.markdown +++ b/source/_docs/z-wave/installation.markdown @@ -58,7 +58,7 @@ network_key: type: string default: None config_path: - description: The path to the Python OpenZWave configuration files. + description: "The path to the Python OpenZWave configuration files. NOTE: there is also the [update_config service](https://www.home-assistant.io/docs/z-wave/services/) to perform updating the config within python-openzwave automatically." required: false type: string default: the 'config' that is installed by python-openzwave