ska_tmc_sdpsubarrayleafnode package

Link to the TMC User documentation is here.

Subpackages

• ska_tmc_sdpsubarrayleafnode.commands package
  • Submodules
  • ska_tmc_sdpsubarrayleafnode.commands.sdp_sln_command module
    • SdpSLNCommand
      • SdpSLNCommand.check_op_state()
      • SdpSLNCommand.do()
      • SdpSLNCommand.do_low()
      • SdpSLNCommand.do_mid()
      • SdpSLNCommand.init_adapter()
      • SdpSLNCommand.init_adapter_low()
      • SdpSLNCommand.init_adapter_mid()
      • SdpSLNCommand.update_task_status()
    • task_callback_default()
  • ska_tmc_sdpsubarrayleafnode.commands.off_command module
    • Off
      • Off.do()
      • Off.off()
  • ska_tmc_sdpsubarrayleafnode.commands.on_command module
    • On
      • On.do()
      • On.on()
  • ska_tmc_sdpsubarrayleafnode.commands.assign_resources_command module
    • AssignResources
      • AssignResources.do()
  • ska_tmc_sdpsubarrayleafnode.commands.configure_command module
    • Configure
      • Configure.do()
  • ska_tmc_sdpsubarrayleafnode.commands.end_command module
    • End
      • End.do()
  • ska_tmc_sdpsubarrayleafnode.commands.end_scan_command module
    • EndScan
      • EndScan.do()
  • ska_tmc_sdpsubarrayleafnode.commands.release_resources_command module
    • ReleaseAllResources
      • ReleaseAllResources.do()
  • ska_tmc_sdpsubarrayleafnode.commands.abort_command module
    • Abort
      • Abort.do()
      • Abort.update_task_status()
  • ska_tmc_sdpsubarrayleafnode.commands.restart_command module
    • Restart
      • Restart.do()
      • Restart.update_task_status()
  • ska_tmc_sdpsubarrayleafnode.commands.scan_command module
    • Scan
      • Scan.do()
  • ska_tmc_sdpsubarrayleafnode.commands.set_sdp_subarray_admin_mode module
    • SetAdminMode
      • SetAdminMode.do()
  • Module contents
    • Abort
      • Abort.do()
      • Abort.update_task_status()
    • AssignResources
      • AssignResources.do()
    • Configure
      • Configure.do()
    • End
      • End.do()
    • EndScan
      • EndScan.do()
    • Off
      • Off.do()
      • Off.off()
    • On
      • On.do()
      • On.on()
    • ReleaseAllResources
      • ReleaseAllResources.do()
    • Restart
      • Restart.do()
      • Restart.update_task_status()
    • Scan
      • Scan.do()
    • SetAdminMode
      • SetAdminMode.do()
