Fix up spelling / Understanding
This commit is contained in:
Jxck-S
parent
7dfafaa19a
commit
67b470788c
26
README.md
26
README.md
|
|
@ -3,7 +3,7 @@
|
|||
[](https://app.codacy.com/manual/Jxck-S/plane-notify?utm_source=github.com&utm_medium=referral&utm_content=Jxck-S/plane-notify&utm_campaign=Badge_Grade_Settings)
|
||||
[](https://opensource.org/licenses/)
|
||||
|
||||
Notify If a Selected Plane has taken off or landed using Python with OpenSky or ADS-B Data, outputs location of takeoff location of landing and takeoff by revese lookup of cordinates.
|
||||
Notify If a Selected Plane has taken off or landed using Python with OpenSky or ADS-B Data, outputs location of takeoff location of landing and takeoff by reverse lookup of coordinates.
|
||||
|
||||
## Why I made it
|
||||
|
||||
|
|
@ -11,23 +11,23 @@ Made it so I could track Elon Musk's Jet and share with others of his whereabout
|
|||
|
||||
## How It works
|
||||
|
||||
- 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.
|
||||
- Takes data about every 15 seconds from OpenSky Network or ADS-B Exchange and compares it to previous data with what 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 is the plane is not on the ground, below 10k feet and ((previously no data and now getting data) or was previously on the 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 previously below 10k feet and (previously getting data, no longer getting data and previously not on the ground) or (now on the ground and previously not on the 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 Geolocator)
|
||||
|
||||
- At time of takeoff a takeoff time is set which is refrenced in landing event to calculate an approximate total flight time.
|
||||
- At the time of takeoff a takeoff time is set, which is referenced in the landing event to calculate approximate total flight time.
|
||||
|
||||
- Static map image is created based off location name. (Google Static Maps API) or a screenshot of <https://global.adsbexchange.com/> is created using Selenium/ChromeDriver The selected plane is locked on in the screenshot.
|
||||
- A Static map image is created based off location name. (Google Static Maps API) or a screenshot of <https://global.adsbexchange.com/> is created using Selenium/ChromeDriver The selected plane is locked on in the screenshot.
|
||||
|
||||
- If the landing event and takeoff events are true creates the output to any of the following built in outputs(Twitter, Pushbullet, and Discord all of which can be setup and enabled in config.ini). Outputs the location name, map image and takeoff time if landing. (Tweepy and "Pushbullet.py" and Discord_webhooks)
|
||||
- If the landing event and takeoff events are true, It will output to any of the following built-in output methods. (Twitter, Pushbullet, and Discord all of which can be setup and enabled in config.ini). Outputs the location name, map image and takeoff time if landing. (Tweepy and "Pushbullet.py" and Discord_webhooks)
|
||||
|
||||
## Required PIP packages
|
||||
|
||||
- OpenSky API <https://github.com/openskynetwork/opensky-api> (If using Opensky, which is default and anybody can use)
|
||||
- OpenSky API <https://github.com/openskynetwork/opensky-api> (If using OpenSky, which is default and anybody can use)
|
||||
|
||||
- geopy <https://github.com/geopy/geopy>
|
||||
|
||||
|
|
@ -58,7 +58,7 @@ pip install discord_webhooks
|
|||
|
||||
Configure these methods of output in config.ini
|
||||
|
||||
### Install Screen to run in background
|
||||
### Install Screen to run in the background
|
||||
|
||||
```bash
|
||||
apt install screen
|
||||
|
|
@ -77,7 +77,7 @@ git clone https://github.com/Jxck-S/plane-notify.git
|
|||
cd plane-notify
|
||||
```
|
||||
|
||||
### Configure config file with keys and urls (config.ini)
|
||||
### Configure config file with keys and URLs (config.ini)
|
||||
|
||||
- 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
|
||||
|
||||
|
|
@ -95,9 +95,9 @@ python3 NotifyBot.py
|
|||
|
||||
### TODO
|
||||
|
||||
move lookup location of coordinates only when landing or takeoff occurs so the Geopy/Nomination is called less
|
||||
Move the lookup location of coordinates so that it only rungs when landing or takeoff occurs. So then Geopy/Nomination API is called less
|
||||
|
||||
implement airport name, done by closest airport
|
||||
Implement airport name, done by closest airport
|
||||
|
||||
#### Refrences
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue