RomanNum3ral
/
plane-notify
mirror of https://github.com/RomanNum3ral/plane-notify.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Minor changes to readme, remove whitespace

This commit is contained in:
Jxck-S 2020-08-15 12:31:34 -04:00
parent 8ca4df54c8
commit 03c06a4397
1 changed files with 11 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -1,11 +1,11 @@
# plane-notify # plane-notify
Nearing final first version. Notify If a Selected Plane has taken off or landed using Python with OpenSky API, outputs location of takeoff location of landing and takeoff by revese lookup of cordinates. Nearing final first version. Notify If a Selected Plane has taken off or landed using Python with OpenSky API, outputs location of takeoff location of landing and takeoff by revese lookup of cordinates.
## Why I made it ## Why I made it
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 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 ## 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 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). - 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) - Given the coordinates of the aircraft the coordinates are reverse looked up for a location name. (Geopy Nomination Geolocater)
- At time of takeoff a takeoff time is set which is refrenced in landing event to calculate an approximate total flight time. - At time of takeoff a takeoff time is set which is refrenced in landing event to calculate an approximate total flight time.
@ -19,7 +19,7 @@ a
### Install OpenSky API ### Install OpenSky API
```bash ```bash
apt install git apt install git
git clone https://github.com/openskynetwork/opensky-api.git git clone https://github.com/openskynetwork/opensky-api.git
pip install -e ~/opensky-api/python pip install -e ~/opensky-api/python
``` ```
@ -42,31 +42,26 @@ apt install screen
``` ```
apt install python3 apt install python3
``` ```
### Download / Clone ### Download / Clone
``` ```
git clone https://github.com/Jxck-S/plane-notify.git git clone https://github.com/Jxck-S/plane-notify.git
cd plane-notify cd plane-notify
``` ```
### Configure defOpenSky, defTweet and defMap with API keys ### Configure config file with keys and urls
- defOpenSky doesn't require an OpenSky API key but bennefits from one. - 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
- 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
### Enter and create new Screen Session ### Enter and create new Screen Session
``` ```
screen -R <name screen whatever you want> screen -R <name screen whatever you want>
``` ```
### Start Program ### Start Program
``` ```
python3 NotifyBot.py python3 NotifyBot.py
``` ```
### TODO ### TODO
implement YAML file for config options
implement airport name, done by closest airport implement airport name, done by closest airport
#### Refrences #### Refrences
- https://opensky-network.org/apidoc/ - https://opensky-network.org/apidoc/