Modules

ska_tmc_cspsubarrayleafnode.csp_subarray_leaf_nodemodule

Csp Subarray Leaf node monitors the CSP Subarray and issues control actions during an observation. It also acts as a CSP contact point for Subarray Node for observation execution for TMC.

class ska_tmc_cspsubarrayleafnode.csp_subarray_leaf_node.TmcLeafNodeCspSubarray(*args: Any, **kwargs: Any)

Bases: TMCBaseLeafDevice

CSP Subarray Leaf node monitors the CSP Subarray and issues control actions during an observation.

Device Properties:

TelmodelSource:

Property to provide telmodel source for array layout

TelmodelPath:

Property to provide telmodel path for array layout

CspSubarrayFQDN:

Property to provide FQDN of CSP Subarray Device

Device Attributes:

commandExecuted:

Stores command executed on the device.

lastDeviceInfoChanged:

Json String representing the last device changed in the internal model.

cspSubarrayDevName:

Stores CSP Subarray Device name.

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

Bases: InitCommand

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

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

Initializes the attributes and properties of the CspSubarrayLeafNode :return: A tuple containing a return code and a string message indicating status. The message is for information purpose only. :rtype: (ReturnCode, str)

create_component_manager()

Empty method for resolving lint issue #abstract-method

delete_device()

init_command_objects() → None

Initialises the command handlers for commands supported by this device.

init_device()

is_Abort_allowed()

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

rtype:

boolean

Raises:

• DevFailed if this command is not allowed to be run in current –

• device state –

is_AssignResources_allowed() → bool

Checks whether AssignResources command is allowed to be run in current device state. :return: True if AssignResources command is allowed to be run in current device state :rtype: boolean

is_Configure_allowed() → bool

Checks whether Configure command is allowed to be run in current device state. :return: True if Configure command is allowed to be run in current device state

Return type:

boolean

is_EndScan_allowed()

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

Returns:

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

rtype:

boolean

is_End_allowed() → bool

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

Returns:

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

rtype:

boolean

is_ReleaseAllResources_allowed() → bool

Checks whether ReleaseResources command is allowed to be run in current device state. :return: True if ReleaseResources command is allowed to be run in current device state. :rtype: boolean

is_Restart_allowed()

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

state

return:

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

rtype:

boolean

raises:

DevFailed if this command is not allowed to be run in current device state

is_Scan_allowed()

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.

rtype:

boolean

push_change_archive_events(attribute_name: str, value: Any) → None

Method to push change event and archive event of the given attribute.

Parameters:

• attribute_name (str) – Attribute name

• value (Any) – Attribute value need to be pushed

read_cspSubarrayAdminMode() → int

Read method for cspSubarrayAdminMode Attribute

read_cspSubarrayDevName() → str

Returns the CspSubarrayDevName attribute value.

read_cspSubarrayObsState() → ska_tango_base.control_model.ObsState

Read method for cspSubarrayObsState

read_delayModel()

Returns the delay model.

read_isAdminModeEnabled() → bool

Return the isAdminModeEnabled attribute value

read_isSubsystemAvailable() → bool

Read method for isSubsystemAvailable

read_lastDeviceInfoChanged() → str

Read method for Last Device info Changed

update_admin_mode_callback(admin_mode: int)

Update cspSubarrayAdminMode attribute callback

update_availablity_callback(csp_subarray_availability)

Change event callback for isSubsystemAvailable

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

Change event callback for cspSubarrayObsState

update_delay_model_callback(delay_model)

Change event callback for delay model

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

Updates the device callback

write_cspSubarrayDevName(value: str) → None

Set the cspsubarraydevname attribute.

write_cspSubarrayObsState(value: ska_tango_base.control_model.ObsState) → None

Write method for cspSubarrayObsState

write_isAdminModeEnabled(value: bool)

Set the value of isAdminModeEnabled attribute

ska_tmc_cspsubarrayleafnode.csp_subarray_leaf_node.main(args=None, **kwargs)

Runs the TmcLeafNodeCspSubarray Tango device. :param args: Arguments internal to TANGO

Parameters:

kwargs – Arguments internal to TANGO

ska_tmc_cspsubarrayleafnode.csp_subarray_leaf_node_mid module

