mavio 0.5.10

Minimalistic MAVLink client that supports `no-std` and `no-alloc` targets.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

//! # MAVLink protocol
//!
//! MAVLink protocol abstractions.
//!
//! We also re-export from [`mavspec::rust::spec`] crate to provide a full specification of
//! MAVLink-related types.
//!
//! ## Frames
//!
//! The key MAVLink entity is a [`Frame`], that represents a packet containing message body and
//! additional metadata as specified by MAVLink [serialization](https://mavlink.io/en/guide/serialization.html)
//! protocol. Each frame has a [`header`](Frame::header) and [`payload`](Frame::payload). Frames can
//! be decoded into messages using [`Frame::decode`]. To build a frame you need a [`FrameBuilder`]
//! that provides an interface for constructing valid frames both manually and from existing
//! messages.
//!
//! ## Message Signing
//!
//! `MAVLink 2` protocol is capable of signing frames allowing the receiver to authenticate frame's
//! sender. To sign a frame you can either use [`Frame<V2>::add_signature`] or
//! [`SigningConf::apply`]. The latter will sign only `MAVLink 2` frames keeping `MAVLink 1`
//! frames untouched.
//!
//! The signing algorithm is split into [`Sign`] and [`Signer`]. The former is a trait that provides
//! `sha256_48`, a `MAVLink 2` specific hashing algorithm. The latter takes an implementor of
//! [`Sign`] and feeds frame data into it. This library provides and implementor of [`Sign`], the
//! [`MavSha256`](crate::utils::MavSha256), for `std` targets. All `no_std` targets should implement
//! their own algorithm based on their platform-specific access to random value generators.

/// <sup>[`mavspec`](https://crates.io/crates/mavspec)</sup>
#[doc(inline)]
pub use mavspec::rust::spec::types::{CrcExtra, DialectId, DialectVersion, MessageId};
/// <sup>[`mavspec`](https://crates.io/crates/mavspec)</sup>
#[doc(inline)]
pub use mavspec::rust::spec::{
    Dialect, DialectSpec, IntoPayload, MavLinkVersion, Message, MessageInfo, MessageSpec, Payload,
};

mod compat;
mod endpoint;
pub(super) mod flags;
pub(super) mod frame;
pub(super) mod frame_builder;
pub(super) mod header;
pub(super) mod header_builder;
pub(super) mod marker;
mod mav_frame;
mod sequencer;
pub(super) mod signature;
pub(crate) mod stx;
pub(super) mod types;
#[cfg(feature = "unsafe")]
mod update;

pub use compat::{CompatProcessor, CompatProcessorBuilder, CompatStrategy, IntoCompatProcessor};
pub use endpoint::Endpoint;
pub use flags::{CompatFlags, IncompatFlags};
pub use frame::Frame;
pub use frame_builder::FrameBuilder;
pub use header::Header;
pub use header_builder::HeaderBuilder;
pub use marker::{MaybeVersioned, Unset, Versioned, Versionless, V1, V2};
pub use mav_frame::MavFrame;
pub use sequencer::{IntoSequencer, Sequencer};
pub use signature::{MavTimestamp, SecretKey, Sign, Signature, Signer, SigningConf};
pub use stx::MavSTX;
pub use types::{
    Behold, Checksum, ComponentId, HeaderV1Bytes, HeaderV2Bytes, MavLinkId, PayloadLength,
    Sequence, SignatureBytes, SignatureTimestampBytes, SignatureValue, SignedLinkId, SystemId,
};

#[cfg(feature = "unsafe")]
pub use update::{UpdateFrame, UpdateFrameUnsafe};