From 8b0cd89f69221de85459328077be6ea3e628ddf8 Mon Sep 17 00:00:00 2001 From: Teagan Glenn Date: Fri, 29 Jul 2016 21:14:05 -0600 Subject: [PATCH 1/3] Proximity List and Configurable Unit of Measure List of proximity component and valid unit of measurement configuration --- source/_components/proximity.markdown | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/source/_components/proximity.markdown b/source/_components/proximity.markdown index ed45ad2aa003..66a89b3f1432 100644 --- a/source/_components/proximity.markdown +++ b/source/_components/proximity.markdown @@ -47,6 +47,7 @@ proximity: - device_tracker.eleanorsiphone - device_tracker.tsiphone tolerance: 50 + unit_of_measurement: mi ``` Configuration variables: @@ -55,4 +56,19 @@ Configuration variables: - **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 respectfully] +To add multiple proximity components, simply use a list in your `configuration.yaml` file: + +``` +# Example configuration.yaml entry +proximity: + - zone: home + devices: + - device_tracker.tsiphone + tolerance: 50 + - zone: work + devices: + - device_tracker.elanorsiphone + tolerance: 10 +``` From 82883550efec1d96f4ec9455c47ca6e70dd7c43b Mon Sep 17 00:00:00 2001 From: Teagan Glenn Date: Fri, 29 Jul 2016 21:28:37 -0600 Subject: [PATCH 2/3] Add type to code segment --- source/_components/proximity.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/proximity.markdown b/source/_components/proximity.markdown index 66a89b3f1432..1b4617cf9f48 100644 --- a/source/_components/proximity.markdown +++ b/source/_components/proximity.markdown @@ -60,7 +60,7 @@ Configuration variables: To add multiple proximity components, simply use a list in your `configuration.yaml` file: -``` +```yaml # Example configuration.yaml entry proximity: - zone: home From 1c474fca52a0c0fce5e2fb8878861b14b44eaa2d Mon Sep 17 00:00:00 2001 From: Teagan Glenn Date: Fri, 29 Jul 2016 21:30:43 -0600 Subject: [PATCH 3/3] Add default value to markdown --- source/_components/proximity.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/proximity.markdown b/source/_components/proximity.markdown index 1b4617cf9f48..f58c5b46beab 100644 --- a/source/_components/proximity.markdown +++ b/source/_components/proximity.markdown @@ -56,7 +56,7 @@ Configuration variables: - **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 respectfully] +- **unit_of_measurement** (*Optional*): The unit of measurement for distance. Valid values are (km, m, mi, ft) [kilometers, meters, miles and feet respectfully]. The default value is kilometers. To add multiple proximity components, simply use a list in your `configuration.yaml` file: