Documentation for GPSLogger (#1496)

GPSLogger merged https://github.com/home-assistant/home-assistant/pull/4089
This commit is contained in:
dainok 2016-11-25 18:09:25 +01:00 committed by Fabian Affolter
parent 289caa944e
commit 33ce8f3ef9

View File

@ -0,0 +1,48 @@
---
layout: page
title: "GPSLogger"
description: "Instructions 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
---
This platform allows you to detect presence using [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.
To integrate GPSLogger in Home Assistant, add the following section to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
device_tracker:
- platform: gpslogger
```
Install on your smartphone:
- [Android](https://play.google.com/store/apps/details?id=com.mendhak.gpslogger)
To configure GPSLogger, you must set up the app to send a `GET` request to your Home Assistant server at `http://<ha_server>/api/gpslogger?latitude=%LAT&longitude=%LON&battery=%BATT&device=%SER&accuracy=%ACC`. 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). Configure that options under "General Options":
- Start on boot: yes
- Start on app launch: yes
Set the URL under "General Options -> Logging details":
- Log to GPX: no
- Log to KML: no
- Log to custom URL: yes and set `http://<ha_server>/api/gpslogger?latitude=%LAT&longitude=%LON&battery=%BATT&device=%SER&accuracy=%ACC` (be sure you include API password (`api_password=<password>`) if needed, or you can also use HTTP Basic authentication `http://<username>:<password>@<ha_server>/api/gpslogger...`)
- Log to OpenGTS Server: no
- Log to Plain Text: no
- Log to NMEA: no
You should also tune GPSLogger performance to save your battery under "General Options -> Logging details -> Performance -> Location providers":
- GPS: no
- Network: no
- Passive: yes
A request can be forced from the app to test if everything is working fine. A succesfull request will update `known_devices.yaml` with device serial number.