@zwave-js/cc 14.0.0-beta.1 → 14.0.0-beta.5

package/build/esm/cc/WindowCoveringCC.d.ts

@@ -0,0 +1,315 @@
+import { CommandClasses, Duration, type MessageOrCCLogEntry, type SupervisionResult, type WithAddress } from "@zwave-js/core";
+import { type MaybeNotKnown } from "@zwave-js/core/safe";
+import type { CCEncodingContext, CCParsingContext, GetValueDB } from "@zwave-js/host";
+import { Bytes } from "@zwave-js/shared/safe";
+import { CCAPI, POLL_VALUE, type PollValueImplementation, SET_VALUE, SET_VALUE_HOOKS, type SetValueImplementation, type SetValueImplementationHooksFactory } from "../lib/API.js";
+import { type CCRaw, CommandClass, type InterviewContext } from "../lib/CommandClass.js";
+import { type LevelChangeDirection, WindowCoveringCommand, WindowCoveringParameter } from "../lib/_Types.js";
+export declare const WindowCoveringCCValues: Readonly<{
+    levelChangeDown: ((parameter: WindowCoveringParameter) => {
+        readonly meta: {
+            readonly label: `${string} - ${string}`;
+            readonly valueChangeOptions: readonly ["transitionDuration"];
+            readonly states: {
+                readonly true: "Start";
+                readonly false: "Stop";
+            };
+            readonly ccSpecific: {
+                readonly parameter: WindowCoveringParameter;
+            };
+            readonly readable: false;
+            readonly type: "boolean";
+            readonly writeable: true;
+        };
+        readonly id: {
+            commandClass: (typeof CommandClasses)["Window Covering"];
+            property: "levelChangeDown";
+            propertyKey: WindowCoveringParameter;
+        };
+        readonly endpoint: (endpoint?: number | undefined) => {
+            readonly commandClass: (typeof CommandClasses)["Window Covering"];
+            readonly endpoint: number;
+            readonly property: "levelChangeDown";
+            readonly propertyKey: WindowCoveringParameter;
+        };
+    }) & {
+        is: (valueId: import("@zwave-js/core").ValueID) => boolean;
+        readonly options: {
+            readonly internal: false;
+            readonly minVersion: 1;
+            readonly secret: false;
+            readonly stateful: true;
+            readonly supportsEndpoints: true;
+            readonly autoCreate: true;
+        };
+    };
+    levelChangeUp: ((parameter: WindowCoveringParameter) => {
+        readonly meta: {
+            readonly label: `${string} - ${string}`;
+            readonly valueChangeOptions: readonly ["transitionDuration"];
+            readonly states: {
+                readonly true: "Start";
+                readonly false: "Stop";
+            };
+            readonly ccSpecific: {
+                readonly parameter: WindowCoveringParameter;
+            };
+            readonly readable: false;
+            readonly type: "boolean";
+            readonly writeable: true;
+        };
+        readonly id: {
+            commandClass: (typeof CommandClasses)["Window Covering"];
+            property: "levelChangeUp";
+            propertyKey: WindowCoveringParameter;
+        };
+        readonly endpoint: (endpoint?: number | undefined) => {
+            readonly commandClass: (typeof CommandClasses)["Window Covering"];
+            readonly endpoint: number;
+            readonly property: "levelChangeUp";
+            readonly propertyKey: WindowCoveringParameter;
+        };
+    }) & {
+        is: (valueId: import("@zwave-js/core").ValueID) => boolean;
+        readonly options: {
+            readonly internal: false;
+            readonly minVersion: 1;
+            readonly secret: false;
+            readonly stateful: true;
+            readonly supportsEndpoints: true;
+            readonly autoCreate: true;
+        };
+    };
+    duration: ((parameter: WindowCoveringParameter) => {
+        readonly meta: {
+            readonly label: `Remaining duration - ${string}`;
+            readonly ccSpecific: {
+                readonly parameter: WindowCoveringParameter;
+            };
+            readonly writeable: false;
+            readonly type: "duration";
+            readonly readable: true;
+        };
+        readonly id: {
+            commandClass: (typeof CommandClasses)["Window Covering"];
+            property: "duration";
+            propertyKey: WindowCoveringParameter;
+        };
+        readonly endpoint: (endpoint?: number | undefined) => {
+            readonly commandClass: (typeof CommandClasses)["Window Covering"];
+            readonly endpoint: number;
+            readonly property: "duration";
+            readonly propertyKey: WindowCoveringParameter;
+        };
+    }) & {
+        is: (valueId: import("@zwave-js/core").ValueID) => boolean;
+        readonly options: {
+            readonly internal: false;
+            readonly minVersion: 1;
+            readonly secret: false;
+            readonly stateful: true;
+            readonly supportsEndpoints: true;
+            readonly autoCreate: true;
+        };
+    };
+    targetValue: ((parameter: WindowCoveringParameter) => {
+        readonly meta: {
+            readonly label: `Target value - ${string}`;
+            readonly writeable: boolean;
+            readonly states: {
+                [x: number]: string;
+            };
+            readonly allowManualEntry: boolean;
+            readonly ccSpecific: {
+                readonly parameter: WindowCoveringParameter;
+            };
+            readonly valueChangeOptions: readonly ["transitionDuration"];
+            readonly max: 99;
+            readonly min: 0;
+            readonly type: "number";
+            readonly readable: true;
+        };
+        readonly id: {
+            commandClass: (typeof CommandClasses)["Window Covering"];
+            property: "targetValue";
+            propertyKey: WindowCoveringParameter;
+        };
+        readonly endpoint: (endpoint?: number | undefined) => {
+            readonly commandClass: (typeof CommandClasses)["Window Covering"];
+            readonly endpoint: number;
+            readonly property: "targetValue";
+            readonly propertyKey: WindowCoveringParameter;
+        };
+    }) & {
+        is: (valueId: import("@zwave-js/core").ValueID) => boolean;
+        readonly options: {
+            readonly internal: false;
+            readonly minVersion: 1;
+            readonly secret: false;
+            readonly stateful: true;
+            readonly supportsEndpoints: true;
+            readonly autoCreate: true;
+        };
+    };
+    currentValue: ((parameter: WindowCoveringParameter) => {
+        readonly meta: {
+            readonly label: `Current value - ${string}`;
+            readonly states: {
+                [x: number]: string;
+            };
+            readonly ccSpecific: {
+                readonly parameter: WindowCoveringParameter;
+            };
+            readonly writeable: false;
+            readonly max: 99;
+            readonly min: 0;
+            readonly type: "number";
+            readonly readable: true;
+        };
+        readonly id: {
+            commandClass: (typeof CommandClasses)["Window Covering"];
+            property: "currentValue";
+            propertyKey: WindowCoveringParameter;
+        };
+        readonly endpoint: (endpoint?: number | undefined) => {
+            readonly commandClass: (typeof CommandClasses)["Window Covering"];
+            readonly endpoint: number;
+            readonly property: "currentValue";
+            readonly propertyKey: WindowCoveringParameter;
+        };
+    }) & {
+        is: (valueId: import("@zwave-js/core").ValueID) => boolean;
+        readonly options: {
+            readonly internal: false;
+            readonly minVersion: 1;
+            readonly secret: false;
+            readonly stateful: true;
+            readonly supportsEndpoints: true;
+            readonly autoCreate: true;
+        };
+    };
+    supportedParameters: {
+        readonly id: {
+            commandClass: (typeof CommandClasses)["Window Covering"];
+            property: "supportedParameters";
+        };
+        readonly endpoint: (endpoint?: number | undefined) => {
+            readonly commandClass: (typeof CommandClasses)["Window Covering"];
+            readonly endpoint: number;
+            readonly property: "supportedParameters";
+        };
+        readonly is: (valueId: import("@zwave-js/core").ValueID) => boolean;
+        readonly meta: {
+            readonly type: "any";
+            readonly readable: true;
+            readonly writeable: true;
+        };
+        readonly options: {
+            readonly stateful: true;
+            readonly secret: false;
+            readonly minVersion: 1;
+            readonly supportsEndpoints: true;
+            readonly autoCreate: true;
+            readonly internal: true;
+        };
+    };
+}>;
+export declare class WindowCoveringCCAPI extends CCAPI {
+    supportsCommand(cmd: WindowCoveringCommand): MaybeNotKnown<boolean>;
+    protected get [SET_VALUE](): SetValueImplementation;
+    protected [SET_VALUE_HOOKS]: SetValueImplementationHooksFactory;
+    protected get [POLL_VALUE](): PollValueImplementation;
+    getSupported(): Promise<MaybeNotKnown<readonly WindowCoveringParameter[]>>;
+    get(parameter: WindowCoveringParameter): Promise<Pick<WindowCoveringCCReport, "duration" | "currentValue" | "targetValue"> | undefined>;
+    set(targetValues: {
+        parameter: WindowCoveringParameter;
+        value: number;
+    }[], duration?: Duration | string): Promise<SupervisionResult | undefined>;
+    startLevelChange(parameter: WindowCoveringParameter, direction: keyof typeof LevelChangeDirection, duration?: Duration | string): Promise<SupervisionResult | undefined>;
+    stopLevelChange(parameter: WindowCoveringParameter): Promise<SupervisionResult | undefined>;
+}
+export declare class WindowCoveringCC extends CommandClass {
+    ccCommand: WindowCoveringCommand;
+    interview(ctx: InterviewContext): Promise<void>;
+    translatePropertyKey(ctx: GetValueDB, property: string | number, propertyKey: string | number): string | undefined;
+}
+export interface WindowCoveringCCSupportedReportOptions {
+    supportedParameters: readonly WindowCoveringParameter[];
+}
+export declare class WindowCoveringCCSupportedReport extends WindowCoveringCC {
+    constructor(options: WithAddress<WindowCoveringCCSupportedReportOptions>);
+    static from(raw: CCRaw, ctx: CCParsingContext): WindowCoveringCCSupportedReport;
+    readonly supportedParameters: readonly WindowCoveringParameter[];
+    serialize(ctx: CCEncodingContext): Bytes;
+    toLogEntry(ctx?: GetValueDB): MessageOrCCLogEntry;
+}
+export declare class WindowCoveringCCSupportedGet extends WindowCoveringCC {
+}
+export interface WindowCoveringCCReportOptions {
+    parameter: WindowCoveringParameter;
+    currentValue: number;
+    targetValue: number;
+    duration: Duration;
+}
+export declare class WindowCoveringCCReport extends WindowCoveringCC {
+    constructor(options: WithAddress<WindowCoveringCCReportOptions>);
+    static from(raw: CCRaw, ctx: CCParsingContext): WindowCoveringCCReport;
+    readonly parameter: WindowCoveringParameter;
+    readonly currentValue: number;
+    readonly targetValue: number;
+    readonly duration: Duration;
+    toLogEntry(ctx?: GetValueDB): MessageOrCCLogEntry;
+}
+export interface WindowCoveringCCGetOptions {
+    parameter: WindowCoveringParameter;
+}
+export declare class WindowCoveringCCGet extends WindowCoveringCC {
+    constructor(options: WithAddress<WindowCoveringCCGetOptions>);
+    static from(raw: CCRaw, ctx: CCParsingContext): WindowCoveringCCGet;
+    parameter: WindowCoveringParameter;
+    serialize(ctx: CCEncodingContext): Bytes;
+    toLogEntry(ctx?: GetValueDB): MessageOrCCLogEntry;
+}
+export interface WindowCoveringCCSetOptions {
+    targetValues: {
+        parameter: WindowCoveringParameter;
+        value: number;
+    }[];
+    duration?: Duration | string;
+}
+export declare class WindowCoveringCCSet extends WindowCoveringCC {
+    constructor(options: WithAddress<WindowCoveringCCSetOptions>);
+    static from(raw: CCRaw, ctx: CCParsingContext): WindowCoveringCCSet;
+    targetValues: {
+        parameter: WindowCoveringParameter;
+        value: number;
+    }[];
+    duration: Duration | undefined;
+    serialize(ctx: CCEncodingContext): Bytes;
+    toLogEntry(ctx?: GetValueDB): MessageOrCCLogEntry;
+}
+export interface WindowCoveringCCStartLevelChangeOptions {
+    parameter: WindowCoveringParameter;
+    direction: keyof typeof LevelChangeDirection;
+    duration?: Duration | string;
+}
+export declare class WindowCoveringCCStartLevelChange extends WindowCoveringCC {
+    constructor(options: WithAddress<WindowCoveringCCStartLevelChangeOptions>);
+    static from(raw: CCRaw, ctx: CCParsingContext): WindowCoveringCCStartLevelChange;
+    parameter: WindowCoveringParameter;
+    direction: keyof typeof LevelChangeDirection;
+    duration: Duration | undefined;
+    serialize(ctx: CCEncodingContext): Bytes;
+    toLogEntry(ctx?: GetValueDB): MessageOrCCLogEntry;
+}
+export interface WindowCoveringCCStopLevelChangeOptions {
+    parameter: WindowCoveringParameter;
+}
+export declare class WindowCoveringCCStopLevelChange extends WindowCoveringCC {
+    constructor(options: WithAddress<WindowCoveringCCStopLevelChangeOptions>);
+    static from(raw: CCRaw, ctx: CCParsingContext): WindowCoveringCCStopLevelChange;
+    parameter: WindowCoveringParameter;
+    serialize(ctx: CCEncodingContext): Bytes;
+    toLogEntry(ctx?: GetValueDB): MessageOrCCLogEntry;
+}
+//# sourceMappingURL=WindowCoveringCC.d.ts.map

