switchkit 0.2.0

Vendor-neutral abstraction for smart-plug devices (Shelly, Tasmota).
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

use serde::{Deserialize, Serialize};

/// The device's vendor. Non-exhaustive: new vendors are added over time and this
/// must not become a breaking change for downstream `match` expressions.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
#[non_exhaustive]
pub enum Vendor {
    Tasmota,
    Shelly,
}

impl Vendor {
    pub fn as_str(&self) -> &'static str {
        match self {
            Vendor::Tasmota => "tasmota",
            Vendor::Shelly => "shelly",
        }
    }
}

/// Per-device credentials, vendor-neutral (user + password covers Tasmota WebPassword
/// and Shelly digest/basic auth). Server-side only; never rendered to a browser.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct DeviceCredentials {
    pub user: String,
    pub password: String,
}

/// Everything a core needs to reach one physical device.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DeviceTarget {
    pub host: String,
    pub credentials: Option<DeviceCredentials>,
}

impl DeviceTarget {
    pub fn new(host: impl Into<String>) -> Self {
        DeviceTarget {
            host: host.into(),
            credentials: None,
        }
    }
    pub fn with_credentials(mut self, credentials: Option<DeviceCredentials>) -> Self {
        self.credentials = credentials;
        self
    }
}