@homebridge-plugins/homebridge-matter 0.1.6 → 0.2.0-beta.1

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to `@homebridge-plugins/homebridge-matter` will be documented in this file.
 
+## v0.2.0 (Unreleased)
+
+### Changes
+
+- refactor codebase for class-based devices
+- add logging for all `MatterRequest` events
+
 ## v0.1.6 (2025-10-24)
 
 ### Changes

package/dist/devices/BaseMatterAccessory.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Base Matter Accessory Class
+ *
+ * This base class implements the MatterAccessory interface and provides
+ * common functionality that all Matter devices can use.
+ *
+ * Individual device types should extend this class and call super() with
+ * the required configuration.
+ */
+import type { EndpointType } from '@matter/main';
+import type { API, Logger, MatterAccessory } from 'homebridge';
+export interface BaseMatterAccessoryConfig {
+    uuid: string;
+    displayName: string;
+    deviceType: EndpointType;
+    serialNumber: string;
+    manufacturer: string;
+    model: string;
+    firmwareRevision: string;
+    hardwareRevision: string;
+    context?: Record<string, any>;
+    clusters: MatterAccessory['clusters'];
+    handlers?: MatterAccessory['handlers'];
+}
+/**
+ * Base class for all Matter accessories
+ * Implements the MatterAccessory interface and provides common methods
+ */
+export declare abstract class BaseMatterAccessory implements MatterAccessory {
+    readonly uuid: string;
+    readonly displayName: string;
+    readonly deviceType: EndpointType;
+    readonly serialNumber: string;
+    readonly manufacturer: string;
+    readonly model: string;
+    readonly firmwareRevision: string;
+    readonly hardwareRevision: string;
+    readonly context: Record<string, any>;
+    readonly clusters: MatterAccessory['clusters'];
+    readonly handlers?: MatterAccessory['handlers'];
+    protected readonly api: API;
+    protected readonly log: Logger;
+    constructor(api: API, log: Logger, config: BaseMatterAccessoryConfig);
+    /**
+     * Update the accessory state
+     * Helper method to update cluster attributes
+     */
+    protected updateState(cluster: string, attributes: Record<string, any>): void;
+    /**
+     * Log helper methods
+     */
+    protected logInfo(message: string, ...args: any[]): void;
+    protected logError(message: string, ...args: any[]): void;
+    protected logDebug(message: string, ...args: any[]): void;
+    protected logWarn(message: string, ...args: any[]): void;
+    /**
+     * Convert this class instance to a plain MatterAccessory object
+     * This is what gets registered with Homebridge
+     */
+    toAccessory(): MatterAccessory;
+}

package/dist/devices/BaseMatterAccessory.js

@@ -0,0 +1,97 @@
+/**
+ * Base Matter Accessory Class
+ *
+ * This base class implements the MatterAccessory interface and provides
+ * common functionality that all Matter devices can use.
+ *
+ * Individual device types should extend this class and call super() with
+ * the required configuration.
+ */
+/**
+ * Base class for all Matter accessories
+ * Implements the MatterAccessory interface and provides common methods
+ */
+export class BaseMatterAccessory {
+    // Required MatterAccessory properties
+    uuid;
+    displayName;
+    deviceType;
+    serialNumber;
+    manufacturer;
+    model;
+    firmwareRevision;
+    hardwareRevision;
+    context;
+    clusters;
+    handlers;
+    // Protected properties available to child classes
+    api;
+    log;
+    constructor(api, log, config) {
+        this.api = api;
+        this.log = log;
+        // Set all required properties
+        this.uuid = config.uuid;
+        this.displayName = config.displayName;
+        this.deviceType = config.deviceType;
+        this.serialNumber = config.serialNumber;
+        this.manufacturer = config.manufacturer;
+        this.model = config.model;
+        this.firmwareRevision = config.firmwareRevision;
+        this.hardwareRevision = config.hardwareRevision;
+        this.clusters = config.clusters;
+        this.handlers = config.handlers;
+        // Set context with all metadata
+        this.context = {
+            serialNumber: this.serialNumber,
+            manufacturer: this.manufacturer,
+            model: this.model,
+            firmwareRevision: this.firmwareRevision,
+            hardwareRevision: this.hardwareRevision,
+            ...config.context,
+        };
+    }
+    /**
+     * Update the accessory state
+     * Helper method to update cluster attributes
+     */
+    updateState(cluster, attributes) {
+        this.api.matter.updateAccessoryState(this.uuid, cluster, attributes);
+        this.log.debug(`[${this.displayName}] Updated ${cluster} state:`, attributes);
+    }
+    /**
+     * Log helper methods
+     */
+    logInfo(message, ...args) {
+        this.log.info(`[${this.displayName}] ${message}`, ...args);
+    }
+    logError(message, ...args) {
+        this.log.error(`[${this.displayName}] ${message}`, ...args);
+    }
+    logDebug(message, ...args) {
+        this.log.debug(`[${this.displayName}] ${message}`, ...args);
+    }
+    logWarn(message, ...args) {
+        this.log.warn(`[${this.displayName}] ${message}`, ...args);
+    }
+    /**
+     * Convert this class instance to a plain MatterAccessory object
+     * This is what gets registered with Homebridge
+     */
+    toAccessory() {
+        return {
+            uuid: this.uuid,
+            displayName: this.displayName,
+            deviceType: this.deviceType,
+            serialNumber: this.serialNumber,
+            manufacturer: this.manufacturer,
+            model: this.model,
+            firmwareRevision: this.firmwareRevision,
+            hardwareRevision: this.hardwareRevision,
+            context: this.context,
+            clusters: this.clusters,
+            handlers: this.handlers,
+        };
+    }
+}
+//# sourceMappingURL=BaseMatterAccessory.js.map

