hues 0.1.3

A Rust client for the Philips Hue API v2
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
use crate::{
    api::HueAPIError,
    command::{
        merge_commands, BasicCommand, GeofenceClientCommand, GeolocationCommand, MotionCommand,
    },
    service::{Bridge, ResourceIdentifier, ResourceType, SetStatus},
};
use serde::{Deserialize, Serialize};

/// A physical contact sensor device.
#[derive(Debug)]
pub struct Contact<'a> {
    bridge: &'a Bridge,
    data: ContactData,
}

impl<'a> Contact<'a> {
    pub fn new(bridge: &'a Bridge, data: ContactData) -> Self {
        Contact { bridge, data }
    }

    pub fn data(&self) -> &ContactData {
        &self.data
    }

    pub fn id(&self) -> &str {
        &self.data.id
    }

    pub fn rid(&self) -> ResourceIdentifier {
        self.data.rid()
    }

    pub async fn send(
        &self,
        commands: &[BasicCommand],
    ) -> Result<Vec<ResourceIdentifier>, HueAPIError> {
        let payload = merge_commands(commands);
        self.bridge.api.put_contact(self.id(), &payload).await
    }
}

/// Internal representation of a [Contact].
#[derive(Clone, Debug, Deserialize)]
pub struct ContactData {
    /// Unique identifier representing a specific resource instance.
    pub id: String,
    /// Clip v1 resource identifier.
    pub id_v1: Option<String>,
    /// Owner of the service, in case the owner service is deleted, the service also gets deleted.
    pub owner: ResourceIdentifier,
    /// Whether sensor is activated or not.
    pub enabled: bool,
    pub contact_report: Option<ContactReport>,
}

impl ContactData {
    pub fn rid(&self) -> ResourceIdentifier {
        ResourceIdentifier {
            rid: self.id.to_owned(),
            rtype: ResourceType::Contact,
        }
    }
}

#[derive(Clone, Debug, Deserialize)]
pub struct ContactReport {
    /// Last time the value of this property was updated.
    pub changed: String,
    pub state: ContactStatus,
}

#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum ContactStatus {
    Contact,
    NoContact,
}

/// A motion detection senseor device.
#[derive(Debug)]
pub struct Motion<'a> {
    bridge: &'a Bridge,
    data: MotionData,
}

impl<'a> Motion<'a> {
    pub fn new(bridge: &'a Bridge, data: MotionData) -> Self {
        Motion { bridge, data }
    }

    pub fn data(&self) -> &MotionData {
        &self.data
    }

    pub fn id(&self) -> &str {
        &self.data.id
    }

    pub fn rid(&self) -> ResourceIdentifier {
        ResourceIdentifier {
            rid: self.id().to_owned(),
            rtype: ResourceType::Motion,
        }
    }

    pub async fn send(
        &self,
        commands: &[MotionCommand],
    ) -> Result<Vec<ResourceIdentifier>, HueAPIError> {
        let payload = merge_commands(commands);
        self.bridge.api.put_motion(self.id(), &payload).await
    }
}

#[derive(Debug)]
pub struct CameraMotion<'a> {
    bridge: &'a Bridge,
    data: MotionData,
}

/// A camera device with motion detection capability.
impl<'a> CameraMotion<'a> {
    pub fn new(bridge: &'a Bridge, data: MotionData) -> Self {
        CameraMotion { bridge, data }
    }

    pub fn data(&self) -> &MotionData {
        &self.data
    }

    pub fn id(&self) -> &str {
        &self.data.id
    }

    pub fn rid(&self) -> ResourceIdentifier {
        ResourceIdentifier {
            rid: self.id().to_owned(),
            rtype: ResourceType::CameraMotion,
        }
    }

    pub async fn send(
        &self,
        commands: &[MotionCommand],
    ) -> Result<Vec<ResourceIdentifier>, HueAPIError> {
        let payload = merge_commands(commands);
        self.bridge.api.put_camera_motion(self.id(), &payload).await
    }
}

/// Internal representation of a [Motion] or [CameraMotion].
#[derive(Clone, Debug, Deserialize)]
pub struct MotionData {
    /// Unique identifier representing a specific resource instance.
    pub id: String,
    /// Clip v1 resource identifier.
    pub id_v1: Option<String>,
    /// Owner of the service, in case the owner service is deleted, the service also gets deleted.
    pub owner: ResourceIdentifier,
    /// Whether sensor is activated or not.
    pub enabled: bool,
    pub motion: MotionState,
    pub sensitivity: Option<Sensitivity>,
}

#[derive(Clone, Debug, Deserialize)]
pub struct MotionState {
    /// Motion is valid when `motion_report` property is present, invalid when absent.
    #[deprecated]
    pub motion_valid: bool,
    pub motion_report: Option<MotionReport>,
}

#[derive(Clone, Debug, Deserialize)]
pub struct MotionReport {
    /// Last time the value of this property is changed.
    pub changed: String,
    /// `true` if motion is detected/
    pub motion: bool,
}

