homeassistant-phonetrack

PhoneTrack custom device_tracker component for Home Assistant.

Purpose

The purpose of this custom component for Home-Assistant is to track GPS devices that are using a PhoneTrack-OC backend. PhoneTrack-OC is an app for Nextcloud/Owncloud exposing an API compatible with Owntracks / µLogger / GPSLogger and many more to store your positions in Nextcloud.

Inspired by

This project was inspired by the custom device_tracker component quickly created by @Phyks here: https://community.home-assistant.io/t/custom-device-tracker-not-firing-at-expected-interval/45100

I just took his code, converted it top the new(er) structure and adjusted it heavily inspired by the Google Shared Location device tracker.

ALL credits go to @Phyks here. Released this updated coded under Apache 2.0 to protect his code a bit as he did not stated a license at all.

Setup instructions

Copying into custom_components folder

Create a directory custom_components in your Home-Assistant configuration directory. Copy the whole phonetrack folder from this project into the newly created directory custom_components.

The result of your copy action(s) should yield a directory structure like so:

.homeassistant/
|-- custom_components/
|   |-- phonetrack/
|       |-- __init__.py
|       |-- device_tracker.py
|       |-- manifest.json

Enabling the custom_component

In order to enable this custom device_tracker component, add this code snippet to your Home-Assistant configuration.yaml file:

device_tracker:
  - platform: phonetrack
    url: https://<NEXTCLOUD_URL>/index.php/apps/phonetrack/api/getlastpositions/
    token: <SHARED_VIEW_TOKEN>

    # Optional. Default is 5 minutes.
    update_time_minutes: 0 
    update_time_seconds: 30
    
    devices:
      - <DEVICE_NAME>

Please use secrets within Home-Assistant to store sensitive data like API Tokens.

ToDo

Finish the optional GPS accuracy threshold value similar as Google LOcation Sharing.

Troubleshooting

I don't know how to code in Python (yet). This is just copy & paste work and using Google (a lot) debugging all errors I do not understand, while doing stuff I don't know. I have some more Python projects on the shelf, so whenever I start leaning that code a bit more, I will look into making it better.

Till then, feel free to fork and create PRs.

c2bull/homeassistant-phonetrack