@project-chip/matter.js 0.2.1 → 0.3.0

package/dist/es/cluster/ActionsCluster.js

@@ -0,0 +1,222 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Attribute, Cluster, Event, OptionalAttribute, OptionalCommand, TlvNoResponse } from "./Cluster.js";
+import { BitFlag } from "../schema/BitmapSchema.js";
+import { TlvEndpointNumber } from "../datatype/EndpointNumber.js";
+import { TlvBitmap, TlvEnum, TlvUInt16, TlvUInt32 } from "../tlv/TlvNumber.js";
+import { TlvField, TlvObject, TlvOptionalField } from "../tlv/TlvObject.js";
+import { TlvString, TlvString32max } from "../tlv/TlvString.js";
+import { TlvArray } from "../tlv/TlvArray.js";
+/**
+ * Supported Commands bitmap which SHALL be used to indicate which of the cluster’s commands are
+ * supported for this particular action, with a bit set to 1 for each supported command.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.14.7
+ */
+const CommandBits = TlvBitmap(TlvUInt16, {
+    /** This command triggers an action (state change) on the involved endpoints. */
+    instantAction: BitFlag(0),
+    /** This command triggers an action (state change) on the involved endpoints, with a specified time to transition from the current state to the new state. */
+    instantActionWithTransition: BitFlag(1),
+    /** This command triggers the commencement of an action on the involved endpoints. */
+    startAction: BitFlag(2),
+    /** This command triggers the commencement of an action (with a duration) on the involved endpoints. */
+    startActionWithDuration: BitFlag(3),
+    /** This command stops the ongoing action on the involved endpoints. */
+    stopAction: BitFlag(4),
+    /** This command pauses an ongoing action. */
+    pauseAction: BitFlag(5),
+    /** This command pauses an ongoing action with a duration. */
+    pauseActionWithDuration: BitFlag(6),
+    /** This command resumes a previously paused action. */
+    resumeAction: BitFlag(7),
+    /** This command enables a certain action or automation. */
+    enableAction: BitFlag(8),
+    /** This command enables a certain action or automation with a duration. */
+    enableActionWithDuration: BitFlag(9),
+    /** This command disables a certain action or automation. */
+    disableAction: BitFlag(10),
+    /** This command disables a certain action or automation with a duration. */
+    disableActionWithDuration: BitFlag(11),
+});
+/**
+ * Holds the details of a single action.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.14.9.1
+ */
+const TlvAction = TlvObject({
+    /** Indicates the device type definition */
+    actionID: TlvField(0, TlvUInt16),
+    /** Indicates the implemented revision of the device type definition */
+    name: TlvField(1, TlvString.bound({ maxLength: 32 })),
+    /** Indicates the type of endpoint list */
+    type: TlvField(2, TlvEnum()),
+    /** Provide a reference to the associated endpoint list, which specifies the endpoints on this Node which will be impacted by this ActionID */
+    endpointListId: TlvField(3, TlvUInt16),
+    /** A bitmap used to indicate which of the cluster’s commands are supported for this particular action */
+    supportedCommands: TlvField(4, CommandBits),
+    /** Indicates the current state of this action */
+    state: TlvField(5, TlvEnum()),
+});
+/**
+ * Provides information about endpoint conformance to a release of a device type definition.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.14.9.5
+ */
+const TlvEndpointList = TlvObject({
+    /** Indicates the device type definition */
+    endpointListId: TlvField(0, TlvUInt16),
+    /** Indicates the implemented revision of the device type definition */
+    name: TlvField(1, TlvString32max),
+    /** Indicates the type of endpoint list. */
+    type: TlvField(2, TlvEnum()),
+    /** A list of endpoint numbers */
+    endpoints: TlvField(3, TlvArray(TlvEndpointNumber, { maxLength: 256 })),
+});
+/** @see {@link MatterCoreClusterSpecificationV1_0} § 9.14.7.1 */
+const TlvInstantActionRequest = TlvObject({
+    actionId: TlvField(0, TlvUInt16),
+    invokeId: TlvOptionalField(1, TlvUInt32),
+});
+/** @see {@link MatterCoreClusterSpecificationV1_0} § 9.14.7.2 */
+const TlvInstantActionWithTransitionRequest = TlvObject({
+    actionId: TlvField(0, TlvUInt16),
+    invokeId: TlvOptionalField(1, TlvUInt32),
+    transitionTime: TlvField(2, TlvUInt16),
+});
+/** @see {@link MatterCoreClusterSpecificationV1_0} §9.14.7.3 */
+const TlvStartActionRequest = TlvObject({
+    actionId: TlvField(0, TlvUInt16),
+    invokeId: TlvOptionalField(1, TlvUInt32),
+});
+/** @see {@link MatterCoreClusterSpecificationV1_0} § 9.14.7.4 */
+const TlvStartActionWithDurationRequest = TlvObject({
+    actionId: TlvField(0, TlvUInt16),
+    invokeId: TlvOptionalField(1, TlvUInt32),
+    duration: TlvField(2, TlvUInt32),
+});
+/** @see {@link MatterCoreClusterSpecificationV1_0} § 9.14.7.5 */
+const TlvStopActionRequest = TlvObject({
+    actionId: TlvField(0, TlvUInt16),
+    invokeId: TlvOptionalField(1, TlvUInt32),
+});
+/** @see {@link MatterCoreClusterSpecificationV1_0} § 9.14.7.6 */
+const TlvPauseActionRequest = TlvObject({
+    actionId: TlvField(0, TlvUInt16),
+    invokeId: TlvOptionalField(1, TlvUInt32),
+});
+/** @see {@link MatterCoreClusterSpecificationV1_0} § 9.14.7.7 */
+const TlvPauseActionWithDurationRequest = TlvObject({
+    actionId: TlvField(0, TlvUInt16),
+    invokeId: TlvOptionalField(1, TlvUInt32),
+    duration: TlvField(2, TlvUInt32),
+});
+/** @see {@link MatterCoreClusterSpecificationV1_0} § 9.14.7.8 */
+const TlvResumeActionRequest = TlvObject({
+    actionId: TlvField(0, TlvUInt16),
+    invokeId: TlvOptionalField(1, TlvUInt32),
+});
+/** @see {@link MatterCoreClusterSpecificationV1_0} § 9.14.7.9 */
+const TlvEnableActionRequest = TlvObject({
+    actionId: TlvField(0, TlvUInt16),
+    invokeId: TlvOptionalField(1, TlvUInt32),
+});
+/** @see {@link MatterCoreClusterSpecificationV1_0} § 9.14.7.10 */
+const TlvEnableActionWithDurationRequest = TlvObject({
+    actionId: TlvField(0, TlvUInt16),
+    invokeId: TlvOptionalField(1, TlvUInt32),
+    duration: TlvField(2, TlvUInt32),
+});
+/** @see {@link MatterCoreClusterSpecificationV1_0} § 9.14.7.11 */
+const TlvDisableActionRequest = TlvObject({
+    actionId: TlvField(0, TlvUInt16),
+    invokeId: TlvOptionalField(1, TlvUInt32),
+});
+/** @see {@link MatterCoreClusterSpecificationV1_0} § 9.14.7.12 */
+const TlvDisableActionWithDurationRequest = TlvObject({
+    actionId: TlvField(0, TlvUInt16),
+    invokeId: TlvOptionalField(1, TlvUInt32),
+    duration: TlvField(2, TlvUInt32),
+});
+/**
+ * Provides feedback to the client about the progress of the action.
+ * @see {@link MatterCoreSpecificationV1_0} § 9.14.8.1
+ */
+const StateChangedEvent = {
+    actionId: TlvField(0, TlvUInt16),
+    invokeId: TlvField(1, TlvUInt32),
+    newState: TlvField(2, TlvEnum()),
+};
+/**
+ * Provides feedback to the client about the non-successful progress of the action.
+ * @see {@link MatterCoreSpecificationV1_0} § 9.14.8.2
+ */
+const ActionFailedEvent = {
+    actionId: TlvField(0, TlvUInt16),
+    invokeId: TlvField(1, TlvUInt32),
+    newState: TlvField(2, TlvEnum()),
+    error: TlvField(3, TlvEnum()),
+};
+/**
+ * This cluster provides a standardized way for a Node (typically a Bridge, but could be any Node) to expose
+ *  * information about logical grouping of endpoints on the Node (example: lights in a room)
+ *  * information about named actions that can be performed on such a group of endpoints (example: recall a
+ *    scene for a group of lights by its name)
+ *  * commands to trigger such actions
+ *  * events to receive feedback on the state of such actions.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.14
+ */
+export const ActionsCluster = Cluster({
+    id: 0x25,
+    name: "Actions",
+    revision: 1,
+    /** @see {@link MatterCoreSpecificationV1_0} § 9.14.6 */
+    attributes: {
+        /** List of actions. */
+        actionList: Attribute(0, TlvArray(TlvAction, { maxLength: 256 }), { default: [] }),
+        /** List of endpoint lists. */
+        endpointLists: Attribute(1, TlvArray(TlvEndpointList, { maxLength: 256 }), { default: [] }),
+        /**
+         * When used without suffix, provides information about the various actions which
+         * the cluster provides.
+         * When used with a suffix of "/?a=" and the decimal value of ActionID for one of
+         * the actions, it may provide information about that particular action. */
+        setupURL: OptionalAttribute(2, TlvString.bound({ maxLength: 512 }), { default: "" }),
+    },
+    commands: {
+        /** This command triggers an action (state change) on the involved endpoints. */
+        instantAction: OptionalCommand(0, TlvInstantActionRequest, 0, TlvNoResponse),
+        /** This command triggers an action (state change) on the involved endpoints, with a specified time to transition from the current state to the new state. */
+        instantActionWithTransition: OptionalCommand(1, TlvInstantActionWithTransitionRequest, 1, TlvNoResponse),
+        /** This command triggers the commencement of an action on the involved endpoints. */
+        startAction: OptionalCommand(2, TlvStartActionRequest, 2, TlvNoResponse),
+        /** This command triggers the commencement of an action (with a duration) on the involved endpoints. */
+        startActionWithDuration: OptionalCommand(3, TlvStartActionWithDurationRequest, 3, TlvNoResponse),
+        /** This command stops the ongoing action on the involved endpoints. */
+        stopAction: OptionalCommand(4, TlvStopActionRequest, 4, TlvNoResponse),
+        /** This command pauses an ongoing action. */
+        pauseAction: OptionalCommand(5, TlvPauseActionRequest, 5, TlvNoResponse),
+        /** This command pauses an ongoing action with a duration. */
+        pauseActionWithDuration: OptionalCommand(6, TlvPauseActionWithDurationRequest, 6, TlvNoResponse),
+        /** This command resumes a previously paused action. */
+        resumeAction: OptionalCommand(7, TlvResumeActionRequest, 7, TlvNoResponse),
+        /** This command enables a certain action or automation. */
+        enableAction: OptionalCommand(8, TlvEnableActionRequest, 8, TlvNoResponse),
+        /** This command enables a certain action or automation with a duration. */
+        enableActionWithDuration: OptionalCommand(9, TlvEnableActionWithDurationRequest, 9, TlvNoResponse),
+        /** This command disables a certain action or automation. */
+        disableAction: OptionalCommand(0x0A, TlvDisableActionRequest, 0x0A, TlvNoResponse),
+        /** This command disables a certain action or automation with a duration. */
+        disableActionWithDuration: OptionalCommand(0x0B, TlvDisableActionWithDurationRequest, 0x0B, TlvNoResponse),
+    },
+    events: {
+        /** This event shall be generated when there is a change in the Status of an ActionID. */
+        stateChanged: Event(0, 1 /* EventPriority.Info */, StateChangedEvent),
+        /** This event shall be generated when there is some error which prevents the action from its normal planned execution. */
+        actionFailed: Event(1, 1 /* EventPriority.Info */, ActionFailedEvent),
+    },
+});

