zkv1000 / README.md /
Newer Older
159 lines | 8.792kb
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"
add bug icon in README.md
Sébastien MARQUE authored on 2017-03-23
18
[green-bug]:  https://upload.wikimedia.org/wikipedia/commons/thumb/6/63/Green_bug.svg/32px-Green_bug.svg.png "non blocking bug"
19
[red-bug]:    https://upload.wikimedia.org/wikipedia/commons/thumb/a/a4/Red_bug.svg/32px-Red_bug.svg.png "blocking bug"
commit initial
Sébastien MARQUE authored on 2017-03-07
20

            
update README before merging
Sébastien MARQUE authored on 2017-03-20
21
![ZKV1000, just after boot](https://sebmarque.hd.free.fr/bozon/index.php?f=158cf9534074e2)
improve README
Sébastien MARQUE authored on 2017-03-20
22
ZKV1000 just after booting, installed in the Lancair 235 (all other instruments removed)  
23
[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
24

            
25
# Thanks
26
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.  
27
Thanks to Hooray's nice efforts, and some examples ans snipsets of code here and there from the Canvas team.  
28
Thanks to all FlightGear community for the funny project I let too many years off side...
29

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

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

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

            
40
# Objectives
41
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.
42

            
43
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)
44

            
45
I'm particulary looking at these points:
46

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

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

            
56
* ![][100%]
57
  * Basic Flight Instrumentation: AI, IAS, ALT, HDG
58
  * Wind data widget
59
  * trends for altitude and speed (6s prevision)
60
  * TAS and Ground Speed display
61
  * VSI
62
  * 3D knobs rotate
63
  * map display on inflight page (with online maps downloading and caching)
64
  * display of NavAids on map
XPDR settings via knob or so...
Sébastien MARQUE authored on 2017-03-22
65
  * XPDR from SoftKeys and knob, with respect of delays from the manual
adds BARO settings
Sébastien MARQUE authored on 2017-03-20
66
  * Selected altitude bug (widget off if IA within 100ft)
67
  * baro settings
add softkeys colors
Sébastien MARQUE authored on 2017-03-21
68
  * SoftKeys menus navigation for PFD and MFD
69
    * not yet implemented function are logged in console
70
    * softkeys colorized when active
71
    * alerts with white backgroud and black text available
makes the CDI available
Sébastien MARQUE authored on 2017-03-23
72
  * CDI
adds OMI to PFD
Sébastien MARQUE authored on 2017-03-23
73
  * OMI
adds slipskid animation
Sébastien MARQUE authored on 2017-03-24
74
  * Slipskid animation
new var organistaion (and fi...
Sébastien MARQUE authored on 2017-03-26
75
  * Radio stack, including ID for NAV
update README before merging
Sébastien MARQUE authored on 2017-03-20
76
* ![][90%]
77
  * Bearing needs some checks to be sure it shows the correct information
78
  * XPDR: emergency code depending of the country (eg.: 1200 for US, 7700 for Europe), should be set in settings
79
* ![][80%]
80
  * EIS: texts displayed ![][done], animations for fuel ![][ongoing]
81
* ![][70%]
improve README
Sébastien MARQUE authored on 2017-03-20
82
  * make booting animation visible ![][pending]
update README before merging
Sébastien MARQUE authored on 2017-03-20
83
* ![][60%]
add window management
Sébastien MARQUE authored on 2017-03-28
84
  * windows management: selectable items ![][done], modifiable items ![][done], scrolling ![][ongoing]
update README before merging
Sébastien MARQUE authored on 2017-03-20
85
* ![][50%]
86
  * EIS: animations for temperature for YaSim and JSBSim
87
* ![][40%]
88
  * 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
TMR/REF window
Sébastien MARQUE authored on 2017-03-28
89
  * TMR/REF ![][ongoing]
update README before merging
Sébastien MARQUE authored on 2017-03-20
90
* ![][30%]
91
* ![][20%]
92
* ![][10%]
93
  * multikey for every part of the device (actually only power on)
94
* ![][0%] (TODO list, unsorted)
makes the CDI available
Sébastien MARQUE authored on 2017-03-23
95
  * CDI/GPS: scale depending of the flight phase
update README before merging
Sébastien MARQUE authored on 2017-03-20
96
  * some aircraft specific data to retrieve from aircraft XML files (VNE, etc)
97
  * display of specific speeds in ruler
98
  * angle of attack display
99
  * Alerts
100
  * Flight planning (MFD)
101
  * Setting pages (MFD)
102
  * Inset Map (PFD)
103
  * PFD settings
104
  * texture for some MFD buttons
105
  * rotation and zooming of online maps in-flight ![][pending]
adds BARO settings
Sébastien MARQUE authored on 2017-03-20
106
  * VS guidance
107
  * VNAV
update README before merging
Sébastien MARQUE authored on 2017-03-20
108
  * tutorials
109
  * many more...
commit initial
Sébastien MARQUE authored on 2017-03-07
110

            
improve README
Sébastien MARQUE authored on 2017-03-20
111
# Installation
112
Somewhere in the XML configuration of your aircraft, put only few lines
113
## Create the `zkv1000` Nasal namespace
114
In the `<nasal>` place of your aircraft configuration
115

            
116
        <zkv1000>
117
            <file>Aircraft/Instruments-3d/zkv1000/zkv1000.nas</file>
118
        </zkv1000>
119

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

            
122
## 3D models
123
In the definition of your flightdeck (here are the values for the installation in the Lancair 235 in which I develop the device)
124
put it everywhere you want to
125

            
126
        <model>
127
            <path>Aircraft/Instruments-3d/zkv1000/pfd.xml</path>
128
            <offsets>
129
                <x-m> -0.023 </x-m>
130
                <y-m> -0.235 </y-m>
131
                <z-m> -0.028 </z-m>
132
            </offsets>
133
        </model>
134
        <model>
135
            <path>Aircraft/Instruments-3d/zkv1000/mfd.xml</path>
136
            <offsets>
137
                <x-m>  0.03  </x-m>
138
                <y-m>  0.06  </y-m>
139
                <z-m> -0.028 </z-m>
140
                <heading-deg> -15 </heading-deg>
141
            </offsets>
142
        </model>
143

            
144
## Switch it up
145
You can use the multikey (souvenirs, thanks to Melchior having that much expended this feature years ago :)) service by typing:
146
`:zo`
147

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

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

            
154
# Documentation
update README before merging
Sébastien MARQUE authored on 2017-03-20
155
* [Canvas in FG](http://wiki.flightgear.org/Category:Canvas)
mise à jour du README
Sébastien MARQUE authored on 2017-03-07
156
* [Nasal](http://wiki.flightgear.org/Category:Nasal)
update README before merging
Sébastien MARQUE authored on 2017-03-20
157
* 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
158
    * [G1000 Pilot’s Guide for the Diamond DA42 (v0370.22)](http://static.garmin.com/pumac/190-00406-07_0B_Web.pdf) *(94 pages)*
159
    * [Pilot's Guide, Cirrus Perspective, SR2x (v0764.30)](http://static.garmin.com/pumac/190-00820-11_A.pdf) *(752 pages)*