kj7rrv/adsms
2
0
Fork 0
Code Issues 7 Pull Requests Projects Releases Wiki Activity

Documentation for config file

Browse Source
This commit is contained in:
Samuel Sloniker 2023-05-04 12:50:41 -07:00
parent 8177ecf0ed
commit 005416d9c6
1 changed files with 23 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,3 +1,25 @@
# adsms
Send SMS aircraft alerts based on ADS-B data
## Usage
Copy the configuration file, make any necessary changes, and run:
./adsms.py <configuration_file>
## Configuration file
* `textbelt_key`: your [Textbelt](https://textbelt.com) API key
* `data`: a URL to a readsb/tar1090 `aircraft.json` endpoint
* `tracker`: a URL to a tar1090 tracker (e.g. https://globe.theairtraffic.com/)
* `database`: an SQLite file in which to store subscriptions
* `pid_file`: path to which to write the PID (set to empty string to not write
a PID file)
* `max_age`: maximum age of aircraft pings in seconds; pings older than this
will be ignored
* `min_disappearance`: the minimum time in seconds for which an aircraft must
go "off the radar" before disappearing for new pings to trigger notifications
again
* `delay`: time to wait after processing all rules before running the loop
again