ezsp 7.3.1

Ember ZNet Serial Protocol
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

use core::fmt::{self, Display};

use bitflags::bitflags;
use le_stream::{FromLeStream, ToLeStream};

pub use self::callback_type::CallbackType;

mod callback_type;

/// Low byte control field of the frame header when it represents a response.
#[derive(Clone, Copy, Debug, Default, Eq, Hash, PartialEq, FromLeStream, ToLeStream)]
pub struct Response(u8);

bitflags! {
    impl Response: u8 {
        /// Response flag. Should not be set.
        const IS_RESPONSE = 0b1000_0000;
        /// Network index bit no. 1.
        const NETWORK_INDEX_1 = 0b0100_0000;
        /// Network index bit no. 2.
        const NETWORK_INDEX_0 = 0b0010_0000;
        /// Callback type bit no. 1.
        const CALLBACK_TYPE_1 = 0b0001_0000;
        /// Callback type bit no. 2.
        const CALLBACK_TYPE_0 = 0b0000_1000;
        /// Callback pending flag.
        const CALLBACK_PENDING = 0b0000_0100;
        /// Truncated flag.
        const TRUNCATED = 0b0000_0010;
        /// Overflow flag.
        const OVERFLOW = 0b0000_0001;
    }
}

impl Response {
    /// Returns `true` if the response is a response else `false`.
    #[must_use]
    pub const fn is_response(self) -> bool {
        self.contains(Self::IS_RESPONSE)
    }

    /// Returns the network index.
    #[must_use]
    pub fn network_index(self) -> u8 {
        (self.bits() & (Self::NETWORK_INDEX_1 | Self::NETWORK_INDEX_0).bits()) >> 5
    }

    /// Returns the callback type.
    ///
    /// Returns `None` if this is not a callback.
    #[must_use]
    pub const fn callback_type(self) -> Option<CallbackType> {
        match (
            self.contains(Self::CALLBACK_TYPE_1),
            self.contains(Self::CALLBACK_TYPE_0),
        ) {
            (true, true) => Some(CallbackType::Reserved),
            (true, false) => Some(CallbackType::Async),
            (false, true) => Some(CallbackType::Sync),
            (false, false) => None,
        }
    }

    /// Returns `true` if a callback is pending on the NCP.
    ///
    /// If this response is a callback, at least one more callback is available.
    #[must_use]
    pub const fn is_callback_pending(self) -> bool {
        self.contains(Self::CALLBACK_PENDING)
    }

    /// Returns `true` if the response is truncated else `false`.
    #[must_use]
    pub const fn is_truncated(self) -> bool {
        self.contains(Self::TRUNCATED)
    }

    /// Returns `true` if the response has overflowed else `false`.
    ///
    /// This is used to indicate that the NCP truncated the current response
    /// to avoid exceeding the maximum EZSP frame length.
    #[must_use]
    pub const fn has_overflowed(self) -> bool {
        self.contains(Self::OVERFLOW)
    }
}

impl Display for Response {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "Response {{ is_response: {}, network_index: {}, callback_type: {}, is_callback_pending: {}, is_truncated: {}, has_overflowed: {} }}",
            self.is_response(),
            self.network_index(),
            self.callback_type()
                .map_or("Not a callback", CallbackType::as_str),
            self.is_callback_pending(),
            self.is_truncated(),
            self.has_overflowed()
        )
    }
}