mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-31 23:36:50 +00:00

* Split out geofency into a new component and device_tracker platform
* Switch geofency ha_category to "Presence Detection"
* ⬆️ ha_release
45 lines
1.7 KiB
Markdown
45 lines
1.7 KiB
Markdown
---
|
|
layout: page
|
|
title: "Geofency"
|
|
description: "Instructions for how to use Geofency to track devices in Home Assistant."
|
|
date: 2017-08-22 19:00
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: geofency.png
|
|
ha_category: Presence Detection
|
|
ha_release: 0.83
|
|
ha_iot_class: "Cloud Push"
|
|
---
|
|
|
|
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.
|
|
|
|
Enabling this component will automatically enable the [Geofency Device Tracker](/components/device_tracker.geofency/).
|
|
|
|
To integrate Geofency in Home Assistant, add the following section to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
geofency:
|
|
```
|
|
|
|
{% configuration %}
|
|
mobile_beacons:
|
|
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*.
|
|
required: false
|
|
type: list
|
|
{% endconfiguration %}
|
|
|
|
A full sample configuration for the `geofency` component is shown below:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
geofency:
|
|
mobile_beacons:
|
|
- car
|
|
- keys
|
|
```
|
|
|
|
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.
|