From 2b4a096ffbcf72176f31b60fe012cf04181d1a61 Mon Sep 17 00:00:00 2001
From: hbeni <beni@hallinger.org>
Date: Sat, 22 May 2021 22:20:55 +0200
Subject: [PATCH] FGFS Addon: Basic rewrite to dynamically registering radios

---
 .../FGData/Protocol/fgcom-mumble.xml          | 228 +-----------------
 client/fgfs-addon/addon-main.nas              |  21 +-
 client/fgfs-addon/gui/combar.nas              |  25 +-
 client/fgfs-addon/radios.nas                  |  81 +++++--
 4 files changed, 108 insertions(+), 247 deletions(-)

diff --git a/client/fgfs-addon/FGData/Protocol/fgcom-mumble.xml b/client/fgfs-addon/FGData/Protocol/fgcom-mumble.xml
index a5c3f897..e617100e 100644
--- a/client/fgfs-addon/FGData/Protocol/fgcom-mumble.xml
+++ b/client/fgfs-addon/FGData/Protocol/fgcom-mumble.xml
@@ -36,224 +36,20 @@
   <output>
    <line_separator>newline</line_separator>
    <var_separator>,</var_separator>
-
-   <!--  ###############  -->
-   <!--  #    RADIOS   #  -->
-   <!--  ###############  -->
-
-   <!-- COM 1 -->
-   <chunk>
-    <name>com1-frequency</name>
-    <type>string</type>
-    <format>COM1_FRQ=%s</format>
-    <node>/instrumentation/comm[0]/fgcom-mumble/selected-mhz</node>
-   </chunk>
-   <chunk>
-    <name>com1-channel-width-khz</name>
-    <type>string</type>
-    <format>COM1_CWKHZ=%s</format>
-    <node>/instrumentation/comm[0]/frequencies/selected-channel-width-khz</node>
-   </chunk>
-   <chunk>
-    <name>com1-powerbutton</name>
-    <type>string</type>
-    <format>COM1_PBT=%s</format> <!-- 0=inactive, 1=active -->
-    <node>/instrumentation/comm[0]/operable</node>
-    <!-- ^^ we use the operable property because it honors all conditions (powered, serviceable, turned on) -->
-   </chunk>
-   <chunk>
-    <name>com1-ptt</name>
-    <type>string</type>
-    <format>COM1_PTT=%s</format> <!-- 0=inactive, 1=active -->
-    <node>/instrumentation/comm[0]/fgcom-mumble/ptt</node>
-   </chunk>
-   <chunk>
-    <name>com1-vol</name>
-    <type>string</type>
-    <format>COM1_VOL=%s</format> <!-- 0.0=mute, <=1.0 full -->
-    <node>/instrumentation/comm[0]/fgcom-mumble/volume</node>
-   </chunk>
-   <chunk>
-    <name>com1-txpwr</name>
-    <type>string</type>
-    <format>COM1_PWR=%s</format> <!-- in watts; Bendix KX165A typical 10w and yields a range of about 50nm@1500ft altitude?? -->
-    <node>/instrumentation/comm[0]/tx-power</node>
-   </chunk>
-   <chunk>
-    <name>com1-squelch</name>
-    <type>string</type>
-    <format>COM1_SQC=%s</format> <!-- 0.0=cutoff nothing, 1.0=cutoff any -->
-    <node>/instrumentation/comm[0]/cutoff-signal-quality</node>
-   </chunk>
-
-   <!-- COM 2 -->
-   <chunk>
-    <name>com2-frequency</name>
-    <type>string</type>
-    <format>COM2_FRQ=%s</format>
-    <node>/instrumentation/comm[1]/fgcom-mumble/selected-mhz</node>
-   </chunk>
-   <chunk>
-    <name>com2-channel-width-khz</name>
-    <type>string</type>
-    <format>COM2_CWKHZ=%s</format>
-    <node>/instrumentation/comm[1]/frequencies/selected-channel-width-khz</node>
-   </chunk>
-   <chunk>
-    <name>com2-powerbutton</name>
-    <type>string</type>
-    <format>COM2_PBT=%s</format> <!-- 0=inactive, 1=active -->
-    <node>/instrumentation/comm[1]/operable</node>
-    <!-- ^^ we use the operable property because it honors all conditions (powered, serviceable, turned on) -->
-   </chunk>
-   <chunk>
-    <name>com2-ptt</name>
-    <type>string</type>
-    <format>COM2_PTT=%s</format> <!-- 0=inactive, 1=active -->
-    <node>/instrumentation/comm[1]/fgcom-mumble/ptt</node>
-   </chunk>
-   <chunk>
-    <name>com2-vol</name>
-    <type>string</type>
-    <format>COM2_VOL=%s</format> <!-- 0.0=mute, <=1.0 full -->
-    <node>/instrumentation/comm[1]/fgcom-mumble/volume</node>
-   </chunk>
-   <chunk>
-    <name>com2-txpwr</name>
-    <type>string</type>
-    <format>COM2_PWR=%s</format> <!-- in watts; Bendix KX165A typical 10w and yields a range of about 50nm@1500ft altitude?? -->
-    <node>/instrumentation/comm[1]/tx-power</node>
-   </chunk>
-   <chunk>
-    <name>com2-squelch</name>
-    <type>string</type>
-    <format>COM2_SQC=%s</format> <!-- 0.0=cutoff nothing, 1.0=cutoff any -->
-    <node>/instrumentation/comm[1]/cutoff-signal-quality</node>
-   </chunk>
-
-   <!-- COM 3 -->
-   <chunk>
-    <name>com3-frequency</name>
-    <type>string</type>
-    <format>COM3_FRQ=%s</format>
-    <node>/instrumentation/comm[2]/fgcom-mumble/selected-mhz</node>
-   </chunk>
-   <chunk>
-    <name>com3-channel-width-khz</name>
-    <type>string</type>
-    <format>COM3_CWKHZ=%s</format>
-    <node>/instrumentation/comm[2]/frequencies/selected-channel-width-khz</node>
-   </chunk>
-   <chunk>
-    <name>com3-powerbutton</name>
-    <type>string</type>
-    <format>COM3_PBT=%s</format> <!-- 0=inactive, 1=active -->
-    <node>/instrumentation/comm[2]/operable</node>
-    <!-- ^^ we use the operable property because it honors all conditions (powered, serviceable, turned on) -->
-   </chunk>
-   <chunk>
-    <name>com3-ptt</name>
-    <type>string</type>
-    <format>COM3_PTT=%s</format> <!-- 0=inactive, 1=active -->
-    <node>/instrumentation/comm[2]/fgcom-mumble/ptt</node>
-   </chunk>
-   <chunk>
-    <name>com3-vol</name>
-    <type>string</type>
-    <format>COM3_VOL=%s</format> <!-- 0.0=mute, <=1.0 full -->
-    <node>/instrumentation/comm[2]/fgcom-mumble/volume</node>
-   </chunk>
-   <chunk>
-    <name>com3-txpwr</name>
-    <type>string</type>
-    <format>COM3_PWR=%s</format> <!-- in watts; Bendix KX165A typical 10w and yields a range of about 50nm@1500ft altitude?? -->
-    <node>/instrumentation/comm[2]/tx-power</node>
-   </chunk>
-   <chunk>
-    <name>com3-squelch</name>
-    <type>string</type>
-    <format>COM3_SQC=%s</format> <!-- 0.0=cutoff nothing, 1.0=cutoff any -->
-    <node>/instrumentation/comm[2]/cutoff-signal-quality</node>
-   </chunk>
-
-   <!-- INFO: add more radios here. The plugin ignores not present radios automatically. -->
-   <!--       Remember that you need to adjust the variables n_COM and COM_offset (and the ADF ones) -->
-   <!--       in radios.nas, and also don't forget to push the following ADF indexes up. -->
-
-
-   <!-- ADF radio / RDF -->
-   <chunk>
-    <!-- UDP RDF client port overwrite: This is needed, because FGFS currently
-         cannot assign the sending client port, but chooses a random one -->
-    <name>fgcom-udp-client-port</name>
-    <type>string</type>
-    <format>UDP_TGT_PORT=19991</format>
-   </chunk>
-
-   <chunk>
-    <name>adf1-local-only</name>
-    <type>string</type>
-    <format>COM4_PUBLISH=%s</format>
-    <node>/instrumentation/adf[0]/fgcom-mumble/publish</node>
-   </chunk>
-   <chunk>
-    <name>adf1-operable</name>
-    <type>string</type>
-    <format>COM4_PBT=%s</format> <!-- 0=inactive, 1=active -->
-    <node>/instrumentation/adf[0]/operable</node>
-    <!-- ^^ we use the operable property because it honors all conditions (powered, serviceable, turned on) -->
-   </chunk>
-   <chunk>
-    <name>adf1-volume</name>
-    <type>string</type>
-    <format>COM4_VOL=%s</format> <!-- 0.0=mute, <=1.0 full -->
-    <node>/instrumentation/adf[0]/fgcom-mumble/volume</node>
-   </chunk>
-   <chunk>
-    <name>adf1-frequency</name>
-    <type>string</type>
-    <format>COM4_FRQ=%s</format>
-    <node>/instrumentation/adf[0]/fgcom-mumble/selected-mhz</node>
-   </chunk>
-   <chunk>
-    <name>adf1-enableRDF</name>
-    <type>string</type>
-    <format>COM4_RDF=%s</format>
-    <node>/instrumentation/adf[0]/fgcom-mumble/rdf-enabled</node>
-   </chunk>
-
-   <chunk>
-    <name>adf2-local-only</name>
-    <type>string</type>
-    <format>COM5_PUBLISH=%s</format>
-    <node>/instrumentation/adf[1]/fgcom-mumble/publish</node>
-   </chunk>
-   <chunk>
-    <name>adf2-operable</name>
-    <type>string</type>
-    <format>COM5_PBT=%s</format> <!-- 0=inactive, 1=active -->
-    <node>/instrumentation/adf[1]/operable</node>
-    <!-- ^^ we use the operable property because it honors all conditions (powered, serviceable, turned on) -->
-   </chunk>
-   <chunk>
-    <name>adf2-volume</name>
-    <type>string</type>
-    <format>COM5_VOL=%s</format> <!-- 0.0=mute, <=1.0 full -->
-    <node>/instrumentation/adf[1]/fgcom-mumble/volume</node>
-   </chunk>
-   <chunk>
-    <name>adf2-frequency</name>
-    <type>string</type>
-    <format>COM5_FRQ=%s</format>
-    <node>/instrumentation/adf[1]/fgcom-mumble/selected-mhz</node>
-   </chunk>
+   
+   
+   <!--  #####################  -->
+   <!--  #  RADIO DATA  #  -->
+   <!--  #####################  -->
+   <!-- This is dynamically created from the nasal addon code -->
    <chunk>
