ska_tmc_cspsubarrayleafnode.commands package
Submodules
ska_tmc_cspsubarrayleafnode.commands.csp_subarray_leaf_node_command_command module
Command class for CSP Subarray Leaf Node
This module defines a command class CspSLNCommand for the CSPSubarrayLeafNode The CspSLNCommand class provides implementation for commands that interact with the CSP Subarray Leaf Node It includes methods for initializing adapters, checking device responsiveness, and handling commands for both low-level and mid-level devices.
- ska_tmc_cspsubarrayleafnode.commands.csp_subarray_leaf_node_command.LOGGER
The logger for the module.
- Type:
logging.Logger
- class ska_tmc_cspsubarrayleafnode.commands.csp_subarray_leaf_node_command.CspSLNCommand(*args: Any, **kwargs: Any)
Bases:
TmcLeafNodeCommand
Abstract command class for all CspSubarrayLeafNode
- do(argin: Optional[str] = None) Tuple[ska_tango_base.commands.ResultCode, str]
Handle a command.
- Parameters:
argin (str, optional) – Command argument. Defaults to None.
- Returns:
A tuple containing the result code and message.
- Return type:
Tuple[ResultCode, str]
- do_low(argin: Optional[Any] = None)
Abstract Method from TmcLeafNodeCommand is defined here but not utilized by this Class. :param argin: Accepts argument if required. :type argin: _type_, optional :param Defaults to None.:
- do_mid(argin: Optional[Any] = None)
Abstract Method from TmcLeafNodeCommand is defined here but not utilized by this Class. :param argin: Accepts argument if required. :type argin: _type_, optional :param Defaults to None.:
- init_adapter() Tuple[ska_tango_base.commands.ResultCode, str]
Creates adapter for underlying CSP subarray device.
- Returns:
A tuple containing the result code and message.
- Return type:
Tuple[ResultCode, str]
- init_adapter_low()
Initialize the adapter for the low-level device.
- init_adapter_mid()
Initialize the adapter for the low-level device.
- update_task_status(**kwargs: Dict[str, Union[ska_tango_base.commands.ResultCode, ska_control_model.task_status.TaskStatus, str]]) None
Update the status of a task.
- Parameters:
**kwargs – Keyword arguments for task status update.
ska_tmc_cspsubarrayleafnode.commands.assign_resources_command module
AssignResources command class for CspSubarrayLeafNode.
- class ska_tmc_cspsubarrayleafnode.commands.assign_resources_command.AssignResources(*args: Any, **kwargs: Any)
Bases:
CspSLNCommand
A class for CspSubarayLeafNode’s AssignResources() command.
It accepts subarrayID and receptor ids in JSON string format and invokes AssignResources command on CSP 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 CspSubarray.
- Parameters:
argin (str) – Input JSON string
task_callback (TaskCallbackType) – Update task state, defaults to None
task_abort_event (Event) – Check for abort, defaults to None
- do_low(argin: str = '') Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke the AssignResources command on the CSP low Subarray
- Parameters:
argin – DevString. The string in JSON format.The JSON contains the following values subarray_id: integer
Example: {“interface”:”https://schema.skao.int/ska-low-csp-assignresources/2.0”, “common”:{“subarray_id”:1},”lowcbf”:{“resources”:[{“device”:”fsp_01”, “shared”:true, “fw_image”:”pst”,”fw_mode”:”unused”},{“device”:”p4_01”, “shared”:true,”fw_image”:”p4.bin”,”fw_mode”:”p4”}]},}
Note: Enter the JSON string without spaces as an input. :return: Tuple[ResultCode, str] - (ResultCode, message) :raises Exception: if the command execution is not successful
- do_mid(argin: str = '') Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke AssignResources command on CSP Subarray.
- Parameters:
argin – DevString. The string in JSON format. The JSON contains following values subarray_id: integer
dish: Mandatory JSON object consisting of receptor_ids,DevVarString The individual string should contain dish numbers in string format with preceding zeroes upto 3 digits. E.g. SKA001, SKA002. .. rubric:: Example
{“interface”:”https: //schema.skao.int/ska-mid-csp-assignresources /2.0”,”subarray_id”:1,”dish”:{“receptor_ids”:[“SKA001”,”SKA002”]}}
Note: Enter the json string without spaces as an input.
- Returns:
(ResultCode, message)
- Raises:
Exception – if the command execution is not successful
- validate_json_argument(input_argin: str) tuple
Validates the json argument
- validate_json_argument_low(input_argin: str) tuple
Validates the json argument
ska_tmc_cspsubarrayleafnode.commands.release_all_resources_command module
ReleaseAllResources command class for CSPSubarrayLeafNode.
- class ska_tmc_cspsubarrayleafnode.commands.release_all_resources_command.ReleaseAllResources(*args: Any, **kwargs: Any)
Bases:
CspSLNCommand
A class for CspSubarayLeafNode’s ReleaseAllResources() command.
Releases all the resources of given CSP Subarray Leaf Node.
- do_low(argin: Optional[Any] = None) Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke ReleaseAllResources command on CSP Subarray.
- Parameters:
argin – DevString. The string in JSON format. Defaults to None.
- Returns:
(ResultCode, message)
- Raises:
Exception – if the command execution is not successful
- do_mid(argin: Optional[Any] = None) Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke ReleaseAllResources command on CSP Subarray.
- Parameters:
argin – DevString. The string in JSON format. Defaults to None.
- Returns:
(ResultCode, message)
- Raises:
Exception – if the command execution is not successful
- release_all_resources(logger, 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 CspSubarray.
- Parameters:
logger (logging.Logger) – logger
task_callback (Callable) – Update task state, defaults to None
task_abort_event (Event) – Check for abort, defaults to None
ska_tmc_cspsubarrayleafnode.commands.configure_command module
Configure command class for CSPSubarrayLeafNode.
- class ska_tmc_cspsubarrayleafnode.commands.configure_command.Configure(*args: Any, **kwargs: Any)
Bases:
CspSLNCommand
A class for CspSubarayLeafNode’s Configure() command.
It accepts CSP configuration in JSON string format and invokes Configure command on CSP Subarray.
- configure(argin: str, logger: Logger, 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 CspSubarray.
- Parameters:
argin (str) – Input JSON string
logger (logging.Logger) – logger
task_callback (Callable) – Update task state, defaults to None
task_abort_event (Event) – Check for abort, defaults to None
- do_low(argin: Optional[str] = None) Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke Configure command on CSP low Subarray.
- Parameters:
argin – The string in JSON format. The JSON contains following values:
Example: {“interface”:”https://schema.skao.int/ska-low-tmc-configure/3.1”, “mccs”:{“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”:{“reference_frame”:”ICRS”,”c1”:180.0,”c2”:45.0}}]}, “sdp”:{“interface”:”https://schema.skao.int/ska-sdp-configure/0.4”, “scan_type”:”science_A”},”csp”:{“interface”:”https://schema.skao.int /ska-low-csp-configure/3.1”,”common”:{“config_id”:”sbi-mvp01- 20200325-00001-science_A”, “subarray_id”: 1},”lowcbf”:{“stations” :{“stns”:[[1,1],[2,1],[3,1],[4,1],[5,1],[6,1]],”stn_beams”:[{ “beam_id”:1,”freq_ids”:[400],”delay_poly”:”ska_low/tm_leaf_node/ csp_subarray01/delayModel”}]},”vis”:{“fsp”:{“firmware”:”vis”, “fsp_ids”:[1]},”stn_beams”:[{“stn_beam_id”:1,”integration_ms” :849}]}}},”tmc”: {“scan_duration”:10.0}}
Note: Enter the json string without spaces as a input. :type argin: str
- Returns:
(ResultCode, message)
- do_mid(argin: str = '') Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke Configure command on CSP Subarray.
- Parameters:
argin – The string in JSON format. The JSON contains following values:
Example: {“interface”:”https://schema.skao.int/ska-csp-configure/2.0”, “subarray”:{“subarray_name”:”science period 23”},”common”: {“config_id”:”sbi-mvp01-20200325-00001-science_A”,”frequency_band”: “1”,”subarray_id”:”1”},”cbf”:{“delay_model_subscription_point”: “ska_mid/tm_leaf_node/csp_subarray01/delayModel”,”fsp”:[{“fsp_id”:1, “function_mode”:”CORR”,”frequency_slice_id”:1,”integration_factor”:1, “zoom_factor”:0,”channel_averaging_map”:[[0,2],[744,0]], “channel_offset”:0,”output_link_map”:[[0,0],[200,1]],},{“fsp_id”:2, “function_mode”:”CORR”,”frequency_slice_id”:2,”integration_factor”:1, “zoom_factor”:1,”zoom_window_tuning”:650000,”channel_averaging_map”: [[0,2],[744,0]],”channel_offset”:744,”output_link_map”:[[0,4], [200,5]],”output_host”:[[0,”192.168.1.1”]],”output_port”: [[0,9744,1]]}],”vlbi”:{}},”pss”:{},”pst”:{},”pointing”:{“target”: {“reference_frame”:”ICRS”,”target_name”:”Polaris Australis”, “ra”:”21:08:47.92”,”dec”:”-88:57:22.9”}}}
Note: Enter the json string without spaces as a input.
- Returns:
(ResultCode, message)
- Raises:
Exception – if the command execution is not successful
DevFailed if the command execution is not successful –
ValueError if input argument json string contains invalid value –
- load_low_configure_json(argin: str) Tuple[ska_tango_base.commands.ResultCode, str]
Method loads low configure json.
- Parameters:
argin (str) – Input JSON string
- Returns:
Tuple[ResultCode, str]: result code and message
- start_delay(argin: str) Tuple[ska_tango_base.commands.ResultCode, str]
A method to start delay thread and starts generating delay polynomials.
- Parameters:
argin (str) – Input JSON string
- Returns:
Tuple[ResultCode, str]: result code and message
- update_station_ids(argin_json: dict) Tuple[ska_tango_base.commands.ResultCode, str]
Method to extract station ids from MCCS apertures and update station ids from component manager.
- Parameters:
argin (dict) – MCCS configuration dict
- Returns:
Tuple[ResultCode, str]: result code and message
ska_tmc_cspsubarrayleafnode.commands.end_command module
End command class for CSPSubarrayLeafNode.
- class ska_tmc_cspsubarrayleafnode.commands.end_command.End(*args: Any, **kwargs: Any)
Bases:
CspSLNCommand
A class for CspSubarayLeafNode’s End() command.
It invokes End command on CSP Subarray.
- do_low(argin: Optional[Any] = None) Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke End command on CSP Subarray.
- Parameters:
argin – None.
- Returns:
(ResultCode, message)
- Raises:
Exception – if the command execution is not successful
- do_mid(argin: Optional[Any] = None) Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke End command on CSP Subarray.
- Parameters:
argin – None.
- Returns:
(ResultCode, message)
- Raises:
Exception – if the command execution is not successful
- end(logger: Logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Optional[Event] = None)
This is a long running method for End command, it executes do hook, invokes End command on CspSubarray.
- Parameters:
logger (logging.Logger) – logger
task_callback (TaskCallbackType) – Update task state
task_abort_event (Event, optional) – Check for abort, defaults to None
- reset_delay_model_values(delay_json: dict)
Method to reset delayModel attribute value to empty delayModel json :param delay_json: delay json :type delay_json: dict
ska_tmc_cspsubarrayleafnode.commands.scan_command module
Scan command class for CspSubarrayLeafNode.
- class ska_tmc_cspsubarrayleafnode.commands.scan_command.Scan(*args: Any, **kwargs: Any)
Bases:
CspSLNCommand
A class for CspSubarrayLeafNode’s Scan() command. Scan command is inherited from CspSLNCommand.
This command invokes Scan command on CSP Subarray.
- do_low(argin: str = '') Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke Scan command on CSP Low Subarray.
- Parameters:
argin – JSON string consists of scan id (int).
Example: {“common”:{“subarray_id”:1},”lowcbf”:{“scan_id”:987654321, “scan_seconds”:30}}
Note: Enter the json string without spaces as a input.
- Returns:
(ResultCode, message)
- do_mid(argin: str = '') Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke Scan command on CSP Mid Subarray.
- Parameters:
argin – JSON string consists of scan id (int).
Example: {“interface”:”https://schema.skao.int/ska-mid-csp-scan/2.0”, “scan_id”:1}
Note: Enter the json string without spaces as a input.
- Returns:
(ResultCode, message)
- 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 CspSubarray.
- Parameters:
argin (str) – Input JSON string
logger (logging.Logger) – logger
task_callback (TaskCallbackType) – Update task state, defaults to None
task_abort_event (Event, optional) – Check for abort, defaults to None
- validate_json_argument(input_argin: str) tuple
Validates the json argument
- validate_json_argument_low(input_argin: str) tuple
Validates the json argument for low
ska_tmc_cspsubarrayleafnode.commands.end_scan_command module
EndScan command class for CspSubarrayLeafNode.
- class ska_tmc_cspsubarrayleafnode.commands.end_scan_command.EndScan(*args: Any, **kwargs: Any)
Bases:
CspSLNCommand
A class for CspSubarrayLeafNode’s EndScan() command.
It invokes EndScan command on CSP Subarray. This command is allowed when CSP Subarray is in obsState SCANNING.
- do_low(argin: Optional[str] = None) Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke EndScan command on CSP Low Subarray.
- Parameters:
argin (String) – Json input string, defaults to None
- Returns:
(ResultCode, message)
- do_mid(argin: Optional[str] = None) Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke EndScan command on CSP Mid Subarray.
- Parameters:
argin (String) – Json input string, defaults to None
- Returns:
(ResultCode, message)
- end_scan(logger: Logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Optional[Event] = None)
This is a long running method for EndScan command, it executes do hook, invokes EndScan command on CspSubarray.
- 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_cspsubarrayleafnode.commands.abort_command module
Abort Command for CspSubarrayLeafNode.
- class ska_tmc_cspsubarrayleafnode.commands.abort_command.Abort(*args: Any, **kwargs: Any)
Bases:
CspSLNCommand
A class for CspSubarrayLeafNode’s Abort() command. Aborts the CSP Subarray device.
- do(argin=None)
This method invokes Abort command on CSP 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 CspSubarrayLeafNode –
- invoke_abort(argin=None)
This method calls do for Abort command
- reset_delay_model_values()
Method to reset delayModel attribute value to empty delayModel json
:param None :return None
ska_tmc_cspsubarrayleafnode.commands.restart_command module
Restart command class for CspSubarrayLeafNode.
- class ska_tmc_cspsubarrayleafnode.commands.restart_command.Restart(*args: Any, **kwargs: Any)
Bases:
CspSLNCommand
A class for CspSubarrayLeafNode’s Restart command. Restarts the CSP Subarray device.
- do(argin=None) tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke Restart command on CSP 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, invokes Restart command on CspSubarray.
- Parameters:
argin (str) – Input JSON string
logger (logging.Logger) – logger
task_callback (TaskCallbackType) – Update task state, defaults to None
task_abort_event (Event, optional) – Check for abort, defaults to None