MSFS 2024 SU4 Release

Author: mattnischan

src/garminsdk/autopilot/FmaData.ts

@@ -1,3 +1,5 @@
+import { APAltitudeModes } from '@microsoft/msfs-sdk';
+
 /**
  * Data describing autopilot status used by Garmin FMAs.
  */
@@ -26,9 +28,30 @@ export type FmaData = {
   /** The armed lateral mode. */
   lateralArmed: number;
 
-  /** Whether the lateral mode is in a failed state. */
+  /**
+   * Whether the lateral mode is in a failed state.
+   * @deprecated Please use `lateralReversionFromMode` instead to access lateral mode reversion state.
+   */
   lateralModeFailed: boolean;
 
+  /**
+   * The lateral mode that was reverted to activate the current lateral mode, or `null` if the current active lateral
+   * mode was not activated due to a mode reversion.
+   */
+  lateralReversionFromMode: number | null;
+
+  /**
+   * The vertical mode that was reverted to activate the current vertical mode, or `null` if the current active
+   * vertical mode was not activated due to a mode reversion.
+   */
+  verticalReversionFromMode: number | null;
+
+  /**
+   * The altitude capture mode that was reverted to activate the current vertical mode, or `null` if the current active
+   * vertical mode was not activated due to a mode reversion.
+   */
+  verticalAltitudeReversionFromMode: APAltitudeModes | null;
+
   /** The state of VNAV to be displayed on the FMA. */
   vnavState: FmaVNavState;
 }

src/garminsdk/autopilot/GarminAPConfig.ts

