mavlink / MAVSDK-docs

MAVSDK Guide Docs - Source Code
https://mavsdk.mavlink.io
Other
24 stars 37 forks source link

Add autopilot server example #247

Closed bazfp closed 3 years ago

bazfp commented 3 years ago

Added the autopilot server example page

Changed the server plugins to be a bit more useful for vehicle manufacturers

hamishwillee commented 3 years ago

Overall looks great. I did simply the introduction a bit in both docs - please check you're OK with it.

Before we can merge yYou need to add these new docs to /en/SUMMARY.md (just follow the existing pattern). That is needed or the files won't build.

In terms of suggestions, there are two things I would love to see.

The first is guide material. Right now you HAVE to go to the source code of the example to work out how callbacks work. This is an example of what I mean: https://mavsdk.mavlink.io/main/en/cpp/guide/telemetry.html Now I know our other examples don't do this - but that's because when I was involved in docs more closely I wrote guide, and when I did an example page I linked to that guide. So it would be good if that basic set of concepts for how you hook into the underlying system was pulled out into docs.

The second is related to the presentation of this example. Right now it is hard to differentiate the server and client sides of the comms. Is there any way to better highlight them so you can easily see the commands and responses. Just a thought.

bazfp commented 3 years ago

Good feedback, thank you.

I agree with you. It is difficult to differentiate the MAVSDK instances in the example at current. This is mostly because the example stems from my local hackpad during devtime.

It would be useful for debugging that MAVSDK instances themselves could be tagged or print some unique ID in the debug messages. For now I am happy to leave the example as is and revise it later.

hamishwillee commented 3 years ago

Cool. Even having an example is a huge contribution. Personally I find these things much more accessible with a little guide material too.