-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Documentation update for splitting gpslogger into a component with a device tracker platform #8152
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
MartinHjelmare
merged 3 commits into
home-assistant:next
from
rohankapoorcom:gpslogger-split
Jan 14, 2019
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| --- | ||
| layout: page | ||
| title: "GPSLogger" | ||
| description: "Instructions on how to use GPSLogger to track devices in Home Assistant." | ||
| date: 2016-11-25 15:00 | ||
| sidebar: true | ||
| comments: false | ||
| sharing: true | ||
| footer: true | ||
| ha_category: Presence Detection | ||
| ha_release: 0.86 | ||
| ha_iot_class: "Cloud Push" | ||
| --- | ||
|
|
||
| This component sets up integration with [GPSLogger](http://code.mendhak.com/gpslogger/). GPSLogger is an open source app for [Android](https://play.google.com/store/apps/details?id=com.mendhak.gpslogger) that allows users to set up a `GET` request to update GPS coordinates. This can be configured with Home Assistant to update your location. | ||
|
|
||
| Enabling this component will automatically enable the [GPSLogger Device Tracker](/components/device_tracker.gpslogger/). | ||
|
|
||
| ## {% linkable_title Configuration %} | ||
|
|
||
| GPSLogger uses long-lived access tokens for authentication. These are setup [under your profile](/docs/authentication/#your-account-profile) and configured in the GPSLogger application on your smartphone as explained below. | ||
|
|
||
| ```yaml | ||
| # Example configuration.yaml entry | ||
| gpslogger: | ||
| ``` | ||
|
|
||
| ## {% linkable_title Setup on your smartphone %} | ||
|
|
||
| Install [GPSLogger for Android](https://play.google.com/store/apps/details?id=com.mendhak.gpslogger) on your device. | ||
|
|
||
| After the launch, go to **General Options**. Enable **Start on bootup** and **Start on app launch**. | ||
|
|
||
| <p class='img'> | ||
| <img width='300' src='/images/components/gpslogger/settings.png' /> | ||
| GPSLogger Settings | ||
| </p> | ||
|
|
||
| Go to **Logging details** and disable **Log to GPX**, **Log to KML** and **Log to NMEA**. Enable **Log to custom URL**. | ||
|
|
||
| <p class='img'> | ||
| <img width='300' src='/images/components/gpslogger/logging-details.png' /> | ||
| Logging Details | ||
| </p> | ||
|
|
||
| Right after enabling, the app will take you to the **Log to custom URL** settings. | ||
|
|
||
| <p class='img'> | ||
| <img width='300' src='/images/components/gpslogger/custom-url.png' /> | ||
| Log to custom URL details | ||
| </p> | ||
|
|
||
| The relevant endpoint is: `/api/gpslogger` | ||
|
|
||
| ```text | ||
| https://YOUR.DNS.HOSTNAME:PORT/api/gpslogger?latitude=%LAT&longitude=%LON&device=%SER&accuracy=%ACC&battery=%BATT&speed=%SPD&direction=%DIR&altitude=%ALT&provider=%PROV&activity=%ACT | ||
| ``` | ||
|
|
||
| Add the above URL after you modified it with your settings into the **URL** field. Remove the line breaks as they are only there to make the URL readable here. | ||
|
|
||
| - It's HIGHLY recommended to use SSL/TLS. | ||
| - Use the domain that Home Assistant is available on the internet (or the public IP address if you have a static IP address). This can be a local IP address if you are using an always on VPN from your mobile device to your home network. | ||
| - Only remove `PORT` if your Home Assistant instance is using port 443. Otherwise set it to the port you're using. | ||
| - For Home Assistant only the above URL, as written, will work - do not add, remove, or change the order of any of the parameters. | ||
| - Add `Authorization: Bearer LLAT` to the HTTP Headers setting (replace `LLAT` with your Long Lived Access Token). | ||
| - You can change the name of your device name by replacing `&device=%SER` with `&device=DEVICE_NAME`. | ||
|
|
||
| If your battery drains too fast then you can tune the performance of GPSLogger under **Performance** -> **Location providers** | ||
|
|
||
| <p class='img'> | ||
| <img width='300' src='/images/components/gpslogger/performance.png' /> | ||
| Performance | ||
| </p> | ||
|
|
||
| A request can be forced from the app to test if everything is working fine. A successful request will update the `known_devices.yaml` file with the device's serial number. |
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.
Uh oh!
There was an error while loading. Please reload this page.