Skip to content

docs(mavftp): add animated walkthroughs for flight log analysis - #2409

Merged
amilcarlucas merged 1 commit into
masterfrom
gifs
Nov 22, 2026
Merged

amilcarlucas merged 1 commit into
masterfrom
gifs

Conversation

@amilcarlucas

Copy link
Copy Markdown
Collaborator

Description

Show how to download a DataFlash log from the flight controller and open it from the local file context menu. Update the four tuning guides to use this workflow and embed the relevant animations.

Add seven walkthroughs for plotbeta, plot, Hardware Report, MagFit, PID Review, Stream Stats, and System ID. Filter Review failed while loading the example flight log, so it has no animation.

Share the download frames across the GIFs and capture each tool's menu selection and browser view separately. Allow the generator to use a synthetic log or an existing DataFlash log and to target individual tools.

Checklist

  • Run pre-commit checks locally
  • Verified by a human programmer
  • All commits are signed off (use git commit --signoff)
  • Code follows our coding standards
  • Documentation updated if needed
  • No breaking changes or properly documented

Testing

Describe how you tested these changes:

  • Unit tests pass
  • Integration tests pass
  • Manual testing performed
  • Tested on flight controller hardware

Copilot AI balanced review requested due to automatic review settings November 21, 2026 22:02

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The tuning guides still direct users to AMC’s log analyser for field-level plots and ATUN inspection that it cannot provide, so those instructions need to use plotbeta instead.

1 open issue
What changed in this PR

This PR documents the existing MAVFTP file-browser workflow for downloading flight logs and opening them in analysis tools, with animated guidance integrated into the tuning documentation.

Changes:

  • Update all four tuning guides to use the downloaded log’s context menu.
  • Embed relevant walkthrough animations in the guides and MAVFTP manual.
  • Add an animation generator with shared download frames, configurable log input, and per-tool selection; Filter Review is excluded by default.
File Description
USERMANUAL_MAVFTP.md Add a download-to-plotbeta animation above the window overview.
TUNING_GUIDE_Rover.md Update log-analysis instructions and embed relevant walkthroughs.
TUNING_GUIDE_Heli.md Update helicopter tuning workflows to use the file-browser context menu.
TUNING_GUIDE_ArduPlane.md Integrate context-menu analysis steps and animations into plane tuning guidance.
TUNING_GUIDE_ArduCopter.md Update flight-log inspection and tuning steps with context-menu workflows and animations.
scripts/​generate_mavftp_animation.py Generate tool-specific GIFs using shared download frames and captured browser views.

Review effort: Balanced

Comment thread TUNING_GUIDE_ArduCopter.md Resolved
@github-actions

github-actions Bot commented Nov 21, 2026 •

Copy link
Copy Markdown
Contributor

☂️ Code Coverage

current status: ✅

Overall Coverage

Statements Covered Coverage Threshold Status
31787 30522 96% 89% 🟢

New Files

No new covered files...

Modified Files

No covered modified files...

updated for commit: 32ef18f by action🐍

@github-actions

github-actions Bot commented Nov 21, 2026 •

Copy link
Copy Markdown
Contributor

Test Results

     5 files  ±0       5 suites  ±0   58m 36s ⏱️ -43s
10 474 tests ±0  10 408 ✅ ±0   4 💤 ±0  62 ❌ ±0 
52 061 runs  ±0  51 864 ✅ ±0  98 💤 ±0  99 ❌ ±0 

For more details on these failures, see this check.

Results for commit 21345e7. ± Comparison against base commit 4393038.

♻️ This comment has been updated with latest results.

@amilcarlucas amilcarlucas added the AIReview Request an automated AI review; picked up by the reviewprs sweep label Nov 21, 2026
@AP-Review

AP-Review commented Nov 21, 2026 •

Copy link
Copy Markdown

Deprecated — see below for the updated review.

Previous review (2026-11-21)

Automated review note — AI-generated (Claude+Codex), validated against the live diff. Please sanity-check before acting.
Verdict: COMMENT

Reviewed at head eb16bced7a.
Full report: https://firmware.ardupilot.org/Tools/APReview/DevCallReviews/PRReviews/ardupilot/methodicconfigurator/2409/1.html#prMethodicConfigurator-2409

The new MAVFTP walkthroughs and links work, but five of the new instructions send users to the wrong analysis tool.

Should fix

Minor (2)
  • images/MAVFTP_download_*.gif: all seven GIFs (1.6-1.9 MB) fail the repo's check-added-large-files pre-commit hook, and the plot, streamstats and sysid GIFs (about 5 MB) are not referenced anywhere. Shrink them or exclude them deliberately, and drop the unused ones.
  • scripts/generate_mavftp_animation.py:293: the frames show the capture machine's C:\Users\…\AppData\Local\Temp\… path. Mask only the displayed directory text during capture, as regenerate_app_screenshots_fully_automated.py does. Do not change local_directory_var before the transfer, because that is the real destination.

