Configuration

Last updated 18 days ago

Description of configuration items

Settings UI

Settings are available from X-Plane's menu: Plugin > LiveTraffic > Settings.... They are split up into 5 pages: Basics, A/C Labels, Advanced, CSL, and Debug.

General Notes

  • All changes are applied immediately.

  • The configuration file is written when the settings UI is closed.

There are no [OK] or [Cancel] buttons. Whatever you do takes effect at once.

Text Edit Fields

For text edit fields the following applies:

  • [Esc] cancels the current edit operation and fills the field with the value from before the edit operation. No change is applied to LiveTraffic.

  • With [Tab] / [Shift+Tab] you can move focus between edit fields. (X-Plane has no concept of 'focus' for buttons and check boxes, which is why LiveTraffic's [Tab] implementation only applies to text edit fields.)

  • [Enter] applies the current value and return focus ot X-Plane, but doesn't close the window

  • A value is applied to LiveTraffic once the field loses focus by either [Tab]bing out of the field, hitting [Enter], or clicking elsewhere.

Tabs / Pages

The actual settings are divided into 5 pages, which you can access with the respective buttons in the top row:

Help

The [?] button in the top right corner opens the detailed help for the currently open settings page, the same as the 5 links above do.

Closing the Window

Click on the Close button: the cross in the top left or top right corner. LiveTraffic's configuration file is written when the window closes.

X-Plane Settings

In X-Planes Settings the following is recommended:

Option

Recommendation

Comment

Settings > Graphics > Draw parked aircraft

Off

Some planes drawn by LiveTraffic will taxi on aprons and even parking positions. It might look better if they don't bump into aircrafts parked by X-Plane.

Flight Configuration > AI Aircrafts

At least 5 aircraft of type "Boing 737-800"

These Ai Aircrafts do not influence how LiveTraffic renders planes in outside 3-D views (if CSL packages are installed), but they are the ones, which appear on TCAS displays. The more you configure the more blibs can be shown on TCAS.

Files

Configuration File

LiveTraffic saves configuration settings in a text config file named<X-Plane>/Output/preferences/LiveTraffic.prf. If on startup the file or some settings in the file do not exist default values apply.

This is what the config file looks like with all settings set to defaults:

<X-Plane>/Output/preferences/LiveTraffic.prf
LiveTraffic 1.1
livetraffic/cfg/auto_start 1
livetraffic/cfg/ai_on_request 0
livetraffic/cfg/labels 5123
livetraffic/cfg/label_shown 7
livetraffic/cfg/label_col_dyn 0
livetraffic/cfg/label_color 16776960
livetraffic/cfg/log_level 2
livetraffic/cfg/msg_area_level 1
livetraffic/cfg/use_historic_data 0
livetraffic/cfg/max_num_ac 50
livetraffic/cfg/max_full_num_ac 50
livetraffic/cfg/full_distance 3
livetraffic/cfg/fd_std_distance 15
livetraffic/cfg/fd_refresh_intvl 20
livetraffic/cfg/fd_buf_period 90
livetraffic/cfg/ac_outdated_intvl 50
livetraffic/cfg/lnd_lights_taxi 0
livetraffic/cfg/hide_below_agl 0
livetraffic/cfg/hide_taxiing 0
livetraffic/cfg/last_check_new_ver 0
livetraffic/channel/adsb_exchange/online 1
livetraffic/channel/adsb_exchange/historic 1
livetraffic/channel/open_sky/online 1
livetraffic/channel/open_sky/ac_masterdata 1
livetraffic/dbg/ac_pos 0
livetraffic/dbg/model_matching 0
DEFAULT_AC_TYPE A320
DEFAULT_CAR_TYPE ZZZC
[CSLPaths]
1|Resources/plugins/LiveTraffic/Resources/ShippedCSL
1|Resources/plugins/LiveTraffic/Resources/CSL

There should be no need to edit the file manually. If you do then only with X-Plane off. LiveTraffic overwrites the file whenever the settings window is closed or on shutdown.

Flight Model

LiveTraffic decides about a lot of parameters during a plane's flight as from the network flight tracking data essentially only the position and the timestamp are reliable data. Everything else is calculated. And these calculations need a number of parameters, which differ slightly if we talk about an A380 as compared to a Cessna Skyhawk.

<X-Plane>/Resources/plugins/LiveTraffic/Resources/FlightModels.prf
LiveTraffic 1.1
# LiveTraffic FlightModels configuration file
# The file is divided into [sections]. First there are an arbitrary number
# of sections defining flight models.
# The last section has the defined name [Map] and maps these flight models
# with actual aircraft types.
[MediumJets]
# These values are also the hard-coded defaults in case
# the entire config file went missing.
GEAR_DURATION 10 # [s] time for gear up/down
FLAPS_DURATION 5 # [s] time for full flaps extension from 0% to 100%
VSI_STABLE 100 # [ft/min] less than this VSI is considered 'stable'
ROTATE_TIME 3 # [s] to rotate before lift off
VSI_FINAL -600 # [ft/min] assumed vsi for final if vector unavailable
VSI_INIT_CLIMB 1500 # [ft/min] assumed vsi if take-off-vector not available
SPEED_INIT_CLIMB 150 # [kt] initial climb speed if take-off-vector not available
AGL_GEAR_DOWN 1600 # [ft] height AGL at which to lower the gear during approach
AGL_GEAR_UP 100 # [ft] height AGL at which to raise the gear during take off
AGL_FLARE 25 # [ft] height AGL to start flare
MAX_TAXI_SPEED 30 # [kt] below that: taxi, above that: take-off/roll-out
TAXI_TURN_TIME 45 # [s] time for a 360° turn on the ground
FLIGHT_TURN_TIME 120 # [s] time for a 360° turn in flight
ROLL_MAX_BANK 30 # [°] max bank angle
ROLL_RATE 5 # [°/s] roll rate in normal turns
FLAPS_UP_SPEED 180 # [kt] below that: initial climb, above that: climb
FLAPS_DOWN_SPEED 200 # [kt] above that: descend, below that: approach
CRUISE_HEIGHT 15000 # [ft] above that height AGL we consider level flight 'cruise'
ROLL_OUT_DECEL -2.0 # [m/s²] deceleration during roll-out if no live position available
PITCH_MIN -2 # [°] minimal pitch angle (aoa)
PITCH_MIN_VSI -1000 # [ft/min] minimal vsi below which pitch is MDL_PITCH_MIN
PITCH_MAX 15 # [°] maximum pitch angle (aoa)
PITCH_MAX_VSI 2000 # [ft/min] maximum vsi above which pitch is MDL_PITCH_MAX
PITCH_FLAP_ADD 4 # [°] to add if flaps extended
PITCH_FLARE 10 # [°] pitch during flare
PITCH_RATE 5 # [°/s] pitch rate of change
LIGHT_PATTERN 0 # Flash: 0 - Jet, 1 - Airbus, 2 - GA (see XPMPMultiplayer.h:124)
LIGHT_LL_ALT 10000 # [ft] Landing Lights on below this altitude; set zero for take-off/final only (GA)
EXT_CAMERA_LON_OFS -45 # longitudinal external camera offset
EXT_CAMERA_LAT_OFS 0 # lateral...
EXT_CAMERA_VERT_OFS 20 # vertical...
# The following sections uses [MediumJets] as parent: It only overrides
# some values of the [MediumJets] section
[MediumAirbus:MediumJets]
LIGHT_PATTERN 1 # Flash: 0 - Jet, 1 - Airbus, 2 - GA (see XPMPMultiplayer.h:124)
[HugeJets:MediumJets]
FLAPS_DURATION 10 # [s] time for full flaps extension from 0% to 100%
ROTATE_TIME 4 # [s] to rotate before lift off
VSI_INIT_CLIMB 2000 # [ft/min] assumed vsi if take-off-vector not available
AGL_FLARE 30 # [ft] height AGL to start flare
ROLL_RATE 3 # [°/s] roll rate in normal turns
PITCH_MAX 10 # [°] maximum pitch angle (aoa)
PITCH_MAX_VSI 2500 # [ft/min] maximum vsi above which pitch is MDL_PITCH_MAX
PITCH_RATE 2.5 # [°/s] pitch rate of change
LABEL_COLOR FF0000 # red label for huge jets
EXT_CAMERA_LON_OFS -70 # longitudinal external camera offset
EXT_CAMERA_LAT_OFS 0 # lateral...
EXT_CAMERA_VERT_OFS 30 # vertical...
[HugeAirbus:HugeJets]
LIGHT_PATTERN 1 # Flash: 0 - Jet, 1 - Airbus, 2 - GA (see XPMPMultiplayer.h:124)
[MediumProps:MediumJets]
ROLL_RATE 6 # [°/s] roll rate in normal turns
FLAPS_UP_SPEED 130 # [kt] below that: initial climb, above that: climb
FLAPS_DOWN_SPEED 180 # [kt] above that: descend, below that: approach
EXT_CAMERA_LON_OFS -20 # longitudinal external camera offset
EXT_CAMERA_LAT_OFS 0 # lateral...
EXT_CAMERA_VERT_OFS 10 # vertical...
[BizJet:MediumJets]
ROLL_RATE 8 # [°/s] roll rate in normal turns
FLAPS_UP_SPEED 130 # [kt] below that: initial climb, above that: climb
FLAPS_DOWN_SPEED 180 # [kt] above that: descend, below that: approach
LABEL_COLOR 00F0F0 # light blue labels for business jets
EXT_CAMERA_LON_OFS -20 # longitudinal external camera offset
EXT_CAMERA_LAT_OFS 0 # lateral...
EXT_CAMERA_VERT_OFS 10 # vertical...
[GA:MediumJets]
ROTATE_TIME 2 # [s] to rotate before lift off
VSI_FINAL -300 # [ft/min] assumed vsi for final if vector unavailable
VSI_INIT_CLIMB 500 # [ft/min] assumed vsi if take-off-vector not available
SPEED_INIT_CLIMB 75 # [kt] initial climb speed if take-off-vector not available
AGL_GEAR_DOWN 1000 # [ft] height AGL at which to lower the gear during approach
AGL_GEAR_UP 100 # [ft] height AGL at which to raise the gear during take off
AGL_FLARE 10 # [ft] height AGL to start flare
MAX_TAXI_SPEED 25 # [kt] below that: taxi, above that: take-off/roll-out
TAXI_TURN_TIME 45 # [s] time for a 360° turn on the ground
ROLL_RATE 8 # [°/s] roll rate in normal turns
FLAPS_UP_SPEED 90 # [kt] below that: initial climb, above that: climb
FLAPS_DOWN_SPEED 100 # [kt] above that: descend, below that: approach
CRUISE_HEIGHT 2000 # [ft] above that height AGL we consider level flight 'cruise'
PITCH_MIN -2 # [°] minimal pitch angle (aoa)
PITCH_MIN_VSI -500 # [ft/min] minimal vsi below which pitch is MDL_PITCH_MIN
PITCH_MAX 10 # [°] maximum pitch angle (aoa)
PITCH_MAX_VSI 600 # [ft/min] maximum vsi above which pitch is MDL_PITCH_MAX
PITCH_FLAP_ADD 2 # [°] to add if flaps extended
PITCH_FLARE 5 # [°] pitch during flare
PITCH_RATE 5 # [°/s] pitch rate of change
LIGHT_PATTERN 2 # Flash: 0 - Jet, 1 - Airbus, 2 - GA (see XPMPMultiplayer.h:124)
LIGHT_LL_ALT 0 # [ft] Landing Lights on below this altitude; set zero for climb/approach only (GA)
LABEL_COLOR 00FF00 # green labels for GA and smaller
EXT_CAMERA_LON_OFS -10 # longitudinal external camera offset
EXT_CAMERA_LAT_OFS 0 # lateral...
EXT_CAMERA_VERT_OFS 5 # vertical...
[LightAC:GA]
VSI_FINAL -300 # [ft/min] assumed vsi for final if vector unavailable
VSI_INIT_CLIMB 400 # [ft/min] assumed vsi if take-off-vector not available
SPEED_INIT_CLIMB 60 # [kt] initial climb speed if take-off-vector not available
[Map]
# The Map section matches flight models (defined previously,
# so [Map] has to be last) with aircraft types.
#
# First word is the name of the flight model.
#
# The remainder of the line is considered a regular expression supposed to
# match an aircraft type string made up of:
# WTC;Classification;Type Designator;Model;Manufacturer
# with 'Classification' being a combination of Description, Engine Type,
# Engine Count in a 3-letter/digit code.
#
# Examples: Airbus A380, Boing 737-200, Dash 8, Beechcraft Baron 58,
# Cessna C172 Skyhawk, and the special designator entry for gliders
# respectively look like this:
#
# H;L4J;A388;A-380-800;AIRBUS
# M;L2J;B732;737-200;BOEING
# M;L2T;DH8A;CT-142 Dash 8;DE HAVILLAND CANADA
# L;L2P;BE58;58 Baron;BEECH
# L;L1P;C172;172 Skyhawk;CESSNA
# -;-;GLID;Glider;(ANY MANUFACTURER)
#
# See https://www.icao.int/publications/doc8643 for details and all
# registered values.
# LiveTraffic takes the aircraft types from the Doc8643.txt file.
#
# The idea is to define a flight model which matches a wide range of aircrafts,
# like 'huge jets', 'medium jets', 'regional commuters', 'general aviation'.
#
# Then for a given aircraft as per live flight data LiveTraffic has to find a
# matching model. And it does so by computing the above aircraft type string
# for the given aircraft and then walk from top to bottom through this list
# and take the first model whose pattern matches the computed type string.
#
# It is possible, allowed, and propably helpful to list a
# flight model name several times at different positions in the list
# with different patterns.
HugeAirbus ^H;L\dJ;.*;AIRBUS
HugeJets ^H;L\dJ;
HugeAirbus ^M;L4J;.*;AIRBUS
HugeJets ^M;L4J;
# many many BizJets are cateogized M;L2J just like A320 or B737
# we can distinguish them only with reference to manufacturer, model, type...
BizJet ^M;L\dJ;*BEECH* # Beech, Beechcraft...
BizJet ^M;L\dJ;GLF # Grumman Gulfstream
BizJet ^M;L\dJ;LJ # Learjet
BizJet ^M;L\dJ;*BEECH* # Beech, Beechcraft...
BizJet ^M;L\dJ;.*;CESSNA # Cessna
BizJet ^M;L\dJ;.*;DASSAULT # Dassault (Falcon)
MediumAirbus ^M;L\dJ;.*;AIRBUS
MediumJets ^M;L\dJ;
MediumProps ^M;L\dT;
BizJet ^L;L\dJ;
GA ^L;L\dP;
LightAC ^-;
# This last line matches anything and serves as a default:
MediumJets .*

While this file is part of the LiveTraffic package and may be updated or enhanced in future releases you may edit it yourself. Options are described in the comments right within the file.