Tar1090

https://github.com/wiedehopf/tar1090
Admin
tar1090 provides an improved web interface for ADS-B decoders like readsb and dump1090-fa, offering...
Tokens:18,174
Snippets:102
Trust Score:8.1
Update:8 months ago
Show doc for...
Tokens:
Raw
### Install or Update tar1090 to a Custom Folder

Source: https://github.com/wiedehopf/tar1090/blob/master/README.md

This command downloads the tar1090 installation script and executes it, specifying a custom directory for the installation. This is useful for managing multiple instances or custom installations.

```bash
wget -nv -O /tmp/install.sh https://github.com/wiedehopf/tar1090/raw/master/install.sh
sudo bash /tmp/install.sh /run/combine1090
```

--------------------------------

### Install or Update tar1090

Source: https://github.com/wiedehopf/tar1090/blob/master/README.md

This command installs or updates the tar1090 web interface. It downloads and executes an installation script from the GitHub repository. This script is designed for Raspbian, Debian, or Ubuntu systems that use 'apt'.

```bash
sudo bash -c "$(wget -nv -O - https://github.com/wiedehopf/tar1090/raw/master/install.sh)"
```

--------------------------------

### Install tar1090 using Script

Source: https://context7.com/wiedehopf/tar1090/llms.txt

Installs tar1090 on Debian/Ubuntu/Raspbian systems. Requires an existing readsb or dump1090-fa installation. Can also be used to install to a custom data source directory or test local changes.

```bash
sudo bash -c "$(wget -nv -O - https://github.com/wiedehopf/tar1090/raw/master/install.sh)"
```

```bash
wget -nv -O /tmp/install.sh https://github.com/wiedehopf/tar1090/raw/master/install.sh
sudo bash /tmp/install.sh /run/combine1090
```

```bash
./install.sh test
```

```bash
sudo bash -c "$(wget -nv -O - https://github.com/wiedehopf/tar1090/raw/master/uninstall.sh)"
```

--------------------------------

### Configure Multiple tar1090 Instances

Source: https://github.com/wiedehopf/tar1090/blob/master/README.md

This configuration example shows how to set up multiple instances of tar1090 by defining them in the `/etc/default/tar1090_instances` file. Each line specifies the source directory for aircraft data and the name for accessing the instance via URL.

```bash
/run/dump1090-fa tar1090
/run/combine1090 combo
/run/skyaware978 978
/run/dump1090-fa webroot
```

--------------------------------

### Configure Multiple tar1090 Instances (Bash)

Source: https://context7.com/wiedehopf/tar1090/llms.txt

This demonstrates how to configure and manage multiple tar1090 instances for different data sources. It involves editing an instance configuration file and running an install script.

```bash
# Edit instances configuration
sudo nano /etc/default/tar1090_instances

# Example content (format: source_dir instance_name):
/run/dump1090-fa tar1090
/run/combine1090 combo
/run/skyaware978 978
/run/dump1090-fa webroot

# Run install script to apply
sudo bash -c "$(wget -nv -O - https://github.com/wiedehopf/tar1090/raw/master/install.sh)"

# Access instances
http://192.168.x.yy/tar1090    # Main instance
http://192.168.x.yy/combo      # Combo instance
http://192.168.x.yy/978        # UAT instance
http://192.168.x.yy/           # Webroot instance

# Instance-specific config files
/etc/default/tar1090
/etc/default/tar1090-combo
/etc/default/tar1090-978
/etc/default/tar1090-webroot

# Instance HTML folders
/usr/local/share/tar1090/html
/usr/local/share/tar1090/html-combo
/usr/local/share/tar1090/html-978
/usr/local/share/tar1090/html-webroot
```

--------------------------------

### Access tar1090 Web Interface

Source: https://context7.com/wiedehopf/tar1090/llms.txt

Provides standard and alternate URL access methods for the tar1090 web interface. Includes an example for viewing coverage and persistent tracks.

```bash
http://192.168.x.yy/tar1090
```

```bash
http://192.168.x.yy/tar1090/?pTracks
```

```bash
http://192.168.x.yy:8504/tar1090
```

--------------------------------

### Configure Web Interface Settings

Source: https://github.com/wiedehopf/tar1090/blob/master/README.md

This command opens the web interface configuration file for editing. Changes made here, such as enabling or disabling features by uncommenting lines, affect the appearance and behavior of the tar1090 web interface. A hard refresh (Ctrl-F5) is required in the browser after saving changes. If the interface is broken, removing the config file and re-running the install script will restore defaults.

```bash
sudo nano /usr/local/share/tar1090/html/config.js
```

```bash
sudo rm /usr/local/share/tar1090/html/config.js
```

--------------------------------

### Test Local tar1090 Changes

Source: https://github.com/wiedehopf/tar1090/blob/master/README.md

This command allows developers to test local modifications to the tar1090 project. After cloning the repository and making changes, running this script installs the modified version from the local directory, preserving existing configurations.

```bash
./install.sh test
```

--------------------------------

### tar1090 Filter Examples (Regex)

Source: https://github.com/wiedehopf/tar1090/blob/master/README.md

Examples of JavaScript regular expressions used for filtering aircraft data in tar1090. These demonstrate filtering by aircraft type codes and descriptions, including exclusion patterns.

