zkv1000 / README.md /
Newer Older
371 lines | 22.158kb
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"
uses named icon for warning
Sébastien MARQUE authored on 2017-04-20
20
[warning]:    https://upload.wikimedia.org/wikipedia/commons/thumb/1/12/Achtung-orange.svg/32px-Achtung-orange.svg.png "warning symbol"
commit initial
Sébastien MARQUE authored on 2017-03-07
21

            
refresh project webpage
Sébastien MARQUE authored on 2020-05-11
22
![ZKV1000 in Diamond DA42, in flight from LFLG to LFBD](https://seb.lautre.net/bozon/index.php?f=15eb94e0c0e1d1)ZKV1000 in Diamond DA42, in flight from LFLG to LFBD, running STEC55X autopilot HDG roll mode.
fix URL
Sébastien MARQUE authored on 2018-11-21
23
[other pictures available here](https://seb.lautre.net/bozon/index.php?f=158cf95340742d)
update README before merging
Sébastien MARQUE authored on 2017-03-20
24

            
25
# Thanks
found the author of Farmin/G...
Sébastien MARQUE authored on 2017-04-21
26
Thanks to [www2](https://forum.flightgear.org/viewtopic.php?f=14&t=25291) the modeller of the [GDU104X project "Farmin/G1000"](http://wiki.flightgear.org/Project_Farmin/FG1000) 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.  
update README before merging
Sébastien MARQUE authored on 2017-03-20
27
Thanks to Hooray's nice efforts, and some examples ans snipsets of code here and there from the Canvas team.  
adds route display on map
Sébastien MARQUE authored on 2017-05-11
28
Thanks to all FlightGear community for the funny project I let too many years off side... Especially to authors of Avidyne Entegra 9 on extra500, from which the map is largely inspired (and many lines of code copied and adapted): Dirk Dittmann and Eric van den Berg 
update README before merging
Sébastien MARQUE authored on 2017-03-20
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 :)
new email address (2)
Sébastien MARQUE authored on 2017-12-21
52
Please report bug at <zkv1000@seb.lautre.net>.
update README before merging
Sébastien MARQUE authored on 2017-03-20
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 README
Sébastien MARQUE authored on 2017-05-02
71
  * windows management: selectable items, modifiable items, scrolling
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)
PFD INSET map available
Sébastien MARQUE authored on 2017-04-19
76
  * Inset Map (PFD)
update README
Sébastien MARQUE authored on 2017-05-02
77
  * single-prop EIS: texts displayed, animations for fuel
78
  * ND and map display: synchronized tiles and navaids, range change, map heads up
79
  * rotation and zooming of online maps in-flight
add TCAS
Sébastien MARQUE authored on 2017-12-21
80
  * simple Traffic Alert Collision Avoidance System (TCAS)
includes last updates
Sébastien MARQUE authored on 2020-04-30
81
  * screen brightness and body lighting settings
82
  * checklists management (emergency and normal)
refresh project webpage
Sébastien MARQUE authored on 2020-05-11
83
  * possibility to fit the size of the devices to enter the panel
84
  * auto power on if set
refresh README
Sébastien MARQUE authored on 2020-05-17
85
  * AFCS capabilities
86
  * integration of [GFC700 from the official Stuart Buchanan's FG1000](http://wiki.flightgear.org/FG1000#GFC700_Autopilot)
update README before merging
Sébastien MARQUE authored on 2017-03-20
87
* ![][90%]
TMR/REF available
Sébastien MARQUE authored on 2017-04-10
88
  * TMR/REF Timer ![][done], Vspeeds ![][done], minimums ![][pending] (don't understand the role of this)
adds GPS OBS mode
Sébastien MARQUE authored on 2020-05-30
89
  * route displayed on map: legs ![][done], current and next leg ![][done], OBS ![][done], TOC/TOD ![][ongoing]
adds AOA display
Sébastien MARQUE authored on 2017-04-15
90
  * angle of attack display (not sure about calculation): specific for each airplane (see Installation instructions below)
update README before merging
Sébastien MARQUE authored on 2017-03-20
91
  * Bearing needs some checks to be sure it shows the correct information
92
  * XPDR: emergency code depending of the country (eg.: 1200 for US, 7700 for Europe), should be set in settings
replace settimer by maketime...
Sébastien MARQUE authored on 2020-05-06
93
  * 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
update README before merging
Sébastien MARQUE authored on 2017-03-20
94
* ![][80%]
refresh project webpage
Sébastien MARQUE authored on 2020-05-11
95
  * Setting pages (MFD): pages/sub-pages selection via FMS knob ![][done], pages content implementation ![][ongoing]
adds flight plan catalog loa...
Sébastien MARQUE authored on 2020-06-08
96
  * Flight plans catalog (display on map doesn't work each time...)
update README before merging
Sébastien MARQUE authored on 2017-03-20
97
* ![][70%]
98
* ![][60%]
configurable display size, v...
Sébastien MARQUE authored on 2017-04-15
99
  * NOT TESTED: add the posssibility to only use Nasal part of the instrument. This in case of a cockpit which already includes needed objects and animations for screens, knobs and buttons in its config files
update README
Sébastien MARQUE authored on 2017-05-02
100
  * Map settings: declutter ![][ongoing], range/zoom ![][done]
update README before merging
Sébastien MARQUE authored on 2017-03-20
101
* ![][50%]
refresh README
Sébastien MARQUE authored on 2020-05-17
102
  * integration of Octal450's [S-TEC 55X](http://wiki.flightgear.org/S-TEC_55X) autopilot system ![][ongoing]
103
  * EIS: animations for temperature for YaSim and JSBSim with provided default single-prop EIS
104
  * make the switch back on working for MFD display and radios ![][ongoing]
update README before merging
Sébastien MARQUE authored on 2017-03-20
105
* ![][40%]
106
* ![][30%]
107
* ![][20%]
108
* ![][10%]
109
  * multikey for every part of the device (actually only power on)
refresh project webpage
Sébastien MARQUE authored on 2020-05-11
110
  * power off
massive code reorganisation ...
Sébastien MARQUE authored on 2017-05-01
111
  * Aircraft Maintainer's Guide
update README before merging
Sébastien MARQUE authored on 2017-03-20
112
* ![][0%] (TODO list, unsorted)
refresh project webpage
Sébastien MARQUE authored on 2020-05-11
113
  * make possible to integrate other autopilot systems than the one integrated
update README
Sébastien MARQUE authored on 2017-05-02
114
  * make booting animation visible
115
  * make possible to include in the aircraft directory (instead of Instruments-3d)
116
  * separation of code for buttons and knobs scenarii and computing
makes the CDI available
Sébastien MARQUE authored on 2017-03-23
117
  * CDI/GPS: scale depending of the flight phase
update README before merging
Sébastien MARQUE authored on 2017-03-20
118
  * Alerts
PFD INSET map available
Sébastien MARQUE authored on 2017-04-19
119
  * TOPO map
120
  * Weather map
update README before merging
Sébastien MARQUE authored on 2017-03-20
121
  * Flight planning (MFD)
122
  * PFD settings
navaids displayed with corre...
Sébastien MARQUE authored on 2017-04-18
123
  * replace the use of `clip` by a better system in map display (think also about INSET)
adds BARO settings
Sébastien MARQUE authored on 2017-03-20
124
  * VS guidance
125
  * VNAV
TMR/REF available
Sébastien MARQUE authored on 2017-04-10
126
  * scrolling lift in menus
update README before merging
Sébastien MARQUE authored on 2017-03-20
127
  * tutorials
massive code reorganisation ...
Sébastien MARQUE authored on 2017-05-01
128
  * User's Guide
adds AOA display
Sébastien MARQUE authored on 2017-04-15
129
  * make any Vspeed available (not only Vx, Vy, Vr and Vglide), depending of their presence in aircraft config
updates README
Sébastien MARQUE authored on 2017-12-30
130
  * [touchable screen](http://wiki.flightgear.org/Canvas_Event_Handling) ([other interesting link](http://wiki.flightgear.org/Touch_Animation))
update README before merging
Sébastien MARQUE authored on 2017-03-20
131
  * many more...
commit initial
Sébastien MARQUE authored on 2017-03-07
132

            
improve README
Sébastien MARQUE authored on 2017-03-20
133
# Installation
fix URL
Sébastien MARQUE authored on 2018-11-21
134
Just `git clone https://seb.lautre.net/git/seb/zkv1000.git` in your favorite `Instrumentation-3d` dir or directly in your aircraft files structure.  
allows zkv1000 to be install...
Sébastien MARQUE authored on 2017-05-11
135
Please note that the `Instruments-3d` dir is recommended as the zkv1000 wants to integrate the official `$FGDATA/Aircraft/Instruments-3d` some days  
improves README
Sébastien MARQUE authored on 2017-04-19
136
Then somewhere in the XML configuration of your aircraft, put only few lines as described below
improve README
Sébastien MARQUE authored on 2017-03-20
137
## Create the `zkv1000` Nasal namespace
allows zkv1000 to be install...
Sébastien MARQUE authored on 2017-05-11
138
In the `<nasal>` place of your aircraft configuration, tell FlightGear where to find the `zkv1000.nas` file
improve README
Sébastien MARQUE authored on 2017-03-20
139

            
140
        <zkv1000>
141
            <file>Aircraft/Instruments-3d/zkv1000/zkv1000.nas</file>
142
        </zkv1000>
143

            
allows zkv1000 to be install...
Sébastien MARQUE authored on 2017-05-11
144
or
145

            
146
        <zkv1000>
147
            <file>Aircraft/My-Nice-Aircraft/arbitrary/dirs/zkv1000-or-not/zkv1000.nas</file>
148
        </zkv1000>
149

            
150
Actually `zkv1000.nas` is where everything begins, please have a look at this code, it would help you to follow the script.
improve README
Sébastien MARQUE authored on 2017-03-20
151

            
add V-speeds bugs
Sébastien MARQUE authored on 2017-04-04
152
## Set specific values for your aircraft
153
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.
154

            
refresh project webpage
Sébastien MARQUE authored on 2020-05-11
155
### Adjust size to  the panel of your aircraft
156
To increase or decrease the size of all the devices (PFDs and MFDs) you can use a factor property, eg. in the DA42:
157

            
158
        <size-factor type="double">1.19</size-factor>
159

            
160
Defaults to 1 if you don't provide this information. Values lower than 1 decreaase size, and higher than 1 increase the size.
161

            
162
### Make your instrument auto powered on
163
Let say you want your PFD and MFD switched on as soon as the electrical system allows it. Set your device with the following
164

            
165
        <auto-power type="bool">1</auto-power>
166

            
167
Then you need to set the property `/instrumentation/zkv1000/serviceable` by the mean you want, as soon as it property is `true` the zkv1000 will automagically switch on.
168

            
add V-speeds bugs
Sébastien MARQUE authored on 2017-04-04
169
### Vspeeds
uses named icon for warning
Sébastien MARQUE authored on 2017-04-20
170
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, ![][warning] values are not to be used in real life).
add V-speeds bugs
Sébastien MARQUE authored on 2017-04-04
171
If not set, defaults to 999 knots
172

            
173
        <alerts>
174
          <Vx>99</Vx>
175
          <Vy>110</Vy>
176
          <Vr>65</Vr>
177
          <Vglide>80</Vglide>
add Vne Vspeed specific to a...
Sébastien MARQUE authored on 2017-04-04
178
          <Vne>170</Vne>
add V-speeds bugs
Sébastien MARQUE authored on 2017-04-04
179
        </alerts>
180

            
EIS can be aircraft specific
Sébastien MARQUE authored on 2017-04-04
181
### EIS
EIS now really specific to a...
Sébastien MARQUE authored on 2017-04-20
182
This parameter tells the zkv1000 which kind of engines equips your aircraft, and the associated EIS.  
183
The Nasal script should include at least three things:
184

            
185
* a method called `displayClass.showEIS` in which you initialize the EIS, especially by selecting the shown, hide, clipped and texts elements
186
* a method called `displayClass.updateEIS` which is used to update the EIS display, it includes its own timer to refresh itself
187
* a SVG object with ID `EIS` (generally the background of the EIS display).  
188
  It should appears in the lists in `displayClass.showEIS`.  
189
  ![][warning] This object is used to compute the map width, so it is important to set it on the left of the screen
190

            
191
There are three ways too put an EIS in MFD:
192

            
193
#### use one of the included simple EIS provided with the zkv1000
EIS can be aircraft specific
Sébastien MARQUE authored on 2017-04-04
194

            
195
        <eis>
README updated
Sébastien MARQUE authored on 2017-04-09
196
          <type>single-prop</type>
EIS can be aircraft specific
Sébastien MARQUE authored on 2017-04-04
197
        </eis>
198

            
EIS now really specific to a...
Sébastien MARQUE authored on 2017-04-20
199
Defaults to `none`, available entries are the `.nas` files located in `Nasal/EIS/` directory.
200

            
201
#### or use the one you specially have created for your aircraft
202

            
203
        <eis>
204
          <file>Aircraft/My-Nice-Aircraft/Nasal/EIS.nas</file>
205
        </eis>
206

            
update README
Sébastien MARQUE authored on 2017-05-02
207
or the one from another aircraft. Anyway if the EIS nasal file targeted doesn't exist, the fallback is the type `none`.
EIS now really specific to a...
Sébastien MARQUE authored on 2017-04-20
208

            
allows zkv1000 to be install...
Sébastien MARQUE authored on 2017-05-11
209
#### or you can give the absolute path (![][warning] not supported)
EIS now really specific to a...
Sébastien MARQUE authored on 2017-04-20
210

            
211
        </eis>
212
          <file>/home/foobar/fgfs-data/Nasal/testing-jet-jsbsim-EIS.nas</file>
213
        </eis>
214

            
215
Be aware that `canvas.parsesvg` uses only relative path and should not work properly if your .nas is outside of the FG tree.  
relocate SVG files in Models...
Sébastien MARQUE authored on 2017-12-31
216
If you want to add your own EIS, just copy the `Models/EIS/single-prop.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 [Nasal/EIS/single-prop.nas](zkv1000/blob/master/Nasal/EIS/single-prop.nas))  
EIS now really specific to a...
Sébastien MARQUE authored on 2017-04-20
217
You are even free to modify the softkeys map in order to get according menus, but this has to be described on another document (check [Nasal/softkeys.nas](zkv1000/master/blob/Nasal/softkeys.nas)).
218

            
219
No matter of the EIS width, as the map size and center are computed relative to the EIS width automatically.  
220

            
221
_Notes:_
improves README
Sébastien MARQUE authored on 2017-04-19
222

            
EIS now really specific to a...
Sébastien MARQUE authored on 2017-04-20
223
  1. you can use `<file>` or `<type>` indifferently, they are actually identical.
224
  1. later on the MFD Engine pages will be managed by the file specified in this section
EIS can be aircraft specific
Sébastien MARQUE authored on 2017-04-04
225

            
adds AOA display
Sébastien MARQUE authored on 2017-04-15
226
### Angle Of Attack (AOA)
227
You can specify the stall AoA in order to display it in the dedicated display.
228

            
229
        <alerts>
230
          <stall-aoa>15</stall-aoa>
nicer AOA display
Sébastien MARQUE authored on 2017-04-16
231
          <approach-aoa>4</approach-aoa>
adds AOA display
Sébastien MARQUE authored on 2017-04-15
232
        </alerts>
233

            
improves README
Sébastien MARQUE authored on 2017-04-19
234
* Values are in degrees.
235
* If `<stall-aoa>` is not specified or equals to `0` (zero) the AOA display won't be accessible.
236
* The `<approach-aoa>` is optionnal, if present a blue marker is visible on AOA display (not in real GarminP1000)
adds AOA display
Sébastien MARQUE authored on 2017-04-15
237

            
adds flight plan catalog loa...
Sébastien MARQUE authored on 2020-06-08
238
### Flight plans catalog
239
You can specify a directory where to find the flightplans you save. Defaults to `$FG_HOME/Export`
240

            
241
        <flightplans type="string">/absolute/path/to/your/flightplans/location</flightplans>
242

            
243
Only the flightplans set for a departure from your position will be shown, no matter of the name of the file (even extension), each will be parsed to find the ones corresponding to your departure location.
244
The list will show only 6 flightplans, but it's scrollable so you can handle much more.
245

            
improve README
Sébastien MARQUE authored on 2017-03-20
246
## 3D models
247
In the definition of your flightdeck (here are the values for the installation in the Lancair 235 in which I develop the device)
allows zkv1000 to be install...
Sébastien MARQUE authored on 2017-05-11
248
put it everywhere you want to. Note that the path `Aircraft/Instruments-3d/zkv1000` is dependant on the path where the zkv1000 is installed, this can be somewhere like `Aircraft/My-Nice-Aircraft/arbitrary/dirs/zkv1000-or-not`as mentionned earlier in this section.
improve README
Sébastien MARQUE authored on 2017-03-20
249

            
250
        <model>
adds the avaibility to have ...
Sébastien MARQUE authored on 2017-04-07
251
            <path>Aircraft/Instruments-3d/zkv1000/pfd-pilot.xml</path>
improve README
Sébastien MARQUE authored on 2017-03-20
252
            <offsets>
253
                <x-m> -0.023 </x-m>
254
                <y-m> -0.235 </y-m>
255
                <z-m> -0.028 </z-m>
256
            </offsets>
257
        </model>
258
        <model>
259
            <path>Aircraft/Instruments-3d/zkv1000/mfd.xml</path>
260
            <offsets>
261
                <x-m>  0.03  </x-m>
262
                <y-m>  0.06  </y-m>
263
                <z-m> -0.028 </z-m>
264
                <heading-deg> -15 </heading-deg>
265
            </offsets>
266
        </model>
267

            
adds the avaibility to have ...
Sébastien MARQUE authored on 2017-04-07
268
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.
269
The device are identified by a name, which should be unique unless they won't be independant.
270
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).
271
Actually there are only two "types of display": MFD or PFD, which is known by the first 3 letters of the name (case sensitive!)
272
Other devices as keyboard or non-display can also exists, as long as they don't have a `status` property...
273
Not sur I'm clear on this point though :)
add some information in READ...
Sébastien MARQUE authored on 2017-03-28
274

            
add TCAS
Sébastien MARQUE authored on 2017-12-21
275
## TCAS
276
To enable TCAS you need to make it serviceable in your aircraft before the ZKV1000 being powered on, so the best is to set it in the aircraft configuration files.
277
Actually it checks if the property `/instrumentation/tcas/serviceable` is set to boolean true value.
278

            
279
        <tcas>
280
          <name>tcas</name>
281
          <number>0</number>
282
          <serviceable type='bool'>true</serviceable>
283
          <inputs>
284
            <mode type="int">5</mode>
285
          </inputs>
286
        </tcas>
287

            
288
Moreover it only shows alerts with an annunciation "TRAFFIC" on PFD, and shows icons on maps (MFD and INSET), no decision is taken, no relation with transponder and no evasion scenari and no evasion scenario.
289

            
refresh project webpage
Sébastien MARQUE authored on 2020-05-11
290
## Autopilot
refresh README
Sébastien MARQUE authored on 2020-05-17
291
There are two systems supported: the GFC700 shipped with the official Stuart Buchanan's FG1000 and the Octal450's STEC 55X (and at time of writing only HDG and buggy NAV/GPS modes are available).
292

            
293
### GFC700
294
To make the magic operate, you just need to insert these lines into the `sim/systems` section. Be aware that this autopilot [has been tuned for the Cessna 182, so may not be correct for light jets](http://wiki.flightgear.org/FG1000#Include_the_GFC700_autopilot_.28optional.29).
295

            
296
        <autopilot>
297
          <path>Aircraft/Instruments-3d/FG1000/GFC700.xml</path>
298
        </autopilot>
refresh project webpage
Sébastien MARQUE authored on 2020-05-11
299

            
refresh README
Sébastien MARQUE authored on 2020-05-17
300
### S-TEC 55X
refresh project webpage
Sébastien MARQUE authored on 2020-05-11
301
To make it available you have to follow the installation rules of the device [on its own page](http://wiki.flightgear.org/S-TEC_55X). The zkv1000 will find it by its own and make it available.
302

            
303
This STEC55X autopilot system would remain shipped in the zkv1000 as it is described in the documentation of Cirrus Perspective SR2x, but the zkv1000 will in near future let you create your own and make its choice depending of the availibilities or property set.
304

            
improves README
Sébastien MARQUE authored on 2017-04-19
305
## Map tiles origin
306
By defaults the maps tiles come from `https://maps.wikimedia.org`, type `osm-intl` (please read [https://www.wikimedia.org/wiki/Maps]()), but you can choose your favorite one if you've got one. I've tested `opentopomap.org` and `thunderforest.com` (my favourite).
307
You can tell the zkv1000 the tile server, type and eventually apikey by using `--prop:` option while starting FlightGear session:
308

            
309
In case of apikey (or whatever added at the en of the URL):
310

            
311
        --prop:/sim/online-tiles-server=tile.thunderforest.com
312
        --prop:/sim/online-tiles-type=landscape
313
        --prop:/sim/online-tiles-apikey=?apikey=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
314

            
315
or if there is no type, just use type `/`:
316

            
317
        --prop:/sim/online-tiles-server=a.tile.opentopomap.org
318
        --prop:/sim/online-tiles-type=/
319

            
add options for online tiles
Sébastien MARQUE authored on 2017-05-14
320
The only used protocol is `https` but you can provide your own template with option
321

            
322
        --prop:/sim/online-tiles-template=http://{server}/{type}/{z}/{x}/{y}.jpeg
323

            
324
An option is also available to tell the format of the tile image which can be used in template with the `{format}` anchor
325

            
326
        --prop:/sim/online-tiles-format=jpeg
improves README
Sébastien MARQUE authored on 2017-04-19
327

            
improve README
Sébastien MARQUE authored on 2017-03-20
328
## Switch it up
refresh README
Sébastien MARQUE authored on 2020-05-17
329
### Autopower on/off
330
You can set an electrical system to make the property `/instrumentation/zkv1000/serviceable` reflect the alimentation of the ZKV1000 (boolean or volts > 12). Then configure the zkv1000 to auto power on as soon as it is known as serviceable withe the following
331

            
332
        <instrumentation>
333
          <zkv1000>
334
            <auto-power type="bool">1</auto-power>
335
          <zkv1000>
336
        </instrumentation>
337

            
338
Note that will also switch off the zkv1000 if it becomes non-serviceable.
339

            
340
The re-switching on is buggy (the MFD doesn't re-display the contents and the NAV/COMM utils aren't available anymore... working on it)
341
### Manually
342
If you haven't set a electrical system to make the property `/instrumentation/zkv1000/serviceable` to reflect the availibity of the ZKV1000, and you haven't set the auto-power, then you can use the multikey (souvenirs, thanks to Melchior having that much expended this feature years ago :)) service by typing:
improve README
Sébastien MARQUE authored on 2017-03-20
343
`:zo`
344

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

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

            
update README
Sébastien MARQUE authored on 2017-05-02
351
# Known issues
new email address (2)
Sébastien MARQUE authored on 2017-12-21
352
Please send issues to <zkv1000@seb.lautre.net>  
fix URL
Sébastien MARQUE authored on 2018-11-21
353
[issues are listed here](https://seb.lautre.net/git/seb/zkv1000/issues)
update README
Sébastien MARQUE authored on 2017-05-02
354

            
improve README
Sébastien MARQUE authored on 2017-03-20
355
# Documentation
updates README
Sébastien MARQUE authored on 2017-12-30
356
Documentation is being actively written. There are two differents guides:
update README
Sébastien MARQUE authored on 2017-05-02
357

            
updates README
Sébastien MARQUE authored on 2017-12-30
358
* [Aircraft Maintainer's Guide](http://wiki.flightgear.org/User:Zakharov/zkv1000_installation_guide)
359
* [User's Guide](http://wiki.flightgear.org/User:Zakharov/zkv1000_user_guide)
update README
Sébastien MARQUE authored on 2017-05-02
360

            
361
Here is a list of useful links:
362

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

            
369
# FG1000
370
There is an implementation of the Primus Garmin 1000 by Stuart Buchanan which is much more respectful of the Canvas principles, using new technology Emesary, with far better coding style, and with the intent to stay close as possible with the Garmin 1000 real device.  
371
The device is avaiblable in [FGData repo](https://sourceforge.net/p/flightgear/fgdata/ci/next/tree/Aircraft/Instruments-3d/FG1000) and has a [specific wiki page](http://wiki.flightgear.org/FG1000).