homebridge 2.0.0-alpha.7 → 2.0.0-alpha.71

package/dist/matter/matterBehaviors.d.ts

@@ -0,0 +1,177 @@
+/**
+ * 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 { MaybePromise } from '@matter/main';
+import type { ColorControl, Identify, LevelControl, RvcOperationalState, ServiceArea, Thermostat, WindowCovering } from '@matter/main/clusters';
+import type { MatterAccessoryMap, MatterCommandHandler } from './matterTypes.js';
+import { ColorControlServer, DoorLockServer, FanControlServer, IdentifyServer, LevelControlServer, OnOffServer, RvcCleanModeServer, RvcOperationalStateServer, RvcRunModeServer, ServiceAreaServer, ThermostatServer, WindowCoveringBaseServer } from '@matter/main/behaviors';
+/**
+ * Result type for Matter commands
+ * MaybePromise allows both sync and async returns, matching Matter.js base classes
+ */
+type MatterCommandResult = MaybePromise<void>;
+/**
+ * Set the accessories map reference for cache syncing
+ */
+export declare function setAccessoriesMap(map: MatterAccessoryMap): 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(): MatterCommandResult;
+    off(): MatterCommandResult;
+    toggle(): MatterCommandResult;
+}
+/**
+ * Custom LevelControl Server that calls plugin handlers
+ */
+export declare class HomebridgeLevelControlServer extends LevelControlServer {
+    moveToLevel(request: LevelControl.MoveToLevelRequest): MatterCommandResult;
+    moveToLevelWithOnOff(request: LevelControl.MoveToLevelRequest): MaybePromise;
+    move(request: LevelControl.MoveRequest): MaybePromise;
+    step(request: LevelControl.StepRequest): MaybePromise;
+    stop(request: LevelControl.StopRequest): MaybePromise;
+}
+/**
+ * Custom WindowCovering Server that calls plugin handlers
+ */
+export declare class HomebridgeWindowCoveringServer extends WindowCoveringBaseServer {
+    upOrOpen(): MaybePromise;
+    downOrClose(): MaybePromise;
+    stopMotion(): MaybePromise;
+    goToLiftPercentage(request: WindowCovering.GoToLiftPercentageRequest): MaybePromise;
+    goToTiltPercentage(request: WindowCovering.GoToTiltPercentageRequest): MaybePromise;
+}
+/**
+ * Custom FanControl Server that calls plugin handlers
+ */
+export declare class HomebridgeFanControlServer extends FanControlServer {
+    #private;
+    initialize(): void;
+}
+/**
+ * Custom DoorLock Server that calls plugin handlers
+ */
+export declare class HomebridgeDoorLockServer extends DoorLockServer {
+    lockDoor(): MaybePromise;
+    unlockDoor(): MaybePromise;
+}
+/**
+ * Custom Thermostat Server that calls plugin handlers
+ */
+export declare class HomebridgeThermostatServer extends ThermostatServer {
+    #private;
+    initialize(): void;
+    setpointRaiseLower(request: Thermostat.SetpointRaiseLowerRequest): MaybePromise;
+}
+/**
+ * Custom Identify Server that calls plugin handlers
+ */
+export declare class HomebridgeIdentifyServer extends IdentifyServer {
+    identify(request: Identify.IdentifyRequest): MaybePromise;
+}
+/**
+ * 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 colorTemperatureMireds - Target color temperature in mireds (micro reciprocal degrees)
+     * @param transitionTime - Transition time in seconds (0 = as fast as possible)
+     */
+    moveToColorTemperatureLogic(colorTemperatureMireds: number, transitionTime: number): MaybePromise;
+    /**
+     * Called when hue and saturation are changed together
+     * @param hue - Target hue value (0-254 for normal hue, 0-65535 for enhanced hue)
+     * @param saturation - Target saturation value (0-254)
+     * @param transitionTime - Transition time in seconds (0 = as fast as possible)
+     */
+    moveToHueAndSaturationLogic(hue: number, saturation: number, transitionTime: number): MaybePromise;
+    /**
+     * 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): MaybePromise;
+    /**
+     * 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: ColorControl.Direction, transitionTime: number, isEnhancedHue?: boolean): MaybePromise;
+    /**
+     * Called when saturation is changed individually
+     * @param targetSaturation - Target saturation value (0-254)
+     * @param transitionTime - Transition time in seconds
+     */
+    moveToSaturationLogic(targetSaturation: number, transitionTime: number): MaybePromise;
+    /**
+     * Called when all color movement should be stopped
+     */
+    stopAllColorMovement(): MaybePromise;
+}
+/**
+ * Custom RvcOperationalState Server that calls plugin handlers
+ * Handles robotic vacuum cleaner operational state commands
+ */
+export declare class HomebridgeRvcOperationalStateServer extends RvcOperationalStateServer {
+    pause(): MaybePromise<RvcOperationalState.OperationalCommandResponse>;
+    resume(): MaybePromise<RvcOperationalState.OperationalCommandResponse>;
+    goHome(): MaybePromise<RvcOperationalState.OperationalCommandResponse>;
+}
+/**
+ * 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: ServiceArea.SelectAreasRequest): MaybePromise<ServiceArea.SelectAreasResponse>;
+    skipArea(request: ServiceArea.SkipAreaRequest): MaybePromise<ServiceArea.SkipAreaResponse>;
+}
+export {};
+//# 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,YAAY,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,KAAK,EACV,YAAY,EACZ,QAAQ,EACR,YAAY,EACZ,mBAAmB,EACnB,WAAW,EACX,UAAU,EACV,cAAc,EACf,MAAM,uBAAuB,CAAA;AAE9B,OAAO,KAAK,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAA;AAEhF,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,cAAc,EACd,kBAAkB,EAClB,WAAW,EACX,kBAAkB,EAClB,yBAAyB,EACzB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,wBAAwB,EACzB,MAAM,wBAAwB,CAAA;AAO/B;;;GAGG;AACH,KAAK,mBAAmB,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;AAiF7C;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,kBAAkB,GAAG,IAAI,CAE/D;AA4BD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,oBAAoB,QAc9B;AAuCD;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,WAAW;IAC3C,EAAE,IAAI,mBAAmB;IAUzB,GAAG,IAAI,mBAAmB;IAU1B,MAAM,IAAI,mBAAmB;CAYvC;AAED;;GAEG;AACH,qBAAa,4BAA6B,SAAQ,kBAAkB;IACzD,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC,kBAAkB,GAAG,mBAAmB;IAU1E,oBAAoB,CAAC,OAAO,EAAE,YAAY,CAAC,kBAAkB,GAAG,YAAY;IAsB5E,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,WAAW,GAAG,YAAY;IAMrD,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,WAAW,GAAG,YAAY;IAMrD,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,WAAW,GAAG,YAAY;CAK/D;AAED;;GAEG;AACH,qBAAa,8BAA+B,SAAQ,wBAAwB;IACjE,QAAQ,IAAI,YAAY;IAoBxB,WAAW,IAAI,YAAY;IAoB3B,UAAU,IAAI,YAAY;IAoB1B,kBAAkB,CAAC,OAAO,EAAE,cAAc,CAAC,yBAAyB,GAAG,YAAY;IAoBnF,kBAAkB,CAAC,OAAO,EAAE,cAAc,CAAC,yBAAyB,GAAG,YAAY;CAmB7F;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,gBAAgB;;IACrD,UAAU,IAAI,IAAI;CA6B5B;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,cAAc;IACjD,QAAQ,IAAI,YAAY;IAexB,UAAU,IAAI,YAAY;CAcpC;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,gBAAgB;;IACrD,UAAU,IAAI,IAAI;IAkDlB,kBAAkB,CAAC,OAAO,EAAE,UAAU,CAAC,yBAAyB,GAAG,YAAY;CAmBzF;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,cAAc;IACjD,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,eAAe,GAAG,YAAY;CAKnE;AAED;;;;;;;;GAQG;AACH,qBAAa,4BAA6B,SAAQ,kBAAkB;IAClE;;;;OAIG;IACM,2BAA2B,CAAC,sBAAsB,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,YAAY;IAiB1G;;;;;OAKG;IACM,2BAA2B,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,YAAY;IAoB3G;;;;;OAKG;IACM,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,YAAY;IAoBjG;;;;;;OAMG;IACM,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC,SAAS,EAAE,cAAc,EAAE,MAAM,EAAE,aAAa,UAAQ,GAAG,YAAY;IAmB1I;;;;OAIG;IACM,qBAAqB,CAAC,gBAAgB,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,YAAY;IAiB9F;;OAEG;IACM,oBAAoB,IAAI,YAAY;CAK9C;AAED;;;GAGG;AACH,qBAAa,mCAAoC,SAAQ,yBAAyB;IACvE,KAAK,IAAI,YAAY,CAAC,mBAAmB,CAAC,0BAA0B,CAAC;IAMrE,MAAM,IAAI,YAAY,CAAC,mBAAmB,CAAC,0BAA0B,CAAC;IAMtE,MAAM,IAAI,YAAY,CAAC,mBAAmB,CAAC,0BAA0B,CAAC;CAKhF;AAED;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,gBAAgB;IACrD,YAAY,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG;CAKzC;AAED;;;GAGG;AACH,qBAAa,4BAA6B,SAAQ,kBAAkB;IACzD,YAAY,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG;CAKzC;AAED;;;GAGG;AACH,qBAAa,2BAA4B,SAAQ,iBAAiB;IACvD,WAAW,CAAC,OAAO,EAAE,WAAW,CAAC,kBAAkB,GAAG,YAAY,CAAC,WAAW,CAAC,mBAAmB,CAAC;IAMnG,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,eAAe,GAAG,YAAY,CAAC,WAAW,CAAC,gBAAgB,CAAC;CAKpG"}