Interface State

interface State {
    capacity: null | number;
    controlMode?: PumpConfigurationAndControl.ControlMode;
    effectiveControlMode: PumpConfigurationAndControl.ControlMode;
    effectiveOperationMode: PumpConfigurationAndControl.OperationMode;
    lifetimeEnergyConsumed?: null | number;
    lifetimeRunningHours?: null | number;
    maxFlow: null | number;
    maxPressure: null | number;
    maxSpeed: null | number;
    operationMode: PumpConfigurationAndControl.OperationMode;
    power?: null | number;
    pumpStatus?: TypeFromPartialBitSchema<{
        deviceFault: BitFlag;
        localOverride: BitFlag;
        remoteFlow: BitFlag;
        remotePressure: BitFlag;
        remoteTemperature: BitFlag;
        running: BitFlag;
        speedHigh: BitFlag;
        speedLow: BitFlag;
        supplyFault: BitFlag;
    }>;
    speed?: null | number;
}

Hierarchy

  • StateType
    • State

Properties

capacity controlMode? effectiveControlMode effectiveOperationMode lifetimeEnergyConsumed? lifetimeRunningHours? maxFlow maxPressure maxSpeed operationMode power? pumpStatus? speed?

Properties

Readonlycapacity

capacity: null | number

This attribute specifies 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.

If the value is not available (the measurement or estimation of the speed is done in the pump), this attribute will indicate the null value.

Valid range is 0 % to 163.835% (0.005 % granularity). Although this attribute is a signed value, values of capacity less than zero have no physical meaning.

See

MatterSpecification.v13.Cluster § 4.2.7.17

Optional ReadonlycontrolMode

controlMode?: PumpConfigurationAndControl.ControlMode

This attribute specifies the control mode of the pump as defined in ControlModeEnum.

See the OperationMode attribute for a detailed description of the operation and control of the

pump.

ControlMode may be changed at any time, even when the pump is running. The behavior of the pump at the point of changing is vendor-specific.

In the case a device does not support a specific control mode, the write interaction to this attribute with an unsupported control mode value shall be ignored and a response containing the status of CONSTRAINT_ERROR shall be returned.

See

MatterSpecification.v13.Cluster § 4.2.7.23

ReadonlyeffectiveControlMode

effectiveControlMode: PumpConfigurationAndControl.ControlMode

This attribute specifies the current effective control mode of the pump as defined in ControlModeEnum.

This attribute contains the control mode that currently applies to the pump. It will have the value of the ControlMode attribute, unless one of the following points are true:

• The ControlMode attribute is set to Automatic. In this case, the value of the EffectiveControlMode shall match the behavior of the pump.

• A remote sensor is used as the sensor for regulation of the pump. In this case, EffectiveControlMode will display ConstantPressure, ConstantFlow or ConstantTemperature if the remote sensor is a pressure sensor, a flow sensor or a temperature sensor respectively, regardless of the value of the ControlMode attribute.

In case the ControlMode attribute is not included on the device and no remote sensors are connected, the value of the EffectiveControlMode shall match the vendor-specific behavior of the pump.

See OperationMode and ControlMode attributes for detailed a description of the operation and control of the pump.

See

MatterSpecification.v13.Cluster § 4.2.7.16

ReadonlyeffectiveOperationMode

effectiveOperationMode: PumpConfigurationAndControl.OperationMode

This attribute specifies current effective operation mode of the pump as defined in OperationModeEnum.

The value of the EffectiveOperationMode attribute is the same as the OperationMode attribute, unless one of the following points are true:

• The pump is physically set to run with the local settings

• The LocalOverride bit in the PumpStatus attribute is set,

See OperationMode and ControlMode attributes for a detailed description of the operation and control of the pump.

See

MatterSpecification.v13.Cluster § 4.2.7.15

Optional ReadonlylifetimeEnergyConsumed

lifetimeEnergyConsumed?: null | number

This attribute specifies the accumulated energy consumption of the pump through the entire lifetime of the pump in kWh. The value of the LifetimeEnergyConsumed attribute is updated dynamically as the energy consumption of the pump increases. If LifetimeEnergyConsumed rises above maximum value it “rolls over” and starts at 0 (zero).

This attribute is writeable, in order to allow setting to an appropriate value after maintenance.

Valid range is 0 kWh to 4,294,967,294 kWh.

Null if the value is unknown.

See

MatterSpecification.v13.Cluster § 4.2.7.21

Optional ReadonlylifetimeRunningHours

lifetimeRunningHours?: null | number

This attribute 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 at 0 (zero).

This attribute is writeable, in order to allow setting to an appropriate value after maintenance. If

the value is not available, this attribute will indicate the null value. Valid range is 0 to 16,777,214 hrs.

See

MatterSpecification.v13.Cluster § 4.2.7.19

ReadonlymaxFlow

maxFlow: null | number

This attribute specifies the maximum flow the pump can achieve. It is a physical limit, and does not apply to any specific control mode or operation mode.

Valid range is 0 m/h to 6,553.4 m/h (steps of 0.1 m/h). Null if the value is invalid.

See

MatterSpecification.v13.Cluster § 4.2.7.3

ReadonlymaxPressure

maxPressure: null | number

This attribute specifies the maximum pressure the pump can achieve. It is a physical limit, and does not apply to any specific control mode or operation mode.

Valid range is -3,276.7 kPa to 3,276.7 kPa (steps of 0.1 kPa). Null if the value is invalid.

