ska_tmc_sdpsubarrayleafnode.commands package

Link to the TMC User documentation is here.

Submodules

ska_tmc_sdpsubarrayleafnode.commands.sdp_sln_command module

SDP Subarray Leaf Node Base Command Class for SDP Subarray Leaf Node

class ska_tmc_sdpsubarrayleafnode.commands.sdp_sln_command.SdpSLNCommand(*args: Any, **kwargs: Any)

Bases: TmcLeafNodeCommand

SDP Subarray Leaf Node Class

check_op_state(command_name) → None

Checks the operational state of the device

do(argin: Optional[Any] = None)

Abstract Method from TmcLeafNodeCommand is defined here but not utilized by this Class.

Parameters:

argin (_type_, optional) – Accepts argument if required. Defaults to None.

do_low(argin: Optional[Any] = None)

Abstract Method from TmcLeafNodeCommand is defined here but not utilized by this Class.

Parameters:

argin (_type_, optional) – Accepts argument if required. Defaults to None.

do_mid(argin: Optional[Any] = None)

Abstract Method from TmcLeafNodeCommand is defined here but not utilized by this Class.

Parameters:

argin (_type_, optional) – Accepts argument if required. Defaults to None.

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

Initialises required adapters for tango devices

Returns:

Tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

init_adapter_low()

Initialises required adapters for low

init_adapter_mid()

Initialises required adapters for low

update_task_status(**kwargs: Dict[str, Union[Tuple[ska_tango_base.commands.ResultCode, str], ska_control_model.task_status.TaskStatus, str]]) → None

Update the status of a task.

Parameters:

**kwargs – Keyword arguments for task status update.

ska_tmc_sdpsubarrayleafnode.commands.sdp_sln_command.task_callback_default(status: TaskStatus | None = None, progress: int | None = None, result: Any = None, exception: Exception | None = None) → None

Default method if the taskcallback is not passed

Parameters:

• status – status of the task.

• progress – progress of the task.

• result – result of the task.

• exception – an exception raised from the task.

ska_tmc_sdpsubarrayleafnode.commands.off_command module

Off command class for SdpSubarrayLeafNode.

class ska_tmc_sdpsubarrayleafnode.commands.off_command.Off(*args: Any, **kwargs: Any)

Bases: SdpSLNCommand

A class for SdpSubarrayLeafNode’s Off() command.

This command turns off SDP Subarray device.

do(argin: Optional[Any] = None) → Tuple[ska_tango_base.commands.ResultCode, str]

Method to invoke Off command on SdpSubarray.

Parameters:

argin – Optional argument.

Returns:

tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

off(logger: Logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Optional[Event] = None) → None

A method to invoke the Off command. It sets the task_callback status according to command progress.

Parameters:

• logger (logging.Logger) – logger

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

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

ska_tmc_sdpsubarrayleafnode.commands.on_command module

On command class for SdpSubarrayLeafNode.

class ska_tmc_sdpsubarrayleafnode.commands.on_command.On(*args: Any, **kwargs: Any)

Bases: SdpSLNCommand

A class for SdpSubarrayLeafNode’s On() command.

This command turns on SDP Subarray device.

do(argin: Optional[Any] = None) → Tuple[ska_tango_base.commands.ResultCode, str]

Method to invoke On command on SdpSubarray.

Parameters:

argin – Optional argument.

Returns:

tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

on(logger: Logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Optional[Event] = None) → None

A method to invoke the On command. It sets the task_callback status according to command progress.

Parameters:

• logger (logging.Logger) – logger

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

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

ska_tmc_sdpsubarrayleafnode.commands.assign_resources_command module

AssignResouces command class for SDPSubarrayLeafNode.

class ska_tmc_sdpsubarrayleafnode.commands.assign_resources_command.AssignResources(*args: Any, **kwargs: Any)

Bases: SdpSLNCommand

A class for SdpSubarayLeafNode’s AssignResources() command. Assigns resources to given SDP Subarray.

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

Method to invoke AssignResources command on SDP Subarray.

Parameters:

argin (str) –

The string in JSON format. The JSON contains following values: Mandatory JSON object consisting of

