Fragtality / Fenix2GSX

GSX Integration for the Fenix A320
MIT License
108 stars 5 forks source link

Fenix2GSX


Full and proper GSX Integration and Automation for the Fenix A320 (all Variants, so including the 319/321)!

NOTE: Fenix2GSX is a "standalone" Solution - you CAN NOT use it parallel to the native Integration. It is either-or.



Requirements


Download here

(Under Assests, the Fenix2GSX-Installer-vXYZ.exe File)



Installation / Update / Removal

Basically: Just run the Installer - it will extract it for you to a fixed Location and will also install/update the neccessary Software to your PC/Sim. It even setups Auto-Start and creates a Link on the Desktop, if you want.

Some Notes:



The Program will display a little Exclamation Mark on the SysTray/Notification Area Icon and in the GUI to inform on a new Version. There is no Pop-Up and there will never be.

.


Auto-Start

When starting it manually, please do so either before MSFS or when MSFS is in the Main Menu.
To automatically start it with FSUIPC or MSFS, select the respective Option in the Installer.

Addon Linker

If you use Addon Linker to start your Addons/Tools, you can also add it there:
Program to launch C:\Users\YOURUSERNAME\AppData\Roaming\Fenix2GSX\bin\Fenix2GSX.exe
Wait for simconnect checked
The Rest can be left at Default.



Configuration

Fenix

Disable Auto-Door and Auto-Jetway Simulation in the EFB!
Disable ALL GSX Options in the EFB! Fenix2GSX currently only works as "standalone" Solution, so it is either Fenix native or Fenix2GSX, not both.
Make sure your Default State is set to either Cold & Dark or Turn-Around with GPU or APU. GSX won't provide any Services when the Engines are running.


GSX Pro


Fenix2GSX

The Configuration is done through the GUI, open it by clicking on the System-Tray/Notification-Icon. The UI does not open from itself! The Settings are stored persistently in the %appdata\Fenix2GSX\Fenix2GSX.config File - so set them once to your Preference and you should be fine :smiley:

All Options have ToolTips which explains them further. When changing/adding something in the Text-Boxes: please either hit Enter or click in another Text-Box (so the one you changed loses the Input-Focus).

You can close the Windows/UI without Problems, Fenix2GSX will continue to run. The UI is only there for Configuration, you don't need to have it open to have Fenix2GSX doing its Work.



All Settings can be changed dynamically on the Fly if needed. But do that before a Service/Feature starts or after it has ended. For example, don't disable "Automatic Jetway/Stair Operation" while the Jetway is connected. Do it before the Tool calls the Jetway or after it was disconnected by the Tool.

In general, it is up to your Preference how much Automation you want. If you want to keep Control of when Services are Called and/or the Jetway is connected, you can still enjoy the (De-)Boarding and Refueling Syncronization when the Automation-Options are disabled. The only Automation which can not be disabled: The Removal of the Ground-Equipment and Jetway-Disconnection (if still connected) is always active on Depature.

Fenix2GSX will automatically select the Operator when one of its Service-Calls or your (manually) selected Arrival-Gate requires that. It will default to the Operator marked with [GSX Choice].
If you still want to select the Operator manually, disable that Option in the GUI. But note, that it will always waits 10 Seconds before continuing when a Selection is needed.

Audio-Control

A Note on the Audio-Control: The Tool does not control Audio until the Plane is powered (=FCU is On).
When you end your Session, Fenix2GSX will try to reset the Application-Audio to unmuted and last set Volume (before it started controlling the Volume). But that does not really work on GSX because it is resetting at the same Time. So GSX can stay muted when switching to another Plane (if it was muted) - keep that in Mind.
Please also note that Fenix2GSX controls all Audio Sessions on all Devices for a configured Application. So if an Application runs on your Speakers and Headphones, both Sessions will have their Volume or Mute-State changed.