#[derive(Clone, Debug, Deserialize)]
pub struct Sensitivity {
    pub status: SetStatus,
    /// Sensitivity of the sensor. Value in the range `0` to `sensitivity_max`.
    pub sensitivity: usize,
    /// Maximum value of the sensitivity configuration attribute.
    pub sensitivity_max: Option<usize>,
}

/// A temperature sensor device.
#[derive(Debug)]
pub struct Temperature<'a> {
    bridge: &'a Bridge,
    data: TemperatureData,
}

impl<'a> Temperature<'a> {
    pub fn new(bridge: &'a Bridge, data: TemperatureData) -> Self {
        Temperature { bridge, data }
    }

    pub fn data(&self) -> &TemperatureData {
        &self.data
    }

    pub fn id(&self) -> &str {
        &self.data.id
    }

    pub fn rid(&self) -> ResourceIdentifier {
        self.data.rid()
    }

    pub async fn send(
        &self,
        commands: &[BasicCommand],
    ) -> Result<Vec<ResourceIdentifier>, HueAPIError> {
        let payload = merge_commands(commands);
        self.bridge.api.put_temperature(self.id(), &payload).await
    }
}

/// Internal representation of a [Temperature].
#[derive(Clone, Debug, Deserialize)]
pub struct TemperatureData {
    /// Unique identifier representing a specific resource instance.
    pub id: String,
    /// Clip v1 resource identifier.
    pub id_v1: Option<String>,
    /// Owner of the service, in case the owner service is deleted, the service also gets deleted.
    pub owner: ResourceIdentifier,
    /// Whether sensor is activated or not.
    pub enabled: bool,
    pub temperature: TemperatureState,
}

impl TemperatureData {
    pub fn rid(&self) -> ResourceIdentifier {
        ResourceIdentifier {
            rid: self.id.to_owned(),
            rtype: ResourceType::Temperature,
        }
    }
}

#[derive(Clone, Debug, Deserialize)]
pub struct TemperatureState {
    #[deprecated]
    pub temperature: f32,
    #[deprecated]
    pub temperature_valid: bool,
    pub temperature_report: Option<TemperatureReport>,
}

#[derive(Clone, Debug, Deserialize)]
pub struct TemperatureReport {
    /// Last time the value of this property is changed.
    pub changed: String,
    pub temperature: f32,
}

/// A light level detection device.
#[derive(Debug)]
pub struct LightLevel<'a> {
    bridge: &'a Bridge,
    data: LightLevelData,
}

impl<'a> LightLevel<'a> {
    pub fn new(bridge: &'a Bridge, data: LightLevelData) -> Self {
        LightLevel { bridge, data }
    }

    pub fn data(&self) -> &LightLevelData {
        &self.data
    }

    pub fn id(&self) -> &str {
        &self.data.id
    }

    pub fn rid(&self) -> ResourceIdentifier {
        self.data.rid()
    }

    pub async fn send(
        &self,
        commands: &[BasicCommand],
    ) -> Result<Vec<ResourceIdentifier>, HueAPIError> {
        let payload = merge_commands(commands);
        self.bridge.api.put_light_level(self.id(), &payload).await
    }
}

/// Internal representation of a [LightLevel].
#[derive(Clone, Debug, Deserialize)]
pub struct LightLevelData {
    /// Unique identifier representing a specific resource instance.
    pub id: String,
    /// Clip v1 resource identifier.
    pub id_v1: Option<String>,
    /// Owner of the service, in case the owner service is deleted, the service also gets deleted.
    pub owner: ResourceIdentifier,
    /// Whether sensor is activated or not.
    pub enabled: bool,
    pub light: LightLevelState,
}

impl LightLevelData {
    pub fn rid(&self) -> ResourceIdentifier {
        ResourceIdentifier {
            rid: self.id.to_owned(),
            rtype: ResourceType::LightLevel,
        }
    }
}

#[derive(Clone, Debug, Deserialize)]
pub struct LightLevelState {
    #[deprecated]
    pub light_level: usize,
    #[deprecated]
    pub light_level_valid: bool,
    pub light_level_report: Option<LightLevelReport>,
}

#[derive(Clone, Debug, Deserialize)]
pub struct LightLevelReport {
    /// Last time the value of this property is changed.
    pub changed: String,
    /// Light level in `10000*log10(lux) + 1` measured by sensor.
    /// Logarithmic scale used because the human eye adjusts to light levels and small changes at
    /// low lux levels are more noticeable than at high lux levels.
    /// This allows use of linear scale configuration sliders.
    pub light_level: usize,
}

/// A virtual device representing the location of the Hue Bridge.
#[derive(Debug)]
pub struct Geolocation<'a> {
    bridge: &'a Bridge,
    data: GeolocationData,
}

impl<'a> Geolocation<'a> {
    pub fn new(bridge: &'a Bridge, data: GeolocationData) -> Self {
        Geolocation { bridge, data }
    }

