ValveConfigurationAndControl

interface ValveConfigurationAndControl : ValveConfigurationAndControlTrait.Attributes, MatterTrait, Updatable, ValveConfigurationAndControlCommands


API for the ValveConfigurationAndControl trait. This trait provides an interface for configuring a valve.

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Inherited functions

From com.google.home.TraitStateInvalidation
suspend Unit
From com.google.home.Updatable
suspend ValveConfigurationAndControl

Creates a mutable copy of an object and calls the given function to mutate it, then saves it and returns a new immutable copy with the updated state.

From com.google.home.matter.standard.ValveConfigurationAndControlCommands
suspend Unit

Set the valve to its closed position.

suspend Unit

Set the valve to its open position.

Inherited properties

From com.google.home.Trait
From com.google.home.matter.standard.ValveConfigurationAndControlTrait.Attributes
List<UInt>

A list of client-generated commands which are supported by this cluster server instance.

List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.

ULong?

The UTC time when the valve will close, depending on value of the openDuration attribute.

UShort

The revision of the server cluster specification supported by the cluster instance.

UByte?

The current level of the valve as a percentage value, between fully closed and fully open.

ValveConfigurationAndControlTrait.ValveStateEnum?

The current state of the valve.

UInt?

The default duration, in seconds, for which the valve will remain open, if a value for the openDuration parameter is not present in the Open command.

UByte?

The default value used for the targetLevel attribute, when a valve transitions from the closed to the open state, caused by an Open command, if a value for the targetLevel parameter isn't present in the Open command.

ValveConfigurationAndControlTrait.Feature

Whether the server supports zero or more optional cluster features.

List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.

UByte?

The step size supported by the valve.

UInt?

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

UInt?

The remaining duration, in seconds, until the valve closes.

UByte?

The target level of the valve as a percentage value, between fully closed and fully open.

ValveConfigurationAndControlTrait.ValveStateEnum?

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

ValveConfigurationAndControlTrait.ValveFaultBitmap?

Any faults registered by the valve.

Public functions

Public properties