package/dist/es/cluster/AdminCommissioningCluster.d.ts

@@ -0,0 +1,63 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { BitFlag } from "../schema/BitmapSchema.js";
+import { Cluster, Command, Attribute, OptionalCommand } from "./Cluster.js";
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 11.18.9 */
+export declare const enum AdminCommissioningStatusCode {
+    /** Could not be completed because another commissioning is in progress. */
+    Busy = 2,
+    /** Provided PAKE parameters were incorrectly formatted or otherwise invalid. */
+    PAKEParameterError = 3,
+    /** No commissioning window was currently open */
+    WindowNotOpen = 4
+}
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 11.18.6.1 */
+export declare const enum CommissioningWindowStatus {
+    /** Commissioning window not open */
+    WindowNotOpen = 0,
+    /** An Enhanced Commissioning Method window is open */
+    EnhancedWindowOpen = 1,
+    /** A Basic Commissioning Method window is open */
+    BasicWindowOpen = 2
+}
+/**
+ * This cluster is used to trigger a Node to allow a new Administrator to commission it.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 11.18
+ */
+export declare const AdminCommissioningCluster: Cluster<{
+    /** Node supports Basic Commissioning Method. */
+    basic: BitFlag;
+}, {
+    windowStatus: Attribute<CommissioningWindowStatus>;
+    adminFabricIndex: Attribute<import("../datatype/FabricIndex.js").FabricIndex | null>;
+    adminVendorId: Attribute<import("../datatype/VendorId.js").VendorId | null>;
+    clusterRevision: Attribute<number>;
+    featureMap: Attribute<import("../schema/BitmapSchema.js").TypeFromBitSchema<{
+        /** Node supports Basic Commissioning Method. */
+        basic: BitFlag;
+    }>>;
+    attributeList: Attribute<import("../datatype/AttributeId.js").AttributeId[]>;
+    eventList: Attribute<import("../datatype/EventId.js").EventId[]>;
+    acceptedCommandList: Attribute<import("../datatype/CommandId.js").CommandId[]>;
+    generatedCommandList: Attribute<import("../datatype/CommandId.js").CommandId[]>;
+}, {
+    /** Used to instruct a Node to go into commissioning mode using enhanced commissioning method. */
+    openCommissioningWindow: Command<{
+        iterations: number;
+        salt: Uint8Array;
+        commissioningTimeout: number;
+        pakePasscodeVerifier: Uint8Array;
+        discriminator: number;
+    }, void>;
+    /** Used to instruct a Node to go into commissioning mode using basic commissioning method, if the node supports it. */
+    openBasicCommissioningWindow: OptionalCommand<{
+        commissioningTimeout: number;
+    }, void>;
+    /** Used to instruct a Node to revoke any active Open Commissioning Window or Open Basic Commissioning Window command. */
+    revokeCommissioning: Command<void, void>;
+}, import("./Cluster.js").Events>;
+//# sourceMappingURL=AdminCommissioningCluster.d.ts.map

