User:Zakharov/zkv1000 installation guide

Get the sources

the whole zkv1000 can be retrieved from https://sebmarque.hd.free.fr/git/seb/zkv1000. You will have the choice with different ways (git, zip or tar.gz).

You have the choice of the destination of the source (in order of recommandation)

1. in $FGHOME/Aircraft/Instruments-3d
2. in your aircraft directory
3. in $FGDATA/Aircraft/Instruments-3d

We'll refer to the zkv1000 installation directory as $ZKV1000 later in this document

Installation in the cockpit

The glass cockpit and the material around are included in the sources, but you can provide yours. Please see the advanced installation below.

The zkv1000 provides files in order to let you choose if you want a PFD, a MFP, both of them, or two PFDs and one PFD.

So the installation depends on what you want. Place in your cockpit the following files in the XML definition files of your aircraft

Configuration	Files needed
PFD only	$ZKV1000/pfd-pilot.xml
MFD only	$ZKV1000/mfd.xml
1 PFD + 1 MFD	$ZKV1000/pfd-pilot.xml + $ZKV1000/mfd.xml
2 PFD + 1 MFD	$ZKV1000/pfd-pilot.xml + $ZKV1000/pfd-copilot.xml + $ZKV1000/mfd.xml

Here's an example from the Lancair 235, configuration with a PFD in front of the pilot's seat and a MFD between the pilot's seat and the copilot's seat, a bit inclinated in direction of the pilot. These lines take place in the dedicated file about the cockpit definition.

  <model>
    <path>Aircraft/Instruments-3d/zkv1000/pfd-pilot.xml</path>
    <offsets>
      <x-m> -0.023 </x-m>
      <y-m> -0.235 </y-m>
      <z-m> -0.028 </z-m>
    </offsets>
  </model>
  <model>
    <path>Aircraft/Instruments-3d/zkv1000/mfd.xml</path>
    <offsets>
      <x-m> 0.03 </x-m>
      <y-m>  0.06 </y-m>
      <z-m> -0.028 </z-m>
      <heading-deg> -15 </heading-deg>
    </offsets>
  </model>

make it work

Once your device is installed in your cockpit you may tell FligthGear where to find the underlying Nasal code. This is done in the <nasal> section of your aircraft definition. Obviously this is one of the manadatory step and value, the Nasal namespace must be zkv1000.

    <zkv1000>
      <file>Aircraft/Instruments-3d/zkv1000/zkv1000.nas</file>
    </zkv1000>

You have other options you can pass to the device in the <instrumentation> section of your aircraft definition

  <instrumentation>
...
    <zkv1000>
      <alerts>
        <Vx>15</Vx>
        <Vy>110</Vy>
        <Vr>65</Vr>
        <Vglide>80</Vglide>
        <stall-aoa>12</stall-aoa>
        <approach-aoa>4</approach-aoa>
      </alerts>
      <eis>
        <type>single-prop</type>
      </eis>
    </zkv1000>
...
  </instrumentation>

The available options are

Category	Option	Meaning	Values
alerts	Vx	default Vx speed, displayed with a mark in the PFD's speed tape, may be modified by user, no default value	a number in knots, it can be modified by user using zkv1000 UI, no default value
	Vy	default Vy speed, displayed with a mark in the PFD's speed tape
	Vr	default Vr speed, displayed with a mark in the PFD's speed tape
	Vglide	default Vglide speed, displayed with a mark in the PFD's speed tape
	stall-aoa	The stalling angle of attack, if defined it is displayed in AOA widget	a number in degrees
	approach-aoa	The expected angle of attack at approach phase, if defined it is displayed in AOA widget
eis	type or file	the type of EIS on MFD only, defaults to none	"none" means... none, the other possible values are the nasal definitions of file as in $ZKV1000/Nasal/eis (without the .nas extension) or the relative path to your definition specific to your aircarft

More options to come...

The zkv1000 Nasal code is loaded at the end of the FDM initialization. Knowing that if you want to automagically switch on the zkv1000 there is a function named zkv1000.powerOn(), otherwise there is a predefined multikey :zo witch will call the powerOn() function

This should work and you and your aircraft's users should enjoy the instrument :)

Advanced installation

The most important is to keep the name of the 3D object about