PumpConfigurationAndControlTrait.Attributes
interface PumpConfigurationAndControlTrait.Attributes
PumpConfigurationAndControl |
API for the PumpConfigurationAndControl trait. |
Attributes for the PumpConfigurationAndControl cluster.
Summary
Public properties |
|
|---|---|
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 |
PumpConfigurationAndControlTrait.ControlModeEnum? |
The current effective control mode of the pump as defined in |
PumpConfigurationAndControlTrait.OperationModeEnum? |
The current effective operation mode of the pump as defined in |
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 |
UShort? |
The maximum flow the pump can achieve when it is working with the |
Short? |
The maximum pressure the pump can achieve when it is working with the |
UShort? |
The maximum speed the pump can achieve when it is working with the |
Short? |
The maximum temperature the pump can maintain in the system when it is working with the |
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 |
UShort? |
The minimum flow the pump can achieve when it is working with the |
Short? |
The minimum pressure the pump can achieve when it is working with the |
UShort? |
The minimum speed the pump can achieve when it is working with the |
Short? |
The minimum temperature the pump can maintain in the system when it is working with the |
PumpConfigurationAndControlTrait.OperationModeEnum? |
The operation mode of the pump as defined in |
UInt? |
The actual power consumption of the pump in watts. |
PumpConfigurationAndControlTrait.PumpStatusBitmap? |
The activity status of the pump functions as listed in |
UShort? |
The actual speed of the pump measured in RPM. |
Public properties
acceptedCommandList
val acceptedCommandList: List<UInt>
A list of client-generated commands which are supported by this cluster server instance.
attributeList
val attributeList: List<UInt>
A list of the attribute IDs of the attributes supported by the cluster instance.
capacity
val capacity: Short?
The actual capacity of the pump as a percentage of the effective maximum setpoint value. It is updated dynamically as the speed of the pump changes. The valid range is 0 % to 163.835%, with 0.005 % granularity. Although this attribute is a signed value, values less than zero have no physical meaning.
Access type: Read
clusterRevision
val clusterRevision: UShort
The revision of the server cluster specification supported by the cluster instance.
controlMode
val controlMode: PumpConfigurationAndControlTrait.ControlModeEnum?
The control mode of the pump as defined in ControlModeEnum.
Access type: Write
effectiveControlMode
val effectiveControlMode: PumpConfigurationAndControlTrait.ControlModeEnum?
The current effective control mode of the pump as defined in ControlModeEnum.
Access type: Read
effectiveOperationMode
val effectiveOperationMode: PumpConfigurationAndControlTrait.OperationModeEnum?
The current effective operation mode of the pump as defined in OperationModeEnum.
Access type: Read
featureMap
val featureMap: PumpConfigurationAndControlTrait.Feature
Whether the server supports zero or more optional cluster features. A cluster feature is a set of cluster elements that are mandatory or optional for a defined feature of the cluster. If a cluster feature is supported by the cluster instance, then the corresponding bit is set to 1, otherwise the bit is set to 0 (zero).
generatedCommandList
val generatedCommandList: List<UInt>
A list of server-generated commands (server to client) which are supported by this cluster server instance.
lifetimeEnergyConsumed
val lifetimeEnergyConsumed: UInt?
The accumulated energy consumption through the entire lifetime of the pump in kWh. The value of this attribute is updated dynamically as the energy consumption of the pump increases. If it rises above the maximum value, it rolls over and starts again at 0. This attribute is writeable, in order to allow setting to an appropriate value after maintenance. The valid range is 0 kWh to 4,294,967,294 kWh.
Access type: Write
lifetimeRunningHours
val lifetimeRunningHours: UInt?
Specifies the accumulated number of hours that the pump has been powered and the motor has been running. It is updated dynamically as it increases. It is preserved over power cycles of the pump. If lifeTimeRunningHours rises above maximum value, it rolls over and starts again at 0. This attribute is writeable, in order to allow setting to an appropriate value after maintenance. The valid range is 0 to 16,777,214 hrs.
Access type: Write
maxCompPressure
val maxCompPressure: Short?
The maximum compensated pressure the pump can achieve when it is working with the controlMode attribute set to ProportionalPressure. The valid range for this attribute is -3,276.7 kPa to 3,276.7 kPa, in steps of 0.1 kPa.
Access type: Read
maxConstFlow
val maxConstFlow: UShort?
The maximum flow the pump can achieve when it is working with the controlMode attribute set to ConstantFlow. The valid range is 0 m3/h to 6,553.4 m3/h, insteps of 0.1 m3/h.
Access type: Read
maxConstPressure
val maxConstPressure: Short?
The maximum pressure the pump can achieve when it is working with the controlMode attribute set to ConstantPressure. The valid range is -3,276.7 kPa to 3,276.7 kPa, in steps of 0.1 kPa.
Access type: Read
maxConstSpeed
val maxConstSpeed: UShort?
The maximum speed the pump can achieve when it is working with the controlMode attribute set to ConstantSpeed. The valid range is 0 to 65,534 RPM, in steps of 1 RPM.
Access type: Read
maxConstTemp
val maxConstTemp: Short?
The maximum temperature the pump can maintain in the system when it is working with the controlMode attribute set to ConstantTemperature. The valid range is -273.15 °C to 327.67 °C, in steps of 0.01 °C.
Access type: Read
maxFlow
val maxFlow: UShort?
The maximum flow the pump can achieve. It is a physical limit, and does not apply to any specific control mode or operation mode. The valid range is 0 m3/h to 6,553.4 m3/h, in steps of 0.1 m3/h.
Access type: Read
maxPressure
val maxPressure: Short?
The maximum pressure the pump can achieve. It is a physical limit, and does not apply to any specific control mode or operation mode. The valid range is -3,276.7 kPa to 3,276.7 kPa, in steps of 0.1 kPa.
Access type: Read
maxSpeed
val maxSpeed: UShort?
The maximum speed the pump can achieve. It is a physical limit, and does not apply to any specific control mode or operation mode. The valid range is 0 to 65,534 RPM, in steps of 1 RPM.
Access type: Read
minCompPressure
val minCompPressure: Short?
The minimum compensated pressure the pump can achieve when it is working with the controlMode attribute set to ProportionalPressure. The valid range is -3,276.7 kPa to 3,276.7 kPa, in steps of 0.1 kPa.
Access type: Read
minConstFlow
val minConstFlow: UShort?
The minimum flow the pump can achieve when it is working with the controlMode attribute set to ConstantFlow. The valid range is 0 m3/h to 6,553.4 m3/h, in steps of 0.1 m3/h.
Access type: Read
minConstPressure
val minConstPressure: Short?
The minimum pressure the pump can achieve when it is working with the controlMode attribute set to ConstantPressure. The valid range is -3,276.7 kPa to 3,276.7 kPa, in steps of 0.1 kPa.
Access type: Read
minConstSpeed
val minConstSpeed: UShort?
The minimum speed the pump can achieve when it is working with the controlMode attribute set to ConstantSpeed. The valid range is 0 to 65,534 RPM, in steps of 1 RPM.
Access type: Read
minConstTemp
val minConstTemp: Short?
The minimum temperature the pump can maintain in the system when it is working with the controlMode attribute set to ConstantTemperature. The valid range is -273.15 °C to 327.67 °C, in steps of 0.01 °C.
Access type: Read
operationMode
val operationMode: PumpConfigurationAndControlTrait.OperationModeEnum?
The operation mode of the pump as defined in OperationModeEnum.
Access type: Write
power
val power: UInt?
The actual power consumption of the pump in watts. The value of this attribute is updated dynamically as the power consumption of the pump changes. The valid range is 0 to 16,777,214 watts.
Access type: Read
pumpStatus
val pumpStatus: PumpConfigurationAndControlTrait.PumpStatusBitmap?
The activity status of the pump functions as listed in PumpStatusBitmap.
Access type: Read