FlightGear wiki - User contributions [en]

User:Zakharov/zkv1000 installation guide

2025-08-07T20:39:15Z

Zakharov: new domainname

[[Image:Routemanagerready.png|link=Route Manager]]
[[Image:Rembrandtready.png|link=Rembrandt]]
[[Image:Canvasready.png|link=Canvas]]
[[Image:Nasallogo3.png|link=Nasal]]



== Get the sources ==
the whole zkv1000 can be retrieved from <tt>https://seb.lautre.netlib.re/git/seb/zkv1000</tt>. You will have the choice with different ways (git, zip or tar.gz).

You have the choice of the destination of the source (in order of recommandation)
# in <tt>$FGHOME/Aircraft/Instruments-3d</tt>
# in your aircraft directory
# in <tt>$FGDATA/Aircraft/Instruments-3d</tt>

We'll refer to the zkv1000 installation directory as <tt>$ZKV1000</tt> later in this document

== Installation in the cockpit ==
The glass cockpit and the material around are included in the sources, but you can provide yours. Please see the advanced installation below.

The zkv1000 provides files in order to let you choose if you want a PFD, a MFP, both of them, or two PFDs and one PFD.

So the installation depends on what you want. Place in your cockpit the following files in the XML definition files of your aircraft
{| class="wikitable"
|-
! Configuration !! Files needed
|-
| PFD only || <tt>$ZKV1000/pfd-pilot.xml</tt>
|-
| MFD only || <tt>$ZKV1000/mfd.xml</tt>
|-
| 1 PFD + 1 MFD || <tt>$ZKV1000/pfd-pilot.xml</tt> + <tt>$ZKV1000/mfd.xml</tt>
|-
| 2 PFD + 1 MFD || <tt>$ZKV1000/pfd-pilot.xml</tt> + <tt>$ZKV1000/pfd-copilot.xml</tt> + <tt>$ZKV1000/mfd.xml</tt>
|}

Here's an example from the Lancair 235, configuration with a PFD in front of the pilot's seat and a MFD between the pilot's seat and the copilot's seat, a bit inclinated in direction of the pilot. These lines take place in the dedicated file about the cockpit definition.
<syntaxhighlight lang="xml">
<model>
<path>Aircraft/Instruments-3d/zkv1000/pfd-pilot.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>
</syntaxhighlight>
== make it work ==
Once your device is installed in your cockpit you may tell FligthGear where to find the underlying Nasal code. This is done in the <nasal> section of your aircraft definition. Obviously this is one of the manadatory step and value, the Nasal namespace '''must''' be zkv1000.
<syntaxhighlight lang="xml">
<zkv1000>
<file>Aircraft/Instruments-3d/zkv1000/zkv1000.nas</file>
</zkv1000>
</syntaxhighlight>

You have other options you can pass to the device in the <instrumentation> section of your aircraft definition
<syntaxhighlight lang="xml">
<instrumentation>
...
<zkv1000>
<alerts>
<Vx>15</Vx>
<Vy>110</Vy>
<Vr>65</Vr>
<Vglide>80</Vglide>
<stall-aoa>12</stall-aoa>
<approach-aoa>4</approach-aoa>
</alerts>
<eis>
<type>single-prop</type>
</eis>
</zkv1000>
...
</instrumentation>
</syntaxhighlight>

