blob: ac047bc5373e7d7dc0288118fe7739e7d12cfa3b [file] [log] [blame]
<?xml version="1.0"?>
<!--
Copyright (C) Connectivity Standards Alliance (2025). All rights reserved.
The information within this document is the property of the Connectivity
Standards Alliance and its use and disclosure are restricted, except as
expressly set forth herein.
Connectivity Standards Alliance hereby grants you a fully-paid, non-exclusive,
nontransferable, worldwide, limited and revocable license (without the right to
sublicense), under Connectivity Standards Alliance's applicable copyright
rights, to view, download, save, reproduce and use the document solely for your
own internal purposes and in accordance with the terms of the license set forth
herein. This license does not authorize you to, and you expressly warrant that
you shall not: (a) permit others (outside your organization) to use this
document; (b) post or publish this document; (c) modify, adapt, translate, or
otherwise change this document in any manner or create any derivative work
based on this document; (d) remove or modify any notice or label on this
document, including this Copyright Notice, License and Disclaimer. The
Connectivity Standards Alliance does not grant you any license hereunder other
than as expressly stated herein.
Elements of this document may be subject to third party intellectual property
rights, including without limitation, patent, copyright or trademark rights,
and any such third party may or may not be a member of the Connectivity
Standards Alliance. Connectivity Standards Alliance members grant other
Connectivity Standards Alliance members certain intellectual property rights as
set forth in the Connectivity Standards Alliance IPR Policy. Connectivity
Standards Alliance members do not grant you any rights under this license. The
Connectivity Standards Alliance is not responsible for, and shall not be held
responsible in any manner for, identifying or failing to identify any or all
such third party intellectual property rights. Please visit www.csa-iot.org for
more information on how to become a member of the Connectivity Standards
Alliance.
This document and the information contained herein are provided on an “AS IS”
basis and the Connectivity Standards Alliance DISCLAIMS ALL WARRANTIES EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO (A) ANY WARRANTY THAT THE USE OF THE
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OF THIRD PARTIES (INCLUDING
WITHOUT LIMITATION ANY INTELLECTUAL PROPERTY RIGHTS INCLUDING PATENT, COPYRIGHT
OR TRADEMARK RIGHTS); OR (B) ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE, TITLE OR NONINFRINGEMENT. IN NO EVENT WILL THE
CONNECTIVITY STANDARDS ALLIANCE BE LIABLE FOR ANY LOSS OF PROFITS, LOSS OF
BUSINESS, LOSS OF USE OF DATA, INTERRUPTION OF BUSINESS, OR FOR ANY OTHER
DIRECT, INDIRECT, SPECIAL OR EXEMPLARY, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL
DAMAGES OF ANY KIND, IN CONTRACT OR IN TORT, IN CONNECTION WITH THIS DOCUMENT
OR THE INFORMATION CONTAINED HEREIN, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
LOSS OR DAMAGE.
All company, brand and product names in this document may be trademarks that
are the sole property of their respective owners.
This notice and disclaimer must be included on all copies of this document.
Connectivity Standards Alliance
508 Second Street, Suite 206
Davis, CA 95616, USA
:xrefstyle: basic
-->
<cluster xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="types types.xsd cluster cluster.xsd" id="0x0200" name="Pump Configuration and Control Cluster" revision="3">
<revisionHistory>
<revision revision="1" summary="mandatory global ClusterRevision attribute added"/>
<revision revision="2" summary="All Hubs changes"/>
<revision revision="3" summary="New data model format and notation, added additional events"/>
</revisionHistory>
<clusterIds>
<clusterId id="0x0200" name="Pump Configuration and Control"/>
</clusterIds>
<classification hierarchy="base" role="application" picsCode="PCC" scope="Endpoint"/>
<dataTypes>
<enum name="ControlModeAttribute">
<item value="0" name="ConstantSpeed" summary="The pump is running at a constant speed. The setpoint is interpreted as a percentage of the range derived from the [MinConstSpeed – MaxConstSpeed] attributes.">
<mandatoryConform/>
</item>
<item value="1" name="ConstantPressure" summary="The pump will regulate its speed to maintain a constant differential pressure over its flanges. The setpoint is interpreted as a percentage of the range of the sensor used for this control mode. In case of the internal pressure sensor, this will be the range derived from the [MinConstPressure – MaxConstPressure] attributes. In case of a remote pressure sensor, this will be the range derived from the [MinMeasuredValue – MaxMeasuredValue] attributes of the remote pressure sensor.">
<mandatoryConform/>
</item>
<item value="2" name="ProportionalPressure" summary="The pump will regulate its speed to maintain a constant differential pressure over its flanges. The setpoint is interpreted as a percentage of the range derived of the [MinCompPressure – MaxCompPressure] attributes. The internal setpoint will be lowered (compensated) dependent on the flow in the pump (lower flow =&gt; lower internal setpoint)">
<mandatoryConform/>
</item>
<item value="3" name="ConstantFlow" summary="The pump will regulate its speed to maintain a constant flow through the pump. The setpoint is interpreted as a percentage of the range of the sensor used for this control mode. In case of the internal flow sensor, this will be the range derived from the [MinConstFlow – MaxConstFlow] attributes. In case of a remote flow sensor, this will be the range derived from the [MinMeasuredValue – MaxMeasuredValue] attributes of the remote flow sensor.">
<mandatoryConform/>
</item>
<item value="5" name="ConstantTemperature" summary="The pump will regulate its speed to maintain a constant temperature. The setpoint is interpreted as a percentage of the range of the sensor used for this control mode. In case of the internal temperature sensor, this will be the range derived from the [MinConstTemp – MaxConstTemp] attributes. In case of a remote temperature sensor, this will be the range derived from the [MinMeasuredValue – MaxMeasuredValue] attributes of the remote temperature sensor.">
<mandatoryConform/>
</item>
<item value="7" name="Automatic" summary="The operation of the pump is automatically optimized to provide the most suitable performance with respect to comfort and energy savings. This behavior is manufacturer defined. The pump can be stopped by setting the setpoint of the level control cluster to 0, or by using the On/Off cluster. If the pump is started (at any setpoint), the speed of the pump is entirely determined by the pump.">
<mandatoryConform/>
</item>
</enum>
<enum name="OperationModeAttribute">
<item value="0" name="Normal" summary="The pump is controlled by a setpoint, as defined by a connected remote sensor or by the ControlMode attribute. (N.B. The setpoint is an internal variable which MAY be controlled between 0% and 100%, e.g., by means of the Level Control cluster)">
<mandatoryConform/>
</item>
<item value="1" name="Minimum" summary="This value sets the pump to run at the minimum possible speed it can without being stopped">
<mandatoryConform/>
</item>
<item value="2" name="Maximum" summary="This value sets the pump to run at its maximum possible speed">
<mandatoryConform/>
</item>
<item value="3" name="Local" summary="This value sets the pump to run with the local settings of the pump, regardless of what these are">
<mandatoryConform/>
</item>
</enum>
<bitmap name="PumpStatusAttribute">
<bitfield name="DeviceFault" bit="0" summary="A fault related to the system or pump device is detected (Corresponds to an Event ID in the range 6-16, see Events)">
<mandatoryConform/>
</bitfield>
<bitfield name="SupplyFault" bit="1" summary="A fault related to the supply to the pump is detected (Corresponds to an Event code in the range 0-5 or 13, see Events)">
<mandatoryConform/>
</bitfield>
<bitfield name="SpeedLow" bit="2" summary="Setpoint is too low to achieve">
<mandatoryConform/>
</bitfield>
<bitfield name="SpeedHigh" bit="3" summary="Setpoint is too high to achieve">
<mandatoryConform/>
</bitfield>
<bitfield name="LocalOverride" bit="4" summary="Device control is overridden by hardware, such as an external STOP button or via a local HMI. While LocalOverride 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.">
<mandatoryConform/>
</bitfield>
<bitfield name="Running" bit="5" summary="Pump is currently running">
<mandatoryConform/>
</bitfield>
<bitfield name="RemotePressure" bit="6" summary="A remote pressure sensor is used as the sensor for the regulation of the pump. EffectiveControlMode is ConstantPressure, and the setpoint for the pump is interpreted as a percentage of the range of the remote sensor ([MinMeasuredValue – MaxMeasuredValue])">
<mandatoryConform/>
</bitfield>
<bitfield name="RemoteFlow" bit="7" summary="A remote flow sensor is used as the sensor for the regulation of the pump. EffectiveControlMode is ConstantFlow, and the setpoint for the pump is interpreted as a percentage of the range of the remote sensor ([MinMeasuredValue – MaxMeasuredValue])">
<mandatoryConform/>
</bitfield>
<bitfield name="RemoteTemperature" bit="8" summary="A remote temperature sensor is used as the sensor for the regulation of the pump. EffectiveControlMode is ConstantTemperature, and setpoint is interpreted as a percentage of the range of the remote sensor ([MinMeasuredValue – MaxMeasuredValue])">
<mandatoryConform/>
</bitfield>
</bitmap>
</dataTypes>
<attributes>
<attribute id="0x0000" name="MaxPressure" type="int16" default="null">
<access read="true" readPrivilege="view"/>
<quality nullable="true" persistence="fixed"/>
<mandatoryConform/>
</attribute>
<attribute id="0x0001" name="MaxSpeed" type="uint16" default="null">
<access read="true" readPrivilege="view"/>
<quality nullable="true" persistence="fixed"/>
<mandatoryConform/>
</attribute>
<attribute id="0x0002" name="MaxFlow" type="uint16" default="null">
<access read="true" readPrivilege="view"/>
<quality nullable="true" persistence="fixed"/>
<mandatoryConform/>
</attribute>
<attribute id="0x0003" name="MinConstPressure" type="int16" default="null">
<access read="true" readPrivilege="view"/>
<quality nullable="true" persistence="fixed"/>
<optionalConform/>
</attribute>
<attribute id="0x0004" name="MaxConstPressure" type="int16" default="null">
<access read="true" readPrivilege="view"/>
<quality nullable="true" persistence="fixed"/>
<optionalConform/>
</attribute>
<attribute id="0x0005" name="MinCompPressure" type="int16" default="null">
<access read="true" readPrivilege="view"/>
<quality nullable="true" persistence="fixed"/>
<optionalConform/>
</attribute>
<attribute id="0x0006" name="MaxCompPressure" type="int16" default="null">
<access read="true" readPrivilege="view"/>
<quality nullable="true" persistence="fixed"/>
<optionalConform/>
</attribute>
<attribute id="0x0007" name="MinConstSpeed" type="uint16" default="null">
<access read="true" readPrivilege="view"/>
<quality nullable="true" persistence="fixed"/>
<optionalConform/>
</attribute>
<attribute id="0x0008" name="MaxConstSpeed" type="uint16" default="null">
<access read="true" readPrivilege="view"/>
<quality nullable="true" persistence="fixed"/>
<optionalConform/>
</attribute>
<attribute id="0x0009" name="MinConstFlow" type="uint16" default="null">
<access read="true" readPrivilege="view"/>
<quality nullable="true" persistence="fixed"/>
<optionalConform/>
</attribute>
<attribute id="0x000A" name="MaxConstFlow" type="uint16" default="null">
<access read="true" readPrivilege="view"/>
<quality nullable="true" persistence="fixed"/>
<optionalConform/>
</attribute>
<attribute id="0x000B" name="MinConstTemp" type="int16" default="null">
<access read="true" readPrivilege="view"/>
<quality nullable="true" persistence="fixed"/>
<optionalConform/>
<constraint>
<min value="-27315"/>
</constraint>
</attribute>
<attribute id="0x000C" name="MaxConstTemp" type="int16" default="null">
<access read="true" readPrivilege="view"/>
<quality nullable="true" persistence="fixed"/>
<optionalConform/>
<constraint>
<min value="-27315"/>
</constraint>
</attribute>
</attributes>
<events>
<event id="0x00" name="SupplyVoltageLow" priority="info">
<access readPrivilege="view"/>
<optionalConform/>
</event>
<event id="0x01" name="SupplyVoltageHigh" priority="info">
<access readPrivilege="view"/>
<optionalConform/>
</event>
<event id="0x02" name="PowerMissingPhase" priority="info">
<access readPrivilege="view"/>
<optionalConform/>
</event>
<event id="0x03" name="SystemPressureLow" priority="info">
<access readPrivilege="view"/>
<optionalConform/>
</event>
<event id="0x04" name="SystemPressureHigh" priority="info">
<access readPrivilege="view"/>
<optionalConform/>
</event>
<event id="0x05" name="DryRunning" priority="critical">
<access readPrivilege="view"/>
<optionalConform/>
</event>
<event id="0x06" name="MotorTemperatureHigh" priority="info">
<access readPrivilege="view"/>
<optionalConform/>
</event>
<event id="0x07" name="PumpMotorFatalFailure" priority="critical">
<access readPrivilege="view"/>
<optionalConform/>
</event>
<event id="0x08" name="ElectronicTemperatureHigh" priority="info">
<access readPrivilege="view"/>
<optionalConform/>
</event>
<event id="0x09" name="PumpBlocked" priority="critical">
<access readPrivilege="view"/>
<optionalConform/>
</event>
<event id="0x0A" name="SensorFailure" priority="info">
<access readPrivilege="view"/>
<optionalConform/>
</event>
<event id="0x0B" name="ElectronicNonFatalFailure" priority="info">
<access readPrivilege="view"/>
<optionalConform/>
</event>
<event id="0x0C" name="ElectronicFatalFailure" priority="critical">
<access readPrivilege="view"/>
<optionalConform/>
</event>
<event id="0x0D" name="GeneralFault" priority="info">
<access readPrivilege="view"/>
<optionalConform/>
</event>
<event id="0x0E" name="Leakage" priority="info">
<access readPrivilege="view"/>
<optionalConform/>
</event>
<event id="0x0F" name="AirDetection" priority="info">
<access readPrivilege="view"/>
<optionalConform/>
</event>
<event id="0x10" name="TurbineOperation" priority="info">
<access readPrivilege="view"/>
<optionalConform/>
</event>
</events>
</cluster>