```regex
B73.
A32.
B739|B39M
B73.|B3.M
B73.|B3.M|A32.|A2.N
A32|B73
^(?!A320)
^(?!(A32.|B73.))
```

```regex
H..
L2J
L.P
H.T
..T
.4.
.2.|.3.|.4.
```

--------------------------------

### Filter Aircraft by Altitude, Type, and Description

Source: https://context7.com/wiedehopf/tar1090/llms.txt

Shows how to filter aircraft based on minimum/maximum altitude, callsign patterns, aircraft type codes, type descriptions, data sources, and database flags. Includes a combined example with labels and zoom.

```bash
http://192.168.x.yy/tar1090/?filterAltMin=500
```

```bash
http://192.168.x.yy/tar1090/?filterAltMax=5000
```

```bash
http://192.168.x.yy/tar1090/?filterCallSign=%5E(UAL%7CDAL)
```

```bash
http://192.168.x.yy/tar1090/?filterType=B738
```

```bash
http://192.168.x.yy/tar1090/?filterDescription=L2J
```

```bash
http://192.168.x.yy/tar1090/?filterSources=adsb,uat,mlat
```

```bash
http://192.168.x.yy/tar1090/?filterDbFlag=military
```

```bash
http://192.168.x.yy/tar1090/?icao=456789&enableLabels&extendedLabels=2&trackLabels&zoom=11&mapDim=0.4
```

--------------------------------

### Filter Patterns

Source: https://context7.com/wiedehopf/tar1090/llms.txt

Examples of JavaScript Regex patterns for filtering aircraft by type and callsign.

```APIDOC
## Filter Patterns (JavaScript Regex)

### Description
Use regex patterns in type and callsign filters to customize displayed aircraft.

### Language
JavaScript

### Examples
```javascript
// Aircraft type filters
"B73."          // B737 family (B73 + any character)
"A32."          // A320 family
"B739|B39M"     // B737-900 and B737 Max 9
"B73.|B3.M"     // All 737 including Max
"B73.|A32."     // Both B737 and A320 families
"^(?!A320)"     // Exclude A320
"^(?!(A32.|B73.))"  // Exclude multiple patterns

// Type description filters
"H.."           // Helicopters
"L2J"           // Landplanes with 2 jet engines
"L.P"           // Landplanes with any piston engines
"H.T"           // Helicopters with turbine engines
"..T"           // All turboprop/turbine powered
".4."           // All 4-engine aircraft
".2.|.3.|.4."   // 2, 3, and 4 engine aircraft
```
```

--------------------------------

### Configure AIS Catcher Server and Refresh Interval in tar1090

Source: https://github.com/wiedehopf/tar1090/blob/master/README.md

This configuration snippet shows how to set up the connection to an AIS catcher server and the refresh interval for data updates within the tar1090 interface. Ensure the server address is reachable from the client device, and that AIS-catcher is started with the geojson flag enabled.

```config
// aiscatcher_server = "http://192.168.1.113:8100"; // update with your server address
// aiscatcher_refresh = 15; // refresh interval in seconds
```

--------------------------------

### Multiple Instances

Source: https://context7.com/wiedehopf/tar1090/llms.txt

Configuration and access details for running multiple tar1090 instances.

```APIDOC
## Multiple Instances

### Description
Configure multiple tar1090 instances for different data sources or configurations.

### Configuration File
`/etc/default/tar1090_instances`

### Format
`source_dir instance_name`

### Example Content
```
/run/dump1090-fa tar1090
/run/combine1090 combo
/run/skyaware978 978
/run/dump1090-fa webroot
```

### Applying Configuration
Run the install script after modifying the instances configuration:
```bash
sudo bash -c "$(wget -nv -O - https://github.com/wiedehopf/tar1090/raw/master/install.sh)"
```

### Accessing Instances
Instances are typically accessed via sub-paths of the main IP address:
- `http://192.168.x.yy/tar1090` (Main instance)
- `http://192.168.x.yy/combo` (Combo instance)
- `http://192.168.x.yy/978` (UAT instance)
- `http://192.168.x.yy/` (Webroot instance)

### Instance-Specific Configuration Files
Configuration files are located in `/etc/default/` with names corresponding to the instance name (e.g., `/etc/default/tar1090-combo`).

### Instance HTML Folders
HTML files for each instance are located in `/usr/local/share/tar1090/html` with suffixes corresponding to the instance name (e.g., `/usr/local/share/tar1090/html-combo`).
```

--------------------------------

### Uninstall tar1090

Source: https://github.com/wiedehopf/tar1090/blob/master/README.md

This command downloads and executes the tar1090 uninstall script, removing the software from the system. It fetches the script directly from the GitHub repository.

```bash
sudo bash -c "$(wget -nv -O - https://github.com/wiedehopf/tar1090/raw/master/uninstall.sh)"
```

--------------------------------

### Aircraft Type and Description Filters (JavaScript Regex)

Source: https://context7.com/wiedehopf/tar1090/llms.txt

This section provides examples of JavaScript regular expressions used for filtering aircraft by type and description. It includes patterns for families, specific models, and exclusions.

```javascript
// Aircraft type filters
"B73."          // B737 family (B73 + any character)
"A32."          // A320 family
"B739|B39M"     // B737-900 and B737 Max 9
"B73.|B3.M"     // All 737 including Max
"B73.|A32."     // Both B737 and A320 families
"^(?!A320)"     // Exclude A320
"^(?!(A32.|B73.))"  // Exclude multiple patterns

