.. _BeckhoffAdixenRoot:

==================
BeckhoffAdixenRoot
==================

Commands
++++++++

+----+---------------+----------------+------+-------------+-----------------------------------------------+
|Key |Displayed Name |Description     |Alias |Access Level |Allowed States                                 |
+====+===============+================+======+=============+===============================================+
|off |Off            | | Switch off   |COff  |USER         |STARTING, ON, ERROR, RUNNING, INTERLOCK_BROKEN |
|    |               | | pump         |      |             |                                               |
+----+---------------+----------------+------+-------------+-----------------------------------------------+
|on  |On             | | Switch on    |COn   |USER         |OFF, INTERLOCK_BROKEN                          |
|    |               | | pump         |      |             |                                               |
+----+---------------+----------------+------+-------------+-----------------------------------------------+

Properties
++++++++++

+--------------------+--------------------------+--------------------------------------------------+---------------------+-------+-------------+---------------+---------------+
|Key                 |Displayed Name            |Description                                       |Alias                |Type   |Access Level |Access Mode    |Allowed States |
+====================+==========================+==================================================+=====================+=======+=============+===============+===============+
|freqPercentage      |Pump Frequency Percentage | | Pump frequency percentage with respect to the  |APumpFrequencyP      |UInt16 |OBSERVER     |READONLY       |               |
|                    |                          | | maximum                                        |                     |       |             |               |               |
+--------------------+--------------------------+--------------------------------------------------+---------------------+-------+-------------+---------------+---------------+
|isMotorTempWarning  |Motor temperature warning | | Only valid for 19 pins HW I/F                  |                     |Bool   |OBSERVER     |READONLY       |               |
+--------------------+--------------------------+--------------------------------------------------+---------------------+-------+-------------+---------------+---------------+
|isOn                |Main pump on output       | | True when main pump is switched on             |                     |Bool   |OBSERVER     |READONLY       |               |
+--------------------+--------------------------+--------------------------------------------------+---------------------+-------+-------------+---------------+---------------+
|isRunning           |Main pump is running      | | Feedback from the Pump if it is actually       |                     |Bool   |OBSERVER     |READONLY       |               |
|                    |                          | | running                                        |                     |       |             |               |               |
+--------------------+--------------------------+--------------------------------------------------+---------------------+-------+-------------+---------------+---------------+
|isStarting          |Pump starting             | | True when pump is starting                     |                     |Bool   |OBSERVER     |READONLY       |               |
+--------------------+--------------------------+--------------------------------------------------+---------------------+-------+-------------+---------------+---------------+
|finalValveInterlock |Final Valve Interlock     | | Valve should not be opened when true           |AFinalValveInterlock |Bool   |OPERATOR     |READONLY       |               |
+--------------------+--------------------------+--------------------------------------------------+---------------------+-------+-------------+---------------+---------------+
|frequencyMax        |frequencyMax              | |                                                |AFrequencyMax        |UInt16 |EXPERT       |RECONFIGURABLE |               |
+--------------------+--------------------------+--------------------------------------------------+---------------------+-------+-------------+---------------+---------------+
|frequencyMin        |frequencyMin              | |                                                |AFrequencyMin        |UInt16 |EXPERT       |RECONFIGURABLE |               |
+--------------------+--------------------------+--------------------------------------------------+---------------------+-------+-------------+---------------+---------------+
|isPumpAlarm         |Pump alarm                | | Pump is in an alarm state or has encountered a |                     |Bool   |EXPERT       |READONLY       |               |
|                    |                          | | hazard                                         |                     |       |             |               |               |
+--------------------+--------------------------+--------------------------------------------------+---------------------+-------+-------------+---------------+---------------+
|isPumpWarning       |Pump warning              | | indicates that the pump has a warning          |                     |Bool   |EXPERT       |READONLY       |               |
+--------------------+--------------------------+--------------------------------------------------+---------------------+-------+-------------+---------------+---------------+
|pumpFrequency       |Pump frequency            | | Pump frequency                                 |APumpFrequency       |UInt16 |EXPERT       |RECONFIGURABLE |               |
+--------------------+--------------------------+--------------------------------------------------+---------------------+-------+-------------+---------------+---------------+
|pumpPins            |Pump Pins                 | | number of signals of pump hardware interface   |APumpPins            |UInt16 |ADMIN        |READONLY       |               |
+--------------------+--------------------------+--------------------------------------------------+---------------------+-------+-------------+---------------+---------------+