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

package/build/cjs/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