fgcom-mumble.xml

<?xml version="1.0"?>

<PropertyList>
 <comment>
  <![CDATA[
    This is the protocol definition for fgcom-mumble - a realtime communication
    middleware based on Mumble for FlightGear
    See https://github.com/hbeni/fgcom-mumble

    Install: just copy the protocol file to your flightgear installation
             `Protocol` folder to make it available to flightgear.

    Usage in launcher:
    # fgfs --generic=socket,out,<hz>,<host>,16661,udp,fgcom-mumble

    Check flightgear is sending data with:
    #  netcat -u -l -p 16661

    You can also send data to the plugin manually:
    (<clientport> will be reported from mumble when the first UDP packet arrives)
    #  echo "COM1_FRQ=123.45,COM1_PTT=1,......" | netcat -q0 -u localhost 16661 -p <clientport>
    
  ]]>
 </comment>

 <generic>

  <!-- The following output is expected to be parsed from the mumble-plugin.
       It will be designed so that order or occurrence of the fields does not matter:
       The fields are parsed from left to right and the values updated accordingly.
       
       If a field is missing (or its content is empty), the previous value will stay intact.
       We supply most stuff here as string to the protocol, so the plugin can
       distinguish between "missing" and "zero" values.
  -->
  <output>
   <line_separator>newline</line_separator>
   <var_separator>,</var_separator>
   
   
   <!--  #####################  -->
   <!--  #  RADIO DATA  #  -->
   <!--  #####################  -->
   <!-- This is dynamically created from the nasal addon code -->
   <chunk>
    <name>radios_data1</name>
    <type>string</type>
    <format>%s</format>
    <node>/addons/by-id/org.hallinger.flightgear.FGCom-mumble/output/udp[0]</node>
   </chunk>
   <chunk>
    <name>radios_data2</name>
    <type>string</type>
    <format>%s</format>
    <node>/addons/by-id/org.hallinger.flightgear.FGCom-mumble/output/udp[1]</node>
   </chunk>
   <chunk>
    <name>radios_data3</name>
    <type>string</type>
    <format>%s</format>
    <node>/addons/by-id/org.hallinger.flightgear.FGCom-mumble/output/udp[2]</node>
   </chunk>
   <chunk>
    <name>radios_data4</name>
    <type>string</type>
    <format>%s</format>
    <node>/addons/by-id/org.hallinger.flightgear.FGCom-mumble/output/udp[3]</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.
        The UDP server takes care to parse this properly into the new format.
        Note however, this overrides the individual COM-PTTs above. -->
   <chunk>
    <name>fgcom-ptt-compatibility</name>
    <type>string</type>
    <format>PTT=%s</format> <!-- 0=inactive, 1=COM1, 2=COM2 -->
    <node>/controls/radios/comm-ptt</node>
   </chunk>

   <!--  #####################  -->
   <!--  #  POSITIONAL DATA  #  -->
   <!--  #####################  -->

   <chunk>
    <name>pos-longitude-deg</name>
    <type>float</type>
    <format>LON=%03.6f</format>
    <node>/position/longitude-deg</node>
   </chunk>

   <chunk>
    <name>pos-latitude-deg</name>
    <type>float</type>
    <format>LAT=%03.6f</format>
    <node>/position/latitude-deg</node>
   </chunk>

   <chunk>
    <name>pos-alt</name>
    <type>float</type>
    <format>ALT=%05.0f</format>
    <node>/position/altitude-agl-ft</node>
   </chunk>

   <!--  #########################  -->
   <!--  #  IDENTIFICATION DATA  #  -->
   <!--  #########################  -->

   <chunk>
    <name>callsign</name>
    <type>string</type>
    <format>CALLSIGN=%s</format>
    <node>/sim/multiplay/callsign</node>
   </chunk>


   <!--  #########################  -->
   <!--  #         OPTIONS       #  -->
   <!--  #########################  -->
   <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>audio-effects-enabled</name>
    <type>bool</type>
    <format>AUDIO_FX_RADIO=%d</format>
    <node>/addons/by-id/org.hallinger.flightgear.FGCom-mumble/audio-effects-enabled</node>
   </chunk>
   <chunk>
    <name>audio-hear-all</name>
    <type>bool</type>
    <format>AUDIO_HEAR_ALL=%d</format>
    <node>/addons/by-id/org.hallinger.flightgear.FGCom-mumble/audio-hear-all</node>
   </chunk>
  </output>


  <input>
    <line_separator>newline</line_separator>
    <var_separator>,</var_separator>
    <!-- RDF info format is this: "RDF:CS_TX=Test,FRQ=123.45,DIR=180.5,VRT=12.5,QLY=0.98,ID_RX=1" -->
    <chunk>
        <name>RDF data: Callsign</name>
        <type>string</type>
        <node>/addons/by-id/org.hallinger.flightgear.FGCom-mumble/rdfinput/callsign</node>
    </chunk>
    <chunk>
        <name>RDF data: Frequency</name>
        <type>string</type>
        <node>/addons/by-id/org.hallinger.flightgear.FGCom-mumble/rdfinput/frequency</node>
    </chunk>
    <chunk>
        <name>RDF data: Direction</name>
        <type>string</type>
        <node>/addons/by-id/org.hallinger.flightgear.FGCom-mumble/rdfinput/direction</node>
    </chunk>
    <chunk>
        <name>RDF data: vertical angle</name>
        <type>string</type>
        <node>/addons/by-id/org.hallinger.flightgear.FGCom-mumble/rdfinput/angle</node>
    </chunk>
    <chunk>
        <name>RDF data: Quality</name>
        <type>string</type>
        <node>/addons/by-id/org.hallinger.flightgear.FGCom-mumble/rdfinput/quality</node>
    </chunk>
    <chunk>
        <name>RDF data: Radio index</name>
        <type>string</type>
        <node>/addons/by-id/org.hallinger.flightgear.FGCom-mumble/rdfinput/radio</node>
    </chunk>
  </input>

 </generic>
</PropertyList>