package/dist/devices/BaseMatterAccessory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseMatterAccessory.js","sourceRoot":"","sources":["../../src/devices/BaseMatterAccessory.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAmBH;;;GAGG;AACH,MAAM,OAAgB,mBAAmB;IACvC,sCAAsC;IACtB,IAAI,CAAQ;IACZ,WAAW,CAAQ;IACnB,UAAU,CAAc;IACxB,YAAY,CAAQ;IACpB,YAAY,CAAQ;IACpB,KAAK,CAAQ;IACb,gBAAgB,CAAQ;IACxB,gBAAgB,CAAQ;IACxB,OAAO,CAAqB;IAC5B,QAAQ,CAA6B;IACrC,QAAQ,CAA8B;IAEtD,kDAAkD;IAC/B,GAAG,CAAK;IACR,GAAG,CAAQ;IAE9B,YACE,GAAQ,EACR,GAAW,EACX,MAAiC;QAEjC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QAEd,8BAA8B;QAC9B,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAA;QACvB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAA;QACrC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAA;QACnC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAA;QACvC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAA;QACvC,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;QACzB,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAA;QAC/C,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAA;QAC/C,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAA;QAC/B,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAA;QAE/B,gCAAgC;QAChC,IAAI,CAAC,OAAO,GAAG;YACb,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;YACvC,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;YACvC,GAAG,MAAM,CAAC,OAAO;SAClB,CAAA;IACH,CAAC;IAED;;;OAGG;IACO,WAAW,CAAC,OAAe,EAAE,UAA+B;QACpE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,CAAA;QACpE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,WAAW,aAAa,OAAO,SAAS,EAAE,UAAU,CAAC,CAAA;IAC/E,CAAC;IAED;;OAEG;IACO,OAAO,CAAC,OAAe,EAAE,GAAG,IAAW;QAC/C,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,WAAW,KAAK,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAA;IAC5D,CAAC;IAES,QAAQ,CAAC,OAAe,EAAE,GAAG,IAAW;QAChD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,WAAW,KAAK,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAA;IAC7D,CAAC;IAES,QAAQ,CAAC,OAAe,EAAE,GAAG,IAAW;QAChD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,WAAW,KAAK,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAA;IAC7D,CAAC;IAES,OAAO,CAAC,OAAe,EAAE,GAAG,IAAW;QAC/C,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,WAAW,KAAK,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAA;IAC5D,CAAC;IAED;;;OAGG;IACI,WAAW;QAChB,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;YACvC,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;YACvC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAA;IACH,CAAC;CACF"}

package/dist/devices/ColorLightAccessory.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Color Light Accessory Class (HS only)
+ * Hue and Saturation color control
+ */
+import type { API, Logger } from 'homebridge';
+import { BaseMatterAccessory } from './BaseMatterAccessory.js';
+export declare class ColorLightAccessory extends BaseMatterAccessory {
+    constructor(api: API, log: Logger);
+    private handleOn;
+    private handleOff;
+    private handleSetLevel;
+    private handleSetColor;
+    private handleSetHueSaturation;
+    updateOnOffState(isOn: boolean): void;
+    updateBrightness(percent: number): void;
+    updateHueSaturation(hue: number, saturation: number): void;
+}

package/dist/devices/ColorLightAccessory.js

@@ -0,0 +1,96 @@
+/**
+ * Color Light Accessory Class (HS only)
+ * Hue and Saturation color control
+ */
+import { BaseMatterAccessory } from './BaseMatterAccessory.js';
+export class ColorLightAccessory extends BaseMatterAccessory {
+    constructor(api, log) {
+        const serialNumber = 'LIGHT-004';
+        super(api, log, {
+            uuid: api.matter.uuid.generate(serialNumber),
+            displayName: 'Colour Light (HS)',
+            deviceType: api.matter.deviceTypes.ExtendedColorLight,
+            serialNumber,
+            manufacturer: 'Homebridge Matter',
+            model: 'HB-MATTER-LIGHT-COLOUR-HS',
+            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,
+                },
+            },
+            handlers: {
+                onOff: {
+                    on: async () => this.handleOn(),
+                    off: async () => this.handleOff(),
+                },
+                levelControl: {
+                    moveToLevelWithOnOff: async (request) => this.handleSetLevel(request),
+                },
+                colorControl: {
+                    moveToColorLogic: async (request) => this.handleSetColor(request),
+                    moveToHueAndSaturationLogic: async (request) => this.handleSetHueSaturation(request),
+                },
+            },
+        });
+        this.logInfo('initialized.');
+    }
+    async handleOn() {
+        this.logInfo('turning on.');
+        // TODO: await myLightAPI.turnOn()
+    }
+    async handleOff() {
+        this.logInfo('turning off.');
+        // TODO: await myLightAPI.turnOff()
+    }
+    async handleSetLevel(request) {
+        this.logInfo(`MoveToLevel request: ${JSON.stringify(request)}`);
+        const { level } = request;
+        const brightnessPercent = Math.round((level / 254) * 100);
+        this.logInfo(`setting brightness to ${brightnessPercent}%.`);
+        // TODO: await myLightAPI.setBrightness(brightnessPercent)
+    }
+    async handleSetColor(request) {
+        this.logInfo(`MoveToColor request: ${JSON.stringify(request)}`);
+        const { colorX, colorY, transitionTime } = request;
+        const xFloat = (colorX / 65535).toFixed(4);
+        const yFloat = (colorY / 65535).toFixed(4);
+        this.logInfo(`setting xy color to (${xFloat}, ${yFloat}).`);
+        // TODO: await myLightAPI.setXY(xFloat, yFloat, transitionTime)
+    }
+    async handleSetHueSaturation(request) {
+        this.logInfo(`MoveToHueAndSaturation request: ${JSON.stringify(request)}`);
+        const { hue, saturation, transitionTime } = request;
+        const hueDegrees = Math.round((hue / 254) * 360);
+        const saturationPercent = Math.round((saturation / 254) * 100);
+        this.logInfo(`setting color to ${hueDegrees}°, ${saturationPercent}%.`);
+        // TODO: await myLightAPI.setColor(hueDegrees, saturationPercent, transitionTime)
+    }
+    updateOnOffState(isOn) {
+        this.updateState(this.api.matter.clusterNames.OnOff, { onOff: isOn });
+    }
+    updateBrightness(percent) {
+        const matterLevel = Math.max(1, Math.round((percent / 100) * 254));
+        this.updateState(this.api.matter.clusterNames.LevelControl, { currentLevel: matterLevel });
+    }
+    updateHueSaturation(hue, saturation) {
+        const matterHue = Math.round((hue / 360) * 254);
+        const matterSat = Math.round((saturation / 100) * 254);
+        this.updateState(this.api.matter.clusterNames.ColorControl, {
+            currentHue: matterHue,
+            currentSaturation: matterSat,
+        });
+    }
+}
+//# sourceMappingURL=ColorLightAccessory.js.map