• interface:

  interface version

• eb_id:

  String

• max_length:

  Float

Example JSON for Assign Resources

{
	"interface": "https://schema.skao.int/ska-sdp-assignres/1.0",
	"execution_block": {
		"eb_id": "eb-mvp01-20200325-00001",
		"max_length": 100,
		"context": {},
		"beams": [
			{
				"beam_id": "vis0",
				"function": "visibilities"
			},
			{
				"beam_id": "pss1",
				"search_beam_id": 1,
				"function": "pulsar search"
			},
			{
				"beam_id": "pss2",
				"search_beam_id": 2,
				"function": "pulsar search"
			},
			{
				"beam_id": "pst1",
				"timing_beam_id": 1,
				"function": "pulsar timing"
			},
			{
				"beam_id": "pst2",
				"timing_beam_id": 2,
				"function": "pulsar timing"
			},
			{
				"beam_id": "vlbi1",
				"vlbi_beam_id": 1,
				"function": "vlbi"
			}
		],
		"scan_types": [
			{
				"scan_type_id": ".default",
				"beams": {
					"vis0": {
						"channels_id": "vis_channels",
						"polarisations_id": "all"
					},
					"pss1": {
						"field_id": "pss_field_0",
						"channels_id": "pulsar_channels",
						"polarisations_id": "all"
					},
					"pss2": {
						"field_id": "pss_field_1",
						"channels_id": "pulsar_channels",
						"polarisations_id": "all"
					},
					"pst1": {
						"field_id": "pst_field_0",
						"channels_id": "pulsar_channels",
						"polarisations_id": "all"
					},
					"pst2": {
						"field_id": "pst_field_1",
						"channels_id": "pulsar_channels",
						"polarisations_id": "all"
					},
					"vlbi": {
						"field_id": "vlbi_field",
						"channels_id": "vlbi_channels",
						"polarisations_id": "all"
					}
				}
			},
			{
				"scan_type_id": "target:a",
				"derive_from": ".default",
				"beams": {
					"vis0": {
						"field_id": "field_a"
					}
				}
			}
		],
		"channels": [
			{
				"channels_id": "vis_channels",
				"spectral_windows": [
					{
						"spectral_window_id": "fsp_1_channels",
						"count": 744,
						"start": 0,
						"stride": 2,
						"freq_min": 350000000,
						"freq_max": 368000000,
						"link_map": [
							[
								0,
								0
							],
							[
								200,
								1
							],
							[
								744,
								2
							],
							[
								944,
								3
							]
						]
					},
					{
						"spectral_window_id": "fsp_2_channels",
						"count": 744,
						"start": 2000,
						"stride": 1,
						"freq_min": 360000000,
						"freq_max": 368000000,
						"link_map": [
							[
								2000,
								4
							],
							[
								2200,
								5
							]
						]
					},
					{
						"spectral_window_id": "zoom_window_1",
						"count": 744,
						"start": 4000,
						"stride": 1,
						"freq_min": 360000000,
						"freq_max": 361000000,
						"link_map": [
							[
								4000,
								6
							],
							[
								4200,
								7
							]
						]
					}
				]
			},
			{
				"channels_id": "pulsar_channels",
				"spectral_windows": [
					{
						"spectral_window_id": "pulsar_fsp_channels",
						"count": 744,
						"start": 0,
						"freq_min": 350000000,
						"freq_max": 368000000
					}
				]
			}
		],
		"polarisations": [
			{
				"polarisations_id": "all",
				"corr_type": [
					"XX",
					"XY",
					"YY",
					"YX"
				]
			}
		],
		"fields": [
			{
				"field_id": "field_a",
				"phase_dir": {
					"ra": [
						123,
						0.1
					],
					"dec": [
						123,
						0.1
					],
					"reference_time": "...",
					"reference_frame": "ICRF3"
				},
				"pointing_fqdn": "low-tmc/telstate/0/pointing"
			}
		]
	},
	"processing_blocks": [
		{
			"pb_id": "pb-mvp01-20200325-00001",
			"sbi_ids": [
				"sbi-mvp01-20200325-00001"
			],
			"script": {},
			"parameters": {},
			"dependencies": {}
		},
		{
			"pb_id": "pb-mvp01-20200325-00002",
			"sbi_ids": [
				"sbi-mvp01-20200325-00002"
			],
			"script": {},
			"parameters": {},
			"dependencies": {}
		},
		{
			"pb_id": "pb-mvp01-20200325-00003",
			"sbi_ids": [
				"sbi-mvp01-20200325-00001",
				"sbi-mvp01-20200325-00002"
			],
			"script": {},
			"parameters": {},
			"dependencies": {}
		}
	],
	"resources": {
		"csp_links": [
			1,
			2,
			3,
			4
		],
		"receptors": [
			"FS4",
			"FS8"
		],
		"receive_nodes": 10
	}
}

