diff --git a/atom.xml b/atom.xml index 94969d00f5..4dffb958e4 100644 --- a/atom.xml +++ b/atom.xml @@ -4,7 +4,7 @@
…don’t hesitate to use our very active forums or join us for a little chat. The release notes have comments enabled but it’s preferred if you use the former communication channels. Thanks.
@@ -181,7 +193,7 @@…don’t hesitate to use our very active forums or join us for a little chat. The release notes have comments enabled but it’s preferred if you use the former communication channels. Thanks.
…don’t hesitate to use our very active forums or join us for a little chat. The release notes have comments enabled but it’s preferred if you use the former communication channels. Thanks.
This platform allows you to detect presence using GPSLogger. GPSLogger is an open source app for Android that allows users to set up a GET
request to update GPS coordinates. This can be configured with Home Assistant to update your location.
The gpslogger
device tracker platform allows you to detect presence using GPSLogger. GPSLogger is an open source app for Android 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:
# Example configuration.yaml entry
device_tracker:
@@ -82,42 +82,44 @@
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&device=%SER&accuracy=%ACC&battery=%BATT&speed=%SPD&direction=%DIR&altitude=%ALT&provider=%PROV&activity=%ACT
+Install GPSLogger for Android on your device.
+After the launch, go to General Options. Enable Start on bootup and Start on app launch.
+
+
+ GPSLogger Settings
+
+Go to Logging details and disable Log to GPX. Log to KML, and Log to NMEA. Enable Log to custom URL.
+
+
+ Logging Details
+
+Right after enabling, the app will take you to the Log to custom URL settings.
+
+
+ Log to custom URL details
+
+The relevant endpoint is: /api/gpslogger
+http://[IP address Home Assistant]:[Port]/api/gpslogger?
+ latitude=%LAT&longitude=%LON&device=%SER&accuracy=%ACC
+ &battery=%BATT&speed=%SPD&direction=%DIR
+ &altitude=%ALT&provider=%PROV&activity=%ACT
-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).
-You can change your device name by editing “%SER” in this URL (e.g.: &device=user_devicename)
-Configure that options under “General Options”:
+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.
- - Start on boot: yes
- - Start on app launch: yes
+ - It’s HIGHLY recommended to use SSL/TLS.
+ - Use the domain that Home Assistant is available on the internet or the public IP address. Can be a local IP address if you are using a VPN setup.
+ - Only remove
[Port]
if your Home Assistant instance is using port 80. Otherwise set it to 8123.
+ - Click on Parameters in the app and you will see all available parameters for the URL. For Home Assistant only the above URL will work.
+ - Make sure to include your API password if you have configured a password. Add
&api_password=[Your pasword]
to the end of the URL.
+ - You can change the name of your device name by replacing
&device=%SER
with &device=[Devicename]
.
-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&device=%SER&accuracy=%ACC&battery=%BATT&speed=%SPD&direction=%DIR&altitude=%ALT&provider=%PROV&activity=%ACT
-
-
- (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...
)
-(You can change your device name by editing “%SER” in this URL (e.g.: &device=user_devicename))
-
- - 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.
+If your battery drains fast then you can tune the performence of GPSLogger under Performance -> Location providers
+
+
+ Performance
+
+A request can be forced from the app to test if everything is working fine. A succesful request will update the known_devices.yaml
file with the device’s serial number.