Struct ComponentMetadata

pub struct ComponentMetadata {
    pub time_boot_ms: u32,
    pub file_crc: u32,
    pub uri: [u8; 100],
}

MAVLink COMPONENT_METADATA message.

Minimum supported MAVLink version is MAVLink 2.

Description

Component metadata message, which may be requested using MAV_CMD_REQUEST_MESSAGE.

This contains the MAVLink FTP URI and CRC for the component’s general metadata file. The file must be hosted on the component, and may be xz compressed. The file CRC can be used for file caching.

The general metadata file can be read to get the locations of other metadata files (COMP_METADATA_TYPE) and translations, which may be hosted either on the vehicle or the internet. For more information see: https://mavlink.io/en/services/component_information.html.

Note: Camera components should use CAMERA_INFORMATION instead, and autopilots may use both this message and AUTOPILOT_VERSION.

Encoding/Decoding

Message encoding/decoding are provided by implementing core::convert::TryFrom<Payload> for ComponentMetadata (encoding) and [IntoPayload] (decoding) traits. These traits are implemented by Message proc macro.

Fields

time_boot_ms: u32

MAVLink field time_boot_ms.

Timestamp (time since system boot).

file_crc: u32

MAVLink field file_crc.

CRC32 of the general metadata file.

uri: [u8; 100]

MAVLink field uri.

MAVLink FTP URI for the general metadata file (COMP_METADATA_TYPE_GENERAL), which may be compressed with xz. The file contains general component metadata, and may contain URI links for additional metadata (see COMP_METADATA_TYPE). The information is static from boot, and may be generated at compile time. The string needs to be zero terminated.

Implementations

impl ComponentMetadata

pub const ID: MessageId = 397u32

MavLink message ID.

pub const fn spec() -> MessageInfo

Returns specification for this message.

pub const fn message_id() -> MessageId

Message ID.

pub const fn crc_extra() -> CrcExtra

Message CRC_EXTRA.

pub const fn min_supported_mavlink_version() -> MavLinkVersion

Minimum supported MAVLink version for this message.

Trait Implementations

impl Clone for ComponentMetadata

fn clone(&self) -> ComponentMetadata

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ComponentMetadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ComponentMetadata

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ComponentMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ComponentMetadata> for Common

fn from(value: ComponentMetadata) -> Self

Converts to this type from the input type.

impl IntoPayload for ComponentMetadata

fn encode(&self, version: MavLinkVersion) -> Result<Payload, SpecError>

Encodes message into MAVLink payload.

impl MessageSpec for ComponentMetadata

fn id(&self) -> MessageId

MAVLink message ID.

fn min_supported_mavlink_version(&self) -> MavLinkVersion

Minimum supported MAVLink protocol version.

fn crc_extra(&self) -> CrcExtra

Message EXTRA_CRC calculated from message XML definition.

impl MessageSpecStatic for ComponentMetadata

fn spec() -> MessageInfo

Returns specification for this message.

fn message_id() -> MessageId

Message ID.

fn crc_extra() -> CrcExtra

Message CRC_EXTRA.

fn min_supported_mavlink_version() -> MavLinkVersion

Minimum supported MAVLink version for this message.

impl NamedType for ComponentMetadata

fn sid() -> SpectaID

fn named_data_type( type_map: &mut TypeCollection, generics: &[DataType], ) -> NamedDataType

this is equivalent to Type::inline but returns a NamedDataType instead.

fn definition_named_data_type(type_map: &mut TypeCollection) -> NamedDataType

this is equivalent to [Type::definition] but returns a NamedDataType instead.

impl PartialEq for ComponentMetadata

fn eq(&self, other: &ComponentMetadata) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ComponentMetadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Payload> for ComponentMetadata

type Error = SpecError

The type returned in the event of a conversion error.

fn try_from(value: &Payload) -> Result<Self, Self::Error>

Performs the conversion.

impl Type for ComponentMetadata

fn inline(type_map: &mut TypeCollection, generics: Generics<'_>) -> DataType

Returns the definition of a type using the provided generics.

fn reference(type_map: &mut TypeCollection, generics: &[DataType]) -> Reference

Generates a datatype corresponding to a reference to this type, as determined by its category. Getting a reference to a type implies that it should belong in the type map (since it has to be referenced from somewhere), so the output of definition will be put into the type map.

impl Flatten for ComponentMetadata

impl Message for ComponentMetadata

impl StructuralPartialEq for ComponentMetadata