ska_tmc_subarraynode package

Submodules

ska_tmc_subarraynode._subarraynode_node module

Subarray Node Provides the monitoring and control interface required by users as well as other TM Components (such as OET, Central Node) for a Subarray.

class ska_tmc_subarraynode.subarray_node.AbstractSubarrayNode(*args: Any, **kwargs: Any)

Bases: ska_tango_base.ska_tango_base.SKASubarray._name

Provides the monitoring and control interface required by users as well as other TM Components (such as OET, Central Node) for a Subarray.

Device Attributes
scanID:

ID of ongoing SCAN

sbID:

ID of ongoing Scheduling Block

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

Bases: ska_tango_base.SKASubarray.ska_tango_base.SKASubarray.InitCommand._name

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

do()

Initializes the attributes and properties of the Subarray Node.

Returns

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

rtype:

(ReturnCode, str)

Raises

DevFailed if the error while subscribing the tango attribute –

Off()

Invokes Off command on SubarrayNode

On()

Invokes On command on SubarrayNode

Standby()

Invokes Standby command on SubarrayNode

always_executed_hook()

Internal construct of TANGO.

create_component_manager()
delete_device()
enqueue_command(command_name, args=None)
init_command_objects()

Initialises the command handlers for commands supported by this device.

is_Abort_allowed()

Check if command Abort is allowed in the current device state.

Returns

True if the command is allowed

Return type

boolean

is_AssignResources_allowed()

Check if command AssignResources is allowed in the current device state.

Returns

True if the command is allowed

Return type

boolean

is_Configure_allowed()

Check if command Configure is allowed in the current device state.

Returns

True if the command is allowed

Return type

boolean

is_EndScan_allowed()

Check if command EndScan is allowed in the current device state.

Returns

True if the command is allowed

Return type

boolean

is_End_allowed()

Check if command End is allowed in the current device state.

Returns

True if the command is allowed

Return type

boolean

is_ObsReset_allowed()

Check if command ObsReset is allowed in the current device state.

Returns

True if the command is allowed

Return type

boolean

is_Off_allowed()

Checks whether the command is allowed to be run in the current state

Returns

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

Return type

boolean

Raises

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

is_On_allowed()

Checks whether the command is allowed to be run in the current state

Returns

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

Return type

boolean

Raises

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

is_ReleaseAllResources_allowed()

Check if command ReleaseAllResources is allowed in the current device state.

Returns

True if the command is allowed

Return type

boolean

is_Reset_allowed()

Whether the Reset() command is allowed to be run in the current state.

Returns

whether the Reset() command is allowed to be run in the current state

Return type

boolean

is_Restart_allowed()

Check if command Restart is allowed in the current device state.

Returns

True if the command is allowed

Return type

boolean

is_Scan_allowed()

Check if command Scan is allowed in the current device state.

Returns

True if the command is allowed

Return type

boolean

is_Standby_allowed()

Checks whether the command is allowed to be run in the current state

Returns

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

Return type

boolean

Raises

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

read_commandExecuted()

Return the commandExecuted attribute.

read_commandInProgress()
read_internalModel()
read_lastCommandExecuted()

Return the lastCommandExecuted attribute as list of string.

read_lastDeviceInfoChanged()
read_sbID()

Internal construct of TANGO. Returns the scheduling block ID.

read_scanID()

Internal construct of TANGO. Returns the Scan ID.

EXAMPLE: 123 Where 123 is a Scan ID from configuration json string.

read_subarrayHealthState()
read_transformedInternalModel()
update_assigned_resources_callback(assigned_resources)
update_command_in_progress_callback(command_in_progress)
update_device_callback(dev_info)
update_subarray_health_state_callback(subarray_health_state)

ska_tmc_subarraynode._subarraynode_node_low module

Subarray Node Low provides the monitoring and control interface required by users as well as other TM Components (such as OET, Central Node) for a Subarray Low.

class ska_tmc_subarraynode.subarray_node_low.SubarrayNodeLow(*args: Any, **kwargs: Any)

Bases: ska_tango_base.ska_tango_base.SKASubarray._name

Provides the monitoring and control interface required by users as well as other TM Components (such as OET, Central Node) for a Subarray.

Device Properties
MccsSubarrayLNFQDN:

This property contains the FQDN of the MCCS Subarray Leaf Node associated with the Subarray Node.

MccsSubarrayFQDN:

This property contains the FQDN of the MCCS Subarray associated with the Subarray Node.

Device Attributes

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

Bases: ska_tango_base.SKASubarray.ska_tango_base.SKASubarray.InitCommand._name

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

do()

Initializes the attributes and properties of the Subarray Node Mid.

