Skip to content

Update tuning guide, usecases and screenshots.#1586

Merged
amilcarlucas merged 1 commit into
masterfrom
customize_configuration_steps
May 4, 2026
Merged

Update tuning guide, usecases and screenshots.#1586
amilcarlucas merged 1 commit into
masterfrom
customize_configuration_steps

Conversation

@amilcarlucas
Copy link
Copy Markdown
Collaborator

Description

Update tuning guide, usecases and screenshots.

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 review requested due to automatic review settings May 3, 2026 22:54
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates the user-facing documentation and screenshot-generation script to reflect revised vehicle creation flows, including new screenshots for creating projects from templates and .bin logs.

Changes:

  • Expanded the screenshot automation script with new capture targets, highlight variants, FC-connected creator flows, and Windows-specific image cropping.
  • Refreshed USECASES.md with updated step-by-step flows and new screenshots for template-based and .bin-based project creation.
  • Updated the ArduCopter tuning guide to align its onboarding steps and screenshots with the revised UI flow.

Reviewed changes

Copilot reviewed 3 out of 8 changed files in this pull request and generated 6 comments.

File Description
scripts/regenerate_app_screenshots_fully_automated.py Adds new screenshot targets and capture logic for updated opener/creator workflows.
USECASES.md Revises user workflows and embeds newly generated screenshots.
TUNING_GUIDE_ArduCopter.md Updates the tuning guide’s setup steps and references the new screenshots.

Comment thread USECASES.md Outdated
Comment thread USECASES.md Outdated
Comment thread TUNING_GUIDE_ArduCopter.md Outdated
Comment thread USECASES.md Outdated
Comment thread USECASES.md Outdated
Comment thread TUNING_GUIDE_ArduCopter.md Outdated
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 3 out of 8 changed files in this pull request and generated 2 comments.

"App_screenshot_Vehicle_directory3.png",
"vehicle_creator_legacy3",
scale=0.8,
variant="params3",
Comment thread TUNING_GUIDE_ArduCopter.md Outdated
![FC connection and parameter download](images/App_screenshot_FC_info_and_param_download.png)
1. Now using [New](USERMANUAL.md#new) subsection
1. Press the *Create a vehicle configuration directory from template* button.<br>
![Create a vehicle configuration directory from template](images/App_screenshot_Vehicle_directory_create_from_template.png)
@amilcarlucas amilcarlucas force-pushed the customize_configuration_steps branch from b9ae200 to 97fe4e0 Compare May 4, 2026 00:08
@amilcarlucas amilcarlucas requested a review from Copilot May 4, 2026 00:09
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 6 out of 17 changed files in this pull request and generated 4 comments.

Comment on lines +945 to 958
elif action.startswith("create_from_template_"):
if target.variant is None:
msg = f"variant required for {action}"
raise RuntimeError(msg)
# Create from template shows the flow without pre-configured FC options
_capture_vehicle_creator_with_highlight(
output_path,
args.delay,
args.padding,
args.vehicle_dir,
current_file="20_throttle_controller.param",
gui_complexity="normal",
scale=0.666,
target.variant,
scale=target.scale,
fc_connected=False,
)
Comment thread TUNING_GUIDE_Rover.md
Comment on lines 134 to +137
1. Open *ArduPilot Methodic Configurator*, and [connect it to the vehicle](USERMANUAL.md#step-1-flight-controller-connection).
![FC connection and parameter download](images/App_screenshot_FC_info_and_param_download.png)
1. Now using [New](USERMANUAL.md#new) subsection
![New vehicle](images/App_screenshot_Vehicle_directory1.png)
![New vehicle](images/App_screenshot_Vehicle_directory_create_from_template_source.png)
Comment thread TUNING_GUIDE_Heli.md
Comment on lines 133 to +136
1. Open *ArduPilot Methodic Configurator*, and [connect it to the vehicle](USERMANUAL.md#step-1-flight-controller-connection).
![FC connection and parameter download](images/App_screenshot_FC_info_and_param_download.png)
1. Now using [New](USERMANUAL.md#new) subsection
![New vehicle](images/App_screenshot_Vehicle_directory1.png)
![New vehicle](images/App_screenshot_Vehicle_directory_create_from_template_source.png)
Comment thread TUNING_GUIDE_ArduPlane.md
Comment on lines 138 to 140
1. From the existing templates, select the one most similar to your vehicle:
![New vehicle](images/App_screenshot_Vehicle_overview.png)
1. select the destination directory, give it a name and press `Create a vehicle configuration directory from template`
@amilcarlucas amilcarlucas merged commit 339210c into master May 4, 2026
21 of 28 checks passed
@amilcarlucas amilcarlucas deleted the customize_configuration_steps branch May 4, 2026 00:21
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 4, 2026

☂️ Code Coverage

current status: ✅

Overall Coverage

Statements Covered Coverage Threshold Status
12578 11859 94% 89% 🟢

New Files

No new covered files...

Modified Files

No covered modified files...

updated for commit: 97fe4e0 by action🐍

@coveralls
Copy link
Copy Markdown

Coverage Report for CI Build 25294760630

Warning

Build has drifted: This PR's base is out of sync with its target branch, so coverage data may include unrelated changes.
Quick fix: rebase this PR. Learn more →

Warning

No base build found for commit ddf8f40 on master.
Coverage changes can't be calculated without a base build.
If a base build is processing, this comment will update automatically when it completes.

Coverage: 94.38%

Details

  • Patch coverage: No coverable lines changed in this PR.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

Requires a base build to compare against. How to fix this →


Coverage Stats

Coverage Status
Relevant Lines: 12581
Covered Lines: 11874
Line Coverage: 94.38%
Relevant Branches: 1883
Covered Branches: 1822
Branch Coverage: 96.76%
Branches in Coverage %: No
Coverage Strength: 2.82 hits per line

💛 - Coveralls

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants