Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Updated GSX Integration Docs to reflect current implementation #999

Merged
merged 5 commits into from
Sep 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/fbw-a32nx/assets/gsxintegration/gsx-fuel-start.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/fbw-a32nx/assets/gsxintegration/gsx-hero.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/fbw-a32nx/assets/gsxintegration/gsx-profile-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 10 additions & 8 deletions docs/fbw-a32nx/feature-guides/gsxintegration/fuel.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Fuel Synchronization

!!! warning ""
You must enable [Fuel Sync](../flypados3/settings.md#3rd-party-options)
You must enable [Fuel Sync](../flypados3/settings.md#3rd-party-options) on the 3rd Party Options settings page on the EFB for this to function.

This page explains, how to use the fueling "synchronization" as-well as any caveats you should be made aware of when using it.

Expand All @@ -18,13 +18,15 @@ This page explains, how to use the fueling "synchronization" as-well as any cave
## Usage
![Fuel Start](../../assets/gsxintegration/gsx-fuel-start.png)

You may notice the fuel page is slightly different, with the Play button being greyed out. This is because for the sake of GSX flow, you cannot begin fueling until the fuel hose is connected.
Much of the refuelling process between the A32NX and GSX is automated; However some input is required from the user to set the fuel and initiate refuelling.

1. Fueling
- The "play" button is disabled until the fuel truck has arrived, and the hose is connected.
- Select `Request Fueling` from the GSX Menu.
- Wait for the fuel truck to arrive and connect the fuel hose.
- Set the [fuel quantity](../flypados3/ground.md#fuel-and-de-fuel) that you desire and press the "play" button.
- You can witness outside as the fuel truck begins to re-fuel your aircraft.
- To use GSX as part of the refuelling process, 'Refuel Time' should be `Real` or `Fast`. Selecting `Instant` will add the fuel immediately, and will not involve GSX.
- Ensure you have synchronised your required fuel with your SimBrief flight plan, or manually adjust the slider to set how much fuel you require.
- Above the slider, you will see `(Call GSX Refuel)` - you need to select `Request Refuelling` within the GSX main menu. Be aware that you cannot adjust the fuel slider/amount once you have clicked this.
- GSX will now send the fuel truck to the aircraft. The `(Call GSX Refuel)` will disappear during this process.
- When the fuel truck has set up and connected the fuel hose to the aircraft it will begin to load fuel into the tanks. Above the slider you will see `(Refuelling...)` and the 'Total Fuel' at the top of the EFB page should begin to increase until it reaches the amount you requested.
- Once complete, `(Refuelling...)` will disappear and the fuel truck will leave.

2. Defueling
- Due to limitations with GSX, this is not supported. To defuel, disable [Fuel Sync](../flypados3/settings.md#3rd-party-options) temporarily.
- Due to limitations with GSX, this is not supported. To defuel, disable [Fuel Sync](../flypados3/settings.md#3rd-party-options) temporarily and use the play button to initiate the defuelling process.
6 changes: 3 additions & 3 deletions docs/fbw-a32nx/feature-guides/gsxintegration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ description: A guide to the GSX Integration provided in the A32NX.
!!! warning "Please Note"
This guide covers GSX Integration and the features available in the latest FlyByWire [Development Version](../../fbw-versions.md#development-version-recommended).

If you use the FlyByWire Stable version, you might not have all features available. This will be appropriately flagged throughout our doucmentation.
If you use the FlyByWire Stable version, you might not have all features available. This will be appropriately flagged throughout our documentation.

!!! danger "Support"
The FlyByWire team does not take responsibility for bugs encountered while using GSX.

If you're experiencing issues with GSX, please refer to the FSDreamTeam's forums or their discord. The GSX Integration feature provided is regarding GSX interacting with FlyByWire and nothing more.
If you're experiencing issues with GSX, please refer to the [FSDreamTeam's forums](https://www.fsdreamteam.com/forum/) or their [Discord](https://discord.com/invite/e7DBUe3Ftc). The GSX Integration feature provided is regarding GSX interacting with FlyByWire and nothing more.

!!! abstract "FSDreamteam: [GSX](https://www.fsdreamteam.com/products_gsxpro.html){target=new}:"

Expand All @@ -32,7 +32,7 @@ This documentation takes you through all pages and functions of GSX Integration.

[//]: # (TODO need to add a picture here)

![GSX Flypad](../../assets/gsxintegration/gsx-hero.jpg "GSX Settings")
![GSX Intergration](../../assets/gsxintegration/gsx-hero.jpg "GSX Refuelling the FBW")

## General Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/fbw-a32nx/feature-guides/gsxintegration/payload.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Payload Synchronization

!!! warning ""
You must enable [Payload Sync](../flypados3/settings.md#3rd-party-options) in order for this to function.
You must enable [Payload Sync](../flypados3/settings.md#3rd-party-options) on the 3rd Party Options settings page on the EFB for this to function.

This page goes over how to use payload synchronization as-well as any caveats you should be aware of when using it.

Expand All @@ -17,7 +17,7 @@ This page goes over how to use payload synchronization as-well as any caveats yo
- Once boarding has started, you can no longer edit the fields in the payload screen.

## General Usage
![Payload Start](../../assets/gsxintegration/gsx-payload-start.jpg)
![Payload Start](../../assets/gsxintegration/gsx-payload-start.png)

You may notice the payload page is slightly different, with the Play/Stop button missing. This is because boarding is now managed by GSX and thus triggering these states is done by you, the user, through the GSX Menu.

Expand Down
3 changes: 0 additions & 3 deletions docs/fbw-a32nx/feature-guides/gsxintegration/profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,6 @@ The correct SimVar was set to ensure that GSX correctly detects the parking brak
### Payload/Fuel Window
This option has been disabled due to our custom payload and fuel systems.

### Traffic cones
As the A32NX's cones and chocks are disabled with enabling GSX Integration, this option is enabled to provide the user with cones.

## Troubleshooting
Currently, GSX may not correctly detect the developer profile as shown in [overview](#overview). To circumvent this, you can manually copy the developer profile to GSX's profile folder.

Expand Down
Loading