Matter Cluster 512 — Pump Configuration and Control Cluster

Cluster Identity

Revision history

Shadow Path Format

Cluster 512 values in the device shadow use this format:

endpoint_id / 512 / attribute_id

Example:

{
  "1/512/0": 1
}

Cluster 512 Features

The FeatureMap attribute (1/512/65532) is a bitmap. Each bit set means the device implements that feature and the attributes and commands that depend on it.

Example: FeatureMap = 0 means no optional feature is enabled; 127 means every feature listed above is enabled.

Data Types

ControlModeEnum

OperationModeEnum

PumpStatusBitmap (bitmap)

Cluster 512 Attributes

Cluster 512 defines 24 attributes plus the global attributes. Conformance: M mandatory, O optional, a feature code means "mandatory when that feature is present", square brackets mean "optional when …".

Global attributes

Attribute Details

Attribute 0 / 0x0000 — MaxPressure

Path example:

1/512/0

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.

Example:

{
  "1/512/0": 1
}

Attribute 1 / 0x0001 — MaxSpeed

Path example:

1/512/1

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.

Example:

{
  "1/512/1": 1
}

Attribute 2 / 0x0002 — MaxFlow

Path example:

1/512/2

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^3/h to 6,553.4 m^3/h (steps of 0.1 m^3/h). Null if the value is invalid.

Example:

{
  "1/512/2": 1
}

Attribute 3 / 0x0003 — MinConstPressure

Path example:

1/512/3

This attribute specifies the minimum pressure the pump can achieve when it is working with the ControlMode attribute set to ConstantPressure. Valid range is –3,276.7 kPa to 3,276.7 kPa (steps of 0.1 kPa). Null if the value is invalid.

Example:

{
  "1/512/3": 1
}

Attribute 4 / 0x0004 — MaxConstPressure

Path example:

1/512/4

This attribute specifies the maximum pressure the pump can achieve when it is working with the ControlMode attribute set to ConstantPressure. Valid range is –3,276.7 kPa to 3,276.7 kPa (steps of 0.1 kPa). Null if the value is invalid.

Example:

{
  "1/512/4": 1
}

Attribute 5 / 0x0005 — MinCompPressure

Path example:

1/512/5

This attribute specifies the minimum compensated pressure the pump can achieve when it is working with the ControlMode attribute set to ProportionalPressure. Valid range is –3,276.7 kPa to 3,276.7 kPa (steps of 0.1 kPa). Null if the value is invalid.

Example:

{
  "1/512/5": 1
}

Attribute 6 / 0x0006 — MaxCompPressure

Path example:

1/512/6

This attribute specifies the maximum compensated pressure the pump can achieve when it is working with the ControlMode attribute set to ProportionalPressure. Valid range is –3,276.7 kPa to 3,276.7 kPa (steps of 0.1 kPa). Null if the value is invalid.

Example:

{
  "1/512/6": 1
}

Attribute 7 / 0x0007 — MinConstSpeed

Path example:

1/512/7

This attribute specifies the minimum speed the pump can achieve when it is working with the ControlMode attribute set to ConstantSpeed. Valid range is 0 to 65,534 RPM (steps of 1 RPM). Null if the value is invalid.

Example:

{
  "1/512/7": 1
}

Attribute 8 / 0x0008 — MaxConstSpeed

Path example:

1/512/8

This attribute specifies the maximum speed the pump can achieve when it is working with the ControlMode attribute set to ConstantSpeed. Valid range is 0 to 65,534 RPM (steps of 1 RPM). Null if the value is invalid.

Example:

{
  "1/512/8": 1
}

Attribute 9 / 0x0009 — MinConstFlow

Path example:

1/512/9

This attribute specifies the minimum flow the pump can achieve when it is working with the ControlMode attribute set to ConstantFlow. Valid range is 0 m^3/h to 6,553.4 m^3/h (steps of 0.1 m^3/h). Null if the value is invalid.

Example:

{
  "1/512/9": 1
}

Attribute 10 / 0x000A — MaxConstFlow

Path example:

1/512/10

This attribute specifies the maximum flow the pump can achieve when it is working with the ControlMode attribute set to ConstantFlow. Valid range is 0 m^3/h to 6,553.4 m^3/h (steps of 0.1 m^3/h). Null if the value is invalid.

Example:

{
  "1/512/10": 1
}

Attribute 11 / 0x000B — MinConstTemp

