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

use crate::{
    api::HueAPIError,
    command::{merge_commands, GroupCommand},
    service::{AlertState, Bridge, OnState, ResourceIdentifier, ResourceType, SignalType},
};
use serde::{Deserialize, Serialize};
use std::collections::HashSet;

/// A virtual device consisting of a group of lights.
#[derive(Debug)]
pub struct Group<'a> {
    bridge: &'a Bridge,
    data: GroupData,
}

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

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

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

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

    pub fn is_on(&self) -> bool {
        self.data
            .on
            .as_ref()
            .and_then(|on| Some(on.on))
            .unwrap_or_default()
    }

    pub async fn on(&self) -> Result<Vec<ResourceIdentifier>, HueAPIError> {
        self.send(&[GroupCommand::On(true)]).await
    }

    pub async fn off(&self) -> Result<Vec<ResourceIdentifier>, HueAPIError> {
        self.send(&[GroupCommand::On(false)]).await
    }

    pub async fn toggle(&self) -> Result<Vec<ResourceIdentifier>, HueAPIError> {
        self.send(&[GroupCommand::On(!self.is_on())]).await
    }

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

/// Internal representation of a [Group].
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct GroupData {
    /// Unique identifier representing a specific resource instance.
    pub id: String,
    /// Clip v1 resource identifier.
    pub id_v1: Option<String>,
    pub owner: ResourceIdentifier,
    /// Joined on control & aggregated on state.
    /// `on` is true if any light in the group is on.
    pub on: Option<OnState>,
    /// Joined dimming control.
    /// `brightness` contains average brightness of group containing turned-on lights only.
    pub dimming: Option<GroupDimmingState>,
    /// Joined alert control.
    pub alert: Option<AlertState>,
    pub signaling: Option<GroupSignalingState>,
}

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

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct GroupDimmingState {
    /// Brightness percentage.
    /// Value cannot be `0`, writing `0` changes it to lowest possible brightness.
    pub brightness: f32,
}

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct GroupSignalingState {
    /// Signals that the group supports.
    pub signal_values: Option<HashSet<SignalType>>,
}