Skip to content

Conversation

julianoes
Copy link
Collaborator

This adds:

  • A guide how to use MavlinkDirect.
  • More MavlinkDirect examples.
  • A note regarding MavlinkPassthrough deprecation.

Copy link
Collaborator

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

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

FYI, front page en/index.md the "Build and test" isn't rendering. Note that you could also change this from "main" to include v3. I don't do this for PX4 because I use the precise text for some dynamic text config, but we don't in this docset

image

Comment on lines +27 to +30
* @warning MavlinkPassthrough will get deprecated in MAVSDK v4 and will only
* be available built from source.
* Use MavlinkDirect instead.
* MavlinkDirect provides enhanced functionality including:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why not deprecate now in v3? I have not tested this layout, but consider

Suggested change
* @warning MavlinkPassthrough will get deprecated in MAVSDK v4 and will only
* be available built from source.
* Use MavlinkDirect instead.
* MavlinkDirect provides enhanced functionality including:
* @warning MavlinkPassthrough is deprecated.
* In MAVSDK v4 it will only
* be available built from source.
* Use MavlinkDirect instead.
*
* MavlinkDirect provides enhanced functionality including:

Copy link
Collaborator Author

@julianoes julianoes Sep 17, 2025

Choose a reason for hiding this comment

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

I will mark it as deprecated in a few months but I'm allowing for some testing time with MavlinkDirect first. But your suggestion makes sense.

Copy link
Collaborator

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

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

The generated MAVLinkDirect class starts with "Enable direct MAVLink communication using libmav."

Libmav is probably only known to a few people, and this raises questions about dependencies.

I would modify that to talk about what this delivers - e.g. Runtime message parsing with JSON field representation
etc

Copy link
Collaborator

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

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

Also would be cool to show this with Python :-)

@julianoes
Copy link
Collaborator Author

@hamishwillee Also would be cool to show this with Python :-)

mavlink/MAVSDK-Python#801

@julianoes
Copy link
Collaborator Author

julianoes commented Sep 17, 2025

FYI, front page en/index.md the "Build and test" isn't rendering. Note that you could also change this from "main" to include v3. I don't do this for PX4 because I use the precise text for some dynamic text config, but we don't in this docset

Yeah, why is that not rendering properly? 😞

Edit: oh, it's essentially an old version of the readme and hasn't been properly updated. Do we really have to have a copy of the readme like this?

Edit 2: I removed the status badges. They are C++ specific anyway.

hamishwillee
hamishwillee previously approved these changes Sep 18, 2025
Copy link
Collaborator

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

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

I think this is good. Added a few last comments.

Co-authored-by: Hamish Willee <[email protected]>
@julianoes
Copy link
Collaborator Author

Thanks for the help @hamishwillee!

Copy link

Please retry analysis of this Pull-Request directly on SonarQube Cloud

@julianoes julianoes merged commit 5240ffa into main Sep 18, 2025
56 checks passed
@julianoes julianoes deleted the pr-mavlink-direct-docs branch September 18, 2025 08:49
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.

2 participants