    pub fn data(&self) -> &GeolocationData {
        &self.data
    }

    pub fn id(&self) -> &str {
        &self.data.id
    }

    pub fn rid(&self) -> ResourceIdentifier {
        self.data.rid()
    }

    pub async fn send(
        &self,
        commands: &[GeolocationCommand],
    ) -> Result<Vec<ResourceIdentifier>, HueAPIError> {
        let payload = merge_commands(commands);
        self.bridge.api.put_geolocation(self.id(), &payload).await
    }
}

/// Internal representation of the device [Geolocation].
#[derive(Clone, Debug, Deserialize)]
pub struct GeolocationData {
    /// Unique identifier representing a specific resource instance.
    pub id: String,
    /// Clip v1 resource identifier.
    pub id_v1: Option<String>,
    /// Is the geolocation configured.
    pub is_configured: bool,
    /// Info related to today's sun (only available when geolocation has been configured).
    pub sun_today: Option<SunToday>,
}

impl GeolocationData {
    pub fn rid(&self) -> ResourceIdentifier {
        ResourceIdentifier {
            rid: self.id.to_owned(),
            rtype: ResourceType::Geolocation,
        }
    }
}

#[derive(Clone, Debug, Deserialize)]
pub struct SunToday {
    pub sunset_time: String,
    pub day_type: DayType,
}

#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum DayType {
    NormalDay,
    PolarDay,
    PolarNight,
    #[serde(other)]
    Unknown,
}

/// A virtual device representing a location-based trigger.
#[derive(Debug)]
pub struct GeofenceClient<'a> {
    bridge: &'a Bridge,
    data: GeofenceClientData,
}

impl<'a> GeofenceClient<'a> {
    pub fn new(bridge: &'a Bridge, data: GeofenceClientData) -> Self {
        GeofenceClient { bridge, data }
    }

    pub fn data(&self) -> &GeofenceClientData {
        &self.data
    }

    pub fn id(&self) -> &str {
        &self.data.id
    }

    pub fn rid(&self) -> ResourceIdentifier {
        self.data.rid()
    }

    pub fn builder(name: impl Into<String>) -> GeofenceClientBuilder {
        GeofenceClientBuilder::new(name)
    }

    pub async fn send(
        &self,
        commands: &[GeofenceClientCommand],
    ) -> Result<Vec<ResourceIdentifier>, HueAPIError> {
        let payload = merge_commands(commands);
        self.bridge
            .api
            .put_geofence_client(self.id(), &payload)
            .await
    }
}

/// Internal representation of a [GeofenceClient].
#[derive(Clone, Debug, Deserialize)]
pub struct GeofenceClientData {
    /// Unique identifier representing a specific resource instance.
    pub id: String,
    /// Clip v1 resource identifier.
    pub id_v1: Option<String>,
    pub name: String,
}

impl GeofenceClientData {
    pub fn rid(&self) -> ResourceIdentifier {
        ResourceIdentifier {
            rid: self.id.to_owned(),
            rtype: ResourceType::GeofenceClient,
        }
    }
}

#[derive(Serialize)]
pub struct GeofenceClientBuilder {
    is_at_home: bool,
    name: String,
}

impl GeofenceClientBuilder {
    pub fn new(name: impl Into<String>) -> Self {
        GeofenceClientBuilder {
            is_at_home: true,
            name: name.into(),
        }
    }

    pub fn is_at_home(mut self, b: bool) -> Self {
        self.is_at_home = b;
        self
    }
}

/// A tamper detection device.
#[derive(Debug)]
pub struct Tamper {
    data: TamperData,
}

impl Tamper {
    pub fn new(data: TamperData) -> Self {
        Tamper { data }
    }

    pub fn data(&self) -> &TamperData {
        &self.data
    }

    pub fn id(&self) -> &str {
        &self.data.id
    }

    pub fn rid(&self) -> ResourceIdentifier {
        self.data.rid()
    }
}

/// Internal representation of a [Tamper].
#[derive(Clone, Debug, Deserialize)]
pub struct TamperData {
    /// Unique identifier representing a specific resource instance.
    pub id: String,
    /// Clip v1 resource identifier.
    pub id_v1: Option<String>,
    /// Owner of the service, in case the owner service is deleted, the service also gets deleted.
    pub owner: ResourceIdentifier,
    pub tamper_reports: Vec<TamperReport>,
}

impl TamperData {
    pub fn rid(&self) -> ResourceIdentifier {
        ResourceIdentifier {
            rid: self.id.to_owned(),
            rtype: ResourceType::Tamper,
        }
    }
}

#[derive(Clone, Debug, Deserialize)]
pub struct TamperReport {
    /// Last time the value of this property is changed.
    pub changed: String,
    /// Source of tamper and time expired since last change of tamper-state.
    pub source: String,
    /// The state of tamper after last change.
    pub state: TamperStatus,
}

#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum TamperStatus {
    Tampered,
    NotTampered,
}