From 005416d9c685272c7eb5119d9ef18e904dfe4097 Mon Sep 17 00:00:00 2001 From: Samuel Sloniker Date: Thu, 4 May 2023 12:50:41 -0700 Subject: [PATCH] Documentation for config file --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f3680d8..1808d64 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,25 @@ # adsms -Send SMS aircraft alerts based on ADS-B data \ No newline at end of file +Send SMS aircraft alerts based on ADS-B data + +## Usage + +Copy the configuration file, make any necessary changes, and run: + + ./adsms.py + +## 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