package/dist/es/cluster/AdminCommissioningCluster.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AdminCommissioningCluster.d.ts","sourceRoot":"","sources":["../../../src/cluster/AdminCommissioningCluster.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAGpD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAiB,SAAS,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAU3F,uEAAuE;AACvE,0BAAkB,4BAA4B;IAC1C,2EAA2E;IAC3E,IAAI,IAAI;IAER,gFAAgF;IAChF,kBAAkB,IAAI;IAEtB,iDAAiD;IACjD,aAAa,IAAI;CACpB;AAED,yEAAyE;AACzE,0BAAkB,yBAAyB;IACvC,oCAAoC;IACpC,aAAa,IAAI;IAEjB,sDAAsD;IACtD,kBAAkB,IAAI;IAEtB,kDAAkD;IAClD,eAAe,IAAI;CACtB;AA0BD;;;;GAIG;AACH,eAAO,MAAM,yBAAyB;IAK9B,gDAAgD;;;;;;;;QAAhD,gDAAgD;;;;;;;;IAkBhD,iGAAiG;;;;;;;;IAGjG,uHAAuH;;;;IAGvH,yHAAyH;;iCAG/H,CAAC"}

package/dist/es/cluster/AdminCommissioningCluster.js

@@ -0,0 +1,66 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { BitFlag } from "../schema/BitmapSchema.js";
+import { TlvFabricIndex } from "../datatype/FabricIndex.js";
+import { TlvVendorId } from "../datatype/VendorId.js";
+import { Cluster, Command, TlvNoResponse, Attribute, OptionalCommand } from "./Cluster.js";
+import { CRYPTO_GROUP_SIZE_BYTES, CRYPTO_PUBLIC_KEY_SIZE_BYTES } from "../crypto/CryptoConstants.js";
+import { TlvField, TlvObject } from "../tlv/TlvObject.js";
+import { TlvEnum, TlvUInt16, TlvUInt32 } from "../tlv/TlvNumber.js";
+import { TlvByteString } from "../tlv/TlvString.js";
+import { TlvNullable } from "../tlv/TlvNullable.js";
+import { TlvNoArguments } from "../tlv/TlvNoArguments.js";
+const PAKE_PASSCODE_VERIFIER_LENGTH = CRYPTO_GROUP_SIZE_BYTES + CRYPTO_PUBLIC_KEY_SIZE_BYTES;
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 11.18.8.1 */
+const TlvOpenCommissioningWindowRequest = TlvObject({
+    /** Time in seconds during which commissioning session establishment is allowed by the Node. */
+    commissioningTimeout: TlvField(0, TlvUInt16),
+    /** Ephemeral PAKE passcode verifier computed by the existing Administrator to be used for this commissioning. */
+    pakePasscodeVerifier: TlvField(1, TlvByteString.bound({ length: PAKE_PASSCODE_VERIFIER_LENGTH })),
+    /** Long discriminator for DNS-SD advertisement for discovery by the new Administrator. */
+    discriminator: TlvField(2, TlvUInt16.bound({ max: 4095 })),
+    /** PAKE iteration count associated with the ephemeral PAKE passcode verifier to be used for this commissioning. */
+    iterations: TlvField(3, TlvUInt32.bound({ min: 1000, max: 100000 })),
+    /** PAKE Salt associated with the ephemeral PAKE passcode verifier to be used for this commissioning. */
+    salt: TlvField(4, TlvByteString.bound({ minLength: 16, maxLength: 32 })),
+});
+/** @see {@link MatterApplicationClusterSpecificationV1_0} § 11.18.8.2 */
+const TlvOpenBasicCommissioningWindowRequest = TlvObject({
+    /** Time in seconds during which commissioning session establishment is allowed by the Node. */
+    commissioningTimeout: TlvField(0, TlvUInt16),
+});
+/**
+ * This cluster is used to trigger a Node to allow a new Administrator to commission it.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 11.18
+ */
+export const AdminCommissioningCluster = Cluster({
+    id: 0x3c,
+    name: "AdministratorCommissioning",
+    revision: 1,
+    features: {
+        /** Node supports Basic Commissioning Method. */
+        basic: BitFlag(0),
+    },
+    /** @see {@link MatterCoreSpecificationV1_0} § 11.18.7 */
+    attributes: {
+        /** Indicates whether a new Commissioning window has been opened by an Administrator. */
+        windowStatus: Attribute(0, TlvEnum()),
+        /** If a window is opened, indicates the FabricIndex of the Administrator fabric that opened the window. */
+        adminFabricIndex: Attribute(1, TlvNullable(TlvFabricIndex)),
+        /** If a window is opened, indicates the vendorId of the Administrator fabric that opened the window. */
+        adminVendorId: Attribute(2, TlvNullable(TlvVendorId)),
+    },
+    /** @see {@link MatterCoreSpecificationV1_0} § 11.18.8 */
+    commands: {
+        /** Used to instruct a Node to go into commissioning mode using enhanced commissioning method. */
+        openCommissioningWindow: Command(0, TlvOpenCommissioningWindowRequest, 0, TlvNoResponse),
+        /** Used to instruct a Node to go into commissioning mode using basic commissioning method, if the node supports it. */
+        openBasicCommissioningWindow: OptionalCommand(1, TlvOpenBasicCommissioningWindowRequest, 1, TlvNoResponse),
+        /** Used to instruct a Node to revoke any active Open Commissioning Window or Open Basic Commissioning Window command. */
+        revokeCommissioning: Command(2, TlvNoArguments, 2, TlvNoResponse),
+    },
+});