-    <name>adf2-enableRDF</name>
+    <name>radios_data</name>
     <type>string</type>
-    <format>COM5_RDF=%s</format>
-    <node>/instrumentation/adf[1]/fgcom-mumble/rdf-enabled</node>
+    <format>%s</format>
+    <node>/addons/by-id/org.hallinger.flightgear.FGCom-mumble/output/udp</node>
    </chunk>
-
+   
+   
    <!-- FGCom 3.0 compatibility: /instrumentation/com[n]/ptt is never set from any aircraft except
         c182s or the combar-gui. The old FGCom protocol seems outdated and transmit an old property.
         To get compatibility out-of-the-box, we transmit the FGCom PTT property here.
@@ -318,8 +114,6 @@
     <format>AUDIO_HEAR_ALL=%d</format>
     <node>/addons/by-id/org.hallinger.flightgear.FGCom-mumble/audio-hear-all</node>
    </chunk>
-
-
   </output>
 
 
diff --git a/client/fgfs-addon/addon-main.nas b/client/fgfs-addon/addon-main.nas
index d78085d9..28c031ea 100644
--- a/client/fgfs-addon/addon-main.nas
+++ b/client/fgfs-addon/addon-main.nas
@@ -11,6 +11,7 @@ var main = func( addon ) {
     var myAddonId  = addon.id;
     var mySettingsRootPath = "/addons/by-id/" ~ myAddonId;
     var protocolInitialized = 0;
+    var fgcom_timers = {};
     
     print("Addon FGCom-mumble loading...");
     
@@ -60,12 +61,23 @@ var main = func( addon ) {
     print("Addon FGCom-mumble loading radios...");
     io.load_nasal(root~"/radios.nas", "FGComMumble_radios");
     var rdfinputNode = props.globals.getNode(mySettingsRootPath ~ "/rdfinput/",1);
+    FGComMumble_radios.GenericRadio.setOutputRoot(props.globals.getNode(mySettingsRootPath ~ "/output", 1));
     FGComMumble_radios.create_radios();
     FGComMumble_radios.start_rdf(rdfinputNode);
 
     # Load the FGCom-mumble combar
     print("Addon FGCom-mumble loading combar...");
     io.load_nasal(root~"/gui/combar.nas", "FGComMumble_combar");
+    
+    var update_udp_output = func() {
+      FGComMumble_radios.update_radios();
+      var out_prop = props.globals.getNode(mySettingsRootPath ~ "/output/udp",1);
+      var str_v = [];
+      foreach (r_out; FGComMumble_radios.GenericRadio.outputRootNode.getChildren("COM")) {
+        append(str_v, r_out.getValue());
+      }
+      out_prop.setValue(string.join(",", str_v));
+    }
 
     var initProtocol = func() {
       if (protocolInitialized == 0) {
@@ -93,6 +105,10 @@ var main = func( addon ) {
           foreach(var p; rdfinputNode.getChildren()) {
             p.setValue("");
           }
+          
+          fgcom_timers.udploop = maketimer(1/refresh, nil, update_udp_output);
+          fgcom_timers.udploop.start();
+          
           protocolInitialized = 1;
         }
       }
@@ -106,6 +122,10 @@ var main = func( addon ) {
                   "name" : "fgcom-mumble"
               })
             );
+            
+            foreach (var t; keys(fgcom_timers.timers)) fgcom_timers.timers[t].stop();
+            fgcom_timers.timers = {};
+          
             protocolInitialized = 0;
         }
     }
