.. _endlow:

======
End
======

1. The Subarray node provides API for **End workflow**.
2. The purpose of command is to conclude an observation block: it stops subsystem configuration context (but does not free resources) and moves the subarray from a **READY** or post-scan condition back to an **IDLE** state ready either for another configure or for later full release.
3. The Sub-array node **accepts the command** if :-

    A. Admin mode reported by each of the system - CSP,SDP subarray are in **ONLINE/ENGINEERING/RESERVED**
    B. Operational state of the Sub-array node is **ON/OFF/INIT/STANDBY/ALARM**

4. The Sub-array Node **rejects the command** if :-

    A. Admin mode reported by each of the system - CSP,SDP Sub-array are in **OFFLINE** or **NOT FITTED**.
    B. Operational state of central node is **FAULT/UNKNOWN/DISABLE** .

5. The following **state requirements** are applied for the **command execution** :-

    A. TMC Subarray is in `'observation state'` **IDLE** or **READY** .
    B. :term:`isSubarrayAvailable` is checked to ensure the subsystems (CSP, SDP and MCCS) are :term:`available`

6. The command execution involves below key operations :-
    A. Resets or clears any stored scan duration and associated timing or scan completion timers .
    B. The command is then invoked on the relevant TMC CSP, SDP, MCCS leaf Nodes.

        * If leaf node rejects End command , command failure is reported as **'RESULT_CODE - FAILED'** on Long Running Command Result attribute of the TMC Subarry node.Command will not be sent to remaining subsystems in this case if multiple subsystems are involved .
        * If all leaf node accept command , the TMC Subarry node will wait for command completion.

7. The Sub-array node monitors the progress of command via the Sub-array node ObsState transitions and the long running command results.
    
    A. Command is successful when the TMC Subarray Node transitions to **IDLE** ObsState. This is reported as **'RESULT_CODE - OK'** on Long Running Command Result attribute of the Subarray node.
    B. Command failure is reported in any of the below cases as **'RESULT_CODE - FAILED'** on Long Running Command Result attribute of the sub-array node.

        * The CSP Leaf node/SDP Leaf node/MCCS Leaf node reports **'RESULT_CODE - FAILED'** on its Long Running Command Result attribute
        * The command times out if TMC SubarrayNode does not transition to **IDLE** within the timeout period specified by `CommandTimeOutDefault` property specified in helm chart of the TMC Subarray node .

8. On success the system is ready for Release Resources or next configure; on failure it may revert to **READY** or **FAULT** depending on severity.