Note

Enter input without spaces.

Returns:

Tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

ska_tmc_sdpsubarrayleafnode.commands.configure_command module

Configure command class for SdpSubarrayLeafNode.

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

Bases: SdpSLNCommand

This class implements the Configure command for SdpSubarray.

It provides methods to configure the SdpSubarray 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 SDP Subarray.

Parameters:

argin (str) – The string in JSON format. The JSON contains following values:

Example JSON for Configure

{
  "interface": "https://schema.skao.int/ska-sdp-configure/0.4",
  "scan_type": "target:a"
}

Note

Enter input without spaces.

Returns:

Tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

ska_tmc_sdpsubarrayleafnode.commands.end_command module

End command class for SdpSubarrayLeafNode.

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

Bases: SdpSLNCommand

A class for SdpSubarrayLeafNode’s End() command.

Invokes End command on SdpSubarray to end the current Scheduling Block.

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

Method to invoke End command on SdpSubarray.

Returns:

Tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

ska_tmc_sdpsubarrayleafnode.commands.end_scan_command module

EndScan command class for SDPSubarrayLeafNode.

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

Bases: SdpSLNCommand

A class for SdpSubarrayLeafNode’s EndScan() command.

It invokes EndScan command on Sdp Subarray. This command is allowed when Sdp Subarray is in SCANNING obsState.

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

Method to invoke EndScan command on SDP Subarray.

Returns:

Tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

ska_tmc_sdpsubarrayleafnode.commands.release_resources_command module

ReleaseAllResources command class for SdpSubarrayLeafNode.

class ska_tmc_sdpsubarrayleafnode.commands.release_resources_command.ReleaseAllResources(*args: Any, **kwargs: Any)

Bases: SdpSLNCommand

A class for SdpSubarayLeafNode’s ReleaseAllResources() command.

Releases all the resources of given SDP Subarray Leaf Node. It accepts the subarray id, releaseALL flag and receptorIDList in JSON string format.

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

Method to invoke ReleaseAllResources command on SDP Subarray.

Returns:

tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

ska_tmc_sdpsubarrayleafnode.commands.abort_command module

Abort Command for Sdp Subarray.

class ska_tmc_sdpsubarrayleafnode.commands.abort_command.Abort(*args: Any, **kwargs: Any)

Bases: SdpSLNCommand

A class for Sdp Subarray Abort() command. Aborts the Sdp Subarray device.

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

This method invokes Abort command on Sdp Subarray

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

Return type:

Tuple[ResultCode, str]

Raises:

Exception – if error occurs in invoking command on any of the devices like Sdp Subarray.

update_task_status(**kwargs: Dict[str, Union[Tuple[ska_tango_base.commands.ResultCode, str], ska_control_model.task_status.TaskStatus, str]]) → None

Update the status of a task.

Parameters:

**kwargs – Keyword arguments for task status update.

ska_tmc_sdpsubarrayleafnode.commands.restart_command module

Restart command class for Sdp Subarray.

class ska_tmc_sdpsubarrayleafnode.commands.restart_command.Restart(*args: Any, **kwargs: Any)

Bases: SdpSLNCommand

A class for Sdp Subarray Restart command. Restarts the Sdp Subarray device.

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

Method to invoke Restart command on Sdp Subarray.

Returns:

A tuple containing a return code and a string message indicating status.