@@ -513,9 +513,8 @@ export class GarminAPConfig implements GarminAPConfigInterface {
    * @param apValues The autopilot's state values.
    * @returns The autopilot's VNAV path mode director, or `undefined` to omit the director.
    */
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   protected createVNavPathDirector(apValues: APValues): PlaneDirector | undefined {
-    return new APVNavPathDirector(this.bus, { guidance: this.verticalPathGuidance });
+    return new APVNavPathDirector(apValues, { guidance: this.verticalPathGuidance });
   }
 
   /**

src/garminsdk/autopilot/GarminAPUtils.ts

@@ -1,9 +1,12 @@
 import {
+  APAltitudeModes,
   APBackCourseDirectorActivateNavData, APBackCourseDirectorNavData, APGpsSteerDirectorState,
   APGSDirectorActivateNavData, APGSDirectorNavData, APLateralModes, APNavDirectorActivateNavData, APNavDirectorNavData,
-  APValues, APVerticalModes, MathUtils, NavMath, NavSourceType, RadioUtils, SimVarValueType, UnitType
+  APValues, APVerticalModes, MathUtils, NavMath, NavSourceType, RadioUtils, UnitType
 } from '@microsoft/msfs-sdk';
 
+import { FmaData, FmaVNavState } from './FmaData';
+
 /**
  * A utility class for working with Garmin autopilots.
  */
@@ -56,7 +59,7 @@ export class GarminAPUtils {
       if (dtk === null) {
         return false;
       }
-      const headingDiff = NavMath.diffAngle(SimVar.GetSimVarValue('PLANE HEADING DEGREES MAGNETIC', SimVarValueType.Degree), dtk);
+      const headingDiff = NavMath.diffAngle(apValues.dataProvider.getItem('heading_magnetic').getValue(), dtk);
       const sensitivity = navData.hasLoc ? 1 : .6;
       if (Math.abs(navData.deviation * sensitivity) < 1 && Math.abs(headingDiff) < 110) {
         return true;
@@ -130,7 +133,7 @@ export class GarminAPUtils {
       && Math.abs(navData.deviation) < 1
     ) {
       const dtk = NavMath.normalizeHeading(navData.locCourse + 180);
-      const headingDiff = NavMath.diffAngle(SimVar.GetSimVarValue('PLANE HEADING DEGREES MAGNETIC', SimVarValueType.Degree), dtk);
+      const headingDiff = NavMath.diffAngle(apValues.dataProvider.getItem('heading_magnetic').getValue(), dtk);
       if (Math.abs(headingDiff) < 110) {
         return true;
       }
@@ -357,4 +360,26 @@ export class GarminAPUtils {
     // for performance reasons.
     return Math.asin(Math.min(Math.sqrt(Math.abs(xtk) / (2 * turnRadius)), 1)) * Avionics.Utils.RAD2DEG;
   }
-}
+
+  /**
+   * Creates an empty `FmaData` object.
+   * @returns A new empty `FmaData` object.
+   */
+  public static createEmptyFmaData(): FmaData {
+    return {
+      verticalActive: APVerticalModes.NONE,
+      verticalArmed: APVerticalModes.NONE,
+      verticalApproachArmed: APVerticalModes.NONE,
+      verticalAltitudeArmed: APAltitudeModes.NONE,
+      altitudeCaptureArmed: false,
+      altitudeCaptureValue: -1,
+      lateralActive: APLateralModes.NONE,
+      lateralArmed: APLateralModes.NONE,
+      lateralModeFailed: false,
+      lateralReversionFromMode: null,
+      verticalReversionFromMode: null,
+      verticalAltitudeReversionFromMode: null,
+      vnavState: FmaVNavState.OFF
+    };
+  }
+}

src/garminsdk/autopilot/GarminAutopilot.ts

@@ -1,15 +1,16 @@
 import {
-  AdcEvents, AltitudeSelectEvents, AltitudeSelectManager, AltitudeSelectManagerOptions, APAltitudeModes, APEvents, APLateralModes,
-  APModePressEvent, APStateManager, APVerticalModes, Autopilot, ConsumerSubject, ConsumerValue, DirectorState,
-  EventBus, FlightPlanner, MappedSubject, MetricAltitudeSettingsManager, MinimumsMode, NavSourceType, ObjectSubject,
-  PlaneDirector,
-  RadioUtils, SetSubject, SimVarValueType, Subject, UnitType, VNavAltCaptureType, VNavState
+  AdcEvents, AltitudeSelectEvents, AltitudeSelectManager, AltitudeSelectManagerOptions, APAltitudeModes, APEvents,
+  APLateralModes, APModePressEvent, APStateManager, APVerticalModes, Autopilot, ConsumerSubject, ConsumerValue,
+  DirectorState, EventBus, FlightPlanner, MappedSubject, MetricAltitudeSettingsManager, MinimumsMode, NavSourceType,
+  ObjectSubject, PlaneDirector, RadioUtils, SetSubject, SimVarValueType, Subject, UnitType, VNavAltCaptureType,
+  VNavState
 } from '@microsoft/msfs-sdk';
 
 import { MinimumsDataProvider } from '../minimums/MinimumsDataProvider';
 import { GarminAPVars } from './data/GarminAPEvents';
 import { FmaData, FmaDataEvents, FmaVNavState } from './FmaData';
 import { GarminAPConfigInterface } from './GarminAPConfigInterface';
+import { GarminAPUtils } from './GarminAPUtils';
 import { GarminVNavManager2 } from './vnav/GarminVNavManager2';
 
 /**
@@ -77,18 +78,7 @@ export class GarminAutopilot extends Autopilot<GarminAPConfigInterface> {
 
   protected readonly isAltSelectInitialized = ConsumerValue.create(null, true);
 
-  protected readonly fmaData = ObjectSubject.create<FmaData>({
-    verticalActive: APVerticalModes.NONE,
-    verticalArmed: APVerticalModes.NONE,
-    verticalApproachArmed: APVerticalModes.NONE,
-    verticalAltitudeArmed: APAltitudeModes.NONE,
-    altitudeCaptureArmed: false,
-    altitudeCaptureValue: -1,
-    lateralActive: APLateralModes.NONE,
-    lateralArmed: APLateralModes.NONE,
-    lateralModeFailed: false,
-    vnavState: FmaVNavState.OFF
-  });
+  protected readonly fmaData = ObjectSubject.create<FmaData>(GarminAPUtils.createEmptyFmaData());
 
   protected readonly fmaDataPublisher = this.bus.getPublisher<FmaDataEvents>();
   protected needPublishFmaData = false;
@@ -103,6 +93,13 @@ export class GarminAutopilot extends Autopilot<GarminAPConfigInterface> {
 
   protected isApproachModeCommandedOn = false;
 
+  protected lateralModeReversionFromMode: number | null = null;
+  protected lateralModeReversionToMode: number | null = null;
+
+  protected verticalModeReversionFromMode: number | null = null;
+  protected verticalModeReversionFromAltitudeMode: APAltitudeModes | null = null;
+  protected verticalModeReversionToMode: number | null = null;
+
   /**
    * Creates a new instance of GarminAutopilot.
    * @param bus The event bus.
@@ -287,6 +284,7 @@ export class GarminAutopilot extends Autopilot<GarminAPConfigInterface> {
   protected onAfterUpdate(): void {
     this.updateApproachModeState();
     this.updateNavModeState();
+    this.updateModeReversionState();
     this.updateFma();
   }
 
@@ -339,6 +337,41 @@ export class GarminAutopilot extends Autopilot<GarminAPConfigInterface> {
     }
   }
 
+  /**
+   * Updates this autopilot's mode reversion state.
+   */
+  protected updateModeReversionState(): void {
+    if (!this.stateManager.apMasterOn.get() && !this.stateManager.isAnyFlightDirectorOn.get()) {
+      // If flight director is not on, then reset all mode reversions.
+
+      this.lateralModeReversionFromMode = null;
+      this.lateralModeReversionToMode = null;
+      this.verticalModeReversionFromMode = null;
+      this.verticalModeReversionFromAltitudeMode = null;
+      this.verticalModeReversionToMode = null;
+    } else {
+      // If flight director is on, then reset mode reversions if the corresponding active mode is not either NONE
+      // or the mode to which the original mode reverted.
+
+      if (this.lateralModeReversionToMode !== null) {
+        const lateralActiveMode = this.apValues.lateralActive.get();
+        if (lateralActiveMode !== this.lateralModeReversionToMode && lateralActiveMode !== APLateralModes.NONE) {
+          this.lateralModeReversionFromMode = null;
+          this.lateralModeReversionToMode = null;
+        }
+      }
+
+      if (this.verticalModeReversionToMode !== null) {
+        const verticalActiveMode = this.apValues.verticalActive.get();
+        if (verticalActiveMode !== this.verticalModeReversionToMode && verticalActiveMode !== APVerticalModes.NONE) {
+          this.verticalModeReversionFromMode = null;
+          this.verticalModeReversionFromAltitudeMode = null;
+          this.verticalModeReversionToMode = null;
+        }
+      }
+    }
+  }
+
   /**
    * Publishes data for the FMA.
    */
@@ -364,6 +397,9 @@ export class GarminAutopilot extends Autopilot<GarminAPConfigInterface> {
     fmaData.set('lateralActive', this.apValues.lateralActive.get());
     fmaData.set('lateralArmed', this.apValues.lateralArmed.get());
     fmaData.set('lateralModeFailed', this.lateralModeFailed);
+    fmaData.set('lateralReversionFromMode', this.lateralModeReversionFromMode);
+    fmaData.set('verticalReversionFromMode', this.verticalModeReversionFromMode);
+    fmaData.set('verticalAltitudeReversionFromMode', this.verticalModeReversionFromAltitudeMode);
     fmaData.set('vnavState', fmaVNavState);
 
     if (this.needPublishFmaData) {
@@ -596,4 +632,66 @@ export class GarminAutopilot extends Autopilot<GarminAPConfigInterface> {
 
     super.checkModes();
   }
+
+  /** @inheritDoc */
+  protected handleLateralActiveModeReversion(mode: number): void {
+    // For backward compatibility.
+    if (mode !== APLateralModes.NONE) {
+      this.lateralModeFailed = true;
+    }
+
+    // Immediately set the active lateral mode to NONE and attempt to activate the NONE director. We do this in order
+    // to guarantee that the reverted mode is not left as the active lateral mode.
+    this.apValues.lateralActive.set(APLateralModes.NONE);
+    this.lateralModes.get(APLateralModes.NONE)?.activate();
+
+    // Immediately deactivate the armed lateral mode, if there is one. We do this to guarantee that during a
+    // reversion, the armed mode ends up as either the default lateral mode (see below) or NONE.
+    const lateralArmedMode = this.apValues.lateralArmed.get();
+    if (lateralArmedMode !== APLateralModes.NONE) {
+      this.lateralModes.get(lateralArmedMode)?.deactivate();
+      this.apValues.lateralArmed.set(APLateralModes.NONE);
+    }
+
+    // Attempt to arm the default lateral mode. If the default lateral mode is NONE, then we can skip arming because
+    // we've already activated the NONE director above.
+    const modeToArm = this.getDefaultLateralMode();
+    if (modeToArm !== APLateralModes.NONE) {
+      this.lateralModes.get(modeToArm)?.arm();
+    }
+
+    if (mode !== APLateralModes.NONE) {
+      this.lateralModeReversionFromMode = mode;
+      this.lateralModeReversionToMode = modeToArm;
+    }
+  }
+
+  /** @inheritDoc */
+  protected handleVerticalActiveModeReversion(mode: number): void {
+    // Immediately set the active vertical mode to NONE and attempt to activate the NONE director. We do this in
+    // order to guarantee that the reverted mode is not left as the active vertical mode.
+    this.apValues.verticalActive.set(APVerticalModes.NONE);
+    this.verticalModes.get(APVerticalModes.NONE)?.activate();
+
+    // Immediately deactivate the armed vertical mode, if there is one. We do this to guarantee that during a
+    // reversion, the armed mode ends up as either the default vertical mode (see below) or NONE.
+    const verticalArmedMode = this.apValues.verticalArmed.get();
+    if (verticalArmedMode !== APLateralModes.NONE) {
+      this.verticalModes.get(verticalArmedMode)?.deactivate();
+      this.apValues.verticalArmed.set(APLateralModes.NONE);
+    }
+
+    // Attempt to arm the default vertical mode. If the default vertical mode is NONE, then we can skip arming
+    // because we've already activated the NONE director above.
+    const modeToArm = this.getDefaultVerticalMode();
+    if (modeToArm !== APVerticalModes.NONE) {
+      this.verticalModes.get(modeToArm)?.arm();
+    }
+
+    if (mode !== APVerticalModes.NONE) {
+      this.verticalModeReversionFromMode = mode;
+      this.verticalModeReversionFromAltitudeMode = this.verticalAltitudeArmed;
+      this.verticalModeReversionToMode = modeToArm;
+    }
+  }
 }

src/garminsdk/autopilot/vnav/GarminVNavManager2.ts

@@ -56,6 +56,9 @@ export class GarminVNavManager2 implements VNavManager {
   /** @inheritDoc */
   public activateMode?: (mode: number) => void;
 
+  /** @inheritDoc */
+  public deactivateMode?: (mode: number) => void;
+
   // eslint-disable-next-line jsdoc/require-returns
   /** Whether VNAV is active. */
   public get isActive(): boolean {
@@ -217,7 +220,7 @@ export class GarminVNavManager2 implements VNavManager {
     }
 
     if (this.apValues.verticalActive.get() === APVerticalModes.PATH) {
-      this.activateMode && this.activateMode(APVerticalModes.PITCH);
+      this.deactivateMode && this.deactivateMode(APVerticalModes.PATH);
     }
   }
 
@@ -270,4 +273,4 @@ export class GarminVNavManager2 implements VNavManager {
       }
     }
   }
-}
+}

