@switchbot/homebridge-switchbot 5.0.0-beta.99 → 5.1.0-beta.0

package/dist/deviceFactory.js

@@ -1,50 +1,109 @@
+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';
-import { GenericDevice, BotDevice, CurtainDevice, FanDevice, LightDevice, LightStripDevice, MotionSensorDevice, ContactSensorDevice, VacuumDevice, LockDevice, HumidifierDevice, TemperatureSensorDevice, RelaySwitchDevice, RelaySwitch1PMDevice, PlugDevice, PlugMiniDevice, BlindTiltDevice, Curtain3Device, RollerShadeDevice, Hub2Device, MeterDevice, WaterDetectorDevice, SmartFanDevice, StripLightDevice, WalletFinderDevice, WoSweeperDevice, WoSweeperMiniDevice, WoSweeperMiniProDevice, } from './devices/genericDevice.js';
 const DEVICE_CLASS_MAP = {
-    bot: BotDevice,
-    curtain: CurtainDevice,
-    fan: FanDevice,
-    light: LightDevice,
-    lightstrip: LightStripDevice,
-    motion: MotionSensorDevice,
-    contact: ContactSensorDevice,
-    vacuum: VacuumDevice,
-    lock: LockDevice,
-    humidifier: HumidifierDevice,
-    temperature: TemperatureSensorDevice,
-    'relay switch 1': RelaySwitchDevice,
-    'relay switch 1pm': RelaySwitch1PMDevice,
-    plug: PlugDevice,
+    // Primary device type keys (lowercase, simplified)
+    'bot': BotDevice,
+    'curtain': CurtainDevice,
+    'curtain3': Curtain3Device,
+    'fan': FanDevice,
+    'light': LightDevice,
+    'lightstrip': LightStripDevice,
+    'motion': MotionSensorDevice,
+    'contact': ContactSensorDevice,
+    'vacuum': VacuumDevice,
+    // Canonical, normalized device type keys (lowercase, mapped to device classes)
+    'video doorbell': GenericDevice,
+    'smart radiator thermostat': GenericDevice,
+    'woiosensor': GenericDevice,
+    'garage door opener': GenericDevice,
+    '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,
     'plug mini (jp)': PlugMiniDevice,
     'plug mini (us)': PlugMiniDevice,
+    '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,
+    'hub mini': GenericDevice,
+    '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, // Includes evaporative humidifier mapping
+    'roller shade': RollerShadeDevice,
+    'strip light 3': StripLightDevice,
+    'circulator fan': FanDevice,
+    'smart lock pro': LockDevice,
+    'lock lite': LockDevice,
+    'keypad': LockDevice,
+    'lock vision pro': LockDevice,
+    'floor lamp': LightDevice,
+    'rgbicww floor lamp': LightStripDevice,
+    'rgbicww strip light': LightStripDevice,
+    'home climate panel': GenericDevice, // Climate panel family
+    'lock': LockDevice,
+    'humidifier2': HumidifierDevice,
+    'temperature': TemperatureSensorDevice,
+    'relay switch 1': RelaySwitchDevice,
     'blind tilt': BlindTiltDevice,
-    curtain3: Curtain3Device,
     'worollershade': RollerShadeDevice,
     'wo rollershade': RollerShadeDevice,
-    'roller shade': RollerShadeDevice,
     'rollershade': RollerShadeDevice,
-    'hub 2': Hub2Device,
-    meter: MeterDevice,
-    'meterplus': MeterDevice,
+    'meter': MeterDevice,
     'meter plus (jp)': MeterDevice,
-    'meterpro': MeterDevice,
-    'meterpro(co2)': MeterDevice,
     'water detector': WaterDetectorDevice,
     'smart fan': SmartFanDevice,
     'strip light': StripLightDevice,
-    'walletfinder': WalletFinderDevice,
     'wosweeper': WoSweeperDevice,
     'wosweepermini': WoSweeperMiniDevice,
     'wosweeperminipro': WoSweeperMiniProDevice,
     'k10+': WoSweeperDevice,
-    'k10+ pro': 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) {
-    const key = (type || '').toLowerCase();
+    const rawKey = (type || '').toLowerCase();
+    const key = DEVICE_TYPE_NORMALIZATION_MAP[rawKey] ?? rawKey;
     return DEVICE_CLASS_MAP[key] ?? GenericDevice;
 }
