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

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

@@ -0,0 +1,318 @@
+import { type MaybeUnknown, type WithAddress } from "@zwave-js/core";
+import { CommandClasses, type ControlsCC, type EndpointId, type GetEndpoint, type MaybeNotKnown, type MessageOrCCLogEntry, type NodeId, type SinglecastCC, type SupervisionResult, type SupportsCC } from "@zwave-js/core/safe";
+import type { CCEncodingContext, CCParsingContext, GetDeviceConfig, GetNode, GetSupportedCCVersion, GetValueDB } from "@zwave-js/host/safe";
+import { Bytes } from "@zwave-js/shared/safe";
+import { type AllOrNone } from "@zwave-js/shared/safe";
+import { POLL_VALUE, PhysicalCCAPI, type PollValueImplementation, SET_VALUE, SET_VALUE_HOOKS, type SetValueImplementation, type SetValueImplementationHooksFactory } from "../lib/API.js";
+import { type CCRaw, CommandClass, type InterviewContext, type PersistValuesContext, type RefreshValuesContext } from "../lib/CommandClass.js";
+import { MeterCommand, type MeterReading, RateType } from "../lib/_Types.js";
+export declare const MeterCCValues: Readonly<{
+    value: ((meterType: number, rateType: RateType, scale: number) => {
+        readonly meta: {
+            readonly ccSpecific: {
+                readonly meterType: number;
+                readonly rateType: RateType;
+                readonly scale: number;
+            };
+            readonly writeable: false;
+            readonly type: "number";
+            readonly readable: true;
+        };
+        readonly id: {
+            commandClass: CommandClasses.Meter;
+            property: "value";
+            propertyKey: number;
+        };
+        readonly endpoint: (endpoint?: number | undefined) => {
+            readonly commandClass: CommandClasses.Meter;
+            readonly endpoint: number;
+            readonly property: "value";
+            readonly propertyKey: number;
+        };
+    }) & {
+        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;
+        };
+    };
+    resetSingle: ((meterType: number, rateType: RateType, scale: number) => {
+        readonly meta: {
+            readonly label: `Reset (${string})` | `Reset (Consumption, ${string})` | `Reset (Production, ${string})`;
+            readonly states: {
+                readonly true: "Reset";
+            };
+            readonly ccSpecific: {
+                readonly meterType: number;
+                readonly rateType: RateType;
+                readonly scale: number;
+            };
+            readonly readable: false;
+            readonly type: "boolean";
+            readonly writeable: true;
+        };
+        readonly id: {
+            commandClass: CommandClasses.Meter;
+            property: "reset";
+            propertyKey: number;
+        };
+        readonly endpoint: (endpoint?: number | undefined) => {
+            readonly commandClass: CommandClasses.Meter;
+            readonly endpoint: number;
+            readonly property: "reset";
+            readonly propertyKey: number;
+        };
+    }) & {
+        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;
+        };
+    };
+    resetAll: {
+        readonly id: {
+            commandClass: CommandClasses.Meter;
+            property: "reset";
+        };
+        readonly endpoint: (endpoint?: number | undefined) => {
+            readonly commandClass: CommandClasses.Meter;
+            readonly endpoint: number;
+            readonly property: "reset";
+        };
+        readonly is: (valueId: import("@zwave-js/core").ValueID) => boolean;
+        readonly meta: {
+            readonly label: "Reset accumulated values";
+            readonly states: {
+                readonly true: "Reset";
+            };
+            readonly readable: false;
+            readonly type: "boolean";
+            readonly writeable: true;
+        };
+        readonly options: {
+            readonly internal: false;
+            readonly minVersion: 1;
+            readonly secret: false;
+            readonly stateful: true;
+            readonly supportsEndpoints: true;
+            readonly autoCreate: true;
+        };
+    };
+    supportedRateTypes: {
+        readonly id: {
+            commandClass: CommandClasses.Meter;
+            property: "supportedRateTypes";
+        };
+        readonly endpoint: (endpoint?: number | undefined) => {
+            readonly commandClass: CommandClasses.Meter;
+            readonly endpoint: number;
+            readonly property: "supportedRateTypes";
+        };
+        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;
+        };
+    };
+    supportedScales: {
+        readonly id: {
+            commandClass: CommandClasses.Meter;
+            property: "supportedScales";
+        };
+        readonly endpoint: (endpoint?: number | undefined) => {
+            readonly commandClass: CommandClasses.Meter;
+            readonly endpoint: number;
+            readonly property: "supportedScales";
+        };
+        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;
+        };
+    };
+    supportsReset: {
+        readonly id: {
+            commandClass: CommandClasses.Meter;
+            property: "supportsReset";
+        };
+        readonly endpoint: (endpoint?: number | undefined) => {
+            readonly commandClass: CommandClasses.Meter;
+            readonly endpoint: number;
+            readonly property: "supportsReset";
+        };
+        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;
+        };
+    };
+    type: {
+        readonly id: {
+            commandClass: CommandClasses.Meter;
+            property: "type";
+        };
+        readonly endpoint: (endpoint?: number | undefined) => {
+            readonly commandClass: CommandClasses.Meter;
+            readonly endpoint: number;
+            readonly property: "type";
+        };
+        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 function isAccumulatedValue(meterType: number, scale: number): boolean;
+export declare class MeterCCAPI extends PhysicalCCAPI {
+    supportsCommand(cmd: MeterCommand): MaybeNotKnown<boolean>;
+    protected get [POLL_VALUE](): PollValueImplementation;
+    get(options?: MeterCCGetOptions): Promise<MeterReading | undefined>;
+    sendReport(options: MeterCCReportOptions): Promise<SupervisionResult | undefined>;
+    getAll(accumulatedOnly?: boolean): Promise<MeterReading[]>;
+    getSupported(): Promise<Pick<MeterCCSupportedReport, "type" | "supportsReset" | "supportedScales" | "supportedRateTypes"> | undefined>;
+    sendSupportedReport(options: MeterCCSupportedReportOptions): Promise<void>;
+    reset(options?: MeterCCResetOptions): Promise<SupervisionResult | undefined>;
+    protected get [SET_VALUE](): SetValueImplementation;
+    protected [SET_VALUE_HOOKS]: SetValueImplementationHooksFactory;
+}
+export declare class MeterCC extends CommandClass {
+    ccCommand: MeterCommand;
+    interview(ctx: InterviewContext): Promise<void>;
+    refreshValues(ctx: RefreshValuesContext): Promise<void>;
+    shouldRefreshValues(this: SinglecastCC<this>, ctx: GetValueDB & GetSupportedCCVersion & GetDeviceConfig & GetNode<NodeId & GetEndpoint<EndpointId & SupportsCC & ControlsCC>>): boolean;
+    /**
+     * Returns which type this meter has.
+     * This only works AFTER the interview process
+     */
+    static getMeterTypeCached(ctx: GetValueDB, endpoint: EndpointId): MaybeNotKnown<number>;
+    /**
+     * Returns which scales are supported by this meter.
+     * This only works AFTER the interview process
+     */
+    static getSupportedScalesCached(ctx: GetValueDB, endpoint: EndpointId): MaybeNotKnown<number[]>;
+    /**
+     * Returns whether reset is supported by this meter.
+     * This only works AFTER the interview process
+     */
+    static supportsResetCached(ctx: GetValueDB, endpoint: EndpointId): MaybeNotKnown<boolean>;
+    /**
+     * Returns which rate types are supported by this meter.
+     * This only works AFTER the interview process
+     */
+    static getSupportedRateTypesCached(ctx: GetValueDB, endpoint: EndpointId): MaybeNotKnown<RateType[]>;
+    translatePropertyKey(ctx: GetValueDB, property: string | number, propertyKey: string | number): string | undefined;
+}
+export interface MeterCCReportOptions {
+    type: number;
+    scale: number;
+    value: number;
+    previousValue?: MaybeNotKnown<number>;
+    rateType?: RateType;
+    deltaTime?: MaybeUnknown<number>;
+}
+export declare class MeterCCReport extends MeterCC {
+    constructor(options: WithAddress<MeterCCReportOptions>);
+    static from(raw: CCRaw, ctx: CCParsingContext): MeterCCReport;
+    persistValues(ctx: PersistValuesContext): boolean;
+    type: number;
+    scale: number;
+    value: number;
+    previousValue: MaybeNotKnown<number>;
+    rateType: RateType;
+    deltaTime: MaybeUnknown<number>;
+    serialize(ctx: CCEncodingContext): Bytes;
+    toLogEntry(ctx?: GetValueDB): MessageOrCCLogEntry;
+}
+export interface MeterCCGetOptions {
+    scale?: number;
+    rateType?: RateType;
+}
+export declare class MeterCCGet extends MeterCC {
+    constructor(options: WithAddress<MeterCCGetOptions>);
+    static from(raw: CCRaw, ctx: CCParsingContext): MeterCCGet;
+    rateType: RateType | undefined;
+    scale: number | undefined;
+    serialize(ctx: CCEncodingContext): Bytes;
+    toLogEntry(ctx?: GetValueDB): MessageOrCCLogEntry;
+}
+export interface MeterCCSupportedReportOptions {
+    type: number;
+    supportsReset: boolean;
+    supportedScales: readonly number[];
+    supportedRateTypes: readonly RateType[];
+}
+export declare class MeterCCSupportedReport extends MeterCC {
+    constructor(options: WithAddress<MeterCCSupportedReportOptions>);
+    static from(raw: CCRaw, ctx: CCParsingContext): MeterCCSupportedReport;
+    readonly type: number;
+    readonly supportsReset: boolean;
+    readonly supportedScales: readonly number[];
+    readonly supportedRateTypes: readonly RateType[];
+    persistValues(ctx: PersistValuesContext): boolean;
+    serialize(ctx: CCEncodingContext): Bytes;
+    toLogEntry(ctx?: GetValueDB): MessageOrCCLogEntry;
+}
+export declare class MeterCCSupportedGet extends MeterCC {
+}
+export type MeterCCResetOptions = AllOrNone<{
+    type: number;
+    scale: number;
+    rateType: RateType;
+    targetValue: number;
+}>;
+export declare class MeterCCReset extends MeterCC {
+    constructor(options: WithAddress<MeterCCResetOptions>);
+    static from(raw: CCRaw, ctx: CCParsingContext): MeterCCReset;
+    type: number | undefined;
+    scale: number | undefined;
+    rateType: RateType | undefined;
+    targetValue: number | undefined;
+    serialize(ctx: CCEncodingContext): Bytes;
+    toLogEntry(ctx?: GetValueDB): MessageOrCCLogEntry;
+}
+//# sourceMappingURL=MeterCC.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"MeterCC.d.ts","sourceRoot":"","sources":["../../../src/cc/MeterCC.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,KAAK,YAAY,EACjB,KAAK,WAAW,EAShB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACN,cAAc,EACd,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,aAAa,EAClB,KAAK,mBAAmB,EAGxB,KAAK,MAAM,EACX,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,UAAU,EAMf,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACX,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,OAAO,EACP,qBAAqB,EACrB,UAAU,EACV,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAC9C,OAAO,EACN,KAAK,SAAS,EAId,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAEN,UAAU,EACV,aAAa,EACb,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,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EAEzB,MAAM,wBAAwB,CAAC;AAahC,OAAO,EAAE,YAAY,EAAE,KAAK,YAAY,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE7E,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoExB,CAAC;AA0HH,wBAAgB,kBAAkB,CACjC,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,GACX,OAAO,CAmCT;AAED,qBACa,UAAW,SAAQ,aAAa;IACrC,eAAe,CAAC,GAAG,EAAE,YAAY,GAAG,aAAa,CAAC,OAAO,CAAC;IAoBjE,SAAS,KAAK,CAAC,UAAU,CAAC,IAAI,uBAAuB,CA4BpD;IAGY,GAAG,CACf,OAAO,CAAC,EAAE,iBAAiB,GACzB,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IA4BvB,UAAU,CACtB,OAAO,EAAE,oBAAoB,GAC3B,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAY5B,MAAM,CAClB,eAAe,GAAE,OAAe,GAC9B,OAAO,CAAC,YAAY,EAAE,CAAC;IA+Cb,YAAY;IAwBZ,mBAAmB,CAC/B,OAAO,EAAE,6BAA6B,GACpC,OAAO,CAAC,IAAI,CAAC;IAYH,KAAK,CACjB,OAAO,CAAC,EAAE,mBAAmB,GAC3B,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAWzC,cAAuB,CAAC,SAAS,CAAC,IAAI,sBAAsB,CAsC3D;IAED,SAAS,CAAC,CAAC,eAAe,CAAC,EAAE,kCAAkC,CAuF7D;CACF;AAED,qBAGa,OAAQ,SAAQ,YAAY;IAChC,SAAS,EAAE,YAAY,CAAC;IAEnB,SAAS,CACrB,GAAG,EAAE,gBAAgB,GACnB,OAAO,CAAC,IAAI,CAAC;IAoEH,aAAa,CACzB,GAAG,EAAE,oBAAoB,GACvB,OAAO,CAAC,IAAI,CAAC;IA0DT,mBAAmB,CACzB,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,EACxB,GAAG,EACA,UAAU,GACV,qBAAqB,GACrB,eAAe,GACf,OAAO,CACR,MAAM,GAAG,WAAW,CAAC,UAAU,GAAG,UAAU,GAAG,UAAU,CAAC,CAC1D,GACA,OAAO;IAmBV;;;OAGG;WACW,kBAAkB,CAC/B,GAAG,EAAE,UAAU,EACf,QAAQ,EAAE,UAAU,GAClB,aAAa,CAAC,MAAM,CAAC;IAMxB;;;OAGG;WACW,wBAAwB,CACrC,GAAG,EAAE,UAAU,EACf,QAAQ,EAAE,UAAU,GAClB,aAAa,CAAC,MAAM,EAAE,CAAC;IAM1B;;;OAGG;WACW,mBAAmB,CAChC,GAAG,EAAE,UAAU,EACf,QAAQ,EAAE,UAAU,GAClB,aAAa,CAAC,OAAO,CAAC;IAMzB;;;OAGG;WACW,2BAA2B,CACxC,GAAG,EAAE,UAAU,EACf,QAAQ,EAAE,UAAU,GAClB,aAAa,CAAC,QAAQ,EAAE,CAAC;IAQrB,oBAAoB,CAC1B,GAAG,EAAE,UAAU,EACf,QAAQ,EAAE,MAAM,GAAG,MAAM,EACzB,WAAW,EAAE,MAAM,GAAG,MAAM,GAC1B,MAAM,GAAG,SAAS;CAuBrB;AAGD,MAAM,WAAW,oBAAoB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IACtC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,SAAS,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;CACjC;AAED,qBACa,aAAc,SAAQ,OAAO;gBAExC,OAAO,EAAE,WAAW,CAAC,oBAAoB,CAAC;WAY7B,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,gBAAgB,GAAG,aAAa;IA+C7D,aAAa,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO;IAiFjD,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IACrC,QAAQ,EAAE,QAAQ,CAAC;IACnB,SAAS,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;IAEhC,SAAS,CAAC,GAAG,EAAE,iBAAiB,GAAG,KAAK;IA0CxC,UAAU,CAAC,GAAG,CAAC,EAAE,UAAU,GAAG,mBAAmB;CAqBxD;AAYD,MAAM,WAAW,iBAAiB;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACpB;AAED,qBAEa,UAAW,SAAQ,OAAO;gBAErC,OAAO,EAAE,WAAW,CAAC,iBAAiB,CAAC;WAO1B,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,gBAAgB,GAAG,UAAU;IAoB1D,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC/B,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAE1B,SAAS,CAAC,GAAG,EAAE,iBAAiB,GAAG,KAAK;IAmCxC,UAAU,CAAC,GAAG,CAAC,EAAE,UAAU,GAAG,mBAAmB;CAsBxD;AAGD,MAAM,WAAW,6BAA6B;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,OAAO,CAAC;IACvB,eAAe,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC,kBAAkB,EAAE,SAAS,QAAQ,EAAE,CAAC;CACxC;AAED,qBAKa,sBAAuB,SAAQ,OAAO;gBAEjD,OAAO,EAAE,WAAW,CAAC,6BAA6B,CAAC;WAUtC,IAAI,CACjB,GAAG,EAAE,KAAK,EACV,GAAG,EAAE,gBAAgB,GACnB,sBAAsB;IA2CzB,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B,SAAgB,aAAa,EAAE,OAAO,CAAC;IAEvC,SAAgB,eAAe,EAAE,SAAS,MAAM,EAAE,CAAC;IAEnD,SAAgB,kBAAkB,EAAE,SAAS,QAAQ,EAAE,CAAC;IAEjD,aAAa,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO;IAoCjD,SAAS,CAAC,GAAG,EAAE,iBAAiB,GAAG,KAAK;IAmCxC,UAAU,CAAC,GAAG,CAAC,EAAE,UAAU,GAAG,mBAAmB;CAqBxD;AAED,qBAEa,mBAAoB,SAAQ,OAAO;CAAG;AAGnD,MAAM,MAAM,mBAAmB,GAAG,SAAS,CAAC;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,QAAQ,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;CACpB,CAAC,CAAC;AAEH,qBAEa,YAAa,SAAQ,OAAO;gBAEvC,OAAO,EAAE,WAAW,CAAC,mBAAmB,CAAC;WAS5B,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,gBAAgB,GAAG,YAAY;IAyB5D,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC/B,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC,SAAS,CAAC,GAAG,EAAE,iBAAiB,GAAG,KAAK;IA0BxC,UAAU,CAAC,GAAG,CAAC,EAAE,UAAU,GAAG,mBAAmB;CAoBxD"}