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

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

use crate::ember::node::Type;
use crate::ember::zll::{SecurityAlgorithmData, State};
use crate::ember::{Eui64, NodeId, zigbee};

/// The parameters of a ZLL network.
#[derive(Clone, Debug, Eq, PartialEq, FromLeStream, ToLeStream)]
pub struct Network {
    #[expect(clippy::struct_field_names)]
    zigbee_network: zigbee::Network,
    security_algorithm: SecurityAlgorithmData,
    eui64: Eui64,
    node_id: NodeId,
    state: u16,
    node_type: u8,
    number_sub_devices: u8,
    total_group_identifiers: u8,
    rssi_correction: u8,
}

impl Network {
    /// Create a new ZLL network.
    #[expect(clippy::too_many_arguments)]
    #[must_use]
    pub fn new(
        zigbee_network: zigbee::Network,
        security_algorithm: SecurityAlgorithmData,
        eui64: Eui64,
        node_id: NodeId,
        state: State,
        node_type: Type,
        number_sub_devices: u8,
        total_group_identifiers: u8,
        rssi_correction: u8,
    ) -> Self {
        Self {
            zigbee_network,
            security_algorithm,
            eui64,
            node_id,
            state: state.into(),
            node_type: node_type.into(),
            number_sub_devices,
            total_group_identifiers,
            rssi_correction,
        }
    }

    /// Return the parameters of a Zigbee network.
    #[must_use]
    pub const fn zigbee_network(&self) -> &zigbee::Network {
        &self.zigbee_network
    }

    /// Return the data associated with the ZLL security algorithm.
    #[must_use]
    pub const fn security_algorithm(&self) -> &SecurityAlgorithmData {
        &self.security_algorithm
    }

    /// Return the associated EUI64.
    #[must_use]
    pub const fn eui64(&self) -> Eui64 {
        self.eui64
    }

    /// Return the node id.
    #[must_use]
    pub const fn node_id(&self) -> NodeId {
        self.node_id
    }

    /// Return the ZLL state.
    ///
    /// # Errors
    /// Returns the [`u16`] value of the state if it has an invalid value.
    pub fn state(&self) -> Result<State, u16> {
        State::try_from(self.state)
    }

    /// Return the node type.
    ///
    /// # Errors
    /// Returns the [`u8`] value of the type if it has an invalid value.
    pub fn node_type(&self) -> Result<Type, u8> {
        Type::from_u8(self.node_type).ok_or(self.node_type)
    }

    /// Return the number of sub devices.
    #[must_use]
    pub const fn number_sub_devices(&self) -> u8 {
        self.number_sub_devices
    }

    /// Return the total number of group identifiers.
    #[must_use]
    pub const fn total_group_identifiers(&self) -> u8 {
        self.total_group_identifiers
    }

    /// Return the RSSI correction value.
    #[must_use]
    pub const fn rssi_correction(&self) -> u8 {
        self.rssi_correction
    }
}