@matter/types 0.12.6-alpha.0-20250304-03716637c → 0.13.0-alpha.0-20250307-ebf84a05a

package/src/clusters/water-heater-mode.ts

@@ -0,0 +1,301 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/*** THIS FILE IS GENERATED, DO NOT EDIT ***/
+
+import { MutableCluster } from "../cluster/mutation/MutableCluster.js";
+import { BitFlag } from "../schema/BitmapSchema.js";
+import { FixedAttribute, Attribute, Command, TlvNoResponse } from "../cluster/Cluster.js";
+import { TlvArray } from "../tlv/TlvArray.js";
+import { TlvField, TlvOptionalField, TlvObject } from "../tlv/TlvObject.js";
+import { TlvString } from "../tlv/TlvString.js";
+import { TlvUInt8, TlvEnum } from "../tlv/TlvNumber.js";
+import { TlvVendorId } from "../datatype/VendorId.js";
+import { ModeBase } from "./mode-base.js";
+import { TypeFromSchema } from "../tlv/TlvSchema.js";
+import { Identity } from "#general";
+import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
+
+export namespace WaterHeaterMode {
+    /**
+     * These are optional features supported by WaterHeaterModeCluster.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 9.6.4
+     */
+    export enum Feature {
+        /**
+         * OnOff (DEPONOFF)
+         *
+         * Dependency with the OnOff cluster
+         */
+        OnOff = "OnOff"
+    }
+
+    export enum ModeTag {
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1
+         */
+        Auto = 0,
+
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1
+         */
+        Quick = 1,
+
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1
+         */
+        Quiet = 2,
+
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1
+         */
+        LowNoise = 3,
+
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1
+         */
+        LowEnergy = 4,
+
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1
+         */
+        Vacation = 5,
+
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1
+         */
+        Min = 6,
+
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1
+         */
+        Max = 7,
+
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1
+         */
+        Night = 8,
+
+        /**
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1
+         */
+        Day = 9,
+
+        /**
+         * While in modes with this tag, the device will not attempt to keep the water warm.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1.1
+         */
+        Off = 16384,
+
+        /**
+         * While in modes with this tag, the device will attempt to keep the water warm based on the
+         * OccupiedHeatingSetpoint attribute of the associated Thermostat cluster.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1.2
+         */
+        Manual = 16385,
+
+        /**
+         * While in modes with this tag, the device will attempt to keep the water warm based on the Schedules
+         * attribute of the associated Thermostat cluster.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 9.6.7.1.3
+         */
+        Timed = 16386
+    }
+
+    /**
+     * A Mode Tag is meant to be interpreted by the client for the purpose the cluster serves.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.1
+     */
+    export const TlvModeTagStruct = TlvObject({
+        /**
+         * If the MfgCode field exists, the Value field shall be in the manufacturer-specific value range (see Section
+         * 1.10.8, “Mode Namespace”).
+         *
+         * This field shall indicate the manufacturer’s VendorID and it shall determine the meaning of the Value field.
+         *
+         * The same manufacturer code and mode tag value in separate cluster instances are part of the same namespace
+         * and have the same meaning. For example: a manufacturer tag meaning "pinch" can be used both in a cluster
+         * whose purpose is to choose the amount of sugar, or in a cluster whose purpose is to choose the amount of
+         * salt.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.1.1
+         */
+        mfgCode: TlvOptionalField(0, TlvVendorId),
+
+        /**
+         * This field shall indicate the mode tag within a mode tag namespace which is either manufacturer specific or
+         * standard.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.1.2
+         */
+        value: TlvField(1, TlvEnum<ModeTag | ModeBase.ModeTag>())
+    });
+
+    /**
+     * A Mode Tag is meant to be interpreted by the client for the purpose the cluster serves.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.1
+     */
+    export interface ModeTagStruct extends TypeFromSchema<typeof TlvModeTagStruct> {}
+
+    /**
+     * The table below lists the changes relative to the Mode Base cluster for the fields of the ModeOptionStruct type.
+     * A blank field indicates no change.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 9.6.5.1
+     */
+    export const TlvModeOption = TlvObject({
+        /**
+         * This field shall indicate readable text that describes the mode option, so that a client can provide it to
+         * the user to indicate what this option means. This field is meant to be readable and understandable by the
+         * user.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.2.1
+         */
+        label: TlvField(0, TlvString.bound({ maxLength: 64 })),
+
+        /**
+         * This field is used to identify the mode option.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.2.2
+         */
+        mode: TlvField(1, TlvUInt8),
+
+        /**
+         * This field shall contain a list of tags that are associated with the mode option. This may be used by
+         * clients to determine the full or the partial semantics of a certain mode, depending on which tags they
+         * understand, using standard definitions and/or manufacturer specific namespace definitions.
+         *
+         * The standard mode tags are defined in this cluster specification. For the derived cluster instances, if the
+         * specification of the derived cluster defines a namespace, the set of standard mode tags also includes the
+         * mode tag values from that namespace.
+         *
+         * Mode tags can help clients look for options that meet certain criteria, render the user interface, use
+         *
+         * the mode in an automation, or to craft help text their voice-driven interfaces. A mode tag shall be either a
+         * standard tag or a manufacturer specific tag, as defined in each ModeTagStruct list entry.
+         *
+         * A mode option may have more than one mode tag. A mode option may be associated with a mixture of standard
+         * and manufacturer specific mode tags. A mode option shall be associated with at least one standard mode tag.
+         *
+         * A few examples are provided below.
+         *
+         *   • A mode named "100%" can have both the High (manufacturer specific) and Max (standard) mode tag. Clients
+         *     seeking the mode for either High or Max will find the same mode in this case.
+         *
+         *   • A mode that includes a LowEnergy tag can be displayed by the client using a widget icon that shows a
+         *     green leaf.
+         *
+         *   • A mode that includes a LowNoise tag may be used by the client when the user wishes for a lower level of
+         *     audible sound, less likely to disturb the household’s activities.
+         *
+         *   • A mode that includes a LowEnergy tag (standard, defined in this cluster specification) and also a
+         *     Delicate tag (standard, defined in the namespace of a Laundry Mode derived cluster).
+         *
+         *   • A mode that includes both a generic Quick tag (defined here), and Vacuum and Mop tags, (defined in the
+         *     RVC Clean cluster that is a derivation of this cluster).
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 1.10.5.2.3
+         */
+        modeTags: TlvField(2, TlvArray(TlvModeTagStruct, { maxLength: 8 }))
+    });
+
+    /**
+     * The table below lists the changes relative to the Mode Base cluster for the fields of the ModeOptionStruct type.
+     * A blank field indicates no change.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 9.6.5.1
+     */
+    export interface ModeOption extends TypeFromSchema<typeof TlvModeOption> {}
+
+    /**
+     * These elements and properties are present in all WaterHeaterMode clusters.
+     */
+    export const Base = MutableCluster.Component({
+        id: 0x9e,
+        name: "WaterHeaterMode",
+        revision: 1,
+
+        features: {
+            /**
+             * OnOff
+             *
+             * Dependency with the OnOff cluster
+             */
+            onOff: BitFlag(0)
+        },
+
+        attributes: {
+            /**
+             * At least one entry in the SupportedModes attribute shall include the Manual mode tag in the ModeTags
+             * field list.
+             *
+             * At least one entry in the SupportedModes attribute shall include the Off mode tag in the ModeTags field
+             * list.
+             *
+             * An entry in the SupportedModes attribute that includes one of an Off, Manual, or Timed tag shall NOT
+             * also include an additional instance of any one of these tag types.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 9.6.6.1
+             */
+            supportedModes: FixedAttribute(
+                0x0,
+                TlvArray(TlvModeOption, { minLength: 2, maxLength: 255 }),
+                { default: [] }
+            ),
+
+            /**
+             * @see {@link MatterSpecification.v13.Cluster} § 9.6.6
+             */
+            currentMode: Attribute(0x1, TlvUInt8, { persistent: true })
+        },
+
+        commands: {
+            /**
+             * This command is used to change device modes.
+             *
+             * On receipt of this command the device shall respond with a ChangeToModeResponse command.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 1.10.7.1
+             */
+            changeToMode: Command(0x0, ModeBase.TlvChangeToModeRequest, 0x0, TlvNoResponse)
+        },
+
+        /**
+         * This metadata controls which WaterHeaterModeCluster elements matter.js activates for specific feature
+         * combinations.
+         */
+        extensions: MutableCluster.Extensions({ flags: { onOff: true }, component: false })
+    });
+
+    /**
+     * @see {@link Cluster}
+     */
+    export const ClusterInstance = MutableCluster(Base);
+
+    /**
+     * This cluster is derived from the Mode Base cluster and defines additional mode tags and namespaced enumerated
+     * values for water heater devices.
+     *
+     * WaterHeaterModeCluster supports optional features that you can enable with the WaterHeaterModeCluster.with()
+     * factory method.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 9.6
+     */
+    export interface Cluster extends Identity<typeof ClusterInstance> {}
+
+    export const Cluster: Cluster = ClusterInstance;
+    export const Complete = Cluster;
+}
+
+export type WaterHeaterModeCluster = WaterHeaterMode.Cluster;
+export const WaterHeaterModeCluster = WaterHeaterMode.Cluster;
+ClusterRegistry.register(WaterHeaterMode.Complete);

