ska_tmc_cspmasterleafnode.commands package
Submodules
ska_tmc_cspmasterleafnode.commands.csp_master_leaf_node_command module
Command class for CSP Master Leaf Node
This module defines a command class CspMLNCommand for the CSPMasterLeafNode The CspMLNCommand class provides implementation for commands that interact with the CSP Master Leaf Node. It includes methods for initializing adapters, checking device responsiveness, and handling commands for both low-level and mid-level devices.
- ska_tmc_cspmasterleafnode.commands.csp_master_leaf_node_command.LOGGER
The logger for the module.
- Type:
logging.Logger
- class ska_tmc_cspmasterleafnode.commands.csp_master_leaf_node_command.CspMLNCommand(*args: Any, **kwargs: Any)
Bases:
TmcLeafNodeCommand
Abstract command class for all CspMasterLeafNode
- check_unresponsive() None
Checks if the device is unresponsive
- Returns:
None
- do(argin=None)
Handle a command.
- Parameters:
argin – Optional command argument.
- do_low(argin=None)
Handle a command for the low-level device.
- Parameters:
argin – Optional command argument.
- do_mid(argin=None)
Handle a command for the mid-level device.
- Parameters:
argin – Optional command argument.
- init_adapter() Tuple[ska_tango_base.commands.ResultCode, str]
Creates adapter for underlying csp master device
- init_adapter_low()
Initialize the adapter for the low-level device.
- init_adapter_mid()
Initialize the adapter for the mid-level device.
- update_task_status(**kwargs)
Update the status of a task.
- Parameters:
kwargs – Keyword arguments for task status update.
ska_tmc_cspmasterleafnode.commands.on_command module
On command class for CSPMasterLeafNode.
- class ska_tmc_cspmasterleafnode.commands.on_command.On(*args: Any, **kwargs: Any)
Bases:
CspMLNCommand
A class for CspMasterLeafNode’s On() command.
On command on CspmasterLeafNode enables the telescope to perform further operations and observations. It Invokes On command on CSP Master device.
- do(argin: Optional[Any] = None) Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke On command on CSP Master.
- do_low(argin=None)
Abstract Method from CSPSLNCommand is defined here but not utilized by this Class. :param argin.: :param Defaults to None.:
- do_mid(argin=None)
Abstract Method from CSPSLNCommand is defined here but not utilized by this Class. :param argin: :param : :param Defaults to None.:
- on(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
- update_task_status(**kwargs)
Abstract Method from CSPSLNCommand is defined here but not utilized by this Class.
ska_tmc_cspmasterleafnode.commands.off_command module
Off command class for CSP Master Leaf Node
- class ska_tmc_cspmasterleafnode.commands.off_command.Off(*args: Any, **kwargs: Any)
Bases:
CspMLNCommand
A class for CspMasterLeafNode’s Off() command.
Off command on CspMasterLeafNode invokes Off command on CSP Master device.
- do(argin: Optional[Any] = None) Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke Off command on CSP Master.
- do_low(argin=None)
Abstract Method from CSPSLNCommand is defined here but not utilized by this Class. :param argin.: :param Defaults to None.:
- do_mid(argin=None)
Abstract Method from CSPSLNCommand is defined here but not utilized by this Class. :param argin: :param : :param Defaults to None.:
- off(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
- update_task_status(**kwargs)
Abstract Method from CSPSLNCommand is defined here but not utilized by this Class.
ska_tmc_cspmasterleafnode.commands.standby_command module
Standby command class for CSP Master Leaf Node
- class ska_tmc_cspmasterleafnode.commands.standby_command.Standby(*args: Any, **kwargs: Any)
Bases:
CspMLNCommand
A class for CSP MasterLeafNode’s Standby() command.
Standby command on CSP MasterLeafNode invokes Standby command on CSP Master device.
- do(argin: Optional[Any] = None) Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke Standby command on CSP Master.
- do_low(argin=None)
Abstract Method from CSPSLNCommand is defined here but not utilized by this Class. :param argin.: :param Defaults to None.:
- do_mid(argin=None)
Abstract Method from CSPSLNCommand is defined here but not utilized by this Class. :param argin: :param : :param Defaults to None.:
- standby(logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Optional[Event] = None) None
A method to invoke the Standby 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
- update_task_status(**kwargs)
Abstract Method from CSPSLNCommand is defined here but not utilized by this Class.
ska_tmc_cspmasterleafnode.commands.load_dish_cfg_command module
Load Dish Cfg command class for CSP Master Leaf Node
- class ska_tmc_cspmasterleafnode.commands.load_dish_cfg_command.LoadDishCfg(*args: Any, **kwargs: Any)
Bases:
CspMLNCommand
A class for CSP MasterLeafNode’s LoadDishCfg command.
LoadDishCfg command on CSP MasterLeafNode invokes LoadDishCfg command on CSP Master device.
- do(argin: Optional[Any] = None) Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke LoadDishCfg command on CSP Master.
- do_low(argin=None)
Abstract Method from CSPSLNCommand is defined here but not utilized by this Class. :param argin.: :param Defaults to None.:
- do_mid(argin=None)
Abstract Method from CSPSLNCommand is defined here but not utilized by this Class. :param argin: :param : :param Defaults to None.:
- get_dishid_vcc_map_json(initial_params: dict) Tuple[dict, str]
Get DishId-VCC map json from initial params :param initial_param: this param containg tm data source uri and file path which is used for extracting vcc_map json file :param type: str :rtype: Tuple (dict, str)
- loadDishCfg(argin: None, logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Event) None
A method to invoke the Standby 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
- update_task_status(**kwargs) None
Update task status for the Load Dish Cfg Command
Module contents
Init file for CSP Master Leaf Node Commands
- class ska_tmc_cspmasterleafnode.commands.LoadDishCfg(*args: Any, **kwargs: Any)
Bases:
CspMLNCommand
A class for CSP MasterLeafNode’s LoadDishCfg command.
LoadDishCfg command on CSP MasterLeafNode invokes LoadDishCfg command on CSP Master device.
- do(argin: Optional[Any] = None) Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke LoadDishCfg command on CSP Master.
- do_low(argin=None)
Abstract Method from CSPSLNCommand is defined here but not utilized by this Class. :param argin.: :param Defaults to None.:
- do_mid(argin=None)
Abstract Method from CSPSLNCommand is defined here but not utilized by this Class. :param argin: :param : :param Defaults to None.:
- get_dishid_vcc_map_json(initial_params: dict) Tuple[dict, str]
Get DishId-VCC map json from initial params :param initial_param: this param containg tm data source uri and file path which is used for extracting vcc_map json file :param type: str :rtype: Tuple (dict, str)
- loadDishCfg(argin: None, logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Event) None
A method to invoke the Standby 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
- update_task_status(**kwargs) None
Update task status for the Load Dish Cfg Command
- class ska_tmc_cspmasterleafnode.commands.Off(*args: Any, **kwargs: Any)
Bases:
CspMLNCommand
A class for CspMasterLeafNode’s Off() command.
Off command on CspMasterLeafNode invokes Off command on CSP Master device.
- do(argin: Optional[Any] = None) Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke Off command on CSP Master.
- do_low(argin=None)
Abstract Method from CSPSLNCommand is defined here but not utilized by this Class. :param argin.: :param Defaults to None.:
- do_mid(argin=None)
Abstract Method from CSPSLNCommand is defined here but not utilized by this Class. :param argin: :param : :param Defaults to None.:
- off(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
- update_task_status(**kwargs)
Abstract Method from CSPSLNCommand is defined here but not utilized by this Class.
- class ska_tmc_cspmasterleafnode.commands.On(*args: Any, **kwargs: Any)
Bases:
CspMLNCommand
A class for CspMasterLeafNode’s On() command.
On command on CspmasterLeafNode enables the telescope to perform further operations and observations. It Invokes On command on CSP Master device.
- do(argin: Optional[Any] = None) Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke On command on CSP Master.
- do_low(argin=None)
Abstract Method from CSPSLNCommand is defined here but not utilized by this Class. :param argin.: :param Defaults to None.:
- do_mid(argin=None)
Abstract Method from CSPSLNCommand is defined here but not utilized by this Class. :param argin: :param : :param Defaults to None.:
- on(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
- update_task_status(**kwargs)
Abstract Method from CSPSLNCommand is defined here but not utilized by this Class.
- class ska_tmc_cspmasterleafnode.commands.Standby(*args: Any, **kwargs: Any)
Bases:
CspMLNCommand
A class for CSP MasterLeafNode’s Standby() command.
Standby command on CSP MasterLeafNode invokes Standby command on CSP Master device.
- do(argin: Optional[Any] = None) Tuple[ska_tango_base.commands.ResultCode, str]
Method to invoke Standby command on CSP Master.
- do_low(argin=None)
Abstract Method from CSPSLNCommand is defined here but not utilized by this Class. :param argin.: :param Defaults to None.:
- do_mid(argin=None)
Abstract Method from CSPSLNCommand is defined here but not utilized by this Class. :param argin: :param : :param Defaults to None.:
- standby(logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Optional[Event] = None) None
A method to invoke the Standby 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
- update_task_status(**kwargs)
Abstract Method from CSPSLNCommand is defined here but not utilized by this Class.