homebridge 2.0.0-alpha.6 → 2.0.0-alpha.61

package/dist/matter/matterBehaviors.d.ts

@@ -0,0 +1,158 @@
+/**
+ * Custom Matter Behavior Classes for Homebridge
+ *
+ * These custom behaviors extend the base Matter.js behaviors and override
+ * command methods to allow plugins to inject custom handlers.
+ *
+ * Note: Only clusters with user-triggered commands need custom behaviors.
+ * Read-only clusters (like sensors) don't need custom behaviors since
+ * they only report state, they don't receive commands.
+ */
+import type { MatterCommandHandler } from './matterTypes.js';
+import { ColorControlServer, DoorLockServer, IdentifyServer, LevelControlServer, OnOffServer, RvcCleanModeServer, RvcOperationalStateServer, RvcRunModeServer, ServiceAreaServer, ThermostatServer, WindowCoveringServer } from '@matter/main/behaviors';
+/**
+ * Set the accessories map reference for cache syncing
+ */
+export declare function setAccessoriesMap(map: Map<string, any>): void;
+/**
+ * Register a handler for a specific endpoint/cluster/command
+ *
+ * @param endpointId - Unique endpoint identifier (typically the accessory UUID)
+ * @param clusterName - Name of the Matter cluster (e.g., 'onOff', 'levelControl')
+ * @param commandName - Name of the command method (e.g., 'on', 'off', 'moveToLevel')
+ * @param handler - Callback function to execute when the command is received
+ *
+ * @example
+ * ```typescript
+ * registerHandler('my-light-uuid', 'onOff', 'on', async () => {
+ *   console.log('Light turned on!')
+ * })
+ * ```
+ */
+export declare function registerHandler(endpointId: string, clusterName: string, commandName: string, handler: MatterCommandHandler): void;
+/**
+ * Custom OnOff Server that calls plugin handlers
+ */
+export declare class HomebridgeOnOffServer extends OnOffServer {
+    on(): any;
+    off(): any;
+    toggle(): any;
+}
+/**
+ * Custom LevelControl Server that calls plugin handlers
+ */
+export declare class HomebridgeLevelControlServer extends LevelControlServer {
+    moveToLevel(request: any): any;
+    moveToLevelWithOnOff(request: any): any;
+    move(request: any): any;
+    step(request: any): any;
+    stop(request: any): any;
+}
+/**
+ * Custom WindowCovering Server that calls plugin handlers
+ */
+export declare class HomebridgeWindowCoveringServer extends WindowCoveringServer {
+    upOrOpen(): any;
+    downOrClose(): any;
+    stopMotion(): any;
+}
+/**
+ * Custom DoorLock Server that calls plugin handlers
+ */
+export declare class HomebridgeDoorLockServer extends DoorLockServer {
+    lockDoor(): any;
+    unlockDoor(): any;
+}
+/**
+ * Custom Thermostat Server that calls plugin handlers
+ */
+export declare class HomebridgeThermostatServer extends ThermostatServer {
+    setpointRaiseLower(request: any): any;
+}
+/**
+ * Custom Identify Server that calls plugin handlers
+ */
+export declare class HomebridgeIdentifyServer extends IdentifyServer {
+    identify(request: any): any;
+}
+/**
+ * Custom ColorControl Server that calls plugin handlers
+ *
+ * ColorControl handles color changes for lights (hue, saturation, XY color, color temperature).
+ * Plugin developers can override these *Logic methods to handle color changes in their hardware.
+ *
+ * Features (Xy, ColorTemperature, HueSaturation) are added by the device type, not this behavior.
+ * This ensures each device only gets the features it needs.
+ */
+export declare class HomebridgeColorControlServer extends ColorControlServer {
+    /**
+     * Called when color temperature is changed
+     * @param targetMireds - Target color temperature in mireds (micro reciprocal degrees)
+     * @param transitionTime - Transition time in seconds (0 = as fast as possible)
+     */
+    moveToColorTemperatureLogic(targetMireds: number, transitionTime: number): any;
+    /**
+     * Called when hue and saturation are changed together
+     * @param targetHue - Target hue value (0-254 for normal hue, 0-65535 for enhanced hue)
+     * @param targetSaturation - Target saturation value (0-254)
+     * @param transitionTime - Transition time in seconds (0 = as fast as possible)
+     */
+    moveToHueAndSaturationLogic(targetHue: number, targetSaturation: number, transitionTime: number): any;
+    /**
+     * Called when XY color coordinates are changed
+     * @param targetX - Target X value (0-65535 representing 0.0-1.0 in CIE color space)
+     * @param targetY - Target Y value (0-65535 representing 0.0-1.0 in CIE color space)
+     * @param transitionTime - Transition time in seconds (0 = as fast as possible)
+     */
+    moveToColorLogic(targetX: number, targetY: number, transitionTime: number): any;
+    /**
+     * Called when hue is changed individually
+     * @param targetHue - Target hue value
+     * @param direction - Direction to move (shortest, longest, up, down)
+     * @param transitionTime - Transition time in seconds
+     * @param isEnhancedHue - Whether this is enhanced hue (16-bit) or normal hue (8-bit)
+     */
+    moveToHueLogic(targetHue: number, direction: any, transitionTime: number, isEnhancedHue?: boolean): any;
+    /**
+     * Called when saturation is changed individually
+     * @param targetSaturation - Target saturation value (0-254)
+     * @param transitionTime - Transition time in seconds
+     */
+    moveToSaturationLogic(targetSaturation: number, transitionTime: number): any;
+    /**
+     * Called when all color movement should be stopped
+     */
+    stopAllColorMovement(): any;
+}
+/**
+ * Custom RvcOperationalState Server that calls plugin handlers
+ * Handles robotic vacuum cleaner operational state commands
+ */
+export declare class HomebridgeRvcOperationalStateServer extends RvcOperationalStateServer {
+    pause(): any;
+    resume(): any;
+    goHome(): any;
+}
+/**
+ * Custom RvcRunMode Server that calls plugin handlers
+ * Handles robotic vacuum cleaner run mode changes
+ */
+export declare class HomebridgeRvcRunModeServer extends RvcRunModeServer {
+    changeToMode(request: any): any;
+}
+/**
+ * Custom RvcCleanMode Server that calls plugin handlers
+ * Handles robotic vacuum cleaner cleaning mode changes
+ */
+export declare class HomebridgeRvcCleanModeServer extends RvcCleanModeServer {
+    changeToMode(request: any): any;
+}
+/**
+ * Custom ServiceArea Server that calls plugin handlers
+ * Handles service area selection for robotic vacuum cleaners
+ */
+export declare class HomebridgeServiceAreaServer extends ServiceAreaServer {
+    selectAreas(request: any): any;
+    skipArea(request: any): any;
+}
+//# sourceMappingURL=matterBehaviors.d.ts.map

