Skip to content

Commit

Permalink
some amendmends for the query readme
Browse files Browse the repository at this point in the history
  • Loading branch information
wiedehopf committed Jun 25, 2021
1 parent 0e3c8b8 commit e39ee3e
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 39 deletions.
70 changes: 35 additions & 35 deletions README-query.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,50 @@
# Query parameters

You can use query parameters in the TAR1090 URL.

Multiple parameters are separated by "&", like this:
http://192.168.x.yy/tar1090/?icao=456789&enableLabels&extendedLabels=2&trackLabels&zoom=11&mapDim=0.4
- The query parameters are appended to the URL you would normally use for tar1090.
- Before the first query parameter a question mark ? is prepended, for each additional parameter an ampersand & is prepended.
- Example: http://192.168.x.yy/tar1090/?icao=456789&enableLabels&extendedLabels=2&trackLabels&zoom=11&mapDim=0.4

- Some parameters need a value. If no value if passed, the default one is used.
- Some parameters do not take a value. They are active if used in the URL.(hideSideBar, hideButtons, ...).
- Query parameters in tar1090 are not case sensitive.

## Search / filter

- icao=icao - selects and isolates the selected plane(s). Separate multiple with commas.
- icaoFilter=hex1,hex2,hex3 – Displays only the listed planes.
- reg=registration - Direct link to specific aircraft registration(s). Separate multiple with commas.
- noIsolation - show other planes and not only the ones selected by ?icao
- icaoFilter=hex1,hex2,hex3 - Only show the mentioned hex ids, no other aircraft will ever be displayed
- reg=registration - Direct link to specific aircraft registration(s). Separate multiple with commas. ?icao is preferred as this option takes longer to load.

## Rendering parameters

- zoom=1-20 : set zoom level.
- enableLabels=true : enable labels on aircraft ("L" button).
- extendedLabels=value : select the labels type ("O" button) / Valid values are 0,1,2.
- trackLabels=true : enable track labels ("K" button).
- noVanish=true : persistence mode ("P" button).
- outlineWidth=value : set width for the for aircraft icons
- iconScale=0.1-x : scale the aircraft icon.
- labelScale=0.1-x : scale the aircraft labels.
- tempTrails=value : shows temporary trails for ## seconds of history.
- largeMode=1-4 : cycles Icons size.
- mapDim=0.1-1 : dim the map
- mapContrast=0.1-1 : set the map contrast.
- filterMaxRange=value : maximum distance of rendered tracks.
- baseMap=maptype : change the map type (as defined in config.js).
- mapOrientation=value : (in degrees).
- monochromeMarkers=xxxxxx : set constant html color for markers (parameter is an hexadecimal color).
- monochromeTracks=xxxxxx : set constant html color for tracks (parameter is an hexadecimal color).
- outlineColor=xxxxxx : set outline color (parameter is an hexadecimal color).
- sidebarWidth=xxx : size of sidebar in pixels.
- zoom=1-20 - set zoom level.
- enableLabels - enable labels on aircraft ("L" button).
- extendedLabels=value - select the labels type ("O" button) / Valid values are 0,1,2.
- trackLabels - enable track labels ("K" button).
- noVanish - persistence mode ("P" button).
- scale=0.1-x - overall interface scaling.
- iconScale=0.1-x - scale the aircraft icons. (multiplies with ?scale)
- labelScale=0.1-x - scale the aircraft labels. (multiplies with ?scale)
- tempTrails=value - shows temporary trails for ## seconds of history.
- mapDim=0.1-1.0 - reduce map brightness (negative values increase brightness)
- mapContrast=0.1-1.0 - increase the map contrast (negative values decrease brightness)
- filterMaxRange=value - maximum distance of rendered tracks.
- baseMap=maptype - change the map type (as defined in config.js).
- mapOrientation=0-360 - normally true north faces up, use this to change which true direction is pointing up.
- monochromeMarkers=xxxxxx - set constant html color for markers (parameter is an hexadecimal color).
- monochromeTracks=xxxxxx - set constant html color for tracks (parameter is an hexadecimal color).
- outlineWidth=value - set width for the for aircraft icons (only works with webGL disabled)
- outlineColor=xxxxxx - set outline color (parameter is an hexadecimal color, only works with webGL disabled)
- sidebarWidth=xxx - size of sidebar in pixels.
- hideSideBar - hides sidebar.
- hideButtons - hides all buttons.
- centerReceiver - conter the view on receiver position.
- nowebgl - force rendering without WebGL.

## Toggles

- noIsolation : enable multiselect when multiple ICAO are used.
- mil : Military/Interesting.
- hideSideBar : hides sidebar.
- hideButtons : hides all buttons.
- centerReceiver : conter the view on receiver position.
- tempTrails : enable temporary aircraft trails.
- nowebgl : force rendering without WebGL.
- mobile : Force mobile view.
- desktop : force desktop view.
- kiosk : force kiosk mode (tempTrails=true / hideButtons=true / userScale=2).
- mil - Military/Interesting.
- tempTrails - enable temporary aircraft trails.
- mobile - Force mobile view.
- desktop - force desktop view.
- kiosk - force kiosk mode (tempTrails=true / hideButtons=true / userScale=2).
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,10 @@ sudo bash -c "$(wget -nv -O - https://github.com/wiedehopf/tar1090/raw/master/un
- T selects all aircraft
- B toggle map brightness

## URL query parameters (/tar1090/?icao=123456&zoom=5 and similar)

See [README-query.md](README-query.md)

## Multiple instances

The script can install multiple instances, this is accomplished by first editing `/etc/default/tar1090_instances`:
Expand Down Expand Up @@ -423,10 +427,6 @@ alternative display style: &realHeat
- blurryness: &heatBlur=2
- weight of each dot for the heatmap: &heatWeight=4

## Query parameters

See [README-query.md](README-query.md)

## NO WARRANTY - Excerpt from the License:

11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
Expand Down

0 comments on commit e39ee3e

Please sign in to comment.