Howto:Add instruments to a cockpit: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
No edit summary
m (Johan G moved page Howto:Adding instruments to an aircraft to Howto:Add instruments to a cockpit: More to the point; Grammar)
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{WIP}}
This is one way '''how to add instruments to a cockpit'''.  While many of the aircraft for FlightGear have both rather detailed and completely instrumented cockpits, many aircraft either only have the most basic instruments or even none at all.


Many of the [[aircraft]] offerred for download on the [[FlightGear]] aircraft download page are detailled and complete. Some models, however lack instrumentation, and in many cases only basic instruments are available. Fortunately, '''adding new instruments''' is a relatively easy task. The biggest difficulty is actually placing the instrument accurately, not to get it working.
Fortunately, adding already existing instruments to a cockpit is a relatively easy task. The biggest difficulty is actually placing them accurately.


For aircraft that are licensed under the [[GNU GPL]] (all aircraft on the official download page are), instruments can be re-used in other aircraft when released under the same license.
For aircraft that are licensed under the [[GNU GPL]] (all aircraft on the official download page are), instruments can be re-used in other aircraft when released under the same license.


== Adding instruments to existing models ==
== Workflow ==
Adding instruments consists of a few major steps:
Adding instruments consists of a few major steps:


Line 12: Line 12:
# Edit the updated aircraft file to place the instrument.
# Edit the updated aircraft file to place the instrument.


== An example ==
== Example ==
Let's update the instruments of the [[Bombardier Dash 8|Dash 8-300Q]] for a start.  
Let's update the instruments of the [[Bombardier Dash 8|Dash 8-300Q]] for a start.  


Line 31: Line 31:
First let's add the VSI (Vertical Speed Indicator) . Locate the tags for the ASI in a similar aircraft config file, the Beech 1900D (B1900D). These appear in the B1900D.xml file as follows:
First let's add the VSI (Vertical Speed Indicator) . Locate the tags for the ASI in a similar aircraft config file, the Beech 1900D (B1900D). These appear in the B1900D.xml file as follows:


<model>
<syntaxhighlight lang="xml">
    <model>
         <name>VSI 1 gauge</name>
         <name>VSI 1 gauge</name>
         <path>Aircraft/b1900d/Models/Instruments/vsi.xml</path>
         <path>Aircraft/b1900d/Models/Instruments/vsi.xml</path>
Line 41: Line 42:
         </offsets>
         </offsets>
     </model>
     </model>
</syntaxhighlight>


Copy this set of tags as shown above into the Dash8 300Q xml file containing the instruments in the models folder. The file is named dhc8-300Q.xml
Copy this set of tags as shown above into the Dash8 300Q xml file in the models folder. The file is named dhc8-300Q.xml


The instrument now has to be placed in position. This is done by changing the x, y and z coordinates as listed above.  
The instrument now has to be placed in position.  
   
   
We will use an existing instrument, the Air Speed Indicator of the DHC8 as a reference. The DHC 8 pilot ASI has the following settings.
We will use an existing instrument, the Air Speed Indicator of the DHC8 as a reference. The DHC 8 pilot ASI has the following settings.


  <model>
<syntaxhighlight lang="xml">
    <model>
     <name>Pilot asi</name>
     <name>Pilot asi</name>
    <path>Aircraft/dhc8/Models/Instruments/asi300-3d.xml</path>
        <path>Aircraft/dhc8/Models/Instruments/asi300-3d.xml</path>
         <offsets>
         <offsets>
             '''<x-m>-8.927</x-m>
             '''<x-m>-8.927</x-m>
Line 58: Line 61:
         </offsets>
         </offsets>
     </model>
     </model>
</syntaxhighlight>


Copy the <offsets> ... </offsets> section and paste it into the offsets section of the VSI instrument, replacing the existing settings.
Copy the <code>&lt;offsets&gt; ... &lt;/offsets&gt;</code> section and paste it into the offsets section of the VSI instrument, replacing the existing settings.


<model>
<syntaxhighlight lang="xml">
    <model>
         <name>VSI 1 gauge</name>
         <name>VSI 1 gauge</name>
         <path>Aircraft/b1900d/Models/Instruments/vsi.xml</path>
         <path>Aircraft/b1900d/Models/Instruments/vsi.xml</path>
Line 71: Line 76:
         </offsets>
         </offsets>
     </model>
     </model>
 
