[#1323] add downlinkHandling diagrams and figures

dhutererprats · dhutererprats · commit c4a57b101ef5 · 2026-03-11T19:38:37.000-06:00
diff --git a/src/simulation/communication/downlinkHandling/_Documentation/Images/DownlinkHandlingFlow.svg b/src/simulation/communication/downlinkHandling/_Documentation/Images/DownlinkHandlingFlow.svg
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" width="1600" height="820" viewBox="0 0 1600 820">
+  <defs>
+    <style>
+      .title { font: 700 36px Arial, Helvetica, sans-serif; fill: #17233a; }
+      .label { font: 600 24px Arial, Helvetica, sans-serif; fill: #17233a; }
+      .small { font: 500 20px Arial, Helvetica, sans-serif; fill: #2a3b55; }
+      .box { stroke: #2f4f6f; stroke-width: 3; rx: 20; ry: 20; }
+      .arrow { stroke: #2f4f6f; stroke-width: 4; fill: none; marker-end: url(#arrowHead); }
+      .arrowDashed { stroke: #506d8e; stroke-width: 3; fill: none; stroke-dasharray: 12 10; marker-end: url(#arrowHeadLite); }
+    </style>
+    <marker id="arrowHead" markerWidth="14" markerHeight="10" refX="12" refY="5" orient="auto">
+      <path d="M0,0 L12,5 L0,10 Z" fill="#2f4f6f"/>
+    </marker>
+    <marker id="arrowHeadLite" markerWidth="14" markerHeight="10" refX="12" refY="5" orient="auto">
+      <path d="M0,0 L12,5 L0,10 Z" fill="#506d8e"/>
+    </marker>
+  </defs>
+
+  <rect x="0" y="0" width="1600" height="820" fill="#f5f8fc"/>
+  <text x="800" y="58" text-anchor="middle" class="title">downlinkHandling Integration and Message Flow</text>
+
+  <rect class="box" x="80" y="120" width="280" height="170" fill="#deebfa"/>
+  <text x="220" y="175" text-anchor="middle" class="label">simpleAntenna #1</text>
+  <text x="220" y="212" text-anchor="middle" class="small">AntennaLogMsgPayload</text>
+  <text x="220" y="244" text-anchor="middle" class="small">(state, gain/noise, pointing)</text>
+
+  <rect class="box" x="80" y="350" width="280" height="170" fill="#deebfa"/>
+  <text x="220" y="405" text-anchor="middle" class="label">simpleAntenna #2</text>
+  <text x="220" y="442" text-anchor="middle" class="small">AntennaLogMsgPayload</text>
+  <text x="220" y="474" text-anchor="middle" class="small">(state, gain/noise, pointing)</text>
+
+  <rect class="box" x="470" y="215" width="300" height="210" fill="#d7f2ea"/>
+  <text x="620" y="275" text-anchor="middle" class="label">linkBudget</text>
+  <text x="620" y="312" text-anchor="middle" class="small">LinkBudgetMsgPayload</text>
+  <text x="620" y="346" text-anchor="middle" class="small">CNR1, CNR2, bandwidth,</text>
+  <text x="620" y="378" text-anchor="middle" class="small">antennaState1, antennaState2</text>
+
+  <rect class="box" x="900" y="190" width="360" height="260" fill="#f7e4d1"/>
+  <text x="1080" y="250" text-anchor="middle" class="label">downlinkHandling</text>
+  <text x="1080" y="288" text-anchor="middle" class="small">CNR → BER → PER → ARQ</text>
+  <text x="1080" y="322" text-anchor="middle" class="small">attempt/remove/deliver/drop</text>
+  <text x="1080" y="356" text-anchor="middle" class="small">storage saturation + packet gate</text>
+  <text x="1080" y="390" text-anchor="middle" class="small">nodeDataOutMsg + diagnostics</text>
+
+  <rect class="box" x="1320" y="190" width="220" height="260" fill="#dcefd3"/>
+  <text x="1430" y="254" text-anchor="middle" class="label">Storage Unit</text>
+  <text x="1430" y="290" text-anchor="middle" class="small">DataStorageStatus</text>
+  <text x="1430" y="324" text-anchor="middle" class="small">partition bits/names</text>
+  <text x="1430" y="358" text-anchor="middle" class="small">consumes</text>
+  <text x="1430" y="390" text-anchor="middle" class="small">DataNodeUsage</text>
+
+  <rect class="box" x="900" y="520" width="640" height="220" fill="#e8eef8"/>
+  <text x="1220" y="582" text-anchor="middle" class="label">DownlinkHandlingMsgPayload (Diagnostics)</text>
+  <text x="1220" y="618" text-anchor="middle" class="small">linkActive, receiverIndex, BER, PER, packetSuccess/drop, expectedAttempts</text>
+  <text x="1220" y="652" text-anchor="middle" class="small">attempted/removal/delivered/dropped rates, remaining bits, cumulative counters</text>
+
+  <path class="arrow" d="M360 205 L470 270"/>
+  <path class="arrow" d="M360 435 L470 370"/>
+  <path class="arrow" d="M770 320 L900 320"/>
+  <path class="arrow" d="M1260 320 L1320 320"/>
+  <path class="arrowDashed" d="M1320 360 L1260 360"/>
+  <path class="arrowDashed" d="M900 400 L760 520 L760 630 L900 630"/>
+</svg>
diff --git a/src/simulation/communication/downlinkHandling/_Documentation/Images/DownlinkHandlingReliabilityChain.svg b/src/simulation/communication/downlinkHandling/_Documentation/Images/DownlinkHandlingReliabilityChain.svg
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" width="1700" height="700" viewBox="0 0 1700 700">
+  <defs>
+    <style>
+      .title { font: 700 34px Arial, Helvetica, sans-serif; fill: #142033; }
+      .hdr { font: 700 22px Arial, Helvetica, sans-serif; fill: #10263c; }
+      .txt { font: 500 19px Arial, Helvetica, sans-serif; fill: #21344f; }
+      .eq { font: 500 20px 'Courier New', monospace; fill: #2a3d5c; }
+      .box { stroke: #365776; stroke-width: 3; rx: 18; ry: 18; }
+      .arrow { stroke: #365776; stroke-width: 4; fill: none; marker-end: url(#arrowHead); }
+    </style>
+    <marker id="arrowHead" markerWidth="14" markerHeight="10" refX="12" refY="5" orient="auto">
+      <path d="M0,0 L12,5 L0,10 Z" fill="#365776"/>
+    </marker>
+  </defs>
+
+  <rect x="0" y="0" width="1700" height="700" fill="#f4f8fe"/>
+  <text x="850" y="58" text-anchor="middle" class="title">CNR to Effective Throughput Pipeline in downlinkHandling</text>
+
+  <rect class="box" x="80" y="120" width="280" height="210" fill="#dff0ff"/>
+  <text x="220" y="170" text-anchor="middle" class="hdr">Link Input</text>
+  <text x="220" y="208" text-anchor="middle" class="txt">selected CNR</text>
+  <text x="220" y="240" text-anchor="middle" class="txt">overlap bandwidth</text>
+  <text x="220" y="282" text-anchor="middle" class="eq">C/N0 = CNR + 10log10(B)</text>
+
+  <rect class="box" x="410" y="120" width="280" height="210" fill="#e3f8ec"/>
+  <text x="550" y="170" text-anchor="middle" class="hdr">Bit-Energy Domain</text>
+  <text x="550" y="208" text-anchor="middle" class="txt">user bit rate Rb</text>
+  <text x="550" y="240" text-anchor="middle" class="eq">Eb/N0 = C/N0 - 10log10(Rb)</text>
+  <text x="550" y="282" text-anchor="middle" class="eq">BER = 0.5*erfc(sqrt(Eb/N0))</text>
+
+  <rect class="box" x="740" y="120" width="280" height="210" fill="#fff1de"/>
+  <text x="880" y="170" text-anchor="middle" class="hdr">Packet Reliability</text>
+  <text x="880" y="208" text-anchor="middle" class="txt">packet size L</text>
+  <text x="880" y="240" text-anchor="middle" class="eq">PER = 1 - (1-BER)^L</text>
+  <text x="880" y="272" text-anchor="middle" class="eq">Pdrop = PER^N</text>
+  <text x="880" y="304" text-anchor="middle" class="eq">Psuccess = 1 - Pdrop</text>
+
+  <rect class="box" x="1070" y="120" width="280" height="210" fill="#efe7ff"/>
+  <text x="1210" y="170" text-anchor="middle" class="hdr">Rate Mapping</text>
+  <text x="1210" y="208" text-anchor="middle" class="eq">E[A] = Psuccess / (1-PER)</text>
+  <text x="1210" y="240" text-anchor="middle" class="eq">Rremove = Rb / E[A]</text>
+  <text x="1210" y="272" text-anchor="middle" class="eq">Rdeliv = Rremove * Psuccess</text>
+  <text x="1210" y="304" text-anchor="middle" class="eq">Rdrop = Rremove - Rdeliv</text>
+
+  <rect class="box" x="1400" y="120" width="220" height="210" fill="#f3f4f7"/>
+  <text x="1510" y="170" text-anchor="middle" class="hdr">Storage Gate</text>
+  <text x="1510" y="208" text-anchor="middle" class="txt">full-packet check</text>
+  <text x="1510" y="240" text-anchor="middle" class="txt">dt + available bits</text>
+  <text x="1510" y="282" text-anchor="middle" class="eq">scale in [0, 1]</text>
+
+  <rect class="box" x="300" y="410" width="1100" height="220" fill="#dbe7f6"/>
+  <text x="850" y="470" text-anchor="middle" class="hdr">Outputs Written Each Step</text>
+  <text x="850" y="510" text-anchor="middle" class="txt">DataNodeUsageMsgPayload: nodeDataOutMsg.baudRate = -Rremove_scaled</text>
+  <text x="850" y="545" text-anchor="middle" class="txt">DownlinkHandlingMsgPayload: BER, PER, success/drop probs, rates, storage estimates, cumulative counters</text>
+  <text x="850" y="580" text-anchor="middle" class="txt">These outputs drive onboard buffer depletion and provide telemetry for fault diagnosis pipelines</text>
+
+  <path class="arrow" d="M360 225 L410 225"/>
+  <path class="arrow" d="M690 225 L740 225"/>
+  <path class="arrow" d="M1020 225 L1070 225"/>
+  <path class="arrow" d="M1350 225 L1400 225"/>
+  <path class="arrow" d="M1510 330 L1510 410"/>
+  <path class="arrow" d="M1210 330 L1210 410"/>
+</svg>
