ezsp 14.0.0

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
103
104
105
106
107
108

//! Complete incoming APS messages with unrestricted payloads.

use crate::ember::NodeId;
use crate::ember::aps::Frame as ApsFrame;
use crate::ember::message::Incoming;
use crate::parameters::messaging::handler::IncomingMessage;

/// A complete incoming APS message with an owned, unrestricted payload.
#[derive(Debug)]
pub struct DefragmentedMessage {
    typ: u8,
    aps_frame: ApsFrame,
    last_hop_lqi: u8,
    last_hop_rssi: i8,
    sender: NodeId,
    binding_index: u8,
    address_index: u8,
    payload: Box<[u8]>,
    source_route_overhead: Option<u8>,
}

impl DefragmentedMessage {
    /// Returns the incoming message type.
    ///
    /// # Errors
    ///
    /// Returns the raw message type if it is not a recognized [`Incoming`] value.
    pub fn typ(&self) -> Result<Incoming, u8> {
        Incoming::try_from(self.typ).map_err(|_| self.typ)
    }
    /// Returns the complete APS payload.
    #[must_use]
    pub const fn message(&self) -> &[u8] {
        &self.payload
    }
    /// Consumes the message and returns its complete APS payload.
    #[must_use]
    pub fn into_message(self) -> Box<[u8]> {
        self.payload
    }
    /// Returns the APS frame.
    #[must_use]
    pub const fn aps_frame(&self) -> &ApsFrame {
        &self.aps_frame
    }
    /// Returns the last-hop LQI.
    #[must_use]
    pub const fn last_hop_lqi(&self) -> u8 {
        self.last_hop_lqi
    }
    /// Returns the last-hop RSSI.
    #[must_use]
    pub const fn last_hop_rssi(&self) -> i8 {
        self.last_hop_rssi
    }
    /// Returns the sender.
    #[must_use]
    pub const fn sender(&self) -> NodeId {
        self.sender
    }
    /// Returns the binding index.
    #[must_use]
    pub const fn binding_index(&self) -> u8 {
        self.binding_index
    }
    /// Returns the address index.
    #[must_use]
    pub const fn address_index(&self) -> u8 {
        self.address_index
    }
    /// Returns the source-route overhead.
    #[must_use]
    pub const fn source_route_overhead(&self) -> Option<u8> {
        self.source_route_overhead
    }
    /// Returns the raw message type.
    #[must_use]
    pub const fn typ_value(&self) -> u8 {
        self.typ
    }

    pub(super) fn from_incoming_message(
        incoming_message: &IncomingMessage,
        payload: Box<[u8]>,
    ) -> Self {
        let mut aps_frame = incoming_message.aps_frame().clone();
        aps_frame.clear_fragmentation();

        Self {
            typ: incoming_message.typ_value(),
            aps_frame,
            last_hop_lqi: incoming_message.last_hop_lqi(),
            last_hop_rssi: incoming_message.last_hop_rssi(),
            sender: incoming_message.sender(),
            binding_index: incoming_message.binding_index(),
            address_index: incoming_message.address_index(),
            payload,
            source_route_overhead: incoming_message.source_route_overhead(),
        }
    }
}

impl From<IncomingMessage> for DefragmentedMessage {
    fn from(incoming_message: IncomingMessage) -> Self {
        let payload = incoming_message.message().into();
        Self::from_incoming_message(&incoming_message, payload)
    }
}