ezsp 13.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

use macaddr::MacAddr8;
use silizium::zigbee::security::man::Key;

use crate::ember::join::Method;
use crate::ember::network::Parameters;
use crate::ember::security::initial::{Bitmask, State};
use crate::ncp::network_credentials::NetworkCredentials;

const DEFAULT_NWK_MANAGER_ID: u16 = 0x0000;
const DEFAULT_NWK_UPDATE_ID: u8 = 0x00;
const CHANNEL_BIT: u32 = 1;
const NETWORK_KEY_SEQUENCE_NUMBER: u8 = 0;

/// Parameters used to leave any current network and form a new Zigbee network.
///
/// Wrap this value in [`Startup::Initialize`](crate::Startup::Initialize) and
/// pass it to a [`Builder`](crate::Builder) constructor to select explicit
/// network formation. Use [`Startup::Resume`](crate::Startup::Resume) instead
/// when the NCP should restore its persisted network state.
///
/// Network identity and network-key material are grouped in
/// [`NetworkCredentials`](NetworkCredentials). The remaining values are
/// specific to forming the network: the preconfigured link key, radio channel,
/// and join method.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct InitializationParameters {
    network_credentials: NetworkCredentials,
    link_key: Key,
    radio_channel: u8,
    join_method: Method,
    bitmask: Bitmask,
    nwk_manager_id: u16,
    nwk_update_id: u8,
}

impl InitializationParameters {
    /// Creates explicit network formation parameters.
    ///
    /// The credential network key and trust-center EUI-64 are installed in the
    /// initial security state. `link_key` becomes the preconfigured trust-center
    /// link key. The network manager ID and network update ID initially use
    /// their default zero values.
    ///
    /// Zigbee radio channels normally range from 11 through 26. This function
    /// does not validate `radio_channel`.
    #[must_use]
    pub const fn new(
        network_credentials: NetworkCredentials,
        link_key: Key,
        radio_channel: u8,
        join_method: Method,
        bitmask: Bitmask,
    ) -> Self {
        Self {
            network_credentials,
            link_key,
            radio_channel,
            join_method,
            bitmask,
            nwk_manager_id: DEFAULT_NWK_MANAGER_ID,
            nwk_update_id: DEFAULT_NWK_UPDATE_ID,
        }
    }

    /// Creates the Ember initial security state for network formation.
    ///
    /// The returned state contains both the network key from the credentials
    /// and the separately supplied preconfigured link key.
    #[must_use]
    pub fn initial_security_state(&self) -> State {
        State::new(
            self.bitmask
                | Bitmask::TRUST_CENTER_GLOBAL_LINK_KEY
                | Bitmask::HAVE_PRECONFIGURED_KEY
                | Bitmask::REQUIRE_ENCRYPTED_KEY
                | Bitmask::HAVE_NETWORK_KEY,
            self.link_key,
            self.network_credentials.network_key,
            NETWORK_KEY_SEQUENCE_NUMBER,
            MacAddr8::default(),
        )
    }

    /// Creates the Ember network parameters used to form the network.
    ///
    /// The network identifiers come from the credentials. `radio_tx_power` is
    /// supplied separately because it remains configurable on the builder.
    ///
    /// # Panics
    ///
    /// Panics if the configured channel is not representable in a 32-bit
    /// channel mask.
    #[must_use]
    pub fn parameters(&self, radio_tx_power: i8) -> Parameters {
        Parameters::new(
            self.network_credentials.extended_pan_id,
            self.network_credentials.pan_id,
            radio_tx_power,
            self.radio_channel,
            self.join_method,
            self.nwk_manager_id,
            self.nwk_update_id,
            CHANNEL_BIT << self.radio_channel,
        )
    }
}