package/dist/es/cluster/BasicInformationCluster.d.ts

@@ -0,0 +1,62 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Attribute, Cluster, Event, OptionalAttribute, OptionalWritableAttribute, WritableAttribute } from "./Cluster.js";
+/**
+ * This cluster provides attributes and events for determining basic information about Nodes, which supports both
+ * commissioning and operational determination of Node characteristics, such as Vendor ID, Product ID and serial number,
+ * which apply to the whole Node. Also allows setting user device information such as location.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 11.1
+ */
+export declare const BasicInformationCluster: Cluster<import("../schema/BitmapSchema.js").BitSchema, {
+    dataModelRevision: Attribute<number>;
+    vendorName: Attribute<string>;
+    vendorId: Attribute<import("../datatype/VendorId.js").VendorId>;
+    productName: Attribute<string>;
+    productId: Attribute<number>;
+    nodeLabel: WritableAttribute<string>;
+    location: WritableAttribute<string>;
+    hardwareVersion: Attribute<number>;
+    hardwareVersionString: Attribute<string>;
+    softwareVersion: Attribute<number>;
+    softwareVersionString: Attribute<string>;
+    manufacturingDate: OptionalAttribute<string>;
+    partNumber: OptionalAttribute<string>;
+    productURL: OptionalAttribute<string>;
+    productLabel: OptionalAttribute<string>;
+    serialNumber: OptionalAttribute<string>;
+    localConfigDisabled: OptionalWritableAttribute<boolean>;
+    reachable: OptionalAttribute<boolean>;
+    uniqueId: OptionalAttribute<string>;
+    capabilityMinima: Attribute<{
+        caseSessionsPerFabric: number;
+        subscriptionsPerFabric: number;
+    }>;
+    clusterRevision: Attribute<number>;
+    featureMap: Attribute<import("../schema/BitmapSchema.js").TypeFromBitSchema<import("../schema/BitmapSchema.js").BitSchema>>;
+    attributeList: Attribute<import("../datatype/AttributeId.js").AttributeId[]>;
+    eventList: Attribute<import("../datatype/EventId.js").EventId[]>;
+    acceptedCommandList: Attribute<import("../datatype/CommandId.js").CommandId[]>;
+    generatedCommandList: Attribute<import("../datatype/CommandId.js").CommandId[]>;
+}, import("./Cluster.js").Commands, {
+    /** First event fired as soon as reasonable after completing a boot or reboot process. */
+    startUp: Event<{
+        softwareVersion: number;
+    }>;
+    /** Last event fired prior to any orderly shutdown sequence on a best-effort basis. */
+    shutDown: Event<{
+        [x: string]: any;
+    }>;
+    /** Fired prior to permanently leaving a given Fabric. */
+    leave: Event<{
+        fabricIndex: import("../datatype/FabricIndex.js").FabricIndex;
+    }>;
+    /** Fired when there is a change in the {@link BasicInformationCluster.attributes.reachable reachable} attribute. */
+    reachableChanged: Event<{
+        reachableNewValue: boolean;
+    }>;
+}>;
+//# sourceMappingURL=BasicInformationCluster.d.ts.map