The available options are
{| class="wikitable"
|-
! Category !! Option !! Meaning !! Values
|-
| rowspan="4" | <tt>alerts</tt> || <tt>V''speed''</tt> || default [https://en.wikipedia.org/wiki/V_speeds V-speed] speed, displayed with a mark in the PFD's speed tape identified by the text after the uppercase V (Vfoobar, Vx, Vglide, etc.), no default value || a number in '''knots''', it can be modified by user using zkv1000 UI '''except for <tt>Vne</tt>''', no default value
|-
| <tt>stall-aoa</tt> || The stalling angle of attack, if defined it is displayed in AOA widget || rowspan="2" | a number in degrees
|-
| <tt>approach-aoa</tt> || The expected angle of attack at approach phase, if defined it is displayed in AOA widget
|-
| <tt>warnings</tt> || colspan="2" | Set of as simple as possible Nasal scripts to use the internal alerts system, internally the message identifies the alert so be careful not to use the same message for two different warnings.

Indexing the warning space can be useful if some property has to be modified like message or level, letting you use only one definition of a kind of alert with multiple levels and messages.

There are 3 alerts levels: <tt>0</tt> (information), <tt>1</tt> (warning), and higher values (begins with <tt>2</tt>, decimal allowed) for really important alerts. The UI will sort the alerts in descendant order (highest level first).

Only the triggered alerts are shown (i.e return <tt>true</tt>)

An example may help a bit<syntaxhighlight lang="xml">
<warnings>
<warning n="0">
<script><![CDATA[
var severity = getprop('/environment/icing/icing-severity');
if (severity) {
setprop('/instrumentation/zkv1000/alerts/warnings/warning/level', severity);
setprop('/instrumentation/zkv1000/alerts/warnings/warning/message',
sprintf('%s ICING CONDITIONS', string.uc(getprop('/environment/icing/icing-severity-name'))));
}
return severity;
]]></script>
<level>0</level> 
<message>icing conditions</message> 
</warning>

<warning n="1">
<script><![CDATA[
getprop('/consumables/deice') / (getprop('/controls/deice/mode')+2) < 100;
]]></script>
<level>1</level>
<message>deice liquid low</message>
</warning>
...
</warnings>
</syntaxhighlight>
|-
| <tt>eis</tt> || <tt>type</tt> or <tt>file</tt> || the type of EIS on MFD only, defaults to none || "none" means... none, the other possible values are the nasal definitions of file as in <tt>$ZKV1000/Nasal/eis</tt> (without the .nas extension) or the relative path to your definition specific to your aircarft
|}
More options to come...

The zkv1000 Nasal code is loaded at the end of the FDM initialization. Knowing that if you want to automagically switch on the zkv1000 there is a function named <code>zkv1000.powerOn()</code>, otherwise there is a predefined multikey {{key press|:}}{{key press|z}}{{key press|o}} witch will call the <tt>powerOn()</tt> function.

This should work and you and your aircraft's users should enjoy the instrument :)
== Advanced installation ==
You may want to use your own 3D objects, this is not a problem.

Each component of the zkv1000 is created at the power on if a property exists : <code>/instruments/zkv1000/<NAME>/status</code> in wich <tt>NAME</tt> is a string with the pattern: <code>(MFD|PFD)[optional identifier]</code>

So there are 3 optional properties useful to create your own device (only <tt>screen-object</tt> is available for now)
{| class="wikitable"
|-
! Property !! Role
|-
| <code>/instruments/zkv1000/<NAME>/screen-object</code> || The name of the 3D object
|-
| <code>/instruments/zkv1000/<NAME>/screen-view</code> || N/A The size of the view in Canvas context (defaults to <tt>[1024, 768]</tt>)
|-
| <code>/instruments/zkv1000/<NAME>/screen-size</code> || N/A The value of the Canvas size (defaults to <tt>[1280, 1280]</tt>), this value should be a square and large enough to allow rotation of the view without a not included pixel
|}

In the <tt>zkv1000</tt> namespace API specific for one component will be available by the <tt>NAME</tt>:
<syntaxhighlight>zkv1000.flightdeck['PFD-example'].knobs.FmsInner(...)</syntaxhighlight>
=== API ===
==== softkeys ====
There are 12 softkeys, related to the twelve boxes along the bottom of the zkv1000 screen.
They are accesible via the Class <tt>softkeys</tt>

===== <tt>SoftKey(number, pressed)</tt> =====
arguments:
* number: the number of the softkey, from 0 on the left-side, to 11 at the most right
* pressed: if the button is being pressed (1) or released (0), actually only pressed status is usable

==== buttons ====
.buttons.FMS
.buttons.ENT
.buttons.CLR
.buttons.PROC
.buttons.FPL
.buttons.MENU
.buttons.DirectTo
.buttons.PAN
.buttons.AsSwitchCOM
.buttons.AsSwitchNAV
.buttons.ALT

==== knobs ====
===== .knobs.FmsOuter(direction) =====
takes one argument which is the direction of the turn: <tt>cmdarg().getNode('offset').getValue()</tt>
===== .knobs.knobs.FmsInner(direction) =====
takes one argument which is the direction of the turn: <tt>cmdarg().getNode('offset').getValue()</tt>
===== .knobs.display.updateNAV({set:1}) =====
set the value for standby frequency for the selected NAV radio
===== .knobs.display.updateNAV({refresh:1|2}) =====
===== .knobs.display.updateCOMM({set:1}) =====
set the value for standby frequency for the selected COMM radio
===== .knobs.display.updateCOMM({refresh:1|2}) =====
===== .knobs.display.updateHDG() =====
no argument, just refresh the HDG display when the knob is used
===== .knobs.display.updateCRS() =====
no argument, just refresh the CRS display when the knob is used
===== .knobs.display.updateALT() =====
no argument, just refresh the ALT display when the knob is used
===== .knobs.display.updateBARO() =====
no argument, just refresh the BARO display when the knob is used

[[Category:Zkv1000|Installation guide]]

User:Zakharov/zkv1000 user guide

2020-08-08T07:57:45Z

Zakharov:

== Introduction ==
The zkv1000 is an instrument which concentrates some other instruments in only one single and simple interface. It is largely inspired from the famous display parts of Garmin Primus 1000. Once said, the zkv1000 is definitively '''not''' an exact replica of the Garmin Primus 1000, and isn't intended to be one. Sorry about that. But by flying with zkv1000 you have the certitude that you're the nearest to the real zkv1000, it can't me more realistic :)

Depending of your aircraft you may have in your cockpit different configurations, and some unavailable entries. Even we are in a sim, so there is no limit in the way to get full instrumented glide plane it may be interesting to limit the use of certain functions depending of the aircraft. This has to checked with the aircraft maintainer, or if you feel free with the GPL licence you may modify the aircraft to get the desired functions to work (see installation guide) 
=== Overview ===
There is two device types: MFD and PFD. You may find in your aircraft a configuration with only one of those, one of each or one MFD and two PFD. But there may be other configurations if the aircraft maintainer has decided it.

==== PFD ====
[[File:Zkv1000-PFD-global.png|thumb|zkv1000 PFD overview]]
 
==== MFD ====
[[File:Zkv1000-MFD-global.png|thumb|zkv1000 MFD overview]]
 
=== Softkeys codes ===
[[File:Zkv1000-available_softkeys.png]] BrightWhite on Black : available menu entry. Grey on Black : not yet implemented entry or not available in this aircraft Black : no entry 
[[File:Zkv1000-active-softkey.png]] Black on White : activated entry 

=== UI code and usage ===
[[File:Zkv1000-available_menus.png]] 
Selected entry is in Black on LightBlue 
Available entry is LightBlue on Black
Unavailable entry is White on Black 
[[File:Zkv1000-selectable-items.png|selectable items]] entries with marks <code><</code> or <code>></code> or both are entries with limited number of choices. First choice doesn't show the <code><</code> char, last one doesn't show the <code>></code> char. All other show both <code><</code> and <code>></code> 
Navigate from an entry to the next or the previous by turning the large FMS knob, modify the value of the entry by turning the small FMS knob. 

== Primary Flight Display ==
You just jumped into your Aircraft, depending of the scenario for it you may need to switch up electric system or some button(s) to get the zkv1000 up. Please refer to the aircraft manual.
=== Airspeed indicator ===
The indicated airspeed tape is in knots or km/h, the unit is refered as speed init later in this documentation. You can modify the speed unit by the dedicated window.
The black pointer shows the current IAS. 
On the tape major ticks are displayed with 10 speed units interval, minor ticks at 5 speed units interval. The trend can show up to 1000 speed units. A pink trend vector shows the estimated speed in the next 6 seconds (in the limit of +/- 30 speed units). 
There may be some Vspeeds marks (pink, text in white) specific to the aircraft (cf installation guide). It is possible to modify these values of the Vspeeds references (value and display, except Vne) as described later in this document 
The black pointer will take a red color if IAS exceeds the defined Vne. 
The true airspeed is shown under the speed tape, and the ground speed, in the same unit than IAS 
 
=== Altitude indicator ===
The altitude tape is in feet or meters, the unit is refered as altitude unit later in this documentation. The altitude can show from -990 to 99990 altitude units. The black pointer shows the current indicated altitude (determined from the air pressure), 20 altitude units graduated. A trend vector indicates the readched altitude in the next 6 seconds in the limit of +/- 300 altitude units. 
The barometric setting is shwon just under the altitude tape. It is graduated in inHg or hPa, which is refered as pressure unit later in this documentation. The pressure unit can be modified to hPa or inHg quickly by using the softkey menu <code>PFD > UNITS</code> and press <code>INHG</code> or <code>HPA</code>
{{note|It won't be saved this way for another session. To save it see the zkv1000 settings part in this documentation}}
The setting to standard barometric value (29.92inHg or 1023hPa) can be automatically set by the menu <code>PFD > STD BARO</code>. The barometer setting is essential and can be done by turning the BARO knob in front of the device (left side, under the COMM knob). 
The selected altitude is indicated by a lightblue bug along the altitude tape. It is blocked at the upper or lower corner of the tape until the tape has in its range the selected altitude. While the selected altitude isn't in the +/- 300 altitude unit range a black box indicates the selected altitude above the altitude tape. This box disappears when the indicated altitude is +/- 100 altitude unit of selected altitude.

=== Vertical speed indicator===
The vertical speed indicator is on the right just near the altitude tape, and is graduated with major ticks every 1000 ft/min or m/min refered as vertical speed units later in this documentation. Minor ticks are displayed every 500 vertical speed units. 
A black pointer containing the vertical speed with 10 vertical speed units precision moves along the non-moving tape. If the vertical speed exceeds +/- 4500 vertical speed units the pointer is locked to the upper/lower of the non-moving tape, and the vertical speed is detailed inside the pointer.

=== Attitude indicator===
Pitch scale is graduated 10° up to 80°, with minor marks 5° interval up to 25°, and every 2.5° below 20° pitch. The horizon line is part of the pitch scale, and represents a pitch of 0°. 
The roll scale is the 120° arc. The inverted triangle represents 0° roll. Major ticks represent 30° and 60°, minor ticks represent 10°, 20° and 45°. 
The slip skid indicator is the bar beneath the roll pointer. The Slip Skid indicator moves laterally away from the pointer to indicate the lateral acceleration.

=== Horizontal situation indicator===
The HSI displays a rotating compass card in a heading-up orientation. Letters indicate the cardinal points and numeric labels occur every 30°. 
Major tick marks are at 10° intervals and minor tick marks at 5° intervals. 
A digital reading of the current heading appears on top of the HSI. 

==== Course Deviation Indicator ====
The HSI contains a Course Deviation Indicator (CDI) with course pointer, TO/FROM indication and a sliding deviation bar. 
GPS, VOR1 and LOC1 have single line arrow, while VOR2 have two lines arrow. 
GPS CDI is available only if a course has been set via the route manager, VOR and LOC show arrow when the active NAVAID is received.

==== Adjust heading ====
Turn the <code>HDG</code> knob to adjust the heading, doing so the heading bug will be positionned along the compass. 
A window showing the desired heading is shown for 3 seconds.
==== Adjust selected course ====
Select the corresponding GPS, NAV1 or NAV2 display by pressing the CDI softkey, then turn the <code>CRS</code> knob to adjust the desired course for VOR. Unless you aren't in OBS mode you cannot change the course for GPS. To do so, select GPS by pressing <code>CDI</code> softkey, then <code>OBS</code> softkey is displayed as available. To enter in OBS mode, press the <code>OBS</code> softkey, now you can adjust course by turning the <code>CRS</code> knob.

== Set your zkv1000 preferences ==
Press the <code>MENU</code> button, a window appears with settings. Navigate into the available settings by turning the outter FMS knob. The inner FMS knob changes the selected setting. To quit and save changes press <code>CLR</code>.
=== Brightness ===
You can adjust the luminosity of the whole device (PFD and MFD). Select the first entry <code>Brightness</code> and turn the inner FMS knob to increase or decrease brightness (from 0% to 100%). This setting isn't saved from a session to another.
=== Device lights ===
For a night flight you may need to change the device enlightment. With outter FMS knob, select the entry in front of <code>Light</code>. With the inner FMS knob select the device light level to fit your need from 0 (lights off) to 3 (lights very bright). This setting isn't saved from a session to another.
=== Units ===
Select the unit domain ou want to change with outter FMS knob, and select the unit with the inner knob. Once choosen, apply the change by pressing the <code>ENT</code> button. Quit the window with the button <code>CLR</code>, the settings will be saved for future session. The settings are only for that aircraft, so if you use another aircraft you have to set to fit your needs again. 
The unit will be used everywhere on the zkv1000, MFD and PFD, and all corresponding data will be displayed in the unit set here. 
Here is the list of available domains and their units, at the time of writting:
* Pressure: inHg or hPa
* Altitude: feet or meters
* Distance: NM (nautic miles) or km (kilometers)
* Speed: KT (knots) or km/h (kilometers per hour)
* Vert. Speed (for Vertical speed): ft/min or m/min
* Temperat. (for Temperature): F (Fahrenheit) or °C (degrees Celsius)
* Volume: L (liters), M3 (cube meter) or GAL (US gal)
<note>It is possible to quickly set the pressure setting from the <code>PFD > UNITS</code> softkeys sequence</note>
=== Time ===
The default displayed time is GMT. You may want to display time in UTC, LCL (local, dependant of your aircraft location), or RL (Real Life, the time of your computer). This setting isn't saved from a session to another.

== check and adapt Vspeeds references ==
You may check the Vspeed references for your aircraft (if any). Press <code>TMR/REF</code> softkey. A window is now displayed presenting a timer, eventually Vspeeds if they are set, and minimums settings (which isn't used at the time of writing). 
Turn the outter FMS knob to select successively the displayed Vspeed. 3 are shown but the list may be longer so continue until you reach the minimums settings. 
You can modify the Vspeed reference by turning the inner knob to adapt it at your situation (altitude, temperature, weight, etc.)

If the device is configured with stall angle of attack (see installation guide) then the softkeys menus <code>PFD > AOA/WIND > AOA ON</code> shows up a window just near the airspeed tape. This indicates the current normalized angle of attack, a LightBlue mark shows the best normalized angle of attack for approach. 
The softkey menu <code>PFD > AOA/WIND > AOA AUTO</code> make the AoA indicator showing up automagically if the gears are down and flaps out.

== Radios ==
=== NAV ===
NAV stack is on the left on each device. It is composed by
* 1 switch button
* 1 tuning knob
* 1 display with 4 frequencies

Frequencies are organized like this
<source>
standby NAV1 | active NAV1
standby NAV2 | active NAV2
</source>

The tuning is done on the selected NAV which is the one with the standby frequency in blue. The tuning step is 0.25 MHz (or 1.00 MHz with the use of {{Key press|shift}}) in the range 108.00 to 118.00 MHz

=== COMM ===
The COMM stack is on the right side on each device. It is composed by
* 1 switch button
* 1 tuning knob
* 1 display with 4 frequencies

The frequencies are displayed as follow:
<source>
active COMM1 | standby COMM1
active COMM2 | standby COMM2
</source>

The tuning frequency is the one in blue, the step is 0.025 MHz (0.500 Mhz using {{Key press|shift}}) from 118.025 to 123.975 MHz

== EIS ==

== Flight Management ==
=== Maps ===
The map content can be modified by using <code>INSET</code> softkey on PFD, and <code>MAP</code> softkey on MFD, then by activating or de-activating each layer. 

The map orientation and zoom can be modified by pressing the <code>MENU</code> button. 
[[File:Zkv1000-mapmenu.png|Map orientation and zoom configuration]] 
The zoom level shows a choice of distances, the distances are the range of the map from the bottom to the top of the MFD screen. They depend of the latitude of the aircraft.
Four orientations are available:
* <code>NORTH UP</code>: in this configuration the aircraft symbol rotates, the map is aligned with North up
* <code>TRK UP</code> (''Track Up''): if aircraft is on the ground the aircraft symbol doesn't rotates and is up, map rotates to represent the heading of the airplane. Airborn, the top of the map is aligned with the current ground track.
* <code>DTK UP</code> (''Desired Track Up''): alignes the map with the desired course (only available if desired course has been set)
* <code>HDG UP</code> (''Heading Up''): the top of the map is the current heading of the aircraft
When the desired zoom and orientation are selected, validate by pressing <code>ENT</code> button. Pressing the <code>CLR</code> exit the modification window without saving the changes. 
==== Terrain ====
You have to choose the map background you want to be displayed. For this you have to use the options in your <code>.fgfsrc</code>. This is subject to change in near future in order to allow to change the maps while the device is running. For now there are some options to tells the zkv1000 which map you want: 
[[File:Zkv1000-wikimedia.org.png|thumb|LFBT - tiles from maps.wikimedia.org]]
* without any configuration (default settings), tiles from [https://www.wikimedia.org/wiki/Maps wikimedia.org]
 

[[File:Zkv1000-thunderforest.png|thumb|LFBT tiles from thunderforest.com (registration needed)]]
* If some more information are needed in URL (as registration key) you may want to use the <code>/sim/online-tiles-apikey</code> property
<source>--prop:/sim/online-tiles-server=tile.thunderforest.com
--prop:/sim/online-tiles-type=landscape
--prop:/sim/online-tiles-apikey=?apikey=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</source>
 
[[File:Zkv1000-opentopomap.png|thumb|LFBT - tiles from opentopomap]]
* If there is no specific "type", please affect <code>/</code> char to property <code>/sim/online-tiles-type</code>
<source>--prop:/sim/online-tiles-server=a.tile.opentopomap.org
--prop:/sim/online-tiles-type=/</source>
 
[[File:Zkv1000-ign.png|thumb|LFBT - tiles from ign.fr (covering France only)]]
* If the URL can't be easily standardized, you can create you own template with property <code>/sim/online-tiles-template</code>, you can use some tags from properties as <code>{server}</code>, <code>{type}</code> and <code>{format}</code>, where values come from respectively <code>/sim/online-tiles-server</code>, <code>/sim/online-tiles-type</code> and <code>/sim/online-tiles-format</code>:
(maps covering only France) 
<source>--prop:/sim/online-tiles-server=wxs.ign.fr
--prop:/sim/online-tiles-type=GEOGRAPHICALGRIDSYSTEMS.MAPS.SCAN-OACI
--prop:/sim/online-tiles-format=jpeg
--prop:/sim/online-tiles-template=https://{server}/an7nvfzojv5wa96dsga5nk8w/geoportail/wmts?layer={type}&style=normal&tilematrixset=PM&Service=WMTS&Request=GetTile&Version=1.0.</source>
 
* By default, protocol is <code>https</code>, so if you need <code>http</code> you'll need to use <code>/sim/online-tiles-template</code> (The follwing example doesn't display anything, tiles are empty around LFBT, need to investigate a bit) 
<source>--prop:/sim/online-tiles-server=1.tile.maps.openaip.net
--prop:/sim/online-tiles-type=EPSG:900913@png
--prop:/sim/online-tiles-template=http://{server}/geowebcache/service/tms/1.0.0/openaip_basemap@{type}/{z}/{x}/{y}.png</source>
 

==== NavAids ====
(screenshots to come as soon as the highlighting system will be repaired)
By default the navaids around the aircraft are shown on the map (airports, VOR & TACAN, NDB)
===== Nearest Navaids =====
(screenshots to come as soon as the highlighting system will be repaired)

By turning the MFD Outer FMS knob you enter in menu system, turn the Outer FMS knob to select the NRST page. The available nearest navaids searches are in light-blue chars, the grey entries aren't available for now.

As the day of writing, here are the available searches:
* NEAREST AIRPORTS
* NEAREST INTERSECTIONS
* NEAREST NDB
* NEAREST VOR

Select the desired search by turning the Inner FMS knob, and validate your choice by pressing the ENT button. The navaids available in a range of 100NM are listed, one by line, the second line contains the distance and course from the aircraft to the navaids. You can select by turning the Inner FMS knob and validate your choice by pressing the ENT button.

You can have information about the selected navaid by pressing the ENT button.
For radios navaids it include frequencies, coordinates, complete name, eventually range if the data is available.
For airports the information include name, coordinates, frequencies, runways (eventually with ILS frequencies)

In near future it will be possible to compute a DTO, or include the navaid in an existing flightplan, but for now these features aren't yet released...

The scrolling feature isn't really well managed, and there are some nasty things displayed, but a go-to-bottom then go-up correct it in most of the cases

==== Route ====
==== TCAS ====
Traffic announciator is shown as there is a traffic in sight, until there is no traffic at all
==== Topography ====
==== Inset map ====

=== Menus ===
==== Set screen brightness and body lighting ====
(screenshots to come one as soon as the highlighting system has been repaired)

On PFD without other windows opened, click on MENU key in order to make the System Settings windows displayed. You can use Inner FMS knob to adjust the brightness of the screen percent by percent from 0% which is very low, to 100% which is adapted to very shiny conditions.

During night, you can also make the ZKV1000 body being lighted (keys, softkeys and knobs descriptions). To do so, select the Light using Outer FMS knob, and adjust the lighting with the INner FMS knob. There are four level, from 0 which is light off, to 3 which is very luminous. Adjust to the level you are the most comfortable.

Using MENU or CLR key close the window.

The settings aren't stored for future flight sessions

==== Checklists ====
(screenshots to come as soon as the highlighting system will be repaired)

If the aircraft provides checklists, they can be visualized directly on the MFD.

To show checklists, press the softkey CHKLIST (which is available only if aircraft has at least one checklist). The checklists are divided into two groups:
* emergency checklists
* all the others

The emergency checklists are accessible by pressing the EMERGCY softkey. This will present a list of checklist if there are multiple checklists, or directly the emergency playlist if there is only one.

The other checklists may be divided by groups of checklists, in this case the group are shown then you can select using Inner or Outer FMS knob the desired group of chekclists, valid your choice by pressing the ENT button. Then another list will be displayed then you can select the desired checklist with Outer or Inner FMS knob, and valid your choice by pressing the ENT button. If there is no groups of checklists, the list of available non-emergency checklists are displayed. Select by using Inner or Outer FMS knob, and valid your choice by pressing ENT button.

A checklist may have more than one page, to navigate into the pages select NEXT or PREVIOUS and validate by pressing ENT button.

To exit a checklist, or selection of checklist, just press the CLR button.

=== Transponder ===

[[Category:Zkv1000|User guide]]

User:Zakharov/zkv1000 installation guide

2020-08-07T12:01:00Z

Zakharov: complete instructions for installation with last updates

[[Image:Routemanagerready.png|link=Route Manager]]
[[Image:Rembrandtready.png|link=Rembrandt]]
[[Image:Canvasready.png|link=Canvas]]
[[Image:Nasallogo3.png|link=Nasal]]



== Get the sources ==
the whole zkv1000 can be retrieved from <tt>https://seb.lautre.net/git/seb/zkv1000</tt>. You will have the choice with different ways (git, zip or tar.gz).

You have the choice of the destination of the source (in order of recommandation)
# in <tt>$FGHOME/Aircraft/Instruments-3d</tt>
# in your aircraft directory
# in <tt>$FGDATA/Aircraft/Instruments-3d</tt>

We'll refer to the zkv1000 installation directory as <tt>$ZKV1000</tt> later in this document

== Installation in the cockpit ==
The glass cockpit and the material around are included in the sources, but you can provide yours. Please see the advanced installation below.

The zkv1000 provides files in order to let you choose if you want a PFD, a MFP, both of them, or two PFDs and one PFD.

So the installation depends on what you want. Place in your cockpit the following files in the XML definition files of your aircraft
{| class="wikitable"
|-
! Configuration !! Files needed
|-
| PFD only || <tt>$ZKV1000/pfd-pilot.xml</tt>
|-
| MFD only || <tt>$ZKV1000/mfd.xml</tt>
|-
| 1 PFD + 1 MFD || <tt>$ZKV1000/pfd-pilot.xml</tt> + <tt>$ZKV1000/mfd.xml</tt>
|-
| 2 PFD + 1 MFD || <tt>$ZKV1000/pfd-pilot.xml</tt> + <tt>$ZKV1000/pfd-copilot.xml</tt> + <tt>$ZKV1000/mfd.xml</tt>
|}

Here's an example from the Lancair 235, configuration with a PFD in front of the pilot's seat and a MFD between the pilot's seat and the copilot's seat, a bit inclinated in direction of the pilot. These lines take place in the dedicated file about the cockpit definition.
<syntaxhighlight lang="xml">
<model>
<path>Aircraft/Instruments-3d/zkv1000/pfd-pilot.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>
</syntaxhighlight>
== make it work ==
Once your device is installed in your cockpit you may tell FligthGear where to find the underlying Nasal code. This is done in the <nasal> section of your aircraft definition. Obviously this is one of the manadatory step and value, the Nasal namespace '''must''' be zkv1000.
<syntaxhighlight lang="xml">
<zkv1000>
<file>Aircraft/Instruments-3d/zkv1000/zkv1000.nas</file>
</zkv1000>
</syntaxhighlight>

You have other options you can pass to the device in the <instrumentation> section of your aircraft definition
<syntaxhighlight lang="xml">
<instrumentation>
...
<zkv1000>
<alerts>
<Vx>15</Vx>
<Vy>110</Vy>
<Vr>65</Vr>
<Vglide>80</Vglide>
<stall-aoa>12</stall-aoa>
<approach-aoa>4</approach-aoa>
</alerts>
<eis>
<type>single-prop</type>
</eis>
</zkv1000>
...
</instrumentation>
</syntaxhighlight>

The available options are
{| class="wikitable"
|-
! Category !! Option !! Meaning !! Values
|-
| rowspan="4" | <tt>alerts</tt> || <tt>V''speed''</tt> || default [https://en.wikipedia.org/wiki/V_speeds V-speed] speed, displayed with a mark in the PFD's speed tape identified by the text after the uppercase V (Vfoobar, Vx, Vglide, etc.), no default value || a number in '''knots''', it can be modified by user using zkv1000 UI '''except for <tt>Vne</tt>''', no default value
|-
| <tt>stall-aoa</tt> || The stalling angle of attack, if defined it is displayed in AOA widget || rowspan="2" | a number in degrees
|-
| <tt>approach-aoa</tt> || The expected angle of attack at approach phase, if defined it is displayed in AOA widget
|-
| <tt>warnings</tt> || colspan="2" | Set of as simple as possible Nasal scripts to use the internal alerts system, internally the message identifies the alert so be careful not to use the same message for two different warnings.

Indexing the warning space can be useful if some property has to be modified like message or level, letting you use only one definition of a kind of alert with multiple levels and messages.

There are 3 alerts levels: <tt>0</tt> (information), <tt>1</tt> (warning), and higher values (begins with <tt>2</tt>, decimal allowed) for really important alerts. The UI will sort the alerts in descendant order (highest level first).

Only the triggered alerts are shown (i.e return <tt>true</tt>)

An example may help a bit<syntaxhighlight lang="xml">
<warnings>
<warning n="0">
<script><![CDATA[
var severity = getprop('/environment/icing/icing-severity');
if (severity) {
setprop('/instrumentation/zkv1000/alerts/warnings/warning/level', severity);
setprop('/instrumentation/zkv1000/alerts/warnings/warning/message',
sprintf('%s ICING CONDITIONS', string.uc(getprop('/environment/icing/icing-severity-name'))));
}
return severity;
]]></script>
<level>0</level> 
<message>icing conditions</message> 
</warning>

<warning n="1">
<script><![CDATA[
getprop('/consumables/deice') / (getprop('/controls/deice/mode')+2) < 100;
]]></script>
<level>1</level>
<message>deice liquid low</message>
</warning>
...
</warnings>
</syntaxhighlight>
|-
| <tt>eis</tt> || <tt>type</tt> or <tt>file</tt> || the type of EIS on MFD only, defaults to none || "none" means... none, the other possible values are the nasal definitions of file as in <tt>$ZKV1000/Nasal/eis</tt> (without the .nas extension) or the relative path to your definition specific to your aircarft
|}
More options to come...

The zkv1000 Nasal code is loaded at the end of the FDM initialization. Knowing that if you want to automagically switch on the zkv1000 there is a function named <code>zkv1000.powerOn()</code>, otherwise there is a predefined multikey {{key press|:}}{{key press|z}}{{key press|o}} witch will call the <tt>powerOn()</tt> function.

This should work and you and your aircraft's users should enjoy the instrument :)
== Advanced installation ==
You may want to use your own 3D objects, this is not a problem.

Each component of the zkv1000 is created at the power on if a property exists : <code>/instruments/zkv1000/<NAME>/status</code> in wich <tt>NAME</tt> is a string with the pattern: <code>(MFD|PFD)[optional identifier]</code>

So there are 3 optional properties useful to create your own device (only <tt>screen-object</tt> is available for now)
{| class="wikitable"
|-
! Property !! Role
|-
| <code>/instruments/zkv1000/<NAME>/screen-object</code> || The name of the 3D object
|-
| <code>/instruments/zkv1000/<NAME>/screen-view</code> || N/A The size of the view in Canvas context (defaults to <tt>[1024, 768]</tt>)
|-
| <code>/instruments/zkv1000/<NAME>/screen-size</code> || N/A The value of the Canvas size (defaults to <tt>[1280, 1280]</tt>), this value should be a square and large enough to allow rotation of the view without a not included pixel
|}

In the <tt>zkv1000</tt> namespace API specific for one component will be available by the <tt>NAME</tt>:
<syntaxhighlight>zkv1000.flightdeck['PFD-example'].knobs.FmsInner(...)</syntaxhighlight>
=== API ===
==== softkeys ====
There are 12 softkeys, related to the twelve boxes along the bottom of the zkv1000 screen.
They are accesible via the Class <tt>softkeys</tt>

===== <tt>SoftKey(number, pressed)</tt> =====
arguments:
* number: the number of the softkey, from 0 on the left-side, to 11 at the most right
* pressed: if the button is being pressed (1) or released (0), actually only pressed status is usable

==== buttons ====
.buttons.FMS
.buttons.ENT
.buttons.CLR
.buttons.PROC
.buttons.FPL
.buttons.MENU
.buttons.DirectTo
.buttons.PAN
.buttons.AsSwitchCOM
.buttons.AsSwitchNAV
.buttons.ALT

==== knobs ====
===== .knobs.FmsOuter(direction) =====
takes one argument which is the direction of the turn: <tt>cmdarg().getNode('offset').getValue()</tt>
===== .knobs.knobs.FmsInner(direction) =====
takes one argument which is the direction of the turn: <tt>cmdarg().getNode('offset').getValue()</tt>
===== .knobs.display.updateNAV({set:1}) =====
set the value for standby frequency for the selected NAV radio
===== .knobs.display.updateNAV({refresh:1|2}) =====
===== .knobs.display.updateCOMM({set:1}) =====
set the value for standby frequency for the selected COMM radio
===== .knobs.display.updateCOMM({refresh:1|2}) =====
===== .knobs.display.updateHDG() =====
no argument, just refresh the HDG display when the knob is used
===== .knobs.display.updateCRS() =====
no argument, just refresh the CRS display when the knob is used
===== .knobs.display.updateALT() =====
no argument, just refresh the ALT display when the knob is used
===== .knobs.display.updateBARO() =====
no argument, just refresh the BARO display when the knob is used

[[Category:Zkv1000|Installation guide]]

User:Zakharov/zkv1000 user guide

2020-06-19T10:01:32Z

Zakharov:

== Introduction ==
The zkv1000 is an instrument which concentrates some other instruments in only one single and simple interface. It is largely inspired from the famous display parts of Garmin Primus 1000. Once said, the zkv1000 is definitively '''not''' an exact replica of the Garmin Primus 1000, and isn't intended to be one. Sorry about that. 
Depending of your aircraft you may have in your cockpit different configurations, and some unavailable entries. Even we are in a sim, so there is no limit in the way to get full instrumented glide plane it may be interesting to limit the use of certain functions depending of the aircraft. This has to checked with the aircraft maintainer, or if you feel free with the GPL licence you may modify the aircraft to get the desired functions to work (see installation guide) 
=== Overview ===
There is two devices: MFD and PFD. You may find in your aircraft a configuration with only one of those, one of each or one MFD and two PFD. But there may be other configurations if the aircraft maintainer has decided it.

==== PFD ====
[[File:Zkv1000-PFD-global.png|thumb|zkv1000 PFD overview]]
 
==== MFD ====
[[File:Zkv1000-MFD-global.png|thumb|zkv1000 MFD overview]]
 
=== Softkeys codes ===
[[File:Zkv1000-available_softkeys.png]] BrightWhite on Black : available menu entry. Grey on Black : not yet implemented entry or not available in this aircraft Black : no entry 
[[File:Zkv1000-active-softkey.png]] Black on White : activated entry 

=== UI code and usage ===
[[File:Zkv1000-available_menus.png]] 
Selected entry is in Black on LightBlue 
Available entry is LightBlue on Black
Unavailable entry is White on Black 
[[File:Zkv1000-selectable-items.png|selectable items]] entries with marks <code><</code> or <code>></code> or both are entries with limited number of choices. First choice doesn't show the <code><</code> char, last one doesn't show the <code>></code> char. All other show both <code><</code> and <code>></code> 
Navigate from an entry to the next or the previous by turning the large FMS knob, modify the value of the entry by turning the small FMS knob. 

== Primary Flight Display ==
You just jumped into your Aircraft, depending of the scenario for it you may need to switch up electric system or some button(s) to get the zkv1000 up. Please refer to the aircraft manual.
=== Airspeed indicator ===
The indicated airspeed tape is in knots or km/h, the unit is refered as speed init later in this documentation. You can modify the speed unit by the dedicated window.
The black pointer shows the current IAS. 
On the tape major ticks are displayed with 10 speed units interval, minor ticks at 5 speed units interval. The trend can show up to 1000 speed units. A pink trend vector shows the estimated speed in the next 6 seconds (in the limit of +/- 30 speed units). 
There may be some Vspeeds marks (pink, text in white) specific to the aircraft (cf installation guide). It is possible to modify these values of the Vspeeds references (value and display, except Vne) as described later in this document 
The black pointer will take a red color if IAS exceeds the defined Vne. 
The true airspeed is shown under the speed tape, and the ground speed, in the same unit than IAS 
 
=== Altitude indicator ===
The altitude tape is in feet or meters, the unit is refered as altitude unit later in this documentation. The altitude can show from -990 to 99990 altitude units. The black pointer shows the current indicated altitude (determined from the air pressure), 20 altitude units graduated. A trend vector indicates the readched altitude in the next 6 seconds in the limit of +/- 300 altitude units. 
The barometric setting is shwon just under the altitude tape. It is graduated in inHg or hPa, which is refered as pressure unit later in this documentation. The pressure unit can be modified to hPa or inHg quickly by using the softkey menu <code>PFD > UNITS</code> and press <code>INHG</code> or <code>HPA</code>
{{note|It won't be saved this way for another session. To save it see the zkv1000 settings part in this documentation}}
The setting to standard barometric value (29.92inHg or 1023hPa) can be automatically set by the menu <code>PFD > STD BARO</code>. The barometer setting is essential and can be done by turning the BARO knob in front of the device (left side, under the COMM knob). 
The selected altitude is indicated by a lightblue bug along the altitude tape. It is blocked at the upper or lower corner of the tape until the tape has in its range the selected altitude. While the selected altitude isn't in the +/- 300 altitude unit range a black box indicates the selected altitude above the altitude tape. This box disappears when the indicated altitude is +/- 100 altitude unit of selected altitude.

=== Vertical speed indicator===
The vertical speed indicator is on the right just near the altitude tape, and is graduated with major ticks every 1000 ft/min or m/min refered as vertical speed units later in this documentation. Minor ticks are displayed every 500 vertical speed units. 
A black pointer containing the vertical speed with 10 vertical speed units precision moves along the non-moving tape. If the vertical speed exceeds +/- 4500 vertical speed units the pointer is locked to the upper/lower of the non-moving tape, and the vertical speed is detailed inside the pointer.

=== Attitude indicator===
Pitch scale is graduated 10° up to 80°, with minor marks 5° interval up to 25°, and every 2.5° below 20° pitch. The horizon line is part of the pitch scale, and represents a pitch of 0°. 
The roll scale is the 120° arc. The inverted triangle represents 0° roll. Major ticks represent 30° and 60°, minor ticks represent 10°, 20° and 45°. 
The slip skid indicator is the bar beneath the roll pointer. The Slip Skid indicator moves laterally away from the pointer to indicate the lateral acceleration.

=== Horizontal situation indicator===
The HSI displays a rotating compass card in a heading-up orientation. Letters indicate the cardinal points and numeric labels occur every 30°. 
Major tick marks are at 10° intervals and minor tick marks at 5° intervals. 
A digital reading of the current heading appears on top of the HSI. 

==== Course Deviation Indicator ====
The HSI contains a Course Deviation Indicator (CDI) with course pointer, TO/FROM indication and a sliding deviation bar. 
GPS, VOR1 and LOC1 have single line arrow, while VOR2 have two lines arrow. 
GPS CDI is available only if a course has been set via the route manager, VOR and LOC show arrow when the active NAVAID is received.

==== Adjust heading ====
Turn the <code>HDG</code> knob to adjust the heading, doing so the heading bug will be positionned along the compass. 
A window showing the desired heading is shown for 3 seconds.
==== Adjust selected course ====
Select the corresponding GPS, NAV1 or NAV2 display by pressing the CDI softkey, then turn the <code>CRS</code> knob to adjust the desired course for VOR. Unless you aren't in OBS mode you cannot change the course for GPS. To do so, select GPS by pressing <code>CDI</code> softkey, then <code>OBS</code> softkey is displayed as available. To enter in OBS mode, press the <code>OBS</code> softkey, now you can adjust course by turning the <code>CRS</code> knob.

== Set your zkv1000 preferences ==
Press the <code>MENU</code> button, a window appears with settings. Navigate into the available settings by turning the outter FMS knob. The inner FMS knob changes the selected setting. To quit and save changes press <code>CLR</code>.
=== Brightness ===
You can adjust the luminosity of the whole device (PFD and MFD). Select the first entry <code>Brightness</code> and turn the inner FMS knob to increase or decrease brightness (from 0% to 100%). This setting isn't saved from a session to another.
=== Device lights ===
For a night flight you may need to change the device enlightment. With outter FMS knob, select the entry in front of <code>Light</code>. With the inner FMS knob select the device light level to fit your need from 0 (lights off) to 3 (lights very bright). This setting isn't saved from a session to another.
=== Units ===
Select the unit domain ou want to change with outter FMS knob, and select the unit with the inner knob. Once choosen, apply the change by pressing the <code>ENT</code> button. Quit the window with the button <code>CLR</code>, the settings will be saved for future session. The settings are only for that aircraft, so if you use another aircraft you have to set to fit your needs again. 
The unit will be used everywhere on the zkv1000, MFD and PFD, and all corresponding data will be displayed in the unit set here. 
Here is the list of available domains and their units, at the time of writting:
* Pressure: inHg or hPa
* Altitude: feet or meters
* Distance: NM (nautic miles) or km (kilometers)
* Speed: KT (knots) or km/h (kilometers per hour)
* Vert. Speed (for Vertical speed): ft/min or m/min
* Temperat. (for Temperature): F (Fahrenheit) or °C (degrees Celsius)
* Volume: L (liters), M3 (cube meter) or GAL (US gal)
<note>It is possible to quickly set the pressure setting from the <code>PFD > UNITS</code> softkeys sequence</note>
=== Time ===
The default displayed time is GMT. You may want to display time in UTC, LCL (local, dependant of your aircraft location), or RL (Real Life, the time of your computer). This setting isn't saved from a session to another.

== check and adapt Vspeeds references ==
You may check the Vspeed references for your aircraft (if any). Press <code>TMR/REF</code> softkey. A window is now displayed presenting a timer, eventually Vspeeds if they are set, and minimums settings (which isn't used at the time of writing). 
Turn the outter FMS knob to select successively the displayed Vspeed. 3 are shown but the list may be longer so continue until you reach the minimums settings. 
You can modify the Vspeed reference by turning the inner knob to adapt it at your situation (altitude, temperature, weight, etc.)

If the device is configured with stall angle of attack (see installation guide) then the softkeys menus <code>PFD > AOA/WIND > AOA ON</code> shows up a window just near the airspeed tape. This indicates the current normalized angle of attack, a LightBlue mark shows the best normalized angle of attack for approach. 
The softkey menu <code>PFD > AOA/WIND > AOA AUTO</code> make the AoA indicator showing up automagically if the gears are down and flaps out.

== Radios ==
=== NAV ===
NAV stack is on the left on each device. It is composed by
* 1 switch button
* 1 tuning knob
* 1 display with 4 frequencies

Frequencies are organized like this
<source>
standby NAV1 | active NAV1
standby NAV2 | active NAV2
</source>

The tuning is done on the selected NAV which is the one with the standby frequency in blue. The tuning step is 0.25 MHz (or 1.00 MHz with the use of {{Key press|shift}}) in the range 108.00 to 118.00 MHz

=== COMM ===
The COMM stack is on the right side on each device. It is composed by
* 1 switch button
* 1 tuning knob
* 1 display with 4 frequencies

The frequencies are displayed as follow:
<source>
active COMM1 | standby COMM1
active COMM2 | standby COMM2
</source>

The tuning frequency is the one in blue, the step is 0.025 MHz (0.500 Mhz using {{Key press|shift}}) from 118.025 to 123.975 MHz

== EIS ==

== Flight Management ==
=== Maps ===
The map content can be modified by using <code>INSET</code> softkey on PFD, and <code>MAP</code> softkey on MFD, then by activating or de-activating each layer. 

The map orientation and zoom can be modified by pressing the <code>MENU</code> button. 
[[File:Zkv1000-mapmenu.png|Map orientation and zoom configuration]] 
The zoom level is an number between 7 (largest range) to 13 (smallest range). The range calculation depends on two other factors: latitude and size of the screen (eg. EIS size). Here's a table for ranges without EIS and for 40° lat: 
{| class="wikitable"
|-
! Zoom index !! Approximative range of Y axis, in NM
|-
| 7 || 194
|-
| 8 || 97
|-
| 9 || 49
|-
| 10 || 24
|-
| 11 || 12
|-
| 12 || 6
|-
| 13 || 3
|}
Four orientations are available:
* <code>NORTH UP</code>: in this configuration the aircraft symbol rotates, the map is aligned with North up
* <code>TRK UP</code> (''Track Up''): if aircraft is on the ground the aircraft symbol doesn't rotates and is up, map rotates to represent the heading of the airplane. Airborn, the top of the map is aligned with the current ground track.
* <code>DTK UP</code> (''Desired Track Up''): alignes the map with the desired course (only available if desired course has been set)
* <code>HDG UP</code> (''Heading Up''): the top of the map is the current heading of the aircraft
When the desired zoom and orientation are selected, validate by pressing <code>ENT</code> button. Pressing the <code>CLR</code> exit the modification window without saving the changes. 
==== Terrain ====
You have to choose the map background you want to be displayed. For this you have to use the options in your <code>.fgfsrc</code>. This is subject to change in near future in order to allow to change the maps while the device is running. For now there are some options to tells the zkv1000 which map you want: 
[[File:Zkv1000-wikimedia.org.png|thumb|LFBT - tiles from maps.wikimedia.org]]
* without any configuration (default settings), tiles from [https://www.wikimedia.org/wiki/Maps wikimedia.org]
 

[[File:Zkv1000-thunderforest.png|thumb|LFBT tiles from thunderforest.com (registration needed)]]
* If some more information are needed in URL (as registration key) you may want to use the <code>/sim/online-tiles-apikey</code> property
<source>--prop:/sim/online-tiles-server=tile.thunderforest.com
--prop:/sim/online-tiles-type=landscape
--prop:/sim/online-tiles-apikey=?apikey=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</source>
 
[[File:Zkv1000-opentopomap.png|thumb|LFBT - tiles from opentopomap]]
* If there is no specific "type", please affect <code>/</code> char to property <code>/sim/online-tiles-type</code>
<source>--prop:/sim/online-tiles-server=a.tile.opentopomap.org
--prop:/sim/online-tiles-type=/</source>
 
[[File:Zkv1000-ign.png|thumb|LFBT - tiles from ign.fr (covering France only)]]
* If the URL can't be easily standardized, you can create you own template with property <code>/sim/online-tiles-template</code>, you can use some tags from properties as <code>{server}</code>, <code>{type}</code> and <code>{format}</code>, where values come from respectively <code>/sim/online-tiles-server</code>, <code>/sim/online-tiles-type</code> and <code>/sim/online-tiles-format</code>:
(maps covering only France) 
<source>--prop:/sim/online-tiles-server=wxs.ign.fr
--prop:/sim/online-tiles-type=GEOGRAPHICALGRIDSYSTEMS.MAPS.SCAN-OACI
--prop:/sim/online-tiles-format=jpeg
--prop:/sim/online-tiles-template=https://{server}/an7nvfzojv5wa96dsga5nk8w/geoportail/wmts?layer={type}&style=normal&tilematrixset=PM&Service=WMTS&Request=GetTile&Version=1.0.</source>
 
* By default, protocol is <code>https</code>, so if you need <code>http</code> you'll need to use <code>/sim/online-tiles-template</code> (The follwing example doesn't display anything, tiles are empty around LFBT, need to investigate a bit) 
<source>--prop:/sim/online-tiles-server=1.tile.maps.openaip.net
--prop:/sim/online-tiles-type=EPSG:900913@png
--prop:/sim/online-tiles-template=http://{server}/geowebcache/service/tms/1.0.0/openaip_basemap@{type}/{z}/{x}/{y}.png</source>
 

==== NavAids ====
(screenshots to come as soon as the highlighting system will be repaired)
By default the navaids around the aircraft are shown on the map (airports, VOR & TACAN, NDB)
===== Nearest Navaids =====
(screenshots to come as soon as the highlighting system will be repaired)

By turning the MFD Outer FMS knob you enter in menu system, turn the Outer FMS knob to select the NRST page. The available nearest navaids searches are in light-blue chars, the grey entries aren't available for now.

As the day of writing, here are the available searches:
* NEAREST AIRPORTS
* NEAREST INTERSECTIONS
* NEAREST NDB
* NEAREST VOR

Select the desired search by turning the Inner FMS knob, and validate your choice by pressing the ENT button. The navaids available in a range of 100NM are listed, one by line, the second line contains the distance and course from the aircraft to the navaids. You can select by turning the Inner FMS knob and validate your choice by pressing the ENT button.

You can have information about the selected navaid by pressing the ENT button.
For radios navaids it include frequencies, coordinates, complete name, eventually range if the data is available.
For airports the information include name, coordinates, frequencies, runways (eventually with ILS frequencies)

In near future it will be possible to compute a DTO, or include the navaid in an existing flightplan, but for now these features aren't yet released...

The scrolling feature isn't really well managed, and there are some nasty things displayed, but a go-to-bottom then go-up correct it in most of the cases

==== Route ====
==== TCAS ====
Traffic announciator is shown as there is a traffic in sight, until there is no traffic at all
==== Topography ====
==== Inset map ====

=== Menus ===
==== Set screen brightness and body lighting ====
(screenshots to come one as soon as the highlighting system has been repaired)

On PFD without other windows opened, click on MENU key in order to make the System Settings windows displayed. You can use Inner FMS knob to adjust the brightness of the screen percent by percent from 0% which is very low, to 100% which is adapted to very shiny conditions.

During night, you can also make the ZKV1000 body being lighted (keys, softkeys and knobs descriptions). To do so, select the Light using Outer FMS knob, and adjust the lighting with the INner FMS knob. There are four level, from 0 which is light off, to 3 which is very luminous. Adjust to the level you are the most comfortable.

Using MENU or CLR key close the window.

The settings aren't stored for future flight sessions

==== Checklists ====
(screenshots to come as soon as the highlighting system will be repaired)

If the aircraft provides checklists, they can be visualized directly on the MFD.

To show checklists, press the softkey CHKLIST (which is available only if aircraft has at least one checklist). The checklists are divided into two groups:
* emergency checklists
* all the others

The emergency checklists are accessible by pressing the EMERGCY softkey. This will present a list of checklist if there are multiple checklists, or directly the emergency playlist if there is only one.

The other checklists may be divided by groups of checklists, in this case the group are shown then you can select using Inner or Outer FMS knob the desired group of chekclists, valid your choice by pressing the ENT button. Then another list will be displayed then you can select the desired checklist with Outer or Inner FMS knob, and valid your choice by pressing the ENT button. If there is no groups of checklists, the list of available non-emergency checklists are displayed. Select by using Inner or Outer FMS knob, and valid your choice by pressing ENT button.

A checklist may have more than one page, to navigate into the pages select NEXT or PREVIOUS and validate by pressing ENT button.

To exit a checklist, or selection of checklist, just press the CLR button.

=== Transponder ===

[[Category:Zkv1000|User guide]]

User:Zakharov/zkv1000 user guide

2020-04-30T15:38:12Z

Zakharov: /* Introduction */

== Introduction ==
The zkv1000 is an instrument which concentrates some other instruments in only one single and simple interface. It is largely inspired from the famous display parts of Garmin Primus 1000. Once said, the zkv1000 is definitively '''not''' an exact replica of the Garmin Primus 1000, and isn't intended to be one. Sorry about that. 
Depending of your aircraft you may have in your cockpit different configurations, and some unavailable entries. Even we are in a sim, so there is no limit in the way to get full instrumented glide plane it may be interesting to limit the use of certain functions depending of the aircraft. This has to checked with the aircraft maintainer, or if you feel free with the GPL licence you may modify the aircraft to get the desired functions to work (see installation guide) 
=== Overview ===
There is two devices for now: MFD and PFD. You may find in your aircraft a configuration with only one of those, one of each or one MFD and two PFD. But there may be other configurations if the aircraft maintainer has decided it.

==== PFD ====
[[File:Zkv1000-PFD-global.png|thumb|zkv1000 PFD overview]]
 
==== MFD ====
[[File:Zkv1000-MFD-global.png|thumb|zkv1000 MFD overview]]
 
=== Softkeys codes ===
[[File:Zkv1000-available_softkeys.png]] BrightWhite on Black : available menu entry. Grey on Black : not yet implemented entry or not available in this aircraft Black : no entry 
[[File:Zkv1000-active-softkey.png]] Black on White : activated entry 

=== UI code and usage ===
[[File:Zkv1000-available_menus.png]] 
Selected entry is in Black on LightBlue 
[[File:Zkv1000-selectable-items.png|selectable items]] entries with marks <code><</code> or <code>></code> or both are entries with limited number of choices. First choice doesn't show the <code><</code> char, last one doesn't show the <code>></code> char. All other show both <code><</code> and <code>></code> 
Navigate from an entry to the next or the previous by turning the large FMS knob, modify the value of the entry by turning the small FMS knob. 

== Flight Instruments ==
=== Airspeed indicator ===
The indicated airspeed tape is in knots and can show up to 1000 knots. The black pointer shows the current IAS. 
On the tape major ticks are shown at 10 knots interval, minor ticks at 5 knots interval. A pink trend vector shows the estimated speed in the next 6 seconds (in the limit of +/- 30 knots). 
There may be some Vspeeds marks (pink, text in white) specific to the aircraft (cf installation guide). It is possible to modify these values of the Vspeeds references by using the softkeys menu TMR/REF which make a window appear in the right down corner of the screen, and then navigating to the value to change it as described in UI code and usage chapter. 
The black pointer will take a red color if IAS exceeds the defined Vne. 
The true airspeed is shown under the speed tape, and the ground speed. Both are in knots. 
If the device is configured with stall angle of attack (see installation guide) then the softkeys menus <code>PFD > AOA/WIND > AOA ON</code> shows up a window just near the airspeed tape. This indicates the current normalized angle of attack, a LightBlue mark shows the best normalized angle of attack for approach. 
The softkey menu <code>PFD > AOA/WIND > AOA AUTO</code> make the AoA indicator showing up automagically if the gears are down and flaps out. 
The softkey menu <code>PFD > AOA/WIND > WIND > OPTN1</code> shows up the direction of the wind relative to the aircraft (heading and speed) 
The softkey menu <code>PFD > AOA/WIND > WIND > OPTN2</code> shows up the direction of the wind with front and cross wind components 
The softkey menu <code>PFD > AOA/WIND > WIND > OFF</code> hides the wind indicator window. 

=== Altitude indicator ===
The altitude tape is in feet, and shows from -990ft to 99990ft. The black pointer shows the current indicated altitude (determined from the air pressure), 20ft graduated. A trend vector indicates the readched altitude in the next 6 seconds in the limit of +/- 300ft. 
The barometric setting is shwon just under the altitude tape. It is graduated in inHg by default, but this can be modified to hPa using the softkey menu <code>PFD > HPA</code>, and back to inHg via menu <code>PFD > IN</code>. The setting to standard barometric value (29.92inHg or 1023hPa) can be automatically set by the menu <code>PFD > STD BARO</code>. The barometer setting is essential and can be done by turning the BARO knob in front of the device (left side, under the COMM knob). 
The selected altitude is indicated by a lightblue bug along the altitude tape. It is blocked at the upper or lower corner of the tape until the tape has in its range the selected altitude. While the selected altitude isn't in the +/- 300 ft range a black box indicate the selected altitude above the altitude tape. This box disappear when the indicated altitude is +/- 100 ft of selected altitude.

=== Vertical speed indicator===
The vertical speed indicator is on the right just near the altitude tape, and is graduated with major ticks every 1000 ft/min, and minor ticks every 500 ft/min. 
A black pointer containing the vertical speed with 10 ft/min precision moves along the non-moving tape. If the vertical speed exceeds +/- 4500 ft/min the pointer is locked to the upper/lower of the non-moving tape, and the vertical speed is detailed inside the pointer.

=== Attitude indicator===
Pitch scale is graduated 10° up to 80°, with minor marks 5° interval up to 25°, and every 2.5° below 20° pitch. The horizon line is part of the pitch scale, and represents a pitch of 0°. 
The roll scale is the 120° arc. The inverted triangle represents 0° roll. Major ticks represent 30° and 60°, minor ticks represent 10°, 20° and 45°. 
The slip skid indicator is the bar beneath the roll pointer. The Slip Skid indicator moves laterally away from the pointer to indicate the lateral acceleration.

=== Horizontal situation indicator===
The HSI displays a rotating compass card in a heading-up orientation. Letters indicate the cardinal points and numeric labels occur every 30°. 
Major tick marks are at 10° intervals and minor tick marks at 5° intervals. 
A digital reading of the current heading appears on top of the HSI, and the current track is represented on the HSI by a magenta diamond bug. 
The HSI also presents turn rate, course deviation, bearing, and navigation source information.

==== Course Deviation Indicator ====
The HSI contains a Course Deviation Indicator (CDI) with course pointer, TO/FROM indication and a sliding deviation bar. 
GPS, VOR1 and LOC1 have single line arrow, while VOR2 and LOC2 have two lines arrow. 
GPS CDI is available only if a course has been set via the route manager, VOR and LOC show arrow when the active NAVAID is received.

==== Adjust heading ====
Turn the <code>HDG</code> knob to adjust the heading, doing so the heading bug will be positionned along the compass. 
A window showing the desired heading is shown for 3 seconds.
==== Adjust selected course ====
Turn the <code>CRS</code> knob to adjust the desired course for VOR and LOC

== Radios ==
=== NAV ===
NAV stack is on the left on each device. It is composed by
* 1 switch button
* 1 tuning knob
* 1 display with 4 frequencies

Frequencies are organized like this
<source>
standby NAV1 | active NAV1
standby NAV2 | active NAV2
</source>

The tuning is done on the selected NAV which is the one with the standby frequency in blue. The tuning step is 0.25 MHz (or 1.00 MHz with the use of {{Key press|shift}}) in the range 108.00 to 118.00 MHz

=== COMM ===
The COMM stack is on the right side on each device. It is composed by
* 1 switch button
* 1 tuning knob
* 1 display with 4 frequencies

The frequencies are displayed as follow:
<source>
active COMM1 | standby COMM1
active COMM2 | standby COMM2
</source>

The tuning frequency is the one in blue, the step is 0.025 MHz (0.500 Mhz using {{Key press|shift}}) from 118.025 to 123.975 MHz

== EIS ==

== Flight Management ==
=== Maps ===
The map content can be modified by using <code>INSET</code> softkey on PFD, and <code>MAP</code> softkey on MFD, then by activating or de-activating each layer. 

The map orientation and zoom can be modified by pressing the <code>MENU</code> button. 
[[File:Zkv1000-mapmenu.png|Map orientation and zoom configuration]] 
The zoom level is an number between 7 (largest range) to 13 (smallest range). The range calculation depends on two other factors: latitude and size of the screen (eg. EIS size). Here's a table for ranges without EIS and for 40° lat: 
{| class="wikitable"
|-
! Zoom index !! Approximative range of Y axis, in NM
|-
| 7 || 194
|-
| 8 || 97
|-
| 9 || 49
|-
| 10 || 24
|-
| 11 || 12
|-
| 12 || 6
|-
| 13 || 3
|}
Four orientations are available:
* <code>NORTH UP</code>: in this configuration the aircraft symbol rotates, the map is aligned with North up
* <code>TRK UP</code> (''Track Up''): if aircraft is on the ground the aircraft symbol doesn't rotates and is up, map rotates to represent the heading of the airplane. Airborn, the top of the map is aligned with the current ground track.
* <code>DTK UP</code> (''Desired Track Up''): alignes the map with the desired course (only available if desired course has been set)
* <code>HDG UP</code> (''Heading Up''): the top of the map is the current heading of the aircraft
When the desired zoom and orientation are selected, validate by pressing <code>ENT</code> button. Pressing the <code>CLR</code> exit the modification window without saving the changes. 
==== Terrain ====
You have to choose the map background you want to be displayed. For this you have to use the options in your <code>.fgfsrc</code>. This is subject to change in near future in order to allow to change the maps while the device is running. For now there are some options to tells the zkv1000 which map you want: 
[[File:Zkv1000-wikimedia.org.png|thumb|LFBT - tiles from maps.wikimedia.org]]
* without any configuration (default settings), tiles from [https://www.wikimedia.org/wiki/Maps wikimedia.org]
 

[[File:Zkv1000-thunderforest.png|thumb|LFBT tiles from thunderforest.com (registration needed)]]
* If some more information are needed in URL (as registration key) you may want to use the <code>/sim/online-tiles-apikey</code> property
<source>--prop:/sim/online-tiles-server=tile.thunderforest.com
--prop:/sim/online-tiles-type=landscape
--prop:/sim/online-tiles-apikey=?apikey=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</source>
 
[[File:Zkv1000-opentopomap.png|thumb|LFBT - tiles from opentopomap]]
* If there is no specific "type", please affect <code>/</code> char to property <code>/sim/online-tiles-type</code>
<source>--prop:/sim/online-tiles-server=a.tile.opentopomap.org
--prop:/sim/online-tiles-type=/</source>
 
[[File:Zkv1000-ign.png|thumb|LFBT - tiles from ign.fr (covering France only)]]
* If the URL can't be easily standardized, you can create you own template with property <code>/sim/online-tiles-template</code>, you can use some tags from properties as <code>{server}</code>, <code>{type}</code> and <code>{format}</code>, where values come from respectively <code>/sim/online-tiles-server</code>, <code>/sim/online-tiles-type</code> and <code>/sim/online-tiles-format</code>:
(maps covering only France) 
<source>--prop:/sim/online-tiles-server=wxs.ign.fr
--prop:/sim/online-tiles-type=GEOGRAPHICALGRIDSYSTEMS.MAPS.SCAN-OACI
--prop:/sim/online-tiles-format=jpeg
--prop:/sim/online-tiles-template=https://{server}/an7nvfzojv5wa96dsga5nk8w/geoportail/wmts?layer={type}&style=normal&tilematrixset=PM&Service=WMTS&Request=GetTile&Version=1.0.</source>
 
* By default, protocol is <code>https</code>, so if you need <code>http</code> you'll need to use <code>/sim/online-tiles-template</code> (The follwing example doesn't display anything, tiles are empty around LFBT, need to investigate a bit) 
<source>--prop:/sim/online-tiles-server=1.tile.maps.openaip.net
--prop:/sim/online-tiles-type=EPSG:900913@png
--prop:/sim/online-tiles-template=http://{server}/geowebcache/service/tms/1.0.0/openaip_basemap@{type}/{z}/{x}/{y}.png</source>
 

==== NavAids ====
(screenshots to come as soon as the highlighting system will be repaired)
By default the navaids around the aircraft are shown on the map (airports, VOR & TACAN, NDB)
===== Nearest Navaids =====
(screenshots to come as soon as the highlighting system will be repaired)

By turning the MFD Outer FMS knob you enter in menu system, turn the Outer FMS knob to select the NRST page. The available nearest navaids searches are in light-blue chars, the grey entries aren't available for now.

As the day of writing, here are the available searches:
* NEAREST AIRPORTS
* NEAREST INTERSECTIONS
* NEAREST NDB
* NEAREST VOR

Select the desired search by turning the Inner FMS knob, and validate your choice by pressing the ENT button. The navaids available in a range of 100NM are listed, one by line, the second line contains the distance and course from the aircraft to the navaids. You can select by turning the Inner FMS knob and validate your choice by pressing the ENT button.

You can have information about the selected navaid by pressing the ENT button.
For radios navaids it include frequencies, coordinates, complete name, eventually range if the data is available.
For airports the information include name, coordinates, frequencies, runways (eventually with ILS frequencies)

In near future it will be possible to compute a DTO, or include the navaid in an existing flightplan, but for now these features aren't yet released...

The scrolling feature isn't really well managed, and there are some nasty things displayed, but a go-to-bottom then go-up correct it in most of the cases

==== Route ====
==== TCAS ====
Traffic announciator is shown as there is a traffic in sight, until there is no traffic at all
==== Topography ====
==== Inset map ====

=== Menus ===
==== Set screen brightness and body lighting ====
(screenshots to come one as soon as the highlighting system has been repaired)

On PFD without other windows opened, click on MENU key in order to make the System Settings windows displayed. You can use Inner FMS knob to adjust the brightness of the screen percent by percent from 0% which is very low, to 100% which is adapted to very shiny conditions.

During night, you can also make the ZKV1000 body being lighted (keys, softkeys and knobs descriptions). To do so, select the Light using Outer FMS knob, and adjust the lighting with the INner FMS knob. There are four level, from 0 which is light off, to 3 which is very luminous. Adjust to the level you are the most comfortable.

Using MENU or CLR key close the window.

The settings aren't stored for future flight sessions

==== Checklists ====
(screenshots to come as soon as the highlighting system will be repaired)

If the aircraft provides checklists, they can be visualized directly on the MFD.

To show checklists, press the softkey CHKLIST (which is available only if aircraft has at least one checklist). The checklists are divided into two groups:
* emergency checklists
* all the others

The emergency checklists are accessible by pressing the EMERGCY softkey. This will present a list of checklist if there are multiple checklists, or directly the emergency playlist if there is only one.

The other checklists may be divided by groups of checklists, in this case the group are shown then you can select using Inner or Outer FMS knob the desired group of chekclists, valid your choice by pressing the ENT button. Then another list will be displayed then you can select the desired checklist with Outer or Inner FMS knob, and valid your choice by pressing the ENT button. If there is no groups of checklists, the list of available non-emergency checklists are displayed. Select by using Inner or Outer FMS knob, and valid your choice by pressing ENT button.

A checklist may have more than one page, to navigate into the pages select NEXT or PREVIOUS and validate by pressing ENT button.

To exit a checklist, or selection of checklist, just press the CLR button.

=== Transponder ===

[[Category:Zkv1000|User guide]]

User:Zakharov/zkv1000 user guide

2020-04-30T15:34:46Z

Zakharov: /* NavAids */

== Introduction ==
The zkv1000 is an instrument which concentrates some other instruments in only one single and simple interface. It is largely inspired from the famous display parts of Garmin Primus 1000. Once said, the zkv1000 is definitively *not* a exact replica of the Garmin Primus 1000, and isn't intended to be one. Sorry about that. 
Depending of your aircraft you may have in your cockpit different configurations, and some unavailable entries. Even we are ina sim, so there is no limit in the way to get full instrumented glide plane it may be interesting to limit the use of certain functions depending of the aircraft. This has to checked with the aircraft maintainer, or if you feel free with the GPL licence you may modify the aircraft to get the desired functions to work (see installation guide) 
=== Overview ===
There is two devices for now: MFD and PFD. You may find in your aircraft a configuration with only one of those, one of each or one MFD and two PFD. But there may be other configurations if the aircraft maintainer has decided it.

==== PFD ====
[[File:Zkv1000-PFD-global.png|thumb|zkv1000 PFD overview]]
 
==== MFD ====
[[File:Zkv1000-MFD-global.png|thumb|zkv1000 MFD overview]]
 
=== Softkeys codes ===
[[File:Zkv1000-available_softkeys.png]] BrightWhite on Black : available menu entry. Grey on Black : not yet implemented entry or not available in this aircraft Black : no entry 
[[File:Zkv1000-active-softkey.png]] Black on White : activated entry 

=== UI code and usage ===
[[File:Zkv1000-available_menus.png]] 
Selected entry is in Black on LightBlue 
[[File:Zkv1000-selectable-items.png|selectable items]] entries with marks <code><</code> or <code>></code> or both are entries with limited number of choices. First choice doesn't show the <code><</code> char, last one doesn't show the <code>></code> char. All other show both <code><</code> and <code>></code> 
Navigate from an entry to the next or the previous by turning the large FMS knob, modify the value of the entry by turning the small FMS knob. 

== Flight Instruments ==
=== Airspeed indicator ===
The indicated airspeed tape is in knots and can show up to 1000 knots. The black pointer shows the current IAS. 
On the tape major ticks are shown at 10 knots interval, minor ticks at 5 knots interval. A pink trend vector shows the estimated speed in the next 6 seconds (in the limit of +/- 30 knots). 
There may be some Vspeeds marks (pink, text in white) specific to the aircraft (cf installation guide). It is possible to modify these values of the Vspeeds references by using the softkeys menu TMR/REF which make a window appear in the right down corner of the screen, and then navigating to the value to change it as described in UI code and usage chapter. 
The black pointer will take a red color if IAS exceeds the defined Vne. 
The true airspeed is shown under the speed tape, and the ground speed. Both are in knots. 
If the device is configured with stall angle of attack (see installation guide) then the softkeys menus <code>PFD > AOA/WIND > AOA ON</code> shows up a window just near the airspeed tape. This indicates the current normalized angle of attack, a LightBlue mark shows the best normalized angle of attack for approach. 
The softkey menu <code>PFD > AOA/WIND > AOA AUTO</code> make the AoA indicator showing up automagically if the gears are down and flaps out. 
The softkey menu <code>PFD > AOA/WIND > WIND > OPTN1</code> shows up the direction of the wind relative to the aircraft (heading and speed) 
The softkey menu <code>PFD > AOA/WIND > WIND > OPTN2</code> shows up the direction of the wind with front and cross wind components 
The softkey menu <code>PFD > AOA/WIND > WIND > OFF</code> hides the wind indicator window. 

=== Altitude indicator ===
The altitude tape is in feet, and shows from -990ft to 99990ft. The black pointer shows the current indicated altitude (determined from the air pressure), 20ft graduated. A trend vector indicates the readched altitude in the next 6 seconds in the limit of +/- 300ft. 
The barometric setting is shwon just under the altitude tape. It is graduated in inHg by default, but this can be modified to hPa using the softkey menu <code>PFD > HPA</code>, and back to inHg via menu <code>PFD > IN</code>. The setting to standard barometric value (29.92inHg or 1023hPa) can be automatically set by the menu <code>PFD > STD BARO</code>. The barometer setting is essential and can be done by turning the BARO knob in front of the device (left side, under the COMM knob). 
The selected altitude is indicated by a lightblue bug along the altitude tape. It is blocked at the upper or lower corner of the tape until the tape has in its range the selected altitude. While the selected altitude isn't in the +/- 300 ft range a black box indicate the selected altitude above the altitude tape. This box disappear when the indicated altitude is +/- 100 ft of selected altitude.

=== Vertical speed indicator===
The vertical speed indicator is on the right just near the altitude tape, and is graduated with major ticks every 1000 ft/min, and minor ticks every 500 ft/min. 
A black pointer containing the vertical speed with 10 ft/min precision moves along the non-moving tape. If the vertical speed exceeds +/- 4500 ft/min the pointer is locked to the upper/lower of the non-moving tape, and the vertical speed is detailed inside the pointer.

=== Attitude indicator===
Pitch scale is graduated 10° up to 80°, with minor marks 5° interval up to 25°, and every 2.5° below 20° pitch. The horizon line is part of the pitch scale, and represents a pitch of 0°. 
The roll scale is the 120° arc. The inverted triangle represents 0° roll. Major ticks represent 30° and 60°, minor ticks represent 10°, 20° and 45°. 
The slip skid indicator is the bar beneath the roll pointer. The Slip Skid indicator moves laterally away from the pointer to indicate the lateral acceleration.

=== Horizontal situation indicator===
The HSI displays a rotating compass card in a heading-up orientation. Letters indicate the cardinal points and numeric labels occur every 30°. 
Major tick marks are at 10° intervals and minor tick marks at 5° intervals. 
A digital reading of the current heading appears on top of the HSI, and the current track is represented on the HSI by a magenta diamond bug. 
The HSI also presents turn rate, course deviation, bearing, and navigation source information.

==== Course Deviation Indicator ====
The HSI contains a Course Deviation Indicator (CDI) with course pointer, TO/FROM indication and a sliding deviation bar. 
GPS, VOR1 and LOC1 have single line arrow, while VOR2 and LOC2 have two lines arrow. 
GPS CDI is available only if a course has been set via the route manager, VOR and LOC show arrow when the active NAVAID is received.

==== Adjust heading ====
Turn the <code>HDG</code> knob to adjust the heading, doing so the heading bug will be positionned along the compass. 
A window showing the desired heading is shown for 3 seconds.
==== Adjust selected course ====
Turn the <code>CRS</code> knob to adjust the desired course for VOR and LOC

== Radios ==
=== NAV ===
NAV stack is on the left on each device. It is composed by
* 1 switch button
* 1 tuning knob
* 1 display with 4 frequencies

Frequencies are organized like this
<source>
standby NAV1 | active NAV1
standby NAV2 | active NAV2
</source>

The tuning is done on the selected NAV which is the one with the standby frequency in blue. The tuning step is 0.25 MHz (or 1.00 MHz with the use of {{Key press|shift}}) in the range 108.00 to 118.00 MHz

=== COMM ===
The COMM stack is on the right side on each device. It is composed by
* 1 switch button
* 1 tuning knob
* 1 display with 4 frequencies

The frequencies are displayed as follow:
<source>
active COMM1 | standby COMM1
active COMM2 | standby COMM2
</source>

The tuning frequency is the one in blue, the step is 0.025 MHz (0.500 Mhz using {{Key press|shift}}) from 118.025 to 123.975 MHz

== EIS ==

== Flight Management ==
=== Maps ===
The map content can be modified by using <code>INSET</code> softkey on PFD, and <code>MAP</code> softkey on MFD, then by activating or de-activating each layer. 

The map orientation and zoom can be modified by pressing the <code>MENU</code> button. 
[[File:Zkv1000-mapmenu.png|Map orientation and zoom configuration]] 
The zoom level is an number between 7 (largest range) to 13 (smallest range). The range calculation depends on two other factors: latitude and size of the screen (eg. EIS size). Here's a table for ranges without EIS and for 40° lat: 
{| class="wikitable"
|-
! Zoom index !! Approximative range of Y axis, in NM
|-
| 7 || 194
|-
| 8 || 97
|-
| 9 || 49
|-
| 10 || 24
|-
| 11 || 12
|-
| 12 || 6
|-
| 13 || 3
|}
Four orientations are available:
* <code>NORTH UP</code>: in this configuration the aircraft symbol rotates, the map is aligned with North up
* <code>TRK UP</code> (''Track Up''): if aircraft is on the ground the aircraft symbol doesn't rotates and is up, map rotates to represent the heading of the airplane. Airborn, the top of the map is aligned with the current ground track.
* <code>DTK UP</code> (''Desired Track Up''): alignes the map with the desired course (only available if desired course has been set)
* <code>HDG UP</code> (''Heading Up''): the top of the map is the current heading of the aircraft
When the desired zoom and orientation are selected, validate by pressing <code>ENT</code> button. Pressing the <code>CLR</code> exit the modification window without saving the changes. 
==== Terrain ====
You have to choose the map background you want to be displayed. For this you have to use the options in your <code>.fgfsrc</code>. This is subject to change in near future in order to allow to change the maps while the device is running. For now there are some options to tells the zkv1000 which map you want: 
[[File:Zkv1000-wikimedia.org.png|thumb|LFBT - tiles from maps.wikimedia.org]]
* without any configuration (default settings), tiles from [https://www.wikimedia.org/wiki/Maps wikimedia.org]
 

[[File:Zkv1000-thunderforest.png|thumb|LFBT tiles from thunderforest.com (registration needed)]]
* If some more information are needed in URL (as registration key) you may want to use the <code>/sim/online-tiles-apikey</code> property
<source>--prop:/sim/online-tiles-server=tile.thunderforest.com
--prop:/sim/online-tiles-type=landscape
--prop:/sim/online-tiles-apikey=?apikey=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</source>
 
[[File:Zkv1000-opentopomap.png|thumb|LFBT - tiles from opentopomap]]
* If there is no specific "type", please affect <code>/</code> char to property <code>/sim/online-tiles-type</code>
<source>--prop:/sim/online-tiles-server=a.tile.opentopomap.org
--prop:/sim/online-tiles-type=/</source>
 
[[File:Zkv1000-ign.png|thumb|LFBT - tiles from ign.fr (covering France only)]]
* If the URL can't be easily standardized, you can create you own template with property <code>/sim/online-tiles-template</code>, you can use some tags from properties as <code>{server}</code>, <code>{type}</code> and <code>{format}</code>, where values come from respectively <code>/sim/online-tiles-server</code>, <code>/sim/online-tiles-type</code> and <code>/sim/online-tiles-format</code>:
(maps covering only France) 
<source>--prop:/sim/online-tiles-server=wxs.ign.fr
--prop:/sim/online-tiles-type=GEOGRAPHICALGRIDSYSTEMS.MAPS.SCAN-OACI
--prop:/sim/online-tiles-format=jpeg
--prop:/sim/online-tiles-template=https://{server}/an7nvfzojv5wa96dsga5nk8w/geoportail/wmts?layer={type}&style=normal&tilematrixset=PM&Service=WMTS&Request=GetTile&Version=1.0.</source>
 
* By default, protocol is <code>https</code>, so if you need <code>http</code> you'll need to use <code>/sim/online-tiles-template</code> (The follwing example doesn't display anything, tiles are empty around LFBT, need to investigate a bit) 
<source>--prop:/sim/online-tiles-server=1.tile.maps.openaip.net
--prop:/sim/online-tiles-type=EPSG:900913@png
--prop:/sim/online-tiles-template=http://{server}/geowebcache/service/tms/1.0.0/openaip_basemap@{type}/{z}/{x}/{y}.png</source>
 

==== NavAids ====
(screenshots to come as soon as the highlighting system will be repaired)
By default the navaids around the aircraft are shown on the map (airports, VOR & TACAN, NDB)
===== Nearest Navaids =====
(screenshots to come as soon as the highlighting system will be repaired)

By turning the MFD Outer FMS knob you enter in menu system, turn the Outer FMS knob to select the NRST page. The available nearest navaids searches are in light-blue chars, the grey entries aren't available for now.

As the day of writing, here are the available searches:
* NEAREST AIRPORTS
* NEAREST INTERSECTIONS
* NEAREST NDB
* NEAREST VOR

Select the desired search by turning the Inner FMS knob, and validate your choice by pressing the ENT button. The navaids available in a range of 100NM are listed, one by line, the second line contains the distance and course from the aircraft to the navaids. You can select by turning the Inner FMS knob and validate your choice by pressing the ENT button.

You can have information about the selected navaid by pressing the ENT button.
For radios navaids it include frequencies, coordinates, complete name, eventually range if the data is available.
For airports the information include name, coordinates, frequencies, runways (eventually with ILS frequencies)

In near future it will be possible to compute a DTO, or include the navaid in an existing flightplan, but for now these features aren't yet released...

The scrolling feature isn't really well managed, and there are some nasty things displayed, but a go-to-bottom then go-up correct it in most of the cases

==== Route ====
==== TCAS ====
Traffic announciator is shown as there is a traffic in sight, until there is no traffic at all
==== Topography ====
==== Inset map ====

=== Menus ===
==== Set screen brightness and body lighting ====
(screenshots to come one as soon as the highlighting system has been repaired)

On PFD without other windows opened, click on MENU key in order to make the System Settings windows displayed. You can use Inner FMS knob to adjust the brightness of the screen percent by percent from 0% which is very low, to 100% which is adapted to very shiny conditions.

During night, you can also make the ZKV1000 body being lighted (keys, softkeys and knobs descriptions). To do so, select the Light using Outer FMS knob, and adjust the lighting with the INner FMS knob. There are four level, from 0 which is light off, to 3 which is very luminous. Adjust to the level you are the most comfortable.

Using MENU or CLR key close the window.

The settings aren't stored for future flight sessions

==== Checklists ====
(screenshots to come as soon as the highlighting system will be repaired)

If the aircraft provides checklists, they can be visualized directly on the MFD.

To show checklists, press the softkey CHKLIST (which is available only if aircraft has at least one checklist). The checklists are divided into two groups:
* emergency checklists
* all the others

The emergency checklists are accessible by pressing the EMERGCY softkey. This will present a list of checklist if there are multiple checklists, or directly the emergency playlist if there is only one.

The other checklists may be divided by groups of checklists, in this case the group are shown then you can select using Inner or Outer FMS knob the desired group of chekclists, valid your choice by pressing the ENT button. Then another list will be displayed then you can select the desired checklist with Outer or Inner FMS knob, and valid your choice by pressing the ENT button. If there is no groups of checklists, the list of available non-emergency checklists are displayed. Select by using Inner or Outer FMS knob, and valid your choice by pressing ENT button.

A checklist may have more than one page, to navigate into the pages select NEXT or PREVIOUS and validate by pressing ENT button.

To exit a checklist, or selection of checklist, just press the CLR button.

=== Transponder ===

[[Category:Zkv1000|User guide]]

User:Zakharov/zkv1000 user guide

2020-04-30T15:31:25Z

Zakharov:

== Introduction ==
The zkv1000 is an instrument which concentrates some other instruments in only one single and simple interface. It is largely inspired from the famous display parts of Garmin Primus 1000. Once said, the zkv1000 is definitively *not* a exact replica of the Garmin Primus 1000, and isn't intended to be one. Sorry about that. 
Depending of your aircraft you may have in your cockpit different configurations, and some unavailable entries. Even we are ina sim, so there is no limit in the way to get full instrumented glide plane it may be interesting to limit the use of certain functions depending of the aircraft. This has to checked with the aircraft maintainer, or if you feel free with the GPL licence you may modify the aircraft to get the desired functions to work (see installation guide) 
=== Overview ===
There is two devices for now: MFD and PFD. You may find in your aircraft a configuration with only one of those, one of each or one MFD and two PFD. But there may be other configurations if the aircraft maintainer has decided it.

==== PFD ====
[[File:Zkv1000-PFD-global.png|thumb|zkv1000 PFD overview]]
 
==== MFD ====
[[File:Zkv1000-MFD-global.png|thumb|zkv1000 MFD overview]]
 
=== Softkeys codes ===
[[File:Zkv1000-available_softkeys.png]] BrightWhite on Black : available menu entry. Grey on Black : not yet implemented entry or not available in this aircraft Black : no entry 
[[File:Zkv1000-active-softkey.png]] Black on White : activated entry 

=== UI code and usage ===
[[File:Zkv1000-available_menus.png]] 
Selected entry is in Black on LightBlue 
[[File:Zkv1000-selectable-items.png|selectable items]] entries with marks <code><</code> or <code>></code> or both are entries with limited number of choices. First choice doesn't show the <code><</code> char, last one doesn't show the <code>></code> char. All other show both <code><</code> and <code>></code> 
Navigate from an entry to the next or the previous by turning the large FMS knob, modify the value of the entry by turning the small FMS knob. 

== Flight Instruments ==
=== Airspeed indicator ===
The indicated airspeed tape is in knots and can show up to 1000 knots. The black pointer shows the current IAS. 
On the tape major ticks are shown at 10 knots interval, minor ticks at 5 knots interval. A pink trend vector shows the estimated speed in the next 6 seconds (in the limit of +/- 30 knots). 
There may be some Vspeeds marks (pink, text in white) specific to the aircraft (cf installation guide). It is possible to modify these values of the Vspeeds references by using the softkeys menu TMR/REF which make a window appear in the right down corner of the screen, and then navigating to the value to change it as described in UI code and usage chapter. 
The black pointer will take a red color if IAS exceeds the defined Vne. 
The true airspeed is shown under the speed tape, and the ground speed. Both are in knots. 
If the device is configured with stall angle of attack (see installation guide) then the softkeys menus <code>PFD > AOA/WIND > AOA ON</code> shows up a window just near the airspeed tape. This indicates the current normalized angle of attack, a LightBlue mark shows the best normalized angle of attack for approach. 
The softkey menu <code>PFD > AOA/WIND > AOA AUTO</code> make the AoA indicator showing up automagically if the gears are down and flaps out. 
The softkey menu <code>PFD > AOA/WIND > WIND > OPTN1</code> shows up the direction of the wind relative to the aircraft (heading and speed) 
The softkey menu <code>PFD > AOA/WIND > WIND > OPTN2</code> shows up the direction of the wind with front and cross wind components 
The softkey menu <code>PFD > AOA/WIND > WIND > OFF</code> hides the wind indicator window. 

=== Altitude indicator ===
The altitude tape is in feet, and shows from -990ft to 99990ft. The black pointer shows the current indicated altitude (determined from the air pressure), 20ft graduated. A trend vector indicates the readched altitude in the next 6 seconds in the limit of +/- 300ft. 
The barometric setting is shwon just under the altitude tape. It is graduated in inHg by default, but this can be modified to hPa using the softkey menu <code>PFD > HPA</code>, and back to inHg via menu <code>PFD > IN</code>. The setting to standard barometric value (29.92inHg or 1023hPa) can be automatically set by the menu <code>PFD > STD BARO</code>. The barometer setting is essential and can be done by turning the BARO knob in front of the device (left side, under the COMM knob). 
The selected altitude is indicated by a lightblue bug along the altitude tape. It is blocked at the upper or lower corner of the tape until the tape has in its range the selected altitude. While the selected altitude isn't in the +/- 300 ft range a black box indicate the selected altitude above the altitude tape. This box disappear when the indicated altitude is +/- 100 ft of selected altitude.

=== Vertical speed indicator===
The vertical speed indicator is on the right just near the altitude tape, and is graduated with major ticks every 1000 ft/min, and minor ticks every 500 ft/min. 
A black pointer containing the vertical speed with 10 ft/min precision moves along the non-moving tape. If the vertical speed exceeds +/- 4500 ft/min the pointer is locked to the upper/lower of the non-moving tape, and the vertical speed is detailed inside the pointer.

=== Attitude indicator===
Pitch scale is graduated 10° up to 80°, with minor marks 5° interval up to 25°, and every 2.5° below 20° pitch. The horizon line is part of the pitch scale, and represents a pitch of 0°. 
The roll scale is the 120° arc. The inverted triangle represents 0° roll. Major ticks represent 30° and 60°, minor ticks represent 10°, 20° and 45°. 
The slip skid indicator is the bar beneath the roll pointer. The Slip Skid indicator moves laterally away from the pointer to indicate the lateral acceleration.

=== Horizontal situation indicator===
The HSI displays a rotating compass card in a heading-up orientation. Letters indicate the cardinal points and numeric labels occur every 30°. 
Major tick marks are at 10° intervals and minor tick marks at 5° intervals. 
A digital reading of the current heading appears on top of the HSI, and the current track is represented on the HSI by a magenta diamond bug. 
The HSI also presents turn rate, course deviation, bearing, and navigation source information.

==== Course Deviation Indicator ====
The HSI contains a Course Deviation Indicator (CDI) with course pointer, TO/FROM indication and a sliding deviation bar. 
GPS, VOR1 and LOC1 have single line arrow, while VOR2 and LOC2 have two lines arrow. 
GPS CDI is available only if a course has been set via the route manager, VOR and LOC show arrow when the active NAVAID is received.

==== Adjust heading ====
Turn the <code>HDG</code> knob to adjust the heading, doing so the heading bug will be positionned along the compass. 
A window showing the desired heading is shown for 3 seconds.
==== Adjust selected course ====
Turn the <code>CRS</code> knob to adjust the desired course for VOR and LOC

== Radios ==
=== NAV ===
NAV stack is on the left on each device. It is composed by
* 1 switch button
* 1 tuning knob
* 1 display with 4 frequencies

Frequencies are organized like this
<source>
standby NAV1 | active NAV1
standby NAV2 | active NAV2
</source>

The tuning is done on the selected NAV which is the one with the standby frequency in blue. The tuning step is 0.25 MHz (or 1.00 MHz with the use of {{Key press|shift}}) in the range 108.00 to 118.00 MHz

=== COMM ===
The COMM stack is on the right side on each device. It is composed by
* 1 switch button
* 1 tuning knob
* 1 display with 4 frequencies

The frequencies are displayed as follow:
<source>
active COMM1 | standby COMM1
active COMM2 | standby COMM2
</source>

The tuning frequency is the one in blue, the step is 0.025 MHz (0.500 Mhz using {{Key press|shift}}) from 118.025 to 123.975 MHz

== EIS ==

== Flight Management ==
=== Maps ===
The map content can be modified by using <code>INSET</code> softkey on PFD, and <code>MAP</code> softkey on MFD, then by activating or de-activating each layer. 

The map orientation and zoom can be modified by pressing the <code>MENU</code> button. 
[[File:Zkv1000-mapmenu.png|Map orientation and zoom configuration]] 
The zoom level is an number between 7 (largest range) to 13 (smallest range). The range calculation depends on two other factors: latitude and size of the screen (eg. EIS size). Here's a table for ranges without EIS and for 40° lat: 
{| class="wikitable"
|-
! Zoom index !! Approximative range of Y axis, in NM
|-
| 7 || 194
|-
| 8 || 97
|-
| 9 || 49
|-
| 10 || 24
|-
| 11 || 12
|-
| 12 || 6
|-
| 13 || 3
|}
Four orientations are available:
* <code>NORTH UP</code>: in this configuration the aircraft symbol rotates, the map is aligned with North up
* <code>TRK UP</code> (''Track Up''): if aircraft is on the ground the aircraft symbol doesn't rotates and is up, map rotates to represent the heading of the airplane. Airborn, the top of the map is aligned with the current ground track.
* <code>DTK UP</code> (''Desired Track Up''): alignes the map with the desired course (only available if desired course has been set)
* <code>HDG UP</code> (''Heading Up''): the top of the map is the current heading of the aircraft
When the desired zoom and orientation are selected, validate by pressing <code>ENT</code> button. Pressing the <code>CLR</code> exit the modification window without saving the changes. 
==== Terrain ====
You have to choose the map background you want to be displayed. For this you have to use the options in your <code>.fgfsrc</code>. This is subject to change in near future in order to allow to change the maps while the device is running. For now there are some options to tells the zkv1000 which map you want: 
[[File:Zkv1000-wikimedia.org.png|thumb|LFBT - tiles from maps.wikimedia.org]]
* without any configuration (default settings), tiles from [https://www.wikimedia.org/wiki/Maps wikimedia.org]
 

[[File:Zkv1000-thunderforest.png|thumb|LFBT tiles from thunderforest.com (registration needed)]]
* If some more information are needed in URL (as registration key) you may want to use the <code>/sim/online-tiles-apikey</code> property
<source>--prop:/sim/online-tiles-server=tile.thunderforest.com
--prop:/sim/online-tiles-type=landscape
--prop:/sim/online-tiles-apikey=?apikey=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</source>
 
[[File:Zkv1000-opentopomap.png|thumb|LFBT - tiles from opentopomap]]
* If there is no specific "type", please affect <code>/</code> char to property <code>/sim/online-tiles-type</code>
<source>--prop:/sim/online-tiles-server=a.tile.opentopomap.org
--prop:/sim/online-tiles-type=/</source>
 
[[File:Zkv1000-ign.png|thumb|LFBT - tiles from ign.fr (covering France only)]]
* If the URL can't be easily standardized, you can create you own template with property <code>/sim/online-tiles-template</code>, you can use some tags from properties as <code>{server}</code>, <code>{type}</code> and <code>{format}</code>, where values come from respectively <code>/sim/online-tiles-server</code>, <code>/sim/online-tiles-type</code> and <code>/sim/online-tiles-format</code>:
(maps covering only France) 
<source>--prop:/sim/online-tiles-server=wxs.ign.fr
--prop:/sim/online-tiles-type=GEOGRAPHICALGRIDSYSTEMS.MAPS.SCAN-OACI
--prop:/sim/online-tiles-format=jpeg
--prop:/sim/online-tiles-template=https://{server}/an7nvfzojv5wa96dsga5nk8w/geoportail/wmts?layer={type}&style=normal&tilematrixset=PM&Service=WMTS&Request=GetTile&Version=1.0.</source>
 
* By default, protocol is <code>https</code>, so if you need <code>http</code> you'll need to use <code>/sim/online-tiles-template</code> (The follwing example doesn't display anything, tiles are empty around LFBT, need to investigate a bit) 
<source>--prop:/sim/online-tiles-server=1.tile.maps.openaip.net
--prop:/sim/online-tiles-type=EPSG:900913@png
--prop:/sim/online-tiles-template=http://{server}/geowebcache/service/tms/1.0.0/openaip_basemap@{type}/{z}/{x}/{y}.png</source>
 

==== NavAids ====
===== Nearest Navaids =====
(screenshots to come as soon as the highlighting system will be repaired)

By turning the MFD Outer FMS knob you enter in menu system, turn the Outer FMS knob to select the NRST page. The available nearest navaids searches are in light-blue chars, the grey entries aren't available for now.

As the day of writing, here are the available searches:
* NEAREST AIRPORTS
* NEAREST INTERSECTIONS
* NEAREST NDB
* NEAREST VOR

Select the desired search by turning the Inner FMS knob, and validate your choice by pressing the ENT button. The navaids available in a range of 100NM are listed, one by line, the second line contains the distance and course from the aircraft to the navaids. You can select by turning the Inner FMS knob and validate your choice by pressing the ENT button.

You can have information about the selected navaid by pressing the ENT button.
For radios navaids it include frequencies, coordinates, complete name, eventually range if the data is available.
For airports the information include name, coordinates, frequencies, runways (eventually with ILS frequencies)

In near future it will be possible to compute a DTO, or include the navaid in an existing flightplan, but for now these features aren't yet released...

The scrolling feature isn't really well managed, and there are some nasty things displayed, but a go-to-bottom then go-up correct it in most of the cases

==== Route ====
==== TCAS ====
Traffic announciator is shown as there is a traffic in sight, until there is no traffic at all
==== Topography ====
==== Inset map ====

=== Menus ===
==== Set screen brightness and body lighting ====
(screenshots to come one as soon as the highlighting system has been repaired)

On PFD without other windows opened, click on MENU key in order to make the System Settings windows displayed. You can use Inner FMS knob to adjust the brightness of the screen percent by percent from 0% which is very low, to 100% which is adapted to very shiny conditions.

During night, you can also make the ZKV1000 body being lighted (keys, softkeys and knobs descriptions). To do so, select the Light using Outer FMS knob, and adjust the lighting with the INner FMS knob. There are four level, from 0 which is light off, to 3 which is very luminous. Adjust to the level you are the most comfortable.

Using MENU or CLR key close the window.

The settings aren't stored for future flight sessions

==== Checklists ====
(screenshots to come as soon as the highlighting system will be repaired)

If the aircraft provides checklists, they can be visualized directly on the MFD.

To show checklists, press the softkey CHKLIST (which is available only if aircraft has at least one checklist). The checklists are divided into two groups:
* emergency checklists
* all the others

The emergency checklists are accessible by pressing the EMERGCY softkey. This will present a list of checklist if there are multiple checklists, or directly the emergency playlist if there is only one.

The other checklists may be divided by groups of checklists, in this case the group are shown then you can select using Inner or Outer FMS knob the desired group of chekclists, valid your choice by pressing the ENT button. Then another list will be displayed then you can select the desired checklist with Outer or Inner FMS knob, and valid your choice by pressing the ENT button. If there is no groups of checklists, the list of available non-emergency checklists are displayed. Select by using Inner or Outer FMS knob, and valid your choice by pressing ENT button.

A checklist may have more than one page, to navigate into the pages select NEXT or PREVIOUS and validate by pressing ENT button.

To exit a checklist, or selection of checklist, just press the CLR button.

=== Transponder ===

[[Category:Zkv1000|User guide]]

User:Zakharov/zkv1000 user guide

2020-04-30T15:17:10Z

Zakharov: /* Menus */

== Introduction ==
The zkv1000 is an instrument which concentrates some other instruments in only one single and simple interface. It is largely inspired from the famous display parts of Garmin Primus 1000. Once said, the zkv1000 is definitively *not* a exact replica of the Garmin Primus 1000, and isn't intended to be one. Sorry about that. 
Depending of your aircraft you may have in your cockpit different configurations, and some unavailable entries. Even we are ina sim, so there is no limit in the way to get full instrumented glide plane it may be interesting to limit the use of certain functions depending of the aircraft. This has to checked with the aircraft maintainer, or if you feel free with the GPL licence you may modify the aircraft to get the desired functions to work (see installation guide) 
=== Overview ===
There is two devices for now: MFD and PFD. You may find in your aircraft a configuration with only one of those, one of each or one MFD and two PFD. But there may be other configurations if the aircraft maintainer has decided it.

==== PFD ====
[[File:Zkv1000-PFD-global.png|thumb|zkv1000 PFD overview]]
 
==== MFD ====
[[File:Zkv1000-MFD-global.png|thumb|zkv1000 MFD overview]]
 
=== Softkeys codes ===
[[File:Zkv1000-available_softkeys.png]] BrightWhite on Black : available menu entry. Grey on Black : not yet implemented entry or not available in this aircraft Black : no entry 
[[File:Zkv1000-active-softkey.png]] Black on White : activated entry 

=== UI code and usage ===
[[File:Zkv1000-available_menus.png]] 
Selected entry is in Black on LightBlue 
[[File:Zkv1000-selectable-items.png|selectable items]] entries with marks <code><</code> or <code>></code> or both are entries with limited number of choices. First choice doesn't show the <code><</code> char, last one doesn't show the <code>></code> char. All other show both <code><</code> and <code>></code> 
Navigate from an entry to the next or the previous by turning the large FMS knob, modify the value of the entry by turning the small FMS knob. 

== Flight Instruments ==
=== Airspeed indicator ===
The indicated airspeed tape is in knots and can show up to 1000 knots. The black pointer shows the current IAS. 
On the tape major ticks are shown at 10 knots interval, minor ticks at 5 knots interval. A pink trend vector shows the estimated speed in the next 6 seconds (in the limit of +/- 30 knots). 
There may be some Vspeeds marks (pink, text in white) specific to the aircraft (cf installation guide). It is possible to modify these values of the Vspeeds references by using the softkeys menu TMR/REF which make a window appear in the right down corner of the screen, and then navigating to the value to change it as described in UI code and usage chapter. 
The black pointer will take a red color if IAS exceeds the defined Vne. 
The true airspeed is shown under the speed tape, and the ground speed. Both are in knots. 
If the device is configured with stall angle of attack (see installation guide) then the softkeys menus <code>PFD > AOA/WIND > AOA ON</code> shows up a window just near the airspeed tape. This indicates the current normalized angle of attack, a LightBlue mark shows the best normalized angle of attack for approach. 
The softkey menu <code>PFD > AOA/WIND > AOA AUTO</code> make the AoA indicator showing up automagically if the gears are down and flaps out. 
The softkey menu <code>PFD > AOA/WIND > WIND > OPTN1</code> shows up the direction of the wind relative to the aircraft (heading and speed) 
The softkey menu <code>PFD > AOA/WIND > WIND > OPTN2</code> shows up the direction of the wind with front and cross wind components 
The softkey menu <code>PFD > AOA/WIND > WIND > OFF</code> hides the wind indicator window. 

=== Altitude indicator ===
The altitude tape is in feet, and shows from -990ft to 99990ft. The black pointer shows the current indicated altitude (determined from the air pressure), 20ft graduated. A trend vector indicates the readched altitude in the next 6 seconds in the limit of +/- 300ft. 
The barometric setting is shwon just under the altitude tape. It is graduated in inHg by default, but this can be modified to hPa using the softkey menu <code>PFD > HPA</code>, and back to inHg via menu <code>PFD > IN</code>. The setting to standard barometric value (29.92inHg or 1023hPa) can be automatically set by the menu <code>PFD > STD BARO</code>. The barometer setting is essential and can be done by turning the BARO knob in front of the device (left side, under the COMM knob). 
The selected altitude is indicated by a lightblue bug along the altitude tape. It is blocked at the upper or lower corner of the tape until the tape has in its range the selected altitude. While the selected altitude isn't in the +/- 300 ft range a black box indicate the selected altitude above the altitude tape. This box disappear when the indicated altitude is +/- 100 ft of selected altitude.

=== Vertical speed indicator===
The vertical speed indicator is on the right just near the altitude tape, and is graduated with major ticks every 1000 ft/min, and minor ticks every 500 ft/min. 
A black pointer containing the vertical speed with 10 ft/min precision moves along the non-moving tape. If the vertical speed exceeds +/- 4500 ft/min the pointer is locked to the upper/lower of the non-moving tape, and the vertical speed is detailed inside the pointer.

=== Attitude indicator===
Pitch scale is graduated 10° up to 80°, with minor marks 5° interval up to 25°, and every 2.5° below 20° pitch. The horizon line is part of the pitch scale, and represents a pitch of 0°. 
The roll scale is the 120° arc. The inverted triangle represents 0° roll. Major ticks represent 30° and 60°, minor ticks represent 10°, 20° and 45°. 
The slip skid indicator is the bar beneath the roll pointer. The Slip Skid indicator moves laterally away from the pointer to indicate the lateral acceleration.

=== Horizontal situation indicator===
The HSI displays a rotating compass card in a heading-up orientation. Letters indicate the cardinal points and numeric labels occur every 30°. 
Major tick marks are at 10° intervals and minor tick marks at 5° intervals. 
A digital reading of the current heading appears on top of the HSI, and the current track is represented on the HSI by a magenta diamond bug. 
The HSI also presents turn rate, course deviation, bearing, and navigation source information.

==== Course Deviation Indicator ====
The HSI contains a Course Deviation Indicator (CDI) with course pointer, TO/FROM indication and a sliding deviation bar. 
GPS, VOR1 and LOC1 have single line arrow, while VOR2 and LOC2 have two lines arrow. 
GPS CDI is available only if a course has been set via the route manager, VOR and LOC show arrow when the active NAVAID is received.

==== Adjust heading ====
Turn the <code>HDG</code> knob to adjust the heading, doing so the heading bug will be positionned along the compass. 
A window showing the desired heading is shown for 3 seconds.
==== Adjust selected course ====
Turn the <code>CRS</code> knob to adjust the desired course for VOR and LOC

== Radios ==
=== NAV ===
NAV stack is on the left on each device. It is composed by
* 1 switch button
* 1 tuning knob
* 1 display with 4 frequencies

Frequencies are organized like this
<source>
standby NAV1 | active NAV1
standby NAV2 | active NAV2
</source>

The tuning is done on the selected NAV which is the one with the standby frequency in blue. The tuning step is 0.25 MHz (or 1.00 MHz with the use of {{Key press|shift}}) in the range 108.00 to 118.00 MHz

=== COMM ===
The COMM stack is on the right side on each device. It is composed by
* 1 switch button
* 1 tuning knob
* 1 display with 4 frequencies

The frequencies are displayed as follow:
<source>
active COMM1 | standby COMM1
active COMM2 | standby COMM2
</source>

The tuning frequency is the one in blue, the step is 0.025 MHz (0.500 Mhz using {{Key press|shift}}) from 118.025 to 123.975 MHz

== EIS ==

== Flight Management ==
=== Maps ===
The map content can be modified by using <code>INSET</code> softkey on PFD, and <code>MAP</code> softkey on MFD, then by activating or de-activating each layer. 

The map orientation and zoom can be modified by pressing the <code>MENU</code> button. 
[[File:Zkv1000-mapmenu.png|Map orientation and zoom configuration]] 
The zoom level is an number between 7 (largest range) to 13 (smallest range). The range calculation depends on two other factors: latitude and size of the screen (eg. EIS size). Here's a table for ranges without EIS and for 40° lat: 
{| class="wikitable"
|-
! Zoom index !! Approximative range of Y axis, in NM
|-
| 7 || 194
|-
| 8 || 97
|-
| 9 || 49
|-
| 10 || 24
|-
| 11 || 12
|-
| 12 || 6
|-
| 13 || 3
|}
Four orientations are available:
* <code>NORTH UP</code>: in this configuration the aircraft symbol rotates, the map is aligned with North up
* <code>TRK UP</code> (''Track Up''): if aircraft is on the ground the aircraft symbol doesn't rotates and is up, map rotates to represent the heading of the airplane. Airborn, the top of the map is aligned with the current ground track.
* <code>DTK UP</code> (''Desired Track Up''): alignes the map with the desired course (only available if desired course has been set)
* <code>HDG UP</code> (''Heading Up''): the top of the map is the current heading of the aircraft
When the desired zoom and orientation are selected, validate by pressing <code>ENT</code> button. Pressing the <code>CLR</code> exit the modification window without saving the changes. 
==== Terrain ====
You have to choose the map background you want to be displayed. For this you have to use the options in your <code>.fgfsrc</code>. This is subject to change in near future in order to allow to change the maps while the device is running. For now there are some options to tells the zkv1000 which map you want: 
[[File:Zkv1000-wikimedia.org.png|thumb|LFBT - tiles from maps.wikimedia.org]]
* without any configuration (default settings), tiles from [https://www.wikimedia.org/wiki/Maps wikimedia.org]
 

[[File:Zkv1000-thunderforest.png|thumb|LFBT tiles from thunderforest.com (registration needed)]]
* If some more information are needed in URL (as registration key) you may want to use the <code>/sim/online-tiles-apikey</code> property
<source>--prop:/sim/online-tiles-server=tile.thunderforest.com
--prop:/sim/online-tiles-type=landscape
--prop:/sim/online-tiles-apikey=?apikey=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</source>
 
[[File:Zkv1000-opentopomap.png|thumb|LFBT - tiles from opentopomap]]
* If there is no specific "type", please affect <code>/</code> char to property <code>/sim/online-tiles-type</code>
<source>--prop:/sim/online-tiles-server=a.tile.opentopomap.org
--prop:/sim/online-tiles-type=/</source>
 
[[File:Zkv1000-ign.png|thumb|LFBT - tiles from ign.fr (covering France only)]]
* If the URL can't be easily standardized, you can create you own template with property <code>/sim/online-tiles-template</code>, you can use some tags from properties as <code>{server}</code>, <code>{type}</code> and <code>{format}</code>, where values come from respectively <code>/sim/online-tiles-server</code>, <code>/sim/online-tiles-type</code> and <code>/sim/online-tiles-format</code>:
(maps covering only France) 
<source>--prop:/sim/online-tiles-server=wxs.ign.fr
--prop:/sim/online-tiles-type=GEOGRAPHICALGRIDSYSTEMS.MAPS.SCAN-OACI
--prop:/sim/online-tiles-format=jpeg
--prop:/sim/online-tiles-template=https://{server}/an7nvfzojv5wa96dsga5nk8w/geoportail/wmts?layer={type}&style=normal&tilematrixset=PM&Service=WMTS&Request=GetTile&Version=1.0.</source>
 
* By default, protocol is <code>https</code>, so if you need <code>http</code> you'll need to use <code>/sim/online-tiles-template</code> (The follwing example doesn't display anything, tiles are empty around LFBT, need to investigate a bit) 
<source>--prop:/sim/online-tiles-server=1.tile.maps.openaip.net
--prop:/sim/online-tiles-type=EPSG:900913@png
--prop:/sim/online-tiles-template=http://{server}/geowebcache/service/tms/1.0.0/openaip_basemap@{type}/{z}/{x}/{y}.png</source>
 

==== NavAids ====
==== Route ====
==== TCAS ====
Traffic announciator is shown as there is a traffic in sight, until there is no traffic at all
==== Topography ====
==== Inset map ====

=== Menus ===
==== Set screen brightness and body lighting ====
(screenshots to come one as soon as the highlighting system has been repaired)

On PFD without other windows opened, click on MENU key in order to make the System Settings windows displayed. You can use Inner FMS knob to adjust the brightness of the screen percent by percent from 0% which is very low, to 100% which is adapted to very shiny conditions.

During night, you can also make the ZKV1000 body being lighted (keys, softkeys and knobs descriptions). To do so, select the Light using Outer FMS knob, and adjust the lighting with the INner FMS knob. There are four level, from 0 which is light off, to 3 which is very luminous. Adjust to the level you are the most comfortable.

Using MENU or CLR key close the window.

The settings aren't stored for future flight sessions

==== Checklists ====
(screenshots to come as soon as the highlighting system will be repaired)

If the aircraft provides checklists, they can be visualized directly on the MFD.

To show checklists, press the softkey CHKLIST (which is available only if aircraft has at least one checklist). The checklists are divided into two groups:
* emergency checklists
* all the others

The emergency checklists are accessible by pressing the EMERGCY softkey. This will present a list of checklist if there are multiple checklists, or directly the emergency playlist if there is only one.

The other checklists may be divided by groups of checklists, in this case the group are shown then you can select using Inner or Outer FMS knob the desired group of chekclists, valid your choice by pressing the ENT button. Then another list will be displayed then you can select the desired checklist with Outer or Inner FMS knob, and valid your choice by pressing the ENT button. If there is no groups of checklists, the list of available non-emergency checklists are displayed. Select by using Inner or Outer FMS knob, and valid your choice by pressing ENT button.

A checklist may have more than one page, to navigate into the pages select NEXT or PREVIOUS and validate by pressing ENT button.

To exit a checklist, or selection of checklist, just press the CLR button.

=== Transponder ===

[[Category:Zkv1000|User guide]]

User:Zakharov/zkv1000 user guide

2020-04-30T15:02:03Z

Zakharov: /* Menus */

Complex Canvas avionics

2020-04-30T14:49:27Z

Zakharov: /* How to proceed */

{{Stub}}

== Background ==
{{See also|Canvas_News#Moving_map.2FRNAV_discussion}}
{{FGCquote
|1= The airspace system is in the process of changing drastically, and I'm following it this summer by finally biting the bullet and installing an IFR GPS (Garmin GTN 650) and ADS-B transponder (Garmin GTX 345) in my Piper Warrior II. What this means that for the first time in the 15 years since I started flying in real life, I won't be able to use FlightGear to practice the IFR approaches I'm flying in real life.
|2= {{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35924395/
|title = <nowiki> [Flightgear-devel] RFD: FlightGear and the changing state of air
navigation </nowiki>
|author = <nowiki> David Megginson </nowiki>
|date = Jul 3rd, 2017
|added = Jul 3rd, 2017
|script_version = 0.39
}}
}}

As of 09/2017, Stuart started making some tentative steps towards a full Garmin G1000 simulation, he started with the excellent xkv1000 as a starting point, particularly for the PFD which very closely mirrors the G1000.

For the MFD he's planning to use the [[Canvas MapStructure]] layers (obviously).
One area he is going to have to develop is tiled mapping, which the [[MapStructure]] in fgdata doesn't currently support as a layer.

Stuart's thoughts are:

# Create an OverlayLayer layer with a controller that is analogous to the SymbolLayer, but likely with a simple update method rather than SearchCmd, and no .symbol equivalent
# Convert the tiled map example from the wiki, but also other layers such as a compass rose, airport diagram, lat/lon grid.

Stuart is currently undecided on how to handle the projection - whether to have the layer itself have to interpret the centerpoint of the map and scale, and then make a projection itself, or to provide it from the Map. The latter in undoubtably cleaner, but for something like a tiled map he suspects that the management will need to be quite low down the stack.<ref>{{cite web
|url = https://forum.flightgear.org/viewtopic.php?p=317013#p317013
|title = <nowiki> Canvas G1000 </nowiki>
|author = <nowiki> stuart </nowiki>
|date = Aug 21st, 2017
|added = Aug 21st, 2017
|script_version = 0.40
}}</ref>

== Objective ==
Provide a summary of potential improvements to make the development of complex Canvas-based avionics feasible and better performing.

== Ideas ==

* Integrate Gijs' [[Canvas_Development#Background|projection handling patches]] (see [[Map]] dialog)
* [[Canvas_Development#Property_I.2FO_observations|reduce/speed up property I/O]]
* [[Howto:Vectorizing the Nasal setprop() API|Come up with new Nasal APIs for operating on Nasal vectors]] (setpropv/getpropv)
* [[Canvas_Development#Instancing|Implement support for symbol/element instancing]] (as per James' original comments)
* Use native C++ code for animation handling instead of dozens of Nasal timers/listeners per element
* Review Richard's MFD framework to make concepts like "screen", "page", "pageElement" first class concepts at the Canvas::Element/Canvas::Group level
* Equally look at some of the other MFD examples to see if generic building blocks can be extracted
* state management should probably be handled by the corresponding SimGear state machine code and not tons of custom Nasal code
* determine what may be missing in terms of new/optimized Canvas elements for special purposes (i.e. best using native C++ code instead of custom Nasal hacks), e.g.:
** [[Canvas_Sandbox#CanvasPDF|CanvasPDF]] - for EFBs
** [[Canvas_Sandbox#CanvasModel|Canvas3DModel]] - for visualizing airspaces

== Making an MFD ==

{{FGCquote
|1=
Note that this isn't just a matter of throwing up a canvas showing some GPS waypoints and a magenta line. Modern navigators are astoundingly-complex
devices — probably an order of magnitude more lines of code than FlightGear itself — and even their basic flight planning algorithms and databases (e.g. fly-by waypoints vs fly-over waypoints, open vs closed approach procedures, transitions into RNAV approaches, etc.) are far beyond the scope of anything we've tried, and we'd also need an up-to-date database far more complex than the ones we have now. Once you get to the extra features, like FIS-B weather or TIS-B traffic info over ADS-B, or TAWS (terrain alerting), we're probably in way over our heads trying to emulate even the simplest general-aviation IFR GPS.
|2= {{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35924395/
|title = <nowiki> [Flightgear-devel] RFD: FlightGear and the changing state of air
navigation </nowiki>
|author = <nowiki> David Megginson </nowiki>
|date = Jul 3rd, 2017
|added = Jul 3rd, 2017
|script_version = 0.39
}}
}}

{{FGCquote
|1=
As I tell my students in real life: Don't get intimidated or hypnotied by the huge number of features. 90% of the value comes from 10% of the features. Actually that's becoming more and more of an understatement. With rare exceptions, you can ignore the features you're not using. This is relevant to FG in the sense that it is not important to implement all the features. Most can be left out in the short term, and some can be left out forever.
|2= {{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35924414/
|title = <nowiki> Re: [Flightgear-devel] RFD: FlightGear and the changing state of
air navigation </nowiki>
|author = <nowiki> John Denker </nowiki>
|date = Jul 3rd, 2017
|added = Jul 3rd, 2017
|script_version = 0.39
}}
}}

{{FGCquote
|1= I think there has been some development in this area for some time, but it's not clear how complete it is in terms of going beyond a PFD displaying basic flight information digitally.
For example zakharov on the forum has been developing a Garmin G1000 clone called the zkv1000:
https://forum.flightgear.org/viewtopic.php?f=14&t=32056

The DA-42 model uses some form of G1000 as well - which may be an older version of the zkv1000.

I agree that this is something we need to address, as our GA aircraft will otherwise become more and more old-fashioned.

I'm more optimistic than David - I think we do have the capability to write this - for example just look at the complexity of the Shuttle model.
|2= {{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35925226/
|title = <nowiki> Re: [Flightgear-devel] RFD: FlightGear and the changing state of
air navigation </nowiki>
|author = <nowiki> Stuart Buchanan </nowiki>
|date = Jul 3rd, 2017
|added = Jul 3rd, 2017
|script_version = 0.39
}}
}}

== Navigation data ==
There's no public-domain source right now, so we'll have to make it happen somehow.<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35927346/
|title = <nowiki> Re: [Flightgear-devel] RFD: FlightGear and the changing state of
air navigation </nowiki>
|author = <nowiki> David Megginson </nowiki>
|date = Jul 4th, 2017
|added = Jul 4th, 2017
|script_version = 0.40
}}</ref>

we need some better data sources, especially with direct routing replacing airways in many areas, and having airspace data would help the map displays, but the current API is specifically designed to support G430, G1000 and similar class devices. Adding RNAV approaches is eminently doable, see the the RNavController base class which the GPS/FMS layer uses to allow new waypoint / route segments to define how they are flown and drive CDIs <ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35927598/
|title = <nowiki> Re: [Flightgear-devel] RFD: FlightGear and the changing state of
air navigation </nowiki>
|author = <nowiki> James Turner </nowiki>
|date = Jul 4th, 2017
|added = Jul 4th, 2017
|script_version = 0.40
}}</ref>

According to the Route Manager wiki page, we already have support for SID/STAR data provided from Navigraph, which is released on the AIRAC cycle, and costs a pretty small amount (9 EUR for a single download of FMS data, or 90 EUR per year) Given the relatively low cost, I don't think that we as an organiation want to get into trying to digitize data ourselves just to make it open-source or public domain. Particularly given the low cost of a download. We might want to digitize the STAR/SIDs for the default airport with each release so there are some approaches available for those who don't want to purchase the data. <ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35927426/
|title = <nowiki> Re: [Flightgear-devel] RFD: FlightGear and the changing state of
air navigation </nowiki>
|author = <nowiki> Stuart Buchanan </nowiki>
|date = Jul 4th, 2017
|added = Jul 4th, 2017
|script_version = 0.40
}}</ref>

== The G1000 & Canvas ==
Here's the list of main pages and how they would map:
# Map - We already have mapping solutions, and the canvas one would seem to get most of the way there
# Traffic - Again, we've already got AI objects displayed on in-sim maps, so this is done
# Terrain - Slightly trickier. Depending on the resolution required, we could do some terrain sampling and colour a canvas?
# Weather - This looks much more challenging. Not sure if we could do this.
# Default Nav - this is just some straightforward property display 6) Flight Plan - This is a UI interfacing the FG Route manager. Frankly, I suspect we'd probably just bring up the existing Route Manager dialog at this point, as entering a route via a simulated touchscreen doesn't sound like a fun way to spend a Sunday afternoon! :)
# Proc - Setting the STAR/SID to use. We already have this function in the Route Manager. There is an issue with getting the underlying data, though there are tools to upload Navigraph into the Route Manager.
# Nearest - This is just a lookup into our existing airport and fix DBs. So, I think most of the fundamentals are there - it's "just" a case of combining them into an instrument that mimics the GTN 650. <ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35927251/
|title = <nowiki> Re: [Flightgear-devel] RFD: FlightGear and the changing state of
air navigation </nowiki>
|author = <nowiki> Stuart Buchanan </nowiki>
|date = Jul 4th, 2017
|added = Jul 4th, 2017
|script_version = 0.40
}}</ref>

the buttonology is an important part of training, so we'll need to support that somehow (if we want to be used for IFR training). For the route manager, we might have to make some tweaks, including fly-by vs fly-over waypoints.<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35927346/
|title = <nowiki> Re: [Flightgear-devel] RFD: FlightGear and the changing state of
air navigation </nowiki>
|author = <nowiki> David Megginson </nowiki>
|date = Jul 4th, 2017
|added = Jul 4th, 2017
|script_version = 0.40
}}</ref>

Overall, the display doesn't have more than 50 unique parameters you need to update per cycle - for most pages significantly less. All the config pages have lots of items - but you only need to update them when they change. All the fancy airport and weather charts absolutely do not need updates per-frame - your airport isn't going anywhere or changing in a hurry - you can just draw the whole layer _once_ before you bring it on-screen and then use a global transform to move it as the plane moves and run lay updates on the edges. Precipitation you can update whenever FG updates precipitation (every few minutes). Most maps can be done as cheap raster images rather than vector data (the Saab Viggen just downloads them on the fly for instance). So yeah, it's a lot of work to code all these displays which someone has to do, but there's no reason to assume it'd be hopeless performance-wise.<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35926412/
|title = <nowiki> Re: [Flightgear-devel] RFD: FlightGear and the changing state of
air navigation </nowiki>
|author = <nowiki> Thorsten Renk </nowiki>
|date = Jul 4th, 2017
|added = Jul 4th, 2017
|script_version = 0.40
}}</ref>

after looking into the G1000 manual, it's Thorsten's considered opinion that it is possible to use canvas to render it with decent performance on mid-range modern hardware (not on 10 year old computers though), that I he has a decent picture how it needs to be organized and that the Shuttle MDU code (using Richard's framework to organize everything into pages and the optimization techniques we've learned to use for the pages themselves) exemplifies this<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35927242/
|title = <nowiki> Re: [Flightgear-devel] RFD: FlightGear and the changing state of
air navigation </nowiki>
|author = <nowiki> Thorsten Renk </nowiki>
|date = Jul 4th, 2017
|added = Jul 4th, 2017
|script_version = 0.40
}}</ref>

there's code examples and experience available. You can basically start by looking into Richard's MFD canvas wrapper and go from there.<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35927242/
|title = <nowiki> Re: [Flightgear-devel] RFD: FlightGear and the changing state of
air navigation </nowiki>
|author = <nowiki> Thorsten Renk </nowiki>
|date = Jul 4th, 2017
|added = Jul 4th, 2017
|script_version = 0.40
}}</ref>

The FG Route Manager provide the RNAV function (http://wiki.flightgear.org/Route_manager), plus logic to connect it as an autopilot source. Switching the CDI to an ILS at the end of the route is pretty straightforward: just put a Nasal listener on /route-manager/signals/finished and then check for a decent ILS signal. <ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35927251/
|title = <nowiki> Re: [Flightgear-devel] RFD: FlightGear and the changing state of
air navigation </nowiki>
|author = <nowiki> Stuart Buchanan </nowiki>
|date = Jul 4th, 2017
|added = Jul 4th, 2017
|script_version = 0.40
}}</ref>

there will be some tweaks requires for the Route Manager for fly-by, fly-over, those radius turn things. But that's really just an extension of what is already there.<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35927426/
|title = <nowiki> Re: [Flightgear-devel] RFD: FlightGear and the changing state of
air navigation </nowiki>
|author = <nowiki> Stuart Buchanan </nowiki>
|date = Jul 4th, 2017
|added = Jul 4th, 2017
|script_version = 0.40
}}</ref>