@AP-Review

AP-Review commented Nov 22, 2026 •

Copy link
Copy Markdown

Deprecated — see below for the updated review.

Previous review (2026-11-22)

Automated review note — AI-generated (Claude+Codex), validated against the live diff. Please sanity-check before acting.
Verdict: COMMENT

Reviewed at head 21345e76b6.
Full report: https://firmware.ardupilot.org/Tools/APReview/DevCallReviews/PRReviews/ardupilot/methodicconfigurator/2409/2.html#prMethodicConfigurator-2409

The animated walkthroughs look good, with only two cosmetic nits left in the new generator script.

All earlier findings are fixed since the last review: the five Autotune and overheating instructions now use plotbeta, the GIFs are under the 500 KB pre-commit limit and are all referenced, and the Windows temp path is masked in the frames.

Minor (2)
  • scripts/generate_mavftp_animation.py:321: in the GIFs, "Verify transfers with CRC32" is ticked in step 3 and unticked from step 4, and 00000158.BIN shows 1.2 MB on the FC but 5.0 MB on the PC. Set the checkbox state before the first frame is recorded, and list the example log's real size in the fake remote listing.
  • scripts/generate_mavftp_animation.py:1: the file has CRLF line endings, so with mode 755 ./scripts/generate_mavftp_animation.py fails on Linux (env: 'python3\r'). Convert it to LF.

Not fully reviewed: the generator was not run end to end, and live web-tool analysis (including Filter Review) and CI at this head were not checked.

@coveralls

Copy link
Copy Markdown

Coverage Report for CI Build 44968726406

Coverage remained the same at 96.052%

Details

  • Coverage remained the same as the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.


Coverage Stats

Coverage Status
Relevant Lines: 31787
Covered Lines: 30532
Line Coverage: 96.05%
Relevant Branches: 9642
Covered Branches: 8770
Branch Coverage: 90.96%
Branches in Coverage %: No
Coverage Strength: 2.86 hits per line

💛 - Coveralls

@AP-Review

Copy link
Copy Markdown

Automated review note — AI-generated (Claude+Codex), validated against the live diff. Please sanity-check before acting.
Verdict: COMMENT

Reviewed at head 049fdf1237.
Full report: https://firmware.ardupilot.org/Tools/APReview/DevCallReviews/PRReviews/ardupilot/methodicconfigurator/2409/3.html#prMethodicConfigurator-2409

Both cosmetic nits from the last review are fixed, but at the new head the Filter Review animation never shows a result and the generator now fails pylint.

Since the last review, the CRC32 checkbox stays ticked, 00000158.BIN shows 5.0 MB on both sides, and the script has LF line endings.

Should fix

  • scripts/generate_mavftp_animation.py:128: the new Filter Review GIF (embedded at TUNING_GUIDE_ArduCopter.md:1157) ends on a frame captioned "Filter Review displays the selected log" that still shows the "Loading" overlay over empty plots. The alert is accepted and the screenshot follows a fixed sleep(2) (line 140). Wait for #loading to be hidden and fail if an alert appears, or leave Filter Review out until the example log works.
  • scripts/generate_mavftp_animation.py:97: pylint 4.1.3 now reports W0221 arguments-differ here (the base get_remote_files is a @staticmethod) and R0912 too-many-branches (16/12) on main() at line 181, so the pylint CI job will fail. Add too-many-branches to the main() disable, and suppress arguments-differ on the override or make the base method an instance method.

Not run: the generator end to end or Filter Review live. CI at this head was still queued.

Show how to download a DataFlash log from the flight controller and
open it from the local file context menu. Update the four tuning
guides to use this workflow and embed the relevant animations.

Add seven walkthroughs for plotbeta, plot, Hardware Report, MagFit,
PID Review, Stream Stats, and System ID. Filter Review failed while
loading the example flight log, so it has no animation.

Share the download frames across the GIFs and capture each tool's
menu selection and browser view separately. Allow the generator to
use a synthetic log or an existing DataFlash log and to target
individual tools.

Signed-off-by: Dr.-Ing. Amilcar do Carmo Lucas <amilcar.lucas@iav.de>
@amilcarlucas
amilcarlucas merged commit 5ac7b2d into master Nov 22, 2026
23 of 28 checks passed
@amilcarlucas
amilcarlucas deleted the gifs branch November 22, 2026 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AIReview Request an automated AI review; picked up by the reviewprs sweep

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants