ATC-pie user guide

From FlightGear wiki
Revision as of 22:03, 19 July 2017 by Mickybadia (talk | contribs) (v1.3.1)
Jump to navigation Jump to search

This article is a guide to using ATC-pie, describing some of its major features. A more exhaustive list can be found in the main article.

Other sources to learn the program are:

  • the online video tutorial;
  • the in-app quick reference available from the Help menu (summary of mouse/keyboard gestures, display conventions...);
  • to play solo!

Anyone motivated to write a full user guide is obviously welcome to contact the developer, or improve this article. For support and troubleshooting, the ATC-pie FAQ might get you an answer first. Otherwise kindly ask on the FlightGear forum, where we have a dedicated sub-forum, so the discussion is public and its contents shared.

Flight strips

Whether dematerialised or on physical paper, printed out or filled by hand, the flight progress strip is the essential piece of air and ground traffic control. Every aircraft in contact is represented by a unique strip, and every strip represents a contact. This helps to ensure that no aircraft is ever forgotten about. Strip positioning and updating then enable to monitor the aircraft's status, sequence number, position, intentions, etc.

Filling details and linking

A click on the "new strip" button (shortcut F2) or double click on an existing flight strip opens a dialog to edit the flight details.

If providing radar service, strips should be linked to identified contacts to inform the radar display with the filled details and enable joint selection. To link a strip to a radar contact, select one and middle-click on the other. Conflicts between the strip details and the values squawked by the linked transponder contact are reported: the strip displays a "!!XPDR" warning and the strip dialog labels the conflicting details.

A strip can also be linked to a filed flight plan (FPL) to merge the information. The strip dialog also shows the mismatching information between the two, though this is rather common because the strip typically gets updated with the flight progress.

All together, a selection can involve up to three linked elements: strip, radar contact, flight plan. You can pull details from linked elements to strips (strip panel bottom menu), and push strip details to their linked flight plan if necessary (strip dialog bottom tick box). Unlinking is possible with SHIFT+middle-click. If you use linking carefully, auto-fill options are available from the general settings, to fill blank strip details with newly-linked information.

For fast and efficient service, every initial contact by a pilot should basically make you hit F2 and type the callsign announced. You should then soon figure out if:

  • a flight plan is already filed: if the matching FPL count displays a non-zero value near the callsign field as you type, you can select a flight plan to link to the strip on save;
  • a flight plan must be filed (e.g. IFR departure not filed by lazy pilot): select "new FPL" from the bottom line to open a fresh FPL detail sheet to link to the strip;
  • he was asked to contact you by a previous ATC, in which case you may have a strip handed over to you already;
  • etc.

Strip placeholders

ATC-pie provides with various placeholders for flight strips, namely racks, loose strip bays and runway boxes. According to your ATC position and local facilities, you should choose and arrange your placeholders for optimal control. Strips can then be moved between them using mouse drag and drop.

Strip rack panel

A strip rack is the preferred way of keeping track of a sequence, e.g. a departure queue at a runway threshold. You can create as many racks as you wish and name them appropriately. Racks can be viewed in the main window and in their own docked or floating panel. The column views show all racked strips at once; the tabbed view avoids spreading the window horizontally. The "default" rack is permanent. It collects strips recovered or received when no other rack is defined.

Reserved runway marked in yellow

In the same panel, above the racks or in their own tab (resp. column or tabbed view), you can opt to show the runway boxes. A runway box is a placeholder for a single strip, named after a runway in use and denoting a clearence to use it (enter, cross, land...). Thorough use of runways boxes will help you never clear an aircraft to land over lined up traffic for example. When freed, runway boxes display a timer since last use together with the wake turbulance category of the last contained strip, to help with separation. What is more, if you use radar, a filled runway box marks the runway as reserved on the scope.

