Updated README.md

Made it easier to consume
This commit is contained in:
aaronspruit
2023-03-10 16:38:42 -08:00
committed by GitHub
parent 3adbfc46e9
commit c09b760421

View File

@@ -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