@matter/types 0.14.0-alpha.0-20250531-7ed2d6da8 → 0.14.0-alpha.0-20250602-37f27bb02

package/src/clusters/unit-localization.ts

@@ -18,7 +18,7 @@ export namespace UnitLocalization {
     /**
      * These are optional features supported by UnitLocalizationCluster.
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.5.4
+     * @see {@link MatterSpecification.v141.Core} § 11.5.4
      */
     export enum Feature {
         /**
@@ -30,7 +30,7 @@ export namespace UnitLocalization {
     }
 
     /**
-     * @see {@link MatterSpecification.v14.Core} § 11.5.5.1
+     * @see {@link MatterSpecification.v141.Core} § 11.5.5.1
      */
     export enum TempUnit {
         /**
@@ -59,7 +59,7 @@ export namespace UnitLocalization {
              * in communication to the user. If provided, this value shall take priority over any unit implied through
              * the ActiveLocale Attribute.
              *
-             * @see {@link MatterSpecification.v14.Core} § 11.5.6.1
+             * @see {@link MatterSpecification.v141.Core} § 11.5.6.1
              */
             temperatureUnit: WritableAttribute(
                 0x0,
@@ -108,7 +108,7 @@ export namespace UnitLocalization {
      * UnitLocalizationCluster supports optional features that you can enable with the UnitLocalizationCluster.with()
      * factory method.
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.5
+     * @see {@link MatterSpecification.v141.Core} § 11.5
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}
 

package/src/clusters/user-label.ts

@@ -28,7 +28,7 @@ export namespace UserLabel {
              * An implementation shall support at least 4 list entries per node for all User Label cluster instances on
              * the node.
              *
-             * @see {@link MatterSpecification.v14.Core} § 9.9.4.1
+             * @see {@link MatterSpecification.v141.Core} § 9.9.4.1
              */
             labelList: WritableAttribute(
                 0x0,
@@ -42,7 +42,7 @@ export namespace UserLabel {
      * This cluster is derived from the Label cluster and provides a feature to tag an endpoint with zero or more
      * writable labels.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.9
+     * @see {@link MatterSpecification.v141.Core} § 9.9
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}
 

package/src/clusters/valid-proxies.ts

@@ -20,28 +20,28 @@ export namespace ValidProxies {
     /**
      * Encapsulates the Node ID of a Valid Proxy.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.15.14.4.1
+     * @see {@link MatterSpecification.v141.Core} § 9.15.14.4.1
      */
     export const TlvValidProxy = TlvObject({ nodeId: TlvField(1, TlvNodeId) });
 
     /**
      * Encapsulates the Node ID of a Valid Proxy.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.15.14.4.1
+     * @see {@link MatterSpecification.v141.Core} § 9.15.14.4.1
      */
     export interface ValidProxy extends TypeFromSchema<typeof TlvValidProxy> {}
 
     /**
      * This command is used during proxy discovery, as specified in Section 9.15.7, “Proxy Discovery & Assignment Flow”.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.15.14.6.2
+     * @see {@link MatterSpecification.v141.Core} § 9.15.14.6.2
      */
     export const TlvGetValidProxiesResponse = TlvObject({ proxyNodeIdList: TlvField(0, TlvArray(TlvNodeId)) });
 
     /**
      * This command is used during proxy discovery, as specified in Section 9.15.7, “Proxy Discovery & Assignment Flow”.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.15.14.6.2
+     * @see {@link MatterSpecification.v141.Core} § 9.15.14.6.2
      */
     export interface GetValidProxiesResponse extends TypeFromSchema<typeof TlvGetValidProxiesResponse> {}
 
@@ -57,7 +57,7 @@ export namespace ValidProxies {
             /**
              * List of valid proxies that can proxy this Node. Each entry in this list is fabric-scoped.
              *
-             * @see {@link MatterSpecification.v14.Core} § 9.15.14.5.1
+             * @see {@link MatterSpecification.v141.Core} § 9.15.14.5.1
              */
             validProxyList: FixedAttribute(0x0, TlvArray(TlvValidProxy), { persistent: true, default: [] })
         },
@@ -67,7 +67,7 @@ export namespace ValidProxies {
              * This command is used during proxy discovery, as specified in Section 9.15.7, “Proxy Discovery &
              * Assignment Flow”.
              *
-             * @see {@link MatterSpecification.v14.Core} § 9.15.14.6.1
+             * @see {@link MatterSpecification.v141.Core} § 9.15.14.6.1
              */
             getValidProxiesRequest: Command(0x0, TlvNoArguments, 0x1, TlvGetValidProxiesResponse)
         }
@@ -77,7 +77,7 @@ export namespace ValidProxies {
      * This cluster provides a means for a device to be told of the valid set of possible proxies that can proxy
      * subscriptions on its behalf as per Section 9.15.7, “Proxy Discovery & Assignment Flow”.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.15.14
+     * @see {@link MatterSpecification.v141.Core} § 9.15.14
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}
 

package/src/clusters/valve-configuration-and-control.ts

@@ -24,6 +24,8 @@ import { BitFlag } from "../schema/BitmapSchema.js";
 import { TlvOptionalField, TlvObject, TlvField } from "../tlv/TlvObject.js";
 import { TypeFromSchema } from "../tlv/TlvSchema.js";
 import { TlvNoArguments } from "../tlv/TlvNoArguments.js";
+import { StatusResponseError } from "../common/StatusResponseError.js";
+import { Status } from "../globals/Status.js";
 import { Identity } from "#general";
 import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
 
@@ -31,7 +33,7 @@ export namespace ValveConfigurationAndControl {
     /**
      * These are optional features supported by ValveConfigurationAndControlCluster.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 4.6.4
+     * @see {@link MatterSpecification.v141.Cluster} § 4.6.4
      */
     export enum Feature {
         /**
@@ -42,7 +44,7 @@ export namespace ValveConfigurationAndControl {
          *
          * This feature shall NOT be supported unless the device supports the Time Synchronization cluster.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 4.6.4.1
+         * @see {@link MatterSpecification.v141.Cluster} § 4.6.4.1
          */
         TimeSync = "TimeSync",
 
@@ -52,13 +54,13 @@ export namespace ValveConfigurationAndControl {
          * This feature shall indicate that the valve is capable of being adjusted to a specific position, as a
          * percentage, of its full range of motion.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 4.6.4.2
+         * @see {@link MatterSpecification.v141.Cluster} § 4.6.4.2
          */
         Level = "Level"
     }
 
     /**
-     * @see {@link MatterSpecification.v14.Cluster} § 4.6.5.2
+     * @see {@link MatterSpecification.v141.Cluster} § 4.6.5.2
      */
     export enum ValveState {
         /**
@@ -78,7 +80,7 @@ export namespace ValveConfigurationAndControl {
     }
 
     /**
-     * @see {@link MatterSpecification.v14.Cluster} § 4.6.5.1
+     * @see {@link MatterSpecification.v141.Cluster} § 4.6.5.1
      */
     export const ValveFault = {
         /**
@@ -115,7 +117,7 @@ export namespace ValveConfigurationAndControl {
     /**
      * Input to the ValveConfigurationAndControl open command
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 4.6.8.1
+     * @see {@link MatterSpecification.v141.Cluster} § 4.6.8.1
      */
     export const TlvOpenRequest = TlvObject({
         /**
@@ -124,14 +126,14 @@ export namespace ValveConfigurationAndControl {
          * A value of null shall indicate the duration is not set, meaning that the valve will remain open until closed
          * by the user or some other automation.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 4.6.8.1.1
+         * @see {@link MatterSpecification.v141.Cluster} § 4.6.8.1.1
          */
         openDuration: TlvOptionalField(0, TlvNullable(TlvUInt32.bound({ min: 1 }))),
 
         /**
          * This field shall indicate the target level used for this specific Open command.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 4.6.8.1.2
+         * @see {@link MatterSpecification.v141.Cluster} § 4.6.8.1.2
          */
         targetLevel: TlvOptionalField(1, TlvPercent.bound({ min: 1 }))
     });
@@ -139,27 +141,27 @@ export namespace ValveConfigurationAndControl {
     /**
      * Input to the ValveConfigurationAndControl open command
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 4.6.8.1
+     * @see {@link MatterSpecification.v141.Cluster} § 4.6.8.1
      */
     export interface OpenRequest extends TypeFromSchema<typeof TlvOpenRequest> {}
 
     /**
      * Body of the ValveConfigurationAndControl valveStateChanged event
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 4.6.9.1
+     * @see {@link MatterSpecification.v141.Cluster} § 4.6.9.1
      */
     export const TlvValveStateChangedEvent = TlvObject({
         /**
          * This field shall indicate the new state of the valve.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 4.6.9.1.1
+         * @see {@link MatterSpecification.v141.Cluster} § 4.6.9.1.1
          */
         valveState: TlvField(0, TlvEnum<ValveState>()),
 
         /**
          * This field shall indicate the new level of the valve.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 4.6.9.1.2
+         * @see {@link MatterSpecification.v141.Cluster} § 4.6.9.1.2
          */
         valveLevel: TlvOptionalField(1, TlvPercent)
     });
@@ -167,20 +169,20 @@ export namespace ValveConfigurationAndControl {
     /**
      * Body of the ValveConfigurationAndControl valveStateChanged event
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 4.6.9.1
+     * @see {@link MatterSpecification.v141.Cluster} § 4.6.9.1
      */
     export interface ValveStateChangedEvent extends TypeFromSchema<typeof TlvValveStateChangedEvent> {}
 
     /**
      * Body of the ValveConfigurationAndControl valveFault event
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 4.6.9.2
+     * @see {@link MatterSpecification.v141.Cluster} § 4.6.9.2
      */
     export const TlvValveFaultEvent = TlvObject({
         /**
          * This field shall indicate the value of the ValveFault attribute, at the time this event is generated.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 4.6.9.2.1
+         * @see {@link MatterSpecification.v141.Cluster} § 4.6.9.2.1
          */
         valveFault: TlvField(0, TlvBitmap(TlvUInt16, ValveFault))
     });
@@ -188,12 +190,12 @@ export namespace ValveConfigurationAndControl {
     /**
      * Body of the ValveConfigurationAndControl valveFault event
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 4.6.9.2
+     * @see {@link MatterSpecification.v141.Cluster} § 4.6.9.2
      */
     export interface ValveFaultEvent extends TypeFromSchema<typeof TlvValveFaultEvent> {}
 
     /**
-     * @see {@link MatterSpecification.v14.Cluster} § 4.6.6.1
+     * @see {@link MatterSpecification.v141.Cluster} § 4.6.6.1
      */
     export enum StatusCode {
         /**
@@ -202,6 +204,21 @@ export namespace ValveConfigurationAndControl {
         FailureDueToFault = 2
     }
 
+    /**
+     * Thrown for cluster status code {@link StatusCode.FailureDueToFault}.
+     *
+     * @see {@link MatterSpecification.v141.Cluster} § 4.6.6.1
+     */
+    export class FailureDueToFaultError extends StatusResponseError {
+        constructor(
+            message = "The requested action could not be performed due to a fault on the valve",
+            code = Status.Failure,
+            clusterCode = StatusCode.FailureDueToFault
+        ) {
+            super(message, code, clusterCode);
+        }
+    }
+
     /**
      * A ValveConfigurationAndControlCluster supports these elements if it supports feature TimeSync.
      */
@@ -226,7 +243,7 @@ export namespace ValveConfigurationAndControl {
              * modifying the current UTC time of the device, the value of this attribute shall be adjusted to match the
              * new UTC time plus the value of the RemainingDuration attribute.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 4.6.7.3
+             * @see {@link MatterSpecification.v141.Cluster} § 4.6.7.3
              */
             autoCloseTime: Attribute(0x2, TlvNullable(TlvEpochUs), { default: null })
         }
@@ -247,7 +264,7 @@ export namespace ValveConfigurationAndControl {
              *
              * A value of null shall indicate that the current state is not known.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 4.6.7.7
+             * @see {@link MatterSpecification.v141.Cluster} § 4.6.7.7
              */
             currentLevel: Attribute(0x6, TlvNullable(TlvPercent), { default: null }),
 
@@ -259,7 +276,7 @@ export namespace ValveConfigurationAndControl {
              * A value of null shall indicate that no target position is set, since the change of level is either done
              * or failed.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 4.6.7.8
+             * @see {@link MatterSpecification.v141.Cluster} § 4.6.7.8
              */
             targetLevel: Attribute(0x7, TlvNullable(TlvPercent), { default: null }),
 
@@ -273,7 +290,7 @@ export namespace ValveConfigurationAndControl {
              * not 0, the requested DefaultOpenLevel value is considered an unsupported value and a CONSTRAINT_ERROR
              * status shall be returned.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 4.6.7.9
+             * @see {@link MatterSpecification.v141.Cluster} § 4.6.7.9
              */
             defaultOpenLevel: OptionalWritableAttribute(
                 0x8,
@@ -290,7 +307,7 @@ export namespace ValveConfigurationAndControl {
              *
              * The values of 0 and 100 shall always be supported, regardless of the value of this attribute.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 4.6.7.11
+             * @see {@link MatterSpecification.v141.Cluster} § 4.6.7.11
              */
             levelStep: OptionalFixedAttribute(0xa, TlvUInt8.bound({ min: 1, max: 50 }), { default: 1 })
         }
@@ -311,7 +328,7 @@ export namespace ValveConfigurationAndControl {
              *
              * This feature shall NOT be supported unless the device supports the Time Synchronization cluster.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 4.6.4.1
+             * @see {@link MatterSpecification.v141.Cluster} § 4.6.4.1
              */
             timeSync: BitFlag(0),
 
@@ -319,7 +336,7 @@ export namespace ValveConfigurationAndControl {
              * This feature shall indicate that the valve is capable of being adjusted to a specific position, as a
              * percentage, of its full range of motion.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 4.6.4.2
+             * @see {@link MatterSpecification.v141.Cluster} § 4.6.4.2
              */
             level: BitFlag(1)
         },
@@ -331,7 +348,7 @@ export namespace ValveConfigurationAndControl {
              * A value of null shall indicate the duration is not set, meaning that the valve will remain open until
              * closed by the user or some other automation.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 4.6.7.1
+             * @see {@link MatterSpecification.v141.Cluster} § 4.6.7.1
              */
             openDuration: Attribute(0x0, TlvNullable(TlvUInt32.bound({ min: 1 })), { default: null }),
 
@@ -342,7 +359,7 @@ export namespace ValveConfigurationAndControl {
              * A value of null shall indicate the duration is not set, meaning that the valve will remain open until
              * closed by the user or some other automation.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 4.6.7.2
+             * @see {@link MatterSpecification.v141.Cluster} § 4.6.7.2
              */
             defaultOpenDuration: WritableAttribute(
                 0x1,
@@ -376,7 +393,7 @@ export namespace ValveConfigurationAndControl {
              * position. The behavior of transitioning to the closed position shall match the behavior described in the
              * Close command.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 4.6.7.4
+             * @see {@link MatterSpecification.v141.Cluster} § 4.6.7.4
              */
             remainingDuration: Attribute(0x3, TlvNullable(TlvUInt32), { default: null }),
 
@@ -385,7 +402,7 @@ export namespace ValveConfigurationAndControl {
              *
              * A value of null shall indicate that the current state is not known.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 4.6.7.5
+             * @see {@link MatterSpecification.v141.Cluster} § 4.6.7.5
              */
             currentState: Attribute(0x4, TlvNullable(TlvEnum<ValveState>()), { default: null }),
 
@@ -395,14 +412,14 @@ export namespace ValveConfigurationAndControl {
              * A value of null shall indicate that no target position is set, since the change in state is either done
              * or failed.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 4.6.7.6
+             * @see {@link MatterSpecification.v141.Cluster} § 4.6.7.6
              */
             targetState: Attribute(0x5, TlvNullable(TlvEnum<ValveState>()), { default: null }),
 
             /**
              * Indicates any faults registered by the valve.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 4.6.7.10
+             * @see {@link MatterSpecification.v141.Cluster} § 4.6.7.10
              */
             valveFault: OptionalAttribute(0x9, TlvBitmap(TlvUInt16, ValveFault))
         },
@@ -411,14 +428,14 @@ export namespace ValveConfigurationAndControl {
             /**
              * This command is used to set the valve to its open position.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 4.6.8.1
+             * @see {@link MatterSpecification.v141.Cluster} § 4.6.8.1
              */
             open: Command(0x0, TlvOpenRequest, 0x0, TlvNoResponse),
 
             /**
              * This command is used to set the valve to its closed position.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 4.6.8.2
+             * @see {@link MatterSpecification.v141.Cluster} § 4.6.8.2
              */
             close: Command(0x1, TlvNoArguments, 0x1, TlvNoResponse)
         },
@@ -428,7 +445,7 @@ export namespace ValveConfigurationAndControl {
              * This event shall be generated when the valve state changed. For level changes, after the end of movement,
              * for state changes when the new state has been reached.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 4.6.9.1
+             * @see {@link MatterSpecification.v141.Cluster} § 4.6.9.1
              */
             valveStateChanged: OptionalEvent(0x0, EventPriority.Info, TlvValveStateChangedEvent),
 
@@ -436,7 +453,7 @@ export namespace ValveConfigurationAndControl {
              * This event shall be generated when the valve registers or clears a fault, e.g. not being able to
              * transition to the requested target level or state.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 4.6.9.2
+             * @see {@link MatterSpecification.v141.Cluster} § 4.6.9.2
              */
             valveFault: OptionalEvent(0x1, EventPriority.Info, TlvValveFaultEvent)
         },
@@ -462,7 +479,7 @@ export namespace ValveConfigurationAndControl {
      * ValveConfigurationAndControlCluster supports optional features that you can enable with the
      * ValveConfigurationAndControlCluster.with() factory method.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 4.6
+     * @see {@link MatterSpecification.v141.Cluster} § 4.6
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}
 

package/src/clusters/wake-on-lan.ts

@@ -29,7 +29,7 @@ export namespace WakeOnLan {
              * Format of this attribute shall be an upper-case hex-encoded string representing the hex address, like
              * 12345678ABCD.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 1.12.4.1
+             * @see {@link MatterSpecification.v141.Cluster} § 1.12.4.1
              */
             macAddress: OptionalFixedAttribute(0x0, TlvString.bound({ maxLength: 12 })),
 
@@ -43,7 +43,7 @@ export namespace WakeOnLan {
              *   will therefore choose not to include it or read it. The MAC Address can often be determined using ARP
              *   in IPv4 or NDP in IPv6.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 1.12.4.2
+             * @see {@link MatterSpecification.v141.Cluster} § 1.12.4.2
              */
             linkLocalAddress: OptionalFixedAttribute(0x1, TlvByteString)
         }
@@ -74,7 +74,7 @@ export namespace WakeOnLan {
      * The cluster server for Wake on LAN or Wake on WLAN is implemented by a device that supports the Wake on LAN/WLAN
      * protocol, such as a TV, Set-top Box, or Smart Speaker.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 1.12
+     * @see {@link MatterSpecification.v141.Cluster} § 1.12
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}