The third placeholder type available is the loose strip bay, allowing free-hand positioning of strips in its reserved space. Such bays can be useful for any kind of unsequenced traffic, or to map out relative positions when controlling without a radar. You may also import background images, e.g. a ground chart to keep visual track of taxiing aircraft and vehicles. See resources/bg-img/Notice to learn how.

Besides, there are two other places a strip can be dropped on, usually when releasing a contact:

  • a connected ATC (if accepting strip exchange), to initiate a handover;
  • the strip shelf (visible in the bottom right-hand corner of every strip panel), which removes the strip from your work bench and stores it as shelved.

Airport scene rendering

Tower viewing, following a departing aircraft

This feature allows you to overlook your airport and the connected (multi-player games) or simulated (solo and teaching sessions) traffic, like a controller from a tower viewpoint. It allows to choose from the tower positions specified in the source data if any, otherwise defaults to somewhere over the airport to allow towering of all available airports. It is disabled in CTR mode. Additionally, more views can be hooked up to your scene.

Tower view window

There are two ways of activating a tower view. You may let ATC-pie start its own suitably configured FlightGear process, or have it connect to an external viewer, manually set up and accepting connections.

Running internally only requires FlightGear installed on your computer. A basic installation is enough, but:

  • aircraft will only be drawn properly if you have the corresponding models installed—read the notice in resources/acft and check out the icao2fgfs file to understand how ATC-pie chooses models for FlightGear (initially included are a few ugly substitutions like B772 for A320 to avoid the lighter installations to miss out on planes, but you can edit the file and use your own models);
  • more importantly, you will need the scenery for your airport if you want anything exciting to see (and not sea!)—add it to your FlightGear root directory or enter the directory in the System settings dialog (ATC-pie will pass it on to FlightGear).

Connecting to an external viewer allows to run FlightGear on a different machine and thereby relieve your session from the CPU load a local instance induces. If you want to do so, get a hint of the required positioning options you should start your viewer with, from the tower view tab in the system settings dialog. More options should also be considered, e.g. --fdm=null. Of course, scenery, models and liveries must also be available to the running process.

In either case, once activated from the View menu, the tower view control pane is enabled, from which you can turn to runway points, follow selected aircraft... Direct FlightGear input in the view window is also possible: right click and drag allows to look around, x/X keys change the zoom level, etc.

Additional scene views

You can connect additional viewers to your session, for example placed around your airport for exciting camera footage of challenging landings. You will not be able to control those viewers from ATC-pie like the tower viewer, but you will be able to activate/stop the connection with a switch in the application View menu. Additional viewers are registered by their host+port address, from the View menu at run-time or from a custom settings file (see settings/Notice), read at start-up and on explicit reload (System menu).

Every such viewer registered on host XXX and port YYY should be running on XXX and started with options --multiplay=out,TTT,HHH,PPP and --multiplay=in,TTT,,YYY, where:

  • HHH is the host on which ATC-pie is running;
  • PPP is the default 5009, or the chosen port number if ATC-pie was started with --views-send-from;
  • TTT is the network polling frequency (100 is common practice; change as desired if you know what you are doing).

Routes and separation warnings

ATC-pie analyses routes and assigned vectors to anticipate conflicts between controlled aircraft.


Route details dialog with world path drawn, available when both end airfields are recognised

A route is analysed for every strip with recognised departure and destination airports (entry fields both turned green), as follows:

  • route tokens are whitespace-separated;
  • each recognised navpoint token (world navigation aid, airfield, fix, RNAV point) creates a waypoint on the path to destination, and a route leg from the previous point (a final leg connects the last point to the destination airport);
  • if ambiguous (navpoint names are not all unique around the world), a waypoint is always the nearest homonym to the point beginning the leg;
  • other tokens are kept as route leg specifications to the following waypoint (e.g. airways between fixes).
Assigned routes are drawn as dashed lines on the radar scope when linked to contacts