package/build/esm/cc/WindowCoveringCC.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WindowCoveringCC.d.ts","sourceRoot":"","sources":["../../../src/cc/WindowCoveringCC.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,cAAc,EACd,QAAQ,EACR,KAAK,mBAAmB,EAGxB,KAAK,iBAAiB,EAEtB,KAAK,WAAW,EAIhB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,KAAK,EACX,iBAAiB,EACjB,gBAAgB,EAChB,UAAU,EACV,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAG9C,OAAO,EACN,KAAK,EACL,UAAU,EACV,KAAK,uBAAuB,EAC5B,SAAS,EACT,eAAe,EACf,KAAK,sBAAsB,EAC3B,KAAK,kCAAkC,EAKvC,MAAM,eAAe,CAAC;AACvB,OAAO,EACN,KAAK,KAAK,EACV,YAAY,EACZ,KAAK,gBAAgB,EACrB,MAAM,wBAAwB,CAAC;AAYhC,OAAO,EACN,KAAK,oBAAoB,EACzB,qBAAqB,EACrB,uBAAuB,EACvB,MAAM,kBAAkB,CAAC;AAqD1B,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA6IjC,CAAC;AAEH,qBACa,mBAAoB,SAAQ,KAAK;IACtC,eAAe,CAAC,GAAG,EAAE,qBAAqB,GAAG,aAAa,CAAC,OAAO,CAAC;IAY1E,cAAuB,CAAC,SAAS,CAAC,IAAI,sBAAsB,CA0E3D;IAED,SAAS,CAAC,CAAC,eAAe,CAAC,EAAE,kCAAkC,CAoG7D;IAEF,SAAS,KAAK,CAAC,UAAU,CAAC,IAAI,uBAAuB,CAuBpD;IAEY,YAAY,IAAI,OAAO,CACnC,aAAa,CAAC,SAAS,uBAAuB,EAAE,CAAC,CACjD;IAqBY,GAAG,CAAC,SAAS,EAAE,uBAAuB;IAuBtC,GAAG,CACf,YAAY,EAAE;QACb,SAAS,EAAE,uBAAuB,CAAC;QACnC,KAAK,EAAE,MAAM,CAAC;KACd,EAAE,EACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,MAAM,GAC1B,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAiB5B,gBAAgB,CAC5B,SAAS,EAAE,uBAAuB,EAClC,SAAS,EAAE,MAAM,OAAO,oBAAoB,EAC5C,QAAQ,CAAC,EAAE,QAAQ,GAAG,MAAM,GAC1B,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAkB5B,eAAe,CAC3B,SAAS,EAAE,uBAAuB,GAChC,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;CAczC;AAED,qBAGa,gBAAiB,SAAQ,YAAY;IACzC,SAAS,EAAE,qBAAqB,CAAC;IAE5B,SAAS,CACrB,GAAG,EAAE,gBAAgB,GACnB,OAAO,CAAC,IAAI,CAAC;IAqFT,oBAAoB,CAC1B,GAAG,EAAE,UAAU,EACf,QAAQ,EAAE,MAAM,GAAG,MAAM,EACzB,WAAW,EAAE,MAAM,GAAG,MAAM,GAC1B,MAAM,GAAG,SAAS;CAMrB;AAGD,MAAM,WAAW,sCAAsC;IACtD,mBAAmB,EAAE,SAAS,uBAAuB,EAAE,CAAC;CACxD;AAED,qBAKa,+BAAgC,SAAQ,gBAAgB;gBAEnE,OAAO,EAAE,WAAW,CAAC,sCAAsC,CAAC;WAM/C,IAAI,CACjB,GAAG,EAAE,KAAK,EACV,GAAG,EAAE,gBAAgB,GACnB,+BAA+B;IAiBlC,SAAgB,mBAAmB,EAAE,SAAS,uBAAuB,EAAE,CAAC;IAEjE,SAAS,CAAC,GAAG,EAAE,iBAAiB,GAAG,KAAK;IAgBxC,UAAU,CAAC,GAAG,CAAC,EAAE,UAAU,GAAG,mBAAmB;CAkBxD;AAED,qBAEa,4BAA6B,SAAQ,gBAAgB;CAAG;AAGrE,MAAM,WAAW,6BAA6B;IAC7C,SAAS,EAAE,uBAAuB,CAAC;IACnC,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,QAAQ,CAAC;CACnB;AAED,qBAgBa,sBAAuB,SAAQ,gBAAgB;gBAE1D,OAAO,EAAE,WAAW,CAAC,6BAA6B,CAAC;WAWtC,IAAI,CACjB,GAAG,EAAE,KAAK,EACV,GAAG,EAAE,gBAAgB,GACnB,sBAAsB;IAiBzB,SAAgB,SAAS,EAAE,uBAAuB,CAAC;IAEnD,SAAgB,YAAY,EAAE,MAAM,CAAC;IAErC,SAAgB,WAAW,EAAE,MAAM,CAAC;IAEpC,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IAE5B,UAAU,CAAC,GAAG,CAAC,EAAE,UAAU,GAAG,mBAAmB;CAcxD;AAGD,MAAM,WAAW,0BAA0B;IAC1C,SAAS,EAAE,uBAAuB,CAAC;CACnC;AASD,qBAEa,mBAAoB,SAAQ,gBAAgB;gBAEvD,OAAO,EAAE,WAAW,CAAC,0BAA0B,CAAC;WAMnC,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,gBAAgB,GAAG,mBAAmB;IAUnE,SAAS,EAAE,uBAAuB,CAAC;IAEnC,SAAS,CAAC,GAAG,EAAE,iBAAiB,GAAG,KAAK;IAKxC,UAAU,CAAC,GAAG,CAAC,EAAE,UAAU,GAAG,mBAAmB;CAWxD;AAGD,MAAM,WAAW,0BAA0B;IAC1C,YAAY,EAAE;QACb,SAAS,EAAE,uBAAuB,CAAC;QACnC,KAAK,EAAE,MAAM,CAAC;KACd,EAAE,CAAC;IACJ,QAAQ,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CAC7B;AAED,qBAEa,mBAAoB,SAAQ,gBAAgB;gBAEvD,OAAO,EAAE,WAAW,CAAC,0BAA0B,CAAC;WAOnC,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,gBAAgB,GAAG,mBAAmB;IA8BnE,YAAY,EAAE;QACpB,SAAS,EAAE,uBAAuB,CAAC;QACnC,KAAK,EAAE,MAAM,CAAC;KACd,EAAE,CAAC;IACG,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAC;IAE/B,SAAS,CAAC,GAAG,EAAE,iBAAiB,GAAG,KAAK;IAkBxC,UAAU,CAAC,GAAG,CAAC,EAAE,UAAU,GAAG,mBAAmB;CAcxD;AAGD,MAAM,WAAW,uCAAuC;IACvD,SAAS,EAAE,uBAAuB,CAAC;IACnC,SAAS,EAAE,MAAM,OAAO,oBAAoB,CAAC;IAC7C,QAAQ,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CAC7B;AAED,qBAEa,gCAAiC,SAAQ,gBAAgB;gBAEpE,OAAO,EAAE,WAAW,CAAC,uCAAuC,CAAC;WAQhD,IAAI,CACjB,GAAG,EAAE,KAAK,EACV,GAAG,EAAE,gBAAgB,GACnB,gCAAgC;IAoB5B,SAAS,EAAE,uBAAuB,CAAC;IACnC,SAAS,EAAE,MAAM,OAAO,oBAAoB,CAAC;IAC7C,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAC;IAE/B,SAAS,CAAC,GAAG,EAAE,iBAAiB,GAAG,KAAK;IASxC,UAAU,CAAC,GAAG,CAAC,EAAE,UAAU,GAAG,mBAAmB;CAgBxD;AAGD,MAAM,WAAW,sCAAsC;IACtD,SAAS,EAAE,uBAAuB,CAAC;CACnC;AAED,qBAEa,+BAAgC,SAAQ,gBAAgB;gBAEnE,OAAO,EAAE,WAAW,CAAC,sCAAsC,CAAC;WAM/C,IAAI,CACjB,GAAG,EAAE,KAAK,EACV,GAAG,EAAE,gBAAgB,GACnB,+BAA+B;IAU3B,SAAS,EAAE,uBAAuB,CAAC;IAEnC,SAAS,CAAC,GAAG,EAAE,iBAAiB,GAAG,KAAK;IAKxC,UAAU,CAAC,GAAG,CAAC,EAAE,UAAU,GAAG,mBAAmB;CAWxD"}