ska_tmc_cspmasterleafnode package

Subpackages

• ska_tmc_cspmasterleafnode.commands package
  • Submodules
  • ska_tmc_cspmasterleafnode.commands.csp_master_leaf_node_command module
    • LOGGER
    • CspMLNCommand
      • CspMLNCommand.check_unresponsive()
      • CspMLNCommand.do()
      • CspMLNCommand.do_low()
      • CspMLNCommand.do_mid()
      • CspMLNCommand.init_adapter()
      • CspMLNCommand.init_adapter_low()
      • CspMLNCommand.init_adapter_mid()
      • CspMLNCommand.update_task_status()
  • ska_tmc_cspmasterleafnode.commands.on_command module
    • On
      • On.do()
      • On.on()
  • ska_tmc_cspmasterleafnode.commands.off_command module
    • Off
      • Off.do()
      • Off.off()
  • ska_tmc_cspmasterleafnode.commands.standby_command module
    • Standby
      • Standby.do()
      • Standby.standby()
  • ska_tmc_cspmasterleafnode.commands.load_dish_cfg_command module
    • LoadDishCfg
      • LoadDishCfg.do()
      • LoadDishCfg.get_dishid_vcc_map_json()
      • LoadDishCfg.loadDishCfg()
      • LoadDishCfg.update_task_status()
  • Module contents
    • LoadDishCfg
      • LoadDishCfg.do()
      • LoadDishCfg.get_dishid_vcc_map_json()
      • LoadDishCfg.loadDishCfg()
      • LoadDishCfg.update_task_status()
    • Off
      • Off.do()
      • Off.off()
    • On
      • On.do()
      • On.on()
    • Standby
      • Standby.do()
      • Standby.standby()
• ska_tmc_cspmasterleafnode.manager package
  • Submodules
  • ska_tmc_cspmasterleafnode.manager.component_manager module
    • CspMLNComponentManager
      • CspMLNComponentManager.check_if_csp_master_is_responsive()
      • CspMLNComponentManager.csp_master_device_name
      • CspMLNComponentManager.get_device()
      • CspMLNComponentManager.is_command_allowed()
      • CspMLNComponentManager.off()
      • CspMLNComponentManager.off_command()
      • CspMLNComponentManager.on()
      • CspMLNComponentManager.on_command()
      • CspMLNComponentManager.standby()
      • CspMLNComponentManager.standby_command()
      • CspMLNComponentManager.start_communicating()
      • CspMLNComponentManager.stop_communicating()
      • CspMLNComponentManager.update_exception_for_unresponsiveness()
      • CspMLNComponentManager.update_responsiveness_info()
  • Module contents
    • CspMLNComponentManager
      • CspMLNComponentManager.check_if_csp_master_is_responsive()
      • CspMLNComponentManager.csp_master_device_name
      • CspMLNComponentManager.get_device()
      • CspMLNComponentManager.is_command_allowed()
      • CspMLNComponentManager.off()
      • CspMLNComponentManager.off_command()
      • CspMLNComponentManager.on()
      • CspMLNComponentManager.on_command()
      • CspMLNComponentManager.standby()
      • CspMLNComponentManager.standby_command()
      • CspMLNComponentManager.start_communicating()
      • CspMLNComponentManager.stop_communicating()
      • CspMLNComponentManager.update_exception_for_unresponsiveness()
      • CspMLNComponentManager.update_responsiveness_info()
    • CspMLNComponentManagerMid
      • CspMLNComponentManagerMid.clear_load_dish_cfg_attributes()
      • CspMLNComponentManagerMid.get_load_dish_cfg_result()
      • CspMLNComponentManagerMid.handle_dish_vcc_config_callback()
      • CspMLNComponentManagerMid.handle_long_running_command_result_callback()
      • CspMLNComponentManagerMid.handle_source_dish_vcc_config_callback()
      • CspMLNComponentManagerMid.is_dish_vcc_config_valid()
      • CspMLNComponentManagerMid.is_event_failed()
      • CspMLNComponentManagerMid.load_dish_cfg_command()
      • CspMLNComponentManagerMid.start_dish_vcc_validation()
      • CspMLNComponentManagerMid.update_command_result()
      • CspMLNComponentManagerMid.update_dish_vcc_map_validation_result()

Submodules

ska_tmc_cspmasterleafnode._csp_master_leaf_node module

This module uses the SKA Control Model for health state definitions an SKA Tango Base for the base device class.

class ska_tmc_cspmasterleafnode.csp_master_leaf_node.CspMasterLeafNode(*args: Any, **kwargs: Any)

Bases: TMCBaseLeafDevice

CSP Master Leaf node acts as a CSP contact point for Master Node and also to monitor and issue commands to the CSP Master.

class InitCommand(*args: Any, **kwargs: Any)

Bases: InitCommand

A class for the TMC CspMasterLeafNode’s init_device() method.

do(*args: Any, **kwargs: Any) → tuple[ska_tango_base.commands.ResultCode, str]

Initializes the attributes and properties of the CspMasterLeafNode.

Returns:

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

rtype:

(ResultCode, str)

Off()

This command invokes Off() command on CSP Master.

Note: CSP Master supports input argument to turn off specific devices, but TMC does not yet support it. So the Off command will always instruct CSP Master to turn on all the devices.

always_executed_hook()

create_component_manager()

cspMasterDevName(value) → str

Sets the cspmasterdevname attribute.

init_command_objects()

Initialises the command handlers for commands supported by this device.

init_device()

is_Off_allowed() → Union[bool, ska_tmc_common.exceptions.CommandNotAllowed, ska_tmc_common.exceptions.DeviceUnresponsive]

Checks whether this command is allowed to be run in current device state.

Returns:

True if this command is allowed to be run in current device state.

Return type:

boolean

is_On_allowed() → Union[bool, ska_tmc_common.exceptions.CommandNotAllowed, ska_tmc_common.exceptions.DeviceUnresponsive]

Checks whether this command is allowed to be run in current device state.

Returns:

True if this command is allowed to be run in current device state.

Return type:

boolean

is_Standby_allowed() → Union[bool, ska_tmc_common.exceptions.CommandNotAllowed, ska_tmc_common.exceptions.DeviceUnresponsive]

Checks whether this command is allowed to be run in current device state.

Returns:

True if this command is allowed to be run in current device state.

Return type:

boolean

read_isSubsystemAvailable() → bool

Read method for isSubsystemAvailable

update_availablity_callback(csp_master_availability: bool) → None

Change event callback for isSubsystemAvailable

ska_tmc_cspmasterleafnode.csp_master_leaf_node.main(args=None, **kwargs)

Runs the CspMasterLeafNodeMid.

Parameters:

• args – Arguments internal to TANGO

• kwargs – Arguments internal to TANGO

Returns:

CspMasterLeafNodeMid TANGO object.

Module contents

CspMasterLeafNode