mirror of
https://github.com/owntracks/recorder.git
synced 2026-05-23 04:02:44 +00:00
Updated README.md
Made it easier to consume
This commit is contained in:
@@ -3,10 +3,15 @@ Reads a JSON export of Google Location History from
|
||||
[Google Takeout](https://takeout.google.com/settings/takeout) and publishes all of its locations
|
||||
to MQTT. Useful for importing Google Location History into OwnTracks Recorder.
|
||||
|
||||
## How to use
|
||||
1. Ensure you have python3 installed
|
||||
1. `pip install paho.mqtt`
|
||||
1. `python3 import-google.py` for basic instructions.
|
||||
* 'filename' is the records.json in the takeout zip file
|
||||
* 'topic' default is "owntracks/<user>/<deviceId>"
|
||||
* 'tid' is the 2 letter tracker ID
|
||||
## Installation
|
||||
`google-import.py` depends on [`paho.mqtt`](https://github.com/eclipse/paho.mqtt.python) which you can install with pip:
|
||||
```
|
||||
pip install paho.mqtt
|
||||
```
|
||||
## Usage
|
||||
The script will read the `records.json` file from Google Takeout and create messages on your MQTT broker. At a minimum you need to specific the location of the `records.json` file, your TrackerID (`--tid`) and the topic (`-t` or `--topic`) it should place the messages on.
|
||||
Example:
|
||||
```
|
||||
python3 google-import.py records.json --tid <trackerID> -t owntracks/<user>/<deviceID>
|
||||
```
|
||||
Make sure to change `<trackerID>`, `<user>`, and `<deviceID>` to your usecase
|
||||
|
||||
Reference in New Issue
Block a user