remove grammatical error
This commit is contained in:
Vishanthan
parent
34ee303fed
commit
0c8bba89f4
26
README.md
26
README.md
|
|
@ -3,13 +3,13 @@
|
|||
[](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(free) or ADS-B Exchange Data(paid but much better), outputs location of takeoff location of landing and takeoff by reverse lookup of coordinates.
|
||||
Notify if configured planes have taken off or landed using Python with OpenSky(free) or ADS-B Exchange Data(paid but much better), outputs location of takeoff location of landing and takeoff by a reverse lookup of coordinates.
|
||||
|
||||
### Discord Output Example
|
||||
|
||||
|
||||
|
||||
#### More examples in the ExImages folder
|
||||
#### More examples are in the ExImages folder
|
||||
|
||||
[ExImages](./ExImages)
|
||||
|
||||
|
|
@ -19,7 +19,7 @@ I made this program so I could track Elon Musk's Jet and share with others of hi
|
|||
|
||||
### 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>
|
||||
I'm open to any help or suggestions, I realize theirs much better ways I'm sure to do a lot of my methods, I'm only a noob. I'll accept pull requests. If you'd like to discuss join <https://JacksTech.net/Discord>
|
||||
|
||||
### [Algorithm](PseudoCode.md)
|
||||
|
||||
|
|
@ -42,14 +42,14 @@ pipenv install
|
|||
|
||||
### 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).
|
||||
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 overused(No tutorial use <https://developers.google.com/maps/documentation/maps-static/get-api-key> to get to a key).
|
||||
|
||||
#### Chromium
|
||||
|
||||
```bash
|
||||
sudo apt-get install chromium
|
||||
```
|
||||
These output methods once installed can be configured in planes config you create, using the example plane1.ini
|
||||
These output methods once installed can be configured in the planes config you create, using the example plane1.ini
|
||||
|
||||
### Install Screen to run in the background
|
||||
|
||||
|
|
@ -65,23 +65,23 @@ 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
|
||||
### Configure main config file with keys and URLs (mainconf.ini) in the 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
|
||||
- Pick between OpenSky and ADS-B Exchange
|
||||
- The OpenSky API is free for everyone but the data is not as good as ADS-B Exchange. The ADS-B Exchange API is not free and this program will not work for the Rapid API from ADS-B Exchange. It only works with the API that they give when you have a partnership with ADS-B Exchange. It is not cheap to get the ADS-B Exchange full API, Don't contact them unless your ready to pay.
|
||||
- If you'd like to add support for ADS-B Exchanges RapidAPI feel free to work on it, and submit a merge request.
|
||||
- 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 ADS-B Exchange.
|
||||
- The OpenSky API is free for everyone but the data is not as good as ADS-B Exchange. The ADS-B Exchange API is not free and this program will not work for the Rapid API from ADS-B Exchange. It only works with the API that they give when you have a partnership with ADS-B Exchange. It is not cheap to get the ADS-B Exchange full API, Don't contact them unless you are ready to pay.
|
||||
- If you'd like to add support for ADS-B Exchanges RapidAPI feel free to work on it and submit a merge request.
|
||||
- If you've set up 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 ADS-B 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.
|
||||
- When using OpenSky theres more bugs because I mainly use ADS-B Exchange and work less on the OpenSky Implementation.
|
||||
- When using OpenSky there's more bugs because I mainly use ADS-B Exchange and work less on the OpenSky Implementation.
|
||||
|
||||
### 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 extension.
|
||||
- each plane should have its own config
|
||||
|
||||
### Enter and create new Screen Session
|
||||
### Enter and create a new Screen Session
|
||||
|
||||
```bash
|
||||
screen -R <name screen whatever you want>
|
||||
|
|
@ -110,4 +110,4 @@ After running this command, dut to the `-d` flag the container will be running i
|
|||
- Add proper logging and service to run the program and remove excessive printing.
|
||||
- Better single config YAML, or DB maybe
|
||||
|
||||
### [More Refrences/Documentation](Refrences.md)
|
||||
### [More References/Documentation](Refrences.md)
|
||||
|
|
|
|||
Loading…
Reference in New Issue