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

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

@@ -0,0 +1,253 @@
+import type { EndpointId, MaybeNotKnown, SupervisionResult, WithAddress } from "@zwave-js/core/safe";
+import { CommandClasses, type MessageOrCCLogEntry } from "@zwave-js/core/safe";
+import type { CCEncodingContext, CCParsingContext, GetDeviceConfig, GetValueDB } from "@zwave-js/host/safe";
+import { Bytes } from "@zwave-js/shared/safe";
+import { PhysicalCCAPI } from "../lib/API.js";
+import { type CCRaw, CommandClass, type InterviewContext, type RefreshValuesContext } from "../lib/CommandClass.js";
+import { type AssociationAddress, AssociationCommand } from "../lib/_Types.js";
+export declare const AssociationCCValues: Readonly<{
+    nodeIds: ((groupId: number) => {
+        readonly meta: {
+            readonly type: "any";
+            readonly readable: true;
+            readonly writeable: true;
+        };
+        readonly id: {
+            commandClass: CommandClasses.Association;
+            property: "nodeIds";
+            propertyKey: number;
+        };
+        readonly endpoint: (endpoint?: number | undefined) => {
+            readonly commandClass: CommandClasses.Association;
+            readonly endpoint: number;
+            readonly property: "nodeIds";
+            readonly propertyKey: number;
+        };
+    }) & {
+        is: (valueId: import("@zwave-js/core/safe").ValueID) => boolean;
+        readonly options: {
+            readonly stateful: true;
+            readonly secret: false;
+            readonly minVersion: 1;
+            readonly supportsEndpoints: true;
+            readonly autoCreate: true;
+            readonly internal: true;
+        };
+    };
+    maxNodes: ((groupId: number) => {
+        readonly meta: {
+            readonly type: "any";
+            readonly readable: true;
+            readonly writeable: true;
+        };
+        readonly id: {
+            commandClass: CommandClasses.Association;
+            property: "maxNodes";
+            propertyKey: number;
+        };
+        readonly endpoint: (endpoint?: number | undefined) => {
+            readonly commandClass: CommandClasses.Association;
+            readonly endpoint: number;
+            readonly property: "maxNodes";
+            readonly propertyKey: number;
+        };
+    }) & {
+        is: (valueId: import("@zwave-js/core/safe").ValueID) => boolean;
+        readonly options: {
+            readonly stateful: true;
+            readonly secret: false;
+            readonly minVersion: 1;
+            readonly supportsEndpoints: true;
+            readonly autoCreate: true;
+            readonly internal: true;
+        };
+    };
+    groupCount: {
+        readonly id: {
+            commandClass: CommandClasses.Association;
+            property: "groupCount";
+        };
+        readonly endpoint: (endpoint?: number | undefined) => {
+            readonly commandClass: CommandClasses.Association;
+            readonly endpoint: number;
+            readonly property: "groupCount";
+        };
+        readonly is: (valueId: import("@zwave-js/core/safe").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;
+        };
+    };
+    hasLifeline: {
+        readonly id: {
+            commandClass: CommandClasses.Association;
+            property: "hasLifeline";
+        };
+        readonly endpoint: (endpoint?: number | undefined) => {
+            readonly commandClass: CommandClasses.Association;
+            readonly endpoint: number;
+            readonly property: "hasLifeline";
+        };
+        readonly is: (valueId: import("@zwave-js/core/safe").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 AssociationCCAPI extends PhysicalCCAPI {
+    supportsCommand(cmd: AssociationCommand): MaybeNotKnown<boolean>;
+    /**
+     * Returns the number of association groups a node supports.
+     * Association groups are consecutive, starting at 1.
+     */
+    getGroupCount(): Promise<MaybeNotKnown<number>>;
+    reportGroupCount(groupCount: number): Promise<void>;
+    /**
+     * Returns information about an association group.
+     */
+    getGroup(groupId: number): Promise<{
+        maxNodes: number;
+        nodeIds: number[];
+    } | undefined>;
+    sendReport(options: AssociationCCReportOptions): Promise<void>;
+    /**
+     * Adds new nodes to an association group
+     */
+    addNodeIds(groupId: number, ...nodeIds: number[]): Promise<SupervisionResult | undefined>;
+    /**
+     * Removes nodes from an association group
+     */
+    removeNodeIds(options: AssociationCCRemoveOptions): Promise<SupervisionResult | undefined>;
+    /**
+     * Removes nodes from all association groups
+     */
+    removeNodeIdsFromAllGroups(nodeIds: number[]): Promise<SupervisionResult | undefined>;
+    /**
+     * Request the association group that represents the most recently detected button press
+     */
+    getSpecificGroup(): Promise<number | undefined>;
+    /**
+     * Report the association group that represents the most recently detected button press
+     */
+    reportSpecificGroup(group: number): Promise<void>;
+}
+export declare class AssociationCC extends CommandClass {
+    ccCommand: AssociationCommand;
+    determineRequiredCCInterviews(): readonly CommandClasses[];
+    /**
+     * Returns the number of association groups reported by the node/endpoint.
+     * This only works AFTER the interview process
+     */
+    static getGroupCountCached(ctx: GetValueDB, endpoint: EndpointId): number;
+    /**
+     * Returns the number of nodes an association group supports.
+     * This only works AFTER the interview process
+     */
+    static getMaxNodesCached(ctx: GetValueDB & GetDeviceConfig, endpoint: EndpointId, groupId: number): number;
+    /**
+     * Returns all the destinations of all association groups reported by the node/endpoint.
+     * This only works AFTER the interview process
+     */
+    static getAllDestinationsCached(ctx: GetValueDB, endpoint: EndpointId): ReadonlyMap<number, readonly AssociationAddress[]>;
+    interview(ctx: InterviewContext): Promise<void>;
+    refreshValues(ctx: RefreshValuesContext): Promise<void>;
+}
+export interface AssociationCCSetOptions {
+    groupId: number;
+    nodeIds: number[];
+}
+export declare class AssociationCCSet extends AssociationCC {
+    constructor(options: WithAddress<AssociationCCSetOptions>);
+    static from(raw: CCRaw, ctx: CCParsingContext): AssociationCCSet;
+    groupId: number;
+    nodeIds: number[];
+    serialize(ctx: CCEncodingContext): Bytes;
+    toLogEntry(ctx?: GetValueDB): MessageOrCCLogEntry;
+}
+export interface AssociationCCRemoveOptions {
+    /** The group from which to remove the nodes. If none is specified, the nodes will be removed from all nodes. */
+    groupId?: number;
+    /** The nodes to remove. If none are specified, ALL nodes will be removed. */
+    nodeIds?: number[];
+}
+export declare class AssociationCCRemove extends AssociationCC {
+    constructor(options: WithAddress<AssociationCCRemoveOptions>);
+    static from(raw: CCRaw, ctx: CCParsingContext): AssociationCCRemove;
+    groupId?: number;
+    nodeIds?: number[];
+    serialize(ctx: CCEncodingContext): Bytes;
+    toLogEntry(ctx?: GetValueDB): MessageOrCCLogEntry;
+}
+export interface AssociationCCReportOptions {
+    groupId: number;
+    maxNodes: number;
+    nodeIds: number[];
+    reportsToFollow: number;
+}
+export declare class AssociationCCReport extends AssociationCC {
+    constructor(options: WithAddress<AssociationCCReportOptions>);
+    static from(raw: CCRaw, ctx: CCParsingContext): AssociationCCReport;
+    groupId: number;
+    maxNodes: number;
+    nodeIds: number[];
+    reportsToFollow: number;
+    getPartialCCSessionId(): Record<string, any> | undefined;
+    expectMoreMessages(): boolean;
+    mergePartialCCs(partials: AssociationCCReport[], _ctx: CCParsingContext): void;
+    serialize(ctx: CCEncodingContext): Bytes;
+    toLogEntry(ctx?: GetValueDB): MessageOrCCLogEntry;
+}
+export interface AssociationCCGetOptions {
+    groupId: number;
+}
+export declare class AssociationCCGet extends AssociationCC {
+    constructor(options: WithAddress<AssociationCCGetOptions>);
+    static from(raw: CCRaw, ctx: CCParsingContext): AssociationCCGet;
+    groupId: number;
+    serialize(ctx: CCEncodingContext): Bytes;
+    toLogEntry(ctx?: GetValueDB): MessageOrCCLogEntry;
+}
+export interface AssociationCCSupportedGroupingsReportOptions {
+    groupCount: number;
+}
+export declare class AssociationCCSupportedGroupingsReport extends AssociationCC {
+    constructor(options: WithAddress<AssociationCCSupportedGroupingsReportOptions>);
+    static from(raw: CCRaw, ctx: CCParsingContext): AssociationCCSupportedGroupingsReport;
+    groupCount: number;
+    serialize(ctx: CCEncodingContext): Bytes;
+    toLogEntry(ctx?: GetValueDB): MessageOrCCLogEntry;
+}
+export declare class AssociationCCSupportedGroupingsGet extends AssociationCC {
+}
+export interface AssociationCCSpecificGroupReportOptions {
+    group: number;
+}
+export declare class AssociationCCSpecificGroupReport extends AssociationCC {
+    constructor(options: WithAddress<AssociationCCSpecificGroupReportOptions>);
+    static from(raw: CCRaw, ctx: CCParsingContext): AssociationCCSpecificGroupReport;
+    group: number;
+    serialize(ctx: CCEncodingContext): Bytes;
+    toLogEntry(ctx?: GetValueDB): MessageOrCCLogEntry;
+}
+export declare class AssociationCCSpecificGroupGet extends AssociationCC {
+}
+//# sourceMappingURL=AssociationCC.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AssociationCC.d.ts","sourceRoot":"","sources":["../../../src/cc/AssociationCC.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,UAAU,EACV,aAAa,EAEb,iBAAiB,EACjB,WAAW,EACX,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACN,cAAc,EAEd,KAAK,mBAAmB,EAKxB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACX,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,UAAU,EACV,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAG9C,OAAO,EAAS,aAAa,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EACN,KAAK,KAAK,EACV,YAAY,EACZ,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,MAAM,wBAAwB,CAAC;AAYhC,OAAO,EAAE,KAAK,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAG/E,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA8B9B,CAAC;AAIH,qBACa,gBAAiB,SAAQ,aAAa;IAC3C,eAAe,CAAC,GAAG,EAAE,kBAAkB,GAAG,aAAa,CAAC,OAAO,CAAC;IAgBvE;;;OAGG;IACU,aAAa,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAoB/C,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAchE;;OAEG;IAGU,QAAQ,CAAC,OAAO,EAAE,MAAM;;;;IAqBxB,UAAU,CACtB,OAAO,EAAE,0BAA0B,GACjC,OAAO,CAAC,IAAI,CAAC;IAchB;;OAEG;IAEU,UAAU,CACtB,OAAO,EAAE,MAAM,EACf,GAAG,OAAO,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAYzC;;OAEG;IAEU,aAAa,CACzB,OAAO,EAAE,0BAA0B,GACjC,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IA6BzC;;OAEG;IAEU,0BAA0B,CACtC,OAAO,EAAE,MAAM,EAAE,GACf,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAuBzC;;OAEG;IAEU,gBAAgB,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAmB5D;;OAEG;IAEU,mBAAmB,CAC/B,KAAK,EAAE,MAAM,GACX,OAAO,CAAC,IAAI,CAAC;CAahB;AAED,qBAGa,aAAc,SAAQ,YAAY;IACtC,SAAS,EAAE,kBAAkB,CAAC;IAE/B,6BAA6B,IAAI,SAAS,cAAc,EAAE;IAUjE;;;OAGG;WACW,mBAAmB,CAChC,GAAG,EAAE,UAAU,EACf,QAAQ,EAAE,UAAU,GAClB,MAAM;IAQT;;;OAGG;WACW,iBAAiB,CAC9B,GAAG,EAAE,UAAU,GAAG,eAAe,EACjC,QAAQ,EAAE,UAAU,EACpB,OAAO,EAAE,MAAM,GACb,MAAM;IAmBT;;;OAGG;WACW,wBAAwB,CACrC,GAAG,EAAE,UAAU,EACf,QAAQ,EAAE,UAAU,GAClB,WAAW,CAAC,MAAM,EAAE,SAAS,kBAAkB,EAAE,CAAC;IAmBxC,SAAS,CACrB,GAAG,EAAE,gBAAgB,GACnB,OAAO,CAAC,IAAI,CAAC;IAkEH,aAAa,CACzB,GAAG,EAAE,oBAAoB,GACvB,OAAO,CAAC,IAAI,CAAC;CAqChB;AAGD,MAAM,WAAW,uBAAuB;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,qBAEa,gBAAiB,SAAQ,aAAa;gBAEjD,OAAO,EAAE,WAAW,CAAC,uBAAuB,CAAC;WAmBhC,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,gBAAgB,GAAG,gBAAgB;IAYhE,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB,SAAS,CAAC,GAAG,EAAE,iBAAiB,GAAG,KAAK;IAKxC,UAAU,CAAC,GAAG,CAAC,EAAE,UAAU,GAAG,mBAAmB;CAYxD;AAGD,MAAM,WAAW,0BAA0B;IAC1C,gHAAgH;IAChH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6EAA6E;IAC7E,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,qBAEa,mBAAoB,SAAQ,aAAa;gBAEpD,OAAO,EAAE,WAAW,CAAC,0BAA0B,CAAC;WASnC,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,gBAAgB,GAAG,mBAAmB;IAgBnE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB,SAAS,CAAC,GAAG,EAAE,iBAAiB,GAAG,KAAK;IAQxC,UAAU,CAAC,GAAG,CAAC,EAAE,UAAU,GAAG,mBAAmB;CAYxD;AAGD,MAAM,WAAW,0BAA0B;IAC1C,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;CACxB;AAED,qBAWa,mBAAoB,SAAQ,aAAa;gBAEpD,OAAO,EAAE,WAAW,CAAC,0BAA0B,CAAC;WAUnC,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,gBAAgB,GAAG,mBAAmB;IAgBnE,OAAO,EAAE,MAAM,CAAC;IAEhB,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB,eAAe,EAAE,MAAM,CAAC;IAExB,qBAAqB,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS;IAKxD,kBAAkB,IAAI,OAAO;IAI7B,eAAe,CACrB,QAAQ,EAAE,mBAAmB,EAAE,EAC/B,IAAI,EAAE,gBAAgB,GACpB,IAAI;IAOA,SAAS,CAAC,GAAG,EAAE,iBAAiB,GAAG,KAAK;IAUxC,UAAU,CAAC,GAAG,CAAC,EAAE,UAAU,GAAG,mBAAmB;CAWxD;AAGD,MAAM,WAAW,uBAAuB;IACvC,OAAO,EAAE,MAAM,CAAC;CAChB;AAED,qBAEa,gBAAiB,SAAQ,aAAa;gBAEjD,OAAO,EAAE,WAAW,CAAC,uBAAuB,CAAC;WAYhC,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,gBAAgB,GAAG,gBAAgB;IAUhE,OAAO,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,GAAG,EAAE,iBAAiB,GAAG,KAAK;IAKxC,UAAU,CAAC,GAAG,CAAC,EAAE,UAAU,GAAG,mBAAmB;CAMxD;AAGD,MAAM,WAAW,4CAA4C;IAC5D,UAAU,EAAE,MAAM,CAAC;CACnB;AAED,qBAEa,qCAAsC,SAAQ,aAAa;gBAEtE,OAAO,EAAE,WAAW,CAAC,4CAA4C,CAAC;WAOrD,IAAI,CACjB,GAAG,EAAE,KAAK,EACV,GAAG,EAAE,gBAAgB,GACnB,qCAAqC;IAUjC,UAAU,EAAE,MAAM,CAAC;IAEnB,SAAS,CAAC,GAAG,EAAE,iBAAiB,GAAG,KAAK;IAKxC,UAAU,CAAC,GAAG,CAAC,EAAE,UAAU,GAAG,mBAAmB;CAMxD;AAED,qBAEa,kCAAmC,SAAQ,aAAa;CAAG;AAGxE,MAAM,WAAW,uCAAuC;IACvD,KAAK,EAAE,MAAM,CAAC;CACd;AAED,qBACa,gCAAiC,SAAQ,aAAa;gBAEjE,OAAO,EAAE,WAAW,CAAC,uCAAuC,CAAC;WAOhD,IAAI,CACjB,GAAG,EAAE,KAAK,EACV,GAAG,EAAE,gBAAgB,GACnB,gCAAgC;IAU5B,KAAK,EAAE,MAAM,CAAC;IAEd,SAAS,CAAC,GAAG,EAAE,iBAAiB,GAAG,KAAK;IAKxC,UAAU,CAAC,GAAG,CAAC,EAAE,UAAU,GAAG,mBAAmB;CAMxD;AAED,qBAEa,6BAA8B,SAAQ,aAAa;CAAG"}