feat(a380x/fms): Secondary flight plans for the A380X (#10429)

* feat: initial commit

* fix(fms): some sync fixes

* fix(a380/fmc): FMC initialization fixes

* feat: request route from avionics wip

* fix: rework syncing of segments to sync procedure changes

* fix: syncing of runways to msfs

* refactor: cleanup

* fix: syncing of origin/destination airport/runways

* fix: unused import

* fix: lint

* fix: initialization and race condition fixes

* chore: remove debug logs

* refactor: draft of refactored airway entry

* fix: more sync fixes, batches

* refactor: more airways work

* refactor: more cleanup, move batch tests

* refactor: more airways work, add integration tests

* test: add simple rpc client unit tests, remove old integration tests

* test: re-enable leg test

* feat: route airways

* chore: fix copyright

* fix: runway conversion and changed property name

* feat: enroute legs to EFB

* feat: add sync support to DataManager

* feat: sync pilot waypoints to sim

* feat: import pilot waypoints, send cruise alt

* fix(a32nx): don't instantiate FlightPlanAsoboSync in MSFS2024

* fix(a32nx): get 2024 sync running

* chore: that's a bit excessive

* feat: add auto-import setting to EFB

* fix: import

* fix: types

* fix: simbrief and coroute adapters

* chore: lint

* fix: test runway designator

* fix: mcdu airways

* chore: address review comments

* chore: address review comments 2

* fix: fix leaked subscription, better property name

* chore: remove unused test code

* chore: formatting

* fix: use new RunwayUtils method

* refactor: use better sync client ID RNG

* fix: a320 airways

* fix: type annotation

* fix: after merge fixes

* fix: various fixes

* refactor: host route sync on FMC

* test: fix tests

* fix: issues after merge and types

* fix: strict error

* chore: lint

* fix: address review comments

* fix enginesWereStarted condition

* switch to readonly flight plans

* prepare for migration to A380FlightPlanPerformanceData

* batch 1

* batch 2

* add SEC INDEX initial

* bugfixes

* batch 3

* fix: post merge fixes

* fix: post merge fixes #2

* some more additions

* batch 4

* fix tests, imports

* found some more

* more strictness

* fix #234346

* add another mock implementation

* fix strict mode

* flight plan creation source

* BM's review comments

(cherry picked from commit 0439b4a)

* WAITING FOR INSERTION IN XXXX message; SEC FPLN source whitespace fix; move CPNY FPLN button code to util

* changelog

* SEC tab navigation from url

* some cpny fpln button changes

* merge fixes

* holland's comments

* try to fix case

* try to fix case #2

* draw waypoints in white for SEC FPLN on ND in A380X

* extend SEC on ND to three SEC FPLN for A380X

* some fixes from QA

* remove debug msg & fix console errors

* that didn't work

* introduce Dummy FMCs, enable flight plan sync on non-master again.

* fix INSERT NEXT WPT on first element; fix step climbs for non-active FPLN

* fix KCCU events not respecting side; add KCCU input to ND/OANS

* add JSdoc

* make master always available, and point to the one real FMC

* add FlightPlanInterface to props

* hook up keyboard to OIT

* fix taxi fuel, extra fuel, LW estimation

* fix: use pd presel speeds & approach flap setting

* fix: make callsign subject. Fix LW & TOW calcs

* fix: tropo, crz & taxi fuel errors

* fix: mfd perf speeds & taxi fuel defaults

* fix: tropo read value should not be pilot entry

* chore: sync large-files

* fix: wrong stash commit. Fuel and loud route reserve

* chore: use common method for RTE RSV

* fix: invalidate fuel pred in SEC

* fix: disable more preds in MFD PERF

* fix: presel speed display. Hide PRED TO in SEC

* fix: RTE RSV percentage calc

* fix: final time fuel calcs

* fix: sec exceptions. flight number not being set for fmgc

* fix: change condition of pilot entry reserves

* fix: disable some fields if copy of active

* fix: colours in fuel & load SEC

* fix: only show dest efob amber in primary. Make perf calc speeds white

* fix: add alternate & fin res fuel to performance data

* fix: change some colors in hold and vert rev

* fix: cleanup some classes

* fix: merge conflicts

* chore: fix strict errors

* fix: disable fix info in sec

* fix: fpln page not showing dist of SEC

* fix: rte rsv pilot entry not visible in SEC

* fix: cleanup some more PD. Bring simplified res fuel calcs to SEC too

* fix: navigate to active if SEC deleted. Only create SEC on page nav

* fix: handle case of no FP in INIT if deleted on other MFD

* fix: loaded sec index not being set if does not exist

* fix: fqms conflicts

* chore: simply getfob

* chore: bbk comments part 1

* feat: change sec created to epoch

* fix: flags only being set after rpc. ground temperature undefined error

* fix: retain flags on sec copy to sec copy. Pipe cost index mode too

* chore: fix 32nx build error due to pd gnd temp

* fix: convert fqms fob to tons

* fix: extra fuel unit error

* fix: a32nx cruise temperature error

* fix: only set flex if active flightplan

* chore: remove non applicable document

* fix: retain 0 deg flex setting

* fix: fadec not being overriten

* fix: selected not updating on & wrong speeds in perf

* fix: make vapp consistent with vls etc

* fix: vapp not being used by systems

---------

Co-authored-by: Benjamin Dupont <4503241+Benjozork@users.noreply.github.com>
Co-authored-by: BravoMike99 <119708186+BravoMike99@users.noreply.github.com>

Author: 3 people

.github/CHANGELOG.md

@@ -100,6 +100,8 @@
 1. [A380X/MFD] Fix CPNY F-PLN REQUEST button disabled when airport ICAO not found in failed Simbrief import - @heclak (Heclak)
 1. [A380X/RMP] Fix FO RMP integrated lights not working - @heclak (Heclak)
 1. [A32NX/FWS] Add `GEAR NOT DOWNLOCKED` master warning - @FozzieHi (fozzie)
+1. [A380X/FMS] Add secondary flight plans to A380X - @flogross89 (floridude), @BravoMike99 (bruno_pt99)
+1. [A380X/FMS] Allow edition of vnav descent speed - @BravoMike99 (bruno_pt99)
 
 ## 0.14.0
 

fbw-a32nx/src/systems/extras-host/modules/flightplan_sync/FlightPlanAsoboSync.ts

@@ -29,7 +29,7 @@ import { ApproachType as MSApproachType } from '../../../../../../fbw-common/src
 import { FacilityCache } from '../../../../../../fbw-common/src/systems/navdata/client/backends/Msfs/FacilityCache';
 import { NavigationDatabaseService } from '@fmgc/flightplanning/NavigationDatabaseService';
 import { NavigationDatabase, NavigationDatabaseBackend } from '@fmgc/NavigationDatabase';
-import { A320FlightPlanPerformanceData } from '@fmgc/flightplanning/plans/performance/FlightPlanPerformanceData';
+import { A320FlightPlanPerformanceData } from '@fmgc/flightplanning/plans/performance/A320FlightPlanPerformanceData';
 import { FlightPlanIndex } from '@fmgc/flightplanning/FlightPlanManager';
 
 export class FlightPlanAsoboSync {

fbw-a32nx/src/systems/fmgc/src/efis/EfisInterface.ts

@@ -24,12 +24,14 @@ export class EfisInterface {
   static readonly A32NX_NUM_LEGS_ON_FPLN_PAGE = 5;
 
   constructor(
-    private side: EfisSide,
-    private flightPlanService: FlightPlanService,
+    private readonly side: EfisSide,
+    private readonly flightPlanService: FlightPlanService,
     private numLegOnFplnPage = EfisInterface.A32NX_NUM_LEGS_ON_FPLN_PAGE,
+    public readonly numSecondaryFlightPlans: number = 1,
   ) {}
 
-  private isSecRelatedPageOpen: boolean = false;
+  /** Index of secondary flight plan for which related page is open. Null if no related page for any secondary flight plan is open.  */
+  private secRelatedPageOpenIndex: number | null = null;
 
   readonly planCentre: PlanCentre = {
     fpIndex: 0,
@@ -59,9 +61,9 @@ export class EfisInterface {
     this.version++;
   }
 
-  setSecRelatedPageOpen(open: boolean): void {
-    if (this.isSecRelatedPageOpen !== open) {
-      this.isSecRelatedPageOpen = open;
+  setSecRelatedPageOpen(secIndex: number | null): void {
+    if (this.secRelatedPageOpenIndex !== secIndex) {
+      this.secRelatedPageOpenIndex = secIndex;
       this.version++;
     }
   }
@@ -74,8 +76,12 @@ export class EfisInterface {
     // Don't increment version here, the real one takes a bit of time to update as well
   }
 
-  shouldTransmitSecondary(): boolean {
-    return this.isSecRelatedPageOpen;
+  shouldTransmitSecondary(secondaryIndex: number = 1): boolean {
+    return this.secRelatedPageOpenIndex === secondaryIndex;
+  }
+
+  shouldTransmitAnySecondary(): boolean {
+    return this.secRelatedPageOpenIndex !== null;
   }
 
   shouldTransmitMissed(planIndex: FlightPlanIndex, isPlanMode: boolean): boolean {

fbw-a32nx/src/systems/fmgc/src/efis/EfisSymbols.ts

@@ -210,19 +210,28 @@ export class EfisSymbols<T extends number> {
     const tempFpVersion = this.flightPlanService.has(FlightPlanIndex.Temporary)
       ? this.flightPlanService.temporary.version
       : -1;
-    const secFpVersion = this.flightPlanService.has(FlightPlanIndex.FirstSecondary)
-      ? this.flightPlanService.secondary(1).version
-      : -1;
 
     const activeFPVersionChanged = this.lastFpVersions[FlightPlanIndex.Active] !== activeFpVersion;
     const tempFPVersionChanged = this.lastFpVersions[FlightPlanIndex.Temporary] !== tempFpVersion;
-    const secFPVersionChanged = this.lastFpVersions[FlightPlanIndex.FirstSecondary] !== secFpVersion;
+    let secFPVersionChanged = false;
+    for (let i = 0; i < this.efisInterface.numSecondaryFlightPlans; i++) {
+      const secVersion = this.flightPlanService.has(FlightPlanIndex.FirstSecondary + i)
+        ? this.flightPlanService.secondary(i + 1).version
+        : -1;
+      secFPVersionChanged ||= this.lastFpVersions[FlightPlanIndex.FirstSecondary + i] !== secVersion;
+    }
 
     const fpChanged = activeFPVersionChanged || tempFPVersionChanged || secFPVersionChanged;
 
     this.lastFpVersions[FlightPlanIndex.Active] = activeFpVersion;
     this.lastFpVersions[FlightPlanIndex.Temporary] = tempFpVersion;
-    this.lastFpVersions[FlightPlanIndex.FirstSecondary] = secFpVersion;
+    for (let i = 0; i < this.efisInterface.numSecondaryFlightPlans; i++) {
+      this.lastFpVersions[FlightPlanIndex.FirstSecondary + i] = this.flightPlanService.has(
+        FlightPlanIndex.FirstSecondary + i,
+      )
+        ? this.flightPlanService.secondary(i + 1).version
+        : -1;
+    }
 
     const navaidsChanged = this.lastNavaidVersion !== this.navaidTuner.navaidVersion;
     this.lastNavaidVersion = this.navaidTuner.navaidVersion;
@@ -504,40 +513,16 @@ export class EfisSymbols<T extends number> {
     }
 
     // SEC
-    if (
-      this.flightPlanService.hasSecondary(1) &&
-      this.guidanceController.hasGeometryForFlightPlan(FlightPlanIndex.FirstSecondary) &&
-      this.efisInterface.shouldTransmitSecondary()
-    ) {
-      const symbols = this.getFlightPlanSymbols(
-        false,
-        this.flightPlanService.secondary(1),
-        this.guidanceController.secondaryGeometry,
-        range,
-        efisOption,
-        mode,
-        this.side,
-        mapReferencePoint,
-        mapOrientation,
-        editArea,
-        formatConstraintAlt,
-        formatConstraintSpeed,
-      );
-
-      for (const symbol of symbols) {
-        upsertSymbol(symbol);
-      }
-
-      // SEC ALTN
+    for (let secIndex = 1; secIndex <= this.efisInterface.numSecondaryFlightPlans; secIndex++) {
       if (
-        this.flightPlanService.secondary(1).alternateFlightPlan.legCount > 0 &&
-        this.guidanceController.hasGeometryForFlightPlan(FlightPlanIndex.FirstSecondary) &&
-        this.efisInterface.shouldTransmitAlternate(FlightPlanIndex.FirstSecondary, mode === EfisNdMode.PLAN)
+        this.flightPlanService.hasSecondary(secIndex) &&
+        this.guidanceController.hasGeometryForFlightPlan(FlightPlanIndex.FirstSecondary + secIndex - 1) &&
+        this.efisInterface.shouldTransmitSecondary(secIndex)
       ) {
         const symbols = this.getFlightPlanSymbols(
-          true,
-          this.flightPlanService.secondary(1).alternateFlightPlan,
-          this.guidanceController.getGeometryForFlightPlan(FlightPlanIndex.FirstSecondary, true),
+          false,
+          this.flightPlanService.secondary(secIndex),
+          this.guidanceController.secondaryGeometry(secIndex),
           range,
           efisOption,
           mode,
@@ -552,6 +537,35 @@ export class EfisSymbols<T extends number> {
         for (const symbol of symbols) {
           upsertSymbol(symbol);
         }
+
+        // SEC ALTN
+        if (
+          this.flightPlanService.secondary(secIndex).alternateFlightPlan.legCount > 0 &&
+          this.guidanceController.hasGeometryForFlightPlan(FlightPlanIndex.FirstSecondary + secIndex - 1) &&
+          this.efisInterface.shouldTransmitAlternate(
+            FlightPlanIndex.FirstSecondary + secIndex - 1,
+            mode === EfisNdMode.PLAN,
+          )
+        ) {
+          const symbols = this.getFlightPlanSymbols(
+            true,
+            this.flightPlanService.secondary(secIndex).alternateFlightPlan,
+            this.guidanceController.getGeometryForFlightPlan(FlightPlanIndex.FirstSecondary + secIndex - 1, true),
+            range,
+            efisOption,
+            mode,
+            this.side,
+            mapReferencePoint,
+            mapOrientation,
+            editArea,
+            formatConstraintAlt,
+            formatConstraintSpeed,
+          );
+
+          for (const symbol of symbols) {
+            upsertSymbol(symbol);
+          }
+        }
       }
     }
 
@@ -753,6 +767,8 @@ export class EfisSymbols<T extends number> {
           type |= NdSymbolTypeFlags.CourseReversalRight;
         }
         direction = MagVar.getLegTrueCourse(leg.definition);
+      } else if (flightPlan.index >= FlightPlanIndex.FirstSecondary) {
+        type |= NdSymbolTypeFlags.SecondaryFlightPlan;
       }
 
       if (i >= flightPlan.firstMissedApproachLegIndex && !transmitMissed) {

fbw-a32nx/src/systems/fmgc/src/efis/EfisVectors.ts

@@ -76,7 +76,10 @@ export class EfisVectors {
 
       this.tryProcessFlightPlan(FlightPlanIndex.Active, side, true);
       this.tryProcessFlightPlan(FlightPlanIndex.Temporary, side, true);
-      this.tryProcessFlightPlan(FlightPlanIndex.FirstSecondary, side, true);
+
+      for (let i = 1; i <= this.efisInterfaces[side].numSecondaryFlightPlans; i++) {
+        this.tryProcessFlightPlan(FlightPlanIndex.FirstSecondary + i - 1, side, true);
+      }
 
       const activeFlightPlanVectors =
         this.guidanceController.activeGeometry?.getAllPathVectors(this.guidanceController.activeLegIndex) ?? [];
@@ -93,7 +96,10 @@ export class EfisVectors {
     } else {
       this.tryProcessFlightPlan(FlightPlanIndex.Active, side);
       this.tryProcessFlightPlan(FlightPlanIndex.Temporary, side);
-      this.tryProcessFlightPlan(FlightPlanIndex.FirstSecondary, side);
+
+      for (let i = 1; i <= this.efisInterfaces[side].numSecondaryFlightPlans; i++) {
+        this.tryProcessFlightPlan(FlightPlanIndex.FirstSecondary + i - 1, side);
+      }
     }
   }
 
@@ -129,7 +135,9 @@ export class EfisVectors {
         case FlightPlanIndex.FirstSecondary:
         case FlightPlanIndex.Uplink:
         default:
-          this.transmit(null, EfisVectorsGroup.SECONDARY, side);
+          if (!this.efisInterfaces[side].shouldTransmitAnySecondary()) {
+            this.transmit(null, EfisVectorsGroup.SECONDARY, side);
+          }
           break;
       }
 
@@ -194,9 +202,9 @@ export class EfisVectors {
         this.transmitFlightPlan(plan, side, EfisVectorsGroup.TEMPORARY);
         break;
       default:
-        if (this.efisInterfaces[side].shouldTransmitSecondary()) {
+        if (this.efisInterfaces[side].shouldTransmitSecondary(planIndex - FlightPlanIndex.FirstSecondary + 1)) {
           this.transmitFlightPlan(plan, side, EfisVectorsGroup.SECONDARY);
-        } else {
+        } else if (!this.efisInterfaces[side].shouldTransmitAnySecondary()) {
           this.transmit(null, EfisVectorsGroup.SECONDARY, side);
         }
         break;

fbw-a32nx/src/systems/fmgc/src/flightplanning/A320AircraftConfig.ts

@@ -12,6 +12,7 @@ import {
   VnavDescentMode,
 } from '@fmgc/flightplanning/AircraftConfigTypes';
 import { FlapConf } from '@fmgc/guidance/vnav/common';
+import { FpmConfigs } from './FpmConfig';
 
 const lnavConfig: LnavConfig = {
   DEFAULT_MIN_PREDICTED_TAS: 160,
@@ -151,4 +152,5 @@ export const A320AircraftConfig: AircraftConfig = {
   engineModelParameters: engineModelParams,
   flightModelParameters: flightModelParams,
   fmSymbolConfig: fmsSymbolConfig,
+  fpmConfig: FpmConfigs.A320_HONEYWELL_H3,
 };

fbw-a32nx/src/systems/fmgc/src/flightplanning/A380AircraftConfig.ts

@@ -12,6 +12,7 @@ import {
   VnavDescentMode,
 } from '@fmgc/flightplanning/AircraftConfigTypes';
 import { FlapConf } from '@fmgc/guidance/vnav/common';
+import { FpmConfigs } from './FpmConfig';
 
 const lnavConfig: LnavConfig = {
   DEFAULT_MIN_PREDICTED_TAS: 160,
@@ -178,4 +179,5 @@ export const A380AircraftConfig: AircraftConfig = {
   engineModelParameters: engineModelParams,
   flightModelParameters: flightModelParams,
   fmSymbolConfig: fmsSymbolConfig,
+  fpmConfig: FpmConfigs.A380,
 };

fbw-a32nx/src/systems/fmgc/src/flightplanning/AircraftConfigTypes.ts

@@ -1,8 +1,9 @@
-// Copyright (c) 2021-2022 FlyByWire Simulations
+// Copyright (c) 2021-2026 FlyByWire Simulations
 //
 // SPDX-License-Identifier: GPL-3.0
 
 import { FlapConf } from '@fmgc/guidance/vnav/common';
+import { FpmConfig } from './FpmConfig';
 
 export enum VnavDescentMode {
   NORMAL,
@@ -16,6 +17,7 @@ export interface AircraftConfig {
   engineModelParameters: EngineModelParameters;
   flightModelParameters: FlightModelParameters;
   fmSymbolConfig: FMSymbolsConfig;
+  fpmConfig: FpmConfig;
 }
 
 export interface VnavConfig {

fbw-a32nx/src/systems/fmgc/src/flightplanning/FlightPlanInterface.integration.spec.ts

@@ -4,7 +4,7 @@ import { testFlightPlanService } from './test/TestFlightPlanService';
 import { NavigationDatabaseService } from './NavigationDatabaseService';
 import { FlightPlanIndex } from './FlightPlanManager';
 import { FlightPlanRpcClient } from '@fmgc/flightplanning/rpc/FlightPlanRpcClient';
-import { A320FlightPlanPerformanceData } from '@fmgc/flightplanning/plans/performance/FlightPlanPerformanceData';
+import { A320FlightPlanPerformanceData } from '@fmgc/flightplanning/plans/performance/A320FlightPlanPerformanceData';
 import { FlightPlanRpcServer } from '@fmgc/flightplanning/rpc/FlightPlanRpcServer';
 import { setupTestDatabase } from '@fmgc/flightplanning/test/Database';
 import { testEventBus } from '@fmgc/flightplanning/test/TestEventBus';

fbw-a32nx/src/systems/fmgc/src/flightplanning/FlightPlanInterface.ts

@@ -59,6 +59,14 @@ export interface FlightPlanInterface<P extends FlightPlanPerformanceData = Fligh
    */
   secondaryCopyFromActive(index: number, isBeforeEngineStart: boolean): Promise<void>;
 
+  /**
+   * Copies the secondary flight plan into another secondary flight plan
+   *
+   * @param from the 1-indexed index of the source secondary flight plan
+   * @param to the 1-indexed index of the destination secondary flight plan
+   */
+  secondaryCopyFromSecondary(from: number, to: number, isBeforeEngineStart: boolean): Promise<void>;
+
   secondaryDelete(index: number): Promise<void>;
 
   secondaryReset(index: number): Promise<void>;
@@ -290,7 +298,7 @@ export interface FlightPlanInterface<P extends FlightPlanPerformanceData = Fligh
   addOrEditManualHold(
     atIndex: number,
     desiredHold: HoldData,
-    modifiedHold: HoldData,
+    modifiedHold: HoldData | undefined,
     defaultHold: HoldData,
     planIndex: number,
     alternate?: boolean,
@@ -334,6 +342,25 @@ export interface FlightPlanInterface<P extends FlightPlanPerformanceData = Fligh
     alternate?: boolean,
   ): Promise<void>;
 
+  /**
+   * Sets whether a fix at an index should be overflown or not.
+   *
+   * @param atIndex the index of the leg to start the pending airway entry at
+   * @param overfly Whether fix should be overflown or not.
+   * @param planIndex which flight plan to make the change on
+   * @param alternate whether to edit the plan's alternate flight plan
+   */
+  setOverfly(atIndex: number, overfly: boolean, planIndex: number, alternate: boolean): Promise<void>;
+
+  /**
+   * Toggle whether a fix at an index should be overflown or not.
+   *
+   * @param atIndex the index of the leg to start the pending airway entry at
+   * @param planIndex which flight plan to make the change on
+   * @param alternate whether to edit the plan's alternate flight plan
+   */
+  toggleOverfly(atIndex: number, planIndex: number, alternate: boolean): Promise<void>;
+
   setFixInfoEntry(index: 1 | 2 | 3 | 4, fixInfo: FixInfoEntry | null, planIndex: number): Promise<void>;
 
   // TODO do not pass in callback (rpc)