apis-saltans-coordinator 0.12.0

Zigbee coordinator library.
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

use std::fmt::Debug;

use tokio::sync::mpsc::{Receiver, Sender};
use zb_core::node::Descriptor;
use zb_hw::{Error, NcpHandle};

use crate::mux::Mux;
use crate::{Event, zcl, zdp};

/// External Zigbee API struct.
#[derive(Clone, Debug)]
pub struct Coordinator {
    pub(crate) ncp: NcpHandle,
    pub(crate) zcl: Sender<zcl::Message>,
    pub(crate) zdp: Sender<zdp::Message>,
}

impl Coordinator {
    /// Start the coordinator on the given hardware.
    ///
    /// Local endpoint descriptors are obtained from the NCP through [`zb_hw::Ncp::get_endpoints`]
    /// when needed; callers do not supply them during startup.
    ///
    /// # Errors
    ///
    /// Returns an [`Error`] if setting up the actor network fails.
    pub fn start(
        ncp: NcpHandle,
        descriptor: Descriptor,
        hw_events: Receiver<zb_hw::Event>,
        events_out: Sender<Event>,
    ) -> Result<Self, Error> {
        let zcl = zcl::Transceiver::spawn(ncp.clone(), events_out.clone());
        let zdp = zdp::Transceiver::spawn(ncp.clone(), events_out.clone(), descriptor);
        Mux::spawn(hw_events, events_out, zcl.clone(), zdp.clone());
        Ok(Self { ncp, zcl, zdp })
    }
}