ezsp 6.0.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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

use le_stream::{FromLeStream, ToLeStream};
use num_traits::FromPrimitive;

use crate::Error;
use crate::ember::Status;
use crate::ember::gp::{Address, KeyType, SecurityLevel};
use crate::types::ByteSizedVec;

crate::frame::parameters::handler!(
    0x00C5,
    { status: u8, payload: Payload },
    impl {
        impl TryFrom<Handler> for Payload {
            type Error = Error;

            fn try_from(handler: Handler) -> Result<Self, Self::Error> {
                match Status::from_u8(handler.status).ok_or(handler.status) {
                    Ok(Status::Success) => Ok(handler.payload),
                    other => Err(other.into()),
                }
            }
        }
    }
);

/// The payload of the GPDF receive.
#[derive(Clone, Debug, Eq, PartialEq, FromLeStream, ToLeStream)]
pub struct Payload {
    gpd_link: u8,
    sequence_number: u8,
    addr: Address,
    gpdf_security_level: SecurityLevel,
    gpdf_security_key_type: KeyType,
    auto_commissioning: bool,
    bidirectional_info: u8,
    gpd_security_frame_counter: u32,
    gpd_command_id: u8,
    mic: u32,
    proxy_table_index: u8,
    #[expect(clippy::struct_field_names)]
    gpd_command_payload: ByteSizedVec<u8>,
}

impl Payload {
    /// The gpdLink value of the received GPDF.
    #[must_use]
    pub const fn gpd_link(&self) -> u8 {
        self.gpd_link
    }

    /// The GPDF sequence number.
    #[must_use]
    pub const fn sequence_number(&self) -> u8 {
        self.sequence_number
    }

    /// The address of the source GPD.
    #[must_use]
    pub const fn addr(&self) -> &Address {
        &self.addr
    }

    /// The security level of the received GPDF.
    #[must_use]
    pub const fn gpdf_security_level(&self) -> SecurityLevel {
        self.gpdf_security_level
    }

    /// The securityKeyType used to decrypt/authenticate the incoming GPDF.
    #[must_use]
    pub const fn gpdf_security_key_type(&self) -> KeyType {
        self.gpdf_security_key_type
    }

    /// Whether the incoming GPDF had the auto-commissioning bit set.
    #[must_use]
    pub const fn auto_commissioning(&self) -> bool {
        self.auto_commissioning
    }

    /// Bidirectional information represented in bitfields, where bit0 holds the rxAfterTx of
    /// incoming gpdf and bit1 holds if tx queue is available for outgoing gpdf.
    #[must_use]
    pub const fn bidirectional_info(&self) -> u8 {
        self.bidirectional_info
    }

    /// The security frame counter of the incoming GDPF.
    #[must_use]
    pub const fn gpd_security_frame_counter(&self) -> u32 {
        self.gpd_security_frame_counter
    }

    /// The gpdCommandId of the incoming GPDF.
    #[must_use]
    pub const fn gpd_command_id(&self) -> u8 {
        self.gpd_command_id
    }

    /// The received MIC of the GPDF.
    #[must_use]
    pub const fn mic(&self) -> u32 {
        self.mic
    }

    /// The proxy table index of the corresponding proxy table entry to the incoming GPDF.
    #[must_use]
    pub const fn proxy_table_index(&self) -> u8 {
        self.proxy_table_index
    }

    /// The GPD command payload.
    #[must_use]
    pub fn gpd_command_payload(&self) -> &[u8] {
        self.gpd_command_payload.as_ref()
    }
}