Add documentation for UAVCAN device tracking #26152
Conversation
Claudio-Chies
force-pushed
the
pr-docs_device_tracking
branch
from
538d219 to
be01d67
Compare
There was a problem hiding this comment.
Pull request overview
This PR introduces comprehensive documentation for PX4's device tracking feature, which automatically collects and logs metadata from DroneCAN-connected hardware devices. The documentation explains how to view device information in real-time and access it from flight logs.
Key changes:
- New dedicated documentation page explaining device tracking capabilities and use cases
- Cross-references added to CAN and DroneCAN documentation linking to the new device tracking page
- Navigation entry added to SUMMARY.md for discoverability
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 9 comments.
| File | Description |
|---|---|
| docs/en/advanced_config/device_tracking.md | New comprehensive documentation covering device tracking overview, use cases, real-time monitoring, and flight log analysis |
| docs/en/can/index.md | Added paragraph introducing device tracking capabilities for CAN devices with link to detailed documentation |
| docs/en/dronecan/index.md | Added bullet point to benefits list highlighting automatic device tracking with cross-reference |
| docs/en/SUMMARY.md | Added navigation entry for the new device tracking documentation page |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| For this reason it is very robust even over longer cable lengths (on large vehicles), and avoids a single point of failure. | ||
| CAN also allows status feedback from peripherals and convenient firmware upgrades over the bus. | ||
|
|
||
| PX4 has the ability to track and log detailed information from CAN devices, including firmware versions, hardware versions, and serial numbers. |
There was a problem hiding this comment.
Double space detected between "to" and "track". Should be a single space for proper formatting.
| PX4 has the ability to track and log detailed information from CAN devices, including firmware versions, hardware versions, and serial numbers. | |
| PX4 has the ability to track and log detailed information from CAN devices, including firmware versions, hardware versions, and serial numbers. |
| Device information is automatically logged to flight logs. | ||
| You can extract it using [pyulog](https://github.com/PX4/pyulog), though note that fields like vendor name, model name, and serial number are stored as char arrays and require additional parsing. |
There was a problem hiding this comment.
According to the project guidelines, lines should end at sentence boundaries (Semantic Line Breaks). This line contains two sentences. Split after "to flight logs." so each sentence is on its own line.
|
|
||
| ### Real-Time Monitoring | ||
|
|
||
| You can view device information in real-time using the [MAVLink Shell](../debug/mavlink_shell.md) or console: |
There was a problem hiding this comment.
According to the project guidelines, tool names should be italicized (emphasis). "MAVLink Shell" is a tool and should be styled as MAVLink Shell.
There was a problem hiding this comment.
Not correct. I will fix our instructions. Ignore.
| ## Flight Log Analysis | ||
|
|
||
| Device information is automatically logged to flight logs. | ||
| You can extract it using [pyulog](https://github.com/PX4/pyulog), though note that fields like vendor name, model name, and serial number are stored as char arrays and require additional parsing. |
There was a problem hiding this comment.
According to the project guidelines, tool names should be italicized (emphasis). "pyulog" is a tool and should be styled as pyulog.
| @@ -0,0 +1,68 @@ | |||
| # Device Tracking | |||
|
|
|||
| PX4 can track and log detailed information about external hardware devices connected to the flight controller. | |||
There was a problem hiding this comment.
- Why is this in advanced configuration? I mean it doesn't look like you have to do any configuration. How about under logging? - https://docs.px4.io/main/en/debug/
| @@ -0,0 +1,68 @@ | |||
| # Device Tracking | |||
There was a problem hiding this comment.
Device Tracking sounds like it could equally well be a "Find my drone" service. Can we find a better name?
I was thinking about something like "Asset Tracking & Logging"? We want it to be something instantly recognisable. Very open to suggestions.
hamishwillee
force-pushed
the
pr-docs_device_tracking
branch
from
be01d67 to
4b783e7
Compare
|
No flaws found |
| @@ -0,0 +1,67 @@ | |||
| # Device Tracking | |||
|
|
|||
| <Badge type="tip" text="main (planned for: PX4 v1.18)" /> | |||
There was a problem hiding this comment.
- What version of PX4 will this first appear in? I have put v1.18 but needs to be correct.
- Can you add a release note. I would expect this to go in https://docs.px4.io/main/en/releases/main if this is in 1.18 and we'd create a new document if it is going into 1.17.
Solved Problem
Fixes #N/A
Solution
Introduce documentation for the device tracking feature in PX4, detailing how it collects and logs metadata from external hardware devices connected via DroneCAN.
Alternatives
N/A
Test coverage
N/A
Context
Related links: Device Tracking Documentation