@matter/types 0.14.0-alpha.0-20250601-939a65f46 → 0.14.0-alpha.0-20250602-37f27bb02

package/src/clusters/commissioner-control.ts

@@ -23,7 +23,7 @@ import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
 
 export namespace CommissionerControl {
     /**
-     * @see {@link MatterSpecification.v14.Core} § 11.26.4.1
+     * @see {@link MatterSpecification.v141.Core} § 11.26.4.1
      */
     export const SupportedDeviceCategory = {
         /**
@@ -32,7 +32,7 @@ export namespace CommissionerControl {
          * The FabricSynchronization bit shall be set to 1 if and only if the server supports commissioning nodes that
          * support Fabric Synchronization.
          *
-         * @see {@link MatterSpecification.v14.Core} § 11.26.4.1.1
+         * @see {@link MatterSpecification.v141.Core} § 11.26.4.1.1
          */
         fabricSynchronization: BitFlag(0)
     };
@@ -40,7 +40,7 @@ export namespace CommissionerControl {
     /**
      * Input to the CommissionerControl requestCommissioningApproval command
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.26.6.1
+     * @see {@link MatterSpecification.v141.Core} § 11.26.6.1
      */
     export const TlvRequestCommissioningApprovalRequest = TlvObject({
         requestId: TlvField(0, TlvUInt64),
@@ -52,14 +52,14 @@ export namespace CommissionerControl {
     /**
      * Input to the CommissionerControl requestCommissioningApproval command
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.26.6.1
+     * @see {@link MatterSpecification.v141.Core} § 11.26.6.1
      */
     export interface RequestCommissioningApprovalRequest extends TypeFromSchema<typeof TlvRequestCommissioningApprovalRequest> {}
 
     /**
      * Input to the CommissionerControl commissionNode command
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.26.6.5
+     * @see {@link MatterSpecification.v141.Core} § 11.26.6.5
      */
     export const TlvCommissionNodeRequest = TlvObject({
         requestId: TlvField(0, TlvUInt64),
@@ -69,7 +69,7 @@ export namespace CommissionerControl {
     /**
      * Input to the CommissionerControl commissionNode command
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.26.6.5
+     * @see {@link MatterSpecification.v141.Core} § 11.26.6.5
      */
     export interface CommissionNodeRequest extends TypeFromSchema<typeof TlvCommissionNodeRequest> {}
 
@@ -90,7 +90,7 @@ export namespace CommissionerControl {
      *
      * The parameters for ReverseOpenCommissioningWindow command are as follows:
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.26.6.8
+     * @see {@link MatterSpecification.v141.Core} § 11.26.6.8
      */
     export const TlvReverseOpenCommissioningWindowResponse = TlvObject({
         commissioningTimeout: TlvField(0, TlvUInt16),
@@ -117,14 +117,14 @@ export namespace CommissionerControl {
      *
      * The parameters for ReverseOpenCommissioningWindow command are as follows:
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.26.6.8
+     * @see {@link MatterSpecification.v141.Core} § 11.26.6.8
      */
     export interface ReverseOpenCommissioningWindowResponse extends TypeFromSchema<typeof TlvReverseOpenCommissioningWindowResponse> {}
 
     /**
      * Body of the CommissionerControl commissioningRequestResult event
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.26.7.1
+     * @see {@link MatterSpecification.v141.Core} § 11.26.7.1
      */
     export const TlvCommissioningRequestResultEvent = TlvObject({
         requestId: TlvField(0, TlvUInt64),
@@ -136,7 +136,7 @@ export namespace CommissionerControl {
     /**
      * Body of the CommissionerControl commissioningRequestResult event
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.26.7.1
+     * @see {@link MatterSpecification.v141.Core} § 11.26.7.1
      */
     export interface CommissioningRequestResultEvent extends TypeFromSchema<typeof TlvCommissioningRequestResultEvent> {}
 
@@ -156,7 +156,7 @@ export namespace CommissionerControl {
              * A client shall NOT send the RequestCommissioningApproval command if the intended node to be commissioned
              * does not conform to any of the values specified in SupportedDeviceCategories.
              *
-             * @see {@link MatterSpecification.v14.Core} § 11.26.5.1
+             * @see {@link MatterSpecification.v141.Core} § 11.26.5.1
              */
             supportedDeviceCategories: Attribute(
                 0x0,
@@ -187,7 +187,7 @@ export namespace CommissionerControl {
              *
              * The parameters for RequestCommissioningApproval command are as follows:
              *
-             * @see {@link MatterSpecification.v14.Core} § 11.26.6.1
+             * @see {@link MatterSpecification.v141.Core} § 11.26.6.1
              */
             requestCommissioningApproval: Command(
                 0x0,
@@ -218,7 +218,7 @@ export namespace CommissionerControl {
              *
              * The parameters for CommissionNode command are as follows:
              *
-             * @see {@link MatterSpecification.v14.Core} § 11.26.6.5
+             * @see {@link MatterSpecification.v141.Core} § 11.26.6.5
              */
             commissionNode: Command(
                 0x1,
@@ -240,7 +240,7 @@ export namespace CommissionerControl {
              *   presenting the Commissioner Control Cluster. Clients SHOULD send the CommissionNode command immediately
              *   upon receiving a CommissioningRequestResult event.
              *
-             * @see {@link MatterSpecification.v14.Core} § 11.26.7.1
+             * @see {@link MatterSpecification.v141.Core} § 11.26.7.1
              */
             commissioningRequestResult: Event(
                 0x0,
@@ -258,7 +258,7 @@ export namespace CommissionerControl {
      *
      * The generalized flow supported by the Commissioner Control Cluster can be seen in the following diagram.
      *
-     * @see {@link MatterSpecification.v14.Core} § 11.26
+     * @see {@link MatterSpecification.v141.Core} § 11.26
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}
 

package/src/clusters/concentration-measurement.ts

@@ -17,7 +17,7 @@ export namespace ConcentrationMeasurement {
     /**
      * These are optional features supported by ConcentrationMeasurementCluster.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 2.10.4
+     * @see {@link MatterSpecification.v141.Cluster} § 2.10.4
      */
     export enum Feature {
         /**
@@ -66,7 +66,7 @@ export namespace ConcentrationMeasurement {
     /**
      * Where mentioned, Billion refers to 10, Trillion refers to 1012 (short scale).
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 2.10.5.1
+     * @see {@link MatterSpecification.v141.Cluster} § 2.10.5.1
      */
     export enum MeasurementUnit {
         /**
@@ -111,7 +111,7 @@ export namespace ConcentrationMeasurement {
     }
 
     /**
-     * @see {@link MatterSpecification.v14.Cluster} § 2.10.5.3
+     * @see {@link MatterSpecification.v141.Cluster} § 2.10.5.3
      */
     export enum LevelValue {
         /**
@@ -141,7 +141,7 @@ export namespace ConcentrationMeasurement {
     }
 
     /**
-     * @see {@link MatterSpecification.v14.Cluster} § 2.10.5.2
+     * @see {@link MatterSpecification.v141.Cluster} § 2.10.5.2
      */
     export enum MeasurementMedium {
         /**
@@ -172,7 +172,7 @@ export namespace ConcentrationMeasurement {
              * A value of null indicates that the measurement is unknown or outside the valid range. MinMeasuredValue
              * and MaxMeasuredValue define the valid range for MeasuredValue.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 2.10.6.1
+             * @see {@link MatterSpecification.v141.Cluster} § 2.10.6.1
              */
             measuredValue: Attribute(0x0, TlvNullable(TlvFloat), { default: null }),
 
@@ -180,7 +180,7 @@ export namespace ConcentrationMeasurement {
              * Indicates the minimum value of MeasuredValue that is capable of being measured. A MinMeasuredValue of
              * null indicates that the MinMeasuredValue is not defined.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 2.10.6.2
+             * @see {@link MatterSpecification.v141.Cluster} § 2.10.6.2
              */
             minMeasuredValue: Attribute(0x1, TlvNullable(TlvFloat), { default: null }),
 
@@ -188,7 +188,7 @@ export namespace ConcentrationMeasurement {
              * Indicates the maximum value of MeasuredValue that is capable of being measured. A MaxMeasuredValue of
              * null indicates that the MaxMeasuredValue is not defined.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 2.10.6.3
+             * @see {@link MatterSpecification.v141.Cluster} § 2.10.6.3
              */
             maxMeasuredValue: Attribute(0x2, TlvNullable(TlvFloat), { default: null }),
 
@@ -196,14 +196,14 @@ export namespace ConcentrationMeasurement {
              * Indicates the range of error or deviation that can be found in MeasuredValue and PeakMeasuredValue. This
              * is considered a +/- value and should be considered to be in MeasurementUnit.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 2.10.6.8
+             * @see {@link MatterSpecification.v141.Cluster} § 2.10.6.8
              */
             uncertainty: OptionalAttribute(0x7, TlvFloat),
 
             /**
              * Indicates the unit of MeasuredValue. See MeasurementUnitEnum.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 2.10.6.9
+             * @see {@link MatterSpecification.v141.Cluster} § 2.10.6.9
              */
             measurementUnit: FixedAttribute(0x8, TlvEnum<MeasurementUnit>())
         }
@@ -218,14 +218,14 @@ export namespace ConcentrationMeasurement {
              * Indicates the maximum value of MeasuredValue that has been measured during the PeakMeasuredValueWindow.
              * If this attribute is provided, the PeakMeasuredValueWindow attribute shall also be provided.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 2.10.6.4
+             * @see {@link MatterSpecification.v141.Cluster} § 2.10.6.4
              */
             peakMeasuredValue: Attribute(0x3, TlvNullable(TlvFloat), { default: null }),
 
             /**
              * Indicates the window of time used for determining the PeakMeasuredValue. The value is in seconds.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 2.10.6.5
+             * @see {@link MatterSpecification.v141.Cluster} § 2.10.6.5
              */
             peakMeasuredValueWindow: Attribute(0x4, TlvUInt32.bound({ max: 604800 }), { default: 1 })
         }
@@ -241,7 +241,7 @@ export namespace ConcentrationMeasurement {
              * AverageMeasuredValueWindow. If this attribute is provided, the AverageMeasuredValueWindow attribute shall
              * also be provided.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 2.10.6.6
+             * @see {@link MatterSpecification.v141.Cluster} § 2.10.6.6
              */
             averageMeasuredValue: Attribute(0x5, TlvNullable(TlvFloat), { default: null }),
 
@@ -249,7 +249,7 @@ export namespace ConcentrationMeasurement {
              * This attribute shall represent the window of time used for determining the AverageMeasuredValue. The
              * value is in seconds.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 2.10.6.7
+             * @see {@link MatterSpecification.v141.Cluster} § 2.10.6.7
              */
             averageMeasuredValueWindow: Attribute(0x6, TlvUInt32.bound({ max: 604800 }), { default: 1 })
         }
@@ -263,7 +263,7 @@ export namespace ConcentrationMeasurement {
             /**
              * Indicates the level of the substance detected. See LevelValueEnum.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 2.10.6.11
+             * @see {@link MatterSpecification.v141.Cluster} § 2.10.6.11
              */
             levelValue: Attribute(0xa, TlvEnum<LevelValue>(), { default: LevelValue.Unknown })
         }
@@ -313,7 +313,7 @@ export namespace ConcentrationMeasurement {
             /**
              * Indicates the medium in which MeasuredValue is being measured. See MeasurementMediumEnum.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 2.10.6.10
+             * @see {@link MatterSpecification.v141.Cluster} § 2.10.6.10
              */
             measurementMedium: FixedAttribute(0x9, TlvEnum<MeasurementMedium>())
         },

package/src/clusters/content-app-observer.ts

@@ -11,6 +11,8 @@ import { Command } from "../cluster/Cluster.js";
 import { TlvField, TlvOptionalField, TlvObject } from "../tlv/TlvObject.js";
 import { TlvString } 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 { TlvEnum } from "../tlv/TlvNumber.js";
 import { Identity } from "#general";
 import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
@@ -19,20 +21,20 @@ export namespace ContentAppObserver {
     /**
      * Input to the ContentAppObserver contentAppMessage command
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 6.12.5.1
+     * @see {@link MatterSpecification.v141.Cluster} § 6.12.5.1
      */
     export const TlvContentAppMessageRequest = TlvObject({
         /**
          * This field shall indicate content app-specific data.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 6.12.5.1.1
+         * @see {@link MatterSpecification.v141.Cluster} § 6.12.5.1.1
          */
         data: TlvField(0, TlvString.bound({ maxLength: 500 })),
 
         /**
          * This optional field shall indicate a content app-specific hint to the encoding of the data.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 6.12.5.1.2
+         * @see {@link MatterSpecification.v141.Cluster} § 6.12.5.1.2
          */
         encodingHint: TlvOptionalField(1, TlvString.bound({ maxLength: 100 }))
     });
@@ -40,12 +42,12 @@ export namespace ContentAppObserver {
     /**
      * Input to the ContentAppObserver contentAppMessage command
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 6.12.5.1
+     * @see {@link MatterSpecification.v141.Cluster} § 6.12.5.1
      */
     export interface ContentAppMessageRequest extends TypeFromSchema<typeof TlvContentAppMessageRequest> {}
 
     /**
-     * @see {@link MatterSpecification.v14.Cluster} § 6.12.4.1
+     * @see {@link MatterSpecification.v141.Cluster} § 6.12.4.1
      */
     export enum Status {
         /**
@@ -59,30 +61,45 @@ export namespace ContentAppObserver {
         UnexpectedData = 1
     }
 
+    /**
+     * Thrown for cluster status code {@link Status.UnexpectedData}.
+     *
+     * @see {@link MatterSpecification.v141.Cluster} § 6.12.4.1
+     */
+    export class UnexpectedDataError extends StatusResponseError {
+        constructor(
+            message = "Data field in command was not understood by the Observer",
+            code = GlobalStatus.Failure,
+            clusterCode = Status.UnexpectedData
+        ) {
+            super(message, code, clusterCode);
+        }
+    }
+
     /**
      * This command shall be generated in response to ContentAppMessage command.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 6.12.5.2
+     * @see {@link MatterSpecification.v141.Cluster} § 6.12.5.2
      */
     export const TlvContentAppMessageResponse = TlvObject({
         /**
          * This field shall indicate the status of the command which resulted in this response.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 6.12.5.2.1
+         * @see {@link MatterSpecification.v141.Cluster} § 6.12.5.2.1
          */
         status: TlvField(0, TlvEnum<Status>()),
 
         /**
          * This optional field shall indicate content app-specific data.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 6.12.5.2.2
+         * @see {@link MatterSpecification.v141.Cluster} § 6.12.5.2.2
          */
         data: TlvOptionalField(1, TlvString.bound({ maxLength: 500 })),
 
         /**
          * This optional field shall indicate a content app-specific hint to the encoding of the data.
          *
-         * @see {@link MatterSpecification.v14.Cluster} § 6.12.5.2.3
+         * @see {@link MatterSpecification.v141.Cluster} § 6.12.5.2.3
          */
         encodingHint: TlvOptionalField(2, TlvString.bound({ maxLength: 100 }))
     });
@@ -90,7 +107,7 @@ export namespace ContentAppObserver {
     /**
      * This command shall be generated in response to ContentAppMessage command.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 6.12.5.2
+     * @see {@link MatterSpecification.v141.Cluster} § 6.12.5.2
      */
     export interface ContentAppMessageResponse extends TypeFromSchema<typeof TlvContentAppMessageResponse> {}
 
@@ -110,7 +127,7 @@ export namespace ContentAppObserver {
              *
              * This command returns a ContentAppMessage Response.
              *
-             * @see {@link MatterSpecification.v14.Cluster} § 6.12.5.1
+             * @see {@link MatterSpecification.v141.Cluster} § 6.12.5.1
              */
             contentAppMessage: Command(0x0, TlvContentAppMessageRequest, 0x1, TlvContentAppMessageResponse)
         }
@@ -155,7 +172,7 @@ export namespace ContentAppObserver {
      * does not recognize. A Content App SHOULD ignore the Data field values in responses when the EncodingHint value is
      * blank or not recognized.
      *
-     * @see {@link MatterSpecification.v14.Cluster} § 6.12
+     * @see {@link MatterSpecification.v141.Cluster} § 6.12
      */
     export interface Cluster extends Identity<typeof ClusterInstance> {}