.. _XrayFeedback:

============
XrayFeedback
============

Commands
++++++++

+-------------+---------------+--------------------------------------------------+------+-------------+---------------+
|Key          |Displayed Name |Description                                       |Alias |Access Level |Allowed States |
+=============+===============+==================================================+======+=============+===============+
|coarseLeft   |Coarse Left    | | Coarse (left) movement of the beam position    |      |OBSERVER     |ON             |
+-------------+---------------+--------------------------------------------------+------+-------------+---------------+
|coarseRight  |Coarse Right   | | Coarse (right) movement of the beam position   |      |OBSERVER     |ON             |
+-------------+---------------+--------------------------------------------------+------+-------------+---------------+
|moveProposal |Move Proposal  | | Move the horizontal piezo to the proposed      |      |OBSERVER     |RUNNING        |
|             |               | | position                                       |      |             |               |
+-------------+---------------+--------------------------------------------------+------+-------------+---------------+
|start        |Start          | |                                                |      |OBSERVER     |ON             |
+-------------+---------------+--------------------------------------------------+------+-------------+---------------+
|stop         |Stop           | |                                                |      |OBSERVER     |RUNNING        |
+-------------+---------------+--------------------------------------------------+------+-------------+---------------+

Properties
++++++++++

+-----------------+-------------------+--------------------------------------------------+------+-------------+-------------+---------------+---------------+
|Key              |Displayed Name     |Description                                       |Alias |Type         |Access Level |Access Mode    |Allowed States |
+=================+===================+==================================================+======+=============+=============+===============+===============+
|actuatorLimitMax |Actuator Max Limit | | The maximum limit of the actuator value        |      |Double       |OBSERVER     |READONLY       |               |
+-----------------+-------------------+--------------------------------------------------+------+-------------+-------------+---------------+---------------+
|actuatorLimitMin |Actuator Min Limit | | The minimum limit of the actuator value        |      |Double       |OBSERVER     |READONLY       |               |
+-----------------+-------------------+--------------------------------------------------+------+-------------+-------------+---------------+---------------+
|actuatorName     |Actuator           | | DeviceID of the horizontal actuatorused for    |      |String       |OBSERVER     |INITONLY       |               |
|                 |                   | | feedback control                               |      |             |             |               |               |
+-----------------+-------------------+--------------------------------------------------+------+-------------+-------------+---------------+---------------+
|availableScenes  |Available Scenes   | | Scenes from the XRayFeed                       |      |VectorString |OBSERVER     |READONLY       |               |
+-----------------+-------------------+--------------------------------------------------+------+-------------+-------------+---------------+---------------+
|coarseIncrement  |Coarse Increment   | | The coarse move increment for the piezo X      |      |Double       |OBSERVER     |RECONFIGURABLE |               |
+-----------------+-------------------+--------------------------------------------------+------+-------------+-------------+---------------+---------------+
|feedLimitMax     |Feedback Max Limit | | The maximum position the actuator is allowed to|      |Double       |OBSERVER     |READONLY       |               |
|                 |                   | | move during the feedback run. Is automatically |      |             |             |               |               |
|                 |                   | | set after each start.                          |      |             |             |               |               |
+-----------------+-------------------+--------------------------------------------------+------+-------------+-------------+---------------+---------------+
|feedLimitMin     |Feedback Min Limit | | The minimum position the actuator is allowed to|      |Double       |OBSERVER     |READONLY       |               |
|                 |                   | | move during the feedback run. Is automatically |      |             |             |               |               |
|                 |                   | | set after each start.                          |      |             |             |               |               |
+-----------------+-------------------+--------------------------------------------------+------+-------------+-------------+---------------+---------------+
|isValidated      |Valid Measure      | | Validated beam position.                       |      |Bool         |OBSERVER     |READONLY       |               |
+-----------------+-------------------+--------------------------------------------------+------+-------------+-------------+---------------+---------------+
|isValidatedEnv   |Valid Environment  | | Validated environment behavior.                |      |Bool         |OBSERVER     |READONLY       |               |
+-----------------+-------------------+--------------------------------------------------+------+-------------+-------------+---------------+---------------+
|isWaiting        |isWaiting          | | Feedback is waiting for a buffered value.      |      |Bool         |OBSERVER     |READONLY       |               |
+-----------------+-------------------+--------------------------------------------------+------+-------------+-------------+---------------+---------------+
|monitorName      |Detector           | | DeviceID of the detector for feedback control  |      |String       |OBSERVER     |INITONLY       |               |
+-----------------+-------------------+--------------------------------------------------+------+-------------+-------------+---------------+---------------+
|posX             |Position X         | | The x position of the beam on the detectorused |      |Double       |OBSERVER     |READONLY       |               |
|                 |                   | | for feedback control                           |      |             |             |               |               |
+-----------------+-------------------+--------------------------------------------------+------+-------------+-------------+---------------+---------------+
|posY             |Position Y         | | The y position of the beam on the detectorused |      |Double       |OBSERVER     |READONLY       |               |
|                 |                   | | for feedback control                           |      |             |             |               |               |
+-----------------+-------------------+--------------------------------------------------+------+-------------+-------------+---------------+---------------+
|proposalPosition |Proposal Position  | | The proposed position of the X-ray feedback    |      |Double       |OBSERVER     |READONLY       |               |
+-----------------+-------------------+--------------------------------------------------+------+-------------+-------------+---------------+---------------+
|constD           |Const D.           | | The derivative constant in the feedback        |      |Double       |ADMIN        |RECONFIGURABLE |               |
|                 |                   | | algorithm.                                     |      |             |             |               |               |
+-----------------+-------------------+--------------------------------------------------+------+-------------+-------------+---------------+---------------+
|constI           |Const I.           | | The integral constant in the feedback          |      |Double       |ADMIN        |RECONFIGURABLE |               |
|                 |                   | | algorithm.                                     |      |             |             |               |               |
+-----------------+-------------------+--------------------------------------------------+------+-------------+-------------+---------------+---------------+
|constP           |Const P.           | | The proportional constant in the feedback      |      |Double       |ADMIN        |RECONFIGURABLE |               |
|                 |                   | | algorithm.                                     |      |             |             |               |               |
+-----------------+-------------------+--------------------------------------------------+------+-------------+-------------+---------------+---------------+