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

package/dist/esm/clusters/actions.js

@@ -92,7 +92,7 @@ var Actions;
     /**
      * This field shall provide an unique identifier used to identify an action.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.14.4.6.1
+     * @see {@link MatterSpecification.v141.Core} § 9.14.4.6.1
      */
     actionId: TlvField(0, TlvUInt16),
     /**
@@ -100,7 +100,7 @@ var Actions;
      * this action. This can be used for identifying the action to the user by the client. Example: "my colorful
      * scene".
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.14.4.6.2
+     * @see {@link MatterSpecification.v141.Core} § 9.14.4.6.2
      */
     name: TlvField(1, TlvString.bound({ maxLength: 128 })),
     /**
@@ -108,14 +108,14 @@ var Actions;
      * SupportedCommands can be used by the client in its UX or logic to determine how to present or use such
      * action. See ActionTypeEnum for details and examples.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.14.4.6.3
+     * @see {@link MatterSpecification.v141.Core} § 9.14.4.6.3
      */
     type: TlvField(2, TlvEnum()),
     /**
      * This field shall provide a reference to the associated endpoint list, which specifies the endpoints on this
      * Node which will be impacted by this ActionID.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.14.4.6.4
+     * @see {@link MatterSpecification.v141.Core} § 9.14.4.6.4
      */
     endpointListId: TlvField(3, TlvUInt16),
     /**
@@ -123,13 +123,13 @@ var Actions;
      * particular action, with a bit set to 1 for each supported command according to the table below. Other bits
      * shall be set to 0.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.14.4.6.5
+     * @see {@link MatterSpecification.v141.Core} § 9.14.4.6.5
      */
     supportedCommands: TlvField(4, TlvBitmap(TlvUInt16, Actions2.CommandBits)),
     /**
      * This field shall indicate the current state of this action.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.14.4.6.6
+     * @see {@link MatterSpecification.v141.Core} § 9.14.4.6.6
      */
     state: TlvField(5, TlvEnum())
   });
@@ -143,7 +143,7 @@ var Actions;
     /**
      * This field shall provide an unique identifier used to identify the endpoint list.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.14.4.7.1
+     * @see {@link MatterSpecification.v141.Core} § 9.14.4.7.1
      */
     endpointListId: TlvField(0, TlvUInt16),
     /**
@@ -151,19 +151,19 @@ var Actions;
      * the set of endpoints in this list. This can be used for identifying the action to the user by the client.
      * Example: "living room".
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.14.4.7.2
+     * @see {@link MatterSpecification.v141.Core} § 9.14.4.7.2
      */
     name: TlvField(1, TlvString.bound({ maxLength: 128 })),
     /**
      * This field shall indicate the type of endpoint list, see EndpointListTypeEnum.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.14.4.7.3
+     * @see {@link MatterSpecification.v141.Core} § 9.14.4.7.3
      */
     type: TlvField(2, TlvEnum()),
     /**
      * This field shall provide a list of endpoint numbers.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.14.4.7.4
+     * @see {@link MatterSpecification.v141.Core} § 9.14.4.7.4
      */
     endpoints: TlvField(3, TlvArray(TlvEndpointNumber, { maxLength: 256 }))
   });
@@ -177,7 +177,7 @@ var Actions;
     /**
      * This field shall indicate the transition time in 1/10th of seconds.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.14.6.2.1
+     * @see {@link MatterSpecification.v141.Core} § 9.14.6.2.1
      */
     transitionTime: TlvField(2, TlvUInt16)
   });
@@ -191,7 +191,7 @@ var Actions;
     /**
      * This field shall indicate the requested duration in seconds.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.14.6.4.1
+     * @see {@link MatterSpecification.v141.Core} § 9.14.6.4.1
      */
     duration: TlvField(2, TlvUInt32)
   });
@@ -209,7 +209,7 @@ var Actions;
     /**
      * This field shall indicate the requested duration in seconds.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.14.6.7.1
+     * @see {@link MatterSpecification.v141.Core} § 9.14.6.7.1
      */
     duration: TlvField(2, TlvUInt32)
   });
@@ -227,7 +227,7 @@ var Actions;
     /**
      * This field shall indicate the requested duration in seconds.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.14.6.10.1
+     * @see {@link MatterSpecification.v141.Core} § 9.14.6.10.1
      */
     duration: TlvField(2, TlvUInt32)
   });
@@ -241,7 +241,7 @@ var Actions;
     /**
      * This field shall indicate the requested duration in seconds.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.14.6.12.1
+     * @see {@link MatterSpecification.v141.Core} § 9.14.6.12.1
      */
     duration: TlvField(2, TlvUInt32)
   });