package/dist/es/cluster/BasicInformationCluster.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BasicInformationCluster.d.ts","sourceRoot":"","sources":["../../../src/cluster/BasicInformationCluster.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EACU,SAAS,EAAE,OAAO,EAAE,KAAK,EAAiB,iBAAiB,EAAiB,yBAAyB,EAClH,iBAAiB,EACpB,MAAM,cAAc,CAAC;AAoBtB;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAsE5B,yFAAyF;;;;IAGzF,sFAAsF;;;;IAGtF,yDAAyD;;;;IAGzD,oHAAoH;;;;EAG1H,CAAC"}

package/dist/es/cluster/BasicInformationCluster.js

@@ -1,15 +1,15 @@
 /**
  * @license
- * Copyright 2022 Project CHIP Authors
+ * Copyright 2022-2023 Project CHIP Authors
  * SPDX-License-Identifier: Apache-2.0
  */
-import { TlvFabricIndex } from "../common/FabricIndex.js";
-import { TlvVendorId } from "../common/VendorId.js";
-import { TlvBoolean } from "../tlv/TlvBoolean.js";
-import { TlvUInt16, TlvUInt32 } from "../tlv/TlvNumber.js";
+import { TlvFabricIndex } from "../datatype/FabricIndex.js";
+import { TlvVendorId } from "../datatype/VendorId.js";
+import { Attribute, Cluster, Event, OptionalAttribute, OptionalEvent, OptionalWritableAttribute, WritableAttribute } from "./Cluster.js";
 import { TlvField, TlvObject } from "../tlv/TlvObject.js";
 import { TlvString, TlvString256max, TlvString32max, TlvString64max } from "../tlv/TlvString.js";
