@@ -0,0 +1,83 @@

+var annunciationsClass = {

+    new: func {

+        var m = { parents : [ annunciationsClass ] };

+        m.registered = {}; # triggers identified by message

+        m.active  = [];    # currently active warnings and alerts, sorted by emergency level

+        m.devices = [];    # PFD displays

+

+        foreach (var d; keys(flightdeck))

+            if (flightdeck[d].role == 'PFD')

+                append(m.devices, d);

+

+        foreach (var warnings; alerts.getChildren('warnings'))

+            foreach (var warning; warnings.getChildren('warning'))

+                m.register(warning);

+

+        data.timers.annunciations = maketimer(1.0, func call(m.activate, [], m));

+        data.timers.annunciations.start();

+

+        return m;

+    },

+

+    register: func (node) {

+        me.registered[node.getValue('message')] = {

+            trigger: compile(node.getValue('script')),

+            node: node,

+        };

+    },

+

+    del: func (message) {

+        if (contains(me.registered, message))

+            delete(me.registered, message);

+        if (contains(me.active, message))

+            delete(me.active, message);

+    },

+

+    activate: func {

+        size(me.registered) or return;

+

+        var score = {};

+

+        foreach (var a; keys(me.registered))

+            if (me.registered[a].trigger())

+                score[me.registered[a].node.getValue('message')] = me.registered[a].node.getValue('level');

+

+        if (size(score) > 1) {

+            var sorted_scores = sort(keys(score), func (a, b) {

+                if (score[a] <= score[b])

+                    return 1; # greatest first

+                else

+                    return -1;

+            });

+        }

+        else

+            var sorted_scores = keys(score);

+

+        me.active = sorted_scores;

+

+        var levels_bg = [ 'lightgrey', 'white', 'red'    ];

+        var levels_fg = [ 'black'    , 'black', 'yellow' ];

+

+        if (size(me.active)) {

+            var level = score[sorted_scores[0]];

+            if (level > 2) level = 2;

+

+            foreach (var d; me.devices) {

+                flightdeck[d].display.screenElements['SoftKey11-bg']

+                    .setColorFill(flightdeck[d].display.colors[levels_bg[level]]);

+                flightdeck[d].display.screenElements['SoftKey11-text']

+                    .setColor(flightdeck[d].display.colors[levels_fg[level]]);

+                flightdeck[d].display.updateSoftKeys();

+            }

+        }

+        else {

+            foreach (var d; me.devices) {

+                flightdeck[d].display.screenElements['SoftKey11-bg']

+                    .setColorFill(flightdeck[d].display.colors.black);

+                flightdeck[d].display.screenElements['SoftKey11-text']

+                    .setColor(flightdeck[d].display.colors.lightgrey);

+                flightdeck[d].display.updateSoftKeys();

+            }

+        }

+    },

+};

