.. _BeckhoffChiller:

===============
BeckhoffChiller
===============

Commands
++++++++

+----+---------------+--------------+------+-------------+------------------------------------+
|Key |Displayed Name |Description   |Alias |Access Level |Allowed States                      |
+====+===============+==============+======+=============+====================================+
|off |Off            | | Stop       |COff  |USER         |ON, ACTIVE, ERROR, INTERLOCK_BROKEN |
|    |               | | Cooling    |      |             |                                    |
+----+---------------+--------------+------+-------------+------------------------------------+
|on  |On             | | Start      |COn   |USER         |INTERLOCK_BROKEN, OFF, PASSIVE      |
|    |               | | Cooling    |      |             |                                    |
+----+---------------+--------------+------+-------------+------------------------------------+

Properties
++++++++++

+------------------+---------------------------------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+
|Key               |Displayed Name                                     |Description                                       |Alias              |Type   |Access Level |Access Mode    |Allowed States |
+==================+===================================================+==================================================+===================+=======+=============+===============+===============+
|bathTemp          |Bath Temperature                                   | |                                                |ABathTemp          |Float  |OBSERVER     |READONLY       |               |
+------------------+---------------------------------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+
|chillerTypeString |Chiller Type                                       | |                                                |                   |String |OBSERVER     |READONLY       |               |
+------------------+---------------------------------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+
|chillerWarning    |Hardware Warning                                   | |                                                |                   |Bool   |OBSERVER     |READONLY       |               |
+------------------+---------------------------------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+
|externalTemp      |External Temperature                               | |                                                |AExternalTemp      |Float  |OBSERVER     |READONLY       |               |
+------------------+---------------------------------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+
|isCooling         |Cooler Element On                                  | |                                                |                   |Bool   |OBSERVER     |READONLY       |               |
+------------------+---------------------------------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+
|isOnTarget        |On Target                                          | |                                                |                   |Bool   |OBSERVER     |READONLY       |               |
+------------------+---------------------------------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+
|isRamping         |Ramping                                            | |                                                |                   |Bool   |OBSERVER     |READONLY       |               |
+------------------+---------------------------------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+
|isShuttingDown    |Shutting Down                                      | |                                                |                   |Bool   |OBSERVER     |READONLY       |               |
+------------------+---------------------------------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+
|deadband          |Allowable Deadband                                 | | Allowable deadband of the Chiller to be        |AChillerDB         |Float  |USER         |RECONFIGURABLE |               |
|                  |                                                   | | considered at setpoint                         |                   |       |             |               |               |
+------------------+---------------------------------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+
|finalSetPoint     |Final Chiller Temperature Setpoint used in ramping | |                                                |AChillerFinalSP    |Float  |USER         |RECONFIGURABLE |               |
+------------------+---------------------------------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+
|minTemp           |Minimum Chiller Temperature                        | | Minimum Temperature range of the Chiller -     |AMinTemp           |Float  |USER         |RECONFIGURABLE |               |
|                  |                                                   | | Inclusive                                      |                   |       |             |               |               |
+------------------+---------------------------------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+
|roomTemp          |Room Temperature Set                               | | Room Temperature - the chiller needs to reach  |ARoomTemp          |Float  |USER         |RECONFIGURABLE |               |
|                  |                                                   | | room temperature before it can safely turn off |                   |       |             |               |               |
+------------------+---------------------------------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+
|setPoint          |Chiller Temperature Setpoint                       | |                                                |AChillerSP         |Float  |USER         |RECONFIGURABLE |               |
+------------------+---------------------------------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+
|filterTime        |Error Filter Time                                  | | Filter Timer for error signals                 |AErrorT            |UInt16 |EXPERT       |RECONFIGURABLE |               |
+------------------+---------------------------------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+
|offset            |Offset                                             | | Calibration Offset                             |AOffset            |Float  |EXPERT       |RECONFIGURABLE |               |
+------------------+---------------------------------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+
|bypassShutdownSeq |Bypass Shutdown Sequence                           | |                                                |ABypassShutdownSeq |Bool   |ADMIN        |RECONFIGURABLE |               |
+------------------+---------------------------------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+
|chillerType       |Chiller Type Code                                  | | Manufacturer of the Chiller. 0=Huber, 1=Julabo.|AChillerType       |UInt16 |ADMIN        |READONLY       |               |
|                  |                                                   | | This must be configured during implementation  |                   |       |             |               |               |
|                  |                                                   | | for the initialization of the soft device.     |                   |       |             |               |               |
+------------------+---------------------------------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+
|maxTemp           |Maximum Chiller Temperature                        | | Maximum Temperature range of the Chiller -     |AMaxTemp           |Float  |ADMIN        |RECONFIGURABLE |               |
|                  |                                                   | | Inclusive                                      |                   |       |             |               |               |
+------------------+---------------------------------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+
|rampRate          |Ramp Rate                                          | | If set to > 0, the chiller will reach the final|ARampRate          |UInt16 |ADMIN        |RECONFIGURABLE |               |
|                  |                                                   | | setpoint at the given rate of X deg_C/minute   |                   |       |             |               |               |
+------------------+---------------------------------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+
|warningFactor     |Warning Factor                                     | | Warning time factor used to determine the      |AWarningFactor     |Float  |ADMIN        |RECONFIGURABLE |               |
|                  |                                                   | | expected duration where the chiller should     |                   |       |             |               |               |
|                  |                                                   | | reach the expected setpoint                    |                   |       |             |               |               |
+------------------+---------------------------------------------------+--------------------------------------------------+-------------------+-------+-------------+---------------+---------------+