zkv1000 / README.md /
Newer Older
190 lines | 11.12kb
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
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
XPDR settings via knob or so...
Sébastien MARQUE authored on 2017-03-22
63
  * XPDR from SoftKeys and knob, with respect of delays from the manual
adds BARO settings
Sébastien MARQUE authored on 2017-03-20
64
  * Selected altitude bug (widget off if IA within 100ft)
65
  * baro settings
add some information in READ...
Sébastien MARQUE authored on 2017-03-28
66
  * SoftKeys menus navigation for PFD and MFD: not yet implemented function are logged in console ![][done], softkeys colorized when active ![][done], alerts with white backgroud and black text available ![][done]
makes the CDI available
Sébastien MARQUE authored on 2017-03-23
67
  * CDI
adds OMI to PFD
Sébastien MARQUE authored on 2017-03-23
68
  * OMI
adds slipskid animation
Sébastien MARQUE authored on 2017-03-24
69
  * Slipskid animation
new var organistaion (and fi...
Sébastien MARQUE authored on 2017-03-26
70
  * Radio stack, including ID for NAV
update progress in README
Sébastien MARQUE authored on 2017-04-02
71
  * windows management: selectable items ![][done], modifiable items ![][done], scrolling ![][done]
add V-speeds bugs
Sébastien MARQUE authored on 2017-04-04
72
  * display of V-speeds in ruler: Vx, Vy, Vr and Vglide (specific for aircraft, see installation instruction)
add Vne Vspeed specific to a...
Sébastien MARQUE authored on 2017-04-04
73
  * some aircraft specific data to retrieve from aircraft XML files (VNE, etc)
README updated
Sébastien MARQUE authored on 2017-04-09
74
  * possibility to add a copilot's PFD, and other displays
75
  * EIS: separation for aircraft specifics (selected by the zkv1000 config)
update README before merging
Sébastien MARQUE authored on 2017-03-20
76
* ![][90%]
TMR/REF available
Sébastien MARQUE authored on 2017-04-10
77
  * TMR/REF Timer ![][done], Vspeeds ![][done], minimums ![][pending] (don't understand the role of this)
update README before merging
Sébastien MARQUE authored on 2017-03-20
78
  * Bearing needs some checks to be sure it shows the correct information
79
  * XPDR: emergency code depending of the country (eg.: 1200 for US, 7700 for Europe), should be set in settings
80
* ![][80%]
README updated
Sébastien MARQUE authored on 2017-04-09
81
  * single-prop EIS: texts displayed ![][done], animations for fuel ![][ongoing]
update README before merging
Sébastien MARQUE authored on 2017-03-20
82
* ![][70%]
improve README
Sébastien MARQUE authored on 2017-03-20
83
  * make booting animation visible ![][pending]
update README before merging
Sébastien MARQUE authored on 2017-03-20
84
* ![][60%]
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
89
* ![][30%]
90
* ![][20%]
91
* ![][10%]
92
  * multikey for every part of the device (actually only power on)
93
* ![][0%] (TODO list, unsorted)
makes the CDI available
Sébastien MARQUE authored on 2017-03-23
94
  * CDI/GPS: scale depending of the flight phase
README updated
Sébastien MARQUE authored on 2017-04-09
95
  * recenter the MFD depending of EIS width
update README before merging
Sébastien MARQUE authored on 2017-03-20
96
  * angle of attack display
97
  * Alerts
98
  * Flight planning (MFD)
99
  * Setting pages (MFD)
100
  * Inset Map (PFD)
101
  * PFD settings
102
  * texture for some MFD buttons
103
  * rotation and zooming of online maps in-flight ![][pending]
adds BARO settings
Sébastien MARQUE authored on 2017-03-20
104
  * VS guidance
105
  * VNAV
TMR/REF available
Sébastien MARQUE authored on 2017-04-10
106
  * scrolling lift in menus
update README before merging
Sébastien MARQUE authored on 2017-03-20
107
  * tutorials
108
  * many more...
commit initial
Sébastien MARQUE authored on 2017-03-07
109

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

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

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

            
add V-speeds bugs
Sébastien MARQUE authored on 2017-04-04
121
## Set specific values for your aircraft
122
Specifics values for aircraft can be set via the aircraft configuration, in the `<instrumentation>` section, just add a section `<zkv1000>` and set here the needed values.
123

            
124
### Vspeeds
add Vne Vspeed specific to a...
Sébastien MARQUE authored on 2017-04-04
125
To see the Vspeeds bugs or the IAS background color change (Vne), set the corresponding V-speeds in knots by adding in your `<instrumentation><zkv1000>` section the following lines (here are the numbers for the Lancair-235, ![](https://upload.wikimedia.org/wikipedia/commons/thumb/1/12/Achtung-orange.svg/32px-Achtung-orange.svg.png) values are not to be used in real life).
add V-speeds bugs
Sébastien MARQUE authored on 2017-04-04
126
If not set, defaults to 999 knots
127

            
128
        <alerts>
129
          <Vx>99</Vx>
130
          <Vy>110</Vy>
131
          <Vr>65</Vr>
132
          <Vglide>80</Vglide>
add Vne Vspeed specific to a...
Sébastien MARQUE authored on 2017-04-04
133
          <Vne>170</Vne>
add V-speeds bugs
Sébastien MARQUE authored on 2017-04-04
134
        </alerts>
135

            
EIS can be aircraft specific
Sébastien MARQUE authored on 2017-04-04
136
### EIS
137
To tells the zkv1000 which kind of engines equip your aircraft, and the associated EIS
138

            
139
        <eis>
README updated
Sébastien MARQUE authored on 2017-04-09
140
          <type>single-prop</type>
EIS can be aircraft specific
Sébastien MARQUE authored on 2017-04-04
141
        </eis>
142

            
143
Defaults to `none`, available entries are the `.nas` files located in `Nasal/EIS/` directory.
fix bad URL
Sébastien MARQUE authored on 2017-04-04
144
If you want to add yours, just copy the `Systems/EIS/single-engine.svg`, modify it to fit your needs, and refer to it in a function named `displayClass.showEIS`, another very important function is `displayClass.updateEIS` (example in [zkv1000/Nasal/EIS/single-engine.nas](Nasal/EIS/single-engine.nas))
EIS can be aircraft specific
Sébastien MARQUE authored on 2017-04-04
145

            
improve README
Sébastien MARQUE authored on 2017-03-20
146
## 3D models
147
In the definition of your flightdeck (here are the values for the installation in the Lancair 235 in which I develop the device)
148
put it everywhere you want to
149

            
150
        <model>
adds the avaibility to have ...
Sébastien MARQUE authored on 2017-04-07
151
            <path>Aircraft/Instruments-3d/zkv1000/pfd-pilot.xml</path>
improve README
Sébastien MARQUE authored on 2017-03-20
152
            <offsets>
153
                <x-m> -0.023 </x-m>
154
                <y-m> -0.235 </y-m>
155
                <z-m> -0.028 </z-m>
156
            </offsets>
157
        </model>
158
        <model>
159
            <path>Aircraft/Instruments-3d/zkv1000/mfd.xml</path>
160
            <offsets>
161
                <x-m>  0.03  </x-m>
162
                <y-m>  0.06  </y-m>
163
                <z-m> -0.028 </z-m>
164
                <heading-deg> -15 </heading-deg>
165
            </offsets>
166
        </model>
167

            
adds the avaibility to have ...
Sébastien MARQUE authored on 2017-04-07
168
You can put as many devices as wanted, but generally they are two (PFD+MFD) or three (2 PFD+ 1 PFD), can be only one which is useful when you just want the PFD or the MFD in your cockpit.
169
The device are identified by a name, which should be unique unless they won't be independant.
170
This name is set by one of the property in the XML model file (`instrumentation/zkv1000/<NAME>/status`), which is a property telling if the device is switched off or not (or in reversionnary mode, later).
171
Actually there are only two "types of display": MFD or PFD, which is known by the first 3 letters of the name (case sensitive!)
172
Other devices as keyboard or non-display can also exists, as long as they don't have a `status` property...
173
Not sur I'm clear on this point though :)
add some information in READ...
Sébastien MARQUE authored on 2017-03-28
174

            
improve README
Sébastien MARQUE authored on 2017-03-20
175
## Switch it up
176
You can use the multikey (souvenirs, thanks to Melchior having that much expended this feature years ago :)) service by typing:
177
`:zo`
178

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

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

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