Spoken ATC: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
No edit summary
No edit summary
(30 intermediate revisions by 3 users not shown)
Line 1: Line 1:
rleibner is working on an '''atc.nas''' script, and it's time to share with you the beta version.
<!--
[[File:Spoken-ATC-Screenshot.jpg|thumb|Screenshot showing [[Spoken ATC]] in action.]]
-->
 
<!--
{{forum|71|Addons}}
-->
 
{{infobox subsystem
|image      = Spoken-ATC-Screenshot.jpg
|name        = Spoken ATC
|started    = 07/2017
|description = Spoken ATC
|status      = Under active development as of 07/2017
|maintainers = {{usr|Rodolfo}}
|developers  = Rodolfo (rleibner on the forum)
}}
 
[[Spoken ATC]] allows the pilot to listen to the directives of the ''Air Traffic Controller''.  
 
The module is not intended to compete with FGComm, Festival or other similar features.  
The module is not intended to compete with FGComm, Festival or other similar features.  
On the contrary, its use is indicated if these are not available (eg, few hardware resources, no Internet connection, etc.) <ref>{{cite web
On the contrary, it is meant to substitute them when these are not available (for example due to constrained hardware resources, no Internet connection, etc.)<ref>{{cite web
   |url    =  https://forum.flightgear.org/viewtopic.php?p=312968#p312968  
   |url    =  https://forum.flightgear.org/viewtopic.php?p=312968#p312968  
   |title  =  <nowiki>  ATC </nowiki>  
   |title  =  <nowiki>  ATC </nowiki>  
Line 10: Line 29:
   }}</ref>
   }}</ref>


== Preface ==
'''Typically''', you should tune the ATC-station frequency and make a request by pressing {{key press|<}} key. You may hear something like:


'''Spoken ATC''' allows the pilot to listen to the directives of the ''Air Traffic Controller''.
{{WIP|Although still incomplete, the information it contains is valid and available. |nocat=}}
= Preface =
'''Typically''', you should tune the ATC-station frequency and make a request by pressing "'''<'''" key. You may hear something like:<br />
<small>
<small>
* ''"Charlie X-ray Bravo Echo X-ray , this is Montevideo Carrasco International tower. QNH 1024 or 30 point 24 inches. Join left pattern Runway 1 9 and report."''
* ''"Charlie X-ray Bravo Echo X-ray , this is Montevideo Carrasco International tower. QNH 1024 or 30 point 24 inches. Join left pattern Runway 1 9 and report."''
</small>
</small>
So, you enter in the base leg and press "'''<'''" again:
So, you enter in the base leg and press {{key press|<}} again:
<small>
<small>
* ''"Charlie X-ray Bravo Echo X-ray , Wind 1 5 0 degrees, 3 knots. Runway 1 9 cleared to land."''
* ''"Charlie X-ray Bravo Echo X-ray , Wind 1 5 0 degrees, 3 knots. Runway 1 9 cleared to land."''
</small>
</small>
After landing and while you are braking, you press "'''<'''" once more:
After landing and while you are braking, you press {{key press|<}} once more:
<small>
<small>
* ''"Charlie X-ray Bravo Echo X-ray , Exit Runway at first taxiway and contact Ground 121 point 82."''
* ''"Charlie X-ray Bravo Echo X-ray , Exit Runway at first taxiway and contact Ground 121 point 82."''
</small>
</small>
That is only an example of standard '''VFR Phraseology'''
That is only an example of standard [[ATC phraseology|VFR Phraseology]] that you can expect from '''Spoken ATC'''.
<ref>{{cite web
 
  |url    =  http://wiki.flightgear.org/ATC_phraseology |title  =  wiki.flightgear.org/ATC_phraseology
== How to install ==
  }}</ref>
{{note |This is the latest version, v.2.2.4 (Apr 26, 2019) }}
that you can expect from '''Spoken ATC'''.<br />
Download this [[Addons|Addon]] from {{fgaddon source |path=Addons/SpokenATC |text=SourceForge}}. Read the [[FGAddon#Obtaining_aircraft|directions]] as a reference.
= How to install =
{{note |   This is the latest version, v.1.21 (Jul 9, 2017) }}
#- Download the [https://drive.google.com/file/d/0BzzojFuPdeyMTGNDYmZDcEljQkU/view?usp=sharing spoken_atc.zip]. There you will find a "''spoken_atc.nas''" file and a "''spoken_atc''" directory with 6 files inside.
#- Extract all into the ''[[$FG_HOME]]/Nasal'' directory '''(keeping the directory structure !)'''.
#- Edit the ''[[$FG_ROOT]]/keyboard.xml'' file and include the following lines in order to bind
<ref>{{cite web
  |url    = http://wiki.flightgear.org/Howto:Reassign_keyboard_bindings
  |title  = wiki.flightgear.org/Howto:Reassign_keyboard_bindings
  }}</ref>
the "'''<'''" key:
<syntaxhighlight lang="xml">
    <key n="60">
        <name>less-than</name>
        <desc>Spoken ATC</desc>
        <binding>
        <command>nasal</command>
        <script><![CDATA[
              atc.speak(15);
              ]]>
        </script>
        </binding>
    </key>
</syntaxhighlight>


And that's all !<br />
Start your FGFS session including <code>--addon=<your local path>/SpokenATC</code> in the command line or in the ''settings'' tab of the launcher.
If you prefer, you can bind an unused joystick button too.<br />


= How to use it =
== How to use it ==
Launch FlighGear (or re-start it) and tune Comm1 to an available ATC frequency (you can find them at ''Menu/Location/Airfield information''),
Launch FlighGear (or re-start it) and tune Comm1 to an available ATC frequency (you can find them at ''Menu/Location/Airfield information''),
and press the "'''>'''" key to transmit your request.<br />
and press the {{key press|<}} key to transmit your request.
 
You will hear the ATC's answer according the standard VFR phraseology, depending on your current position, weather and previous messages:
You will hear the ATC's answer according the standard VFR phraseology, depending on your current position, weather and previous messages:
* If you are on ground =>
* If you are on ground:
** The code interprets it's a taxi request (if you are far from the runway or you've just landed),
** The code interprets it's a taxi request (if you are far from the runway or you've just landed),
** or a take-off request (if you are on the correct Runway or at his holding point).
** or a take-off request (if you are on the correct Runway or at his holding point).
* If you are flying =>
 
* If you are flying:
** The code interprets it's an approach request (if you tunned an APP station),
** The code interprets it's an approach request (if you tunned an APP station),
** or a landing request (if you tunned a TWR station),
** or a landing request (if you tunned a TWR station),
** or a departure request (if you tunned a DEP station. and you are climbing after a take-off).<br />
** or a departure request (if you tunned a DEP station. and you are climbing after a take-off).
 
Note that only TWR stations can deliver landing or take-off clearances, and only GND or TWR stations can deliver taxiing ones.
 
Where there is not a specific GND or APP-DEP freq., TOWER can take their tasks.
 
If they do exist, TWR will redirect to the specific frequency.
 
 
Only at initial contact, the ATC message includes his station name & type, and the current QNH.


Note that only TWR stations can deliver landing or take-off clearances, and only GND or TWR stations can deliver taxiing ones.<br />
APP stations will give a vector to the runway threshold in use (if you are far from there) or order to contact TWR (if you are inside the CTR).
Where there is not a specific GND or APP-DEP freq., TOWER can take their tasks.<br />
If they do exist, TWR will redirect to the specific frequency.<br />


Only at initial contact, the ATC message includes his station name & type, and the current QNH.<br />
TWR stations will give instructions to join pattern or make direct final (depending on your position).
APP stations will give a vector to the runway threshold in use (if you are far from there) or order to contact TWR (if you are inside the CTR).<br />
TWR stations will give instructions to join pattern or make direct final (depending on your position).<br />
= Tips =


== Comming soon ==
Next version (under development now) includes 2 new features:
* User can toggle anytime between Comm1 and Comm2 by pressing {{key press|Alt}}{{key press|<}}
* Can request for a vector to the closest airport by pressing {{key press|Ctrl}}{{key press|Alt}}{{key press|<}}