</syntaxhighlight>


You will find that the VSI, the new instrument, will appear on top of the existing one. This confirms that the instrument appears in the cockpit.  
You will find that the VSI, the new instrument, will appear on top of the existing one. This confirms that the instrument appears in the cockpit.  
Line 77: Line 82:
To place the instrument in a correct location, use the following adjustments:
To place the instrument in a correct location, use the following adjustments:


            <x-m>-8.927</x-mdistance of the instrument from the pilot (depth)
* <code>&lt;x-m&gt;</codeDistance of the instrument from the pilot (depth)
            <y-m>-0.702</y-msideways location of the instrument
* <code>&lt;y-m&gt;</codeSideways location of the instrument
            <z-m>2.382</z-m>   vertical location of the instrument
* <code>&lt;z-m&gt;</code> Vertical location of the instrument


Using the offsets for an existing instrument, the altimeter, ALT, the VSI can be placed directly on top of the ALT using the offsets for the Altimeter, which is  <y-m>-0.44</y-m>. To move the VSI down, experiment with different values of the z value, 2.182, 2.282, 2.382 etc.  
Using the offsets for an existing instrument, the altimeter, ALT, the VSI can be placed directly on top of the altimeter. The Y value for the altimeter is  <code>&lt;y-m&gt;-0.44&lt;/y-m&gt;</code>. To move the VSI down, experiment with different values of the z value, 2.182, 2.282, 2.382 etc.  


Finally, adjust the depth of the instrument (x - value)
Finally, adjust the depth of the instrument (x - value)


== A shortcut: multiple copies of an instrument==
== A shortcut: multiple copies of an instrument==
FlightGear allows the creation of the same instrument copies in different locations in the cockpit. We can use this to our advantage: placing copies of the same instrument in different locations in the cockpit and selecting the right one.
FlightGear allows the creation of the same instrument copies in different locations in the cockpit. We can use this to our advantage: placing copies of the same instrument in different locations in the cockpit and selecting the right one.


[[File:MultipleVSI.jpg|thumb|VSI in multiple locations. Choose the best. ]]


== Instrument path ==
The path can be left as follows, or the instrument related files (.ac, xml and image files) can be copied to the DHC8 folder and the reference can be changed to that folder:


== More on placement==
<syntaxhighlight lang="xml">
* '''X:''' specifies the depth, and in this case is a negative value. The increase in the value, say from -2.330 to -2.430 means the instrument will move away from you into the panel, towards the nose of the aircraft.
* '''Y:''' is the simplest, here, and simply specifies left/right values. The pilot ASI is listed with an Y value of -xxx. The value of zero means it is centre in the panel. You will notice the the co-pilot's ASI has a positive value of xxx.
* '''Z:''' gives the position of the instrument in the vertical direction. For example 2.223 will place the instrument higher than 2.123 in the panel.
 
==Instrument path==
 
The path can be left as follows, or the instrument xml files and image files can be copied to the DHC8 folder and the reference can be changed to that folder:
 
  <path>Aircraft/b1900d/Models/Instruments/vsi.xml</path>
  <path>Aircraft/b1900d/Models/Instruments/vsi.xml</path>
</syntaxhighlight>


can be changed to  
can be changed to  


<syntaxhighlight lang="xml">
  <path>Aircraft/dhc8/Models/Instruments/vsi.xml</path>
  <path>Aircraft/dhc8/Models/Instruments/vsi.xml</path>
</syntaxhighlight>


[[File:dhc8addedinstruments.jpg|thumb|270px|Several instruments added. Fine adjustment needed.]]
[[File:dhc8addedinstruments.jpg|thumb|270px|Several instruments added. Fine adjustment needed.]]


