Le ZKV1000

Sébastien MARQUE improve README
Latest commit d9ed6c3 7 years ago
README.md

ZKV1000, just after boot ZKV1000 just after booting, installed in the Lancair 235 (all other instruments removed)
other pictures available here

Thanks

Thanks to the modeller of the GDU104X project "Farmin/G1000"(can't remember who, if he/she can tell me...) I can continue the work began many years ago with a nicer (and working) 3D model instrument. Thanks to him/her for the SVG basis file too.
Thanks to Hooray's nice efforts, and some examples ans snipsets of code here and there from the Canvas team.
Thanks to all FlightGear community for the funny project I let too many years off side...

Origin

The first ZKV1000, which was completly XML animated, was completly abandonned. Moreover the Nasal code became unmaintanable from my point of view. Not sure this one is better, but I think it is at least more modulable.

The origin is to simulate a Garmin Primus 1000, as near as possible of the documentation found.

But as we are in a simulation, the zkv1000 is definitly not a replica of the well-known G1000, as it takes the liberty to be integrated with some features that doesn't exit in the real device, as well as some real features aren't scheduled to be implemented. But, it should be easy to add or remove features in order to get the real device. This is GPL-2 license though :)

Objectives

There is no intention to provide a fully qualified G1000 in order to train or so, but this should be possible to be done from the zkv1000.

And it is intented to be a two displays device (PFD/MFD-Reversionary PFD), even if it shouldn't be that hard to make it three displays device (2 PFD, one MFD-Reversionnary PFD)

I'm particulary looking at these points:

  1. easy to implement new features
  2. optimized code (from my non-dev point of view...)
  3. easy to integrate in every cockpit with only few lines, and with easy use for the pilot
  4. near from the G1000 documentation but with some neat features added, and some unrelevant features in a sim removed

Progress

Note: this is not because the progress bar show 100% that it means it is 100% bug free :) Please report bug at seb.marque@free.fr.

    • Basic Flight Instrumentation: AI, IAS, ALT, HDG
    • Wind data widget
    • trends for altitude and speed (6s prevision)
    • TAS and Ground Speed display
    • VSI
    • 3D knobs rotate
    • map display on inflight page (with online maps downloading and caching)
    • display of NavAids on map
    • XPDR from SoftKeys
    • SoftKeys menus navigation for PFD and MFD, not yet implemented function are logged in console (not yet 100% because it lackss the 45sec timer of inactivity on every level, actually done only for XPDR menu, that can easily be extended )
    • Radio stack, including ID for NAV (bug: NAV1 ID isn't displayed ![][pause])
    • Bearing needs some checks to be sure it shows the correct information
    • CDI , lacks information about the scale
    • XPDR: emergency code depending of the country (eg.: 1200 for US, 7700 for Europe), should be set in settings
    • EIS: texts displayed , animations for fuel
    • make booting animation visible
    • EIS: animations for temperature for YaSim and JSBSim
    • multikey for every part of the device (actually only power on)
  • (TODO list, unsorted)
    • XPDR from FMS knob
    • rotating online map on inflight page
    • some aircraft specific data to retrieve from aircraft XML files (VNE, etc)
    • display of specific speeds in ruler
    • angle of attack display
    • baro settings
    • Alerts
    • Flight planning (MFD)
    • Setting pages (MFD)
    • Inset Map (PFD)
    • PFD settings
    • texture for some MFD buttons
    • rotation and zooming of online maps in-flight
    • tutorials
    • many more...

Installation

Somewhere in the XML configuration of your aircraft, put only few lines

Create the zkv1000 Nasal namespace

In the <nasal> place of your aircraft configuration

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

Actually this is where everything begins, please have a look at this code, it would help you to follow the script.

3D models

In the definition of your flightdeck (here are the values for the installation in the Lancair 235 in which I develop the device) put it everywhere you want to

    <model>
        <path>Aircraft/Instruments-3d/zkv1000/pfd.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>

Switch it up

You can use the multikey (souvenirs, thanks to Melchior having that much expended this feature years ago :)) service by typing: :zo

The :z will be the multikey entry for all multikeys of the zkv1000.

  1. If you see a single red dot under the ZKV100O xxx init message (xxx = MFD or PFD), this is likely the sim is paused (press p by default to stop the pause).
  2. If you see multiple dots under the ZKV1000 xxx init message, something wrong happened, time to check console
  3. If you see only black screen on one of the screen, something really wrong happened, time to check console

Documentation