Merge pull request #107 from chrivers/chrivers/z2m-crate-refactor

Refactor code to move all z2m-related code entirely into the z2m crate (`crates/z2m/`)

This improves rebuild times, and makes it easier to reuse parts of the Bifrost code in other projects.

Author: chrivers

Cargo.lock

@@ -37,6 +37,7 @@ keywords = [
 members = [
     "crates/hue",
     "crates/svc",
+    "crates/z2m",
     "crates/zcl",
 ]
 
@@ -139,6 +140,7 @@ tokio-openssl = "0.6.5"
 udp-stream = "0.0.12"
 maplit = "1.0.2"
 svc = { version = "0.1.0", path = "crates/svc" }
+z2m = { version = "0.1.0", path = "crates/z2m" }
 
 [dev-dependencies]
 clap-stdin = "0.6.0"

Cargo.toml

@@ -485,12 +485,39 @@ pub struct LightEffects {
     pub effect_values: Vec<LightEffect>,
 }
 
+impl LightEffects {
+    #[must_use]
+    pub fn all() -> Self {
+        Self {
+            status_values: Vec::from(LightEffect::ALL),
+            status: LightEffect::NoEffect,
+            effect_values: Vec::from(LightEffect::ALL),
+        }
+    }
+}
+
 #[derive(Debug, Serialize, Deserialize, Clone)]
 pub struct LightEffectsV2 {
     pub action: LightEffectValues,
     pub status: LightEffectStatus,
 }
 
+impl LightEffectsV2 {
+    #[must_use]
+    pub fn all() -> Self {
+        Self {
+            action: LightEffectValues {
+                effect_values: Vec::from(LightEffect::ALL),
+            },
+            status: LightEffectStatus {
+                effect: LightEffect::NoEffect,
+                effect_values: Vec::from(LightEffect::ALL),
+                parameters: None,
+            },
+        }
+    }
+}
+
 #[derive(Debug, Serialize, Deserialize, Clone)]
 pub struct LightEffectsV2Update {
     #[serde(default)]

crates/hue/src/api/light.rs

@@ -0,0 +1,22 @@
+[package]
+name = "z2m"
+version = "0.1.0"
+
+edition.workspace = true
+authors.workspace = true
+rust-version.workspace = true
+description.workspace = true
+readme.workspace = true
+repository.workspace = true
+license.workspace = true
+categories.workspace = true
+keywords.workspace = true
+
+[lints]
+workspace = true
+
+[dependencies]
+hue = { version = "0.1.0", path = "../hue" }
+serde = "1.0.219"
+serde_json = "1.0.140"
+thiserror = "2.0.12"

crates/z2m/Cargo.toml

@@ -178,7 +178,7 @@ pub struct Config {
     pub external_converters: Vec<Option<Value>>,
     pub frontend: Value,
     pub groups: HashMap<String, GroupValue>,
-    #[serde(with = "crate::z2m::serde_util::struct_or_false")]
+    #[serde(with = "crate::serde_util::struct_or_false")]
     pub homeassistant: Option<ConfigHomeassistant>,
     pub map_options: Value,
     pub mqtt: Value,

src/z2m/api.rs crates/z2m/src/api.rs

@@ -7,7 +7,7 @@ use hue::api::{
 use hue::devicedb::{hardware_platform_type, product_archetype};
 use hue::xy::XY;
 
-use crate::z2m::api::{Device, Expose, ExposeList, ExposeNumeric};
+use crate::api::{Device, Expose, ExposeList, ExposeNumeric};
 
 pub trait ExtractExposeNumeric {
     fn extract_mirek_schema(&self) -> Option<MirekSchema>;

src/z2m/convert.rs crates/z2m/src/convert.rs

@@ -0,0 +1,25 @@
+use thiserror::Error;
+
+#[derive(Error, Debug)]
+pub enum Z2mError {
+    /* mapped errors */
+    #[error(transparent)]
+    FromUtf8Error(#[from] std::string::FromUtf8Error),
+
+    #[error(transparent)]
+    ParseIntError(#[from] std::num::ParseIntError),
+
+    #[error(transparent)]
+    IOError(#[from] std::io::Error),
+
+    #[error(transparent)]
+    SerdeJson(#[from] serde_json::Error),
+
+    #[error(transparent)]
+    HueError(#[from] hue::error::HueError),
+
+    #[error("Invalid hex color")]
+    InvalidHexColor,
+}
+
+pub type Z2mResult<T> = Result<T, Z2mError>;

crates/z2m/src/error.rs

@@ -4,7 +4,7 @@ use serde::{Deserialize, Serialize};
 
 use hue::xy::XY;
 
-use crate::error::ApiError;
+use crate::error::Z2mError;
 
 #[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq, Eq)]
 #[serde(into = "String", try_from = "&str")]
@@ -45,11 +45,11 @@ impl Display for HexColor {
 }
 
 impl TryFrom<&str> for HexColor {
-    type Error = ApiError;
+    type Error = Z2mError;
 
     fn try_from(value: &str) -> Result<Self, Self::Error> {
         if value.len() != 7 || !value.starts_with('#') {
-            return Err(ApiError::InvalidHexColor);
+            return Err(Z2mError::InvalidHexColor);
         }
         let r = u8::from_str_radix(&value[1..3], 16)?;
         let g = u8::from_str_radix(&value[3..5], 16)?;
@@ -60,7 +60,7 @@ impl TryFrom<&str> for HexColor {
 
 #[cfg(test)]
 mod tests {
-    use crate::z2m::hexcolor::HexColor;
+    use crate::hexcolor::HexColor;
 
     #[test]
     fn make_hexcolor() {

src/z2m/hexcolor.rs crates/z2m/src/hexcolor.rs

@@ -1,5 +1,6 @@
 pub mod api;
 pub mod convert;
+pub mod error;
 pub mod hexcolor;
 pub mod request;
 pub mod serde_util;

src/z2m/mod.rs crates/z2m/src/lib.rs

@@ -1,7 +1,7 @@
 use serde::Serialize;
 use serde_json::Value;
 
-use crate::z2m::update::DeviceUpdate;
+use crate::update::DeviceUpdate;
 
 #[derive(Clone, Debug, Serialize)]
 #[serde(rename_all = "snake_case")]

src/z2m/request.rs crates/z2m/src/request.rs

@@ -68,7 +68,7 @@ mod tests {
     use serde::{Deserialize, Serialize};
     use serde_json::{from_str, to_string};
 
-    use crate::error::ApiResult;
+    use crate::error::Z2mResult;
 
     #[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
     struct Foo {
@@ -92,26 +92,26 @@ mod tests {
     const FOO_LIST: &str = r#"{"foo":[42]}"#;
 
     #[test]
-    pub fn serialize_none() -> ApiResult<()> {
+    pub fn serialize_none() -> Z2mResult<()> {
         assert_eq!(to_string(&FOO_NONE)?, FOO_NONE_STR);
         Ok(())
     }
 
     #[test]
-    pub fn serialize_some() -> ApiResult<()> {
+    pub fn serialize_some() -> Z2mResult<()> {
         assert_eq!(to_string(&FOO_SOME)?, FOO_SOME_STR);
 
         Ok(())
     }
 
     #[test]
-    pub fn deserialize_false() -> ApiResult<()> {
+    pub fn deserialize_false() -> Z2mResult<()> {
         assert_eq!(from_str::<Foo>(FOO_NONE_STR)?, FOO_NONE);
         Ok(())
     }
 
     #[test]
-    pub fn deserialize_struct() -> ApiResult<()> {
+    pub fn deserialize_struct() -> Z2mResult<()> {
         assert_eq!(from_str::<Foo>(FOO_SOME_STR)?, FOO_SOME);
         Ok(())
     }

src/z2m/serde_util.rs crates/z2m/src/serde_util.rs

@@ -6,7 +6,7 @@ use serde_json::Value;
 use hue::api::{LightGradientUpdate, On};
 use hue::xy::XY;
 
-use crate::z2m::hexcolor::HexColor;
+use crate::hexcolor::HexColor;
 
 #[allow(clippy::pub_underscore_fields)]
 #[derive(Debug, Serialize, Deserialize, Clone, Default)]

src/z2m/update.rs crates/z2m/src/update.rs

@@ -9,7 +9,7 @@ use tokio::select;
 use tokio_tungstenite::{connect_async, tungstenite::Message};
 
 use bifrost::error::ApiResult;
-use bifrost::z2m::api::RawMessage;
+use z2m::api::RawMessage;
 
 #[macro_use]
 extern crate log;