we already have a ton of this code - sids, stars, approaches, tagging missed approach segments, fly-over vs fly-by waypoints. <ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35927598/
|title = <nowiki> Re: [Flightgear-devel] RFD: FlightGear and the changing state of
air navigation </nowiki>
|author = <nowiki> James Turner </nowiki>
|date = Jul 4th, 2017
|added = Jul 4th, 2017
|script_version = 0.40
}}</ref>

== How to proceed ==
One thing Stuart pointed out is that, in the last couple of years, that aircraft development has moved on from being a "one man show" to being a team effort, with tightly knit teams working together to produce really high quality work. Examples are the updated c172p, Shuttle, J3Cub and probably many others. This is is a (very positive!) reaction to the amount of work required for high fidelity models, and has allowed much more rapid development, which has created a positive feedback loop, as well as allowing specialiation. That model seems to bode well for developing a complex system like this, and can develop organically.<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35927754/
|title = <nowiki> Re: [Flightgear-devel] RFD: FlightGear and the changing state of
air navigation </nowiki>
|author = <nowiki> Stuart Buchanan </nowiki>
|date = Jul 4th, 2017
|added = Jul 4th, 2017
|script_version = 0.40
}}</ref>

the FG team (in the very wide sense) has the skills and infrastructure to do this, and with sufficient interest could have a respectable G1000 implementation within 12 months.<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35927754/
|title = <nowiki> Re: [Flightgear-devel] RFD: FlightGear and the changing state of
air navigation </nowiki>
|author = <nowiki> Stuart Buchanan </nowiki>
|date = Jul 4th, 2017
|added = Jul 4th, 2017
|script_version = 0.40
}}</ref>