• ska_tmc_sdpsubarrayleafnode.manager package
  • Submodules
  • ska_tmc_sdpsubarrayleafnode.manager.component_manager module
    • SdpSLNComponentManager
      • SdpSLNComponentManager.abort()
      • SdpSLNComponentManager.assign_resources()
      • SdpSLNComponentManager.assign_resources_schema_version
      • SdpSLNComponentManager.cmd_ended_cb()
      • SdpSLNComponentManager.configure()
      • SdpSLNComponentManager.end()
      • SdpSLNComponentManager.end_scan()
      • SdpSLNComponentManager.generate_command_result()
      • SdpSLNComponentManager.get_attribute_dict()
      • SdpSLNComponentManager.get_device()
      • SdpSLNComponentManager.get_obs_state()
      • SdpSLNComponentManager.is_command_allowed()
      • SdpSLNComponentManager.is_command_allowed_callable()
      • SdpSLNComponentManager.lrc_result
      • SdpSLNComponentManager.off()
      • SdpSLNComponentManager.on()
      • SdpSLNComponentManager.raise_invalid_obsstate_error()
      • SdpSLNComponentManager.release_all_resources()
      • SdpSLNComponentManager.restart()
      • SdpSLNComponentManager.scan()
      • SdpSLNComponentManager.standby()
      • SdpSLNComponentManager.start_communicating()
      • SdpSLNComponentManager.stop()
      • SdpSLNComponentManager.stop_communicating()
      • SdpSLNComponentManager.update_command_result()
      • SdpSLNComponentManager.update_device_admin_mode()
      • SdpSLNComponentManager.update_device_obs_state()
      • SdpSLNComponentManager.update_exception_for_unresponsiveness()
      • SdpSLNComponentManager.update_responsiveness_info()
  • ska_tmc_sdpsubarrayleafnode.manager.event_receiver module
    • SdpSLNEventReceiver
      • SdpSLNEventReceiver.run()
      • SdpSLNEventReceiver.subscribe_events()
  • Module contents
    • SdpSLNComponentManager
      • SdpSLNComponentManager.abort()
      • SdpSLNComponentManager.assign_resources()
      • SdpSLNComponentManager.assign_resources_schema_version
      • SdpSLNComponentManager.cmd_ended_cb()
      • SdpSLNComponentManager.configure()
      • SdpSLNComponentManager.end()
      • SdpSLNComponentManager.end_scan()
      • SdpSLNComponentManager.generate_command_result()
      • SdpSLNComponentManager.get_attribute_dict()
      • SdpSLNComponentManager.get_device()
      • SdpSLNComponentManager.get_obs_state()
      • SdpSLNComponentManager.is_command_allowed()
      • SdpSLNComponentManager.is_command_allowed_callable()
      • SdpSLNComponentManager.lrc_result
      • SdpSLNComponentManager.off()
      • SdpSLNComponentManager.on()
      • SdpSLNComponentManager.raise_invalid_obsstate_error()
      • SdpSLNComponentManager.release_all_resources()
      • SdpSLNComponentManager.restart()
      • SdpSLNComponentManager.scan()
      • SdpSLNComponentManager.standby()
      • SdpSLNComponentManager.start_communicating()
      • SdpSLNComponentManager.stop()
      • SdpSLNComponentManager.stop_communicating()
      • SdpSLNComponentManager.update_command_result()
      • SdpSLNComponentManager.update_device_admin_mode()
      • SdpSLNComponentManager.update_device_obs_state()
      • SdpSLNComponentManager.update_exception_for_unresponsiveness()
      • SdpSLNComponentManager.update_responsiveness_info()
    • SdpSLNEventReceiver
      • SdpSLNEventReceiver.run()
      • SdpSLNEventReceiver.subscribe_events()
• Command Timeout
  • Usage

Submodules

ska_tmc_sdpsubarrayleafnode._sdp_subarray_leaf_node module

SDP Subarray Leaf node is to monitor the SDP Subarray and issue control actions during an observation. It also acts as a SDP contact point for Subarray Node for observation execution

class ska_tmc_sdpsubarrayleafnode.sdp_subarray_leaf_node.SdpSubarrayLeafNode(*args: Any, **kwargs: Any)

Bases: TMCBaseLeafDevice

SDP Subarray Leaf node is to monitor the SDP Subarray and issue control actions during an observation.

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

Bases: InitCommand

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

do(*args, **kwargs) → Tuple[ska_tango_base.commands.ResultCode, str]

Initializes the attributes and properties of the SdpSubarrayLeafNode.

Returns:

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

Return type:

Tuple[ResultCode, str]

always_executed_hook()

assignResourcesSchemaVersion(version: str) → None

Set or update the AssignResources schema version.

Parameters:

version (str) – assignResourcesSchema version to be set

create_component_manager() → SdpSLNComponentManager

Returns Sdp Subarray Leaf Node component manager object

Returns:

Instance of SdpSLNComponentManager

delete_device() → None

init_command_objects() → None

Initialises the command handlers for commands supported by this device.

init_device()

isAdminModeEnabled(value: bool) → None

