@switchbot/homebridge-switchbot 5.0.0-beta.12 → 5.0.0-beta.121

package/src/device-types.ts

@@ -0,0 +1,261 @@
+export const DEVICE_TYPES = {
+  'Window Coverings': ['Blind Tilt', 'Curtain', 'Curtain3', 'Roller Shade'],
+  'Locks & Access': [
+    'Keypad',
+    'Keypad Touch',
+    'Keypad Vision',
+    'Keypad Vision Pro',
+    'Lock Vision Pro',
+    'Lock Lite',
+    'Smart Lock',
+    'Smart Lock Pro',
+    'Smart Lock Ultra',
+    'Video Doorbell',
+  ],
+  'Sensors': ['Contact Sensor', 'Motion Sensor', 'Presence Sensor', 'Water Detector'],
+  'Lighting': [
+    'Candle Warmer Lamp',
+    'Ceiling Light',
+    'Ceiling Light Pro',
+    'Color Bulb',
+    'Floor Lamp',
+    'RGBIC Neon Rope Light',
+    'RGBIC Neon Wire Rope Light',
+    'RGBICWW Floor Lamp',
+    'RGBICWW Strip Light',
+    'Strip Light',
+    'Strip Light 3',
+  ],
+  'Climate Control': [
+    'Air Purifier PM2.5',
+    'Air Purifier Table PM2.5',
+    'Air Purifier VOC',
+    'Air Purifier Table VOC',
+    'Battery Circulator Fan',
+    'Circulator Fan',
+    'Humidifier',
+    'Humidifier2',
+    'Meter',
+    'MeterPlus',
+    'Meter Plus',
+    'MeterPro',
+    'Meter Pro',
+    'MeterPro(CO2)',
+    'Meter Pro (CO2)',
+    'Smart Radiator Thermostat',
+    'Standing Circulator Fan',
+    'WoIOSensor',
+  ],
+  'Plugs & Switches': [
+    'Garage Door Opener',
+    'Plug',
+    'Plug Mini (EU)',
+    'Plug Mini (JP)',
+    'Plug Mini (US)',
+    'Relay Switch 1',
+    'Relay Switch 1PM',
+    'Relay Switch 2PM',
+  ],
+  'Robot Vacuums': [
+    'K10+',
+    'K10+ Pro',
+    'Robot Vacuum Cleaner K10+ Pro Combo',
+    'Robot Vacuum Cleaner K11+',
+    'Robot Vacuum Cleaner K20 Plus Pro',
+    'Robot Vacuum Cleaner S1',
+    'Robot Vacuum Cleaner S1 Plus',
+    'Robot Vacuum Cleaner S10',
+    'Robot Vacuum Cleaner S20',
+  ],
+  'Hubs': ['AI Hub', 'Hub', 'Hub 2', 'Hub 3', 'Hub Mini', 'Hub Plus'],
+  'Cameras': [
+    'Indoor Cam',
+    'Pan/Tilt Cam',
+    'Pan/Tilt Cam 2K',
+    'Pan/Tilt Cam Plus 2K',
+    'Pan/Tilt Cam Plus 3K',
+  ],
+  'IR Devices': [
+    'Air Conditioner',
+    'Air Purifier',
+    'Camera',
+    'DVD',
+    'Fan',
+    'Light',
+    'Others',
+    'Projector',
+    'Set Top Box',
+    'Speaker',
+    'Streamer',
+    'TV',
+    'Vacuum Cleaner',
+    'Water Heater',
+  ],
+  'Other Devices': ['AI Art Frame', 'Bot', 'Home Climate Panel', 'Remote', 'remote with screen'],
+} as const
+
+export const DEVICE_TYPE_NORMALIZATION_MAP: Record<string, string> = {
+  // --- node-switchbot beta new types normalization additions ---
+  'hub mini': 'Hub Mini',
+  'hub 3': 'Hub 3',
+  'keypad': 'Keypad', // node-switchbot beta
+  'plug mini': 'Plug Mini (US)', // fallback to US if region not specified
+  'art frame': 'AI Art Frame',
+  'rgbicww': 'RGBICWW Strip Light',
+  'lock vision': 'Lock Vision Pro', // alias for new lock vision
+  'lock pro': 'Smart Lock Pro',
+  'lock lite': 'Lock Lite', // node-switchbot beta
+  'circulator fan': 'Circulator Fan', // node-switchbot beta
+  'smart thermostat radiator': 'Smart Radiator Thermostat',
+  'climate panel': 'Home Climate Panel',
+  'evaporative humidifier': 'Humidifier',
+  // --- end node-switchbot beta additions ---
+  // Only keep the last occurrence for each key, all values canonical
+  'air purifier pm2.5': 'Air Purifier PM2.5',
+  'pan/tilt cam plus 3k': 'Pan/Tilt Cam Plus 3K',
+  'remote with screen': 'Remote with Screen',
+  'ai hub': 'AI Hub',
+  'water detector': 'Water Detector',
+  'video doorbell': 'Video Doorbell',
+  'smart radiator thermostat': 'Smart Radiator Thermostat',
+  'woiosensor': 'WoIOSensor',
+  'garage door opener': 'Garage Door Opener',
+  'air purifier table pm2.5': 'Air Purifier Table PM2.5',
+  'air purifier voc': 'Air Purifier VOC',
+  'air purifier table voc': 'Air Purifier Table VOC',
+  'plug mini (eu)': 'Plug Mini (EU)',
+  // Only last occurrence for each key is kept above. Removed duplicates here.
+
+  // Climate control conversions
+  'humidifier2': 'Humidifier2',
+  'battery circulator fan': 'Battery Circulator Fan',
+  'standing circulator fan': 'Standing Circulator Fan',
+
+  // Lock/keypad conversions
+  'smart lock': 'Smart Lock',
+  'smart lock pro': 'Smart Lock Pro',
+  'smart lock ultra': 'Smart Lock Ultra',
+  'keypad touch': 'Keypad Touch',
+  'keypad vision': 'Keypad Vision',
+  'keypad vision pro': 'Keypad Vision Pro',
+
+  // Light conversions
+  'color bulb': 'Color Bulb',
+  'ceiling light': 'Ceiling Light',
+  'ceiling light pro': 'Ceiling Light Pro',
+  'candle warmer lamp': 'Candle Warmer Lamp',
+  'floor lamp': 'Floor Lamp',
+  'rgbic neon rope light': 'RGBIC Neon Rope Light',
+  'rgbic neon wire rope light': 'RGBIC Neon Wire Rope Light',
+  'rgbicww floor lamp': 'RGBICWW Floor Lamp',
+  'rgbicww strip light': 'RGBICWW Strip Light',
+  'strip light': 'Strip Light',
+  'strip light 3': 'Strip Light 3', // node-switchbot beta
+
+  // Vacuum conversions
+  'robot vacuum cleaner s1': 'Robot Vacuum Cleaner S1',
+  'robot vacuum cleaner s1 plus': 'Robot Vacuum Cleaner S1 Plus',
+  'robot vacuum cleaner s10': 'Robot Vacuum Cleaner S10',
+  'robot vacuum cleaner s20': 'Robot Vacuum Cleaner S20',
+  'robot vacuum cleaner k10+ pro combo': 'Robot Vacuum Cleaner K10+ Pro Combo',
+  'robot vacuum cleaner k11+': 'Robot Vacuum Cleaner K11+',
+  'robot vacuum cleaner k20 plus pro': 'Robot Vacuum Cleaner K20 Plus Pro',
+
+  // Exact device type mappings (API format → canonical format)
+  'relay switch 1': 'Relay Switch 1',
+  'blind tilt': 'Blind Tilt',
+  'roller shade': 'Roller Shade',
+  'curtain3': 'Curtain3',
+  'hub 2': 'Hub 2',
+  'meterplus': 'MeterPlus',
+  'meterpro': 'MeterPro',
+  'meterpro(co2)': 'MeterPro(CO2)',
+  'walletfinder': 'WalletFinder',
+  'k10+': 'K10+',
+  'k10+ pro (wosweeperminipro)': 'K10+ Pro (wosweeperminipro)',
+
+  // Handle spaced variants from config files (normalize back to canonical type)
+  'meter pro': 'Meter Pro',
+  'meter pro (co2)': 'Meter Pro (CO2)',
+  'meter plus': 'Meter Plus',
+  'relay switch 1 pm': 'Relay Switch 1PM',
+  'relay switch 2 pm': 'Relay Switch 2PM',
+  'plug mini eu': 'Plug Mini (EU)',
+  'plug mini jp': 'Plug Mini (JP)',
+  'plug mini us': 'Plug Mini (US)',
+
+  // Migration mappings for invalid/legacy device types
+  'lock vision pro': 'Lock Vision Pro', // Valid alias; map to canonical
+  // 'lock vision': 'Keypad Vision', // Invalid type (removed, now node-switchbot beta alias above)
+  'lock touch': 'Keypad Touch', // Invalid type
+
+  // Additional normalization for new/unknown types from logs
+  'woplugus': 'Plug Mini (US)',
+  // Removed duplicate keys below, only last occurrence kept
+  // 'plug mini us': 'plug mini (us)', // duplicate, removed
+  // 'plug us': 'plug mini (us)', // duplicate, removed
+  // 'plug': 'plug', // duplicate, removed
+  // 'air purifier pm2.5': 'air purifier pm2.5', // duplicate, removed
+  // 'rgbic neon wire rope light': 'rgbic neon wire rope light', // duplicate, removed
+  // 'candle warmer lamp': 'candle warmer lamp', // duplicate, removed
+  // 'pan/tilt cam plus 3k': 'pan/tilt cam plus 3k', // duplicate, removed
+  // 'remote with screen': 'remote with screen', // duplicate, removed
+  // 'ai hub': 'ai hub', // duplicate, removed
+  // 'lock vision pro': 'lock vision pro', // duplicate, remove this line
+  // Add any other device types from logs as needed
+}
+
+/**
+ * Get all valid device types as a flat set for validation
+ */
+export function getValidDeviceTypes(): Set<string> {
+  const validTypes = new Set<string>()
+  for (const category of Object.values(DEVICE_TYPES)) {
+    for (const type of category) {
+      validTypes.add(type)
+    }
+  }
+  return validTypes
+}
+
+/**
+ * Normalize and validate a device type, returning a valid type or null
+ * @param deviceType The device type to validate/normalize
+ * @returns Valid device type string or null if no valid mapping found
+ */
+export function normalizeDeviceType(deviceType: string | undefined | null): string | null {
+  if (!deviceType || typeof deviceType !== 'string') {
+    return null
+  }
+
+  const trimmed = deviceType.trim()
+  const lowercase = trimmed.toLowerCase()
+
+  // Check if already valid
+  const validTypes = getValidDeviceTypes()
+  if (validTypes.has(trimmed)) {
+    return trimmed
+  }
+
+  // Check normalization map
+  const normalized = DEVICE_TYPE_NORMALIZATION_MAP[lowercase]
+  if (normalized && validTypes.has(normalized)) {
+    return normalized
+  }
+
+  // No valid mapping found
+  return null
+}
+
+/**
+ * Check if a device type is valid
+ * @param deviceType The device type to check
+ * @returns true if device type is in DEVICE_TYPES
+ */
+export function isValidDeviceType(deviceType: string | undefined | null): boolean {
+  if (!deviceType || typeof deviceType !== 'string') {
+    return false
+  }
+  const validTypes = getValidDeviceTypes()
+  return validTypes.has(deviceType.trim())
+}