Routes on flight plans and strips are viewable in a route dialog, showing geodesic paths, headings and leg distances on a world map. When a specified route is linked to a radar contact, ATC-pie works out its current leg based on distance to destination, and:

  • details of the current leg are displayed in the selection info pane, and the route viewing button enabled;
  • the strip shows only the remainder of the route for this contact;
  • the route to go is drawn as a dashed line on the radar (unless aircraft is inbound and near enough);
  • the radar tag contains the next waypoint and the heading leading the aircraft to it on a great circle, unless:
    • the current route leg is the first, and the keyword "SID" appears in its specification: "SID wp" is displayed, where wp is the first waypoint on the route;
    • the current route leg is the last, and the keyword "STAR" appears in its specification: "STAR wp" is displayed, where wp is the last en-route waypoint.

NB: If either of the DEP or ARR airports are missing or unidentified, radar tags show the strip destination detail (ARR) if it is filled, possibly with a heading if it is recognised.

See tutorial video 7 for a demonstration of routes.

Conflicts and anticipation

Route conflict depiction

ATC-pie features a conflict prediction system, which can be activated or turned off from the Options menu. It uses route and vector assignments to anticipate and alert you of path conflicts so you can take action and prevent separation losses.

When looking for conflicts, a horizontal (ground projection) path is considered for aircraft with a linked strip and an assigned route or heading. An aircraft is assumed to follow its route, unless a heading vector is given in which case it is assumed to be flying the assigned straight course. When the projections of two aircraft intersect, a conflict is anticipated if the respective intervals between the current and assigned altitudes overlap. When an aircraft's altitude is unknown, the assigned altitude will be assumed. If an altitude assignment is missing, a possible conflict is reported.

Another possible alarm is the separation incident, a serious ATC mistake which calls for immediate action. The table below summarises the different levels of conflicts, ranked in decreasing order of emergency.

Conflict warnings in ATC-pie
Alarm Shown on scope (default colours) Meaning
Separation incident Thick bright red intersecting circles Separation loss between aircraft
Path conflict Red circles and paths Anticipated paths and altitudes are intersecting
Possible path conflict Yellow circles and paths Paths intersecting but some altitudes unknown

Playing solo

In solo games, you control virtual IFR planes, receiving and handing over strips to virtual ATCs depending on your position and the aircraft's intentions. ATC-pie allows to train in different situations:

  • as an en-route controller (CTR) if started in centre mode;
  • or in airport mode, where four combinable positions are available:
    • ground (GND), to taxi aircraft between gates and runways;
    • tower (TWR), to control runways and immediate surroundings;
    • departure (DEP), to bring departing traffic to their exit point;
    • approach (APP), to vector arrivals onto final.


When playing CTR, your task is to transit the aircraft across your airspace, always ensuring separation, and to hand each of them over to the most appropriate neighbouring centre North, South, East or West of your sector. You can specify local navpoints in the location settings so that the system includes them as turning points in the randomised aircraft's routes.

In airport mode, traffic is either inbound or outbound. Assuming APP, inbound aircraft must be sequenced and vectored into tower range for handover, unless you are in the TWR position as well. Each inbound aircraft either requests ILS or visual. Playing TWR, you must clear them to land when appropriate, i.e. cleared for ILS approach or expected runway reported in sight. If landing cannot take place (too high, not cleared...), aircraft will go around. Controlling GND, you must move inbound traffic near their parking position once they have vacated the runway, and hand them over to the ramp. Outbound traffic must be brought to hold short of a runway threshold and report ready for departure with TWR. If you play DEP, you must hand outbound aircraft over to the en-route centre (CTR) once they are high enough and close to their exit point if specified in its route. Entry and exit points are configurable in the location settings.

Handover pane when playing solo in airport mode, assuming all three available positions
Handovers with virtual ATCs in airport mode
Departure strips Arrival strips
Assuming positions Receive from Hand over to Receive from Hand over to
All 4 DEL CTR CTR Ramp

Instructing aircraft

Click&drag taxi instruction tool at OMDB ground

