ska\_tmc\_subarraynode package
==============================

Link to the TMC User documentation is `here <https://confluence.skatelescope.org/display/UD/TMC+User+Documentation>`_.

See the :ref:`commands` section for details about TMC command workflows.


.. toctree::
   :maxdepth: 1
   :caption: TMC Subarray Node

   ska_tmc_subarraynode.subarray_node
   ska_tmc_subarraynode.commands
   ska_tmc_subarraynode.model
   ska_tmc_subarraynode.utils
   ska_tmc_subarraynode.input_validator
   ska_tmc_subarraynode.manager
   


.. toctree::
   :maxdepth: 1
   :caption: TMC Subarray Node Low

   ska_tmc_subarraynode.subarray_node_low
   low-tmc-subarray-device

.. toctree::
   :maxdepth: 1
   :caption: TMC Subarray Node Mid

   ska_tmc_subarraynode.subarray_node_mid
   mid-tmc-subarray-device



###########################
Properties in Subarray Node
###########################


+-----------------------------------+-----------------+--------------------------------------------------------------------------------+
| Property Name                     | Data Type       | Description                                                                    |
+===================================+=================+================================================================================+
| CspSubarrayLNFQDN                 | DevString       | FQDN of the CSP Subarray Leaf Node device                                      |
+-----------------------------------+-----------------+--------------------------------------------------------------------------------+
| SdpSubarrayLNFQDN                 | DevString       | FQDN of the SDP Subarray Leaf Node device                                      |
+-----------------------------------+-----------------+--------------------------------------------------------------------------------+
| CspSubarrayFQDN                   | DevString       | FQDN of the CSP Subarray device                                                |
+-----------------------------------+-----------------+--------------------------------------------------------------------------------+
| SdpSubarrayFQDN                   | DevString       | FQDN of the SDP Subarray device                                                |
+-----------------------------------+-----------------+--------------------------------------------------------------------------------+
| AbortCommandTimeOut               | DevUShort       | Timeout for the Subarray ABORTED obsState transition. Once                     |
|                                   |                 | the AbortCommandTimeOut exceeds, SubarrayNode transitions to obsState FAULT.   |
+-----------------------------------+-----------------+--------------------------------------------------------------------------------+
| CspScanInterfaceURL               | DevString       | Interface URL of the CSP sub-system for Scan command                           |
+-----------------------------------+-----------------+--------------------------------------------------------------------------------+
| SdpScanInterfaceURL               | DevString       | Interface URL of the SDP sub-system for Scan command                           |
+-----------------------------------+-----------------+--------------------------------------------------------------------------------+
| CspAssignResourcesInterfaceURL    | DevString       | Interface URL of the CSP sub-system for AssignResources command                |
+-----------------------------------+-----------------+--------------------------------------------------------------------------------+
| CommandTimeOutDefault             | DevUShort       | Timeout for the command execution                                              |
+-----------------------------------+-----------------+--------------------------------------------------------------------------------+
| LivelinessCheckPeriod             | DevFloat        | Period for the liveliness probe to monitor each device in a loop               |
+-----------------------------------+-----------------+--------------------------------------------------------------------------------+
| EventSubscriptionCheckPeriod      | DevFloat        | Period for the event subscriber to check the device subscriptions in a loop    |
+-----------------------------------+-----------------+--------------------------------------------------------------------------------+


##########################################
Additional Properties in Subarray Node Mid
##########################################


+-------------------------------------+----------------+--------------------------------------------------------------------------------+
| Property Name                       | Data Type      | Description                                                                    |
+=====================================+================+================================================================================+
| DishLeafNodePrefix                  | DevString      | Device name prefix for Dish Leaf Node. This property is for internal use.      |
+-------------------------------------+----------------+--------------------------------------------------------------------------------+
| DishMasterIdentifier                | DevString      | Device name tag/identifier for Dish Master device. This property is for        |
|                                     |                | internal use.                                                                  |
+-------------------------------------+----------------+--------------------------------------------------------------------------------+
| DishMasterFQDNs                     | DevStringArray | List of Dish Master devices. This property derived from the values of          |
|                                     |                | properties DishIDs and DishMasterIdentifier. It is for internal use.           |
+-------------------------------------+----------------+--------------------------------------------------------------------------------+

##########################################
Additional Properties in Subarray Node Low
##########################################


+-------------------------------+---------------+----------------------------------------------------------------------------------------------+
| Property Name                 | Data Type     | Description                                                                                  |
+===============================+===============+==============================================================================================+
| MccsSubarrayLNFQDN            | DevString     | FQDN of the MCCS Subarray Leaf Node Tango Device Server                                      |
+-------------------------------+---------------+----------------------------------------------------------------------------------------------+
| MccsSubarrayFQDN              | DevString     | FQDN of the MCCS Subarray device                                                             |
+-------------------------------+---------------+----------------------------------------------------------------------------------------------+
| MccsControllerFQDN            | DevString     | FQDN of the MCCS Controller device                                                           |
+-------------------------------+---------------+----------------------------------------------------------------------------------------------+
| MccsMasterLNFQDN              | DevString     | FQDN of the MCCS Master Leaf Node                                                            |
+-------------------------------+---------------+----------------------------------------------------------------------------------------------+
| MccsConfigureInterfaceURL     | DevString     | Interface URL of the MCCS sub-system for Configure command                                   |
+-------------------------------+---------------+----------------------------------------------------------------------------------------------+
| MccsReleaseInterfaceURL       | DevString     | Interface URL of the MCCS sub-system for Release command                                     |
+-------------------------------+---------------+----------------------------------------------------------------------------------------------+
| MccsScanInterfaceURL          | DevString     | Interface URL of the MCCS sub-system for Scan command                                        |
+-------------------------------+---------------+----------------------------------------------------------------------------------------------+
| JonesURI                      | DevString     | URI for Jones Matrix                                                                         |
+-------------------------------+---------------+----------------------------------------------------------------------------------------------+
| IsAutoRecoveryEnabled         | DevBoolean    | Feature Flag used temporarily till all the nodes are tested with auto recovery functionality |
+-------------------------------+---------------+----------------------------------------------------------------------------------------------+