mavlink/mavlink-devguide

Document Offboard Control protocol

hamishwillee opened this issue · 4 comments

Currently we use Protocols · MAVLink Developer Guide to group sub protocols (ie Mission, Command, etc). As part of documenting the protocol this also sensibly groups messages.

However we don't have any similar spot to group "interfaces" - logical sets of messages without any special protocol over/above the command protocol (say). For example Offboard (Control) messages.

Possible option is to make the Protocols section - Protocols & Interfaces.

Near empty doc on interface from old site:

Control Interface

In contrast to the parameter or waypoint interface these messages are not part of a formal protocol, but serve all the same purpose of providing controller set points to the autopilot. The most common application of this interface is an onboard companion computer.

The offboard interface has a statemachine as well, so in fact it’s the same. Let’s call all of them Micro services and work on documenting all state machines.

That is a good idea. I will move towards that.

Though I don't love "microservice" either. I tend to think of a service as the implementation of a protocol. So what we have here is a sub-protocol, as documented.