-
-
Notifications
You must be signed in to change notification settings - Fork 577
Add MavlinkDirect docs and more examples #2655
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* @warning MavlinkPassthrough will get deprecated in MAVSDK v4 and will only | ||
* be available built from source. | ||
* Use MavlinkDirect instead. | ||
* MavlinkDirect provides enhanced functionality including: |
There was a problem hiding this comment.
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
* @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: |
There was a problem hiding this comment.
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.
There was a problem hiding this 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
There was a problem hiding this 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 :-)
|
Co-authored-by: Hamish Willee <[email protected]>
Co-authored-by: Hamish Willee <[email protected]>
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. |
There was a problem hiding this 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]>
Co-authored-by: Hamish Willee <[email protected]>
Thanks for the help @hamishwillee! |
Please retry analysis of this Pull-Request directly on SonarQube Cloud |
This adds: