****************************
Sq1TuneProcess
****************************



Summary
#######

Variable List
*************

* Running
* Progress
* Message
* Sq1FbLowOffset
* Sq1FbHighOffset
* Sq1FbNumSteps
* Sq1BiasLowOffset
* Sq1BiasHighOffset
* Sq1BiasNumSteps
* SetAfterFinish
* Sq1TuneOutput

Command List
*************

* ReadDevice
* WriteDevice
* Start
* Stop

Details
#######

Variables
*********

.. topic:: GroupRoot.Group.Sq1TuneProcess.Running

    | Status values indicating if operation is running.


    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |Field                                                                                               |Value                                                                                               |
    +====================================================================================================+====================================================================================================+
    |name                                                                                                |Running                                                                                             |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |path                                                                                                |GroupRoot.Group.Sq1TuneProcess.Running                                                              |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |enum                                                                                                |{False: 'False', True: 'True'}                                                                      |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |typeStr                                                                                             |bool                                                                                                |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |disp                                                                                                |enum                                                                                                |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |precision                                                                                           |0                                                                                                   |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |mode                                                                                                |RO                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+

.. topic:: GroupRoot.Group.Sq1TuneProcess.Progress

    | Percent complete: 0 - 100 %.


    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |Field                                                                                               |Value                                                                                               |
    +====================================================================================================+====================================================================================================+
    |name                                                                                                |Progress                                                                                            |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |path                                                                                                |GroupRoot.Group.Sq1TuneProcess.Progress                                                             |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |typeStr                                                                                             |float                                                                                               |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |disp                                                                                                |{:1.2f}                                                                                             |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |precision                                                                                           |2                                                                                                   |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |mode                                                                                                |RO                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |units                                                                                               |Pct                                                                                                 |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |minimum                                                                                             |0.0                                                                                                 |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |maximum                                                                                             |1.0                                                                                                 |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+

.. topic:: GroupRoot.Group.Sq1TuneProcess.Message

    | Process status message.
    | Prefixed with 'Error:' if an error occurred.


    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |Field                                                                                               |Value                                                                                               |
    +====================================================================================================+====================================================================================================+
    |name                                                                                                |Message                                                                                             |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |path                                                                                                |GroupRoot.Group.Sq1TuneProcess.Message                                                              |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |typeStr                                                                                             |str                                                                                                 |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |disp                                                                                                |{}                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |precision                                                                                           |0                                                                                                   |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |mode                                                                                                |RO                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+

.. topic:: GroupRoot.Group.Sq1TuneProcess.Sq1FbLowOffset

    | Starting point offset for SQ1 FB Tuning.


    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |Field                                                                                               |Value                                                                                               |
    +====================================================================================================+====================================================================================================+
    |name                                                                                                |Sq1FbLowOffset                                                                                      |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |path                                                                                                |GroupRoot.Group.Sq1TuneProcess.Sq1FbLowOffset                                                       |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |typeStr                                                                                             |float                                                                                               |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |disp                                                                                                |{}                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |precision                                                                                           |8                                                                                                   |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |mode                                                                                                |RW                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |units                                                                                               |μA                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+

.. topic:: GroupRoot.Group.Sq1TuneProcess.Sq1FbHighOffset

    | Ending point offset for SQ1 FB Tuning.


    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |Field                                                                                               |Value                                                                                               |
    +====================================================================================================+====================================================================================================+
    |name                                                                                                |Sq1FbHighOffset                                                                                     |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |path                                                                                                |GroupRoot.Group.Sq1TuneProcess.Sq1FbHighOffset                                                      |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |typeStr                                                                                             |float                                                                                               |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |disp                                                                                                |{}                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |precision                                                                                           |8                                                                                                   |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |mode                                                                                                |RW                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |units                                                                                               |μA                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+

.. topic:: GroupRoot.Group.Sq1TuneProcess.Sq1FbNumSteps

    | Number of steps for SQ1 FB Tuning.


    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |Field                                                                                               |Value                                                                                               |
    +====================================================================================================+====================================================================================================+
    |name                                                                                                |Sq1FbNumSteps                                                                                       |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |path                                                                                                |GroupRoot.Group.Sq1TuneProcess.Sq1FbNumSteps                                                        |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |typeStr                                                                                             |int                                                                                                 |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |disp                                                                                                |{}                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |precision                                                                                           |0                                                                                                   |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |mode                                                                                                |RW                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+

.. topic:: GroupRoot.Group.Sq1TuneProcess.Sq1BiasLowOffset

    | Starting point offset for SQ1 Bias Tuning.


    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |Field                                                                                               |Value                                                                                               |
    +====================================================================================================+====================================================================================================+
    |name                                                                                                |Sq1BiasLowOffset                                                                                    |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |path                                                                                                |GroupRoot.Group.Sq1TuneProcess.Sq1BiasLowOffset                                                     |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |typeStr                                                                                             |float                                                                                               |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |disp                                                                                                |{}                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |precision                                                                                           |8                                                                                                   |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |mode                                                                                                |RW                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |units                                                                                               |μA                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+