Stuart suggested that identifying a particular piece to develop as a "reference model" in the same way that the c172p is the "reference aircraft" would be a good start as it would allow us to focus on getting one thing right, doing the G1000 (NXi) would be most useful, as it's fitted to the Cessna 172, 182, Caravan, Mustang, and Piper Archer, many of which we already have as airframes in FG. The G1000 also has the advantage tha takh has already done some of the work already for the zhk1000 (https://seb.lautre.net/git/seb/zkv1000).<ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35927754/
|title = <nowiki> Re: [Flightgear-devel] RFD: FlightGear and the changing state of
air navigation </nowiki>
|author = <nowiki> Stuart Buchanan </nowiki>
|date = Jul 4th, 2017
|added = Jul 4th, 2017
|script_version = 0.40
}}</ref>

since we're not writing software for a real hardware device but just a simulation of one, this is _a lot_ less work than a real GPS. Not only do we never need to extract any information from real satellite signals, but we also utilie TONS of existing work - for instance a canvas display call goes through the canvas API, that calls Shiva (or how it's called) - which we didn't write - that in turn calls OSG (which we didn't write), this calls OpenGL code (which we didn't write), that ultimately calls GPU driver functionality (which we didn't write),... if you sum all that, we are likely effectively utilizing 'millions of lines' of code (or a lot anyway) - we just don't have to write it all ourselves. <ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35928220/
|title = <nowiki> Re: [Flightgear-devel] RFD: FlightGear and the changing state of
air navigation </nowiki>
|author = <nowiki> Thorsten Renk </nowiki>
|date = Jul 5th, 2017
|added = Jul 5th, 2017
|script_version = 0.40
}}</ref>

