FlightGear wiki - User contributions [en]

Mumble

2019-03-19T01:03:43Z

Jester: Added section about binding Push-To-Talk to joystick button on linux

{{Infobox Software
| title = Mumble
| logo =
| image =
| alt =
| developedby = Various
| initialrelease = 2005
| latestrelease = 1.2.19 (stable)
| writtenin = C++
| os = Windows, OS X, Linux, Android, iOS
| platform = PC, Mac, smartphones
| developmentstatus =
| developmentprogress =
| type = Voice chat software
| license = [https://github.com/mumble-voip/mumble/blob/master/LICENSE Open source]
| website = http://wiki.mumble.info/wiki/Main_Page
}}

'''Mumble''' is a free, open source VoIP software used by some ATCs and pilots on the multiplayer network.

== Installation and configuration ==
# Download Mumble from its [http://wiki.mumble.info/wiki/Main_Page official website] (choose the links from the ''Stable Release'' column). If you're on Linux, you can usually install it using your package manager.
# Start it and follow the instructions on your screen to configure the program.
{{tip|We suggest to choose the '''Push-To-Talk''' mode in the '''Voice Activity Detection''' step; if you choose another mode, make sure to calibrate the volume levels correctly (follow the on-screen instructions carefully). This way, your voice will be transmitted only when you mean to, and there will be less background noise on the channel.}}

=== Binding '''Push-To-Talk''' to joystick button on linux ===

On linux you can enable generic input support by editing <code>~/.config/Mumble/Mumble.conf</code>. You need to add the following section:

<syntaxhighlight lang="ini" enclose="div">
[shortcut]
linux\evdev\enable=true
</syntaxhighlight>

Make sure you have permission to access the input devices (typically called <code>/dev/input/event*</code>). You might need to add yourself to the appropriate group (for example <code>input</code>) or configure your device manager to grant access. Consult your OS documentation for details. {{Tip|<code>input-events</code> is a useful tool for troubleshooting.}}

Proceed to launch mumble. If you are using a terminal, watch the output messages. You should see your input device listed, such as:

<code>GlobalShortcutX: /dev/input/event7: Saitek Cyborg Evo Force</code>

Open the settings dialog, go to the shortcuts tab and assign any button you like to the <code>Push-to-Talk</code> function.
{{Note|It may show up as nonsense but that is just a cosmetic issue. For example, one of my joystick buttons appears as {{button|semicolon}}. Nevertheless, it's still the joystick button and typing semicolon on the keyboard has no effect.}}

== Connecting ==
<ol>
<li>Click on {{Menu item|Server|Connect}}.</li>
<li>If this is the first time you connect to the FlightGear Mumble server, click on {{button|Add New...}} at the bottom of the window and input the following parameters, then click {{button|OK}}:
{| class="wikitable"
|-
| '''Label'''
| <tt>FlightGear ATC</tt> (or another descriptive name of your choice)
|-
| '''Address'''
| <tt>itpns.ddns.net</tt>
|-
| '''Port'''
| <tt>64738</tt> (the default value)
|-
| '''Username'''
| A username (callsign) of your choice
|}</li>
<li>Select '''FlightGear ATC''' from the server list and click {{button|Connect}}.</li>
</ol>

== Using Mumble ==
When you are connected, Mumble will show a hierarchical list of channels on the right side of the main window.
* To enter an existing channel, right click on it and choose {{Menu item|Join Channel}}.
* To create a new channel (e.g. if you're acting as a controller), right click on the ''FlightGear'' channel and choose {{Menu item|Add}}. Input a name and (optionally) a description, then click {{button|OK}}.
{{note|The new channel is temporary and will be deleted when the last person in it exits the channel.}}
* To mute yourself, click the {{button|Mute}} button in the main toolbar.

== OpenRadar flickering when using Mumble ==
If you're using Mumble and OpenRadar at the same time, you might notice that the OpenRadar screen flickers. A solution is disabling the Mumble overlay (in Mumble, click on {{Menu item|Configure|Settings}}, open the '''Overlay''' section, deselect '''Enable Overlay''' and click {{button|OK}}).

[[Category:Air Traffic Control]]
[[Category:Software]]

FlightGear Git

2011-06-21T23:20:14Z

Jester: /* fgdata.bundle */ updated instructions for new bundle version

{{FlightGearGitOn}}
'''Git''' is a version control system used by the [[FlightGear]] project to store all of the files required to build FlightGear, as well as data (mainly [[aircraft]]). Git tracks updates to every file as developers around the world work together concurrently to create new versions.

While new FlightGear features and additions are in development, they are available from Git before they are available in the standard release version. Using Git allows a user to build the newest possible version of FlightGear from the latest source files, to experiment with new aircraft or other features. However, it's not a beginner's tool. Using Git can expose the user to unstable features that show ugly error messages, or crash the computer.

In May 2010, after a hardware failure on the [[CVS]] servers, the FlightGear project changed version control system from CVS to Git. The Git repositories are located at [http://gitorious.org/fg Gitorious] and at the [http://mapserver.flightgear.org/git/?p=fgdata;a=summary Mapserver].

Due to the "recent" switch, we are currently doing our best on providing manuals for obtaining FlightGear through Git. The following articles are work in progress:
* '''Mac OS X:''' [[FlightGear Git on Mac OS X]]
* '''Windows:''' [[FlightGear Git on Windows]]

== Motivation ==
Much has been written on the advantages of Git over CVS. For us, some advantages are:
* Much better support for branches and merging branches. This is especially important for creating bug-fix releases for major releases while still allowing work on the next major release to continue. It is also very nice for a developer's personal workflow.
* Easier path for contributors to submit changes and developers to integrate them;
* Much better support for everyday tasks like searching the project history for changes, viewing changes, bisecting the project history to find the original source of a bug.

Also, as noted before, the CVS servers had a hardware failure on May 2010, speeding up FlightGear's change to Git.

== Repositories and Branches ==
For historical reasons there continue to be separate repositories for SimGear and FlightGear '''source'''. For most users and developers the most interesting ones of each are:

* <tt>next</tt> The current tip of new development. This branch should always compile and run, but various things could be broken.
* <tt>release/*</tt> The branch subdirectory containing former and, if there is one, upcoming releases.
For other available branches have a look at our [http://gitorious.org/fg/flightgear#more repository] at gitorious.org. The following two branches are as of now (May 2011) very much out of date. '''Do not use'''.
* <tt>master</tt> The tip of stable, tested new features. If we were to make a new release today, we would start from the tip of this branch. New features that have been "cooking" in the <tt>next</tt> branch for a few days or weeks will be merged here.
* <tt>maint</tt> Bug fixes for the most recently released Flightgear. When a release is made from <tt>master</tt>, this branch is reset to it.

FlightGear '''data''''s branches of interest are:
* <tt>master</tt> The one that is used with the <tt>next</tt> branch of the source.
* <tt>release/*</tt> Same as for the source.

This arrangement follows the scheme used by the Git maintainers.
[http://www.kernel.org/pub/software/scm/git/docs/howto/maintain-git.txt This description] is very technical; you will surely have achieved git-fu if completely understand it. However, the idea of maintaining several branches of different stability is common in collaborative software projects.

== Clone and handle Repositories ==
=== Quick checkout ===
# Check on gitorious for valid projects: http://gitorious.org/fg
# Cloning Simgear
# Cloning FlightGear
# Cloning FGData

By default you will be checking out the <tt>next</tt> branch of SimGear and FlightGear and the <tt>master</tt> branch of FGData. This is probably what you want if you want to assist with reporting bugs and the like before they are release as a proper release version.

=== For dummies ===
Some basic git commands on how to clone, update and handle local git repositories. Except the initial ''git clone'' for each repository all commands have to be executed from within the ''target'' folder. 

==== Cloning SimGear ====
;<code>git clone git://gitorious.org/fg/simgear.git [target]</code>
: the folder ''target'' will be created and a clone of the SimGear repo stored inside it. If no ''target'' is given the new folder's name is <code>simgear</code>.

'''<code>cd</code>''' into the new folder. You are then inside the ''working tree'' of this git repo. The repo itself is stored inside the subfolder <tt>.git</tt>, which we mustn't edit manually. Git will take care of that.

;<code>git branch</code>
: will show the active [[FlightGear and Git#Repositories and Branches|branch]]. Right after download this will be <tt>* next</tt>, that means the content of the ''working tree'' is the bleeding edge of SimGear's source code.
:;<code>git branch -a</code>
:: will list all branches of a git repository. The one marked with an asterisk (*) is the active one.

;<code>git checkout master</code>
: will change the active [[FlightGear and Git#Repositories and Branches|branch]] to <tt>master</tt>. Means, that the content of the ''working tree'' will be changed to that state.

:;<code>git checkout v2.0.0</code>
:: will activate the state of the code inside the <tt>master</tt> branch at the time FG 2.0.0 was released.
:;<code>git tag</code>
:: will show all tags of the history of the active branch.

;<code>git pull</code>
: will update the local repo from the remote one.

==== Cloning FlightGear ====
Except for the initial clone command this is identic to [[FlightGear and Git#Cloning SimGear|Cloning SimGear]].
;<code>git clone git://gitorious.org/fg/flightgear.git [target]</code>
To successfully compile <code>fgfs</code> Flight- and SimGear's ''working tree'' must have the same state.

==== Cloning fgdata ====
At the time of writing the data repository is about ''3.4 GB''. Continuing an interrupted cloning of a repository is '''not supported''' with git. Therefore, if you have a slow or unstable connection to the internet, it is recommended to download the [[FlightGear and Git#fgdata.bundle|fgdata.bundle]].

Also have in mind, that the repository plus the ''working tree'' will be more than twice the size of the download on your local filesystem.

There is neither a <tt>next</tt> branch nor any tags in that repository. If you want to build FlightGear 2.0.0 you may fetch the data (FlightGear-data-2.0.0.tar.bz2) at one of the [http://flightgear.org/mirrors.html mirrors].

;<code>git clone git://mapserver.flightgear.org/fgdata/ [target]</code>
: if no ''target'' is given the new folder's name is <tt>fgdata</tt>
'''<code>cd</code>''' into the new directory and verify it's state with '''<code>git branch</code>'''. If it isn't <tt>* master</tt>, do a '''<code>git checkout master</code>'''.

==== Local Branch ====
To make individual changes, like editing a joystick file or add a plane to fgdata or patch the source code, it is recommended to create a local branch inside that repository. The following commands will describe a way to achieve this. But have in mind, that this is very basic and only suits for users who have minor changes.

'''<code>cd</code>''' into the repositories folder, e.g. fgdata:
;<code>git checkout -b master.local master</code>
: a new branch <tt>master.local</tt> is created out of the <tt>master</tt> branch and set as the active one. You may now apply your individual stuff there and start FlightGear to verify the changes are propper.

If you conclude they are, you have to tell git about those changes:
;<code>git status</code>
: will give you a list of files that have been altered or that are new.

;<code>git add -i</code>
: will show the files that have been altered and give you options on what to do next. <code>git add</code> does not actually add the changes to ''master.local'' but adds them to the ''index''.
: '''<tt>[a]dd</tt>''' will add new paths/files (called ''untracked'' in status) from the ''working tree'' to the ''index''. This has to be done only if you have added paths/files, like an aircraft, to the ''working tree''.
: If git finds more than one ''untracked'' file/path, it will give you a numbered list and prompt to select which ones should be added. An empty input will exit this mode. See "Interactive mode" in [http://www.kernel.org/pub/software/scm/git/docs/git-add.html man git add] for more details.
: '''<tt>[u]pdate</tt>''' is the next step and will update the altered and ''tracked'' files to the index in the same manner as explained in <tt>add</tt> untracked paths above.
;<code>git commit</code>
: will commit the ''indexed'' updates to the ''master.local'' branch. It opens a list of the updates in your standard editor. You may add a comment to that file describing the object of the commit. Save and exit the editor. You have now commited your changes inside the ''working tree'' to your personal branch.

To update that personal branch from the remote one do the following steps:
git checkout master # switch to master branch
git pull # update it
git checkout master.local # switch back to the individual branch
git rebase master # update it

==== Some more helpful commands ====
;<code>git help</code>
;<code>git help [commad]</code>
;<code>git apply</code>
: apply a patch to files and/or to the index http://www.kernel.org/pub/software/scm/git/docs/git-apply.html
;<code>git checkout -f</code>
: may be used to throw away any local changes to the ''working tree''. Use with care, as any option that name is <tt>-f</tt> or <tt>--force</tt>, and only after reading <code>git checkout help</code>!

=== fgdata.bundle ===
For the FlightGear-data there are also bundles (snapshots) available that can be retrieved with your favourite download manager. This way you can resume interrupted downloads. After unpacking only a comparatively small amount of data has to be transferred from the git server to synchronize your repository.

Download the bundle from
$ wget http://flightgear.mxchange.org/pub/fgfs/fgdata.bundle

The bundle may be periodically updated and bundles from different sources need not be the same. The file size for the above bundle dated 2011-05-27 is 3607494099, while the md5 checksum is
$ md5sum fgdata.bundle
3ddb025053fc395323ae708816555551 fgdata.bundle

Do the following steps to extract the bundle and bring the repository up to date:
$ git clone fgdata.bundle fgdata
Initialized empty Git repository in fgdata/.git/
warning: unrecognized header: -deg" - /orientation/roll += "-deg" - /position/altitude += "-ft" - /position/altitude-agl += "-ft" - /position/latitude += "-deg" - /position/longitude += "-deg" [...]
$ cd fgdata
$ git checkout -b master-tmp
Switched to a new branch 'master-tmp'
$ git remote rm origin
$ git remote add origin git://gitorious.org/fg/fgdata
$ git fetch origin
remote: Counting objects: 5011, done.
remote: Compressing objects: 100% (2206/2206), done.
remote: Total 3512 (delta 1948), reused 2321 (delta 1239)
Receiving objects: 100% (3512/3512), 161.20 MiB | 474 KiB/s, done.
Resolving deltas: 100% (1948/1948), completed with 698 local objects.
From git://gitorious.org/fg/fgdata
* [new branch] PRE_OSG_PLIB_20061029 -> origin/PRE_OSG_PLIB_20061029
* [new branch] master -> origin/master
* [new branch] releases/2.2.0 -> origin/releases/2.2.0
* [new tag] last-cvs -> last-cvs
* [new tag] mapserver -> mapserver
From git://gitorious.org/fg/fgdata
* [new tag] last-cvs -> last-cvs
* [new tag] mapserver -> mapserver
$ git branch --track master origin/master
Branch master set up to track remote branch refs/remotes/origin/master.
$ git checkout master
Checking out files: 100% (1117/1117), done.
Switched to branch 'master'
$ git branch -D master-tmp
Deleted branch master-tmp.

If you get an error at '''<code>git fetch origin</code>''' try:
$ git remote rm origin
$ git remote add origin git://mapserver.flightgear.org/fgdata/
$ git fetch origin
You should be suspicious if based on the printed progress you estimate the data download during the fetch will exceed 1GB (assuming the bundle is not terribly outdated).

For future updates just do a '''<code>git pull</code>'''.

== External links ==
=== Git tutorials and resources ===
* Git [http://git-scm.com/documentation documentation and tutorials]
* Git as a [http://tomayko.com/topics/git way of life].
* The [https://git.wiki.kernel.org/index.php/GitCheatSheet Git Cheat Sheet] and the [http://jan-krueger.net/development/git-cheat-sheet-extended-edition Git Cheat Sheet Extended Edition]
* [http://wiki.github.com/bogolisk/egg Egg], a cool Git emacs mode.
* A guide to [http://nathanj.github.com/gitguide/ using Git on Windows]
* [http://kylecordes.com/2008/04/30/git-windows-go/ Git on Windows Go!] (Setting up msysgit on Windows)
* [http://gitcasts.com/posts/git-on-windows Git on Windows (webcast)]
* [http://sourceforge.net/projects/qgit qgit - interactive git repository viewer and frontend]
* Additional [[Resources WRT running git on Win32]]

{{Building}}

[[Category:FlightGear]]

Howto:Implement generic tyre smoke

2011-02-15T15:19:03Z

Jester: Removed cleanup required notice

[[Image:Tyre smoke 727-230.jpg|thumb|270px|Tyre smoke, as seen on a [[Boeing 727-230]] at touchdown.]]
'''Tyre smoke''' often refers to the smoke that is visible when an [[aircraft]] touches down. This arises when stationary wheels hit the ground at high speeds; a little layer of rubber is burned due to the friction between the tyre and the runway.

Following this [[:Category:Howto|howto]], you will be able to add tyre smoke when landing and spray when it is raining to your aircraft. The here explained method works with both [[YASim]] and [[JSBSim]].

The examples below are for a 3-point-gear, but you can use more gears of course!

===Nasal/tyresmoke.nas===

Create a folder in <tt>[[$FG_ROOT]]/Aircraft/''YourAircraft''</tt> called ''Nasal'', if not already there.
Create a file called tyresmoke.nas with the following lines inside:

<syntaxhighlight>
#============================ Tyre Smoke ===================================
aircraft.tyresmoke_system.new(0, 1, 2);
#============================ Rain ===================================
aircraft.rain.init();
var rain = func {
aircraft.rain.update();
settimer(rain, 0);
}
# == fire it up ===
rain()
# end
</syntaxhighlight>

Pass the indices of gears you would like to produce smoke.

=== -set.xml ===
Insert the following code before the <sim>-tag or below </sim>-tag in your aircraft's -set.xml file. Not between them!

<syntaxhighlight lang="xml">
<gear>
<gear n="0">
<tyre-smoke type="int">0</tyre-smoke>
<sprayspeed-ms type="double">0</sprayspeed-ms>
<spray-density type="double">0</spray-density>
<caster-angle-deg-damped type="double">0</caster-angle-deg-damped>
</gear>
<gear n="1">
<tyre-smoke type="int">0</tyre-smoke>
<sprayspeed-ms type="double">0</sprayspeed-ms>
<spray-density type="double">0</spray-density>
</gear>
<gear n="2">
<tyre-smoke type="int">0</tyre-smoke>
<sprayspeed-ms type="double">0</sprayspeed-ms>
<spray-density type="double">0</spray-density>
</gear>
</gear>
</syntaxhighlight>

At the bottom of the file, add the link to the nasal-file, between the <nasal> and </nasal> tags.

<syntaxhighlight lang="xml">
<tyresmoke>
<file>Aircraft/''YourAircraft''/Nasal/tyresmoke.nas</file>
</tyresmoke>
</syntaxhighlight>

=== Models/ .model.xml ===
Insert the following lines into your animation.xml in your Models-Folder and change the ccordinates so it matches with your gear.
This are examples for a 3-point-gear- it links to the Aircraft/Generic/Effects-folder.

You can create of course your own Effect-file if you want. Just regard the correct link!

<syntaxhighlight lang="xml">
<model>
<path>Aircraft/Generic/Effects/tyre-smoke-nose.xml</path>
<name>tyre-smoke-n</name>
<offsets>
<x-m>-4.669</x-m>
<y-m>0</y-m>
<z-m>-2.484</z-m>
</offsets>
</model>

<model>
<path>Aircraft/Generic/Effects/tyre-smoke-port.xml</path>
<name>tyre-smoke-p</name>
<offsets>
<x-m>7.962</x-m>
<y-m>-2.634</y-m>
<z-m>-2.784</z-m>
</offsets>
</model>

<model>
<path>Aircraft/Generic/Effects/tyre-smoke-stbd.xml</path>
<name>tyre-smoke-s</name>
<offsets>
<x-m>7.962</x-m>
<y-m>2.634</y-m>
<z-m>-2.784</z-m>
</offsets>
</model>
</syntaxhighlight>

Now you have tyre-smoke when landing, and spray when it is raining on your aircraft!

[[Category:Aircraft enhancement|Implement generic tyre smoke]]
[[Category:Howto|Implement generic tyre smoke]]

Howto:Implement generic tyre smoke

2011-02-15T15:17:30Z

Jester: /* Nasal/tyresmoke.nas */ updated for new tyresmoke_system

{{cleanup}}
Do not use the instructions for now. A nasal cleanup is coming shortly. --[[User:Papillon81|Papillon81]] 05:33, 14 February 2011 (EST)

[[Image:Tyre smoke 727-230.jpg|thumb|270px|Tyre smoke, as seen on a [[Boeing 727-230]] at touchdown.]]
'''Tyre smoke''' often refers to the smoke that is visible when an [[aircraft]] touches down. This arises when stationary wheels hit the ground at high speeds; a little layer of rubber is burned due to the friction between the tyre and the runway.

Following this [[:Category:Howto|howto]], you will be able to add tyre smoke when landing and spray when it is raining to your aircraft. The here explained method works with both [[YASim]] and [[JSBSim]].

The examples below are for a 3-point-gear, but you can use more gears of course!

===Nasal/tyresmoke.nas===

Create a folder in <tt>[[$FG_ROOT]]/Aircraft/''YourAircraft''</tt> called ''Nasal'', if not already there.
Create a file called tyresmoke.nas with the following lines inside:

<syntaxhighlight>
#============================ Tyre Smoke ===================================
aircraft.tyresmoke_system.new(0, 1, 2);
#============================ Rain ===================================
aircraft.rain.init();
var rain = func {
aircraft.rain.update();
settimer(rain, 0);
}
# == fire it up ===
rain()
# end
</syntaxhighlight>

Pass the indices of gears you would like to produce smoke.

=== -set.xml ===
Insert the following code before the <sim>-tag or below </sim>-tag in your aircraft's -set.xml file. Not between them!

<syntaxhighlight lang="xml">
<gear>
<gear n="0">
<tyre-smoke type="int">0</tyre-smoke>
<sprayspeed-ms type="double">0</sprayspeed-ms>
<spray-density type="double">0</spray-density>
<caster-angle-deg-damped type="double">0</caster-angle-deg-damped>
</gear>
<gear n="1">
<tyre-smoke type="int">0</tyre-smoke>
<sprayspeed-ms type="double">0</sprayspeed-ms>
<spray-density type="double">0</spray-density>
</gear>
<gear n="2">
<tyre-smoke type="int">0</tyre-smoke>
<sprayspeed-ms type="double">0</sprayspeed-ms>
<spray-density type="double">0</spray-density>
</gear>
</gear>
</syntaxhighlight>

At the bottom of the file, add the link to the nasal-file, between the <nasal> and </nasal> tags.

<syntaxhighlight lang="xml">
<tyresmoke>
<file>Aircraft/''YourAircraft''/Nasal/tyresmoke.nas</file>
</tyresmoke>
</syntaxhighlight>

=== Models/ .model.xml ===
Insert the following lines into your animation.xml in your Models-Folder and change the ccordinates so it matches with your gear.
This are examples for a 3-point-gear- it links to the Aircraft/Generic/Effects-folder.

You can create of course your own Effect-file if you want. Just regard the correct link!

<syntaxhighlight lang="xml">
<model>
<path>Aircraft/Generic/Effects/tyre-smoke-nose.xml</path>
<name>tyre-smoke-n</name>
<offsets>
<x-m>-4.669</x-m>
<y-m>0</y-m>
<z-m>-2.484</z-m>
</offsets>
</model>

<model>
<path>Aircraft/Generic/Effects/tyre-smoke-port.xml</path>
<name>tyre-smoke-p</name>
<offsets>
<x-m>7.962</x-m>
<y-m>-2.634</y-m>
<z-m>-2.784</z-m>
</offsets>
</model>

<model>
<path>Aircraft/Generic/Effects/tyre-smoke-stbd.xml</path>
<name>tyre-smoke-s</name>
<offsets>
<x-m>7.962</x-m>
<y-m>2.634</y-m>
<z-m>-2.784</z-m>
</offsets>
</model>
</syntaxhighlight>

Now you have tyre-smoke when landing, and spray when it is raining on your aircraft!

[[Category:Aircraft enhancement|Implement generic tyre smoke]]
[[Category:Howto|Implement generic tyre smoke]]

Nasal scripting language

2011-02-07T22:21:29Z

Jester: /* setprop() */ Fixed list example and added note about slash separator

''Please note that a considerable amount of resources has not yet been incorporated here, you can check these out by going to the "[http://wiki.flightgear.org/index.php/Talk:Nasal_scripting_language discussion]" page, where we are collecting links to webpages and mailing list discussions/postings related to Nasal.''

==Nasal = Not another scripting language!==

[[FlightGear]] offers a very powerful functional scripting language called [http://plausible.org/nasal/ "Nasal"], which supports reading and writing of internal [[Property Tree Intro|FlightGear properties]], accessing internal data via extension functions, creating GUI dialogs and much more.

It uses some of the concepts of ECMA/JavaScript, Python and Perl and implements a simple but complete way of Object Oriented Programming.

Nasal code can be run by aircraft configuration files, and it can be embedded in various [[XML]] files (dialog files, animation files, bindings for joysticks, keyboard and cockpit controls, and even in [[Howto: Nasal in scenery object XML files|scenery objects]]). Nasal is platform independent.

As of 03/2009, there were approximately 170.000 lines of reported Nasal source code in the FlightGear base package [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg21333.html], compared to 2006 this is almost a rate of growth of 600% within 3 years [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg01728.html]. This illustrates the sheer adoption rate Nasal is experiencing in FlightGear.

Note that this page is mostly about FlightGear-specific APIs/extension functions and usage patterns.
* [http://plausible.org/nasal/lib.html core language/library documentation]
* [http://plausible.org/nasal/sample.nas annotated source code examples]
* [http://plausible.org/nasal/doc.html Nasal design document]
* [http://www.plausible.org/nasal/flightgear.html a helpful tutorial about using Nasal in FlightGear].

In addition, the [http://cvs.flightgear.org/viewvc/data/Nasal/ Nasal directory] in the FlightGear base package contains a wealth of tested, proven and usually well-commented source code that you may want to check out for additional examples of using the Nasal scripting language in FlightGear [http://cvs.flightgear.org/viewvc/data/Nasal/].

If you have any Nasal specific questions, you will want to check out the [[Nasal FAQ]], feel free to ask new questions or help answer or refine existing ones. If you would like to learn more about existing Nasal modules in FlightGear, you may want to check out [[Nasal Modules]].

If you are a developer and interested in extending Nasal, you may want to check out [[Howto:Extending Nasal]].

== Creating new Scripts ==
Generally, aircraft specific Nasal scripts reside in the corresponding aircraft's folder (or a corresponding /Nasal subfolder) where they are usually included by adding a corresponding <nasal> tag to the aircraft-set.xml file (see [http://wiki.flightgear.org/index.php/Writing_simple_scripts_in_%22nasal%22]), while instrument specific scripts are saved within the instrument's folder (as previously mentioned, Nasal scripts can also be embedded in various other XML files), nasal scripts driving shared instruments are generally stored in [[$FG_ROOT]]/Aircraft/Generic/

Nasal scripts that are not specific to certain aircraft, instruments or other uses, generally reside in the system-wide [[$FG_ROOT]]/Nasal directory.

Nasal scripts need to be plain text files, saved with a *.nas extension.

Nasal scripts that are placed inside [[$FG_ROOT]]/Nasal (with a *.nas extension) are automatically loaded and run during FlightGear startup, a simple hello world example would be:

# hello.nas
print('Hello World!');

This will show the "Hello World" string during startup in the console window. The pound sign (#) just introduces comments.

Note: Script-specific symbols such as global variables (or functions) will be put into a scope (namespace) based on the script's name, scripts embedded via aircraft-set.xml files can separately specify a corresponding module name (see [[Howto: Make an aircraft]] for details).

Strings in Nasal can also use double quotes which support escaping:
# hello.nas
print("Hello\nWorld!");

Double quotes support typical escape sequences:
* \n
* \r
* \t
* \xnn
* \"
Single quotes treat everything as literal except for embedded single quotes (including embedded whitespace like newlines).

Nasal strings are always arrays of bytes (never characters: see the utf8 library if you want character-based equivalents of substr() et. al.). They can be indexed just like in C (although note that there is no nul termination -- get the length with size()):

Note that there is currently no way to tell FlightGear to reload Nasal scripts from the global Nasal directory at runtime, so in order to see changes take effect, you will have to exit and restart FlightGear for the time being.

Also, note that as of 05/2009, Nasal in FlightGear does not yet support any form of dependency resolution. In other words, there's no "import", "require" or "include" directive - this is also why most code in FlightGear is wrapped inside a _setlistener() call instead, which in turn waits for a FlightGear signal before executing the code (see below for details).

== Variables ==
Nasal scripts should make use of the var keyword when declaring variables. The "var" keyword makes a variable guaranteed to be local. Nasal, natively provides support for scalars (numbers, strings), lists (arrays, vectors) and hashes (objects or dictionaries):

var w=100; # w is a local numerical variable
var x="hello"; # x is a local string variable
var y=[]; # y is a local vector (array)
var z={}; # z is a local hash (dictionary or table) - also used for OOP

Nasal supports a "nil" value for use as a null pointer equivalent:

var foo=nil;

Also, note that Nasal symbols are case-sensitive, these are all different variables:

var show = func(what) {print(what,"\n");}
var abc=1; # these are all different symbols
var ABC=2; # different from abc
var aBc=3; # different from abc and ABC

show(abc);
show(ABC);
show(aBc);

Please note that functions assigned to variables are no exception. If you write code without using "var" on variables, then you risk (often hard to debug) breakage at a later time because you may be overwriting symbols in another namespace.

So functions bound to variables should use the "var" keyword as well:

var hello = func {
print("hello\n");
}

But there's another reason why "var" should be used consequently, even if a variable is safe enough from later side effects, because it has a relatively specific or unique name: The "var" keyword makes
reading code for others (and for the author after some time) easier, as it makes clear: "this variable starts its life *HERE*". No need to search around to see whether assigning a value to it means something to other code outside or not. Also, with an editor offering proper syntax highlighting reading such code is actually easier, despite the "noise".

The problem with nasal code that does not make use of the var keyword is, that it can break other code, and with it the whole system, but no Nasal error message will point you there, as it's syntactically and semantically correct code. Just doing things that it wasn't supposed to do.
For a more in-depth discussion, please see [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg13557.html].

Also, Nasal scripts that are loaded from $FG_ROOT/Nasal are automatically placed inside a namespace that is based on the script's name.

For example, referring to our earlier "Hello World" example, global variables defined in the hello.nas script would be accessible by using "hello" as prefix from other modules:

# hello.nas
var greeting="Hello World"; # define a greeting symbol inside the hello namespace

If you were now to read out the value from the greeting variable from another Nasal module, you would have to use the hello prefix:

# greetme.nas
print(hello.greeting); # the hello prefix is referring to the hello namespace (or module).

== Variables - Advanced Uses ==

Nasal, also supports Multi-assignment expressions. You can assign more than one variable (or lvalue) at a time by putting them in a parenthesized list:

(var a, var b) = (1, 2);
var (a, b) = (1, 2); # Shorthand for (var a, var b)
(var a, v[0], obj.field) = (1,2,3) # Any assignable lvalue works
var color = [1, 1, 0.5];
var (r, g, b) = color; # works with runtime vectors too

Vectors (lists or arrays) can be created from others using an ordered list of indexes and ranges.
This is usually called "vector slicing".
For example:

var v1 = ["a","b","c","d","e"]
#
var v2 = v1[3,2]; # == ["d","c"];
var v3 = v1[1:3]; # i.e. range from 1 to 3: ["b","c","d"];
var v4 = v1[1:]; # no value means "to the end": ["b","c","d","e"]
var i = 2;
var v5 = v1[i]; # runtime expressions are fine: ["c"]
var v6 = v1[-2,-1]; # negative indexes are relative to end: ["d","e"]

The range values can be computed at runtime (e.g. i=1; v5=v1[i:]). Negative indices work the same way they do with the vector functions (-1 is the last element, -2 is 2nd to last, etc...).

== Functions ==
As previously shown, Nasal functions are implemented using the func keyword:

var log_message = func {
print(arg[0]);
}

By default, arguments are passed in the "arg" array, not unlike perl.
Note that this is just an assignment of an (anonymous) function argument to the local "log_message" variable. There is no function declaration syntax in Nasal.

Also, Nasal being a functional programming language, all passed arguments will be local to the corresponding scope. If you want to modify state in a function, you'll preferably return new state to the caller.

You can also pass named arguments to a function, thus saving the typing and performance costs of extracting them from the arg array:

var log_message = func(msg) {
print(msg);
}

Also, Nasal functions can be easily nested, for example:

var calculate = func(param1,param2,operator) {
var add = func(p1,p2) {p1+p2;}
var sub = func(p1,p2) {p1-p2;}
var mul = func(p1,p2) {p1*p2;}
var div = func(p1,p2) {p1/p2;}
if (operator=="+") return add(param1,param2);
if (operator=="-") return sub(param1,param2);
if (operator=="*") return mul(param1,param2);
if (operator=="/") return div(param1,param2);
}

Note that the add,sub,mul and div functions in this example do not make use of an explicit return statement, instead the result of each expression is implicitly returned to the caller.
Nasal functions that just consist of such simple expressions can also be further simplified to read:

var add = func(val1,val2) val1+val2;

Function arguments can have default values, as in C++. Note that the default value must be a scalar (number, string, function, nil) and not a mutable composite object (list, hash).

var log_message = func(msg="error") {
print(msg);
}

Any extra arguments after the named list are placed in the "arg" vector as above. You can rename this to something other than "arg" by specifying a final argument name with an ellipsis:

listify = func(elements...) { return elements; }
listify(1, 2, 3, 4); # returns a list: [1, 2, 3, 4]

Also, Nasal supports Call-by-name function arguments.
You can specify a hash literal in place of ordered function arguments, and it will become the local
variable namespace for the called function, making functions with many arguments more readable.

log_message(msg:"Hello World!");
view_manager.lookat(heading:180, pitch:20, roll:0, x:X0, y:Y0, z:Z0,time:now, fov:55);

Declared arguments are checked and defaulted as would be expected: it's an error if you fail to pass a value for an undefaulted argument, missing default arguments get assigned, and any rest parameter (e.g. "func(a,b=2,rest...){}") will be assigned with an empty vector.

Note that Nasal functions can generally not be overloaded, and that operator overloading in particular is also not supported.

As previously mentioned, arguments to a Nasal function can also be functions themselves (Nasal being a functional programming language), this means that Nasal functions are higher order functions so that you can easily pass and return functions to and from Nasal functions. This can for example be used to dynamically create new functions (such functions are commonly called 'generators'):

# a function that returns a new custom function
var i18n_hello = func(hello) {
return func(name) { # returns an anonymous/unnamed function
print(hello,name);
}
}

# create three new functions
var english_hello = i18n_hello("Good Day ");
var spanish_hello = i18n_hello("Buenos Dias ");
var italian_hello = i18n_hello("Buon giorno ");

# actually call these functions
english_hello("FlightGear");
spanish_hello("FlightGear");
italian_hello("FlightGear");

== Conditionals ==

Nasal has no "statements", which means that any expression can appear in any context. This means that you can use an if/else clause to do what the ?: does in C.
The last semicolon in a code block is optional, to make this prettier

abs = func(n) { if(n<0) { -n } else { n } }

But for those who don't like typing, the ternary operator works like you expect:

abs = func(n) { n < 0 ? -n : n }

In addition, Nasal supports braceless blocks, like they're known from C/C++ and other languages:

var foo=1;
if (foo)
print("1\n");
else
print("0\n");
print("this is printed regardless\n")

Nasal's binary boolean operators are "and" and "or", unlike C. unary not is still "!" however.
They short-circuit like you expect

var toggle = 0;
var a = nil;
if(a and a.field == 42) {
toggle = !toggle; # doesn't crash when a is nil
}

== Loops ==

Nasal has several ways to implement an iteration.

Nasal's looping constructs are mostly C-like:

for(var i=0; i < 3; i = i+1) {
# loop body
}

while (condition) {
# loop body
}

The differences are that there is no do{}while(); construct, and there is a foreach, which takes a local variable name as its first argument and a vector as its second:

foreach(elem; list1) { doSomething(elem); }

The hash/vector index expression is an lvalue that can be assigned as well as inspected:

foreach(light; lights) { lightNodes[light] = propertyPath; }

There is also a "forindex", which is like foreach except that it assigns the index of each element, instead of the value, to the loop variable.

forindex(i; list1) { doSomething(list1[i]); }

Also, braceless blocks work for loops equally well:

var c=0;
while( c<5 )
print( c+=1 );
print("end of loop\n");

However, loops using <tt>while</tt>, <tt>for</tt>, <tt>foreach</tt>, and <tt>forindex</tt> block all of FlightGear's subsystems that run in the main thread, and can, thus, only be used for instantaneous operations that don't take too long.

For operations that should continue over a longer period, one needs a non-blocking solution. This is done by letting functions call themselves after a timed delay:

var loop = func {
print("this line appears once every two seconds");
settimer(loop, 2);
}

loop(); # start loop

Note that the <tt>settimer</tt> function expects a ''function object'' (<tt>loop</tt>), not a function call (<tt>loop()</tt>) - unless of course the function call returns a function object.

The fewer code FlightGear has to execute, the better, so it is desirable to run loops only when they are needed. But how does one stop a loop? A once triggered timer function can't be revoked. But one can let the loop function check an outside variable and refuse calling itself, which makes the loop chain die off:

var running = 1;
var loop = func {
if (running) {
print("this line appears once every two seconds");
settimer(loop, 2);
}
}

loop(); # start loop ...
...
running = 0; # ... and let it die

Unfortunately, this method is rather unreliable. What if the loop is "stopped" and a new instance immediately started again? Then the ''running'' variable would be ''1'' again, and a pending old loop call, which should really finish this chain, would happily continue. And the new loop chain would start, too, so that we would end up with two loop chains.

This can be solved by providing each loop chain with a ''loop identifier'' and letting the function end itself if the id doesn't match the global loop-id. Self-called loop functions need to inherit the chain id. So, every time the global loop id is increased, all loop chains die, and a new one can immediately be started.

var loopid = 0;
var loop = func(id) {
id == loopid or return; # stop here if the id doesn't match the global loop-id
...
settimer(func { loop(id) }, 2); # call self with own loop id
}

loop(loopid); # start loop
...
loopid += 1; # this kills off all pending loops, as none can have this new identifier yet
...
loop(loopid); # start new chain; this can also be abbreviated to: loop(loopid += 1);

== OOP - Object Oriented Programming ==

In Nasal, objects ("classes") are regular hashes. Self-reference and inheritance are implemented through special variables <tt>me</tt> and <tt>parents</tt>. To get a better understanding of the concept, let's start with the very basics.

=== Hashes ===

Hashes, also known as "dictionaries" in Python or "maps" in C++/STL are data structures that hold key/value pairs in a way that allows quick access to a value via its key.

var airport = {
"LOXZ": "Zeltweg",
"LOWI": "Innsbruck",
"LOXL": "Linz Hoersching", # the last comma is optional
};

print(airport["LOXZ"]); # prints "Zeltweg"
airport["LOXA"] = "Aigen"; # adds LOXA to the hash

The quotes around keys can be left away in a hash definition if the key is a valid variable name or a number. This works just as well:

var airport = {
LOXZ: "Zeltweg",
};

There's also an alternative way to access hash members if the keys are valid variable names: <tt>airport.LOXI</tt> can be used instead of <tt>airport["LOXI"]</tt>. There is a difference, though, which is described in the next section.

Note that assigning a hash (or a vector) to another variable does never ''copy'' the contents. It only creates another reference to the same data structure. So manipulating the hash via its new name does in fact change the one, original hash.

var a = airport;
a.LOXL = "Linz"; # same as airport.LOXL!
print(airport.LOXL); # prints now "Linz", not "Linz Hoersching"

(True copies of vectors can be made by assigning a full slice: <tt>var copy = vec[:]</tt>. There's no such method for hashes.)

=== Self-reference: "<tt>me</tt>" ===

Values stored in a hash can be of any type, even of type ''function''. Member functions ("methods") can reference their own enclosing hash via reserved keyword <tt>me</tt>. This is comparable to the <tt>this</tt> keyword in C++ classes, or the <tt>self</tt> keyword in Python.

var value = "test";

var data = {
value: 23, # scalar member variable
write1: func { print(value); }, # function member
write2: func { print(me.value); }, # function member
};

data.write1(); # prints "test"
data.write2(); # prints 23

The above example is already a simple form of an object. It has its own variable namespace (''data''), its own methods, and it can be passed around by-reference as one unit. Such classes are sometimes called ''singleton classes'', as they are unique, with no independent class instances. They mostly serve as a way to keep data and methods nicely encapsulated within a Nasal module. Often they contain a method for initializing, which is usually called <tt>init</tt>.

=== Inheritance: "<tt>parents</tt>" ===

What we learned about <tt>me</tt> in the last section is only half the truth. "me" doesn't only reference an object's own hash, but also one or more parent hashes. <tt>parents</tt> is another reserved keyword. It denotes a vector referencing other object hashes, which are "inherited" that way.

Please note that Nasal's currently supported form of encapsulation does not provide support for any form of data/information hiding (restricting access), i.e. all hash fields (but also all hash methods) are always publicly accessible (so there's nothing like the "private" or "protected" keywords in C++: in this sense, Nasal's inheritance mechanism can be thought of like C++ structs which are also public by default).

var parent_object = {
value: 123,
};

var object = {
parents: [parent_object],
write: func { print(me.value) },
};

object.write(); # prints 123

Even though <tt>object</tt> itself doesn't contain a member <tt>value</tt>, it finds and uses the one of its parent object. <tt>parents</tt> is a vector that can contain several parent objects. These are then searched in the order from left to right, until a matching member variable or method is found. Each of the parents can itself have parents, which are all recursively searched.

In the section about hashes it was said that hash members can be accessed in two alternative ways, and that's also true for methods. <tt>object.write()</tt> could also be called as <tt>object["write"]()</tt>. But only in the first form will members also be searched in parent hashes if not found in the base hash, whereas the second form creates an error if it's not a direct member.

=== Creating class instances ===

With <tt>me</tt> and <tt>parents</tt> we can implement a class object and create independent instances from that:

var Class = {
write: func { print(me.value); },
increment: func { me.value += 1; },
};

var instance1 = { parents: [Class], value: 123 };
var instance2 = { parents: [Class], value: 456 };

instance1.write(); # prints 123
instance2.write(); # prints 456

As you can see, the two class instances are separate, independent objects, which share another object as parent -- they "inherit" from object <tt>Class</tt>. One can now easily change members of any of these three objects. The following will redefine the parent's <tt>write</tt> method, and all instances will automatically use this new version:

Class.write = func { print("VALUE = " ~ me.value) }

But one can also add a method to just one instance:

instance1.write = func { print("VALUE = " ~ me.value) }

Because <tt>instance1</tt> does now have its own <tt>write</tt> method, the parents won't be searched for one, so <tt>Class.write</tt> is now overridden by <tt>instance1</tt>'s own method. Nothing changed for <tt>instance2</tt> -- it will still only find and use <tt>Class.write</tt> via its parent.

Note, the we couldn't create a class instance by simple assignment, because, as we learned above, this wouldn't create a separate copy of the Class object. All "instances" would reference the same hash!

var bad_instance1 = Class; # bad
var bad_instance2 = Class; # bad

bad_instance1.value = 123; # sets Class.value to 123
bad_instance2.value = 456; # sets Class.value to 456

bad_instance1.write(); # prints 456, not 123

=== Constructor ===

Defining each class instance by explicitly creating a hash with parents is clumsy. It is nicer to have a function that does that for us. Then we can also use function arguments to initialize members of this instance.

var new_class = func(val) {
return { parents: [Class], value: val };
}

var instance1 = new_class(123);
var instance2 = new_class(456);

instance1.write(); # prints 123
instance2.write(); # prints 456

Because the class generating function <tt>new_class()</tt> really belongs to class <tt>Class</tt>, it would be nicer to put it into the class hash as well. In this case we call it a class "constructor", and as a convention, give it the name ''new''. It could have any name, though, and there could be more than one constructor.

var Class = {
new: func(val) {
return { parents: [Class], value: val };
},
write: func {
print("VALUE=" ~ me.value);
},
};

var instance1 = Class.new(123);
var instance2 = Class.new(456);

As you can see, <tt>new()</tt> doesn't return a copy of <tt>Class</tt>, but rather a small hash that contains only a list of parents and one individual member <tt>value</tt>.

Classes aren't always as simple as in our example. Usually they contain several members, of which some may have yet to be calculated in the constructor. In that case it's easier to create a local object hash first, and to let the constructor finally return it. Such local hashes are often named <tt>m</tt> (as a short reference to <tt>me</tt>), or <tt>obj</tt>.

var Class = {
new: func(val) {
var m = { parents: [Class] };
m.value = val;
return m;
},
write: func {
print("VALUE=" ~ me.value);
},
};

This last example is the most frequently used form of class definitions in FlightGear-Nasal.

=== Destructor ===

There's no such thing in Nasal. In other languages destructors are automatically called when the class gets destroyed, so that memory and other resources that were allocated by the constructor can be freed. In Nasal that's all done by the Garbage Collector (GC), anyway. In the FlightGear context, however, there ''are'' resources that should get freed. Listeners should get removed, self-calling functions ("loops") stopped. For that it's recommended to create a destructor function and to call that manually. Such functions are often called <tt>del</tt>, similar to Python and to pair nicely with the three-letter constructor name <tt>new</tt>.

=== Multiple inheritance ===

A class can inherit from one or more other classes. It can then access all methods and class members of all parent classes, but also override them and add additional members.

var A = { # simple class A
new: func {
return { parents: [A] };
},
alpha: func print("\tALPHA"),
test: func print("\tthis is A.test"),
};

var B = { # simple class B
new: func(v) { # ... whose constructor takes an argument
return { parents: [B], value: v };
},
bravo: func print("\tBRAVO"),
test: func print("\tthis is B.test"),
write: func print("\tmy value is: ", me.value),
},

var C = { # class C that inherits ...
new: func(v) {
return { parents: [C, A.new(), B.new(v)] }; # ... from class A and B
},
charlie: func print("\tCHARLIE"),
test: func print("\tthis is C.test"), # overrides A.test() and B.test()
};

print("A instance");
var a = A.new();
a.alpha();

print("B instance");
var b = B.new(123);
b.bravo();
b.write();

print("C instance");
var c = C.new(456);
c.alpha(); # use alpha from the A parent
c.bravo(); # use bravo from the B parent
c.charlie(); # use charlie from C itself
c.test(); # use C.test(), which overrides A.test() and B.test()
c.write();

Even if a class overrides a method of a parent with the same name, the parent's version can still be accessed via <tt>parents</tt> vector.

c.test() # use C.test()
c.parents[0].test(); # use C.test()
c.parents[1].test(); # use A.test()
c.parents[2].test(); # use B.test()

=== More on methods ===

Methods are function members of a class hash. They can access other class members via the <tt>me</tt> variable, which is a reference to the class hash. For this reason, a method returning <tt>me</tt> can be used like the class itself, and one can apply further methods to the return value (this is usually called "method chaining"):

var Object = {
new: func(coords...) {
return { parents: [Object], coords: coords };
},
rotate: func(angle) {
# do the rotation
return me;
},
scale: func(factor) {
# do the scaling
return me;
},
translate: func(x, y) {
# do the translation
return me;
},
};

var triangle = Object.new([0, 0], [10, 0], [5, 7]);
triangle.translate(-9, -4).scale(5).rotate(33).translate(9, 4); # concatenated methods thanks to "me"

<tt>me</tt>, however, is only known in the scope of the class. If a method is to be called as a listener callback or a timer function, <tt>me</tt> has to get wrapped in a function, so that it's stored in the function closure.

var Manager = {
new: func {
return { parents: [Manager] };
},
start_timers: func {
settimer(do_stuff, 5); # BAD: there's no "do_stuff" function in the scope
settimer(me.do_stuff, 5); # BAD: function exists, but "me" won't be known
# when the timer function is actually executed
settimer(func me.do_stuff(), 5); # GOOD: new function object packs "me" in the closure

setlistener("/sim/foo", func me.do_stuff()); # GOOD (same as with timers)
},
do_stuff: func {
print("doing stuff");
},
};

var manager = Manager.new();
manager.start_timers();

== Exception handling ==

<tt>die()</tt> aborts a function with an error message (this can be compared to the throw() mechanism in C++).

var divide = func(a, b) {
if (b == 0)
die("division by zero");
return a / b; # this line won't be reached if b == 0
}

die() is also used internally by built-in extension functions or Nasal core functions. <tt>getprop("/4me")</tt>, for example, dies with an error message ''"name must begin with alpha or '_'"''. Now assume we want to write a dialog where the user can type a property path into an input field, and we display the property's value in a popup dialog. What if the user typed an invalid path and we hand that over to <tt>getprop()</tt>? We don't want Nasal to abort our code because of that. We want to display a nice error message instead. The <tt>call()</tt> function can catch <tt>die()</tt> exceptions:

var value = getprop(property); # dies if 'property' is invalid
var value = call(func getprop(property), nil, var err = []); # catches invalid-property-exception and continues

The second line calls getprop(property) just like the first, and returns its value. But if 'property' was invalid then the <tt>call()</tt> function catches the exception and sets the 'err' vector instead. That vector remains empty on success.

if (size(err))
print("ERROR: bad property ", property, " (", err[0], ")"); # err[0] contains the die() message
else
print("value of ", property, " is ", value);

The first argument of <tt>call()</tt> is a function object, the second a vector of function arguments (or ''nil''), and the third a vector where the function will return a possible error. For more information on the <tt>call()</tt> function see the [http://plausible.org/nasal/lib.html Nasal library documentation].

<tt>die()</tt> doesn't really care about what its argument is. It doesn't have to be a string, and can be any variable, for example a class. This can be used to pass values through a chain of functions.

var Error = { # exception class
new: func(msg, number) {
return { parents: [Error], message: msg, number: number };
},
};

var A = func(a) {
if (a < 0)
die(Error.new("negative argument to A", a)); # throw Error
return "A received " ~ a;
}

var B = func(val) {
var result = A(val);
print("B finished"); # this line is not reached if A threw an exception
return result;
}

var value = call(B, [-4], var err = []); # try B(-4)

if (size(err)) { # catch (...)
print("ERROR: ", err[0].message, "; bad value was ", err[0].number);
die(err[0]); # re-throw
} else {
print("SUCCESS: ", value);
}

== Listeners and Signals ==

Listeners are callback functions that are attached to property nodes. They are triggered whenever the node is written to, or, depending on the listener type, also when children are added or removed, and when children are written to. Unlike polling loops, listeners don't have the least effect on the frame rate when they aren't triggered, which makes them preferable to monitor properties that aren't written to frequently. Unfortunately, listeners don't work on so-called "tied" properties when the node value isn't set via property methods. (You can spot such tied properties by Ctrl-clicking the "." entry in the property browser: they are marked with a "T".) Most of the FDM properties are "tied".

=== <tt>setlistener()</tt> ===

Syntax:

var listener_id = setlistener(<property>, <function> [, <startup=0> [, <runtime=1>]]);

The first argument is a property node object (<tt>props.Node()</tt> hash) or a property path. Because the node hash depends on the props.nas module being loaded, <tt>setlistener()</tt> calls need to be deferred when used in an $FG_ROOT/Nasal/*.nas file, usually by calling them in a <tt>settimer(func {}, 0)</tt> construction. To avoid that, one can use the raw <tt>_setlistener()</tt> function directly, for which <tt>setlistener()</tt> is a wrapper. The raw function does only accept node paths (e.g. "/sim/menubar/visibility"), but not props.Node() objects.

The second argument is a function object (not a function call!). The <tt>func</tt> keyword turns code into a function object.

The third argument is optional. If it is non-null, then it causes the listener to be called initially. This is useful to let the callback function pick up the node value at startup.

The fourth argument is optional, and defaults to 1. This means that the callback function will be executed whenever the property is written to, independent of the value. If the argument is set to 0, then the function will only get triggered if a value other than the current value is written to the node. This should be used for properties that are written to in every frame, although the written value is mostly the same. If the argument is 2, then also write access to children will get reported, as well as the creation and removal of children nodes.

<tt>setlistener()</tt> returns a unique listener id on success, and <tt>nil</tt> on error. The id is nothing else than a counter that is 0 for the first Nasal listener, 1 for the second etc. You need this id number to remove the listener. Most listeners are never removed, so that one doesn't assign the return value, but simply drop it.

Listener callback functions can access up to four values via regular function arguments, the first two of which are property nodes in the form of a <tt>props.Node()</tt> object hash.

If you have set a callback function named ''myCallbackFunc'' via <tt>setlistener</tt> (''setlistener(myNode, myCallbackFunc)''), you can use this syntax in the callback function:

myCallbackFunc ([<changed_node> [, <listened_to_node> [, <operation> [, <is_child_event>]]]])

=== <tt>removelistener()</tt> ===

Syntax:

var num_listeners = removelistener(<listener id>);

<tt>removelistener()</tt> takes one argument: the unique listener id that a <tt>setlistener()</tt> call returned. It returns the number of remaining active Nasal listeners on success, <tt>nil</tt> on error, or -1 if a listener function applies <tt>removelistener()</tt> to itself. The fact that a listener can remove itself, can be used to implement a one-shot listener function:

var L = setlistener("/some/property", func {
print("I can only be triggered once.");
removelistener(L);
});

=== Listener Examples ===

The following example attaches an anonymous callback function to a "signal". The function will be executed when FlightGear is closed.

setlistener("/sim/signals/exit", func { print("bye!") });

Instead of an anonymous function, a named function can be used as well:

var say_bye = func { print("bye") }
setlistener("/sim/signals/exit", say_bye);

Callback functions can, optionally, access up to four parameters which are handed over via regular function arguments. Many times none of these parameters is used at all, as in the above example.

Most often, only the first parameter is used--which gives the node of the changed value.

The following code attaches the monitor_course() function to a gps property, using the argument course to get the node with the changed value.

var monitor_course = func(course) {
print("Monitored course set to ", course.getValue());
}
var i = setlistener("instrumentation/gps/wp/leg-course-deviation-deg", monitor_course);

# here the listener is active

removelistener(i); # remove that listener again

Here is code that accesses two arguments--the changed node and the listened-to node (these may be different when monitoring all children of a certain node)--and also shows how to monitor changes to a node including changes to children:

var monitor_course = func(course, flightinfo) {
print("One way to get the course setting: ", flightinfo.leg-course-deviation-deg.getValue());
print("Another way to get the same setting ", course.getValue());
}
var i = setlistener("instrumentation/gps/wp", monitor_course, 0, 2);

The function object doesn't need to be a separate, external function -- it can also be an anonymous function made directly in the <tt>setlistener()</tt> call:

setlistener("/sim/signals/exit", func { print("bye") }); # say "bye" on exit

Beware, however, that the contents of a function defined within the <tt>setlistener</tt> call are not evaluated until the call is actually made. If, for instance, local variables change before the setlistener call happens, the call will reflect the current value of those variables ''at the time the callback function is called'', not the value ''at the time the listener was set''.

For example, with this loop, the function will always return the value 10--even if mynode[1], mynode[2], mynode[3] or any of the others is the one that changed. It is because the contents of the setlistener are evaluated after the loop has completed running and at that point, i=10:

var output = func(number) {
print("mynode", number, " has changed!"); #This won't work!
}
for(i=1; i <= 10; i = i+1) {
var i = setlistener("mynode["~i~"]", func{ output (i); });
}

You can also access the four available function properties (or just one, two, or three of them as you need) in your anonymous function. Here is an example that accesses the first value:

for(i=1; i <= 10; i = i+1) {
var i = setlistener("mynode["~i~"]", func (changedNode) { print (changedNode); });
}

Attaching a function to a node that is specified as <tt>props.Node()</tt> hash:

var node = props.globals.getNode("/sim/signals/click", 1);
setlistener(node, func { gui.popupTip("don't click here!") });

Sometimes it is desirable to call the listener function initially, so that it can pick up the node value. In the following example a listener watches the view number, and turns the HUD on in cockpit view, and off in all other views. It doesn't only do that on writing to "view-number", but also once when the listener gets attached, thanks to the third argument "1":

setlistener("/sim/current-view/view-number", func(n) {
setprop("/sim/hud/visibility[0]", n.getValue() == 0);
}, 1);

There's no limit for listeners on a node. Several functions can get attached to one node, just as one function can get attached to several nodes. Listeners may write to the node they are listening to. This will not make the listener call itself causing an endless recursion.

=== Signals ===

In addition to "normal" nodes, there are "signal" nodes that were created solely for the purpose of having listeners attached:

<tt>/sim/signals/exit</tt> ... set to "true" on quitting FlightGear

<tt>/sim/signals/reinit</tt> ... set to "true" right before resetting FlightGear (Shift-Esc), and to "false" afterwards

<tt>/sim/signals/click</tt> ... set to "true" after a mouse click at the terrain. Hint that the geo coords for the click spot were updated and can be retrieved from /sim/input/click/{longitude-deg,latitude-deg,elevation-ft,elevation-m}

<tt>/sim/signals/screenshot</tt> ... set to "true" right before the screenshot is taken, and set to "false" after it. Can be used to hide and reveal dialogs etc.

<tt>/sim/signals/nasal-dir-initialized</tt> ... set to "true" after all Nasal "library" files in $FG_ROOT/Nasal/ were loaded and executed. It is only set once and can only be used to trigger listener functions that were defined in one of the Nasal files in that directory. After that signal was set
Nasal starts loading and executing aircraft Nasal files, and only later are <tt>settimer()</tt> functions
called and the next signal is set:

<tt>/sim/signals/fdm-initialized</tt> ... set to "true" when then FDM has just finished its initialization

<tt>/sim/signals/reinit-gui</tt> ... set to "true" when the GUI has just been reset (e.g. via Help menu). This
is used by the gui.Dialog class to reload Nasal-loaded XML dialogs.

<tt>/sim/signals/frame</tt> ... triggered at the beginning of each iteration of the main loop (a.k.a. "frame"). This is meant for debugging purposes. Normally, one would just use a settimer() with interval 0 for the same effect. The difference is that the signal is guaranteed to be raised at a defined moment, while the timer call may change when subsystems are re-ordered.

== FlightGear extension functions ==

=== <tt>print()</tt> ===
Concatenates an arbitrary number of arguments to one string, appends a new-line, and prints it to the terminal. Returns the number of printed characters.

print("Just", " a ", "test");

=== <tt>getprop()</tt> ===
Returns the node value for a given path, or <tt>nil</tt> if the node doesn't exist or hasn't been initialized yet.

getprop(<path>);

Example:

print("The frame rate is ", getprop("/sim/frame-rate"), " FPS");

=== <tt>setprop()</tt> ===
Sets a property value for a given node path string. Always returns nil.

setprop(<path> [, <path>, [...]], <value>);

All arguments but the last are concatenated to a path string, with a slash (/) inserted between each element. The last value is written to the respective node. If the node isn't writable, then an error message is printed to the console.

Examples:

setprop("/sim/current-view/view-number", 2);
setprop("/controls", "engines/engine[0]", "reverser", 1);

=== <tt>settimer()</tt> ===
Runs a function after a given simulation (default) or real time in seconds.

settimer(<function>, <time> [, <realtime=0>]);

The third argument is optional and defaults to 0, which lets the time argument be interpreted as "seconds simulation time". In this case the timer doesn't run when FlightGear is paused. For user interaction purposes (measuring key press time, displaying popups, etc.) one usually prefers real time.

var copilot_annoyed = func { setprop("/sim/messages/copilot", "Stop it! Immediately!") }
settimer(copilot_annoyed, 10);

=== <tt>systime()</tt> ===
Returns epoch time (time since 1972/01/01 00:00) in seconds as a floating point number with high resolution. This is useful for benchmarking purposes.

#benchmarking example:
var start = systime();
how_fast_am_I(123);
var end = systime();
print("took ", end - start, " seconds");

=== <tt>carttogeod()</tt> ===
Converts cartesian coordinates x/y/z to geodetic coordinates lat/lon/alt, which are returned as a vector. Units are degree and meter.

var geod = carttogeod(-2737504, -4264101, 3862172);
print("lat=", geod[0], " lon=", geod[1], " alt=", geod[2]);

# outputs
lat=37.49999782141546 lon=-122.6999914632327 alt=998.6042055172776

=== <tt>geodtocart()</tt> ===
Converts geodetic coordinates lat/lon/alt to cartesian coordinates x/y/z. Units are degree and meter.

var cart = geodtocart(37.5, -122.7, 1000); # lat/lon/alt(m)
print("x=", cart[0], " y=", cart[1], " z=", cart[2]);

# outputs
x=-2737504.667684828 y=-4264101.900993474 z=3862172.834656495

=== <tt>geodinfo()</tt> ===
Returns information about geodetic coordinates. Takes two arguments: lat, lon (in degree) and returns a vector with two entries, or nil if no information could be obtained because the terrain tile wasn't loaded. The first entry is the elevation (in meters) for the given point, and the second is a hash with information about the assigned material, or nil if there was no material information available, because there is, for instance, an untextured building at that spot.

var lat = getprop("/position/latitude-deg");
var lon = getprop("/position/longitude-deg");
var info = geodinfo(lat, lon);

if (info != nil) {
print("the terrain under the aircraft is at elevation ", info[0], " m");
if (info[1] != nil)
print("and it is ", info[1].solid ? "solid ground" : "covered by water");
}

A full data set looks like this:

debug.dump(geodinfo(lat, lon));

# outputs
[ 106.9892101062052, { light_coverage : 0, bumpiness : 0.5999999999999999, load_resistance : 1e+30,
solid : 0, names : [ "Lake", "Pond", "Reservoir", "Stream", "Canal" ], friction_factor : 1,
rolling_friction : 1.5 } ]

=== <tt>parsexml()</tt> ===

This function is an interface to the built-in expat XML parser. It takes up to five arguments. The first is a mandatory absolute path to an XMl file, the remaining four are optional callback functions, each of which can be nil (which is also the default value).

var ret = parsexml(<path> [, <start-elem> [, <end-elem> [, <data> [, <pi> ]]]]);

<start-elem> ... called for every starting tag with two arguments: the tag name, and an attribute hash
<end-elem> ... called for every ending tag with one argument: the tag name
<data> ... called for every piece of data with one argument: the data string
<pi> ... called for every "processing information" with two args: target and data string

<ret> ... the return value is nil on error, and the <path> otherwise

Example:

var start = func(name, attr) {
print("starting tag ", name);
foreach (var a; keys(attr))
print("\twith attribute ", a, "=", attr[a]);
}
var end = func(name) { print("ending tag ", name) }
var data = func(data) { print("data=", data) }
var pi = func(target, data) { print("processing instruction: target=", target, " data=", data) }
parsexml("/tmp/foo.xml", start, end, data, pi);

=== airportinfo() ===
Function for retrieval of airport/runway information.
Usage:

var apt = airportinfo("KHAF"); # get info about KHAF
var apt = airportinfo(lat, lon); # get info about apt closest to lat/lon
var apt = airportinfo(); # get info about apt closest to aircraft

The command debug.dump(airportinfo("KHAF")) outputs this:

{ lon : -122.4962626410256, lat : 37.51343502564102, has_metar : 0,
runways : { 12 : { stopway2 : 0, threshold1 : 232.5624,
lon : -122.5010889999999, lat : 37.513831, stopway1 : 0, width : 45.72,
threshold2 : 232.5624, heading : 138.1199999999999, length : 1523.0856 } },
elevation : 20.42159999999999, id : "KHAF", name : "Half Moon Bay" }

That is: a hash with elements lat/lon/elev/id/name/has_metar for the
airport, and a hash with runways, each of which consists of lat/lon/
/length/width/heading/threshold[12]/stopway[12]. Only one side of each
runway is listed -- the other can easily be deduced.

==Useful functions==

===Distance calculations===

To calculate the distance between two points (in two different ways):
# mylat1, mylong1, mylat2, mylong2 are lat & long in degrees
# myalt1 & myalt2 are altitude in meters

var GeoCoord1 = geo.Coord.new();
GeoCoord1.set_latlon(mylat1, mylong1,myalt1);

var GeoCoord2 = geo.Coord.new();
GeoCoord2.set_latlon(mylat2, mylong2, myalt2);

var directDistance = GeoCoord1.direct_distance_to(GeoCoord2);
var surfaceDistance = GeoCoord1.distance_to(GeoCoord2);

The results are distances in meters.

* distance_to - returns distance in meters along Earth curvature, ignoring altitudes; useful for map distance
* direct_distance_to - returns distance in meters direct; considers altitude, but cuts through Earth surface

===Other useful geographical functions===
Other useful geographical functions are found in geo.nas (in the FlightGear/data/Nasal directory of a FlightGear installation). geo.nas also includes documentation/explanation of the functions available.

==Related content==
{{Forum|30|Nasal}}
* [[:Category:Nasal]]

=== External links ===
* http://www.plausible.org/nasal

[[Category:Nasal]]

Building FlightGear - Debian

2010-10-04T22:02:17Z

Jester: /* FlightGear source */ Remove confusing [] notation

= HowTo build on Debian =

HowTo build FlightGear 2.0.0 or GIT on GNU/Linux Debian '''Stable''' 5.x (Lenny).

This HowTo may also work with '''Testing'''/'''Unstable''' except that some things are easier because of more up to date packages. So, before fetching something check the version of the available -dev package for it.

It even *should* work with '''Etch''', but I am not certain about some dependencies. [http://wiki.flightgear.org/index.php?title=Talk:Building_Flightgear_-_Debian&action=edit Reports] are welcome.

If you don't want to make your hands dirty, have a look at [[Scripted_Compilation_on_Linux_Debian/Ubuntu]].

== Requirements and Preparations ==
You need an OpenGL capable graphics including a proper installed driver. 

Also a bunch of packages (and some of their dependencies) are required:
*gcc, g++, make, automake1.9, pkg-config
*mawk (or gawk)
*cmake (min. version 2.6.0-5, for Etch available on backports.debian.org!)
*git, subversion, wget

*freeglut3-dev, libgl1-mesa-dev, libxrandr-dev
*libxi-dev, libxmu-dev, libxext-dev
*libopenal-dev (see [[#libopenal|libopenal]]), libalut-dev
*libjpeg62-dev, libtiff4-dev, libpng12-dev
*libboost1.37-dev (min 1.37, 1.40 available for Lenny on backports.debian.org)

During installation packages ''simgear-dev'' and ''openscenegraph-dev'' *must not* be installed. They can safely be re-installed after compilation.

== Build and install ==
Because we are going to install versions different to the ones in the repositries it is recommended to install FG-2.0.0 and/or GIT in a place independent to the base system such as /usr/local/FG-2.0.0, /opt/FG-2.0.0 or in a subdirectory of your $HOME. I suggest to make it writeable by the user that there is no need to become root for the <code>make install</code> commands. I'll use <code>$prefix</code> as a placeholder for this directory. 
Another one will be <code>$srcdir</code>, it stands for the absolute path to the directory which contains the folders of the various source codes. So in the following instructions you have to replace these with the local paths or even <code>export</code> them during the process.

Follow the instructions to fetch the sources and the data needed by FlightGear and the commands to build/install each source.

Have in mind that the data is relatively large (GIT about 3.5 GB and 2.0.0 300 MB) so, to save some time, it is a good idea to fetch it while building the sources.

=== libopenal ===
The libopenal-dev package in Lenny/Etch is too old for [[fgcom]]. For FlightGear it does work but not all features (like Doppler) are available, so installing an up to date version is recommended anyway.
cd $srcdir
wget http://kcat.strangesoft.net/openal-releases/openal-soft-1.11.753.tar.bz2
tar xjf openal-soft-1.11.753.tar.bz2
cd openal-soft-1.11.753/build
cmake -D CMAKE_INSTALL_PREFIX:PATH="$prefix" ..
make install

=== plib ===
Latest SVN is [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg20793.html recommended], yet package plib1.8.5-dev for Testing/Unstable does work as well.
cd $srcdir
svn co https://plib.svn.sourceforge.net/svnroot/plib/trunk plib
cd plib
sed s/PLIB_TINY_VERSION\ \ 5/PLIB_TINY_VERSION\ \ 6/ -i src/util/ul.h
./autogen.sh
./configure --prefix=$prefix
make install

=== Boost Library ===
Version 1.37 is needed. At least for Lenny/Etch this means getting the sources because this is not available atm on backports.org. Testing/Unstable users may have more luck and a package is available, libboost-1.37-dev or newer.

To build SimGear, FlightGear, fgrun and fgcom some boostlib header files are required, no need to compile and install it. If you have installed a libboost1.37-dev (or higher) package on your system you don't have to bother at all with it. If not, you have to tell each ./configure where the header files are. To do so, add the option <code>CPPFLAGS=-I$prefix/include</code> to the SimGear, FlightGear and fgrun <code>./configure</code> commands. We copy the header files to $prefix/include because fgcom will need them there.

Get the newest version tar ball from http://sourceforge.net/projects/boost/files/boost/, extract it into <code>$srcdir</code> then:
cp -R $srcdir/boost-[version]/boost/ $prefix/include/

Alternatively, you can directly extract the required include files:
tar xvf boost_1_37_0.tar.bz2 -C $prefix/include --strip 1 --wildcards --no-wildcards-match-slash '*/boost'

=== OpenSceneGraph ===
For FlightGear 2.0.0 one may use the latest (or at least 2.9.6) developer release from http://www.openscenegraph.org/projects/osg/wiki/Downloads/DeveloperReleases and extract it into <code>$srcdir</code>.

Mostly this is ok for FlightGear GIT as well as it is stable. However, sometimes the release is not fresh enough and one have to get the latest developments via SVN:
cd $srcdir
svn co http://www.openscenegraph.org/svn/osg/OpenSceneGraph/trunk OpenSceneGraph

cmake demands a build directory separate to its source directory. So <code>mkdir</code> one and <code>cd</code> into it.
cmake -D CMAKE_BUILD_TYPE="Release" -D CMAKE_CXX_FLAGS="-O3" -D CMAKE_C_FLAGS="-O3" \
-D CMAKE_INSTALL_PREFIX:PATH="$prefix" $srcdir/OpenSceneGraph[-version]
make install

=== SimGear ===
2.0.0:
cd $srcdir
wget http://mirrors.ibiblio.org/pub/mirrors/simgear/ftp/Source/SimGear-2.0.0.tar.gz
tar xzf SimGear-2.0.0.tar.gz
cd SimGear-2.0.0

GIT:
cd $srcdir
git clone git://gitorious.org/fg/simgear.git simgear
cd simgear
./autogen.sh

2.0.0 and GIT:
./configure --prefix=$prefix CPPFLAGS=-I$prefix/include LDFLAGS="-L$prefix/lib -L$prefix/lib64"
make install

=== FlightGear source ===
2.0.0:
cd $srcdir
wget http://mirrors.ibiblio.org/pub/mirrors/flightgear/ftp/Source/FlightGear-2.0.0.tar.gz
tar xzf FlightGear-2.0.0.tar.gz
cd FlightGear-2.0.0

GIT:
cd $srcdir
git clone git://gitorious.org/fg/flightgear.git flightgear
cd flightgear
./autogen.sh

2.0.0 and GIT:
./configure --prefix=$prefix CPPFLAGS=-I$prefix/include/ LDFLAGS="-L$prefix/lib -L$prefix/lib64"
make install

=== FlightGear data ===
2.0.0:
cd $prefix
wget http://mirrors.ibiblio.org/pub/mirrors/flightgear/ftp/Shared/FlightGear-data-2.0.0.tar.bz2
tar xjf FlightGear-data-2.0.0.tar.bz2

GIT:
cd $prefix
git clone git://gitorious.org/fg/fgdata.git data

The primary gitorious source is known to have trouble cloning the data, the mapserver mirror usually has no problems:
cd $prefix
git clone git://mapserver.flightgear.org/fgdata data

Also, there are bundles (snapshots) available that can be retrieved with your favorite download manager. This way you can resume interrupted downloads. After unpacking only a comparatively small amount of data has to be transferred from the git server to synchronize your repository.
$ cd $prefix
$ wget http://flightgear.mxchange.org/pub/fgfs/fgdata.bundle
$ git clone fgdata.bundle fgdata
Initialized empty Git repository in fgdata/.git/
warning: unrecognized header: -deg" - /orientation/roll += "-deg" - /position/altitude += "-ft" - /position/altitude-agl += "-ft" - /position/latitude += "-deg" --/position/longitude += "-deg" - /radios/adf/frequencies/selected += "-khz" - /radios/adf/frequencies/
warning: remote HEAD refers to nonexistent ref, unable to checkout.
$ cd fgdata
$ git branch master-tmp origin/master
Branch master-tmp set up to track remote branch refs/remotes/origin/master.
$ git remote rm origin
$ git remote add origin git://gitorious.org/fg/fgdata
$ git fetch origin
remote: Counting objects: 5596, done.
remote: Compressing objects: 100% (2919/2919), done.
remote: Total 4266 (delta 2540), reused 2166 (delta 1297)
Receiving objects: 100% (4266/4266), 117.93 MiB | 1374 KiB/s, done.
Resolving deltas: 100% (2540/2540), completed with 628 local objects.
From git://gitorious.org/fg/fgdata
* [new branch] PRE_OSG_PLIB_20061029 -> origin/PRE_OSG_PLIB_20061029
* [new branch] master -> origin/master
* [new tag] last-cvs -> last-cvs
* [new tag] mapserver -> mapserver
$ git branch -D master-tmp
Deleted branch master-tmp.
$ git branch --track master origin/master
Branch master set up to track remote branch refs/remotes/origin/master.
$ git checkout

The bundle may be periodically updated and bundles from different sources need not be the same. The file size for the above bundle dated 2010-06-09 is 2394168314, while the md5 checksum is
$ md5sum fgdata.bundle
2996221bd2b8ab7740f332f49396cf56 fgdata.bundle

=== Trial run ===
When all the builds are done and the data download has finished it is time for a test run:
export LD_LIBRARY_PATH=$prefix/lib/:$LD_LIBRARY_PATH
$prefix/bin/fgfs --fg-root=$prefix/data

For the future, if you want to start FlightGear from command line have a look at [[fgfsrc]], if you prefer a graphical user interface continue with [[#fgrun|compiling fgrun]]. Have in mind that fgfs need to find our self compiled libraries and therefore we have to tell the linker (ld) where to find them. That is what the first line here does.

== Optional Software ==

=== fgrun ===
To build [[fgrun]] two more package is required:
*libfltk1.1-dev fluid

cd $srcdir
svn co http://fgrun.svn.sourceforge.net/svnroot/fgrun/trunk fgrun
cd fgrun/fgrun/
./autogen.sh
./configure --prefix=$prefix [CPPFLAGS=-I$prefix/include/]
make install

=== fgcom ===
For [[fgcom]] unfortunately there is one more dependency which cannot be solved with packages on Lenny/Etch, see [[#libopenal|libopenal]].

cd $srcdir
svn co https://appfgcom.svn.sourceforge.net/svnroot/fgcom/trunk fgcom
cd fgcom/src
make INSTALL_BIN=$prefix/bin INSTALL_DIR=$prefix/fgcom \
PLIB_PREFIX=$prefix OPENAL_PREFIX=$prefix install



{{Building}}

[[de:FlightGear_bauen_-_Debian]]

Building FlightGear - Debian

2010-10-04T22:01:38Z

Jester: /* SimGear */ remove confusing [] notatiom

= HowTo build on Debian =

HowTo build FlightGear 2.0.0 or GIT on GNU/Linux Debian '''Stable''' 5.x (Lenny).

This HowTo may also work with '''Testing'''/'''Unstable''' except that some things are easier because of more up to date packages. So, before fetching something check the version of the available -dev package for it.

It even *should* work with '''Etch''', but I am not certain about some dependencies. [http://wiki.flightgear.org/index.php?title=Talk:Building_Flightgear_-_Debian&action=edit Reports] are welcome.

If you don't want to make your hands dirty, have a look at [[Scripted_Compilation_on_Linux_Debian/Ubuntu]].

== Requirements and Preparations ==
You need an OpenGL capable graphics including a proper installed driver. 

Also a bunch of packages (and some of their dependencies) are required:
*gcc, g++, make, automake1.9, pkg-config
*mawk (or gawk)
*cmake (min. version 2.6.0-5, for Etch available on backports.debian.org!)
*git, subversion, wget

*freeglut3-dev, libgl1-mesa-dev, libxrandr-dev
*libxi-dev, libxmu-dev, libxext-dev
*libopenal-dev (see [[#libopenal|libopenal]]), libalut-dev
*libjpeg62-dev, libtiff4-dev, libpng12-dev
*libboost1.37-dev (min 1.37, 1.40 available for Lenny on backports.debian.org)

During installation packages ''simgear-dev'' and ''openscenegraph-dev'' *must not* be installed. They can safely be re-installed after compilation.

== Build and install ==
Because we are going to install versions different to the ones in the repositries it is recommended to install FG-2.0.0 and/or GIT in a place independent to the base system such as /usr/local/FG-2.0.0, /opt/FG-2.0.0 or in a subdirectory of your $HOME. I suggest to make it writeable by the user that there is no need to become root for the <code>make install</code> commands. I'll use <code>$prefix</code> as a placeholder for this directory. 
Another one will be <code>$srcdir</code>, it stands for the absolute path to the directory which contains the folders of the various source codes. So in the following instructions you have to replace these with the local paths or even <code>export</code> them during the process.

Follow the instructions to fetch the sources and the data needed by FlightGear and the commands to build/install each source.

Have in mind that the data is relatively large (GIT about 3.5 GB and 2.0.0 300 MB) so, to save some time, it is a good idea to fetch it while building the sources.

=== libopenal ===
The libopenal-dev package in Lenny/Etch is too old for [[fgcom]]. For FlightGear it does work but not all features (like Doppler) are available, so installing an up to date version is recommended anyway.
cd $srcdir
wget http://kcat.strangesoft.net/openal-releases/openal-soft-1.11.753.tar.bz2
tar xjf openal-soft-1.11.753.tar.bz2
cd openal-soft-1.11.753/build
cmake -D CMAKE_INSTALL_PREFIX:PATH="$prefix" ..
make install

=== plib ===
Latest SVN is [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg20793.html recommended], yet package plib1.8.5-dev for Testing/Unstable does work as well.
cd $srcdir
svn co https://plib.svn.sourceforge.net/svnroot/plib/trunk plib
cd plib
sed s/PLIB_TINY_VERSION\ \ 5/PLIB_TINY_VERSION\ \ 6/ -i src/util/ul.h
./autogen.sh
./configure --prefix=$prefix
make install

=== Boost Library ===
Version 1.37 is needed. At least for Lenny/Etch this means getting the sources because this is not available atm on backports.org. Testing/Unstable users may have more luck and a package is available, libboost-1.37-dev or newer.

To build SimGear, FlightGear, fgrun and fgcom some boostlib header files are required, no need to compile and install it. If you have installed a libboost1.37-dev (or higher) package on your system you don't have to bother at all with it. If not, you have to tell each ./configure where the header files are. To do so, add the option <code>CPPFLAGS=-I$prefix/include</code> to the SimGear, FlightGear and fgrun <code>./configure</code> commands. We copy the header files to $prefix/include because fgcom will need them there.

Get the newest version tar ball from http://sourceforge.net/projects/boost/files/boost/, extract it into <code>$srcdir</code> then:
cp -R $srcdir/boost-[version]/boost/ $prefix/include/

Alternatively, you can directly extract the required include files:
tar xvf boost_1_37_0.tar.bz2 -C $prefix/include --strip 1 --wildcards --no-wildcards-match-slash '*/boost'

=== OpenSceneGraph ===
For FlightGear 2.0.0 one may use the latest (or at least 2.9.6) developer release from http://www.openscenegraph.org/projects/osg/wiki/Downloads/DeveloperReleases and extract it into <code>$srcdir</code>.

Mostly this is ok for FlightGear GIT as well as it is stable. However, sometimes the release is not fresh enough and one have to get the latest developments via SVN:
cd $srcdir
svn co http://www.openscenegraph.org/svn/osg/OpenSceneGraph/trunk OpenSceneGraph

cmake demands a build directory separate to its source directory. So <code>mkdir</code> one and <code>cd</code> into it.
cmake -D CMAKE_BUILD_TYPE="Release" -D CMAKE_CXX_FLAGS="-O3" -D CMAKE_C_FLAGS="-O3" \
-D CMAKE_INSTALL_PREFIX:PATH="$prefix" $srcdir/OpenSceneGraph[-version]
make install

=== SimGear ===
2.0.0:
cd $srcdir
wget http://mirrors.ibiblio.org/pub/mirrors/simgear/ftp/Source/SimGear-2.0.0.tar.gz
tar xzf SimGear-2.0.0.tar.gz
cd SimGear-2.0.0

GIT:
cd $srcdir
git clone git://gitorious.org/fg/simgear.git simgear
cd simgear
./autogen.sh

2.0.0 and GIT:
./configure --prefix=$prefix CPPFLAGS=-I$prefix/include LDFLAGS="-L$prefix/lib -L$prefix/lib64"
make install

=== FlightGear source ===
2.0.0:
cd $srcdir
wget http://mirrors.ibiblio.org/pub/mirrors/flightgear/ftp/Source/FlightGear-2.0.0.tar.gz
tar xzf FlightGear-2.0.0.tar.gz
cd FlightGear-2.0.0

GIT:
cd $srcdir
git clone git://gitorious.org/fg/flightgear.git flightgear
cd flightgear
./autogen.sh

2.0.0 and GIT:
./configure --prefix=$prefix [CPPFLAGS=-I$prefix/include/ LDFLAGS="-L$prefix/lib -L$prefix/lib64"]
make install

=== FlightGear data ===
2.0.0:
cd $prefix
wget http://mirrors.ibiblio.org/pub/mirrors/flightgear/ftp/Shared/FlightGear-data-2.0.0.tar.bz2
tar xjf FlightGear-data-2.0.0.tar.bz2

GIT:
cd $prefix
git clone git://gitorious.org/fg/fgdata.git data

The primary gitorious source is known to have trouble cloning the data, the mapserver mirror usually has no problems:
cd $prefix
git clone git://mapserver.flightgear.org/fgdata data

Also, there are bundles (snapshots) available that can be retrieved with your favorite download manager. This way you can resume interrupted downloads. After unpacking only a comparatively small amount of data has to be transferred from the git server to synchronize your repository.
$ cd $prefix
$ wget http://flightgear.mxchange.org/pub/fgfs/fgdata.bundle
$ git clone fgdata.bundle fgdata
Initialized empty Git repository in fgdata/.git/
warning: unrecognized header: -deg" - /orientation/roll += "-deg" - /position/altitude += "-ft" - /position/altitude-agl += "-ft" - /position/latitude += "-deg" --/position/longitude += "-deg" - /radios/adf/frequencies/selected += "-khz" - /radios/adf/frequencies/
warning: remote HEAD refers to nonexistent ref, unable to checkout.
$ cd fgdata
$ git branch master-tmp origin/master
Branch master-tmp set up to track remote branch refs/remotes/origin/master.
$ git remote rm origin
$ git remote add origin git://gitorious.org/fg/fgdata
$ git fetch origin
remote: Counting objects: 5596, done.
remote: Compressing objects: 100% (2919/2919), done.
remote: Total 4266 (delta 2540), reused 2166 (delta 1297)
Receiving objects: 100% (4266/4266), 117.93 MiB | 1374 KiB/s, done.
Resolving deltas: 100% (2540/2540), completed with 628 local objects.
From git://gitorious.org/fg/fgdata
* [new branch] PRE_OSG_PLIB_20061029 -> origin/PRE_OSG_PLIB_20061029
* [new branch] master -> origin/master
* [new tag] last-cvs -> last-cvs
* [new tag] mapserver -> mapserver
$ git branch -D master-tmp
Deleted branch master-tmp.
$ git branch --track master origin/master
Branch master set up to track remote branch refs/remotes/origin/master.
$ git checkout

The bundle may be periodically updated and bundles from different sources need not be the same. The file size for the above bundle dated 2010-06-09 is 2394168314, while the md5 checksum is
$ md5sum fgdata.bundle
2996221bd2b8ab7740f332f49396cf56 fgdata.bundle

=== Trial run ===
When all the builds are done and the data download has finished it is time for a test run:
export LD_LIBRARY_PATH=$prefix/lib/:$LD_LIBRARY_PATH
$prefix/bin/fgfs --fg-root=$prefix/data

For the future, if you want to start FlightGear from command line have a look at [[fgfsrc]], if you prefer a graphical user interface continue with [[#fgrun|compiling fgrun]]. Have in mind that fgfs need to find our self compiled libraries and therefore we have to tell the linker (ld) where to find them. That is what the first line here does.

== Optional Software ==

=== fgrun ===
To build [[fgrun]] two more package is required:
*libfltk1.1-dev fluid

cd $srcdir
svn co http://fgrun.svn.sourceforge.net/svnroot/fgrun/trunk fgrun
cd fgrun/fgrun/
./autogen.sh
./configure --prefix=$prefix [CPPFLAGS=-I$prefix/include/]
make install

=== fgcom ===
For [[fgcom]] unfortunately there is one more dependency which cannot be solved with packages on Lenny/Etch, see [[#libopenal|libopenal]].

cd $srcdir
svn co https://appfgcom.svn.sourceforge.net/svnroot/fgcom/trunk fgcom
cd fgcom/src
make INSTALL_BIN=$prefix/bin INSTALL_DIR=$prefix/fgcom \
PLIB_PREFIX=$prefix OPENAL_PREFIX=$prefix install



{{Building}}

[[de:FlightGear_bauen_-_Debian]]

Building FlightGear - Debian

2010-08-31T01:04:44Z

Jester: /* Boost Library */ Added alternate extract command

= HowTo build on Debian =

HowTo build FlightGear 2.0.0 or GIT on GNU/Linux Debian '''Stable''' 5.x (Lenny).

This HowTo may also work with '''Testing'''/'''Unstable''' except that some things are easier because of more up to date packages. So, before fetching something check the version of the available -dev package for it.

It even *should* work with '''Etch''', but I am not certain about some dependencies. [http://wiki.flightgear.org/index.php?title=Talk:Building_Flightgear_-_Debian&action=edit Reports] are welcome.

If you don't want to make your hands dirty, have a look at [[Scripted_Compilation_on_Linux_Debian/Ubuntu]].

== Requirements and Preparations ==
You need an OpenGL capable graphics including a proper installed driver. 

Also a bunch of packages (and some of their dependencies) are required:
*gcc, g++, make, automake1.9, pkg-config
*mawk (or gawk)
*cmake (min. version 2.6.0-5, for Etch available on backports.org!)
*git, subversion, wget

*freeglut3-dev, libgl1-mesa-dev, libxrandr-dev
*libxi-dev, libxmu-dev, libxext-dev
*libopenal-dev (see [[#libopenal|libopenal]]), libalut-dev
*libjpeg62-dev, libtiff4-dev, libpng12-dev
*libboost1.37-dev (Not available for Lenny atm, see [[#Boost Library|Boost Library]] below.)

During installation packages ''simgear-dev'' and ''openscenegraph-dev'' *must not* be installed. They can safely be re-installed after compilation.

== Build and install ==
Because we are going to install versions different to the ones in the repositries it is recommended to install FG-2.0.0 and/or GIT in a place independent to the base system such as /usr/local/FG-2.0.0, /opt/FG-2.0.0 or in a subdirectory of your $HOME. I suggest to make it writeable by the user that there is no need to become root for the <code>make install</code> commands. I'll use <code>$prefix</code> as a placeholder for this directory. 
Another one will be <code>$srcdir</code>, it stands for the absolute path to the directory which contains the folders of the various source codes. So in the following instructions you have to replace these with the local paths or even <code>export</code> them during the process.

Follow the instructions to fetch the sources and the data needed by FlightGear and the commands to build/install each source.

Have in mind that the data is relatively large (GIT about 3.5 GB and 2.0.0 300 MB) so, to save some time, it is a good idea to fetch it while building the sources.

=== libopenal ===
The libopenal-dev package in Lenny/Etch is too old for [[fgcom]]. For FlightGear it does work but not all features (like Doppler) are available, so installing an up to date version is recommended anyway.
cd $srcdir
wget http://kcat.strangesoft.net/openal-releases/openal-soft-1.11.753.tar.bz2
tar xjf openal-soft-1.11.753.tar.bz2
cd openal-soft-1.11.753/build
cmake -D CMAKE_INSTALL_PREFIX:PATH="$prefix" ..
make install

=== plib ===
Latest SVN is [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg20793.html recommended], yet package plib1.8.5-dev for Testing/Unstable does work as well.
cd $srcdir
svn co https://plib.svn.sourceforge.net/svnroot/plib/trunk plib
cd plib
sed s/PLIB_TINY_VERSION\ \ 5/PLIB_TINY_VERSION\ \ 6/ -i src/util/ul.h
./autogen.sh
./configure --prefix=$prefix
make install

=== Boost Library ===
Version 1.37 is needed. At least for Lenny/Etch this means getting the sources because this is not available atm on backports.org. Testing/Unstable users may have more luck and a package is available, libboost-1.37-dev or newer.

To build SimGear, FlightGear, fgrun and fgcom some boostlib header files are required, no need to compile and install it. If you have installed a libboost1.37-dev (or higher) package on your system you don't have to bother at all with it. If not, you have to tell each ./configure where the header files are. To do so, add the option <code>CPPFLAGS=-I$prefix/include</code> to the SimGear, FlightGear and fgrun <code>./configure</code> commands. We copy the header files to $prefix/include because fgcom will need them there.

Get the newest version tar ball from http://sourceforge.net/projects/boost/files/boost/, extract it into <code>$srcdir</code> then:
cp -R $srcdir/boost-[version]/boost/ $prefix/include/

Alternatively, you can directly extract the required include files:
tar xvf boost_1_37_0.tar.bz2 -C $prefix/include --strip 1 --wildcards --no-wildcards-match-slash '*/boost'

=== OpenSceneGraph ===
For FlightGear 2.0.0 one may use the latest (or at least 2.9.6) developer release from http://www.openscenegraph.org/projects/osg/wiki/Downloads/DeveloperReleases and extract it into <code>$srcdir</code>.

Mostly this is ok for FlightGear GIT as well as it is stable. However, sometimes the release is not fresh enough and one have to get the latest developments via SVN:
cd $srcdir
svn co http://www.openscenegraph.org/svn/osg/OpenSceneGraph/trunk OpenSceneGraph

cmake demands a build directory separate to its source directory. So <code>mkdir</code> one and <code>cd</code> into it.
cmake -D CMAKE_BUILD_TYPE="Release" -D CMAKE_CXX_FLAGS="-O3" -D CMAKE_C_FLAGS="-O3" \
-D CMAKE_INSTALL_PREFIX:PATH="$prefix" $srcdir/OpenSceneGraph[-version]
make install

=== SimGear ===
2.0.0:
cd $srcdir
wget http://mirrors.ibiblio.org/pub/mirrors/simgear/ftp/Source/SimGear-2.0.0.tar.gz
tar xzf SimGear-2.0.0.tar.gz
cd SimGear-2.0.0

GIT:
cd $srcdir
git clone git://gitorious.org/fg/simgear.git simgear
cd simgear
./autogen.sh

2.0.0 and GIT:
./configure --prefix=$prefix [CPPFLAGS=-I$prefix/include LDFLAGS="-L$prefix/lib -L$prefix/lib64"]
make install

=== FlightGear source ===
2.0.0:
cd $srcdir
wget http://mirrors.ibiblio.org/pub/mirrors/flightgear/ftp/Source/FlightGear-2.0.0.tar.gz
tar xzf FlightGear-2.0.0.tar.gz
cd FlightGear-2.0.0

GIT:
cd $srcdir
git clone git://gitorious.org/fg/flightgear.git flightgear
cd flightgear
./autogen.sh

2.0.0 and GIT:
./configure --prefix=$prefix [CPPFLAGS=-I$prefix/include/ LDFLAGS="-L$prefix/lib -L$prefix/lib64"]
make install

=== FlightGear data ===
2.0.0:
cd $prefix
wget http://mirrors.ibiblio.org/pub/mirrors/flightgear/ftp/Shared/FlightGear-data-2.0.0.tar.bz2
tar xjf FlightGear-data-2.0.0.tar.bz2

GIT:
cd $prefix
git clone git://gitorious.org/fg/fgdata.git data

The primary gitorious source is known to have trouble cloning the data, the mapserver mirror usually has no problems:
cd $prefix
git clone git://mapserver.flightgear.org/fgdata data

Also, there are bundles (snapshots) available that can be retrieved with your favorite download manager. This way you can resume interrupted downloads. After unpacking only a comparatively small amount of data has to be transferred from the git server to synchronize your repository.
$ cd $prefix
$ wget http://flightgear.mxchange.org/pub/fgfs/fgdata.bundle
$ git clone fgdata.bundle fgdata
Initialized empty Git repository in fgdata/.git/
warning: unrecognized header: -deg" - /orientation/roll += "-deg" - /position/altitude += "-ft" - /position/altitude-agl += "-ft" - /position/latitude += "-deg" --/position/longitude += "-deg" - /radios/adf/frequencies/selected += "-khz" - /radios/adf/frequencies/
warning: remote HEAD refers to nonexistent ref, unable to checkout.
$ cd fgdata
$ git branch master-tmp origin/master
Branch master-tmp set up to track remote branch refs/remotes/origin/master.
$ git remote rm origin
$ git remote add origin git://gitorious.org/fg/fgdata
$ git fetch origin
remote: Counting objects: 5596, done.
remote: Compressing objects: 100% (2919/2919), done.
remote: Total 4266 (delta 2540), reused 2166 (delta 1297)
Receiving objects: 100% (4266/4266), 117.93 MiB | 1374 KiB/s, done.
Resolving deltas: 100% (2540/2540), completed with 628 local objects.
From git://gitorious.org/fg/fgdata
* [new branch] PRE_OSG_PLIB_20061029 -> origin/PRE_OSG_PLIB_20061029
* [new branch] master -> origin/master
* [new tag] last-cvs -> last-cvs
* [new tag] mapserver -> mapserver
$ git branch -D master-tmp
Deleted branch master-tmp.
$ git branch --track master origin/master
Branch master set up to track remote branch refs/remotes/origin/master.
$ git checkout

The bundle may be periodically updated and bundles from different sources need not be the same. The file size for the above bundle dated 2010-06-09 is 2394168314, while the md5 checksum is
$ md5sum fgdata.bundle
2996221bd2b8ab7740f332f49396cf56 fgdata.bundle

=== Trial run ===
When all the builds are done and the data download has finished it is time for a test run:
export LD_LIBRARY_PATH=$prefix/lib/:$LD_LIBRARY_PATH
$prefix/bin/fgfs --fg-root=$prefix/data

For the future, if you want to start FlightGear from command line have a look at [[fgfsrc]], if you prefer a graphical user interface continue with [[#fgrun|compiling fgrun]]. Have in mind that fgfs need to find our self compiled libraries and therefore we have to tell the linker (ld) where to find them. That is what the first line here does.

== Optional Software ==

=== fgrun ===
To build [[fgrun]] two more package is required:
*libfltk1.1-dev fluid

cd $srcdir
svn co http://fgrun.svn.sourceforge.net/svnroot/fgrun/trunk fgrun
cd fgrun/fgrun/
./autogen.sh
./configure --prefix=$prefix [CPPFLAGS=-I$prefix/include/]
make install

=== fgcom ===
For [[fgcom]] unfortunately there is one more dependency which cannot be solved with packages on Lenny/Etch, see [[#libopenal|libopenal]].

cd $srcdir
svn co https://appfgcom.svn.sourceforge.net/svnroot/fgcom/trunk fgcom
cd fgcom/src
make INSTALL_BIN=$prefix/bin INSTALL_DIR=$prefix/fgcom \
PLIB_PREFIX=$prefix OPENAL_PREFIX=$prefix install



{{Building}}

[[de:FlightGear_bauen_-_Debian]]

Howto:Understand console output

2010-08-09T19:45:18Z

Jester: /* Errors without known solutions */ Removed "FGMultiplayerMgr::Open - Failed to bind recieve socket"

This document lists '''[[FlightGear]] errors''', how to get rid of them and other '''console output'''. If FlightGear quits but does not give you any error, try increasing the [[FlightGear Launch Control#Debugging|Log Level]].

Errors can appear in various locations, but the most common one is the console (a black window), which pops up when you run fgfs.exe.

==Errors with known solutions==
===Airports/.... ... Done===
This is not an error. The message lets us know that [[TerraSync]] is updating the <tt>[[$FG_SCENERY]]/Airports</tt> directory.

===Base package check failed ... Found version [none] at: ... Please upgrade to version:===
* FlightGear was unable to find the [[$FG_ROOT]] directory. Set it using the <tt>--fg-root=</tt> commandline option.
* When using [[CVS]] with binaries, the data must match the binary. You cannot use data from a different date than the binary's release date.

===condition: comparison without property[1] or value===
A condition (like <tt><less-than></tt> or <tt><equals></tt>) exists, without either:
* a property to check
* a value to check the property against

===Could not find at least one of the following objects for animation:===
This means that FlightGear is unable to find an object in a .ac file. Check the .xml file (where the animation is stored) to see if the object-names match those in the .ac file. If you are not the aircraft's author you can safely ignore such warnings.

===creating 3D noise texture... DONE===
Tells you that a new noise texture is created. It is not an error and can be ignored.

===Error: [Screen #0] GraphicsWindowWin32::setPixelFormat() - No matching pixel format found based on traits specified====
Try changing the [[FlightGear Launch Control#Page Four - Options and Run|BPP]] value of your FlightGear setup. If that does not work, your graphics card is probably not able to run FlightGear 1.9 and higher. Another graphics card, or an older FlightGear version will likely "fix" the problem.

===Error: bind() failed in make_server_socket()===
When using [[Howto: Multiplayer|multiplayer]] or socket input, this usually means you specified an invalid ip address or the port is in use. Note: for multiplayer, you don't need to use the ''--multiplay=in,...'' option at all, FlightGear (since version 1.0) figures out the proper setting automatically. Only use when you know what you are doing.

===Error Building Technique: findAttr: could not find attribute bool===
Make sure that your data and source (or binary) match. They must be from the same date, to provide the best performance.

===Error: connect() failed in make_client_socket() SG_IO_OUT socket creation failed===
Your computer is not connected with the internet.

===Error: RenderTexture requires the following unsupported OpenGL extensions...===
Your graphics card doesn't support some graphics feature that FG requires. Update your drivers, change the BPP value and/or try disabling some of the visual goodies like [[3D Clouds]].

===Failed to find .... in apt.dat.gz===
You need to edit ATC/default.tower and ATC/default.atis. You can open these files with any text editor. Either remove or fix the entries containing your airports ICAO code (like KSFO).

===Failed to open file ...===
Check if the file exists on your system. If the missing file is a scenery object; be sure you have the latest [http://scenemodels.flightgear.org/download/SharedModels.tgz Shared Models] from the [[FlightGear Scenery Database]].

===Fatal error: mismatched tag ...===
In some .xml file, an opening tag (like <tt><sim></tt>) does not match its closing tag (like <tt></sim></tt>). This error is hard to track down, best method is to comment (place code between <nowiki></nowiki>) most of the aircraft. Then uncomment code one by one, until the error appears again.

===Fatal error: name must begin with alpha or '_'===
This error comes up when a property should be formed of which the name does not start with a letter of the alphabet or _. If this error only happens with certain planes, contact their authors.

===Fatal error: unclosed token===
A token (<nowiki></nowiki>) has been started, but not closes. Add <nowiki>--></nowiki> at the correct line.

===FGMultiplayMgr::MP_ProcessData: No such file or directory===
This is telling you that there's someone online on the multiplayerserver, using a plane that you do not have installed on your own system. In order to remove the error (and see the other plane) you have to install the plane that the other pilot is using.

===FGMultiplayMgr - No receiver port, Multiplayermode disabled===
FlightGear [[Howto: Multiplayer|multiplayer]] has not been set.

===FGPropertyManager::GetNode() No node found for ... In component: ... unknown property ... referenced. Aborting===
FlightGear found a reference in the [[FDM]] to a non-existing property.

===FGPropertyManager::GetNode() No node found for ... The property ... is undefined.===
FlightGear found a reference in the [[FDM]] to a non-existing property. Keep in mind that JSBSim reads the FDM from top to bottom. Properties should always be created before they are needed somewhere.

===Fgtzfile_read(): : Invalid argument Fatal error: Timezone reading failed===
This one is caused by wrong line ending in a timezone file. Solution might be to download the Timezone/time.tab file manually from [http://gitorious.org/fg/fgdata/blobs/raw/master/Timezone/zone.tab Gitorious] (Right mouseclick > Save target as) and overwrite the file in <tt>[[$FG_ROOT]]/Timezone/time.tab</tt> with it.

===Found unexpected subsystem: system exiting. JSBSim failed to load aircraft and/or engine model===
You are probably trying to run an aircraft on a out-of-date version of FlightGear. The planes on the official download page are intended to be used with the latest version of FlightGear. Usage on any older systems may not work.

===freeglut (fgfs): Unable to create direct context rendering for window 'FlightGear' This may hurt performance===
This reports that you do not have proper hardware accelerated 3D (direct rendering) configured.

===Gate ... doesn't seem to have routes associated with it===
A startup location in the [[Interactive Traffic#Ground networks|groundnetwork]] is not (properly) connected to a taxi route. Contact the airport author, or import the network to [[TaxiDraw]] and run the Verify network command to find the corrupted gate.

===glLinkProgram "" Failed===
Update your drivers; they have to support atleast OpenGL 2.0 for FlightGear 2.0 and later.

===loading scenario '...'===
This is not an error. It shows that an [[AI Systems#AI Models|AI scenario]] is loaded.

===Model not found: ...===
This one tells you that FlightGear was unable to find a certain file. The nice thing is that it also tells you excactly what file.

# Check if the file really does not exist at your computer.
# Try to locate the file in which the missing file is referenced. This is likely to be <tt>-set.xml</tt> in the root directory of the loaded [[aircraft]]. Between the <model> tags, the base model file is referenced. This file references to all other models that are displayed with the aircraft.
# Contact the aircraft author with a detailed bug-report, in which you state the excact location of the missing file and (if you found it) the file in which it is referenced.

===Nasal runtime error: nil used in numeric context===
This error is [[Nasal]] triggered by a Nasal file (the console should show what file (and line) and from where it was referenced). The Nasal script tried to do something with a [[Property Tree|property]] with an empty value. A solution is to fill the property before the Nasal is loaded. This can be done by setting the property in an [[aircraft]]'s <tt>-set.xml</tt> file or by adding a [[Nasal scripting language#Listeners and Signals|listener]] to the script.

[[Howto: Contact the developers|Contact the developers]] if this error is shown for a <tt>[[$FG_ROOT]]/Nasal/</tt> script.

===Near camera not rendering===
[[Image:Near_camera_off.png|500px]]

If you screen looks like the image above; make sure you have at least [[OSG]] version 2.7.6.

===No render bin name specified in render bin section===
Update [[SimGear]] (or binary) and your data directory.

===No render bin number specified in render bin section===
Update [[SimGear]] (or binary) and your data directory.

===... not a valid win32 application===
This Windows error could have various reasons to pop up. Usually, the file that is causing troubles is mentioned. Re-installing this file might solve the problem.

===OBJECT_SIGN: unsupported glyph `.'===
Check the OBJECT_SIGN lines in the .stg file of the tile that was loaded when this error showed up.

===OpenAL error <AL_INVALID_VALUE>: bind source <alGenSources> Failed to generate audio source.===
This error is probably displayed because of some misdirected audio settings in the [[aircraft]]s setup. Check the -sound.xml file of the aircraft and see if all files refered to really exist. If not, try to contact the author of the plane, so he can fix the problem in the [[FlightGear CVS|CVS]] version or solve the problem yourself and let someone commit the patch.

===OpenAL error (AL_INVALID_VALUE): constructor (alBufferData) Fatal error: Failed to buffer data.===
Disabling sound is a temporarily solution for this problem.

===osgDB ac3d reader: could not find texture...===
See [[#Failed to open file ...|Failed to open file ...]]

===osgDB ac3d reader: detected surface with less than 3 vertices!===
In one of the loaded models a non-existing surface is found. This can be a single line (sometimes used to simulate thin wires) or a fault in the model.

===Program's vertex attrib binding ..., usrAttr...===
Tells you that an effect binded certain attributes to a [[Shaders|shader]].

===QNAN===
(Q)NAN stands for (Quiet) Not A Number, produced by 0/0 or other floating point break downs. There can be various causes for this:
* Using a "flap start" value of 0 in the [[YASim]] [[FDM]]. Use some small value like 0.001 instead.

===Scaling image...===
This means a texture, whether in the scenery on your aircraft or anyone elses (when multiplayer is enabled), is not sized to powers of two. All textures in FlightGear have to be sized to power of two (eg. 16*16, 32*64, 32*1024). As of version 1.9 textures are resized automaticly, but it does slow your computer down, so it's better to resize the noted textures.

===ssgInit called without a valid OpenGL context===
In short, your GL libraries are broken. So far only Red Hat 7.x users have experienced this (see http://www.redhat.com/bugzilla/show_bug.cgi?id=18867). The only solutions are possibly complicated ones: you can either change distributions (most of us prefer Debian) or upgrade/downgrade your Mesa libs.

===The system cannot find the file specified===
If you are running Windows Vista; start by looking in <tt>C:\Users\Owner\AppData\Local\VirtualStore</tt> and seeing if you have a folder called FlightGear in there. If you do, cut-and-paste (merge) that one with <tt>C:\Program Files\Flightgear</tt> and try to launch FlightGear again.

'''Hint:''' you may need to go under Tools and Folder Options to specify "Show Hidden/System Files and Folders" in order for AppData to be visible.

===Time zone reading failed===
This is probably caused by a line-ending problem in the timezone files. Win32 users can resolve the problem by downloading a DOS to UNIX conversion utility available at http://www.nottingham.ac.uk/~eazdluf/d2u.zip. Run as `d2u *.tab` from within the timezone directory to fix your timezone files

===Traffic manager could not find airport===
There is either an airport missing from apt.dat, or there is a wrong ICAO code in a [[Interactive Traffic#Building Traffic Files|traffic file]]. An airport missing from apt.dat could be due to a recent opening.

===Unable to choose requested pixel format===
Error should be solved as of version 1.9. If not, try changing your [[FlightGear Launch Control#Page Four - Options and Run|BPP]] and/or resolution.

===Unable to find airport details for .... in FGTower::Init()===
This error can be surpressed by disabling [[Interactive Traffic|AI Traffic]], via the AI/ATC [[menu]].

The error appears when an airport in <tt>[[$FG_ROOT]]/Airports/apt.dat.gz</tt> cannot be found in <tt>[[$FG_ROOT]]/ATC/default.tower</tt> and <tt>[[$FG_ROOT]]/ATC/default.atis</tt>. Renaming the airports in the apt.dat.gz file ór in both default ATC files will fix the problem.

===Unable to open aircraft directory===
The [[aircraft]] that you are trying to run most likely relies on another aircraft, which you did not install (yet). The error shows what aircraft, so go download that one!
=== Unexpected tag '...' found in YASim aircraft description===
FlightGear found a non-existing tag in the [[FDM]] of the aircraft you are trying to launch. If you have not changed the original aircraft, contact the aircraft author. Else, check the FDM througly for mistakes.

=== Unknown ... aircraft: ... defaulting to C172 ===
FlightGear is unable to load the forced [[FDM]] (set through <tt>--fdm=...</tt> or via <tt>Advanced > Flight Model</tt> in [[FGRun]]) for this aircraft. FlightGear automatically picks the right FDM for each aircraft, so there is no need to set it manually, unless you know what you are doing. In the Flight Model dialog of FGRun, set the FDM to <tt>jsb</tt>; that is the "auto setting".

===Unknown exception to the main loop. Aborting... Possible cause: No such file or directory===
This error could have a variety of sources, among them missing files but also other things. Increasing the [[FlightGear_Launch_Control#Debugging|log level]] to debug and repeating excactly what you did when the error came up, might provide some more information on what FlightGear was doing when the error occurred.
* Setting your [[FlightGear Launch Control#Page Four - Options and Run|BPP]] to a lower value might work.
* Changing the resolution to a smaller one might work as well.

===WARNING: Couldn't convert texture...===
You are trying to run an aircraft not compatible with your FlightGear version. Most of the time, this error appears when you fly an aircraft, textured with .png files on versions older than 1.9. Convert the textures manually to .rgb or upgrade your FlightGear version.

===Warning: Picked up TriangleIntersect===
Reduce your [[FlightGear Launch Control#Debugging|Log Level]] to alert. Or [[Showstoppers|send the fgfs output to /dev/null (unix systems) or 2>nul (Windows)]]. The errors might still be shown, but do not affect the sim anymore.

===Warning: TangentSpaceGenerator: unknown primitive mode 9===
This is an [[OSG]] error, showing up when an effect needs tangent vectors, but polygons are not support. The error itself can be ignored, altough some [[shaders]] may look wrong. Shader developers should try to minimise the use of polygons and use triangles and quads instead.

===YASim SOLUTION FAILURE: Solution failed to converge after 10000 iterations===
Some control in the [[YASim]] [[FDM]] is too weak, according to YASim, to control the aircraft. An effectiveness tag will be required in the FDM to solve this error.

===YASim SOLUTION FAILURE: Zero length fuselage===
There is a problem in the [[FDM]]. A fuselage section with similar ax and ay was created. Change the ax and/or ay values to match the aircraft.

===FGMultiplayerMgr::Open - Failed to bind receive socket===

This means FlightGear was unable to open the listening network socket required by the --multiplay=in option. Frequently this option can be omitted and FlightGear will figure out the necessary parameters automatically.
Common reasons are:
* Address given in the option does not resolve to one of the IP addresses of the local machine. This parameter should only be required if you want to fine-tune the network behavior. Omitting it directs FlightGear to listen on all local interfaces automatically. Example:
--multiplay=in,10,,5001
Notice that you still need the comma.
* The UDP port given in the option (or the default port 5000 if no option given) is already in use. Verify nothing is using the port.

==Errors without known solutions==
Please take a look at the upcoming errors and see if you know a solution to get rid of them. Your additions are greatly appreciated!

===AL Error (fx): Invalid Value at pitch and gain===

===AL Error (sound manager): Invalid Operation at update===

===AL Error (sound manager): Invalid Value at buffer add data No such buffer!===

===Failed to execute command nasal===

===Failed to tie property ... to object methods===
A JSBSim error.

===FGMultiplayMgr::MP_ProcessData - message from ... has invalid length!===

===GPS: malformed route, index=1===

===Mesa 7.3 implementation error: bad texture level in r300UploadSubImage===
http://www.flightgear.org/forums/viewtopic.php?f=2&t=6706&start=0&st=0&sk=t&sd=a

===Nasal runtime error: stack overflow===

===No image file for texture, using white===
A [[Shaders|shader]] error

===No path in /sim/sound/path===

===OpenAL error (AL_ILLEGAL_COMMAND): set_source_pos===

===OpenAL error (AL_ILLEGAL_COMMAND): set_volume===

===PT_vs_hpt: ran out of layers===

===Warning: detected OpenGL error 'invalid value' after RenderBin::draw(,)===

===Warning: GraphicsWindowWin32::grabFocus() - Failed grabbing the focus===

===WARNING: PUI: Too many live puInterfaces open at once!===
Appears when printing large outputs (very) frequently on the screen.

===Warning: State::drawQuads(0, 154400) too large handle in remapping to ushort glDrawElements===

[[Category:Howto|Get rid of common errors]]

[[fr:Howto: Débarrassez-vous des erreurs les plus fréquentes]]

Howto:Understand console output

2010-08-09T19:44:39Z

Jester: /* Errors with known solutions */ added "Failed to bind receive socket"

This document lists '''[[FlightGear]] errors''', how to get rid of them and other '''console output'''. If FlightGear quits but does not give you any error, try increasing the [[FlightGear Launch Control#Debugging|Log Level]].

Errors can appear in various locations, but the most common one is the console (a black window), which pops up when you run fgfs.exe.

==Errors with known solutions==
===Airports/.... ... Done===
This is not an error. The message lets us know that [[TerraSync]] is updating the <tt>[[$FG_SCENERY]]/Airports</tt> directory.

===Base package check failed ... Found version [none] at: ... Please upgrade to version:===
* FlightGear was unable to find the [[$FG_ROOT]] directory. Set it using the <tt>--fg-root=</tt> commandline option.
* When using [[CVS]] with binaries, the data must match the binary. You cannot use data from a different date than the binary's release date.

===condition: comparison without property[1] or value===
A condition (like <tt><less-than></tt> or <tt><equals></tt>) exists, without either:
* a property to check
* a value to check the property against

===Could not find at least one of the following objects for animation:===
This means that FlightGear is unable to find an object in a .ac file. Check the .xml file (where the animation is stored) to see if the object-names match those in the .ac file. If you are not the aircraft's author you can safely ignore such warnings.

===creating 3D noise texture... DONE===
Tells you that a new noise texture is created. It is not an error and can be ignored.

===Error: [Screen #0] GraphicsWindowWin32::setPixelFormat() - No matching pixel format found based on traits specified====
Try changing the [[FlightGear Launch Control#Page Four - Options and Run|BPP]] value of your FlightGear setup. If that does not work, your graphics card is probably not able to run FlightGear 1.9 and higher. Another graphics card, or an older FlightGear version will likely "fix" the problem.

===Error: bind() failed in make_server_socket()===
When using [[Howto: Multiplayer|multiplayer]] or socket input, this usually means you specified an invalid ip address or the port is in use. Note: for multiplayer, you don't need to use the ''--multiplay=in,...'' option at all, FlightGear (since version 1.0) figures out the proper setting automatically. Only use when you know what you are doing.

===Error Building Technique: findAttr: could not find attribute bool===
Make sure that your data and source (or binary) match. They must be from the same date, to provide the best performance.

===Error: connect() failed in make_client_socket() SG_IO_OUT socket creation failed===
Your computer is not connected with the internet.

===Error: RenderTexture requires the following unsupported OpenGL extensions...===
Your graphics card doesn't support some graphics feature that FG requires. Update your drivers, change the BPP value and/or try disabling some of the visual goodies like [[3D Clouds]].

===Failed to find .... in apt.dat.gz===
You need to edit ATC/default.tower and ATC/default.atis. You can open these files with any text editor. Either remove or fix the entries containing your airports ICAO code (like KSFO).

===Failed to open file ...===
Check if the file exists on your system. If the missing file is a scenery object; be sure you have the latest [http://scenemodels.flightgear.org/download/SharedModels.tgz Shared Models] from the [[FlightGear Scenery Database]].

===Fatal error: mismatched tag ...===
In some .xml file, an opening tag (like <tt><sim></tt>) does not match its closing tag (like <tt></sim></tt>). This error is hard to track down, best method is to comment (place code between <nowiki></nowiki>) most of the aircraft. Then uncomment code one by one, until the error appears again.

===Fatal error: name must begin with alpha or '_'===
This error comes up when a property should be formed of which the name does not start with a letter of the alphabet or _. If this error only happens with certain planes, contact their authors.

===Fatal error: unclosed token===
A token (<nowiki></nowiki>) has been started, but not closes. Add <nowiki>--></nowiki> at the correct line.

===FGMultiplayMgr::MP_ProcessData: No such file or directory===
This is telling you that there's someone online on the multiplayerserver, using a plane that you do not have installed on your own system. In order to remove the error (and see the other plane) you have to install the plane that the other pilot is using.

===FGMultiplayMgr - No receiver port, Multiplayermode disabled===
FlightGear [[Howto: Multiplayer|multiplayer]] has not been set.

===FGPropertyManager::GetNode() No node found for ... In component: ... unknown property ... referenced. Aborting===
FlightGear found a reference in the [[FDM]] to a non-existing property.

===FGPropertyManager::GetNode() No node found for ... The property ... is undefined.===
FlightGear found a reference in the [[FDM]] to a non-existing property. Keep in mind that JSBSim reads the FDM from top to bottom. Properties should always be created before they are needed somewhere.

===Fgtzfile_read(): : Invalid argument Fatal error: Timezone reading failed===
This one is caused by wrong line ending in a timezone file. Solution might be to download the Timezone/time.tab file manually from [http://gitorious.org/fg/fgdata/blobs/raw/master/Timezone/zone.tab Gitorious] (Right mouseclick > Save target as) and overwrite the file in <tt>[[$FG_ROOT]]/Timezone/time.tab</tt> with it.

===Found unexpected subsystem: system exiting. JSBSim failed to load aircraft and/or engine model===
You are probably trying to run an aircraft on a out-of-date version of FlightGear. The planes on the official download page are intended to be used with the latest version of FlightGear. Usage on any older systems may not work.

===freeglut (fgfs): Unable to create direct context rendering for window 'FlightGear' This may hurt performance===
This reports that you do not have proper hardware accelerated 3D (direct rendering) configured.

===Gate ... doesn't seem to have routes associated with it===
A startup location in the [[Interactive Traffic#Ground networks|groundnetwork]] is not (properly) connected to a taxi route. Contact the airport author, or import the network to [[TaxiDraw]] and run the Verify network command to find the corrupted gate.

===glLinkProgram "" Failed===
Update your drivers; they have to support atleast OpenGL 2.0 for FlightGear 2.0 and later.

===loading scenario '...'===
This is not an error. It shows that an [[AI Systems#AI Models|AI scenario]] is loaded.

===Model not found: ...===
This one tells you that FlightGear was unable to find a certain file. The nice thing is that it also tells you excactly what file.

# Check if the file really does not exist at your computer.
# Try to locate the file in which the missing file is referenced. This is likely to be <tt>-set.xml</tt> in the root directory of the loaded [[aircraft]]. Between the <model> tags, the base model file is referenced. This file references to all other models that are displayed with the aircraft.
# Contact the aircraft author with a detailed bug-report, in which you state the excact location of the missing file and (if you found it) the file in which it is referenced.

===Nasal runtime error: nil used in numeric context===
This error is [[Nasal]] triggered by a Nasal file (the console should show what file (and line) and from where it was referenced). The Nasal script tried to do something with a [[Property Tree|property]] with an empty value. A solution is to fill the property before the Nasal is loaded. This can be done by setting the property in an [[aircraft]]'s <tt>-set.xml</tt> file or by adding a [[Nasal scripting language#Listeners and Signals|listener]] to the script.

[[Howto: Contact the developers|Contact the developers]] if this error is shown for a <tt>[[$FG_ROOT]]/Nasal/</tt> script.

===Near camera not rendering===
[[Image:Near_camera_off.png|500px]]

If you screen looks like the image above; make sure you have at least [[OSG]] version 2.7.6.

===No render bin name specified in render bin section===
Update [[SimGear]] (or binary) and your data directory.

===No render bin number specified in render bin section===
Update [[SimGear]] (or binary) and your data directory.

===... not a valid win32 application===
This Windows error could have various reasons to pop up. Usually, the file that is causing troubles is mentioned. Re-installing this file might solve the problem.

===OBJECT_SIGN: unsupported glyph `.'===
Check the OBJECT_SIGN lines in the .stg file of the tile that was loaded when this error showed up.

===OpenAL error <AL_INVALID_VALUE>: bind source <alGenSources> Failed to generate audio source.===
This error is probably displayed because of some misdirected audio settings in the [[aircraft]]s setup. Check the -sound.xml file of the aircraft and see if all files refered to really exist. If not, try to contact the author of the plane, so he can fix the problem in the [[FlightGear CVS|CVS]] version or solve the problem yourself and let someone commit the patch.

===OpenAL error (AL_INVALID_VALUE): constructor (alBufferData) Fatal error: Failed to buffer data.===
Disabling sound is a temporarily solution for this problem.

===osgDB ac3d reader: could not find texture...===
See [[#Failed to open file ...|Failed to open file ...]]

===osgDB ac3d reader: detected surface with less than 3 vertices!===
In one of the loaded models a non-existing surface is found. This can be a single line (sometimes used to simulate thin wires) or a fault in the model.

===Program's vertex attrib binding ..., usrAttr...===
Tells you that an effect binded certain attributes to a [[Shaders|shader]].

===QNAN===
(Q)NAN stands for (Quiet) Not A Number, produced by 0/0 or other floating point break downs. There can be various causes for this:
* Using a "flap start" value of 0 in the [[YASim]] [[FDM]]. Use some small value like 0.001 instead.

===Scaling image...===
This means a texture, whether in the scenery on your aircraft or anyone elses (when multiplayer is enabled), is not sized to powers of two. All textures in FlightGear have to be sized to power of two (eg. 16*16, 32*64, 32*1024). As of version 1.9 textures are resized automaticly, but it does slow your computer down, so it's better to resize the noted textures.

===ssgInit called without a valid OpenGL context===
In short, your GL libraries are broken. So far only Red Hat 7.x users have experienced this (see http://www.redhat.com/bugzilla/show_bug.cgi?id=18867). The only solutions are possibly complicated ones: you can either change distributions (most of us prefer Debian) or upgrade/downgrade your Mesa libs.

===The system cannot find the file specified===
If you are running Windows Vista; start by looking in <tt>C:\Users\Owner\AppData\Local\VirtualStore</tt> and seeing if you have a folder called FlightGear in there. If you do, cut-and-paste (merge) that one with <tt>C:\Program Files\Flightgear</tt> and try to launch FlightGear again.

'''Hint:''' you may need to go under Tools and Folder Options to specify "Show Hidden/System Files and Folders" in order for AppData to be visible.

===Time zone reading failed===
This is probably caused by a line-ending problem in the timezone files. Win32 users can resolve the problem by downloading a DOS to UNIX conversion utility available at http://www.nottingham.ac.uk/~eazdluf/d2u.zip. Run as `d2u *.tab` from within the timezone directory to fix your timezone files

===Traffic manager could not find airport===
There is either an airport missing from apt.dat, or there is a wrong ICAO code in a [[Interactive Traffic#Building Traffic Files|traffic file]]. An airport missing from apt.dat could be due to a recent opening.

===Unable to choose requested pixel format===
Error should be solved as of version 1.9. If not, try changing your [[FlightGear Launch Control#Page Four - Options and Run|BPP]] and/or resolution.

===Unable to find airport details for .... in FGTower::Init()===
This error can be surpressed by disabling [[Interactive Traffic|AI Traffic]], via the AI/ATC [[menu]].

The error appears when an airport in <tt>[[$FG_ROOT]]/Airports/apt.dat.gz</tt> cannot be found in <tt>[[$FG_ROOT]]/ATC/default.tower</tt> and <tt>[[$FG_ROOT]]/ATC/default.atis</tt>. Renaming the airports in the apt.dat.gz file ór in both default ATC files will fix the problem.

===Unable to open aircraft directory===
The [[aircraft]] that you are trying to run most likely relies on another aircraft, which you did not install (yet). The error shows what aircraft, so go download that one!
=== Unexpected tag '...' found in YASim aircraft description===
FlightGear found a non-existing tag in the [[FDM]] of the aircraft you are trying to launch. If you have not changed the original aircraft, contact the aircraft author. Else, check the FDM througly for mistakes.

=== Unknown ... aircraft: ... defaulting to C172 ===
FlightGear is unable to load the forced [[FDM]] (set through <tt>--fdm=...</tt> or via <tt>Advanced > Flight Model</tt> in [[FGRun]]) for this aircraft. FlightGear automatically picks the right FDM for each aircraft, so there is no need to set it manually, unless you know what you are doing. In the Flight Model dialog of FGRun, set the FDM to <tt>jsb</tt>; that is the "auto setting".

===Unknown exception to the main loop. Aborting... Possible cause: No such file or directory===
This error could have a variety of sources, among them missing files but also other things. Increasing the [[FlightGear_Launch_Control#Debugging|log level]] to debug and repeating excactly what you did when the error came up, might provide some more information on what FlightGear was doing when the error occurred.
* Setting your [[FlightGear Launch Control#Page Four - Options and Run|BPP]] to a lower value might work.
* Changing the resolution to a smaller one might work as well.

===WARNING: Couldn't convert texture...===
You are trying to run an aircraft not compatible with your FlightGear version. Most of the time, this error appears when you fly an aircraft, textured with .png files on versions older than 1.9. Convert the textures manually to .rgb or upgrade your FlightGear version.

===Warning: Picked up TriangleIntersect===
Reduce your [[FlightGear Launch Control#Debugging|Log Level]] to alert. Or [[Showstoppers|send the fgfs output to /dev/null (unix systems) or 2>nul (Windows)]]. The errors might still be shown, but do not affect the sim anymore.

===Warning: TangentSpaceGenerator: unknown primitive mode 9===
This is an [[OSG]] error, showing up when an effect needs tangent vectors, but polygons are not support. The error itself can be ignored, altough some [[shaders]] may look wrong. Shader developers should try to minimise the use of polygons and use triangles and quads instead.

===YASim SOLUTION FAILURE: Solution failed to converge after 10000 iterations===
Some control in the [[YASim]] [[FDM]] is too weak, according to YASim, to control the aircraft. An effectiveness tag will be required in the FDM to solve this error.

===YASim SOLUTION FAILURE: Zero length fuselage===
There is a problem in the [[FDM]]. A fuselage section with similar ax and ay was created. Change the ax and/or ay values to match the aircraft.

===FGMultiplayerMgr::Open - Failed to bind receive socket===

This means FlightGear was unable to open the listening network socket required by the --multiplay=in option. Frequently this option can be omitted and FlightGear will figure out the necessary parameters automatically.
Common reasons are:
* Address given in the option does not resolve to one of the IP addresses of the local machine. This parameter should only be required if you want to fine-tune the network behavior. Omitting it directs FlightGear to listen on all local interfaces automatically. Example:
--multiplay=in,10,,5001
Notice that you still need the comma.
* The UDP port given in the option (or the default port 5000 if no option given) is already in use. Verify nothing is using the port.

==Errors without known solutions==
Please take a look at the upcoming errors and see if you know a solution to get rid of them. Your additions are greatly appreciated!

===AL Error (fx): Invalid Value at pitch and gain===

===AL Error (sound manager): Invalid Operation at update===

===AL Error (sound manager): Invalid Value at buffer add data No such buffer!===

===Failed to execute command nasal===

===Failed to tie property ... to object methods===
A JSBSim error.

===FGMultiplayMgr::MP_ProcessData - message from ... has invalid length!===

===FGMultiplayerMgr::Open - Failed to bind recieve socket===

===GPS: malformed route, index=1===

===Mesa 7.3 implementation error: bad texture level in r300UploadSubImage===
http://www.flightgear.org/forums/viewtopic.php?f=2&t=6706&start=0&st=0&sk=t&sd=a

===Nasal runtime error: stack overflow===

===No image file for texture, using white===
A [[Shaders|shader]] error

===No path in /sim/sound/path===

===OpenAL error (AL_ILLEGAL_COMMAND): set_source_pos===

===OpenAL error (AL_ILLEGAL_COMMAND): set_volume===

===PT_vs_hpt: ran out of layers===

===Warning: detected OpenGL error 'invalid value' after RenderBin::draw(,)===

===Warning: GraphicsWindowWin32::grabFocus() - Failed grabbing the focus===

===WARNING: PUI: Too many live puInterfaces open at once!===
Appears when printing large outputs (very) frequently on the screen.

===Warning: State::drawQuads(0, 154400) too large handle in remapping to ushort glDrawElements===

[[Category:Howto|Get rid of common errors]]

[[fr:Howto: Débarrassez-vous des erreurs les plus fréquentes]]

Howto:Understand console output

2010-08-09T19:29:06Z

Jester: /* Errors without known solutions */ fix typo

This document lists '''[[FlightGear]] errors''', how to get rid of them and other '''console output'''. If FlightGear quits but does not give you any error, try increasing the [[FlightGear Launch Control#Debugging|Log Level]].

Errors can appear in various locations, but the most common one is the console (a black window), which pops up when you run fgfs.exe.

==Errors with known solutions==
===Airports/.... ... Done===
This is not an error. The message lets us know that [[TerraSync]] is updating the <tt>[[$FG_SCENERY]]/Airports</tt> directory.

===Base package check failed ... Found version [none] at: ... Please upgrade to version:===
* FlightGear was unable to find the [[$FG_ROOT]] directory. Set it using the <tt>--fg-root=</tt> commandline option.
* When using [[CVS]] with binaries, the data must match the binary. You cannot use data from a different date than the binary's release date.

===condition: comparison without property[1] or value===
A condition (like <tt><less-than></tt> or <tt><equals></tt>) exists, without either:
* a property to check
* a value to check the property against

===Could not find at least one of the following objects for animation:===
This means that FlightGear is unable to find an object in a .ac file. Check the .xml file (where the animation is stored) to see if the object-names match those in the .ac file. If you are not the aircraft's author you can safely ignore such warnings.

===creating 3D noise texture... DONE===
Tells you that a new noise texture is created. It is not an error and can be ignored.

===Error: [Screen #0] GraphicsWindowWin32::setPixelFormat() - No matching pixel format found based on traits specified====
Try changing the [[FlightGear Launch Control#Page Four - Options and Run|BPP]] value of your FlightGear setup. If that does not work, your graphics card is probably not able to run FlightGear 1.9 and higher. Another graphics card, or an older FlightGear version will likely "fix" the problem.

===Error: bind() failed in make_server_socket()===
When using [[Howto: Multiplayer|multiplayer]] or socket input, this usually means you specified an invalid ip address or the port is in use. Note: for multiplayer, you don't need to use the ''--multiplay=in,...'' option at all, FlightGear (since version 1.0) figures out the proper setting automatically. Only use when you know what you are doing.

===Error Building Technique: findAttr: could not find attribute bool===
Make sure that your data and source (or binary) match. They must be from the same date, to provide the best performance.

===Error: connect() failed in make_client_socket() SG_IO_OUT socket creation failed===
Your computer is not connected with the internet.

===Error: RenderTexture requires the following unsupported OpenGL extensions...===
Your graphics card doesn't support some graphics feature that FG requires. Update your drivers, change the BPP value and/or try disabling some of the visual goodies like [[3D Clouds]].

===Failed to find .... in apt.dat.gz===
You need to edit ATC/default.tower and ATC/default.atis. You can open these files with any text editor. Either remove or fix the entries containing your airports ICAO code (like KSFO).

===Failed to open file ...===
Check if the file exists on your system. If the missing file is a scenery object; be sure you have the latest [http://scenemodels.flightgear.org/download/SharedModels.tgz Shared Models] from the [[FlightGear Scenery Database]].

===Fatal error: mismatched tag ...===
In some .xml file, an opening tag (like <tt><sim></tt>) does not match its closing tag (like <tt></sim></tt>). This error is hard to track down, best method is to comment (place code between <nowiki></nowiki>) most of the aircraft. Then uncomment code one by one, until the error appears again.

===Fatal error: name must begin with alpha or '_'===
This error comes up when a property should be formed of which the name does not start with a letter of the alphabet or _. If this error only happens with certain planes, contact their authors.

===Fatal error: unclosed token===
A token (<nowiki></nowiki>) has been started, but not closes. Add <nowiki>--></nowiki> at the correct line.

===FGMultiplayMgr::MP_ProcessData: No such file or directory===
This is telling you that there's someone online on the multiplayerserver, using a plane that you do not have installed on your own system. In order to remove the error (and see the other plane) you have to install the plane that the other pilot is using.

===FGMultiplayMgr - No receiver port, Multiplayermode disabled===
FlightGear [[Howto: Multiplayer|multiplayer]] has not been set.

===FGPropertyManager::GetNode() No node found for ... In component: ... unknown property ... referenced. Aborting===
FlightGear found a reference in the [[FDM]] to a non-existing property.

===FGPropertyManager::GetNode() No node found for ... The property ... is undefined.===
FlightGear found a reference in the [[FDM]] to a non-existing property. Keep in mind that JSBSim reads the FDM from top to bottom. Properties should always be created before they are needed somewhere.

===Fgtzfile_read(): : Invalid argument Fatal error: Timezone reading failed===
This one is caused by wrong line ending in a timezone file. Solution might be to download the Timezone/time.tab file manually from [http://gitorious.org/fg/fgdata/blobs/raw/master/Timezone/zone.tab Gitorious] (Right mouseclick > Save target as) and overwrite the file in <tt>[[$FG_ROOT]]/Timezone/time.tab</tt> with it.

===Found unexpected subsystem: system exiting. JSBSim failed to load aircraft and/or engine model===
You are probably trying to run an aircraft on a out-of-date version of FlightGear. The planes on the official download page are intended to be used with the latest version of FlightGear. Usage on any older systems may not work.

===freeglut (fgfs): Unable to create direct context rendering for window 'FlightGear' This may hurt performance===
This reports that you do not have proper hardware accelerated 3D (direct rendering) configured.

===Gate ... doesn't seem to have routes associated with it===
A startup location in the [[Interactive Traffic#Ground networks|groundnetwork]] is not (properly) connected to a taxi route. Contact the airport author, or import the network to [[TaxiDraw]] and run the Verify network command to find the corrupted gate.

===glLinkProgram "" Failed===
Update your drivers; they have to support atleast OpenGL 2.0 for FlightGear 2.0 and later.

===loading scenario '...'===
This is not an error. It shows that an [[AI Systems#AI Models|AI scenario]] is loaded.

===Model not found: ...===
This one tells you that FlightGear was unable to find a certain file. The nice thing is that it also tells you excactly what file.

# Check if the file really does not exist at your computer.
# Try to locate the file in which the missing file is referenced. This is likely to be <tt>-set.xml</tt> in the root directory of the loaded [[aircraft]]. Between the <model> tags, the base model file is referenced. This file references to all other models that are displayed with the aircraft.
# Contact the aircraft author with a detailed bug-report, in which you state the excact location of the missing file and (if you found it) the file in which it is referenced.

===Nasal runtime error: nil used in numeric context===
This error is [[Nasal]] triggered by a Nasal file (the console should show what file (and line) and from where it was referenced). The Nasal script tried to do something with a [[Property Tree|property]] with an empty value. A solution is to fill the property before the Nasal is loaded. This can be done by setting the property in an [[aircraft]]'s <tt>-set.xml</tt> file or by adding a [[Nasal scripting language#Listeners and Signals|listener]] to the script.

[[Howto: Contact the developers|Contact the developers]] if this error is shown for a <tt>[[$FG_ROOT]]/Nasal/</tt> script.

===Near camera not rendering===
[[Image:Near_camera_off.png|500px]]

If you screen looks like the image above; make sure you have at least [[OSG]] version 2.7.6.

===No render bin name specified in render bin section===
Update [[SimGear]] (or binary) and your data directory.

===No render bin number specified in render bin section===
Update [[SimGear]] (or binary) and your data directory.

===... not a valid win32 application===
This Windows error could have various reasons to pop up. Usually, the file that is causing troubles is mentioned. Re-installing this file might solve the problem.

===OBJECT_SIGN: unsupported glyph `.'===
Check the OBJECT_SIGN lines in the .stg file of the tile that was loaded when this error showed up.

===OpenAL error <AL_INVALID_VALUE>: bind source <alGenSources> Failed to generate audio source.===
This error is probably displayed because of some misdirected audio settings in the [[aircraft]]s setup. Check the -sound.xml file of the aircraft and see if all files refered to really exist. If not, try to contact the author of the plane, so he can fix the problem in the [[FlightGear CVS|CVS]] version or solve the problem yourself and let someone commit the patch.

===OpenAL error (AL_INVALID_VALUE): constructor (alBufferData) Fatal error: Failed to buffer data.===
Disabling sound is a temporarily solution for this problem.

===osgDB ac3d reader: could not find texture...===
See [[#Failed to open file ...|Failed to open file ...]]

===osgDB ac3d reader: detected surface with less than 3 vertices!===
In one of the loaded models a non-existing surface is found. This can be a single line (sometimes used to simulate thin wires) or a fault in the model.

===Program's vertex attrib binding ..., usrAttr...===
Tells you that an effect binded certain attributes to a [[Shaders|shader]].

===QNAN===
(Q)NAN stands for (Quiet) Not A Number, produced by 0/0 or other floating point break downs. There can be various causes for this:
* Using a "flap start" value of 0 in the [[YASim]] [[FDM]]. Use some small value like 0.001 instead.

===Scaling image...===
This means a texture, whether in the scenery on your aircraft or anyone elses (when multiplayer is enabled), is not sized to powers of two. All textures in FlightGear have to be sized to power of two (eg. 16*16, 32*64, 32*1024). As of version 1.9 textures are resized automaticly, but it does slow your computer down, so it's better to resize the noted textures.

===ssgInit called without a valid OpenGL context===
In short, your GL libraries are broken. So far only Red Hat 7.x users have experienced this (see http://www.redhat.com/bugzilla/show_bug.cgi?id=18867). The only solutions are possibly complicated ones: you can either change distributions (most of us prefer Debian) or upgrade/downgrade your Mesa libs.

===The system cannot find the file specified===
If you are running Windows Vista; start by looking in <tt>C:\Users\Owner\AppData\Local\VirtualStore</tt> and seeing if you have a folder called FlightGear in there. If you do, cut-and-paste (merge) that one with <tt>C:\Program Files\Flightgear</tt> and try to launch FlightGear again.

'''Hint:''' you may need to go under Tools and Folder Options to specify "Show Hidden/System Files and Folders" in order for AppData to be visible.

===Time zone reading failed===
This is probably caused by a line-ending problem in the timezone files. Win32 users can resolve the problem by downloading a DOS to UNIX conversion utility available at http://www.nottingham.ac.uk/~eazdluf/d2u.zip. Run as `d2u *.tab` from within the timezone directory to fix your timezone files

===Traffic manager could not find airport===
There is either an airport missing from apt.dat, or there is a wrong ICAO code in a [[Interactive Traffic#Building Traffic Files|traffic file]]. An airport missing from apt.dat could be due to a recent opening.

===Unable to choose requested pixel format===
Error should be solved as of version 1.9. If not, try changing your [[FlightGear Launch Control#Page Four - Options and Run|BPP]] and/or resolution.

===Unable to find airport details for .... in FGTower::Init()===
This error can be surpressed by disabling [[Interactive Traffic|AI Traffic]], via the AI/ATC [[menu]].

The error appears when an airport in <tt>[[$FG_ROOT]]/Airports/apt.dat.gz</tt> cannot be found in <tt>[[$FG_ROOT]]/ATC/default.tower</tt> and <tt>[[$FG_ROOT]]/ATC/default.atis</tt>. Renaming the airports in the apt.dat.gz file ór in both default ATC files will fix the problem.

===Unable to open aircraft directory===
The [[aircraft]] that you are trying to run most likely relies on another aircraft, which you did not install (yet). The error shows what aircraft, so go download that one!
=== Unexpected tag '...' found in YASim aircraft description===
FlightGear found a non-existing tag in the [[FDM]] of the aircraft you are trying to launch. If you have not changed the original aircraft, contact the aircraft author. Else, check the FDM througly for mistakes.

=== Unknown ... aircraft: ... defaulting to C172 ===
FlightGear is unable to load the forced [[FDM]] (set through <tt>--fdm=...</tt> or via <tt>Advanced > Flight Model</tt> in [[FGRun]]) for this aircraft. FlightGear automatically picks the right FDM for each aircraft, so there is no need to set it manually, unless you know what you are doing. In the Flight Model dialog of FGRun, set the FDM to <tt>jsb</tt>; that is the "auto setting".

===Unknown exception to the main loop. Aborting... Possible cause: No such file or directory===
This error could have a variety of sources, among them missing files but also other things. Increasing the [[FlightGear_Launch_Control#Debugging|log level]] to debug and repeating excactly what you did when the error came up, might provide some more information on what FlightGear was doing when the error occurred.
* Setting your [[FlightGear Launch Control#Page Four - Options and Run|BPP]] to a lower value might work.
* Changing the resolution to a smaller one might work as well.

===WARNING: Couldn't convert texture...===
You are trying to run an aircraft not compatible with your FlightGear version. Most of the time, this error appears when you fly an aircraft, textured with .png files on versions older than 1.9. Convert the textures manually to .rgb or upgrade your FlightGear version.

===Warning: Picked up TriangleIntersect===
Reduce your [[FlightGear Launch Control#Debugging|Log Level]] to alert. Or [[Showstoppers|send the fgfs output to /dev/null (unix systems) or 2>nul (Windows)]]. The errors might still be shown, but do not affect the sim anymore.

===Warning: TangentSpaceGenerator: unknown primitive mode 9===
This is an [[OSG]] error, showing up when an effect needs tangent vectors, but polygons are not support. The error itself can be ignored, altough some [[shaders]] may look wrong. Shader developers should try to minimise the use of polygons and use triangles and quads instead.

===YASim SOLUTION FAILURE: Solution failed to converge after 10000 iterations===
Some control in the [[YASim]] [[FDM]] is too weak, according to YASim, to control the aircraft. An effectiveness tag will be required in the FDM to solve this error.

===YASim SOLUTION FAILURE: Zero length fuselage===
There is a problem in the [[FDM]]. A fuselage section with similar ax and ay was created. Change the ax and/or ay values to match the aircraft.

==Errors without known solutions==
Please take a look at the upcoming errors and see if you know a solution to get rid of them. Your additions are greatly appreciated!

===AL Error (fx): Invalid Value at pitch and gain===

===AL Error (sound manager): Invalid Operation at update===

===AL Error (sound manager): Invalid Value at buffer add data No such buffer!===

===Failed to execute command nasal===

===Failed to tie property ... to object methods===
A JSBSim error.

===FGMultiplayMgr::MP_ProcessData - message from ... has invalid length!===

===FGMultiplayerMgr::Open - Failed to bind recieve socket===

===GPS: malformed route, index=1===

===Mesa 7.3 implementation error: bad texture level in r300UploadSubImage===
http://www.flightgear.org/forums/viewtopic.php?f=2&t=6706&start=0&st=0&sk=t&sd=a

===Nasal runtime error: stack overflow===

===No image file for texture, using white===
A [[Shaders|shader]] error

===No path in /sim/sound/path===

===OpenAL error (AL_ILLEGAL_COMMAND): set_source_pos===

===OpenAL error (AL_ILLEGAL_COMMAND): set_volume===

===PT_vs_hpt: ran out of layers===

===Warning: detected OpenGL error 'invalid value' after RenderBin::draw(,)===

===Warning: GraphicsWindowWin32::grabFocus() - Failed grabbing the focus===

===WARNING: PUI: Too many live puInterfaces open at once!===
Appears when printing large outputs (very) frequently on the screen.

===Warning: State::drawQuads(0, 154400) too large handle in remapping to ushort glDrawElements===

[[Category:Howto|Get rid of common errors]]

[[fr:Howto: Débarrassez-vous des erreurs les plus fréquentes]]

Building FlightGear - Debian

2010-08-09T19:23:05Z

Jester: Extended git instructions for the data bundle

= HowTo build on Debian =

HowTo build FlightGear 2.0.0 or GIT on GNU/Linux Debian '''Stable''' 5.x (Lenny).

This HowTo may also work with '''Testing'''/'''Unstable''' except that some things are easier because of more up to date packages. So, before fetching something check the version of the available -dev package for it.

It even *should* work with '''Etch''', but I am not certain about some dependencies. [http://wiki.flightgear.org/index.php?title=Talk:Building_Flightgear_-_Debian&action=edit Reports] are welcome.

If you don't want to make your hands dirty, have a look at [[Scripted_Compilation_on_Linux_Debian/Ubuntu]].

== Requirements and Preparations ==
You need an OpenGL capable graphics including a proper installed driver. 

Also a bunch of packages (and some of their dependencies) are required:
*gcc, g++, make, automake1.9, pkg-config
*mawk (or gawk)
*cmake (min. version 2.6.0-5, for Etch available on backports.org!)
*git, subversion, wget

*freeglut3-dev, libgl1-mesa-dev, libxrandr-dev
*libxi-dev, libxmu-dev, libxext-dev
*libopenal-dev (see [[#libopenal|libopenal]]), libalut-dev
*libjpeg62-dev, libtiff4-dev, libpng12-dev
*libboost1.37-dev (Not available for Lenny atm, see [[#Boost Library|Boost Library]] below.)

During installation packages ''simgear-dev'' and ''openscenegraph-dev'' *must not* be installed. They can safely be re-installed after compilation.

== Build and install ==
Because we are going to install versions different to the ones in the repositries it is recommended to install FG-2.0.0 and/or GIT in a place independent to the base system such as /usr/local/FG-2.0.0, /opt/FG-2.0.0 or in a subdirectory of your $HOME. I suggest to make it writeable by the user that there is no need to become root for the <code>make install</code> commands. I'll use <code>$prefix</code> as a placeholder for this directory. 
Another one will be <code>$srcdir</code>, it stands for the absolute path to the directory which contains the folders of the various source codes. So in the following instructions you have to replace these with the local paths or even <code>export</code> them during the process.

Follow the instructions to fetch the sources and the data needed by FlightGear and the commands to build/install each source.

Have in mind that the data is relatively large (GIT about 3.5 GB and 2.0.0 300 MB) so, to save some time, it is a good idea to fetch it while building the sources.

=== libopenal ===
The libopenal-dev package in Lenny/Etch is too old for [[fgcom]]. For FlightGear it does work but not all features (like Doppler) are available, so installing an up to date version is recommended anyway.
cd $srcdir
wget http://kcat.strangesoft.net/openal-releases/openal-soft-1.11.753.tar.bz2
tar xjf openal-soft-1.11.753.tar.bz2
cd openal-soft-1.11.753/build
cmake -D CMAKE_INSTALL_PREFIX:PATH="$prefix" ..
make install

=== plib ===
Latest SVN is [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg20793.html recommended], yet package plib1.8.5-dev for Testing/Unstable does work as well.
cd $srcdir
svn co https://plib.svn.sourceforge.net/svnroot/plib/trunk plib
cd plib
sed s/PLIB_TINY_VERSION\ \ 5/PLIB_TINY_VERSION\ \ 6/ -i src/util/ul.h
./autogen.sh
./configure --prefix=$prefix
make install

=== Boost Library ===
Version 1.37 is needed. At least for Lenny/Etch this means getting the sources because this is not available atm on backports.org. Testing/Unstable users may have more luck and a package is available, libboost-1.37-dev or newer.

To build SimGear, FlightGear, fgrun and fgcom some boostlib header files are required, no need to compile and install it. If you have installed a libboost1.37-dev (or higher) package on your system you don't have to bother at all with it. If not, you have to tell each ./configure where the header files are. To do so, add the option <code>CPPFLAGS=-I$prefix/include</code> to the SimGear, FlightGear and fgrun <code>./configure</code> commands. We copy the header files to $prefix/include because fgcom will need them there.

Get the newest version tar ball from http://sourceforge.net/projects/boost/files/boost/, extract it into <code>$srcdir</code> then:
cp -R $srcdir/boost-[version]/boost/ $prefix/include/

=== OpenSceneGraph ===
For FlightGear 2.0.0 one may use the latest (or at least 2.9.6) developer release from http://www.openscenegraph.org/projects/osg/wiki/Downloads/DeveloperReleases and extract it into <code>$srcdir</code>.

Mostly this is ok for FlightGear GIT as well as it is stable. However, sometimes the release is not fresh enough and one have to get the latest developments via SVN:
cd $srcdir
svn co http://www.openscenegraph.org/svn/osg/OpenSceneGraph/trunk OpenSceneGraph

cmake demands a build directory separate to its source directory. So <code>mkdir</code> one and <code>cd</code> into it.
cmake -D CMAKE_BUILD_TYPE="Release" -D CMAKE_CXX_FLAGS="-O3" -D CMAKE_C_FLAGS="-O3" \
-D CMAKE_INSTALL_PREFIX:PATH="$prefix" $srcdir/OpenSceneGraph[-version]
make install

=== SimGear ===
2.0.0:
cd $srcdir
wget http://mirrors.ibiblio.org/pub/mirrors/simgear/ftp/Source/SimGear-2.0.0.tar.gz
tar xzf SimGear-2.0.0.tar.gz
cd SimGear-2.0.0

GIT:
cd $srcdir
git clone git://gitorious.org/fg/simgear.git simgear
cd simgear
./autogen.sh

2.0.0 and GIT:
./configure --prefix=$prefix [CPPFLAGS=-I$prefix/include LDFLAGS="-L$prefix/lib -L$prefix/lib64"]
make install

=== FlightGear source ===
2.0.0:
cd $srcdir
wget http://mirrors.ibiblio.org/pub/mirrors/flightgear/ftp/Source/FlightGear-2.0.0.tar.gz
tar xzf FlightGear-2.0.0.tar.gz
cd FlightGear-2.0.0

GIT:
cd $srcdir
git clone git://gitorious.org/fg/flightgear.git flightgear
cd flightgear
./autogen.sh

2.0.0 and GIT:
./configure --prefix=$prefix [CPPFLAGS=-I$prefix/include/ LDFLAGS="-L$prefix/lib -L$prefix/lib64"]
make install

=== FlightGear data ===
2.0.0:
cd $prefix
wget http://mirrors.ibiblio.org/pub/mirrors/flightgear/ftp/Shared/FlightGear-data-2.0.0.tar.bz2
tar xjf FlightGear-data-2.0.0.tar.bz2

GIT:
cd $prefix
git clone git://gitorious.org/fg/fgdata.git data

The primary gitorious source is known to have trouble cloning the data, the mapserver mirror usually has no problems:
cd $prefix
git clone git://mapserver.flightgear.org/fgdata data

Also, there are bundles (snapshots) available that can be retrieved with your favorite download manager. This way you can resume interrupted downloads. After unpacking only a comparatively small amount of data has to be transferred from the git server to synchronize your repository.
$ cd $prefix
$ wget http://flightgear.mxchange.org/pub/fgfs/fgdata.bundle
$ git clone fgdata.bundle fgdata
Initialized empty Git repository in fgdata/.git/
warning: unrecognized header: -deg" - /orientation/roll += "-deg" - /position/altitude += "-ft" - /position/altitude-agl += "-ft" - /position/latitude += "-deg" --/position/longitude += "-deg" - /radios/adf/frequencies/selected += "-khz" - /radios/adf/frequencies/
warning: remote HEAD refers to nonexistent ref, unable to checkout.
$ cd fgdata
$ git branch master-tmp origin/master
Branch master-tmp set up to track remote branch refs/remotes/origin/master.
$ git remote rm origin
$ git remote add origin git://gitorious.org/fg/fgdata
$ git fetch origin
remote: Counting objects: 5596, done.
remote: Compressing objects: 100% (2919/2919), done.
remote: Total 4266 (delta 2540), reused 2166 (delta 1297)
Receiving objects: 100% (4266/4266), 117.93 MiB | 1374 KiB/s, done.
Resolving deltas: 100% (2540/2540), completed with 628 local objects.
From git://gitorious.org/fg/fgdata
* [new branch] PRE_OSG_PLIB_20061029 -> origin/PRE_OSG_PLIB_20061029
* [new branch] master -> origin/master
* [new tag] last-cvs -> last-cvs
* [new tag] mapserver -> mapserver
$ git branch -D master-tmp
Deleted branch master-tmp.
$ git branch --track master origin/master
Branch master set up to track remote branch refs/remotes/origin/master.
$ git checkout

The bundle may be periodically updated and bundles from different sources need not be the same. The file size for the above bundle dated 2010-06-09 is 2394168314, while the md5 checksum is
$ md5sum fgdata.bundle
2996221bd2b8ab7740f332f49396cf56 fgdata.bundle

=== Trial run ===
When all the builds are done and the data download has finished it is time for a test run:
export LD_LIBRARY_PATH=$prefix/lib/:$LD_LIBRARY_PATH
$prefix/bin/fgfs --fg-root=$prefix/data

For the future, if you want to start FlightGear from command line have a look at [[fgfsrc]], if you prefer a graphical user interface continue with [[#fgrun|compiling fgrun]]. Have in mind that fgfs need to find our self compiled libraries and therefore we have to tell the linker (ld) where to find them. That is what the first line here does.

== Optional Software ==

=== fgrun ===
To build [[fgrun]] two more package is required:
*libfltk1.1-dev fluid

cd $srcdir
svn co http://fgrun.svn.sourceforge.net/svnroot/fgrun/trunk fgrun
cd fgrun/fgrun/
./autogen.sh
./configure --prefix=$prefix [CPPFLAGS=-I$prefix/include/]
make install

=== fgcom ===
For [[fgcom]] unfortunately there is one more dependency which cannot be solved with packages on Lenny/Etch, see [[#libopenal|libopenal]].

cd $srcdir
svn co https://appfgcom.svn.sourceforge.net/svnroot/fgcom/trunk fgcom
cd fgcom/src
make INSTALL_BIN=$prefix/bin INSTALL_DIR=$prefix/fgcom \
PLIB_PREFIX=$prefix OPENAL_PREFIX=$prefix install



{{Building}}

[[de:FlightGear_bauen_-_Debian]]

TerraSync

2010-05-25T13:32:51Z

Jester: Replaced /tmp terrasync directory with $HOME

To see the terrain below your aircraft, you have to install the respective [[scenery]]. This can happen by downloading certain bits of scenery before flying as described in the article [[Installing Scenery]].

Alternatively you can use '''TerraSync'''. It is a utility that automatically downloads the newest version of the needed [[FlightGear]] [[scenery]] while the simulator is running. TerraSync runs in the background in a separate process, monitors your position, and downloads (or updates) the latest greatest scenery from the master scenery server "just in time".

The master repository for terrasync, i.e. the online resource from which TerraSync downloads its files, is synchronized with the [http://scenemodels.flightgear.org/ FlightGear Scenery Database] once a day. So when using TerraSync, you will always have 1) the latest [[File_Formats#.2A.stg|.stg-files]], which tell FlightGear where to place an object and 2) the latest '''static''' scenery objects. Static scenery objects are such objects that exist in one place only.

: Important note: TerraSync does not download the newest '''shared''' scenery objects. Shared objects are such objects that are used more than once in the scenery, like generic houses or ships etc. If the set of shared scenery objects has changed since your version of FlightGear was released (usually that is the case), you need to install the newest [http://scenemodels.flightgear.org/download/SharedModels.tgz '''shared''' models archive] from the [http://scenemodels.flightgear.org/ FlightGear Scenery Database] to see all objects. Unpack it to <code>[FG_ROOT]\data\Models</code>.

It is recommended to use a separate scenery directory for TerraSync (i.e. do not run it on your main scenery directory) as network interruptions may upset the synchronization protocol - if/when that happens the easiest solution is to delete the affected subdirectory and let terrasync download it again.

===Usage example (for POSIX compliant [[command line]] shell)===

Start terrasync:

<code>% nice terrasync -p 5500 -S -d "$HOME/fgfsScenery"</code>

The -S option tells terrasync to use the SVN protocol to fetch data. If you omit it terrasync will use the rsync program instead (which has to be installed on your system).

Start FlightGear:

<code>% fgfs --atlas=socket,out,1,localhost,5500,udp --fg-scenery="$FG_ROOT/Scenery/:$HOME/fgfsScenery"</code>

The full documentation and source for TerraSync is located in the FlightGear source distribution (in <code>utils/TerraSync/</code>).

===Start TerraSync from fgrun.exe (Wizard in Windows) in FlightGear 1.9.1===

1. Make sure you are in the first screen where you can set up directories. To get there, start fgrun.exe. You'll first be in the Aircraft selection screen, then hit "Back". You are now here:

[[Image:TerraSync 1.png]]

2. Select the destination folder for all files downloaded by terrasync. Usually the folder <code>[FG_ROOT]\terrasync</code> already exists and you only have to add it to the list (as in the above example). Insure that it is positioned '''above''' your standard scenery folder (here that is <code>FlightGear191\scenery</code>) and all other directories over which the terrasync folder is supposed to have priority. When two directories contain information for the same region, FlightGear will take the information from the directory higher in the list.

3. For TerraSync to know where to deposit the downloaded files, you have to tell the program which folder is the destination folder. In the above example, it is the 3rd in the list.

4. Finally, go to the last screen. There you have to activate TerraSync as in the following screenshot. Now TerraSync should work.

[[Image:TerraSync 2.png]]

''Note: Expect your firewall to block in first place, since you request a new port (5505) in ud-protocol (UDP)'' .

See [[Installing Scenery]]

[[Category:Software]]

Howto:Carrier

2009-02-23T15:01:12Z

Jester: /* Land */ Added table of aircraft carriers w/ TACAN frequencies

'''AJ MacLeod'''

30th September 2005
Current Status (1st March 2006)
[[Image:Carrier3.jpg|thumb|300px|The Nimitz carrier in the San Fransisco bay]]
At the time of writing, it is possible with Flightgear 0.9.9 or a recent CVS copy to:

* start FG with your chosen aircraft placed on the aircraft carrier "Nimitz" or "Eisenhower"
* Engage the launchbar in the steam catapult
* Have the carrier set course into the prevailing wind direction and attempt to get wind speed over the deck at a suitable value for launch
* Launch from the deck when ready
* Set the TACAN reciever in the aircraft to Nimitz's channel (029Y) and have the heading and range to the carrier displayed on the cockpit instruments
* Land on the deck and be halted by the arrestor cables
* Taxi onto the deck elevators, operate them and park on the hangar deck (0.9.10 and later)

==What to do first==
Note: as of version 1.0, the default preferences has the Nimitz enabled, so you don't need to do the editing described below. Also, there is a command line option --ai-scenario you can use instead of editing.

To enable the carrier, you must edit your <tt>preferences.xml</tt> file. This lives in your FlightGear data directory, the one under which your Aircraft, Scenery etc directories reside. Open this file in a text editor (such as notepad on Windows, or TextEdit on OSX - Linux users are probably familiar with such software... try kedit or gedit if not.)

Search for the word ``nimitz'. You ought to find something that looks like this :


You should remove the ``comment' marks so that it looks like this:

<scenario>nimitz_demo</scenario>

Also ensure that the line above that referring to ai being enabled is set to "true"

Save the file and quit the text editor.
[[Image:Carrier4.jpg|thumb|300px|The [[FlightGear Wizard]]]]
You are now ready to start FlightGear. To position your [[aircraft]] on the carrier at startup, use the following [[Command Line Parameters|command line options]] (noting the upper-case "N") :
--carrier=Nimitz --aircraft=seahawk
or
--carrier=Eisenhower --aircraft=seahawk

Note that several FG aircraft are carrier capable, but the [[Hawker Seahawk|Seahawk]] is possibly the easiest to fly to begin with.

If you are using the Windows or OSX launcher to run FG, you should find a text entry box in the gui that allows you to specify command line options, add the above options there. Linux or Cygwin users can just add them to their usual startup command; ``fgfs --carrier=Nimitz --aircraft=seahawk'. Please note the uppercase ``N' in ``Nimitz'.

In the [[FlightGear Wizard]]: go to Advanced... > Properties and make a new property with
sim/ai/scenario[0]=nimitz_demo --carrier=Nimitz

With version 1.0.0 there comes a special box for the carriers on the Airport selection page of the Wizard.

==Takeoff==
[[Image:Carrier1.jpg|thumb|300px|The [[Hawker Seahawk|Seahawk]] aircraft ready for takeoff]]
Once FlightGear has started, you should ensure that the parking brakes are off, ease the plane a little way down the catapult pressing ``L' to engage the launchbar (this might be best done from an external view initially.) You should notice the aircraft being pulled into alignment with the catapult and see the strops appear and hold down the aircraft. This will only happen if your aircraft is close enough to the correct spot on the catapult; as a rough guide, for the default parking position the seahawk's nose should be rougly level with the deck observation bubble.

To get the carrier into as good a position as possible for launch, select the ``ATC/AI' menu, then check the ``Turn into wind' box under the ``AI Carrier' section.

You should now notice the carrier begin to pick up speed and turn into the wind, and naturally the deck may tilt somewhat as it turns. You should wait for this maneuver to finish and the deck to return to level before moving on to the next stage.
[[Image:Carrier6.jpg|thumb|300px|'''1:''' The takeoff part of the carrier with the catapults
'''2:''' The land part of the carrier with the wires]]
Being engaged to the catapult, you should spool up the engines to full power, ensure the brakes are off and that all flight controls are in a suitable position for launch. When ready, press ``C' to release the catapult. Your aircraft will be hurled forward off the deck, and you should be able to raise the undercarriage and climb slowly away, being careful to avoid stalling.

==Land==
Actually finding the carrier in a vast expanse of open water can be very difficult, especially if visibility is poor. To assist with this task, the carriers are equipped with [[TACAN]], which allows a suitably-equipped aircraft (Seahawk at present) to obtain a range and bearing to the carrier. First, you must set the appropriate TACAN channel, 029Y in this case, in the radios dialogue (ctrl-r or choose Equipment/Radio Settings from the FG [[menubar]]). You should, if within range, notice the DME instrument show your distance from the carrier, and the ADF instrument (next to the DME in the seahawk) should indicate a bearing to the carrier. Turn to the indicated heading and you should see the DME dial indicate your closing in on the carrier.

{|
! Carrier || Scenario || TACAN
|-
| Nimitz || nimitz_demo || 029Y
|-
| Eisenhower || nimitz_demo || 030Y
|-
| Clemenceau || clemenceau_demo || 026Y
|-
| Foch || foch_demo || 026X
|-
| Akagi || akagi || N/A
|}

This is the most difficult part of the operation, as in real life. You might well find Andy Ross' [[A-4F Skyhawk Operations Manual]] useful here. Basically, though, you should use the TACAN to locate the carrier, and line up with the rear of the deck. As this part of the deck is at an angle to the course of the vessel, you may need to correct your alignment often. Ensure that the aircraft is in the correct configuration for approach (the Help/Aircraft Help menu should contain useful data for your aircraft) and that the gear and the arrestor hook are down.
[[Image:Carrier5.jpg|thumb|300px|The Fresnel Lens Optical landing System]]
As you approach you should see, on the left hand side of the deck, a set of brightly coloured lights - called the Fresnel Lens Optical landing System (FLOLS). This indicates your position on the landing glideslope. You will see a horizontal row of green lights, and when approximately on the glideslope, an orange light ( known in some circles as the ``meatball') approximately in line with the green lights. When approaching correctly, the meatball appears in line with the green lights. If you are high it is above, and when low it is below. If you are very low the meatball turns red. If you fly to keep the meatball aligned you should catch number 3 wire.

Carrier landings are often described as ``controlled crashes' and you shouldn't waste your time attempting to flare and place the aircraft gently on the deck like you would with a conventional landing - ensuring that you catch the wires is the main thing.

Immediately your wheels touch the deck, you should open the throttles to full power, in case you have missed the wires and need to ``go around' again; the wires will hold the aircraft if you have caught them, even at full power.

If you wish, you can then (with 0.9.10 and later) raise the elevators from the ATC/AI menu, taxy onto one of the elevators, lower it (uncheck the box on the menu and don't worry, they are VERY slow...) and taxy off into the hangar.

Don't be discouraged if you don't succeed at first with carrier landings - it's not an easy maneouver to master. If after a little practice you find the Seahawk too easy, you could move on to the Seafire for more of a challenge!

==Related content==
* [[Carrier over MP]] to find out how you could control the carrier and/or use the carrier over the multiplayer network.

[[Category:Howto|Carrier]]

Howto:Carrier

2009-02-23T14:46:51Z

Jester: /* What to do first */ Mention that editing preferences.xml is no longer necessary

'''AJ MacLeod'''

30th September 2005
Current Status (1st March 2006)
[[Image:Carrier3.jpg|thumb|300px|The Nimitz carrier in the San Fransisco bay]]
At the time of writing, it is possible with Flightgear 0.9.9 or a recent CVS copy to:

* start FG with your chosen aircraft placed on the aircraft carrier "Nimitz" or "Eisenhower"
* Engage the launchbar in the steam catapult
* Have the carrier set course into the prevailing wind direction and attempt to get wind speed over the deck at a suitable value for launch
* Launch from the deck when ready
* Set the TACAN reciever in the aircraft to Nimitz's channel (029Y) and have the heading and range to the carrier displayed on the cockpit instruments
* Land on the deck and be halted by the arrestor cables
* Taxi onto the deck elevators, operate them and park on the hangar deck (0.9.10 and later)

==What to do first==
Note: as of version 1.0, the default preferences has the Nimitz enabled, so you don't need to do the editing described below. Also, there is a command line option --ai-scenario you can use instead of editing.

To enable the carrier, you must edit your <tt>preferences.xml</tt> file. This lives in your FlightGear data directory, the one under which your Aircraft, Scenery etc directories reside. Open this file in a text editor (such as notepad on Windows, or TextEdit on OSX - Linux users are probably familiar with such software... try kedit or gedit if not.)

Search for the word ``nimitz'. You ought to find something that looks like this :


You should remove the ``comment' marks so that it looks like this:

<scenario>nimitz_demo</scenario>

Also ensure that the line above that referring to ai being enabled is set to "true"

Save the file and quit the text editor.
[[Image:Carrier4.jpg|thumb|300px|The [[FlightGear Wizard]]]]
You are now ready to start FlightGear. To position your [[aircraft]] on the carrier at startup, use the following [[Command Line Parameters|command line options]] (noting the upper-case "N") :
--carrier=Nimitz --aircraft=seahawk
or
--carrier=Eisenhower --aircraft=seahawk

Note that several FG aircraft are carrier capable, but the [[Hawker Seahawk|Seahawk]] is possibly the easiest to fly to begin with.

If you are using the Windows or OSX launcher to run FG, you should find a text entry box in the gui that allows you to specify command line options, add the above options there. Linux or Cygwin users can just add them to their usual startup command; ``fgfs --carrier=Nimitz --aircraft=seahawk'. Please note the uppercase ``N' in ``Nimitz'.

In the [[FlightGear Wizard]]: go to Advanced... > Properties and make a new property with
sim/ai/scenario[0]=nimitz_demo --carrier=Nimitz

With version 1.0.0 there comes a special box for the carriers on the Airport selection page of the Wizard.

==Takeoff==
[[Image:Carrier1.jpg|thumb|300px|The [[Hawker Seahawk|Seahawk]] aircraft ready for takeoff]]
Once FlightGear has started, you should ensure that the parking brakes are off, ease the plane a little way down the catapult pressing ``L' to engage the launchbar (this might be best done from an external view initially.) You should notice the aircraft being pulled into alignment with the catapult and see the strops appear and hold down the aircraft. This will only happen if your aircraft is close enough to the correct spot on the catapult; as a rough guide, for the default parking position the seahawk's nose should be rougly level with the deck observation bubble.

To get the carrier into as good a position as possible for launch, select the ``ATC/AI' menu, then check the ``Turn into wind' box under the ``AI Carrier' section.

You should now notice the carrier begin to pick up speed and turn into the wind, and naturally the deck may tilt somewhat as it turns. You should wait for this maneuver to finish and the deck to return to level before moving on to the next stage.
[[Image:Carrier6.jpg|thumb|300px|'''1:''' The takeoff part of the carrier with the catapults
'''2:''' The land part of the carrier with the wires]]
Being engaged to the catapult, you should spool up the engines to full power, ensure the brakes are off and that all flight controls are in a suitable position for launch. When ready, press ``C' to release the catapult. Your aircraft will be hurled forward off the deck, and you should be able to raise the undercarriage and climb slowly away, being careful to avoid stalling.

==Land==
Actually finding the carrier in a vast expanse of open water can be very difficult, especially if visibility is poor. To assist with this task, the carriers are equipped with [[TACAN]], which allows a suitably-equipped aircraft (Seahawk at present) to obtain a range and bearing to the carrier. First, you must set the appropriate TACAN channel, 029Y in this case, in the radios dialogue (ctrl-r or choose Equipment/Radio Settings from the FG [[menubar]]). You should, if within range, notice the DME instrument show your distance from the carrier, and the ADF instrument (next to the DME in the seahawk) should indicate a bearing to the carrier. Turn to the indicated heading and you should see the DME dial indicate your closing in on the carrier.

This is the most difficult part of the operation, as in real life. You might well find Andy Ross' [[A-4F Skyhawk Operations Manual]] useful here. Basically, though, you should use the TACAN to locate the carrier, and line up with the rear of the deck. As this part of the deck is at an angle to the course of the vessel, you may need to correct your alignment often. Ensure that the aircraft is in the correct configuration for approach (the Help/Aircraft Help menu should contain useful data for your aircraft) and that the gear and the arrestor hook are down.
[[Image:Carrier5.jpg|thumb|300px|The Fresnel Lens Optical landing System]]
As you approach you should see, on the left hand side of the deck, a set of brightly coloured lights - called the Fresnel Lens Optical landing System (FLOLS). This indicates your position on the landing glideslope. You will see a horizontal row of green lights, and when approximately on the glideslope, an orange light ( known in some circles as the ``meatball') approximately in line with the green lights. When approaching correctly, the meatball appears in line with the green lights. If you are high it is above, and when low it is below. If you are very low the meatball turns red. If you fly to keep the meatball aligned you should catch number 3 wire.

Carrier landings are often described as ``controlled crashes' and you shouldn't waste your time attempting to flare and place the aircraft gently on the deck like you would with a conventional landing - ensuring that you catch the wires is the main thing.

Immediately your wheels touch the deck, you should open the throttles to full power, in case you have missed the wires and need to ``go around' again; the wires will hold the aircraft if you have caught them, even at full power.

If you wish, you can then (with 0.9.10 and later) raise the elevators from the ATC/AI menu, taxy onto one of the elevators, lower it (uncheck the box on the menu and don't worry, they are VERY slow...) and taxy off into the hangar.

Don't be discouraged if you don't succeed at first with carrier landings - it's not an easy maneouver to master. If after a little practice you find the Seahawk too easy, you could move on to the Seafire for more of a challenge!

==Related content==
* [[Carrier over MP]] to find out how you could control the carrier and/or use the carrier over the multiplayer network.

[[Category:Howto|Carrier]]

FGCom (before 3.0)

2009-02-14T19:24:39Z

Jester: /* Status */ fixed typo in server name

{{cleanup}}

'''FGCom''' is an addon for [[FlightGear]]. With FGCom (and the infrastructure behind), FlightGear gets a realtime voice communication system which could be used for [[ATC]]. The current version of fgcom is airport based - that means radio frequencies are based towards the location of the tower. Further version will fix this for a more realistic radio implementation (see [[Development]])

==Status==
*'''18 November, 2008:'''
Latest SVN (rev 163) has the compile problems fixed. Also we have a '''new server: fgcom.flightgear.org.uk'''. User accounts not required (ie. do '''not''' use -U or -P)
*'''31 October, 2008:'''

The latest SVN release at this time is the '''r149''' which does not compile due to a constant that is not defined (STL_STRING). Such constant appears at line 57 in the file ''src/fgcom_init.cpp'' which is:
''#include STL_STRING''

I guess that such constant must point to the STL library include file but I am not sure.
I revert to the '''r148''' SVN version which successfully compiles.

Command to get such version is: ''svn co -r148 svn://svn.dfn.de:/fgcom/trunk fgcom-r148''

* '''19 June, 2008:''' Currently the server is down due to hardware problems. It is unknown when the service comes back becuase he currently has no time to fix the problems.

* '''22 November 2007:''' Due to heavy development at this time there may be some differences between the information on the web pages and the installation. Please follow the discussions on the FlightGear development list!

==Client installation==
Before you start, make sure that your speakers and mic are working and tested to sensible volumes.
===Linux===
Fetch FGCom (a copy of a working iaxclient is inside)

svn checkout svn://svn.dfn.de:/fgcom/trunk fgcom

Optional: edit iaxclient/lib/Makefile

To use OpenAl (Recommended and the default for now. Note however, that it requires OpenAl with capture support.)

USE_PA_OSS=0
USE_PA_ALSA=0
USE_PA_JACK=0
AUDIO_ALSA=0
AUDIO_OPENAL=1

To use oss emulation

USE_PA_OSS=1
USE_PA_ALSA=0
USE_PA_JACK=0
AUDIO_ALSA=0
AUDIO_OPENAL=0

To use native alsa (WARNING: PTT won't work)

USE_PA_OSS=0
USE_PA_ALSA=0
USE_PA_JACK=0
AUDIO_ALSA=1
AUDIO_OPENAL=0

To use portaudio alsa (WARNING: only if your card natively supports 8000Hz sample rate)

USE_PA_OSS=0
USE_PA_ALSA=1
USE_PA_JACK=0
AUDIO_ALSA=0
AUDIO_OPENAL=0

Edit fgcom/src/Makefile and check the pathes for PLIB_PREFIX and OPENAL_PREFIX.

Compile iaxclient and fgcom. To do so, do the following:

cd fgcom/src && make

Install

make install

and you should be ready for a quick test...

==Using==
===Testing===
quick test

$ fgcom -Sfgcom.flightgear.org.uk -f910

will give the following output--
fgcom - a communication radio based on VoIP with IAX/Asterisk
(c)2007 by H. Wirtz <wirtz@dfn.de>
Version 1.2.2 build 163M
Using iaxclient library Version SVN 163M

Successfully parsed commandline options.
Reading list of airports...done.
Initializing IAX client as guest:xxxxxxxxxxx@fgcom.flightgear.org.uk
Call 0 accepted
Call 0 answered

speak into the mic and your words will be echoed back with a short delay.

type <nowiki>ctrl-C</nowiki> to exit this test

===Configuration===

''Or if it didn't work perfectly first time''

fgcom --help

returns the following useful info

fgcom - a communication radio based on VoIP with IAX/Asterisk
(c)2007 by H. Wirtz <wirtz@dfn.de>
Version 1.2.2 build 163M
Using iaxclient library Version SVN 163M

OPTION DESCRIPTION

-d, -debug, --debug= show debugging information
-S, -voipserver, --voipserver= voip server to connect to (default: 'fgcom1.parasitstudio.de')
-s, -fgserver, --fgserver= fg to connect to (default: 'localhost')
-p, -port, --port= where we should listen to FG (default: '16661')
-a, -airport, --airport= airport-id (ICAO) for ATC-mode
-f, -frequency, --frequency= frequency for ATC-mode
-U, -user, --user= username for VoIP account (default: 'guest')
-P, -password, --password= password for VoIP account (default: 'guest')
-i, -mic, --mic= mic input level (0.0 - 1.0)
-o, -speaker, --speaker= speaker output level (0.0 - 1.0)
-b, -mic-boost, --mic-boost= enable mic boost
-l, -list-audio, --list-audio= list audio devices
-r, -set-audio-in, --set-audio-in= use <devicename> as audio input
-k, -set-audio-out, --set-audio-out= use <devicename> as audio output
-c, -codec, --codec= use codec <codec> as transfer codec (default: 'u')

Available codecs:
u - ulaw (default and best codec because the mixing is based onto ulaw)
a - alaw
g - gsm
s - speex
7 - G.723

Mode 1: client for COM1 of flightgear:
$ fgcom
- connects fgcom to fgfs at localhost:16661
$ fgcom -sother.host.tld -p23456
- connects fgcom to fgfs at other.host.tld:23456

Mode 2: client for an ATC at <airport> on <frequency>:
$ fgcom -aKSFO -f120.500
- sets up fgcom for an ATC radio at KSFO 120.500 MHz

Note that /home/hcs/src/fgcom/trunk/src/fgcom starts with a guest account unless you use -U and -P!

Also note that the current server (fgcom.flightgear.co.uk) works with guest account, so '''do not use -U or -P'''

==Server installation==

For running a FGCOM server you need Asterisk and depending on the amount of users much bandwith and CPU power. Because of putting pilots and ATCs in a VoIP conference the server-admin has to assure that there is enough network and cpu power to avoid drop-outs of the voice stream.

===Prerequirements===

Install Asterisk on top of your favorite distribution. Please refer to installation manuals (e.g. [[http://www.asteriskguru.com/|Asterisk-Guru]]) you can find on the net. You do not need H.323 or SIP because the fgcom client uses IAX2 as VoIP signaling protocol. Only if you think about connecting external VoIP applications to FGCOM you should consider to activate H.323 or SIP (but this is not the scope of this small howto).

Notice: You need to install the zaptel driver modules - even if you won't use any hardware for telecom interfacing. You need the ztdummy kernel module for the asterisk conference application MeetMe() because it simulates a hardware clock needed by this application. Further development of FGCOM might use app_conference which don't needs any timing device.

For now we want to use /etc/asterisk as the base configuration directory.

===Setting up the radio frequencies===

The radio frequencies are "simple" Conferences and realized due to the Asterisk application MeetMe().

====Part 1: General configuration====

First you have to set up the general configuration of the system. Put the following at the top of your "extensions.conf" file:

[general]
static=yes
writeprotect=yes
;
[globals]
;
[macro-com]
exten => s,1,Answer()
exten => s,n,MeetMe(${MACRO_EXTEN},qd)
exten => s,n,Hangup()
;
[macro-echo]
exten => s,1,Answer()
exten => s,n,Echo()
exten => s,n,Hangup()
;
[guest]
; ATC-Help
exten => 01-ZZZZ-911.000,1,Macro(com)
exten => 012525252591100,1,Dial(Local/01-ZZZZ-911.000)
exten => 01-ZZZZ-910.000,1,Macro(echo)
exten => 012525252591000,1,Dial(Local/01-ZZZZ-910.000)
;
[default]
include => guest
;
; Code:
; 01 - FlightGear
; 02 - Microsoft Flight-Simulator
; 03 - ...
;
; Air2Air
exten => 01-ZZZZ-123.450,1,Macro(com)
exten => 012525252512345,1,Dial(Local/01-ZZZZ-123.450)
exten => 01-ZZZZ-122.750,1,Macro(com)
exten => 012525252512275,1,Dial(Local/01-ZZZZ-122.750)

====Part 2: Adding your favorite (all?) frequencies====

For this you have simply to create an extension for every touple of airport/frequency in extensions.conf. The following is an example for Berlin-Tempelhof (EDDI). The information comes from the file "apt.dat.gz" of your FlightGear installation.

; EDDI ATIS 126.020 - Berlin Tempelhof
exten => 01-EDDI-126.020,1,Macro(com)
exten => 010403030812602,1,Dial(Local/01-EDDI-126.020)
;
; EDDI BERLIN DEP 120.620 - Berlin Tempelhof
exten => 01-EDDI-120.620,1,Macro(com)
exten => 010403030812062,1,Dial(Local/01-EDDI-120.620)
;
; EDDI BERLIN DIRECTOR 121.120 - Berlin Tempelhof
exten => 01-EDDI-121.120,1,Macro(com)
exten => 010403030812112,1,Dial(Local/01-EDDI-121.120)
;
; EDDI BERLIN ARR 126.420 - Berlin Tempelhof
exten => 01-EDDI-126.420,1,Macro(com)
exten => 010403030812642,1,Dial(Local/01-EDDI-126.420)
;
; EDDI GND 121.950 - Berlin Tempelhof
exten => 01-EDDI-121.950,1,Macro(com)
exten => 010403030812195,1,Dial(Local/01-EDDI-121.950)
;
; EDDI TWR 119.570 - Berlin Tempelhof
exten => 01-EDDI-119.570,1,Macro(com)
exten => 010403030811957,1,Dial(Local/01-EDDI-119.570)
;
; EDDI BERLIN DIRECTOR 136.100 - Berlin Tempelhof
exten => 01-EDDI-136.100,1,Macro(com)
exten => 010403030813610,1,Dial(Local/01-EDDI-136.100)
;
; EDDI TWR 118.100 - Berlin Tempelhof
exten => 01-EDDI-118.100,1,Macro(com)
exten => 010403030811810,1,Dial(Local/01-EDDI-118.100)
;
; EDDI BERLIN DEP 119.500 - Berlin Tempelhof
exten => 01-EDDI-119.500,1,Macro(com)
exten => 010403030811950,1,Dial(Local/01-EDDI-119.500)
;
; EDDI BERLIN ARR 119.620 - Berlin Tempelhof
exten => 01-EDDI-119.620,1,Macro(com)
exten => 010403030811962,1,Dial(Local/01-EDDI-119.620)

What does the above mean? There are two lines (three with the comment) for each frequency: The first one sets up an extension named "01-EDDI-119.500". Yes, for VoIP you can use textual extensions but be careful if you want to setup your Asterisk-Server with POTS (=Plain old telephone service). Therefor you need the second line which is the same as above but without dashes and the letters in the decimal representation of the ASCII Code. The second line does only a "rewrite" of the numerical representation to the textual one.

For setting up all airports you can write your own simple script. But this maybe also not needed in further versions of FGCOM.

After editing the extensions.conf file you have to reload the extensions file (e.g. "asterisk -rx extensions reload").

You can add further nice goodies to your extensions.conf: MorseCode() for morsing the code of the VOR (MorseCode() will only work in Asterisk >= 1.4), Recording of metar data and playing this recording back when using the frequency of the metar information, ...

===Setting up user accounts===

The user accounts are located in the file iax.conf (and perhaps also in sip.conf, but this is not necessary). The top of the file should look like this:

[general]
bandwith=low
disallow=lpc10
jitterbuffer=yes
forcejitterbuffer=no
tos=lowdelay
autokill=yes
disallow=all
allow=alaw
allow=gsm
allow=ilbc
allow=g726
allow=ulaw
language=en
maxauthreq=10
context=guest
;
[guest]
type=user
username=guest
context=guest
qualify=yes
callerid=Guest IAX User
host=dynamic
;

You may want to disallow more codecs or want to allow additional codecs (such as speex). But have in mind that the internal mixing of the conferences are done in "ulaw". But "ulaw" needs about 80 kBit/s because it does no compression. So you have to think about what's better for you: less bandwidth (per user) and more CPU usage or more bandwidth (per user) and less CPU usage... you should also consider the "sound" of some codecs may not have the 'real radio sound'.

For each user you have to add a bunch of lines to your iax.conf file:

[<USERNAME>]
type=user
username=<USERNAME>
secret=<PASSWORD>
context=default
host=dynamic
nat=yes
notransfer=yes

You just have to fill in the <USERNAME> and <PASSWORD>. After each change you have to reload the configuration (e.g. "asterisk -rx reload chan_iax2.so"). Perhaps you want to write scripts for automatic configuration and so on. But be warned: Further versions of fgcom may use the multiplayer servers for getting usernames and position data and you have to change your scripts.

===Problems?===

If you have problems you can contact me via email at "dcoredump AT gmail.com".

==External links==
* [http://squonk.abacab.org/dokuwiki/fgcom Official website]
* [http://squonk.abacab.org/dokuwiki/fgcom-manual Manual]

==Development==

TODO

==See also==
*[[FlightGear related projects]]

[[Category:Software]]

Howto:Understand console output

2009-01-25T00:18:51Z

Jester: /* Near camera not rendering */ formatting

'''This document is intended to list common errors and how to get rid of them.'''

===OpenAL error <AL_INVALID_VALUE>: bind source <alGenSources> Failed to generate audio source.===
This error is probably displayed because of some misdirected audio settings in the aircrafts setup. Check the -sound.xml file of the aircraft and see if all files refered to really exist. If not, try to contact the author of the plane, so he can fix the problem in the CVS version or solve the problem yourself and let someone commit the patch.

===Found unexpected subsystem: system exiting. JSBSim failed to load aircraft and/or engine model===
You are probably trying to run an aircraft on a out-of-date version of FlightGear. The planes on the official download page are intended to be used with the latest version of FlightGear. Usage on any older systems may nog work.

===Unkown exeption to the main loop. Abording... Possible cause: No such file or directory===
Setting your BPP to a lower value might work.

===OpenAL error (AL_INVALID_VALUE): constructor (alBufferData) Fatal error: Failed to buffer data.===
Disabling sound is a temporarily solution for this problem.

===FGMultiplayMgr::MP_ProcessData: No such file or directory===
This is telling you that there's someone online on the multiplayerserver, using a plane that you do not have installed on your own system. In order to remove the error (and see the other plane) you have to install the plane that pilot is using.

===Error: bind() failed in make_server_socket()===
When using multiplayer or socket input, this usually means you specified an invalid ip address or the port is in use. Note: for multiplayer, you don't need to use the ''--multiplay=in,...'' option at all, FlightGear (since version 1.0) figures out the proper setting automatically. Only use when you know what you are doing.

===Near camera not rendering===
[[Image:Near_camera_off.png]]

Make sure you have at least OSG version 2.7.6.

[[Category:Howto|Get rid of common errors]]

Howto:Understand console output

2009-01-25T00:17:51Z

Jester: Added "near camera not rendering"

'''This document is intended to list common errors and how to get rid of them.'''

===OpenAL error <AL_INVALID_VALUE>: bind source <alGenSources> Failed to generate audio source.===
This error is probably displayed because of some misdirected audio settings in the aircrafts setup. Check the -sound.xml file of the aircraft and see if all files refered to really exist. If not, try to contact the author of the plane, so he can fix the problem in the CVS version or solve the problem yourself and let someone commit the patch.

===Found unexpected subsystem: system exiting. JSBSim failed to load aircraft and/or engine model===
You are probably trying to run an aircraft on a out-of-date version of FlightGear. The planes on the official download page are intended to be used with the latest version of FlightGear. Usage on any older systems may nog work.

===Unkown exeption to the main loop. Abording... Possible cause: No such file or directory===
Setting your BPP to a lower value might work.

===OpenAL error (AL_INVALID_VALUE): constructor (alBufferData) Fatal error: Failed to buffer data.===
Disabling sound is a temporarily solution for this problem.

===FGMultiplayMgr::MP_ProcessData: No such file or directory===
This is telling you that there's someone online on the multiplayerserver, using a plane that you do not have installed on your own system. In order to remove the error (and see the other plane) you have to install the plane that pilot is using.

===Error: bind() failed in make_server_socket()===
When using multiplayer or socket input, this usually means you specified an invalid ip address or the port is in use. Note: for multiplayer, you don't need to use the ''--multiplay=in,...'' option at all, FlightGear (since version 1.0) figures out the proper setting automatically. Only use when you know what you are doing.

===Near camera not rendering===
Make sure you have at least OSG version 2.7.6.
[[Image:Near_camera_off.png]]

[[Category:Howto|Get rid of common errors]]

File:Near camera off.png

2009-01-25T00:16:06Z

Jester: Illustration for near camera not rendering

Illustration for near camera not rendering

Howto:Understand console output

2009-01-23T14:32:35Z

Jester: Added bind() error

Howto:Understand console output

2009-01-23T14:26:50Z

Jester: Fixed typo

FGCom (before 3.0)

2008-12-28T03:56:35Z

Jester: /* Registration */ Removed

{{cleanup}}

'''FGCom''' is an addon for [[FlightGear]]. With FGCom (and the infrastructure behind), FlightGear gets a realtime voice communication system which could be used for [[ATC]]. The current version of fgcom is airport based - that means radio frequencies are based towards the location of the tower. Further version will fix this for a more realistic radio implementation (see [[Development]])

==Status==
*'''18 November, 2008:'''
Latest SVN (rev 163) has the compile problems fixed. Also we have a '''new server: fgcom.flightgear.co.uk'''. User accounts not required (ie. do '''not''' use -U or -P)
*'''31 October, 2008:'''

The latest SVN release at this time is the '''r149''' which does not compile due to a constant that is not defined (STL_STRING). Such constant appears at line 57 in the file ''src/fgcom_init.cpp'' which is:
''#include STL_STRING''

I guess that such constant must point to the STL library include file but I am not sure.
I revert to the '''r148''' SVN version which successfully compiles.

Command to get such version is: ''svn co -r148 svn://svn.dfn.de:/fgcom/trunk fgcom-r148''

* '''19 June, 2008:''' Currently the server is down due to hardware problems. It is unknown when the service comes back becuase he currently has no time to fix the problems.

* '''22 November 2007:''' Due to heavy development at this time there may be some differences between the information on the web pages and the installation. Please follow the discussions on the FlightGear development list!

==Client installation==
Before you start, make sure that your speakers and mic are working and tested to sensible volumes.
===Linux===
Fetch FGCom (a copy of a working iaxclient is inside)

svn checkout svn://svn.dfn.de:/fgcom/trunk fgcom

Optional: edit iaxclient/lib/Makefile

To use OpenAl (Recommended and the default for now. Note however, that it requires OpenAl with capture support.)

USE_PA_OSS=0
USE_PA_ALSA=0
USE_PA_JACK=0
AUDIO_ALSA=0
AUDIO_OPENAL=1

To use oss emulation

USE_PA_OSS=1
USE_PA_ALSA=0
USE_PA_JACK=0
AUDIO_ALSA=0
AUDIO_OPENAL=0

To use native alsa (WARNING: PTT won't work)

USE_PA_OSS=0
USE_PA_ALSA=0
USE_PA_JACK=0
AUDIO_ALSA=1
AUDIO_OPENAL=0

To use portaudio alsa (WARNING: only if your card natively supports 8000Hz sample rate)

USE_PA_OSS=0
USE_PA_ALSA=1
USE_PA_JACK=0
AUDIO_ALSA=0
AUDIO_OPENAL=0

Edit fgcom/src/Makefile and check the pathes for PLIB_PREFIX and OPENAL_PREFIX.

Compile iaxclient and fgcom. To do so, do the following:

cd fgcom/src && make

Install

make install

and you should be ready for a quick test...

==Using==
===Testing===
quick test

$ fgcom -Sfgcom.flightgear.org.uk -f910

will give the following output--
fgcom - a communication radio based on VoIP with IAX/Asterisk
(c)2007 by H. Wirtz <wirtz@dfn.de>
Version 1.2.2 build 163M
Using iaxclient library Version SVN 163M

Successfully parsed commandline options.
Reading list of airports...done.
Initializing IAX client as guest:xxxxxxxxxxx@fgcom.flightgear.org.uk
Call 0 accepted
Call 0 answered

speak into the mic and your words will be echoed back with a short delay.

type <nowiki>ctrl-C</nowiki> to exit this test

===Configuration===

''Or if it didn't work perfectly first time''

fgcom --help

returns the following useful info

fgcom - a communication radio based on VoIP with IAX/Asterisk
(c)2007 by H. Wirtz <wirtz@dfn.de>
Version 1.2.2 build 163M
Using iaxclient library Version SVN 163M

OPTION DESCRIPTION

-d, -debug, --debug= show debugging information
-S, -voipserver, --voipserver= voip server to connect to (default: 'fgcom1.parasitstudio.de')
-s, -fgserver, --fgserver= fg to connect to (default: 'localhost')
-p, -port, --port= where we should listen to FG (default: '16661')
-a, -airport, --airport= airport-id (ICAO) for ATC-mode
-f, -frequency, --frequency= frequency for ATC-mode
-U, -user, --user= username for VoIP account (default: 'guest')
-P, -password, --password= password for VoIP account (default: 'guest')
-i, -mic, --mic= mic input level (0.0 - 1.0)
-o, -speaker, --speaker= speaker output level (0.0 - 1.0)
-b, -mic-boost, --mic-boost= enable mic boost
-l, -list-audio, --list-audio= list audio devices
-r, -set-audio-in, --set-audio-in= use <devicename> as audio input
-k, -set-audio-out, --set-audio-out= use <devicename> as audio output
-c, -codec, --codec= use codec <codec> as transfer codec (default: 'u')

Available codecs:
u - ulaw (default and best codec because the mixing is based onto ulaw)
a - alaw
g - gsm
s - speex
7 - G.723

Mode 1: client for COM1 of flightgear:
$ fgcom
- connects fgcom to fgfs at localhost:16661
$ fgcom -sother.host.tld -p23456
- connects fgcom to fgfs at other.host.tld:23456

Mode 2: client for an ATC at <airport> on <frequency>:
$ fgcom -aKSFO -f120.500
- sets up fgcom for an ATC radio at KSFO 120.500 MHz

Note that /home/hcs/src/fgcom/trunk/src/fgcom starts with a guest account unless you use -U and -P!

Also note that the current server (fgcom.flightgear.co.uk) works with guest account, so '''do not use -U or -P'''

==Server installation==

For running a FGCOM server you need Asterisk and depending on the amount of users much bandwith and CPU power. Because of putting pilots and ATCs in a VoIP conference the server-admin has to assure that there is enough network and cpu power to avoid drop-outs of the voice stream.

===Prerequirements===

Install Asterisk on top of your favorite distribution. Please refer to installation manuals (e.g. [[http://www.asteriskguru.com/|Asterisk-Guru]]) you can find on the net. You do not need H.323 or SIP because the fgcom client uses IAX2 as VoIP signaling protocol. Only if you think about connecting external VoIP applications to FGCOM you should consider to activate H.323 or SIP (but this is not the scope of this small howto).

Notice: You need to install the zaptel driver modules - even if you won't use any hardware for telecom interfacing. You need the ztdummy kernel module for the asterisk conference application MeetMe() because it simulates a hardware clock needed by this application. Further development of FGCOM might use app_conference which don't needs any timing device.

For now we want to use /etc/asterisk as the base configuration directory.

===Setting up the radio frequencies===

The radio frequencies are "simple" Conferences and realized due to the Asterisk application MeetMe().

====Part 1: General configuration====

First you have to set up the general configuration of the system. Put the following at the top of your "extensions.conf" file:

[general]
static=yes
writeprotect=yes
;
[globals]
;
[macro-com]
exten => s,1,Answer()
exten => s,n,MeetMe(${MACRO_EXTEN},qd)
exten => s,n,Hangup()
;
[macro-echo]
exten => s,1,Answer()
exten => s,n,Echo()
exten => s,n,Hangup()
;
[guest]
; ATC-Help
exten => 01-ZZZZ-911.000,1,Macro(com)
exten => 012525252591100,1,Dial(Local/01-ZZZZ-911.000)
exten => 01-ZZZZ-910.000,1,Macro(echo)
exten => 012525252591000,1,Dial(Local/01-ZZZZ-910.000)
;
[default]
include => guest
;
; Code:
; 01 - FlightGear
; 02 - Microsoft Flight-Simulator
; 03 - ...
;
; Air2Air
exten => 01-ZZZZ-123.450,1,Macro(com)
exten => 012525252512345,1,Dial(Local/01-ZZZZ-123.450)
exten => 01-ZZZZ-122.750,1,Macro(com)
exten => 012525252512275,1,Dial(Local/01-ZZZZ-122.750)

====Part 2: Adding your favorite (all?) frequencies====

For this you have simply to create an extension for every touple of airport/frequency in extensions.conf. The following is an example for Berlin-Tempelhof (EDDI). The information comes from the file "apt.dat.gz" of your FlightGear installation.

; EDDI ATIS 126.020 - Berlin Tempelhof
exten => 01-EDDI-126.020,1,Macro(com)
exten => 010403030812602,1,Dial(Local/01-EDDI-126.020)
;
; EDDI BERLIN DEP 120.620 - Berlin Tempelhof
exten => 01-EDDI-120.620,1,Macro(com)
exten => 010403030812062,1,Dial(Local/01-EDDI-120.620)
;
; EDDI BERLIN DIRECTOR 121.120 - Berlin Tempelhof
exten => 01-EDDI-121.120,1,Macro(com)
exten => 010403030812112,1,Dial(Local/01-EDDI-121.120)
;
; EDDI BERLIN ARR 126.420 - Berlin Tempelhof
exten => 01-EDDI-126.420,1,Macro(com)
exten => 010403030812642,1,Dial(Local/01-EDDI-126.420)
;
; EDDI GND 121.950 - Berlin Tempelhof
exten => 01-EDDI-121.950,1,Macro(com)
exten => 010403030812195,1,Dial(Local/01-EDDI-121.950)
;
; EDDI TWR 119.570 - Berlin Tempelhof
exten => 01-EDDI-119.570,1,Macro(com)
exten => 010403030811957,1,Dial(Local/01-EDDI-119.570)
;
; EDDI BERLIN DIRECTOR 136.100 - Berlin Tempelhof
exten => 01-EDDI-136.100,1,Macro(com)
exten => 010403030813610,1,Dial(Local/01-EDDI-136.100)
;
; EDDI TWR 118.100 - Berlin Tempelhof
exten => 01-EDDI-118.100,1,Macro(com)
exten => 010403030811810,1,Dial(Local/01-EDDI-118.100)
;
; EDDI BERLIN DEP 119.500 - Berlin Tempelhof
exten => 01-EDDI-119.500,1,Macro(com)
exten => 010403030811950,1,Dial(Local/01-EDDI-119.500)
;
; EDDI BERLIN ARR 119.620 - Berlin Tempelhof
exten => 01-EDDI-119.620,1,Macro(com)
exten => 010403030811962,1,Dial(Local/01-EDDI-119.620)

What does the above mean? There are two lines (three with the comment) for each frequency: The first one sets up an extension named "01-EDDI-119.500". Yes, for VoIP you can use textual extensions but be careful if you want to setup your Asterisk-Server with POTS (=Plain old telephone service). Therefor you need the second line which is the same as above but without dashes and the letters in the decimal representation of the ASCII Code. The second line does only a "rewrite" of the numerical representation to the textual one.

For setting up all airports you can write your own simple script. But this maybe also not needed in further versions of FGCOM.

After editing the extensions.conf file you have to reload the extensions file (e.g. "asterisk -rx extensions reload").

You can add further nice goodies to your extensions.conf: MorseCode() for morsing the code of the VOR (MorseCode() will only work in Asterisk >= 1.4), Recording of metar data and playing this recording back when using the frequency of the metar information, ...

===Setting up user accounts===

The user accounts are located in the file iax.conf (and perhaps also in sip.conf, but this is not necessary). The top of the file should look like this:

[general]
bandwith=low
disallow=lpc10
jitterbuffer=yes
forcejitterbuffer=no
tos=lowdelay
autokill=yes
disallow=all
allow=alaw
allow=gsm
allow=ilbc
allow=g726
allow=ulaw
language=en
maxauthreq=10
context=guest
;
[guest]
type=user
username=guest
context=guest
qualify=yes
callerid=Guest IAX User
host=dynamic
;

You may want to disallow more codecs or want to allow additional codecs (such as speex). But have in mind that the internal mixing of the conferences are done in "ulaw". But "ulaw" needs about 80 kBit/s because it does no compression. So you have to think about what's better for you: less bandwidth (per user) and more CPU usage or more bandwidth (per user) and less CPU usage... you should also consider the "sound" of some codecs may not have the 'real radio sound'.

For each user you have to add a bunch of lines to your iax.conf file:

[<USERNAME>]
type=user
username=<USERNAME>
secret=<PASSWORD>
context=default
host=dynamic
nat=yes
notransfer=yes

You just have to fill in the <USERNAME> and <PASSWORD>. After each change you have to reload the configuration (e.g. "asterisk -rx reload chan_iax2.so"). Perhaps you want to write scripts for automatic configuration and so on. But be warned: Further versions of fgcom may use the multiplayer servers for getting usernames and position data and you have to change your scripts.

===Problems?===

If you have problems you can contact me via email at "dcoredump AT gmail.com".

==External links==
* [http://squonk.abacab.org/dokuwiki/fgcom Official website]
* [http://squonk.abacab.org/dokuwiki/fgcom-manual Manual]

==Development==

TODO

==See also==
*[[FlightGear related projects]]

[[Category:Software]]

FGCom (before 3.0)

2008-12-28T03:55:17Z

Jester: /* Configuration */ Updated

{{cleanup}}

'''FGCom''' is an addon for [[FlightGear]]. With FGCom (and the infrastructure behind), FlightGear gets a realtime voice communication system which could be used for [[ATC]]. The current version of fgcom is airport based - that means radio frequencies are based towards the location of the tower. Further version will fix this for a more realistic radio implementation (see [[Development]])

==Status==
*'''18 November, 2008:'''
Latest SVN (rev 163) has the compile problems fixed. Also we have a '''new server: fgcom.flightgear.co.uk'''. User accounts not required (ie. do '''not''' use -U or -P)
*'''31 October, 2008:'''

The latest SVN release at this time is the '''r149''' which does not compile due to a constant that is not defined (STL_STRING). Such constant appears at line 57 in the file ''src/fgcom_init.cpp'' which is:
''#include STL_STRING''

I guess that such constant must point to the STL library include file but I am not sure.
I revert to the '''r148''' SVN version which successfully compiles.

Command to get such version is: ''svn co -r148 svn://svn.dfn.de:/fgcom/trunk fgcom-r148''

* '''19 June, 2008:''' Currently the server is down due to hardware problems. It is unknown when the service comes back becuase he currently has no time to fix the problems.

* '''22 November 2007:''' Due to heavy development at this time there may be some differences between the information on the web pages and the installation. Please follow the discussions on the FlightGear development list!

==Client installation==
Before you start, make sure that your speakers and mic are working and tested to sensible volumes.
===Linux===
Fetch FGCom (a copy of a working iaxclient is inside)

svn checkout svn://svn.dfn.de:/fgcom/trunk fgcom

Optional: edit iaxclient/lib/Makefile

To use OpenAl (Recommended and the default for now. Note however, that it requires OpenAl with capture support.)

USE_PA_OSS=0
USE_PA_ALSA=0
USE_PA_JACK=0
AUDIO_ALSA=0
AUDIO_OPENAL=1

To use oss emulation

USE_PA_OSS=1
USE_PA_ALSA=0
USE_PA_JACK=0
AUDIO_ALSA=0
AUDIO_OPENAL=0

To use native alsa (WARNING: PTT won't work)

USE_PA_OSS=0
USE_PA_ALSA=0
USE_PA_JACK=0
AUDIO_ALSA=1
AUDIO_OPENAL=0

To use portaudio alsa (WARNING: only if your card natively supports 8000Hz sample rate)

USE_PA_OSS=0
USE_PA_ALSA=1
USE_PA_JACK=0
AUDIO_ALSA=0
AUDIO_OPENAL=0

Edit fgcom/src/Makefile and check the pathes for PLIB_PREFIX and OPENAL_PREFIX.

Compile iaxclient and fgcom. To do so, do the following:

cd fgcom/src && make

Install

make install

and you should be ready for a quick test...

==Using==
===Testing===
quick test

$ fgcom -Sfgcom.flightgear.org.uk -f910

will give the following output--
fgcom - a communication radio based on VoIP with IAX/Asterisk
(c)2007 by H. Wirtz <wirtz@dfn.de>
Version 1.2.2 build 163M
Using iaxclient library Version SVN 163M

Successfully parsed commandline options.
Reading list of airports...done.
Initializing IAX client as guest:xxxxxxxxxxx@fgcom.flightgear.org.uk
Call 0 accepted
Call 0 answered

speak into the mic and your words will be echoed back with a short delay.

type <nowiki>ctrl-C</nowiki> to exit this test

===Configuration===

''Or if it didn't work perfectly first time''

fgcom --help

returns the following useful info

fgcom - a communication radio based on VoIP with IAX/Asterisk
(c)2007 by H. Wirtz <wirtz@dfn.de>
Version 1.2.2 build 163M
Using iaxclient library Version SVN 163M

OPTION DESCRIPTION

-d, -debug, --debug= show debugging information
-S, -voipserver, --voipserver= voip server to connect to (default: 'fgcom1.parasitstudio.de')
-s, -fgserver, --fgserver= fg to connect to (default: 'localhost')
-p, -port, --port= where we should listen to FG (default: '16661')
-a, -airport, --airport= airport-id (ICAO) for ATC-mode
-f, -frequency, --frequency= frequency for ATC-mode
-U, -user, --user= username for VoIP account (default: 'guest')
-P, -password, --password= password for VoIP account (default: 'guest')
-i, -mic, --mic= mic input level (0.0 - 1.0)
-o, -speaker, --speaker= speaker output level (0.0 - 1.0)
-b, -mic-boost, --mic-boost= enable mic boost
-l, -list-audio, --list-audio= list audio devices
-r, -set-audio-in, --set-audio-in= use <devicename> as audio input
-k, -set-audio-out, --set-audio-out= use <devicename> as audio output
-c, -codec, --codec= use codec <codec> as transfer codec (default: 'u')

Available codecs:
u - ulaw (default and best codec because the mixing is based onto ulaw)
a - alaw
g - gsm
s - speex
7 - G.723

Mode 1: client for COM1 of flightgear:
$ fgcom
- connects fgcom to fgfs at localhost:16661
$ fgcom -sother.host.tld -p23456
- connects fgcom to fgfs at other.host.tld:23456

Mode 2: client for an ATC at <airport> on <frequency>:
$ fgcom -aKSFO -f120.500
- sets up fgcom for an ATC radio at KSFO 120.500 MHz

Note that /home/hcs/src/fgcom/trunk/src/fgcom starts with a guest account unless you use -U and -P!

Also note that the current server (fgcom.flightgear.co.uk) works with guest account, so '''do not use -U or -P'''

===Registration===
'''To make full use of FGCOM you will need an account!'''

Please email <nowiki> wirtz <at> dfn <dot> de</nowiki> (replace with @ and .) and login details will be sent to you shortly. Accounts will not be made until Autumn 2008. But you can test without an account (by default the used account is guest, password guest) with restricted frequency use. As guest you can only use the following frequencies:

* 911.000 MHz (ATC-Help)
* 910.000 MHz (Echo-Box)
* 123.450 MHz (Air2Air 1)
* 122.750 Mhz (Air2Air 2)

==Server installation==

For running a FGCOM server you need Asterisk and depending on the amount of users much bandwith and CPU power. Because of putting pilots and ATCs in a VoIP conference the server-admin has to assure that there is enough network and cpu power to avoid drop-outs of the voice stream.

===Prerequirements===

Install Asterisk on top of your favorite distribution. Please refer to installation manuals (e.g. [[http://www.asteriskguru.com/|Asterisk-Guru]]) you can find on the net. You do not need H.323 or SIP because the fgcom client uses IAX2 as VoIP signaling protocol. Only if you think about connecting external VoIP applications to FGCOM you should consider to activate H.323 or SIP (but this is not the scope of this small howto).

Notice: You need to install the zaptel driver modules - even if you won't use any hardware for telecom interfacing. You need the ztdummy kernel module for the asterisk conference application MeetMe() because it simulates a hardware clock needed by this application. Further development of FGCOM might use app_conference which don't needs any timing device.

For now we want to use /etc/asterisk as the base configuration directory.

===Setting up the radio frequencies===

The radio frequencies are "simple" Conferences and realized due to the Asterisk application MeetMe().

====Part 1: General configuration====

First you have to set up the general configuration of the system. Put the following at the top of your "extensions.conf" file:

[general]
static=yes
writeprotect=yes
;
[globals]
;
[macro-com]
exten => s,1,Answer()
exten => s,n,MeetMe(${MACRO_EXTEN},qd)
exten => s,n,Hangup()
;
[macro-echo]
exten => s,1,Answer()
exten => s,n,Echo()
exten => s,n,Hangup()
;
[guest]
; ATC-Help
exten => 01-ZZZZ-911.000,1,Macro(com)
exten => 012525252591100,1,Dial(Local/01-ZZZZ-911.000)
exten => 01-ZZZZ-910.000,1,Macro(echo)
exten => 012525252591000,1,Dial(Local/01-ZZZZ-910.000)
;
[default]
include => guest
;
; Code:
; 01 - FlightGear
; 02 - Microsoft Flight-Simulator
; 03 - ...
;
; Air2Air
exten => 01-ZZZZ-123.450,1,Macro(com)
exten => 012525252512345,1,Dial(Local/01-ZZZZ-123.450)
exten => 01-ZZZZ-122.750,1,Macro(com)
exten => 012525252512275,1,Dial(Local/01-ZZZZ-122.750)

====Part 2: Adding your favorite (all?) frequencies====

For this you have simply to create an extension for every touple of airport/frequency in extensions.conf. The following is an example for Berlin-Tempelhof (EDDI). The information comes from the file "apt.dat.gz" of your FlightGear installation.

; EDDI ATIS 126.020 - Berlin Tempelhof
exten => 01-EDDI-126.020,1,Macro(com)
exten => 010403030812602,1,Dial(Local/01-EDDI-126.020)
;
; EDDI BERLIN DEP 120.620 - Berlin Tempelhof
exten => 01-EDDI-120.620,1,Macro(com)
exten => 010403030812062,1,Dial(Local/01-EDDI-120.620)
;
; EDDI BERLIN DIRECTOR 121.120 - Berlin Tempelhof
exten => 01-EDDI-121.120,1,Macro(com)
exten => 010403030812112,1,Dial(Local/01-EDDI-121.120)
;
; EDDI BERLIN ARR 126.420 - Berlin Tempelhof
exten => 01-EDDI-126.420,1,Macro(com)
exten => 010403030812642,1,Dial(Local/01-EDDI-126.420)
;
; EDDI GND 121.950 - Berlin Tempelhof
exten => 01-EDDI-121.950,1,Macro(com)
exten => 010403030812195,1,Dial(Local/01-EDDI-121.950)
;
; EDDI TWR 119.570 - Berlin Tempelhof
exten => 01-EDDI-119.570,1,Macro(com)
exten => 010403030811957,1,Dial(Local/01-EDDI-119.570)
;
; EDDI BERLIN DIRECTOR 136.100 - Berlin Tempelhof
exten => 01-EDDI-136.100,1,Macro(com)
exten => 010403030813610,1,Dial(Local/01-EDDI-136.100)
;
; EDDI TWR 118.100 - Berlin Tempelhof
exten => 01-EDDI-118.100,1,Macro(com)
exten => 010403030811810,1,Dial(Local/01-EDDI-118.100)
;
; EDDI BERLIN DEP 119.500 - Berlin Tempelhof
exten => 01-EDDI-119.500,1,Macro(com)
exten => 010403030811950,1,Dial(Local/01-EDDI-119.500)
;
; EDDI BERLIN ARR 119.620 - Berlin Tempelhof
exten => 01-EDDI-119.620,1,Macro(com)
exten => 010403030811962,1,Dial(Local/01-EDDI-119.620)

What does the above mean? There are two lines (three with the comment) for each frequency: The first one sets up an extension named "01-EDDI-119.500". Yes, for VoIP you can use textual extensions but be careful if you want to setup your Asterisk-Server with POTS (=Plain old telephone service). Therefor you need the second line which is the same as above but without dashes and the letters in the decimal representation of the ASCII Code. The second line does only a "rewrite" of the numerical representation to the textual one.

For setting up all airports you can write your own simple script. But this maybe also not needed in further versions of FGCOM.

After editing the extensions.conf file you have to reload the extensions file (e.g. "asterisk -rx extensions reload").

You can add further nice goodies to your extensions.conf: MorseCode() for morsing the code of the VOR (MorseCode() will only work in Asterisk >= 1.4), Recording of metar data and playing this recording back when using the frequency of the metar information, ...

===Setting up user accounts===

The user accounts are located in the file iax.conf (and perhaps also in sip.conf, but this is not necessary). The top of the file should look like this:

[general]
bandwith=low
disallow=lpc10
jitterbuffer=yes
forcejitterbuffer=no
tos=lowdelay
autokill=yes
disallow=all
allow=alaw
allow=gsm
allow=ilbc
allow=g726
allow=ulaw
language=en
maxauthreq=10
context=guest
;
[guest]
type=user
username=guest
context=guest
qualify=yes
callerid=Guest IAX User
host=dynamic
;

You may want to disallow more codecs or want to allow additional codecs (such as speex). But have in mind that the internal mixing of the conferences are done in "ulaw". But "ulaw" needs about 80 kBit/s because it does no compression. So you have to think about what's better for you: less bandwidth (per user) and more CPU usage or more bandwidth (per user) and less CPU usage... you should also consider the "sound" of some codecs may not have the 'real radio sound'.

For each user you have to add a bunch of lines to your iax.conf file:

[<USERNAME>]
type=user
username=<USERNAME>
secret=<PASSWORD>
context=default
host=dynamic
nat=yes
notransfer=yes

You just have to fill in the <USERNAME> and <PASSWORD>. After each change you have to reload the configuration (e.g. "asterisk -rx reload chan_iax2.so"). Perhaps you want to write scripts for automatic configuration and so on. But be warned: Further versions of fgcom may use the multiplayer servers for getting usernames and position data and you have to change your scripts.

===Problems?===

If you have problems you can contact me via email at "dcoredump AT gmail.com".

==External links==
* [http://squonk.abacab.org/dokuwiki/fgcom Official website]
* [http://squonk.abacab.org/dokuwiki/fgcom-manual Manual]

==Development==

TODO

==See also==
*[[FlightGear related projects]]

[[Category:Software]]

FGCom (before 3.0)

2008-12-28T03:49:58Z

Jester: /* Testing */ Added server and updated output

{{cleanup}}

'''FGCom''' is an addon for [[FlightGear]]. With FGCom (and the infrastructure behind), FlightGear gets a realtime voice communication system which could be used for [[ATC]]. The current version of fgcom is airport based - that means radio frequencies are based towards the location of the tower. Further version will fix this for a more realistic radio implementation (see [[Development]])

==Status==
*'''18 November, 2008:'''
Latest SVN (rev 163) has the compile problems fixed. Also we have a '''new server: fgcom.flightgear.co.uk'''. User accounts not required (ie. do '''not''' use -U or -P)
*'''31 October, 2008:'''

The latest SVN release at this time is the '''r149''' which does not compile due to a constant that is not defined (STL_STRING). Such constant appears at line 57 in the file ''src/fgcom_init.cpp'' which is:
''#include STL_STRING''

I guess that such constant must point to the STL library include file but I am not sure.
I revert to the '''r148''' SVN version which successfully compiles.

Command to get such version is: ''svn co -r148 svn://svn.dfn.de:/fgcom/trunk fgcom-r148''

* '''19 June, 2008:''' Currently the server is down due to hardware problems. It is unknown when the service comes back becuase he currently has no time to fix the problems.

* '''22 November 2007:''' Due to heavy development at this time there may be some differences between the information on the web pages and the installation. Please follow the discussions on the FlightGear development list!

==Client installation==
Before you start, make sure that your speakers and mic are working and tested to sensible volumes.
===Linux===
Fetch FGCom (a copy of a working iaxclient is inside)

svn checkout svn://svn.dfn.de:/fgcom/trunk fgcom

Optional: edit iaxclient/lib/Makefile

To use OpenAl (Recommended and the default for now. Note however, that it requires OpenAl with capture support.)

USE_PA_OSS=0
USE_PA_ALSA=0
USE_PA_JACK=0
AUDIO_ALSA=0
AUDIO_OPENAL=1

To use oss emulation

USE_PA_OSS=1
USE_PA_ALSA=0
USE_PA_JACK=0
AUDIO_ALSA=0
AUDIO_OPENAL=0

To use native alsa (WARNING: PTT won't work)

USE_PA_OSS=0
USE_PA_ALSA=0
USE_PA_JACK=0
AUDIO_ALSA=1
AUDIO_OPENAL=0

To use portaudio alsa (WARNING: only if your card natively supports 8000Hz sample rate)

USE_PA_OSS=0
USE_PA_ALSA=1
USE_PA_JACK=0
AUDIO_ALSA=0
AUDIO_OPENAL=0

Edit fgcom/src/Makefile and check the pathes for PLIB_PREFIX and OPENAL_PREFIX.

Compile iaxclient and fgcom. To do so, do the following:

cd fgcom/src && make

Install

make install

and you should be ready for a quick test...

==Using==
===Testing===
quick test

$ fgcom -Sfgcom.flightgear.org.uk -f910

will give the following output--
fgcom - a communication radio based on VoIP with IAX/Asterisk
(c)2007 by H. Wirtz <wirtz@dfn.de>
Version 1.2.2 build 163M
Using iaxclient library Version SVN 163M

Successfully parsed commandline options.
Reading list of airports...done.
Initializing IAX client as guest:xxxxxxxxxxx@fgcom.flightgear.org.uk
Call 0 accepted
Call 0 answered

speak into the mic and your words will be echoed back with a short delay.

type <nowiki>ctrl-C</nowiki> to exit this test

===Configuration===

''Or if it didn't work perfectly first time''

fgcom --help

returns the following useful info

fgcom - a communication radio based on VoIP with IAX/Asterisk

(c)2007 by H. Wirtz <wirtz@dfn.de>

Version 1.1.0 build 42

Using iaxclient library Version SVN 42

fgcom: unrecognized option `--help'

Usage: fgcom [-u user] -w [password] [[-s voipserver] [-p port]] | [[-a airport] [-f frequency]] [-d]

====Account options====
FGCom starts with a guest account unless you use -U and -P!

--user | -U username for VoIP account (default: 'guest')
--password | -P password for VoIP account (default: 'guest')
--voipserver | -s voip server to ceonnect to (default 'localhost')
--port | -p where we should listen to FG(default '16661')

====ATC mode options====
--airport | -a airport-id (ICAO) for ATC-mode
--frequency | -f frequency for ATC-mode

====Audio options====
--mic | -i mic input level (0.0 - 1.0)
--speaker | -o speaker output level (0.0 - 1.0)
--mic-boost | -b enable mic boost
--list-audio | -l list audio devices
--set-audio-in | -r use <devicename> as audio input
--set-audio-out | -k use <devicename> as audio output

====Misc options====
--debug | -d show debugging information

Mode 1: client for COM1 of flightgear:

$ fgcom

- connects fgcom to fgfs at localhost:16661

$ fgcom -sother.host.tld -p23456

- connects fgcom to fgfs at other.host.tld:23456

Mode 2: client for an ATC at <airport> on <frequency>:

$ fgcom -aKSFO -d120.500

- sets up fgcom for an ATC radio at KSFO 120.500 MHz

===Registration===
'''To make full use of FGCOM you will need an account!'''

Please email <nowiki> wirtz <at> dfn <dot> de</nowiki> (replace with @ and .) and login details will be sent to you shortly. Accounts will not be made until Autumn 2008. But you can test without an account (by default the used account is guest, password guest) with restricted frequency use. As guest you can only use the following frequencies:

* 911.000 MHz (ATC-Help)
* 910.000 MHz (Echo-Box)
* 123.450 MHz (Air2Air 1)
* 122.750 Mhz (Air2Air 2)

==Server installation==

For running a FGCOM server you need Asterisk and depending on the amount of users much bandwith and CPU power. Because of putting pilots and ATCs in a VoIP conference the server-admin has to assure that there is enough network and cpu power to avoid drop-outs of the voice stream.

===Prerequirements===

Install Asterisk on top of your favorite distribution. Please refer to installation manuals (e.g. [[http://www.asteriskguru.com/|Asterisk-Guru]]) you can find on the net. You do not need H.323 or SIP because the fgcom client uses IAX2 as VoIP signaling protocol. Only if you think about connecting external VoIP applications to FGCOM you should consider to activate H.323 or SIP (but this is not the scope of this small howto).

Notice: You need to install the zaptel driver modules - even if you won't use any hardware for telecom interfacing. You need the ztdummy kernel module for the asterisk conference application MeetMe() because it simulates a hardware clock needed by this application. Further development of FGCOM might use app_conference which don't needs any timing device.

For now we want to use /etc/asterisk as the base configuration directory.

===Setting up the radio frequencies===

The radio frequencies are "simple" Conferences and realized due to the Asterisk application MeetMe().

====Part 1: General configuration====

First you have to set up the general configuration of the system. Put the following at the top of your "extensions.conf" file:

[general]
static=yes
writeprotect=yes
;
[globals]
;
[macro-com]
exten => s,1,Answer()
exten => s,n,MeetMe(${MACRO_EXTEN},qd)
exten => s,n,Hangup()
;
[macro-echo]
exten => s,1,Answer()
exten => s,n,Echo()
exten => s,n,Hangup()
;
[guest]
; ATC-Help
exten => 01-ZZZZ-911.000,1,Macro(com)
exten => 012525252591100,1,Dial(Local/01-ZZZZ-911.000)
exten => 01-ZZZZ-910.000,1,Macro(echo)
exten => 012525252591000,1,Dial(Local/01-ZZZZ-910.000)
;
[default]
include => guest
;
; Code:
; 01 - FlightGear
; 02 - Microsoft Flight-Simulator
; 03 - ...
;
; Air2Air
exten => 01-ZZZZ-123.450,1,Macro(com)
exten => 012525252512345,1,Dial(Local/01-ZZZZ-123.450)
exten => 01-ZZZZ-122.750,1,Macro(com)
exten => 012525252512275,1,Dial(Local/01-ZZZZ-122.750)

====Part 2: Adding your favorite (all?) frequencies====

For this you have simply to create an extension for every touple of airport/frequency in extensions.conf. The following is an example for Berlin-Tempelhof (EDDI). The information comes from the file "apt.dat.gz" of your FlightGear installation.

; EDDI ATIS 126.020 - Berlin Tempelhof
exten => 01-EDDI-126.020,1,Macro(com)
exten => 010403030812602,1,Dial(Local/01-EDDI-126.020)
;
; EDDI BERLIN DEP 120.620 - Berlin Tempelhof
exten => 01-EDDI-120.620,1,Macro(com)
exten => 010403030812062,1,Dial(Local/01-EDDI-120.620)
;
; EDDI BERLIN DIRECTOR 121.120 - Berlin Tempelhof
exten => 01-EDDI-121.120,1,Macro(com)
exten => 010403030812112,1,Dial(Local/01-EDDI-121.120)
;
; EDDI BERLIN ARR 126.420 - Berlin Tempelhof
exten => 01-EDDI-126.420,1,Macro(com)
exten => 010403030812642,1,Dial(Local/01-EDDI-126.420)
;
; EDDI GND 121.950 - Berlin Tempelhof
exten => 01-EDDI-121.950,1,Macro(com)
exten => 010403030812195,1,Dial(Local/01-EDDI-121.950)
;
; EDDI TWR 119.570 - Berlin Tempelhof
exten => 01-EDDI-119.570,1,Macro(com)
exten => 010403030811957,1,Dial(Local/01-EDDI-119.570)
;
; EDDI BERLIN DIRECTOR 136.100 - Berlin Tempelhof
exten => 01-EDDI-136.100,1,Macro(com)
exten => 010403030813610,1,Dial(Local/01-EDDI-136.100)
;
; EDDI TWR 118.100 - Berlin Tempelhof
exten => 01-EDDI-118.100,1,Macro(com)
exten => 010403030811810,1,Dial(Local/01-EDDI-118.100)
;
; EDDI BERLIN DEP 119.500 - Berlin Tempelhof
exten => 01-EDDI-119.500,1,Macro(com)
exten => 010403030811950,1,Dial(Local/01-EDDI-119.500)
;
; EDDI BERLIN ARR 119.620 - Berlin Tempelhof
exten => 01-EDDI-119.620,1,Macro(com)
exten => 010403030811962,1,Dial(Local/01-EDDI-119.620)

What does the above mean? There are two lines (three with the comment) for each frequency: The first one sets up an extension named "01-EDDI-119.500". Yes, for VoIP you can use textual extensions but be careful if you want to setup your Asterisk-Server with POTS (=Plain old telephone service). Therefor you need the second line which is the same as above but without dashes and the letters in the decimal representation of the ASCII Code. The second line does only a "rewrite" of the numerical representation to the textual one.

For setting up all airports you can write your own simple script. But this maybe also not needed in further versions of FGCOM.

After editing the extensions.conf file you have to reload the extensions file (e.g. "asterisk -rx extensions reload").

You can add further nice goodies to your extensions.conf: MorseCode() for morsing the code of the VOR (MorseCode() will only work in Asterisk >= 1.4), Recording of metar data and playing this recording back when using the frequency of the metar information, ...

===Setting up user accounts===

The user accounts are located in the file iax.conf (and perhaps also in sip.conf, but this is not necessary). The top of the file should look like this:

[general]
bandwith=low
disallow=lpc10
jitterbuffer=yes
forcejitterbuffer=no
tos=lowdelay
autokill=yes
disallow=all
allow=alaw
allow=gsm
allow=ilbc
allow=g726
allow=ulaw
language=en
maxauthreq=10
context=guest
;
[guest]
type=user
username=guest
context=guest
qualify=yes
callerid=Guest IAX User
host=dynamic
;

You may want to disallow more codecs or want to allow additional codecs (such as speex). But have in mind that the internal mixing of the conferences are done in "ulaw". But "ulaw" needs about 80 kBit/s because it does no compression. So you have to think about what's better for you: less bandwidth (per user) and more CPU usage or more bandwidth (per user) and less CPU usage... you should also consider the "sound" of some codecs may not have the 'real radio sound'.

For each user you have to add a bunch of lines to your iax.conf file:

[<USERNAME>]
type=user
username=<USERNAME>
secret=<PASSWORD>
context=default
host=dynamic
nat=yes
notransfer=yes

You just have to fill in the <USERNAME> and <PASSWORD>. After each change you have to reload the configuration (e.g. "asterisk -rx reload chan_iax2.so"). Perhaps you want to write scripts for automatic configuration and so on. But be warned: Further versions of fgcom may use the multiplayer servers for getting usernames and position data and you have to change your scripts.

===Problems?===

If you have problems you can contact me via email at "dcoredump AT gmail.com".

==External links==
* [http://squonk.abacab.org/dokuwiki/fgcom Official website]
* [http://squonk.abacab.org/dokuwiki/fgcom-manual Manual]

==Development==

TODO

==See also==
*[[FlightGear related projects]]

[[Category:Software]]

FGCom (before 3.0)

2008-12-28T03:43:31Z

Jester: /* Linux */ Added OpenAl

{{cleanup}}

'''FGCom''' is an addon for [[FlightGear]]. With FGCom (and the infrastructure behind), FlightGear gets a realtime voice communication system which could be used for [[ATC]]. The current version of fgcom is airport based - that means radio frequencies are based towards the location of the tower. Further version will fix this for a more realistic radio implementation (see [[Development]])

==Status==
*'''18 November, 2008:'''
Latest SVN (rev 163) has the compile problems fixed. Also we have a '''new server: fgcom.flightgear.co.uk'''. User accounts not required (ie. do '''not''' use -U or -P)
*'''31 October, 2008:'''

The latest SVN release at this time is the '''r149''' which does not compile due to a constant that is not defined (STL_STRING). Such constant appears at line 57 in the file ''src/fgcom_init.cpp'' which is:
''#include STL_STRING''

I guess that such constant must point to the STL library include file but I am not sure.
I revert to the '''r148''' SVN version which successfully compiles.

Command to get such version is: ''svn co -r148 svn://svn.dfn.de:/fgcom/trunk fgcom-r148''

* '''19 June, 2008:''' Currently the server is down due to hardware problems. It is unknown when the service comes back becuase he currently has no time to fix the problems.

* '''22 November 2007:''' Due to heavy development at this time there may be some differences between the information on the web pages and the installation. Please follow the discussions on the FlightGear development list!

==Client installation==
Before you start, make sure that your speakers and mic are working and tested to sensible volumes.
===Linux===
Fetch FGCom (a copy of a working iaxclient is inside)

svn checkout svn://svn.dfn.de:/fgcom/trunk fgcom

Optional: edit iaxclient/lib/Makefile

To use OpenAl (Recommended and the default for now. Note however, that it requires OpenAl with capture support.)

USE_PA_OSS=0
USE_PA_ALSA=0
USE_PA_JACK=0
AUDIO_ALSA=0
AUDIO_OPENAL=1

To use oss emulation

USE_PA_OSS=1
USE_PA_ALSA=0
USE_PA_JACK=0
AUDIO_ALSA=0
AUDIO_OPENAL=0

To use native alsa (WARNING: PTT won't work)

USE_PA_OSS=0
USE_PA_ALSA=0
USE_PA_JACK=0
AUDIO_ALSA=1
AUDIO_OPENAL=0

To use portaudio alsa (WARNING: only if your card natively supports 8000Hz sample rate)

USE_PA_OSS=0
USE_PA_ALSA=1
USE_PA_JACK=0
AUDIO_ALSA=0
AUDIO_OPENAL=0

Edit fgcom/src/Makefile and check the pathes for PLIB_PREFIX and OPENAL_PREFIX.

Compile iaxclient and fgcom. To do so, do the following:

cd fgcom/src && make

Install

make install

and you should be ready for a quick test...

==Using==
===Testing===
quick test

$ fgcom -f910

will give the following output--

fgcom - a communication radio based on VoIP with IAX/Asterisk

(c)2007 by H. Wirtz <wirtz@dfn.de>

Version 1.1.0 build 42

Using iaxclient library Version SVN 42

Reading list of airports...done.

Initializing IAX client as guest:xxxxxxxxxxx@fgcom1.parasitstudio.de

Call 0 accepted

Echo-Box

Call 0 answered

speak into the mic and your words will be echoed back with a short delay.

type <nowiki>ctrl-C</nowiki> to exit this test

===Configuration===

''Or if it didn't work perfectly first time''

fgcom --help

returns the following useful info

fgcom - a communication radio based on VoIP with IAX/Asterisk

(c)2007 by H. Wirtz <wirtz@dfn.de>

Version 1.1.0 build 42

Using iaxclient library Version SVN 42

fgcom: unrecognized option `--help'

Usage: fgcom [-u user] -w [password] [[-s voipserver] [-p port]] | [[-a airport] [-f frequency]] [-d]

====Account options====
FGCom starts with a guest account unless you use -U and -P!

--user | -U username for VoIP account (default: 'guest')
--password | -P password for VoIP account (default: 'guest')
--voipserver | -s voip server to ceonnect to (default 'localhost')
--port | -p where we should listen to FG(default '16661')

====ATC mode options====
--airport | -a airport-id (ICAO) for ATC-mode
--frequency | -f frequency for ATC-mode

====Audio options====
--mic | -i mic input level (0.0 - 1.0)
--speaker | -o speaker output level (0.0 - 1.0)
--mic-boost | -b enable mic boost
--list-audio | -l list audio devices
--set-audio-in | -r use <devicename> as audio input
--set-audio-out | -k use <devicename> as audio output

====Misc options====
--debug | -d show debugging information

Mode 1: client for COM1 of flightgear:

$ fgcom

- connects fgcom to fgfs at localhost:16661

$ fgcom -sother.host.tld -p23456

- connects fgcom to fgfs at other.host.tld:23456

Mode 2: client for an ATC at <airport> on <frequency>:

$ fgcom -aKSFO -d120.500

- sets up fgcom for an ATC radio at KSFO 120.500 MHz

===Registration===
'''To make full use of FGCOM you will need an account!'''

Please email <nowiki> wirtz <at> dfn <dot> de</nowiki> (replace with @ and .) and login details will be sent to you shortly. Accounts will not be made until Autumn 2008. But you can test without an account (by default the used account is guest, password guest) with restricted frequency use. As guest you can only use the following frequencies:

* 911.000 MHz (ATC-Help)
* 910.000 MHz (Echo-Box)
* 123.450 MHz (Air2Air 1)
* 122.750 Mhz (Air2Air 2)

==Server installation==

For running a FGCOM server you need Asterisk and depending on the amount of users much bandwith and CPU power. Because of putting pilots and ATCs in a VoIP conference the server-admin has to assure that there is enough network and cpu power to avoid drop-outs of the voice stream.

===Prerequirements===

Install Asterisk on top of your favorite distribution. Please refer to installation manuals (e.g. [[http://www.asteriskguru.com/|Asterisk-Guru]]) you can find on the net. You do not need H.323 or SIP because the fgcom client uses IAX2 as VoIP signaling protocol. Only if you think about connecting external VoIP applications to FGCOM you should consider to activate H.323 or SIP (but this is not the scope of this small howto).

Notice: You need to install the zaptel driver modules - even if you won't use any hardware for telecom interfacing. You need the ztdummy kernel module for the asterisk conference application MeetMe() because it simulates a hardware clock needed by this application. Further development of FGCOM might use app_conference which don't needs any timing device.

For now we want to use /etc/asterisk as the base configuration directory.

===Setting up the radio frequencies===

The radio frequencies are "simple" Conferences and realized due to the Asterisk application MeetMe().

====Part 1: General configuration====

First you have to set up the general configuration of the system. Put the following at the top of your "extensions.conf" file:

[general]
static=yes
writeprotect=yes
;
[globals]
;
[macro-com]
exten => s,1,Answer()
exten => s,n,MeetMe(${MACRO_EXTEN},qd)
exten => s,n,Hangup()
;
[macro-echo]
exten => s,1,Answer()
exten => s,n,Echo()
exten => s,n,Hangup()
;
[guest]
; ATC-Help
exten => 01-ZZZZ-911.000,1,Macro(com)
exten => 012525252591100,1,Dial(Local/01-ZZZZ-911.000)
exten => 01-ZZZZ-910.000,1,Macro(echo)
exten => 012525252591000,1,Dial(Local/01-ZZZZ-910.000)
;
[default]
include => guest
;
; Code:
; 01 - FlightGear
; 02 - Microsoft Flight-Simulator
; 03 - ...
;
; Air2Air
exten => 01-ZZZZ-123.450,1,Macro(com)
exten => 012525252512345,1,Dial(Local/01-ZZZZ-123.450)
exten => 01-ZZZZ-122.750,1,Macro(com)
exten => 012525252512275,1,Dial(Local/01-ZZZZ-122.750)

====Part 2: Adding your favorite (all?) frequencies====

For this you have simply to create an extension for every touple of airport/frequency in extensions.conf. The following is an example for Berlin-Tempelhof (EDDI). The information comes from the file "apt.dat.gz" of your FlightGear installation.

; EDDI ATIS 126.020 - Berlin Tempelhof
exten => 01-EDDI-126.020,1,Macro(com)
exten => 010403030812602,1,Dial(Local/01-EDDI-126.020)
;
; EDDI BERLIN DEP 120.620 - Berlin Tempelhof
exten => 01-EDDI-120.620,1,Macro(com)
exten => 010403030812062,1,Dial(Local/01-EDDI-120.620)
;
; EDDI BERLIN DIRECTOR 121.120 - Berlin Tempelhof
exten => 01-EDDI-121.120,1,Macro(com)
exten => 010403030812112,1,Dial(Local/01-EDDI-121.120)
;
; EDDI BERLIN ARR 126.420 - Berlin Tempelhof
exten => 01-EDDI-126.420,1,Macro(com)
exten => 010403030812642,1,Dial(Local/01-EDDI-126.420)
;
; EDDI GND 121.950 - Berlin Tempelhof
exten => 01-EDDI-121.950,1,Macro(com)
exten => 010403030812195,1,Dial(Local/01-EDDI-121.950)
;
; EDDI TWR 119.570 - Berlin Tempelhof
exten => 01-EDDI-119.570,1,Macro(com)
exten => 010403030811957,1,Dial(Local/01-EDDI-119.570)
;
; EDDI BERLIN DIRECTOR 136.100 - Berlin Tempelhof
exten => 01-EDDI-136.100,1,Macro(com)
exten => 010403030813610,1,Dial(Local/01-EDDI-136.100)
;
; EDDI TWR 118.100 - Berlin Tempelhof
exten => 01-EDDI-118.100,1,Macro(com)
exten => 010403030811810,1,Dial(Local/01-EDDI-118.100)
;
; EDDI BERLIN DEP 119.500 - Berlin Tempelhof
exten => 01-EDDI-119.500,1,Macro(com)
exten => 010403030811950,1,Dial(Local/01-EDDI-119.500)
;
; EDDI BERLIN ARR 119.620 - Berlin Tempelhof
exten => 01-EDDI-119.620,1,Macro(com)
exten => 010403030811962,1,Dial(Local/01-EDDI-119.620)

What does the above mean? There are two lines (three with the comment) for each frequency: The first one sets up an extension named "01-EDDI-119.500". Yes, for VoIP you can use textual extensions but be careful if you want to setup your Asterisk-Server with POTS (=Plain old telephone service). Therefor you need the second line which is the same as above but without dashes and the letters in the decimal representation of the ASCII Code. The second line does only a "rewrite" of the numerical representation to the textual one.

For setting up all airports you can write your own simple script. But this maybe also not needed in further versions of FGCOM.

After editing the extensions.conf file you have to reload the extensions file (e.g. "asterisk -rx extensions reload").

You can add further nice goodies to your extensions.conf: MorseCode() for morsing the code of the VOR (MorseCode() will only work in Asterisk >= 1.4), Recording of metar data and playing this recording back when using the frequency of the metar information, ...

===Setting up user accounts===

The user accounts are located in the file iax.conf (and perhaps also in sip.conf, but this is not necessary). The top of the file should look like this:

[general]
bandwith=low
disallow=lpc10
jitterbuffer=yes
forcejitterbuffer=no
tos=lowdelay
autokill=yes
disallow=all
allow=alaw
allow=gsm
allow=ilbc
allow=g726
allow=ulaw
language=en
maxauthreq=10
context=guest
;
[guest]
type=user
username=guest
context=guest
qualify=yes
callerid=Guest IAX User
host=dynamic
;

You may want to disallow more codecs or want to allow additional codecs (such as speex). But have in mind that the internal mixing of the conferences are done in "ulaw". But "ulaw" needs about 80 kBit/s because it does no compression. So you have to think about what's better for you: less bandwidth (per user) and more CPU usage or more bandwidth (per user) and less CPU usage... you should also consider the "sound" of some codecs may not have the 'real radio sound'.

For each user you have to add a bunch of lines to your iax.conf file:

[<USERNAME>]
type=user
username=<USERNAME>
secret=<PASSWORD>
context=default
host=dynamic
nat=yes
notransfer=yes

You just have to fill in the <USERNAME> and <PASSWORD>. After each change you have to reload the configuration (e.g. "asterisk -rx reload chan_iax2.so"). Perhaps you want to write scripts for automatic configuration and so on. But be warned: Further versions of fgcom may use the multiplayer servers for getting usernames and position data and you have to change your scripts.

===Problems?===

If you have problems you can contact me via email at "dcoredump AT gmail.com".

==External links==
* [http://squonk.abacab.org/dokuwiki/fgcom Official website]
* [http://squonk.abacab.org/dokuwiki/fgcom-manual Manual]

==Development==

TODO

==See also==
*[[FlightGear related projects]]

[[Category:Software]]

FGCom (before 3.0)

2008-12-28T03:39:42Z

Jester: /* Status */ We are up again!

{{cleanup}}

'''FGCom''' is an addon for [[FlightGear]]. With FGCom (and the infrastructure behind), FlightGear gets a realtime voice communication system which could be used for [[ATC]]. The current version of fgcom is airport based - that means radio frequencies are based towards the location of the tower. Further version will fix this for a more realistic radio implementation (see [[Development]])

==Status==
*'''18 November, 2008:'''
Latest SVN (rev 163) has the compile problems fixed. Also we have a '''new server: fgcom.flightgear.co.uk'''. User accounts not required (ie. do '''not''' use -U or -P)
*'''31 October, 2008:'''

The latest SVN release at this time is the '''r149''' which does not compile due to a constant that is not defined (STL_STRING). Such constant appears at line 57 in the file ''src/fgcom_init.cpp'' which is:
''#include STL_STRING''

I guess that such constant must point to the STL library include file but I am not sure.
I revert to the '''r148''' SVN version which successfully compiles.

Command to get such version is: ''svn co -r148 svn://svn.dfn.de:/fgcom/trunk fgcom-r148''

* '''19 June, 2008:''' Currently the server is down due to hardware problems. It is unknown when the service comes back becuase he currently has no time to fix the problems.

* '''22 November 2007:''' Due to heavy development at this time there may be some differences between the information on the web pages and the installation. Please follow the discussions on the FlightGear development list!

==Client installation==
Before you start, make sure that your speakers and mic are working and tested to sensible volumes.
===Linux===
Fetch FGCom (a copy of a working iaxclient is inside)

svn checkout svn://svn.dfn.de:/fgcom/trunk fgcom

Optional: edit iaxclient/lib/Makefile

To use oss emulation (recommended and the default for now)

USE_PA_OSS=1
USE_PA_ALSA=0
USE_PA_JACK=0
AUDIO_ALSA=0

To use native alsa (WARNING: PTT won't work)

USE_PA_OSS=0
USE_PA_ALSA=0
USE_PA_JACK=0
AUDIO_ALSA=1

To use portaudio alsa (WARNING: only if your card natively supports 8000Hz sample rate)

USE_PA_OSS=0
USE_PA_ALSA=1
USE_PA_JACK=0
AUDIO_ALSA=0

Edit fgcom/src/Makefile and check the pathes for PLIB_PREFIX and OPENAL_PREFIX.

Compile iaxclient and fgcom. To do so, do the following:

cd fgcom/src && make

Install

make install

and you should be ready for a quick test...

==Using==
===Testing===
quick test

$ fgcom -f910

will give the following output--

fgcom - a communication radio based on VoIP with IAX/Asterisk

(c)2007 by H. Wirtz <wirtz@dfn.de>

Version 1.1.0 build 42

Using iaxclient library Version SVN 42

Reading list of airports...done.

Initializing IAX client as guest:xxxxxxxxxxx@fgcom1.parasitstudio.de

Call 0 accepted

Echo-Box

Call 0 answered

speak into the mic and your words will be echoed back with a short delay.

type <nowiki>ctrl-C</nowiki> to exit this test

===Configuration===

''Or if it didn't work perfectly first time''

fgcom --help

returns the following useful info

fgcom - a communication radio based on VoIP with IAX/Asterisk

(c)2007 by H. Wirtz <wirtz@dfn.de>

Version 1.1.0 build 42

Using iaxclient library Version SVN 42

fgcom: unrecognized option `--help'

Usage: fgcom [-u user] -w [password] [[-s voipserver] [-p port]] | [[-a airport] [-f frequency]] [-d]

====Account options====
FGCom starts with a guest account unless you use -U and -P!

--user | -U username for VoIP account (default: 'guest')
--password | -P password for VoIP account (default: 'guest')
--voipserver | -s voip server to ceonnect to (default 'localhost')
--port | -p where we should listen to FG(default '16661')

====ATC mode options====
--airport | -a airport-id (ICAO) for ATC-mode
--frequency | -f frequency for ATC-mode

====Audio options====
--mic | -i mic input level (0.0 - 1.0)
--speaker | -o speaker output level (0.0 - 1.0)
--mic-boost | -b enable mic boost
--list-audio | -l list audio devices
--set-audio-in | -r use <devicename> as audio input
--set-audio-out | -k use <devicename> as audio output

====Misc options====
--debug | -d show debugging information

Mode 1: client for COM1 of flightgear:

$ fgcom

- connects fgcom to fgfs at localhost:16661

$ fgcom -sother.host.tld -p23456

- connects fgcom to fgfs at other.host.tld:23456

Mode 2: client for an ATC at <airport> on <frequency>:

$ fgcom -aKSFO -d120.500

- sets up fgcom for an ATC radio at KSFO 120.500 MHz

===Registration===
'''To make full use of FGCOM you will need an account!'''

Please email <nowiki> wirtz <at> dfn <dot> de</nowiki> (replace with @ and .) and login details will be sent to you shortly. Accounts will not be made until Autumn 2008. But you can test without an account (by default the used account is guest, password guest) with restricted frequency use. As guest you can only use the following frequencies:

* 911.000 MHz (ATC-Help)
* 910.000 MHz (Echo-Box)
* 123.450 MHz (Air2Air 1)
* 122.750 Mhz (Air2Air 2)

==Server installation==

For running a FGCOM server you need Asterisk and depending on the amount of users much bandwith and CPU power. Because of putting pilots and ATCs in a VoIP conference the server-admin has to assure that there is enough network and cpu power to avoid drop-outs of the voice stream.

===Prerequirements===

Install Asterisk on top of your favorite distribution. Please refer to installation manuals (e.g. [[http://www.asteriskguru.com/|Asterisk-Guru]]) you can find on the net. You do not need H.323 or SIP because the fgcom client uses IAX2 as VoIP signaling protocol. Only if you think about connecting external VoIP applications to FGCOM you should consider to activate H.323 or SIP (but this is not the scope of this small howto).

Notice: You need to install the zaptel driver modules - even if you won't use any hardware for telecom interfacing. You need the ztdummy kernel module for the asterisk conference application MeetMe() because it simulates a hardware clock needed by this application. Further development of FGCOM might use app_conference which don't needs any timing device.

For now we want to use /etc/asterisk as the base configuration directory.

===Setting up the radio frequencies===

The radio frequencies are "simple" Conferences and realized due to the Asterisk application MeetMe().

====Part 1: General configuration====

First you have to set up the general configuration of the system. Put the following at the top of your "extensions.conf" file:

[general]
static=yes
writeprotect=yes
;
[globals]
;
[macro-com]
exten => s,1,Answer()
exten => s,n,MeetMe(${MACRO_EXTEN},qd)
exten => s,n,Hangup()
;
[macro-echo]
exten => s,1,Answer()
exten => s,n,Echo()
exten => s,n,Hangup()
;
[guest]
; ATC-Help
exten => 01-ZZZZ-911.000,1,Macro(com)
exten => 012525252591100,1,Dial(Local/01-ZZZZ-911.000)
exten => 01-ZZZZ-910.000,1,Macro(echo)
exten => 012525252591000,1,Dial(Local/01-ZZZZ-910.000)
;
[default]
include => guest
;
; Code:
; 01 - FlightGear
; 02 - Microsoft Flight-Simulator
; 03 - ...
;
; Air2Air
exten => 01-ZZZZ-123.450,1,Macro(com)
exten => 012525252512345,1,Dial(Local/01-ZZZZ-123.450)
exten => 01-ZZZZ-122.750,1,Macro(com)
exten => 012525252512275,1,Dial(Local/01-ZZZZ-122.750)

====Part 2: Adding your favorite (all?) frequencies====

For this you have simply to create an extension for every touple of airport/frequency in extensions.conf. The following is an example for Berlin-Tempelhof (EDDI). The information comes from the file "apt.dat.gz" of your FlightGear installation.

; EDDI ATIS 126.020 - Berlin Tempelhof
exten => 01-EDDI-126.020,1,Macro(com)
exten => 010403030812602,1,Dial(Local/01-EDDI-126.020)
;
; EDDI BERLIN DEP 120.620 - Berlin Tempelhof
exten => 01-EDDI-120.620,1,Macro(com)
exten => 010403030812062,1,Dial(Local/01-EDDI-120.620)
;
; EDDI BERLIN DIRECTOR 121.120 - Berlin Tempelhof
exten => 01-EDDI-121.120,1,Macro(com)
exten => 010403030812112,1,Dial(Local/01-EDDI-121.120)
;
; EDDI BERLIN ARR 126.420 - Berlin Tempelhof
exten => 01-EDDI-126.420,1,Macro(com)
exten => 010403030812642,1,Dial(Local/01-EDDI-126.420)
;
; EDDI GND 121.950 - Berlin Tempelhof
exten => 01-EDDI-121.950,1,Macro(com)
exten => 010403030812195,1,Dial(Local/01-EDDI-121.950)
;
; EDDI TWR 119.570 - Berlin Tempelhof
exten => 01-EDDI-119.570,1,Macro(com)
exten => 010403030811957,1,Dial(Local/01-EDDI-119.570)
;
; EDDI BERLIN DIRECTOR 136.100 - Berlin Tempelhof
exten => 01-EDDI-136.100,1,Macro(com)
exten => 010403030813610,1,Dial(Local/01-EDDI-136.100)
;
; EDDI TWR 118.100 - Berlin Tempelhof
exten => 01-EDDI-118.100,1,Macro(com)
exten => 010403030811810,1,Dial(Local/01-EDDI-118.100)
;
; EDDI BERLIN DEP 119.500 - Berlin Tempelhof
exten => 01-EDDI-119.500,1,Macro(com)
exten => 010403030811950,1,Dial(Local/01-EDDI-119.500)
;
; EDDI BERLIN ARR 119.620 - Berlin Tempelhof
exten => 01-EDDI-119.620,1,Macro(com)
exten => 010403030811962,1,Dial(Local/01-EDDI-119.620)

What does the above mean? There are two lines (three with the comment) for each frequency: The first one sets up an extension named "01-EDDI-119.500". Yes, for VoIP you can use textual extensions but be careful if you want to setup your Asterisk-Server with POTS (=Plain old telephone service). Therefor you need the second line which is the same as above but without dashes and the letters in the decimal representation of the ASCII Code. The second line does only a "rewrite" of the numerical representation to the textual one.

For setting up all airports you can write your own simple script. But this maybe also not needed in further versions of FGCOM.

After editing the extensions.conf file you have to reload the extensions file (e.g. "asterisk -rx extensions reload").

You can add further nice goodies to your extensions.conf: MorseCode() for morsing the code of the VOR (MorseCode() will only work in Asterisk >= 1.4), Recording of metar data and playing this recording back when using the frequency of the metar information, ...

===Setting up user accounts===

The user accounts are located in the file iax.conf (and perhaps also in sip.conf, but this is not necessary). The top of the file should look like this:

[general]
bandwith=low
disallow=lpc10
jitterbuffer=yes
forcejitterbuffer=no
tos=lowdelay
autokill=yes
disallow=all
allow=alaw
allow=gsm
allow=ilbc
allow=g726
allow=ulaw
language=en
maxauthreq=10
context=guest
;
[guest]
type=user
username=guest
context=guest
qualify=yes
callerid=Guest IAX User
host=dynamic
;

You may want to disallow more codecs or want to allow additional codecs (such as speex). But have in mind that the internal mixing of the conferences are done in "ulaw". But "ulaw" needs about 80 kBit/s because it does no compression. So you have to think about what's better for you: less bandwidth (per user) and more CPU usage or more bandwidth (per user) and less CPU usage... you should also consider the "sound" of some codecs may not have the 'real radio sound'.

For each user you have to add a bunch of lines to your iax.conf file:

[<USERNAME>]
type=user
username=<USERNAME>
secret=<PASSWORD>
context=default
host=dynamic
nat=yes
notransfer=yes

You just have to fill in the <USERNAME> and <PASSWORD>. After each change you have to reload the configuration (e.g. "asterisk -rx reload chan_iax2.so"). Perhaps you want to write scripts for automatic configuration and so on. But be warned: Further versions of fgcom may use the multiplayer servers for getting usernames and position data and you have to change your scripts.

===Problems?===

If you have problems you can contact me via email at "dcoredump AT gmail.com".

==External links==
* [http://squonk.abacab.org/dokuwiki/fgcom Official website]
* [http://squonk.abacab.org/dokuwiki/fgcom-manual Manual]

==Development==

TODO

==See also==
*[[FlightGear related projects]]

[[Category:Software]]