package/dist/devices/ColorLightAccessory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ColorLightAccessory.js","sourceRoot":"","sources":["../../src/devices/ColorLightAccessory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAE9D,MAAM,OAAO,mBAAoB,SAAQ,mBAAmB;IAC1D,YAAY,GAAQ,EAAE,GAAW;QAC/B,MAAM,YAAY,GAAG,WAAW,CAAA;QAChC,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE;YACd,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;YAC5C,WAAW,EAAE,mBAAmB;YAChC,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,kBAAkB;YACrD,YAAY;YACZ,YAAY,EAAE,mBAAmB;YACjC,KAAK,EAAE,2BAA2B;YAClC,gBAAgB,EAAE,OAAO;YACzB,gBAAgB,EAAE,OAAO;YAEzB,QAAQ,EAAE;gBACR,KAAK,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE;gBACvB,YAAY,EAAE;oBACZ,YAAY,EAAE,GAAG;oBACjB,QAAQ,EAAE,CAAC;oBACX,QAAQ,EAAE,GAAG;iBACd;gBACD,YAAY,EAAE;oBACZ,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,8BAA8B;oBACjF,UAAU,EAAE,CAAC;oBACb,iBAAiB,EAAE,GAAG;oBACtB,QAAQ,EAAE,KAAK;oBACf,QAAQ,EAAE,KAAK;iBAChB;aACF;YAED,QAAQ,EAAE;gBACR,KAAK,EAAE;oBACL,EAAE,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE;oBAC/B,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE;iBAClC;gBACD,YAAY,EAAE;oBACZ,oBAAoB,EAAE,KAAK,EAAE,OAAmC,EAAE,EAAE,CAClE,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;iBAC/B;gBACD,YAAY,EAAE;oBACZ,gBAAgB,EAAE,KAAK,EAAE,OAAmC,EAAE,EAAE,CAC9D,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;oBAC9B,2BAA2B,EAAE,KAAK,EAAE,OAA8C,EAAE,EAAE,CACpF,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC;iBACvC;aACF;SACF,CAAC,CAAA;QAEF,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;IAC9B,CAAC;IAEO,KAAK,CAAC,QAAQ;QACpB,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAA;QAC3B,kCAAkC;IACpC,CAAC;IAEO,KAAK,CAAC,SAAS;QACrB,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;QAC5B,mCAAmC;IACrC,CAAC;IAEO,KAAK,CAAC,cAAc,CAAC,OAAmC;QAC9D,IAAI,CAAC,OAAO,CAAC,wBAAwB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QAC/D,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAA;QACzB,MAAM,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAA;QACzD,IAAI,CAAC,OAAO,CAAC,yBAAyB,iBAAiB,IAAI,CAAC,CAAA;QAC5D,0DAA0D;IAC5D,CAAC;IAEO,KAAK,CAAC,cAAc,CAAC,OAAmC;QAC9D,IAAI,CAAC,OAAO,CAAC,wBAAwB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QAC/D,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,OAAO,CAAA;QAClD,MAAM,MAAM,GAAG,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;QAC1C,MAAM,MAAM,GAAG,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;QAC1C,IAAI,CAAC,OAAO,CAAC,wBAAwB,MAAM,KAAK,MAAM,IAAI,CAAC,CAAA;QAC3D,+DAA+D;IACjE,CAAC;IAEO,KAAK,CAAC,sBAAsB,CAAC,OAA8C;QACjF,IAAI,CAAC,OAAO,CAAC,mCAAmC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QAC1E,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,cAAc,EAAE,GAAG,OAAO,CAAA;QACnD,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAA;QAChD,MAAM,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,UAAU,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAA;QAC9D,IAAI,CAAC,OAAO,CAAC,oBAAoB,UAAU,MAAM,iBAAiB,IAAI,CAAC,CAAA;QACvE,iFAAiF;IACnF,CAAC;IAEM,gBAAgB,CAAC,IAAa;QACnC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IACvE,CAAC;IAEM,gBAAgB,CAAC,OAAe;QACrC,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAA;QAClE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,YAAY,EAAE,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,CAAA;IAC5F,CAAC;IAEM,mBAAmB,CAAC,GAAW,EAAE,UAAkB;QACxD,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAA;QAC/C,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,UAAU,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAA;QACtD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,YAAY,EAAE;YAC1D,UAAU,EAAE,SAAS;YACrB,iBAAiB,EAAE,SAAS;SAC7B,CAAC,CAAA;IACJ,CAAC;CACF"}