The new "Advanced Audio Control" can be used to Control other Apps with the other Channels (VHF2, VHF3, HF1, HF2, CAB, PA) - one App, one Channel. Their knobs are not moved on Start-Up and the Record Latch always mutes/unmutes the App. But that Feature follows the configured Seat-Position and therefore which ACP is used for Audio-Control those Applications.
The Syntax is CHANNEL=Application and multiple Mappings are separated by a , - the Channel-Name is upper-case as noted above and for the Application you need to enter the exact (case-sensitive) Name of the Applications Binary (EXE-File) without Extension. For Example controlling MSFS Volume with the Cabin and Chrome Volume with the Passenger Announcement Knob would be: CAB=FlightSimulator,PA=chrome

Advanced / Hidden Options

Advanced Options not available in the GUI - can be changed in %appdata%\Fenix2GSX\Fenix2GSX.config (Fenix2GSX restart needed. Don't touch any other Option):



Usage

General Service Flow / SOP

Note that Fenix2GSX does not open a Window when started - it is designed to run in the Background, the Window/GUI is only there for Configuration! There is no Need to have the GUI opened while running the Sim. When you do open the GUI, it can safely be closed (it only closes that Window, it does not Stop the Binary/App itself)

Pre-Flight

Besides that general Best Practices, there is nothing Special to consider - Plan your Flight as you always do.

Cockpit Preparation


Departure


Pushback


Enroute


Arrival

(Arrival Services will only start when Engines are off and the Parking Brake is set)


Turn-Around



Service Calls via INT/RAD Switch

You can also use the INT/RAD Switch on the ACP to trigger some Services in certain Situations. Move the Switch to the INT Position and leave it there. When Fenix2GSX reacts to the Request it will reset the Switch Postion as Confirmation! Services triggerable:



Addon NOTAMs

Self-Loading Cargo

There Issues reported when used together with Self-Loading Cargo (SLC). Based on User Reports disabling "Ground Crew" in SLC can help!
You can try to play with some Advanced Options in the .config File to improve Timings.

FlowPro

It is strongly recommended to disable the Option Skip 'Ready to Fly'. Else it might happen that Fenix2GSX starts in the Flight State.


In order to enable/disable the GSX Menu-Entry and prevent the GSX Menu to open/pop-up when Fenix2GSX does the Service Calls, you need to open FlowPro and Scroll on the GSX Icon. Green means on, not-green means off.



NOTE: Please uninstall the Plugin Flow GSX Launcher: it is outdated since that Widget is already included since Flow Version 2023.30.4.13.


FS2Crew

FS2Crew (Fenix Edition): You basically don't need any Ground- or Door-Handling Features of Fs2Crew. This is what another User recommends as Settings to let Fenix2GSX and FS2Crew work together (thanks for sharing):


If you deviate from that, that is fine, but don't bother me with Fenix2GSX is not working properly then 😜



Usage Tips / NOTAMs

Tip for VATSIM / IVAO: Disable the automatic Jetway Operation before loading the Session in MSFS, in Case you need to move to another Gate. If the Gate is free (or you have moved to a free one) you can renable Auto-Connect and the Jetway/Stairs will still connect then, when you don't have the Flightplan imported in the mean Time.
You can also experiement with the advanced autoConnectDelay Option with setting that to a high / safe Value. You can cancel the Delay with the INT/RAD Switch.

Fenix2GSX has a Detection built-in when starting with Engines running (i.e. you selected a Runway as Start). It won't provide any Departure Service apart from removing the Ground-Equipment. It will provide Arrival-Sevices after you've landed again (when you have imported a FlightPlan in the EFB before Take-Off)



Troubleshooting / FCOM

First Order: Ensure you have fully read and understand the Readme πŸ˜‰
If that and any of the Instructions below did not help, and you are really really sure that Fenix2GSX is misbehaving and you provide a meaningful Description with the Logs attached to it (%appdata%\Fenix2GSX\log) - I might look into it if I find it worthwhile.
Else the new "Support-Policy" introduced with 0.3.4 takes Effect: Issues (and Messages/Pings on other Platforms) are directly ignored!
Almost every Problem I dealt with lately has something to do with weird Settings, broken Sim- or GSX-Setups or People just not reading anything I wrote.

Beginning with 0.3.6 the Connection Status in the GUI shows some additional Information about the Fenix2GSX and GSX State. If you encounter Problems, I'd recommend to watch these Values in the GUI while it happens:

Especially the GSX Values are important here: These are the raw Values which Fenix2GSX reads through SimConnect from GSX and the Values it acts upon. So if the Values are faulty, there is nothing that Fenix2GSX can do.


Does not Start


There are no Log Files


Does not Connect / Exception 31

The MobiFlight WASM Module is not installed correctly or at all:


Fenix2GSX is stuck in a Reposition Loop

Some Issue in your Setup causes a Situation where Fenix2GSX can't read/evaluate the GSX Menu File. But during Repostion Fenix2GSX checks actively to be in the right Menu before selecting anything - so it is stuck in a Loop because it can't get that Information.
As a Workaround there are two Advanced/Hidden Config Parameters you can try: 1) If the Cause is that it just takes more Time on your System before everything is fully ready, you can try to increase the startupDelay 2) If that does not help, or Fenix2GSX can never read/evaluate the GSX Menu File, you can try to set ignoreMenuChecks to true. Note that this disables Check meant as Safety-Measure - so you have to hope the Reposition does not do weird Things (and happens at all). But at least you won't be stuck in a Loop anymore πŸ˜…

