Merge pull request #13 from chrivers/chrivers/group-filters

Add support for group_filter option on z2m server blocks

Author: chrivers

doc/config-reference.md

@@ -57,6 +57,16 @@ z2m:
     url: ws://10.00.0.100:8080
   other-server:
     url: ws://10.10.0.102:8080
+
+    # Group prefix [optional!]
+    #
+    # If you specify this parameter, *only* groups with this prefix
+    # will be visible from this z2m server. The prefix will be removed.
+    #
+    # So with a group_prefix of "bifrost_", the group "bifrost_kitchen"
+    # will be available as "kitchen", but the group "living_room" will
+    # be hidden instead.
+    group_prefix: bifrost_
   ...
 
 # Rooms section [optional!]

src/config.rs

@@ -34,6 +34,7 @@ pub struct Z2mConfig {
 #[derive(Clone, Debug, Serialize, Deserialize)]
 pub struct Z2mServer {
     pub url: String,
+    pub group_prefix: Option<String>,
 }
 
 #[derive(Clone, Debug, Serialize, Deserialize, Default)]

src/main.rs

@@ -85,7 +85,7 @@ async fn build_tasks(appstate: AppState) -> ApiResult<JoinSet<ApiResult<()>>> {
     for (name, server) in &appstate.config().z2m.servers {
         let client = z2m::Client::new(
             name.clone(),
-            server.url.clone(),
+            server.clone(),
             appstate.config(),
             appstate.res.clone(),
         )?;

src/z2m/mod.rs

@@ -16,7 +16,7 @@ use tokio::time::sleep;
 use tokio_tungstenite::{connect_async, tungstenite, MaybeTlsStream, WebSocketStream};
 use uuid::Uuid;
 
-use crate::config::AppConfig;
+use crate::config::{AppConfig, Z2mServer};
 use crate::hue;
 use crate::hue::api::{
     Button, ButtonData, ButtonMetadata, ButtonReport, ColorTemperature, ColorTemperatureUpdate,
@@ -43,7 +43,7 @@ struct LearnScene {
 
 pub struct Client {
     name: String,
-    conn: String,
+    server: Z2mServer,
     config: Arc<AppConfig>,
     state: Arc<Mutex<Resources>>,
     map: HashMap<String, Uuid>,
@@ -55,7 +55,7 @@ pub struct Client {
 impl Client {
     pub fn new(
         name: String,
-        conn: String,
+        server: Z2mServer,
         config: Arc<AppConfig>,
         state: Arc<Mutex<Resources>>,
     ) -> ApiResult<Self> {
@@ -65,7 +65,7 @@ impl Client {
         let ignore = HashSet::new();
         Ok(Self {
             name,
-            conn,
+            server,
             config,
             state,
             map,
@@ -163,6 +163,23 @@ impl Client {
     }
 
     pub async fn add_group(&mut self, grp: &crate::z2m::api::Group) -> ApiResult<()> {
+        let room_name;
+
+        if let Some(ref prefix) = self.server.group_prefix {
+            if !grp.friendly_name.starts_with(prefix) {
+                log::debug!(
+                    "[{}] Ignoring room outside our prefix: {}",
+                    self.name,
+                    grp.friendly_name
+                );
+                return Ok(());
+            } else {
+                room_name = grp.friendly_name.strip_prefix(prefix).unwrap()
+            }
+        } else {
+            room_name = &grp.friendly_name;
+        }
+
         let link_room = RType::Room.deterministic(&grp.friendly_name);
         let link_glight = RType::GroupedLight.deterministic((link_room.rid, grp.id));
 
@@ -234,7 +251,7 @@ impl Client {
             log::debug!("[{}] {link_room:?} is new, adding..", self.name);
         }
 
-        let mut metadata = RoomMetadata::new(RoomArchetype::Home, &topic);
+        let mut metadata = RoomMetadata::new(RoomArchetype::Home, room_name);
         if let Some(room_conf) = self.config.rooms.get(&topic) {
             if let Some(name) = &room_conf.name {
                 metadata.name = name.to_string();
@@ -623,8 +640,8 @@ impl Client {
     pub async fn run_forever(mut self) -> ApiResult<()> {
         let mut chan = self.state.lock().await.z2m_channel();
         loop {
-            log::info!("[{}] Connecting to {}", self.name, self.conn);
-            match connect_async(&self.conn).await {
+            log::info!("[{}] Connecting to {}", self.name, self.server.url);
+            match connect_async(&self.server.url).await {
                 Ok((socket, _)) => {
                     let res = self.event_loop(&mut chan, socket).await;
                     log::error!("[{}] Event loop broke: {res:?}", self.name);