@matter/types 0.17.4 → 0.17.5-alpha.0-20260704-9ea70abfa

package/dist/cjs/clusters/diagnostic-logs.d.ts

@@ -21,7 +21,7 @@ import type { Status as GlobalStatus } from "../globals/Status.js";
  * Node-wide and not specific to any subset of Endpoints. When present, this Cluster shall be implemented once for the
  * Node. The Node SHOULD also implement the BDX Initiator and BDX Sender roles as defined in the BDX Protocol.
  *
- * @see {@link MatterSpecification.v151.Core} § 11.11
+ * @see {@link MatterSpecification.v16.Core} § 11.11
  */
 export declare namespace DiagnosticLogs {
     /**
@@ -35,7 +35,7 @@ export declare namespace DiagnosticLogs {
     export const name: "DiagnosticLogs";
 
     /**
-     * The cluster revision assigned by {@link MatterSpecification.v151.Cluster}.
+     * The cluster revision assigned by {@link MatterSpecification.v16.Cluster}.
      */
     export const revision: 1;
 
@@ -53,7 +53,7 @@ export declare namespace DiagnosticLogs {
         /**
          * Reception of this command starts the process of retrieving diagnostic logs from a Node.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.11.5.1
+         * @see {@link MatterSpecification.v16.Core} § 11.11.5.1
          */
         retrieveLogsRequest(request: RetrieveLogsRequest): MaybePromise<RetrieveLogsResponse>;
     }
@@ -68,7 +68,7 @@ export declare namespace DiagnosticLogs {
     /**
      * Reception of this command starts the process of retrieving diagnostic logs from a Node.
      *
-     * @see {@link MatterSpecification.v151.Core} § 11.11.5.1
+     * @see {@link MatterSpecification.v16.Core} § 11.11.5.1
      */
     export class RetrieveLogsRequest {
         constructor(values?: Partial<RetrieveLogsRequest>);
@@ -77,7 +77,7 @@ export declare namespace DiagnosticLogs {
          * This field shall indicate why the diagnostic logs are being retrieved from the Node. A Node may utilize this
          * field to selectively determine the logs to transfer.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.11.5.1.1
+         * @see {@link MatterSpecification.v16.Core} § 11.11.5.1.1
          */
         intent: Intent;
 
@@ -88,7 +88,7 @@ export declare namespace DiagnosticLogs {
          * TransferProtocolEnum of ResponsePayload. If this field is set to ResponsePayload the receiving Node shall
          * only utilize the LogContent field of the RetrieveLogsResponse command to transfer diagnostic log information.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.11.5.1.2
+         * @see {@link MatterSpecification.v16.Core} § 11.11.5.1.2
          */
         requestedProtocol: TransferProtocol;
 
@@ -96,7 +96,7 @@ export declare namespace DiagnosticLogs {
          * This field shall be present if the RequestedProtocol is BDX. The TransferFileDesignator shall be set as the
          * File Designator of the BDX transfer if initiated.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.11.5.1.3
+         * @see {@link MatterSpecification.v16.Core} § 11.11.5.1.3
          */
         transferFileDesignator?: string;
     }
@@ -106,7 +106,7 @@ export declare namespace DiagnosticLogs {
      *
      * The data for this command is shown in the following.
      *
-     * @see {@link MatterSpecification.v151.Core} § 11.11.5.2
+     * @see {@link MatterSpecification.v16.Core} § 11.11.5.2
      */
     export class RetrieveLogsResponse {
         constructor(values?: Partial<RetrieveLogsResponse>);
@@ -114,7 +114,7 @@ export declare namespace DiagnosticLogs {
         /**
          * This field shall indicate the result of an attempt to retrieve diagnostic logs.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.11.5.2.1
+         * @see {@link MatterSpecification.v16.Core} § 11.11.5.2.1
          */
         status: Status;
 
@@ -123,7 +123,7 @@ export declare namespace DiagnosticLogs {
          * SHOULD utilize this field to transfer the newest diagnostic log entries. This field shall be empty if BDX is
          * requested and the Status field has a value of Success.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.11.5.2.2
+         * @see {@link MatterSpecification.v16.Core} § 11.11.5.2.2
          */
         logContent: Bytes;
 
@@ -132,7 +132,7 @@ export declare namespace DiagnosticLogs {
          * maintains a wall clock. When included, the UTCTimeStamp field shall contain the value of the oldest log entry
          * in the diagnostic logs that are being transferred.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.11.5.2.3
+         * @see {@link MatterSpecification.v16.Core} § 11.11.5.2.3
          */
         utcTimeStamp?: number | bigint;
 
@@ -141,13 +141,13 @@ export declare namespace DiagnosticLogs {
          * TimeSinceBoot field shall contain the time of the oldest log entry in the diagnostic logs that are being
          * transferred represented by the number of microseconds since the last time the Node went through a reboot.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.11.5.2.4
+         * @see {@link MatterSpecification.v16.Core} § 11.11.5.2.4
          */
         timeSinceBoot?: number | bigint;
     }
 
     /**
-     * @see {@link MatterSpecification.v151.Core} § 11.11.4.1
+     * @see {@link MatterSpecification.v16.Core} § 11.11.4.1
      */
     export enum Intent {
         /**
@@ -156,7 +156,7 @@ export declare namespace DiagnosticLogs {
          * shall indicate that the purpose of the log request is to retrieve logs for the intention of providing support
          * to an end-user.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.11.4.1.1
+         * @see {@link MatterSpecification.v16.Core} § 11.11.4.1.1
          */
         EndUserSupport = 0,
 
@@ -166,7 +166,7 @@ export declare namespace DiagnosticLogs {
          * shall indicate that the purpose of the log request is to diagnose the network(s) for which the Node is
          * currently commissioned (and/or connected) or has previously been commissioned (and/or connected).
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.11.4.1.2
+         * @see {@link MatterSpecification.v16.Core} § 11.11.4.1.2
          */
         NetworkDiag = 1,
 
@@ -176,13 +176,13 @@ export declare namespace DiagnosticLogs {
          * shall indicate that the purpose of the log request is to retrieve any crash logs that may be present on a
          * Node.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.11.4.1.3
+         * @see {@link MatterSpecification.v16.Core} § 11.11.4.1.3
          */
         CrashLogs = 2
     }
 
     /**
-     * @see {@link MatterSpecification.v151.Core} § 11.11.4.2
+     * @see {@link MatterSpecification.v16.Core} § 11.11.4.2
      */
     export enum Status {
         /**
@@ -190,7 +190,7 @@ export declare namespace DiagnosticLogs {
          *
          * shall be used if diagnostic logs will be or are being transferred.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.11.4.2.1
+         * @see {@link MatterSpecification.v16.Core} § 11.11.4.2.1
          */
         Success = 0,
 
@@ -200,7 +200,7 @@ export declare namespace DiagnosticLogs {
          * shall be used when a BDX session is requested, however, all available logs were provided in a LogContent
          * field.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.11.4.2.2
+         * @see {@link MatterSpecification.v16.Core} § 11.11.4.2.2
          */
         Exhausted = 1,
 
@@ -210,7 +210,7 @@ export declare namespace DiagnosticLogs {
          * shall be used if the Node does not currently have any diagnostic logs of the requested type (Intent) to
          * transfer.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.11.4.2.3
+         * @see {@link MatterSpecification.v16.Core} § 11.11.4.2.3
          */
         NoLogs = 2,
 
@@ -220,7 +220,7 @@ export declare namespace DiagnosticLogs {
          * shall be used if the Node is unable to handle the request (e.g. in the process of another transfer) and the
          * Client SHOULD re-attempt the request later.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.11.4.2.4
+         * @see {@link MatterSpecification.v16.Core} § 11.11.4.2.4
          */
         Busy = 3,
 
@@ -229,7 +229,7 @@ export declare namespace DiagnosticLogs {
          *
          * shall be used if the Node is denying the current transfer of diagnostic logs for any reason.
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.11.4.2.5
+         * @see {@link MatterSpecification.v16.Core} § 11.11.4.2.5
          */
         Denied = 4
     }
@@ -237,7 +237,7 @@ export declare namespace DiagnosticLogs {
     /**
      * Thrown for cluster status code {@link Status.Exhausted}.
      *
-     * @see {@link MatterSpecification.v151.Core} § 11.11.4.2.2
+     * @see {@link MatterSpecification.v16.Core} § 11.11.4.2.2
      */
     export class ExhaustedError extends StatusResponseError {
         constructor(message?: string, code?: GlobalStatus, clusterCode?: number)
@@ -246,7 +246,7 @@ export declare namespace DiagnosticLogs {
     /**
      * Thrown for cluster status code {@link Status.NoLogs}.
      *
-     * @see {@link MatterSpecification.v151.Core} § 11.11.4.2.3
+     * @see {@link MatterSpecification.v16.Core} § 11.11.4.2.3
      */
     export class NoLogsError extends StatusResponseError {
         constructor(message?: string, code?: GlobalStatus, clusterCode?: number)
@@ -255,7 +255,7 @@ export declare namespace DiagnosticLogs {
     /**
      * Thrown for cluster status code {@link Status.Busy}.
      *
-     * @see {@link MatterSpecification.v151.Core} § 11.11.4.2.4
+     * @see {@link MatterSpecification.v16.Core} § 11.11.4.2.4
      */
     export class BusyError extends StatusResponseError {
         constructor(message?: string, code?: GlobalStatus, clusterCode?: number)
@@ -264,14 +264,14 @@ export declare namespace DiagnosticLogs {
     /**
      * Thrown for cluster status code {@link Status.Denied}.
      *
-     * @see {@link MatterSpecification.v151.Core} § 11.11.4.2.5
+     * @see {@link MatterSpecification.v16.Core} § 11.11.4.2.5
      */
     export class DeniedError extends StatusResponseError {
         constructor(message?: string, code?: GlobalStatus, clusterCode?: number)
     }
 
     /**
-     * @see {@link MatterSpecification.v151.Core} § 11.11.4.3
+     * @see {@link MatterSpecification.v16.Core} § 11.11.4.3
      */
     export enum TransferProtocol {
         /**
@@ -279,7 +279,7 @@ export declare namespace DiagnosticLogs {
          *
          * shall be used by a Client to request that logs are transferred using the LogContent attribute of the response
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.11.4.3.1
+         * @see {@link MatterSpecification.v16.Core} § 11.11.4.3.1
          */
         ResponsePayload = 0,
 
@@ -288,7 +288,7 @@ export declare namespace DiagnosticLogs {
          *
          * shall be used by a Client to request that logs are transferred using BDX as defined in BDX Protocol
          *
-         * @see {@link MatterSpecification.v151.Core} § 11.11.4.3.2
+         * @see {@link MatterSpecification.v16.Core} § 11.11.4.3.2
          */
         Bdx = 1
     }

package/dist/cjs/clusters/dishwasher-alarm.d.ts

@@ -17,7 +17,7 @@ import type { MaybePromise } from "@matter/general";
  * This cluster is a derived cluster of the Alarm Base cluster and provides the alarm definition related to dishwasher
  * devices.
  *
- * @see {@link MatterSpecification.v151.Cluster} § 8.4
+ * @see {@link MatterSpecification.v16.Cluster} § 8.4
  */
 export declare namespace DishwasherAlarm {
     /**
@@ -31,7 +31,7 @@ export declare namespace DishwasherAlarm {
     export const name: "DishwasherAlarm";
 
     /**
-     * The cluster revision assigned by {@link MatterSpecification.v151.Cluster}.
+     * The cluster revision assigned by {@link MatterSpecification.v16.Cluster}.
      */
     export const revision: 1;
 
@@ -49,7 +49,7 @@ export declare namespace DishwasherAlarm {
         /**
          * Indicates a bitmap where each bit set in the Mask attribute corresponds to an alarm that shall be enabled.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.15.6.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.15.6.1
          */
         mask: Alarm;
 
@@ -57,7 +57,7 @@ export declare namespace DishwasherAlarm {
          * Indicates a bitmap where each bit shall represent the state of an alarm. The value of true means the alarm is
          * active, otherwise the alarm is inactive.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.15.6.3
+         * @see {@link MatterSpecification.v16.Cluster} § 1.15.6.3
          */
         state: Alarm;
 
@@ -67,7 +67,7 @@ export declare namespace DishwasherAlarm {
          *
          * If an alarm is not supported, the corresponding bit in Mask, Latch, and State shall be false.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.15.6.4
+         * @see {@link MatterSpecification.v16.Cluster} § 1.15.6.4
          */
         supported: Alarm;
     }
@@ -81,7 +81,7 @@ export declare namespace DishwasherAlarm {
          * be latched when set, and will not reset to inactive when the underlying condition which caused the alarm is
          * no longer present, and so requires an explicit reset using the Reset command.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.15.6.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.15.6.2
          */
         latch: Alarm;
     }
@@ -96,7 +96,7 @@ export declare namespace DishwasherAlarm {
         /**
          * Indicates a bitmap where each bit set in the Mask attribute corresponds to an alarm that shall be enabled.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.15.6.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.15.6.1
          */
         mask: Alarm;
 
@@ -104,7 +104,7 @@ export declare namespace DishwasherAlarm {
          * Indicates a bitmap where each bit shall represent the state of an alarm. The value of true means the alarm is
          * active, otherwise the alarm is inactive.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.15.6.3
+         * @see {@link MatterSpecification.v16.Cluster} § 1.15.6.3
          */
         state: Alarm;
 
@@ -114,7 +114,7 @@ export declare namespace DishwasherAlarm {
          *
          * If an alarm is not supported, the corresponding bit in Mask, Latch, and State shall be false.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.15.6.4
+         * @see {@link MatterSpecification.v16.Cluster} § 1.15.6.4
          */
         supported: Alarm;
 
@@ -123,7 +123,7 @@ export declare namespace DishwasherAlarm {
          * be latched when set, and will not reset to inactive when the underlying condition which caused the alarm is
          * no longer present, and so requires an explicit reset using the Reset command.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.15.6.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.15.6.2
          */
         latch: Alarm;
     }
@@ -135,7 +135,7 @@ export declare namespace DishwasherAlarm {
         /**
          * This command allows a client to request that an alarm be enabled or suppressed at the server.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.15.7.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.15.7.2
          */
         modifyEnabledAlarms(request: ModifyEnabledAlarmsRequest): MaybePromise;
     }
@@ -148,7 +148,7 @@ export declare namespace DishwasherAlarm {
          * This command resets active and latched alarms (if possible). Any generated Notify event shall contain fields
          * that represent the state of the server after the command has been processed.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.15.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.15.7.1
          */
         reset(request: ResetRequest): MaybePromise;
     }
@@ -168,7 +168,7 @@ export declare namespace DishwasherAlarm {
         /**
          * This event shall be generated when one or more alarms change state.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.15.8.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.15.8.1
          */
         notify: NotifyEvent;
     }
@@ -183,7 +183,7 @@ export declare namespace DishwasherAlarm {
         /**
          * This event shall be generated when one or more alarms change state.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.15.8.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.15.8.1
          */
         notify: NotifyEvent;
     }
@@ -197,7 +197,7 @@ export declare namespace DishwasherAlarm {
     /**
      * These are optional features supported by DishwasherAlarmCluster.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.15.4
+     * @see {@link MatterSpecification.v16.Cluster} § 1.15.4
      */
     export enum Feature {
         /**
@@ -205,13 +205,13 @@ export declare namespace DishwasherAlarm {
          *
          * This feature indicates that alarms can be reset via the Reset command.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.15.4.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.15.4.1
          */
         Reset = "Reset"
     }
 
     /**
-     * @see {@link MatterSpecification.v151.Cluster} § 8.4.4.1
+     * @see {@link MatterSpecification.v16.Cluster} § 8.4.4.1
      */
     export class Alarm {
         constructor(values?: Partial<Alarm> | number);
@@ -250,7 +250,7 @@ export declare namespace DishwasherAlarm {
     /**
      * This command allows a client to request that an alarm be enabled or suppressed at the server.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.15.7.2
+     * @see {@link MatterSpecification.v16.Cluster} § 1.15.7.2
      */
     export class ModifyEnabledAlarmsRequest {
         constructor(values?: Partial<ModifyEnabledAlarmsRequest>);
@@ -274,7 +274,7 @@ export declare namespace DishwasherAlarm {
          * field from this command. After that the server shall also update the value of its State attribute to reflect
          * the status of the new alarm set as indicated by the new value of the Mask attribute.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.15.7.2.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.15.7.2.1
          */
         mask: Alarm;
     }
@@ -283,7 +283,7 @@ export declare namespace DishwasherAlarm {
      * This command resets active and latched alarms (if possible). Any generated Notify event shall contain fields that
      * represent the state of the server after the command has been processed.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.15.7.1
+     * @see {@link MatterSpecification.v16.Cluster} § 1.15.7.1
      */
     export class ResetRequest {
         constructor(values?: Partial<ResetRequest>);
@@ -294,7 +294,7 @@ export declare namespace DishwasherAlarm {
          * alarms indicated are successfully reset, the response status code shall be SUCCESS, otherwise, the response
          * status code shall be FAILURE.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.15.7.1.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.15.7.1.1
          */
         alarms: Alarm;
     }
@@ -302,7 +302,7 @@ export declare namespace DishwasherAlarm {
     /**
      * This event shall be generated when one or more alarms change state.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.15.8.1
+     * @see {@link MatterSpecification.v16.Cluster} § 1.15.8.1
      */
     export class NotifyEvent {
         constructor(values?: Partial<NotifyEvent>);
@@ -310,14 +310,14 @@ export declare namespace DishwasherAlarm {
         /**
          * This field shall indicate those alarms that have become active.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.15.8.1.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.15.8.1.1
          */
         active: Alarm;
 
         /**
          * This field shall indicate those alarms that have become inactive.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.15.8.1.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.15.8.1.2
          */
         inactive: Alarm;
 
@@ -325,14 +325,14 @@ export declare namespace DishwasherAlarm {
          * This field shall be a copy of the new State attribute value that resulted in the event being generated. That
          * is, this field shall have all the bits in Active set and shall NOT have any of the bits in Inactive set.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.15.8.1.4
+         * @see {@link MatterSpecification.v16.Cluster} § 1.15.8.1.4
          */
         state: Alarm;
 
         /**
          * This field shall be a copy of the Mask attribute when this event was generated.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.15.8.1.3
+         * @see {@link MatterSpecification.v16.Cluster} § 1.15.8.1.3
          */
         mask: Alarm;
     }