ATC-pie installation guide: Difference between revisions

Jump to navigation Jump to search
v1.8.5
(+ Template:Key press)
(v1.8.5)
Line 25: Line 25:
For a 3D '''tower view''' in any airport session, ''[[FlightGear]]'' must be available, with the appropriate aircraft models and scenery data. Note that it can run on a separate machine, as explained [[#Airport scene rendering|down this article]].
For a 3D '''tower view''' in any airport session, ''[[FlightGear]]'' must be available, with the appropriate aircraft models and scenery data. Note that it can run on a separate machine, as explained [[#Airport scene rendering|down this article]].


To enhance solo sessions:
To enhance solo sessions with:
* with '''voice instruction recognition''' by the AI aircraft, install ''PocketSphinx'';
* '''voice instruction recognition''' by the AI aircraft, install ''PocketSphinx'' (requires ''PyAudio'');
* with '''speech synthesis''' of AI pilots' radio messages, install ''pyttsx''.
* '''speech synthesis''' of AI pilots' radio messages, install ''pyttsx''.


To enhance FlightGear and FSD sessions with an integrated '''ATC telephone switchboard''' (direct voice lines), install ''PyMumble''.
For an integrated '''ATC phone line switchboard''' (all sessions except solo), install ''PyAudio'', plus ''PyMumble'' for FlightGear and FSD sessions.


To enhance FlightGear sessions:
To enhance FlightGear sessions with:
* with '''[[CPDLC]]''' and '''full ATC coordination''' including unlimited strip exchange and text messaging, install the ''Python IRC library'' (recommended!);
* '''[[CPDLC]]''' and '''full ATC coordination''', including unlimited strip exchange and text messaging, install the ''Python IRC library'' (recommended!);
* with '''voice radio simulation''', install the ''FGCom-Mumble'' plugin (requires a ''Mumble''>=1.4 client) or the older ''standalone FGCom'' executable client (note that both variants cannot be used simultaneously).
* '''voice radio simulation''', install the ''FGCom-Mumble'' plugin (requires a ''Mumble''>=1.4 client) or the older ''standalone FGCom'' executable client (note that both variants cannot be used simultaneously).


== Running ==
== Running ==
Line 72: Line 72:
* callsigns for ATCs in FlightGear are 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...), e.g. "KORDgnd" (note that FGMS restricts callsign length to 7 characters);
* callsigns for ATCs in FlightGear are 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...), e.g. "KORDgnd" (note that FGMS restricts callsign length to 7 characters);
* before choosing your callsign, make sure it is not already in use;
* before choosing your callsign, make sure it is not already in use;
* you can connect more than one ATC-pie instance from the same computer, but must use different ports;
* you can connect multiple ATC-pie instances from the same computer, but you must use a different local port for each one;
* the three "sub-systems" that can be activated support different coordination features and differ in terms of interoperability with other clients, but all can be enabled together:
* the three "sub-systems" that can be activated support different coordination features and differ in terms of interoperability with other clients, but all can be enabled together:
** '''native ATC-pie coordination''' enables full interaction with other ATC-pie clients, but does not currently operate with other software;
** '''native ATC-pie coordination''' enables full interaction with other ATC-pie clients (except phone lines), plus CPDLC with FG aircraft;
** '''ATC phone lines''' system integrates direct voice (telephone) lines to other connected ATCs in the ATC coordination panel (also ATC-pie only);
** '''ATC phone lines''' enables direct voice communications (telephone calls) with other connected ATC-pie clients;
** '''OpenRadar handover compatibility''' implements [[OpenRadar]]'s native system to enable coordination with its users, although some limitations apply (see [[ATC-pie#FlightGear_sessions_and_compatibility_with_OpenRadar|interoperability note]] in the main article).
** '''OpenRadar handover compatibility''' implements [[OpenRadar]]'s protocol to enable coordination with its users (will work with ATC-pie clients as a fallback if native sub-system not available), although some limitations apply (see [[ATC-pie#OpenRadar|interoperability note]] in the main article).


== Configuring ==
== Configuring ==
Line 99: Line 99:
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 to listen for traffic and accept telnet 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 to listen for traffic and accept telnet 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 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]].
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.


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, {{key press|x}} / {{key press|Shift|x}} keys change the zoom level, etc.
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, {{key press|x}} and {{key press|Shift|x}} change the zoom level, etc.


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).
Line 116: Line 116:
[[File:ATC-pie-screenshot-backgroundHandDrawing.png|thumbnail|Hand drawing example with procedures for LSGG (Geneva, Switzerland)]]
[[File:ATC-pie-screenshot-backgroundHandDrawing.png|thumbnail|Hand drawing example with procedures for LSGG (Geneva, Switzerland)]]
Background images allow to decorate:
Background images allow to decorate:
* radar scopes, with all sorts of maps and useful information about the airspace, terrain or procedures;
* radar scopes, e.g. to display procedure maps or text annotations of the airspace;
* loose strip bays, to move unracked strips over custom backgrounds, e.g. ground charts of the airport.
* 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 for all purposes is to '''import pictures''' (pixmap files like JPEG or PNG, including transparency); the other for radar backgrounds consists in writing '''drawing specification''' files to paint coloured lines and labelled points. This allows to import anything from complex coloured height maps to schematic airspace outlines. The <code>CONFIG/bg/Notice</code> file explains how to import and draw background images.
There are two ways to create backgrounds in the program. One is to '''import pictures''' (pixmap files like JPEG or PNG, including transparency); the other consists in writing '''drawing specification''' files to paint coloured lines and labelled points (radar backgrounds only). This allows to import anything from complex pictures like terrain maps to schematic drawings like airspace boundaries. The <code>CONFIG/bg/Notice</code> file explains how to import and draw background images.


For example, you can map out procedures (SID, STAR, IAD...), grouping them by associated runways. Drawings are generally appropriate for that because specifications allow to directly refer to named points as per the published procedures, and therefore 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 so they toggle together on the radar. Drawings are generally appropriate for that because they avoid manual positioning by directly referring to the points named in the published procedures. But if you want more than schematic line plots and text labels, you should create the picture yourself, for example using an image processing tool like ''GIMP'' and a transparent layer over a real map canvas or a screenshot of your ATC-pie radar with pinned navaids as landmarks.


'''If you have a sector file''' of the format used in VATSIM/IVAO (.sct) for your area, you should try to import it with the "extract drawings from sector file" ''System'' menu tool. It will extract most of the contents around the open location up to the current map range, and translate it to ATC-pie's native drawing format. If you know they are included, it is generally the best option for things like SID/STAR procedures, although the generated files always require some filtering and post-editing. The way to proceed is as follows:
'''If you have a sector file''' of the format used in VATSIM/IVAO (.sct) for your area, you should try to import it with the "extract drawings from sector file" ''System'' menu tool. It will extract most of the contents around the open location up to the current map range, and translate it to ATC-pie's native drawing format. If you know they are included, it is generally the best option for things like SID/STAR procedures, although the generated files always require some filtering and post-editing. The way to proceed is as follows:
265

edits

Navigation menu