package/dist/matter/matterBehaviors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"matterBehaviors.d.ts","sourceRoot":"","sources":["../../src/matter/matterBehaviors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAA;AAE5D,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,cAAc,EACd,kBAAkB,EAClB,WAAW,EACX,kBAAkB,EAClB,yBAAyB,EACzB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,oBAAoB,EACrB,MAAM,wBAAwB,CAAA;AAkB/B;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,QAEtD;AA4BD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,oBAAoB,QAc9B;AASD;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,WAAW;IAC3C,EAAE,IAAI,GAAG;IAyBT,GAAG,IAAI,GAAG;IAyBV,MAAM,IAAI,GAAG;CAuBvB;AAED;;GAEG;AACH,qBAAa,4BAA6B,SAAQ,kBAAkB;IACzD,WAAW,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG;IAyB9B,oBAAoB,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG;IA+BvC,IAAI,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG;IAkBvB,IAAI,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG;IAkBvB,IAAI,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG;CAiBjC;AAED;;GAEG;AACH,qBAAa,8BAA+B,SAAQ,oBAAoB;IAC7D,QAAQ,IAAI,GAAG;IA+Bf,WAAW,IAAI,GAAG;IA+BlB,UAAU,IAAI,GAAG;CA8B3B;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,cAAc;IACjD,QAAQ,IAAI,GAAG;IA0Bf,UAAU,IAAI,GAAG;CAyB3B;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,gBAAgB;IACrD,kBAAkB,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG;CA8B/C;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,cAAc;IACjD,QAAQ,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG;CAiBrC;AAED;;;;;;;;GAQG;AACH,qBAAa,4BAA6B,SAAQ,kBAAkB;IAClE;;;;OAIG;IACM,2BAA2B,CAAC,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,GAAG;IA4BvF;;;;;OAKG;IACM,2BAA2B,CAAC,SAAS,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,GAAG;IA+B9G;;;;;OAKG;IACM,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,GAAG;IA+BxF;;;;;;OAMG;IACM,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,EAAE,cAAc,EAAE,MAAM,EAAE,aAAa,UAAQ,GAAG,GAAG;IA8B9G;;;;OAIG;IACM,qBAAqB,CAAC,gBAAgB,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,GAAG;IA4BrF;;OAEG;IACM,oBAAoB,IAAI,GAAG;CAiBrC;AAED;;;GAGG;AACH,qBAAa,mCAAoC,SAAQ,yBAAyB;IACvE,KAAK,IAAI,GAAG;IAkBZ,MAAM,IAAI,GAAG;IAkBb,MAAM,IAAI,GAAG;CAiBvB;AAED;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,gBAAgB;IACrD,YAAY,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG;CAiBzC;AAED;;;GAGG;AACH,qBAAa,4BAA6B,SAAQ,kBAAkB;IACzD,YAAY,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG;CAiBzC;AAED;;;GAGG;AACH,qBAAa,2BAA4B,SAAQ,iBAAiB;IACvD,WAAW,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG;IAkB9B,QAAQ,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG;CAiBrC"}