Return type:

Tuple[ResultCode, str]

update_task_status(**kwargs: Dict[str, Union[Tuple[ska_tango_base.commands.ResultCode, str], ska_control_model.task_status.TaskStatus, str]]) → None

Update the status of a task.

Parameters:

**kwargs – Keyword arguments for task status update.

ska_tmc_sdpsubarrayleafnode.commands.scan_command module

Scan command class for SdpSubarrayLeafNode.

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

Bases: SdpSLNCommand

This class implements the Scan command for SdpSubarray.

It provides methods to Scan the SdpSubarray 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 SDP Subarray.

Parameters:

argin (str) – The string in JSON format. The JSON contains following values:

Example JSON for Scan

{"interface": "https://schema.skao.int/ska-sdp-scan/0.4", "scan_id": 1}

Note

Enter input without spaces.

Returns:

A tuple containing a return code and a string message indicating status.

Return type:

Tuple[ResultCode, str]

ska_tmc_sdpsubarrayleafnode.commands.set_sdp_subarray_admin_mode module

SetAdminMode command class for SDPSubarrayLeafNode.

class ska_tmc_sdpsubarrayleafnode.commands.set_sdp_subarray_admin_mode.SetAdminMode(*args: Any, **kwargs: Any)

Bases: SdpSLNCommand, FastCommand

A class for SDP SubarrayLeafNode’s SetAdminMode() command.

SetAdminMode command on SDP Subarray LeafNode enables to set the adminMode of the SDP subarray device

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

A method to set the adminMode of the SDP Subarray device

Parameters:

argin (AdminMode) – An adminMode enum value to be set for SDP subarray device.

Returns:

A tuple containing a return code and a string message indicating status.

Return type:

Tuple[ResultCode, str]

Module contents

Init module for SDP Subarray Leaf Node.

class ska_tmc_sdpsubarrayleafnode.commands.Abort(*args: Any, **kwargs: Any)

Bases: SdpSLNCommand

A class for Sdp Subarray Abort() command. Aborts the Sdp Subarray device.

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

This method invokes Abort command on Sdp Subarray

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

Return type:

Tuple[ResultCode, str]

Raises:

Exception – if error occurs in invoking command on any of the devices like Sdp Subarray.

update_task_status(**kwargs: Dict[str, Union[Tuple[ska_tango_base.commands.ResultCode, str], ska_control_model.task_status.TaskStatus, str]]) → None

Update the status of a task.

Parameters:

**kwargs – Keyword arguments for task status update.

class ska_tmc_sdpsubarrayleafnode.commands.AssignResources(*args: Any, **kwargs: Any)

Bases: SdpSLNCommand

A class for SdpSubarayLeafNode’s AssignResources() command. Assigns resources to given SDP Subarray.

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

Method to invoke AssignResources command on SDP Subarray.

Parameters:

argin (str) –

The string in JSON format. The JSON contains following values: Mandatory JSON object consisting of

• interface:

  interface version

• eb_id:

  String

• max_length:

  Float

Example JSON for Assign Resources

