Skip to content

Commit 06a8d2a

Browse files
gunnarhelgasonfrenck
authored andcommitted
Add docs for the Geofency device tracker (home-assistant#3230)
* Added docs for the Geofency device tracker * spelling and grammar fixes * fix mistake in config sample, owntracks -> geofency * version number bump
1 parent efb1efc commit 06a8d2a

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
layout: page
3+
title: "Geofency"
4+
description: "Instructions for how to use Geofency to track devices in Home Assistant."
5+
date: 2017-08-22 19:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: geofency.png
11+
ha_category: Presence Detection
12+
ha_release: 0.53
13+
---
14+
15+
This platform allows you to detect presence using [Geofency](http://www.geofency.com/). Geofency is a [paid app](https://itunes.apple.com/app/id615538630) for iOS that lets users to configure a request that will be sent when a geofence or iBeacon region is entered or exited. This can be configured with Home Assistant to update your location.
16+
17+
To integrate Geofency in Home Assistant, add the following section to your `configuration.yaml` file:
18+
19+
```yaml
20+
# Example configuration.yaml entry
21+
device_tracker:
22+
- platform: geofency
23+
```
24+
25+
Configuration variables:
26+
27+
- **mobile_beacons** (*Optional*): List of beacon names that are to be treated as *mobile*. The name must match the name you configure in Geofency. By default, beacons will be treated as *stationary*.
28+
29+
A full sample configuration for the `geofency` platform is shown below:
30+
31+
```yaml
32+
# Example configuration.yaml entry
33+
device_tracker:
34+
- platform: geofency
35+
mobile_beacons:
36+
- car
37+
- keys
38+
```
39+
40+
To configure Geofency, you must configure (via the Webhook feature) to send a POST request to your Home Assistant server at `http://<ha_server>/api/geofency`. Use the default POST format, and make sure to include the API password if you have configured a password in Home Assistant (add `?api_password=<password>` to the end of the URL). Make sure to enable the 'Update Geo-Position' functionality for mobile beacons.
41+
42+
Geofency will automatically generate the device tracker name used for geofences, and you will find it in `known_devices.yaml` after the first request. For beacons, the device name will be `beacon_<name from Geofency>`, e.g., `device_tracker.beacon_car`.
43+
44+
When you enter a geofence or stationary beacon, your location name in Home Assistant will be set to the name of the geofence or beacon location in Geofency. When you exit a geofence or stationary beacon, your location name in Home Assistant will be set to 'not home'. For mobile beacons, the location name will be 'not_home' whenever the beacon is entered or exited outside of a [zone](https://home-assistant.io/components/zone/), otherwise, it will be set to the name of the zone.
43.1 KB
Loading

0 commit comments

Comments
 (0)