See

MatterSpecification.v13.Cluster § 4.2.7.1

ReadonlymaxSpeed

maxSpeed: null | number

This attribute specifies the maximum speed the pump can achieve. It is a physical limit, and does not apply to any specific control mode or operation mode.

Valid range is 0 to 65,534 RPM (steps of 1 RPM). Null if the value is invalid.

See

MatterSpecification.v13.Cluster § 4.2.7.2

ReadonlyoperationMode

operationMode: PumpConfigurationAndControl.OperationMode

This attribute specifies the operation mode of the pump as defined in OperationModeEnum.

The actual operating mode of the pump is a result of the setting of the attributes OperationMode, ControlMode and the optional connection of a remote sensor. The operation and control is prioritized as shown in the scheme below:

Priority Scheme of Pump Operation and Control

If this attribute is Maximum, Minimum or Local, the OperationMode attribute decides how the pump is operated.

If this attribute is Normal and a remote sensor is connected to the pump, the type of the remote sensor decides the control mode of the pump. A connected remote pressure sensor will make the pump run in control mode Constant pressure and vice versa for flow and temperature type sensors. This is regardless of the setting of the ControlMode attribute.

If this attribute is Normal and no remote sensor is connected, the control mode of the pump is decided by the ControlMode attribute.

OperationMode may be changed at any time, even when the pump is running. The behavior of the pump at the point of changing the value of this attribute is vendor-specific.

In the case a device does not support a specific operation mode, the write interaction to this attribute with an unsupported operation mode value shall be ignored and a response containing the status of CONSTRAINT_ERROR shall be returned.

See

MatterSpecification.v13.Cluster § 4.2.7.22

Optional Readonlypower

power?: null | number

This attribute specifies 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.

This attribute is read only. If the value is not available (the measurement of power consumption is not done in the pump), this attribute will indicate the null value.

Valid range is 0 to 16,777,214 Watts.

See

MatterSpecification.v13.Cluster § 4.2.7.20

Optional ReadonlypumpStatus

pumpStatus?: TypeFromPartialBitSchema<{
    deviceFault: BitFlag;
    localOverride: BitFlag;
    remoteFlow: BitFlag;
    remotePressure: BitFlag;
    remoteTemperature: BitFlag;
    running: BitFlag;
    speedHigh: BitFlag;
    speedLow: BitFlag;
    supplyFault: BitFlag;
}>

This attribute specifies the activity status of the pump functions as listed in PumpStatusBitmap. Where a pump controller function is active, the corresponding bit shall be set to 1. Where a pump controller function is not active, the corresponding bit shall be set to 0.

Type declaration

  • deviceFault: BitFlag

    A fault related to the system or pump device is detected.

    If this bit is set, it may correspond to an event in the range 2-16, see Events.

    See

    MatterSpecification.v13.Cluster § 4.2.6.1.1

  • localOverride: BitFlag

    Device control is overridden by hardware, such as an external STOP button or via a local HMI.

    While this bit is set, the EffectiveOperationMode is adjusted to Local. Any request changing OperationMode shall generate a FAILURE error status until LocalOverride is cleared on the physical device. When LocalOverride is cleared, the device shall return to the operation mode set in OperationMode.

    See

    MatterSpecification.v13.Cluster § 4.2.6.1.3

  • remoteFlow: BitFlag

    A remote flow sensor is used as the sensor for the regulation of the pump.

    If this bit is set, EffectiveControlMode is ConstantFlow, and the setpoint for the pump is interpreted as a percentage of the range of the remote sensor ([MinMeasuredValue – MaxMeasuredValue]).

    See

    MatterSpecification.v13.Cluster § 4.2.6.1.5

  • remotePressure: BitFlag

    A remote pressure sensor is used as the sensor for the regulation of the pump.

    If this bit is set, EffectiveControlMode is ConstantPressure and the setpoint for the pump is interpreted as a percentage of the range of the remote sensor ([MinMeasuredValue – MaxMeasuredValue]).

    See

    MatterSpecification.v13.Cluster § 4.2.6.1.4

  • remoteTemperature: BitFlag

    A remote temperature sensor is used as the sensor for the regulation of the pump.

    If this bit is set, EffectiveControlMode is ConstantTemperature, and the setpoint for the pump is interpreted as a percentage of the range of the remote sensor ([MinMeasuredValue – MaxMeasuredValue])

    See

    MatterSpecification.v13.Cluster § 4.2.6.1.6

  • running: BitFlag

    Pump is currently running

  • speedHigh: BitFlag

    Setpoint is too high to achieve.

  • speedLow: BitFlag

    Setpoint is too low to achieve.

  • supplyFault: BitFlag

    A fault related to the supply to the pump is detected.

    If this bit is set, it may correspond to an event in the range 0-1 or 13, see Events.

    See

    MatterSpecification.v13.Cluster § 4.2.6.1.2

See

MatterSpecification.v13.Cluster § 4.2.7.14

Optional Readonlyspeed

speed?: null | number

This attribute specifies the actual speed of the pump measured in RPM. It is updated dynamically as the speed of the pump changes.

If the value is not available (the measurement or estimation of the speed is done in the pump), this attribute will indicate the null value.

Valid range is 0 to 65.534 RPM.

See

MatterSpecification.v13.Cluster § 4.2.7.18

Settings

Member Visibility

On This Page

Properties