@switchbot/homebridge-switchbot 5.0.0-beta.4 → 5.0.0-beta.40

package/src/devices-matter/ExtendedColorLightAccessory.ts

@@ -5,6 +5,7 @@
 
 import type { API, Logger, MatterRequests } from 'homebridge'
 
+import { hs2rgb } from '../utils.js'
 import { BaseMatterAccessory } from './BaseMatterAccessory.js'
 
 export class ExtendedColorLightAccessory extends BaseMatterAccessory {
@@ -61,46 +62,44 @@ export class ExtendedColorLightAccessory extends BaseMatterAccessory {
 
   private async handleOn(): Promise<void> {
     this.logInfo('turning on.')
-    // TODO: await myLightAPI.turnOn()
+    await this.sendOnCommand()
   }
 
   private async handleOff(): Promise<void> {
     this.logInfo('turning off.')
-    // TODO: await myLightAPI.turnOff()
+    await this.sendOffCommand()
   }
 
   private async handleSetLevel(request: MatterRequests.MoveToLevel): Promise<void> {
     this.logInfo(`MoveToLevel request: ${JSON.stringify(request)}`)
     const { level } = request
     const brightnessPercent = Math.round((level / 254) * 100)
-    this.logInfo(`setting brightness to ${brightnessPercent}%.`)
-    // TODO: await myLightAPI.setBrightness(brightnessPercent)
+    await this.sendSetBrightness(brightnessPercent)
   }
 
   private async handleSetColor(request: MatterRequests.MoveToColor): Promise<void> {
     this.logInfo(`MoveToColor request: ${JSON.stringify(request)}`)
-    const { colorX, colorY, transitionTime } = request
-    const xFloat = (colorX / 65535).toFixed(4)
-    const yFloat = (colorY / 65535).toFixed(4)
-    this.logInfo(`setting xy color to (${xFloat}, ${yFloat}), ${transitionTime}ms.`)
-    // TODO: await myLightAPI.setXY(xFloat, yFloat, transitionTime)
+    const { colorX, colorY } = request
+    const hueApprox = Math.round((colorX / 65535) * 360)
+    const satApprox = Math.round((colorY / 65535) * 100)
+    const [r, g, b] = hs2rgb(hueApprox, satApprox)
+    await this.sendSetColor(r, g, b)
   }
 
   private async handleSetHueSaturation(request: MatterRequests.MoveToHueAndSaturation): Promise<void> {
     this.logInfo(`MoveToHueAndSaturation request: ${JSON.stringify(request)}`)
-    const { hue, saturation, transitionTime } = request
+    const { hue, saturation } = request
     const hueDegrees = Math.round((hue / 254) * 360)
     const saturationPercent = Math.round((saturation / 254) * 100)
-    this.logInfo(`setting color to ${hueDegrees}°, ${saturationPercent}%, ${transitionTime}ms.`)
-    // TODO: await myLightAPI.setColor(hueDegrees, saturationPercent, transitionTime)
+    const [r, g, b] = hs2rgb(hueDegrees, saturationPercent)
+    await this.sendSetColor(r, g, b)
   }
 
   private async handleSetColorTemperature(request: MatterRequests.MoveToColorTemperature): Promise<void> {
     this.logInfo(`MoveToColorTemperature request: ${JSON.stringify(request)}`)
-    const { colorTemperatureMireds, transitionTime } = request
+    const { colorTemperatureMireds } = request
     const kelvin = Math.round(1000000 / colorTemperatureMireds)
-    this.logInfo(`setting color temp to ${kelvin}k, ${transitionTime}ms.`)
-    // TODO: await myLightAPI.setColorTemperature(kelvin, transitionTime)
+    await this.sendSetColorTemperature(kelvin)
   }
 
   public updateOnOffState(isOn: boolean): void {

package/src/devices-matter/OnOffLightAccessory.ts

@@ -27,12 +27,8 @@ export class OnOffLightAccessory extends BaseMatterAccessory {
     const clusters = opts?.clusters ?? { onOff: { onOff: true } }
     const handlers = opts?.handlers ?? {
       onOff: {
-        on: async () => {
-          log.debug(`${displayName} on handler invoked (default no-op).`)
-        },
-        off: async () => {
-          log.debug(`${displayName} off handler invoked (default no-op).`)
-        },
+        on: async () => this.handleOnCommand(),
+        off: async () => this.handleOffCommand(),
       },
     }
 
@@ -61,14 +57,10 @@ export class OnOffLightAccessory extends BaseMatterAccessory {
     this.logInfo('turning on.')
 
     try {
-      // TODO: Control your physical device here
-      // Examples:
-      // await fetch('https://api.mydevice.com/light/on', { method: 'POST' })
-      // await fetch('http://192.168.1.50/api/light/on')
-      // mqttClient.publish('home/light/command', JSON.stringify({ state: 'ON' }))
-      // await myLightAPI.turnOn(this.context.deviceId)
+      // Delegate to the platform-provided helper (OpenAPI/BLE) when available
+      await this.sendOnCommand()
 
-      this.logInfo('physical device turned on.')
+      this.logInfo('physical device turned on (via platform helper).')
 
       // State automatically updated by Homebridge after handler completes
     } catch (error) {
@@ -84,10 +76,10 @@ export class OnOffLightAccessory extends BaseMatterAccessory {
     this.logInfo('turning off.')
 
     try {
-      // TODO: Control your physical device here
-      // await myLightAPI.turnOff(this.context.deviceId)
+      // Delegate to the platform-provided helper (OpenAPI/BLE) when available
+      await this.sendOffCommand()
 
-      this.logInfo('physical device turned off.')
+      this.logInfo('physical device turned off (via platform helper).')
 
       // State automatically updated by Homebridge after handler completes
     } catch (error) {

package/src/devices-matter/OnOffOutletAccessory.ts

@@ -13,13 +13,8 @@ export class OnOffOutletAccessory extends BaseMatterAccessory {
     const clusters = opts?.clusters ?? { onOff: { onOff: false } }
     const handlers = opts?.handlers ?? {
       onOff: {
-        on: async () => {
-          // default no-op; platform may inject handlers via opts.handlers
-          log.debug(`${displayName} on handler invoked (default no-op).`)
-        },
-        off: async () => {
-          log.debug(`${displayName} off handler invoked (default no-op).`)
-        },
+        on: async () => this.handleOn(),
+        off: async () => this.handleOff(),
       },
     }
 
@@ -43,4 +38,14 @@ export class OnOffOutletAccessory extends BaseMatterAccessory {
   public updateOnOffState(isOn: boolean): void {
     this.updateState(this.api.matter.clusterNames.OnOff, { onOff: isOn })
   }
+
+  private async handleOn(): Promise<void> {
+    this.logInfo('turning on.')
+    await this.sendOnCommand()
+  }
+
+  private async handleOff(): Promise<void> {
+    this.logInfo('turning off.')
+    await this.sendOffCommand()
+  }
 }

package/src/devices-matter/OnOffSwitchAccessory.ts

@@ -37,12 +37,12 @@ export class OnOffSwitchAccessory extends BaseMatterAccessory {
 
   private async handleOn(): Promise<void> {
     this.logInfo('turning on.')
-    // TODO: await mySwitchAPI.turnOn()
+    await this.sendOnCommand()
   }
 
   private async handleOff(): Promise<void> {
     this.logInfo('turning off.')
-    // TODO: await mySwitchAPI.turnOff()
+    await this.sendOffCommand()
   }
 
   public updateOnOffState(isOn: boolean): void {

package/src/homebridge-ui/public/index.html

@@ -122,6 +122,41 @@
   (async () => {
     try {
       const currentConfig = await homebridge.getPluginConfig();
+
+      // Defensive wrapper: ensure token/secret aren't accidentally cleared by
+      // the UI/schema form. Some versions of config UI can omit sensitive
+      // fields from the submitted payload; when that happens we copy the
+      // existing values from `currentConfig` into the outgoing payload so
+      // saved config does not inadvertently remove credentials.
+      try {
+        if (typeof homebridge.updatePluginConfig === 'function') {
+          const _origUpdatePluginConfig = homebridge.updatePluginConfig.bind(homebridge)
+          homebridge.updatePluginConfig = async (cfg) => {
+            try {
+              if (Array.isArray(cfg) && cfg.length > 0 && Array.isArray(currentConfig) && currentConfig.length > 0) {
+                const incoming = cfg[0] || {}
+                const existing = currentConfig[0] || {}
+                incoming.credentials = incoming.credentials || {}
+                // Preserve token/secret when incoming payload leaves them blank/undefined
+                if ((incoming.credentials.token === undefined || String(incoming.credentials.token).trim() === '') && existing.credentials && existing.credentials.token) {
+                  incoming.credentials.token = existing.credentials.token
+                }
+                if ((incoming.credentials.secret === undefined || String(incoming.credentials.secret).trim() === '') && existing.credentials && existing.credentials.secret) {
+                  incoming.credentials.secret = existing.credentials.secret
+                }
+                cfg[0] = incoming
+              }
+            } catch (e) {
+              // Swallow any wrapper errors but log to console for debugging
+              // (do not expose secrets).
+              console.error('updatePluginConfig wrapper error', e)
+            }
+            return await _origUpdatePluginConfig(cfg)
+          }
+        }
+      } catch (e) {
+        console.error('Failed to attach updatePluginConfig wrapper', e)
+      }
       showIntro = () => {
         const introLink = document.getElementById('introLink');
         introLink.addEventListener('click', () => {
@@ -144,10 +179,22 @@
         document.getElementById('menuSettings').classList.add('btn-primary');
         document.getElementById('pageSupport').style.display = 'none';
         document.getElementById('pageDevices').style.display = 'block';
-        const cachedAccessories =
+        let cachedAccessories =
           typeof homebridge.getCachedAccessories === 'function'
             ? await homebridge.getCachedAccessories()
             : await homebridge.request('/getCachedAccessories');
+
+        // If no HAP cached accessories were returned, try the Matter cached list
+        if ((!cachedAccessories || cachedAccessories.length === 0) && typeof homebridge.request === 'function') {
+          try {
+            const matter = await homebridge.request('/getCachedMatterAccessories')
+            if (Array.isArray(matter) && matter.length > 0) {
+              cachedAccessories = matter
+            }
+          } catch (e) {
+            // ignore
+          }
+        }
         if (cachedAccessories.length > 0) {
           cachedAccessories.sort((a, b) => {
             return a.displayName.toLowerCase() > b.displayName.toLowerCase() ? 1 : b.displayName.toLowerCase() > a.displayName.toLowerCase() ? -1 : 0;

package/src/homebridge-ui/server.ts

@@ -9,9 +9,12 @@ class PluginUiServer extends HomebridgePluginUiServer {
       A native method getCachedAccessories() was introduced in config-ui-x v4.37.0
       The following is for users who have a lower version of config-ui-x
     */
-    this.onRequest('getCachedAccessories', () => {
+    const getCachedAccessoriesHandler = () => {
       try {
-        const plugin = 'homebridge-switchbot'
+        // Some Homebridge versions store cached accessories with the scoped
+        // plugin name ("@switchbot/homebridge-switchbot"); others may use
+        // the unscoped id ("homebridge-switchbot"). Check both.
+        const pluginNames = ['@switchbot/homebridge-switchbot', 'homebridge-switchbot']
         const devicesToReturn = []
 
         // The path and file of the cached accessories
@@ -22,11 +25,12 @@ class PluginUiServer extends HomebridgePluginUiServer {
           // read the cached accessories file
           const cachedAccessories: any[] = JSON.parse(fs.readFileSync(accFile, 'utf8'))
 
-          cachedAccessories.forEach((accessory: any) => {
-            // Check the accessory is from this plugin
-            if (accessory.plugin === plugin) {
-              // Add the cached accessory to the array
-              devicesToReturn.push(accessory.accessory as never)
+          cachedAccessories.forEach((entry: any) => {
+            // entry shape varies by UI version
+            const pluginName = entry.plugin || entry?.accessory?.plugin || entry?.accessory?.pluginName
+            const acc = entry.accessory ?? entry
+            if (pluginNames.includes(pluginName)) {
+              devicesToReturn.push(acc as never)
             }
           })
         }
@@ -36,7 +40,50 @@ class PluginUiServer extends HomebridgePluginUiServer {
         // Just return an empty accessory list in case of any errors
         return []
       }
-    })
+    }
+    this.onRequest('getCachedAccessories', getCachedAccessoriesHandler)
+    // Also register with a leading slash for compatibility with some UIs
+    this.onRequest('/getCachedAccessories', getCachedAccessoriesHandler)
+    // Provide Matter cached accessories if Homebridge stores them separately.
+    const getCachedMatterAccessoriesHandler = () => {
+      try {
+        const pluginNames = ['@switchbot/homebridge-switchbot', 'homebridge-switchbot']
+        const devicesToReturn: any[] = []
+
+        const accFile = `${this.homebridgeStoragePath}/accessories/cachedAccessories`
+        const matterFile = `${this.homebridgeStoragePath}/accessories/cachedMatterAccessories`
+
+        const readAndCollect = (filePath: string) => {
+          if (!fs.existsSync(filePath)) {
+            return
+          }
+          try {
+            const parsed: any[] = JSON.parse(fs.readFileSync(filePath, 'utf8'))
+            parsed.forEach((entry: any) => {
+              // Entry shape varies between Homebridge versions; try common locations
+              const pluginName = entry.plugin || entry?.accessory?.plugin || entry?.accessory?.pluginName
+              const acc = entry.accessory ?? entry
+              if (pluginNames.includes(pluginName)) {
+                devicesToReturn.push(acc as never)
+              }
+            })
+          } catch {
+            // ignore parse errors for a single file
+          }
+        }
+
+        // Read both canonical files (some Homebridge versions use one or the other)
+        readAndCollect(accFile)
+        readAndCollect(matterFile)
+
+        return devicesToReturn
+      } catch {
+        return []
+      }
+    }
+    this.onRequest('getCachedMatterAccessories', getCachedMatterAccessoriesHandler)
+    // Also register with a leading slash for compatibility with some UIs
+    this.onRequest('/getCachedMatterAccessories', getCachedMatterAccessoriesHandler)
     this.ready()
   }
 }

package/src/index.ts

@@ -7,14 +7,11 @@ import type { API } from 'homebridge'
 import { SwitchBotHAPPlatform } from './platform-hap.js'
 import { SwitchBotMatterPlatform } from './platform-matter.js'
 import { PLATFORM_NAME, PLUGIN_NAME } from './settings.js'
+import { createPlatformProxy } from './utils.js'
 
 // Register our platform with homebridge.
 export default (api: API): void => {
-  // Call the instance method on the runtime `api` object (optional chaining in case
-  // older homebridge doesn't provide it). Treat undefined as false.
-  const isMatter = Boolean(api.isMatterEnabled?.())
-  const log = (api as any).logger ?? console
-  log.info?.(`Homebridge SwitchBot Plugin initializing in ${isMatter ? 'Matter' : 'HAP'} mode.`)
-  // If Matter is enabled register the Matter platform, otherwise use HAP platform.
-  api.registerPlatform(PLUGIN_NAME, PLATFORM_NAME, isMatter ? SwitchBotMatterPlatform : SwitchBotHAPPlatform)
+  // Create and register a small proxy that selects the correct platform (HAP or Matter) at runtime.
+  const ProxyCtor = createPlatformProxy(SwitchBotHAPPlatform, SwitchBotMatterPlatform)
+  api.registerPlatform(PLUGIN_NAME, PLATFORM_NAME, ProxyCtor as any)
 }

package/src/irdevice/irdevice.ts

@@ -276,69 +276,108 @@ export abstract class irdeviceBase {
   /**
    * Logging for Device
    */
-  async infoLog(...log: any[]): Promise<void> {
-    if (await this.enablingDeviceLogging()) {
-      this.log.info(`${this.device.remoteType}: ${this.accessory.displayName}`, String(...log))
+  infoLog(...log: any[]): void {
+    if (!this.enablingDeviceLogging()) {
+      return
     }
+    // Delegate to a single helper that prefers platform-provided loggers.
+    this.logWith('info', `${this.device.remoteType}: ${this.accessory.displayName}`, undefined, String(...log))
   }
 
-  async successLog(...log: any[]): Promise<void> {
-    if (await this.enablingDeviceLogging()) {
-      this.log.success(`${this.device.remoteType}: ${this.accessory.displayName}`, String(...log))
+  successLog(...log: any[]): void {
+    if (!this.enablingDeviceLogging()) {
+      return
     }
+    this.logWith('success', `${this.device.remoteType}: ${this.accessory.displayName}`, undefined, String(...log))
   }
 
-  async debugSuccessLog(...log: any[]): Promise<void> {
-    if (await this.enablingDeviceLogging()) {
-      if (await this.loggingIsDebug()) {
-        this.log.success(`[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, String(...log))
-      }
+  debugSuccessLog(...log: any[]): void {
+    if (!this.enablingDeviceLogging()) {
+      return
+    }
+    if (!this.loggingIsDebug()) {
+      return
     }
+    this.logWith('success', `[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, 'debugSuccessLog', String(...log))
   }
 
-  async warnLog(...log: any[]): Promise<void> {
-    if (await this.enablingDeviceLogging()) {
-      this.log.warn(`${this.device.remoteType}: ${this.accessory.displayName}`, String(...log))
+  warnLog(...log: any[]): void {
+    if (!this.enablingDeviceLogging()) {
+      return
     }
+    this.logWith('warn', `${this.device.remoteType}: ${this.accessory.displayName}`, undefined, String(...log))
   }
 
-  async debugWarnLog(...log: any[]): Promise<void> {
-    if (await this.enablingDeviceLogging()) {
-      if (await this.loggingIsDebug()) {
-        this.log.warn(`[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, String(...log))
-      }
+  debugWarnLog(...log: any[]): void {
+    if (!this.enablingDeviceLogging() || !this.loggingIsDebug()) {
+      return
     }
+    this.logWith('warn', `[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, 'debugWarnLog', String(...log))
   }
 
-  async errorLog(...log: any[]): Promise<void> {
-    if (await this.enablingDeviceLogging()) {
-      this.log.error(`${this.device.remoteType}: ${this.accessory.displayName}`, String(...log))
+  errorLog(...log: any[]): void {
+    if (!this.enablingDeviceLogging()) {
+      return
     }
+    this.logWith('error', `${this.device.remoteType}: ${this.accessory.displayName}`, undefined, String(...log))
   }
 
-  async debugErrorLog(...log: any[]): Promise<void> {
-    if (await this.enablingDeviceLogging()) {
-      if (await this.loggingIsDebug()) {
-        this.log.error(`[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, String(...log))
-      }
+  debugErrorLog(...log: any[]): void {
+    if (!this.enablingDeviceLogging() || !this.loggingIsDebug()) {
+      return
     }
+    this.logWith('error', `[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, 'debugErrorLog', String(...log))
   }
 
-  async debugLog(...log: any[]): Promise<void> {
-    if (await this.enablingDeviceLogging()) {
-      if (this.deviceLogging === 'debug') {
-        this.log.info(`[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, String(...log))
-      } else if (this.deviceLogging === 'debugMode') {
-        this.log.debug(`${this.device.remoteType}: ${this.accessory.displayName}`, String(...log))
+  debugLog(...log: any[]): void {
+    if (!this.enablingDeviceLogging()) {
+      return
+    }
+    if (this.deviceLogging === 'debug') {
+      this.logWith('debug', `[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, 'debugLog', String(...log))
+    } else if (this.deviceLogging === 'debugMode') {
+      this.logWith('debug', `${this.device.remoteType}: ${this.accessory.displayName}`, 'debugLog', String(...log))
+    }
+  }
+
+  // Generic platform/local logger delegate
+  protected logWith(level: string, message: string, platformMethodName?: string, payload?: string): void {
+    const method = platformMethodName ?? `${level}Log`
+    const pFn = (this.platform as any)?.[method]
+    if (typeof pFn === 'function') {
+      try {
+        if (payload !== undefined) {
+          pFn(message, payload)
+        } else {
+          pFn(message)
+        }
+        return
+      } catch (_err) {
+        // fallthrough to local logger
+      }
+    }
+    const map: Record<string, string> = {
+      info: 'info',
+      success: 'success',
+      debug: 'debug',
+      warn: 'warn',
+      error: 'error',
+    }
+    const local = (this.log as any)[map[level] ?? level]
+    if (typeof local === 'function') {
+      if (payload !== undefined) {
+        local.call(this.log, message, payload)
+      } else {
+        local.call(this.log, message)
       }
     }
   }
 
-  async loggingIsDebug(): Promise<boolean> {
+  loggingIsDebug(): boolean {
     return this.deviceLogging === 'debugMode' || this.deviceLogging === 'debug'
   }
 
-  async enablingDeviceLogging(): Promise<boolean> {
+  enablingDeviceLogging(): boolean {
     return this.deviceLogging === 'debugMode' || this.deviceLogging === 'debug' || this.deviceLogging === 'standard'
   }
 }