ATC-pie user guide: Difference between revisions

Jump to navigation Jump to search
v1.7.0
(v1.6.4)
(v1.7.0)
Line 1: Line 1:
{{forum|83|ATC-Pie support & development}}
{{forum|83|ATC-Pie support & development}}


This article is a guide to '''[[ATC-pie]]''', describing some of its major features. A more exhaustive list can be found in the main article. For download and installation help, refer to the [[ATC-pie installation guide]].
This article is a guide to the air traffic control simulation program [[ATC-pie]], describing some of its major features. A more exhaustive list can be found in the main article. For download and installation help, refer to the [[ATC-pie installation guide]].


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.
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.
Line 52: Line 52:
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.
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 you will need the [[scenery]] for your airport if you want anything exciting to see (and not sea!). Also, aircraft will only be drawn properly if the appropriate [[Aircraft|models]] are available. In multi-player, the models required are those flown by the players. For solo-simulated (AI) traffic and teacher-controlled aircraft, read about <code>icao2fgfs</code> in <code>CONFIG/acft/Notice</code> to understand how ATC-pie chooses models and liveries for its viewers. Aircraft and scenery locations can be filled in the ''System'' settings dialog if they are not in your [[$FG_ROOT|FlightGear root directory]].
'''Running internally''' only requires FlightGear installed on your computer. A basic installation is enough, but you will need the [[scenery]] for your airport if you want anything exciting to see (and not sea!). Also, aircraft will only be drawn properly if the appropriate [[Aircraft|models]] are available. In FlightGear sessions, the models required are those flown by the pilots. For all other session types, models are chosen according to the ICAO type designators of the aircraft and the specifications in <code>icao2fgfs</code>. Read <code>CONFIG/acft/Notice</code> to understand how ATC-pie chooses models and liveries for its viewers. Aircraft and scenery locations can be filled in the ''System'' settings dialog if they are not in your [[$FG_ROOT|FlightGear root directory]].


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. Of course, scenery, models and liveries must also be available to the running process.
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. Of course, scenery, models and liveries must also be available to the running process.
Line 83: Line 83:
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.


NB: In multi-player sessions, an appropriate text chat instruction is suggested for every registered vector. This allows you to send it easily, for example to pilots whose communications are limited to text chat.
NB: In network sessions, an appropriate text chat instruction is suggested for every mouse vectoring action. This allows you to send it easily, for example to pilots whose communications are limited to text chat.


=== Routes ===
=== Routes ===
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;
* ATC text chat, to exchange messages between connected ATCs (see ''Communications'' section);
* ATC text chat, to exchange messages between connected ATCs (see ''Communications'' section);
* ''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.
Line 218: Line 219:
See [https://www.youtube.com/watch?v=oQIud-cAlT4 tutorial video 6] for a presentation of the feature.
See [https://www.youtube.com/watch?v=oQIud-cAlT4 tutorial video 6] for a presentation of the feature.


=== Coexisting sub-systems in multi-player ===
=== FlightGear sessions and compatibility with OpenRadar ===
On multi-player session start, there are two "sub-systems" that can be activated. They differ in terms of provided features and interoperability with other clients:
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:
* the '''IRC sub-system''' allows full flexibility with other ATC-pie clients, but does not currently operate with other software;
* 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 '''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. If so, ATC-pie will try to choose the most appropriate system through which to send the strips on handovers.
=== OpenRadar interoperability ===
ATC-pie and OpenRadar's philosophies differ in several ways:
ATC-pie and OpenRadar's philosophies differ in several ways:
* OpenRadar's basic processing unit is the FGMS callsign, whereas ATC-pie's is the strip;
* OpenRadar's basic processing unit is the FGMS callsign, whereas ATC-pie's is the strip;
Line 242: Line 241:
* pie-to-pie handovers: strip detail preserved, whether present or absent.
* 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.
Features not supported by OpenRadar:
* wake turbulance category on strips (but detail preserved for ATC-pie instances later receiving the strip);
* ATC text messaging;
* CPDLC.
 
Note that who-has requests are fully supported.
 
=== FSD sessions and compatibility with Euroscope ===
Euroscope is a popular program to control on VATSIM, a flight simulation network which, although made incompatible with it today, is historically based on the FSD protocol. For a long time Euroscope allowed to connect to "plain" FSD servers, until it started being tailored more specifically for VATSIM, and closed the door to outside FSD connections. Older versions are still around, which ATC-pie is able to interact with, but only to a limited extent:
* 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");
* who-has requests will remain unanswered.
 
ATC-pie clients interact normally between each other, but note that CPDLC is not supported by the FSD protocol.


== Background images ==
== Background images ==
Line 258: Line 270:
ATC-pie comes with a couple of '''helper tools''' to create or import background images:
ATC-pie comes with a couple of '''helper tools''' to create or import background images:
# If you have a VATSIM/IVAO sector file for your area (.sct), the "extract drawings from sector file" option will translate the contained diagrams into ATC-pie drawings. While the generated files always require some filtering and post-editing, it is generally the best option for things like SID/STAR diagrams.
# If you have a VATSIM/IVAO sector file for your area (.sct), the "extract drawings from sector file" option will translate the contained diagrams into ATC-pie drawings. While the generated files always require some filtering and post-editing, it is generally the best option for things like SID/STAR diagrams.
# 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 <code>output</code> directory for you to copy from.
# 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 <code>OUTPUT</code> directory for you to copy from.
# An [[OpenStreetMap]] option will take you to the free online map server, centred on your radar centre position. For a quick and dirty start (e.g. for access to coastlines, borders and rivers) you can screenshot the map and use it as a background.
# An [[OpenStreetMap]] option will take you to the free online map server, centred on your radar centre position. For a quick and dirty start (e.g. for access to coastlines, borders and rivers) you can screenshot the map and use it as a background.


Line 272: Line 284:
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 not wear a headset. It will avoid picking up GUI sound notifications with your microphone while transmitting.


=== Public text chat ===
=== Radio text chat ===
ATC-pie has a powerful text chat system for those who use the keyboard extensively to interact with pilots in multi-player sessions, though of course voice radio communications should be encouraged for realism, whenever possible.
ATC-pie has a powerful text chat system for those who use the keyboard extensively to interact with pilots in network sessions, although voice communications should be encouraged for realism whenever possible.


First, '''text aliases''' are dollar-prefixed words that ATC-pie tries to replace with context-dependant values when sent. For example, <code>$metar</code> expands to the current primary station weather. This allows to write and save formatted messages instead of repeating chunks of a recurrent format. For instance, anybody will enjoy the comfort of sending "Current weather is $metar" instead of copy-pasting a weather look-up for every such message.
First, '''text aliases''' are dollar-prefixed words that ATC-pie tries to replace with context-dependant values when sent. For example, <code>$metar</code> expands to the current primary station weather. This allows to write and save formatted messages instead of repeating chunks of a recurrent format. For instance, anybody will enjoy the comfort of sending "Current weather is $metar" instead of copy-pasting a weather look-up for every such message.
Line 279: Line 291:
Aliases can be predefined or custom. Predefined aliases take values that are specified by the program, e.g. <code>$metar</code>, 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.
Aliases can be predefined or custom. Predefined aliases take values that are specified by the program, e.g. <code>$metar</code>, 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:
All other aliases will be considered custom, in other words to take values specified by you. You can define text aliases on three different levels:
* world (program user), in the general notes (notepad dock);
* world (saved for replacement anywhere that the program will be opened), in the general notes (notepad dock);
* location (airport/centre), in the local notes;
* location (saved for this airport or centre), in the local notes;
* individual (selected strip), in your strip comments.
* single aircraft contact (by selected strip), in the strip comments.


Here is how ATC-pie decides what to do with a text alias of the form <code>$foo</code> on chat message send:
Here is how ATC-pie decides what to do with a text alias of the form <code>$foo</code> on chat message send:
Line 297: Line 309:


=== 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 that pilots read. It offers '''private channels''' simulating one-to-one landline conversations, and a '''general ATC chat room''' in multi-player 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 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 305: Line 317:
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. Strip exchange and ATC text chat is possible, either between both parties ("offline" exchanges) or between the student and the virtual ATCs (in-sim coordination). All exchanges are monitored by the teacher, and transparent to the student. The teacher can also snapshot traffic position situations to recall them later.
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. Strip exchange and ATC text chat is possible, either between both parties ("offline" exchanges) or between the student and the virtual ATCs (in-sim coordination). All exchanges are monitored by the teacher, and transparent to the student. The teacher can also snapshot traffic position situations to recall them later.


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.
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 other 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''':
When '''playing teacher''':
265

edits

Navigation menu