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

package/src/clusters/target-navigator.ts

@@ -13,6 +13,8 @@ import { TlvField, TlvObject, TlvOptionalField } from "../tlv/TlvObject.js";
 import { TlvUInt8, TlvEnum } from "../tlv/TlvNumber.js";
 import { TlvString, TlvByteString } from "../tlv/TlvString.js";
 import { TypeFromSchema } from "../tlv/TlvSchema.js";
+import { StatusResponseError } from "../common/StatusResponseError.js";
+import { Status as GlobalStatus } from "../globals/Status.js";
 import { Identity } from "#general";
 import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
 
@@ -20,20 +22,20 @@ export namespace TargetNavigator {
     /**
      * This indicates an object describing the navigable target.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 6.11.4.2
+     * @see {@link MatterSpecification.v141.Cluster} § 6.11.4.2
      */
     export const TlvTargetInfo = TlvObject({
         /**
          * This field shall contain an unique id within the TargetList.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 6.11.4.2.1
+         * @see {@link MatterSpecification.v141.Cluster} § 6.11.4.2.1
          */
         identifier: TlvField(0, TlvUInt8.bound({ max: 254 })),
 
         /**
          * This field shall contain a name string for the TargetInfoStruct.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 6.11.4.2.2
+         * @see {@link MatterSpecification.v141.Cluster} § 6.11.4.2.2
          */
         name: TlvField(1, TlvString)
     });
@@ -41,28 +43,28 @@ export namespace TargetNavigator {
     /**
      * This indicates an object describing the navigable target.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 6.11.4.2
+     * @see {@link MatterSpecification.v141.Cluster} § 6.11.4.2
      */
     export interface TargetInfo extends TypeFromSchema<typeof TlvTargetInfo> {}
 
     /**
      * Input to the TargetNavigator navigateTarget command
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 6.11.6.1
+     * @see {@link MatterSpecification.v141.Cluster} § 6.11.6.1
      */
     export const TlvNavigateTargetRequest = TlvObject({
         /**
          * This field shall indicate the Identifier for the target for UX navigation. The Target shall be an Identifier
          * value contained within one of the TargetInfoStruct objects in the TargetList attribute.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 6.11.6.1.1
+         * @see {@link MatterSpecification.v141.Cluster} § 6.11.6.1.1
          */
         target: TlvField(0, TlvUInt8),
 
         /**
          * This field shall indicate Optional app-specific data.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 6.11.6.1.2
+         * @see {@link MatterSpecification.v141.Cluster} § 6.11.6.1.2
          */
         data: TlvOptionalField(1, TlvString)
     });
@@ -70,12 +72,12 @@ export namespace TargetNavigator {
     /**
      * Input to the TargetNavigator navigateTarget command
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 6.11.6.1
+     * @see {@link MatterSpecification.v141.Cluster} § 6.11.6.1
      */
     export interface NavigateTargetRequest extends TypeFromSchema<typeof TlvNavigateTargetRequest> {}
 
     /**
-     * @see {@link MatterSpecification.v14.Cluster} § 6.11.4.1
+     * @see {@link MatterSpecification.v141.Cluster} § 6.11.4.1
      */
     export enum Status {
         /**
@@ -94,23 +96,53 @@ export namespace TargetNavigator {
         NotAllowed = 2
     }
 
+    /**
+     * Thrown for cluster status code {@link Status.TargetNotFound}.
+     *
+     * @see {@link MatterSpecification.v141.Cluster} § 6.11.4.1
+     */
+    export class TargetNotFoundError extends StatusResponseError {
+        constructor(
+            message = "Requested target was not found in the TargetList",
+            code = GlobalStatus.Failure,
+            clusterCode = Status.TargetNotFound
+        ) {
+            super(message, code, clusterCode);
+        }
+    }
+
+    /**
+     * Thrown for cluster status code {@link Status.NotAllowed}.
+     *
+     * @see {@link MatterSpecification.v141.Cluster} § 6.11.4.1
+     */
+    export class NotAllowedError extends StatusResponseError {
+        constructor(
+            message = "Target request is not allowed in current state",
+            code = GlobalStatus.Failure,
+            clusterCode = Status.NotAllowed
+        ) {
+            super(message, code, clusterCode);
+        }
+    }
+
     /**
      * This command shall be generated in response to NavigateTarget command.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 6.11.6.2
+     * @see {@link MatterSpecification.v141.Cluster} § 6.11.6.2
      */
     export const TlvNavigateTargetResponse = TlvObject({
         /**
          * This field shall indicate the of the command.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 6.11.6.2.1
+         * @see {@link MatterSpecification.v141.Cluster} § 6.11.6.2.1
          */
         status: TlvField(0, TlvEnum<Status>()),
 
         /**
          * This field shall indicate Optional app-specific data.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 6.11.6.2.2
+         * @see {@link MatterSpecification.v141.Cluster} § 6.11.6.2.2
          */
         data: TlvOptionalField(1, TlvString)
     });
@@ -118,14 +150,14 @@ export namespace TargetNavigator {
     /**
      * This command shall be generated in response to NavigateTarget command.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 6.11.6.2
+     * @see {@link MatterSpecification.v141.Cluster} § 6.11.6.2
      */
     export interface NavigateTargetResponse extends TypeFromSchema<typeof TlvNavigateTargetResponse> {}
 
     /**
      * Body of the TargetNavigator targetUpdated event
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 6.11.7.1
+     * @see {@link MatterSpecification.v141.Cluster} § 6.11.7.1
      */
     export const TlvTargetUpdatedEvent = TlvObject({
         targetList: TlvOptionalField(0, TlvArray(TlvTargetInfo)),
@@ -136,7 +168,7 @@ export namespace TargetNavigator {
     /**
      * Body of the TargetNavigator targetUpdated event
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 6.11.7.1
+     * @see {@link MatterSpecification.v141.Cluster} § 6.11.7.1
      */
     export interface TargetUpdatedEvent extends TypeFromSchema<typeof TlvTargetUpdatedEvent> {}
 
@@ -154,7 +186,7 @@ export namespace TargetNavigator {
              * Endpoint (Video Player or Content App). The list shall NOT contain any entries with the same Identifier
              * in the TargetInfoStruct object.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 6.11.5.1
+             * @see {@link MatterSpecification.v141.Cluster} § 6.11.5.1
              */
             targetList: Attribute(0x0, TlvArray(TlvTargetInfo), { default: [] }),
 
@@ -165,7 +197,7 @@ export namespace TargetNavigator {
              * When not 0xFF, the CurrentTarget shall be an Identifier value contained within one of the
              * TargetInfoStruct objects in the TargetList attribute.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 6.11.5.2
+             * @see {@link MatterSpecification.v141.Cluster} § 6.11.5.2
              */
             currentTarget: OptionalAttribute(0x1, TlvUInt8, { default: 255 })
         },
@@ -174,7 +206,7 @@ export namespace TargetNavigator {
             /**
              * Upon receipt, this shall navigation the UX to the target identified.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 6.11.6.1
+             * @see {@link MatterSpecification.v141.Cluster} § 6.11.6.1
              */
             navigateTarget: Command(0x0, TlvNavigateTargetRequest, 0x1, TlvNavigateTargetResponse)
         },
@@ -184,7 +216,7 @@ export namespace TargetNavigator {
              * This event shall be generated when there is a change in either the active target or the list of available
              * targets or both.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 6.11.7.1
+             * @see {@link MatterSpecification.v141.Cluster} § 6.11.7.1
              */
             targetUpdated: OptionalEvent(0x0, EventPriority.Info, TlvTargetUpdatedEvent)
         }
@@ -202,7 +234,7 @@ export namespace TargetNavigator {
      * When this cluster is implemented for a Content App endpoint, the Video Player device containing the endpoint
      * shall launch the Content App when a client invokes the NavigateTarget command.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 6.11
+     * @see {@link MatterSpecification.v141.Cluster} § 6.11
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}
 

package/src/clusters/temperature-control.ts

@@ -21,7 +21,7 @@ export namespace TemperatureControl {
     /**
      * These are optional features supported by TemperatureControlCluster.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 8.2.4
+     * @see {@link MatterSpecification.v141.Cluster} § 8.2.4
      */
     export enum Feature {
         /**
@@ -31,7 +31,7 @@ export namespace TemperatureControl {
          * the feature TN shall be used. Note that this cluster provides and supports temperatures in degrees Celsius
          * via the temperature data type.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 8.2.4.1
+         * @see {@link MatterSpecification.v141.Cluster} § 8.2.4.1
          */
         TemperatureNumber = "TemperatureNumber",
 
@@ -41,7 +41,7 @@ export namespace TemperatureControl {
          * For devices that use vendor-specific temperature levels for the temperature setpoint, such as some washers,
          * the feature TL shall be used.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 8.2.4.2
+         * @see {@link MatterSpecification.v141.Cluster} § 8.2.4.2
          */
         TemperatureLevel = "TemperatureLevel",
 
@@ -51,7 +51,7 @@ export namespace TemperatureControl {
          * For devices that support discrete temperature setpoints that are larger than the temperature resolution
          * imposed via the temperature data type, the Step feature may be used.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 8.2.4.3
+         * @see {@link MatterSpecification.v141.Cluster} § 8.2.4.3
          */
         TemperatureStep = "TemperatureStep"
     }
@@ -59,7 +59,7 @@ export namespace TemperatureControl {
     /**
      * Input to the TemperatureControl setTemperature command
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 8.2.6.1
+     * @see {@link MatterSpecification.v141.Cluster} § 8.2.6.1
      */
     export const TlvSetTemperatureRequest = TlvObject({
         /**
@@ -68,7 +68,7 @@ export namespace TemperatureControl {
          * The TargetTemperature shall be from MinTemperature to MaxTemperature inclusive. If the Step attribute is
          * supported, TargetTemperature shall be such that (TargetTemperature - MinTemperature) % Step == 0.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 8.2.6.1.1
+         * @see {@link MatterSpecification.v141.Cluster} § 8.2.6.1.1
          */
         targetTemperature: TlvOptionalField(0, TlvInt16),
 
@@ -77,7 +77,7 @@ export namespace TemperatureControl {
          * the desired temperature level setting of the server. The value of this field shall be between 0 and the
          * length of the SupportedTemperatureLevels list -1.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 8.2.6.1.2
+         * @see {@link MatterSpecification.v141.Cluster} § 8.2.6.1.2
          */
         targetTemperatureLevel: TlvOptionalField(1, TlvUInt8)
     });
@@ -85,7 +85,7 @@ export namespace TemperatureControl {
     /**
      * Input to the TemperatureControl setTemperature command
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 8.2.6.1
+     * @see {@link MatterSpecification.v141.Cluster} § 8.2.6.1
      */
     export interface SetTemperatureRequest extends TypeFromSchema<typeof TlvSetTemperatureRequest> {}
 
@@ -97,14 +97,14 @@ export namespace TemperatureControl {
             /**
              * Indicates the desired Temperature Setpoint on the device.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 8.2.5.1
+             * @see {@link MatterSpecification.v141.Cluster} § 8.2.5.1
              */
             temperatureSetpoint: Attribute(0x0, TlvInt16),
 
             /**
              * Indicates the minimum temperature to which the TemperatureSetpoint attribute may be set.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 8.2.5.2
+             * @see {@link MatterSpecification.v141.Cluster} § 8.2.5.2
              */
             minTemperature: FixedAttribute(0x1, TlvInt16),
 
@@ -115,7 +115,7 @@ export namespace TemperatureControl {
              * Step * n, where n is an integer and n > 0. If the Step attribute is not supported, this attribute shall
              * be such that MaxTemperature > MinTemperature.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 8.2.5.3
+             * @see {@link MatterSpecification.v141.Cluster} § 8.2.5.3
              */
             maxTemperature: FixedAttribute(0x2, TlvInt16)
         }
@@ -134,7 +134,7 @@ export namespace TemperatureControl {
              * values of the TargetTemperature field of the SetTemperature command would be 25.50C (2550), 26.00C
              * (2600), 26.50C (2650), etc.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 8.2.5.4
+             * @see {@link MatterSpecification.v141.Cluster} § 8.2.5.4
              */
             step: FixedAttribute(0x3, TlvInt16)
         }
@@ -150,7 +150,7 @@ export namespace TemperatureControl {
              * positional index of the list item in the SupportedTemperatureLevels list that represents the currently
              * selected temperature level setting of the server.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 8.2.5.5
+             * @see {@link MatterSpecification.v141.Cluster} § 8.2.5.5
              */
             selectedTemperatureLevel: Attribute(0x4, TlvUInt8.bound({ max: 31 })),
 
@@ -165,7 +165,7 @@ export namespace TemperatureControl {
              * unique value. The entries in this list shall appear in order of increasing temperature level with list
              * item 0 being the setting with the lowest temperature level.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 8.2.5.6
+             * @see {@link MatterSpecification.v141.Cluster} § 8.2.5.6
              */
             supportedTemperatureLevels: Attribute(0x5, TlvArray(TlvString, { maxLength: 32 }), { default: [] })
         }
@@ -185,7 +185,7 @@ export namespace TemperatureControl {
              * heaters, the feature TN shall be used. Note that this cluster provides and supports temperatures in
              * degrees Celsius via the temperature data type.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 8.2.4.1
+             * @see {@link MatterSpecification.v141.Cluster} § 8.2.4.1
              */
             temperatureNumber: BitFlag(0),
 
@@ -193,7 +193,7 @@ export namespace TemperatureControl {
              * For devices that use vendor-specific temperature levels for the temperature setpoint, such as some
              * washers, the feature TL shall be used.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 8.2.4.2
+             * @see {@link MatterSpecification.v141.Cluster} § 8.2.4.2
              */
             temperatureLevel: BitFlag(1),
 
@@ -201,14 +201,14 @@ export namespace TemperatureControl {
              * For devices that support discrete temperature setpoints that are larger than the temperature resolution
              * imposed via the temperature data type, the Step feature may be used.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 8.2.4.3
+             * @see {@link MatterSpecification.v141.Cluster} § 8.2.4.3
              */
             temperatureStep: BitFlag(2)
         },
 
         commands: {
             /**
-             * @see {@link MatterSpecification.v14.Cluster} § 8.2.6.1
+             * @see {@link MatterSpecification.v141.Cluster} § 8.2.6.1
              */
             setTemperature: Command(0x0, TlvSetTemperatureRequest, 0x0, TlvNoResponse)
         },
@@ -246,7 +246,7 @@ export namespace TemperatureControl {
      * Per the Matter specification you cannot use {@link TemperatureControlCluster} without enabling certain feature
      * combinations. You must use the {@link with} factory method to obtain a working cluster.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 8.2
+     * @see {@link MatterSpecification.v141.Cluster} § 8.2
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}
 

package/src/clusters/temperature-measurement.ts

@@ -26,7 +26,7 @@ export namespace TemperatureMeasurement {
             /**
              * Indicates the measured temperature. The null value indicates that the temperature is unknown.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 2.3.4.1
+             * @see {@link MatterSpecification.v141.Cluster} § 2.3.4.1
              */
             measuredValue: Attribute(0x0, TlvNullable(TlvInt16)),
 
@@ -36,7 +36,7 @@ export namespace TemperatureMeasurement {
              *
              * The null value indicates that the value is not available.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 2.3.4.2
+             * @see {@link MatterSpecification.v141.Cluster} § 2.3.4.2
              */
             minMeasuredValue: Attribute(0x1, TlvNullable(TlvInt16.bound({ min: -27315 })), { default: -27315 }),
 
@@ -46,14 +46,14 @@ export namespace TemperatureMeasurement {
              *
              * The null value indicates that the value is not available.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 2.3.4.3
+             * @see {@link MatterSpecification.v141.Cluster} § 2.3.4.3
              */
             maxMeasuredValue: Attribute(0x2, TlvNullable(TlvInt16.bound({ max: 32767 })), { default: 32767 }),
 
             /**
              * See Measured Value.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 2.3.4.4
+             * @see {@link MatterSpecification.v141.Cluster} § 2.3.4.4
              */
             tolerance: OptionalAttribute(0x3, TlvUInt16.bound({ max: 2048 }), { default: 0 })
         }
@@ -63,7 +63,7 @@ export namespace TemperatureMeasurement {
      * This cluster provides an interface to temperature measurement functionality, including configuration and
      * provision of notifications of temperature measurements.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 2.3
+     * @see {@link MatterSpecification.v141.Cluster} § 2.3
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}
 

package/src/clusters/thermostat-user-interface-configuration.ts

@@ -15,7 +15,7 @@ import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
 
 export namespace ThermostatUserInterfaceConfiguration {
     /**
-     * @see {@link MatterSpecification.v14.Cluster} § 4.5.5.1
+     * @see {@link MatterSpecification.v141.Cluster} § 4.5.5.1
      */
     export enum TemperatureDisplayMode {
         /**
@@ -32,7 +32,7 @@ export namespace ThermostatUserInterfaceConfiguration {
     /**
      * The interpretation of the various levels is device-dependent.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 4.5.5.2
+     * @see {@link MatterSpecification.v141.Cluster} § 4.5.5.2
      */
     export enum KeypadLockout {
         /**
@@ -67,7 +67,7 @@ export namespace ThermostatUserInterfaceConfiguration {
     }
 
     /**
-     * @see {@link MatterSpecification.v14.Cluster} § 4.5.5.3
+     * @see {@link MatterSpecification.v141.Cluster} § 4.5.5.3
      */
     export enum ScheduleProgrammingVisibility {
         /**
@@ -93,7 +93,7 @@ export namespace ThermostatUserInterfaceConfiguration {
             /**
              * Indicates the units of the temperature displayed on the thermostat screen.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 4.5.6.1
+             * @see {@link MatterSpecification.v141.Cluster} § 4.5.6.1
              */
             temperatureDisplayMode: WritableAttribute(
                 0x0,
@@ -104,7 +104,7 @@ export namespace ThermostatUserInterfaceConfiguration {
             /**
              * Indicates the level of functionality that is available to the user via the keypad.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 4.5.6.2
+             * @see {@link MatterSpecification.v141.Cluster} § 4.5.6.2
              */
             keypadLockout: WritableAttribute(
                 0x1,
@@ -121,7 +121,7 @@ export namespace ThermostatUserInterfaceConfiguration {
              * programmed by users or service providers via a more capable remote interface. The programming schedule
              * shall continue to run even though it is not visible to the user locally at the thermostat.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 4.5.6.3
+             * @see {@link MatterSpecification.v141.Cluster} § 4.5.6.3
              */
             scheduleProgrammingVisibility: OptionalWritableAttribute(
                 0x2,
@@ -135,7 +135,7 @@ export namespace ThermostatUserInterfaceConfiguration {
      * This cluster provides an interface to allow configuration of the user interface for a thermostat, or a thermostat
      * controller device, that supports a keypad and LCD screen.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 4.5
+     * @see {@link MatterSpecification.v141.Cluster} § 4.5
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}