Skip to content

docs: add troubleshooting guide for missing Actuators tab - #14862

Merged
DonLakeFlyer merged 2 commits into
mavlink:masterfrom
Tartistbz:docs/actuators-troubleshooting
Aug 15, 2026
Merged

docs: add troubleshooting guide for missing Actuators tab#14862
DonLakeFlyer merged 2 commits into
mavlink:masterfrom
Tartistbz:docs/actuators-troubleshooting

Conversation

@Tartistbz

Copy link
Copy Markdown
Contributor

Documentation Changes

  • Add a troubleshooting section to the PX4 Actuators / Motors setup page.
  • Explain that component metadata, initialization, and show-ui-if determine whether the Actuators page appears.
  • Document how to capture the three relevant logging categories and interpret common FTP, HTTP fallback, and initialization failures.
  • List the information users should include in support requests.

Reason

QGroundControl already logs why it falls back to the legacy Motors page, but users did not have instructions for collecting or interpreting those messages. This update provides a self-diagnosis workflow for the common missing Actuators page report.

Validation

  • VitePress documentation build passes with npm run docs:build.
  • markdownlint passes for the modified file.
  • The generated Actuators page was previewed locally on Windows.

Checklist

  • I have checked for spelling/grammar errors.
  • Links are valid and working (no new links were added).
  • Screenshots are up to date (not applicable; no screenshots were changed).
  • I have previewed the changes locally.
  • I have read the contribution guidelines and Code of Conduct.

Related Issues

Closes #14851


By submitting this pull request, I confirm that my contribution is made under the terms of the project's dual license (Apache 2.0 and GPL v3).

@github-actions github-actions Bot added the Docs label Aug 14, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Thanks for your first pull request! 🎉

A maintainer will review this soon. Please ensure:

  • CI checks pass
  • Code follows coding standards
  • Changes tested on relevant platforms

We appreciate your contribution to QGroundControl!

@github-actions

github-actions Bot commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

⚠️ Build results unavailable — artifact download from one or more platform workflows failed (likely artifact retention expiry or transient API error). The combined report cannot be generated for this run.

See the Build Results workflow run for details.

@DonLakeFlyer DonLakeFlyer added this to the Release V5.1 milestone Aug 15, 2026
@DonLakeFlyer

Copy link
Copy Markdown
Contributor

Thanks. Can you flip the order of this so the troubleshooting is at the bottom of the page, not the top

@Tartistbz

Copy link
Copy Markdown
Contributor Author

Thanks for the suggestion. I moved the troubleshooting section to the end of the Actuators / Motors page and verified the documentation build and markdownlint locally.

@DonLakeFlyer
DonLakeFlyer merged commit 68cc1bb into mavlink:master Aug 15, 2026
27 checks passed
@DonLakeFlyer
DonLakeFlyer requested a balanced review from Copilot August 15, 2026 18:38

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.

Pull request overview

Adds troubleshooting guidance for diagnosing a missing PX4 Actuators page.

Changes:

  • Explains Actuators page selection.
  • Documents log capture and common failure messages.
  • Lists support-request details.
Suppressed comments (1)

docs/en/qgc-user-guide/setup_view/px4/actuators.md:63

  • This interpretation is too strong: Condition::evaluate() also returns false when the referenced parameter is unavailable, so this message can indicate a metadata/firmware compatibility problem rather than deliberate hiding for the current configuration (src/Vehicle/Actuators/Common.cc:194-199). Describe the result neutrally and direct users to the condition log for the cause.
| `Vehicle.Actuators.PX4AutoPilotPlugin` | `Condition 'show-ui-if' evaluated to false` | The metadata deliberately hides the page for the current vehicle configuration. |

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

Comment on lines +43 to +45
- `Vehicle.Actuators.PX4AutoPilotPlugin`
- `ComponentInformation.RequestMetaDataTypeStateMachine`
- `Vehicle.FTPManager`

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.

@Tartistbz Do you think you could submit another pull which this change?

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.

Nevermind, I'll take care of it.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: troubleshooting guide for missing Actuators tab (logging-based diagnosis)

3 participants