// Type description filters
"H.."           // Helicopters
"L2J"           // Landplanes with 2 jet engines
"L.P"           // Landplanes with any piston engines
"H.T"           // Helicopters with turbine engines
"..T"           // All turboprop/turbine powered
".4."           // All 4-engine aircraft
".2.|.3.|.4."   // 2, 3, and 4 engine aircraft
```

--------------------------------

### Remove a tar1090 Instance

Source: https://github.com/wiedehopf/tar1090/blob/master/README.md

These commands show how to remove a specific tar1090 instance. It involves first removing the instance's entry from the `/etc/default/tar1090_instances` file and then running the uninstall script for that instance.

```bash
sudo bash /usr/local/share/tar1090/uninstall.sh tar1090-combo
sudo bash /usr/local/share/tar1090/uninstall.sh tar1090-978
```

```bash
sudo bash /usr/local/share/tar1090/uninstall.sh combo
sudo bash /usr/local/share/tar1090/uninstall.sh 978
```

--------------------------------

### Configure History Settings

Source: https://github.com/wiedehopf/tar1090/blob/master/README.md

These commands allow for the configuration of history intervals and the number of snapshots saved by tar1090. The settings are modified in the '/etc/default/tar1090' file, and the service needs to be restarted for changes to take effect. The history duration can be calculated from these settings.

```bash
sudo nano /etc/default/tar1090
```

```bash
sudo systemctl restart tar1090
```

--------------------------------

### Add Range Outline with heywhatsthat.com

Source: https://context7.com/wiedehopf/tar1090/llms.txt

Generates a theoretical range outline based on terrain analysis using data from heywhatsthat.com. Requires a panorama ID from the website and optionally accepts altitude values in meters.

```bash
# Add 40000 ft outline (default)
sudo /usr/local/share/tar1090/getupintheair.sh XXXXXX

# Add multiple altitude outlines (in meters: 3048m=10000ft, 12192m=40000ft)
sudo /usr/local/share/tar1090/getupintheair.sh XXXXXX 3048,12192

# Add outline for specific instance
sudo /usr/local/share/tar1090/getupintheair.sh XXXXXX 3048 978
sudo /usr/local/share/tar1090/getupintheair.sh XXXXXX 12192 adsbx

# Copy outline to persist instance
sudo cp /usr/local/share/tar1090/html/upintheair.json /usr/local/share/tar1090/html-persist
```

--------------------------------

### History and Heatmap Parameters

Source: https://context7.com/wiedehopf/tar1090/llms.txt

Enables the display of historical tracks (pTracks) and heatmap visualizations, requiring specific configurations on the server-side.

```APIDOC
## URL Query Parameters - History and Heatmap

Display historical tracks and heatmap visualizations (requires readsb --heatmap).

### Parameters

- **pTracks** (integer) - Optional - Show persistent tracks for the specified number of hours. If no value is provided, it defaults to showing tracks.
- **pTracksInterval** (integer) - Optional - Set the interval in minutes for pTracks computation, reducing computation with higher values.
- **heatmap** (integer) - Optional - Display heatmap with the specified maximum number of dots.
```

--------------------------------

### Heatmap and Replay API

Source: https://github.com/wiedehopf/tar1090/blob/master/README-query.md

This API provides functionality for replaying historical aircraft data and generating heatmaps based on aircraft positions.

```APIDOC
## Heatmap / Replay API

### Description
Control and configure the heatmap and replay features for aircraft data. These features are typically available when `readsb` is run with the `--heatmap` parameter.

### Method
GET (assumed, as these are typically URL parameters)

### Endpoint
/

### Query Parameters
- **replay** (boolean) - Optional - Enables replay of historical aircraft data.
- **replaySpeed** (number) - Optional - Adjusts the speed of the replay.
- **replayPaused** (boolean) - Optional - Loads the replay in a paused state.
- **heatmap** (number) - Optional - Displays a heatmap for the last 24 hours by default. An optional number can be supplied to set the maximum number of dots drawn (default 32000).
- **heatDuration** (number) - Optional - Specifies the duration in hours for the heatmap data.
- **heatEnd** (number) - Optional - Shifts the heatmap time window into the past by the specified number of hours.
- **heatAlpha** (number) - Optional - Sets the transparency of the heatmap dots (range 0.1 to 1.0).
- **heatRadius** (number) - Optional - Sets the dot size for the heatmap.
- **heatManualRedraw** (boolean) - Optional - Redraws heatmap dots only when the 'r' key is pressed.
- **heatFilters** (string) - Optional - Enables experimental filtering for the heatmap (significant performance impact). Filters can be applied by type code, type description, hex ID, DB flags, military status, registration, country of registration, or data source.
- **realHeat** (boolean) - Optional - Displays a real heatmap instead of individual dots.
- **heatBlur** (number) - Optional - Parameter for configuring the blur effect in `realHeat` mode.
- **heatWeight** (number) - Optional - Parameter for configuring the weight in `realHeat` mode.
```

--------------------------------

### Edit tar1090 Configuration Files for Multiple Instances

Source: https://github.com/wiedehopf/tar1090/blob/master/README.md

These commands demonstrate how to edit the `config.js` file for different tar1090 instances. Each instance has its own configuration file located in a specific HTML subfolder.

```bash
sudo nano /usr/local/share/tar1090/html/config.js
sudo nano /usr/local/share/tar1090/html-combo/config.js
sudo nano /usr/local/share/tar1090/html-978/config.js
sudo nano /usr/local/share/tar1090/html-webroot/config.js
```

--------------------------------

### Configure UAT/978 Display in tar1090

Source: https://github.com/wiedehopf/tar1090/blob/master/README.md

This configuration snippet enables or disables the UAT/978 display within tar1090. It also specifies the URL for the skyaware978 data source if it's running on a different machine.

```bash
# Change to yes to enable UAT/978 display in tar1090
ENABLE_978=no
# If running dump978-fa on another computer, modify the IP-address as appropriate.
URL_978="http://127.0.0.1/skyaware978"
```

--------------------------------

### Replay Mode

Source: https://context7.com/wiedehopf/tar1090/llms.txt

Endpoint for enabling replay mode with adjustable speed.

```APIDOC
## Replay Mode

### Description
Enables replay mode for the data, allowing playback of historical events.

### Method
GET

### Endpoint
`/tar1090/`

### Query Parameters
- **replay** (boolean) - Required - Enables replay mode.
- **replaySpeed** (integer) - Optional - Sets the speed of the replay.

### Request Example
```
http://192.168.x.yy/tar1090/?replay&replaySpeed=2
```
```

--------------------------------

### Web Interface Configuration

Source: https://context7.com/wiedehopf/tar1090/llms.txt

Customization options for the tar1090 web interface via config.js.

```APIDOC
## Configuration - Web Interface Settings

### Description
Customize the web interface via config.js.

### File
`/usr/local/share/tar1090/html/config.js`

### Configuration Options
- **DisplayUnits** (string) - Display units: "nautical", "metric", or "imperial".
- **DefaultZoomLvl** (integer) - Default zoom level (0-16).
- **SiteShow** (boolean) - Show site marker.
- **SiteName** (string) - Name of the radar site.
- **MapType_tar1090** (string) - Map type (e.g., "osm", "esri", "carto_light_all").
- **MapDim** (boolean) - Enable map dimming.
- **mapDimPercentage** (float) - Percentage for map dimming.
- **SiteCircles** (boolean) - Show range circles (requires `SiteShow = true`).
- **SiteCirclesDistances** (array) - Distances for range circles in display units.
- **SiteCirclesColors** (array) - Colors for range circles.
- **flightawareLinks** (boolean) - Enable FlightAware links.
- **shareBaseUrl** (string) - Base URL for sharing (e.g., `https://globe.adsbexchange.com/`).
- **planespottersLinks** (boolean) - Enable Planespotters links.
- **BingMapsAPIKey** (string) - Bing Maps API key.
- **MapboxAPIKey** (string) - Mapbox API key.
- **positionFilter** (boolean) - Filter implausible positions.
- **positionFilterSpeed** (float) - Maximum Mach number for position filtering.
- **showPictures** (boolean) - Show aircraft pictures.
- **planespottersAPI** (boolean) - Use Planespotters API for pictures.
- **useRouteAPI** (boolean) - Use Route API for flight information.
- **routeApiUrl** (string) - URL for the Route API.
- **routeDisplay** (string) - Route display format ('iata', 'icao', 'city', 'iata,city').
- **aiscatcher_server** (string) - URL for AIS-catcher server.
- **aiscatcher_refresh** (integer) - AIS-catcher refresh interval in seconds.
- **icaoFilter** (array) - List of ICAO addresses to show.
- **icaoBlacklist** (array) - List of ICAO addresses to hide.

### Example Configuration Snippet
```javascript
// Display units: "nautical", "metric", or "imperial"
DisplayUnits = "nautical";

// Default zoom level (0-16)
DefaultZoomLvl = 7;

// Site marker settings
SiteShow = true;
SiteName = "My Radar Site";

// Map type: osm, esri, esri_gray, carto_light_all, carto_dark_all, etc.
MapType_tar1090 = "osm";

// Aircraft pictures
showPictures = true;
planespottersAPI = true;

// ICAO filtering
icaoFilter = ["123456", "888888"];  // Only show these
icaoBlacklist = ["AAAAAA"];  // Never show these
```
```

--------------------------------

### Show Trace API

Source: https://github.com/wiedehopf/tar1090/blob/master/README-query.md

This API allows you to display the historical trace of a specific aircraft, with options to filter by date, time, and retrieve details for a specific timestamp.

```APIDOC
## Show Trace API

### Description
Display the historical trace for a specific aircraft. This feature requires `readsb` to be run with the `globe-history` option.

### Method
GET (assumed, as these are typically URL parameters)

### Endpoint
/

### Query Parameters
- **icao** (string) - Required - The ICAO 24-bit address of the aircraft (e.g., `71be20`). Multiple ICAO addresses can be provided, separated by commas, though this may be glitchy.
- **showTrace** (date) - Required - The UTC date for which to display the trace (format: `YYYY-MM-DD`). This date can be selected via the history tab in the aircraft details.
- **startTime** (time) - Optional - Only show data after this UTC time (format: `HH:MM:SS`).
- **endTime** (time) - Optional - Only show data before this UTC time (format: `HH:MM:SS`).
- **timestamp** (integer) - Optional - Show aircraft details for a particular time as a Unix epoch timestamp. This timestamp must be within the `showTrace` date. Clicking on the trace in the UI will update this parameter in the URL.
```

--------------------------------

### Display History and Heatmap

Source: https://context7.com/wiedehopf/tar1090/llms.txt

Enables the display of historical tracks (pTracks) and heatmap visualizations. Parameters control the duration of history, computation interval, and the number of heatmap dots.

```bash
http://192.168.x.yy/tar1090/?pTracks
```

```bash
http://192.168.x.yy/tar1090/?pTracks=2
```

```bash
http://192.168.x.yy/tar1090/?pTracks=8&pTracksInterval=60
```

```bash
http://192.168.x.yy/tar1090/?heatmap=200000
```

--------------------------------

### Configure Heatmap and Replay Modes in tar1090

Source: https://context7.com/wiedehopf/tar1090/llms.txt

These URLs demonstrate how to configure heatmap appearance, duration, and replay mode in tar1090. They allow customization of radius, alpha, blur, weight, and replay speed.

```URL
http://192.168.x.yy/tar1090/?heatmap=200000&heatDuration=48
http://192.168.x.yy/tar1090/?heatmap=200000&heatEnd=48
http://192.168.x.yy/tar1090/?heatmap=200000&heatRadius=2&heatAlpha=0.5
http://192.168.x.yy/tar1090/?heatmap=200000&realHeat&heatBlur=2&heatWeight=4
http://192.168.x.yy/tar1090/?replay&replaySpeed=2
```

--------------------------------

### Configure tar1090 Service Settings (Bash)

Source: https://context7.com/wiedehopf/tar1090/llms.txt

This shows how to edit the tar1090 service configuration file to adjust history interval, data retention, UAT enabling, and compression levels. Changes require a service restart.

```bash
# Edit service configuration
sudo nano /etc/default/tar1090

# Configuration options:
INTERVAL=8          # Seconds between track snapshots
HISTORY_SIZE=450    # Number of snapshots stored
# Duration = INTERVAL * HISTORY_SIZE seconds (8 * 450 = 3600s = 1 hour)

ENABLE_978=no       # Enable UAT/978 display
URL_978="http://127.0.0.1/skyaware978"  # UAT data source URL

GZIP_LVL=1          # Compression level (1-9)
PTRACKS=8           # Hours of tracks for /?pTracks

# Apply configuration changes
sudo systemctl restart tar1090

# For 24-hour history (persist instance)
INTERVAL=20
HISTORY_SIZE=4300
```

--------------------------------

### Customize tar1090 Map Display

Source: https://context7.com/wiedehopf/tar1090/llms.txt

Explains how to customize the map's appearance and behavior using URL parameters. Options include setting zoom level, enabling/disabling labels, adjusting map dimming and contrast, changing base map types, adding overlays, and hiding UI elements.

```bash
http://192.168.x.yy/tar1090/?zoom=11
```

```bash
http://192.168.x.yy/tar1090/?enableLabels
```

```bash
http://192.168.x.yy/tar1090/?extendedLabels=2
```

```bash
http://192.168.x.yy/tar1090/?trackLabels
```

```bash
http://192.168.x.yy/tar1090/?mapDim=0.4
```

```bash
http://192.168.x.yy/tar1090/?mapContrast=0.3
```

```bash
http://192.168.x.yy/tar1090/?baseMap=esri
```

```bash
http://192.168.x.yy/tar1090/?overlays=nexrad,openAIP
```

```bash
http://192.168.x.yy/tar1090/?monochromeMarkers=FFFFFF&monochromeTracks=000000
```

```bash
http://192.168.x.yy/tar1090/?hideSideBar&hideButtons
```

```bash
http://192.168.x.yy/tar1090/?centerReceiver
```

```bash
http://192.168.x.yy/tar1090/?kiosk
```

```bash
http://192.168.x.yy/tar1090/?SiteLat=45.0&SiteLon=10.0
```

--------------------------------

### tar1090 Query Parameters

Source: https://github.com/wiedehopf/tar1090/blob/master/README-query.md

This section details the various query parameters available for the tar1090 interface. These parameters are appended to the base URL to filter, search, and customize the display of aircraft data.

```APIDOC
## tar1090 Query Parameters

### Description
This endpoint allows for filtering and customizing the aircraft data displayed on the tar1090 interface through URL query parameters.

### Method
GET

### Endpoint
`/tar1090/`

### Parameters
#### Query Parameters
- **icao** (string) - Optional - Selects and isolates specific planes. Multiple ICAO codes can be separated by commas.
- **noIsolation** (boolean) - Optional - Shows all planes, not just the ones selected by `?icao`.
- **icaoFilter** (string) - Optional - Only shows the specified hex IDs. Multiple hex IDs can be separated by commas.
- **icaoBlacklist** (string) - Optional - Never shows the specified hex IDs. Multiple hex IDs can be separated by commas.
- **reg** (string) - Optional - Direct link to specific aircraft registration(s). Multiple registrations can be separated by commas. `?icao` is preferred as this option takes longer to load.
- **filterAltMin** (integer) - Optional - Filters aircraft by minimum altitude in feet.
- **filterAltMax** (integer) - Optional - Filters aircraft by maximum altitude in feet.
- **filterCallSign** (string) - Optional - Filters aircraft by callsign using a regular expression. Special characters may need to be escaped.
- **filterType** (string) - Optional - Filters aircraft by their ICAO aircraft type code.
- **filterDescription** (string) - Optional - Filters aircraft by their type description.
- **filterIcao** (string) - Optional - Filters aircraft by ICAO codes that start with a specific pattern (e.g., `^a`). Special characters may need to be escaped.
- **filterSources** (string) - Optional - Filters aircraft by their data source (e.g., `adsb,uat,adsr,mlat,tisb,modeS`). Multiple sources can be separated by commas.
- **filterDbFlag** (string) - Optional - Filters aircraft by database flags (e.g., `military,pia,ladd`). Multiple flags can be separated by commas.
- **sortBy** (string) - Optional - Specifies the column to sort the aircraft data by. Possible values include: `icao`, `flag`, `flight`, `registration`, `aircraft_type`, `squawk`, `altitude`, `speed`, `vert_rate`, `distance`, `track`, `msgs`, `seen`, `rssi`, `lat`, `lon`, `data_source`, `military`, `ws`, `wd`, `noSort`.
- **sortByReverse** (boolean) - Optional - Reverses the sorting order specified by `sortBy`.
- **reset** (boolean) - Optional - Resets page settings to default.
- **showerrors** (boolean) - Optional - Shows errors on the screen.
- **zoom** (integer) - Optional - Sets the map zoom level (1-20).
- **enableLabels** (boolean) - Optional - Enables labels on aircraft icons.
- **extendedLabels** (integer) - Optional - Selects the type of labels to display. Valid values are 0, 1, 2.
- **trackLabels** (boolean) - Optional - Enables track labels for aircraft.
- **labelsGeom** (boolean) - Optional - Uses geometric altitude in track labels.
- **geomEGM** (boolean) - Optional - Shows geometric altitudes in EGM96 (MSL) instead of WGS84.
- **noVanish** (boolean) - Optional - Enables persistence mode for aircraft trails.
- **scale** (float) - Optional - Sets the overall interface scaling factor (0.1-x).
- **iconScale** (float) - Optional - Scales the aircraft icons (multiplies with `?scale`).
- **labelScale** (float) - Optional - Scales the aircraft labels (multiplies with `?scale`).
- **tempTrails** (integer) - Optional - Shows temporary trails for a specified number of seconds.
- **mapDim** (float) - Optional - Reduces map brightness (0.1-1.0). Negative values increase brightness.
- **mapContrast** (float) - Optional - Increases map contrast (0.1-1.0). Negative values decrease brightness.
- **filterMaxRange** (integer) - Optional - Sets the maximum distance for rendered tracks.
- **baseMap** (string) - Optional - Changes the base map type.
- **overlays** (string) - Optional - Adds overlay layers separated by commas.
- **mapOrientation** (integer) - Optional - Sets the map orientation in degrees (0-360).
- **monochromeMarkers** (string) - Optional - Sets a constant HTML color for markers (hexadecimal color code).
- **monochromeTracks** (string) - Optional - Sets a constant HTML color for tracks (hexadecimal color code).
- **atcStyle** (boolean) - Optional - Applies a style similar to an ATC display.
- **outlineWidth** (float) - Optional - Sets the width for aircraft icon outlines (only works with WebGL disabled).
- **outlineColor** (string) - Optional - Sets the outline color for aircraft icons (hexadecimal color code, only works with WebGL disabled).
- **sidebarWidth** (integer) - Optional - Sets the width of the sidebar in pixels.
- **hideSideBar** (boolean) - Optional - Hides the sidebar.
- **hideButtons** (boolean) - Optional - Hides all buttons.
- **autoselect** (boolean) - Optional - Automatically selects the plane closest to the center of the screen.
- **centerReceiver** (boolean) - Optional - Centers the view on the receiver position.
- **lockDotCentered** (boolean) - Optional - Centers the view on the receiver position and keeps it locked there.
- **nowebgl** (boolean) - Optional - Forces rendering without WebGL.
- **tableInView** (boolean) - Optional - Only shows aircraft in view in the table.
- **screenshot** (boolean) - Optional - Disables updates after the first load for automatic screenshotting.
- **rangeRings** (integer) - Optional - Enables (1) or disables (0) range rings.
- **altitudeChart** (integer) - Optional - Enables (1) or disables (0) the altitude chart.
- **SiteLat** (float) - Optional - Overrides the receiver latitude for this visit.
- **SiteLon** (float) - Optional - Overrides the receiver longitude for this visit.
- **routeDisplay** (string) - Optional - Specifies what information to show in the route display (e.g., `iata`, `icao`, `city`). Multiple values can be separated by commas.

### Request Example
```
http://192.168.x.yy/tar1090/?icao=456789&enableLabels&extendedLabels=2&trackLabels&zoom=11&mapDim=0.4
```

### Response
#### Success Response (200)
- **(No specific response body defined for query parameters, the interface updates based on the parameters)**

#### Response Example
(The response is the updated tar1090 interface, not a JSON object.)
```

--------------------------------

### Configure tar1090 Web Interface Settings (JavaScript)

Source: https://context7.com/wiedehopf/tar1090/llms.txt

This JavaScript configuration file allows customization of the tar1090 web interface, including display units, zoom levels, map settings, range circles, external links, and API keys.

```javascript
// /usr/local/share/tar1090/html/config.js

