Crate mavlink_core

The MAVLink message set.

Message sets and the Message trait

Each message set has its own module with corresponding data types, including a MavMessage enum that represents all possible messages in that message set. The Message trait is used to represent messages in an abstract way, and each MavMessage enum implements this trait (for example, [ardupilotmega::MavMessage]). This is then monomorphized to the specific message set you are using in your application at compile-time via type parameters. If you expect ArduPilotMega-flavored messages, then you will need a MavConnection<ardupilotmega::MavMessage> and you will receive ardupilotmega::MavMessages from it.

Some message sets include others. For example, all message sets except common include the common message set. This is represented with extra values in the MavMessage enum: a message in the common message set received on an ArduPilotMega connection will be an ardupilotmega::MavMessage::common(common::MavMessage).

Please note that if you want to enable a given message set, you must also enable the feature for the message sets that it includes. For example, you cannot use the ardupilotmega feature without also using the uavionix and icarous features.

Modules

• async_peek_readertokio-1
  This module implements a buffered/peekable reader using async I/O.
• bytes
• bytes_mut
• error
• peek_reader
  This module implements a buffered/peekable reader.
• utils

Structs

• FileConnectablestd or tokio-1
• MAVLinkV1MessageRaw
• MAVLinkV2MessageRaw
• MavFrame
  Encapsulation of the Mavlink message and the header, important to preserve information about the sender system and component id.
• MavHeader
  Metadata from a MAVLink packet header
• SerialConnectablestd or tokio-1
• SigningConfigsigning
  Configuration used for MAVLink 2 messages signing as defined in https://mavlink.io/en/guide/message_signing.html.
• SigningDatasigning
  MAVLink 2 message signing data.
• TcpConnectablestd or tokio-1
• UdpConnectablestd or tokio-1

Enums

• ConnectionAddressstd or tokio-1
• MavlinkVersion
  Versions of the Mavlink protocol that we support

Constants

• MAV_STX
  Message framing marker for mavlink v1
• MAV_STX_V2
  Message framing marker for mavlink v2
• MAX_FRAME_SIZE

Traits

• AsyncConnectabletokio-1
• AsyncMavConnectiontokio-1
  An async MAVLink connection
• Connectablestd
• MavConnectionstd
  A MAVLink connection
• Message
• MessageData

Functions

• calculate_crc
• connectstd
  Connect to a MAVLink node by address string.
• connect_asynctokio-1
  Connect asynchronously to a MAVLink node by address string.
• read_v1_msg
  Read a MAVLink v1 message from a Read stream.
• read_v1_msg_asynctokio-1
  Read a MAVLink v1 message from a Read stream.
• read_v1_raw_message
  Return a raw buffer with the mavlink message V1 maximum size is 263 bytes: <https://mavlink.io/en/guide/serialization.html>
• read_v1_raw_message_asynctokio-1
  Return a raw buffer with the mavlink message V1 maximum size is 263 bytes: <https://mavlink.io/en/guide/serialization.html>
• read_v2_msg
  Read a MAVLink v2 message from a Read stream.
• read_v2_msg_asynctokio-1
  Async read a MAVLink v2 message from a Read stream.
• read_v2_msg_async_signedtokio-1 and signing
  Async read a MAVLink v2 message from a Read stream.
• read_v2_msg_signedsigning
  Read a MAVLink v2 message from a Read stream.
• read_v2_raw_message
  Return a raw buffer with the mavlink message
• read_v2_raw_message_asynctokio-1
  Async read a raw buffer with the mavlink message V2 maximum size is 280 bytes: <https://mavlink.io/en/guide/serialization.html>
• read_v2_raw_message_async_signedtokio-1 and signing
  Async read a raw buffer with the mavlink message with signing support V2 maximum size is 280 bytes: <https://mavlink.io/en/guide/serialization.html>
• read_v2_raw_message_signedsigning
  Return a raw buffer with the mavlink message with signing support
• read_versioned_msg
• read_versioned_msg_asynctokio-1
• read_versioned_msg_async_signedtokio-1 and signing
• read_versioned_msg_signedsigning
• write_v1_msg
  Write a MAVLink v1 message to a Write stream.
• write_v1_msg_asynctokio-1
  Async write a MAVLink v1 message to a Write stream.
• write_v2_msg
  Write a MAVLink v2 message to a Write stream.
• write_v2_msg_asynctokio-1
  Async write a MAVLink v2 message to a Write stream.
• write_v2_msg_async_signedsigning and tokio-1
  Write a MAVLink v2 message to a Write stream with signing support.
• write_v2_msg_signedsigning
  Write a MAVLink v2 message to a Write stream with signing support.
• write_versioned_msg
  Write a message using the given mavlink version
• write_versioned_msg_asynctokio-1
  Async write a message using the given mavlink version
• write_versioned_msg_async_signedtokio-1 and signing
  Async write a message with signing support using the given mavlink version
• write_versioned_msg_signedsigning
  Write a message with signing support using the given mavlink version