package/dist/devices/ColorTemperatureLightAccessory.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Color Temperature Light Accessory Class
+ */
+import type { API, Logger } from 'homebridge';
+import { BaseMatterAccessory } from './BaseMatterAccessory.js';
+export declare class ColorTemperatureLightAccessory extends BaseMatterAccessory {
+    constructor(api: API, log: Logger);
+    private handleOn;
+    private handleOff;
+    private handleSetLevel;
+    private handleSetColorTemperature;
+    updateOnOffState(isOn: boolean): void;
+    updateBrightness(percent: number): void;
+    updateColorTemperature(kelvin: number): void;
+}

package/dist/devices/ColorTemperatureLightAccessory.js

@@ -0,0 +1,83 @@
+/**
+ * Color Temperature Light Accessory Class
+ */
+import { BaseMatterAccessory } from './BaseMatterAccessory.js';
+export class ColorTemperatureLightAccessory extends BaseMatterAccessory {
+    constructor(api, log) {
+        const serialNumber = 'LIGHT-003';
+        super(api, log, {
+            uuid: api.matter.uuid.generate(serialNumber),
+            displayName: 'Colour Temperature Light',
+            deviceType: api.matter.deviceTypes.ColorTemperatureLight,
+            serialNumber,
+            manufacturer: 'Homebridge Matter',
+            model: 'HB-MATTER-LIGHT-COLOUR-TEMP',
+            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.ColorTemperatureMireds,
+                    colorTemperatureMireds: 250,
+                    colorTempPhysicalMinMireds: 147,
+                    colorTempPhysicalMaxMireds: 454,
+                    coupleColorTempToLevelMinMireds: 147,
+                },
+            },
+            handlers: {
+                onOff: {
+                    on: async () => this.handleOn(),
+                    off: async () => this.handleOff(),
+                },
+                levelControl: {
+                    moveToLevelWithOnOff: async (request) => this.handleSetLevel(request),
+                },
+                colorControl: {
+                    moveToColorTemperatureLogic: async (request) => this.handleSetColorTemperature(request),
+                },
+            },
+        });
+        this.logInfo('initialized.');
+    }
+    async handleOn() {
+        this.logInfo('turning on.');
+        // TODO: await myLightAPI.turnOn()
+    }
+    async handleOff() {
+        this.logInfo('turning off.');
+        // TODO: await myLightAPI.turnOff()
+    }
+    async handleSetLevel(request) {
+        this.logInfo(`MoveToLevel request: ${JSON.stringify(request)}`);
+        const { level } = request;
+        const brightnessPercent = Math.round((level / 254) * 100);
+        this.logInfo(`setting brightness to ${brightnessPercent}% (level: ${level}).`);
+        // TODO: await myLightAPI.setBrightness(brightnessPercent)
+    }
+    async handleSetColorTemperature(request) {
+        this.logInfo(`MoveToColorTemperature request: ${JSON.stringify(request)}`);
+        const { colorTemperatureMireds, transitionTime } = request;
+        const kelvin = Math.round(1000000 / colorTemperatureMireds);
+        this.logInfo((`setting color temp to ${kelvin}k (${colorTemperatureMireds} mireds).`));
+        // TODO: await myLightAPI.setColorTemperature(kelvin, transitionTime)
+    }
+    updateOnOffState(isOn) {
+        this.updateState(this.api.matter.clusterNames.OnOff, { onOff: isOn });
+    }
+    updateBrightness(percent) {
+        const matterLevel = Math.max(1, Math.round((percent / 100) * 254));
+        this.updateState(this.api.matter.clusterNames.LevelControl, { currentLevel: matterLevel });
+    }
+    updateColorTemperature(kelvin) {
+        const mireds = Math.round(1000000 / kelvin);
+        this.updateState(this.api.matter.clusterNames.ColorControl, { colorTemperatureMireds: mireds });
+    }
+}
+//# sourceMappingURL=ColorTemperatureLightAccessory.js.map