-import { Attribute, Cluster, Event, OptionalAttribute, OptionalEvent, OptionalWritableAttribute, WritableAttribute } from "./Cluster.js";
+import { TlvUInt16, TlvUInt32 } from "../tlv/TlvNumber.js";
+import { TlvBoolean } from "../tlv/TlvBoolean.js";
 /**
  * Provides constant values related to overall global capabilities of this Node, that are not cluster-specific.
  *
@@ -30,7 +30,7 @@ const TlvCapabilityMinima = TlvObject({
  */
 export const BasicInformationCluster = Cluster({
     id: 0x28,
-    name: "Basic Information",
+    name: "BasicInformation",
     revision: 1,
     /** @see {@link MatterCoreSpecificationV1_0} § 11.1.6.3 */
     attributes: {
@@ -45,9 +45,9 @@ export const BasicInformationCluster = Cluster({
         /** Product ID assigned by the vendor that is unique to the specific product of the Node. */
         productId: Attribute(4, TlvUInt16),
         /** User defined name for the Node. It is set during initial commissioning and may be updated by further reconfigurations. */
-        nodeLabel: WritableAttribute(5, TlvString32max, { default: "", writeAcl: 1 /* AccessLevel.Manage */ }),
+        nodeLabel: WritableAttribute(5, TlvString32max, { persistent: true, default: "", writeAcl: 1 /* AccessLevel.Manage */ }),
         /** ISO 3166-1 alpha-2 code where the Node is located. Might affect some regulatory aspects. */
-        location: WritableAttribute(6, TlvString.bound({ length: 2 }), { default: "XX", writeAcl: 2 /* AccessLevel.Administer */ }),
+        location: WritableAttribute(6, TlvString.bound({ length: 2 }), { persistent: true, default: "XX", writeAcl: 2 /* AccessLevel.Administer */ }),
         /** Version number of the hardware of the Node. The meaning of its value, and the versioning scheme, are vendor defined. */
         hardwareVersion: Attribute(7, TlvUInt16, { default: 0 }),
         /** Human-readable representation of the {@link BasicInformationCluster.attributes.hardwareVersion hardwareVersion} attribute. */
@@ -67,7 +67,7 @@ export const BasicInformationCluster = Cluster({
         /** Human readable serial number. */
         serialNumber: OptionalAttribute(15, TlvString32max),
         /** Allows to disable the ability to configure the Node through an on-Node user interface. */
-        localConfigDisabled: OptionalWritableAttribute(16, TlvBoolean, { default: false, writeAcl: 1 /* AccessLevel.Manage */ }),
+        localConfigDisabled: OptionalWritableAttribute(16, TlvBoolean, { persistent: true, default: false, writeAcl: 1 /* AccessLevel.Manage */ }),
         /** Indicates whether the Node can be reached over the non-native network for bridged devices. */
         reachable: OptionalAttribute(17, TlvBoolean, { default: true }),
         /** Unique identifier for the device, which is constructed in a manufacturer specific manner, updated during factory reset. */

package/dist/es/cluster/BindingCluster.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Cluster, WritableAttribute } from "./Cluster.js";
+/**
+ * A binding represents a persistent relationship between an endpoint and one or more other local or
+ * remote endpoints. A binding does not require that the relationship exists. It is up to the node
+ * application to set up the relationship.
+ *
+ * @see {@link MatterCoreSpecificationV1_0} § 9.6
+ */
+export declare const BindingCluster: Cluster<import("../schema/BitmapSchema.js").BitSchema, {
+    bindingList: WritableAttribute<{
+        node?: import("../datatype/NodeId.js").NodeId | undefined;
+        endpoint?: import("../datatype/EndpointNumber.js").EndpointNumber | undefined;
+        cluster?: import("../datatype/ClusterId.js").ClusterId | undefined;
+        group?: import("../datatype/GroupId.js").GroupId | undefined;
+    }[]>;
+    clusterRevision: import("./Cluster.js").Attribute<number>;
+    featureMap: import("./Cluster.js").Attribute<import("../schema/BitmapSchema.js").TypeFromBitSchema<import("../schema/BitmapSchema.js").BitSchema>>;
+    attributeList: import("./Cluster.js").Attribute<import("../datatype/AttributeId.js").AttributeId[]>;
+    eventList: import("./Cluster.js").Attribute<import("../datatype/EventId.js").EventId[]>;
+    acceptedCommandList: import("./Cluster.js").Attribute<import("../datatype/CommandId.js").CommandId[]>;
+    generatedCommandList: import("./Cluster.js").Attribute<import("../datatype/CommandId.js").CommandId[]>;
+}, import("./Cluster.js").Commands, import("./Cluster.js").Events>;
+//# sourceMappingURL=BindingCluster.d.ts.map

package/dist/es/cluster/BindingCluster.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BindingCluster.d.ts","sourceRoot":"","sources":["../../../src/cluster/BindingCluster.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAgC1D;;;;;;GAMG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;kEAUzB,CAAC"}

package/dist/es/cluster/BindingCluster.js

@@ -1,14 +1,14 @@
 /**
  * @license
- * Copyright 2022 Project CHIP Authors
+ * Copyright 2022-2023 Project CHIP Authors
  * SPDX-License-Identifier: Apache-2.0
  */
 import { Cluster, WritableAttribute } from "./Cluster.js";
-import { TlvClusterId } from "../common/ClusterId.js";
-import { TlvEndpointNumber } from "../common/EndpointNumber.js";
-import { TlvNodeId } from "../common/NodeId.js";
-import { TlvGroupId } from "../common/GroupId.js";
 import { TlvObject, TlvOptionalField } from "../tlv/TlvObject.js";
+import { TlvNodeId } from "../datatype/NodeId.js";
+import { TlvGroupId } from "../datatype/GroupId.js";
+import { TlvEndpointNumber } from "../datatype/EndpointNumber.js";
+import { TlvClusterId } from "../datatype/ClusterId.js";
 import { TlvArray } from "../tlv/TlvArray.js";
 /**
  * Provides information about endpoint conformance to a release of a device type definition.
@@ -43,6 +43,6 @@ export const BindingCluster = Cluster({
     /** @see {@link MatterCoreSpecificationV1_0} § 9.6.5 */
     attributes: {
         /** List of device types and corresponding revisions declaring endpoint conformance. */
-        binding: WritableAttribute(0, TlvArray(TlvTarget), { default: [] }), /* non-volatile */
+        bindingList: WritableAttribute(0, TlvArray(TlvTarget), { persistent: true, default: [] }),
     },
 });

package/dist/es/cluster/BooleanStateCluster.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Attribute, Cluster } from "./Cluster.js";
+/**
+ * Attributes and commands for Boolean State.
+ *
+ * @see {@link MatterApplicationClusterSpecificationV1_0} § 1.7
+ */
+export declare const BooleanStateCluster: Cluster<import("../schema/BitmapSchema.js").BitSchema, {
+    stateValue: Attribute<boolean>;
+    clusterRevision: Attribute<number>;
+    featureMap: Attribute<import("../schema/BitmapSchema.js").TypeFromBitSchema<import("../schema/BitmapSchema.js").BitSchema>>;
+    attributeList: Attribute<import("../datatype/AttributeId.js").AttributeId[]>;
+    eventList: Attribute<import("../datatype/EventId.js").EventId[]>;
+    acceptedCommandList: Attribute<import("../datatype/CommandId.js").CommandId[]>;
+    generatedCommandList: Attribute<import("../datatype/CommandId.js").CommandId[]>;
+}, import("./Cluster.js").Commands, {
+    /** generated when the StateValue attribute changes */
+    stateChange: import("./Cluster.js").Event<{
+        stateValue: boolean;
+    }>;
+}>;
+//# sourceMappingURL=BooleanStateCluster.d.ts.map

package/dist/es/cluster/BooleanStateCluster.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BooleanStateCluster.d.ts","sourceRoot":"","sources":["../../../src/cluster/BooleanStateCluster.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,SAAS,EAAgC,OAAO,EAAE,MAAM,cAAc,CAAC;AAKhF;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;IAgBxB,sDAAsD;;;;EAG5D,CAAC"}

package/dist/es/cluster/BooleanStateCluster.js

@@ -0,0 +1,31 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Attribute, OptionalEvent, Cluster } from "./Cluster.js";
+import { TlvBoolean } from "../tlv/TlvBoolean.js";
+import { TlvField } from "../tlv/TlvObject.js";
+/**
+ * Attributes and commands for Boolean State.
+ *
+ * @see {@link MatterApplicationClusterSpecificationV1_0} § 1.7
+ */
+export const BooleanStateCluster = Cluster({
+    id: 0x0045,
+    name: "BooleanState",
+    revision: 1,
+    /** @see {@link MatterApplicationClusterSpecificationV1_0} § 1.7.4 */
+    attributes: {
+        /**
+         * The semantics of this boolean state are defined by the device type using this cluster.
+         * For example, in a Contact Sensor device type, FALSE=open or no contact, TRUE=closed or contact
+         */
+        stateValue: Attribute(0, TlvBoolean),
+    },
+    /** @see {@link MatterApplicationClusterSpecificationV1_0 1.7.5} */
+    events: {
+        /** generated when the StateValue attribute changes */
+        stateChange: OptionalEvent(0, 1 /* EventPriority.Info */, { stateValue: TlvField(0, TlvBoolean) }),
+    },
+});