> For the complete documentation index, see [llms.txt](https://support.powerio.com/hub/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.powerio.com/hub/codesys-hvac/en/hvac-modbus-library/functionblocks/ksb/ksb_pump_drive_2_mod-1.md). # KSB\_CALIO\_PRO\_PLUS\_Z ## KSB\_CALIO\_PRO\_PLUS\_Z (FB) `FUNCTION_BLOCK` KSB\_CALIO\_PRO\_PLUS\_Z ### Representation
### Short description > Control of the Calio Pro Plus or Calio Pro Plus Z device series from KSB. > > Typical application: circulation pump in heating/cooling circuits ### Guidelines - software development The following Modbus register ranges are used:\ Actual values: 0x07D0 - 0x07ED ( FC03 )\ Setpoints: 0x0834 - 0x0838 ( FC16 )\ \ Modbus default parameters: address 17, 19200 baud, 1-8-E-1 ### Interfaces ### Inputs | Scope | Name | Type | Initial | Comment | | ----- | --------------- | ------ | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | Input | `xEn` | `BOOL` | TRUE | Enable / disable communication (TRUE = enable) | | Input | `byUnitId` | `BYTE` | 17 | Device address | | Input | `xUpdateActual` | `BOOL` | FALSE |

Update of actual values (on every rising edge
)

| | Input | `xUpdateSetp` | `BOOL` | FALSE |

Update of setpoints (on every rising edge
)

| | Input | xEnDevice | BOOL | FALSE | Enable / disable the pump ( FALSE = Stop ) | | Input | rSetp\_PERC | REAL | 0.0 | Setpoint for the pump in percent ( 0.0 - 100.0% ) | | Input | rSetp\_ABS | REAL | 1000.0 | Setpoint for the pump in the unit assigned to the operating mode | | Input | `xResError` | `BOOL` | FALSE | Reinitialization of the outputs 'eErrorCodeCom' and 'sErrorCode1Dev' or 'sErrorCode2Dev' to the error-free state (on every rising edge) | #### Inputs/Outputs | Scope | Name | Type | Initial | Comment | | ----- | -------------- | ------------------ | ------- | -------------------- | | Inout | `ModbusClient` | `ModbusClientBase` | | Client of the device | #### Outputs | Scope | Name | Type | Initial | Comment | | ------ | --------------- | --------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------- | | Output | `xOperation` | `BOOL` | FALSE | Pump operating message ( TRUE = Operation ) | | Output | xEnDeviceFb | BOOL | FALSE | Enable / disable the pump ( FALSE = Off ) --- feedback | | Output | eControlModeFb | KSB\_CALIO\_PRO\_PLUS\_Z\_CONTROL\_MODE | | Type of control / regulation --- feedback | | Output | rCalcDelievHead | REAL | 0.0 | Calculated delivery head in X.X m | | Output | rCalcFlowRate | REAL | 0.0 | Calculated flow rate in X.X m3/h | | Output | rSpeed | REAL | 0.0 | Current speed of the pump in XXX 1/min | | Output | rOperatingHours | REAL | 0.0 | Operating hours of the pump in XXX h | | Output | rPower | REAL | 0.0 | Current power consumption of the pump in XXX W | | Output | rExtTempA | REAL | 0.0 | Current external temperature A in XX.XX degrees Celsius | | Output | rExtTempB | REAL | 0.0 | Current external temperature B in XX.XX degrees Celsius | | Output | rTemp\_SPM | REAL | 0.0 | Current temperature of the power module in XXX degrees Celsius | | Output | rTemp\_PCB | REAL | 0.0 | Current temperature of the control board in XXX degrees Celsius | | Output | rTemp\_Motor | REAL | 0.0 | Current temperature of the motor in XXX degrees Celsius | | Output | rTemp\_Media | REAL | 0.0 | Current temperature of the pumped medium in XXX degrees Celsius | | Output | ElecEnergyTota | REAL | 0.0 | Total electrical work of the pump in XXX kWh | | Output | rFlowTota | REAL | 0.0 | Total flow rate of the pump in XXX m3/h | | Output | rHeatMeterTota | REAL | 0.0 | Total thermal energy of the pump in XXX kWh | | Output | rHeatPower | REAL | 0.0 | Current transported thermal output of the pump in XXX W | | Output | rAnalogInput1 | REAL | 0.0 | Current actual value at analog input 1 in XXX mV ( 0.0 - 10000.0 mV ) | | Output | rTempPT1 | REAL | 0.0 | Current temperature at input PT1 ( PT1000, in XX.XX degrees Celsius ) | | Output | rTempPT21 | REAL | 0.0 | Current temperature at input PT2 ( PT1000, in XX.XX degrees Celsius ) | | Output | xNightDay | BOOL | FALSE | Current state of night/day operation ( FALSE = night operation ) | | Output | rSetp\_PERC\_Fb | REAL | 0.0 | Setpoint for the pump in XX.XX percent --- feedback | | Output | rSetp\_ABS\_Fb | REAL | 0.0 | Setpoint for the pump ( unit depending on the selected operating mode ) --- feedback | | Output | xAlarm | BOOL | FALSE | Collective fault ( TRUE = fault ) | | Output | xAlarmCom | BOOL | FALSE | Collective fault - communication ( TRUE = fault ) | | Output | eErrorCodeCom | ModbusErrorCode | | Error code - communication ( 0 = no error ) | | Output | xAlarmDevice | BOOL | FALSE | Collective fault - pump ( TRUE = fault ) | | Output | sErrorCode1 | STRING | | String with the numbers of the active device faults 0 - 15 of pump 1 ( Bit 0 = number 1, Bit 1 = number 2, etc. ) | | Output | sErrorCode21 | STRING | | String with the numbers of the active device faults 16 - 31 of pump 1 ( Bit 0 = number 16, Bit 1 = number 17, etc. ) | | Output | xWarning | BOOL | FALSE | Collective warning - pump ( TRUE = warning ) | | Output | sWarningCode1 | STRING | | String with the numbers of the active device warnings 0 - 15 of pump 1 ( Bit 0 = number 1, Bit 1 = number 2, etc. ) | | Output | sWarningCode2 | STRING | | String with the numbers of the active device warnings 16 - 31 of pump 1 ( Bit 0 = number 16, Bit 1 = number 17, etc. ) | | Output | xBusy | BOOL | | Communication display ( TRUE = communication ) | ### Parameter | Scope | Name | Type | Initial | Comment | | ----------- | ------------------- | --------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | | Input Const | eSetpMode | KSB\_CALIO\_PRO\_PLUS\_Z\_SETP\_MODE | KSB\_CALIO\_PRO\_PLUS\_Z\_SETP\_MODE.INPUT\_rSetp\_PERC | Selection of setpoint inputs | | Input Const | eControlMode | KSB\_CALIO\_PRO\_PLUS\_Z\_CONTROL\_MODE | KSB\_CALIO\_PRO\_PLUS\_Z\_CONTROL\_MODE.VARIABLE\_SPEED | Type of control / regulation | | Input Const | `tTimeUpdateSetp` | `TIME` | TIME#45s | Update interval for the processes influenced by input 'xUpdateSetp' | | Input Const | `tTimeUpdateActual` | `TIME` | TIME#3s |

Update interval for the processes influenced by the input
xUpdateActual influenced by

| ### Function description #### Specification of setpoints The setpoints are specified via the inputs 'rSetp\_PERC' in the range 0.0 - 100.0 percent\ ( 'eSetpMode' = INPUT\_rSetp\_PERC ) or 'rSetp\_ABS' in the absolute range relevant for the pump operating mode ( 'eSetpMode' = INPUT\_rSetp\_ABS ).\ When using input 'rSetp\_ABS', the following value ranges are permitted depending on the pump operating mode: ``` eControlMode = KSB_CALIO_PRO_PLUS_Z_CONTROL_MODE.CONSTANT_PRESSURE: Valid range for rSetp_ABS: 1.0 to 18.0 eControlMode = KSB_CALIO_PRO_PLUS_Z_CONTROL_MODE.CONSTANT_FLOW_RATE: Valid range for rSetp_ABS: 1.0 to 68.0 eControlMode = KSB_CALIO_PRO_PLUS_Z_CONTROL_MODE.PROPORTIONAL_PRESSURE: Valid range for rSetp_ABS: 1.0 to 18.0 eControlMode = KSB_CALIO_PRO_PLUS_Z_CONTROL_MODE.DYNAMIC_CONTROL: Valid range for rSetp_ABS: 1.0 to 18.0 eControlMode = KSB_CALIO_PRO_PLUS_Z_CONTROL_MODE.VARIABLE_SPEED: Valid range for rSetp_ABS: 1000.0 to 5000.0 eControlMode = KSB_CALIO_PRO_PLUS_Z_CONTROL_MODE.TEMPERATURE_CONTROL: Valid range for rSetp_ABS: -25.0 to 140.0 eControlMode = KSB_CALIO_PRO_PLUS_Z_CONTROL_MODE.PID_CONTROLLER: Valid range for rSetp_ABS: 0.0 to 1000.0 ``` The two feedback values 'rSetp\_PERC\_Fb' and 'rSetp\_ABS\_Fb' are calculated and read back by the pump independently of 'rSetpMpde' for every operating state. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://support.powerio.com/hub/codesys-hvac/en/hvac-modbus-library/functionblocks/ksb/ksb_pump_drive_2_mod-1.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.