Instructions are given through different means:

  • provided the speech recognition modules are installed, you can turn on voice instructions from the solo game settings dialog and instruct aircraft through your microphone, using the Ctrl key as push-to-talk and standard phraseology (see the quick reference tab about it);
  • if voice instructions are turned off:
    • the mouse vector assignment tool will issue the corresponding instructions: click&drag out of a radar contact for heading, hold SHIFT and drag for altitude/FL vertically and speed horizontally (see video 5 of the tutorial);
    • handoffs are issued when dropping strips on an ATC receiver;
  • instruct taxi routes by dragging out of radar contacts when they are considered on the ground (low enough or squawking GND);
  • the dockable instruction panel works regardless of voice vs. mouse selection.

NB: Instructions from the panel are always issued to the callsign entered in the top field, which should fill automatically on aircraft or strip selection when a callsign is known. Therefore, make sure you do not mess up your strip links or your instructions will realistically be acknowledged and followed by the wrong aircraft.

Need a scenario?

Things you can train for:

  • towering a single runway with mixed traffic: select TWR position and an equal balance of departures and arrivals;
  • optimising approach spacing in dense traffic: select APP position only, increase traffic density, turn on spacing hints and try to stabilise them all at "3:00" for example;
  • change of runways (e.g. irl after wind direction change): start with APP+TWR and select a runway for arrivals at least, play for a while and change for opposite runway use;
  • CTR mode with a low ceiling to increase the number of conflicts to resolve;
  • etc.

Teacher & student connections (ATC tutoring)

This connection type is made to bring an ATC student and a teacher together for tutorial sessions. The teacher creates and manipulates traffic for the student to work with, controls the weather and decides on the ATC neighbours.

To set up a session, the student must connect to the teacher, so make sure the teacher's session is running first. Only one student can connect to a teacher at a time. To communicate via voice during the session, the two parties may use nearby FGCom frequencies, but a private channel on Mumble is also an option to avoid interfering with multi-player users sharing the same server. The best choice is probably to tune into unused (guard or secondary) FGCom frequencies for in-simulation transmissions, and to open a separate channel for teacher–student conversations.

When playing teacher:

  • The teaching console dock is enabled, which you should keep visible to control of the student's environment.
  • You create new traffic with SHIFT+click&drag on the radar, specifying the place and face heading of the wanted traffic. A dialog pops up and allows you to choose a callsign (one is initially generated), altitude and other details. If near a ground route node, a parking position or runway threshold, you can place it on the ground instead, ready to taxi or for departure (NB: parking overrides position/heading input).
  • Traffic is initially created in an "unspawned" state (round-shaped blip on radar), in other words visible to you but not to the student. This allows you to set its transponder or get it into a certain state before spawning it into the student's world.
  • Controlling the traffic is done in the same way as in solo sessions without voice, i.e. using the click&drag vector and taxi tools and the instruction dock. The only difference is that you control the selected aircraft directly, regardless of your strip links and details. You therefore do not need a strip and a correctly filled callsign to instruct a pilot, though it is a good idea to have one if you want your vectors registered and drawn on the radar. The traffic creation dialog offers to create a linked strip with every new aircraft.
  • You may pause the whole simulation, or freeze each aircraft individually. Frozen aircraft will result in stationary flights on the student's radar.

Strip exchange is possible, either between both parties ("offline" exchanges) or between the student and the virtual ATCs (in-sim handovers). As the teacher, you must drop every strip on "Student" and select as prompted whom the strip should appear from on the student's side. As the student, drop your strip on any of the ATCs in the neighbours list to simulate a handover, or on "Teacher" if only showing it to your mentor. All student handovers are made visible to the teacher for supervision. Interestingly, for his convenience in further control of the traffic, the teacher's strips do not disappear on handovers.

NB: Unlike in FlightGear games where limitations apply (see section further down), all strips are exchangeable in tutorial sessions.

ATC strip exchange (handovers)

Sending and receiving strips

Example of a strip received from "DEL"

