core-s3 0.3.1

Board support crate for the M5Stack CoreS3 ESP32-S3 kit.
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

//! Matter-over-Thread configuration scaffolding for Gateway H2 applications.
//!
//! The Gateway H2 provides the IEEE 802.15.4/Thread-capable ESP32-H2 side of the
//! stack. The BSP owns board metadata and the CoreS3-to-H2 UART transport setup,
//! while consumer firmware owns the concrete Matter server, endpoint model,
//! persistence, commissioning policy, and networking stack such as `rs-matter`.

use heapless::String;

use super::GatewayH2;

/// Default Matter secure port.
pub const DEFAULT_MATTER_PORT: u16 = 5540;

/// Default Matter setup discriminator length in decimal digits.
pub const SETUP_DISCRIMINATOR_DIGITS: u8 = 12;

/// Configuration needed to advertise and commission a Matter node over Thread.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct MatterServerConfig {
    pub vendor_id: u16,
    pub product_id: u16,
    pub discriminator: u16,
    pub setup_passcode: u32,
    pub device_name: String<32>,
    pub port: u16,
}

impl MatterServerConfig {
    pub fn new(
        vendor_id: u16,
        product_id: u16,
        discriminator: u16,
        setup_passcode: u32,
        device_name: &str,
    ) -> Self {
        let mut name = String::new();
        let _ = name.push_str(device_name);

        Self {
            vendor_id,
            product_id,
            discriminator,
            setup_passcode,
            device_name: name,
            port: DEFAULT_MATTER_PORT,
        }
    }

    pub const fn with_port(mut self, port: u16) -> Self {
        self.port = port;
        self
    }
}

/// Thread dataset values a firmware can provision through the Gateway H2
/// co-processor before starting `rs-matter` networking.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct ThreadDatasetConfig {
    pub network_name: String<16>,
    pub pan_id: u16,
    pub extended_pan_id: [u8; 8],
    pub channel: u8,
    pub network_key: [u8; 16],
}

impl ThreadDatasetConfig {
    pub fn new(
        network_name: &str,
        pan_id: u16,
        extended_pan_id: [u8; 8],
        channel: u8,
        network_key: [u8; 16],
    ) -> Self {
        let mut name = String::new();
        let _ = name.push_str(network_name);

        Self {
            network_name: name,
            pan_id,
            extended_pan_id,
            channel,
            network_key,
        }
    }
}

/// Combined BSP-level Matter-over-Thread setup description.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct MatterOverThreadConfig {
    pub gateway: GatewayH2,
    pub matter: MatterServerConfig,
    pub thread: ThreadDatasetConfig,
}

impl MatterOverThreadConfig {
    pub const fn new(
        gateway: GatewayH2,
        matter: MatterServerConfig,
        thread: ThreadDatasetConfig,
    ) -> Self {
        Self {
            gateway,
            matter,
            thread,
        }
    }
}