-export async function createDevice(opts, cfg, useMatter) {
+export async function createDevice(opts, cfg, useMatter, log) {
+    // Always pass the logger to both device opts and config
+    const logger = log || cfg?.logger || cfg?.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).
     let client = cfg?._client ?? null;
@@ -54,8 +113,24 @@ export async function createDevice(opts, cfg, useMatter) {
     }
     // Pass client via config so devices can access it
     const mergedCfg = { ...cfg, _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) {
+        deviceOpts.encryptionKey = opts.encryptionKey;
+    }
+    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(opts, mergedCfg);
+    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);
@@ -63,8 +138,9 @@ export async function createDevice(opts, cfg, useMatter) {
         try {
             // Prefer client-backed getDevice when available
             const dev = await client.getDevice(opts.id);
-            if (dev)
+            if (dev) {
                 return dev;
+            }
         }
         catch (e) {
             // ignore and fallback to device implementation
@@ -74,7 +150,9 @@ export async function createDevice(opts, cfg, useMatter) {
     // Provide accessory factory based on platform selection
     return {
         instance: device,
-        createAccessory: (api) => (useMatter ? device.createMatterAccessory(api) : device.createHAPAccessory(api)),
+        createAccessory: useMatter
+            ? async (api) => await device.createMatterAccessory(api)
+            : (api) => device.createHAPAccessory(api),
         protocol: useMatter ? 'matter' : 'hap',
     };
 }

package/dist/deviceFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"deviceFactory.js","sourceRoot":"","sources":["../src/deviceFactory.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EACL,aAAa,EACb,SAAS,EACT,aAAa,EACb,SAAS,EACT,WAAW,EACX,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACnB,YAAY,EACZ,UAAU,EACV,gBAAgB,EAChB,uBAAuB,EACvB,iBAAiB,EACjB,oBAAoB,EACpB,UAAU,EACV,cAAc,EACd,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,UAAU,EACV,WAAW,EACX,mBAAmB,EACnB,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,mBAAmB,EACnB,sBAAsB,GACvB,MAAM,4BAA4B,CAAA;AASnC,MAAM,gBAAgB,GAAwB;IAC5C,GAAG,EAAE,SAAS;IACd,OAAO,EAAE,aAAa;IACtB,GAAG,EAAE,SAAS;IACd,KAAK,EAAE,WAAW;IAClB,UAAU,EAAE,gBAAgB;IAC5B,MAAM,EAAE,kBAAkB;IAC1B,OAAO,EAAE,mBAAmB;IAC5B,MAAM,EAAE,YAAY;IACpB,IAAI,EAAE,UAAU;IAChB,UAAU,EAAE,gBAAgB;IAC5B,WAAW,EAAE,uBAAuB;IACpC,gBAAgB,EAAE,iBAAiB;IACnC,kBAAkB,EAAE,oBAAoB;IACxC,IAAI,EAAE,UAAU;IAChB,gBAAgB,EAAE,cAAc;IAChC,gBAAgB,EAAE,cAAc;IAChC,YAAY,EAAE,eAAe;IAC7B,QAAQ,EAAE,cAAc;IACxB,eAAe,EAAE,iBAAiB;IAClC,gBAAgB,EAAE,iBAAiB;IACnC,cAAc,EAAE,iBAAiB;IACjC,aAAa,EAAE,iBAAiB;IAChC,OAAO,EAAE,UAAU;IACnB,KAAK,EAAE,WAAW;IAClB,WAAW,EAAE,WAAW;IACxB,iBAAiB,EAAE,WAAW;IAC9B,UAAU,EAAE,WAAW;IACvB,eAAe,EAAE,WAAW;IAC5B,gBAAgB,EAAE,mBAAmB;IACrC,WAAW,EAAE,cAAc;IAC3B,aAAa,EAAE,gBAAgB;IAC/B,cAAc,EAAE,kBAAkB;IAClC,WAAW,EAAE,eAAe;IAC5B,eAAe,EAAE,mBAAmB;IACpC,kBAAkB,EAAE,sBAAsB;IAC1C,MAAM,EAAE,eAAe;IACvB,UAAU,EAAE,eAAe;IAC3B,6BAA6B,EAAE,sBAAsB;CACtD,CAAA;AAED,SAAS,YAAY,CAAC,IAAY;IAChC,MAAM,GAAG,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAA;IACtC,OAAO,gBAAgB,CAAC,GAAG,CAAC,IAAI,aAAa,CAAA;AAC/C,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,IAAmB,EAAE,GAA0B,EAAE,SAAkB;IACpG,mEAAmE;IACnE,6DAA6D;IAC7D,IAAI,MAAM,GAAS,GAAW,EAAE,OAAO,IAAI,IAAI,CAAA;IAC/C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,GAAG,IAAI,eAAe,CAAC,GAAG,CAAC,CAAA;QACjC,MAAM,MAAM,CAAC,IAAI,EAAE,CAAA;IACrB,CAAC;IAED,kDAAkD;IAClD,MAAM,SAAS,GAAG,EAAE,GAAI,GAAW,EAAE,OAAO,EAAE,MAAM,EAAE,CAAA;IAEtD,MAAM,UAAU,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC1C,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,CAAA;IAC9C,MAAM,MAAM,CAAC,IAAI,EAAE,CAAA;IAEnB,qEAAqE;IACrE,MAAM,gBAAgB,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IACrD,MAAM,CAAC,QAAQ,GAAG,KAAK,IAAI,EAAE;QAC3B,IAAI,CAAC;YACH,gDAAgD;YAChD,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YAC3C,IAAI,GAAG;gBAAE,OAAO,GAAG,CAAA;QACrB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,+CAA+C;QACjD,CAAC;QACD,OAAO,gBAAgB,EAAE,CAAA;IAC3B,CAAC,CAAA;IAED,wDAAwD;IACxD,OAAO;QACL,QAAQ,EAAE,MAAM;QAChB,eAAe,EAAE,CAAC,GAAQ,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;QAC/G,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK;KACvC,CAAA;AACH,CAAC"}
+{"version":3,"file":"deviceFactory.js","sourceRoot":"","sources":["../src/deviceFactory.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,6BAA6B,EAAE,MAAM,mBAAmB,CAAA;AACjE,OAAO,EACL,eAAe,EACf,SAAS,EACT,mBAAmB,EACnB,cAAc,EACd,aAAa,EACb,SAAS,EACT,aAAa,EACb,UAAU,EACV,gBAAgB,EAChB,WAAW,EACX,gBAAgB,EAChB,UAAU,EACV,WAAW,EACX,kBAAkB,EAClB,UAAU,EACV,cAAc,EACd,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,uBAAuB,EACvB,YAAY,EACZ,kBAAkB,EAClB,mBAAmB,EACnB,eAAe,EACf,mBAAmB,EACnB,sBAAsB,GACvB,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAStD,MAAM,gBAAgB,GAAwB;IAC5C,mDAAmD;IACnD,KAAK,EAAE,SAAS;IAChB,SAAS,EAAE,aAAa;IACxB,UAAU,EAAE,cAAc;IAC1B,KAAK,EAAE,SAAS;IAChB,OAAO,EAAE,WAAW;IACpB,YAAY,EAAE,gBAAgB;IAC9B,QAAQ,EAAE,kBAAkB;IAC5B,SAAS,EAAE,mBAAmB;IAC9B,QAAQ,EAAE,YAAY;IACtB,+EAA+E;IAC/E,gBAAgB,EAAE,aAAa;IAC/B,2BAA2B,EAAE,aAAa;IAC1C,YAAY,EAAE,aAAa;IAC3B,oBAAoB,EAAE,aAAa;IACnC,0BAA0B,EAAE,aAAa;IACzC,kBAAkB,EAAE,aAAa;IACjC,wBAAwB,EAAE,aAAa;IACvC,WAAW,EAAE,WAAW;IACxB,UAAU,EAAE,WAAW;IACvB,eAAe,EAAE,WAAW;IAC5B,cAAc,EAAE,kBAAkB;IAClC,MAAM,EAAE,UAAU;IAClB,gBAAgB,EAAE,cAAc;IAChC,gBAAgB,EAAE,cAAc;IAChC,gBAAgB,EAAE,cAAc;IAChC,kBAAkB,EAAE,oBAAoB;IACxC,kBAAkB,EAAE,oBAAoB;IACxC,UAAU,EAAE,eAAe;IAC3B,qCAAqC,EAAE,eAAe;IACtD,2BAA2B,EAAE,eAAe;IAC5C,mCAAmC,EAAE,eAAe;IACpD,QAAQ,EAAE,aAAa;IACvB,KAAK,EAAE,aAAa;IACpB,OAAO,EAAE,UAAU;IACnB,OAAO,EAAE,aAAa;IACtB,UAAU,EAAE,aAAa;IACzB,UAAU,EAAE,aAAa;IACzB,YAAY,EAAE,aAAa;IAC3B,cAAc,EAAE,aAAa;IAC7B,iBAAiB,EAAE,aAAa;IAChC,sBAAsB,EAAE,aAAa;IACrC,sBAAsB,EAAE,aAAa;IACrC,YAAY,EAAE,gBAAgB,EAAE,0CAA0C;IAC1E,cAAc,EAAE,iBAAiB;IACjC,eAAe,EAAE,gBAAgB;IACjC,gBAAgB,EAAE,SAAS;IAC3B,gBAAgB,EAAE,UAAU;IAC5B,WAAW,EAAE,UAAU;IACvB,QAAQ,EAAE,UAAU;IACpB,iBAAiB,EAAE,UAAU;IAC7B,YAAY,EAAE,WAAW;IACzB,oBAAoB,EAAE,gBAAgB;IACtC,qBAAqB,EAAE,gBAAgB;IACvC,oBAAoB,EAAE,aAAa,EAAE,uBAAuB;IAC5D,MAAM,EAAE,UAAU;IAClB,aAAa,EAAE,gBAAgB;IAC/B,aAAa,EAAE,uBAAuB;IACtC,gBAAgB,EAAE,iBAAiB;IACnC,YAAY,EAAE,eAAe;IAC7B,eAAe,EAAE,iBAAiB;IAClC,gBAAgB,EAAE,iBAAiB;IACnC,aAAa,EAAE,iBAAiB;IAChC,OAAO,EAAE,WAAW;IACpB,iBAAiB,EAAE,WAAW;IAC9B,gBAAgB,EAAE,mBAAmB;IACrC,WAAW,EAAE,cAAc;IAC3B,aAAa,EAAE,gBAAgB;IAC/B,WAAW,EAAE,eAAe;IAC5B,eAAe,EAAE,mBAAmB;IACpC,kBAAkB,EAAE,sBAAsB;IAC1C,MAAM,EAAE,eAAe;IACvB,6BAA6B,EAAE,sBAAsB;IACrD,wBAAwB,EAAE,SAAS;IACnC,yBAAyB,EAAE,SAAS;IACpC,YAAY,EAAE,UAAU;IACxB,kBAAkB,EAAE,UAAU;IAC9B,cAAc,EAAE,UAAU;IAC1B,eAAe,EAAE,UAAU;IAC3B,mBAAmB,EAAE,UAAU;IAC/B,YAAY,EAAE,WAAW;IACzB,eAAe,EAAE,WAAW;IAC5B,mBAAmB,EAAE,WAAW;IAChC,oBAAoB,EAAE,WAAW;IACjC,uBAAuB,EAAE,gBAAgB;IACzC,4BAA4B,EAAE,gBAAgB;IAC9C,yBAAyB,EAAE,YAAY;IACvC,8BAA8B,EAAE,YAAY;IAC5C,0BAA0B,EAAE,YAAY;IACxC,0BAA0B,EAAE,YAAY;CACzC,CAAA;AAED,SAAS,YAAY,CAAC,IAAY;IAChC,MAAM,MAAM,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAA;IACzC,MAAM,GAAG,GAAG,6BAA6B,CAAC,MAAM,CAAC,IAAI,MAAM,CAAA;IAC3D,OAAO,gBAAgB,CAAC,GAAG,CAAC,IAAI,aAAa,CAAA;AAC/C,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,IAAmB,EAAE,GAA0B,EAAE,SAAkB,EAAE,GAAY;IAClH,wDAAwD;IACxD,MAAM,MAAM,GAAG,GAAG,IAAK,GAAW,EAAE,MAAM,IAAK,GAAW,EAAE,GAAG,CAAA;IAC/D,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QACrE,MAAM,CAAC,IAAI,CAAC,iDAAiD,IAAI,CAAC,IAAI,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;IAC3G,CAAC;IACD,mEAAmE;IACnE,6DAA6D;IAC7D,IAAI,MAAM,GAAS,GAAW,EAAE,OAAO,IAAI,IAAI,CAAA;IAC/C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,GAAG,IAAI,eAAe,CAAC,GAAG,CAAC,CAAA;QACjC,MAAM,MAAM,CAAC,IAAI,EAAE,CAAA;IACrB,CAAC;IACD,kDAAkD;IAClD,MAAM,SAAS,GAAG,EAAE,GAAI,GAAW,EAAE,OAAO,EAAE,MAAM,EAAE,CAAA;IACtD,kCAAkC;IAClC,IAAI,MAAM,EAAE,CAAC;QACX,SAAS,CAAC,GAAG,GAAG,MAAM,CAAA;IACxB,CAAC;IACD,yDAAyD;IACzD,MAAM,UAAU,GAAG,EAAE,GAAG,IAAI,EAAE,CAAA;IAC9B,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;QACvB,UAAU,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAA;IAC/C,CAAC;IACD,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,UAAU,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;IAC/B,CAAC;IACD,mCAAmC;IACnC,IAAI,MAAM,EAAE,CAAC;QACX,UAAU,CAAC,GAAG,GAAG,MAAM,CAAA;IACzB,CAAC;IACD,MAAM,UAAU,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC1C,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,UAAU,EAAE,SAAS,CAAC,CAAA;IACpD,MAAM,MAAM,CAAC,IAAI,EAAE,CAAA;IAEnB,qEAAqE;IACrE,MAAM,gBAAgB,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IACrD,MAAM,CAAC,QAAQ,GAAG,KAAK,IAAI,EAAE;QAC3B,IAAI,CAAC;YACH,gDAAgD;YAChD,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YAC3C,IAAI,GAAG,EAAE,CAAC;gBACR,OAAO,GAAG,CAAA;YACZ,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,+CAA+C;QACjD,CAAC;QACD,OAAO,gBAAgB,EAAE,CAAA;IAC3B,CAAC,CAAA;IAED,wDAAwD;IACxD,OAAO;QACL,QAAQ,EAAE,MAAM;QAChB,eAAe,EAAE,SAAS;YACxB,CAAC,CAAC,KAAK,EAAE,GAAQ,EAAE,EAAE,CAAC,MAAM,MAAM,CAAC,qBAAqB,CAAC,GAAG,CAAC;YAC7D,CAAC,CAAC,CAAC,GAAQ,EAAE,EAAE,CAAC,MAAM,CAAC,kBAAkB,CAAC,GAAG,CAAC;QAChD,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK;KACvC,CAAA;AACH,CAAC"}

package/dist/devices/genericDevice.d.ts

@@ -1,11 +1,66 @@
+/**
+ * Status Update Strategy for BLE and OpenAPI
+ *
+ * BLE (Bluetooth Low Energy):
+ * - Primary: Subscribes to device notifications for real-time state updates using _subscribeBLENotifications().
+ * - Fallback: (Recommended) Optionally, a low-frequency polling timer (e.g., every 5–10 minutes) can call getState() to recover from missed notifications or connection loss.
+ *   - This ensures state stays in sync even if notifications are unreliable or the device reconnects.
+ *   - Polling should be infrequent to avoid battery drain and BLE congestion.
+ *
+ * BLE Polling Options (config & per-device):
+ * - blePollingEnabled (boolean): Enable/disable BLE polling fallback (default: true).
+ * - blePollIntervalMs (integer): Polling interval in ms (default: 600000, min: 60000).
+ *   - These can be set globally in config or overridden per device.
+ *   - Setting a lower interval increases update frequency but may drain battery faster.
+ *   - Setting a higher interval reduces battery impact but may delay state recovery.
+ *
+ * OpenAPI (Cloud):
+ * - Uses periodic polling to fetch device status at a configurable interval (default: 300 seconds, can be set per device or platform).
+ * - Platform supports batched refresh (matterBatchEnabled, matterBatchRefreshRate, etc.) and per-device refreshRate overrides.
+ * - Rate limiting:
+ *   - Default daily limit: 10,000 OpenAPI requests (configurable via options.dailyApiLimit).
+ *   - Reserve: 1,000 requests for user commands (options.dailyApiReserveForCommands).
+ *   - When the remaining budget reaches the reserve, background polling/discovery pauses, but user commands and webhooks continue.
+ *   - Counter resets at local or UTC midnight (options.dailyApiResetLocalMidnight).
+ *
+ * Best Practices:
+ * - BLE: Use notifications for instant updates, add periodic polling as a safety net.
+ * - OpenAPI: Tune polling intervals to balance freshness and rate limit budget.
+ * - Both: Document and expose polling intervals and rate limit settings in config.
+ *
+ * See README.md and docs for more details.
+ */
 import type { SwitchBotPluginConfig } from '../settings.js';
+import { Buffer } from 'node:buffer';
 import { DeviceBase } from './deviceBase.js';
 export declare class GenericDevice extends DeviceBase {
+    protected log: import('homebridge').Logger;
+    private _blePollTimer;
+    private _blePollIntervalMs;
+    private _blePollingEnabled;
     constructor(opts: any, cfg: SwitchBotPluginConfig);
+    /**
+     * Start periodic BLE polling as a fallback to notifications.
+     */
+    private _startBlePolling;
+    /**
+     * Clean up BLE polling timer on destroy.
+     */
+    destroy(): Promise<void>;
+    /**
+     * Subscribe to BLE notifications for this device (if supported by node-switchbot)
+     * Logs unsolicited notifications and enables per-command notification futures.
+     */
+    private _subscribeBLENotifications;
+    /**
+     * Await a BLE notification for this device (for advanced use in subclasses)
+     * Returns the notification payload or throws on timeout.
+     */
+    protected _awaitBLENotification(timeoutMs?: number): Promise<Buffer>;
     getState(): Promise<any>;
     setState(change: any): Promise<any>;
     createHAPAccessory(api: any): any;
-    createMatterAccessory(api: any): any;
+    createMatterAccessory(api: any): Promise<any>;
 }
 export declare class BotDevice extends GenericDevice {
 }
@@ -24,7 +79,7 @@ export declare class CurtainDevice extends GenericDevice {
             };
         }[];
     };
-    createMatterAccessory(api: any): any;
+    createMatterAccessory(api: any): Promise<any>;
 }
 export declare class FanDevice extends GenericDevice {
     createHAPAccessory(api: any): {
@@ -154,7 +209,7 @@ export declare class HumidifierDevice extends GenericDevice {
                     set: (v: any) => Promise<void>;
                 };
                 CurrentHumidifierDehumidifierState: {
-                    get: () => Promise<2 | 0>;
+                    get: () => Promise<0 | 2>;
                 };
                 TargetHumidifierDehumidifierState: {
                     get: () => Promise<number>;
@@ -173,40 +228,7 @@ export declare class HumidifierDevice extends GenericDevice {
     setState(change: any): Promise<any>;
 }
 export declare class HumidifierMatterDevice extends HumidifierDevice {
-    createMatterAccessory(api: any): {
-        id: string;
-        name: string;
-        protocol: string;
-        clusters: ({
-            type: string;
-            clusterId: 1029;
-            attributes: {
-                currentRelativeHumidity: {
-                    read: () => Promise<any>;
-                    write: undefined;
-                };
-                0: {
-                    read: () => Promise<any>;
-                    write: undefined;
-                };
-                onOff?: undefined;
-            };
-        } | {
-            type: string;
-            clusterId: 6;
-            attributes: {
-                onOff: {
-                    read: () => Promise<boolean>;
-                    write: (v: any) => Promise<any>;
-                };
-                0: {
-                    read: () => Promise<boolean>;
-                    write: (v: any) => Promise<any>;
-                };
-                currentRelativeHumidity?: undefined;
-            };
-        })[];
-    };
+    createMatterAccessory(api: any): Promise<any>;
 }
 export declare class TemperatureSensorDevice extends GenericDevice {
     createHAPAccessory(api: any): {

package/dist/devices/genericDevice.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"genericDevice.d.ts","sourceRoot":"","sources":["../../src/devices/genericDevice.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAA;AAG3D,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAE5C,qBAAa,aAAc,SAAQ,UAAU;gBAC/B,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,qBAAqB;IAI3C,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC;IAmBxB,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAyEzC,kBAAkB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG;IA0BjC,qBAAqB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG;CAiErC;AAGD,qBAAa,SAAU,SAAQ,aAAa;CAAG;AAE/C,qBAAa,aAAc,SAAQ,aAAa;IAC9C,kBAAkB,CAAC,GAAG,EAAE,GAAG;;;;;;;;;6BAiBA,GAAG;;;;;IAW9B,qBAAqB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG;CAoBrC;AAED,qBAAa,SAAU,SAAQ,aAAa;IAC1C,kBAAkB,CAAC,GAAG,EAAE,GAAG;;;;;;6BAWA,GAAG;;;;6BASH,GAAG;;;;;IAUxB,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAwCzC,qBAAqB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG;CA8BrC;AACD,qBAAa,WAAY,SAAQ,aAAa;IAC5C,kBAAkB,CAAC,GAAG,EAAE,GAAG;;;;;;6BAWA,GAAG;;;;;;;;;6BAUH,GAAG;;;;;;;;;6BAqCH,GAAG;;;;;;;;;6BAuBH,GAAG;;;;;;;;;6BAiBH,GAAG;;;;;IAUxB,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAiDzC,qBAAqB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG;CA4CrC;AAED,qBAAa,gBAAiB,SAAQ,WAAW;CAAG;AAEpD,qBAAa,kBAAmB,SAAQ,aAAa;IACnD,kBAAkB,CAAC,GAAG,EAAE,GAAG;;;;;;;;;;IAkBrB,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;CAsC1C;AAED,qBAAa,mBAAoB,SAAQ,aAAa;IACpD,kBAAkB,CAAC,GAAG,EAAE,GAAG;;;;;;;;;;CAiB5B;AAED,qBAAa,YAAa,SAAQ,aAAa;IAE7C,kBAAkB,CAAC,GAAG,EAAE,GAAG;CAG5B;AAED,qBAAa,UAAW,SAAQ,aAAa;IAC3C,kBAAkB,CAAC,GAAG,EAAE,GAAG;;;;;;;;;6BAiBA,GAAG;;;;;IAUxB,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IA0DzC,qBAAqB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG;CA6BrC;AAED,qBAAa,gBAAiB,SAAQ,aAAa;IACjD,kBAAkB,CAAC,GAAG,EAAE,GAAG;;;;;;6BAWA,GAAG;;;;;;;6BAYH,GAAG;;;;;;;6BAeH,GAAG;;;;;IAUxB,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;CAgC1C;AAGD,qBAAa,sBAAuB,SAAQ,gBAAgB;IAC1D,qBAAqB,CAAC,GAAG,EAAE,GAAG;;;;;;;;;;;;;;;;;;;;;;;;+BAmB6E,GAAG;;;;+BAC0B,GAAG;;;;;;CAM5I;AAED,qBAAa,uBAAwB,SAAQ,aAAa;IACxD,kBAAkB,CAAC,GAAG,EAAE,GAAG;;;;;;;;;;CAiB5B;AAGD,qBAAa,iBAAkB,SAAQ,aAAa;CAAG;AACvD,qBAAa,oBAAqB,SAAQ,aAAa;CAAG;AAC1D,qBAAa,UAAW,SAAQ,aAAa;IAC3C,kBAAkB,CAAC,GAAG,EAAE,GAAG;;;;;;6BAWA,GAAG;;;;;;;;CAe/B;AAED,qBAAa,cAAe,SAAQ,UAAU;CAAG;AAEjD,qBAAa,eAAgB,SAAQ,aAAa;CAAG;AACrD,qBAAa,cAAe,SAAQ,aAAa;CAAG;AACpD,qBAAa,iBAAkB,SAAQ,aAAa;CAAG;AAEvD,qBAAa,UAAW,SAAQ,aAAa;CAAG;AAEhD,qBAAa,WAAY,SAAQ,aAAa;IAC5C,kBAAkB,CAAC,GAAG,EAAE,GAAG;;;;;;;;;;;;;;;;;;;CA4B5B;AAED,qBAAa,mBAAoB,SAAQ,aAAa;IACpD,kBAAkB,CAAC,GAAG,EAAE,GAAG;;;;;;;;;;CAiB5B;AAED,qBAAa,cAAe,SAAQ,SAAS;CAAG;AAEhD,qBAAa,gBAAiB,SAAQ,gBAAgB;CAAG;AAEzD,qBAAa,kBAAmB,SAAQ,aAAa;CAAG;AAGxD,qBAAa,eAAgB,SAAQ,YAAY;CAAG;AACpD,qBAAa,mBAAoB,SAAQ,YAAY;CAAG;AACxD,qBAAa,sBAAuB,SAAQ,YAAY;CAAG"}
+{"version":3,"file":"genericDevice.d.ts","sourceRoot":"","sources":["../../src/devices/genericDevice.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAA;AAE3D,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAGpC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAgB5C,qBAAa,aAAc,SAAQ,UAAU;IAC3C,SAAS,CAAC,GAAG,EAAE,OAAO,YAAY,EAAE,MAAM,CAAA;IAC1C,OAAO,CAAC,aAAa,CAA8B;IACnD,OAAO,CAAC,kBAAkB,CAAQ;IAClC,OAAO,CAAC,kBAAkB,CAAS;gBAEvB,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,qBAAqB;IAqCjD;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAcxB;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAY9B;;;OAGG;YACW,0BAA0B;IA0BxC;;;OAGG;cACa,qBAAqB,CAAC,SAAS,SAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAuBlE,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC;IA0BxB,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAyEzC,kBAAkB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG;IA0B3B,qBAAqB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;CAsKpD;AAGD,qBAAa,SAAU,SAAQ,aAAa;CAAG;AAE/C,qBAAa,aAAc,SAAQ,aAAa;IAC9C,kBAAkB,CAAC,GAAG,EAAE,GAAG;;;;;;;;;6BAiBA,GAAG;;;;;IAWxB,qBAAqB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;CA2EpD;AAED,qBAAa,SAAU,SAAQ,aAAa;IAC1C,kBAAkB,CAAC,GAAG,EAAE,GAAG;;;;;;6BAWA,GAAG;;;;6BASH,GAAG;;;;;IAUxB,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAwCzC,qBAAqB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG;CA8BrC;AACD,qBAAa,WAAY,SAAQ,aAAa;IAC5C,kBAAkB,CAAC,GAAG,EAAE,GAAG;;;;;;6BAWA,GAAG;;;;;;;;;6BAUH,GAAG;;;;;;;;;6BAqCH,GAAG;;;;;;;;;6BAuBH,GAAG;;;;;;;;;6BAiBH,GAAG;;;;;IAUxB,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAiDzC,qBAAqB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG;CA8CrC;AAED,qBAAa,gBAAiB,SAAQ,WAAW;CAAG;AAEpD,qBAAa,kBAAmB,SAAQ,aAAa;IACnD,kBAAkB,CAAC,GAAG,EAAE,GAAG;;;;;;;;;;IAkBrB,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;CAsC1C;AAED,qBAAa,mBAAoB,SAAQ,aAAa;IACpD,kBAAkB,CAAC,GAAG,EAAE,GAAG;;;;;;;;;;CAiB5B;AAED,qBAAa,YAAa,SAAQ,aAAa;IAE7C,kBAAkB,CAAC,GAAG,EAAE,GAAG;CAG5B;AAED,qBAAa,UAAW,SAAQ,aAAa;IAC3C,kBAAkB,CAAC,GAAG,EAAE,GAAG;;;;;;;;;6BAiBA,GAAG;;;;;IAUxB,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IA0DzC,qBAAqB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG;CA6BrC;AAED,qBAAa,gBAAiB,SAAQ,aAAa;IACjD,kBAAkB,CAAC,GAAG,EAAE,GAAG;;;;;;6BAWA,GAAG;;;;;;;6BAYH,GAAG;;;;;;;6BAeH,GAAG;;;;;IAUxB,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;CAgC1C;AAGD,qBAAa,sBAAuB,SAAQ,gBAAgB;IACpD,qBAAqB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;CA0BpD;AAED,qBAAa,uBAAwB,SAAQ,aAAa;IACxD,kBAAkB,CAAC,GAAG,EAAE,GAAG;;;;;;;;;;CAiB5B;AAGD,qBAAa,iBAAkB,SAAQ,aAAa;CAAG;AACvD,qBAAa,oBAAqB,SAAQ,aAAa;CAAG;AAC1D,qBAAa,UAAW,SAAQ,aAAa;IAC3C,kBAAkB,CAAC,GAAG,EAAE,GAAG;;;;;;6BAWA,GAAG;;;;;;;;CAe/B;AAED,qBAAa,cAAe,SAAQ,UAAU;CAAG;AAEjD,qBAAa,eAAgB,SAAQ,aAAa;CAAG;AACrD,qBAAa,cAAe,SAAQ,aAAa;CAAG;AACpD,qBAAa,iBAAkB,SAAQ,aAAa;CAAG;AAEvD,qBAAa,UAAW,SAAQ,aAAa;CAAG;AAEhD,qBAAa,WAAY,SAAQ,aAAa;IAC5C,kBAAkB,CAAC,GAAG,EAAE,GAAG;;;;;;;;;;;;;;;;;;;CA4B5B;AAED,qBAAa,mBAAoB,SAAQ,aAAa;IACpD,kBAAkB,CAAC,GAAG,EAAE,GAAG;;;;;;;;;;CAiB5B;AAED,qBAAa,cAAe,SAAQ,SAAS;CAAG;AAEhD,qBAAa,gBAAiB,SAAQ,gBAAgB;CAAG;AAEzD,qBAAa,kBAAmB,SAAQ,aAAa;CAAG;AAGxD,qBAAa,eAAgB,SAAQ,YAAY;CAAG;AACpD,qBAAa,mBAAoB,SAAQ,YAAY;CAAG;AACxD,qBAAa,sBAAuB,SAAQ,YAAY;CAAG"}