it's a lot of work to code all these displays which someone has to do, but there's no reason to assume it'd be hopeless performance-wise. <ref>{{cite web
|url = https://sourceforge.net/p/flightgear/mailman/message/35926412/
|title = <nowiki> Re: [Flightgear-devel] RFD: FlightGear and the changing state of
air navigation </nowiki>
|author = <nowiki> Thorsten Renk </nowiki>
|date = Jul 4th, 2017
|added = Jul 4th, 2017
|script_version = 0.40
}}</ref>

== References ==
{{Appendix}}

User:Zakharov/zkv1000 user guide

2018-01-03T01:06:04Z

Zakharov: /* Horizontal situation indicator */

User:Zakharov/zkv1000 user guide

2018-01-03T00:26:55Z

Zakharov: /* NAV */

User:Zakharov/zkv1000 user guide

2018-01-03T00:26:09Z

Zakharov: /* COMM */

User:Zakharov/zkv1000 user guide

2018-01-03T00:00:27Z

Zakharov: /* NAV */

User:Zakharov/zkv1000 user guide

2018-01-02T23:28:03Z

Zakharov:

User:Zakharov/zkv1000 user guide

2018-01-02T18:54:35Z

Zakharov:

User:Zakharov/zkv1000 user guide

2018-01-02T15:21:02Z

