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

use core::future::Future;

use crate::ember::Eui64;
use crate::error::Error;
use crate::frame::parameters::bootloader::{
    aes_encrypt, get_standalone_bootloader_version_plat_micro_phy, launch_standalone_bootloader,
    send_bootload_message,
};
use crate::transport::Transport;
use crate::types::ByteSizedVec;

/// The `Bootloader` trait provides an interface for the bootloader features.
pub trait Bootloader {
    /// Perform AES encryption on `plaintext` using `key`.
    fn aes_encrypt(
        &mut self,
        plaintext: [u8; 16],
        key: [u8; 16],
    ) -> impl Future<Output = Result<[u8; 16], Error>> + Send;

    /// Detects if the standalone bootloader is installed, and if so returns the installed version.
    ///
    /// If not return `0xffff`. A returned version of `0x1234` would indicate version 1.2 build 34.
    /// Also return the node's version of `PLAT`, `MICRO` and `PHY`.
    fn get_standalone_bootloader_version_plat_micro_phy(
        &mut self,
    ) -> impl Future<
        Output = Result<get_standalone_bootloader_version_plat_micro_phy::Response, Error>,
    > + Send;

    /// Quits the current application and launches the standalone bootloader (if installed).
    ///
    /// The function returns an error if the standalone bootloader is not present.
    fn launch_standalone_bootloader(
        &mut self,
        mode: u8,
    ) -> impl Future<Output = Result<(), Error>> + Send;

    /// Transmits the given bootload message to a neighboring node using a specific 802.15.4 header
    /// that allows the `EmberZNet` stack as well as the bootloader to recognize the message,
    /// but will not interfere with other Zigbee stacks.
    fn send_bootload_message(
        &mut self,
        broadcast: bool,
        dest_eui64: Eui64,
        message: ByteSizedVec<u8>,
    ) -> impl Future<Output = Result<(), Error>> + Send;
}

impl<T> Bootloader for T
where
    T: Transport,
{
    async fn aes_encrypt(&mut self, plaintext: [u8; 16], key: [u8; 16]) -> Result<[u8; 16], Error> {
        self.communicate(aes_encrypt::Command::new(plaintext, key))
            .await
            .map(|response| response.ciphertext())
    }

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

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

    async fn send_bootload_message(
        &mut self,
        broadcast: bool,
        dest_eui64: Eui64,
        message: ByteSizedVec<u8>,
    ) -> Result<(), Error> {
        self.communicate(send_bootload_message::Command::new(
            broadcast, dest_eui64, message,
        ))
        .await?
        .try_into()
    }
}