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

//! Transport abstraction for an NCP that supports EZSP.
//!
//! EZSP itself is independent of the physical link. The Silicon Labs references
//! describe both SPI and UART interfaces; this crate exposes the common
//! command/response behavior through [`Transport`] and provides a UART
//! implementation behind the `ashv2` feature.

use core::future::Future;
use std::num::NonZero;

use le_stream::ToLeStream;

use crate::frame::Parameter;
use crate::parameters::configuration::version;
use crate::{Connection, Error, Parameters};

/// A connection to an EZSP-capable Network Co-Processor.
///
/// Every transport receives a blanket [`Communicate`](crate::Communicate)
/// implementation and, through it, implementations of the higher-level EZSP
/// command traits. Implementing this trait is therefore the integration point
/// for alternate links such as SPI or a custom UART stack.
///
/// Unless you know what you are doing, you should not use the methods of this trait directly.
pub trait Transport: Send {
    /// Initialize the `EZSP` connection.
    ///
    /// The host must issue the EZSP `version` command after an NCP reset before
    /// normal commands are accepted. Implementations perform that negotiation
    /// here and record the negotiated protocol version.
    ///
    /// # Errors
    ///
    /// Returns an [`Error`] on I/O errors or if the desired protocol version is not supported.
    fn connect(&mut self) -> impl Future<Output = Result<version::Response, Error>> + Send;

    /// Returns the current connection state.
    fn state(&self) -> Connection;

    /// Returns the negotiated protocol version, if any.
    fn negotiated_version(&self) -> Option<NonZero<u8>>;

    /// Send a command frame to the NCP.
    fn send<T>(&mut self, command: T) -> impl Future<Output = Result<u16, Error>> + Send
    where
        T: Parameter + ToLeStream;

    /// Receive a response or synchronous callback frame from the NCP.
    fn receive<T>(&mut self) -> impl Future<Output = Result<T, Error>> + Send
    where
        T: TryFrom<Parameters> + Send,
        <T as TryFrom<Parameters>>::Error: Into<Parameters> + Send;
}