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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

//! Gets information about a timer.
//!
//! The Host can use this command to find out how much longer it will be
//! before a previously set timer will generate a callback.

use le_stream::{FromLeStream, ToLeStream};

use crate::ember::event::{Duration, Units};
use crate::frame::Parameter;
use crate::frame::responds_with::RespondsWith;

const ID: u16 = 0x004E;

#[derive(Clone, Debug, Eq, PartialEq, ToLeStream)]
pub(crate) struct Command {
    timer_id: u8,
}

impl Command {
    #[must_use]
    pub const fn new(timer_id: u8) -> Self {
        Self { timer_id }
    }
}

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

impl RespondsWith for Command {
    type Response = Response;
}

/// The response to a get timer command.
#[derive(Clone, Debug, Eq, PartialEq, FromLeStream)]
pub struct Response {
    time: u16,
    units: u8,
    repeat: bool,
}

impl Response {
    /// Returns the time.
    #[must_use]
    pub const fn time(&self) -> u16 {
        self.time
    }

    /// Returns the time units.
    ///
    /// # Errors
    ///
    /// Returns an error if the units are invalid.
    pub fn units(&self) -> Result<Units, u8> {
        Units::try_from(self.units)
    }

    /// Returns the time duration.
    #[must_use]
    pub fn duration(&self) -> Option<Duration> {
        self.units()
            .ok()
            .and_then(|units| Duration::try_new(self.time, units).ok())
    }

    /// Returns whether the timer should repeat.
    #[must_use]
    pub const fn repeat(&self) -> bool {
        self.repeat
    }
}

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