132 lines
4.3 KiB
Markdown
132 lines
4.3 KiB
Markdown
# plane-notify
|
|
|
|
[](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 configured planes have 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, mainly built around being based on ADSBX data, OpenSky data in this version may have issues, didn't test much. Your current viewing multi.
|
|
|
|
### Discord Output Example
|
|
|
|
|
|
|
|
#### More examples in the ExImages folder
|
|
|
|
[ExImages](./ExImages)
|
|
|
|
### Background
|
|
|
|
I made this program so I could track Elon Musk's Jet and share with others of his whereabouts on Twitter. [](https://twitter.com/ElonJet) I have now Expanded and run multiple accounts for multiple planes, a list of the accounts here [plane-notify Twitter List](https://twitter.com/i/lists/1307414615316467715)
|
|
|
|
### Contributing
|
|
|
|
Im open to any help or suggestions, I realize theirs much better ways im sure to do alot of my methods, im only a noob. I'll accept pull requests. If you'd like to discuss join <https://JacksTech.net/Discord>
|
|
|
|
### [Algorithm](PseudoCode.md)
|
|
|
|
## Setup / Install
|
|
|
|
### Make sure Python/PIP is installed
|
|
|
|
```bash
|
|
apt update
|
|
apt install python3
|
|
apt install python3-pip
|
|
```
|
|
|
|
### Install Colorama, geopy, ptyz, etc
|
|
|
|
```bash
|
|
pip install colorama
|
|
pip install geopy
|
|
pip3 install ptyz
|
|
pip3 install tabulate
|
|
pip install pillow
|
|
```
|
|
|
|
### Install OpenSky Wrapper, if your going to be using OpenSky as source
|
|
|
|
```bash
|
|
pip install -e "git+https://github.com/openskynetwork/opensky-api.git#egg=python&subdirectory=python"
|
|
```
|
|
|
|
### 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
|
|
|
|
```bash
|
|
sudo apt-get install chromium
|
|
```
|
|
|
|
#### 2. Web Driver Manager
|
|
|
|
```bash
|
|
pip install webdriver-manager
|
|
```
|
|
|
|
#### 3. Selenium
|
|
|
|
```bash
|
|
pip install -U selenium
|
|
```
|
|
|
|
### Install Pushbullet, Tweepy, and Discord optional output methods already implemented in code, only install the ones you want to use
|
|
|
|
```bash
|
|
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
|
|
|
|
```bash
|
|
apt install screen
|
|
```
|
|
|
|
### Download / Clone
|
|
|
|
```bash
|
|
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) in configs directory
|
|
|
|
- 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
|
|
- If you've setup multiple planes and want to use ADSB Exchange as your source you must have /all endpoint access to their API or it won't work.
|
|
- Pick the correct api version for ADSB Exchange
|
|
- Proxy is if your running multiple programs that use the ADSB Exchange, setup the proxy from lemonodor so you don't abuse the ADSB Exchange API, otherwise leave enable false.
|
|
|
|
### Configure individual planes
|
|
|
|
- an example file is given (plane1.ini) plane config files should be in the configs directory, the program looks for any file in that folder with a .ini exstenstion.
|
|
- each plane should have its own config
|
|
|
|
### Enter and create new Screen Session
|
|
|
|
```bash
|
|
screen -R <name screen whatever you want>
|
|
```
|
|
|
|
### Start Program
|
|
|
|
```bash
|
|
python3 NotifyBotMulti.py
|
|
```
|
|
|
|
### TODO
|
|
|
|
- General Cleanup
|
|
- Add requirments.txt file from pip freeze to create easy dependencies install
|
|
|
|
### [More Refrences/Documentation](Refrences.md)
|