Merge pull request #135 from chrivers/chrivers/apiv1-entertainment-mode

Implement complete support for entertainment zones ("sync mode") for the v1 api, including the obsolete (but apparently still used) streaming v1 api!

This fixes support for at least the following:
 - Philips Ambilight TVs (..ironically)
 - The iLightShow app for streaming blinkenlights

This change also improves logging and error handling related to sync streaming.

Author: chrivers

crates/bifrost-api/src/backend.rs

@@ -2,7 +2,7 @@ use serde::{Deserialize, Serialize};
 use uuid::Uuid;
 
 use hue::api::{GroupedLightUpdate, LightUpdate, ResourceLink, RoomUpdate, Scene, SceneUpdate};
-use hue::stream::HueStreamLights;
+use hue::stream::HueStreamLightsV2;
 
 use crate::Client;
 use crate::config::Z2mServer;
@@ -23,7 +23,7 @@ pub enum BackendRequest {
     Delete(ResourceLink),
 
     EntertainmentStart(Uuid),
-    EntertainmentFrame(HueStreamLights),
+    EntertainmentFrame(HueStreamLightsV2),
     EntertainmentStop(),
 }
 

crates/hue/src/api/device.rs

@@ -30,9 +30,19 @@ pub struct DeviceUpdate {
 }
 
 impl Device {
+    #[must_use]
+    pub fn service(&self, rtype: RType) -> Option<&ResourceLink> {
+        self.services.iter().find(|rl| rl.rtype == rtype)
+    }
+
     #[must_use]
     pub fn light_service(&self) -> Option<&ResourceLink> {
-        self.services.iter().find(|rl| rl.rtype == RType::Light)
+        self.service(RType::Light)
+    }
+
+    #[must_use]
+    pub fn entertainment_service(&self) -> Option<&ResourceLink> {
+        self.service(RType::Entertainment)
     }
 }
 

crates/hue/src/api/entertainment_config.rs

@@ -104,7 +104,7 @@ pub enum EntertainmentConfigurationType {
     Other,
 }
 
-#[derive(Debug, Serialize, Deserialize, Clone)]
+#[derive(Debug, Serialize, Deserialize, Clone, Default)]
 pub struct EntertainmentConfigurationUpdate {
     pub configuration_type: Option<EntertainmentConfigurationType>,
     pub metadata: Option<EntertainmentConfigurationMetadata>,
@@ -113,6 +113,13 @@ pub struct EntertainmentConfigurationUpdate {
     pub locations: Option<EntertainmentConfigurationLocationsUpdate>,
 }
 
+impl EntertainmentConfigurationUpdate {
+    #[must_use]
+    pub fn new() -> Self {
+        Self::default()
+    }
+}
+
 #[derive(Debug, Serialize, Deserialize, Clone)]
 #[serde(deny_unknown_fields)]
 pub struct EntertainmentConfigurationNew {
@@ -196,6 +203,18 @@ impl From<EntertainmentConfigurationServiceLocationsNew>
     }
 }
 
+impl From<EntertainmentConfigurationLocationsNew> for EntertainmentConfigurationLocationsUpdate {
+    fn from(value: EntertainmentConfigurationLocationsNew) -> Self {
+        Self {
+            service_locations: value
+                .service_locations
+                .into_iter()
+                .map(Into::into)
+                .collect(),
+        }
+    }
+}
+
 #[derive(Debug, Serialize, Deserialize, Clone)]
 pub struct EntertainmentConfigurationServiceLocationsUpdate {
     pub equalization_factor: Option<f64>,

crates/hue/src/legacy_api.rs

@@ -122,19 +122,14 @@ pub struct NewUserReply {
 }
 
 #[allow(non_camel_case_types)]
-#[derive(Debug, Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize, Default)]
 #[serde(rename_all = "lowercase")]
 pub enum ConnectionState {
     Connected,
+    #[default]
     Disconnected,
 }
 
-impl Default for ConnectionState {
-    fn default() -> Self {
-        Self::Disconnected
-    }
-}
-
 #[derive(Debug, Serialize, Deserialize)]
 pub struct ApiInternetServices {
     pub internet: ConnectionState,
@@ -301,15 +296,16 @@ pub struct ApiGroupAction {
     pub colormode: Option<LightColorMode>,
 }
 
-#[derive(Debug, Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize, Default, PartialEq, Eq)]
 pub enum ApiGroupType {
     Entertainment,
+    #[default]
     LightGroup,
     Room,
     Zone,
 }
 
-#[derive(Debug, Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize, Default, PartialEq, Eq)]
 pub enum ApiGroupClass {
     #[serde(rename = "Living room")]
     LivingRoom,
@@ -332,6 +328,7 @@ pub enum ApiGroupClass {
     Garden,
     Driveway,
     Carport,
+    #[default]
     Other,
 
     Home,
@@ -380,6 +377,16 @@ pub struct ApiGroup {
     pub locations: Value,
 }
 
+#[derive(Debug, Serialize, Deserialize)]
+pub struct ApiGroupNew {
+    pub name: Option<String>,
+    #[serde(default, rename = "type")]
+    pub group_type: ApiGroupType,
+    #[serde(default)]
+    pub class: ApiGroupClass,
+    pub lights: Vec<String>,
+}
+
 impl ApiGroup {
     #[must_use]
     pub fn make_group_0() -> Self {
@@ -388,7 +395,7 @@ impl ApiGroup {
             lights: vec![],
             action: ApiGroupAction::default(),
             group_type: ApiGroupType::LightGroup,
-            class: ApiGroupClass::Other,
+            class: ApiGroupClass::default(),
             recycle: false,
             sensors: vec![],
             state: ApiGroupState::default(),
@@ -418,7 +425,7 @@ impl ApiGroup {
                 alert: ApiAlert::None,
                 colormode: None,
             },
-            class: ApiGroupClass::Other,
+            class: ApiGroupClass::default(),
             group_type: ApiGroupType::Room,
             recycle: false,
             sensors: vec![],
@@ -427,31 +434,6 @@ impl ApiGroup {
             locations: Value::Null,
         }
     }
-
-    #[allow(clippy::cast_possible_truncation, clippy::cast_sign_loss)]
-    #[must_use]
-    pub fn from_entertainment_configuration(ent: &api::EntertainmentConfiguration) -> Self {
-        Self {
-            name: ent.metadata.name.clone(),
-            // FIXME: obviously don't hard-code light numbers here
-            lights: vec!["9".into()],
-            locations: json!({
-                "9": [0, 0.8, 0],
-            }),
-            action: ApiGroupAction::default(),
-            class: ApiGroupClass::Other,
-            group_type: ApiGroupType::Entertainment,
-            recycle: false,
-            sensors: vec![],
-            state: ApiGroupState::default(),
-            stream: json!({
-                "active": false,
-                "owner": Value::Null,
-                "proxymode": "auto",
-                "proxynode": "/bridge"
-            }),
-        }
-    }
 }
 
 #[derive(Debug, Serialize, Deserialize, Default)]
@@ -509,14 +491,16 @@ pub struct ApiGroupUpdate {
     pub scene: String,
 }
 
-#[derive(Debug, Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize, Clone, Copy)]
 pub struct Active {
     pub active: bool,
 }
 
 #[derive(Debug, Serialize, Deserialize)]
 pub struct ApiGroupUpdate2 {
-    pub stream: Active,
+    pub lights: Option<Vec<String>>,
+    pub name: Option<String>,
+    pub stream: Option<Active>,
 }
 
 #[derive(Debug, Serialize, Deserialize)]