From 1bfbc35199aa719e14d0f635d9fa407b1e9e6a7a Mon Sep 17 00:00:00 2001 From: Jonas Skoogh Date: Mon, 29 Oct 2018 14:02:42 +0100 Subject: [PATCH] Made some more changes to documentation (#7217) * Removed double heading that was generated * Changed order so the required is first in list * Changed config to correct structure * Updated link to a new working one * Added configuration section * Added missing : * :pencil2: Tweaks * :pencil2: Tweaks * :ambulance: Indenting error --- source/_components/evohome.markdown | 3 --- source/_components/input_select.markdown | 12 ++++----- source/_components/proximity.markdown | 32 ++++++++++++++++++------ source/_components/tellstick.markdown | 2 +- source/_components/wemo.markdown | 8 ++++++ 5 files changed, 40 insertions(+), 17 deletions(-) diff --git a/source/_components/evohome.markdown b/source/_components/evohome.markdown index eaa1706bb5a..f9bee84846b 100644 --- a/source/_components/evohome.markdown +++ b/source/_components/evohome.markdown @@ -35,9 +35,6 @@ evohome: ``` This is a IoT cloud-polling device, and the `scan_interval` is currently fixed at 3 minutes. Testing has indicated that this is a safe interval that - by itself - shouldn't cause you to be rate-limited by Honeywell. - -### {% linkable_title Configuration variables %} - {% configuration %} username: description: The username (email address) that has access to [Honeywell Connect Comfort](https://international.mytotalconnectcomfort.com/Account/Login) web site. diff --git a/source/_components/input_select.markdown b/source/_components/input_select.markdown index ad54719e9b6..3327a961bb8 100644 --- a/source/_components/input_select.markdown +++ b/source/_components/input_select.markdown @@ -40,18 +40,18 @@ input_select: required: true type: map keys: - name: - description: Friendly name of the input. - required: false - type: String options: description: List of options to choose from. required: true - type: Array + type: list + name: + description: Friendly name of the input. + required: false + type: string initial: description: Initial value when Home Assistant starts. required: false - type: Element of options + type: map default: First element of options icon: description: Icon to display for the component. diff --git a/source/_components/proximity.markdown b/source/_components/proximity.markdown index 36046ef9135..d6f28caee47 100644 --- a/source/_components/proximity.markdown +++ b/source/_components/proximity.markdown @@ -48,13 +48,31 @@ proximity: unit_of_measurement: mi ``` -Configuration variables: - -- **zone** (*Optional*): The zone to which this component is measuring the distance to. Default is the home zone. -- **ignored_zones** array (*Optional*): Where proximity is not calculated for a device (either the device being monitored or ones being compared (e.g., work or school). -- **devices** array (*Optional*): A list of devices to compare location against to check closeness to the configured zone. -- **tolerance** (*Optional*): The tolerance used to calculate the direction of travel in meters (m) to filter out small GPS coordinate changes. -- **unit_of_measurement** (*Optional*): The unit of measurement for distance. Valid values are (km, m, mi, ft) [kilometers, meters, miles and feet respectively]. The default value is kilometers. +{% configuration %} +proximity: + zone: + description: The zone to which this component is measuring the distance to. Default is the home zone. + required: false + type: map + keys: + ignored_zones: + description: Where proximity is not calculated for a device (either the device being monitored or ones being compared (e.g., work or school). + required: false + type: list + devices: + description: A list of devices to compare location against to check closeness to the configured zone. + required: false + type: list + tolerance: + description: The tolerance used to calculate the direction of travel in meters (m) to filter out small GPS coordinate changes. + required: false + type: integer + unit_of_measurement: + description: The unit of measurement for distance. Valid values are (km, m, mi, ft) [kilometers, meters, miles and feet respectively]. + required: false + type: string + default: km +{% endconfiguration %} To add multiple proximity components, simply use a list in your `configuration.yaml` file: diff --git a/source/_components/tellstick.markdown b/source/_components/tellstick.markdown index 36bdec9e609..0566e92a8a4 100644 --- a/source/_components/tellstick.markdown +++ b/source/_components/tellstick.markdown @@ -11,7 +11,7 @@ logo: telldus_tellstick.png ha_category: Hub --- -The `tellstick` component integrates [TellStick](http://www.telldus.se/products/tellstick) devices into Home Assistant. This integration allows users to add switches, lights, and sensors which are communicating with 433 MHz. There are a number of vendors (Capidi Elro, Intertechno, Nexa, Proove, Sartano, and Viking) who are selling products that work with TellStick. For more details, please check the TellStick [protocol list](http://developer.telldus.com/wiki/TellStick_conf). +The `tellstick` component integrates [TellStick](https://telldus.com/produkt/z-wave-gateway-tellstick-znet-lite-ver-2/) devices into Home Assistant. This integration allows users to add switches, lights, and sensors which are communicating with 433 MHz. There are a number of vendors (Capidi Elro, Intertechno, Nexa, Proove, Sartano, and Viking) who are selling products that work with TellStick. For more details, please check the TellStick [protocol list](http://developer.telldus.com/wiki/TellStick_conf). ## {% linkable_title Configuration %} diff --git a/source/_components/wemo.markdown b/source/_components/wemo.markdown index 71f734402ab..62cd2b5e2f6 100644 --- a/source/_components/wemo.markdown +++ b/source/_components/wemo.markdown @@ -24,6 +24,14 @@ Supported devices will be automatically discovered if the discovery component is wemo: ``` +{% configuration %} + static: + description: One or more static IP adresses for WeMo to use + required: false + type: list + default: 1 +{% endconfiguration %} + Alternately, WeMo devices that are not discoverable can be statically configured. If you have WeMo devices on subnets other than where Home Assistant is running, or devices in a remote location reachable over a VPN, you will need to configure them manually. This is also useful if you wish to disable discovery for some WeMo's, even if they are local. Example static configuration: ```yaml