ezsp 15.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
107
108
109
110
111
112

//! Transport-independent actor wiring for EZSP frame I/O.
//!
//! External transports implement [`Transmit`] and [`Receive`]. [`Client::run`]
//! takes ownership of those halves, creates the bounded actor channels, and
//! returns a pre-negotiation [`Client`] plus the [`Futures`] that drive both
//! actors. Spawn both futures before calling [`Client::connect`].

use std::num::NonZero;

use tokio::sync::mpsc::{self, Sender, channel};

pub use self::connection::Connection;
pub use self::futures::Futures;
use self::message::Message;
pub use self::receiver::Receive;
use self::receiver::Receiver;
pub use self::translatable_event::TranslatableEvent;
pub use self::transmitter::Transmit;
use self::transmitter::Transmitter;
use crate::api::negotiate_version::NegotiateVersion;
use crate::{Callback, Error};

mod connection;
mod futures;
mod message;
mod negotiate_version;
mod receiver;
mod translatable_event;
mod transmitter;

/// Handle to running transport tasks before EZSP version negotiation.
///
/// [`Client::run`] wires transport-specific transmit and receive halves into
/// the EZSP actors. After both returned actor futures have been spawned,
/// [`Client::connect`] issues the initial `version` command and transitions to
/// a cloneable [`Connection`].
#[derive(Debug)]
pub struct Client {
    pub(crate) handle: Sender<Message>,
    pub(crate) callbacks: mpsc::Receiver<Callback>,
}

impl Client {
    /// Creates a client and the futures that drive its transport actors.
    ///
    /// This associated function creates command/response and callback channels
    /// around `transmit` and `receive`, then returns a pre-negotiation client
    /// and [`Futures`]. Spawn `futures.transmitter` and `futures.receiver`
    /// before calling [`Client::connect`] or [`crate::Builder::start`]. Start
    /// any lower-level tasks used by the transport implementations first.
    ///
    /// `channel_size` is used for both the command/response actor channel and
    /// the asynchronous callback channel.
    ///
    /// # Panics
    ///
    /// Panics if `channel_size` is zero.
    #[must_use]
    pub fn run<T, R>(
        transmit: T,
        receive: R,
        channel_size: usize,
    ) -> (
        Self,
        Futures<
            impl Future<Output = ()> + Send + 'static,
            impl Future<Output = ()> + Send + 'static,
        >,
    )
    where
        T: Transmit + Send + 'static,
        R: Receive + Send + 'static,
    {
        let (handle, msg_rx) = channel(channel_size);
        let transmitter = Transmitter::new(transmit, msg_rx).run();
        let (cb_tx, callbacks) = channel(channel_size);
        let receiver = Receiver::new(receive, cb_tx, handle.clone()).run();
        (
            Self { handle, callbacks },
            Futures {
                transmitter,
                receiver,
            },
        )
    }

    /// Negotiates `desired_version` and returns a connection and callback stream.
    ///
    /// This method consumes the pre-negotiation client. The returned
    /// [`Connection`] is cloneable and implements the typed command traits
    /// through [`Communicate`](crate::Communicate). The callback receiver yields
    /// asynchronous EZSP callbacks routed by the receiver actor.
    ///
    /// # Errors
    ///
    /// Returns an [`Error`] if the actor channel closes, transmission fails, or
    /// the NCP negotiates a different protocol version.
    pub async fn connect(
        self,
        desired_version: NonZero<u8>,
    ) -> Result<(Connection, mpsc::Receiver<Callback>), Error> {
        self.handle.negotiate_version(desired_version).await?;

        Ok((
            Connection {
                desired_version,
                handle: self.handle,
            },
            self.callbacks,
        ))
    }
}