ezsp 6.0.1

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

use core::future::Future;

use crate::error::Error;
use crate::frame::parameters::wwah::{
    get_parent_classification_enabled, is_hub_connected, is_uptime_long, set_hub_connectivity,
    set_long_uptime, set_parent_classification_enabled,
};
use crate::transport::Transport;

/// The `Wwah` trait provides an interface for the Work With All Hubs (WWAH) protocol.
pub trait Wwah {
    /// Gets whether to use parent classification when processing beacons during a join or rejoin.
    ///
    /// Parent classification considers whether a received beacon indicates trust center
    /// connectivity and long uptime on the network.
    fn get_parent_classification_enabled(&mut self) -> impl Future<Output = Result<bool, Error>>;

    /// Checks if the hub is connected or not.
    fn is_hub_connected(&mut self) -> impl Future<Output = Result<bool, Error>>;

    /// Checks if the device uptime is long or short.
    fn is_uptime_long(&mut self) -> impl Future<Output = Result<bool, Error>>;

    /// Sets the hub connectivity to be `true` or `false`.
    fn set_hub_connectivity(&mut self, connected: bool) -> impl Future<Output = Result<(), Error>>;

    /// Sets the device uptime to be long or short.
    fn set_long_uptime(&mut self, has_long_uptime: bool)
    -> impl Future<Output = Result<(), Error>>;

    /// Sets whether to use parent classification when processing beacons during a join or rejoin.
    ///
    /// Parent classification considers whether a received beacon indicates trust center
    /// connectivity and long uptime on the network.
    fn set_parent_classification_enabled(
        &mut self,
        enabled: bool,
    ) -> impl Future<Output = Result<(), Error>>;
}

impl<T> Wwah for T
where
    T: Transport,
{
    async fn get_parent_classification_enabled(&mut self) -> Result<bool, Error> {
        self.communicate(get_parent_classification_enabled::Command)
            .await
            .map(Into::into)
    }

    async fn is_hub_connected(&mut self) -> Result<bool, Error> {
        self.communicate(is_hub_connected::Command)
            .await
            .map(Into::into)
    }

    async fn is_uptime_long(&mut self) -> Result<bool, Error> {
        self.communicate(is_uptime_long::Command)
            .await
            .map(Into::into)
    }

    async fn set_hub_connectivity(&mut self, connected: bool) -> Result<(), Error> {
        self.communicate(set_hub_connectivity::Command::new(connected))
            .await
            .map(drop)
    }

    async fn set_long_uptime(&mut self, has_long_uptime: bool) -> Result<(), Error> {
        self.communicate(set_long_uptime::Command::new(has_long_uptime))
            .await
            .map(drop)
    }

    async fn set_parent_classification_enabled(&mut self, enabled: bool) -> Result<(), Error> {
        self.communicate(set_parent_classification_enabled::Command::new(enabled))
            .await
            .map(drop)
    }
}