@switchbot/homebridge-switchbot 5.0.0-beta.16 → 5.0.0-beta.18

package/src/platform-matter.ts

@@ -7,7 +7,7 @@ import type {
 } from 'homebridge'
 import type { bodyChange, device } from 'node-switchbot'
 
-import type { SwitchBotPlatformConfig } from './settings.js'
+import type { devicesConfig, SwitchBotPlatformConfig } from './settings.js'
 
 import { SwitchBotBLE, SwitchBotOpenAPI } from 'node-switchbot'
 
@@ -174,10 +174,24 @@ export class SwitchBotMatterPlatform implements DynamicPlatformPlugin {
         })()
       }
 
-      // perform device discovery from SwitchBot OpenAPI (if configured)
-      void this.discoverDevices()
+      // perform device discovery from SwitchBot OpenAPI (if configured) and
+      // register Matter accessories after discovery completes. Previously we
+      // called discoverDevices() without awaiting it which caused registration
+      // to run before discovery finished and only example accessories were
+      // created. Use an async IIFE to sequentially await discovery then register.
+      ;(async () => {
+        try {
+          await this.discoverDevices()
+        } catch (e: any) {
+          this.debugLog('Device discovery failed during startup: %s', e?.message ?? e)
+        }
 
-      this.registerMatterAccessories()
+        try {
+          await this.registerMatterAccessories()
+        } catch (e: any) {
+          this.errorLog('Failed to register Matter accessories: %s', e?.message ?? e)
+        }
+      })()
     })
   }
 