.. topic:: GroupRoot.Group.Sq1TuneProcess.Sq1BiasHighOffset

    | Ending point offset for SQ1 Bias Tuning.


    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |Field                                                                                               |Value                                                                                               |
    +====================================================================================================+====================================================================================================+
    |name                                                                                                |Sq1BiasHighOffset                                                                                   |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |path                                                                                                |GroupRoot.Group.Sq1TuneProcess.Sq1BiasHighOffset                                                    |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |typeStr                                                                                             |float                                                                                               |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |disp                                                                                                |{}                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |precision                                                                                           |8                                                                                                   |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |mode                                                                                                |RW                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |units                                                                                               |μA                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+

.. topic:: GroupRoot.Group.Sq1TuneProcess.Sq1BiasNumSteps

    | Number of steps for SQ1 Bias Tuning.


    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |Field                                                                                               |Value                                                                                               |
    +====================================================================================================+====================================================================================================+
    |name                                                                                                |Sq1BiasNumSteps                                                                                     |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |path                                                                                                |GroupRoot.Group.Sq1TuneProcess.Sq1BiasNumSteps                                                      |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |typeStr                                                                                             |int                                                                                                 |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |disp                                                                                                |{}                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |precision                                                                                           |0                                                                                                   |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |mode                                                                                                |RW                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+

.. topic:: GroupRoot.Group.Sq1TuneProcess.SetAfterFinish

    | This variable controls if the FAS set points found at the end of the process is set back.
    | Otherwise the previous values of FasFluxOn, FasFluxOff and SaFb for each row will be restored.


    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |Field                                                                                               |Value                                                                                               |
    +====================================================================================================+====================================================================================================+
    |name                                                                                                |SetAfterFinish                                                                                      |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |path                                                                                                |GroupRoot.Group.Sq1TuneProcess.SetAfterFinish                                                       |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |enum                                                                                                |{False: 'False', True: 'True'}                                                                      |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |typeStr                                                                                             |bool                                                                                                |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |disp                                                                                                |enum                                                                                                |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |precision                                                                                           |0                                                                                                   |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |mode                                                                                                |RW                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+

.. topic:: GroupRoot.Group.Sq1TuneProcess.Sq1TuneOutput

    | Results Data From SQ1 Tuning.


    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |Field                                                                                               |Value                                                                                               |
    +====================================================================================================+====================================================================================================+
    |name                                                                                                |Sq1TuneOutput                                                                                       |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |path                                                                                                |GroupRoot.Group.Sq1TuneProcess.Sq1TuneOutput                                                        |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |typeStr                                                                                             |dict                                                                                                |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |disp                                                                                                |{}                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |precision                                                                                           |0                                                                                                   |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |mode                                                                                                |RO                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+

Commands
********

.. topic:: GroupRoot.Group.Sq1TuneProcess.ReadDevice

    | Force read of device without recursion.


    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |Field                                                                                               |Value                                                                                               |
    +====================================================================================================+====================================================================================================+
    |name                                                                                                |ReadDevice                                                                                          |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |path                                                                                                |GroupRoot.Group.Sq1TuneProcess.ReadDevice                                                           |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |enum                                                                                                |{False: 'False', True: 'True'}                                                                      |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |typeStr                                                                                             |bool                                                                                                |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |disp                                                                                                |enum                                                                                                |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+

.. topic:: GroupRoot.Group.Sq1TuneProcess.WriteDevice

    | Force write of device without recursion.


    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |Field                                                                                               |Value                                                                                               |
    +====================================================================================================+====================================================================================================+
    |name                                                                                                |WriteDevice                                                                                         |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |path                                                                                                |GroupRoot.Group.Sq1TuneProcess.WriteDevice                                                          |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |typeStr                                                                                             |str                                                                                                 |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |disp                                                                                                |{}                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+

.. topic:: GroupRoot.Group.Sq1TuneProcess.Start

    | Start process.
    | No Args.


    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |Field                                                                                               |Value                                                                                               |
    +====================================================================================================+====================================================================================================+
    |name                                                                                                |Start                                                                                               |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |path                                                                                                |GroupRoot.Group.Sq1TuneProcess.Start                                                                |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |typeStr                                                                                             |int                                                                                                 |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |disp                                                                                                |{}                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+

.. topic:: GroupRoot.Group.Sq1TuneProcess.Stop

    | Stop process.
    | No Args.


    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |Field                                                                                               |Value                                                                                               |
    +====================================================================================================+====================================================================================================+
    |name                                                                                                |Stop                                                                                                |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |path                                                                                                |GroupRoot.Group.Sq1TuneProcess.Stop                                                                 |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |typeStr                                                                                             |int                                                                                                 |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |disp                                                                                                |{}                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+