ATC-pie user guide: Difference between revisions

Jump to navigation Jump to search
v1.8.0
(v1.7.1)
(v1.8.0)
Line 16: Line 16:


=== Filling details and linking ===
=== Filling details and linking ===
A click on the "new strip" tool bar button (shortcut F2) or double-click on an empty rack space will open a dialog to fill flight details on a fresh strip, e.g. destination, type of aircraft, etc. Double-clicking on an existing strip allows to edit the filled details.
A click on the "new strip" tool bar button (shortcut <code>F2</code>) or double-click on an empty strip rack or bay space will open a dialog to fill flight details on a fresh blank strip, e.g. destination, type of aircraft, etc. Double-clicking on an existing strip allows to edit the filled 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.
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 as the flight progresses.
A strip can also be linked to a filed flight plan (FPL). This will make radar and strip display fall back on filed information for missing details. The strip dialog also shows the mismatching information between the two, though this is rather common because the strip typically gets updated as the flight progresses.


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.
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:
For fast and efficient service, every initial contact by a pilot should basically make you hit <code>F2</code> and type the callsign announced. You should then soon figure out if:
* a flight plan is already filed: a matching FPL count is displayed near the callsign field as you type, if any (click on the button to view them);
* a flight plan is already filed: a matching FPL count is displayed near the callsign field as you type, if any (click on the button to view them);
* 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;
* 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;
Line 31: Line 31:


=== Strip placeholders ===
=== 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.
ATC-pie provides with three types of placeholders for flight strips: ''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.


