Variable ClusterInstanceConst

Type declaration

• Readonlyattributes: {
      countdownTime: OptionalAttribute<number | null, any>;
      currentPhase: Attribute<number | null, any>;
      operationalError: Attribute<., any>;
      operationalState: Attribute<number, any>;
      operationalStateList: Attribute<.[], any>;
      phaseList: Attribute<string[] | null, any>;
  }

  • ReadonlycountdownTime: OptionalAttribute<number | null, any>

    Indicates the estimated time left before the operation is completed, in seconds. Changes to this value shall NOT be reported in a subscription (note the C Quality). A Client implementation may periodically poll this value to ensure alignment of any local rendering of the CountdownTime with the device provided value.

    A value of 0 means that the operation has completed.

    When this attribute is null, that represents that there is no time currently defined until operation completion. This may happen, for example, because no operation is in progress or because the completion time is unknown.

    See

    MatterSpecification.v13.Cluster § 1.14.5.3

  • ReadonlycurrentPhase: Attribute<number | null, any>

    This attribute represents the current phase of operation being performed by the server. This shall be the positional index representing the value from the set provided in the PhaseList Attribute, where the first item in that list is an index of 0. Thus, this attribute shall have a maximum value that is "length(PhaseList) - 1".

    Null if the PhaseList attribute is null or if the PhaseList attribute is an empty list.

    See

    MatterSpecification.v13.Cluster § 1.14.5.2

  • ReadonlyoperationalError: Attribute<., any>

    This attribute shall specify the details of any current error condition being experienced on the device when the OperationalState attribute is populated with Error. Please see ErrorStateStruct for general requirements on the population of this attribute.

    When there is no error detected, this shall have an ErrorStateID of NoError.

    See

    MatterSpecification.v13.Cluster § 1.14.5.6

  • ReadonlyoperationalState: Attribute<number, any>

    This attribute specifies the current operational state of a device. This shall be populated with a valid OperationalStateID from the set of values in the OperationalStateList Attribute.

    See

    MatterSpecification.v13.Cluster § 1.14.5.5

  • ReadonlyoperationalStateList: Attribute<.[], any>

    This attribute describes the set of possible operational states that the device exposes. An operational state is a fundamental device state such as Running or Error. Details of the phase of a device when, for example, in a state of Running are provided by the CurrentPhase attribute.

    All devices shall, at a minimum, expose the set of states matching the commands that are also supported by the cluster instance, in addition to Error. The set of possible device states are defined in the OperationalStateEnum. A device type requiring implementation of this cluster shall define the set of states that are applicable to that specific device type.

    See

    MatterSpecification.v13.Cluster § 1.14.5.4

  • ReadonlyphaseList: Attribute<string[] | null, any>

    Indicates a list of names of different phases that the device can go through for the selected function or mode. The list may not be in sequence order. For example in a washing machine this could include items such as "pre-soak", "rinse", and "spin". These phases are manufacturer specific and may change when a different function or mode is selected.

    A null value indicates that the device does not present phases during its operation. When this attribute’s value is null, the CurrentPhase attribute shall also be set to null.

    See

    MatterSpecification.v13.Cluster § 1.14.5.1

• Readonlycommands: {
      goHome: OptionalCommand<void, ., any>;
  }

  • ReadonlygoHome: OptionalCommand<void, ., any>

    On receipt of this command, the device shall start seeking the charging dock, if possible in the current state of the device.

    If this command is received when already in the SeekingCharger state the device shall respond with an OperationalCommandResponse command with an ErrorStateID of NoError but the command shall have no other effect.

    A device that receives this command in any state which does not allow seeking the charger, such as Charging or Docked, shall respond with an OperationalCommandResponse command with an ErrorStateID of CommandInvalidInState and shall have no other effect.

    Otherwise, on success:

    • The OperationalState attribute shall be set to SeekingCharger.

    • The device shall respond with an OperationalCommandResponse command with an ErrorStateID of NoError.

    See

    MatterSpecification.v13.Cluster § 7.4.5.1

• Readonlyevents: {
      operationalError: Event<., any>;
      operationCompletion: OptionalEvent<., any>;
  }

  • ReadonlyoperationalError: Event<., any>

    This event is generated when a reportable error condition is detected. A device that generates this event shall also set the OperationalState attribute to Error, indicating an error condition.

    This event shall contain the following fields:

    See

    MatterSpecification.v13.Cluster § 1.14.7.1

  • ReadonlyoperationCompletion: OptionalEvent<., any>

    This event is generated when the overall operation ends, successfully or otherwise. For example, the completion of a cleaning operation in a Robot Vacuum Cleaner, or the completion of a wash cycle in a Washing Machine.

    This event shall contain the following fields:

    See

    MatterSpecification.v13.Cluster § 1.14.7.2

• Readonlyid: 97

• Readonlyname: "RvcOperationalState"

• Readonlyrevision: 2