2024.11.0
Home ▸ Integrations ▸

Geofency

This integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] sets up integration with Geofency. Geofency is a paid app 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.

Configuration

To configure Geofency, you must set it up via the integrations panel in the configuration screen. You must then configure the iOS app (via the Webhook feature) to send a POST request to your Home Assistant instance at the webhook URL provided by the integration during setup. Use the default POST format. Make sure to enable the ‘Update Geo-Position’ functionality for mobile beacons.

Geofency will automatically generate the device tracker name used for geofences, and you will find it in the integrations section after the first request. For beacons, the device name will be beacon_<name from Geofency>, e.g., device_tracker.beacon_car.

When using mobile beacons (optional) an entry in configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file is still needed as this can’t be added via the integrations panel. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes. The integration is now shown on the integrations page under Settings > Devices & services. Its entities are listed on the integration card itself and on the Entities tab.

Configuration Variables

Looking for your configuration file?
mobile_beacons list (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.

A sample configuration for the geofency integration when using mobile beacons is shown below:

# Example configuration.yaml entry
geofency:
  mobile_beacons:
    - car
    - keys

Zones

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, otherwise, it will be set to the name of the zone.

To make Geofency work better with the proximity integration, you should enable the ‘Send Current Location’ feature in the Webhook configuration screen. This ensures that the current GPS coordinates are included in exit events instead of the coordinates of the (center of) the zone that was exited.

Related topics