feat: flyPad Local Files via SimBridge

[frankkopp]

Summary of Changes

Add the following SimBridge dependent features and fixes to the flyPad:

• [x] Local Files
  • [x] Images
  • [x] PDF
• [x] Fix pagination for PDF
• [x] Fix horizontal and vertical zoom for mixed PDFs (landscape and portrait pages)
• [ ] Testing

Fixes to do:

• [x] Having a subfolder within the resources folders seems to crash simbridge.
  • Requires a fix in SimBridge to be merged (hides folders)]
• [x] Charts above 5MB in size tend to take very long to display, a loading animation may be needed so that the user knows that the chart is still in the process of loading in.
• [ ] Power cycling EFB results in "There is no chart to display" message and inability to display any charts. Workaround: Select navigraph charts tab, then return to local files tab.

Screenshots (if necessary)

Additional context

Requires SimBridge - therefore targeted against the Experimental branch for now.

Discord username (if different from GitHub): Cdr_Maverick#6475

Testing instructions

Have SimBridge running to test this. Add some files to the SimBridge resources/images and resources/pdf folder Add multi-paged PDF files

• Check that the files you copied into the resource folders appear under Local Files (image, pdf and both)
• Click on files to see of they are loading
• Check if multi-page PDFs are loading and pages can be iterated through
• Check fullscreen, zooming, fit to height, fit to width, rotation, and resetting in any combination you can think of
  • Check this also for Navigraph charts
• Check pinning local files (remember when clicking on a pinned chart and wanting to see all files again, delete the search field content)
• In general try to break anything

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

[Benjozork]

Copied from other PR:

this cannot be merged or put into exp before https://github.com/flybywiresim/simbridge/issues/30 is fixed

[2hwk]

QA Report Discord: 2Cas#1022 Object of testing: https://github.com/flybywiresim/a32nx/pull/7451 Tier of Testing: 2 Date: 2/09/2022

• [x] Have SimBridge running to test this.
• [x] Add some files to the SimBridge resources/images and resources/pdf folder
• [x]Add multi-paged PDF files
• [x] Check that the files you copied into the resource folders appear under Local Files (image, pdf and both)
• [x] Click on files to see of they are loading
• [x] Check if multi-page PDFs are loading and pages can be iterated through
• [x] Check fullscreen, zooming, fit to height, fit to width, rotation, and resetting in any combination you can think of
  • [x] Check this also for Navigraph charts
• [ ] Check pinning local files (remember when clicking on a pinned chart and wanting to see all files again, delete the search field content) - FAILED
• [ ] In general try to break anything - FAILED

Negatives:

• In simbridge/resources -> Images/PDFs should be able to be stored in the same folder, and not require them to be sorted into seperate resources/images and resources/pdf folders
• Having a subfolder within the resources folders seems to crash simbridge. It would be desirable for Image/PDF Content to be found recursively through subfolders and then passed through to the sim.
• Charts above 5MB in size tend to take very long to display, a loading animation may be needed so that the user knows that the chart is still in the process of loading in.
• Pinned items should always have priority for display over unpinned items
• Power cycling EFB results in "There is no chart to display" message and inability to display any charts. Workaround: Select navigraph charts tab, then return to local files tab.

Test Result: Not Passed.

Conclusion: Good start, but not quite ready for experimental yet given several critical bugs, particularly the power cycle EFB bug and the priority of pinned items.

[frankkopp]

• In simbridge/resources -> Images/PDFs should be able to be stored in the same folder, and not require them to be sorted into seperate resources/images and resources/pdf folders
• Having a subfolder within the resources folders seems to crash simbridge. It would be desirable for Image/PDF Content to be found recursively through subfolders and then passed through to the sim.
• Charts above 5MB in size tend to take very long to display, a loading animation may be needed so that the user knows that the chart is still in the process of loading in.
• Pinned items should always have priority for display over unpinned items
• Power cycling EFB results in "There is no chart to display" message and inability to display any charts. Workaround: Select navigraph charts tab, then return to local files tab.

Thanks for the tests. I have taken the feature as it was was build by Erick and did not expand on it but reactivated it and fixex some issue. Most of the things below did exist before and are per design - e.g. separate folders. Only the last seem to be an actual bug. The others are new features.

I'm not saying I disagree with them but they were not in scope of this PR.

I will see if some can be done easily but I do assume another PR with additional features should be done.

[frankkopp]

@2hwk

Having a subfolder within the resources folders seems to crash simbridge. It would be desirable for Image/PDF Content to be found recursively through subfolders and then passed through to the sim.

Does not crash SimBrief for me - doesn't work as it was never meant to work but no crash.

[frankkopp]

@2hwk

Having a subfolder within the resources folders seems to crash simbridge. It would be desirable for Image/PDF Content to be found recursively through subfolders and then passed through to the sim.

Does not crash SimBrief for me - doesn't work as it was never meant to work but no crash.

@Lucky38i will fix the above error in simbridge a create a PR - will filter out directories. If we want a recursive file search in the future we need to extend this.

[EuanM199]

QA Report Discord: Euan#7980 Object of testing: https://github.com/flybywiresim/a32nx/pull/7451 Tier of Testing: 2 Date: 11/09/2022

• [x] Have SimBridge running to test this.
• [x] Add some files to the SimBridge resources/images and resources/pdf folder
• [x] Add multi-paged PDF files
• [x] Check that the files you copied into the resource folders appear under Local Files (image, pdf and both)
• [ ] Click on files to see of they are loading - PARTIAL FAILURE
• [X] Check if multi-page PDFs are loading and pages can be iterated through
• [x] Check fullscreen, zooming, fit to height, fit to width, rotation, and resetting in any combination you can think of
• [ ] Check this also for Navigraph charts - FAILURE
• [x] Check pinning local files (remember when clicking on a pinned chart and wanting to see all files again, delete the search field content)
• [ ] In general try to break anything - FAILED

images and PDFs do load and can be iterated through, However Sometimes the "LOADING PDF" popup shows up with 2 of them that forever loads and does not disappear until a next page is selected on the PDF, This can be tricky since the PDF popup directly blocks the next page option

Navigraph Connection also does not work anymore and forever loads.

[frankkopp]

images and PDFs do load and can be iterated through, However Sometimes the "LOADING PDF" popup shows up with 2 of them that forever loads and does not disappear until a next page is selected on the PDF, This can be tricky since the PDF popup directly blocks the next page option

This issue only appeared because there is fix missing in SimBridge. But I also fixed this case now so it should work. Maybe you can doublecheck ?

Navigraph Connection also does not work anymore and forever loads.

I could not reproduce this - mine worked. Even removed the device from my Navigraph account and re-authenticated. No problems on my side. Might need more tests from other users or there is an issue on your side. I didn't really touch the Navigraph code - can't see how I could have messed it up.

[mico975]

Quality Assurance Tester Report

Discord : mico#3145 Object of testing: #7451 Tier of Testing : 2 Date : 26/09/2022

Testing Process: Check that the files you copied into the resource folders appear under Local Files (image, pdf and both) - OK Click on files to see of they are loading - OK Check if multi-page PDFs are loading and pages can be iterated through - OK Check fullscreen, zooming, fit to height, fit to width, rotation, and resetting in any combination you can think of - ALL OK Check this also for Navigraph charts Check pinning local files (remember when clicking on a pinned chart and wanting to see all files again, delete the search field content) - OK In general try to break anything - See negatives below.

Negatives:
Minor issue with "There is no chart to display" on power cycle, but it's easily corrected by switching to Navigraph or pinned charts tab. Needs to be documented in the docs.

Testing Results: Passed

Conclusions: LGTM

Media: