FGCom (before 3.0): Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
No edit summary
(cleanup required!)
Line 1: Line 1:
'''FGCOM''' is an addon for Flightgear. With FGCOM (and the infrastructure behind) Flightgear gets a realtime voice communication system.
{{cleanup}}


The original (and for now, authoratative) documentation  is in the
'''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]].
[http://squonk.abacab.org/dokuwiki/fgcom-manual FGCOM manual] at the [http://squonk.abacab.org/dokuwiki/fgcom FGCOM web site].


----
==Status==
'''VERY IMPORTANT!!!'''
* '''19 June, 2008:''' '''Currently the server is <u>down</u> due to hardware problems. It is unknown when the service comes back becuase he currently has no time to fix the problems.'''


19 June, 2008:
* '''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!
 
'''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!
 
----
 
'''The Quick 3 Steps to get FGCOM running on a 32 -bit Linux system'''
 
support for 64-bit machines will follow


==Installation==
Before you start, make sure that your speakers and mic are working and tested to sensible volumes.
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
1.) fetch fgcom (a copy of a working iaxclient is inside)
 
        svn checkout svn://svn.dfn.de:/fgcom/trunk fgcom


Optional: edit iaxclient/lib/Makefile
Optional: edit iaxclient/lib/Makefile
Line 32: Line 19:
To use oss emulation (recommended and the default for now)
To use oss emulation (recommended and the default for now)
   
   
USE_PA_OSS=1
USE_PA_OSS=1
USE_PA_ALSA=0
USE_PA_ALSA=0
USE_PA_JACK=0
USE_PA_JACK=0
AUDIO_ALSA=0
AUDIO_ALSA=0


To use native alsa (WARNING: PTT won't work)
To use native alsa (WARNING: PTT won't work)


USE_PA_OSS=0
USE_PA_OSS=0
USE_PA_ALSA=0
USE_PA_ALSA=0
USE_PA_JACK=0
USE_PA_JACK=0
AUDIO_ALSA=1
AUDIO_ALSA=1


To use portaudio alsa (WARNING: only if your card natively supports
To use portaudio alsa (WARNING: only if your card natively supports 8000Hz sample rate)
8000Hz sample rate)


USE_PA_OSS=0
USE_PA_OSS=0
USE_PA_ALSA=1
USE_PA_ALSA=1
USE_PA_JACK=0
USE_PA_JACK=0
AUDIO_ALSA=0
AUDIO_ALSA=0


Edit fgcom/src/Makefile and check the pathes for PLIB_PREFIX and OPENAL_PREFIX.
Edit fgcom/src/Makefile and check the pathes for PLIB_PREFIX and OPENAL_PREFIX.


2.) Compile iaxclient and fgcom. To do so, do the following:
Compile iaxclient and fgcom. To do so, do the following:


      cd fgcom/src && make
cd fgcom/src && make


3.) Install
Install


    make install
make install


and you should be ready for a quick test...
and you should be ready for a quick test...


----
==Using==
 
===Testing===
'''Testing'''
 
quick test
quick test


Line 81: Line 65:


Using iaxclient library Version SVN 42
Using iaxclient library Version SVN 42


Reading list of airports...done.
Reading list of airports...done.
Line 93: Line 75:


Call 0 answered
Call 0 answered


speak into the mic and your words will be echoed back with a short delay.
speak into the mic and your words will be echoed back with a short delay.
Line 99: Line 80:
type <nowiki>ctrl-C</nowiki> to exit this test
type <nowiki>ctrl-C</nowiki> to exit this test


 
===Configuration===
 
'''Configuration'''


''Or if it didn't work perfectly first time''
''Or if it didn't work perfectly first time''
Line 108: Line 87:


returns the following useful info
returns the following useful info


fgcom - a communication radio based on VoIP with IAX/Asterisk
fgcom - a communication radio based on VoIP with IAX/Asterisk
Line 121: Line 99:


Usage: fgcom [-u user] -w [password] [[-s voipserver] [-p port]] | [[-a airport] [-f frequency]] [-d]
Usage: fgcom [-u user] -w [password] [[-s voipserver] [-p port]] | [[-a airport] [-f frequency]] [-d]


--user          | -U    username for VoIP account (default: 'guest')
--user          | -U    username for VoIP account (default: 'guest')
Line 158: Line 135:


- connects fgcom to fgfs at other.host.tld:23456
- connects fgcom to fgfs at other.host.tld:23456


Mode 2: client for an ATC at <airport> on <frequency>:
Mode 2: client for an ATC at <airport> on <frequency>:
Line 165: Line 141:


- sets up fgcom for an ATC radio at KSFO 120.500 MHz
- sets up fgcom for an ATC radio at KSFO 120.500 MHz


Note that fgcom starts with a guest account unless you use -U and -P!
Note that fgcom starts with a guest account unless you use -U and -P!


 
===Registration===
 
 
 
'''To make full use of FGCOM you will need an account'''
'''To make full use of FGCOM you will need an account'''


Line 186: Line 158:


122.750 Mhz (Air2Air 2)
122.750 Mhz (Air2Air 2)
==External links==
* [http://squonk.abacab.org/dokuwiki/fgcom Official website]
* [http://squonk.abacab.org/dokuwiki/fgcom-manual Manual]

Revision as of 15:26, 29 September 2008

Cleanup.png This article may require cleanup to meet the quality standards of the wiki. Please improve this article if you can.

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.

Status

  • 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!

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 ctrl-C 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]

--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')

--airport | -a airport-id (ICAO) for ATC-mode

--frequency | -f frequency for ATC-mode

--mic | -i mic input level (0.0 - 1.0)

--speaker | -o speaker output level (0.0 - 1.0)

--debug | -d show debugging information

--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

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

Note that fgcom starts with a guest account unless you use -U and -P!

Registration

To make full use of FGCOM you will need an account

please email wirtz@dfn.de 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)

External links