ska_tmc_mccssubarrayleafnode.commands package

Submodules

ska_tmc_mccssubarrayleafnode.commands.mccssubarrayln_command module

This module provides the implementation of the MccsSLNCommand class, which is a common command class for MCCS Subarray Leaf Node. It contains common functionality for the commands present on this device.

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

Bases: TmcLeafNodeCommand

Common Command class for MCCS Subarray Leaf Node. This class provides common functionality for the commands present on this device.

init_adapter() → Tuple[ska_tango_base.commands.ResultCode, str]

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.

set_command_id(command_name: str)

Sets the command id for error propagation.

Parameters:

command_name – Name of the command

Command_name dtype:

str

update_task_status(**kwargs) → None

Method to update task status with result code and exception message if any.

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: str) → Tuple[ska_tango_base.commands.ResultCode, str]

Method to invoke Configure command on Mccs Subarray. :param argin: The string in JSON format. :argin dtype: str 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: Tuple[ResultCode, str]:

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

This is a long running method for Configure command, it executes the do hook of the command class.

Parameters:

  • argin – Input json string for the configure command

  • task_callback – A callable function to update the command status.

  • task_abort_event – A threading event to notify in case of Abort command being called.

Argin dtype:

str

Task_callback dtype:

Callable

Task_abort_event dtype:

Event

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.

do() → Tuple[ska_tango_base.commands.ResultCode, str]

Method to invoke End command on Mccs Subarray.

Return type:

(ResultCode, message)

end(task_callback: Callable, task_abort_event: Event)

This is a long running method for End command, it executes the do hook of the command class.

Parameters:

  • task_callback – A callable function to update the command status.

  • task_abort_event – A threading event to notify in case of Abort command being called.

Task_callback dtype:

Callable

Task_abort_event dtype:

Event

ska_tmc_mccssubarrayleafnode.commands.mccssubarrayln_command module

This module provides the implementation of the MccsSLNCommand class, which is a common command class for MCCS Subarray Leaf Node. It contains common functionality for the commands present on this device.

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

Bases: TmcLeafNodeCommand

Common Command class for MCCS Subarray Leaf Node. This class provides common functionality for the commands present on this device.

init_adapter() → Tuple[ska_tango_base.commands.ResultCode, str]

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.

set_command_id(command_name: str)

Sets the command id for error propagation.

Parameters:

command_name – Name of the command

Command_name dtype:

str

update_task_status(**kwargs) → None

Method to update task status with result code and exception message if any.

ska_tmc_mccssubarrayleafnode.commands.scan_command module

Scan command class for MccsSubarrayLeafNode.

class ska_tmc_mccssubarrayleafnode.commands.scan_command.Scan(*args: Any, **kwargs: Any)

Bases: MccsSLNCommand

This class implements the Scan command for Mccs Subarray.

It provides methods to scan the Mccs Subarray device and handle the execution of the Scan command.

do(argin: str) → Tuple[ska_tango_base.commands.ResultCode, str]

Method to invoke Scan command on Mccs Subarray.

Parameters:

argin – The string in JSON format.

Argin dtype:

str

The JSON contains following values:

Example: { “interface”: “https://schema.skatelescope.org/ska-low-mccs-subarray-scan/3.0”, “scan_id”: 12345678, “start_time”: “2023-12-31T12:34:28Z”, “duration”: 0.0 } :rtype: Tuple[ResultCode, str]

scan(argin: str, task_callback: Callable, task_abort_event: Event) → None

This is a long running method for Scan command, it executes the do hook of the command class.

Parameters:

  • argin – Input json string for the scan command

  • task_callback – A callable function to update the command status.

  • task_abort_event – A threading event to notify in case of Abort command being called.

Argin dtype:

str

Task_callback dtype:

Callable

Task_abort_event dtype:

Event

ska_tmc_mccssubarrayleafnode.commands.endscan_command module

EndScan command class for MccsSubarrayLeafNode.

class ska_tmc_mccssubarrayleafnode.commands.endscan_command.EndScan(*args: Any, **kwargs: Any)

Bases: MccsSLNCommand

This class implements the EndScan command for Mccs Subarray.

It provides methods to endscan the Mccs Subarray device and handle the execution of the EndScan command.

do() → Tuple[ska_tango_base.commands.ResultCode, str]

Method to invoke End command on Mccs Subarray. :return: Tuple[ResultCode, str]:

endscan(task_callback: Callable, task_abort_event: Event) → None

This method executes the EndScan command as a long-running task. It triggers the do hook and invokes the EndScan command on MccsSubarray.

Parameters:

  • task_callback (Callable) – A callback function to update the command status.

  • task_abort_event – A threading event to notify in case of Abort

command being called. :type task_abort_event: threading.Event

Module contents

This is init module for MccsSubarrayleafnode commands.

class ska_tmc_mccssubarrayleafnode.commands.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: str) → Tuple[ska_tango_base.commands.ResultCode, str]

Method to invoke Configure command on Mccs Subarray. :param argin: The string in JSON format. :argin dtype: str 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: Tuple[ResultCode, str]:

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

This is a long running method for Configure command, it executes the do hook of the command class.

Parameters:

  • argin – Input json string for the configure command

  • task_callback – A callable function to update the command status.

  • task_abort_event – A threading event to notify in case of Abort command being called.

Argin dtype:

str

Task_callback dtype:

Callable

Task_abort_event dtype:

Event

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

Bases: MccsSLNCommand

A class for MccsSubarrayLeafNode’s End() command.

do() → Tuple[ska_tango_base.commands.ResultCode, str]

Method to invoke End command on Mccs Subarray.

Return type:

(ResultCode, message)

end(task_callback: Callable, task_abort_event: Event)

This is a long running method for End command, it executes the do hook of the command class.

Parameters:

  • task_callback – A callable function to update the command status.

  • task_abort_event – A threading event to notify in case of Abort command being called.

Task_callback dtype:

Callable

Task_abort_event dtype:

Event

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

Bases: MccsSLNCommand

This class implements the EndScan command for Mccs Subarray.

It provides methods to endscan the Mccs Subarray device and handle the execution of the EndScan command.

do() → Tuple[ska_tango_base.commands.ResultCode, str]

Method to invoke End command on Mccs Subarray. :return: Tuple[ResultCode, str]:

endscan(task_callback: Callable, task_abort_event: Event) → None

This method executes the EndScan command as a long-running task. It triggers the do hook and invokes the EndScan command on MccsSubarray.

Parameters:

  • task_callback (Callable) – A callback function to update the command status.

  • task_abort_event – A threading event to notify in case of Abort

command being called. :type task_abort_event: threading.Event

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

Bases: MccsSLNCommand

This class implements the Scan command for Mccs Subarray.

It provides methods to scan the Mccs Subarray device and handle the execution of the Scan command.

do(argin: str) → Tuple[ska_tango_base.commands.ResultCode, str]

Method to invoke Scan command on Mccs Subarray.

Parameters:

argin – The string in JSON format.

Argin dtype:

str

The JSON contains following values:

Example: { “interface”: “https://schema.skatelescope.org/ska-low-mccs-subarray-scan/3.0”, “scan_id”: 12345678, “start_time”: “2023-12-31T12:34:28Z”, “duration”: 0.0 } :rtype: Tuple[ResultCode, str]

scan(argin: str, task_callback: Callable, task_abort_event: Event) → None

This is a long running method for Scan command, it executes the do hook of the command class.

Parameters:

  • argin – Input json string for the scan command

  • task_callback – A callable function to update the command status.

  • task_abort_event – A threading event to notify in case of Abort command being called.

Argin dtype:

str

Task_callback dtype:

Callable

Task_abort_event dtype:

Event