package/src/deviceFactory.ts

@@ -0,0 +1,190 @@
+import type { DeviceType, SwitchBotPluginConfig } from './settings.js'
+
+import { DEVICE_TYPE_NORMALIZATION_MAP } from './device-types.js'
+import {
+  BlindTiltDevice,
+  BotDevice,
+  ContactSensorDevice,
+  Curtain3Device,
+  CurtainDevice,
+  FanDevice,
+  GenericDevice,
+  Hub2Device,
+  HumidifierDevice,
+  LightDevice,
+  LightStripDevice,
+  LockDevice,
+  MeterDevice,
+  MotionSensorDevice,
+  PlugDevice,
+  PlugMiniDevice,
+  RelaySwitch1PMDevice,
+  RelaySwitchDevice,
+  RollerShadeDevice,
+  SmartFanDevice,
+  StripLightDevice,
+  TemperatureSensorDevice,
+  VacuumDevice,
+  WalletFinderDevice,
+  WaterDetectorDevice,
+  WoSweeperDevice,
+  WoSweeperMiniDevice,
+  WoSweeperMiniProDevice,
+} from './devices/genericDevice.js'
+import { SwitchBotClient } from './switchbotClient.js'
+
+export interface DeviceOptions {
+  id: string
+  type: DeviceType
+  name?: string
+  [key: string]: any
+}
+
+const DEVICE_CLASS_MAP: Record<string, any> = {
+  // Primary device type keys (lowercase, simplified)
+  'bot': BotDevice,
+  'curtain': CurtainDevice,
+  'curtain3': Curtain3Device,
+  'fan': FanDevice,
+  'light': LightDevice,
+  'lightstrip': LightStripDevice,
+  'motion': MotionSensorDevice,
+  'contact': ContactSensorDevice,
+  'vacuum': VacuumDevice, // node-switchbot beta
+  // Canonical, normalized device type keys (lowercase, mapped to device classes)
+  'video doorbell': GenericDevice,
+  'smart radiator thermostat': GenericDevice, // node-switchbot beta
+  'woiosensor': GenericDevice,
+  'garage door opener': GenericDevice, // node-switchbot beta
+  'air purifier table pm2.5': GenericDevice,
+  'air purifier voc': GenericDevice,
+  'air purifier table voc': GenericDevice,
+  'meterplus': MeterDevice,
+  'meterpro': MeterDevice,
+  'meterpro(co2)': MeterDevice,
+  'walletfinder': WalletFinderDevice,
+  'plug': PlugDevice,
+  'plug mini (eu)': PlugMiniDevice, // node-switchbot beta
+  'plug mini (jp)': PlugMiniDevice, // node-switchbot beta
+  'plug mini (us)': PlugMiniDevice, // node-switchbot beta
+  'relay switch 1pm': RelaySwitch1PMDevice,
+  'relay switch 2pm': RelaySwitch1PMDevice,
+  'k10+ pro': WoSweeperDevice,
+  'robot vacuum cleaner k10+ pro combo': WoSweeperDevice,
+  'robot vacuum cleaner k11+': WoSweeperDevice,
+  'robot vacuum cleaner k20 plus pro': WoSweeperDevice,
+  'ai hub': GenericDevice,
+  'hub': GenericDevice,
+  'hub 2': Hub2Device,
+  'hub 3': GenericDevice, // node-switchbot beta
+  'hub mini': GenericDevice, // node-switchbot beta
+  'hub plus': GenericDevice,
+  'indoor cam': GenericDevice,
+  'pan/tilt cam': GenericDevice,
+  'pan/tilt cam 2k': GenericDevice,
+  'pan/tilt cam plus 2k': GenericDevice,
+  'pan/tilt cam plus 3k': GenericDevice,
+  'humidifier': HumidifierDevice, // node-switchbot beta (Evaporative Humidifier)
+  'roller shade': RollerShadeDevice, // node-switchbot beta
+  'strip light 3': StripLightDevice, // node-switchbot beta
+  'circulator fan': FanDevice, // node-switchbot beta
+  'smart lock pro': LockDevice, // node-switchbot beta
+  'lock lite': LockDevice, // node-switchbot beta
+  'keypad': LockDevice, // node-switchbot beta
+  'lock vision pro': LockDevice, // node-switchbot beta
+  'floor lamp': LightDevice, // node-switchbot beta
+  'rgbicww floor lamp': LightStripDevice, // node-switchbot beta
+  'rgbicww strip light': LightStripDevice, // node-switchbot beta
+  'home climate panel': GenericDevice, // node-switchbot beta (Climate Panel)
+  'lock': LockDevice,
+  'humidifier2': HumidifierDevice,
+  'temperature': TemperatureSensorDevice,
+  'relay switch 1': RelaySwitchDevice,
+  'blind tilt': BlindTiltDevice,
+  'worollershade': RollerShadeDevice,
+  'wo rollershade': RollerShadeDevice,
+  'rollershade': RollerShadeDevice,
+  'meter': MeterDevice,
+  'meter plus (jp)': MeterDevice,
+  'water detector': WaterDetectorDevice,
+  'smart fan': SmartFanDevice,
+  'strip light': StripLightDevice,
+  'wosweeper': WoSweeperDevice,
+  'wosweepermini': WoSweeperMiniDevice,
+  'wosweeperminipro': WoSweeperMiniProDevice,
+  'k10+': WoSweeperDevice,
+  'k10+ pro (wosweeperminipro)': WoSweeperMiniProDevice,
+  'battery circulator fan': FanDevice,
+  'standing circulator fan': FanDevice,
+  'smart lock': LockDevice,
+  'smart lock ultra': LockDevice,
+  'keypad touch': LockDevice,
+  'keypad vision': LockDevice,
+  'keypad vision pro': LockDevice,
+  'color bulb': LightDevice,
+  'ceiling light': LightDevice,
+  'ceiling light pro': LightDevice,
+  'candle warmer lamp': LightDevice,
+  'rgbic neon rope light': LightStripDevice,
+  'rgbic neon wire rope light': LightStripDevice,
+  'robot vacuum cleaner s1': VacuumDevice,
+  'robot vacuum cleaner s1 plus': VacuumDevice,
+  'robot vacuum cleaner s10': VacuumDevice,
+  'robot vacuum cleaner s20': VacuumDevice,
+}
+
+function classForType(type: string) {
+  const rawKey = (type || '').toLowerCase()
+  const key = DEVICE_TYPE_NORMALIZATION_MAP[rawKey] ?? rawKey
+  return DEVICE_CLASS_MAP[key] ?? GenericDevice
+}
+
+export async function createDevice(opts: DeviceOptions, cfg: SwitchBotPluginConfig, useMatter: boolean) {
+  // Reuse existing client when provided via config to avoid creating
+  // a new SwitchBotClient per device (which can be expensive).
+  let client: any = (cfg as any)?._client ?? null
+  if (!client) {
+    client = new SwitchBotClient(cfg)
+    await client.init()
+  }
+
+  // Pass client via config so devices can access it
+  const mergedCfg = { ...(cfg as any), _client: client }
+
+  // Pass encryptionKey and keyId to device opts if present
+  const deviceOpts = { ...opts }
+  if (opts.encryptionKey) {
+    deviceOpts.encryptionKey = opts.encryptionKey
+  }
+  if (opts.keyId) {
+    deviceOpts.keyId = opts.keyId
+  }
+
+  const DeviceCtor = classForType(opts.type)
+  const device = new DeviceCtor(deviceOpts, mergedCfg)
+  await device.init()
+
+  // Attach a simple getState delegator to the client where appropriate
+  const originalGetState = device.getState.bind(device)
+  device.getState = async () => {
+    try {
+      // Prefer client-backed getDevice when available
+      const dev = await client.getDevice(opts.id)
+      if (dev) {
+        return dev
+      }
+    } catch (e) {
+      // ignore and fallback to device implementation
+    }
+    return originalGetState()
+  }
+
+  // Provide accessory factory based on platform selection
+  return {
+    instance: device,
+    createAccessory: useMatter
+      ? async (api: any) => await device.createMatterAccessory(api)
+      : (api: any) => device.createHAPAccessory(api),
+    protocol: useMatter ? 'matter' : 'hap',
+  }
+}

