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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

//! # MAVLink packet start marker
//!
//! [`MavSTX`] represents a protocol-specific start-of-text (STX) marker used to indicate the
//! beginning of a new packet.
//!
//! Any system that does not understand protocol version will skip the packet.
//!
//! See:
//! * [MAVLink 1 Packet Format](https://mavlink.io/en/guide/serialization.html#v1_packet_format).
//! * [MAVLink 2 Packet Format](https://mavlink.io/en/guide/serialization.html#mavlink2_packet_format).

use crate::consts::{STX_V1, STX_V2};
use crate::protocol::MavLinkVersion;

/// Packet start marker.
///
/// Protocol-specific start-of-text (STX) marker used to indicate the beginning of a new packet.
///
/// Any system that does not understand protocol version will skip the packet.
///
/// See:
/// * [MAVLink 1 Packet Format](https://mavlink.io/en/guide/serialization.html#v1_packet_format).
/// * [MAVLink 2 Packet Format](https://mavlink.io/en/guide/serialization.html#mavlink2_packet_format).
#[derive(Clone, Copy, Debug)]
#[cfg_attr(feature = "specta", derive(specta::Type))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum MavSTX {
    /// Designates `MAVLink 1` protocol, equals to [`STX_V1`].
    V1,
    /// Designates `MAVLink 2` protocol, equals to [`STX_V2`].
    V2,
    /// Unknown protocol.
    Unknown(u8),
}

impl Default for MavSTX {
    /// Creates [`MavSTX`] with default value.
    ///
    /// We assume unknown protocol with zero marker.
    #[inline]
    fn default() -> Self {
        Self::Unknown(0)
    }
}

impl From<MavSTX> for u8 {
    /// Converts from `u8` into [`MavSTX`].
    #[inline]
    fn from(value: MavSTX) -> Self {
        match value {
            MavSTX::V1 => STX_V1,
            MavSTX::V2 => STX_V2,
            MavSTX::Unknown(unknown) => unknown,
        }
    }
}

impl From<u8> for MavSTX {
    /// Converts from `u8` into [`MavSTX`].
    #[inline]
    fn from(value: u8) -> Self {
        match value {
            STX_V1 => MavSTX::V1,
            STX_V2 => MavSTX::V2,
            unknown => MavSTX::Unknown(unknown),
        }
    }
}

impl From<MavLinkVersion> for MavSTX {
    /// Creates [`MavSTX`] from [`MavLinkVersion`].
    #[inline]
    fn from(value: MavLinkVersion) -> Self {
        match value {
            MavLinkVersion::V1 => MavSTX::V1,
            MavLinkVersion::V2 => MavSTX::V2,
        }
    }
}

impl From<MavSTX> for Option<MavLinkVersion> {
    /// Converts [`MavSTX`] into [`Option<MavLinkVersion>`].
    #[inline]
    fn from(value: MavSTX) -> Self {
        value.to_mavlink_version()
    }
}

impl MavSTX {
    /// Checks that `value` represents MAVLink magic (start-of-text) byte.
    #[inline]
    pub fn is_magic_byte(value: u8) -> bool {
        value == STX_V1 || value == STX_V2
    }

    /// Attempt to convert [`MavSTX`] into [`MavLinkVersion`]. Otherwise, returns [`None`].
    #[inline]
    pub fn to_mavlink_version(&self) -> Option<MavLinkVersion> {
        Some(match self {
            MavSTX::V1 => MavLinkVersion::V1,
            MavSTX::V2 => MavLinkVersion::V2,
            MavSTX::Unknown(_) => return None,
        })
    }
}