{
	"interface": "https://schema.skao.int/ska-sdp-assignres/1.0",
	"execution_block": {
		"eb_id": "eb-mvp01-20200325-00001",
		"max_length": 100,
		"context": {},
		"beams": [
			{
				"beam_id": "vis0",
				"function": "visibilities"
			},
			{
				"beam_id": "pss1",
				"search_beam_id": 1,
				"function": "pulsar search"
			},
			{
				"beam_id": "pss2",
				"search_beam_id": 2,
				"function": "pulsar search"
			},
			{
				"beam_id": "pst1",
				"timing_beam_id": 1,
				"function": "pulsar timing"
			},
			{
				"beam_id": "pst2",
				"timing_beam_id": 2,
				"function": "pulsar timing"
			},
			{
				"beam_id": "vlbi1",
				"vlbi_beam_id": 1,
				"function": "vlbi"
			}
		],
		"scan_types": [
			{
				"scan_type_id": ".default",
				"beams": {
					"vis0": {
						"channels_id": "vis_channels",
						"polarisations_id": "all"
					},
					"pss1": {
						"field_id": "pss_field_0",
						"channels_id": "pulsar_channels",
						"polarisations_id": "all"
					},
					"pss2": {
						"field_id": "pss_field_1",
						"channels_id": "pulsar_channels",
						"polarisations_id": "all"
					},
					"pst1": {
						"field_id": "pst_field_0",
						"channels_id": "pulsar_channels",
						"polarisations_id": "all"
					},
					"pst2": {
						"field_id": "pst_field_1",
						"channels_id": "pulsar_channels",
						"polarisations_id": "all"
					},
					"vlbi": {
						"field_id": "vlbi_field",
						"channels_id": "vlbi_channels",
						"polarisations_id": "all"
					}
				}
			},
			{
				"scan_type_id": "target:a",
				"derive_from": ".default",
				"beams": {
					"vis0": {
						"field_id": "field_a"
					}
				}
			}
		],
		"channels": [
			{
				"channels_id": "vis_channels",
				"spectral_windows": [
					{
						"spectral_window_id": "fsp_1_channels",
						"count": 744,
						"start": 0,
						"stride": 2,
						"freq_min": 350000000,
						"freq_max": 368000000,
						"link_map": [
							[
								0,
								0
							],
							[
								200,
								1
							],
							[
								744,
								2
							],
							[
								944,
								3
							]
						]
					},
					{
						"spectral_window_id": "fsp_2_channels",
						"count": 744,
						"start": 2000,
						"stride": 1,
						"freq_min": 360000000,
						"freq_max": 368000000,
						"link_map": [
							[
								2000,
								4
							],
							[
								2200,
								5
							]
						]
					},
					{
						"spectral_window_id": "zoom_window_1",
						"count": 744,
						"start": 4000,
						"stride": 1,
						"freq_min": 360000000,
						"freq_max": 361000000,
						"link_map": [
							[
								4000,
								6
							],
							[
								4200,
								7
							]
						]
					}
				]
			},
			{
				"channels_id": "pulsar_channels",
				"spectral_windows": [
					{
						"spectral_window_id": "pulsar_fsp_channels",
						"count": 744,
						"start": 0,
						"freq_min": 350000000,
						"freq_max": 368000000
					}
				]
			}
		],
		"polarisations": [
			{
				"polarisations_id": "all",
				"corr_type": [
					"XX",
					"XY",
					"YY",
					"YX"
				]
			}
		],
		"fields": [
			{
				"field_id": "field_a",
				"phase_dir": {
					"ra": [
						123,
						0.1
					],
					"dec": [
						123,
						0.1
					],
					"reference_time": "...",
					"reference_frame": "ICRF3"
				},
				"pointing_fqdn": "low-tmc/telstate/0/pointing"
			}
		]
	},
	"processing_blocks": [
		{
			"pb_id": "pb-mvp01-20200325-00001",
			"sbi_ids": [
				"sbi-mvp01-20200325-00001"
			],
			"script": {},
			"parameters": {},
			"dependencies": {}
		},
		{
			"pb_id": "pb-mvp01-20200325-00002",
			"sbi_ids": [
				"sbi-mvp01-20200325-00002"
			],
			"script": {},
			"parameters": {},
			"dependencies": {}
		},
		{
			"pb_id": "pb-mvp01-20200325-00003",
			"sbi_ids": [
				"sbi-mvp01-20200325-00001",
				"sbi-mvp01-20200325-00002"
			],
			"script": {},
			"parameters": {},
			"dependencies": {}
		}
	],
	"resources": {
		"csp_links": [
			1,
			2,
			3,
			4
		],
		"receptors": [
			"FS4",
			"FS8"
		],
		"receive_nodes": 10
	}
}

Note

Enter input without spaces.

Returns:

Tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

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

Bases: SdpSLNCommand

This class implements the Configure command for SdpSubarray.

It provides methods to configure the SdpSubarray 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 SDP Subarray.

Parameters:

argin (str) – The string in JSON format. The JSON contains following values:

Example JSON for Configure

{
  "interface": "https://schema.skao.int/ska-sdp-configure/0.4",
  "scan_type": "target:a"
}

