.. _BeckhoffEbaraRoots:

==================
BeckhoffEbaraRoots
==================

Commands
++++++++

+--------------------+-----------------------+--------------------------------------------------+---------------------+-------------+-----------------------------------------------+
|Key                 |Displayed Name         |Description                                       |Alias                |Access Level |Allowed States                                 |
+====================+=======================+==================================================+=====================+=============+===============================================+
|off                 |Off                    | | Switch off device                              |COff                 |OPERATOR     |CHANGING, ON, ERROR, RUNNING, INTERLOCK_BROKEN |
+--------------------+-----------------------+--------------------------------------------------+---------------------+-------------+-----------------------------------------------+
|on                  |On                     | | Switch on main pump                            |COn                  |OPERATOR     |OFF, INTERLOCK_BROKEN                          |
+--------------------+-----------------------+--------------------------------------------------+---------------------+-------------+-----------------------------------------------+
|pumpReset           |Pump Reset             | | send a reset signal to the pump                |CReset               |OPERATOR     |                                               |
+--------------------+-----------------------+--------------------------------------------------+---------------------+-------------+-----------------------------------------------+
|boostOff            |Boost Off              | | Turn the booster pump off. This functionality  |COffBoost            |EXPERT       |STARTING, ON, ERROR, RUNNING, INTERLOCK_BROKEN |
|                    |                       | | can only be used when DIP switch A-8 has been  |                     |             |                                               |
|                    |                       | | set to On. (Default is Off)                    |                     |             |                                               |
+--------------------+-----------------------+--------------------------------------------------+---------------------+-------------+-----------------------------------------------+
|boostOn             |Boost On               | | Turn the booster pump on. This functionality   |COnBoost             |EXPERT       |ON, RUNNING, INTERLOCK_BROKEN                  |
|                    |                       | | can only be used when DIP switch A-8 has been  |                     |             |                                               |
|                    |                       | | set to On. (Default is Off)                    |                     |             |                                               |
+--------------------+-----------------------+--------------------------------------------------+---------------------+-------------+-----------------------------------------------+
|energySavingModeOff |Energy Saving Mode Off | | Energy Saving mode is deactivated.             |CEnergySavingModeOff |EXPERT       |ON, RUNNING, INTERLOCK_BROKEN                  |
+--------------------+-----------------------+--------------------------------------------------+---------------------+-------------+-----------------------------------------------+
|energySavingModeOn  |Energy Saving Mode On  | | Energy Saving mode is activated. This mode runs|CEnergySavingModeOn  |EXPERT       |ON, RUNNING, INTERLOCK_BROKEN                  |
|                    |                       | | the main and booster pumps at a slower pre-    |                     |             |                                               |
|                    |                       | | defined speed as cofigured via the device      |                     |             |                                               |
|                    |                       | | interface.                                     |                     |             |                                               |
+--------------------+-----------------------+--------------------------------------------------+---------------------+-------------+-----------------------------------------------+

Properties
++++++++++

+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|Key                  |Displayed Name             |Description                                       |Alias             |Type   |Access Level |Access Mode    |Allowed States |
+=====================+===========================+==================================================+==================+=======+=============+===============+===============+
|isAlarm              |Pump Alarm                 | | Device is in alarm state                       |                  |Bool   |OBSERVER     |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|isBoosterPumpOn      |Booster pump is on         | | Booster pump is on                             |                  |Bool   |OBSERVER     |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|isBoosterPumpRunning |Booster pump is running    | | Booster pump is running                        |                  |Bool   |OBSERVER     |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|isEmergencyStop      |Emergency Stop             | | Emergency Stop active                          |                  |Bool   |OBSERVER     |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|isEnergySavingOn     |Energy Saving Mode On      | | Energy saving mode actually on                 |                  |Bool   |OBSERVER     |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|isEnergySavingSet    |Energy Saving Mode Set     | | Energy saving mode wanted on                   |                  |Bool   |OBSERVER     |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|isLocalMode          |Local Mode                 | | Device in local mode (remote control disabled) |                  |Bool   |OBSERVER     |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|isMainPumpOn         |Main pump is on            | | Main pump is on                                |                  |Bool   |OBSERVER     |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|isMainPumpRunning    |Main pump is running       | | Main pump is running                           |                  |Bool   |OBSERVER     |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|isN2Warning          |N2 Warning                 | | Device is in has N2 warning                    |                  |Bool   |OBSERVER     |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|isReset              |Reset alarms on the device | | reset for tripped alarms or alarms and warnings|                  |Bool   |OBSERVER     |READONLY       |               |
|                     |                           | | on the device                                  |                  |       |             |               |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|isStarting           |pump starting              | | True when pump is starting                     |                  |Bool   |OBSERVER     |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|isWarning            |Pump Warning               | | Device is in a warning state                   |                  |Bool   |OBSERVER     |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|backPressure         |Back Pressure              | | Back Pressure in kPa                           |ABackPressure     |Float  |OPERATOR     |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|coolingWaterFlow     |Cooling water flow         | | Cooling water flow in l/min                    |ACoolingWaterFlow |Float  |OPERATOR     |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|motCasingTemp        |Casing temperature         | | Main Pump Motor casing temperature             |AMotCasingTemp    |UInt32 |OPERATOR     |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|motorSpeedBp         |Booster Pump Motor Speed   | | Booster Pump Power in K/min                    |AMotorSpeedBP     |Float  |OPERATOR     |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|motorSpeedMp         |Main Pump Motor Speed      | | Main pump motor speed in K/min                 |AMotorSpeedMP     |Float  |OPERATOR     |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|powerBp              |Boost Pump Power           | | Booster Pump Power in kW                       |APowerBP          |Float  |OPERATOR     |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|powerMp              |Main Pump Power            | | Main Pump Power in kW                          |APowerMP          |Float  |OPERATOR     |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|pumpN2Flow           |Pump N2 Flow               | | Pump N2 Flow in Pa*m^3/s                       |APumpN2Flow       |Float  |OPERATOR     |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|pumpRunTime          |Pump run time              | | Total run time of the pump in hours            |APumpRunTime      |UInt32 |OPERATOR     |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|warningOrErrors      |Warning or Errors          | | True if any warning or error is present        |AWarningOrErrors  |UInt32 |OPERATOR     |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|baudRate             |baudRate                   | |                                                |ABaudRate         |UInt8  |EXPERT       |RECONFIGURABLE |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|dataFrame            |dataFrame                  | |                                                |ADataFrame        |UInt8  |EXPERT       |RECONFIGURABLE |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|enableCtsRts         |enableCtsRts               | |                                                |AEnableCTSRTS     |Bool   |EXPERT       |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|enableXonXoffRx      |enableXonXoffRx            | |                                                |AEnableXOnXOffRx  |Bool   |EXPERT       |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|enableXonXoffTx      |enableXonXoffTx            | |                                                |AEnableXOnXOffTx  |Bool   |EXPERT       |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|rxBufferFull         |rxBufferFull               | |                                                |ARxBufferFull     |UInt16 |EXPERT       |RECONFIGURABLE |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|sendFifoDataCont     |sendFifoDataCont           | |                                                |ASendFIFODataCont |UInt8  |EXPERT       |RECONFIGURABLE |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+
|transferRateOpt      |transferRateOpt            | |                                                |ATransferRateOpt  |Bool   |EXPERT       |READONLY       |               |
+---------------------+---------------------------+--------------------------------------------------+------------------+-------+-------------+---------------+---------------+