PumpConfigurationAndControlTrait.ControlModeEnum
enum PumpConfigurationAndControlTrait.ControlModeEnum : Enum, ClusterEnum
| kotlin.Any | ||
| ↳ | kotlin.Enum | |
| ↳ | com.google.home.matter.standard.PumpConfigurationAndControlTrait.ControlModeEnum | |
The various modes of controlling the pump.
Summary
Enum Values |
|
|---|---|
Automatic |
The operation of the pump is automatically optimized to provide the most suitable performance with respect to comfort and energy savings. |
ConstantFlow |
The pump is regulating its speed to maintain a constant flow through the pump. |
ConstantPressure |
The pump is regulating its speed to maintain a constant differential pressure over its flanges. |
ConstantSpeed |
The pump is running at a constant speed. |
ConstantTemperature |
The pump is regulating its speed to maintain a constant temperature. |
ProportionalPressure |
The pump will regulate its speed to maintain a constant differential pressure over its flanges. |
UnknownValue |
The enum value is out of range. |
Public functions |
|
|---|---|
PumpConfigurationAndControlTrait.ControlModeEnum |
Returns the enum constant of this type with the specified name. |
Array<PumpConfigurationAndControlTrait.ControlModeEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Public properties |
|
|---|---|
open String |
Trait identifier of the Matter Cluster that defines the enum Data Type. |
open String |
Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster. |
open ULong |
Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset. |
Enum Values
Automatic
val PumpConfigurationAndControlTrait.ControlModeEnum.Automatic: PumpConfigurationAndControlTrait.ControlModeEnum
The operation of the pump is automatically optimized to provide the most suitable performance with respect to comfort and energy savings.
ConstantFlow
val PumpConfigurationAndControlTrait.ControlModeEnum.ConstantFlow: PumpConfigurationAndControlTrait.ControlModeEnum
The pump is regulating its speed to maintain a constant flow through the pump.
ConstantPressure
val PumpConfigurationAndControlTrait.ControlModeEnum.ConstantPressure: PumpConfigurationAndControlTrait.ControlModeEnum
The pump is regulating its speed to maintain a constant differential pressure over its flanges.
ConstantSpeed
val PumpConfigurationAndControlTrait.ControlModeEnum.ConstantSpeed: PumpConfigurationAndControlTrait.ControlModeEnum
The pump is running at a constant speed.
ConstantTemperature
val PumpConfigurationAndControlTrait.ControlModeEnum.ConstantTemperature: PumpConfigurationAndControlTrait.ControlModeEnum
The pump is regulating its speed to maintain a constant temperature.
ProportionalPressure
val PumpConfigurationAndControlTrait.ControlModeEnum.ProportionalPressure: PumpConfigurationAndControlTrait.ControlModeEnum
The pump will regulate its speed to maintain a constant differential pressure over its flanges.
UnknownValue
val PumpConfigurationAndControlTrait.ControlModeEnum.UnknownValue: PumpConfigurationAndControlTrait.ControlModeEnum
The enum value is out of range. For example, a newer Matter cluster definition may support enum values not yet supported by the Home APIs.
Public functions
valueOf
fun valueOf(value: String): PumpConfigurationAndControlTrait.ControlModeEnum
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if this enum type has no constant with the specified name |
values
fun values(): Array<PumpConfigurationAndControlTrait.ControlModeEnum>
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Public properties
traitId
open val traitId: String
Trait identifier of the Matter Cluster that defines the enum Data Type. Refer to ClusterId.traitId for the format.