ATC-pie user guide: Difference between revisions

Jump to navigation Jump to search
v 1.5.0
(v1.4.1)
(v 1.5.0)
Line 25: Line 25:


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 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 is already filed (the matching FPL count displays a non-zero value near the callsign field as you type): click on the button to select one 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;
* 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;
* he was asked to contact you by a previous ATC, in which case you may have a strip handed over to you already;
Line 49: Line 49:
=== Tower view window ===
=== Tower view window ===
[[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 (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.
This feature allows you to overlook your airport and the connected (multi-player) 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.
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 simulated aircraft (AI traffic in solo games and teacher-controlled aircraft), read about <code>icao2fgfs</code> in <code>resources/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 multi-player, the models required are those flown by the players. For simulated aircraft (AI traffic in solo-simulated and teacher-controlled aircraft), read about <code>icao2fgfs</code> in <code>resources/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 66: Line 66:
* ''TTT'' is the network polling frequency (100 is common practice; change as desired if you know what you are doing).
* ''TTT'' is the network polling frequency (100 is common practice; change as desired if you know what you are doing).


== Routes and separation warnings ==
== Vectors, routes and separation warnings ==


ATC-pie analyses routes and assigned vectors to anticipate conflicts between controlled aircraft.
ATC-pie can register and analyse issued vectors and routes to:
* inform radar display and help monitor traffic, checking against
* anticipate conflicts between controlled aircraft.
 
=== Vectors ===
[[File:ATC-pie-screenshot-courseAndAssignmentsGraphics.png|thumbnail|Course/vector drawing for linked radar contact]]
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 (and suggest the appropriate text chat instruction), use the following mouse gestures:
* click and drag out of a radar contact to issue a heading vector;
* hold SHIFT, click and drag vertically for altitude/FL vectors;
* hold SHIFT, click and drag horizontally for speed instructions;
* hold SHIFT and double-click 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 drawn on the radar contact.


=== Routes ===
=== Routes ===
Line 113: Line 125:
== Playing solo ==
== 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:
In solo sessions, 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;
* as an en-route controller (CTR) if started in centre mode;
* or in airport mode, where four combinable positions are available:
* or in airport mode, where four combinable positions are available:
Line 174: Line 186:
[[File:ATC-pie-screenshot-taxiInstructionTool.png|thumbnail|Click&drag taxi instruction tool at OMDB ground]]
[[File:ATC-pie-screenshot-taxiInstructionTool.png|thumbnail|Click&drag taxi instruction tool at OMDB ground]]
'''Instructions''' are given through different means:
'''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 <code>Ctrl</code> key as push-to-talk and standard phraseology (see the quick reference tab about it);
* provided the speech recognition modules are installed, you can turn on voice instructions from the solo simulation settings dialog and instruct aircraft through your microphone, using the <code>Ctrl</code> key as push-to-talk and standard phraseology (see the quick reference tab about it);
* if voice instructions are turned off:
* 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 [https://www.youtube.com/watch?v=BvA3MRlGJjU video 5] of the tutorial);
** mouse vector assignments issue the corresponding instructions (see section on vectors above);
** handoffs are issued when dropping strips on an ATC receiver;
** 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);
* instruct taxi routes by dragging out of radar contacts when they are considered on the ground (low enough or squawking GND);
Line 190: Line 202:
* CTR mode with a low ceiling to increase the number of conflicts to resolve;
* CTR mode with a low ceiling to increase the number of conflicts to resolve;
* etc.
* 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) ==
== ATC strip exchange (handovers) ==
Line 212: Line 207:
=== Sending and receiving strips ===
=== Sending and receiving strips ===
[[File:ATC-pie-screenshot-receivedStrip.png|thumbnail|Example of a strip received from "DEL"]]
[[File:ATC-pie-screenshot-receivedStrip.png|thumbnail|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 [https://www.youtube.com/watch?v=oQIud-cAlT4 tutorial video 6] for a presentation of the feature.
To hand a strip over, drag it and drop it on the recipient in the list of connected controllers. Received strips appear 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. They may link automatically to identified radar contacts, according to the auto-link configuration (general settings).


Received strips appear 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. They may link automatically to identified radar contacts, according to the auto-link configuration (general settings).
Check [https://www.youtube.com/watch?v=oQIud-cAlT4 tutorial video 6] for a presentation of the feature.
 
=== Coexisting sub-systems in multi-player ===
On multi-player session start, there are two "sub-systems" that can be activated to enable strip exchange. They differ in terms of interoperability with other clients:
* the '''IRC sub-system''' allows full flexibility with other ATC-pie clients (e.g. exchanging unlinked strips), but does not currently operate with any other software;
* the '''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. If so, ATC-pie will try to choose the most appropriate system through which to send the strips on handovers.


=== OpenRadar interoperability ===
=== 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:
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;
* 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;
* 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 and write a callsign on it;
* 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.
* in OpenRadar, a handover must be acknowledged by the receiver for the sender to lose ownership and for all neighbouring users to see it complete, whereas ATC-pie considers that a strip sent is gone and assumed to land on the receiver's rack, 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 apply:
For most interactions to work while respecting both approaches as much as possible, the following principles and restrictions apply:
* ATC-pie users can only hand over strips that are linked to a radar contact (no lone strip can be sent);
* ATC-pie users can only hand over strips that are linked to a radar contact;
* aircraft under ATC-pie control are not shown as "owned" to OpenRadar users;
* aircraft under ATC-pie control are not shown as "owned" to OpenRadar users;
* handovers from ATC-pie will fail if an OpenRadar user is claiming ownership on the linked radar contact;
* handovers from ATC-pie will fail if an OpenRadar user is claiming ownership on the linked radar contact;
Line 247: Line 249:
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.
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:
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.
# 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.
# 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 <code>output</code> 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.
# 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.
# 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 post-editing, it is generally the best option for things like SID/STAR diagrams.


== Communications ==
== Communications ==
The features described in this section do not apply to solo sessions, where text sending is disabled and voice radio interaction is dealt with through speech recognition and synthesis (see the appropriate section above).


=== FGCom radio ===
=== FGCom radio ===
Line 261: Line 265:
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.


=== Text chat ===
=== Public 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.
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.


First, '''text aliases''' are dollar-prefixed words (like <code>$foo</code>) 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 <code>Current weather is $metar</code>, whose alias will expand to the current primary station weather, instead of typing or copy-pasting a weather look-up for every such message.
First, '''text aliases''' are dollar-prefixed words (like <code>$foo</code>) 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 <code>Current weather is $metar</code>, whose alias will expand to the current primary station weather, instead of typing or copy-pasting a weather look-up for every such message.
Line 283: Line 287:
: <code>.qdm|Heading to airport $qdm</code>
: <code>.qdm|Heading to airport $qdm</code>


Lastly, if a troll or angry user is polluting your session with undesired messages, 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.
Lastly, if a troll or angry user is polluting your session with undesired messages, 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.
 
=== 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.
 
'''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.
 
== 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. 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.
 
When '''playing teacher''':
* The teaching console dock is enabled, which allows you to control most aspects of the environment visible to the student.
* 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.
* 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.
* 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