ska_tmc_sdpsubarrayleafnode.commands package
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
- check_unresponsive() None
Checks whether the device is unresponsive
- 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]
- init_adapter_low()
- init_adapter_mid()
- update_task_status(**kwargs: Dict[str, Union[ska_tango_base.commands.ResultCode, ska_control_model.task_status.TaskStatus, str]]) None
- 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.
- 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.
- 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.
- assign_resources(argin: str, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Event) None
This is a long running method for AssignResources command, it executes do hook, invokes AssignResources command on Sdp Subarray.
- Parameters:
argin (str) – Input JSON string
task_callback (TaskCallbackTyp) – Update task state, defaults to None
task_abort_event (Event) – Check for abort, defaults to None
- do(argin: str = '') Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke AssignResources command on SDP Subarray.
- Parameters:
argin –
The string in JSON format. The JSON contains following values:
eb_id and maximum length of the SBI: Mandatory JSON object consisting of
- eb_id :
String
- max_length:
Float
- scan_types:
Consist of Scan type id name
- scan_type:
DevVarStringArray
- Processing blocks:
Mandatory JSON object consisting of
- processing_blocks:
DevVarStringArray
Example: “{“interface”:”https://schema.skao.int/ska-sdp-assignres/0.4”, “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”}], “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:
None
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.
- configure(argin: str, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Event) None
This is a long running method for Configure command, it executes do hook, invokes Configure command on SdpSubarray.
- Parameters:
task_callback (TaskCallbackType) – Update task state, defaults to None
task_abort_event (Event) – Check for abort, defaults to None
- do(argin: str = '') Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke Configure command on SDP Subarray. :param argin: The string in JSON format. The JSON contains following values: Example: { “interface”: “https://schema.skao.int/ska-sdp-configure/0.4”, “scan_type”: “science_A” } return: None
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(argin: Optional[Any] = None) Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke End command on SdpSubarray.
- Parameters:
argin – None
- Returns:
None
- end(logger: Logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Optional[Event] = None) None
This is a long running method for End command, it executes do hook, invokes End command on SdpSubarray.
- 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.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(argin: Optional[str] = None) Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke EndScan command on SDP Subarray.
- end_scan(logger: Logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Optional[Event] = None) None
This is a long running method for EndScan command, it executes do hook, invokes EndScan command on SdpSubarray.
- 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.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.
- Parameters:
argin – None.
- Returns:
None
- release_resources(task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Event) None
This is a long running method for ReleaseAllResources command, it executes do hook, invokes ReleaseAllResources command on SdpSubarray.
- Parameters:
task_callback (TaskCallbackType) – Update task state, defaults to None
task_abort_event (Event) – Check for abort, defaults to None
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.
- Parameters:
None –
Note: Enter the json string without spaces as a input.
- Returns:
(ResultCode, message)
- restart(logger: Logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Optional[Event] = None) None
This is a long-running method for a Restart command, it executes do hook :param logger: logger :type logger: logging.Logger :param task_callback: Update task state, defaults to None :type task_callback: TaskCallbackType :param task_abort_event: Check for abort, defaults to None :type task_abort_event: Event, optional
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. :param argin: The string in JSON format. The JSON contains following values: Example: { “interface”: “https://schema.skao.int/ska-sdp-scan/0.4”, “scan_id”: 1 } return: None
- scan(argin: str, logger: Logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Optional[Event] = None) None
This is a long running method for Scan command, it executes do hook, invokes Scan command on SdpSubarray.
- 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
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.
- rtype:
(ResultCode, str)
- Raises:
Exception if error occurs in invoking command –
on any of the devices like Sdp Subarray –
- 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.
- assign_resources(argin: str, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Event) None
This is a long running method for AssignResources command, it executes do hook, invokes AssignResources command on Sdp Subarray.
- Parameters:
argin (str) – Input JSON string
task_callback (TaskCallbackTyp) – Update task state, defaults to None
task_abort_event (Event) – Check for abort, defaults to None
- do(argin: str = '') Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke AssignResources command on SDP Subarray.
- Parameters:
argin –
The string in JSON format. The JSON contains following values:
eb_id and maximum length of the SBI: Mandatory JSON object consisting of
- eb_id :
String
- max_length:
Float
- scan_types:
Consist of Scan type id name
- scan_type:
DevVarStringArray
- Processing blocks:
Mandatory JSON object consisting of
- processing_blocks:
DevVarStringArray
Example: “{“interface”:”https://schema.skao.int/ska-sdp-assignres/0.4”, “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”}], “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:
None
- 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.
- configure(argin: str, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Event) None
This is a long running method for Configure command, it executes do hook, invokes Configure command on SdpSubarray.
- Parameters:
task_callback (TaskCallbackType) – Update task state, defaults to None
task_abort_event (Event) – Check for abort, defaults to None
- do(argin: str = '') Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke Configure command on SDP Subarray. :param argin: The string in JSON format. The JSON contains following values: Example: { “interface”: “https://schema.skao.int/ska-sdp-configure/0.4”, “scan_type”: “science_A” } return: None
- 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(argin: Optional[Any] = None) Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke End command on SdpSubarray.
- Parameters:
argin – None
- Returns:
None
- end(logger: Logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Optional[Event] = None) None
This is a long running method for End command, it executes do hook, invokes End command on SdpSubarray.
- 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.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(argin: Optional[str] = None) Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke EndScan command on SDP Subarray.
- end_scan(logger: Logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Optional[Event] = None) None
This is a long running method for EndScan command, it executes do hook, invokes EndScan command on SdpSubarray.
- 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.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.
- 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.
- 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.
- Parameters:
argin – None.
- Returns:
None
- release_resources(task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Event) None
This is a long running method for ReleaseAllResources command, it executes do hook, invokes ReleaseAllResources command on SdpSubarray.
- Parameters:
task_callback (TaskCallbackType) – Update task state, defaults to None
task_abort_event (Event) – Check for abort, defaults to None
- 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.
- Parameters:
None –
Note: Enter the json string without spaces as a input.
- Returns:
(ResultCode, message)
- restart(logger: Logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Optional[Event] = None) None
This is a long-running method for a Restart command, it executes do hook :param logger: logger :type logger: logging.Logger :param task_callback: Update task state, defaults to None :type task_callback: TaskCallbackType :param task_abort_event: Check for abort, defaults to None :type task_abort_event: Event, optional
- 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. :param argin: The string in JSON format. The JSON contains following values: Example: { “interface”: “https://schema.skao.int/ska-sdp-scan/0.4”, “scan_id”: 1 } return: None
- scan(argin: str, logger: Logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Optional[Event] = None) None
This is a long running method for Scan command, it executes do hook, invokes Scan command on SdpSubarray.
- 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