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

feat: flyPad Checklists refactor and adaption to A380X #8593

Merged
merged 32 commits into from
Apr 5, 2024

Conversation

frankkopp
Copy link
Member

@frankkopp frankkopp commented Mar 29, 2024

Summary of Changes

This PR brings the flyPad Checklists to the A380X using a slight blend of the A380X paper checklist and A380X ECL lists.

It includes refactoring how checklists are defined using json5 configurations so that multiple aircrafts can be easily defined using a configuration path that can be determined by the aircraft type. The goal is to enable mods to alter these configurations for the users.
It is planned to integrate this with the currently developed unified configuration framework (#8599)

This PR also enhances the data structure of the checklists to allow for checklist lines ("down to the line" and "below the line") and sub checklists as they appear on the A380X ECL. The aim is to reuse these data structures for the ECL once implemented.

The refactoring also impacts the A32NX checklists with little visible changes to the user.

One noticeable change is that automatically checked items are now updated in all checklists not yet completed. Previously these updates were limited to the checklist associated with the current flight phase which was confusing as it then showed completed items as incomplete (or vice versa) in checklists outside the current flight phase without any hint why the status is displayed incorrectly.

Screenshots (if necessary)

image

References

Reference showing Sublist and Line: https://youtu.be/p28erS6uWHE?t=2514

image

Discord username (if different from GitHub): cdr_maverick

Testing instructions

A32NX:
Test all checklist using manual and autocompletion mode.
Esp. the auto-complete items should actually show correctly - e.g. PARK BRK ON is complete when parking brake is set.

A380X:
Test all checklist using manual and autocompletion mode.
Esp. the auto-complete items should actually show correctly - e.g. PARK BRK ON is complete when parking brake is set.

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.

  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 either flybywire-aircraft-a320-neo or flybywire-aircraft-a380-842 download link at the bottom of the page

@frankkopp frankkopp self-assigned this Mar 29, 2024
@frankkopp frankkopp added Not Ready For Review Still draft but needs a GitHub build A32NX Related to the A32NX aircraft A380X Related to the A380X aircraft labels Mar 29, 2024
@frankkopp frankkopp marked this pull request as ready for review March 29, 2024 23:58
@2hwk
Copy link
Member

2hwk commented Mar 30, 2024

Note: build is failing

@frankkopp frankkopp force-pushed the a380x-flypad-checklist branch 3 times, most recently from 0fda55f to bf4507e Compare April 1, 2024 06:33
@frankkopp frankkopp changed the title feat: flyPad Checklists for A380X feat: flyPad Checklists refactor and adaption to A380X Apr 1, 2024
@frankkopp frankkopp added Needs Code Review Not Ready For Review Still draft but needs a GitHub build and removed Not Ready For Review Still draft but needs a GitHub build Needs Code Review labels Apr 1, 2024
@frankkopp frankkopp force-pushed the a380x-flypad-checklist branch from a8f4bc5 to f585d0c Compare April 1, 2024 20:27
@frankkopp frankkopp added Needs Code Review and removed Not Ready For Review Still draft but needs a GitHub build labels Apr 1, 2024
@frankkopp frankkopp requested a review from 2hwk April 1, 2024 20:34
@frankkopp frankkopp added Not Ready For Review Still draft but needs a GitHub build and removed Needs Code Review labels Apr 1, 2024
@frankkopp frankkopp force-pushed the a380x-flypad-checklist branch from f9bd89a to 3e8a8e2 Compare April 2, 2024 08:42
@frankkopp frankkopp added Needs Code Review QA Tier 1 QA Ready to Test and removed Not Ready For Review Still draft but needs a GitHub build labels Apr 2, 2024
frankkopp added 19 commits April 4, 2024 13:53
…tialize using the actual aircraft checklist as a template. The 'getAircraftType()' function, hard-coded checklist definitions and 'setChecklistItems' action were removed. In their place, a new 'addTrackingChecklists' action was introduced to dynamically add tracking checklists. Further changes were made in `Efb.tsx` to load and process aircraft checklists accordingly.
…tsx of the aircraft EFB class to make sure it is loaded before any component of the EFB is loaded.
@frankkopp frankkopp force-pushed the a380x-flypad-checklist branch from 41b1498 to 1d3010a Compare April 4, 2024 11:54
@pilotseyea350
Copy link

Quality Assurance Trainee Report

Discord : PilotEyesA350
Object of testing: #8593
Tier of Testing : 2
Date : 04/04/2024

Testing Process:

Spawn at EDDM
Load 4.7tons of fuel
Turn on Automatic Checks
Perform cockpit preparation
Prepare Flight from and to EDDM (T/O RWY26L, Landing ILS26R)
Follow the checklists throughout the flight and make sure items are automatically checked
Land and park at Stand 308
Turn the aircraft off and observe checklists items are automatically checked
Reset checklists
Turn aircraft back on
Turn off Automatic Checks
Manually check in each checklist thateach item can be clicked

Negatives:
N/A

Testing Results:
Passed

Conclusions:
Working as expected

Media:
N/A

@frankkopp frankkopp merged commit 711d93a into flybywiresim:master Apr 5, 2024
7 checks passed
@frankkopp frankkopp deleted the a380x-flypad-checklist branch April 5, 2024 12:18
@2hwk 2hwk added this to the v0.12.0 milestone Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A32NX Related to the A32NX aircraft A380X Related to the A380X aircraft QA Passed QA Tier 1
Projects
Status: ✔️ Done
Development

Successfully merging this pull request may close these issues.

5 participants