feat: remote flyPad and displays #8598

Benjozork · 2024-03-31T00:20:00Z

Summary of Changes

This PR adds the first implementation of the remote display bridge protocol, and enables it for certain instruments, including the flyPad.

Testing instructions

TBD

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, click on the bottom PR tab
Click on either flybywire-aircraft-a320-neo or flybywire-aircraft-a380-842 download link at the bottom of the page

# Conflicts: # fbw-a380x/src/systems/instruments/src/PFD/instrument.tsx # pnpm-lock.yaml

# Conflicts: # fbw-a380x/mach.config.js # fbw-a380x/src/systems/extras-host/index.ts # fbw-a380x/src/systems/extras-host/modules/common/AircraftPresetsList.ts # fbw-a380x/src/systems/extras-host/modules/key_interceptor/KeyInterceptor.ts # fbw-a380x/src/systems/extras-host/modules/version_check/VersionCheck.ts # fbw-common/src/systems/instruments/src/EFB/Efb.tsx # fbw-common/src/systems/instruments/src/EFB/ToolBar/ToolBar.tsx # fbw-common/src/systems/instruments/src/ND/pages/rose/RoseVorPage.tsx

2hwk · 2024-04-02T01:56:04Z

fbw-a32nx/src/systems/extras-host/index.ts

+            airframeName: 'A320-251N',
+            clientName: 'A32NX',


Suggested change

airframeName: 'A320-251N',

clientName: 'A32NX',

airframeName: 'A320-251N',

clientName: 'A32NX',

