feat: GSX Integration

[Lucky38i]

Summary of Changes

Integrates GSX features with the aircraft custom systems including refueling, boarding and cargo. De-Ice will come at a later stage when we simulate the usefull of de-ice on aircraft performance.

GSX Profile disables the rear cargo door and rear passenger door, and disables the option of the fuel menu opening. Doors were disabled as they can't currently be opened in-game. If you still want passengers/cargo to use these doors then you can re-enable them in the Airplane Settings menu on GSX.

Documentation will follow suit.

• Fuel Synced
• GSX Profile
• Boarding Synced
• Baggage/Freight Loading Synced
• Deboarding Synced
• Baggage/Freight Emptying Synced
• Disable A32NX's chocks and cones and use GSX when sync enabled
• Use A32NX's cabin noises outside of boarding and deboarding
• Migrate to Rust

Screenshots (if necessary)

References

• GSX Manual on Development Interactions

Additional context

Discord username (if different from GitHub): Lucky38i

Testing instructions

There's a few things to be aware of when using GSX Sync. PLEASE READ each of these carefully, documentation is planned for release.

• There's a new page in the EFB settings labelled 3rd Party Options. Inside there are two options to give you the freedom on what to sync with GSX. This activates the synchronisation. Without it GSX won't sync as expected. It's important to note various items and fields get disabled in the payload and fuel page with these options enabled.
• De-fueling Is NOT supported, GSX only checks if the fuel has changed to a number higher than the current value. If you call the refueling truck and attempt to defuel, the aircraft will defuel but GSX will nag you to change fuel and not actually do anything, constantly nagging you.
• Fueling is managed by A32NX, GSX simply acts as a visual indicator here which allows the user to still use Instant/Fast/Real options in the EFB. However, Fuel cannot be started until the fueling truck has connected the hose as shown by a grey start button. The fueling truck will remain and count for the duration of the fueling period set by A32NX, you will of course get a bill as usual.
• You must set your amount of passengers before GSX boarding, whether through simbrief sync in the EFB or manually in the payload page. Same goes for cargo. Once GSX boarding has been requested, these fields CANNOT be edited until deboarding (meaning an entire flight)
• Boarding is managed by GSX (in a sense), this means you cannot adjust the boarding times in the EFB, you can only adjust boarding time, through GSX's own settings. If one physical passengers boards the aircraft through GSX, then A32NX's Boarding backend is made aware and acts accordingly. Passenger seats are still loaded in the same way they would without GSX Sync.
• The same is regarded with Cargo/Baggage, however due to limitations with the simvars available from GSX, all stations are loaded at the same time. So if GSX says baggage is 33% loaded, all stations will be loaded to 33% of their given weight target. This removed a bit of the randomness to loading but the limitations is out of my hands.

An aircraft profile is provided, you don't need to do anything GSX picks up on this

• With this profile, the aft passenger door is disabled and the the aft cargo door as-well. This is because these doors can't be opened from the EFB. The aft service door is not disabled, but must be manually opened through the EFB. I'll try and notify the GSX team on the simvars to open this door. So you won't have to in the future.

• Ensure simbrief loading still performs as before in EFB
• Fueling
  • Test GSX properly plays the re-fueling animation when you begin refueling with the EFB
  • Test the refueling animation correctly stops when the EFB stops refueling the aircraft
  • Test the refueling animation is instant when you're using Instant refueling time
  • Ensure you can still refuel in-flight with GSX Fuel Sync enabled
• Payload
  • Set in the EFB how much passengers you want as-well as cargo, to notify GSX of these details.
  • Ensure passenger current in EFB, matches GSX tooltip
  • Confirm as GSX baggage tooltip percentage increase, current cargo weight increase in EFB
  • Ensure baggage weight decreases when deboarding
  • Ensure passenger amount decreases when deboarding
  • Ensure passenger/cargo amount in EFB cannot be modified after boarding is requested and only appears again after deboarding is completed

How to download the PR for QA

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

1. Make sure you are signed in to GitHub
2. Click on the Checks tab on the PR
3. On the left side, click on the bottom PR tab
4. Click on the A32NX download link at the bottom of the page

[2hwk]

Note: A32NX_Boarding.js will have conflicts with #7442

[LeDerpLegend]

