ska_tmc_mccssubarrayleafnode.commands package

Submodules

ska_tmc_mccssubarrayleafnode.commands.mccssubarrayln_command module

Common Command module for MCCS Subarray Leaf Node

class ska_tmc_mccssubarrayleafnode.commands.mccs_subarrayln_command.MccsSLNCommand(*args: Any, **kwargs: Any)

Bases: TmcLeafNodeCommand

Common Command class for MCCSSubarrayLeaf Node, responsible for handling commands related to the MCCSSubarrayleafNode.

init_adapter() tuple

Initialize the adapter for communication with the MCCS Subarray device.

Returns:

A tuple containing the result code and message indicating the

status of the adapter initialization. :rtype: tuple(ResultCode, str)

ska_tmcs_mccssubarrayleafnode.commands.configure_command module

Configure command class for MccsSubarrayLeafNode.

class ska_tmc_mccssubarrayleafnode.commands.configure_command.Configure(*args: Any, **kwargs: Any)

Bases: MccsSLNCommand

This class implements the Configure command for Mccs Subarray.

It provides methods to configure the Mccs Subarray device and handle the execution of the Configure command.

do(argin=None)

Method to invoke Configure command on Mccs Subarray. :param argin: The string in JSON format. The JSON contains following values: Example: {“interface”: “https://schema.skatelescope.org/ska-low-mccs-subarray-configure/3.0”, “subarray_beams”: [{“subarray_beam_id”: 1, “update_rate”: 0.0, “logical_bands”: [{“start_channel”: 80, “number_of_channels”: 16}, {“start_channel”: 384, “number_of_channels”: 16}], “apertures”: [{“aperture_id”: “AP001.01”, “weighting_key_ref”: “aperture2”}, {“aperture_id”: “AP001.02”, “weighting_key_ref”: “aperture3”}, {“aperture_id”: “AP002.01”, “weighting_key_ref”: “aperture2”}, {“aperture_id”: “AP002.02”, “weighting_key_ref”: “aperture3”}, {“aperture_id”: “AP003.01”, “weighting_key_ref”: “aperture1”}], “sky_coordinates”:{“timestamp”: “2021-10-23T12:34:56.789Z”, “reference_frame”: “ICRS”, “c1”: 180.0, “c1_rate”: 0.0, “c2”: 45.0, “c2_rate”: 0.0}}]}

return: None

invoke_configure(argin: str, logger: Logger, task_callback: Callable, task_abort_event: Event) None

This is a long running method for Configure command, it executes do hook, invokes Configure command on Mccs Subarray.

Parameters:
  • logger (logging.Logger) – logger

  • task_callback (Callable, optional) – Update task state, defaults to None

update_task_status(result: ska_tango_base.commands.ResultCode, message: str = '')

ska_tmc_mccssubarrayleafnode.commands.end_command module

End command class for MccsSubarrayLeafNode.

class ska_tmc_mccssubarrayleafnode.commands.end_command.End(*args: Any, **kwargs: Any)

Bases: MccsSLNCommand

A class for MccsSubarrayLeafNode’s End() command.

It invokes End command on Mccs Subarray.

do(argin: Optional[str] = None) tuple

Method to invoke End command on Mccs Subarray.

Parameters:

argin – None.

Returns:

(ResultCode, message)

Raises:

Exception – if the command execution is not successful

end(logger, task_callback: Callable, task_abort_event: Event)

This is a long running method for End command, it executes do hook, invokes End command on Mccs Subarray.

Parameters:
  • logger (logging.Logger) – logger

  • task_callback (Callable, optional) – Update task state, defaults to None

  • task_abort_event (Event, optional) – Check for abort, defaults to None

Module contents