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()
      • CspMLNCommand.wait_for_completion()
  • 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.check_and_validate_dish_vcc_data()
      • LoadDishCfg.do()
      • LoadDishCfg.get_dishid_vcc_map_json()
      • LoadDishCfg.loadDishCfg()
      • LoadDishCfg.update_task_status()
  • ska_tmc_cspmasterleafnode.commands.set_controller_admin_mode module
    • SetAdminMode
      • SetAdminMode.do()
  • Module contents
    • LoadDishCfg
      • LoadDishCfg.check_and_validate_dish_vcc_data()
      • 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.build_device_attribute_map()
      • CspMLNComponentManager.check_device_responsiveness()
      • CspMLNComponentManager.check_if_csp_master_is_responsive()
      • CspMLNComponentManager.csp_master_device_name
      • CspMLNComponentManager.get_attribute_dict()
      • CspMLNComponentManager.get_device()
      • CspMLNComponentManager.health_info
      • CspMLNComponentManager.health_state
      • CspMLNComponentManager.is_command_allowed()
      • CspMLNComponentManager.is_event_failed()
      • CspMLNComponentManager.off()
      • CspMLNComponentManager.off_command()
      • CspMLNComponentManager.on()
      • CspMLNComponentManager.on_command()
      • CspMLNComponentManager.set_health_info()
      • CspMLNComponentManager.set_health_state()
      • CspMLNComponentManager.setup_event_subscription()
      • CspMLNComponentManager.standby()
      • CspMLNComponentManager.standby_command()
      • CspMLNComponentManager.start_communicating()
      • CspMLNComponentManager.stop()
      • CspMLNComponentManager.stop_communicating()
      • CspMLNComponentManager.update_device_admin_mode()
      • CspMLNComponentManager.update_device_health_state()
      • CspMLNComponentManager.update_exception_for_unresponsiveness()
      • CspMLNComponentManager.update_responsiveness_info()
  • Module contents
    • CspMLNComponentManager
      • CspMLNComponentManager.build_device_attribute_map()
      • CspMLNComponentManager.check_device_responsiveness()
      • CspMLNComponentManager.check_if_csp_master_is_responsive()
      • CspMLNComponentManager.csp_master_device_name
      • CspMLNComponentManager.get_attribute_dict()
      • CspMLNComponentManager.get_device()
      • CspMLNComponentManager.health_info
      • CspMLNComponentManager.health_state
      • CspMLNComponentManager.is_command_allowed()
      • CspMLNComponentManager.is_event_failed()
      • CspMLNComponentManager.off()
      • CspMLNComponentManager.off_command()
      • CspMLNComponentManager.on()
      • CspMLNComponentManager.on_command()
      • CspMLNComponentManager.set_health_info()
      • CspMLNComponentManager.set_health_state()
      • CspMLNComponentManager.setup_event_subscription()
      • CspMLNComponentManager.standby()
      • CspMLNComponentManager.standby_command()
      • CspMLNComponentManager.start_communicating()
      • CspMLNComponentManager.stop()
      • CspMLNComponentManager.stop_communicating()
      • CspMLNComponentManager.update_device_admin_mode()
      • CspMLNComponentManager.update_device_health_state()
      • CspMLNComponentManager.update_exception_for_unresponsiveness()
      • CspMLNComponentManager.update_responsiveness_info()
    • CspMLNComponentManagerMid
      • CspMLNComponentManagerMid.build_device_attribute_map()
      • CspMLNComponentManagerMid.clear_load_dish_cfg_attributes()
      • CspMLNComponentManagerMid.get_attribute_dict()
      • CspMLNComponentManagerMid.handle_dish_vcc_config_callback()
      • CspMLNComponentManagerMid.handle_source_dish_vcc_config_callback()
      • CspMLNComponentManagerMid.is_dish_vcc_config_valid()
      • CspMLNComponentManagerMid.load_dish_cfg_command()
      • CspMLNComponentManagerMid.start_dish_vcc_validation()
      • CspMLNComponentManagerMid.update_dish_vcc_map_validation_result()
      • CspMLNComponentManagerMid.validat_load_dish_cfg_json()

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.TmcLeafNodeCspControl(*args: Any, **kwargs: Any)

Bases: TMCBaseLeafDevice

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

InitCommand = None

always_executed_hook()

create_component_manager()

cspMasterDevName(value) → str

Sets the cspmasterdevname attribute.

init_device()

is_Off_allowed(request_type: ska_tango_base.long_running_commands.LRCReqType = ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ) → 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(request_type: ska_tango_base.long_running_commands.LRCReqType = ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ) → 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(request_type: ska_tango_base.long_running_commands.LRCReqType = ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ) → 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_isAdminModeEnabled() → bool

Return the isAdminModeEnabled attribute value

update_admin_mode_callback(admin_mode: int)

Update CSPMLNAdminMode attribute callback

update_availablity_callback(csp_master_availability: bool) → None

Change event callback for isSubsystemAvailable

update_health_info_callback(health_info: dict) → None

Change event callback for healthInfo attribute :param health_info: New health info to be set. :type health_info: dict

update_health_state_callback(healthState: ska_control_model.HealthState) → None

Change event callback for healthState attribute :param healthState: New health state to be set. :type healthState: HealthState

write_isAdminModeEnabled(value: bool)

Set the value of isAdminModeEnabled attribute

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

Runs the MidTmcLeafNodeCspControl.

Parameters:

• args – Arguments internal to TANGO

• kwargs – Arguments internal to TANGO

Returns:

MidTmcLeafNodeCspControl TANGO object.

Module contents

CspMasterLeafNode

Properties in CSP Master Leaf Node

Property Name	Data Type	Description
CspMasterFQDN	DevString	FQDN of the CSP Master Tango Device Server.
LivelinessCheckPeriod	DevFloat	Period for the liveliness probe to monitor each device in a loop.
EventSubscriptionCheckPeriod	DevFloat	Period for the event subscriber to check the device subscriptions in a loop.
AdapterTimeOut	DevFloat	Timeout for the adapter creation. This property is for internal use.

Additional Properties in CSP Master Leaf Node Mid

CommandTimeOutDefault | DevFloat | Default Timeout for the command execution