@@ -193,10 +207,19 @@ export class SwitchBotMatterPlatform implements DynamicPlatformPlugin {
    * find matching item in a2 (discovered devices) and merge them with user overrides last.
    */
   private mergeByDeviceId(a1: { deviceId: string }[], a2: any[]) {
-    return a1.map((itm) => {
-      const matchingItem = a2.find(item => this.normalizeDeviceId(item.deviceId) === this.normalizeDeviceId(itm.deviceId))
-      return Object.assign({}, matchingItem, itm)
-    })
+    const allowConfigOnly = Boolean(this.config.options?.allowConfigOnlyDevices)
+    const result: any[] = []
+    for (const itm of (a1 || [])) {
+      const matchingItem = (a2 || []).find(item => this.normalizeDeviceId(item.deviceId) === this.normalizeDeviceId(itm.deviceId))
+      if (matchingItem) {
+        result.push(Object.assign({}, matchingItem, itm))
+      } else if (allowConfigOnly) {
+        // include config-only device as-is when explicitly allowed
+        result.push(Object.assign({}, itm))
+      }
+      // otherwise skip config-only entries
+    }
+    return result
   }
 
   /**
@@ -225,7 +248,8 @@ export class SwitchBotMatterPlatform implements DynamicPlatformPlugin {
     // For any entries in merged (which are based on config.options.devices), ensure final per-device merges include deviceId-specific config
     const final: any[] = []
     for (const device of merged) {
-      const deviceIdConfig = this.config.options?.devices?.[device.deviceId] || {}
+      // Find per-device config entry by deviceId (config.options.devices is an array)
+      const deviceIdConfig = (this.config.options?.devices || []).find((d: any) => this.normalizeDeviceId(d.deviceId) === this.normalizeDeviceId(device.deviceId)) || {}
       const deviceWithConfig = Object.assign({}, device, deviceIdConfig)
       final.push(deviceWithConfig)
     }
@@ -260,12 +284,12 @@ export class SwitchBotMatterPlatform implements DynamicPlatformPlugin {
    * Map a SwitchBot device object to a MatterAccessory using the device-specific
    * Matter accessory classes in `src/devices-matter`.
    */
-  private async createAccessoryFromDevice(dev: device): Promise<MatterAccessory<Record<string, unknown>> | undefined> {
+  private async createAccessoryFromDevice(dev: device & devicesConfig): Promise<MatterAccessory<Record<string, unknown>> | undefined> {
     // Basic metadata
     const displayName = dev.deviceName ?? dev.deviceId ?? 'SwitchBot Device'
     const serial = dev.deviceId ?? 'unknown'
     const manufacturer = 'SwitchBot'
-    const model = dev.deviceType ?? 'SwitchBot'
+    const model = dev.model ?? dev.deviceType ?? 'SwitchBot'
     const firmware = (dev as any).firmware ?? (dev as any).version ?? '0.0.0'
 
     // Helper to build a default opts object consumed by the matter device classes
@@ -780,41 +804,77 @@ export class SwitchBotMatterPlatform implements DynamicPlatformPlugin {
     // If we discovered real SwitchBot devices via OpenAPI, map and register them
     if (this.discoveredDevices && this.discoveredDevices.length > 0) {
       this.infoLog(`Registering ${this.discoveredDevices.length} discovered SwitchBot device(s) as Matter accessories`)
-      const accessories: Array<MatterAccessory<Record<string, unknown>>> = []
 
       // Merge device config (deviceConfig per deviceType and per-device overrides) to match HAP behavior
       const devicesToProcess = await this.mergeDiscoveredDevices(this.discoveredDevices)
 
+      // We'll separate discovered devices into two buckets:
+      // - platformAccessories: accessories that will be hosted under the plugin's Matter bridge
+      // - roboticAccessories: robot vacuum devices which require standalone commissioning behaviour
+      const platformAccessories: Array<MatterAccessory<Record<string, unknown>>> = []
+      const roboticAccessories: Array<MatterAccessory<Record<string, unknown>>> = []
+
+      // Known robot vacuum deviceType names (matches mapping in createAccessoryFromDevice)
+      const robotTypes = new Set([
+        'K10+',
+        'K10+ Pro',
+        'WoSweeper',
+        'WoSweeperMini',
+        'Robot Vacuum Cleaner S1',
+        'Robot Vacuum Cleaner S1 Plus',
+        'Robot Vacuum Cleaner S10',
+        'Robot Vacuum Cleaner S1 Pro',
+        'Robot Vacuum Cleaner S1 Mini',
+      ])
+
       for (const dev of devicesToProcess) {
         try {
           const acc = await this.createAccessoryFromDevice(dev)
-          if (acc) {
-            accessories.push(acc)
+          if (!acc) {
+            continue
+          }
+          if (robotTypes.has(dev.deviceType ?? '')) {
+            roboticAccessories.push(acc)
+          } else {
+            platformAccessories.push(acc)
           }
         } catch (e: any) {
           this.errorLog(`Failed to create Matter accessory for ${dev.deviceId}: ${e?.message ?? e}`)
         }
       }
-      if (accessories.length > 0) {
-        this.infoLog(`✓ Registered ${accessories.length} discovered device(s)`)
-        for (const acc of accessories) {
+
+      // Register platform-hosted accessories (most devices)
+      if (platformAccessories.length > 0) {
+        this.infoLog(`✓ Registered ${platformAccessories.length} discovered platform-hosted device(s)`)
+        for (const acc of platformAccessories) {
           this.infoLog(`  - ${acc.displayName}`)
         }
-        await this.api.matter.registerPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, accessories)
-        return
+        await this.api.matter.registerPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, platformAccessories)
       }
-      this.infoLog('No discovered devices were mapped to Matter accessories; falling back to example sections')
+
+      // Register robotic accessories (robot vacuums) separately so they can be
+      // commissioned in the way Apple Home expects (these devices often require
+      // standalone commissioning flow). We still call registerPlatformAccessories
+      // because the accessory implementations manage their commissioning behavior.
+      if (roboticAccessories.length > 0) {
+        this.infoLog(`✓ Registered ${roboticAccessories.length} discovered robot vacuum device(s)`)
+        for (const acc of roboticAccessories) {
+          this.infoLog(`  - ${acc.displayName} (standalone for Apple Home compatibility)`)
+        }
+        await this.api.matter.registerPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, roboticAccessories)
+      }
+
+      // Debug/info: how many discovered vs example accessories were registered.
+      // Example accessories are disabled — we intentionally do NOT register them.
+      const discoveredRegistered = platformAccessories.length + roboticAccessories.length
+      const exampleRegistered = 0
+      this.debugLog(`Discovered accessories registered: ${discoveredRegistered}; Example accessories registered: ${exampleRegistered}`)
+
+      return
     }
 
-    // Register example/demo devices by Matter specification sections
-    await this.registerSection4Lighting()
-    await this.registerSection5SmartPlugs()
-    await this.registerSection6Switches()
-    await this.registerSection7Sensors()
-    await this.registerSection8Closure()
-    await this.registerSection9HVAC()
-    await this.registerSection12Robotic()
-    await this.registerCustomDevices()
+    // If no discovered devices are available, do not register example/demo accessories.
+    this.infoLog('No discovered SwitchBot devices found; not registering example Matter accessories by default.')
 
     this.debugLog('═'.repeat(80))
     this.debugLog('Finished registering Matter accessories')

package/src/settings.ts

@@ -36,6 +36,10 @@ export interface options {
   irdevices?: irDevicesConfig[]
   irdeviceConfig?: { [remoteType: string]: irDevicesConfig }
   allowInvalidCharacters?: boolean
+  // When true, devices declared in config.options.devices that are not
+  // discovered via the SwitchBot OpenAPI will still be included (config-only
+  // devices). Default: false.
+  allowConfigOnlyDevices?: boolean
   mqttURL?: string
   mqttOptions?: IClientOptions
   mqttPubOptions?: IClientOptions

package/dist/baseMatterAccessory.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"baseMatterAccessory.test.d.ts","sourceRoot":"","sources":["../src/baseMatterAccessory.test.ts"],"names":[],"mappings":""}

package/dist/baseMatterAccessory.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"baseMatterAccessory.test.js","sourceRoot":"","sources":["../src/baseMatterAccessory.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AAEjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,yCAAyC,CAAA;AAE7E,wCAAwC;AACxC,MAAM,aAAc,SAAQ,mBAAmB;IAC7C,YAAY,GAAQ,EAAE,GAAQ,EAAE,IAAU;QACxC,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE;YACd,IAAI,EAAE,IAAI,EAAE,IAAI,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;YACpD,WAAW,EAAE,IAAI,EAAE,WAAW,IAAI,MAAM;YACxC,UAAU,EAAE,IAAI,EAAE,UAAU,IAAK,YAAoB;YACrD,YAAY,EAAE,IAAI,EAAE,YAAY,IAAI,QAAQ;YAC5C,YAAY,EAAE,IAAI,EAAE,YAAY,IAAI,QAAQ;YAC5C,KAAK,EAAE,IAAI,EAAE,KAAK,IAAI,KAAK;YAC3B,gBAAgB,EAAE,IAAI,EAAE,gBAAgB,IAAI,KAAK;YACjD,gBAAgB,EAAE,IAAI,EAAE,gBAAgB,IAAI,KAAK;YACjD,OAAO,EAAE,IAAI,EAAE,OAAO,IAAI,EAAE;YAC5B,QAAQ,EAAE,IAAI,EAAE,QAAQ;YACxB,QAAQ,EAAE,IAAI,EAAE,QAAQ;SACzB,CAAC,CAAA;IACJ,CAAC;CACF;AAED,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;IAC3C,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;QACnE,MAAM,MAAM,GAAG,EAAE,CAAC,EAAE,EAAE,CAAA;QACtB,MAAM,WAAW,GAAG,EAAE,CAAC,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;QAC1E,MAAM,GAAG,GAAQ,EAAE,MAAM,EAAE,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE,EAAE,oBAAoB,EAAE,MAAM,EAAE,EAAE,CAAA;QACjL,MAAM,GAAG,GAAQ,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAA;QAEjF,MAAM,GAAG,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,SAAS,EAAE,CAAA;QACzE,MAAM,GAAG,GAAG,IAAI,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAA;QAEzD,MAAM,GAAG,CAAC,aAAa,EAAE,CAAA;QAEzB,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAA;QAC7D,MAAM,CAAC,MAAM,CAAC,CAAC,oBAAoB,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IACzE,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;QACxE,MAAM,MAAM,GAAG,EAAE,CAAC,EAAE,EAAE,CAAA;QACtB,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,CAAA;QACvC,MAAM,GAAG,GAAQ,EAAE,MAAM,EAAE,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE,EAAE,oBAAoB,EAAE,MAAM,EAAE,EAAE,CAAA;QACjL,MAAM,GAAG,GAAQ,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAA;QAEjF,MAAM,GAAG,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,KAAK,EAAE,CAAA;QACjE,MAAM,GAAG,GAAG,IAAI,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAA;QAEzD,MAAM,GAAG,CAAC,aAAa,EAAE,CAAA;QAEzB,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAA;QAC9C,MAAM,CAAC,MAAM,CAAC,CAAC,oBAAoB,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IACzE,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;QACxE,MAAM,MAAM,GAAG,EAAE,CAAC,EAAE,EAAE,CAAA;QACtB,MAAM,WAAW,GAAG,EAAE,CAAC,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;QAC1E,MAAM,GAAG,GAAQ,EAAE,MAAM,EAAE,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE,EAAE,oBAAoB,EAAE,MAAM,EAAE,EAAE,CAAA;QACjL,MAAM,GAAG,GAAQ,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAA;QAEjF,MAAM,GAAG,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,SAAS,EAAE,CAAA;QACzE,MAAM,GAAG,GAAG,IAAI,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAA;QAEzD,MAAM,GAAG,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAA;QAE/B,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,eAAe,EAAE,IAAI,CAAC,CAAA;QAC/D,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAA;QAClD,MAAM,CAAC,MAAM,CAAC,CAAC,oBAAoB,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC,CAAA;IACzF,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,MAAM,GAAG,EAAE,CAAC,EAAE,EAAE,CAAA;QACtB,MAAM,WAAW,GAAG,EAAE,CAAC,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;QAC1E,MAAM,GAAG,GAAQ,EAAE,MAAM,EAAE,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE,EAAE,oBAAoB,EAAE,MAAM,EAAE,EAAE,CAAA;QACjL,MAAM,GAAG,GAAQ,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAA;QAEjF,MAAM,GAAG,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,SAAS,EAAE,CAAA;QACzE,MAAM,GAAG,GAAG,IAAI,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAA;QAEzD,MAAM,GAAG,CAAC,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;QAEnC,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,UAAU,EAAE,WAAW,CAAC,CAAA;QACjE,MAAM,CAAC,MAAM,CAAC,CAAC,gBAAgB,EAAE,CAAA;QACjC,iEAAiE;QACjE,MAAM,UAAU,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;QACjE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,OAAO,IAAI,UAAU,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,UAAU,EAAE,CAAA;IAC1G,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}