@matter/types 0.13.0-alpha.0-20250329-cd36948da → 0.13.0-alpha.0-20250330-df5a17eba

package/dist/esm/clusters/service-area.js

@@ -25,14 +25,14 @@ var ServiceArea;
     /**
      * This field shall represent the map’s identifier.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.17.5.3.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.17.5.3.1
      */
     mapId: TlvField(0, TlvUInt32),
     /**
      * This field shall represent a human understandable map description. For example: "Main Floor", or "Second
      * Level".
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.17.5.3.2
+     * @see {@link MatterSpecification.v14.Cluster} § 1.17.5.3.2
      */
     name: TlvField(1, TlvString.bound({ maxLength: 64 }))
   });
@@ -48,14 +48,14 @@ var 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.v13.Cluster} § 1.17.5.5.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.17.5.5.1
      */
     areaId: TlvField(0, TlvUInt32),
     /**
      * This field shall indicate the operational status of the device regarding the area indicated by the AreaID
      * field.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.17.5.5.2
+     * @see {@link MatterSpecification.v14.Cluster} § 1.17.5.5.2
      */
     status: TlvField(1, TlvEnum()),
     /**
@@ -70,7 +70,7 @@ var ServiceArea;
      *
      * Null if the Status field is not set to Completed or Skipped.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.17.5.5.3
+     * @see {@link MatterSpecification.v14.Cluster} § 1.17.5.5.3
      */
     totalOperationalTime: TlvOptionalField(2, TlvNullable(TlvUInt32)),
     /**
@@ -84,7 +84,7 @@ var 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.v13.Cluster} § 1.17.5.5.4
+     * @see {@link MatterSpecification.v14.Cluster} § 1.17.5.5.4
      */
     estimatedTime: TlvOptionalField(3, TlvNullable(TlvUInt32))
   });
@@ -95,7 +95,7 @@ var 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.v13.Cluster} § 1.17.5.1.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.17.5.1.1
      */
     landmarkTag: TlvField(0, TlvUInt8),
     /**
@@ -111,7 +111,7 @@ var 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.v13.Cluster} § 1.17.5.1.2
+     * @see {@link MatterSpecification.v14.Cluster} § 1.17.5.1.2
      */
     relativePositionTag: TlvField(1, TlvNullable(TlvUInt8))
   });
@@ -129,7 +129,7 @@ var 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.v13.Cluster} § 1.17.5.2.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.17.5.2.1
      */
     locationInfo: TlvField(0, TlvNullable(TlvLocationdesc)),
     /**
@@ -140,7 +140,7 @@ var 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.v13.Cluster} § 1.17.5.2.2
+     * @see {@link MatterSpecification.v14.Cluster} § 1.17.5.2.2
      */
     landmarkInfo: TlvField(1, TlvNullable(ServiceArea2.TlvLandmarkInfo))
   });
@@ -148,7 +148,7 @@ var ServiceArea;
     /**
      * This field shall represent the identifier of the area.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.17.5.4.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.17.5.4.1
      */
     areaId: TlvField(0, TlvUInt32),
     /**
@@ -158,7 +158,7 @@ var 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.v13.Cluster} § 1.17.5.4.2
+     * @see {@link MatterSpecification.v14.Cluster} § 1.17.5.4.2
      */
     mapId: TlvField(1, TlvNullable(TlvUInt32)),
     /**
@@ -172,7 +172,7 @@ var ServiceArea;
      * 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.v13.Cluster} § 1.17.5.4.3
+     * @see {@link MatterSpecification.v14.Cluster} § 1.17.5.4.3
      */
     areaInfo: TlvField(2, ServiceArea2.TlvAreaInfo)
   });
@@ -184,7 +184,7 @@ var 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.v13.Cluster} § 1.17.7.1.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.17.7.1.1
      */
     newAreas: TlvField(0, TlvArray(TlvUInt32))
   });
