@switchbot/homebridge-switchbot 5.0.0-beta.146 → 5.0.0-beta.148

package/src/deviceCommandMapper.ts

@@ -0,0 +1,333 @@
+// deviceCommandMapper.ts
+// Maps HAP/Matter commands to node-switchbot device methods for all supported device types
+
+// This is a starter mapping. Expand as needed for new device types and commands.
+// Each device type maps to a set of commands, each command maps to a function that takes (device, body) and returns a Promise.
+
+export type DeviceCommandHandler = (device: any, body: any) => Promise<any>
+
+export interface DeviceCommandMap {
+  [command: string]: DeviceCommandHandler
+}
+
+export interface DeviceTypeCommandMap {
+  [deviceType: string]: DeviceCommandMap
+}
+
+export const deviceTypeCommandMap: DeviceTypeCommandMap = {
+  // SwitchBot AI Hub (read-only/generic)
+  'ai hub': {},
+  // SwitchBot Cameras (read-only/generic)
+  'indoor cam': {},
+  'pan/tilt cam': {},
+  'pan/tilt cam 2k': {},
+  'pan/tilt cam plus 2k': {},
+  'pan/tilt cam plus 3k': {},
+  // SwitchBot Air Purifiers (read-only/generic)
+  'air purifier pm2.5': {},
+  'air purifier table pm2.5': {},
+  'air purifier voc': {},
+  'air purifier table voc': {},
+  // SwitchBot Home Climate Panel (read-only/generic)
+  'home climate panel': {},
+  // SwitchBot WoIOSensor (read-only/generic)
+  'woiosensor': {},
+  // SwitchBot Candle Warmer Lamp
+  'candle warmer lamp': {
+    turnOn: async device => device.turnOn(),
+    turnOff: async device => device.turnOff(),
+  },
+  // SwitchBot Hubs (read-only/generic)
+  'hub': {},
+  'hub 2': {},
+  'hub 3': {},
+  'hub mini': {},
+  'hub plus': {},
+  // SwitchBot Robot Vacuum Cleaner K20 Plus Pro
+  'robot vacuum cleaner k20 plus pro': {
+    start: async device => device.start(),
+    stop: async device => device.stop(),
+    pause: async device => device.pause(),
+    dock: async device => device.dock(),
+    resume: async device => device.resume(),
+    locate: async device => device.locate(),
+  },
+  // SwitchBot Robot Vacuum Cleaner S1
+  'robot vacuum cleaner s1': {
+    start: async device => device.start(),
+    stop: async device => device.stop(),
+    pause: async device => device.pause(),
+    dock: async device => device.dock(),
+    resume: async device => device.resume(),
+    locate: async device => device.locate(),
+  },
+  // SwitchBot Robot Vacuum Cleaner S1 Plus
+  'robot vacuum cleaner s1 plus': {
+    start: async device => device.start(),
+    stop: async device => device.stop(),
+    pause: async device => device.pause(),
+    dock: async device => device.dock(),
+    resume: async device => device.resume(),
+    locate: async device => device.locate(),
+  },
+  // SwitchBot Robot Vacuum Cleaner S10
+  'robot vacuum cleaner s10': {
+    start: async device => device.start(),
+    stop: async device => device.stop(),
+    pause: async device => device.pause(),
+    dock: async device => device.dock(),
+    resume: async device => device.resume(),
+    locate: async device => device.locate(),
+  },
+  // SwitchBot Robot Vacuum Cleaner S20
+  'robot vacuum cleaner s20': {
+    start: async device => device.start(),
+    stop: async device => device.stop(),
+    pause: async device => device.pause(),
+    dock: async device => device.dock(),
+    resume: async device => device.resume(),
+    locate: async device => device.locate(),
+  },
+  // SwitchBot Relay Switch 2PM
+  'relay switch 2pm': {
+    turnOn: async device => device.turnOn(),
+    turnOff: async device => device.turnOff(),
+  },
+  // SwitchBot K10+
+  'k10+': {
+    start: async device => device.start(),
+    stop: async device => device.stop(),
+    pause: async device => device.pause(),
+    dock: async device => device.dock(),
+    resume: async device => device.resume(),
+    locate: async device => device.locate(),
+  },
+  // SwitchBot K10+ Pro
+  'k10+ pro': {
+    start: async device => device.start(),
+    stop: async device => device.stop(),
+    pause: async device => device.pause(),
+    dock: async device => device.dock(),
+    resume: async device => device.resume(),
+    locate: async device => device.locate(),
+  },
+  // SwitchBot Robot Vacuum Cleaner K10+ Pro Combo
+  'robot vacuum cleaner k10+ pro combo': {
+    start: async device => device.start(),
+    stop: async device => device.stop(),
+    pause: async device => device.pause(),
+    dock: async device => device.dock(),
+    resume: async device => device.resume(),
+    locate: async device => device.locate(),
+  },
+  // SwitchBot Robot Vacuum Cleaner K11+
+  'robot vacuum cleaner k11+': {
+    start: async device => device.start(),
+    stop: async device => device.stop(),
+    pause: async device => device.pause(),
+    dock: async device => device.dock(),
+    resume: async device => device.resume(),
+    locate: async device => device.locate(),
+  },
+  // SwitchBot MeterPro(CO2) (read-only)
+  'meterpro(co2)': {},
+  // SwitchBot Water Detector (read-only)
+  'water detector': {},
+  // SwitchBot Garage Door Opener
+  'garage door opener': {
+    open: async device => device.open(),
+    close: async device => device.close(),
+    stop: async device => device.stop(),
+  },
+  // SwitchBot Relay Switch 1
+  'relay switch 1': {
+    turnOn: async device => device.turnOn(),
+    turnOff: async device => device.turnOff(),
+  },
+  // SwitchBot Relay Switch 1PM
+  'relay switch 1pm': {
+    turnOn: async device => device.turnOn(),
+    turnOff: async device => device.turnOff(),
+  },
+  // SwitchBot Smart Radiator Thermostat (read-only or not directly controllable)
+  'smart radiator thermostat': {},
+  // SwitchBot Humidifier2
+  'humidifier2': {
+    turnOn: async device => device.turnOn(),
+    turnOff: async device => device.turnOff(),
+    setMode: async (device, body) => device.setMode(body?.parameter),
+    setHumidity: async (device, body) => device.setHumidity(body?.parameter),
+  },
+  // SwitchBot MeterPlus (read-only)
+  'meterplus': {},
+  // SwitchBot Meter Pro (read-only)
+  'meter pro': {},
+  // SwitchBot MeterPro (read-only)
+  'meterpro': {},
+  // SwitchBot RGBICWW Floor Lamp
+  'rgbicww floor lamp': {
+    turnOn: async device => device.turnOn(),
+    turnOff: async device => device.turnOff(),
+    setBrightness: async (device, body) => device.setBrightness(body?.parameter),
+    setColor: async (device, body) => device.setColor(body?.parameter),
+  },
+  // SwitchBot RGBICWW Strip Light
+  'rgbicww strip light': {
+    turnOn: async device => device.turnOn(),
+    turnOff: async device => device.turnOff(),
+    setBrightness: async (device, body) => device.setBrightness(body?.parameter),
+    setColor: async (device, body) => device.setColor(body?.parameter),
+  },
+  // SwitchBot Circulator Fan
+  'circulator fan': {
+    turnOn: async device => device.turnOn(),
+    turnOff: async device => device.turnOff(),
+    setSpeed: async (device, body) => device.setSpeed(body?.parameter),
+    swing: async device => device.swing(),
+  },
+  // SwitchBot Battery Circulator Fan
+  'battery circulator fan': {
+    turnOn: async device => device.turnOn(),
+    turnOff: async device => device.turnOff(),
+    setSpeed: async (device, body) => device.setSpeed(body?.parameter),
+    swing: async device => device.swing(),
+  },
+  // SwitchBot Standing Circulator Fan
+  'standing circulator fan': {
+    turnOn: async device => device.turnOn(),
+    turnOff: async device => device.turnOff(),
+    setSpeed: async (device, body) => device.setSpeed(body?.parameter),
+    swing: async device => device.swing(),
+  },
+  // SwitchBot Bot
+  'bot': {
+    turnOn: async device => device.turnOn(),
+    turnOff: async device => device.turnOff(),
+    press: async device => device.press(),
+  },
+  // SwitchBot Curtain
+  'curtain': {
+    open: async device => device.open(),
+    close: async device => device.close(),
+    pause: async device => device.pause(),
+    setPosition: async (device, body) => device.setPosition(body?.parameter),
+  },
+  // SwitchBot Blind Tilt
+  'blind tilt': {
+    open: async device => device.open(),
+    close: async device => device.close(),
+    pause: async device => device.pause(),
+    setPosition: async (device, body) => device.setPosition(body?.parameter),
+  },
+  // SwitchBot Roller Shade
+  'roller shade': {
+    open: async device => device.open(),
+    close: async device => device.close(),
+    pause: async device => device.pause(),
+    setPosition: async (device, body) => device.setPosition(body?.parameter),
+  },
+  // SwitchBot Plug
+  'plug': {
+    turnOn: async device => device.turnOn(),
+    turnOff: async device => device.turnOff(),
+  },
+  // SwitchBot Strip Light 3
+  'strip light 3': {
+    turnOn: async device => device.turnOn(),
+    turnOff: async device => device.turnOff(),
+    setBrightness: async (device, body) => device.setBrightness(body?.parameter),
+    setColor: async (device, body) => device.setColor(body?.parameter),
+  },
+  // SwitchBot Floor Lamp
+  'floor lamp': {
+    turnOn: async device => device.turnOn(),
+    turnOff: async device => device.turnOff(),
+    setBrightness: async (device, body) => device.setBrightness(body?.parameter),
+    setColor: async (device, body) => device.setColor(body?.parameter),
+  },
+  // SwitchBot RGBIC Neon Rope Light
+  'rgbic neon rope light': {
+    turnOn: async device => device.turnOn(),
+    turnOff: async device => device.turnOff(),
+    setBrightness: async (device, body) => device.setBrightness(body?.parameter),
+    setColor: async (device, body) => device.setColor(body?.parameter),
+  },
+  // SwitchBot RGBIC Neon Wire Rope Light
+  'rgbic neon wire rope light': {
+    turnOn: async device => device.turnOn(),
+    turnOff: async device => device.turnOff(),
+    setBrightness: async (device, body) => device.setBrightness(body?.parameter),
+    setColor: async (device, body) => device.setColor(body?.parameter),
+  },
+  // SwitchBot Plug Mini
+  'plug mini': {
+    turnOn: async device => device.turnOn(),
+    turnOff: async device => device.turnOff(),
+  },
+  // SwitchBot Color Bulb
+  'color bulb': {
+    turnOn: async device => device.turnOn(),
+    turnOff: async device => device.turnOff(),
+    setBrightness: async (device, body) => device.setBrightness(body?.parameter),
+    setColor: async (device, body) => device.setColor(body?.parameter),
+  },
+  // SwitchBot Light Strip
+  'light strip': {
+    turnOn: async device => device.turnOn(),
+    turnOff: async device => device.turnOff(),
+    setBrightness: async (device, body) => device.setBrightness(body?.parameter),
+    setColor: async (device, body) => device.setColor(body?.parameter),
+  },
+  // SwitchBot Fan
+  'fan': {
+    turnOn: async device => device.turnOn(),
+    turnOff: async device => device.turnOff(),
+    setSpeed: async (device, body) => device.setSpeed(body?.parameter),
+    swing: async device => device.swing(),
+  },
+  // SwitchBot Lock
+  'lock': {
+    lock: async device => device.lock(),
+    unlock: async device => device.unlock(),
+  },
+  // SwitchBot Curtain 3
+  'curtain3': {
+    open: async device => device.open(),
+    close: async device => device.close(),
+    pause: async device => device.pause(),
+    setPosition: async (device, body) => device.setPosition(body?.parameter),
+  },
+  // SwitchBot Meter
+  'meter': {}, // Read-only
+  // SwitchBot Motion Sensor
+  'motion sensor': {}, // Read-only
+  // SwitchBot Contact Sensor
+  'contact sensor': {}, // Read-only
+  // SwitchBot Humidifier
+  'humidifier': {
+    turnOn: async device => device.turnOn(),
+    turnOff: async device => device.turnOff(),
+    setMode: async (device, body) => device.setMode(body?.parameter),
+    setHumidity: async (device, body) => device.setHumidity(body?.parameter),
+  },
+  // SwitchBot Vacuum
+  'vacuum': {
+    start: async device => device.start(),
+    stop: async device => device.stop(),
+    pause: async device => device.pause(),
+    dock: async device => device.dock(),
+    resume: async device => device.resume(),
+    locate: async device => device.locate(),
+  },
+  // Add more device types and commands as needed
+}
+
+// Helper to get the handler for a device type and command
+export function getDeviceCommandHandler(deviceType: string, command: string): DeviceCommandHandler | undefined {
+  const typeKey = deviceType.toLowerCase()
+  const typeMap = deviceTypeCommandMap[typeKey]
+  if (!typeMap) {
+    return undefined
+  }
+  return typeMap[command]
+}

