Struct Heartbeat 

pub struct Heartbeat {
    pub type_: MavType,
    pub autopilot: MavAutopilot,
    pub base_mode: MavModeFlag,
    pub custom_mode: u32,
    pub system_status: MavState,
    pub mavlink_version: u8,
}

MAVLink HEARTBEAT message.

The minimum supported MAVLink version is MAVLink 1.

Description

The heartbeat message shows that a system or component is present and responding. The type and autopilot fields (along with the message component id), allow the receiving system to treat further messages from this system appropriately (e.g. by laying out the user interface based on the autopilot). This microservice is documented at https://mavlink.io/en/services/heartbeat.html

Encoding/Decoding

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

Fields

type_: MavType

MAVLink field type.

Vehicle or component type. For a flight controller component the vehicle type (quadrotor, helicopter, etc.). For other components the component type (e.g. camera, gimbal, etc.). This should be used in preference to component id for identifying the component type.

autopilot: MavAutopilot

MAVLink field autopilot.

Autopilot type / class. Use MAV_AUTOPILOT_INVALID for components that are not flight controllers.

base_mode: MavModeFlag

MAVLink field base_mode.

System mode bitmap.

custom_mode: u32

MAVLink field custom_mode.

A bitfield for use for autopilot-specific flags

system_status: MavState

MAVLink field system_status.

System status flag.

mavlink_version: u8

MAVLink field mavlink_version.

MAVLink version, not writable by user, gets added by protocol because of magic data type: uint8_t_mavlink_version

Implementations

impl Heartbeat

pub const ID: u32 = 0u32

MavLink message ID.

pub const fn spec() -> MessageInfo

Returns specification for this message.

pub const fn message_id() -> u32

Message ID.

pub const fn crc_extra() -> u8

Message CRC_EXTRA.

pub const fn min_supported_mavlink_version() -> MavLinkVersion

Minimum supported MAVLink version for this message.

Trait Implementations

impl Clone for Heartbeat

fn clone(&self) -> Heartbeat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Heartbeat

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

Formats the value using the given formatter.

impl Default for Heartbeat

fn default() -> Heartbeat

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Heartbeat

fn deserialize<__D>( __deserializer: __D, ) -> Result<Heartbeat, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Heartbeat> for Minimal

fn from(value: Heartbeat) -> Minimal

Converts to this type from the input type.

impl IntoPayload for Heartbeat

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

Encodes message into MAVLink payload.

impl MessageSpec for Heartbeat

fn id(&self) -> u32

MAVLink message ID.

fn min_supported_mavlink_version(&self) -> MavLinkVersion

Minimum supported MAVLink protocol version.

fn crc_extra(&self) -> u8

Message EXTRA_CRC calculated from message XML definition.

impl MessageSpecStatic for Heartbeat

fn spec() -> MessageInfo

Returns specification for this message.

fn message_id() -> u32

Message ID.

fn crc_extra() -> u8

Message CRC_EXTRA.

fn min_supported_mavlink_version() -> MavLinkVersion

Minimum supported MAVLink version for this message.

impl NamedType for Heartbeat

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 Heartbeat

fn eq(&self, other: &Heartbeat) -> 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 Heartbeat

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Payload> for Heartbeat

type Error = SpecError

The type returned in the event of a conversion error.

fn try_from( value: &Payload, ) -> Result<Heartbeat, <Heartbeat as TryFrom<&Payload>>::Error>

Performs the conversion.

impl Type for Heartbeat

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 Heartbeat

impl Message for Heartbeat

impl StructuralPartialEq for Heartbeat