@switchbot/homebridge-switchbot 5.0.0-beta.13 → 5.0.0-beta.15

package/src/utils.ts

@@ -2,7 +2,7 @@
  *
  * util.ts: @switchbot/homebridge-switchbot platform class.
  */
-import type { API } from 'homebridge'
+import type { API, Logging } from 'homebridge'
 import type { blindTilt, curtain, curtain3, device } from 'node-switchbot'
 
 import type { devicesConfig } from './settings.js'
@@ -718,6 +718,78 @@ export function cleanDeviceConfig(deviceConfig?: Record<string, Record<string, a
   return undefined
 }
 
+/**
+ * Factory that returns a function to send OpenAPI commands using a retry wrapper.
+ *
+ * @param retryCommandFunc - bound function that calls platform.retryCommand(device, bodyChange, maxRetries, delay)
+ * @param deviceObj - the device object to operate on
+ * @param opts - optional overrides for maxRetries and delayBetweenRetries
+ * @param opts.maxRetries - override for maxRetries
+ * @param opts.delayBetweenRetries - override for delayBetweenRetries
+ */
+export function makeOpenAPISender(retryCommandFunc: any, deviceObj: any, opts?: { maxRetries?: number, delayBetweenRetries?: number }) {
+  return async (command: string, parameter = 'default') => {
+    const bodyChange: any = { command, parameter, commandType: 'command' }
+    return retryCommandFunc(deviceObj, bodyChange, opts?.maxRetries, opts?.delayBetweenRetries)
+  }
+}
+
+/**
+ * Factory that returns a function to perform BLE actions using a SwitchBotBLE client.
+ * Handles discovery retries and method invocation on the discovered device instance.
+ *
+ * @param switchBotBLE - instance of SwitchBotBLE (may be undefined)
+ * @param deviceObj - the device object (used to obtain bleModel/deviceId)
+ * @param opts - optional retry settings
+ * @param opts.bleRetries - number of BLE discovery retries
+ * @param opts.bleRetryDelay - delay between BLE retries in ms
+ */
+export function makeBLESender(switchBotBLE: any, deviceObj: any, opts?: { bleRetries?: number, bleRetryDelay?: number }) {
+  return async (methodName: string, ...args: any[]) => {
+    if (!switchBotBLE) {
+      throw new Error('Platform BLE not available')
+    }
+    const id = formatDeviceIdAsMac(deviceObj.deviceId)
+    const maxRetries = opts?.bleRetries ?? 2
+    const retryDelay = opts?.bleRetryDelay ?? 500
+    let attempt = 0
+    while (attempt < maxRetries) {
+      try {
+        const list = await switchBotBLE.discover({ model: (deviceObj as any).bleModel, id })
+        if (!Array.isArray(list) || list.length === 0) {
+          throw new Error('BLE device not found')
+        }
+        const deviceInst: any = list[0]
+        if (typeof deviceInst[methodName] !== 'function') {
+          throw new TypeError(`BLE method ${methodName} not available on device`)
+        }
+        return await deviceInst[methodName](...args)
+      } catch (e: any) {
+        attempt++
+        if (attempt >= maxRetries) {
+          throw e
+        }
+        await sleep(retryDelay)
+      }
+    }
+    throw new Error('BLE operation failed')
+  }
+}
+
+/**
+ * Decide effective connection type for a device given platform options.
+ * Mirrors the logic previously in platform-matter.
+ */
+export function chooseConnectionType(platformOptions: any, deviceObj: any): 'BLE' | 'OpenAPI' {
+  if (deviceObj?.connectionType) {
+    return deviceObj.connectionType === 'BLE' ? 'BLE' : 'OpenAPI'
+  }
+  if (platformOptions?.BLE && (deviceObj?.bleModel || (typeof deviceObj?.deviceId === 'string' && deviceObj.deviceId.length > 0))) {
+    return 'BLE'
+  }
+  return 'OpenAPI'
+}
+
 /**
  * Detect whether Matter is enabled/available on the provided Homebridge API object.
  * This encapsulates the multi-fallback detection used across the project.
@@ -758,6 +830,91 @@ export function detectMatterEnabled(apiObj: API): boolean {
   return detectMatter(apiObj).enabled
 }
 
+/**
+ * Create platform logging helpers used by both HAP and Matter platforms.
+ *
+ * getPlatformLogging may be either a synchronous string-returning function or an
+ * async function that resolves to the current platform logging setting. The
+ * returned helpers mirror the instance methods previously implemented on the
+ * HAP platform (infoLog, warnLog, errorLog, debugLog, etc.).
+ */
+export function createPlatformLogger(getPlatformLogging: () => string | Promise<string | undefined>, log: Logging) {
+  const getPL = async () => {
+    try {
+      return await getPlatformLogging()
+    } catch {
+      return undefined
+    }
+  }
+
+  const loggingIsDebug = async () => {
+    const pl = await getPL()
+    return pl === 'debugMode' || pl === 'debug'
+  }
+
+  const enablingPlatformLogging = async () => {
+    const pl = await getPL()
+    return pl === 'debugMode' || pl === 'debug' || pl === 'standard'
+  }
+
+  return {
+    infoLog: async (...args: any[]) => {
+      if (await enablingPlatformLogging()) {
+        log.info(String(...args))
+      }
+    },
+    successLog: async (...args: any[]) => {
+      if (await enablingPlatformLogging()) {
+        // Some Logging implementations expose `success` — call if present
+        ;(log as any).success?.(String(...args)) ?? log.info(String(...args))
+      }
+    },
+    debugSuccessLog: async (...args: any[]) => {
+      if (await enablingPlatformLogging()) {
+        if (await loggingIsDebug()) {
+          ;(log as any).success?.('[DEBUG]', String(...args)) ?? log.info('[DEBUG]', String(...args))
+        }
+      }
+    },
+    warnLog: async (...args: any[]) => {
+      if (await enablingPlatformLogging()) {
+        log.warn(String(...args))
+      }
+    },
+    debugWarnLog: async (...args: any[]) => {
+      if (await enablingPlatformLogging()) {
+        if (await loggingIsDebug()) {
+          log.warn('[DEBUG]', String(...args))
+        }
+      }
+    },
+    errorLog: async (...args: any[]) => {
+      if (await enablingPlatformLogging()) {
+        log.error(String(...args))
+      }
+    },
+    debugErrorLog: async (...args: any[]) => {
+      if (await enablingPlatformLogging()) {
+        if (await loggingIsDebug()) {
+          log.error('[DEBUG]', String(...args))
+        }
+      }
+    },
+    debugLog: async (...args: any[]) => {
+      if (await enablingPlatformLogging()) {
+        const pl = await getPL()
+        if (pl === 'debug') {
+          log.info('[DEBUG]', String(...args))
+        } else if (pl === 'debugMode') {
+          log.debug(String(...args))
+        }
+      }
+    },
+    loggingIsDebug,
+    enablingPlatformLogging,
+  }
+}
+
 /**
  * Create a Platform proxy class that selects between two platform constructors
  * (HAP vs Matter) at runtime using `detectMatter`. Returns a class suitable

package/src/verifyconfig.test.ts

@@ -1,6 +1,7 @@
-import { describe, expect, it, vi } from 'vitest'
 import type { SwitchBotPlatformConfig } from './settings.js'
 
+import { describe, expect, it } from 'vitest'
+
 // Create a minimal mock of the SwitchBotPlatform to test verifyConfig
 class MockSwitchBotPlatform {
   config: SwitchBotPlatformConfig
@@ -102,10 +103,10 @@ describe('verifyConfig fix for reboot loop', () => {
 
     // This should NOT throw an error anymore - it should log instead
     await expect(platform.verifyConfig()).resolves.not.toThrow()
-    
+
     // Verify that the error was logged instead of thrown
     expect(platform.errorLogCalls).toContain(
-      'The devices config section is missing the *Device ID* in the config. Please check your config.'
+      'The devices config section is missing the *Device ID* in the config. Please check your config.',
     )
   })
 
@@ -132,10 +133,10 @@ describe('verifyConfig fix for reboot loop', () => {
 
     // This should NOT throw an error anymore - it should log instead
     await expect(platform.verifyConfig()).resolves.not.toThrow()
-    
+
     // Verify that the error was logged instead of thrown
     expect(platform.errorLogCalls).toContain(
-      'The devices config section is missing the *Device Type* in the config. Please check your config.'
+      'The devices config section is missing the *Device Type* in the config. Please check your config.',
     )
   })
 
@@ -187,11 +188,11 @@ describe('verifyConfig fix for reboot loop', () => {
 
     // Should not throw or log device config errors with valid config
     await expect(platform.verifyConfig()).resolves.not.toThrow()
-    
+
     // Should not have device config errors
-    expect(platform.errorLogCalls.filter(msg => 
-      msg.includes('missing the *Device ID*') || 
-      msg.includes('missing the *Device Type*')
+    expect(platform.errorLogCalls.filter(msg =>
+      msg.includes('missing the *Device ID*')
+      || msg.includes('missing the *Device Type*'),
     )).toHaveLength(0)
   })
-})
+})