Zakharov: /* Maps */

User:Zakharov/zkv1000 user guide

2018-01-02T14:26:23Z

Zakharov: /* Maps */

User:Zakharov/zkv1000 user guide

2018-01-02T13:57:09Z

Zakharov: /* Maps */

File:Zkv1000-mapmenu.png

2018-01-02T13:55:12Z

Zakharov: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=Map orientation and zoom configuration}}
|date=2018-01-02
|source={{own}}
|author=[[User:Zakharov|Zakharov]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{self|cc-by-sa-4.0}}

[[Category:Zkv1000]]

User:Zakharov/zkv1000 user guide

2018-01-02T01:10:01Z

Zakharov: /* Terrain */

File:Zkv1000-ign.png

2018-01-02T01:08:17Z

Zakharov: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=LFBT - tiles from ign.fr (covering France only)}}
|date=2018-01-01
|source={{own}}
|author=[[User:Zakharov|Zakharov]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{self|cc-by-sa-4.0}}

[[Category:Zkv1000]]

File:Zkv1000-opentopomap.png

2018-01-02T01:08:17Z

Zakharov: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=LFBT - tiles from opentopomap}}
|date=2018-01-01
|source={{own}}
|author=[[User:Zakharov|Zakharov]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{self|cc-by-sa-4.0}}

[[Category:Zkv1000]]

User:Zakharov/zkv1000 user guide

2018-01-02T00:49:18Z

Zakharov: /* Terrain */

File:Zkv1000-thunderforest.png

2018-01-02T00:36:37Z

Zakharov: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=LFBT - tiles from thunderforest.com (registration needed)}}
|date=2018-01-01
|source={{own}}
|author=[[User:Zakharov|Zakharov]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{self|cc-by-sa-4.0}}

[[Category:Zkv1000]]

File:Zkv1000-wikimedia.org.png

2018-01-02T00:33:11Z

Zakharov: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=LFBT - from maps.wikimedia.org (default)}}
|date=2018-01-01
|source={{own}}
|author=[[User:Zakharov|Zakharov]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{self|cc-by-sa-4.0}}

[[Category:Zkv1000]]

User:Zakharov/zkv1000 user guide

2018-01-01T18:10:14Z

Zakharov: /* Maps */

User:Zakharov/zkv1000 user guide

2018-01-01T12:57:47Z

Zakharov:

File:Zkv1000-selectable-items.png

2018-01-01T12:52:54Z

Zakharov: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=selectable items}}
|date=2018-01-01
|source={{own}}
|author=[[User:Zakharov|Zakharov]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{self|cc-by-sa-4.0}}

[[Category:Zkv1000]]

User:Zakharov/zkv1000 user guide

2018-01-01T12:39:56Z

Zakharov:

User:Zakharov/zkv1000 user guide

2017-12-31T12:04:49Z

Zakharov:

User:Zakharov/zkv1000 user guide

2017-12-30T14:08:23Z

Zakharov: /* MFD */

User:Zakharov/zkv1000 user guide

2017-12-30T14:07:46Z

Zakharov: /* PFD */

File:Zkv1000-PFD-global.png

2017-12-30T13:03:47Z

Zakharov: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=zkv1000 PFD overview}}
|date=2017-12-30
|source={{own}}
|author=[[User:Zakharov|Zakharov]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{self|cc-by-sa-4.0}}

[[Category:Zkv1000]]

File:Zkv1000-MFD-global.png

2017-12-30T13:03:47Z

Zakharov: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=zkv1000 MFD overview}}
|date=2017-12-30
|source={{own}}
|author=[[User:Zakharov|Zakharov]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{self|cc-by-sa-4.0}}

[[Category:Zkv1000]]

File:Zkv1000-available softkeys.png

2017-12-30T13:03:46Z

Zakharov: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=available and unavailable softkey on zkv1000}}
|date=2017-12-30
|source={{own}}
|author=[[User:Zakharov|Zakharov]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{self|cc-by-sa-4.0}}

[[Category:Zkv1000]]

File:Zkv1000-available menus.png

2017-12-30T13:03:46Z

Zakharov: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=available and unavailable menus in zkv1000}}
|date=2017-12-30
|source={{own}}
|author=[[User:Zakharov|Zakharov]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{self|cc-by-sa-4.0}}

[[Category:Zkv1000]]

File:Zkv1000-active-softkey.png

2017-12-30T13:03:46Z

Zakharov: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=active and inactive softkeys in zkv1000}}{{fr|1=softkey active et inactive sur le zkv1000}}
|date=2017-12-30
|source={{own}}
|author=[[User:Zakharov|Zakharov]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{self|cc-by-sa-4.0}}

[[Category:Zkv1000]]

User:Zakharov/zkv1000 user guide

2017-12-27T08:59:48Z

Zakharov:

User:Zakharov/zkv1000 user guide

2017-12-27T08:26:58Z

Zakharov:

User:Zakharov/zkv1000 user guide

2017-12-26T22:09:11Z

Zakharov: /* TCAS */

[[Image:Routemanagerready.png|link=Route Manager]]
[[Image:Rembrandtready.png|link=Rembrandt]]
[[Image:Canvasready.png|link=Canvas]]

== Softkeys codes ==
BrightWhite on Black : available menu entry 
Black on White : activated entry 
Grey on Black : not yet implemented entry or not available in this aircraft 
Black : no entry 

== UI code and usage ==
Selected entry is in Black on LightBlue
entry with marks <code><</code> or <code>></code> are entries with limited number of choices. First choice doesn't show the <code><</code> char, last one doesn't show the <code>></code> char. 
Navigate from an entruy to the next or the previous by turning the large FMS knob, modify the value of the entry by turning the small FMS knob. 

== PFD ==
=== Airspeed indicators ===
The indicated airspeed tape is in knots and can show up to 1000 knots. The black pointer shows the current IAS. 
On the tape major ticks are shown at 10 knots interval, minor ticks at 5 knots interval. A pink trend vector shows the estimated speed in the next 6 seconds (in the limit of +/- 30 knots). 
There may be some Vspeeds marks (pink, text in white) specific to the aircraft (cf installation guide). It is possible to modify these values of the Vspeeds references by using the softkeys menu TMR/REF which make a window appear in the right down corner of the screen, and then navigating to the value to change it as described in UI code and usage chapter. 
The black pointer will take a red color if IAS exceeds the defined Vne. 
The true airspeed is shown under the speed tape, and the ground speed. Both are in knots. 
If the device is configured with stall angle of attack (see installation guide) then the softkeys menus <code>PFD > AOA/WIND > AOA ON</code> shows up a window just near the airspeed tape. This indicates the current normalized angle of attack, a LightBlue mark shows the best normalized angle of attack for approach. 
The softkey menu <code>PFD > AOA/WIND > AOA AUTO</code> make the AoA indicator showing up automagically if the gears are down and flaps out. 
The softkey menu <code>PFD > AOA/WIND > WIND > OPTN1</code> shows up the direction of the wind relative to the aircraft (heading and speed) 
The softkey menu <code>PFD > AOA/WIND > WIND > OPTN2</code> shows up the direction of the wind with front and cross wind components 
The softkey menu <code>PFD > AOA/WIND > WIND > OFF</code> hides the wind indicator window. 

=== Altitude indicator ===
The altitude tape is in feet, and shows from -990ft to 99990ft. The black pointer shows the current indicated altitude (determined from the air pressure), 20ft graduated. A trend vector indicates the readched altitude in the next 6 seconds in the limit of +/- 300ft. 
The barometric setting is shwon just under the altitude tape. It is graduated in inHg by default, but this can be modified to hPa using the softkey menu <code>PFD > HPA</code>, and back to inHg via menu <code>PFD > IN</code>. The setting to standard barometric value (29.92inHg or 1023hPa) can be automatically set by the menu <code>PFD > STD BARO</code>. The barometer setting is essential and can be done by turning the BARO knob in front of the device (left side, under the COMM knob). 
The selected altitude is indicated by a lightblue bug along the altitude tape. It is blocked at the upper or lower corner of the tape until the tape has in its range the selected altitude. While the selected altitude isn't in the +/- 300 ft range a black box indicate the selected altitude above the altitude tape. This box disappear when the indicated altitude is +/- 100 ft of selected altitude.

=== Vertical speed indicator===
The vertical speed indicator is on the right just near the altitude tape, and is graduated with major ticks every 1000 ft/min, and minor ticks every 500 ft/min. 
A black pointer containing the vertical speed with 10 ft/min precision moves along the non-moving tape. If the vertical speed exceeds +/- 4500 ft/min the pointer is locked to the upper/lower of the non-moving tape, and the vertical speed is detailed inside the pointer.

=== Attitude indicator===
Pitch scale is graduated 10° up to 80°, with minor marks 5° interval up to 25°, and every 2.5° below 20° pitch. The horizon line is part of the pitch scale, and represents a pitch of 0°. 
The roll scale is the 120° arc. The inverted triangle represents 0° roll. Major ticks represent 30° and 60°, minor ticks represent 10°, 20° and 45°. 
The slip skid indicator is the bar beneath the roll pointer. The Slip Skid indicator moves laterally away from the pointer to indicate the lateral acceleration.

=== Horizontal situation indicator===
=== Inset map ===
=== TCAS ===
Traffic announciator is shown as there is a traffic in sight, until there is no traffic at all
=== Transponder ===

== MFD ==
=== EIS ===
=== Maps ===
=== Menus ===

User:Zakharov/zkv1000 user guide

2017-12-26T22:08:21Z

Zakharov: /* Altitude indicator */

User:Zakharov/zkv1000 user guide

2017-12-26T21:58:40Z

Zakharov: /* Attitude indicator */

[[Image:Routemanagerready.png|link=Route Manager]]
[[Image:Rembrandtready.png|link=Rembrandt]]
[[Image:Canvasready.png|link=Canvas]]

== Softkeys codes ==
BrightWhite on Black : available menu entry 
Black on White : activated entry 
Grey on Black : not yet implemented entry or not available in this aircraft 
Black : no entry 

== UI code and usage ==
Selected entry is in Black on LightBlue
entry with marks <code><</code> or <code>></code> are entries with limited number of choices. First choice doesn't show the <code><</code> char, last one doesn't show the <code>></code> char. 
Navigate from an entruy to the next or the previous by turning the large FMS knob, modify the value of the entry by turning the small FMS knob. 

== PFD ==
=== Airspeed indicators ===
The indicated airspeed tape is in knots and can show up to 1000 knots. The black pointer shows the current IAS. 
On the tape major ticks are shown at 10 knots interval, minor ticks at 5 knots interval. A pink trend vector shows the estimated speed in the next 6 seconds (in the limit of +/- 30 knots). 
There may be some Vspeeds marks (pink, text in white) specific to the aircraft (cf installation guide). It is possible to modify these values of the Vspeeds references by using the softkeys menu TMR/REF which make a window appear in the right down corner of the screen, and then navigating to the value to change it as described in UI code and usage chapter. 
The black pointer will take a red color if IAS exceeds the defined Vne. 
The true airspeed is shown under the speed tape, and the ground speed. Both are in knots. 
If the device is configured with stall angle of attack (see installation guide) then the softkeys menus <code>PFD > AOA/WIND > AOA ON</code> shows up a window just near the airspeed tape. This indicates the current normalized angle of attack, a LightBlue mark shows the best normalized angle of attack for approach. 
The softkey menu <code>PFD > AOA/WIND > AOA AUTO</code> make the AoA indicator showing up automagically if the gears are down and flaps out. 
The softkey menu <code>PFD > AOA/WIND > WIND > OPTN1</code> shows up the direction of the wind relative to the aircraft (heading and speed) 
The softkey menu <code>PFD > AOA/WIND > WIND > OPTN2</code> shows up the direction of the wind with front and cross wind components 
The softkey menu <code>PFD > AOA/WIND > WIND > OFF</code> hides the wind indicator window. 

=== Altitude indicator ===
The altitude tape is in feet, and shows from -990ft to 99990ft. The black pointer shows the current indicated altitude (determined from the air pressure), 20ft graduated. A trend vector indicates the readched altitude in the next 6 seconds in the limit of +/- 300ft.
The barometric setting is shwon just under the altitude tape. It is graduated in inHg by default, but this can be modified to hPa using the softkey menu <code>PFD > HPA</code>, and back to inHg via menu <code>PFD > IN</code>. The setting to standard barometric value (29.92inHg or 1023hPa) can be automatically set by the menu <code>PFD > STD BARO</code>. The barometer setting is essential and can be done by turning the BARO knob in front of the device (left side, under the COMM knob).
The selected altitude is indicated by a lightblue bug along the altitude tape. It is blocked at the upper or lower corner of the tape until the tape has in its range the selected altitude. While the selected altitude isn't in the +/- 300 ft range a black box indicate the selected altitude above the altitude tape. This box disappear when the indicated altitude is +/- 100 ft of selected altitude.

=== Attitude indicator===
Pitch scale is graduated 10° up to 80°, with minor marks 5° interval up to 25°, and every 2.5° below 20° pitch. The horizon line is part of the pitch scale, and represents a pitch of 0°. 
The roll scale is the 120° arc. The inverted triangle represents 0° roll. Major ticks represent 30° and 60°, minor ticks represent 10°, 20° and 45°. 
The slip skid indicator is the bar beneath the roll pointer. The Slip Skid indicator moves laterally away from the pointer to indicate the lateral acceleration.

=== Horizontal situation indicator===
=== Inset map ===
=== TCAS ===
Traffic announciator is shown as there is a traffic in sight, until there is no traffic at all

== MFD ==
=== EIS ===
=== Maps ===
=== Menus ===

User:Zakharov/zkv1000 user guide

2017-12-26T21:37:02Z

Zakharov:

[[Image:Routemanagerready.png|link=Route Manager]]
[[Image:Rembrandtready.png|link=Rembrandt]]
[[Image:Canvasready.png|link=Canvas]]

== Softkeys codes ==
BrightWhite on Black : available menu entry 
Black on White : activated entry 
Grey on Black : not yet implemented entry or not available in this aircraft 
Black : no entry 

== UI code and usage ==
Selected entry is in Black on LightBlue
entry with marks <code><</code> or <code>></code> are entries with limited number of choices. First choice doesn't show the <code><</code> char, last one doesn't show the <code>></code> char. 
Navigate from an entruy to the next or the previous by turning the large FMS knob, modify the value of the entry by turning the small FMS knob. 

== PFD ==
=== Airspeed indicators ===
The indicated airspeed tape is in knots and can show up to 1000 knots. The black pointer shows the current IAS. 
On the tape major ticks are shown at 10 knots interval, minor ticks at 5 knots interval. A pink trend vector shows the estimated speed in the next 6 seconds (in the limit of +/- 30 knots). 
There may be some Vspeeds marks (pink, text in white) specific to the aircraft (cf installation guide). It is possible to modify these values of the Vspeeds references by using the softkeys menu TMR/REF which make a window appear in the right down corner of the screen, and then navigating to the value to change it as described in UI code and usage chapter. 
The black pointer will take a red color if IAS exceeds the defined Vne. 
The true airspeed is shown under the speed tape, and the ground speed. Both are in knots. 
If the device is configured with stall angle of attack (see installation guide) then the softkeys menus <code>PFD > AOA/WIND > AOA ON</code> shows up a window just near the airspeed tape. This indicates the current normalized angle of attack, a LightBlue mark shows the best normalized angle of attack for approach. 
The softkey menu <code>PFD > AOA/WIND > AOA AUTO</code> make the AoA indicator showing up automagically if the gears are down and flaps out. 
The softkey menu <code>PFD > AOA/WIND > WIND > OPTN1</code> shows up the direction of the wind relative to the aircraft (heading and speed) 
The softkey menu <code>PFD > AOA/WIND > WIND > OPTN2</code> shows up the direction of the wind with front and cross wind components 
The softkey menu <code>PFD > AOA/WIND > WIND > OFF</code> hides the wind indicator window. 

=== Altitude indicator ===
The altitude tape is in feet, and shows from -990ft to 99990ft. The black pointer shows the current indicated altitude (determined from the air pressure), 20ft graduated. A trend vector indicates the readched altitude in the next 6 seconds in the limit of +/- 300ft.
The barometric setting is shwon just under the altitude tape. It is graduated in inHg by default, but this can be modified to hPa using the softkey menu <code>PFD > HPA</code>, and back to inHg via menu <code>PFD > IN</code>. The setting to standard barometric value (29.92inHg or 1023hPa) can be automatically set by the menu <code>PFD > STD BARO</code>. The barometer setting is essential and can be done by turning the BARO knob in front of the device (left side, under the COMM knob).
The selected altitude is indicated by a lightblue bug along the altitude tape. It is blocked at the upper or lower corner of the tape until the tape has in its range the selected altitude. While the selected altitude isn't in the +/- 300 ft range a black box indicate the selected altitude above the altitude tape. This box disappear when the indicated altitude is +/- 100 ft of selected altitude.

=== Attitude indicator===
=== Horizontal situation indicator===
=== Inset map ===
=== TCAS ===
Traffic announciator is shown as there is a traffic in sight, until there is no traffic at all

== MFD ==
=== EIS ===
=== Maps ===
=== Menus ===

User:Zakharov/zkv1000 user guide

2017-12-26T21:32:47Z

Zakharov:

[[Image:Routemanagerready.png|link=Route Manager]]
[[Image:Rembrandtready.png|link=Rembrandt]]
[[Image:Canvasready.png|link=Canvas]]

== Softkeys codes ==
BrightWhite on Black : available menu entry
Black on White : activated entry
Grey on Black : unavailable entry (not yet implemented or not available in this aircraft)
Black : no entry

== UI code and usage ==
Selected entry is in Black on LightBlue
entry with marks <code><</code> or <code>></code> are entries with limited number of choices. First choice doesn't show the <code><</code> char, last one doesn't show the <code>></code> char. 
Navigate from an entruy to the next or the previous by turning the large FMS knob, modify the value of the entry by turning the small FMS knob. 

== PFD ==
=== Airspeed indicators ===
The indicated airspeed tape is in knots and can show up to 1000 knots. The black pointer shows the current IAS. 
On the tape major ticks are shown at 10 knots interval, minor ticks at 5 knots interval. A pink trend vector shows the estimated speed in the next 6 seconds (in the limit of +/- 30 knots). 
There may be some Vspeeds marks (pink, text in white) specific to the aircraft (cf installation guide). It is possible to modify these values of the Vspeeds references by using the softkeys menu TMR/REF which make a window appear in the right down corner of the screen, and then navigating to the value to change it as described in UI code and usage chapter. 
The black pointer will take a red color if IAS exceeds the defined Vne. 
The true airspeed is shown under the speed tape, and the ground speed. Both are in knots. 
If the device is configured with stall angle of attack (see installation guide) then the softkeys menus <code>PFD > AOA/WIND > AOA ON</code> shows up a window just near the airspeed tape. This indicates the current normalized angle of attack, a LightBlue mark shows the best normalized angle of attack for approach. 
The softkey menu <code>PFD > AOA/WIND > AOA AUTO</code> make the AoA indicator showing up automagically if the gears are down and flaps out. 
The softkey menu <code>PFD > AOA/WIND > WIND > OPTN1</code> shows up the direction of the wind relative to the aircraft (heading and speed) 
The softkey menu <code>PFD > AOA/WIND > WIND > OPTN2</code> shows up the direction of the wind with front and cross wind components 
The softkey menu <code>PFD > AOA/WIND > WIND > OFF</code> hides the wind indicator window. 

=== Altitude indicator ===
The altitude tape is in feet, and shows from -990ft to 99990ft. The black pointer shows the current indicated altitude (determined from the air pressure), 20ft graduated. A trend vector indicates the readched altitude in the next 6 seconds in the limit of +/- 300ft.
The barometric setting is shwon just under the altitude tape. It is graduated in inHg by default, but this can be modified to hPa using the softkey menu <code>PFD > HPA</code>, and back to inHg via menu <code>PFD > IN</code>. The setting to standard barometric value (29.92inHg or 1023hPa) can be automatically set by the menu <code>PFD > STD BARO</code>. The barometer setting is essential and can be done by turning the BARO knob in front of the device (left side, under the COMM knob).
The selected altitude is indicated by a lightblue bug along the altitude tape. It is blocked at the upper or lower corner of the tape until the tape has in its range the selected altitude. While the selected altitude isn't in the +/- 300 ft range a black box indicate the selected altitude above the altitude tape. This box disappear when the indicated altitude is +/- 100 ft of selected altitude.

=== Attitude indicator===
=== Horizontal situation indicator===
=== Inset map ===
=== TCAS ===
Traffic announciator is shown as there is a traffic in sight, until there is no traffic at all

== MFD ==
=== EIS ===
=== Maps ===
=== Menus ===

User:Zakharov/zkv1000 user guide

2017-12-26T21:24:02Z

Zakharov: /* tcas */

== Softkeys codes ==
BrightWhite on Black : available menu entry
Black on White : activated entry
Grey on Black : unavailable entry (not yet implemented or not available in this aircraft)
Black : no entry

== UI code and usage ==
Selected entry is in Black on LightBlue
entry with marks <code><</code> or <code>></code> are entries with limited number of choices. First choice doesn't show the <code><</code> char, last one doesn't show the <code>></code> char. 
Navigate from an entruy to the next or the previous by turning the large FMS knob, modify the value of the entry by turning the small FMS knob. 

== PFD ==
=== Airspeed indicators ===
The indicated airspeed tape is in knots and can show up to 1000 knots. The black pointer shows the current IAS. 
On the tape major ticks are shown at 10 knots interval, minor ticks at 5 knots interval. A pink trend vector shows the estimated speed in the next 6 seconds (in the limit of +/- 30 knots). 
There may be some Vspeeds marks (pink, text in white) specific to the aircraft (cf installation guide). It is possible to modify these values of the Vspeeds references by using the softkeys menu TMR/REF which make a window appear in the right down corner of the screen, and then navigating to the value to change it as described in UI code and usage chapter. 
The black pointer will take a red color if IAS exceeds the defined Vne. 
The true airspeed is shown under the speed tape, and the ground speed. Both are in knots. 
If the device is configured with stall angle of attack (see installation guide) then the softkeys menus <code>PFD > AOA/WIND > AOA ON</code> shows up a window just near the airspeed tape. This indicates the current normalized angle of attack, a LightBlue mark shows the best normalized angle of attack for approach. 
The softkey menu <code>PFD > AOA/WIND > AOA AUTO</code> make the AoA indicator showing up automagically if the gears are down and flaps out. 
The softkey menu <code>PFD > AOA/WIND > WIND > OPTN1</code> shows up the direction of the wind relative to the aircraft (heading and speed) 
The softkey menu <code>PFD > AOA/WIND > WIND > OPTN2</code> shows up the direction of the wind with front and cross wind components 
The softkey menu <code>PFD > AOA/WIND > WIND > OFF</code> hides the wind indicator window. 

=== Altitude indicator ===
The altitude tape is in feet, and shows from -990ft to 99990ft. The black pointer shows the current indicated altitude (determined from the air pressure), 20ft graduated. A trend vector indicates the readched altitude in the next 6 seconds in the limit of +/- 300ft.
The barometric setting is shwon just under the altitude tape. It is graduated in inHg by default, but this can be modified to hPa using the softkey menu <code>PFD > HPA</code>, and back to inHg via menu <code>PFD > IN</code>. The setting to standard barometric value (29.92inHg or 1023hPa) can be automatically set by the menu <code>PFD > STD BARO</code>. The barometer setting is essential and can be done by turning the BARO knob in front of the device (left side, under the COMM knob).
The selected altitude is indicated by a lightblue bug along the altitude tape. It is blocked at the upper or lower corner of the tape until the tape has in its range the selected altitude. While the selected altitude isn't in the +/- 300 ft range a black box indicate the selected altitude above the altitude tape. This box disappear when the indicated altitude is +/- 100 ft of selected altitude.

=== Attitude indicator===
=== Horizontal situation indicator===
=== Inset map ===
=== TCAS ===
Traffic announciator is shown as there is a traffic in sight, until there is no traffic at all

== MFD ==
=== EIS ===
=== Maps ===
=== Menus ===

