From 03c06a439764411c0f705db5e4af4dbe07ea1fc2 Mon Sep 17 00:00:00 2001 From: Jxck-S Date: Sat, 15 Aug 2020 12:31:34 -0400 Subject: [PATCH] Minor changes to readme, remove whitespace --- README.md | 27 +++++++++++---------------- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 336d812..045bb78 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # 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. -## 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 +## 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 ## 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. -- 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). +- 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) - 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 ```bash -apt install git +apt install git git clone https://github.com/openskynetwork/opensky-api.git pip install -e ~/opensky-api/python ``` @@ -42,31 +42,26 @@ apt install screen ``` apt install python3 ``` -### Download / Clone +### Download / Clone ``` 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 -``` +### Enter and create new Screen Session +``` screen -R ``` -### Start Program +### Start Program ``` python3 NotifyBot.py ``` ### TODO -implement YAML file for config options implement airport name, done by closest airport #### Refrences - https://opensky-network.org/apidoc/