PumpConfigurationAndControl

interface PumpConfigurationAndControl : PumpConfigurationAndControlTrait.Attributes, MatterTrait, Updatable


API for the PumpConfigurationAndControl trait. This trait provides an interface for the setup and control of pump devices, and the automatic reporting of pump status information. Note that control of pump speed is handled by the OnOff and LevelControl clusters.

Summary

Nested types

Descriptor enum for this trait's attributes.

Inherited functions

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

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.

Inherited properties

From com.google.home.matter.standard.PumpConfigurationAndControlTrait.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.

Short?

The actual capacity of the pump as a percentage of the effective maximum setpoint value.

UShort

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

PumpConfigurationAndControlTrait.ControlModeEnum?

The control mode of the pump as defined in ControlModeEnum.

PumpConfigurationAndControlTrait.ControlModeEnum?

The current effective control mode of the pump as defined in ControlModeEnum.

PumpConfigurationAndControlTrait.OperationModeEnum?

The current effective operation mode of the pump as defined in OperationModeEnum.

PumpConfigurationAndControlTrait.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.

UInt?

The accumulated energy consumption through the entire lifetime of the pump in kWh.

UInt?

Specifies the accumulated number of hours that the pump has been powered and the motor has been running.

Short?

The maximum compensated pressure the pump can achieve when it is working with the controlMode attribute set to ProportionalPressure.

UShort?

The maximum flow the pump can achieve when it is working with the controlMode attribute set to ConstantFlow.

Short?

The maximum pressure the pump can achieve when it is working with the controlMode attribute set to ConstantPressure.

UShort?

The maximum speed the pump can achieve when it is working with the controlMode attribute set to ConstantSpeed.

Short?

The maximum temperature the pump can maintain in the system when it is working with the controlMode attribute set to ConstantTemperature.

UShort?

The maximum flow the pump can achieve.

Short?

The maximum pressure the pump can achieve.

UShort?

The maximum speed the pump can achieve.

Short?

The minimum compensated pressure the pump can achieve when it is working with the controlMode attribute set to ProportionalPressure.

UShort?

The minimum flow the pump can achieve when it is working with the controlMode attribute set to ConstantFlow.

Short?

The minimum pressure the pump can achieve when it is working with the controlMode attribute set to ConstantPressure.

UShort?

The minimum speed the pump can achieve when it is working with the controlMode attribute set to ConstantSpeed.

Short?

The minimum temperature the pump can maintain in the system when it is working with the controlMode attribute set to ConstantTemperature.

PumpConfigurationAndControlTrait.OperationModeEnum?

The operation mode of the pump as defined in OperationModeEnum.

UInt?

The actual power consumption of the pump in watts.

PumpConfigurationAndControlTrait.PumpStatusBitmap?

The activity status of the pump functions as listed in PumpStatusBitmap.

UShort?

The actual speed of the pump measured in RPM.

From com.google.home.Trait

Public functions

Public properties