@@ -207,7 +207,7 @@ var 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.v13.Cluster} § 1.17.7.2.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.17.7.2.1
      */
     status: TlvField(0, TlvEnum()),
     statusText: TlvField(1, TlvString.bound({ maxLength: 256 }))
@@ -218,7 +218,7 @@ var ServiceArea;
      *
      * The SkippedArea field shall match an entry in the SupportedAreas list.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.17.7.3.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.17.7.3.1
      */
     skippedArea: TlvField(0, TlvUInt32)
   });
@@ -240,7 +240,7 @@ var 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.v13.Cluster} § 1.17.7.4.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.17.7.4.1
      */
     status: TlvField(0, TlvEnum()),
     statusText: TlvField(1, TlvString.bound({ maxLength: 256 }))
@@ -293,7 +293,7 @@ var 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.v13.Cluster} § 1.17.6.2
+       * @see {@link MatterSpecification.v14.Cluster} § 1.17.6.2
        */
       supportedMaps: Attribute(1, TlvArray(ServiceArea2.TlvMap, { maxLength: 255 }), { default: [] })
     }
@@ -339,7 +339,7 @@ var 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.v13.Cluster} § 1.17.6.6
+       * @see {@link MatterSpecification.v14.Cluster} § 1.17.6.6
        */
       progress: Attribute(5, TlvArray(ServiceArea2.TlvProgress, { maxLength: 255 }), { default: [] })
     }
@@ -355,7 +355,7 @@ var ServiceArea;
        * This feature indicates whether this device allows changing the selected areas, by using the SelectAreas
        * command, while operating.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.17.4.1
+       * @see {@link MatterSpecification.v14.Cluster} § 1.17.4.1
        */
       selectWhileRunning: BitFlag(0),
       /**
@@ -416,7 +416,7 @@ var ServiceArea;
        *
        *   • AreaID=3, LocationName="hallway", MapID=2
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.17.6.1
+       * @see {@link MatterSpecification.v14.Cluster} § 1.17.6.1
        */
       supportedAreas: Attribute(0, TlvArray(ServiceArea2.TlvArea, { maxLength: 255 }), { default: [] }),
       /**
@@ -434,7 +434,7 @@ var ServiceArea;
        *
        *   • each entry in this list shall have a unique value
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.17.6.3
+       * @see {@link MatterSpecification.v14.Cluster} § 1.17.6.3
        */
       selectedAreas: Attribute(2, TlvArray(TlvUInt32), { default: [] }),
       /**
@@ -462,7 +462,7 @@ var 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.v13.Cluster} § 1.17.6.4
+       * @see {@link MatterSpecification.v14.Cluster} § 1.17.6.4
        */
       currentArea: OptionalAttribute(3, TlvNullable(TlvUInt32), { default: null }),
       /**
@@ -494,7 +494,7 @@ var ServiceArea;
        * 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.v13.Cluster} § 1.17.6.5
+       * @see {@link MatterSpecification.v14.Cluster} § 1.17.6.5
        */
       estimatedEndTime: Attribute(4, TlvNullable(TlvEpochS), { default: null })
     },
@@ -504,7 +504,7 @@ var ServiceArea;
        *
        * On receipt of this command the device shall respond with a SelectAreasResponse command.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.17.7.1
+       * @see {@link MatterSpecification.v14.Cluster} § 1.17.7.1
        */
       selectAreas: Command(0, ServiceArea2.TlvSelectAreasRequest, 1, ServiceArea2.TlvSelectAreasResponse),
       /**
@@ -516,7 +516,7 @@ var ServiceArea;
        *
        * On receipt of this command the device shall respond with a SkipAreaResponse command.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.17.7.3
+       * @see {@link MatterSpecification.v14.Cluster} § 1.17.7.3
        */
       skipArea: OptionalCommand(2, ServiceArea2.TlvSkipAreaRequest, 3, ServiceArea2.TlvSkipAreaResponse)
     },