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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

use core::future::Future;

use crate::ember::gp::Address;
use crate::ember::gp::sink::TableEntry;
use crate::error::Error;
use crate::frame::parameters::green_power::sink_table::{
    clear_all, find_or_allocate_entry, get_entry, init, lookup, number_of_active_entries,
    remove_entry, set_entry, set_security_frame_counter,
};
use crate::transport::Transport;

/// The `SinkTable` trait provides an interface for the sink table.
pub trait SinkTable {
    /// Clear the entire sink table.
    fn clear_all(&mut self) -> impl Future<Output = Result<(), Error>> + Send;

    /// Finds or allocates a sink entry.
    fn find_or_allocate_entry(
        &mut self,
        addr: Address,
    ) -> impl Future<Output = Result<u8, Error>> + Send;

    /// Retrieves the sink table entry stored at the passed index.
    fn get_entry(
        &mut self,
        sink_index: u8,
    ) -> impl Future<Output = Result<TableEntry, Error>> + Send;

    /// Initializes Sink Table.
    fn init(&mut self) -> impl Future<Output = Result<(), Error>> + Send;

    /// Finds the index of the passed address in the gp table.
    fn lookup(&mut self, addr: Address) -> impl Future<Output = Result<u8, Error>> + Send;

    /// Return number of active entries in sink table.
    fn number_of_active_entries(&mut self) -> impl Future<Output = Result<u8, Error>> + Send;

    /// Removes the sink table entry stored at the passed index.
    fn remove_entry(&mut self, sink_index: u8) -> impl Future<Output = Result<(), Error>> + Send;

    /// Retrieves the sink table entry stored at the passed index.
    fn set_entry(
        &mut self,
        sink_index: u8,
        entry: TableEntry,
    ) -> impl Future<Output = Result<(), Error>> + Send;

    /// Sets security frame counter in the sink table.
    fn set_security_frame_counter(
        &mut self,
        index: u8,
        sfc: u32,
    ) -> impl Future<Output = Result<(), Error>> + Send;
}

impl<T> SinkTable for T
where
    T: Transport,
{
    async fn clear_all(&mut self) -> Result<(), Error> {
        self.communicate(clear_all::Command).await.map(drop)
    }

    async fn find_or_allocate_entry(&mut self, addr: Address) -> Result<u8, Error> {
        self.communicate(find_or_allocate_entry::Command::new(addr))
            .await
            .map(|response| response.index())
    }

    async fn get_entry(&mut self, sink_index: u8) -> Result<TableEntry, Error> {
        self.communicate(get_entry::Command::new(sink_index))
            .await?
            .try_into()
    }

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

    async fn lookup(&mut self, addr: Address) -> Result<u8, Error> {
        self.communicate(lookup::Command::new(addr))
            .await
            .map(|response| response.index())
    }

    async fn number_of_active_entries(&mut self) -> Result<u8, Error> {
        self.communicate(number_of_active_entries::Command)
            .await
            .map(|response| response.number_of_entries())
    }

    async fn remove_entry(&mut self, sink_index: u8) -> Result<(), Error> {
        self.communicate(remove_entry::Command::new(sink_index))
            .await
            .map(drop)
    }

    async fn set_entry(&mut self, sink_index: u8, entry: TableEntry) -> Result<(), Error> {
        self.communicate(set_entry::Command::new(sink_index, entry))
            .await?
            .try_into()
    }

    async fn set_security_frame_counter(&mut self, index: u8, sfc: u32) -> Result<(), Error> {
        self.communicate(set_security_frame_counter::Command::new(index, sfc))
            .await
            .map(drop)
    }
}