Skip to content

Commit 7fe5b11

Browse files
committed
docs(troubleshooting): reorganize troubleshooting section and modernize logging docs
- Add Standard Modes / external flight mode troubleshooting page (Fixes #14890) - Move actuators troubleshooting from setup docs to troubleshooting section - Move Console Logging page from settings to troubleshooting section - Update stale UI names to App Log Viewer / Categories - Update log category names to current dotted runtime names - Replace outdated console logging screenshot, remove orphaned assets
1 parent 184a05f commit 7fe5b11

21 files changed

Lines changed: 171 additions & 156 deletions
101 KB
Loading

‎docs/assets/support/console.jpg‎

-77.5 KB
Binary file not shown.
-66.6 KB
Binary file not shown.

‎docs/en/SUMMARY.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,6 @@
6565
- [Plan View](qgc-user-guide/settings_view/plan_view.md)
6666
- [ADSB Server](qgc-user-guide/settings_view/adsb_server.md)
6767
- [Comm Links](qgc-user-guide/settings_view/comm_links.md)
68-
- [Logging](qgc-user-guide/settings_view/console_logging.md)
6968
- [Maps](qgc-user-guide/settings_view/maps.md)
7069
- [NTRIP / RTK](qgc-user-guide/settings_view/ntrip_rtk.md)
7170
- [PX4 Log Transfer](qgc-user-guide/settings_view/px4_log_transfer.md)
@@ -82,12 +81,15 @@
8281
- [MAVLink Inspector](qgc-user-guide/analyze_view/mavlink_inspector.md)
8382
- [Reference](qgc-user-guide/reference/index.md)
8483
- [Troubleshooting](qgc-user-guide/troubleshooting/index.md)
84+
- [Console Logging](qgc-user-guide/troubleshooting/console_logging.md)
8585
- [Setup Problems](qgc-user-guide/troubleshooting/qgc_setup.md)
8686
- [Usage Problems](qgc-user-guide/troubleshooting/qgc_usage.md)
8787
- [Connection problems](qgc-user-guide/troubleshooting/vehicle_connection.md)
8888
- [Parameter Download failures](qgc-user-guide/troubleshooting/parameter_download.md)
8989
- [Plan Upload/Download failures](qgc-user-guide/troubleshooting/plan_upload_download.md)
9090
- [Resume Mission failures](qgc-user-guide/troubleshooting/resume_mission.md)
91+
- [Standard Modes / External Flight Mode failures](qgc-user-guide/troubleshooting/standard_modes.md)
92+
- [Missing Actuators Page (PX4)](qgc-user-guide/troubleshooting/actuators.md)
9193
- [Privacy Policy](qgc-user-guide/reference/privacy_policy.md)
9294

9395
- [Developer's Guide](qgc-dev-guide/index.md)

‎docs/en/qgc-dev-guide/command_line_options.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,16 @@ Linux Terminal:
3030

3131
The options/command line arguments are listed in the table below.
3232

33-
| Option | Description |
34-
| --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
35-
| `--clear-settings` | Clears the app settings (reverts _QGroundControl_ back to default settings). |
36-
| `--logging:full` | Turns on full logging. See [Console Logging](../qgc-user-guide/settings_view/console_logging.md#logging-from-the-command-line). |
37-
| `--logging:full,LinkManagerVerboseLog,ParameterLoaderLog` | Turns on full logging and turns off the following listed comma-separated logging options. |
38-
| `--logging:LinkManagerLog,ParameterLoaderLog` | Turns on the specified comma separated logging options |
39-
| `--unittest:name` | (Debug builds only) Runs the specified unit test. Leave off `:name` to run all tests. |
40-
| `--unittest-stress:name` | (Debug builds only) Runs the specified unit test 20 times in a row. Leave off :name to run all tests. |
41-
| `--fake-mobile` | Simulates running on a mobile device. |
42-
| `--test-high-dpi` | Simulates running _QGroundControl_ on a high DPI device. |
33+
| Option | Description |
34+
| ---------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
35+
| `--clear-settings` | Clears the app settings (reverts _QGroundControl_ back to default settings). |
36+
| `--logging:full` | Turns on full logging. See [Console Logging](../qgc-user-guide/troubleshooting/console_logging.md#logging-from-the-command-line). |
37+
| `--logging:full,Comms.LinkManager:verbose,FactSystem.ParameterManager` | Turns on full logging and turns off the following listed comma-separated logging categories. |
38+
| `--logging:Comms.LinkManager,FactSystem.ParameterManager` | Turns on the specified comma separated logging categories. |
39+
| `--unittest:name` | (Debug builds only) Runs the specified unit test. Leave off `:name` to run all tests. |
40+
| `--unittest-stress:name` | (Debug builds only) Runs the specified unit test 20 times in a row. Leave off :name to run all tests. |
41+
| `--fake-mobile` | Simulates running on a mobile device. |
42+
| `--test-high-dpi` | Simulates running _QGroundControl_ on a high DPI device. |
4343

4444
Notes:
4545

‎docs/en/qgc-dev-guide/file_formats/settings_override.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ The following file forces the video decoder setting to a specific value and hide
114114

115115
## Debugging
116116

117-
Enable the `SettingsManagerLog` logging category ([Console Logging](../../qgc-user-guide/settings_view/console_logging.md)) to see which override files are loaded and which overrides are applied at startup.
117+
Enable the `Utilities.SettingsManager` logging category ([Console Logging](../../qgc-user-guide/troubleshooting/console_logging.md)) to see which override files are loaded and which overrides are applied at startup.
118118

119119
## Related Mechanisms
120120

‎docs/en/qgc-user-guide/plan_view/plan_view.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ This tool is only visible if the vehicle firmware supports ROI mode.
7373
### Return / Land
7474

7575
Adds a return or land command to the mission. The label varies by vehicle type:
76+
7677
- **Multicopters:** _Return_
7778
- **Fixed-wing:** _Land_ (or _Alt Land_ if a land item already exists in the mission)
7879

@@ -193,6 +194,4 @@ The loss rate should be in the low single digits (i.e. maximum of 2 or 3):
193194
- Higher loss rates often lead to 100% failure.
194195

195196
There is a much smaller possibility that issues are caused by bugs in either flight stack or QGC.
196-
To analyze this possibility you can turn on [Console Logging](../settings_view/console_logging.md) for Plan upload/download and review the protocol message traffic.
197-
198-
197+
To analyze this possibility you can turn on [Console Logging](../troubleshooting/console_logging.md) for Plan upload/download and review the protocol message traffic.

‎docs/en/qgc-user-guide/settings_view/console_logging.md‎

Lines changed: 0 additions & 56 deletions
This file was deleted.

‎docs/en/qgc-user-guide/settings_view/settings_view.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Use the **search bar** at the top of the settings sidebar to find any setting by
2828
**[Comm Links](comm_links.md)**
2929
<br>Manually create communication links and configure auto-connect options.
3030

31-
**[Logging](console_logging.md)**
31+
**[Logging](../troubleshooting/console_logging.md)**
3232
<br>Capture application logs for help with diagnosing problems.
3333

3434
**[Maps](maps.md)**

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

Lines changed: 1 addition & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -29,48 +29,4 @@ Dynamic action buttons (e.g., beep, identify, 3D mode) are shown based on the ve
2929

3030
## Troubleshooting a Missing Actuators Page
3131

32-
The Actuators page is shown when QGroundControl receives and initializes the
33-
vehicle's `COMP_METADATA_TYPE_ACTUATORS` component metadata. The firmware
34-
version alone does not determine whether the page is available. If the
35-
metadata is unavailable, cannot be initialized, or its top-level `show-ui-if`
36-
condition evaluates to false, QGroundControl uses the legacy Motors page
37-
instead.
38-
39-
### Capture Diagnostic Logs
40-
41-
1. Open **Application Settings > App Log Viewer**.
42-
2. Click **Categories** and enable these categories:
43-
- `Vehicle.Actuators.PX4AutoPilotPlugin`
44-
- `Vehicle.Actuators.Common`
45-
- `ComponentInformation.RequestMetaDataTypeStateMachine`
46-
- `Vehicle.FTPManager`
47-
3. Connect the vehicle. If it is already connected, disconnect and reconnect
48-
it so that QGroundControl requests the component metadata again.
49-
4. Open **Vehicle Setup** and check whether **Actuators** or **Motors** is
50-
available.
51-
5. Return to **App Log Viewer** and click **Save**. Keep the saved app log
52-
unchanged when attaching it to a support request.
53-
54-
The metadata URI can use MAVLink FTP (`mavlinkftp://`) or HTTP. QGroundControl
55-
tries the primary URI first and then the fallback URI advertised by the
56-
vehicle.
57-
58-
### Read the Diagnostic Messages
59-
60-
| Log category | Message or pattern | Meaning |
61-
| --- | --- | --- |
62-
| `Vehicle.Actuators.PX4AutoPilotPlugin` | `Vehicle did not provide actuators metadata via component information` | No actuator metadata was received from the vehicle. |
63-
| `Vehicle.Actuators.PX4AutoPilotPlugin` | `Actuators initialization failed` | Metadata was received but could not be parsed or initialized. |
64-
| `Vehicle.Actuators.PX4AutoPilotPlugin` | `Condition 'show-ui-if' evaluated to false` | The vehicle's metadata indicated the page should not be shown. This can be intentional for your configuration, or a firmware/metadata mismatch. Attach the saved log to a support request. |
65-
| `ComponentInformation.RequestMetaDataTypeStateMachine` | `primary failed, requesting metadata (fallback) from ...` | The primary metadata URI failed and QGroundControl is trying the fallback URI. |
66-
| `ComponentInformation.RequestMetaDataTypeStateMachine` | `FTP download failed` or `HTTP download failed` | The selected transport could not download the metadata. An HTTP status such as `404` identifies a missing or incorrect URL. |
67-
| `ComponentInformation.RequestMetaDataTypeStateMachine` | `failed to load metadata (primary and fallback)` | Both metadata URIs failed, so the Actuators page cannot be initialized. |
68-
| `Vehicle.FTPManager` | `Download fromCompId`, `Nak - ...`, or timeout messages | Details of the MAVLink FTP request and any vehicle-side error. |
69-
70-
### Include This Information in a Support Request
71-
72-
Include the QGroundControl version and build, PX4 firmware version, vehicle
73-
type, connection type, whether the legacy Motors page appears, and the saved
74-
app log. If the log contains a fallback or download error, include the full
75-
line with the URI and error text. Also mention whether reconnecting the vehicle
76-
changes the result.
32+
If the Actuators page does not appear (the legacy Motors page is shown instead), see [Missing Actuators Page](../../troubleshooting/actuators.md).

0 commit comments

Comments
 (0)