apis-saltans-coordinator 0.12.0

Zigbee coordinator library.
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

use zb_core::GroupId;
use zb_core::destination::Device;
use zb_core::types::{String, Uint16};
use zb_zcl::groups::{AddGroup, GetGroupMembership, GetGroupMembershipResponse, RemoveGroup};

use crate::{Error, StatusExt, Zcl, ZclResponse};

/// Trait for Groups cluster operations.
pub trait Groups {
    /// Lists the group memberships from the device.
    ///
    /// The first await queues the request and returns a [`ZclResponse`]. Await that response to
    /// confirm transmission and receive the membership list.
    ///
    /// # Errors
    ///
    /// Returns an [`Error`] if the request cannot be queued. The returned [`ZclResponse`] reports
    /// transmission, reception, and response-conversion errors when awaited.
    fn list(
        &self,
        device: Device,
    ) -> impl Future<Output = Result<ZclResponse<GetGroupMembershipResponse>, Error>> + Send;

    /// Adds the device to a group.
    ///
    /// If `name` is [`None`], an empty group name is sent.
    ///
    /// # Errors
    ///
    /// Returns an [`Error`] if execution of the command failed or if the device
    /// rejected the group addition.
    fn add(
        &self,
        device: Device,
        group_id: GroupId,
        name: Option<String>,
    ) -> impl Future<Output = Result<Uint16, Error>> + Send;

    /// Removes the device from a group.
    ///
    /// # Errors
    ///
    /// Returns an [`Error`] if execution of the command failed or if the device
    /// rejected the group removal.
    fn remove(
        &self,
        device: Device,
        group_id: GroupId,
    ) -> impl Future<Output = Result<Uint16, Error>> + Send;
}

impl<T> Groups for T
where
    T: Zcl + Sync,
{
    async fn list(&self, device: Device) -> Result<ZclResponse<GetGroupMembershipResponse>, Error> {
        self.communicate(device, GetGroupMembership::default())
            .await
    }

    async fn add(
        &self,
        device: Device,
        group_id: GroupId,
        name: Option<String>,
    ) -> Result<Uint16, Error> {
        let response = self
            .communicate(device, AddGroup::new(group_id, name.unwrap_or_default()))
            .await?
            .await?;

        response
            .status()
            .ensure_success()
            .map(|()| response.group_id())
    }

    async fn remove(&self, device: Device, group_id: GroupId) -> Result<Uint16, Error> {
        let response = self
            .communicate(device, RemoveGroup::new(group_id))
            .await?
            .await?;
        response
            .status()
            .ensure_success()
            .map(|()| response.group_id())
    }
}