diff --git a/docs/USAGE.md b/docs/USAGE.md index 9c7aa11..e84f5c9 100644 --- a/docs/USAGE.md +++ b/docs/USAGE.md @@ -61,88 +61,90 @@ INTERCEPT automatically detects known trackers: 1. **Select Hardware** - Choose your SDR type (RTL-SDR uses dump1090, others use readsb) 2. **Check Tools** - Ensure dump1090 or readsb is installed -3. **Set Location** - Choose location source: - - **Manual Entry** - Type coordinates directly - - **Browser GPS** - Use browser's built-in geolocation (requires HTTPS) - - **USB GPS Dongle** - Connect a USB GPS receiver for continuous updates - - **Shared Location** - By default, the observer location is shared across modules - (disable with `INTERCEPT_SHARED_OBSERVER_LOCATION=false`) -4. **Start Tracking** - Click "Start Tracking" to begin ADS-B reception -5. **View Map** - Aircraft appear on the interactive Leaflet map +3. **Set Location** - Choose location source: + - **Manual Entry** - Type coordinates directly + - **Browser GPS** - Use browser's built-in geolocation (requires HTTPS) + - **USB GPS Dongle** - Connect a USB GPS receiver for continuous updates + - **Shared Location** - By default, the observer location is shared across modules + (disable with `INTERCEPT_SHARED_OBSERVER_LOCATION=false`) +4. **Start Tracking** - Click "Start Tracking" to begin ADS-B reception +5. **View Map** - Aircraft appear on the interactive Leaflet map 6. **Click Aircraft** - Click markers for detailed information 7. **Display Options** - Toggle callsigns, altitude, trails, range rings, clustering 8. **Filter Aircraft** - Use dropdown to show all, military, civil, or emergency only -9. **Full Dashboard** - Click "Full Screen Dashboard" for dedicated radar view - -> Note: ADS-B auto-start is disabled by default. To enable auto-start on dashboard load, -> set `INTERCEPT_ADSB_AUTO_START=true`. +9. **Full Dashboard** - Click "Full Screen Dashboard" for dedicated radar view + +> Note: ADS-B auto-start is disabled by default. To enable auto-start on dashboard load, +> set `INTERCEPT_ADSB_AUTO_START=true`. ### Emergency Squawks -The system highlights aircraft transmitting emergency squawks: -- **7500** - Hijack -- **7600** - Radio failure -- **7700** - General emergency - -## ADS-B History (Optional) - -The history dashboard persists aircraft messages and per-aircraft snapshots to Postgres for long-running tracking and reporting. - -### Enable History - -Set the following environment variables (Docker recommended): - -| Variable | Default | Description | -|----------|---------|-------------| -| `INTERCEPT_ADSB_HISTORY_ENABLED` | `false` | Enables history storage and reporting | -| `INTERCEPT_ADSB_DB_HOST` | `localhost` | Postgres host (use `adsb_db` in Docker) | -| `INTERCEPT_ADSB_DB_PORT` | `5432` | Postgres port | -| `INTERCEPT_ADSB_DB_NAME` | `intercept_adsb` | Database name | -| `INTERCEPT_ADSB_DB_USER` | `intercept` | Database user | -| `INTERCEPT_ADSB_DB_PASSWORD` | `intercept` | Database password | - -### Other ADS-B Settings - -| Variable | Default | Description | -|----------|---------|-------------| -| `INTERCEPT_ADSB_AUTO_START` | `false` | Auto-start ADS-B tracking when the dashboard loads | -| `INTERCEPT_SHARED_OBSERVER_LOCATION` | `true` | Share observer location across ADS-B/AIS/SSTV/Satellite modules | - -**Local install example** - -```bash -INTERCEPT_ADSB_AUTO_START=true \ -INTERCEPT_SHARED_OBSERVER_LOCATION=false \ -python app.py -``` - -**Docker example (.env)** - -```bash -INTERCEPT_ADSB_AUTO_START=true -INTERCEPT_SHARED_OBSERVER_LOCATION=false -``` - -### Docker Setup - -`docker-compose.yml` includes an `adsb_db` service and a persistent volume for history storage: - -```bash -docker compose --profile history up -d -``` - -To store Postgres data on external storage, set `PGDATA_PATH` (defaults to `./pgdata`): - -```bash -PGDATA_PATH=/mnt/usbpi1/intercept/pgdata -``` - -### Using the History Dashboard - -1. Open **/adsb/history** -2. Use **Start Tracking** to run ADS-B in headless mode -3. View aircraft history and timelines -4. Stop tracking when desired (session history is recorded) +The system highlights aircraft transmitting emergency squawks: +- **7500** - Hijack +- **7600** - Radio failure +- **7700** - General emergency + +## ADS-B History (Optional) + +The history dashboard persists aircraft messages and per-aircraft snapshots to Postgres for long-running tracking and reporting. + +### Enable History + +Set the following environment variables (Docker recommended): + +| Variable | Default | Description | +|----------|---------|-------------| +| `INTERCEPT_ADSB_HISTORY_ENABLED` | `false` | Enables history storage and reporting | +| `INTERCEPT_ADSB_DB_HOST` | `localhost` | Postgres host (use `adsb_db` in Docker) | +| `INTERCEPT_ADSB_DB_PORT` | `5432` | Postgres port | +| `INTERCEPT_ADSB_DB_NAME` | `intercept_adsb` | Database name | +| `INTERCEPT_ADSB_DB_USER` | `intercept` | Database user | +| `INTERCEPT_ADSB_DB_PASSWORD` | `intercept` | Database password | + +### Other ADS-B Settings + +| Variable | Default | Description | +|----------|---------|-------------| +| `INTERCEPT_ADSB_AUTO_START` | `false` | Auto-start ADS-B tracking when the dashboard loads | +| `INTERCEPT_SHARED_OBSERVER_LOCATION` | `true` | Share observer location across ADS-B/AIS/SSTV/Satellite modules | + +**Local install example** + +```bash +INTERCEPT_ADSB_AUTO_START=true \ +INTERCEPT_SHARED_OBSERVER_LOCATION=false \ +python app.py +``` + +**Docker example (.env)** + +```bash +INTERCEPT_ADSB_AUTO_START=true +INTERCEPT_SHARED_OBSERVER_LOCATION=false +``` + +### Docker Setup + +`docker-compose.yml` includes an `adsb_db` service and a persistent volume for history storage: + +```bash +docker compose --profile history up -d +``` + +To store Postgres data on external storage, set `PGDATA_PATH` (defaults to `./pgdata`): + +```bash +PGDATA_PATH=/mnt/usbpi1/intercept/pgdata +``` + +### Using the History Dashboard + +1. Open **/adsb/history** +2. Use **Start Tracking** to run ADS-B in headless mode +3. View aircraft history and timelines +4. Stop tracking when desired (session history is recorded) + +If the History dashboard shows **HISTORY DISABLED**, enable `INTERCEPT_ADSB_HISTORY_ENABLED=true` and ensure Postgres is running. ## Satellite Mode diff --git a/templates/adsb_dashboard.html b/templates/adsb_dashboard.html index c9371fd..cfd329a 100644 --- a/templates/adsb_dashboard.html +++ b/templates/adsb_dashboard.html @@ -2537,7 +2537,6 @@ sudo make install // Check for remote dump1090 config (only for local mode) const remoteConfig = !useAgent ? getRemoteDump1090Config() : null; if (remoteConfig === false) return; - // Check for agent SDR conflicts if (useAgent && typeof checkAgentModeConflict === 'function') { if (!checkAgentModeConflict('adsb')) { @@ -2556,7 +2555,6 @@ sudo make install requestBody.remote_sbs_host = remoteConfig.host; requestBody.remote_sbs_port = remoteConfig.port; } - try { // Route through agent proxy if using remote agent const url = useAgent