matter_setup_code 0.1.1

Parse and generate Matter onboarding payloads, including QR codes and manual setup codes.
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

use deku::prelude::*;
use crate::base38;
use crate::error::{PayloadError, Result};
use super::common::CommissioningFlow;

/// Represents the binary structure of a Matter QR code payload.
/// This struct is an internal detail and is not exposed publicly.
#[derive(Debug, PartialEq, DekuRead, DekuWrite)]
#[deku(endian = "big")]
pub(super) struct QrCodeData {
    #[deku(bits = "4")]
    pub padding: u8,
    #[deku(bits = "27")]
    pub pincode: u32,
    #[deku(bits = "12")]
    pub discriminator: u16,
    #[deku(bits = "8")]
    pub discovery: u8,
    pub flow: CommissioningFlow,
    #[deku(bits = "16")]
    pub pid: u16,
    #[deku(bits = "16")]
    pub vid: u16,
    #[deku(bits = "3")]
    pub version: u8,
}

impl QrCodeData {
    /// Parses a raw "MT:..." string into the QR code data structure.
    pub(super) fn parse_from_str(payload: &str) -> Result<Self> {
        if !payload.starts_with("MT:") {
            return Err(PayloadError::InvalidQrCodePrefix.into());
        }

        let encoded = &payload[3..];
        let mut decoded_bytes = base38::decode(encoded)?;
        decoded_bytes.reverse();

        // Deku reads from a bit slice. The `from_bytes` helper creates this for us.
        let (_rest, data) = QrCodeData::from_bytes((&decoded_bytes, 0))?;
        Ok(data)
    }
}