== External link ==
== Related content ==
* [http://en.wikipedia.org/wiki/Flight_instruments Flight instruments] (Wikipedia)
=== Wiki articles ===
* [[Avionics and instruments]]
 
== External links ==
* {{wikipedia|Flight instruments}}
 
* [http://www.faa.gov/library/manuals/aviation/instrument_flying_handbook/media/FAA-H-8083-15A%20-%20Chapter%2003.pdf FAA Instrument Flying Handbook] (Free e-book)


[[Category:Aircraft enhancement]]
[[Category:Aircraft enhancement]]
[[Category:Howto]]
[[Category:Howto]]

Latest revision as of 09:45, 13 June 2015

This is one way how to add instruments to a cockpit. While many of the aircraft for FlightGear have both rather detailed and completely instrumented cockpits, many aircraft either only have the most basic instruments or even none at all.

Fortunately, adding already existing instruments to a cockpit is a relatively easy task. The biggest difficulty is actually placing them accurately.

For aircraft that are licensed under the GNU GPL (all aircraft on the official download page are), instruments can be re-used in other aircraft when released under the same license.

Workflow

Adding instruments consists of a few major steps:

  1. Locate an FG aircraft with a similar instrument.
  2. Copy XML tags relevant to the instrument files into XML file of the aircraft you want to update.
  3. Edit the updated aircraft file to place the instrument.

Example

Let's update the instruments of the Dash 8-300Q for a start.

The existing aircraft, version v20101217 from the version 2.6 aircraft download page has the following set of basic flight instruments.

  • Air Speed Indicator (ASI)
  • Altimeter
  • Artificial Horizon
Cockpit of the Dash 8 with some instruments missing.

We can see that our aircraft is lacking the following:

  • Vertical Speed Indicator (VSI)
  • Electronic Flight Systems Information (EFSI)
  • Electronic Horizontal Situation Indicator (EHSI)
  • Radio Magnetic Indicator (RMI)
  • VOR instrument

First let's add the VSI (Vertical Speed Indicator) . Locate the tags for the ASI in a similar aircraft config file, the Beech 1900D (B1900D). These appear in the B1900D.xml file as follows:

    <model>
        <name>VSI 1 gauge</name>
        <path>Aircraft/b1900d/Models/Instruments/vsi.xml</path>
        <offsets>
            <x-m>-4.860</x-m>
            <y-m>-0.280</y-m>
            <z-m>-0.082</z-m>
            <pitch-deg>-10</pitch-deg>
        </offsets>
    </model>

Copy this set of tags as shown above into the Dash8 300Q xml file in the models folder. The file is named dhc8-300Q.xml

The instrument now has to be placed in position.

We will use an existing instrument, the Air Speed Indicator of the DHC8 as a reference. The DHC 8 pilot ASI has the following settings.

    <model>
     	<name>Pilot asi</name>
        <path>Aircraft/dhc8/Models/Instruments/asi300-3d.xml</path>
        <offsets>
            '''<x-m>-8.927</x-m>
            <y-m>-0.702</y-m>
            <z-m>2.382</z-m>'''
            <pitch-deg>0</pitch-deg>
        </offsets>
    </model>

Copy the <offsets> ... </offsets> section and paste it into the offsets section of the VSI instrument, replacing the existing settings.

    <model>
        <name>VSI 1 gauge</name>
        <path>Aircraft/b1900d/Models/Instruments/vsi.xml</path>
        <offsets>
            '''<x-m>-8.927</x-m>
            <y-m>-0.702</y-m>
            <z-m>2.382</z-m>'''
            <pitch-deg>0</pitch-deg>
        </offsets>
    </model>

You will find that the VSI, the new instrument, will appear on top of the existing one. This confirms that the instrument appears in the cockpit.

To place the instrument in a correct location, use the following adjustments:

  • <x-m> Distance of the instrument from the pilot (depth)
  • <y-m> Sideways location of the instrument
  • <z-m> Vertical location of the instrument

Using the offsets for an existing instrument, the altimeter, ALT, the VSI can be placed directly on top of the altimeter. The Y value for the altimeter is <y-m>-0.44</y-m>. To move the VSI down, experiment with different values of the z value, 2.182, 2.282, 2.382 etc.

Finally, adjust the depth of the instrument (x - value)

A shortcut: multiple copies of an instrument

FlightGear allows the creation of the same instrument copies in different locations in the cockpit. We can use this to our advantage: placing copies of the same instrument in different locations in the cockpit and selecting the right one.

VSI in multiple locations. Choose the best.

Instrument path

The path can be left as follows, or the instrument related files (.ac, xml and image files) can be copied to the DHC8 folder and the reference can be changed to that folder:

 <path>Aircraft/b1900d/Models/Instruments/vsi.xml</path>

can be changed to

 <path>Aircraft/dhc8/Models/Instruments/vsi.xml</path>
Several instruments added. Fine adjustment needed.

Related content

Wiki articles

External links