@switchbot/homebridge-switchbot 5.0.0-beta.1 → 5.0.0-beta.2

package/src/devices-matter/ExtendedColorLightAccessory.ts

@@ -8,56 +8,52 @@ import type { API, Logger, MatterRequests } from 'homebridge'
 import { BaseMatterAccessory } from './BaseMatterAccessory.js'
 
 export class ExtendedColorLightAccessory extends BaseMatterAccessory {
-  constructor(api: API, log: Logger) {
-    const serialNumber = 'LIGHT-005'
-    super(api, log, {
-      uuid: api.matter.uuid.generate(serialNumber),
-      displayName: 'Extended Colour Light (HS+CCT)',
-      deviceType: api.matter.deviceTypes.ExtendedColorLight,
-      serialNumber,
-      manufacturer: 'Homebridge Matter',
-      model: 'HB-MATTER-LIGHT-EXTENDED-COLOUR',
-      firmwareRevision: '2.0.0',
-      hardwareRevision: '1.0.0',
-
-      clusters: {
-        onOff: { onOff: false },
-        levelControl: {
-          currentLevel: 127,
-          minLevel: 1,
-          maxLevel: 254,
-        },
-        colorControl: {
-          colorMode: api.matter.types.ColorControl.ColorMode.CurrentHueAndCurrentSaturation,
-          currentHue: 0,
-          currentSaturation: 254,
-          currentX: 41942,
-          currentY: 21626,
-          colorTemperatureMireds: 250,
-          colorTempPhysicalMinMireds: 147,
-          colorTempPhysicalMaxMireds: 454,
-          coupleColorTempToLevelMinMireds: 147,
-        },
+  constructor(api: API, log: Logger, opts?: Partial<import('./BaseMatterAccessory').BaseMatterAccessoryConfig & { deviceId?: string }>) {
+    const serialNumber = opts?.serialNumber ?? 'LIGHT-005'
+    const displayName = opts?.displayName ?? 'Extended Colour Light (HS+CCT)'
+    const manufacturer = opts?.manufacturer ?? 'Homebridge Matter'
+    const model = opts?.model ?? 'HB-MATTER-LIGHT-EXTENDED-COLOUR'
+    const firmwareRevision = opts?.firmwareRevision ?? '2.0.0'
+    const hardwareRevision = opts?.hardwareRevision ?? '1.0.0'
+
+    const clusters = opts?.clusters ?? {
+      onOff: { onOff: false },
+      levelControl: { currentLevel: 127, minLevel: 1, maxLevel: 254 },
+      colorControl: {
+        colorMode: api.matter.types.ColorControl.ColorMode.CurrentHueAndCurrentSaturation,
+        currentHue: 0,
+        currentSaturation: 254,
+        currentX: 41942,
+        currentY: 21626,
+        colorTemperatureMireds: 250,
+        colorTempPhysicalMinMireds: 147,
+        colorTempPhysicalMaxMireds: 454,
+        coupleColorTempToLevelMinMireds: 147,
       },
+    }
 
-      handlers: {
-        onOff: {
-          on: async () => this.handleOn(),
-          off: async () => this.handleOff(),
-        },
-        levelControl: {
-          moveToLevelWithOnOff: async (request: MatterRequests.MoveToLevel) =>
-            this.handleSetLevel(request),
-        },
-        colorControl: {
-          moveToColorLogic: async (request: MatterRequests.MoveToColor) =>
-            this.handleSetColor(request),
-          moveToHueAndSaturationLogic: async (request: MatterRequests.MoveToHueAndSaturation) =>
-            this.handleSetHueSaturation(request),
-          moveToColorTemperatureLogic: async (request: MatterRequests.MoveToColorTemperature) =>
-            this.handleSetColorTemperature(request),
-        },
+    const handlers = opts?.handlers ?? {
+      onOff: { on: async () => this.handleOn(), off: async () => this.handleOff() },
+      levelControl: { moveToLevelWithOnOff: async (request: MatterRequests.MoveToLevel) => this.handleSetLevel(request) },
+      colorControl: {
+        moveToColorLogic: async (request: MatterRequests.MoveToColor) => this.handleSetColor(request),
+        moveToHueAndSaturationLogic: async (request: MatterRequests.MoveToHueAndSaturation) => this.handleSetHueSaturation(request),
+        moveToColorTemperatureLogic: async (request: MatterRequests.MoveToColorTemperature) => this.handleSetColorTemperature(request),
       },
+    }
+
+    super(api, log, {
+      uuid: opts?.uuid ?? api.matter.uuid.generate(serialNumber),
+      displayName,
+      deviceType: api.matter.deviceTypes.ExtendedColorLight,
+      serialNumber,
+      manufacturer,
+      model,
+      firmwareRevision,
+      hardwareRevision,
+      clusters,
+      handlers,
+      context: { deviceId: opts?.deviceId, ...(opts?.context ?? {}) },
     })
 
     this.logInfo('initialized.')

package/src/devices-matter/FanAccessory.ts

@@ -7,35 +7,43 @@ import type { API, Logger, MatterRequests } from 'homebridge'
 import { BaseMatterAccessory } from './BaseMatterAccessory.js'
 
 export class FanAccessory extends BaseMatterAccessory {
-  constructor(api: API, log: Logger) {
-    const serialNumber = 'FAN-001'
-    super(api, log, {
-      uuid: api.matter.uuid.generate(serialNumber),
-      displayName: 'Fan',
-      deviceType: api.matter.deviceTypes.Fan,
-      serialNumber,
-      manufacturer: 'Homebridge Matter',
-      model: 'HB-MATTER-FAN',
-      firmwareRevision: '2.0.0',
-      hardwareRevision: '1.0.0',
+  constructor(api: API, log: Logger, opts?: Partial<import('./BaseMatterAccessory').BaseMatterAccessoryConfig & { deviceId?: string }>) {
+    const serialNumber = opts?.serialNumber ?? 'FAN-001'
+    const displayName = opts?.displayName ?? 'Fan'
+    const manufacturer = opts?.manufacturer ?? 'Homebridge Matter'
+    const model = opts?.model ?? 'HB-MATTER-FAN'
+    const firmwareRevision = opts?.firmwareRevision ?? '2.0.0'
+    const hardwareRevision = opts?.hardwareRevision ?? '1.0.0'
 
-      clusters: {
-        fanControl: {
-          fanMode: api.matter.types.FanControl.FanMode.Off,
-          fanModeSequence: api.matter.types.FanControl.FanModeSequence.OffLowMedHigh,
-          percentSetting: 0,
-          percentCurrent: 0,
-        },
+    const clusters = opts?.clusters ?? {
+      fanControl: {
+        fanMode: api.matter.types.FanControl.FanMode.Off,
+        fanModeSequence: api.matter.types.FanControl.FanModeSequence.OffLowMedHigh,
+        percentSetting: 0,
+        percentCurrent: 0,
       },
+    }
 
-      handlers: {
-        fanControl: {
-          step: async (request: MatterRequests.FanStep) => this.handleStep(request),
-          fanModeChange: async (request: { fanMode: number, oldFanMode: number }) => this.handleFanModeChange(request),
-          percentSettingChange: async (request: { percentSetting: number | null, oldPercentSetting: number | null }) =>
-            this.handlePercentSettingChange(request),
-        },
+    const handlers = opts?.handlers ?? {
+      fanControl: {
+        step: async (request: MatterRequests.FanStep) => this.handleStep(request),
+        fanModeChange: async (request: { fanMode: number, oldFanMode: number }) => this.handleFanModeChange(request),
+        percentSettingChange: async (request: { percentSetting: number | null, oldPercentSetting: number | null }) => this.handlePercentSettingChange(request),
       },
+    }
+
+    super(api, log, {
+      uuid: opts?.uuid ?? api.matter.uuid.generate(serialNumber),
+      displayName,
+      deviceType: api.matter.deviceTypes.Fan,
+      serialNumber,
+      manufacturer,
+      model,
+      firmwareRevision,
+      hardwareRevision,
+      clusters,
+      handlers,
+      context: { deviceId: opts?.deviceId, ...(opts?.context ?? {}) },
     })
 
     this.logInfo('initialized.')

package/src/devices-matter/HumiditySensorAccessory.ts

@@ -7,25 +7,27 @@ import type { API, Logger } from 'homebridge'
 import { BaseMatterAccessory } from './BaseMatterAccessory.js'
 
 export class HumiditySensorAccessory extends BaseMatterAccessory {
-  constructor(api: API, log: Logger) {
-    const serialNumber = 'SENSOR-005'
+  constructor(api: API, log: Logger, opts?: Partial<import('./BaseMatterAccessory').BaseMatterAccessoryConfig & { deviceId?: string }>) {
+    const serialNumber = opts?.serialNumber ?? 'SENSOR-005'
+    const displayName = opts?.displayName ?? 'Humidity Sensor'
+    const manufacturer = opts?.manufacturer ?? 'Homebridge Matter'
+    const model = opts?.model ?? 'HB-MATTER-SENSOR-HUMIDITY'
+    const firmwareRevision = opts?.firmwareRevision ?? '2.0.0'
+    const hardwareRevision = opts?.hardwareRevision ?? '1.0.0'
+
+    const clusters = opts?.clusters ?? { relativeHumidityMeasurement: { measuredValue: 5500, minMeasuredValue: 0, maxMeasuredValue: 10000 } }
+
     super(api, log, {
-      uuid: api.matter.uuid.generate(serialNumber),
-      displayName: 'Humidity Sensor',
+      uuid: opts?.uuid ?? api.matter.uuid.generate(serialNumber),
+      displayName,
       deviceType: api.matter.deviceTypes.HumiditySensor,
       serialNumber,
-      manufacturer: 'Homebridge Matter',
-      model: 'HB-MATTER-SENSOR-HUMIDITY',
-      firmwareRevision: '2.0.0',
-      hardwareRevision: '1.0.0',
-
-      clusters: {
-        relativeHumidityMeasurement: {
-          measuredValue: 5500, // 55% (in hundredths of a percent)
-          minMeasuredValue: 0,
-          maxMeasuredValue: 10000,
-        },
-      },
+      manufacturer,
+      model,
+      firmwareRevision,
+      hardwareRevision,
+      clusters,
+      context: { deviceId: opts?.deviceId, ...(opts?.context ?? {}) },
     })
 
     this.logInfo('initialized.')

package/src/devices-matter/LeakSensorAccessory.ts

@@ -7,23 +7,27 @@ import type { API, Logger } from 'homebridge'
 import { BaseMatterAccessory } from './BaseMatterAccessory.js'
 
 export class LeakSensorAccessory extends BaseMatterAccessory {
-  constructor(api: API, log: Logger) {
-    const serialNumber = 'SENSOR-007'
+  constructor(api: API, log: Logger, opts?: Partial<import('./BaseMatterAccessory').BaseMatterAccessoryConfig & { deviceId?: string }>) {
+    const serialNumber = opts?.serialNumber ?? 'SENSOR-007'
+    const displayName = opts?.displayName ?? 'Leak Sensor'
+    const manufacturer = opts?.manufacturer ?? 'Homebridge Matter'
+    const model = opts?.model ?? 'HB-MATTER-SENSOR-LEAK'
+    const firmwareRevision = opts?.firmwareRevision ?? '2.0.0'
+    const hardwareRevision = opts?.hardwareRevision ?? '1.0.0'
+
+    const clusters = opts?.clusters ?? { booleanState: { stateValue: false } }
+
     super(api, log, {
-      uuid: api.matter.uuid.generate(serialNumber),
-      displayName: 'Leak Sensor',
+      uuid: opts?.uuid ?? api.matter.uuid.generate(serialNumber),
+      displayName,
       deviceType: api.matter.deviceTypes.LeakSensor,
       serialNumber,
-      manufacturer: 'Homebridge Matter',
-      model: 'HB-MATTER-SENSOR-LEAK',
-      firmwareRevision: '2.0.0',
-      hardwareRevision: '1.0.0',
-
-      clusters: {
-        booleanState: {
-          stateValue: false, // false = dry, true = leak
-        },
-      },
+      manufacturer,
+      model,
+      firmwareRevision,
+      hardwareRevision,
+      clusters,
+      context: { deviceId: opts?.deviceId, ...(opts?.context ?? {}) },
     })
 
     this.logInfo('initialized.')

package/src/devices-matter/LightSensorAccessory.ts

@@ -7,25 +7,27 @@ import type { API, Logger } from 'homebridge'
 import { BaseMatterAccessory } from './BaseMatterAccessory.js'
 
 export class LightSensorAccessory extends BaseMatterAccessory {
-  constructor(api: API, log: Logger) {
-    const serialNumber = 'SENSOR-002'
+  constructor(api: API, log: Logger, opts?: Partial<import('./BaseMatterAccessory').BaseMatterAccessoryConfig & { deviceId?: string }>) {
+    const serialNumber = opts?.serialNumber ?? 'SENSOR-002'
+    const displayName = opts?.displayName ?? 'Light Sensor'
+    const manufacturer = opts?.manufacturer ?? 'Homebridge Matter'
+    const model = opts?.model ?? 'HB-MATTER-SENSOR-LIGHT'
+    const firmwareRevision = opts?.firmwareRevision ?? '2.0.0'
+    const hardwareRevision = opts?.hardwareRevision ?? '1.0.0'
+
+    const clusters = opts?.clusters ?? { illuminanceMeasurement: { measuredValue: 5000, minMeasuredValue: 1, maxMeasuredValue: 65534 } }
+
     super(api, log, {
-      uuid: api.matter.uuid.generate(serialNumber),
-      displayName: 'Light Sensor',
+      uuid: opts?.uuid ?? api.matter.uuid.generate(serialNumber),
+      displayName,
       deviceType: api.matter.deviceTypes.LightSensor,
       serialNumber,
-      manufacturer: 'Homebridge Matter',
-      model: 'HB-MATTER-SENSOR-LIGHT',
-      firmwareRevision: '2.0.0',
-      hardwareRevision: '1.0.0',
-
-      clusters: {
-        illuminanceMeasurement: {
-          measuredValue: 5000,
-          minMeasuredValue: 1,
-          maxMeasuredValue: 65534,
-        },
-      },
+      manufacturer,
+      model,
+      firmwareRevision,
+      hardwareRevision,
+      clusters,
+      context: { deviceId: opts?.deviceId, ...(opts?.context ?? {}) },
     })
 
     this.logInfo('initialized.')

package/src/devices-matter/OccupancySensorAccessory.ts

@@ -7,37 +7,33 @@ import type { API, Logger } from 'homebridge'
 import { BaseMatterAccessory } from './BaseMatterAccessory.js'
 
 export class OccupancySensorAccessory extends BaseMatterAccessory {
-  constructor(api: API, log: Logger) {
-    const serialNumber = 'SENSOR-003'
+  constructor(api: API, log: Logger, opts?: Partial<import('./BaseMatterAccessory').BaseMatterAccessoryConfig & { deviceId?: string }>) {
+    const serialNumber = opts?.serialNumber ?? 'SENSOR-003'
     // Note: Matter.js API calls this "MotionSensor" but it's actually an Occupancy Sensor
     const OccupancySensingServer = api.matter.deviceTypes.MotionSensor.requirements.OccupancySensingServer
     const OccupancySensorWithPIR = api.matter.deviceTypes.MotionSensor.with(
       OccupancySensingServer.with('PassiveInfrared'),
     )
 
+    const clusters = opts?.clusters ?? {
+      occupancySensing: {
+        occupancy: { occupied: false },
+        occupancySensorType: 0,
+        occupancySensorTypeBitmap: { pir: true, ultrasonic: false, physicalContact: false },
+      },
+    }
+
     super(api, log, {
-      uuid: api.matter.uuid.generate(serialNumber),
-      displayName: 'Occupancy Sensor',
+      uuid: opts?.uuid ?? api.matter.uuid.generate(serialNumber),
+      displayName: opts?.displayName ?? 'Occupancy Sensor',
       deviceType: OccupancySensorWithPIR,
       serialNumber,
-      manufacturer: 'Homebridge Matter',
-      model: 'HB-MATTER-SENSOR-OCCUPANCY',
-      firmwareRevision: '2.0.0',
-      hardwareRevision: '1.0.0',
-
-      clusters: {
-        occupancySensing: {
-          occupancy: {
-            occupied: false,
-          },
-          occupancySensorType: 0,
-          occupancySensorTypeBitmap: {
-            pir: true,
-            ultrasonic: false,
-            physicalContact: false,
-          },
-        },
-      },
+      manufacturer: opts?.manufacturer ?? 'Homebridge Matter',
+      model: opts?.model ?? 'HB-MATTER-SENSOR-OCCUPANCY',
+      firmwareRevision: opts?.firmwareRevision ?? '2.0.0',
+      hardwareRevision: opts?.hardwareRevision ?? '1.0.0',
+      clusters,
+      context: { deviceId: opts?.deviceId, ...(opts?.context ?? {}) },
     })
 
     this.logInfo('initialized.')

package/src/devices-matter/OnOffLightAccessory.ts

@@ -16,17 +16,29 @@ import { BaseMatterAccessory } from './BaseMatterAccessory.js'
  * It extends BaseMatterAccessory to inherit common functionality.
  */
 export class OnOffLightAccessory extends BaseMatterAccessory {
-  constructor(api: API, log: Logger) {
-    const serialNumber = 'LIGHT-001'
-    const displayName = 'On/Off Light'
-    const manufacturer = 'Homebridge Matter'
-    const model = 'HB-MATTER-LIGHT-ON-OFF'
-    const firmwareRevision = '2.0.0'
-    const hardwareRevision = '1.0.0'
+  constructor(api: API, log: Logger, opts?: Partial<import('./BaseMatterAccessory').BaseMatterAccessoryConfig & { deviceId?: string }>) {
+    const serialNumber = opts?.serialNumber ?? 'LIGHT-001'
+    const displayName = opts?.displayName ?? 'On/Off Light'
+    const manufacturer = opts?.manufacturer ?? 'Homebridge Matter'
+    const model = opts?.model ?? 'HB-MATTER-LIGHT-ON-OFF'
+    const firmwareRevision = opts?.firmwareRevision ?? '2.0.0'
+    const hardwareRevision = opts?.hardwareRevision ?? '1.0.0'
+
+    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).`)
+        },
+      },
+    }
 
     // Call parent constructor with device configuration
     super(api, log, {
-      uuid: api.matter.uuid.generate(serialNumber),
+      uuid: opts?.uuid ?? api.matter.uuid.generate(serialNumber),
       displayName,
       deviceType: api.matter.deviceTypes.OnOffLight,
       serialNumber,
@@ -34,21 +46,9 @@ export class OnOffLightAccessory extends BaseMatterAccessory {
       model,
       firmwareRevision,
       hardwareRevision,
-
-      // Initial cluster states
-      clusters: {
-        onOff: {
-          onOff: true, // initial state: light is on
-        },
-      },
-
-      // Command handlers
-      handlers: {
-        onOff: {
-          on: async () => this.handleOnCommand(),
-          off: async () => this.handleOffCommand(),
-        },
-      },
+      clusters,
+      handlers,
+      context: { deviceId: opts?.deviceId, ...(opts?.context ?? {}) },
     })
 
     this.logInfo('initialized.')

package/src/devices-matter/OnOffOutletAccessory.ts

@@ -7,45 +7,39 @@ import type { API, Logger } from 'homebridge'
 import { BaseMatterAccessory } from './BaseMatterAccessory.js'
 
 export class OnOffOutletAccessory extends BaseMatterAccessory {
-  constructor(api: API, log: Logger) {
-    const serialNumber = 'OUTLET-001'
-    super(api, log, {
-      uuid: api.matter.uuid.generate(serialNumber),
-      displayName: 'On/Off Outlet',
-      deviceType: api.matter.deviceTypes.OnOffOutlet,
-      serialNumber,
-      manufacturer: 'Homebridge Matter',
-      model: 'HB-MATTER-OUTLET-ON-OFF',
-      firmwareRevision: '2.0.0',
-      hardwareRevision: '1.0.0',
-
-      clusters: {
-        onOff: {
-          onOff: false,
+  constructor(api: API, log: Logger, opts?: Partial<import('./BaseMatterAccessory').BaseMatterAccessoryConfig & { deviceId?: string }>) {
+    const serialNumber = opts?.serialNumber ?? 'OUTLET-001'
+    const displayName = opts?.displayName ?? 'On/Off Outlet'
+    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).`)
         },
-      },
-
-      handlers: {
-        onOff: {
-          on: async () => this.handleOn(),
-          off: async () => this.handleOff(),
+        off: async () => {
+          log.debug(`${displayName} off handler invoked (default no-op).`)
         },
       },
+    }
+
+    super(api, log, {
+      uuid: opts?.uuid ?? api.matter.uuid.generate(serialNumber),
+      displayName,
+      deviceType: api.matter.deviceTypes.OnOffOutlet,
+      serialNumber,
+      manufacturer: opts?.manufacturer ?? 'Homebridge Matter',
+      model: opts?.model ?? 'HB-MATTER-OUTLET-ON-OFF',
+      firmwareRevision: opts?.firmwareRevision ?? '2.0.0',
+      hardwareRevision: opts?.hardwareRevision ?? '1.0.0',
+      clusters,
+      handlers,
+      context: { deviceId: opts?.deviceId, ...(opts?.context ?? {}) },
     })
 
     this.logInfo('initialized.')
   }
 
-  private async handleOn(): Promise<void> {
-    this.logInfo('turning on.')
-    // TODO: await myOutletAPI.turnOn()
-  }
-
-  private async handleOff(): Promise<void> {
-    this.logInfo('turning off.')
-    // TODO: await myOutletAPI.turnOff()
-  }
-
   public updateOnOffState(isOn: boolean): void {
     this.updateState(this.api.matter.clusterNames.OnOff, { onOff: isOn })
   }

package/src/devices-matter/OnOffSwitchAccessory.ts

@@ -7,30 +7,29 @@ import type { API, Logger } from 'homebridge'
 import { BaseMatterAccessory } from './BaseMatterAccessory.js'
 
 export class OnOffSwitchAccessory extends BaseMatterAccessory {
-  constructor(api: API, log: Logger) {
-    const serialNumber = 'SWITCH-001'
+  constructor(api: API, log: Logger, opts?: Partial<import('./BaseMatterAccessory').BaseMatterAccessoryConfig & { deviceId?: string }>) {
+    const serialNumber = opts?.serialNumber ?? 'SWITCH-001'
+    const displayName = opts?.displayName ?? 'On/Off Switch'
+    const manufacturer = opts?.manufacturer ?? 'Homebridge Matter'
+    const model = opts?.model ?? 'HB-MATTER-SWITCH-ON-OFF'
+    const firmwareRevision = opts?.firmwareRevision ?? '2.0.0'
+    const hardwareRevision = opts?.hardwareRevision ?? '1.0.0'
+
+    const clusters = opts?.clusters ?? { onOff: { onOff: false } }
+    const handlers = opts?.handlers ?? { onOff: { on: async () => this.handleOn(), off: async () => this.handleOff() } }
+
     super(api, log, {
-      uuid: api.matter.uuid.generate(serialNumber),
-      displayName: 'On/Off Switch',
+      uuid: opts?.uuid ?? api.matter.uuid.generate(serialNumber),
+      displayName,
       deviceType: api.matter.deviceTypes.OnOffSwitch,
       serialNumber,
-      manufacturer: 'Homebridge Matter',
-      model: 'HB-MATTER-SWITCH-ON-OFF',
-      firmwareRevision: '2.0.0',
-      hardwareRevision: '1.0.0',
-
-      clusters: {
-        onOff: {
-          onOff: false,
-        },
-      },
-
-      handlers: {
-        onOff: {
-          on: async () => this.handleOn(),
-          off: async () => this.handleOff(),
-        },
-      },
+      manufacturer,
+      model,
+      firmwareRevision,
+      hardwareRevision,
+      clusters,
+      handlers,
+      context: { deviceId: opts?.deviceId, ...(opts?.context ?? {}) },
     })
 
     this.logInfo('initialized.')