aqara 0.1.1

Aqara SDK for Rust.
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

//! Device networking / pairing related request types.

use crate::types::SecretString;

/// Parameters for `query.device.bindKey`.
#[derive(Clone, Debug, Default)]
#[non_exhaustive]
pub struct QueryBindKeyParams {
    /// Optional position id. Empty means default position.
    pub position_id: Option<String>,
    /// Optional connect type (default: `"lumi"`).
    pub connect_type: Option<String>,
}

impl QueryBindKeyParams {
    /// Set position id.
    pub fn with_position_id(mut self, position_id: impl Into<String>) -> Self {
        self.position_id = Some(position_id.into());
        self
    }

    /// Set connect type.
    pub fn with_connect_type(mut self, connect_type: impl Into<String>) -> Self {
        self.connect_type = Some(connect_type.into());
        self
    }
}

/// Parameters for `query.device.bind`.
#[derive(Clone, Debug)]
#[non_exhaustive]
pub struct QueryBindParams {
    /// Bind key (secret).
    pub bind_key: SecretString,
}

impl QueryBindParams {
    /// Create params.
    pub fn new(bind_key: impl Into<String>) -> Self {
        Self {
            bind_key: SecretString::new(bind_key),
        }
    }
}

/// Parameters for `write.device.openConnect`.
#[derive(Clone, Debug)]
#[non_exhaustive]
pub struct OpenConnectParams {
    /// Gateway DID.
    pub did: String,
}

impl OpenConnectParams {
    /// Create params.
    pub fn new(did: impl Into<String>) -> Self {
        Self { did: did.into() }
    }
}

/// Parameters for `write.device.closeConnect`.
#[derive(Clone, Debug)]
#[non_exhaustive]
pub struct CloseConnectParams {
    /// Gateway DID.
    pub did: String,
}

impl CloseConnectParams {
    /// Create params.
    pub fn new(did: impl Into<String>) -> Self {
        Self { did: did.into() }
    }
}

/// Parameters for `query.device.supportGateway`.
#[derive(Clone, Debug)]
#[non_exhaustive]
pub struct QueryDeviceSupportGatewayParams {
    /// Sub-device model.
    pub model: String,
}

impl QueryDeviceSupportGatewayParams {
    /// Create params.
    pub fn new(model: impl Into<String>) -> Self {
        Self {
            model: model.into(),
        }
    }
}

/// Parameters for `query.position.supportGateway`.
#[derive(Clone, Debug)]
#[non_exhaustive]
pub struct QueryPositionSupportGatewayParams {
    /// Optional position id. Empty means default position.
    pub position_id: Option<String>,
    /// Sub-device model.
    pub model: String,
    /// Page number (1-based).
    pub page_num: u32,
    /// Page size.
    pub page_size: u32,
}

impl QueryPositionSupportGatewayParams {
    /// Create params with required fields.
    pub fn new(model: impl Into<String>) -> Self {
        Self {
            position_id: None,
            model: model.into(),
            page_num: 1,
            page_size: 30,
        }
    }

    /// Set position id.
    pub fn with_position_id(mut self, position_id: impl Into<String>) -> Self {
        self.position_id = Some(position_id.into());
        self
    }

    /// Set page number (1-based).
    pub fn with_page_num(mut self, page_num: u32) -> Self {
        self.page_num = page_num;
        self
    }

    /// Set page size.
    pub fn with_page_size(mut self, page_size: u32) -> Self {
        self.page_size = page_size;
        self
    }
}