User:Zakharov/zkv1000 user guide

2017-12-26T21:23:39Z

Zakharov:

== Softkeys codes ==
BrightWhite on Black : available menu entry
Black on White : activated entry
Grey on Black : unavailable entry (not yet implemented or not available in this aircraft)
Black : no entry

== UI code and usage ==
Selected entry is in Black on LightBlue
entry with marks <code><</code> or <code>></code> are entries with limited number of choices. First choice doesn't show the <code><</code> char, last one doesn't show the <code>></code> char. 
Navigate from an entruy to the next or the previous by turning the large FMS knob, modify the value of the entry by turning the small FMS knob. 

== PFD ==
=== Airspeed indicators ===
The indicated airspeed tape is in knots and can show up to 1000 knots. The black pointer shows the current IAS. 
On the tape major ticks are shown at 10 knots interval, minor ticks at 5 knots interval. A pink trend vector shows the estimated speed in the next 6 seconds (in the limit of +/- 30 knots). 
There may be some Vspeeds marks (pink, text in white) specific to the aircraft (cf installation guide). It is possible to modify these values of the Vspeeds references by using the softkeys menu TMR/REF which make a window appear in the right down corner of the screen, and then navigating to the value to change it as described in UI code and usage chapter. 
The black pointer will take a red color if IAS exceeds the defined Vne. 
The true airspeed is shown under the speed tape, and the ground speed. Both are in knots. 
If the device is configured with stall angle of attack (see installation guide) then the softkeys menus <code>PFD > AOA/WIND > AOA ON</code> shows up a window just near the airspeed tape. This indicates the current normalized angle of attack, a LightBlue mark shows the best normalized angle of attack for approach. 
The softkey menu <code>PFD > AOA/WIND > AOA AUTO</code> make the AoA indicator showing up automagically if the gears are down and flaps out. 
The softkey menu <code>PFD > AOA/WIND > WIND > OPTN1</code> shows up the direction of the wind relative to the aircraft (heading and speed) 
The softkey menu <code>PFD > AOA/WIND > WIND > OPTN2</code> shows up the direction of the wind with front and cross wind components 
The softkey menu <code>PFD > AOA/WIND > WIND > OFF</code> hides the wind indicator window. 

=== Altitude indicator ===
The altitude tape is in feet, and shows from -990ft to 99990ft. The black pointer shows the current indicated altitude (determined from the air pressure), 20ft graduated. A trend vector indicates the readched altitude in the next 6 seconds in the limit of +/- 300ft.
The barometric setting is shwon just under the altitude tape. It is graduated in inHg by default, but this can be modified to hPa using the softkey menu <code>PFD > HPA</code>, and back to inHg via menu <code>PFD > IN</code>. The setting to standard barometric value (29.92inHg or 1023hPa) can be automatically set by the menu <code>PFD > STD BARO</code>. The barometer setting is essential and can be done by turning the BARO knob in front of the device (left side, under the COMM knob).
The selected altitude is indicated by a lightblue bug along the altitude tape. It is blocked at the upper or lower corner of the tape until the tape has in its range the selected altitude. While the selected altitude isn't in the +/- 300 ft range a black box indicate the selected altitude above the altitude tape. This box disappear when the indicated altitude is +/- 100 ft of selected altitude.

=== Attitude indicator===
=== Horizontal situation indicator===
=== Inset map ===
=== tcas ===
Traffic announciator is shown as there is a traffic in sight, until there is no traffic at all

== MFD ==
=== EIS ===
=== Maps ===
=== Menus ===

User:Zakharov/zkv1000 user guide

2017-12-26T21:05:49Z

Zakharov: Created page with "Softkeys colors : BrightWhite on Black : available menu entry Black on White : activated entry Grey on Black : unavailable entry (not yet implemented or not available in this..."

Softkeys colors :
BrightWhite on Black : available menu entry
Black on White : activated entry
Grey on Black : unavailable entry (not yet implemented or not available in this aircraft)
Black : no entry

UI code and usage
selected entry is in Black on LightBlue
entry with marks < or > are entries with limited number of choices. First choice doesn't show the < char, last one doesn't show the > char.
Navigate from an entruy to the next or the previous by turning the large FMS knob, modify the value of the entry by turning the small FMS knob.

PFD
Airspeed indicators
The indicated airspeed tape is in knots and can show up to 1000 knots. Tha black pointer shows the current IAS. On the tape major ticks are shown at 10 knots interval, minor ticks at 5 knots interval. A pink trend vector shows the estimated speed in the next 6 seconds (in the limit of +/- 30 knots). There may be some Vspeeds marks (pink, text in white) specific to the aircraft (cf installation guide). It is possible to modify these values of the Vspeeds references by using the softkeys menu TMR/REF which make a window appear in the right down corner of the screen, and then navigating to the value to change it as described in UI code and usage chapter. The black pointer will take a red color if IAS exceeds the defined Vne.
The true airspeed is shown under the speed tape, and the ground speed. Both are in knots.
If the device is configured with stall angle of attack (see installation guide) then the softkeys menus PFD > AOA/WIND > AOA ON shows up a window just near the airspeed tape. This indicates the current normalized angle of attack, a LightBlue mark shows the best normalized angle of attack for approach.
The softkey menu PFD > AOA/WIND > AOA AUTO make the AoA indicator showing up automagically if the gears are down and flaps out.
The softkey menu PFD > AOA/WIND > WIND > OPTN1 shows up the direction of the wind relative to the aircraft (haeding and speed)
The softkey menu PFD > AOA/WIND > WIND > OPTN2 shows up the direction of the wind with front and cross wind components
The softkey menu PFD > AOA/WIND > WIND > OFF hides the wind indicator window

Altitude indicator
The altitude tape is in feet, and shows from -990ft to 99990ft. The black pointer shows the current indicated altitude (determined from the air pressure), 20ft graduated. A trend vector indicates the readched altitude in the next 6 seconds in the limit of +/- 300ft.
The barometric setting is shwon just under the altitude tape. It is graduated in inHg by default, but this can be modified to hPa using the softkey menu PFD > HPA, and back to inHg via menu PFD > IN. The setting to standard barometric value (29.92inHg or 1023hPa) can be automatically set by the menu PFD > STD BARO. The barometer setting is essential and can be done by turning the BORO knob in front of the device (left side, under the COMM knob).
The selected altitude is indicated by a lightblue bug along the altitude tape. It is blocked at the upper or lower corner of the tape until the tape has in its range the selected altitude. While the selected altitude isn't in the +/- 300 ft range a black box indicate the selected altitude above the altitude tape. This box disappear when the indicated altitude is +/- 100 ft of selected altitude.

tcas:
Traffic announciator is shown as there is a traffic in sight, until there is no traffic at all

MFD

User:Zakharov/zkv1000 installation guide

2017-07-21T15:19:42Z

Zakharov: /* knobs */

[[Image:Routemanagerready.png|link=Route Manager]]
[[Image:Rembrandtready.png|link=Rembrandt]]
[[Image:Canvasready.png|link=Canvas]]
[[Image:Nasallogo3.png|link=Nasal]]



== Get the sources ==
the whole zkv1000 can be retrieved from <tt>https://sebmarque.hd.free.fr/git/seb/zkv1000</tt>. You will have the choice with different ways (git, zip or tar.gz).

You have the choice of the destination of the source (in order of recommandation)
# in <tt>$FGHOME/Aircraft/Instruments-3d</tt>
# in your aircraft directory
# in <tt>$FGDATA/Aircraft/Instruments-3d</tt>

We'll refer to the zkv1000 installation directory as <tt>$ZKV1000</tt> later in this document

== Installation in the cockpit ==
The glass cockpit and the material around are included in the sources, but you can provide yours. Please see the advanced installation below.

The zkv1000 provides files in order to let you choose if you want a PFD, a MFP, both of them, or two PFDs and one PFD.

So the installation depends on what you want. Place in your cockpit the following files in the XML definition files of your aircraft
{| class="wikitable"
|-
! Configuration !! Files needed
|-
| PFD only || <tt>$ZKV1000/pfd-pilot.xml</tt>
|-
| MFD only || <tt>$ZKV1000/mfd.xml</tt>
|-
| 1 PFD + 1 MFD || <tt>$ZKV1000/pfd-pilot.xml</tt> + <tt>$ZKV1000/mfd.xml</tt>
|-
| 2 PFD + 1 MFD || <tt>$ZKV1000/pfd-pilot.xml</tt> + <tt>$ZKV1000/pfd-copilot.xml</tt> + <tt>$ZKV1000/mfd.xml</tt>
|}

Here's an example from the Lancair 235, configuration with a PFD in front of the pilot's seat and a MFD between the pilot's seat and the copilot's seat, a bit inclinated in direction of the pilot. These lines take place in the dedicated file about the cockpit definition.
<syntaxhighlight lang="xml">
<model>
<path>Aircraft/Instruments-3d/zkv1000/pfd-pilot.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>
</syntaxhighlight>
== make it work ==
Once your device is installed in your cockpit you may tell FligthGear where to find the underlying Nasal code. This is done in the <nasal> section of your aircraft definition. Obviously this is one of the manadatory step and value, the Nasal namespace '''must''' be zkv1000.
<syntaxhighlight lang="xml">
<zkv1000>
<file>Aircraft/Instruments-3d/zkv1000/zkv1000.nas</file>
</zkv1000>
</syntaxhighlight>

You have other options you can pass to the device in the <instrumentation> section of your aircraft definition
<syntaxhighlight lang="xml">
<instrumentation>
...
<zkv1000>
<alerts>
<Vx>15</Vx>
<Vy>110</Vy>
<Vr>65</Vr>
<Vglide>80</Vglide>
<stall-aoa>12</stall-aoa>
<approach-aoa>4</approach-aoa>
</alerts>
<eis>
<type>single-prop</type>
</eis>
</zkv1000>
...
</instrumentation>
</syntaxhighlight>

The available options are
{| class="wikitable"
|-
! Category !! Option !! Meaning !! Values
|-
| rowspan="6" | <tt>alerts</tt> || <tt>Vx</tt> || default Vx speed, displayed with a mark in the PFD's speed tape, may be modified by user, no default value || rowspan="4" | a number in knots, it can be modified by user using zkv1000 UI, no default value
|-
| <tt>Vy</tt> || default Vy speed, displayed with a mark in the PFD's speed tape
|-
| <tt>Vr</tt> || default Vr speed, displayed with a mark in the PFD's speed tape
|-
| <tt>Vglide</tt> || default Vglide speed, displayed with a mark in the PFD's speed tape
|-
| <tt>stall-aoa</tt> || The stalling angle of attack, if defined it is displayed in AOA widget || rowspan="2" | a number in degrees
|-
| <tt>approach-aoa</tt> || The expected angle of attack at approach phase, if defined it is displayed in AOA widget
|-
| <tt>eis</tt> || <tt>type</tt> or <tt>file</tt> || the type of EIS on MFD only, defaults to none || "none" means... none, the other possible values are the nasal definitions of file as in <tt>$ZKV1000/Nasal/eis</tt> (without the .nas extension) or the relative path to your definition specific to your aircarft
|}
More options to come...

The zkv1000 Nasal code is loaded at the end of the FDM initialization. Knowing that if you want to automagically switch on the zkv1000 there is a function named <code>zkv1000.powerOn()</code>, otherwise there is a predefined multikey {{key press|:}}{{key press|z}}{{key press|o}} witch will call the <tt>powerOn()</tt> function.

This should work and you and your aircraft's users should enjoy the instrument :)
== Advanced installation ==
You may want to use your own 3D objects, this is not a problem.

Each component of the zkv1000 is created at the power on if a property exists : <code>/instruments/zkv1000/<NAME>/status</code> in wich <tt>NAME</tt> is a string with the pattern: <code>(MFD|PFD)[optional identifier]</code>

So there are 3 optional properties useful to create your own device (only <tt>screen-object</tt> is available for now)
{| class="wikitable"
|-
! Property !! Role
|-
| <code>/instruments/zkv1000/<NAME>/screen-object</code> || The name of the 3D object
|-
| <code>/instruments/zkv1000/<NAME>/screen-view</code> || N/A The size of the view in Canvas context (defaults to <tt>[1024, 768]</tt>)
|-
| <code>/instruments/zkv1000/<NAME>/screen-size</code> || N/A The value of the Canvas size (defaults to <tt>[1280, 1280]</tt>), this value should be a square and large enough to allow rotation of the view without a not included pixel
|}

In the <tt>zkv1000</tt> namespace API specific for one component will be available by the <tt>NAME</tt>:
<syntaxhighlight lang="nasal">zkv1000.flightdeck['PFD-example'].knobs.FmsInner(...)</syntaxhighlight>
=== API ===
==== softkeys ====
There are 12 softkeys, related to the twelve boxes along the bottom of the zkv1000 screen.
They are accesible via the Class <tt>softkeys</tt>

===== <tt>SoftKey(number, pressed)</tt> =====
arguments:
* number: the number of the softkey, from 0 on the left-side, to 11 at the most right
* pressed: if the button is being pressed (1) or released (0), actually only pressed status is usable

==== buttons ====
.buttons.FMS
.buttons.ENT
.buttons.CLR
.buttons.PROC
.buttons.FPL
.buttons.MENU
.buttons.DirectTo
.buttons.PAN
.buttons.AsSwitchCOM
.buttons.AsSwitchNAV
.buttons.ALT

==== knobs ====
===== .knobs.FmsOuter(direction) =====
takes one argument which is the direction of the turn: <tt>cmdarg().getNode('offset').getValue()</tt>
===== .knobs.knobs.FmsInner(direction) =====
takes one argument which is the direction of the turn: <tt>cmdarg().getNode('offset').getValue()</tt>
===== .knobs.display.updateNAV({set:1}) =====
set the value for standby frequency for the selected NAV radio
===== .knobs.display.updateNAV({refresh:1|2}) =====
===== .knobs.display.updateCOMM({set:1}) =====
set the value for standby frequency for the selected COMM radio
===== .knobs.display.updateCOMM({refresh:1|2}) =====
===== .knobs.display.updateHDG() =====
no argument, just refresh the HDG display when the knob is used
===== .knobs.display.updateCRS() =====
no argument, just refresh the CRS display when the knob is used
===== .knobs.display.updateALT() =====
no argument, just refresh the ALT display when the knob is used
===== .knobs.display.updateBARO() =====
no argument, just refresh the BARO display when the knob is used

User:Zakharov/zkv1000 installation guide

2017-07-21T13:13:23Z

Zakharov: /* knobs */

[[Image:Routemanagerready.png|link=Route Manager]]
[[Image:Rembrandtready.png|link=Rembrandt]]
[[Image:Canvasready.png|link=Canvas]]
[[Image:Nasallogo3.png|link=Nasal]]



== Get the sources ==
the whole zkv1000 can be retrieved from <tt>https://sebmarque.hd.free.fr/git/seb/zkv1000</tt>. You will have the choice with different ways (git, zip or tar.gz).

You have the choice of the destination of the source (in order of recommandation)
# in <tt>$FGHOME/Aircraft/Instruments-3d</tt>
# in your aircraft directory
# in <tt>$FGDATA/Aircraft/Instruments-3d</tt>

We'll refer to the zkv1000 installation directory as <tt>$ZKV1000</tt> later in this document

== Installation in the cockpit ==
The glass cockpit and the material around are included in the sources, but you can provide yours. Please see the advanced installation below.

The zkv1000 provides files in order to let you choose if you want a PFD, a MFP, both of them, or two PFDs and one PFD.

So the installation depends on what you want. Place in your cockpit the following files in the XML definition files of your aircraft
{| class="wikitable"
|-
! Configuration !! Files needed
|-
| PFD only || <tt>$ZKV1000/pfd-pilot.xml</tt>
|-
| MFD only || <tt>$ZKV1000/mfd.xml</tt>
|-
| 1 PFD + 1 MFD || <tt>$ZKV1000/pfd-pilot.xml</tt> + <tt>$ZKV1000/mfd.xml</tt>
|-
| 2 PFD + 1 MFD || <tt>$ZKV1000/pfd-pilot.xml</tt> + <tt>$ZKV1000/pfd-copilot.xml</tt> + <tt>$ZKV1000/mfd.xml</tt>
|}

Here's an example from the Lancair 235, configuration with a PFD in front of the pilot's seat and a MFD between the pilot's seat and the copilot's seat, a bit inclinated in direction of the pilot. These lines take place in the dedicated file about the cockpit definition.
<syntaxhighlight lang="xml">
<model>
<path>Aircraft/Instruments-3d/zkv1000/pfd-pilot.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>
</syntaxhighlight>
== make it work ==
Once your device is installed in your cockpit you may tell FligthGear where to find the underlying Nasal code. This is done in the <nasal> section of your aircraft definition. Obviously this is one of the manadatory step and value, the Nasal namespace '''must''' be zkv1000.
<syntaxhighlight lang="xml">
<zkv1000>
<file>Aircraft/Instruments-3d/zkv1000/zkv1000.nas</file>
</zkv1000>
</syntaxhighlight>

You have other options you can pass to the device in the <instrumentation> section of your aircraft definition
<syntaxhighlight lang="xml">
<instrumentation>
...
<zkv1000>
<alerts>
<Vx>15</Vx>
<Vy>110</Vy>
<Vr>65</Vr>
<Vglide>80</Vglide>
<stall-aoa>12</stall-aoa>
<approach-aoa>4</approach-aoa>
</alerts>
<eis>
<type>single-prop</type>
</eis>
</zkv1000>
...
</instrumentation>
</syntaxhighlight>

The available options are
{| class="wikitable"
|-
! Category !! Option !! Meaning !! Values
|-
| rowspan="6" | <tt>alerts</tt> || <tt>Vx</tt> || default Vx speed, displayed with a mark in the PFD's speed tape, may be modified by user, no default value || rowspan="4" | a number in knots, it can be modified by user using zkv1000 UI, no default value
|-
| <tt>Vy</tt> || default Vy speed, displayed with a mark in the PFD's speed tape
|-
| <tt>Vr</tt> || default Vr speed, displayed with a mark in the PFD's speed tape
|-
| <tt>Vglide</tt> || default Vglide speed, displayed with a mark in the PFD's speed tape
|-
| <tt>stall-aoa</tt> || The stalling angle of attack, if defined it is displayed in AOA widget || rowspan="2" | a number in degrees
|-
| <tt>approach-aoa</tt> || The expected angle of attack at approach phase, if defined it is displayed in AOA widget
|-
| <tt>eis</tt> || <tt>type</tt> or <tt>file</tt> || the type of EIS on MFD only, defaults to none || "none" means... none, the other possible values are the nasal definitions of file as in <tt>$ZKV1000/Nasal/eis</tt> (without the .nas extension) or the relative path to your definition specific to your aircarft
|}
More options to come...

The zkv1000 Nasal code is loaded at the end of the FDM initialization. Knowing that if you want to automagically switch on the zkv1000 there is a function named <code>zkv1000.powerOn()</code>, otherwise there is a predefined multikey {{key press|:}}{{key press|z}}{{key press|o}} witch will call the <tt>powerOn()</tt> function.

This should work and you and your aircraft's users should enjoy the instrument :)
== Advanced installation ==
You may want to use your own 3D objects, this is not a problem.

Each component of the zkv1000 is created at the power on if a property exists : <code>/instruments/zkv1000/<NAME>/status</code> in wich <tt>NAME</tt> is a string with the pattern: <code>(MFD|PFD)[optional identifier]</code>

So there are 3 optional properties useful to create your own device (only <tt>screen-object</tt> is available for now)
{| class="wikitable"
|-
! Property !! Role
|-
| <code>/instruments/zkv1000/<NAME>/screen-object</code> || The name of the 3D object
|-
| <code>/instruments/zkv1000/<NAME>/screen-view</code> || N/A The size of the view in Canvas context (defaults to <tt>[1024, 768]</tt>)
|-
| <code>/instruments/zkv1000/<NAME>/screen-size</code> || N/A The value of the Canvas size (defaults to <tt>[1280, 1280]</tt>), this value should be a square and large enough to allow rotation of the view without a not included pixel
|}

In the <tt>zkv1000</tt> namespace API specific for one component will be available by the <tt>NAME</tt>:
<syntaxhighlight lang="nasal">zkv1000.flightdeck['PFD-example'].knobs.FmsInner(...)</syntaxhighlight>
=== API ===
==== softkeys ====
There are 12 softkeys, related to the twelve boxes along the bottom of the zkv1000 screen.
They are accesible via the Class <tt>softkeys</tt>

===== <tt>SoftKey(number, pressed)</tt> =====
arguments:
* number: the number of the softkey, from 0 on the left-side, to 11 at the most right
* pressed: if the button is being pressed (1) or released (0), actually only pressed status is usable

==== buttons ====
.buttons.FMS
.buttons.ENT
.buttons.CLR
.buttons.PROC
.buttons.FPL
.buttons.MENU
.buttons.DirectTo
.buttons.PAN
.buttons.AsSwitchCOM
.buttons.AsSwitchNAV
.buttons.ALT

==== knobs ====
===== .knobs.FmsOuter(direction) =====
takes one argument which is the direction of the turn: <tt>cmdarg().getNode('offset').getValue()</tt>
===== .knobs.knobs.FmsInner(direction) =====
takes one argument which is the direction of the turn: <tt>cmdarg().getNode('offset').getValue()</tt>
===== .knobs.display.updateNAV([{args,...}]) =====
===== .knobs.display.updateCOMM[{args,...}] =====
===== .knobs.display.updateHDG() =====
no argument, just refresh the HDG display when the knob is used
===== .knobs.display.updateCRS() =====
no argument, just refresh the CRS display when the knob is used
===== .knobs.display.updateALT() =====
no argument, just refresh the ALT display when the knob is used
===== .knobs.display.updateBARO() =====
no argument, just refresh the BARO display when the knob is used