But generally it would be advisable to eliminate the Root Cause. Maybe a Reinstall through the Offline Installer (see below) or even a complete fresh/clean installation of GSX - in Case your Installation is somehow "corrupted".


Exception or even Crash when Final LS is transmitted

On some Systems the Chromium Embedded Framework (CEF) behaves differently for unknown Reasons - but CEF is needed to trigger the Final LS and its Transmission is needed to advance the current State correctly.
In most Cases it should be fixed by setting the Advanced/Hidden Config Parameter setCefRootPath to true.


Fenix2GSX in Flight/Taxi-In when starting on the Ground

Try to increase the startupDelay Parameter in the Config File.
Can also be caused by FlowPro - check the recommended Settings.


Jetway does not connect

There can be certain Situations where the Jetways stop responding. For me usually when I arrive again at an Airport I already departed from in the same Sim-Session.
This an 100% Asobo-Problem. Any Application is then not able to call Jetways anymore via SimEvent ("TOGGLE_JETWAY"). When you are in such a Situation, confirm it by use "Toggle Jetway" in the Fenix EFB. If it still does not move, you experience that MSFS-"Feature".
The only Workaround is to request the Jetway via ATC Menu. But beware: That does not toggle the mentioned Event, so no Application (i.e. GSX) can detect that the Jetway is connected.
The Workaround is only for the Visuals, GSX (and therefor Fenix2GSX) should handle the Situation and should be able to deboard the Plane (you won't see any Passengers either Way though).


Refuel Stops / Problems with Boarding or Deboarding / other Erratic Behavior

If it is only Boarding (e.g. only 10 Pax boarded) it might be something with your GSX Settings (In Game Menu -> Settings):


If it is only Refueling it might be something with your GSX Settings (In Game Menu -> Settings):


It is also likely that you have Issues with the SimConnect Interface (the API which both GSX and Fenix2GSX use) being overloaded by too many SimObjects (one of these Things Asobo is incapable or unwilling of fixing).
In most Cases this is caused by AI Aircraft or other Tools spawning SimObjects (e.g. Nool VDGS or even GSX itself). Reduce the Number of SimObjects and check if it works better then:


Remove Microsoft Fireworks


There have been also Cases where the GSX Installation was somehow "corrupted". You can try to run the Check in the FSDT Installer multiple Times or use the offline Installer. Else a complete fresh / clean Installation of GSX might be required.