package/src/deviceFactory.ts

@@ -1,4 +1,5 @@
 import type { DeviceType, SwitchBotPluginConfig } from './settings.js'
+import type { Logger } from 'homebridge'
 
 import { DEVICE_TYPE_NORMALIZATION_MAP } from './device-types.js'
 import {
@@ -139,10 +140,11 @@ function classForType(type: string) {
   return DEVICE_CLASS_MAP[key] ?? GenericDevice
 }
 
-export async function createDevice(opts: DeviceOptions, cfg: SwitchBotPluginConfig, useMatter: boolean, log?: { info: (...args: any[]) => void }) {
-  // Debug: Log the options passed to the device constructor
-  if (opts && opts.name && log && typeof log.info === 'function') {
-    log.info(`[Matter/Debug] createDevice: Passing opts for ${opts.name}:`, JSON.stringify(opts, null, 2))
+export async function createDevice(opts: DeviceOptions, cfg: SwitchBotPluginConfig, useMatter: boolean, log?: Logger) {
+  // Always pass the logger to both device opts and config
+  const logger = log || (cfg as any)?.logger || (cfg as any)?.log
+  if (opts && opts.name && logger && typeof logger.info === 'function') {
+    logger.info(`[Matter/Debug] createDevice: Passing opts for ${opts.name}:`, JSON.stringify(opts, null, 2))
   }
   // Reuse existing client when provided via config to avoid creating
   // a new SwitchBotClient per device (which can be expensive).
@@ -151,9 +153,12 @@ export async function createDevice(opts: DeviceOptions, cfg: SwitchBotPluginConf
     client = new SwitchBotClient(cfg)
     await client.init()
   }
-
   // Pass client via config so devices can access it
   const mergedCfg = { ...(cfg as any), _client: client }
+  // Always pass logger to mergedCfg
+  if (logger) {
+    mergedCfg.log = logger
+  }
   // Pass encryptionKey and keyId to device opts if present
   const deviceOpts = { ...opts }
   if (opts.encryptionKey) {
@@ -162,7 +167,10 @@ export async function createDevice(opts: DeviceOptions, cfg: SwitchBotPluginConf
   if (opts.keyId) {
     deviceOpts.keyId = opts.keyId
   }
-
+  // Always pass logger to deviceOpts
+  if (logger) {
+    deviceOpts.log = logger
+  }
   const DeviceCtor = classForType(opts.type)
   const device = new DeviceCtor(deviceOpts, mergedCfg)
   await device.init()

package/src/homebridge-ui/endpoints/config.ts

@@ -4,7 +4,7 @@ import { RequestError } from '@homebridge/plugin-ui-utils'
 import fs from 'node:fs/promises'
 
 import { isValidDeviceType } from '../../device-types.js'
-import { getAllDevices, getSwitchBotPlatformConfig, SWITCHBOT_PLATFORM_REGEX } from '../utils/config-parser.js'
+import { getAllDevices, SWITCHBOT_PLATFORM_REGEX } from '../utils/config-parser.js'
 import { validateAndMigrateDeviceType } from '../utils/device-migration.js'
 import { uiLog } from '../utils/logger.js'
 
@@ -12,6 +12,7 @@ export function registerConfigEndpoints(server: HomebridgePluginUiServer) {
   /**
    * GET /devices - List all configured devices from Homebridge config
    */
+
   server.onRequest('/devices', async () => {
     try {
       const cfgPath = server.homebridgeConfigPath
@@ -106,21 +107,4 @@ export function registerConfigEndpoints(server: HomebridgePluginUiServer) {
       throw new RequestError(msg || 'Failed to read Homebridge config', e)
     }
   })
-
-  /**
-   * GET /platform-config - Get SwitchBot platform configuration
-   */
-  server.onRequest('/platform-config', async () => {
-    try {
-      const { platform } = await getSwitchBotPlatformConfig(server)
-      return {
-        success: true,
-        data: JSON.parse(JSON.stringify(platform)),
-      }
-    } catch (e) {
-      const msg = e instanceof Error ? e.message : String(e)
-      uiLog.error(`Error in /platform-config: ${msg}`)
-      throw new RequestError(msg || 'Failed to read platform config', e)
-    }
-  })
 }