SquawkGear: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
No edit summary
No edit summary
(12 intermediate revisions by 7 users not shown)
Line 1: Line 1:
SquawkGear allows you to fly FlightGear on VATSIM, using a
{{delete
couple of old VATSIM clients, SquawkBox 747 and Advanced Voice Client.
| reason = AVC not longer supported. SB747 support likely to end very soon.
| day    = 07
| month  = 05
| year  = 2020
| nocat  =
}}
{{out of date|article}}


===What is VATSIM?===
'''SquawkGear''' allows you to fly [[FlightGear]] on VATSIM.
The [http://vatsim.net Virtual Air Traffic Simulation network].
"VATSIM is an online community where people can learn and, at the same time, enjoy the pastimes of flight simulation and air traffic control simulation all while making new friends from all over the world."
http://www.vatsim.net/vatsim/


===History===
You can find all needed downloads and a good description how to do the setup at http://squawkgear.wordpress.com
With Squawkbox 747 you show up as a Boeing 747 on VATSIM. Because of this you may want to use Squawkgear only in connection with airliner aircrafts to avoid confusions.


    Curt thinks it worth pushing towards VATSIM connectivity
== What is VATSIM? ==
    "a bridge... acts as a FG multiplayer server..." - Curt
VATSIM (short for the Virtual Air Traffic Simulation Network) is a completely free online platform which allows virtual pilots, wherever they are in the world, to connect their flight simulators into one shared virtual world. VATSIM also simulates air traffic control in this virtual world, creating the ultimate as-real-as-it-gets experience for you, the virtual aviation enthusiast.<ref>{{Cite web |url=http://www.vatsim.net/about |title=About VATSIM |publisher=VATSIM }}</ref>
    http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg20971.html


    "FG users stand to benefit" - Curt
You have to register on http://www.vatsim.net in oder to be able to connect yourself to the VATSIM network. Registration (and membership) is free and can be done easily.
    http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg12538.html
Flying on VATSIM expects you to have good knowledge of:
* how to fly your aircraft properly,
* how to set up correct flightplans,
* correct ATC communication.


    Similar concept in 2006 (XPlane - FG)
{{Cquote|What some people may not realize is that "FSD" predates VATSIM. VATSIM did not create, nor does it "own" the basic FSD design or protocol. VATSIM's FSD is slightly customized, but anyone can develop a pilot client that speaks the basic FSD language without signing VATSIM's NDA. You'll just need to do the NDA before your pilot client can be used on VATSIM.|Ross Carlson<ref>{{Cite web |url=http://forums.vatsim.net/viewtopic.php?p=350127#p350127 |title=Multiplayer protocol: portable? |date=25 March 2010 }}</ref> }}
    http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg03730.html
    the difference is that SquawkGear interfaces with SB747, not XSB


===References===
== Quick guide ==
=== Installation and setup ===
* It is recommended to read the instructions on http://squawkgear.wordpress.com carefully.
* Download and install squawkgear, Squawkbox 747 and Advanced Voice Client AVC from http://squawkgear.wordpress.com
* Place the additional files into the [[Flightgear]] folders and edit the files as described. Read also the further instructions below.
* Set [[Flightgear]] Input/Output options as described.
* Set [[Flightgear]] Network options as described.
* Set [[Flightgear]] Multiplayer options as described. You may want to disable Multiplayer output by setting no output port to avoid appearing also in [[Flightgear]] Multiplayer enviroment.


SquawkBox747 by hoppie: http://hoppie.nl/sb747
=== Startup ===
# Make sure that you have a working VATSIM ID and password by registering to VATSIM.
# File your flightplan on https://cert.vatsim.net/fp/file.php
# Start squawkbox, then [[Flightgear]], then SquawkBox747, then AVC.
# Make sure that you are on parking position and not on runway!
# In Squawkbox747, blank out the Flightplan and enter the callsign you used to file your flightplan.
# Set Squawkbox747 online
# Tune your radio to the ATC frequency of your relevant controller and make the initial contact.


The 'Broker' referred to by hoppie is the interface that SquawkGear emulates. The API is documented here: http://www.hoppie.nl/broker/downloads/747brok.html
== Setup details ==
There are some pitfalls when installing Squawkgear and trying to fly for the first time. This section tries to cover some of them:


SquawkGear design (from FG forums):
=== Input/Output ===
http://flightgear.org/forums/viewtopic.php?f=6&t=533&start=60#p66399
Put the file squawk.xml into fgdata/Protocol folder.
Because this protocol file uses a wrong property you may want to edit squawk.xml


Concerning multiplayer (visualisation of network air traffic):
search the line
<syntaxhighlight lang="xml">
<node>/position/altitude-ft</node>
</syntaxhighlight>
 
and replace it with:
<syntaxhighlight lang="xml">
<node>/instrumentation/altimeter/indicated-altitude-ft</node>
</syntaxhighlight>
 
Then either use command line options or edit the Advanced Options in [[FGRun]] to add the following lines:
<br />
<code>--generic=socket,out,1,IP_OF_SQUAWKGEAR,1863,tcp,squawk</code><br />
<code>--telnet=socket,in,1,IP_OF_SQUAWKGEAR,5900,tcp</code>
<br />
where IP_OF_SQUAWKGEAR is the IP address of the PC running squawkgear. Normally, this is the IP of your PC.
 
=== Multiplay ===
Advanced Options in [[FGRun]] - Network - Multiplayer Options should be set to:<br />
Callsign: your callsign used for filing the flightplan
<br />
Multiplay 1: <code>out,10,mpserver01.flightgear.org,0</code><br />
Multiplay 2: <code>in,10,,5000</code><br />
 
=== Menu bar ===
http://squawkgear.wordpress.com describes how to edit the gui/menubar.xml, but the description is deprecated. Instead, insert the following:
 
<syntaxhighlight lang="xml">
<menu>
  <name>Squawkgear</name>
  <item>
    <name>DirectComms</name>
    <binding>
      <command>dialog-show</command>
      <dialog-name>sq_comm</dialog-name>
    </binding>
  </item>
</menu>
</syntaxhighlight>
 
=== AVC auto tuning ===
You may find it helpful to have auto tuning on. When you set your COM frequency in [[Flightgear]], AVC will automatically enter the corrsponding channel.
In SquawkBox 747 type:
<br />
<code>.rw a/on</code>
<br />
You have to do this only once, SquawkBox 747 will remember the setting on next startup.
 
=== More Tips ===
There is an undocumented dot command in SquawkBox 747 that sets the transponder mode:
* <code>.xpdr standby</code>: force squawk-standby, regardless of the code that is set
* <code>.xpdr on</code>: force squawk-mode C (except when code is set as 0000)
* <code>.xpdr auto</code>: squawk-standby when airspeed is below 120 knots, regardless of the code that is set, and mode C when above 120 knots. This feature is meant to reduce ATC's radarscope clutter.
 
http://forum.flightgear.org/viewtopic.php?f=6&t=8816
 
 
 
== History ==
Curt thinks it worth pushing towards VATSIM connectivity:
{{Cquote|... a bridge acts as a FG multiplayer server ...<br/>... FG users stand to benefit ...|Curt<ref>http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg20971.html</ref><ref>http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg12538.html</ref> }}
 
Similar concept in 2006 (XPlane - FG)<ref>http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg03730.html</ref>, the difference is that SquawkGear interfaces with SB747, not XSB.
 
 
== References ==
* {{Cite web |url=http://hoppie.nl/sb747 |title=SquawkBox747 by hoppie}}
* The 'Broker' referred to by hoppie is the interface that SquawkGear emulates. The API is documented here: http://www.hoppie.nl/broker/downloads/747brok.html
* SquawkGear design (from FG forums): http://forum.flightgear.org/viewtopic.php?f=6&t=533&start=60#p66399
* Concerning multiplayer (visualisation of network air traffic):
http://forums.vatsim.net/viewtopic.php?f=8&t=47884
http://forums.vatsim.net/viewtopic.php?f=8&t=47884
* Concerning the FSD protocol: Download the FSD server source code (for testing a new client): http://flightsim.apollo3.com/files/fs-files-2.html (grab fsd1110.tar.gz)
* Concerning the NDA:
** http://forums.vatsim.net/viewtopic.php?p=350103#p350103 and
** http://forums.vatsim.net/viewtopic.php?p=350127#p350127


Concerning the FSD protocol:
* [http://xivap.linuxpunk.org/index.php/Main_Page X-IvAp] is a GPL'd IVAO client for X-Plane.
Download the FSD server source code (for testing a new client): http://flightsim.apollo3.com/files/fs-files-2.html (grab fsd1110.tar.gz)
* [http://vas-project.org/ VAS Project] is a GPL'd generic FMS for MSFS, X-Plane and (future) FlightGear.


Concerning the NDA:
{{Appendix}}
http://forums.vatsim.net/viewtopic.php?p=350103#p350103 and
http://forums.vatsim.net/viewtopic.php?p=350127#p350127


''What some people may not realize is that "FSD" predates VATSIM. VATSIM did not create, nor does it "own" the basic FSD design or protocol. VATSIM's FSD is slightly customized, but anyone can develop a pilot client that speaks the basic FSD language without signing VATSIM's NDA. You'll just need to do the NDA before your pilot client can be used on VATSIM.'' http://forums.vatsim.net/viewtopic.php?p=350127#p350127
== See also ==
* [[Swift]] A client currently (Mars 2019) under development
[[Category:Software]]

Revision as of 20:46, 7 May 2020

This article has been nominated for deletion since 07 May 2020. To discuss it, please visit the talk page.

Do not remove this tag until the discussion is closed.


Reason for the nomination: AVC not longer supported. SB747 support likely to end very soon.


This article or section contains out-of-date information

Please help improve this article by updating it. There may be additional information on the talk page.

SquawkGear allows you to fly FlightGear on VATSIM.

You can find all needed downloads and a good description how to do the setup at http://squawkgear.wordpress.com With Squawkbox 747 you show up as a Boeing 747 on VATSIM. Because of this you may want to use Squawkgear only in connection with airliner aircrafts to avoid confusions.

What is VATSIM?

VATSIM (short for the Virtual Air Traffic Simulation Network) is a completely free online platform which allows virtual pilots, wherever they are in the world, to connect their flight simulators into one shared virtual world. VATSIM also simulates air traffic control in this virtual world, creating the ultimate as-real-as-it-gets experience for you, the virtual aviation enthusiast.[1]

You have to register on http://www.vatsim.net in oder to be able to connect yourself to the VATSIM network. Registration (and membership) is free and can be done easily. Flying on VATSIM expects you to have good knowledge of:

  • how to fly your aircraft properly,
  • how to set up correct flightplans,
  • correct ATC communication.
Cquote1.png What some people may not realize is that "FSD" predates VATSIM. VATSIM did not create, nor does it "own" the basic FSD design or protocol. VATSIM's FSD is slightly customized, but anyone can develop a pilot client that speaks the basic FSD language without signing VATSIM's NDA. You'll just need to do the NDA before your pilot client can be used on VATSIM.
— Ross Carlson[2]
Cquote2.png

Quick guide

Installation and setup

  • It is recommended to read the instructions on http://squawkgear.wordpress.com carefully.
  • Download and install squawkgear, Squawkbox 747 and Advanced Voice Client AVC from http://squawkgear.wordpress.com
  • Place the additional files into the Flightgear folders and edit the files as described. Read also the further instructions below.
  • Set Flightgear Input/Output options as described.
  • Set Flightgear Network options as described.
  • Set Flightgear Multiplayer options as described. You may want to disable Multiplayer output by setting no output port to avoid appearing also in Flightgear Multiplayer enviroment.

Startup

  1. Make sure that you have a working VATSIM ID and password by registering to VATSIM.
  2. File your flightplan on https://cert.vatsim.net/fp/file.php
  3. Start squawkbox, then Flightgear, then SquawkBox747, then AVC.
  4. Make sure that you are on parking position and not on runway!
  5. In Squawkbox747, blank out the Flightplan and enter the callsign you used to file your flightplan.
  6. Set Squawkbox747 online
  7. Tune your radio to the ATC frequency of your relevant controller and make the initial contact.

Setup details

There are some pitfalls when installing Squawkgear and trying to fly for the first time. This section tries to cover some of them:

Input/Output

Put the file squawk.xml into fgdata/Protocol folder. Because this protocol file uses a wrong property you may want to edit squawk.xml

search the line

<node>/position/altitude-ft</node>

and replace it with:

<node>/instrumentation/altimeter/indicated-altitude-ft</node>

Then either use command line options or edit the Advanced Options in FGRun to add the following lines:
--generic=socket,out,1,IP_OF_SQUAWKGEAR,1863,tcp,squawk
--telnet=socket,in,1,IP_OF_SQUAWKGEAR,5900,tcp
where IP_OF_SQUAWKGEAR is the IP address of the PC running squawkgear. Normally, this is the IP of your PC.

Multiplay

Advanced Options in FGRun - Network - Multiplayer Options should be set to:
Callsign: your callsign used for filing the flightplan
Multiplay 1: out,10,mpserver01.flightgear.org,0
Multiplay 2: in,10,,5000

Menu bar

http://squawkgear.wordpress.com describes how to edit the gui/menubar.xml, but the description is deprecated. Instead, insert the following:

<menu>
  <name>Squawkgear</name>
  <item>
    <name>DirectComms</name>
    <binding>
      <command>dialog-show</command>
      <dialog-name>sq_comm</dialog-name>
    </binding>
  </item>
</menu>

AVC auto tuning

You may find it helpful to have auto tuning on. When you set your COM frequency in Flightgear, AVC will automatically enter the corrsponding channel. In SquawkBox 747 type:
.rw a/on
You have to do this only once, SquawkBox 747 will remember the setting on next startup.

More Tips

There is an undocumented dot command in SquawkBox 747 that sets the transponder mode:

  • .xpdr standby: force squawk-standby, regardless of the code that is set
  • .xpdr on: force squawk-mode C (except when code is set as 0000)
  • .xpdr auto: squawk-standby when airspeed is below 120 knots, regardless of the code that is set, and mode C when above 120 knots. This feature is meant to reduce ATC's radarscope clutter.

http://forum.flightgear.org/viewtopic.php?f=6&t=8816


History

Curt thinks it worth pushing towards VATSIM connectivity:

Cquote1.png ... a bridge acts as a FG multiplayer server ...
... FG users stand to benefit ...
— Curt[3][4]
Cquote2.png

Similar concept in 2006 (XPlane - FG)[5], the difference is that SquawkGear interfaces with SB747, not XSB.


References

http://forums.vatsim.net/viewtopic.php?f=8&t=47884

  • X-IvAp is a GPL'd IVAO client for X-Plane.
  • VAS Project is a GPL'd generic FMS for MSFS, X-Plane and (future) FlightGear.
References

See also

  • Swift A client currently (Mars 2019) under development