package/dist/devices/ColorTemperatureLightAccessory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ColorTemperatureLightAccessory.js","sourceRoot":"","sources":["../../src/devices/ColorTemperatureLightAccessory.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAE9D,MAAM,OAAO,8BAA+B,SAAQ,mBAAmB;IACrE,YAAY,GAAQ,EAAE,GAAW;QAC/B,MAAM,YAAY,GAAG,WAAW,CAAA;QAChC,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE;YACd,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;YAC5C,WAAW,EAAE,0BAA0B;YACvC,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,qBAAqB;YACxD,YAAY;YACZ,YAAY,EAAE,mBAAmB;YACjC,KAAK,EAAE,6BAA6B;YACpC,gBAAgB,EAAE,OAAO;YACzB,gBAAgB,EAAE,OAAO;YAEzB,QAAQ,EAAE;gBACR,KAAK,EAAE;oBACL,KAAK,EAAE,KAAK;iBACb;gBACD,YAAY,EAAE;oBACZ,YAAY,EAAE,GAAG;oBACjB,QAAQ,EAAE,CAAC;oBACX,QAAQ,EAAE,GAAG;iBACd;gBACD,YAAY,EAAE;oBACZ,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,sBAAsB;oBACzE,sBAAsB,EAAE,GAAG;oBAC3B,0BAA0B,EAAE,GAAG;oBAC/B,0BAA0B,EAAE,GAAG;oBAC/B,+BAA+B,EAAE,GAAG;iBACrC;aACF;YAED,QAAQ,EAAE;gBACR,KAAK,EAAE;oBACL,EAAE,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE;oBAC/B,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE;iBAClC;gBACD,YAAY,EAAE;oBACZ,oBAAoB,EAAE,KAAK,EAAE,OAAmC,EAAE,EAAE,CAClE,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;iBAC/B;gBACD,YAAY,EAAE;oBACZ,2BAA2B,EAAE,KAAK,EAAE,OAA8C,EAAE,EAAE,CACpF,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC;iBAC1C;aACF;SACF,CAAC,CAAA;QAEF,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;IAC9B,CAAC;IAEO,KAAK,CAAC,QAAQ;QACpB,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAA;QAC3B,kCAAkC;IACpC,CAAC;IAEO,KAAK,CAAC,SAAS;QACrB,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;QAC5B,mCAAmC;IACrC,CAAC;IAEO,KAAK,CAAC,cAAc,CAAC,OAAmC;QAC9D,IAAI,CAAC,OAAO,CAAC,wBAAwB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QAC/D,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAA;QACzB,MAAM,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAA;QACzD,IAAI,CAAC,OAAO,CAAC,yBAAyB,iBAAiB,aAAa,KAAK,IAAI,CAAC,CAAA;QAC9E,0DAA0D;IAC5D,CAAC;IAEO,KAAK,CAAC,yBAAyB,CAAC,OAA8C;QACpF,IAAI,CAAC,OAAO,CAAC,mCAAmC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QAC1E,MAAM,EAAE,sBAAsB,EAAE,cAAc,EAAE,GAAG,OAAO,CAAA;QAC1D,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,sBAAsB,CAAC,CAAA;QAC3D,IAAI,CAAC,OAAO,CAAC,CAAC,yBAAyB,MAAM,MAAM,sBAAsB,WAAW,CAAC,CAAC,CAAA;QACtF,qEAAqE;IACvE,CAAC;IAEM,gBAAgB,CAAC,IAAa;QACnC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IACvE,CAAC;IAEM,gBAAgB,CAAC,OAAe;QACrC,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAA;QAClE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,YAAY,EAAE,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,CAAA;IAC5F,CAAC;IAEM,sBAAsB,CAAC,MAAc;QAC1C,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC,CAAA;QAC3C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,YAAY,EAAE,EAAE,sBAAsB,EAAE,MAAM,EAAE,CAAC,CAAA;IACjG,CAAC;CACF"}

package/dist/devices/ContactSensorAccessory.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Contact Sensor Accessory Class
+ */
+import type { API, Logger } from 'homebridge';
+import { BaseMatterAccessory } from './BaseMatterAccessory.js';
+export declare class ContactSensorAccessory extends BaseMatterAccessory {
+    constructor(api: API, log: Logger);
+    updateContactState(isOpen: boolean): void;
+}