Path example:

1/512/11

This attribute specifies the minimum temperature the pump can maintain in the system when it is working with the ControlMode attribute set to ConstantTemperature. Valid range is –273.15 °C to 327.67 °C (steps of 0.01 °C). Null if the value is invalid.

Example:

{
  "1/512/11": 1
}

Attribute 12 / 0x000C — MaxConstTemp

Path example:

1/512/12

This attribute specifies the maximum temperature the pump can maintain in the system when it is working with the ControlMode attribute set to ConstantTemperature. MaxConstTemp is greater than or equal to MinConstTemp Valid range is –273.15 °C to 327.67 °C (steps of 0.01 °C). Null if the value is invalid.

Example:

{
  "1/512/12": 1
}

Attribute 16 / 0x0010 — PumpStatus

Path example:

1/512/16

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

Bits (PumpStatusBitmap):

Example:

{
  "1/512/16": 0
}

Attribute 17 / 0x0011 — EffectiveOperationMode

Path example:

1/512/17

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 Attribute and ControlMode Attribute for a detailed description of the operation and control of the pump.

Values (OperationModeEnum):

Example:

{
  "1/512/17": 0
}

Attribute 18 / 0x0012 — EffectiveControlMode

Path example:

1/512/18

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 must match the behavior of the pump. - A remote sensor is used as the sensor for regulation of the pump.

Values (ControlModeEnum):

Example:

{
  "1/512/18": 0
}

Attribute 19 / 0x0013 — Capacity

Path example:

1/512/19

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

Example:

{
  "1/512/19": 1
}

Attribute 20 / 0x0014 — Speed

Path example:

1/512/20

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.

Example:

{
  "1/512/20": 1
}

Attribute 21 / 0x0015 — LifetimeRunningHours

Path example:

1/512/21

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

Example:

{
  "1/512/21": 0
}

Attribute 22 / 0x0016 — Power

Path example:

1/512/22

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.

Example:

{
  "1/512/22": 1
}

Attribute 23 / 0x0017 — LifetimeEnergyConsumed

Path example:

1/512/23

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.

Example:

{
  "1/512/23": 0
}

Attribute 32 / 0x0020 — OperationMode

Path example:

1/512/32

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

Values (OperationModeEnum):

Example:

{
  "1/512/32": 0
}

Attribute 33 / 0x0021 — ControlMode

Path example:

1/512/33

This attribute specifies the control mode of the pump as defined in ControlModeEnum. See 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.

Values (ControlModeEnum):

Example:

{
  "1/512/33": 0
}

Attribute 34 / 0x0022 — AlarmMask

Path example:

1/512/34

No condensed specification text is available for AlarmMask; use the type, conformance and constraint below together with the cluster description above.

Example:

{
  "1/512/34": 0
}

Cluster 512 Commands

Cluster 512 defines no commands. It is read (and, for writable attributes, written) through attribute access only.

Cluster 512 Events

Event 0 — SupplyVoltageLow

This event has no fields.

Event 1 — SupplyVoltageHigh

This event has no fields.

Event 2 — PowerMissingPhase

This event has no fields.

Event 3 — SystemPressureLow

This event has no fields.

Event 4 — SystemPressureHigh

This event has no fields.

Event 5 — DryRunning

This event has no fields.

Event 6 — MotorTemperatureHigh

This event has no fields.

Event 7 — PumpMotorFatalFailure

This event has no fields.

Event 8 — ElectronicTemperatureHigh

This event has no fields.

Event 9 — PumpBlocked

This event has no fields.

Event 10 — SensorFailure

This event has no fields.

Event 11 — ElectronicNonFatalFailure

This event has no fields.

Event 12 — ElectronicFatalFailure

This event has no fields.

Event 13 — GeneralFault

This event has no fields.

Event 14 — Leakage

This event has no fields.

Event 15 — AirDetection

This event has no fields.

Event 16 — TurbineOperation

This event has no fields.

SmartphoneKey Notes

• Cluster 512 is not currently exposed by SmartphoneKey devices. This page documents the Matter 1.6.1 specification so that future devices can be interpreted without changes to the backend.
• Shadow paths follow endpoint/512/attribute; attribute values that the device reports as unreadable are written as n/a.
• Attribute IDs, command IDs and enum values on this page come from the CSA Matter 1.6.1 data model; descriptions are condensed from the specification text.