@@ -249,20 +249,20 @@ var Actions;
     /**
      * This field shall be set to the ActionID of the action which has changed state.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.14.7.1.1
+     * @see {@link MatterSpecification.v141.Core} § 9.14.7.1.1
      */
     actionId: TlvField(0, TlvUInt16),
     /**
      * This field shall be set to the InvokeID which was provided to the most recent command referencing this
      * ActionID.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.14.7.1.2
+     * @see {@link MatterSpecification.v141.Core} § 9.14.7.1.2
      */
     invokeId: TlvField(1, TlvUInt32),
     /**
      * This field shall be set to state that the action has changed to.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.14.7.1.3
+     * @see {@link MatterSpecification.v141.Core} § 9.14.7.1.3
      */
     newState: TlvField(2, TlvEnum())
   });
@@ -275,26 +275,26 @@ var Actions;
     /**
      * This field shall be set to the ActionID of the action which encountered an error.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.14.7.2.1
+     * @see {@link MatterSpecification.v141.Core} § 9.14.7.2.1
      */
     actionId: TlvField(0, TlvUInt16),
     /**
      * This field shall be set to the InvokeID which was provided to the most recent command referencing this
      * ActionID.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.14.7.2.2
+     * @see {@link MatterSpecification.v141.Core} § 9.14.7.2.2
      */
     invokeId: TlvField(1, TlvUInt32),
     /**
      * This field shall be set to state that the action is in at the time of generating the event.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.14.7.2.3
+     * @see {@link MatterSpecification.v141.Core} § 9.14.7.2.3
      */
     newState: TlvField(2, TlvEnum()),
     /**
      * This field shall be set to indicate the reason for non-successful progress of the action.
      *
-     * @see {@link MatterSpecification.v14.Core} § 9.14.7.2.4
+     * @see {@link MatterSpecification.v141.Core} § 9.14.7.2.4
      */
     error: TlvField(3, TlvEnum())
   });
@@ -307,14 +307,14 @@ var Actions;
        * The ActionList attribute holds the list of actions. Each entry shall have an unique ActionID, and its
        * EndpointListID shall exist in the EndpointLists attribute.
        *
-       * @see {@link MatterSpecification.v14.Core} § 9.14.5.1
+       * @see {@link MatterSpecification.v141.Core} § 9.14.5.1
        */
       actionList: Attribute(0, TlvArray(Actions2.TlvAction, { maxLength: 256 }), { default: [] }),
       /**
        * The EndpointLists attribute holds the list of endpoint lists. Each entry shall have an unique
        * EndpointListID.
        *
-       * @see {@link MatterSpecification.v14.Core} § 9.14.5.2
+       * @see {@link MatterSpecification.v141.Core} § 9.14.5.2
        */
       endpointLists: Attribute(1, TlvArray(Actions2.TlvEndpointList, { maxLength: 256 }), { default: [] }),
       /**
@@ -339,7 +339,7 @@ var Actions;
        *       https://domain.example/Matter/bridgev1/Actions/?a=12345 for linking to specific info/editing of the
        *       action with ActionID 0x3039.
        *
-       * @see {@link MatterSpecification.v14.Core} § 9.14.5.3
+       * @see {@link MatterSpecification.v141.Core} § 9.14.5.3
        */
       setupUrl: OptionalAttribute(2, TlvString.bound({ maxLength: 512 }))
     },
@@ -350,7 +350,7 @@ var Actions;
        *
        * Example: recall a scene on a number of lights.
        *