@@ -309,6 +309,9 @@ var powerOn = func {

     if (! contains(autopilot, 'parents'))

         autopilot = APClass.new();

+    if (! contains(annunciations, 'parents'))

+        annunciations = annunciationsClass.new();

+

     if (! contains(data.timers, 'listeners')) {

         data.timers.listeners = maketimer(1, setListeners);

         data.timers.listeners.singleShot = 1;

@@ -57,6 +57,40 @@ var softkeysClass = {

     bindings : {

         PFD : {

+            ALERTS: func {

+                id = 'ALERTS';

+                if (!contains(me.device.windows.state, id)) {

+                    var obj_infos = [

+                        { text: sprintf('%i ALERT%s', size(annunciations.active), size(annunciations.active) > 1 ? 'S' : ''), type: 'title' },

+                        { type: 'separator' }

+                    ];

+                    var firstEntry = 1;

+                    var levels = [ 'INFO', 'WARNING', 'ALERT' ];

+                    forindex (var order; annunciations.active) {

+                        var level = annunciations.registered[annunciations.active[order]].node.getValue('level');

+                        if (level > 2) level = 2;

+                        append(obj_infos, {

+                            text: sprintf('%02i - %-7s ', order + 1, levels[level]),

+                            type: firstEntry ? 'selected' : 'editable',

+                            scrollgroup: order,

+                        });

+                        append(obj_infos, {

+                            text: annunciations.registered[annunciations.active[order]].node.getValue('message'),

+                            type: 'normal|end-of-line',

+                            scrollgroup: order,

+                        });

+                        firstEntry = 0;

+                    }

+                    me.device.knobs.FmsInner = me.device.knobs.NavigateMenu;

+                    me.device.knobs.FmsOuter = me.device.knobs.NavigateMenu;

+                    me.device.windows.draw( id, obj_infos, {lines: 4, columns: 2, rows: 1} );

+                }

+                else {

+                    me.device.knobs.FmsInner = func;

+                    me.device.knobs.FmsOuter = func;

+                    me.device.buttons.ClearTMRREF();

+                }

+            },

             INSET: {

                 OFF: func {

                     me.device.map.setVisible(0);

@@ -58,13 +58,14 @@ Please report bug at <zkv1000@seb.lautre.net>.

   * Screens are fully animated, with softkeys and menus, on map (PFD inset and MFD) background is configurable with the preferred one, navaids and [route](https://seb.lautre.net/git/seb/zkv1000/issues/6) are displayed. Traffic and topography layers are available for display only on MFD screen (not in PFD inset as the window is too small).

   * There is also per-aircraft settings storage for preferred units (speed, distance, etc.).

   * Flightplan management is delegated to the more usable FG interface lauched from inside the zkv100, but it is possible to use DirectTo on selected navaid, and OBS mode with GPS.

-  * Checklists are managed, including separation between emergency and normal checklists (and aircraft agnostic, should be compatible with most systems).

+  * Checklists are managed, including separation between emergency and normal checklists (and aircraft agnostic, should be compatible with most systems). Moreover a alerting system allow to show specific alerts for your aircraft, just register a new alert check and PFDs will warn the pilot about.

   * ... and many more ! :)

 * ![][90%]

   * route displayed on map: legs ![][done], current and next leg ![][done], OBS ![][done], TOC/TOD ![][ongoing]

   * XPDR: emergency code depending of the country (eg.: 1200 for US, 7700 for Europe), should be set in settings

 * ![][80%]

   * Flight plans catalog (display on map doesn't work each time...)

+  * Alerts: voice description of the alert ![][ongoing]

 * ![][60%]

   * NOT TESTED: add the posssibility to only use Nasal part of the instrument. This in case of a cockpit which already includes needed objects and animations for screens, knobs and buttons in its config files

 * ![][50%]

@@ -79,7 +80,6 @@ Please report bug at <zkv1000@seb.lautre.net>.

   * make possible to integrate other autopilot systems than the one integrated

   * make booting animation visible

   * CDI/GPS: scale depending of the flight phase

-  * Alerts

   * Weather map

   * replace the use of `clip` by a better system in map display (think also about INSET)

   * VS guidance

@@ -206,6 +206,58 @@ You can specify a directory where to find the flightplans you save. Defaults to

 Only the flightplans set for a departure from your position will be shown, no matter of the name of the file (even extension), each will be parsed to find the ones corresponding to your departure location.

 The list will show only 6 flightplans, but it's scrollable so you can handle much more.

+### Alerting system

+You can set some alerts of your choice. Note that there are 3 levels:

+

+* `0`: INFO

+* `1`: WARNING

+* `2`: ALERT

+

+Alerts are identified by the displayed message, so you can't provide two alerts with the same alert message. The higher level is shown first in list displayed on PFD (press `ALERT` softkey), all levels should be integers at least if less than 2. The tests are executed each second.

+

+To come: a voice alert if needed and configured (but I'm facing issue of multiple alerts at the same time, temporisation is ongoing).

+

+To register your alerts you have two ways:

+#### set the alerts in `/instrumentation/zkv1000/alerts/warnings`

+This way they are registered at start

+

+        <warnings>

+          <warning>

+            <script><![CDATA[

+              getprop('/foo/bar/baz/value') and getprop('/foo/bar/baz/value[1]') > 5;

+            ]]></script>

+            <message>TEST 1</message>

+            <!-- <speaker/> TO USE THE MESSAGE AS VOICE -->

+            <level>0</level>

+          </warning>

+          <warning>

+            <script><![CDATA[

+              getprop('/foo/bar/baz/value[3]') == 'foobar' or getprop('/foo/bar/baz/value[2]') < 10;

+            ]]></script>

+            <message>TEST 2</message>

+            <level>1</level>

+            <!-- <speaker>this is only for testing</speaker> TO USE A SPECIFIC VOICE MESSAGE -->

+          </warning>

+          <warning>

+            <script><![CDATA[

+              return getprop('/foo/bar/baz/value[4]') == 5 or getprop('/foo/bar/baz/value[5]');

+            ]]></script>

+            <message>TEST 3</message>

+            <level>2</level>

+          </warning>

+        </warnings>

+

+#### or use the integrated API

+Actually not yet tested, but you can register new alerts somewhere in your Nasal code with the following:

+

+        zkv1000.annunciations.register(props.globals.new({

+            message: "a message",

+            level: 20,

+            script: "if (something) return 1; else return 0;"

+        }));

+

+It also exists a `zkv1000.annunciations.del(message)` to delete a warning from the register list, so it won't be tested anymore.

+

 ## 3D models

 In the definition of your flightdeck (here are the values for the installation in the Lancair 235 in which I develop the device)

 put it everywhere you want to. Note that the path `Aircraft/Instruments-3d/zkv1000` is dependant on the path where the zkv1000 is installed, this can be somewhere like `Aircraft/My-Nice-Aircraft/arbitrary/dirs/zkv1000-or-not`as mentionned earlier in this section.

@@ -16,17 +16,19 @@ files_to_load = [

     'menu.nas',    # manage windows

     'core.nas',    # the scheduler and switch on button

     'afcs.nas',    # Automatic Flight Control System

+    'annunciations.nas',  # in flight tests

 ];

 #    'routes.nas',  # manages flightplans and routes

 #    'display.nas', # display messages and popups

 #    'infos.nas',   # get informations from environment

-#    'alerts.nas',  # in flight tests

 #    'mud.nas',     # displays simple embedded GUI (Multi-Use Display)

 var flightdeck = {};

 var autopilot = {};

+var annunciations = {};

+

 var units = {

     speed : {

         from_kt  : 1,