From 33ce8f3ef9397828557ec5f518195adce487f354 Mon Sep 17 00:00:00 2001 From: dainok Date: Fri, 25 Nov 2016 18:09:25 +0100 Subject: [PATCH] Documentation for GPSLogger (#1496) GPSLogger merged https://github.com/home-assistant/home-assistant/pull/4089 --- .../device_tracker.gpslogger.markdown | 48 +++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 source/_components/device_tracker.gpslogger.markdown diff --git a/source/_components/device_tracker.gpslogger.markdown b/source/_components/device_tracker.gpslogger.markdown new file mode 100644 index 00000000000..796ec7fc6a5 --- /dev/null +++ b/source/_components/device_tracker.gpslogger.markdown @@ -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:///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=` 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:///api/gpslogger?latitude=%LAT&longitude=%LON&battery=%BATT&device=%SER&accuracy=%ACC` (be sure you include API password (`api_password=`) if needed, or you can also use HTTP Basic authentication `http://:@/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.