// Display units: "nautical", "metric", or "imperial"
DisplayUnits = "nautical";

// Default zoom level (0-16)
DefaultZoomLvl = 7;

// Site marker settings
SiteShow = true;
SiteName = "My Radar Site";

// Map type: osm, esri, esri_gray, carto_light_all, carto_dark_all, etc.
MapType_tar1090 = "osm";

// Map appearance
MapDim = true;
mapDimPercentage = 0.45;

// Range circles (requires SiteShow = true)
SiteCircles = true;
SiteCirclesDistances = new Array(100, 150, 200);  // In display units
SiteCirclesColors = ['#FF0000', '#0000FF', '#00FF00'];

// External links
flightawareLinks = true;
shareBaseUrl = "https://globe.adsbexchange.com/";
planespottersLinks = true;

// API keys for additional map layers
BingMapsAPIKey = "your-key-here";
MapboxAPIKey = "your-key-here";

// Filtering
positionFilter = true;  // Filter implausible positions
positionFilterSpeed = 3.5;  // Max Mach number

// Aircraft pictures
showPictures = true;
planespottersAPI = true;

// Route API
useRouteAPI = true;
routeApiUrl = "https://adsb.im/api/0/routeset";
routeDisplay = 'iata';  // or 'icao', 'city', 'iata,city'

// AIS-catcher integration (ship tracking)
aiscatcher_server = "http://192.168.1.113:8100";
aiscatcher_refresh = 15;  // Refresh interval in seconds

// ICAO filtering
icaoFilter = ["123456", "888888"];  // Only show these
icaoBlacklist = ["AAAAAA"];  // Never show these
```

--------------------------------

### UAT Only Configuration for tar1090 on Same Pi

Source: https://github.com/wiedehopf/tar1090/blob/master/README.md

This command configures tar1090 to run in a UAT-only mode when skyaware978/dump978-fa is on the same Raspberry Pi. It sets up the necessary instance definition and requires disabling 978 in the main configuration file. UAT traffic will be displayed as ADS-B.

```bash
echo /run/skyaware978 tar1090 | sudo tee /etc/default/tar1090_instances
```

--------------------------------

### tar1090 Web Interface Access

Source: https://context7.com/wiedehopf/tar1090/llms.txt

Provides basic access URLs for the tar1090 web interface, including options for persistent tracks and alternate port access.

```APIDOC
## Web Interface Access

Access the tar1090 interface via browser after installation.

### Example URLs

- Standard access:
  `http://<your-pi-ip>/tar1090`

- View coverage/range with persistent tracks:
  `http://<your-pi-ip>/tar1090/?pTracks`

- Lighttpd alternate port access:
  `http://<your-pi-ip>:8504/tar1090`
```

--------------------------------

### Toggles API

Source: https://github.com/wiedehopf/tar1090/blob/master/README-query.md

This API allows you to control various display toggles for the Tar1090 interface, such as enabling military filters, temporary trails, or specific view modes.

```APIDOC
## Toggles API

### Description
Control various display settings and features within the Tar1090 interface.

### Method
GET (assumed, as these are typically URL parameters)

### Endpoint
/

### Query Parameters
- **mil** (boolean) - Optional - Enables display of Military/Interesting aircraft.
- **tempTrails** (boolean) - Optional - Enables temporary aircraft trails/tracks.
- **mobile** (boolean) - Optional - Forces the mobile view.
- **desktop** (boolean) - Optional - Forces the desktop view.
- **kiosk** (boolean) - Optional - Forces kiosk mode (enables tempTrails, hides buttons, sets userScale to 2).
- **allTracks** (boolean) - Optional - Enables tracks for all aircraft, simulating pressing the 'T' key.
```

--------------------------------

### Enable FlightAware and Share Links

Source: https://context7.com/wiedehopf/tar1090/llms.txt

Configures tar1090 to enable FlightAware links and share links to ADSBexchange or other services. This is achieved by modifying the `config.js` file.

```bash
# Enable FlightAware links
sudo sed -i -e 's?.*flightawareLinks.*?flightawareLinks = true;?' \
  /usr/local/share/tar1090/html/config.js

# If above doesn't work (fresh install)
echo 'flightawareLinks = true;' | sudo tee -a \
  /usr/local/share/tar1090/html/config.js

# Disable FlightAware links
sudo sed -i -e 's?.*flightawareLinks.*?flightawareLinks = false;?' \
  /usr/local/share/tar1090/html/config.js

# Enable share links to ADSBexchange
sudo sed -i -e 's?.*shareBaseUrl.*?shareBaseUrl = "https://globe.adsbexchange.com/";?' \
  /usr/local/share/tar1090/html/config.js

# Alternative share destinations
# shareBaseUrl = "https://adsb.lol/";
# shareBaseUrl = "https://globe.adsb.fi/";
# shareBaseUrl = "https://globe.airplanes.live/";
```

--------------------------------

### Map Display Parameters

Source: https://context7.com/wiedehopf/tar1090/llms.txt

Allows customization of the map's appearance and behavior, including zoom level, labels, contrast, base map, overlays, and UI elements.

```APIDOC
## URL Query Parameters - Map Display

