@switchbot/homebridge-switchbot 5.0.0-beta.11 → 5.0.0-beta.110

package/src/devices-matter/VenetianBlindAccessory.ts

@@ -1,115 +0,0 @@
-/**
- * Venetian Blind Accessory Class
- * Lift and tilt control
- */
-
-import type { API, Logger, MatterRequests } from 'homebridge'
-
-import { BaseMatterAccessory } from './BaseMatterAccessory.js'
-
-export class VenetianBlindAccessory extends BaseMatterAccessory {
-  constructor(api: API, log: Logger, opts?: Partial<import('./BaseMatterAccessory').BaseMatterAccessoryConfig & { deviceId?: string }>) {
-    const serialNumber = opts?.serialNumber ?? 'BLIND-002'
-
-    const clusters = opts?.clusters ?? {
-      windowCovering: {
-        targetPositionLiftPercent100ths: 5000,
-        currentPositionLiftPercent100ths: 5000,
-        targetPositionTiltPercent100ths: 5000,
-        currentPositionTiltPercent100ths: 5000,
-        operationalStatus: { global: 0, lift: 0, tilt: 0 },
-        endProductType: 8,
-        configStatus: {
-          operational: true,
-          onlineReserved: true,
-          liftMovementReversed: false,
-          liftPositionAware: true,
-          tiltPositionAware: true,
-          liftEncoderControlled: true,
-          tiltEncoderControlled: true,
-        },
-      },
-    }
-
-    const handlers = opts?.handlers ?? {
-      windowCovering: {
-        goToLiftPercentage: async (request: MatterRequests.GoToLiftPercentage) => this.handleGoToLift(request),
-        goToTiltPercentage: async (request: MatterRequests.GoToTiltPercentage) => this.handleGoToTilt(request),
-        upOrOpen: async () => this.handleUpOrOpen(),
-        downOrClose: async () => this.handleDownOrClose(),
-        stopMotion: async () => this.handleStop(),
-      },
-    }
-
-    super(api, log, {
-      uuid: opts?.uuid ?? api.matter.uuid.generate(serialNumber),
-      displayName: opts?.displayName ?? 'Venetian Blind (Tilt)',
-      deviceType: api.matter.deviceTypes.WindowCovering,
-      serialNumber,
-      manufacturer: opts?.manufacturer ?? 'Homebridge Matter',
-      model: opts?.model ?? 'HB-MATTER-BLIND-VENETIAN',
-      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 handleGoToLift(request: MatterRequests.GoToLiftPercentage): Promise<void> {
-    this.logInfo(`GoToLiftPercentage request: ${JSON.stringify(request)}`)
-
-    // Matter uses 0=open, 10000=closed, so invert to get open percentage
-    const closedPercent = request.liftPercent100thsValue / 100
-    const openPercent = (100 - closedPercent).toFixed(0)
-    this.logInfo(`moved to ${openPercent}% open.`)
-    // TODO: await myBlindAPI.setPosition(openPercent)
-  }
-
-  private async handleGoToTilt(request: MatterRequests.GoToTiltPercentage): Promise<void> {
-    this.logInfo(`GoToTiltPercentage request: ${JSON.stringify(request)}`)
-
-    // Matter tilt: 0=horizontal/open (0deg), 10000=vertical/closed (90deg)
-    const degrees = Math.round((request.tiltPercent100thsValue / 10000) * 90)
-    this.logInfo(`tilted to ${degrees}°.`)
-    // TODO: await myBlindAPI.setTiltAngle(degrees)
-  }
-
-  private async handleUpOrOpen(): Promise<void> {
-    this.logInfo('opened blind.')
-    // TODO: await myBlindAPI.open()
-  }
-
-  private async handleDownOrClose(): Promise<void> {
-    this.logInfo('closed blind.')
-    // TODO: await myBlindAPI.close()
-  }
-
-  private async handleStop(): Promise<void> {
-    this.logInfo('stopped blind.')
-    // TODO: await myBlindAPI.stop()
-  }
-
-  public updateLiftPosition(openPercent: number): void {
-    // Convert open percentage to Matter's closed percentage (0=open, 10000=closed)
-    const closedPercent = 100 - openPercent
-    const value = Math.round(closedPercent * 100)
-    this.updateState(this.api.matter.clusterNames.WindowCovering, {
-      currentPositionLiftPercent100ths: value,
-      targetPositionLiftPercent100ths: value,
-    })
-    this.logInfo(`lift position: ${openPercent}% open.`)
-  }
-
-  public updateTiltPosition(degrees: number): void {
-    // Convert degrees (0-90) to Matter's tilt percentage (0=horizontal, 10000=vertical)
-    const value = Math.round((degrees / 90) * 10000)
-    this.updateState(this.api.matter.clusterNames.WindowCovering, {
-      currentPositionTiltPercent100ths: value,
-      targetPositionTiltPercent100ths: value,
-    })
-    this.logInfo(`tilt position: ${degrees}°.`)
-  }
-}

package/src/devices-matter/WindowBlindAccessory.ts

@@ -1,92 +0,0 @@
-/**
- * Window Blind Accessory Class
- * Lift control only (up/down)
- */
-
-import type { API, Logger, MatterRequests } from 'homebridge'
-
-import { BaseMatterAccessory } from './BaseMatterAccessory.js'
-
-export class WindowBlindAccessory extends BaseMatterAccessory {
-  constructor(api: API, log: Logger, opts?: Partial<import('./BaseMatterAccessory').BaseMatterAccessoryConfig & { deviceId?: string }>) {
-    const serialNumber = opts?.serialNumber ?? 'BLIND-001'
-
-    const clusters = opts?.clusters ?? {
-      windowCovering: {
-        targetPositionLiftPercent100ths: 5000,
-        currentPositionLiftPercent100ths: 5000,
-        operationalStatus: { global: 0, lift: 0, tilt: 0 },
-        endProductType: 0,
-        configStatus: {
-          operational: true,
-          onlineReserved: true,
-          liftMovementReversed: false,
-          liftPositionAware: true,
-          tiltPositionAware: false,
-          liftEncoderControlled: true,
-          tiltEncoderControlled: false,
-        },
-      },
-    }
-
-    const handlers = opts?.handlers ?? {
-      windowCovering: {
-        goToLiftPercentage: async (request: MatterRequests.GoToLiftPercentage) => this.handleGoToLift(request),
-        upOrOpen: async () => this.handleUpOrOpen(),
-        downOrClose: async () => this.handleDownOrClose(),
-        stopMotion: async () => this.handleStop(),
-      },
-    }
-
-    super(api, log, {
-      uuid: opts?.uuid ?? api.matter.uuid.generate(serialNumber),
-      displayName: opts?.displayName ?? 'Window Blind',
-      deviceType: api.matter.deviceTypes.WindowCovering,
-      serialNumber,
-      manufacturer: opts?.manufacturer ?? 'Homebridge Matter',
-      model: opts?.model ?? 'HB-MATTER-BLIND-WINDOW',
-      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 handleGoToLift(request: MatterRequests.GoToLiftPercentage): Promise<void> {
-    this.logInfo(`GoToLiftPercentage request: ${JSON.stringify(request)}`)
-    // Matter uses 0=open, 10000=closed, so invert to get open percentage
-    const closedPercent = request.liftPercent100thsValue / 100
-    const openPercent = (100 - closedPercent).toFixed(0)
-    this.logInfo(`moved to ${openPercent}% open.`)
-    // TODO: await myBlindAPI.setPosition(openPercent)
-  }
-
-  private async handleUpOrOpen(): Promise<void> {
-    this.logInfo('opened blind.')
-    // TODO: await myBlindAPI.open()
-  }
-
-  private async handleDownOrClose(): Promise<void> {
-    this.logInfo('closed blind.')
-    // TODO: await myBlindAPI.close()
-  }
-
-  private async handleStop(): Promise<void> {
-    this.logInfo('stopped blind.')
-    // TODO: await myBlindAPI.stop()
-  }
-
-  public updateLiftPosition(openPercent: number): void {
-    // Convert open percentage to Matter's closed percentage (0=open, 10000=closed)
-    const closedPercent = 100 - openPercent
-    const value = Math.round(closedPercent * 100)
-    this.updateState(this.api.matter.clusterNames.WindowCovering, {
-      currentPositionLiftPercent100ths: value,
-      targetPositionLiftPercent100ths: value,
-    })
-    this.logInfo(`lift position: ${openPercent}% open.`)
-  }
-}

package/src/devices-matter/custom/PowerStripAccessory.ts

@@ -1,309 +0,0 @@
-/**
- * Power Strip Accessory Class
- *
- * This demonstrates a composed device with multiple independent endpoints (parts).
- * Each outlet appears as a separate device in the Home app and can be controlled independently.
- *
- * This uses the Homebridge Matter API's `parts` feature to create true multi-endpoint
- * composed devices, where each part has its own Matter endpoint.
- */
-
-import type { API, Logger } from 'homebridge'
-
-import { BaseMatterAccessory } from '../BaseMatterAccessory.js'
-
-export class PowerStripAccessory extends BaseMatterAccessory {
-  constructor(api: API, log: Logger) {
-    const serialNumber = 'POWER-STRIP-001'
-
-    super(api, log, {
-      uuid: api.matter.uuid.generate(serialNumber),
-      displayName: 'Power Strip',
-      deviceType: api.matter.deviceTypes.OnOffOutlet,
-      serialNumber,
-      manufacturer: 'Homebridge Matter',
-      model: 'HB-MATTER-POWER-STRIP-4X',
-      firmwareRevision: '2.0.0',
-      hardwareRevision: '1.0.0',
-
-      // Main accessory can optionally have its own clusters/handlers
-      // Here we'll just use it as a container for the 4 outlet parts
-      clusters: {
-        onOff: {
-          onOff: false, // Master control
-        },
-      },
-
-      handlers: {
-        onOff: {
-          on: async () => this.handleMasterOn(),
-          off: async () => this.handleMasterOff(),
-        },
-      },
-
-      // Define 4 independent outlet parts
-      // Each part appears as a separate device in the Home app
-      parts: [
-        {
-          id: 'outlet-1',
-          displayName: 'Outlet 1',
-          deviceType: api.matter.deviceTypes.OnOffOutlet,
-          clusters: {
-            onOff: { onOff: false },
-          },
-          handlers: {
-            onOff: {
-              on: async (_args, context) => this.handleOutletOn(context?.partId || 'outlet-1'),
-              off: async (_args, context) => this.handleOutletOff(context?.partId || 'outlet-1'),
-            },
-          },
-        },
-        {
-          id: 'outlet-2',
-          displayName: 'Outlet 2',
-          deviceType: api.matter.deviceTypes.OnOffOutlet,
-          clusters: {
-            onOff: { onOff: false },
-          },
-          handlers: {
-            onOff: {
-              on: async (_args, context) => this.handleOutletOn(context?.partId || 'outlet-2'),
-              off: async (_args, context) => this.handleOutletOff(context?.partId || 'outlet-2'),
-            },
-          },
-        },
-        {
-          id: 'outlet-3',
-          displayName: 'Outlet 3',
-          deviceType: api.matter.deviceTypes.OnOffOutlet,
-          clusters: {
-            onOff: { onOff: false },
-          },
-          handlers: {
-            onOff: {
-              on: async (_args, context) => this.handleOutletOn(context?.partId || 'outlet-3'),
-              off: async (_args, context) => this.handleOutletOff(context?.partId || 'outlet-3'),
-            },
-          },
-        },
-        {
-          id: 'outlet-4',
-          displayName: 'Outlet 4',
-          deviceType: api.matter.deviceTypes.OnOffOutlet,
-          clusters: {
-            onOff: { onOff: false },
-          },
-          handlers: {
-            onOff: {
-              on: async (_args, context) => this.handleOutletOn(context?.partId || 'outlet-4'),
-              off: async (_args, context) => this.handleOutletOff(context?.partId || 'outlet-4'),
-            },
-          },
-        },
-      ],
-    })
-
-    this.logInfo('initialized with 4 independent outlet endpoints.')
-  }
-
-  /**
-   * Handler for individual outlet ON command
-   * Called when a specific outlet is turned on from the Home app
-   */
-  private async handleOutletOn(partId: string): Promise<void> {
-    const outletNumber = this.getOutletNumber(partId)
-    this.logInfo(`Outlet ${outletNumber} turned ON`)
-
-    // TODO: Send command to actual power strip hardware
-    // await myPowerStripAPI.turnOnOutlet(outletNumber)
-  }
-
-  /**
-   * Handler for individual outlet OFF command
-   * Called when a specific outlet is turned off from the Home app
-   */
-  private async handleOutletOff(partId: string): Promise<void> {
-    const outletNumber = this.getOutletNumber(partId)
-    this.logInfo(`Outlet ${outletNumber} turned OFF`)
-
-    // TODO: Send command to actual power strip hardware
-    // await myPowerStripAPI.turnOffOutlet(outletNumber)
-  }
-
-  /**
-   * Master ON - Turns on all outlets
-   */
-  private async handleMasterOn(): Promise<void> {
-    this.logInfo('Master ON - turning on all outlets.')
-
-    // Update each outlet's state
-    for (let i = 1; i <= 4; i++) {
-      const partId = `outlet-${i}`
-      this.updateState(this.api.matter.clusterNames.OnOff, { onOff: true }, partId)
-    }
-
-    // TODO: Send command to actual power strip hardware
-    // await myPowerStripAPI.turnOnAllOutlets()
-  }
-
-  /**
-   * Master OFF - Turns off all outlets
-   */
-  private async handleMasterOff(): Promise<void> {
-    this.logInfo('Master OFF - turning off all outlets.')
-
-    // Update each outlet's state
-    for (let i = 1; i <= 4; i++) {
-      const partId = `outlet-${i}`
-      this.updateState(this.api.matter.clusterNames.OnOff, { onOff: false }, partId)
-    }
-
-    // TODO: Send command to actual power strip hardware
-    // await myPowerStripAPI.turnOffAllOutlets()
-  }
-
-  /**
-   * Extract outlet number from part ID
-   */
-  private getOutletNumber(partId: string): number {
-    const match = partId.match(/outlet-(\d+)/)
-    return match ? Number.parseInt(match[1], 10) : 0
-  }
-
-  /**
-   * Turn on a specific outlet programmatically
-   * Use this to update outlet state from external sources (API, webhooks, etc.)
-   *
-   * @param outletNumber - Outlet number (1-4)
-   */
-  public async turnOnOutlet(outletNumber: 1 | 2 | 3 | 4): Promise<void> {
-    const partId = `outlet-${outletNumber}`
-    this.logInfo(`Programmatically turning ON outlet ${outletNumber}`)
-
-    // Update the specific outlet's state
-    this.updateState(this.api.matter.clusterNames.OnOff, { onOff: true }, partId)
-
-    // TODO: Send command to actual power strip hardware
-    // await myPowerStripAPI.turnOnOutlet(outletNumber)
-  }
-
-  /**
-   * Turn off a specific outlet programmatically
-   * Use this to update outlet state from external sources (API, webhooks, etc.)
-   *
-   * @param outletNumber - Outlet number (1-4)
-   */
-  public async turnOffOutlet(outletNumber: 1 | 2 | 3 | 4): Promise<void> {
-    const partId = `outlet-${outletNumber}`
-    this.logInfo(`Programmatically turning OFF outlet ${outletNumber}`)
-
-    // Update the specific outlet's state
-    this.updateState(this.api.matter.clusterNames.OnOff, { onOff: false }, partId)
-
-    // TODO: Send command to actual power strip hardware
-    // await myPowerStripAPI.turnOffOutlet(outletNumber)
-  }
-
-  /**
-   * Toggle a specific outlet
-   *
-   * @param outletNumber - Outlet number (1-4)
-   */
-  public async toggleOutlet(outletNumber: 1 | 2 | 3 | 4): Promise<void> {
-    const currentState = await this.getOutletState(outletNumber)
-
-    if (currentState) {
-      await this.turnOffOutlet(outletNumber)
-    } else {
-      await this.turnOnOutlet(outletNumber)
-    }
-  }
-
-  /**
-   * Get the current state of a specific outlet
-   *
-   * @param outletNumber - Outlet number (1-4)
-   * @returns Current on/off state of the outlet
-   */
-  public async getOutletState(outletNumber: 1 | 2 | 3 | 4): Promise<boolean> {
-    const partId = `outlet-${outletNumber}`
-
-    // Get the state from the Matter server
-    const state = await this.api.matter.getAccessoryState(
-      this.uuid,
-      this.api.matter.clusterNames.OnOff,
-      partId,
-    )
-
-    return state?.onOff === true
-  }
-
-  /**
-   * Get the state of all outlets
-   *
-   * @returns Object containing state of all outlets
-   */
-  public async getAllOutletStates(): Promise<Record<string, boolean>> {
-    return {
-      outlet1: await this.getOutletState(1),
-      outlet2: await this.getOutletState(2),
-      outlet3: await this.getOutletState(3),
-      outlet4: await this.getOutletState(4),
-    }
-  }
-
-  /**
-   * Update the state of a specific outlet from external source
-   * (e.g., when outlet state changes via physical button or other controller)
-   *
-   * @param outletNumber - Outlet number (1-4)
-   * @param isOn - New state of the outlet
-   */
-  public updateOutletStateFromExternal(outletNumber: 1 | 2 | 3 | 4, isOn: boolean): void {
-    const partId = `outlet-${outletNumber}`
-    this.logInfo(`Outlet ${outletNumber} state updated from external source: ${isOn ? 'ON' : 'OFF'}`)
-
-    // Update the specific outlet's state
-    this.updateState(this.api.matter.clusterNames.OnOff, { onOff: isOn }, partId)
-  }
-
-  /**
-   * Update all outlet states from external source
-   *
-   * @param states - Object containing new states for all outlets
-   * @param states.outlet1 - State for outlet 1
-   * @param states.outlet2 - State for outlet 2
-   * @param states.outlet3 - State for outlet 3
-   * @param states.outlet4 - State for outlet 4
-   */
-  public updateAllOutletStatesFromExternal(states: {
-    outlet1: boolean
-    outlet2: boolean
-    outlet3: boolean
-    outlet4: boolean
-  }): void {
-    this.logInfo('All outlet states updated from external source.')
-
-    for (let i = 1; i <= 4; i++) {
-      const key = `outlet${i}` as keyof typeof states
-      const partId = `outlet-${i}`
-
-      this.updateState(this.api.matter.clusterNames.OnOff, { onOff: states[key] }, partId)
-    }
-  }
-
-  /**
-   * Override updateState to support partId parameter
-   */
-  protected async updateState(cluster: string, attributes: Record<string, unknown>, partId?: string): Promise<void> {
-    if (partId) {
-      // Update a specific part
-      await this.api.matter.updateAccessoryState(this.uuid, cluster, attributes, partId)
-      this.logDebug(`Updated ${cluster} state for part ${partId}:`, attributes)
-    } else {
-      // Update main accessory
-      await this.api.matter.updateAccessoryState(this.uuid, cluster, attributes)
-      this.logDebug(`Updated ${cluster} state:`, attributes)
-    }
-  }
-}

package/src/devices-matter/custom/index.ts

@@ -1,8 +0,0 @@
-/**
- * Custom Device Examples
- *
- * This folder contains custom device examples that demonstrate advanced
- * patterns and use cases beyond the standard Matter device types.
- */
-
-export { PowerStripAccessory } from './PowerStripAccessory.js'

package/src/devices-matter/index.ts

@@ -1,29 +0,0 @@
-/**
- * Base Device Classes
- *
- * Export all base classes and device implementations
- */
-
-export { BaseMatterAccessory } from './BaseMatterAccessory.js'
-export type { BaseMatterAccessoryConfig } from './BaseMatterAccessory.js'
-export { ColorLightAccessory } from './ColorLightAccessory.js'
-export { ColorTemperatureLightAccessory } from './ColorTemperatureLightAccessory.js'
-export { ContactSensorAccessory } from './ContactSensorAccessory.js'
-export { PowerStripAccessory } from './custom/index.js'
-export { DimmableLightAccessory } from './DimmableLightAccessory.js'
-export { DoorLockAccessory } from './DoorLockAccessory.js'
-export { ExtendedColorLightAccessory } from './ExtendedColorLightAccessory.js'
-export { FanAccessory } from './FanAccessory.js'
-export { HumiditySensorAccessory } from './HumiditySensorAccessory.js'
-export { LeakSensorAccessory } from './LeakSensorAccessory.js'
-export { LightSensorAccessory } from './LightSensorAccessory.js'
-export { OccupancySensorAccessory } from './OccupancySensorAccessory.js'
-export { OnOffLightAccessory } from './OnOffLightAccessory.js'
-export { OnOffOutletAccessory } from './OnOffOutletAccessory.js'
-export { OnOffSwitchAccessory } from './OnOffSwitchAccessory.js'
-export { RoboticVacuumAccessory } from './RoboticVacuumAccessory.js'
-export { SmokeCOAlarmAccessory } from './SmokeCOAlarmAccessory.js'
-export { TemperatureSensorAccessory } from './TemperatureSensorAccessory.js'
-export { ThermostatAccessory } from './ThermostatAccessory.js'
-export { VenetianBlindAccessory } from './VenetianBlindAccessory.js'
-export { WindowBlindAccessory } from './WindowBlindAccessory.js'

package/src/index.test.ts

@@ -1,24 +0,0 @@
-import type { API } from 'homebridge'
-
-import { describe, expect, it, vi } from 'vitest'
-
-import registerPlatform from './index.js'
-import { PLATFORM_NAME, PLUGIN_NAME } from './settings.js'
-
-describe('index.ts', () => {
-  it('should register the platform with homebridge', () => {
-    const api = {
-      registerPlatform: vi.fn(),
-    } as unknown as API
-
-    registerPlatform(api)
-
-    // The platform registration now uses a runtime proxy/delegate constructor so
-    // assert the call happened and the third argument is a constructor function.
-    expect(api.registerPlatform).toHaveBeenCalled()
-    const callArgs = (api.registerPlatform as any).mock.calls[0]
-    expect(callArgs[0]).toBe(PLUGIN_NAME)
-    expect(callArgs[1]).toBe(PLATFORM_NAME)
-    expect(typeof callArgs[2]).toBe('function')
-  })
-})