feat(fms): MSFS 2024 route sync support #10005

Benjozork · 2025-04-12T21:50:54Z

Fixes #10004

Summary of Changes

Introduces route sync capabilities for MSFS2024.

The following features are supported:

(MSFS EFB) Send route to avionics
(MSFS EFB) Request route from avionics
(A32NX/A380X) Auto-import of route from sim (disabled by default, replaces "MSFS Flight Plan Sync" option in 2024)

The following elements are synced between the simulator and FMS:

Procedures and their transitions
Enroute waypoints
Pilot-defined waypoints
Cruise Level

Limitations:

At the moment, airways are not preserved when sending the flight plan back to the simulator. Every waypoint along the airway will be sent separately.
Any changes made inside procedures are not preserved when sending the flight plan back to the simulator. This is due to the inherent differences in how various flight planning systems handle procedures, which makes it difficult to support this use case.
At the moment, step climbs are not imported from the simulator flight plan.
Place-bearing/Place-bearing and Place-distance waypoints are converted to coordinate waypoints when sending the flight plan back to the simulator

Testing instructions

MSFS 2020

On both aircraft:

Ensure flight plan sync (all three settings) still works like it does in the dev version
Ensure the new "Automatically Load MSFS Route" option does not appear in the EFB sim options page

MSFS 2024 (recommended to use SU2 beta)

On both aircraft:

Ensure that pressing "send route to avionics" correctly sends the route to the FMS in various cases (please test many flight plans and kinds of procedures)
Ensure that pressing "request route to avionics" correctly imports the route to the MSFS EFB in various cases (please test many flight plans and kinds of procedures)
Ensure that "Automatically Load MSFS Route" option in the EFB sim options page works correctly (both on and off)

On both sims

Make sure that all flight plan entry features in the FMS still work correctly

How to download the PR for QA

Every new commit to this PR will cause new A32NX and A380X artifacts to be created, built, and uploaded.

Make sure you are signed in to GitHub
Click on the Checks tab on the PR
On the left side, find and click on the PR Build tab
Click on either flybywire-aircraft-a320-neo, flybywire-aircraft-a380-842 (4K) or flybywire-aircraft-a380-842 (8K) download link at the bottom of the page

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

BlueberryKing · 2025-04-27T09:04:02Z

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


 export class FlightPlanService<P extends FlightPlanPerformanceData = FlightPlanPerformanceData>
  implements FlightPlanInterface<P>
 {
  private readonly flightPlanManager: FlightPlanManager<P>;

-  navigationDatabase: NavigationDatabase;
+  public syncClientID = Math.round(Math.random() * 10_000_000);


While incredibly unlikely, multiple instances could potentially get the same syncClientID here. Could this lead to issues?

It would cause issues yes. I can bump up the constant for now - could be a UUID, but I feel that allocation would be more expensive when deserializing sync messages.

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

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

BlueberryKing · 2025-04-27T09:31:50Z

fbw-a32nx/src/systems/fmgc/src/flightplanning/rpc/FlightPlanRpcClient.ts

@@ -74,19 +124,54 @@ export class FlightPlanRpcClient<P extends FlightPlanPerformanceData> implements
    funcName: T,
    ...args: Parameters<FunctionsOnlyAndUnwrapPromises<FlightPlanInterface<P>>[T]>
  ): Promise<ReturnType<FunctionsOnlyAndUnwrapPromises<FlightPlanInterface<P>>[T]>> {
-    const id = v4();
+    const batchState = { batch: null, state: false };


What does state mean here? It's not clear to me what this boolean signifies. Maybe we can choose a more descriptive name?

Clarified. Also fixed a subscription leak 😄

BlueberryKing · 2025-04-27T09:34:17Z

fbw-a32nx/src/systems/fmgc/src/flightplanning/rpc/FlightPlanRpcServer.ts

+    const gameStateSub = GameStateProvider.get().sub((state) => {
+      if (state === GameState.ingame) {
+        this.handleSendHeartbeat();
+        setInterval(() => this.handleSendHeartbeat(), 2_500);


Do we need to clean up this setInterval when we destroy the RPC server?

At the moment the server basically always exists, because it exists as long as the FMC does, and IIRC we don't have FMC failures yet. If you want, I can add a destroy() method

I'm not too bothered about cleaning up to be honest if it's expected to exist for the entire session. It's fine to keep it as it is.

fbw-a32nx/src/systems/fmgc/src/flightplanning/test/FlightPlan.ts

BlueberryKing · 2025-04-27T09:43:47Z

fbw-common/src/systems/instruments/src/EFB/Localization/data/en.json

@@ -674,6 +674,7 @@
      "SimBridgeIp": "External SimBridge Host Address",
      "SimBridgePort": "External SimBridge Port",
      "SyncMsfsFlightPlan": "Sync MSFS Flight Plan",
+      "AutoLoadMsfsRoute":"Automatically Load MSFS Route",


Suggested change

"AutoLoadMsfsRoute":"Automatically Load MSFS Route",

"AutoLoadMsfsRoute": "Automatically Load MSFS Route",

Benjozork force-pushed the feat/msfs-2024-route-sync branch from c902799 to 824a623 Compare April 12, 2025 21:54

Benjozork added 26 commits April 12, 2025 17:56

feat: initial commit

6df06aa

fix(fms): some sync fixes

a4ab02e

fix(a380/fmc): FMC initialization fixes

d12ef77

feat: request route from avionics wip

1edb72d

fix: rework syncing of segments to sync procedure changes

e001e6f

fix: syncing of runways to msfs

98c4115

refactor: cleanup

c0440c1

fix: syncing of origin/destination airport/runways

1de61c7

fix: unused import

4c5f0d1

fix: lint

4aafe67

fix: initialization and race condition fixes

6d96c24

chore: remove debug logs

35104cf

refactor: draft of refactored airway entry

847e6a2

fix: more sync fixes, batches

9c86f5d

refactor: more airways work

1a1158a

refactor: more cleanup, move batch tests

a876909

refactor: more airways work, add integration tests

8b9665e

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

20e418e

test: re-enable leg test

1870b8c

feat: route airways

5680b36

chore: fix copyright

cecd625

fix: runway conversion and changed property name

1593bfc

feat: enroute legs to EFB

452b72a

feat: add sync support to DataManager

020f07d

feat: sync pilot waypoints to sim

c6265b7

feat: import pilot waypoints, send cruise alt

f065c75

Benjozork force-pushed the feat/msfs-2024-route-sync branch from 824a623 to f065c75 Compare April 12, 2025 21:57

Benjozork added 2 commits April 12, 2025 18:03

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

a343063

fix(a32nx): get 2024 sync running

a5c38e9

Benjozork added 3 commits April 12, 2025 22:23

chore: that's a bit excessive

cc4c680

feat: add auto-import setting to EFB

df88862

Merge branch 'master' into msfs-route-sync-fixed

589009e

Benjozork marked this pull request as ready for review April 19, 2025 15:43

Benjozork added QA Tier 1 A32NX Related to the A32NX aircraft A380X Related to the A380X aircraft MSFS2024 PRs Fixing FS2024 Issues labels Apr 19, 2025

Benjozork added this to the v0.14.0 milestone Apr 19, 2025

github-project-automation bot added this to Quality Assurance Apr 19, 2025

github-project-automation bot moved this to 🟡 Code Review: Ready for Review in Quality Assurance Apr 19, 2025

Benjozork added QA Tier 2 and removed QA Tier 1 labels Apr 19, 2025

Benjozork added 6 commits April 19, 2025 16:12

fix: import

db50700

fix: types

a8ed4c0

fix: simbrief and coroute adapters

4c95d1b

chore: lint

0b91b9b

fix: test runway designator

c376ba1

fix: mcdu airways

3d54b29

BlueberryKing requested changes Apr 27, 2025

View reviewed changes

github-project-automation bot moved this from 🟡 Code Review: Ready for Review to 🔴 Code Review: In progress in Quality Assurance Apr 27, 2025

Benjozork added 4 commits April 27, 2025 08:59

chore: address review comments

c59e1ef

chore: address review comments 2

df832af

fix: fix leaked subscription, better property name

f457a47

chore: remove unused test code

5eba3a6

Benjozork force-pushed the feat/msfs-2024-route-sync branch from d6bef28 to 5eba3a6 Compare April 27, 2025 13:09

chore: formatting

ce2a06b

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(fms): MSFS 2024 route sync support #10005

feat(fms): MSFS 2024 route sync support #10005

Benjozork commented Apr 12, 2025 •

edited

Loading

BlueberryKing Apr 27, 2025

Benjozork Apr 27, 2025

BlueberryKing Apr 27, 2025

Benjozork Apr 27, 2025

BlueberryKing Apr 27, 2025

Benjozork Apr 27, 2025

BlueberryKing Apr 27, 2025

BlueberryKing Apr 27, 2025

	"AutoLoadMsfsRoute":"Automatically Load MSFS Route",
	"AutoLoadMsfsRoute": "Automatically Load MSFS Route",

feat(fms): MSFS 2024 route sync support #10005

Are you sure you want to change the base?

feat(fms): MSFS 2024 route sync support #10005

Conversation

Benjozork commented Apr 12, 2025 • edited Loading

Summary of Changes

Testing instructions

MSFS 2020

MSFS 2024 (recommended to use SU2 beta)

On both sims

How to download the PR for QA

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Benjozork commented Apr 12, 2025 •

edited

Loading