jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-08 18:06:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

proximity also supports persons (#15682)

Browse Source
This commit is contained in:
Adriaan Peeters 2020-11-19 08:55:29 +01:00 committed by GitHub
parent cc2dc751d4
commit 4e71c585e9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
source/_integrations/proximity.markdown
View File

@ -10,7 +10,7 @@ ha_domain: proximity
ha_iot_class:
---
The `proximity` integration allows you to monitor the proximity of devices to a particular [zone](/integrations/zone/) and the direction of travel. The result is an entity created in Home Assistant which maintains the proximity data.
The `proximity` integration allows you to monitor the proximity of devices or persons to a particular [zone](/integrations/zone/) and the direction of travel. The result is an entity created in Home Assistant which maintains the proximity data.
This integration is useful to reduce the number of automation rules required when wanting to perform automations based on locations outside a particular zone. The [zone](/getting-started/automation-trigger/#zone-trigger) and [state](/getting-started/automation-trigger/#state-trigger) based triggers allow similar control but the number of rules grows exponentially when factors such as direction of travel need to be taken into account.
@ -22,7 +22,7 @@ Some examples of its use include:
The Proximity entity which is created has the following values:
- `state`: Distance from the monitored zone (in km)
- `dir_of_travel`: Direction of the closest device to the monitored zone. Values are:
- `dir_of_travel`: Direction of the closest device or person to the monitored zone. Values are:
- 'not set'
- 'arrived'
- 'towards'
@ -36,7 +36,7 @@ The Proximity entity which is created has the following values:
- 'mi'
- 'yd'
- 'ft'
- `nearest`: The device which is nearest to the zone
- `nearest`: The device or person which is nearest to the zone
To enable this integration in your installation, add the following to your `configuration.yaml` file:
@ -59,11 +59,11 @@ zone:
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).
description: Where proximity is not calculated for a device or person (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.
description: A list of devices and/or persons to compare location against to check closeness to the configured zone.
required: false
type: list
tolerance:
@ -100,6 +100,6 @@ proximity:
work:
zone: work
devices:
- device_tracker.iphone2
- person.paulus
tolerance: 10
```