To hand a strip over, drag it and drop it on the recipient in the list of connected controllers. Note that some ATCs may not be capable of strip exchange. Check tutorial video 6 for a presentation of the feature.

Received strips appear unlinked on their collecting rack (if defined), with an identification of the sender which disappears as soon as the strip is clicked on. Double-click on the rack tab or column header to add an ATC callsign from which to collect strips.

OpenRadar interoperability

The handover feature in FlightGear multi-player games is based on OpenRadar's exchange server to enable ATC coordination between users of both software programs. However, it is to note that their philosophies differ in several ways:

  • OpenRadar's basic processing unit is the FGMS callsign, whereas ATC-pie's is the strip;
  • OpenRadar's concept of handover is based on a shared notion of aircraft ownership, whereas ATC-pie allows any controller to pull out a strip, write any callsign and link it to a radar contact;
  • in OpenRadar, a handover must be acknowledged by the receiver for the sender to lose ownership and for all neighbouring OpenRadar users to see the handover complete, whereas ATC-pie considers that a strip sent through the hand-over pipe is gone and should land directly on a receiver's rack at the other end, without anybody else necessarily to know.

For most interactions to work while still respecting both philosophies as much as possible, the following principles and restrictions were chosen:

  • ATC-pie users can only hand over strips that are linked to a radar contact (no lone strip can be sent);
  • aircraft under ATC-pie control are not shown as "owned" to OpenRadar users;
  • handovers from ATC-pie are restricted to a 180 NM range, and will fail if an OpenRadar user in range is claiming ownership;
  • when sending to ATC-pie controllers, OpenRadar users will see their transfers acknowledged straight away, unconditionally.

Callsign handover policy:

  • O-R to ATC-pie: FGMS callsign will appear on the strip, as if the sender had filled the detail properly;
  • ATC-pie to O-R: callsign resolved for the receiver, sender's entry will reappear next time ATC-pie handles the strip;
  • pie-to-pie handovers: strip detail preserved, whether present or absent.

Detail note: wake turbulance category does not show in OpenRadar, but is preserved and visible to ATC-pie instances later receiving the strip.

Background images

Pixmap image example with a topographic map shot around LIMW (Aosta, Italy)
Hand drawing example with procedures for LSGG (Geneva, Switzerland)

Background images allow to decorate:

  • radar scopes, with all sorts of maps and useful information about the airspace, terrain or procedures;
  • loose strip bays, to move unracked strips over custom backgrounds, e.g. ground charts of the airport.

There are two ways to create backgrounds in the program. One working for all purposes is to import pictures (pixmap files like JPEG or PNG, including transparency); the other works only for radar backgrounds and consists in writing drawing specification files to paint coloured lines and labelled points. This allows to import anything from the most complex coloured height map to the the most schematic airspace outline. The resources/bg-img/Notice file explains how to import and draw background images. All pictures and drawing points are positioned using lat/lon coordinates, navpoints in map range and radial/distance expressions as per the "point specification" syntax explained in the notice.

For example, you can map out procedures (SID, STAR, IAD...), grouping them by associated runways. Drawings are generally appropriate for that because they allow referring to named points as per the published procedures and avoid manual positioning. But if you want more than schematic line plots, you should create the picture yourself. Using an image processing tool like GIMP, superimpose a transparent layer on top of a real map canvas, or over a screenshot of your ATC-pie radar with pinned navaids as landmarks, and freely decorate your picture.

ATC-pie comes with a handful of helper tools to create or import background images:

  1. Located in the System menu, the "image positioning helper" allows to move and resize imported pictures, adjusting the corners visually rather than programmatically if you have no specification for them. All visible pixmap images will be moved simultaneously, so you can work with several at a time if you want to. On dialog box close, a file is generated in the output directory for you to copy from.
  2. The "download OSM background" option facilitates map retrieval from the OpenStreetMap still image server. After specifying corners and a scale, a PNG map will be generated in the output directory for you to import. Caution: downloads can fail for large images; try reducing the requested size or resolution in such case. Also, the server is rather limited so make parsimonious use of it.
  3. If you have a sector file for your area (.sct), the script will translate the contained diagrams into ATC-pie drawings. While the generated files always require some post-editing, it is generally the best option for things like SID/STAR diagrams. See the README file for a description.