package/dist/devices/ContactSensorAccessory.js

@@ -0,0 +1,30 @@
+/**
+ * Contact Sensor Accessory Class
+ */
+import { BaseMatterAccessory } from './BaseMatterAccessory.js';
+export class ContactSensorAccessory extends BaseMatterAccessory {
+    constructor(api, log) {
+        const serialNumber = 'SENSOR-001';
+        super(api, log, {
+            uuid: api.matter.uuid.generate(serialNumber),
+            displayName: 'Contact Sensor',
+            deviceType: api.matter.deviceTypes.ContactSensor,
+            serialNumber,
+            manufacturer: 'Homebridge Matter',
+            model: 'HB-MATTER-SENSOR-CONTACT',
+            firmwareRevision: '2.0.0',
+            hardwareRevision: '1.0.0',
+            clusters: {
+                booleanState: {
+                    stateValue: false, // false = closed, true = open
+                },
+            },
+        });
+        this.logInfo('initialized.');
+    }
+    updateContactState(isOpen) {
+        this.updateState(this.api.matter.clusterNames.BooleanState, { stateValue: isOpen });
+        this.logInfo(`contact state: ${isOpen ? 'OPEN' : 'CLOSED'}.`);
+    }
+}
+//# sourceMappingURL=ContactSensorAccessory.js.map

package/dist/devices/ContactSensorAccessory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContactSensorAccessory.js","sourceRoot":"","sources":["../../src/devices/ContactSensorAccessory.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAE9D,MAAM,OAAO,sBAAuB,SAAQ,mBAAmB;IAC7D,YAAY,GAAQ,EAAE,GAAW;QAC/B,MAAM,YAAY,GAAG,YAAY,CAAA;QACjC,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE;YACd,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;YAC5C,WAAW,EAAE,gBAAgB;YAC7B,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,aAAa;YAChD,YAAY;YACZ,YAAY,EAAE,mBAAmB;YACjC,KAAK,EAAE,0BAA0B;YACjC,gBAAgB,EAAE,OAAO;YACzB,gBAAgB,EAAE,OAAO;YAEzB,QAAQ,EAAE;gBACR,YAAY,EAAE;oBACZ,UAAU,EAAE,KAAK,EAAE,8BAA8B;iBAClD;aACF;SACF,CAAC,CAAA;QAEF,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;IAC9B,CAAC;IAEM,kBAAkB,CAAC,MAAe;QACvC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,YAAY,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAA;QACnF,IAAI,CAAC,OAAO,CAAC,kBAAkB,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAA;IAC/D,CAAC;CACF"}

package/dist/devices/DimmableLightAccessory.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Dimmable Light Accessory Class
+ *
+ * Example of a more complex device with multiple clusters.
+ * Shows how to handle devices with on/off + level control.
+ */
+import type { API, Logger } from 'homebridge';
+import { BaseMatterAccessory } from './BaseMatterAccessory.js';
+/**
+ * Dimmable Light Device Class
+ *
+ * Demonstrates:
+ * - Multiple clusters (OnOff + LevelControl)
+ * - Type-safe request handlers
+ * - Value conversion (Matter level ↔ percentage)
+ * - Custom public methods for external control
+ */
+export declare class DimmableLightAccessory extends BaseMatterAccessory {
+    private currentLevel;
+    constructor(api: API, log: Logger);
+    /**
+     * Handle the "on" command
+     */
+    private handleOn;
+    /**
+     * Handle the "off" command
+     */
+    private handleOff;
+    /**
+     * Handle brightness level changes
+     */
+    private handleSetLevel;
+    /**
+     * Update on/off state from external source
+     */
+    updateOnOffState(isOn: boolean): void;
+    /**
+     * Update brightness level from external source
+     * @param percent - Brightness percentage (0-100)
+     */
+    updateBrightness(percent: number): void;
+    /**
+     * Get current brightness as percentage
+     */
+    getBrightness(): number;
+    /**
+     * Set brightness and power state together
+     * Useful for syncing complete state from external source
+     */
+    updateFullState(isOn: boolean, percent: number): void;
+    /**
+     * Example monitoring setup
+     */
+    startMonitoring(): void;
+}