Repository navigation
docs(mavftp): add animated walkthroughs for flight log analysis - #2409
Conversation
There was a problem hiding this comment.
🟡 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
☂️ Code Coverage
Overall Coverage
New FilesNo new covered files... Modified FilesNo covered modified files...
|
Test Results 5 files ±0 5 suites ±0 58m 36s ⏱️ -43s 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. |
Previous review (2026-11-21)Automated review note — AI-generated (Claude+Codex), validated against the live diff. Please sanity-check before acting. Reviewed at head The new MAVFTP walkthroughs and links work, but five of the new instructions send users to the wrong analysis tool. Should fix
Minor (2)
|
Previous review (2026-11-22)Automated review note — AI-generated (Claude+Codex), validated against the live diff. Please sanity-check before acting. Reviewed at head 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)
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. |
Coverage Report for CI Build 44968726406Coverage remained the same at 96.052%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsNo coverage regressions found. Coverage Stats💛 - Coveralls |
|
Automated review note — AI-generated (Claude+Codex), validated against the live diff. Please sanity-check before acting. Reviewed at head 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
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>

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
git commit --signoff)Testing
Describe how you tested these changes: