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

use le_stream::FromLeStream;
use num_traits::FromPrimitive;

use crate::Error;
use crate::ember::Status;
use crate::frame::Parameter;

const ID: u16 = 0x001C;

/// Returns the status of the current scan of type
/// [`Type::EnergyScan`](crate::ezsp::network::scan::Type::EnergyScan) or
/// [`Type::ActiveScan`](crate::ezsp::network::scan::Type::ActiveScan).
///
/// [`Status::Success`] signals that the scan has completed.
///
/// Other error conditions signify a failure to scan on the channel specified.
#[derive(Clone, Debug, Eq, PartialEq, FromLeStream)]
pub struct Handler {
    channel: u8,
    status: u8,
}

impl Handler {
    /// The channel on which the current error occurred.
    ///
    /// Undefined for the case of [`Status::Success`].
    #[must_use]
    pub fn channel(&self) -> Option<u8> {
        match self.status() {
            Ok(()) => None,
            Err(_) => Some(self.channel),
        }
    }

    /// The error condition that occurred on the current channel.
    ///
    /// Value will be [`Status::Success`] when the scan has completed.
    ///
    /// # Errors
    ///
    /// Returns an [`Error`] if the status is invalid.
    pub fn status(&self) -> Result<(), Error> {
        match Status::from_u8(self.status).ok_or(self.status) {
            Ok(Status::Success) => Ok(()),
            other => Err(other.into()),
        }
    }
}

impl TryFrom<Handler> for u8 {
    type Error = Error;

    fn try_from(handler: Handler) -> Result<Self, Self::Error> {
        handler.status().map(|()| handler.channel)
    }
}

impl Parameter for Handler {
    const ID: u16 = ID;
}