Set the value of isAdminModeEnabled attribute

Parameters:

value (bool) – Value of isAdminModeEnabled attribute to be set.

is_Abort_allowed() → bool

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

Returns:

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

Return type:

bool

is_AssignResources_allowed() → bool

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

Returns:

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

Return type:

bool

is_Configure_allowed() → bool

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

Returns:

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

Return type:

bool

is_EndScan_allowed() → bool

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

is_End_allowed()

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

is_Off_allowed()

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

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

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

is_ReleaseAllResources_allowed() → bool

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.

Return type:

bool

is_Restart_allowed() → bool

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

Returns:

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

Return type:

bool

is_Scan_allowed() → bool

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

Returns:

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

Return type:

bool

read_isSubsystemAvailable() → bool

Read method for issubsystemavailable

Returns:

isSubsystemAvailable Attribute

Return type:

bool

read_lastDeviceInfoChanged() → str

Read the last device info change

Returns:

last deviceInfo change.

Return type:

str

read_sdpSubarrayDevName() → str

Read the sdpsubarraydevname attribute.

Returns:

current value of sdpsubarraydevname attribute.

Return type:

str

read_sdpSubarrayObsState() → ska_tango_base.control_model.ObsState

Reads the current observation state of the SDP subarray

Returns:

current observation state of the SDP subarray.

Return type:

ObsState

sdpSubarrayAdminMode() → ska_control_model.AdminMode

Get the current admin mode of SDP Subarray

Returns:

Current admin mode of SDP Subarray.

Return type:

AdminMode

update_admin_mode_callback(admin_mode: ska_control_model.AdminMode) → None

Update SDP subarray admin mode attribute callback

Parameters:

AdminMode – Callback for AdminMode.

update_availablity_callback(availablity) → None

Change event callback for isSubsystemAvailable

Parameters:

availablity – Callback for isSubsystemAvailable.

update_device_callback(dev_info: ska_tmc_common.device_info.SdpSubarrayDeviceInfo) → None

Updates device callback info

Parameters:

dev_info (SdpSubarrayDeviceInfo) – dev_info to be updated

update_lrcr_callback(lrc_result: Tuple[str, Union[ska_tango_base.commands.ResultCode, ska_tango_base.executor.TaskStatus, Exception, str]])

Change event callback for longRunningCommandResult

Parameters:

lrc_result (Tuple) – Tuple of LRCR.

update_sdp_subarray_obs_state_callback(obs_state: ska_tango_base.control_model.ObsState) → None

Updates SDP Subarray ObsState

Parameters:

obs_state (ObsState) – ObsState to be updated

write_sdpSubarrayDevName(value: str) → None

Set the sdpsubarraydevname attribute.

ska_tmc_sdpsubarrayleafnode.sdp_subarray_leaf_node.main(args=None, **kwargs)

Runs the SdpSubarrayLeafNode Tango device.

Parameters:

• args – Arguments internal to TANGO

• kwargs – Arguments internal to TANGO

Returns:

integer. Exit code of the run method.

ska_tmc_sdpsubarrayleafnode.transaction_id module

Transaction ID

ska_tmc_sdpsubarrayleafnode.transaction_id.identify_with_id(name: str, arg_name: str)

Wrapper function

Module contents

SdpSubarrayLeafNode

Properties in SDP Master Leaf Node

Property Name	Data Type	Description
SdpSubarrayFQDN	DevString	FQDN of the SDP Subarray 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.
CommandTimeOutDefault	DevFloat	Default Timeout for the command execution

Properties in SDP Subarray Leaf Node

Property Name	Data Type	Description
assign_resources_schema_version	DevString	Gets the schema version assigned to resources.

Attribute in SDP Subarray Leaf Node

Attribute Name	Data Type	Description
assignResourcesSchemaVersion	DevString	Get the version of the AssignResources schema being used.
assignResourcesSchemaVersion.write	DevString	Set or update the AssignResources schema version.