hive-client 0.0.6

A Rust client for interfacing with Hive smart home systems.
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194

use std::collections::HashMap;

use crate::client::api::HiveApi;
use crate::client::api::error::ApiError;
use crate::client::authentication::Tokens;
use crate::helper::url::{Url, get_base_url};
use chrono::{DateTime, Utc, serde::ts_milliseconds};
use serde::Deserialize;
use serde_json::Value;

#[derive(Deserialize, Debug)]
#[serde(rename_all = "lowercase")]
#[allow(missing_docs)]
pub enum PowerType {
    /// The device is powered by an internal battery.
    Battery,

    /// The device is connected directly to the mains power supply.
    Mains,
}

#[derive(Deserialize, Debug)]
#[non_exhaustive]
#[allow(missing_docs)]
pub struct Properties {
    #[serde(rename = "online")]
    /// Whether the device is currently online or not.
    pub is_online: bool,

    /// The type of power source used by the device (if applicable).
    pub power: Option<PowerType>,

    #[serde(rename = "battery")]
    /// The battery percentage of the device (if applicable).
    pub battery_percentage: Option<i32>,

    #[serde(rename = "zone")]
    /// The ID of the zone the device is located in (if applicable).
    pub zone_id: Option<String>,

    #[serde(flatten)]
    #[allow(missing_docs)]
    pub extra: HashMap<String, Value>,
}

#[derive(Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
#[allow(missing_docs)]
pub struct State {
    /// The name of the device.
    pub name: String,

    /// The name of the zone the device is located in (if applicable).
    pub zone_name: Option<String>,
}

#[derive(Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
/// A [Hive Thermostat](https://www.hivehome.com/shop/smart-heating/hive-thermostat).
pub struct Thermostat {
    /// The unique ID of the Thermostat.
    pub id: String,

    #[serde(with = "ts_milliseconds")]
    /// The date and time the Thermostat last communicated with the Hub.
    pub last_seen: DateTime<Utc>,

    #[serde(with = "ts_milliseconds")]
    #[serde(rename = "created")]
    /// The date and time when the Thermostat was first created.
    pub created_at: DateTime<Utc>,

    #[serde(rename = "props")]
    /// The properties of the Thermostat.
    pub properties: Properties,

    /// The current state of the Thermostat.
    pub state: State,

    #[serde(flatten)]
    #[allow(missing_docs)]
    pub extra: HashMap<String, Value>,
}

#[derive(Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
/// A [Hive Hub](https://www.hivehome.com/shop/smart-home/hive-hub).
pub struct Hub {
    /// The unique ID of the Hub.
    pub id: String,

    #[serde(with = "ts_milliseconds")]
    /// The date and time the Hub last communicated with the Hive servers.
    pub last_seen: DateTime<Utc>,

    #[serde(with = "ts_milliseconds")]
    #[serde(rename = "created")]
    /// The date and time when the Hub was first created.
    pub created_at: DateTime<Utc>,

    #[serde(rename = "props")]
    /// The properties of the Hub.
    pub properties: Properties,

    /// The current state of the Hub.
    pub state: State,

    #[serde(flatten)]
    #[allow(missing_docs)]
    pub extra: HashMap<String, Value>,
}

#[derive(Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
/// A Hive Boiler Module.
pub struct BoilerModule {
    /// The unique ID of the Boiler Module.
    pub id: String,

    #[serde(with = "ts_milliseconds")]
    /// The date and time the Boiler Module last communicated with the Hub.
    pub last_seen: DateTime<Utc>,

    #[serde(with = "ts_milliseconds")]
    #[serde(rename = "created")]
    /// The date and time when the Boiler Module was first created.
    pub created_at: DateTime<Utc>,

    #[serde(rename = "props")]
    /// The properties of the Boiler Module.
    pub properties: Properties,

    /// The current state of the Boiler Module.
    pub state: State,

    #[serde(flatten)]
    #[allow(missing_docs)]
    pub extra: HashMap<String, Value>,
}

#[derive(Deserialize, Debug)]
#[serde(rename_all = "lowercase")]
#[serde(tag = "type")]
#[non_exhaustive]
#[allow(missing_docs)]
pub enum DeviceData {
    #[serde(rename = "thermostatui")]
    /// A [Hive Thermostat](https://www.hivehome.com/shop/smart-heating/hive-thermostat).
    Thermostat(Thermostat),

    /// A [Hive Hub](https://www.hivehome.com/shop/smart-home/hive-hub).
    Hub(Hub),

    /// A Hive Boiler Module.
    BoilerModule(BoilerModule),

    #[serde(other)]
    /// A device which is yet to be mapped by the crate.
    Unknown,
}

/// A Device setup in a Hive account.
///
/// For example, a [`DeviceData::Thermostat`], a [`DeviceData::Hub`], etc.
#[derive(Debug)]
pub struct Device {
    #[allow(missing_docs)]
    pub data: DeviceData,
}

impl Device {
    pub(crate) const fn new(data: DeviceData) -> Self {
        Self { data }
    }
}

impl HiveApi {
    pub(crate) async fn get_devices(&self, tokens: &Tokens) -> Result<Vec<DeviceData>, ApiError> {
        let response = self
            .client
            .get(get_base_url(&Url::Device))
            .header("Authorization", &tokens.id_token)
            .send()
            .await;

        let body = response?.text().await?;

        Ok(serde_json::from_str(&body)?)
    }
}