@@ -142,7 +162,6 @@ var main = func( addon ) {
     var reinit_hostChange = setlistener(mySettingsRootPath ~ "/host", reinitProtocol, 0, 0);
     var reinit_portChange = setlistener(mySettingsRootPath ~ "/port", reinitProtocol, 0, 0);
     
-    
     # Check for upates at init time
     checkUpdate(mySettingsRootPath);
 }
diff --git a/client/fgfs-addon/gui/combar.nas b/client/fgfs-addon/gui/combar.nas
index 303139eb..83d89267 100644
--- a/client/fgfs-addon/gui/combar.nas
+++ b/client/fgfs-addon/gui/combar.nas
@@ -34,10 +34,6 @@ canvas.gui.widgets.SpringButton.setDown = func(down = 1)
 
 var combar = {
 
-    # Generate buttons for this much COM radios;
-    # /!\ must be the same as the defined/transmitted radios in the protocol file!
-    num_radios: FGComMumble_radios.n_COM,
-
     comPTTButton_size: [65,25],
     dialogOpened: 0,
     show: func() {
@@ -64,22 +60,21 @@ var combar = {
 
 
         # Generate PTT buttons for the configured radios
-        for (var i=0; i<me.num_radios; i=i+1) {
-            var radio_p   = "/instrumentation/comm["~i~"]";
-            var radio_used = getprop(radio_p~"/fgcom-mumble/is-used");
-            if (!radio_used) {
-                print("Addon FGCom-mumble: combar skipping "~radio_p);
+        var r_num = 1;
+        foreach (var ridx; keys(FGComMumble_radios.COM_radios)) {
+            var r = FGComMumble_radios.COM_radios[ridx];
+            if (!r.is_used) {
+                print("Addon FGCom-mumble: combar skipping "~r.root.getPath());
                 continue;
             }
 
-            var comid = i+1;
-            print("Addon FGCom-mumble: combar adding "~radio_p~" (COM"~comid~")");
+            print("Addon FGCom-mumble: combar adding "~r.root.getPath()~" (COM"~r.fgcomPacketStr.getIndex()~")");
 
-            var newSizeWidth = math.round((i+1)*me.comPTTButton_size[0] + me.comPTTButton_size[0]/4);
+            var newSizeWidth = math.round((r_num)*me.comPTTButton_size[0] + me.comPTTButton_size[0]/4);
             dlgWindow.setSize([newSizeWidth, me.comPTTButton_size[1]+4]);
 
             var button = canvas.gui.widgets.SpringButton.new(root, canvas.style, {})
-                    .setText("COM" ~ comid)
+                    .setText("COM" ~ r.fgcomPacketStr.getIndex())
                     .setFixedSize(me.comPTTButton_size[0], me.comPTTButton_size[1]);
             var init_button = func(b,rp,ci) {
                 b.ptt_prop = rp~"/ptt";
@@ -102,9 +97,11 @@ var combar = {
                 });
                 update_button_timer.start();
             };
-            init_button(button, radio_p, comid);
+            init_button(button, r.root.getPath(), r.fgcomPacketStr.getIndex());
 
             myLayout.addItem(button);
+            
+            r_num = r_num + 1;
         }
 
         me.dialogOpened = 1;
diff --git a/client/fgfs-addon/radios.nas b/client/fgfs-addon/radios.nas
index bf081e63..7bdbbbe1 100644
--- a/client/fgfs-addon/radios.nas
+++ b/client/fgfs-addon/radios.nas
@@ -5,15 +5,6 @@
 # @author Colin Geniet, 2021
 
 
-# Number of radios, and their offset in protocol file fgcom-mumble.xml.
-# This needs to be changed according to the protocol file.
-var n_COM      = 3;
-var COM_offset = 1;
-var n_ADF      = 2;
-var ADF_offset = 4;
-
-
-
 # FGCom-mumble nasal radios objects task is to make some minor checks and changes
 # to the properties transmitted to the FGCom-mumble plugin.
 # Notably, they make sure that no value is transmitted for unused radios.
@@ -27,6 +18,15 @@ var GenericRadio = {
         return r;
     },
 
+    # initialized by addon-main.nas after load to specify where the output should go
+    outputRootNode: nil,
+    setOutputRoot: func(p) {
+        GenericRadio.outputRootNode = p;
+    },
+
+    fgcomPacketStr: nil, # node for udp output
+    fields2props: {},    # map packet field names to properties
+
     init: func {
         # Radio frequencies are initialized by C++ code even for aircrafts which do not use the radio.
         # To avoid transmitting the frequency for an unused radio (which would make it functional
@@ -46,6 +46,30 @@ var GenericRadio = {
         me.listeners = {};
         me.timers = {};
         me.aliases = {};
+
+        # Update the udp string once a prop changes;
+        # for this register a new distinct output subnode
+        if (me.is_used) {
+            me.fgcomPacketStr = me.outputRootNode.addChild("COM", 1);
+            print("Addon FGCom-mumble     registered output node as "~me.fgcomPacketStr.getPath());
+            me.fields2props = {
+                # Map the fgcom-mumble protocol fields to properties
+                FRQ:     me.fgcom_root.getPath() ~ "/selected-mhz",
+                CWKHZ:   me.root.getPath()       ~ "/frequencies/selected-channel-width-khz",
+                PBT:     me.root.getPath()       ~ "/operable",
+                PTT:     me.fgcom_root.getPath() ~ "/ptt",
+                VOL:     me.fgcom_root.getPath() ~ "/volume",
+                PWR:     me.root.getPath()       ~ "/tx-power",
+                SQC:     me.root.getPath()       ~ "/cutoff-signal-quality",
+                RDF:     me.fgcom_root.getPath() ~ "/rdf-enabled",
+                PUBLISH: me.fgcom_root.getPath() ~ "/publish",
+            };
+            foreach (var f; keys(me.fields2props)) {
+                print("Addon FGCom-mumble     add listener for " ~ f ~ " ("~me.fields2props[f]~")");
+                me.listeners["upd_udp_field:"~f] = setlistener(me.fields2props[f], func { me.updatePacketString(); }, 0, 0);
+            }
+            me.updatePacketString();
+        }
     },
 
     del: func {
@@ -55,6 +79,22 @@ var GenericRadio = {
         me.listeners = {};
         me.timers = {};
         me.aliases = {};
+        fgcomPacketStr.setValue("");
+    },
+
+    updatePacketString: func {
+        # Generates the FGCom-mumble udp packet string for this radio
+        if (me.fgcomPacketStr == nil) return;
+
+        # stringify the props, fields are only added if the prop exists
+        var fields = [];
+        foreach (var f; keys(me.fields2props)) {
+            var propval = getprop(me.fields2props[f]);
+            #print("Addon FGCom-mumble     generate udp packet field: "~f~ " ("~(propval != nil? propval:"<nil>")~")");
+            if (propval != nil) append(fields, "COM" ~ me.fgcomPacketStr.getIndex() ~ "_" ~ f ~ "=" ~ propval);
+        }
+
+        me.fgcomPacketStr.setValue(string.join(",", fields));
     },
 };
 
@@ -98,6 +138,7 @@ var ADF = {
 
     new: func(root) {
         var r = { parents: [ADF, GenericRadio.new(root)], };
+        r.udp_prefix = "ADF" ~ (root.getIndex() + 1);
         r.init();
         return r;
     },
@@ -209,16 +250,26 @@ var COM_radios = {};
 var ADF_radios = {};
 
 var create_radios = func {
-    for (var i=0; i<n_COM; i+=1) {
-        if (contains(COM_radios, i+COM_offset)) continue;
-        COM_radios[i+COM_offset] = COM.new(props.globals.getNode("instrumentation/comm["~i~"]", 1));
+    var i = 1;
+    # Walk all com entries and create instances
+    foreach (r; props.globals.getNode("/instrumentation/").getChildren("comm") ) {
+        COM_radios[i] = COM.new(r);
+        i = i + 1;
     }
-    for (var i=0; i<n_ADF; i+=1) {
-        if (contains(ADF_radios, i+ADF_offset)) continue;
-        ADF_radios[i+ADF_offset] = ADF.new(props.globals.getNode("instrumentation/adf["~i~"]", 1));
+
+    # Walk all ADF entries and create isntances
+    foreach (r; props.globals.getNode("/instrumentation/").getChildren("adf") ) {
+        ADF_radios[i] = ADF.new(r);
+        i = i + 1;
     }
 }
 
+var update_radios = func {
+    foreach (var i; keys(COM_radios)) COM_radios[i].updatePacketString();
+    foreach (var i; keys(ADF_radios)) ADF_radios[i].updatePacketString();
+}
+
+
 var destroy_radios = func {
     foreach (var i; keys(COM_radios)) COM_radios[i].del();
     foreach (var i; keys(ADF_radios)) ADF_radios[i].del();