[[File:ATC-pie-screenshot-stripRacks.png|thumbnail|Strip rack panel]]
[[File:ATC-pie-screenshot-stripRacks.png|thumbnail|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. Rack panels can be created from the main window workspace, popped out as separate windows, and a persistent one can be found among the available docks. You can create as many racks as you wish and name them appropriately. Double click on the rack name to edit its properties. Use mouse drag to move strips up and down a rack sequence.
A '''strip rack''' is the preferred way of keeping track of a sequence, e.g. a departure queue at a runway threshold. Rack panels can be created from the main window workspace, popped out as separate windows, and a persistent one can be found among the available docks. You can create as many racks as you wish in every panel. Double click on a rack's name to rename it or edit its properties. Use mouse drag to move strips up and down a rack sequence.


A '''loose strip bay''' allows free-hand positioning of strips in its reserved space. Such bays are 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 <code>CONFIG/bg-img/Notice</code> to learn how.
A '''loose strip bay''' allows free-hand positioning of strips in its reserved space. Such bays are useful for 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 <code>CONFIG/bg-img/Notice</code> to learn how.


[[File:ATC-pie-screenshot-runwayReserved.png|thumbnail|Reserved runway marked in yellow]]
[[File:ATC-pie-screenshot-runwayReserved.png|thumbnail|Reserved runway marked in yellow]]
A '''runway box''' is a placeholder for a single strip, named after a runway and denoting a clearence to use it (enter, cross, land...). Runway boxes are contained in their own dock, and made visible if a corresponding runway is marked in use. Thorough use of runway boxes will help you avoid bad mistakes like clear an aircraft to land over lined up traffic. When freed, runway boxes start and display a timer together with the wake turbulance category of the last contained strip to help with TKOF/LDG separation. What is more, if you use radar, a filled runway box marks the runway as ''reserved'' on the scope.
A '''runway box''' is a placeholder for a single strip, named after a physical runway and denoting a clearence to use it (enter, cross, land...). Runway boxes are contained in their own dock, with one made visible for each runway marked as in use in either direction. Thorough use of runway boxes will help you avoid bad mistakes like clear an aircraft to land over lined up traffic. When freed, runway boxes start and display a timer together with the wake turbulance category of the last contained strip to help with TKOF/LDG separation. What is more, if you use radar, a filled runway box marks the runway as ''reserved'' on the scope.


Besides, there are two other places a strip can be dropped on, usually when releasing a contact:
Besides, there are two other places a strip can be dropped on, usually when releasing a contact:
* a connected ATC to initiate a handover;
* an ATC callsign in the ATC panel to initiate a handover;
* a '''strip shelf''' (flat button at the bottom of loose and racked strip panels), which clears the strip from your work bench and stores it as shelved.
* a '''strip shelf''' (flat button at the bottom of loose and racked strip panels), which clears the strip from your workbench and stores it as shelved.


== Airport scene rendering ==
== Airport scene rendering ==
Line 59: Line 59:


=== Additional scene views ===
=== Additional scene views ===
You can hook up '''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 from the ''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 <code>CONFIG/Notice</code>), read at start-up and on explicit reload (''System'' menu).
You can hook up '''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 from the ''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 <code>CONFIG/Notice</code>) 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 <code>--multiplay=out,TTT,HHH,PPP</code> and <code>--multiplay=in,TTT,,YYY</code>, where:
Every such viewer registered on host ''XXX'' and port ''YYY'' should be running on ''XXX'' and started with options <code>--multiplay=out,TTT,HHH,PPP</code> and <code>--multiplay=in,TTT,,YYY</code>, where:
Line 70: Line 70:
ATC-pie can register and analyse issued vectors and routes to:
ATC-pie can register and analyse issued vectors and routes to:
* inform strip and radar display;
* inform strip and radar display;
* help monitor traffic, checking against vectors;
* help monitor traffic, checking tracked positions against route/vector assignments;
* anticipate route and FL conflicts between controlled aircraft.
* help manage traffic, anticipating route and FL conflicts between controlled aircraft.


=== Vectors ===
=== Vectors ===
Line 77: Line 77:
Registering vectors on strips enhances the drawing of linked radar contacts, enables easy monitoring of tracks and detection of aircraft flying off course. To register vectors automatically when a radar contact is linked to a strip, use the following mouse gestures:
Registering vectors on strips enhances the drawing of linked radar contacts, enables easy monitoring of tracks and detection of aircraft flying off course. To register vectors automatically when a radar contact is linked to a strip, use the following mouse gestures:
* click and drag out of a radar contact to issue a heading vector;
* click and drag out of a radar contact to issue a heading vector;
* hold SHIFT, click and drag vertically for altitude/FL vectors;
* holding <code>SHIFT</code>, click and drag vertically for altitude/FL vectors;
* hold SHIFT, click and drag horizontally for speed instructions;
* holding <code>SHIFT</code>, click and drag horizontally for speed instructions;
* hold SHIFT and double-click to clear registered vecors from the linked strip.
* holding <code>SHIFT</code>, double-click on the radar target to clear registered vecors from the linked strip.


See [https://www.youtube.com/watch?v=BvA3MRlGJjU video 5] of the tutorial for more on vectoring, and check the quick reference ''display conventions'' to interpret the lines and colours of the course and vector graphics around radar contacts.
See [https://www.youtube.com/watch?v=BvA3MRlGJjU video 5] of the tutorial for more on vectoring, and check the quick reference ''display conventions'' to interpret the lines and colours of the course and vector graphics around radar contacts.
Line 102: Line 102:
** 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.
** 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 both DEP and ARR airports are not identified, radar tags show the strip destination detail if it is filled, possibly with a heading if it is recognised.
NB: If DEP and ARR airports are not both recognised, radar tags show the strip destination detail if it is filled, possibly with a heading if it is recognised.


See tutorial [https://www.youtube.com/watch?v=LfdukpBc90w video 7] for a demonstration of routes.
See tutorial [https://www.youtube.com/watch?v=LfdukpBc90w video 7] for a demonstration of routes.
Line 193: Line 193:
* instruct taxi routes by dragging out of radar contacts when they are considered on the ground (low enough or squawking GND);
* 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;
* the dockable instruction panel works regardless of voice vs. mouse selection;
* if the aircraft is connected to CPDLC, you can choose to be prompted to send the instruction through the data link (see ''General settings'' dialog, CPDLC tab).
* alternatively, if the aircraft is connected to CPDLC, you can send instructions through the data link (see ''Mouse gestures'' in the quick reference, combining the <code>ALT</code> key).


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.
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.
Line 209: Line 209:
"ATC coordination" refers to the following:
"ATC coordination" refers to the following:
* strip exchange, i.e. sending and receiving strips (handovers);
* strip exchange, i.e. sending and receiving strips (handovers);
* CPDLC transfers between ATCs;
* CPDLC authority transfers;
* ATC text chat, to exchange messages between connected ATCs (see ''Communications'' section);
* voice land lines (direct phone calls);
* ''who-has'' requests, to query the system and know who is claiming contact/control of callsigns.
* ''who-has'' requests, to query the system and know who is claiming contact/control of callsigns;
* ATC text chat, to exchange messages between connected ATCs (see ''Communications'' section).


=== Strip exchange ===
=== Strip exchange ===
Line 220: Line 221:


=== FlightGear sessions and compatibility with OpenRadar ===
=== FlightGear sessions and compatibility with OpenRadar ===
On FlightGear session start, there are two "sub-systems" that can be activated for coordination. They differ in terms of supported features and interoperability with other clients:
On FlightGear session start, there are three "sub-systems" that can be activated for coordination. They differ in terms of supported features and interoperability with other clients:
* the '''IRC sub-system''' enables all coordination features with other ATC-pie clients, but does not currently operate with other software (recommended in all cases);
* the '''IRC sub-system''' enables all coordination features with other ATC-pie clients, but does not currently operate with other software;
* the '''PyMumble land lines''' enable direct voice (telephone) lines to other connected ATCs in the ''ATC coordination'' panel (also ATC-pie only);
* the '''OpenRadar handover service''' is [[OpenRadar]]'s native system, which ATC-pie implements to enable coordination with its users, but some limitations apply (see below).
* the '''OpenRadar handover service''' is [[OpenRadar]]'s native system, which ATC-pie implements to enable coordination with its users, but some limitations apply (see below).
Both systems can be enabled together.
Both systems can be enabled together.
Line 244: Line 246:
* wake turbulance category on strips (but detail preserved for ATC-pie instances later receiving the strip);
* wake turbulance category on strips (but detail preserved for ATC-pie instances later receiving the strip);
* ATC text messaging;
* ATC text messaging;
* phone land lines;
* CPDLC.
* CPDLC.


Line 252: Line 255:
* sending a strip to Euroscope will result in a loss of all strip details but the callsign (which must be connected), the only information left to the recipient being the FPL details for that callsign if any (strip changes made after FPL data retrieval are therefore lost);
* sending a strip to Euroscope will result in a loss of all strip details but the callsign (which must be connected), the only information left to the recipient being the FPL details for that callsign if any (strip changes made after FPL data retrieval are therefore lost);
* receiving a strip from Euroscope is supported, but the sender will see the hondover pending (never "assumed");
* receiving a strip from Euroscope is supported, but the sender will see the hondover pending (never "assumed");
* who-has requests will remain unanswered by Euroscope.
* who-has requests will remain unanswered by Euroscope;
* there are no integrated phone land lines to Euroscope clients.


ATC-pie clients interact normally between each other, but note that CPDLC is not supported by the FSD protocol.
ATC-pie clients interact normally between each other for all coordination purposes listed above, but note that CPDLC is not supported by the FSD protocol (so there will be no transfers).


== Background images ==
== Background images ==
Line 282: Line 286:
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.
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 if you not wear a headset. It will avoid picking up GUI sound notifications with your microphone while transmitting.
The '''''PTT turns off sounds''''' option is recommended if you do not wear a headset. It will avoid picking up GUI sound notifications with your microphone while transmitting.


=== Radio text chat ===
=== Radio text chat ===
Line 309: Line 313:


=== ATC text chat ===
=== ATC text chat ===
The ATC text messaging system allows to talk to other ATCs in channels that are separate from the public one read by pilots. It offers '''private channels''' simulating one-to-one landline conversations, and a '''general ATC chat room''' in network sessions, readable by all connected ATCs.
The ATC text messaging system allows to talk to other ATCs in channels that are separate from the public one read by pilots. It offers '''private channels''' simulating one-to-one landline conversations, and a '''general ATC chat room''' in network sessions, readable by all connected ATCs. Note however that ATC-pie features a direct voice (phone) land line switching system for a lot more realistic coordination between human ATCs!


'''Note on interoperability''': While only ATC-pie integrates ATC-side text chat in its interface, other users can join the same channel with an IRC client. They will be able to send and receive public and private messages and chat with everybody, at the only cost of ignoring the system messages that will sometimes appear on their side. For best results, they should use their FlightGear network callsign as their IRC nickname.
'''Note on interoperability''': While only ATC-pie integrates ATC-side text chat in its interface, other users can join the same channel with an IRC client. They will be able to send and receive public and private messages and chat with everybody, at the only cost of ignoring the system messages that will sometimes appear on their side. For best results, they should use their FlightGear network callsign as their IRC nickname.
Line 323: Line 327:
* 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.
* 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.
* You may pause the whole simulation, or freeze each aircraft individually. Frozen aircraft will result in stationary flights on the student's radar.
* The ATC text chat system allows to simulate landline conversations with the student (select ATC callsign to interact as), or to speak to the student directly as the teacher.
* The ATC text chat system allows to chat to the student directly as the teacher, and to simulate landline conversations with the student (select ATC callsign to interact as).
* To exchange strips, drop them on "Student" and select whom the strip should appear from on the student's side. Note that for your convenience in further control of the traffic, teacher strips do not disappear on handovers.
* To exchange strips, drop them on "Student" and select whom the strip should appear from on the student's side. Note that for your convenience in further control of the traffic, teacher strips do not disappear on handovers.


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

edits

Navigation menu