ATC-pie user guide: Difference between revisions

Jump to navigation Jump to search
New release: r8
(Adding categories)
(New release: r8)
Line 23: Line 23:


=== Starting the program ===
=== Starting the program ===
Depending on your system and preference, you might be double-clicking, typing stuff or pulling your hair out. In any case what you need to start the program is to run a Python3 interpreter on the <code>ATC-pie.py</code> file in the top-level directory. To start at a chosen airport location, say with code ICAO, add a system command line argument, which may look as simple as:
Depending on your system and preference, you might be double-clicking, typing stuff or pulling your hair out. In any case what you need is to run a Python3 interpreter on the <code>ATC-pie.py</code> file in the top-level directory. You may start the program in either '''airport''' or '''centre''' mode, i.e. respectively with or without a base airfield.
 
The '''airport mode''' is typically used for ATC positions like approach or tower control. In this mode, ATC-pie places the radar at the chosen base airfield, depicts its tarmac and runways, and enables features like tower viewing and runway use configuration. To start the airport mode from a system terminal, say with base airfield ICAO, the command to run is:
: <code>./ATC-pie.py ICAO</code>
: <code>./ATC-pie.py ICAO</code>
If no ICAO code is given, good old KSFO will be chosen as default.


If no ICAO code is given, good old KSFO will be chosen as default. After a few seconds, you should see the main window appear with a radar scope and a depiction of your airport in the centre.
ATC-pie's '''centre mode''' is designed for en-route control centre simulation (CTR). It disables all airport-specific features, and allows to place the radar anywhere on Earth. To start this mode and define a new position, run the command:
: <code>./ATC-pie.py --ctr=code radar_position</code>
The ''radar_position'' argument specifies the point on which to centre the radar, for example given as world coordinates (see down <code>resources/bg-img/Notice</code> for full point syntax description; look out for any character to escape from shell). Replace ''code'' by a designator of your choice (excluding airport codes), under which to save your location-specific settings. A good idea is to use ICAO airspace designations, e.g. "SBBS" for the Brasiia FIR in central Brazil. Subsequent runs at the same location will then be enabled without the second argument, and with the even more direct command:
: <code>./ATC-pie.py code</code>


Additional command line options are available:
Additional command line options are available:
{| class="wikitable"
{| class="wikitable"
! Option || Effect and argument specification || Default
! Option || Effect and argument specification || Default
|-
| --ctr=''code'' || Start in CTR mode at given location code (see above). Anonymous argument sets/resets the radar position for this location. || (none)
|-
|-
| --map-range=''range'' || Define the distance in NM from the radar centre up to which the map will be drawn and navpoints listed in the navigator (accepted values are 20..500). This is a different setting to the radar range configurable in the game settings. || 100
| --map-range=''range'' || Define the distance in NM from the radar centre up to which the map will be drawn and navpoints listed in the navigator (accepted values are 20..500). This is a different setting to the radar range configurable in the game settings. || 100
Line 51: Line 59:
* If you intend to use the radio like you should in multi-player games, check the [[FGCom]] version setting in the ''System'' menu, and try an echo test. Read the <code>resources/fgcom/Notice</code> file if you have problems hearing yourself, and check the FAQ section in this article.
* If you intend to use the radio like you should in multi-player games, check the [[FGCom]] version setting in the ''System'' menu, and try an echo test. Read the <code>resources/fgcom/Notice</code> file if you have problems hearing yourself, and check the FAQ section in this article.
* In the same menu, if you want to use the tower viewing system and not bother making it external (see feature note below), make sure you have the right paths set for your [[FlightGear]] installation.
* In the same menu, if you want to use the tower viewing system and not bother making it external (see feature note below), make sure you have the right paths set for your [[FlightGear]] installation.
* Set up the airport runway parameters in the airport settings, especially ILS capability if you will be playing solo often at the same location.
* Set up the important location-specific settings like airport runway parameters, especially ILS capability if you will be playing solo often at the same location.


Note for multi-player games: callsigns for ATCs are typically expected to start with the ICAO code of the controlled airport or sector, and end with a hint on the provided service: twr, gnd... When choosing your callsign on MP connect, make sure it is unique, and note that [[FGMS]] restricts callsign length to 7 characters. :-(
Note for multi-player games: callsigns for ATCs are typically expected to start with the ICAO code of the controlled airport or sector, and end with a hint on the provided service (twr, gnd, ctr...). Before choosing your callsign on MP connect, make sure it is not already in use, and note that [[FGMS]] restricts callsign length to 7 characters. :-(


== Feature notes ==
== Feature notes ==
Line 59: Line 67:


=== Routing and conflict warnings ===
=== Routing and conflict warnings ===
ATC-pie analyses routes and assigned vectors to assist traffic management and anticipate path conflicts between controlled aircraft.
ATC-pie analyses routes and assigned vectors to assist traffic management and anticipate path conflicts between controlled aircraft. This feature is essential in centre mode.


[[File:ATC-pie-screenshot-routeDetailsView.png|thumbnail|Route details dialog with world path drawn, available when both end airfields are recognised]]
[[File:ATC-pie-screenshot-routeDetailsView.png|thumbnail|Route details dialog with world path drawn, available when both end airfields are recognised]]
A '''route''' is parsed for every strip with both recognised departure and destination airports (names shown near respective fields on the strip sheet), as follows:
A '''route''' is parsed for every strip with recognised departure and destination airports (entry fields both turned green), as follows:
* route tokens are whitespace-separated;
* 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);
* 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);
* other tokens are kept as route leg specifications to the following waypoint;
* if ambiguous (navpoint names are not all unique around the world), a waypoint is always the nearest homonym to the point beginning the leg;
* 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 (allows for airway or procedure names for example).


[[File:ATC-pie-screenshot-routeDrawing.png|thumbnail|Assigned routes can be drawn as dotted lines on the radar scope when linked to contacts]]
[[File:ATC-pie-screenshot-routeDrawing.png|thumbnail|Assigned routes can be drawn as dotted lines on the radar scope when linked to contacts]]
Line 100: Line 108:


=== Solo training mode ===
=== Solo training mode ===
This mode allows to train on your own in different situations. Three combinable positions are available:
In solo games, you control virtual IFR planes via the instruction interface, receiving and handing over strips to virtual ATCs depending on your position and aircraft's intentions. ATC-pie allows to train in different situations:
* tower (TWR), controlling runways and immediate surroundings;
* as an en-route controller (CTR) if started in centre mode;
* departure (DEP), bringing departing traffic to their exit point;
* or in airport mode, where three combinable positions are available:
* approach (APP), vectoring arrivals onto final.
** tower (TWR), controlling runways and immediate surroundings;
 
** departure (DEP), bringing departing traffic to their exit point;
In any case, you will be controlling virtual IFR planes via the software interface, and receiving and handing over strips to virtual ATCs, depending on your position and on the aircraft's intentions (see table below). Approaches can be requested ILS or visual, and the balance between the two is adjustable from the solo mode settings.
** approach (APP), vectoring arrivals onto final.


Assuming APP, aircraft requesting ILS must be vectored to intercept a runway localiser and cleared for ILS approach, whereas those requesting visual require vectors until they report the expected runway is in sight. Then, approaching aircraft must be handed over to TWR, unless you are in the TWR position as well. If you are, you must clear them to land—or they will climb back up for go-around—and hand them over to ground control (GND) once they have vacated the runway. Tower also manages departures, which appear ready holding short of runways. After take-off, hand over your strips to departure control, unless assuming DEP yourself. When doing DEP, you must hand outbound aircraft over to the en-route centre (CTR) once they are high enough and close enough to their exit point if specified.
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 (you must clear them for ILS approach), or visual (they require vectors until they report the expected runway is in sight). Playing TWR, you must clear them to land and hand them over to ground control (GND) once they have vacated the runway. If landing cannot take place (too high, not cleared, etc.), aircraft will climb back up for go-around. Tower also manages outbound traffic, which appears ready holding short of runways. After take-off, hand over your strips to departure control, unless you are assuming DEP yourself. When doing 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.


[[File:ATC-pie-screenshot-handoverPane-solo.png|thumbnail|Handover pane when playing solo, assuming all three available positions]]
[[File:ATC-pie-screenshot-handoverPane-solo.png|thumbnail|Handover pane when playing solo in airport mode, assuming all three available positions]]
{| class="wikitable" style="text-align:center"
{| class="wikitable" style="text-align:center"
|+ Handovers with virtual ATCs
|+ Handovers with virtual ATCs in airport mode
|-
|-
| || colspan="2" | Departure strips || colspan="2" | Arrival strips
| || colspan="2" | Departure strips || colspan="2" | Arrival strips
Line 139: Line 147:
|}
|}


'''Vectors''' are given by means of the vectoring assignment tool (click&drag on radar contact for heading, with SHIFT for altitude/FL and speed). '''Other instructions''' (''line up and wait'', ''clear to land'', etc.) can be sent from the instruction dock. Pull it up from the ''View'' menu if it is not visible. Non-vectoring instructions are sent to the callsign entered in the top field, which should fill automatically on aircraft or strip selection if the callsign is known.
'''Vectors''' are given by means of the vectoring assignment tool (click&drag on radar contact for heading, with SHIFT for altitude/FL and speed). '''Other instructions''' (''line up and wait'', ''clear to land'', etc.) can be sent from the instruction dock. Pull it up from the ''View'' menu if it is not visible. Instructions are issued to the callsign entered in the top field, which should fill automatically on aircraft or strip selection if the callsign is known.


Things you can train for:
Things you can train for:
Line 149: Line 157:
=== Tower viewing ===
=== Tower viewing ===
[[File:ATC-pie-screenshot-towerViewing.png|thumbnail|Tower viewing, following a departing aircraft]]
[[File:ATC-pie-screenshot-towerViewing.png|thumbnail|Tower viewing, following a departing aircraft]]
This feature allows you to overlook your airport and the connected (MP) or simulated (solo) traffic, like a controller from a '''tower viewpoint'''. It uses the tower position specified in the source data if any, otherwise defaults to somewhere over the airport to allow towering all available airports.
This feature allows you to overlook your airport and the connected (MP) or simulated (solo) traffic, like a controller from a '''tower viewpoint'''. It uses the tower position specified in the source data if any, otherwise defaults to somewhere over the airport to allow towering all available airports. It is disabled in CTR mode.


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. The latter way takes a little more effort but allows to run FlightGear on a different machine and thereby relieve your session from the CPU load a local instance induces. If you are going for that, start ATC-pie with <code>--tower-view-external</code> and check the <code>--tower-view-ports</code> and <code>--views-send-from</code> command line options in the table above to set it up correctly.
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. The latter way takes a little more effort but allows to run FlightGear on a different machine and thereby relieve your session from the CPU load a local instance induces. If you are going for that, start ATC-pie with <code>--tower-view-external</code> and check the <code>--tower-view-ports</code> and <code>--views-send-from</code> command line options in the table above to set it up correctly.
Line 201: Line 209:


=== Interface and information display ===
=== Interface and information display ===
The '''''Options'' menu''' is divided in two sections. The item above the separator contains unsaved session options, which go back to their default setting on restart. Under the separator are saved settings, which come in two flavours:
The '''''Options'' menu''' is divided in two sections. Items above the separator are unsaved session options, which go back to their default setting on restart. Under the separator are the saved settings, which come in two flavours:
* airport-specific (under a unique submenu): saved and restored when started at the same airport again, e.g. runway ILS capabilities;
* location-specific (under a single submenu): saved and restored when started at the same location again, e.g. runway ILS capabilities for an airport, main METAR station;
* global settings: saved and restored regardless of airports, e.g. preset text chat messages.
* global settings (all other entries): saved and restored regardless of location or game mode, e.g. preset text chat messages.


You can '''customise the radar colours''' by editing the colour codes in the <code>settings/colours.ini</code> file generated on first run.
You can '''customise the radar colours''' by editing the colour codes in the <code>settings/colours.ini</code> file generated on first run.
Line 220: Line 228:
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.
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.


For more efficient text chat, '''text aliases''' are available and allowed in both instant and preset chat messages, e.g. <code>$wind</code>, <code>$qnh</code>... When the containing message is sent, they automatically expand to the current context-dependant value. Custom aliases can be used, whose replacement will be searched for in the general and airport notes (your notepads) and in the selected strip comments. This allows for variable text by controller, by airport and by radar contact. Have a look at the ''Quick reference'' available from the ''Help'' menu, ''Text aliases'' section. Unsuccessful replacements will trigger an edit box so that you can review your message before sending it.
For more efficient text chat, '''text aliases''' are available and allowed in both instant and preset chat messages, e.g. <code>$wind</code>, <code>$qnh</code>... When the containing message is sent, they automatically expand to the current context-dependant value. Custom aliases can be used, whose replacement will be searched for in the general and local notes (your notepads) and in the selected strip comments. This allows for variable text by controller, by location (AD or CTR) and by radar contact. Have a look at the ''Quick reference'' available from the ''Help'' menu, ''Text aliases'' section. Unsuccessful replacements will trigger an edit box so that you can review your message before sending it.


Everything up to the first pipe character (<code>|</code>, if any) in a text chat line will be stripped before the message is processed and sent. For quicker access to preset messages if you use them and the keyboard a lot, you can therefore '''prefix your messages''' with a custom shortcut and a pipe, which will enable the automatic suggestion list to pull up the desired message line as you start typing the prefix. Here is a preset message example enabling something like a dot-command for sending a bearing to your airport to the currently selected pilot:
Everything up to the first pipe character (<code>|</code>, if any) in a text chat line will be stripped before the message is processed and sent. For quicker access to preset messages if you use them and the keyboard a lot, you can therefore '''prefix your messages''' with a custom shortcut and a pipe, which will enable the automatic suggestion list to pull up the desired message line as you start typing the prefix. Here is a preset message example enabling something like a dot-command for sending a bearing to your base airport to the currently selected pilot:
: <code>.qdm|Heading to airport $qdm</code>
: <code>.qdm|Heading to airport $qdm</code>


Line 234: Line 242:
* etc.
* etc.


In '''airport input fields''', typing a single dot will instantly fill the box with your ICAO position. Use this as a shortcut from/to your airport when filling details.
In airport mode, typing a single dot character '.' in an '''airport input field''' will instantly fill the box with your ICAO position. Use this as a shortcut from/to your airport when filling details.


Resolving '''strip–FPL conflicts''':
Resolving '''strip–FPL conflicts''':
Line 299: Line 307:
You are missing the FlightGear scenery data for your location, or ATC-pie does not know where it is. Check out the ''Tower viewing'' feature note in this article.
You are missing the FlightGear scenery data for your location, or ATC-pie does not know where it is. Check out the ''Tower viewing'' feature note in this article.


[[Category: ATC-pie]]
[[Category:ATC-pie]]
[[Category: ATC clients]]
[[Category:ATC clients]]
265

edits

Navigation menu