package/src/devices/deviceBase.ts

@@ -0,0 +1,141 @@
+import type { SwitchBotPluginConfig } from '../settings.js'
+
+import { MATTER_ATTRIBUTE_IDS, MATTER_CLUSTER_IDS } from '../utils.js'
+
+export interface DeviceOptions {
+  id: string
+  type: string
+  name?: string
+  [key: string]: any
+}
+
+export abstract class DeviceBase {
+  protected opts: DeviceOptions
+  protected cfg: SwitchBotPluginConfig
+  protected client: any | null
+
+  constructor(opts: DeviceOptions, cfg: SwitchBotPluginConfig) {
+    this.opts = opts
+    this.cfg = cfg
+    this.client = (cfg as any)?._client ?? null
+  }
+
+  // Initialize any connections/resources
+  async init(): Promise<void> {}
+
+  // Return current device state from SwitchBot or cache
+  abstract getState(): Promise<any>
+
+  // Apply a state change to the device
+  abstract setState(change: any): Promise<any>
+
+  /**
+   * Create and return a HAP accessory descriptor.
+   *
+   * This method returns a descriptor object (not a platformAccessory instance).
+   * The platform will use this descriptor to construct a real HAP accessory.
+   *
+   * Default descriptor provides a simple Switch service with an `On` characteristic
+   * backed by `getState()` / `setState()` so most simple devices work out of the box.
+   *
+   * If the Homebridge `api` is passed, `Service` and `Characteristic` constructors
+   * are included under `_resolved` for callers that need them.
+   *
+   * @example
+   * {
+   *   id: 'd1',
+   *   name: 'My Device',
+   *   protocol: 'hap',
+   *   services: [ { type: 'Switch', characteristics: { On: { get: async ()=>true, set: async v=>{} } } } ]
+   * }
+   */
+  createHAPAccessory(api: any): any {
+    const base: any = {
+      id: this.opts.id,
+      name: this.opts.name ?? this.opts.type,
+      protocol: 'hap',
+      services: [
+        {
+          type: 'Switch',
+          characteristics: {
+            On: {
+              get: async () => {
+                const s = await this.getState()
+                return !!(s && (s.on === true || s.state === 'on' || s.power === 'on'))
+              },
+              set: async (v: any) => {
+                await this.setState({ on: !!v })
+              },
+            },
+          },
+        },
+      ],
+    }
+
+    try {
+      const hap = api?.hap
+      if (hap && hap.Service && hap.Characteristic) {
+        base._resolved = { Service: hap.Service, Characteristic: hap.Characteristic }
+      }
+    } catch (e) {
+      // ignore
+    }
+
+    return base
+  }
+
+  /**
+   * Create and return a Matter accessory descriptor.
+   *
+   * Returns a descriptor containing `clusters` and attribute read/write handlers
+   * which the platform will serialize when registering Matter accessories. The
+   * default provides an `OnOff` cluster wired to `getState()` / `setState()`.
+   *
+   * If the Homebridge `api` provides a `matter` namespace it is attached under
+   * `_resolved.matter` for callers that need direct access to the Matter API.
+   */
+  createMatterAccessory(api: any): any {
+    const base: any = {
+      id: this.opts.id,
+      name: this.opts.name ?? this.opts.type,
+      protocol: 'matter',
+      clusters: [
+        {
+          type: 'OnOff',
+          clusterId: MATTER_CLUSTER_IDS.OnOff,
+          attributes: {
+            onOff: {
+              read: async () => {
+                const s = await this.getState()
+                return !!(s && (s.on === true || s.state === 'on' || s.power === 'on'))
+              },
+              write: async (v: any) => this.setState({ on: !!v }),
+            },
+            [MATTER_ATTRIBUTE_IDS.OnOff.OnOff]: {
+              read: async () => {
+                const s = await this.getState()
+                return !!(s && (s.on === true || s.state === 'on' || s.power === 'on'))
+              },
+              write: async (v: any) => this.setState({ on: !!v }),
+            },
+          },
+        },
+      ],
+    }
+
+    try {
+      const matter = api?.matter
+      if (matter) {
+        base._resolved = {
+          matter,
+        }
+      }
+    } catch (e) {
+      // ignore
+    }
+
+    return base
+  }
+
+  async destroy(): Promise<void> {}
+}