Variable ClusterInstanceConst

Type declaration

• Readonlyattributes: {
      currentState: Attribute<ValveConfigurationAndControl.ValveState | null, any>;
      defaultOpenDuration: WritableAttribute<number | null, any>;
      openDuration: Attribute<number | null, any>;
      remainingDuration: Attribute<number | null, any>;
      targetState: Attribute<ValveConfigurationAndControl.ValveState | null, any>;
      valveFault: OptionalAttribute<TypeFromPartialBitSchema, any>;
  }

  • ReadonlycurrentState: Attribute<ValveConfigurationAndControl.ValveState | null, any>

    Indicates the current state of the valve.

    A value of null shall indicate that the current state is not known.

    See

    MatterSpecification.v13.Cluster § 4.6.7.5

  • ReadonlydefaultOpenDuration: WritableAttribute<number | null, any>

    Indicates the default duration, in seconds, for which the valve will remain open, if the OpenDuration field is not present in the Open command.

    A value of null shall indicate the duration is not set, meaning that the valve will remain open until closed by the user or some other automation.

    See

    MatterSpecification.v13.Cluster § 4.6.7.2

  • ReadonlyopenDuration: Attribute<number | null, any>

    Indicates the total duration, in seconds, for which the valve will remain open for this current opening.

    A value of null shall indicate the duration is not set, meaning that the valve will remain open until closed by the user or some other automation.

    See

    MatterSpecification.v13.Cluster § 4.6.7.1

  • ReadonlyremainingDuration: Attribute<number | null, any>

    Indicates the remaining duration, in seconds, until the valve closes. Null:

    • When OpenDuration is null, or

    • When the valve is closed.

    The value of this attribute shall only be reported in the following cases:

    • When it changes from null to any other value and vice versa, or

    • When it changes to 0, or

    • When it increases, or

    • When the closing time changes.

    Meaning that clients SHOULD NOT rely on the reporting of this attribute in order to keep track of the remaining duration, due to this attribute not being reported during regular countdown.

    When reading this attribute it shall return the remaining duration, in seconds, until the valve closes.

    When the value of this attribute counts down to 0, the valve shall automatically transition to its closed position. The behavior of transitioning to the closed position shall match the behavior described in the Close command.

    See

    MatterSpecification.v13.Cluster § 4.6.7.4

  • ReadonlytargetState: Attribute<ValveConfigurationAndControl.ValveState | null, any>

    Indicates the target state, while changing the state, of the valve.

    A value of null shall indicate that no target position is set, since the change in state is either done or failed.

    See

    MatterSpecification.v13.Cluster § 4.6.7.6

  • ReadonlyvalveFault: OptionalAttribute<TypeFromPartialBitSchema, any>

    Indicates any faults registered by the valve.

    See

    MatterSpecification.v13.Cluster § 4.6.7.10

• Readonlycommands: {
      close: Command<void, void, any>;
      open: Command<TypeFromFields, void, any>;
  }

  • Readonlyclose: Command<void, void, any>

    This command is used to set the valve to its closed position.

    See

    MatterSpecification.v13.Cluster § 4.6.8.2

  • Readonlyopen: Command<TypeFromFields, void, any>

    This command is used to set the valve to its open position.

    See

    MatterSpecification.v13.Cluster § 4.6.8.1

• Readonlyevents: {
      valveFault: OptionalEvent<TypeFromFields, any>;
      valveStateChanged: OptionalEvent<TypeFromFields, any>;
  }

  • ReadonlyvalveFault: OptionalEvent<TypeFromFields, any>

    This event shall be generated when the valve registers or clears a fault, e.g. not being able to transition to the requested target level or state.

    See

    MatterSpecification.v13.Cluster § 4.6.9.2

  • ReadonlyvalveStateChanged: OptionalEvent<TypeFromFields, any>

    This event shall be generated when the valve state changed. For level changes, after the end of movement, for state changes when the new state has been reached.

    See

    MatterSpecification.v13.Cluster § 4.6.9.1

• Readonlyextensions: readonly [{
      component: {
          attributes: {
              autoCloseTime: Attribute<number | bigint | null, any>;
          };
      };
      flags: {
          timeSync: true;
      };
  }, {
      component: {
          attributes: {
              currentLevel: Attribute<number | null, any>;
              defaultOpenLevel: OptionalWritableAttribute<number, any>;
              levelStep: OptionalFixedAttribute<number, any>;
              targetLevel: Attribute<number | null, any>;
          };
      };
      flags: {
          level: true;
      };
  }]

  This metadata controls which ValveConfigurationAndControlCluster elements matter.js activates for specific feature combinations.

• Readonlyfeatures: {
      level: BitFlag;
      timeSync: BitFlag;
  }

  • Readonlylevel: BitFlag

    Level

    This feature shall indicate that the valve is capable of being adjusted to a specific position, as a percentage, of its full range of motion.

    See

    MatterSpecification.v13.Cluster § 4.6.4.2

  • ReadonlytimeSync: BitFlag

    TimeSync

    This feature shall indicate that the valve uses Time Synchronization and UTC time to indicate duration and auto close time.

    This feature shall NOT be supported unless the device supports the Time Synchronization cluster.

    See

    MatterSpecification.v13.Cluster § 4.6.4.1

• Readonlyid: 129

• Readonlyname: "ValveConfigurationAndControl"

• Readonlyrevision: 1