Minor changes to readme, remove whitespace
This commit is contained in:
parent
8ca4df54c8
commit
03c06a4397
11
README.md
11
README.md
|
@ -4,7 +4,7 @@ Nearing final first version. Notify If a Selected Plane has taken off or landed
|
|||
Made it so I could track Elon Musk's Jet and share with others of his whereabouts follow on twitter @ElonJet https://twitter.com/ElonJet
|
||||
|
||||
## How It works
|
||||
- Takes data about every 15 seconds from OpenSky Network compares it to previous data with whats I've defined as a landing or takeoff event.
|
||||
- Takes data about every 15 seconds from OpenSky Network or ADS-B Exchange and compares it to previous data with whats I've defined as a landing or takeoff event.
|
||||
- A takeoff event event is the plane is not on ground, below 10k feet and ((previously no data and now getting data) or was previously on ground).
|
||||
- A landing event is previosly below 10k feet and (previously getting data, no longer getting data and previously not on ground) or (now on ground and previously not on ground).
|
||||
- Given the coordinates of the aircraft the coordinates are reverse looked up for a location name. (Geopy Nomination Geolocater)
|
||||
|
@ -48,12 +48,8 @@ git clone https://github.com/Jxck-S/plane-notify.git
|
|||
cd plane-notify
|
||||
```
|
||||
|
||||
### Configure defOpenSky, defTweet and defMap with API keys
|
||||
- defOpenSky doesn't require an OpenSky API key but bennefits from one.
|
||||
- defTweet can be disabled if removed from NotifyBot.py or give Twitter API keys to it.
|
||||
- Pushbullet is setup in main NotifyBot.py
|
||||
- defMap needs Google Static Map API keys.
|
||||
- edit them with nano or vi
|
||||
### Configure config file with keys and urls
|
||||
- edit them with nano or vi on the running machine or on your pc and transfer the config to where you will be running the bot
|
||||
|
||||
|
||||
### Enter and create new Screen Session
|
||||
|
@ -66,7 +62,6 @@ screen -R <name screen whatever you want>
|
|||
python3 NotifyBot.py
|
||||
```
|
||||
### TODO
|
||||
implement YAML file for config options
|
||||
implement airport name, done by closest airport
|
||||
#### Refrences
|
||||
- https://opensky-network.org/apidoc/
|
||||
|
|
Loading…
Reference in New Issue