src/garminsdk/autopilot/vnav/GarminVNavUtils.ts

@@ -1,6 +1,6 @@
 import {
   BitFlags, FlightPlan, FlightPlanSegment, FlightPlanUtils, LegDefinition, LegDefinitionFlags, LegType, MathUtils,
-  TocBocDetails, UnitType, VerticalFlightPlan, VNavConstraint, VNavLeg, VNavUtils
+  TocBocDetails, UncomputedVNavConstraint, UnitType, VerticalFlightPlan, VNavConstraint, VNavLeg, VNavUtils
 } from '@microsoft/msfs-sdk';
 
 import { FmsUtils } from '../../flightplan/FmsUtils';
@@ -97,9 +97,9 @@ export class GarminVNavUtils {
    * @returns Whether the specified climb constraint should be invalidated.
    */
   public static invalidateClimbConstraint(
-    constraint: VNavConstraint,
+    constraint: UncomputedVNavConstraint,
     index: number,
-    constraints: readonly VNavConstraint[],
+    constraints: readonly UncomputedVNavConstraint[],
     firstDescentConstraintIndex: number,
     priorMinAltitude: number,
     priorMaxAltitude: number
@@ -146,9 +146,9 @@ export class GarminVNavUtils {
    * @returns Whether the specified descent constraint should be invalidated.
    */
   public static invalidateDescentConstraint(
-    constraint: VNavConstraint,
+    constraint: UncomputedVNavConstraint,
     index: number,
-    constraints: readonly VNavConstraint[],
+    constraints: readonly UncomputedVNavConstraint[],
     priorMinAltitude: number,
     priorMaxAltitude: number,
     requiredFpa: number,