Csp Subarray Leaf node mid monitors the CSP Subarray and issues control actions during an observation. It also acts as a CSP contact point for Subarray Node for observation execution for TMC.

class ska_tmc_cspsubarrayleafnode.csp_subarray_leaf_node_mid.MidTmcLeafNodeCspSubarray(*args: Any, **kwargs: Any)

Bases: TmcLeafNodeCspSubarray

Tango device class for tmc csp subarray leaf node low

create_component_manager() → CspSLNComponentManagerMid

Empty method for resolving lint issue #abstract-method

ska_tmc_cspsubarrayleafnode.csp_subarray_leaf_node_mid.main(args=None, **kwargs)

Runs the MidTmcLeafNodeCspSubarray. :param args: Arguments internal to TANGO

Parameters:

kwargs – Arguments internal to TANGO

Returns:

MidTmcLeafNodeCspSubarray TANGO object.

ska_tmc_cspsubarrayleafnode.csp_subarray_leaf_node_low module

CSP Subarray Leaf node low monitors the CSP Subarray and issues control actions during an observation. It also acts as a CSP contact point for Subarray Node for observation execution for TMC.

class ska_tmc_cspsubarrayleafnode.csp_subarray_leaf_node_low.LowTmcLeafNodeCspSubarray(*args: Any, **kwargs: Any)

Bases: TmcLeafNodeCspSubarray

Tango device class for tmc csp subarray leafnode low

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

Bases: InitCommand

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

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

Initializes the attributes and properties of the CspSubarrayLeafNode

create_component_manager() → CspSLNComponentManagerLow

Method for creating component manager instance Returns: Component Manager object

read_delayModelPSTBeam1()

Returns the delay model json for PST Beam. Returns: Delay model json of PST Beam1

read_delayModelPSTBeam2()

Returns the delay model json for PST Beam. Returns: Delay model json of PST Beam2

read_delayModelStationBeam01() → str

Returns the delay model value for station beam 1.

read_delayModelStationBeam02() → str

Returns the delay model value for station beam 2.

read_delayModelStationBeam03() → str

Returns the delay model value for station beam 3.

read_delayModelStationBeam04() → str

Returns the delay model value for station beam 4.

update_delay_model_pst_beam_callback1(delay_model_pst_beam: str)

Change event callback for delay model PST beam :param delay_model_pst_beam: Delay json string :type delay_model_pst_beam: str

Returns:

update_delay_model_pst_beam_callback2(delay_model_pst_beam)

Change event callback for delay model PST beam :param delay_model_pst_beam: Delay json string :type delay_model_pst_beam: str

Returns: None

update_delay_model_station_beam_callback(beam_id: str, delay_model: str) → None

Callback method to handle change events for delay model attributes of station beams. It formats the attribute name using the beam ID and pushes the updated delay model value to the change and archive events.

Parameters:

• beam_id (str) – Beam ID as a string (e.g., “1”, “2”, “3”, etc.).

• delay_model (str) – Updated delay model value in JSON format.

Returns:

None

ska_tmc_cspsubarrayleafnode.csp_subarray_leaf_node_low.main(args=None, **kwargs)

Runs the LowTmcLeafNodeCspSubarray. :param args: Arguments internal to TANGO :param **kwargs: Arguments internal to TANGO

Returns: LowTmcLeafNodeCspSubarray TANGO object.

Properties in CSP Subarry Leaf Node

Property Name	Data Type	Description
CspSubarrayFQDN	DevString	FQDN of the CSP 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.
CommandTimeOut	DevFloat	Timeout for the command execution
TelmodelSource	DevString	Property to provide telmodel source for array layout
TelmodelPath	DevString	Property to provide telmodel path for array layout
DelayModelTimeInAdvance	DevShort	Time in advance for calculating delays
DelayCadence	DevFloat | Cadence for delay calculation
DelayValidityPeriod	DevFloat | Validity period for calculated delays

Additional Properties in CSP Subarry Leaf Node Low

PSTDelayModelTimeInAdvance	DevShort	Time in advance for calculating PST beam delays
PSTDelayCadence	DevFloat	Cadence for PST beam delay calculation
PSTDelayValidityPeriod	DevFloat	Validity period for calculated PST beam delays