package/src/clusters/water-tank-level-monitoring.ts

@@ -0,0 +1,50 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/*** THIS FILE IS GENERATED, DO NOT EDIT ***/
+
+import { MutableCluster } from "../cluster/mutation/MutableCluster.js";
+import { ResourceMonitoring } from "./resource-monitoring.js";
+import { Identity } from "#general";
+import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
+
+export namespace WaterTankLevelMonitoring {
+    export const Base = { ...ResourceMonitoring.Base, id: 0x79, name: "WaterTankLevelMonitoring" } as const;
+
+    /**
+     * @see {@link Cluster}
+     */
+    export const ClusterInstance = MutableCluster(Base);
+
+    /**
+     * This alias specializes the semantics of {@link ResourceMonitoring.Base}.
+     *
+     * WaterTankLevelMonitoringCluster supports optional features that you can enable with the
+     * WaterTankLevelMonitoringCluster.with() factory method.
+     */
+    export interface Cluster extends Identity<typeof ClusterInstance> {}
+
+    export const Cluster: Cluster = ClusterInstance;
+
+    /**
+     * This cluster supports all WaterTankLevelMonitoring features. It may support illegal feature combinations.
+     *
+     * If you use this cluster you must manually specify which features are active and ensure the set of active
+     * features is legal per the Matter specification.
+     */
+    export const CompleteInstance = MutableCluster({
+        ...ResourceMonitoring.Complete,
+        id: 0x79,
+        name: "WaterTankLevelMonitoring"
+    });
+
+    export interface Complete extends Identity<typeof CompleteInstance> {}
+    export const Complete: Complete = CompleteInstance;
+}
+
+export type WaterTankLevelMonitoringCluster = WaterTankLevelMonitoring.Cluster;
+export const WaterTankLevelMonitoringCluster = WaterTankLevelMonitoring.Cluster;
+ClusterRegistry.register(WaterTankLevelMonitoring.Complete);

