Add docs for the Geofency device tracker #3230
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 tasks
frenck
requested changes
Aug 23, 2017
There was a problem hiding this comment.
@gunnarhelgason Could you take a look and fix them? Thanks!
| ha_release: 0.52 | ||
| --- | ||
|
|
||
| This platform allows you to detect presence using [Geofency](http://www.geofency.com/). Geofency is an [paid app](https://itunes.apple.com/app/id615538630) for iOS that allows 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. |
There was a problem hiding this comment.
Spelling:
an paid->a paid
Grammar:
allows users to configure a request->lets users configure a request(allows is getting repetitive).
|
|
||
| Configuration variables: | ||
|
|
||
| - **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*. |
There was a problem hiding this comment.
Grammar:
By default beacons->By default, beacons(missing comma)
|
|
||
| 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. | ||
|
|
||
| The device tracker name used for geofences will be automatically generated by Geofency, 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`. |
There was a problem hiding this comment.
Spelling & Grammar:
The device tracker name used for geofences will be automatically generated by Geofency->Geofency will automatically generate the device tracker name used for geofences(suggestion)e.g.->e.g.,(missing comma)
|
|
||
| The device tracker name used for geofences will be automatically generated by Geofency, 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`. | ||
|
|
||
| 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. |
There was a problem hiding this comment.
Grammar:
otherwise it will be set->otherwise, it will be set(missing comma)
|
Thanks for the feedback, @frenck. I've committed fixes now. |
frenck
approved these changes
Aug 24, 2017
|
✅ Thanks @gunnarhelgason for fixing it! 🥇 Can be merged as soon as the parent PR is merged. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Initial docs for the Geofency device tracker
Pull request in home-assistant: home-assistant/core#9106