Returns

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

rtype:

(ReturnCode, str)

Raises

DevFailed if the error while subscribing the tango attribute –

create_component_manager()
init_command_objects()

Initialises the command handlers for commands supported by this device.

read_mccsSubarrayDevName()

Return the mccsSubarrayDevName attribute.

read_tmcLeafMccsSubarrayDevName()

Return the tmcLeafMccsSubarrayDevName attribute.

write_mccsSubarrayDevName(value)

Set the mccsSubarrayDevName attribute.

write_tmcLeafMccsSubarrayDevName(value)

Set the tmcLeafMccsSubarrayDevName attribute.

ska_tmc_subarraynode.subarray_node_low.main(args=None, **kwargs)

Runs the SubarrayNodeLow. :param args: Arguments internal to TANGO :param kwargs: Arguments internal to TANGO :return: SubarrayNodeLow TANGO object.

ska_tmc_subarraynode._subarraynode_node_mid module

Subarray Node Mid provides the monitoring and control interface required by users as well as other TM Components (such as OET, Central Node) for a Subarray Mid.

class ska_tmc_subarraynode.subarray_node_mid.SubarrayNodeMid(*args: Any, **kwargs: Any)

Bases: ska_tango_base.ska_tango_base.SKASubarray._name

Provides the monitoring and control interface required by users as well as other TM Components (such as OET, Central Node) for a Subarray.

Device Properties
SdpSubarrayLNFQDN:

This property contains the FQDN of the SDP Subarray Leaf Node associated with the Subarray Node.

CspSubarrayLNFQDN:

This property contains the FQDN of the CSP Subarray Leaf Node associated with the Subarray Node.

DishLeafNodePrefix:

Device name prefix for the Dish Leaf Node.

CspSubarrayFQDN:

FQDN of the CSP Subarray Tango Device Server.

SdpSubarrayFQDN:

FQDN of the CSP Subarray Tango Device Server.

Device Attributes

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

Bases: ska_tango_base.SKASubarray.ska_tango_base.SKASubarray.InitCommand._name

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

do()

Initializes the attributes and properties of the Subarray Node Mid.

Returns

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

rtype:

(ReturnCode, str)

Raises

DevFailed if the error while subscribing the tango attribute –

init_command_objects()

Initialises the command handlers for commands supported by this device.

read_cspSubarrayDevName()

Return the cspsubarraydevname attribute.

read_dishDevNames()

Return the dishdevnames attribute.

read_sdpSubarrayDevName()

Return the sdpsubarraydevname attribute.

read_tmcLeafCspSubarrayDevName()

Return the tmcLeafCspSubarrayDevName attribute.

read_tmcLeafDishDevNames()

Return the tmcLeafDishDevNames attribute.

read_tmcLeafSdpSubarrayDevName()

Return the tmcLeafSdpSubarrayDevName attribute.

write_cspSubarrayDevName(value)

Set the cspsubarraydevname attribute.

write_dishDevNames(value)

Set the dishdevnames attribute.

write_sdpSubarrayDevName(value)

Set the sdpsubarraydevname attribute.

write_tmcLeafCspSubarrayDevName(value)

Set the tmcLeafCspSubarrayDevName attribute.

write_tmcLeafDishDevNames(value)

Set the tmcLeafDishDevNames attribute.

write_tmcLeafSdpSubarrayDevName(value)

Set the tmcLeafSdpSubarrayDevName attribute.

ska_tmc_subarraynode.subarray_node_mid.main(args=None, **kwargs)

Runs the SubarrayNode. :param args: Arguments internal to TANGO :param kwargs: Arguments internal to TANGO :return: SubarrayNode TANGO object.

ska_tmc_subarraynode.exceptions module

exception ska_tmc_subarraynode.exceptions.CommandNotAllowed

Bases: Exception

Raised when a command is not allowed.

exception ska_tmc_subarraynode.exceptions.DeviceUnresponsive

Bases: Exception

Raised when a device is not responsive.

exception ska_tmc_subarraynode.exceptions.InvalidObsStateError

Bases: ValueError

Raised when subarray is not in required obsState.

ska_tmc_subarraynode.release module

Release information for Python Package

ska_tmc_subarraynode.transaction_id module

ska_tmc_subarraynode.transaction_id.identify_with_id(name: str, arg_name: str)
ska_tmc_subarraynode.transaction_id.inject_id(obj, data: Dict) → Dict
ska_tmc_subarraynode.transaction_id.inject_with_id(arg_position: int, arg_name: str)
ska_tmc_subarraynode.transaction_id.update_with_id(obj, parameters: Any) → Union[Dict, str]

Module contents