package/src/clusters/wi-fi-network-diagnostics.ts

@@ -185,9 +185,8 @@ export namespace WiFiNetworkDiagnostics {
 
         /**
          * The Status field shall be set to the Status Code value that was present in the last frame related to
-         * association where Status Code was not equal to zero and which caused the failure of a last trial
-         *
-         * attempt, if this last failure was due to one of the following Management frames:
+         * association where Status Code was not equal to zero and which caused the failure of a last trial attempt, if
+         * this last failure was due to one of the following Management frames:
          *
          *   • Association Response (Type 0, Subtype 1)
          *
@@ -292,11 +291,10 @@ export namespace WiFiNetworkDiagnostics {
     export const PacketCountsComponent = MutableCluster.Component({
         attributes: {
             /**
-             * The BeaconRxCount attribute shall indicate the count of the number of received beacons. The
-             *
-             * total number of expected beacons that could have been received during the interval since association
-             * SHOULD match the sum of BeaconRxCount and BeaconLostCount. If the Node does not have an ability to
-             * report count of beacons received, this value may remain set to zero.
+             * The BeaconRxCount attribute shall indicate the count of the number of received beacons. The total number
+             * of expected beacons that could have been received during the interval since association SHOULD match the
+             * sum of BeaconRxCount and BeaconLostCount. If the Node does not have an ability to report count of
+             * beacons received, this value may remain set to zero.
              *
              * @see {@link MatterSpecification.v13.Core} § 11.15.6.7
              */

package/src/clusters/wi-fi-network-management.ts

@@ -0,0 +1,119 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/*** THIS FILE IS GENERATED, DO NOT EDIT ***/
+
+import { MutableCluster } from "../cluster/mutation/MutableCluster.js";
+import { Attribute, Command } from "../cluster/Cluster.js";
+import { TlvByteString } from "../tlv/TlvString.js";
+import { TlvNullable } from "../tlv/TlvNullable.js";
+import { TlvUInt64 } from "../tlv/TlvNumber.js";
+import { AccessLevel } from "#model";
+import { TlvNoArguments } from "../tlv/TlvNoArguments.js";
+import { Identity } from "#general";
+import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
+
+export namespace WiFiNetworkManagement {
+    /**
+     * @see {@link Cluster}
+     */
+    export const ClusterInstance = MutableCluster({
+        id: 0x451,
+        name: "WiFiNetworkManagement",
+        revision: 1,
+
+        attributes: {
+            /**
+             * Indicates the SSID of the primary Wi-Fi network provided by this device.
+             *
+             * A value of null shall indicate that no primary Wi-Fi network is available (e.g. because the Wi-Fi
+             * network has not yet been configured by the user).
+             *
+             * NOTE
+             *
+             * The SSID in Wi-Fi is a collection of 1-32 bytes, the text encoding of which is not specified.
+             * Implementations must be careful to support transferring these byte strings without requiring a
+             * particular encoding. The most common encoding is UTF-8, however this is just a convention. Some
+             * configurations may use Latin-1 or other character sets.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 10.2.4.1
+             */
+            ssid: Attribute(
+                0x0,
+                TlvNullable(TlvByteString.bound({ minLength: 1, maxLength: 32 })),
+                { persistent: true, default: null }
+            ),
+
+            /**
+             * This attribute shall contain an arbitrary numeric value; this value shall increase whenever the
+             * passphrase or PSK associated with the primary Wi-Fi network provided by this device changes.
+             *
+             * A value of null shall indicate that no primary Wi-Fi network is available.
+             *
+             * Clients can subscribe to this attribute or compare its value to a locally cached copy to detect if a
+             * cached passphrase value has become stale.
+             *
+             * It is recommended that servers implement this attribute as either a timestamp or a counter. When
+             * implemented as a counter it SHOULD be initialized with a random value.
+             *
+             * NOTE
+             *
+             * The passphrase itself is not exposed as an attribute to avoid its unintentional retrieval or caching by
+             * clients that use wildcard reads or otherwise routinely read all available attributes. It can be
+             * retrieved using the NetworkPassphraseRequest
+             *
+             * command.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 10.2.4.2
+             */
+            passphraseSurrogate: Attribute(
+                0x1,
+                TlvNullable(TlvUInt64),
+                { persistent: true, default: null, readAcl: AccessLevel.Manage, writeAcl: AccessLevel.Manage }
+            )
+        },
+
+        commands: {
+            /**
+             * This command is used to request the current WPA-Personal passphrase or PSK associated with the Wi-Fi
+             * network provided by this device.
+             *
+             * If the command is not executed via a CASE session, the command shall be rejected with a status of
+             * UNSUPPORTED_ACCESS.
+             *
+             * If no primary Wi-Fi network is available (the SSID attribute is null), the command shall be rejected
+             * with a status of INVALID_IN_STATE.
+             *
+             * Otherwise a NetworkPassphraseResponse shall be generated.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 10.2.5.1
+             */
+            networkPassphraseRequest: Command(
+                0x0,
+                TlvNoArguments,
+                0x1,
+                TlvNoArguments,
+                { invokeAcl: AccessLevel.Manage }
+            )
+        }
+    });
+
+    /**
+     * This cluster provides an interface for getting information about the Wi-Fi network that a Network Infrastructure
+     * Manager device type provides. Privileged nodes within the same fabric as a Network Infrastructure Manager can
+     * use these interfaces to request information related to the Wi-Fi Network such as SSID and Passphrase.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 10.2
+     */
+    export interface Cluster extends Identity<typeof ClusterInstance> {}
+
+    export const Cluster: Cluster = ClusterInstance;
+    export const Complete = Cluster;
+}
+
+export type WiFiNetworkManagementCluster = WiFiNetworkManagement.Cluster;
+export const WiFiNetworkManagementCluster = WiFiNetworkManagement.Cluster;
+ClusterRegistry.register(WiFiNetworkManagement.Complete);