TMC Common Tango Helper Devices
================================

Devices and their functionality
-------------------------------

Functionality
-------------

- Pytango Devices - Similar to real devices 
- Fault Injection - To make devices faulty to check error handling in tango devices


Device List
===========

1. Helper_CSP_Master
--------------------
.. automodule:: ska_tmc_common.test_helpers.helper_csp_master_device
.. autoclass:: ska_tmc_common.test_helpers.helper_csp_master_device.HelperCspMasterDevice
   :members:
   :undoc-members:
   :show-inheritance:


2. Helper_CSP_Subarray
----------------------
.. automodule:: ska_tmc_common.test_helpers.helper_csp_subarray_leaf_device
.. autoclass:: ska_tmc_common.test_helpers.helper_csp_subarray_leaf_device.HelperCspSubarrayLeafDevice
   :members:
   :undoc-members:
   :show-inheritance:

3. Helper_Dish_Device
---------------------
.. automodule:: ska_tmc_common.test_helpers.helper_dish_device
.. autoclass:: ska_tmc_common.test_helpers.helper_dish_device.HelperDishDevice
   :members:
   :undoc-members:
   :show-inheritance:

4. Helper_SDP_Subarray
----------------------
.. automodule:: ska_tmc_common.test_helpers.helper_sdp_subarray
.. autoclass:: ska_tmc_common.test_helpers.helper_sdp_subarray.HelperSdpSubarray
   :members:
   :undoc-members:
   :show-inheritance:

5. Helper_SDP_Subarray_leaf_Device
----------------------------------
.. automodule:: ska_tmc_common.test_helpers.helper_sdp_subarray_leaf_device
.. autoclass:: ska_tmc_common.test_helpers.helper_sdp_subarray_leaf_device.HelperSdpSubarrayLeafDevice
   :members:
   :undoc-members:
   :show-inheritance:

6. Helper_StateMCCS_Device
--------------------------
.. automodule:: ska_tmc_common.test_helpers.helper_state_mccsdevice
.. autoclass:: ska_tmc_common.test_helpers.helper_state_mccsdevice.HelperMCCSStateDevice
   :members:
   :undoc-members:
   :show-inheritance:

7. Helper_Subarray_Device
-------------------------
.. automodule:: ska_tmc_common.test_helpers.helper_subarray_device
.. autoclass:: ska_tmc_common.test_helpers.helper_subarray_device.HelperSubArrayDevice
   :members:
   :undoc-members:
   :show-inheritance:


8. Helper_Subarray_Leaf_Device
------------------------------
.. automodule:: ska_tmc_common.test_helpers.helper_subarray_leaf_device
.. autoclass:: ska_tmc_common.test_helpers.helper_subarray_leaf_device.HelperSubarrayLeafDevice
   :members:
   :undoc-members:
   :show-inheritance:


Conclusion
-----------

This module contain all helper devices required in TMC for testing and debugging  




.. .. toctree::
..    :maxdepth: 2

.. .. automodule:: ska_tmc_common.tango_server_helper
.. .. autoclass:: ska_tmc_common.tango_helper_devices.TangoHelperDevices
..    :members:
..    :undoc-members: