zkv1000 / README.md /
Newer Older
152 lines | 8.348kb
commit initial
Sébastien MARQUE authored on 2017-03-07
1
[0%]:   https://upload.wikimedia.org/wikipedia/commons/thumb/5/5c/Progress_00.svg/80px-Progress_00.svg.png "00%"
2
[10%]:  https://upload.wikimedia.org/wikipedia/commons/thumb/c/c4/Progress_10.svg/80px-Progress_10.svg.png "10%"
3
[20%]:  https://upload.wikimedia.org/wikipedia/commons/thumb/9/96/Progress_20.svg/80px-Progress_20.svg.png "20%"
4
[30%]:  https://upload.wikimedia.org/wikipedia/commons/thumb/2/22/Progress_30.svg/80px-Progress_30.svg.png "30%"
5
[40%]:  https://upload.wikimedia.org/wikipedia/commons/thumb/5/5c/Progress_40.svg/80px-Progress_40.svg.png "40%"
6
[50%]:  https://upload.wikimedia.org/wikipedia/commons/thumb/f/f2/Progress_50.svg/80px-Progress_50.svg.png "50%"
7
[60%]:  https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Progress_60.svg/80px-Progress_60.svg.png "60%"
8
[70%]:  https://upload.wikimedia.org/wikipedia/commons/thumb/5/5e/Progress_70.svg/80px-Progress_70.svg.png "70%"
9
[80%]:  https://upload.wikimedia.org/wikipedia/commons/thumb/5/57/Progress_80.svg/80px-Progress_80.svg.png "80%"
10
[90%]:  https://upload.wikimedia.org/wikipedia/commons/thumb/b/ba/Progress_90.svg/80px-Progress_90.svg.png "90%"
11
[100%]: https://upload.wikimedia.org/wikipedia/commons/thumb/8/82/Progress_100.svg/80px-Progress_100.svg.png "100%"
12
[abandonned]: http://wiki.flightgear.org/images/thumb/3/30/Cross_32px.png/16px-Cross_32px.png         "abandonné"
13
[done]:       http://wiki.flightgear.org/images/thumb/7/75/Tick_32px.png/16px-Tick_32px.png           "fait"
14
[ongoing]:    http://wiki.flightgear.org/images/thumb/3/37/Ongoing.png/16px-Ongoing.png               "en cours"
15
[pending]:    http://wiki.flightgear.org/images/thumb/8/8d/Hourglass_32px.png/16px-Hourglass_32px.png "en attente"
16
[fixed]:      http://wiki.flightgear.org/images/thumb/8/85/WIP.png/26px-WIP.png                       "réparé"
17
[paused]:     http://wiki.flightgear.org/images/thumb/d/dc/Paused.png/16px-Paused.png                 "en pause"
18

            
update README before merging
Sébastien MARQUE authored on 2017-03-20
19
![ZKV1000, just after boot](https://sebmarque.hd.free.fr/bozon/index.php?f=158cf9534074e2)
improve README
Sébastien MARQUE authored on 2017-03-20
20
ZKV1000 just after booting, installed in the Lancair 235 (all other instruments removed)  
21
[other pictures available here](https://sebmarque.hd.free.fr/bozon/index.php?f=158cf95340742d)
update README before merging
Sébastien MARQUE authored on 2017-03-20
22

            
23
# Thanks
24
Thanks to the modeller of the [GDU104X project "Farmin/G1000"](http://wiki.flightgear.org/Project_Farmin/FG1000)(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.  
25
Thanks to Hooray's nice efforts, and some examples ans snipsets of code here and there from the Canvas team.  
26
Thanks to all FlightGear community for the funny project I let too many years off side...
27

            
28
# Origin
29
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
30
it is at least more modulable.
31

            
32
The origin is to simulate a Garmin Primus 1000, as near as possible of the [documentation found](# documentation).
33

            
34
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
35
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. 
36
This is GPL-2 license though :)
37

            
38
# Objectives
39
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.
40

            
41
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)
42

            
43
I'm particulary looking at these points:
44

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

            
50
# Progress
51
Note: this is not because the progress bar show 100% that it means it is 100% bug free :)
52
Please report bug at <seb.marque@free.fr>.
53

            
54
* ![][100%]
55
  * Basic Flight Instrumentation: AI, IAS, ALT, HDG
56
  * Wind data widget
57
  * trends for altitude and speed (6s prevision)
58
  * TAS and Ground Speed display
59
  * VSI
60
  * 3D knobs rotate
61
  * map display on inflight page (with online maps downloading and caching)
62
  * display of NavAids on map
63
  * XPDR from SoftKeys
adds BARO settings
Sébastien MARQUE authored on 2017-03-20
64
  * Selected altitude bug (widget off if IA within 100ft)
65
  * baro settings
Softkeys revert to the previ...
Sébastien MARQUE authored on 2017-03-21
66
  * SoftKeys menus navigation for PFD and MFD, not yet implemented function are logged in console
update README before merging
Sébastien MARQUE authored on 2017-03-20
67
* ![][90%]
68
  * Radio stack, including ID for NAV (bug: NAV1 ID isn't displayed ![][pause])
69
  * Bearing needs some checks to be sure it shows the correct information
70
  * CDI ![][ongoing], lacks information about the scale
71
  * XPDR: emergency code depending of the country (eg.: 1200 for US, 7700 for Europe), should be set in settings
72
* ![][80%]
73
  * EIS: texts displayed ![][done], animations for fuel ![][ongoing]
74
* ![][70%]
improve README
Sébastien MARQUE authored on 2017-03-20
75
  * make booting animation visible ![][pending]
update README before merging
Sébastien MARQUE authored on 2017-03-20
76
* ![][60%]
77
* ![][50%]
78
  * EIS: animations for temperature for YaSim and JSBSim
79
* ![][40%]
80
  * use of [maketimer()](http://wiki.flightgear.org/Nasal_library#maketimer.28.29) instead of [settimer()](http://wiki.flightgear.org/Nasal_library#settimer.28.29) when possible
81
* ![][30%]
82
* ![][20%]
83
* ![][10%]
84
  * multikey for every part of the device (actually only power on)
85
* ![][0%] (TODO list, unsorted)
86
  * XPDR from FMS knob
87
  * rotating online map on inflight page
88
  * some aircraft specific data to retrieve from aircraft XML files (VNE, etc)
89
  * display of specific speeds in ruler
90
  * angle of attack display
91
  * Alerts
92
  * Flight planning (MFD)
93
  * Setting pages (MFD)
94
  * Inset Map (PFD)
95
  * PFD settings
96
  * texture for some MFD buttons
97
  * rotation and zooming of online maps in-flight ![][pending]
adds BARO settings
Sébastien MARQUE authored on 2017-03-20
98
  * OMI
99
  * VS guidance
100
  * VNAV
update README before merging
Sébastien MARQUE authored on 2017-03-20
101
  * tutorials
102
  * many more...
commit initial
Sébastien MARQUE authored on 2017-03-07
103

            
improve README
Sébastien MARQUE authored on 2017-03-20
104
# Installation
105
Somewhere in the XML configuration of your aircraft, put only few lines
106
## Create the `zkv1000` Nasal namespace
107
In the `<nasal>` place of your aircraft configuration
108

            
109
        <zkv1000>
110
            <file>Aircraft/Instruments-3d/zkv1000/zkv1000.nas</file>
111
        </zkv1000>
112

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

            
115
## 3D models
116
In the definition of your flightdeck (here are the values for the installation in the Lancair 235 in which I develop the device)
117
put it everywhere you want to
118

            
119
        <model>
120
            <path>Aircraft/Instruments-3d/zkv1000/pfd.xml</path>
121
            <offsets>
122
                <x-m> -0.023 </x-m>
123
                <y-m> -0.235 </y-m>
124
                <z-m> -0.028 </z-m>
125
            </offsets>
126
        </model>
127
        <model>
128
            <path>Aircraft/Instruments-3d/zkv1000/mfd.xml</path>
129
            <offsets>
130
                <x-m>  0.03  </x-m>
131
                <y-m>  0.06  </y-m>
132
                <z-m> -0.028 </z-m>
133
                <heading-deg> -15 </heading-deg>
134
            </offsets>
135
        </model>
136

            
137
## Switch it up
138
You can use the multikey (souvenirs, thanks to Melchior having that much expended this feature years ago :)) service by typing:
139
`:zo`
140

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

            
143
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).
144
1. If you see multiple dots under the `ZKV1000 xxx init` message, something wrong happened, time to check console
145
1. If you see only black screen on one of the screen, something really wrong happened, time to check console
146

            
147
# Documentation
update README before merging
Sébastien MARQUE authored on 2017-03-20
148
* [Canvas in FG](http://wiki.flightgear.org/Category:Canvas)
mise à jour du README
Sébastien MARQUE authored on 2017-03-07
149
* [Nasal](http://wiki.flightgear.org/Category:Nasal)
update README before merging
Sébastien MARQUE authored on 2017-03-20
150
* the guides used to create the scenario from [Garmin website](http://support.garmin.com/support/manuals/searchManuals.faces)
liens directs vers la doc of...
Sébastien MARQUE authored on 2017-03-08
151
    * [G1000 Pilot’s Guide for the Diamond DA42 (v0370.22)](http://static.garmin.com/pumac/190-00406-07_0B_Web.pdf) *(94 pages)*
152
    * [Pilot's Guide, Cirrus Perspective, SR2x (v0764.30)](http://static.garmin.com/pumac/190-00820-11_A.pdf) *(752 pages)*