Quality Assurance Trainee Report

Discord : LeDerpLegend#0109
Object of testing: #7695
Tier of Testing : 1
Date : 16/01/2023

Testing Process: Followed instructions to set settings in the EFB, set payloads ahead of time, and followed down the checklist, using the EFB mainly as a input and visual reference, and GSX as the program in control. At the time of testing GSX is on Version 2.1.16

I did a small loop around flight around LAS, spawned at a gate, loaded simbrief, loaded with some fuel instantly, good. Reset the flight, this time using real time fuel to fill up, good. Loaded simbrief into into payload page, started boarding process with GSX. Seats and cargo filled up as intended, and editing any info was disabled until plane was empty. Fuel page was disabled as long as I was at a gate, if I was taxing or flying, I was able to edit my fuel with instant time.

EFB x Simbrief

• Ensure simbrief loading still performs as before in EFB - OK
  Fueling

• Test GSX properly plays the re-fueling animation when you begin refueling with the EFB - OK

• Test the refueling animation correctly stops when the EFB stops refueling the aircraft - OK

• Test the refueling animation is instant when you're using Instant refueling time - OK

• Ensure you can still refuel in-flight with GSX Fuel Sync enabled - OK

Payload

• Set in the EFB how much passengers you want as-well as cargo, to notify GSX of these details. - OK
• Ensure passenger current in EFB, matches GSX tooltip - OK
• Confirm as GSX baggage tooltip percentage increase, current cargo weight increase in EFB - FAIL OK
• Ensure baggage weight decreases when deboarding - FAIL OK
• Ensure passenger amount decreases when deboarding - FAIL OK
• Ensure passenger/cargo amount in EFB cannot be modified after boarding is requested and only appears again after deboarding is completed - FAIL OK

Negatives:

• Just visually, two luggage cars and two catering trucks will arrive, but only one door will open, I get that's probably a model thing nothing we can do, functionality still works. Nothing to worry about.

Positives:

• After changing the options, GSX seemed to work pretty flawlessly with the Payload and Fuel pages.
• If de-fueling is required, GSX as stated will not do anything, instead of nagging, the truck seems to connect, then after a short time, just disconnects and leaves.

Testing Result: NOT PASSED PASSED

Conclusion: Well done on this, honestly, it's something I've been looking forward to for a while. I think this could be cleaned up a bit in terms of UI and some instructions (like making sure to set Payload ahead of requesting boarding, or buttons becoming disabled.) Overall, good job.

[frankkopp]

I have uploaded your flyPad translation keys to Localazy:

 "ThirdPartyOptions": {
      "Title": "3rd Party Options",
      "GsxFuelEnabled": "GSX Fueling Synchronization",
      "GsxPayloadEnabled": "GSX Payload Synchronization"
    },

[Lucky38i]

Quality Assurance Trainee Report

Discord : LeDerpLegend#0109 Object of testing: #7695 Tier of Testing : 1 Date : 16/01/2023

Thanks for the test :) @LeDerpLegend

Negatives:

* Just visually, two luggage cars and two catering trucks will arrive, but only one door will open, I get that's probably a model thing nothing we can do, functionality still works. Nothing to worry about.

The aft service door does indeed work so that should work. You might need to manually open it in the EFB. Perhaps GSX is unaware of the simvar to do it on it's own. The aft cargo door cannot be opened and so that is disabled in accordance with the provided GSX profile So only one luggage car should arrive. Make sure you don't already have a custom profile.

* If de-fueling is required, GSX as stated will not do anything, instead of nagging, the truck seems to connect, then after a short time, just disconnects and leaves.

This is interesting, couldn't get it to stop nagging on my end.

Conclusion: Well done on this, honestly, it's something I've been looking forward to for a while. I think this could be cleaned up a bit in terms of UI and some instructions (like making sure to set Payload ahead of requesting boarding, or buttons becoming disabled.) Overall, good job.

I'll be making documentation as-well.

[LeDerpLegend]

Quality Assurance Trainee Report
Discord : LeDerpLegend#0109 Object of testing: #7695 Tier of Testing : 1 Date : 16/01/2023

Thanks for the test :) @LeDerpLegend

Negatives:

* Just visually, two luggage cars and two catering trucks will arrive, but only one door will open, I get that's probably a model thing nothing we can do, functionality still works. Nothing to worry about.

The aft service door does indeed work so that should work. You might need to manually open it in the EFB. Perhaps GSX is unaware of the simvar to do it on it's own. The aft cargo door cannot be opened and so that is disabled in accordance with the provided GSX profile So only one luggage car should arrive. Make sure you don't already have a custom profile.

This has to do with the front service door. The aft service door opens up as intended automatically, however the front one, visually at least, remains closed, but the catering truck still operates normally. Just some dude who has the power to phase through walls I guess.

I know that the aft cargo door can not be opened, I should state that this issue seems to happen when arriving back at an airport, or restarting GSX's connection service. I can never remember how to spell it but something along the lines of Colgut or something.
I have an issue of the GSX service quitting after taking off. I have no idea if this is an issue with GSX itself or something on my PC, but it always seems to quit on itself, requiring me to restart it. For me, spawning in at an airport, will correctly yield one loader and cart.

I have no custom profiles for the A320 or KLAS

* If de-fueling is required, GSX as stated will not do anything, instead of nagging, the truck seems to connect, then after a short time, just disconnects and leaves.

This is interesting, couldn't get it to stop nagging on my end.

It may have to do with some settings with GSX fueling. I set it to fuel at least for 5 seconds before disconnecting. I wonder if this changes anything. If you want I can send an image of my settings later. I have had no issues with it nagging me when attempting to defuel, it just plays the animation, fuels for a little bit (with audio, it doesn't change the fuel load in the plane whatsoever.) Then they pack up and leave like normal.

Conclusion: Well done on this, honestly, it's something I've been looking forward to for a while. I think this could be cleaned up a bit in terms of UI and some instructions (like making sure to set Payload ahead of requesting boarding, or buttons becoming disabled.) Overall, good job.

I'll be making documentation as-well.

Very well.

[Lucky38i]

Hi, I'm requesting authorization to download files I'm a Headwind a339 pilot. Saw the link through the discord channel for Headwind, thanks in advance.

I have no idea what you're asking for here. This is a PR for the A32NX, I no idea this'll work with Headwind, speak to the people there.

[Saschl]

I guess we should disable GSX cones as we have our own. What do you think?

[choi-choi]

Tried with experimental version, enabled 3rd party GSX things. Simbrief used.

However the fuel truck always loads too slowly, even if i move the timings to x10. FBW is already done 5 mins ago, loading less than 3000kg of fuel. I always load real time.

Tried this with progressive fueling and detect 3rd party fueling checked.

For the passengers, the EFB of FBW has no buttons available, nothing also happens there and is basically dead. I assume they load..

[brewers10]

Quality Assurance Trainee Report

Discord : brewers_10#5706
Object of testing: #7695
Tier of Testing : 2
Date : 08/02/2023

Testing Process:

Loaded into Stand 17B at KLAX for a flight to KSFO. Followed instructions to a tee: results below :)

Ensure simbrief loading still performs as before in EFB - OK

Fueling
Test GSX properly plays the re-fueling animation when you begin refueling with the EFB - OK
Test the refueling animation correctly stops when the EFB stops refueling the aircraft - OK
Test the refueling animation is instant when you're using Instant refueling time - OK
Ensure you can still refuel in-flight with GSX Fuel Sync enabled - OK

Payload
Set in the EFB how much passengers you want as-well as cargo, to notify GSX of these details. - OK
Ensure passenger current in EFB, matches GSX tooltip - OK (tested with normal, dense and very dense)
Confirm as GSX baggage tooltip percentage increase, current cargo weight increase in EFB - OK
Ensure baggage weight decreases when deboarding - OK
Ensure passenger amount decreases when deboarding - OK
Ensure passenger/cargo amount in EFB cannot be modified after boarding is requested and only appears again after deboarding is completed - OK

Negatives:
Had to restart Couatl twice to get rid of the GSX bug where it decides to board around 10 passengers in one block. This messed up the planes passenger number when boarding was complete (only had 108 Pax compared to the planned 169). This is a GSX bug and nothing to do with the aircraft however.

Testing Results:
Passed

Conclusions:
Very very good work, this will certainly make people's lives easier when using GSX and the A32NX together. Top work to all involved!

Media: