@matter/types 0.17.4 → 0.17.5-alpha.0-20260702-a2cd6f764

package/src/clusters/service-area.d.ts

@@ -30,7 +30,7 @@ import type { Locationdesc } from "../globals/Locationdesc.js";
  * The area semantic data is a combination of semantic tags, indicating one or more of the following: the building
  * floor, area type, landmark, and relative position.
  *
- * @see {@link MatterSpecification.v151.Cluster} § 1.17
+ * @see {@link MatterSpecification.v16.Cluster} § 1.17
  */
 export declare namespace ServiceArea {
     /**
@@ -44,7 +44,7 @@ export declare namespace ServiceArea {
     export const name: "ServiceArea";
 
     /**
-     * The cluster revision assigned by {@link MatterSpecification.v151.Cluster}.
+     * The cluster revision assigned by {@link MatterSpecification.v16.Cluster}.
      */
     export const revision: 2;
 
@@ -107,7 +107,7 @@ export declare namespace ServiceArea {
          *
          *   - AreaID=3, LocationName="hallway", MapID=2
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.6.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.6.1
          */
         supportedAreas: Area[];
 
@@ -126,7 +126,7 @@ export declare namespace ServiceArea {
          *
          *   - each entry in this list shall have a unique value
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.6.3
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.6.3
          */
         selectedAreas: number[];
 
@@ -154,7 +154,7 @@ export declare namespace ServiceArea {
          * If not null, the value of this attribute shall match the AreaID field of an entry on the SupportedAreas
          * attribute's list.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.6.4
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.6.4
          */
         currentArea?: number | null;
 
@@ -186,7 +186,7 @@ export declare namespace ServiceArea {
          *     > NOTE: If the device is capable of pausing its operation, this attribute may be set to null, to indicate
          *       that completion time is unknown, or increment the value while being in the paused state.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.6.5
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.6.5
          */
         estimatedEndTime?: number | null;
     }
@@ -241,7 +241,7 @@ export declare namespace ServiceArea {
          * The SupportedMaps attribute list changes mentioned above SHOULD NOT be allowed while the device is operating,
          * to reduce the impact on the clients, and the potential confusion for the users.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.6.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.6.2
          */
         supportedMaps: Map[];
     }
@@ -288,7 +288,7 @@ export declare namespace ServiceArea {
          *   UnableToCompleteOperation error from that cluster specification). The clients SHOULD then read the Progress
          *   attribute, and indicate which areas have been successfully serviced (marked as completed).
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.6.6
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.6.6
          */
         progress: Progress[];
     }
@@ -348,7 +348,7 @@ export declare namespace ServiceArea {
          *
          *   - AreaID=3, LocationName="hallway", MapID=2
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.6.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.6.1
          */
         supportedAreas: Area[];
 
@@ -367,7 +367,7 @@ export declare namespace ServiceArea {
          *
          *   - each entry in this list shall have a unique value
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.6.3
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.6.3
          */
         selectedAreas: number[];
 
@@ -395,7 +395,7 @@ export declare namespace ServiceArea {
          * If not null, the value of this attribute shall match the AreaID field of an entry on the SupportedAreas
          * attribute's list.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.6.4
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.6.4
          */
         currentArea: number | null;
 
@@ -427,7 +427,7 @@ export declare namespace ServiceArea {
          *     > NOTE: If the device is capable of pausing its operation, this attribute may be set to null, to indicate
          *       that completion time is unknown, or increment the value while being in the paused state.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.6.5
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.6.5
          */
         estimatedEndTime: number | null;
 
@@ -477,7 +477,7 @@ export declare namespace ServiceArea {
          * The SupportedMaps attribute list changes mentioned above SHOULD NOT be allowed while the device is operating,
          * to reduce the impact on the clients, and the potential confusion for the users.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.6.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.6.2
          */
         supportedMaps: Map[];
 
@@ -519,7 +519,7 @@ export declare namespace ServiceArea {
          *   UnableToCompleteOperation error from that cluster specification). The clients SHOULD then read the Progress
          *   attribute, and indicate which areas have been successfully serviced (marked as completed).
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.6.6
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.6.6
          */
         progress: Progress[];
     }
@@ -533,7 +533,7 @@ export declare namespace ServiceArea {
          *
          * On receipt of this command the device shall respond with a SelectAreasResponse command.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.7.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.7.1
          */
         selectAreas(request: SelectAreasRequest): MaybePromise<SelectAreasResponse>;
 
@@ -543,7 +543,7 @@ export declare namespace ServiceArea {
          *
          * On receipt of this command the device shall respond with a SkipAreaResponse command.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.7.3
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.7.3
          */
         skipArea(request: SkipAreaRequest): MaybePromise<SkipAreaResponse>;
     }
@@ -563,7 +563,7 @@ export declare namespace ServiceArea {
     /**
      * These are optional features supported by ServiceAreaCluster.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.17.4
+     * @see {@link MatterSpecification.v16.Cluster} § 1.17.4
      */
     export enum Feature {
         /**
@@ -572,7 +572,7 @@ export declare namespace ServiceArea {
          * This feature indicates whether this device allows changing the selected areas, by using the SelectAreas
          * command, while operating.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.4.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.4.1
          */
         SelectWhileRunning = "SelectWhileRunning",
 
@@ -594,7 +594,7 @@ export declare namespace ServiceArea {
     /**
      * This is a struct representing an area known to the server.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.17.5.4
+     * @see {@link MatterSpecification.v16.Cluster} § 1.17.5.4
      */
     export class Area {
         constructor(values?: Partial<Area>);
@@ -602,7 +602,7 @@ export declare namespace ServiceArea {
         /**
          * This field shall represent the identifier of the area.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.5.4.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.5.4.1
          */
         areaId: number;
 
@@ -613,7 +613,7 @@ export declare namespace ServiceArea {
          * If the SupportedMaps attribute is not empty, this field shall match the MapID field of an entry from the
          * SupportedMaps attribute's list. If the SupportedMaps attribute is empty, this field shall be null.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.5.4.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.5.4.2
          */
         mapId: number | null;
 
@@ -628,7 +628,7 @@ export declare namespace ServiceArea {
          * > NOTE: If any entries on the SupportedAreas attribute's list have the AreaInfo field missing the semantic
          *   data, the client may remind the user to assign the respective data.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.5.4.3
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.5.4.3
          */
         areaInfo: AreaInfo;
     }
@@ -636,7 +636,7 @@ export declare namespace ServiceArea {
     /**
      * This is a struct representing a map.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.17.5.3
+     * @see {@link MatterSpecification.v16.Cluster} § 1.17.5.3
      */
     export class Map {
         constructor(values?: Partial<Map>);
@@ -644,7 +644,7 @@ export declare namespace ServiceArea {
         /**
          * This field shall represent the map's identifier.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.5.3.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.5.3.1
          */
         mapId: number;
 
@@ -653,7 +653,7 @@ export declare namespace ServiceArea {
          *
          * For example: "Main Floor", or "Second Level".
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.5.3.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.5.3.2
          */
         name: string;
     }
@@ -661,7 +661,7 @@ export declare namespace ServiceArea {
     /**
      * This is a struct indicating the progress.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.17.5.5
+     * @see {@link MatterSpecification.v16.Cluster} § 1.17.5.5
      */
     export class Progress {
         constructor(values?: Partial<Progress>);
@@ -670,7 +670,7 @@ export declare namespace ServiceArea {
          * This field shall indicate the identifier of the area, and the identifier shall be an entry in the
          * SupportedAreas attribute's list.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.5.5.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.5.5.1
          */
         areaId: number;
 
@@ -678,7 +678,7 @@ export declare namespace ServiceArea {
          * This field shall indicate the operational status of the device regarding the area indicated by the AreaID
          * field.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.5.5.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.5.5.2
          */
         status: OperationalStatus;
 
@@ -694,7 +694,7 @@ export declare namespace ServiceArea {
          *
          * Null if the Status field is not set to Completed or Skipped.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.5.5.3
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.5.5.3
          */
         totalOperationalTime?: number | null;
 
@@ -709,7 +709,7 @@ export declare namespace ServiceArea {
          * After initializing the ProgressStruct instance, the server SHOULD NOT change the value of this field, except
          * when repopulating the entire instance, to avoid excessive reporting of the Progress attribute changes.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.5.5.4
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.5.5.4
          */
         estimatedTime?: number | null;
     }
@@ -719,7 +719,7 @@ export declare namespace ServiceArea {
      *
      * On receipt of this command the device shall respond with a SelectAreasResponse command.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.17.7.1
+     * @see {@link MatterSpecification.v16.Cluster} § 1.17.7.1
      */
     export class SelectAreasRequest {
         constructor(values?: Partial<SelectAreasRequest>);
@@ -731,7 +731,7 @@ export declare namespace ServiceArea {
          * specific areas, and the operation will not allow skipping using the SkipArea Command, otherwise the field
          * shall be a list of unique values that match the AreaID field of entries on the SupportedAreas list.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.7.1.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.7.1.1
          */
         newAreas: number[];
     }
@@ -739,7 +739,7 @@ export declare namespace ServiceArea {
     /**
      * This command is sent by the device on receipt of the SelectAreas command.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.17.7.2
+     * @see {@link MatterSpecification.v16.Cluster} § 1.17.7.2
      */
     export class SelectAreasResponse {
         constructor(values?: Partial<SelectAreasResponse>);
@@ -754,7 +754,7 @@ export declare namespace ServiceArea {
          * Status field is set to InvalidInMode, the StatusText field SHOULD indicate why the request is not allowed,
          * given the current mode of the device, which may involve other clusters.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.7.2.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.7.2.1
          */
         status: SelectAreasStatus;
 
@@ -767,7 +767,7 @@ export declare namespace ServiceArea {
      *
      * On receipt of this command the device shall respond with a SkipAreaResponse command.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.17.7.3
+     * @see {@link MatterSpecification.v16.Cluster} § 1.17.7.3
      */
     export class SkipAreaRequest {
         constructor(values?: Partial<SkipAreaRequest>);
@@ -777,7 +777,7 @@ export declare namespace ServiceArea {
          *
          * The SkippedArea field shall match an entry in the SupportedAreas list.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.7.3.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.7.3.1
          */
         skippedArea: number;
     }
@@ -785,7 +785,7 @@ export declare namespace ServiceArea {
     /**
      * This command is sent by the device on receipt of the SkipArea command.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.17.7.4
+     * @see {@link MatterSpecification.v16.Cluster} § 1.17.7.4
      */
     export class SkipAreaResponse {
         constructor(values?: Partial<SkipAreaResponse>);
@@ -800,7 +800,7 @@ export declare namespace ServiceArea {
          * field is set to InvalidInMode, the StatusText field SHOULD indicate why the request is not allowed, given the
          * current mode of the device, which may involve other clusters.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.7.4.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.7.4.1
          */
         status: SkipAreaStatus;
 
@@ -810,7 +810,7 @@ export declare namespace ServiceArea {
     /**
      * The data from this structure indicates a landmark and position relative to the landmark.
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.17.5.1
+     * @see {@link MatterSpecification.v16.Cluster} § 1.17.5.1
      */
     export class LandmarkInfo {
         constructor(values?: Partial<LandmarkInfo>);
@@ -821,7 +821,7 @@ export declare namespace ServiceArea {
          * This field shall be the ID of a landmark semantic tag, located within the Common Landmark Namespace. For
          * example, this tag may indicate that the area refers to an area next to a table.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.5.1.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.5.1.1
          */
         landmarkTag: number;
 
@@ -838,7 +838,7 @@ export declare namespace ServiceArea {
          * LandmarkTag field. For example, this tag, in conjunction with the LandmarkTag field, may indicate that the
          * area refers to a zone under a table.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.5.1.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.5.1.2
          */
         relativePositionTag: number | null;
     }
@@ -879,7 +879,7 @@ export declare namespace ServiceArea {
      *
      *   - LandmarkInfo field
      *
-     * @see {@link MatterSpecification.v151.Cluster} § 1.17.5.2
+     * @see {@link MatterSpecification.v16.Cluster} § 1.17.5.2
      */
     export class AreaInfo {
         constructor(values?: Partial<AreaInfo>);
@@ -898,7 +898,7 @@ export declare namespace ServiceArea {
          *     semantic tag. With such an area indication, the client can request the device to operate in (or service)
          *     the area located under the table.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.5.2.1
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.5.2.1
          */
         locationInfo: Locationdesc | null;
 
@@ -910,13 +910,13 @@ export declare namespace ServiceArea {
          * located, as indicated by the LandmarkTag and, if not null, by the RelativePositionTag fields, rather than to
          * the entire room or floor where the landmark is located, if those are indicated by the LocationInfo field.
          *
-         * @see {@link MatterSpecification.v151.Cluster} § 1.17.5.2.2
+         * @see {@link MatterSpecification.v16.Cluster} § 1.17.5.2.2
          */
         landmarkInfo: LandmarkInfo | null;
     }
 
     /**
-     * @see {@link MatterSpecification.v151.Cluster} § 1.17.5.6
+     * @see {@link MatterSpecification.v16.Cluster} § 1.17.5.6
      */
     export enum OperationalStatus {
         /**
@@ -944,7 +944,7 @@ export declare namespace ServiceArea {
     }
 
     /**
-     * @see {@link MatterSpecification.v151.Cluster} § 1.17.5.6.1
+     * @see {@link MatterSpecification.v16.Cluster} § 1.17.5.6.1
      */
     export enum SelectAreasStatus {
         /**
@@ -972,7 +972,7 @@ export declare namespace ServiceArea {
     }
 
     /**
-     * @see {@link MatterSpecification.v151.Cluster} § 1.17.5.6.2
+     * @see {@link MatterSpecification.v16.Cluster} § 1.17.5.6.2
      */
     export enum SkipAreaStatus {
         /**