ska\_tmc\_subarraynode.manager package
======================================

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

Subpackages
-----------

.. toctree::
   :maxdepth: 4

   ska_tmc_subarraynode.manager.transition_rules

Submodules
----------


*aggregators*
~~~~~~~~~~~~~
**Path:** *src/ska\_tmc\_subarraynode/manager/aggregators.py*

.. automodule:: ska_tmc_subarraynode.manager.aggregators
   :members:
   :undoc-members:
   :show-inheritance:

*aggregate\_process*
~~~~~~~~~~~~~~~~~~~~
**Path:** *src/ska\_tmc\_subarraynode/manager/aggregate\_process.py*

.. automodule:: ska_tmc_subarraynode.manager.aggregate_process
   :members:
   :undoc-members:
   :show-inheritance:

*event\_data\_manager*
~~~~~~~~~~~~~~~~~~~~~~
**Path:** *src/ska\_tmc\_subarraynode/manager/event\_data\_manager.py*

.. automodule:: ska_tmc_subarraynode.manager.event_data_manager
   :members:
   :undoc-members:
   :show-inheritance:


*event\_manager*
~~~~~~~~~~~~~~~~
**Path:** *src/ska\_tmc\_subarraynode/manager/event\_manager.py*

.. automodule:: ska_tmc_subarraynode.manager.event_manager
   :members:
   :undoc-members:
   :show-inheritance:

*subarray\_node\_component\_manager*
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Path:** *src/ska\_tmc\_subarraynode/manager/subarray\_node\_component\_manager.py*

.. automodule:: ska_tmc_subarraynode.manager.subarray_node_component_manager
   :members:
   :undoc-members:
   :show-inheritance:

*subarray\_node\_component\_manager\_low*
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Path:** *src/ska\_tmc\_subarraynode/manager/subarray\_node\_component\_manager\_low.py*

.. automodule:: ska_tmc_subarraynode.manager.subarray_node_component_manager_low
   :members:
   :undoc-members:
   :show-inheritance:

*subarray\_node\_component\_manager\_mid*
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Path:** *src/ska\_tmc\_subarraynode/manager/subarray\_node\_component\_manager\_mid.py*

.. automodule:: ska_tmc_subarraynode.manager.subarray_node_component_manager_mid
   :members:
   :undoc-members:
   :show-inheritance:

Module contents
---------------

.. automodule:: ska_tmc_subarraynode.manager
   :members:
   :undoc-members:
   :show-inheritance:


Command Timeout
===============

The ``CommandTimeout`` attribute is introduced to allow updating the timeout value
for commands without requiring a redeployment. This provides flexibility in tuning
the timeout dynamically at runtime based on operational needs.

The ``CommandTimeOutDefault`` property is also introduced, which can be used to set
a default timeout value during the deployment phase. This ensures that an initial
timeout value is preconfigured when the component starts for the first time.

Usage
-----

* **CommandTimeout attribute**  
  - Can be updated at runtime without redeployment.
  - Helps in adapting to varying command execution times.

* **CommandTimeOutDefault property**  
  - Configurable in the deployment configuration (e.g., ``values.yaml``).
  - Sets the initial timeout value at startup.