Matter

Author: donavanbecker

CHANGELOG.md

@@ -1,28 +1,18 @@
-## [3.0.2](https://github.com/homebridge-plugins/homebridge-lutron-caseta-leap/compare/v3.0.1...v3.0.2) (2026-04-24)
-
-
-### Bug Fixes
-
-* This accessory will not be registered. ([fb3c249](https://github.com/homebridge-plugins/homebridge-lutron-caseta-leap/commit/fb3c2492cdcb30b2abe58aa9368be7e410d396c2))
-
-
-
-
 # Changelog
 
 All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [3.0.3](https://github.com/homebridge-plugins/homebridge-lutron-caseta-leap/releases/tag/v3.0.3) (2026-04-23)
 
 ### What's Changed
-* fix: This accessory will not be registered.
+* fix: This accessory will not be registered. 
 
 **Full Changelog**: https://github.com/homebridge-plugins/homebridge-lutron-caseta-leap/compare/v3.0.2...v3.0.3
 
 ## [3.0.2](https://github.com/homebridge-plugins/homebridge-lutron-caseta-leap/releases/tag/v3.0.2) (2026-04-23)
 
 ### What's Changed
-* fix: This accessory will not be registered.
+* fix: This accessory will not be registered. ([fb3c249](https://github.com/homebridge-plugins/homebridge-lutron-caseta-leap/commit/fb3c2492cdcb30b2abe58aa9368be7e410d396c2))
 
 **Full Changelog**: https://github.com/homebridge-plugins/homebridge-lutron-caseta-leap/compare/v3.0.1...v3.0.2
 

package-lock.json

@@ -65,4 +65,4 @@
     "typescript": "^6.0.2",
     "vitest": "^4.1.4"
   }
-}
+}

package.json

@@ -75,9 +75,9 @@ export class ButtonTracker {
     private longPressCB: () => void,
     private log: Logging,
     private href: string,
-        clickSpeedDouble = 'default',
-        clickSpeedLong = 'default',
-        isUpDownButton = false,
+    clickSpeedDouble = 'default',
+    clickSpeedLong = 'default',
+    isUpDownButton = false,
   ) {
     log.debug(`btrk ${this.href} created speed ${clickSpeedDouble} dbl ${clickSpeedLong} long`)
 

src/ButtonState.ts

@@ -1,10 +1,18 @@
+// Type for Matter-required fields
 // Matter device type IDs (see CSA Device Library)
 import type { API, Logging, PlatformAccessory, PlatformConfig } from 'homebridge'
 import type { DeviceDefinition, SmartBridge } from 'lutron-leap'
 
 import { DeviceWireResultType, LutronCasetaLeap } from './platform.js'
 import { PLATFORM_NAME, PLUGIN_NAME } from './settings.js'
 
+interface MatterAccessoryFields {
+  deviceType: number[]
+  manufacturer: string
+  model: string
+  serialNumber: string
+}
+
 enum MatterDeviceType {
   RemoteControl = 0x0016,
   // Add more as needed
@@ -76,17 +84,92 @@ export class LutronCasetaLeapMatterPlatform extends LutronCasetaLeap {
     const result = await this.wireAccessory(accessory, bridge, d)
     accessory.displayName = fullName
 
-    // Set required Matter deviceType before registration, using types
-    let deviceType: MatterDeviceType | undefined
+    // Set all required Matter fields before registration
+    let matterFields: MatterAccessoryFields | undefined
     if (typeof d.DeviceType === 'string' && d.DeviceType.toLowerCase().includes('pico')) {
-      deviceType = MatterDeviceType.RemoteControl
+      matterFields = {
+        deviceType: [MatterDeviceType.RemoteControl],
+        manufacturer: 'Lutron Electronics',
+        model: (d.ModelNumber || d.DeviceType || 'Pico Remote').toString(),
+        serialNumber: d.SerialNumber?.toString() || uuid,
+      }
+      // Use PicoRemote to generate clusters and wire up Matter event emission
+      const PicoRemote = (await import('./PicoRemote.js')).PicoRemote
+      // Pass mApi and accessory for event emission
+      const pico = new PicoRemote(this, accessory, bridge, {} as any, mApi)
+      const clusters = pico.getMatterClusters()
+      // Deeply remove accidental 'behaviors' property from clusters, accessory, and context, handling circular refs
+      function deepDeleteBehaviors(obj: any, seen = new WeakSet()) {
+        if (!obj || typeof obj !== 'object' || seen.has(obj)) {
+          return
+        }
+        seen.add(obj)
+        if ('behaviors' in obj) {
+          delete obj.behaviors
+        }
+        for (const key of Object.keys(obj)) {
+          if (typeof obj[key] === 'object' && obj[key] !== null) {
+            deepDeleteBehaviors(obj[key], seen)
+          }
+        }
+      }
+      deepDeleteBehaviors(clusters);
+      (accessory as any).clusters = clusters
+      accessory.context.clusters = clusters
+      deepDeleteBehaviors(accessory)
+      deepDeleteBehaviors(accessory.context)
+
+      // Homebridge Matter API does not support setClusterHandler; only set clusters on accessory/context
+      // Debug: log the final objects before registration to check for lingering 'behaviors'
+      function safeStringify(obj: any, depth = 4) {
+        const seen = new WeakSet()
+        function isTimerObject(o: any) {
+          if (!o || typeof o !== 'object') return false
+          const ctor = o.constructor && o.constructor.name
+          return ctor === 'Timeout' || ctor === 'TimersList'
+        }
+        function _stringify(o: any, d: number): any {
+          if (d < 0 || o === null) return o
+          if (typeof o !== 'object') return o
+          if (seen.has(o)) return '[Circular]'
+          if (isTimerObject(o)) return `[${o.constructor.name}]`
+          seen.add(o)
+          if (Array.isArray(o)) return o.map(v => _stringify(v, d - 1))
+          const out: Record<string, any> = {}
+          for (const k of Object.keys(o)) {
+            if (k === 'log' || k === 'platform' || k === 'api') continue // skip noisy fields
+            const v = o[k]
+            if (typeof v === 'function') continue
+            if (isTimerObject(v)) {
+              out[k] = `[${v.constructor.name}]`
+              continue
+            }
+            // Only serialize plain objects, arrays, and primitives
+            const ctor = v && v.constructor && v.constructor.name
+            if (v && typeof v === 'object' && ctor !== 'Object' && ctor !== 'Array') {
+              out[k] = `[${ctor}]`
+              continue
+            }
+            out[k] = _stringify(v, d - 1)
+          }
+          return out
+        }
+        try {
+          return JSON.stringify(_stringify(obj, depth), null, 2)
+        } catch (e) {
+          return '[Unserializable object]'
+        }
+      }
+      this.log.warn('[Matter Debug] Accessory before registration:', safeStringify(accessory))
+      this.log.warn('[Matter Debug] Accessory.context before registration:', safeStringify(accessory.context))
+      this.log.warn('[Matter Debug] Clusters before registration:', safeStringify(clusters))
     }
     // Add more device type mappings as needed, using MatterDeviceType enum
 
-    if (deviceType !== undefined) {
+    if (matterFields) {
       // Set on both the accessory and its context for maximum compatibility
-      (accessory as any).deviceType = deviceType
-      accessory.context.deviceType = deviceType
+      Object.assign(accessory, matterFields)
+      Object.assign(accessory.context, matterFields)
     }
 
     switch (result.kind) {

src/LutronCasetaLeapMatterPlatform.ts

@@ -102,13 +102,19 @@ const BUTTON_MAP = new Map<string, Map<number, { label: string, index: number, i
 export class PicoRemote {
   private services: Map<string, Service> = new Map()
   private trackers: Map<string, ButtonTracker> = new Map()
+  // Map button href to ButtonNumber for event lookup
+  private hrefToButtonNumber: Map<string, number> = new Map()
 
+  private matterApi?: any
   constructor(
     private readonly platform: LutronCasetaLeap,
     private readonly accessory: PlatformAccessory,
     private readonly bridge: SmartBridge,
     private readonly options: GlobalOptions,
-  ) { }
+    matterApi?: any,
+  ) {
+    this.matterApi = matterApi
+  }
 
   public async initialize(): Promise<DeviceWireResult> {
     const fullName = this.accessory.context.device.FullyQualifiedName.join(' ')
@@ -125,8 +131,8 @@ export class PicoRemote {
       )
 
     const label_svc
-            = this.accessory.getService(this.platform.api.hap.Service.ServiceLabel)
-              || this.accessory.addService(this.platform.api.hap.Service.ServiceLabel)
+      = this.accessory.getService(this.platform.api.hap.Service.ServiceLabel)
+        || this.accessory.addService(this.platform.api.hap.Service.ServiceLabel)
     label_svc.setCharacteristic(
       this.platform.api.hap.Characteristic.ServiceLabelNamespace,
       this.platform.api.hap.Characteristic.ServiceLabelNamespace.ARABIC_NUMERALS, // ha ha
@@ -187,6 +193,9 @@ export class PicoRemote {
         }
       }
 
+      // Map href to ButtonNumber for event lookup
+      this.hrefToButtonNumber.set(button.href, button.ButtonNumber)
+
       this.platform.log.debug(
         `setting up ${button.href} named ${button.Name} numbered ${button.ButtonNumber} as ${inspect(
           alias,
@@ -196,12 +205,12 @@ export class PicoRemote {
       )
 
       const service
-                = this.accessory.getServiceById(this.platform.api.hap.Service.StatelessProgrammableSwitch, alias.label)
-                  || this.accessory.addService(
-                    this.platform.api.hap.Service.StatelessProgrammableSwitch,
-                    button.Name,
-                    alias.label,
-                  )
+        = this.accessory.getServiceById(this.platform.api.hap.Service.StatelessProgrammableSwitch, alias.label)
+          || this.accessory.addService(
+            this.platform.api.hap.Service.StatelessProgrammableSwitch,
+            button.Name,
+            alias.label,
+          )
       service.addLinkedService(label_svc)
 
       service.setCharacteristic(this.platform.api.hap.Characteristic.Name, alias.label)
@@ -305,11 +314,51 @@ export class PicoRemote {
 
   handleEvent(response: Response): void {
     const evt = (response.Body! as OneButtonStatusEvent).ButtonStatus
+    // Look up ButtonNumber from href
+    const buttonHref = evt.Button.href
+    const buttonNumber = this.hrefToButtonNumber.get(buttonHref)
+    // Emit Matter cluster events for LevelControl and Scenes clusters if present
+    if (this.matterApi && (this.accessory as any).clusters && buttonNumber !== undefined) {
+      const dentry = BUTTON_MAP.get(this.accessory.context.device.DeviceType)
+      if (dentry) {
+        const alias = dentry.get(buttonNumber)
+        if (alias) {
+          // LevelControl: Raise/Lower
+          if (alias.label.toLowerCase() === 'raise') {
+            this.matterApi.emitClusterEvent(this.accessory, 'levelControl', 'raise')
+          } else if (alias.label.toLowerCase() === 'lower') {
+            this.matterApi.emitClusterEvent(this.accessory, 'levelControl', 'lower')
+          }
+          // Scenes: Button 1-4
+          if (alias.label.toLowerCase().startsWith('button ')) {
+            const sceneNum = Number.parseInt(alias.label.split(' ')[1], 10)
+            if (!Number.isNaN(sceneNum)) {
+              this.matterApi.emitClusterEvent(this.accessory, 'scenes', 'recallScene', sceneNum)
+            }
+          }
+        }
+      }
+    }
     const fullName = this.accessory.context.device.FullyQualifiedName.join(' ')
     this.platform.log.info(
       `Button ${evt.Button.href} on Pico remote ${fullName} got action ${evt.ButtonEvent.EventType}`,
     )
     this.trackers.get(evt.Button.href)!.update(evt.ButtonEvent.EventType)
+
+    // Emit Matter cluster event for On/Off cluster if present
+    if (this.matterApi && (this.accessory as any).clusters?.onOff && buttonNumber !== undefined) {
+      const dentry = BUTTON_MAP.get(this.accessory.context.device.DeviceType)
+      if (dentry) {
+        const alias = dentry.get(buttonNumber)
+        if (alias) {
+          if (alias.label.toLowerCase() === 'on') {
+            this.matterApi.emitClusterEvent(this.accessory, 'onOff', 'on')
+          } else if (alias.label.toLowerCase() === 'off') {
+            this.matterApi.emitClusterEvent(this.accessory, 'onOff', 'off')
+          }
+        }
+      }
+    }
   }
 
   handleUnsolicited(response: Response): void {
@@ -321,4 +370,36 @@ export class PicoRemote {
       }
     }
   }
+
+  /**
+   * Returns a Matter clusters object for this Pico remote, based on its button map.
+   */
+  public getMatterClusters(): Record<string, any> {
+    const type = this.accessory.context.device.DeviceType
+    const dentry = BUTTON_MAP.get(type)
+    if (!dentry) {
+      return {}
+    }
+    // Gather all button labels for this remote
+    const buttonLabels = Array.from(dentry.values()).map(v => v.label.toLowerCase())
+    const clusters: Record<string, any> = {}
+    // On/Off cluster for remotes with On/Off buttons
+    if (buttonLabels.includes('on') && buttonLabels.includes('off')) {
+      clusters.onOff = { onOff: false }
+    }
+    // LevelControl cluster for Raise/Lower
+    if (buttonLabels.includes('raise') && buttonLabels.includes('lower')) {
+      clusters.levelControl = { currentLevel: 0, minLevel: 0, maxLevel: 254 }
+    }
+    // Scenes cluster for 4-button scene/zone remotes
+    if (type.includes('4ButtonScene') || type.includes('4ButtonZone')) {
+      clusters.scenes = { sceneCount: 4 }
+    }
+    // 4Button2Group: treat as two on/off pairs
+    if (type.includes('4Button2Group')) {
+      clusters.onOff = { onOff: false }
+      clusters.onOff2 = { onOff: false }
+    }
+    return clusters
+  }
 }