zigbee 0.1.0-alpha.3

ZigBee protocol stack in `no-std` based on the ZigBee specification 22 1.0
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

#![allow(dead_code)]

/// 3.2.2.3 NLME-NETWORK-DISCOVERY.request
pub struct NlmeNetworkDiscoveryRequest {
    pub(crate) scan_channels_list_structure: [u8; 8],
    pub(crate) scan_duration: u8,
}

/// 3.2.2.4 - NLME-NETWORK-DISCOVERY.confirm
pub struct NlmeNetworkDiscoveryConfirm {
    pub status: NlmeNetworkDiscoveryStatus,
    pub(crate) network_count: u8,
    pub(crate) network_descriptor: NetworkDescriptor,
}

#[derive(Debug, PartialEq, Eq)]
pub enum NlmeNetworkDiscoveryStatus {
    Successful,
}

/// Network descriptor
pub struct NetworkDescriptor {
    /// 64-bit PAN identifier
    pub extended_pan_id: u64,
    /// 16-bit PAN identifier
    pub pan_id: u16,
    /// update ID from the NIB
    pub update_id: u8,
    /// current logical channel
    pub logical_channel: u8,
    /// A zigbee stack profile
    pub stack_profile: u8,
    /// version of the ZigBee protocol in use
    pub zigbee_version: u8,
    /// specifies how often the MAC sub-layer beacon is to be transmitted
    pub beacon_order: u8,
    /// for beacon oriented networks
    pub superframe_order: u8,
    /// indicates that at least one ZigBee router or network currently permits
    /// joineng
    pub permit_joining: bool,
    /// set to TRUE if the device is capable of accepting join requests from
    /// router-capable devices
    pub router_capacity: bool,
    /// set to TRUE if the device is capable of accepting join requests from end
    /// devices
    pub end_device_capacity: bool,
}

/// 3.2.2.5 - NLME-NETWORK-FORMATION.request
pub struct NlmeNetworkFormationRequest {}
/// 3.2.2.6 - NLME-NETWORK-FORMATION.confirm
pub struct NlmeNetworkFormationConfirm {}

/// 3.2.2.7 - NLME-PERMIT-JOINING.request
pub struct NlmePermitJoiningRequest {}
/// 3.2.2.8 - NLME-PERMIT-JOINING.confirm
pub struct NlmePermitJoiningConfirm {}
/// 3.2.2.9 - NLME-START-ROUTER.request
pub struct NlmeStartRouterRequest {}
/// 3.2.2.10 - NLME-START-ROUTER.confirm
pub struct NlmeStartRouterConfirm {}
/// 3.2.2.11 - NLME-ED-SCAN.request
pub struct NlmeEdScanRequest {}
/// 3.2.2.12 - NLME-ED-SCAN.confirm
pub struct NlmeEdScanConfirm {}
/// 3.2.2.13 - NLME-JOIN.request
pub struct NlmeJoinRequest {
    pub(crate) extended_pan_id: u64,
    pub(crate) rejoin_network: u8,
    // ScanChannelsListStructure
    pub(crate) scan_duration: u8,
    // CapabilityInformation
    pub(crate) security_enabled: bool,
}
/// 3.2.2.14 - NLME-JOIN.indication
pub struct NlmeJoinIndication {
    pub(crate) network_address: u16,
    pub(crate) extended_address: u64,
    //CapabilityInformation
    pub(crate) rejoin_network: u8,
    pub(crate) secure_rejoin: bool,
}
/// 3.2.2.15 - NLME-JOIN.confirm
pub struct NlmeJoinConfirm {
    pub(crate) status: NlmeJoinStatus,
    pub(crate) network_address: u16,
    pub(crate) extended_pan_id: u64,
    // Channel List Structure
    pub(crate) enhanced_beacon_type: bool,
    pub(crate) mac_interface_index: u8,
}

pub(crate) enum NlmeJoinStatus {
    Success,
    InvalidRequest,
    NotPermitted,
    NoNetworks,
    // TODO: add more from 3.2.2.13.3
}

/// 3.2.2.16 - NLME-DIRECT-JOIN.request
pub struct NlmeDirectJoinRequest {}
/// 3.2.2.17 - NLME-DIRECT-JOIN.confirm
pub struct NlmeDirectJoinConfirm {}

/// 3.2.2.18 - NLME-LEAVE.request
pub struct NlmeLeaveRequest {}
/// 3.2.2.19 - NLME-LEAVE.indication
pub struct NlmeLeaveIndication {}
/// 3.2.2.20 - NLME-LEAVE.confirm
pub struct NlmeLeaveConfirm {}

/// 3.2.2.21 - NLME-RESET.request
pub struct NlmeResetRequest {}
/// 3.2.2.22 - NLME-RESET.confirm
pub struct NlmeResetConfirm {}