FGCom radio

Multiple radios can be opened and tuned in at once, and you can talk on either one by holding the PTT mouse button down for the chosen radio box. The left-Ctrl keyboard key will also let you PTT on selected frequencies. You can transmit on several at once, for example to service GND+TWR frequencies in view of splitting them seemlessly again if a controller is expected soon to fill one of the two positions. Tick the Kbd PTT option in the radio boxes of the frequencies to merge. Your keyboard PTT key will then transmit on them all simultaneously. Note that while you will be broadcasting on, and hearing incoming transmissions from, all frequencies, pilots will not be hearing each other across frequencies.

Say you are TWR coordinating with GND at your airport, and you want to monitor both radio frequencies while you are only in charge of TWR. To set this up, start your radio box on TWR frequency and turn on a second one to monitor GND. Tick "Kbd PTT" only for TWR so that you only transmit to your frequency and don't interfere with the other, and set the volume to "soft" on the latter so that you can tell the radio you are hearing the messages from, and know if it is for you to answer.

The PTT turns off sounds option is recommended for those of you who do not wear headsets, as it will avoid GUI sound notifications being picked up by your microphone while transmitting on frequencies.

Text chat

ATC-pie has a powerful text chat system for those who use the keyboard extensively, though of course voice radio communications should be encouraged for realism, whenever possible.

First, text aliases are dollar-prefixed words (like $foo) that ATC-pie will try to replace with context-dependant values on message send. This allows to write and save formatted messages and avoid typing verbatim for every message of a recurrent format. For instance, anybody will enjoy the comfort of sending Current weather is $metar, whose alias will expand to the current primary station weather, instead of typing or copy-pasting a weather look-up for every such message.

Aliases can be predefined or custom. Predefined aliases take values that are specified by the program, e.g. $metar standing for the current weather, and may depend on the local environment (declination, airport elevation...), on your configuration (transition altitude, runways in use...) or on the current selection (QDM to airport, assigned route...). They are all listed with their meaning in the "quick reference", Text aliases section. Make sure to take a look.

All other aliases will be considered custom, in other words to take values specified by you. You can define text aliases and replacements on three different levels:

  • world (program user), in the general notes;
  • location (airport/centre), in the local notes;
  • individual (selected strip), in your strip comments.

Here is how ATC-pie decides what to do with a text alias of the form $foo on chat message send:

  1. If it is one of the predefined list, the substitution is the one described. If not, it is a custom alias and we carry on to the next step.
  2. Look for a line beginning with "foo=" in the general notes (notepad dock). If one is found, the alias is substituted with what follows the '='.
  3. Perform the same search through the local notes. If nothing is found, consider the current selection.
  4. If a strip is part of the current selection, look inside the comment field and search likewise.
  5. Substitution is unsuccessful. ATC-pie will open an edit box so that you can review your message before sending it.

NB: You can test all this without polluting any game channel by holding the mouse down on the "Msg" button and selecting "check message". This will allow you to view what replacements would take place.

Moreover, ATC-pie strips everything up to the first pipe character (|), if any, before a message is processed and sent. You may check this with test line "stripped part|sent part" and observe that only the "sent part" makes it to the message contents. You can therefore make your life easier with piped shortcuts in your preset message list. They will pop up like any other message in the filtered menu as you type. For example, the following preset message enables something like a dot-command for sending a bearing to your base airport in a few key strokes:

.qdm|Heading to airport $qdm

Lastly, if a troll or angry user is polluting your session with undesired messages, click and hold the Dest. tool button in the text chat dock to add their callsign to the senders blacklist. All messages from the user will then be filtered out from the message pane. You can view and clear this list at any time during the game.