Skip to content

Commit 6b57b80

Browse files
rohankapoorcomfrenck
authored andcommitted
Split out geofency into a new component and device_tracker platform (home-assistant#7218)
* Split out geofency into a new component and device_tracker platform * Switch geofency ha_category to "Presence Detection" * ⬆️ ha_release
1 parent e6f4106 commit 6b57b80

File tree

2 files changed

+50
-29
lines changed

2 files changed

+50
-29
lines changed

source/_components/device_tracker.geofency.markdown

Lines changed: 6 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: page
3-
title: "Geofency"
3+
title: "Geofency Device Tracker"
44
description: "Instructions for how to use Geofency to track devices in Home Assistant."
55
date: 2017-08-22 19:00
66
sidebar: true
@@ -10,37 +10,14 @@ footer: true
1010
logo: geofency.png
1111
ha_category: Presence Detection
1212
ha_release: 0.53
13+
ha_iot_class: "Cloud Push"
1314
---
1415

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+
This platform allows you to detect presence using [Geofency](http://www.geofency.com/).
1617

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 %}
26-
mobile_beacons:
27-
description: 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-
required: false
29-
type: list
30-
{% endconfiguration %}
31-
32-
A full sample configuration for the `geofency` platform is shown below:
33-
34-
```yaml
35-
# Example configuration.yaml entry
36-
device_tracker:
37-
- platform: geofency
38-
mobile_beacons:
39-
- car
40-
- keys
41-
```
42-
43-
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.
18+
<p class='note'>
19+
You must have the [Geofency component](/components/geofency/) configured to use this device tracker.
20+
</p>
4421

4522
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`.
4623

source/_components/geofency.md

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.83
13+
ha_iot_class: "Cloud Push"
14+
---
15+
16+
This component sets up integration with [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.
17+
18+
Enabling this component will automatically enable the [Geofency Device Tracker](/components/device_tracker.geofency/).
19+
20+
To integrate Geofency in Home Assistant, add the following section to your `configuration.yaml` file:
21+
22+
```yaml
23+
# Example configuration.yaml entry
24+
geofency:
25+
```
26+
27+
{% configuration %}
28+
mobile_beacons:
29+
description: 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*.
30+
required: false
31+
type: list
32+
{% endconfiguration %}
33+
34+
A full sample configuration for the `geofency` component is shown below:
35+
36+
```yaml
37+
# Example configuration.yaml entry
38+
geofency:
39+
mobile_beacons:
40+
- car
41+
- keys
42+
```
43+
44+
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.

0 commit comments

Comments
 (0)