ska_tmc_sdpmasterleafnode package

Subpackages

• ska_tmc_sdpmasterleafnode.commands package
  • Submodules
  • ska_tmc_sdpmasterleafnode.commands.sdp_mln_command module
    • SdpMLNCommand
      • SdpMLNCommand.do()
      • SdpMLNCommand.do_low()
      • SdpMLNCommand.do_mid()
      • SdpMLNCommand.init_adapter()
      • SdpMLNCommand.init_adapter_low()
      • SdpMLNCommand.init_adapter_mid()
      • SdpMLNCommand.update_task_status()
  • ska_tmc_sdpmasterleafnode.commands.disable_command module
    • Disable
      • Disable.disable()
      • Disable.do()
  • ska_tmc_sdpmasterleafnode.commands.off_command module
    • Off
      • Off.do()
      • Off.off()
  • ska_tmc_sdpmasterleafnode.commands.on_command module
    • On
      • On.do()
      • On.on()
  • ska_tmc_sdpmasterleafnode.commands.standby_command module
    • Standby
      • Standby.do()
      • Standby.standby()
  • ska_tmc_sdpmasterleafnode.commands.set_controller_admin_mode_command module
    • SetAdminMode
      • SetAdminMode.do()
  • Module contents
    • Disable
      • Disable.disable()
      • Disable.do()
    • Off
      • Off.do()
      • Off.off()
    • On
      • On.do()
      • On.on()
    • SetAdminMode
      • SetAdminMode.do()
    • Standby
      • Standby.do()
      • Standby.standby()
• ska_tmc_sdpmasterleafnode.manager package
  • Submodules
  • ska_tmc_sdpmasterleafnode.manager.component_manager module
    • SdpMLNComponentManager
      • SdpMLNComponentManager.disable()
      • SdpMLNComponentManager.get_attribute_dict()
      • SdpMLNComponentManager.get_device()
      • SdpMLNComponentManager.handle_admin_mode_event()
      • SdpMLNComponentManager.is_command_allowed()
      • SdpMLNComponentManager.off()
      • SdpMLNComponentManager.on()
      • SdpMLNComponentManager.sdp_master_device_name
      • SdpMLNComponentManager.standby()
      • SdpMLNComponentManager.start_communicating()
      • SdpMLNComponentManager.stop_communicating()
      • SdpMLNComponentManager.update_device_admin_mode()
      • SdpMLNComponentManager.update_exception_for_unresponsiveness()
      • SdpMLNComponentManager.update_responsiveness_info()
  • Module contents
    • SdpMLNComponentManager
      • SdpMLNComponentManager.disable()
      • SdpMLNComponentManager.get_attribute_dict()
      • SdpMLNComponentManager.get_device()
      • SdpMLNComponentManager.handle_admin_mode_event()
      • SdpMLNComponentManager.is_command_allowed()
      • SdpMLNComponentManager.off()
      • SdpMLNComponentManager.on()
      • SdpMLNComponentManager.sdp_master_device_name
      • SdpMLNComponentManager.standby()
      • SdpMLNComponentManager.start_communicating()
      • SdpMLNComponentManager.stop_communicating()
      • SdpMLNComponentManager.update_device_admin_mode()
      • SdpMLNComponentManager.update_exception_for_unresponsiveness()
      • SdpMLNComponentManager.update_responsiveness_info()

Submodules

ska_tmc_sdpmasterleafnode._sdp_master_leaf_node module

SDP Master Leaf node acts as a SDP contact point for the Master Node and also monitors and issues commands to the SDP Master.

class ska_tmc_sdpmasterleafnode.sdp_master_leaf_node.TmcLeafNodeSdp(*args: Any, **kwargs: Any)

Bases: TMCBaseLeafDevice

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

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

Bases: InitCommand

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

do()

Initializes the attributes and properties of the SdpMasterLeafNode.

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 Sdp Master.

always_executed_hook()

create_component_manager()

Returns Sdp Master Leaf Node component manager object

init_command_objects()

Initialises the command handlers for commands supported by this device.

isAdminModeEnabled(value: bool) → None

Set the value of isAdminModeEnabled attribute

is_Disable_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:

bool,CommandNotAllowed,DeviceUnresponsive

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:

bool,CommandNotAllowed,DeviceUnresponsive

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:

bool,CommandNotAllowed,DeviceUnresponsive

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:

bool,CommandNotAllowed,DeviceUnresponsive

read_isSubsystemAvailable() → bool

Returns the TMC Sdp MasterLeafNode isSubsystemAvailable attribute.

read_sdpMasterDevName() → str

Return the sdpmasterdevname attribute.

sdpControllerAdminMode() → ska_control_model.AdminMode

Read the admin mode of SDP Controller

update_admin_mode_callback(admin_mode: ska_control_model.AdminMode)

Update SDPMLNAdminMode attribute callback

update_availablity_callback(availablity: bool) → None

Change event callback for isSubsystemAvailable

write_sdpMasterDevName(value: str) → None

Set the sdpmasterdevname attribute.

ska_tmc_sdpmasterleafnode.sdp_master_leaf_node.main(args=None, **kwargs)

Runs the TmcLeafNodeSdp.

Parameters:

• args – Arguments internal to TANGO

• kwargs – Arguments internal to TANGO

Returns:

TmcLeafNodeSdp TANGO object.

Module contents

Properties in SDP Master Leaf Node

Property Name	Data Type	Description
SdpMasterFQDN	DevString	FQDN of the SDP 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.