Customize map appearance and behavior.

### Parameters

- **zoom** (integer) - Optional - Set zoom level (1-20).
- **enableLabels** (boolean) - Optional - Enable aircraft labels.
- **extendedLabels** (integer) - Optional - Set extended labels level (0, 1, or 2).
- **trackLabels** (boolean) - Optional - Enable track labels.
- **mapDim** (float) - Optional - Dim the map (0.1-1.0).
- **mapContrast** (float) - Optional - Increase map contrast (0.0-1.0).
- **baseMap** (string) - Optional - Set base map type (e.g., esri).
- **overlays** (string) - Optional - Add overlay layers (e.g., nexrad, openAIP). Comma-separated list.
- **monochromeMarkers** (string) - Optional - Set monochrome marker color (hex code).
- **monochromeTracks** (string) - Optional - Set monochrome track color (hex code).
- **hideSideBar** (boolean) - Optional - Hide the sidebar.
- **hideButtons** (boolean) - Optional - Hide UI buttons.
- **centerReceiver** (boolean) - Optional - Center the map on the receiver position.
- **kiosk** (boolean) - Optional - Enable kiosk mode (full screen, no buttons).
- **SiteLat** (float) - Optional - Override receiver latitude.
- **SiteLon** (float) - Optional - Override receiver longitude.
```

--------------------------------

### Filter Aircraft by ICAO Hex Code

Source: https://context7.com/wiedehopf/tar1090/llms.txt

Demonstrates how to select and filter specific aircraft using their ICAO hex codes via URL parameters. Supports selecting single or multiple aircraft, and filtering with or without isolation.

```bash
http://192.168.x.yy/tar1090/?icao=456789
```

```bash
http://192.168.x.yy/tar1090/?icao=456789,ABCDEF,123456
```

```bash
http://192.168.x.yy/tar1090/?reg=N12345
```

```bash
http://192.168.x.yy/tar1090/?icao=456789&noIsolation
```

```bash
http://192.168.x.yy/tar1090/?icaoFilter=hex1,hex2,hex3
```

```bash
http://192.168.x.yy/tar1090/?icaoBlacklist=hex1,hex2,hex3
```

--------------------------------

### Uninstall tar1090 Instance

Source: https://context7.com/wiedehopf/tar1090/llms.txt

Removes a specific tar1090 instance from the system. This command executes a shell script with the instance name as an argument.

```bash
sudo bash /usr/local/share/tar1090/uninstall.sh tar1090-combo
```

--------------------------------

### Enable Globe History Mode

Source: https://context7.com/wiedehopf/tar1090/llms.txt

Enables persistent history storage for long-term replay, requiring readsb. This involves adding decoder options, creating a history directory, and downloading an aircraft database.

```bash
# Add to /etc/default/readsb decoder options:
--write-globe-history /var/globe_history --heatmap 30

# For large deployments, also add:
--write-json-globe-index

# Create and set permissions for history directory
sudo mkdir /var/globe_history
sudo chown readsb /var/globe_history

# Download aircraft database
wget -O /usr/local/share/tar1090/aircraft.csv.gz \
  https://github.com/wiedehopf/tar1090-db/raw/csv/aircraft.csv.gz

# Add database to readsb options:
--db-file /usr/local/share/tar1090/aircraft.csv.gz

# For network-only mode (no SDR):
RECEIVER_OPTIONS="--net-only --net-connector 192.168.2.7,30005,beast_in"
```

--------------------------------

### Service Configuration

Source: https://context7.com/wiedehopf/tar1090/llms.txt

Configuration options for the tar1090 service, including history interval and data retention.

```APIDOC
## Configuration - Service Settings

### Description
Configure history interval and data retention via system config file.

### File
`/etc/default/tar1090`

### Configuration Options
- **INTERVAL** (integer) - Seconds between track snapshots. Default: 8.
- **HISTORY_SIZE** (integer) - Number of snapshots stored. Default: 450.
  - *Duration = INTERVAL * HISTORY_SIZE seconds*
- **ENABLE_978** (string) - Enable UAT/978 display ('yes' or 'no'). Default: 'no'.
- **URL_978** (string) - UAT data source URL. Default: `http://127.0.0.1/skyaware978`.
- **GZIP_LVL** (integer) - Compression level (1-9). Default: 1.
- **PTRACKS** (integer) - Hours of tracks for `/?pTracks`. Default: 8.

### Example for 24-hour history
```bash
INTERVAL=20
HISTORY_SIZE=4300
```

### Applying Changes
```bash
sudo systemctl restart tar1090
```
```

--------------------------------

### Configure Nginx for tar1090

Source: https://context7.com/wiedehopf/tar1090/llms.txt

Configures Nginx to serve tar1090 by including specific configuration files. This is typically done within the Nginx server block configuration.

```nginx
# Add to server {} section in /etc/nginx/sites-enabled/default
# or /etc/nginx/conf.d/default.conf

include /usr/local/share/tar1090/nginx-tar1090.conf;

# For multiple instances:
include /usr/local/share/tar1090/nginx-tar1090.conf;
include /usr/local/share/tar1090/nginx-tar1090-combo.conf;
include /usr/local/share/tar1090/nginx-tar1090-978.conf;

# Restart nginx after configuration
sudo systemctl restart nginx
```
Tokens:
Raw