Note

Enter input without spaces.

Returns:

Tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

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

Bases: SdpSLNCommand

A class for SdpSubarrayLeafNode’s End() command.

Invokes End command on SdpSubarray to end the current Scheduling Block.

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

Method to invoke End command on SdpSubarray.

Returns:

Tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

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

Bases: SdpSLNCommand

A class for SdpSubarrayLeafNode’s EndScan() command.

It invokes EndScan command on Sdp Subarray. This command is allowed when Sdp Subarray is in SCANNING obsState.

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

Method to invoke EndScan command on SDP Subarray.

Returns:

Tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

class ska_tmc_sdpsubarrayleafnode.commands.Off(*args: Any, **kwargs: Any)

Bases: SdpSLNCommand

A class for SdpSubarrayLeafNode’s Off() command.

This command turns off SDP Subarray device.

do(argin: Optional[Any] = None) → Tuple[ska_tango_base.commands.ResultCode, str]

Method to invoke Off command on SdpSubarray.

Parameters:

argin – Optional argument.

Returns:

tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

off(logger: Logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Optional[Event] = None) → None

A method to invoke the Off command. It sets the task_callback status according to command progress.

Parameters:

• logger (logging.Logger) – logger

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

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

class ska_tmc_sdpsubarrayleafnode.commands.On(*args: Any, **kwargs: Any)

Bases: SdpSLNCommand

A class for SdpSubarrayLeafNode’s On() command.

This command turns on SDP Subarray device.

do(argin: Optional[Any] = None) → Tuple[ska_tango_base.commands.ResultCode, str]

Method to invoke On command on SdpSubarray.

Parameters:

argin – Optional argument.

Returns:

tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

on(logger: Logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Optional[Event] = None) → None

A method to invoke the On command. It sets the task_callback status according to command progress.

Parameters:

• logger (logging.Logger) – logger

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

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

class ska_tmc_sdpsubarrayleafnode.commands.ReleaseAllResources(*args: Any, **kwargs: Any)

Bases: SdpSLNCommand

A class for SdpSubarayLeafNode’s ReleaseAllResources() command.

Releases all the resources of given SDP Subarray Leaf Node. It accepts the subarray id, releaseALL flag and receptorIDList in JSON string format.

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

Method to invoke ReleaseAllResources command on SDP Subarray.

Returns:

tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

class ska_tmc_sdpsubarrayleafnode.commands.Restart(*args: Any, **kwargs: Any)

Bases: SdpSLNCommand

A class for Sdp Subarray Restart command. Restarts the Sdp Subarray device.

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

Method to invoke Restart command on Sdp Subarray.

Returns:

A tuple containing a return code and a string message indicating status.

Return type:

Tuple[ResultCode, str]

update_task_status(**kwargs: Dict[str, Union[Tuple[ska_tango_base.commands.ResultCode, str], ska_control_model.task_status.TaskStatus, str]]) → None

Update the status of a task.

Parameters:

**kwargs – Keyword arguments for task status update.

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

Bases: SdpSLNCommand

This class implements the Scan command for SdpSubarray.

It provides methods to Scan the SdpSubarray 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 SDP Subarray.

Parameters:

argin (str) – The string in JSON format. The JSON contains following values:

Example JSON for Scan

{"interface": "https://schema.skao.int/ska-sdp-scan/0.4", "scan_id": 1}

Note

Enter input without spaces.

Returns:

A tuple containing a return code and a string message indicating status.

Return type:

Tuple[ResultCode, str]

class ska_tmc_sdpsubarrayleafnode.commands.SetAdminMode(*args: Any, **kwargs: Any)

Bases: SdpSLNCommand, FastCommand

A class for SDP SubarrayLeafNode’s SetAdminMode() command.

SetAdminMode command on SDP Subarray LeafNode enables to set the adminMode of the SDP subarray device

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

A method to set the adminMode of the SDP Subarray device

Parameters:

argin (AdminMode) – An adminMode enum value to be set for SDP subarray device.

Returns:

A tuple containing a return code and a string message indicating status.

Return type:

Tuple[ResultCode, str]