****************************
SaOffsetProcess
****************************

| Process which attempts to find an SaOffset value which results in the SaOut value being zero.
| A PID controller is used with configurable parameters, including a precision value to determine how close to zero the loop must come.
| A timeout value will terminate the process if it fails to converge witing a set period of time.


Summary
#######

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

* Running
* Progress
* Message
* SaOffsetOutput

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

* Start
* Stop

Details
#######

Variables
*********

.. topic:: GroupRoot.Group.SaOffsetProcess.Running

    | Status values indicating if operation is running.


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

.. topic:: GroupRoot.Group.SaOffsetProcess.Progress

    | Percent complete: 0 - 100 %.


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

.. topic:: GroupRoot.Group.SaOffsetProcess.Message

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


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

.. topic:: GroupRoot.Group.SaOffsetProcess.SaOffsetOutput

    | Results Data From SA Offset.
    | This is an array of values, one for each column.
    | The length is ColumnCount * 8'.


    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |Field                                                                                               |Value                                                                                               |
    +====================================================================================================+====================================================================================================+
    |name                                                                                                |SaOffsetOutput                                                                                      |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |path                                                                                                |GroupRoot.Group.SaOffsetProcess.SaOffsetOutput                                                      |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |typeStr                                                                                             |list                                                                                                |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |disp                                                                                                |{}                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |precision                                                                                           |0                                                                                                   |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
    |mode                                                                                                |RO                                                                                                  |
    +----------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+

Commands
********

.. topic:: GroupRoot.Group.SaOffsetProcess.Start

    | Start process.
    | No Args.


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

.. topic:: GroupRoot.Group.SaOffsetProcess.Stop

    | Stop process.
    | No Args.


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