This maybe should use an existing configuration (or the new VFS-based solution currently in the planning stages in #8599)

Ok to put a TODO: here as well for this to be covered later.

2hwk · 2024-04-02T01:57:32Z

fbw-a32nx/src/systems/instruments/src/PFD/PFD.tsx

@@ -23,7 +23,7 @@ import { VerticalSpeedIndicator } from './VerticalSpeedIndicator';
 import { PFDSimvars } from './shared/PFDSimvarPublisher';

 export const getDisplayIndex = () => {
-    const url = document.getElementsByTagName('a32nx-pfd')[0].getAttribute('url');
+    const url = document.querySelector('vcockpit-panel > *').getAttribute('url');


Suggested change

const url = document.querySelector('vcockpit-panel > *').getAttribute('url');

const url = document.querySelector('vcockpit-panel > *').getAttribute('url');

May be a use case for xmlConfig via panel.xml in the future, for now this is ok.

2hwk · 2024-04-02T01:59:33Z

fbw-common/src/systems/instruments/src/EFB/Efb.tsx

+export const getAirframeType = () => {
+    if (window.FBW_REMOTE) {
+        return 'A320_251N';
+    }


Suggested change

export const getAirframeType = () => {

if (window.FBW_REMOTE) {

return 'A320_251N';

}

export const getAirframeType = () => {

if (window.FBW_REMOTE) {

return 'A320_251N';

}

Note for self: I'll need to take note of this in #8599 as well as potentially #8500

In the future, if we have remote instruments in multiple AC and variants, this might also need some thought.

We are also deprecating the function getAirframeType() from usage in the EFB (PR 8500), may be better to switch to the new aircraft type L:Var for this and merge 8500 first? (Or again, long term solution, is the VFS based unified config)

2hwk · 2024-04-02T02:01:18Z

fbw-common/src/systems/instruments/src/EFB/Efb.tsx

@@ -85,9 +85,15 @@ interface BatteryStatus {
 export const usePower = () => React.useContext(PowerContext);

 // this returns either `A380_842` or `A320_251N` depending on the aircraft
-export const getAirframeType = () => new URL(
+export const getAirframeType = () => {
+    if (window.FBW_REMOTE) {


Suggested change

if (window.FBW_REMOTE) {

if (window.FBW_REMOTE) {

May want to abstract this into its own util or function so that its easier to manage, for a potential future use case if one day we also have to have bespoke remote EFB code in future in the EFB (Unlikely, but better to push this out into a dedicated function)

2hwk · 2024-04-02T02:02:35Z

fbw-common/src/systems/instruments/src/EFB/ToolBar/ToolBar.tsx

@@ -58,7 +59,7 @@ export const ToolBar = () => (
            <ToolBarButton to="/atc" tooltipText={t('AirTrafficControl.Title')}>
                <BroadcastPin size={35} />
            </ToolBarButton>
-            <ToolBarButton to="/failures" tooltipText={t('Failures.Title')}>
+            <ToolBarButton to="/failures" tooltipText={t('Failures.Title')} disabled={window.FBW_REMOTE}>


See above point about having an abstracted util function (that reads from window.FBW_REMOTE). We don't need awareness of window at this level.

2hwk · 2024-04-02T02:03:34Z

fbw-common/src/systems/instruments/src/remote-client.ts

+
+    constructor(options: RemoteClientOptions) {
+        this.url = options.websocketUrl();
+        this.airframeName = options.airframeName;


Suggested change

this.airframeName = options.airframeName;

this.airframeName = options.airframeName;

Maybe this should be aircraft instead of airframe (a bit pendatic but sure)

2hwk · 2024-04-02T02:07:39Z

fbw-a380x/src/systems/extras-host/index.ts

+            airframeName: 'A380-842',
+            clientName: 'A380X',


Suggested change

airframeName: 'A380-842',

clientName: 'A380X',

airframeName: 'A380-842',

clientName: 'A380X',

See point about using either an existing config, or (plan) to implement the new VFS based solution with a TODO:

2hwk · 2024-04-02T02:08:51Z

fbw-a32nx/mach.config.js

+    msfsAvionicsInstrument,
+    reactInstrument,
+} = getMachInstrumentBuilders({
+    templateIDPrefix: 'A32NX',


Suggested change

templateIDPrefix: 'A32NX',

templateIDPrefix: 'A32NX',

I'd actually like to read from .env, or some kind of markup here, but I'm not sure if its actually possible.

2hwk · 2024-05-03T15:57:02Z

Looks like merge conflicts from lint changes (You probably already know, this is for the do not merge tag)

# Conflicts: # fbw-a32nx/mach.config.js # fbw-a32nx/src/systems/extras-host/index.ts # fbw-a32nx/src/systems/instruments/src/Clock/instrument.tsx # fbw-a32nx/src/systems/instruments/src/EWD/instrument.tsx # fbw-a32nx/src/systems/instruments/src/ND/instrument.tsx # fbw-a32nx/src/systems/instruments/src/PFD/PFD.tsx # fbw-a32nx/src/systems/instruments/src/PFD/instrument.tsx # fbw-a32nx/src/systems/simbridge-client/src/common.ts # fbw-a380x/src/systems/extras-host/index.ts # fbw-common/src/systems/instruments/src/EFB/Efb.tsx # fbw-common/src/systems/instruments/src/EFB/ToolBar/ToolBar.tsx # fbw-common/src/systems/instruments/src/ND/pages/rose/RoseVorPage.tsx # fbw-common/src/systems/instruments/src/ND/shared/utils/MapParameters.ts # fbw-common/src/systems/shared/src/simbridge/components/ClientState.ts # package.json # pnpm-lock.yaml

Benjozork added 22 commits December 2, 2023 13:31

initial commit

2faa205

support signin requests

881edb1

hide failures tab on efb in remote

f958a2d

update protocol and use prod url

a40a1c8

update protocol and use room keys

846e332

support setting simvars

18a54cc

add a380 extras-host

529270f

switch to using shared types package, proper instruments enumeration

98a2d16

check protocol id

a543cd4

simbridge

109ed72

fix react instruments in-sim

7dbfcb5

pnpm (this needs to go in master in a separate PR)

e19f98f

implement new file downloading

532db80

add instrument filtering, extract mach instrument utils

b7e77f8

add js-base64

786bf2d

Merge branch 'master' into feature/remote-test

a0e2e12

# Conflicts: # fbw-a380x/src/systems/instruments/src/PFD/instrument.tsx # pnpm-lock.yaml

Merge branch 'master' into feature/remote-test

c5bfd81

fix: support canceling more subscriptions

9ea3410

fix: remove Avionics.Utils calls from ND

7353f5f

fix: updates

e4635e1

feet: connect when simbridge status changes, not automatically

021b20c

Benjozork force-pushed the feature/remote-test branch from 5bf28a1 to 021b20c Compare March 31, 2024 00:25

Benjozork marked this pull request as ready for review March 31, 2024 16:33

github-actions bot added this to 🟡 Code Review: Ready for Review in Quality Assurance Mar 31, 2024

2hwk added the Needs Code Review label Apr 1, 2024

2hwk requested changes Apr 2, 2024

View reviewed changes

Quality Assurance automation moved this from 🟡 Code Review: Ready for Review to 🔴 Code Review: In progress Apr 2, 2024

2hwk added this to the v0.12.0 milestone Apr 10, 2024

2hwk added the Do Not Merge label May 3, 2024

Benjozork added 4 commits May 11, 2024 13:24

style: run lint after merge

fb10f34

chore: fix lint

6cb681f

fix: package.json

9a830d2

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: remote flyPad and displays #8598

feat: remote flyPad and displays #8598

Benjozork commented Mar 31, 2024 •

edited

2hwk Apr 2, 2024

2hwk Apr 4, 2024

2hwk Apr 2, 2024

2hwk Apr 2, 2024

2hwk Apr 2, 2024

2hwk Apr 2, 2024

2hwk Apr 2, 2024

2hwk Apr 2, 2024

2hwk Apr 2, 2024

2hwk Apr 2, 2024

2hwk commented May 3, 2024

	const url = document.querySelector('vcockpit-panel > *').getAttribute('url');
	const url = document.querySelector('vcockpit-panel > *').getAttribute('url');

	this.airframeName = options.airframeName;
	this.airframeName = options.airframeName;

feat: remote flyPad and displays #8598

Are you sure you want to change the base?

feat: remote flyPad and displays #8598

Conversation

Benjozork commented Mar 31, 2024 • edited

Summary of Changes

Testing instructions

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

2hwk commented May 3, 2024

Benjozork commented Mar 31, 2024 •

edited