package mavsdk.rpc.component_metadata

Get desktop application:
View/edit binary Protocol Buffers messages

Access component metadata json definitions, such as parameters.

• rpc GetMetadata (GetMetadataRequest, GetMetadataResponse)

  component_metadata.proto:34

  Access metadata. This can be used if you know the metadata is available already, otherwise use the subscription to get notified when it becomes available.

  message GetMetadataRequest

  component_metadata.proto:43

  • uint32 compid = 1

    The component ID to request

  • MetadataType metadata_type = 2

    The metadata type

  message GetMetadataResponse

  component_metadata.proto:48

  • optional ComponentMetadataResult component_metadata_result = 1

  • optional MetadataData response = 2

    The response

• rpc RequestAutopilotComponent (RequestAutopilotComponentRequest, RequestAutopilotComponentResponse)

  component_metadata.proto:23

  Request metadata from the autopilot component. This is used to start requesting metadata from the autopilot. The metadata can later be accessed via subscription (see below) or GetMetadata.

  message RequestAutopilotComponentRequest

  component_metadata.proto:77

  (message has no fields)

  message RequestAutopilotComponentResponse

  component_metadata.proto:78

  (message has no fields)

• rpc RequestComponent (RequestComponentRequest, RequestComponentResponse)

  component_metadata.proto:17

  Request metadata from a specific component. This is used to start requesting metadata from a component. The metadata can later be accessed via subscription (see below) or GetMetadata.

  message RequestComponentRequest

  component_metadata.proto:37

  • uint32 compid = 1

    The component ID to request

  message RequestComponentResponse

  component_metadata.proto:41

  (message has no fields)

• rpc SubscribeMetadataAvailable (SubscribeMetadataAvailableRequest, stream MetadataAvailableResponse)

  component_metadata.proto:28

  Register a callback that gets called when metadata is available

  message SubscribeMetadataAvailableRequest

  component_metadata.proto:80

  (message has no fields)

  message MetadataAvailableResponse

  component_metadata.proto:83

  An update about available metadata

  • optional MetadataUpdate data = 1

    The metadata data

Result type.

Used in: GetMetadataResponse

• ComponentMetadataResult.Result result = 1

  Result enum value

• string result_str = 2

  Human-readable English string describing the result

Possible results returned

Used in: ComponentMetadataResult

• RESULT_SUCCESS = 0

  Success

• RESULT_NOT_AVAILABLE = 1

  Not available

• RESULT_CONNECTION_ERROR = 2

  Connection error

• RESULT_UNSUPPORTED = 3

  Unsupported

• RESULT_DENIED = 4

  Denied

• RESULT_FAILED = 5

  Failed

• RESULT_TIMEOUT = 6

  Timeout

• RESULT_NO_SYSTEM = 7

  No system

• RESULT_NOT_REQUESTED = 8

  Not requested

Metadata response

Used in: GetMetadataResponse

• string json_metadata = 1

  The JSON metadata

The metadata type

Used in: GetMetadataRequest, MetadataUpdate

• METADATA_TYPE_ALL_COMPLETED = 0

  This is set in the subscription callback when all metadata types completed for a given component ID

• METADATA_TYPE_PARAMETER = 1

  Parameter metadata

• METADATA_TYPE_EVENTS = 2

  Event definitions

• METADATA_TYPE_ACTUATORS = 3

  Actuator definitions

Metadata for a given component and type

Used in: MetadataAvailableResponse

• uint32 compid = 1

  The component ID

• MetadataType type = 2

  The metadata type

• string json_metadata = 3

  The JSON metadata