== a realistic behavior ==
You can taste those facilities by replacing your '''voice.nas''' file with this one:
[https://www.dropbox.com/s/t60csb1pl7nblip/voice.nas?dl=1 next (beta) version]
 
 
== Tips ==
=== Heavy airplanes ===
To request a ILS runway, contact ATC using {{key press|Ctrl}}{{key press|<}}.
 
=== A realistic behavior ===
To achieve realistic behavior, follow a logical sequence of communications, viz.:
To achieve realistic behavior, follow a logical sequence of communications, viz.:
* Contact GND (or TWR) prior to taxiing.
* Contact GND (or TWR) prior to taxiing.
Line 89: Line 99:
*          etc, etc.
*          etc, etc.


== Phraseology customization == 
=== On screen voice ===
You can customize the phraseology by editing the "''phraseology.nas''" file (only lines 44 to 82, please!).<br />
If the writen messages bother you, when binding (see above) you can call the function as  
The file includes abundant commented lines to help you understand how to do it.<br />
Besides that, you can call the ''phrase_test()'' function at runtime to check your customization.<br />
=== phrase_test() function ===
You can ... [TODO]
== On screen voice ==
If the gui.popupTip() messages bother you, when binding (see above) you can call the function as  
<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
  <script> <![CDATA[ spoken_atc.speak(n); ]]> </script> </syntaxhighlight>
  <script> <![CDATA[ spoken_atc.speak(n); ]]> </script> </syntaxhighlight>
with '''n''' seconds you want, even 0 meaning no popupTip at all.<br />
with '''n''' seconds you want, even 0 meaning no messages at all.


<br />
== Phraseology customization ==
You can customize the phraseology by editing the <code>phraseology.xml</code> file.


There you can find groups of tags like:
<syntaxhighlight lang="xml">
    . . . .
  <foo type="string">Hello world. </foo>
  <foo type="string">It is a good </foo>
  <foo type="string">day </foo>
  <foo type="string">to fly. </foo>
    . . . .  </syntaxhighlight>
which will be read as a single sentence (''"Hello world. It is a good day to fly. "'').
=== Literals ===
Those in the example above are literal sentences that you can change by the strings you want.
{{note |
* You should not include either <code>"</code> or <code>'</code>.
* Punctuation is meaningfull. }}
=== Substitutions ===
Strings starting by <code>%</code> will call some '''property value'''.
In the example above replace <code>day</code> by <code>% /sim/startup/time-offset-type</code>.
Now the sentence will be read as ''"Hello world. It is a good morning to fly. "'' or ''"Hello world. It is a good evening to fly. "'' depending on the time.
{{note |
* The called property must be a string.}}
=== Concatenation ===
Strings starting by <code>~</code> will append the sentence with another one.
Try this:
<syntaxhighlight lang="xml">
    . . . .
  <short type="string">% /satc/callsign-fmt</short>
  <short type="string">, </short>
  <foo type="string">Have a nice fly, </foo>
  <foo type="string">~short</foo>
    . . . .  </syntaxhighlight>when calling ''foo'' you should hear ''"Have a nice fly, <your-callsign> , "''
=== Word Replacement ===
If you find that the word ''Wind'' is not pronounced clearly, you can change it by ''Winnded'' or similar to increase its intelligibility.
Better? Fine, but what about the message on the screen?
Include a tag with the pattern  <code><nowiki><replace type="string">'''old''':'''new'''</replace></nowiki></code>:
<syntaxhighlight lang="xml">
    . . . .
  <replace type="string">Winnded:Wind</replace>
    . . . .  </syntaxhighlight>
Besides that, you can call the <code>spoken_atc.say()</code> function at runtime to check your customization.
=== spoken_atc.say() function ===
You can ... [TODO]
  <big>And remember this is '''VFR''': heed the instructions of the ATC but '''keep your eyes wide open !'''</big>
  <big>And remember this is '''VFR''': heed the instructions of the ATC but '''keep your eyes wide open !'''</big>


= References =
== References ==
{{Appendix}}
{{Appendix}}
== Related content ==
=== Wiki articles ===
* [[ATC phraseology]]
* [[Howto:Implementing a simple GCA system]] - Ground Controlled Approaches
* [[Spoken GCA]]
=== Forum topics ===
* [https://forum.flightgear.org/viewtopic.php?f=30&t=32408 Spoken ATC]
[[Category:FlightGear add-ons]]
[[Category:Air Traffic Control]]

Revision as of 19:00, 4 June 2020


Spoken ATC
Spoken-ATC-Screenshot.jpg
Started in 07/2017
Description Spoken ATC
Maintainer(s) Rodolfo
Contributor(s) Rodolfo (rleibner on the forum)
Status Under active development as of 07/2017

Spoken ATC allows the pilot to listen to the directives of the Air Traffic Controller.

The module is not intended to compete with FGComm, Festival or other similar features. On the contrary, it is meant to substitute them when these are not available (for example due to constrained hardware resources, no Internet connection, etc.)[1]

Preface

Typically, you should tune the ATC-station frequency and make a request by pressing < key. You may hear something like:

  • "Charlie X-ray Bravo Echo X-ray , this is Montevideo Carrasco International tower. QNH 1024 or 30 point 24 inches. Join left pattern Runway 1 9 and report."

So, you enter in the base leg and press < again:

  • "Charlie X-ray Bravo Echo X-ray , Wind 1 5 0 degrees, 3 knots. Runway 1 9 cleared to land."

After landing and while you are braking, you press < once more:

  • "Charlie X-ray Bravo Echo X-ray , Exit Runway at first taxiway and contact Ground 121 point 82."

That is only an example of standard VFR Phraseology that you can expect from Spoken ATC.

How to install

Note  This is the latest version, v.2.2.4 (Apr 26, 2019)

Download this Addon from SourceForge. Read the directions as a reference.

Start your FGFS session including --addon=<your local path>/SpokenATC in the command line or in the settings tab of the launcher.

How to use it

Launch FlighGear (or re-start it) and tune Comm1 to an available ATC frequency (you can find them at Menu/Location/Airfield information), and press the < key to transmit your request.

You will hear the ATC's answer according the standard VFR phraseology, depending on your current position, weather and previous messages:

  • If you are on ground:
    • The code interprets it's a taxi request (if you are far from the runway or you've just landed),
    • or a take-off request (if you are on the correct Runway or at his holding point).
  • If you are flying:
    • The code interprets it's an approach request (if you tunned an APP station),
    • or a landing request (if you tunned a TWR station),
    • or a departure request (if you tunned a DEP station. and you are climbing after a take-off).

Note that only TWR stations can deliver landing or take-off clearances, and only GND or TWR stations can deliver taxiing ones.

Where there is not a specific GND or APP-DEP freq., TOWER can take their tasks.

If they do exist, TWR will redirect to the specific frequency.


Only at initial contact, the ATC message includes his station name & type, and the current QNH.

APP stations will give a vector to the runway threshold in use (if you are far from there) or order to contact TWR (if you are inside the CTR).

TWR stations will give instructions to join pattern or make direct final (depending on your position).

Comming soon

Next version (under development now) includes 2 new features:

  • User can toggle anytime between Comm1 and Comm2 by pressing Alt<
  • Can request for a vector to the closest airport by pressing CtrlAlt<

You can taste those facilities by replacing your voice.nas file with this one: next (beta) version


Tips

Heavy airplanes

To request a ILS runway, contact ATC using Ctrl<.

A realistic behavior

To achieve realistic behavior, follow a logical sequence of communications, viz.:

  • Contact GND (or TWR) prior to taxiing.
  • Contact TWR prior to take-off or land.
  • Contact DEP (if available) after take-off to leave the CTR.
  • Contact APP (if available) prior to enter the CTR.
  • etc, etc.

On screen voice

If the writen messages bother you, when binding (see above) you can call the function as

 <script> <![CDATA[ spoken_atc.speak(n); ]]> </script>

with n seconds you want, even 0 meaning no messages at all.

Phraseology customization

You can customize the phraseology by editing the phraseology.xml file.

There you can find groups of tags like:

    . . . . 
  <foo type="string">Hello world. </foo>
  <foo type="string">It is a good </foo>
  <foo type="string">day </foo>
  <foo type="string">to fly. </foo>
    . . . .

which will be read as a single sentence ("Hello world. It is a good day to fly. ").

Literals

Those in the example above are literal sentences that you can change by the strings you want.

Note
  • You should not include either " or '.
  • Punctuation is meaningfull.

Substitutions

Strings starting by % will call some property value. In the example above replace day by % /sim/startup/time-offset-type.

Now the sentence will be read as "Hello world. It is a good morning to fly. " or "Hello world. It is a good evening to fly. " depending on the time.

Note
  • The called property must be a string.

Concatenation

Strings starting by ~ will append the sentence with another one.

Try this:

    . . . . 
  <short type="string">% /satc/callsign-fmt</short>	
  <short type="string">, </short>

  <foo type="string">Have a nice fly, </foo>
  <foo type="string">~short</foo>
    . . . .

when calling foo you should hear "Have a nice fly, <your-callsign> , "

Word Replacement

If you find that the word Wind is not pronounced clearly, you can change it by Winnded or similar to increase its intelligibility.

Better? Fine, but what about the message on the screen? Include a tag with the pattern <replace type="string">'''old''':'''new'''</replace>:

    . . . . 
  <replace type="string">Winnded:Wind</replace> 
    . . . .


Besides that, you can call the spoken_atc.say() function at runtime to check your customization.

spoken_atc.say() function

You can ... [TODO]

And remember this is VFR: heed the instructions of the ATC but keep your eyes wide open !

References

References
  1. rleibner  (Jun 22nd, 2017).  ATC .

Related content

Wiki articles

Forum topics