-       * @see {@link MatterSpecification.v14.Core} § 9.14.6.1
+       * @see {@link MatterSpecification.v141.Core} § 9.14.6.1
        */
       instantAction: OptionalCommand(0, Actions2.TlvInstantActionRequest, 0, TlvNoResponse),
       /**
@@ -364,7 +364,7 @@ var Actions;
        *
        * Example: recall a scene on a number of lights, with a specified transition time.
        *
-       * @see {@link MatterSpecification.v14.Core} § 9.14.6.2
+       * @see {@link MatterSpecification.v141.Core} § 9.14.6.2
        */
       instantActionWithTransition: OptionalCommand(
         1,
@@ -382,7 +382,7 @@ var Actions;
        * Example: start a sequence of events such as a wake-up experience involving lights moving through several
        * brightness/color combinations and the window covering gradually opening.
        *
-       * @see {@link MatterSpecification.v14.Core} § 9.14.6.3
+       * @see {@link MatterSpecification.v141.Core} § 9.14.6.3
        */
       startAction: OptionalCommand(2, Actions2.TlvStartActionRequest, 2, TlvNoResponse),
       /**
@@ -393,7 +393,7 @@ var Actions;
        * Example: start a dynamic lighting pattern (such as gradually rotating the colors around the setpoints of
        * the scene) on a set of lights for 1 hour (Duration=3600).
        *
-       * @see {@link MatterSpecification.v14.Core} § 9.14.6.4
+       * @see {@link MatterSpecification.v141.Core} § 9.14.6.4
        */
       startActionWithDuration: OptionalCommand(3, Actions2.TlvStartActionWithDurationRequest, 3, TlvNoResponse),
       /**
@@ -402,7 +402,7 @@ var Actions;
        *
        * Example: stop a dynamic lighting pattern which was previously started with StartAction.
        *
-       * @see {@link MatterSpecification.v14.Core} § 9.14.6.5
+       * @see {@link MatterSpecification.v141.Core} § 9.14.6.5
        */
       stopAction: OptionalCommand(4, Actions2.TlvStopActionRequest, 4, TlvNoResponse),
       /**
@@ -411,7 +411,7 @@ var Actions;
        * Example: pause a dynamic lighting effect (the lights stay at their current color) which was previously
        * started with StartAction.
        *
-       * @see {@link MatterSpecification.v14.Core} § 9.14.6.6
+       * @see {@link MatterSpecification.v141.Core} § 9.14.6.6
        */
       pauseAction: OptionalCommand(5, Actions2.TlvPauseActionRequest, 5, TlvNoResponse),
       /**
@@ -428,7 +428,7 @@ var Actions;
        * after some hours or during a nightly reset, while an Disable would remain in effect until explicitly
        * enabled again).
        *
-       * @see {@link MatterSpecification.v14.Core} § 9.14.6.7
+       * @see {@link MatterSpecification.v141.Core} § 9.14.6.7
        */
       pauseActionWithDuration: OptionalCommand(6, Actions2.TlvPauseActionWithDurationRequest, 6, TlvNoResponse),
       /**
@@ -440,7 +440,7 @@ var Actions;
        * Example: resume a dynamic lighting effect (the lights' colors will change gradually, continuing from the
        * point they were paused).
        *
-       * @see {@link MatterSpecification.v14.Core} § 9.14.6.8
+       * @see {@link MatterSpecification.v141.Core} § 9.14.6.8
        */
       resumeAction: OptionalCommand(7, Actions2.TlvResumeActionRequest, 7, TlvNoResponse),
       /**
@@ -448,7 +448,7 @@ var Actions;
        *
        * Example: enable a motion sensor to control the lights in an area.
        *
-       * @see {@link MatterSpecification.v14.Core} § 9.14.6.9
+       * @see {@link MatterSpecification.v141.Core} § 9.14.6.9
        */
       enableAction: OptionalCommand(8, Actions2.TlvEnableActionRequest, 8, TlvNoResponse),
       /**
@@ -460,7 +460,7 @@ var Actions;
        * Duration field is used to indicated the length of your absence from home. After that period, the presence
        * mimicking behavior will no longer control these lights.
        *
-       * @see {@link MatterSpecification.v14.Core} § 9.14.6.10
+       * @see {@link MatterSpecification.v141.Core} § 9.14.6.10
        */
       enableActionWithDuration: OptionalCommand(9, Actions2.TlvEnableActionWithDurationRequest, 9, TlvNoResponse),
       /**
@@ -468,7 +468,7 @@ var Actions;
        *
        * Example: disable a motion sensor to no longer control the lights in an area.
        *
-       * @see {@link MatterSpecification.v14.Core} § 9.14.6.11
+       * @see {@link MatterSpecification.v141.Core} § 9.14.6.11
        */
       disableAction: OptionalCommand(10, Actions2.TlvDisableActionRequest, 10, TlvNoResponse),
       /**
@@ -480,7 +480,7 @@ var Actions;
        * turning on in the morning while you’re not at home). After this period, the wakeup experience will
        * control the lights as before.
        *
-       * @see {@link MatterSpecification.v14.Core} § 9.14.6.12
+       * @see {@link MatterSpecification.v141.Core} § 9.14.6.12
        */
       disableActionWithDuration: OptionalCommand(11, Actions2.TlvDisableActionWithDurationRequest, 11, TlvNoResponse)
     },
@@ -498,7 +498,7 @@ var Actions;
        *
        *   • one when the transition completed (NewState=Inactive)
        *
-       * @see {@link MatterSpecification.v14.Core} § 9.14.7.1
+       * @see {@link MatterSpecification.v141.Core} § 9.14.7.1
        */
       stateChanged: Event(0, EventPriority.Info, Actions2.TlvStateChangedEvent),
       /**
@@ -526,7 +526,7 @@ var Actions;
        *
        *   • StateChanged (InvokeID=2, NewState=Inactive) upon the execution of the action for the second command
        *
-       * @see {@link MatterSpecification.v14.Core} § 9.14.7.2
+       * @see {@link MatterSpecification.v141.Core} § 9.14.7.2
        */
       actionFailed: Event(1, EventPriority.Info, Actions2.TlvActionFailedEvent)
     }