busylib 0.0.8

BUSY Bar Rust HTTP client
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

//! Smart home schemas

use serde::{Deserialize, Serialize};

/// How many smart homes the device is paired with
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SmartHomePairingInfo {
    /// Number of smart homes (Matter "fabrics") that this device is paired with ("commissioned
    /// into")
    pub fabric_count: Option<u32>,
    pub latest_pairing_status: Option<PairingStatusInfo>,
}

impl SmartHomePairingInfo {
    pub fn is_paired(&self) -> bool {
        self.fabric_count.is_some_and(|count| count > 0)
    }
}

/// Latest pairing state and when it was recorded
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct PairingStatusInfo {
    /// Latest state of smart home pairing (Matter "commissioning") process. Note:
    /// "never_started" only refers to the current power cycle of the device; this status is not
    /// recorded across reboots.
    pub value: PairingStatus,
    /// UTC Unix second timestamp of latest state update. Only present when a status update has
    /// occurred.
    pub timestamp: Option<u64>,
}

/// States the pairing process can be in
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum PairingStatus {
    NeverStarted,
    Started,
    CompletedSuccessfully,
    Failed,
    #[serde(untagged)]
    Unknown(String),
}

/// Set of information for pairing with a Matter smart home
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SmartHomePairingPayload {
    /// Pairing with ("commissioning into") a Matter smart home using the provided payload is
    /// possible before this UTC Unix millisecond timestamp. Note: it's a number in a string.
    #[serde(default, with = "crate::serde_util::option_string_u64")]
    pub available_until: Option<u64>,
    /// Payload of the QR code for pairing with ("commissioning into") a smart home
    pub qr_code: Option<String>,
    /// Manual code for pairing with ("commissioning into") a smart home
    pub manual_code: Option<String>,
}

/// State of the emulated switch
#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
pub struct SmartHomeSwitchState {
    /// State of emulated switch.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub state: Option<bool>,
    /// State of emulated switch on startup. Never sent by the server, but can be specified by
    /// the client.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub startup: Option<SwitchStartup>,
}

impl SmartHomeSwitchState {
    pub fn on() -> Self {
        Self {
            state: Some(true),
            startup: None,
        }
    }

    pub fn off() -> Self {
        Self {
            state: Some(false),
            startup: None,
        }
    }

    pub fn startup(mut self, startup: SwitchStartup) -> Self {
        self.startup = Some(startup);
        self
    }

    pub fn is_on(&self) -> bool {
        self.state.unwrap_or(false)
    }
}

/// State the emulated switch takes on startup
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum SwitchStartup {
    Off,
    On,
    Toggle,
    Last,
}