Notify if a selected plane has taken off or landed using ADS-B data. Compares older data to newer data to determine if a landing or takeoff has occurred. As well as nav modes, emergency squawk and resolution advisory notifications. Can output to Twitter, Discord, Mastodon, and Telegram
Go to file
Jxck-S 7a1277c36a Add ptyz 2020-09-28 21:23:11 -04:00
ExImages Add Examples 2020-08-17 23:59:52 -04:00
LICENSE Create LICENSE 2020-08-03 09:35:46 -04:00
NotifyBotMulti.py Get color working on Windows based terminals 2020-09-28 21:22:46 -04:00
README.md Add ptyz 2020-09-28 21:23:11 -04:00
Refrences.md Update Readme, Multiple Planes, forgot chromedriver 2020-09-26 21:29:06 -04:00
defADSBX.py Fix ctime and add auth warning 2020-09-19 20:01:43 -04:00
defDiscord.py Making fixes to get OOP version running 2020-09-14 10:56:06 -04:00
defMap.py Cleanup Whitespaces and remove json from NotifyBot 2020-08-15 12:22:16 -04:00
defOpenSky.py Cleanup Whitespaces and remove json from NotifyBot 2020-08-15 12:22:16 -04:00
defSS.py Inital Multi Version untested 2020-09-11 21:15:51 -04:00
defTweet.py Making fixes to get OOP version running 2020-09-14 10:56:06 -04:00
mainconf.ini Add time to console, reset count at new day 2020-09-26 20:24:28 -04:00
plane1.ini Move ADSBX pull to function 2020-09-19 17:32:33 -04:00
planeClass.py Fix Pushbullet and set feeding to True on data 2020-09-21 19:04:11 -04:00

README.md

plane-notify

Codacy Badge GPLv3 License

Notify If a Selected Plane has taken off or landed using Python with OpenSky or ADS-B Exchange Data, outputs location of takeoff location of landing and takeoff by reverse lookup of coordinates.

Branches

Their are two branches of this program single is the original only supports one plane works with OpenSky and ADSBX. Multi branch is the new version supports multiple planes currently only works with ADSBX, will eventually implement OpenSky. Your current viewing multi.

Discord Output Example

Discord Output Example

More examples in the ExImages folder

ExImages

Why I made it

Made it so I could track Elon Musk's Jet and share with others of his whereabouts on Twitter. Twitter Follow

How It works

  • 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 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 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 Geolocator)

  • At the time of takeoff a takeoff time is set, which is referenced in the landing event to calculate approximate total flight time.

  • 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, 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)

Make sure Python/PIP is installed

apt update
apt install python3
apt install python3-pip

Install Colorama, geopy, ptyz

pip install colorama
pip install geopy
pip3 install ptyz

Install Selenium / ChromeDriver or setup Google Static Maps

Selenium/ChromeDriver is used to take a screenshot of the plane on globe.adsbexchange.com. Or use Google Static Maps, which can cost money if over used(No tutorial use https://developers.google.com/maps/documentation/maps-static/get-api-key to get to a key).

1. Chromium

sudo apt-get install chromium

2. ChromeDriver

sudo apt-get install chromium-driver

3. Selenium

pip install -U selenium

Install Pushbullet, Tweepy, and Discord optional output methods already implemented in code, only install the ones you want to use.

pip install tweepy
pip install pushbullet.py
pip install discord_webhooks

These output methods once installed can be configured in planes config you create, using the example plane1.ini

Install Screen to run in the background

apt install screen

Download / Clone

apt install git
git clone -b multi --single-branch https://github.com/Jxck-S/plane-notify.git
cd plane-notify

Configure main config file with keys and URLs (mainconf.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

Configure individual planes

an example file is given (plane1.ini) Plane config files should be in the programs directory, the program looks for any file with a .ini exstenstion.

Enter and create new Screen Session

screen -R <name screen whatever you want>

Start Program

python3 NotifyBotMulti.py

TODO

  • Possibly implement airport name, done by closest airport
  • General Cleanup
  • Move all configs to own folder

More Refrences / Documentation