CSP Subarray Leaf Node¶

class tmcprototype.cspsubarrayleafnode.src.cspsubarrayleafnode.csp_subarray_leaf_node.CspSubarrayLeafNode(*args, **kwargs)¶

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

Device Properties

CspSubarrayFQDN:
	Property to provide FQDN of CSP Master Device

Attributes

CspsubarrayHealthState:
	Forwarded attribute to provide CSP Subarray Health State
CspSubarrayObsState:
	Forwarded attribute to provide CSP Subarray Observation State
ActivityMessage:
	String providing information about the current activity in CspSubarrayLeaf Node.
DelayModel:	Attribute to provide the delay model.
VersionInfo:	Provides Version information of TANGO device.

class tmcprototype.cspsubarrayleafnode.src.cspsubarrayleafnode.on_command.On(*args, **kwargs)¶

A class for CSP Subarray’s On() command.

Invokes On command on the CSP Subarray.

do()¶

Method to invoke On command on CSP Subarray.

Parameters:	argin – None.
Returns:	A tuple containing a return code and a string message indicating status.

The message is for information purpose only.

Return type:	(ResultCode, str)

class tmcprototype.cspsubarrayleafnode.src.cspsubarrayleafnode.off_command.Off(*args, **kwargs)¶

A class for CSP Subarray’s Off() command.

Invokes Off command on the CSP Subarray.

do()¶

Method to invoke Off command on CSP Subarray.

Parameters:	argin – None.
Returns:	A tuple containing a return code and a string message indicating status.

The message is for information purpose only.

Return type:	(ResultCode, str)

class tmcprototype.cspsubarrayleafnode.src.cspsubarrayleafnode.assign_resources_command.AssignResourcesCommand(*args, **kwargs)¶

A class for CspSubarrayLeafNode’s AssignResources() command.

It accepts subarrayID and receptor ids in JSON string format and invokes AssignResources command on CspSubarray with dish as an input argument.

do(argin)¶

Method to invoke AssignResources command on CSP Subarray.

Parameters:

The string in JSON format. The JSON contains following values (argin:DevString.) –

subarrayID: integer

dish:

Mandatory JSON object consisting of

receptorIDList:: DevVarString The individual string should contain dish numbers in string format with preceding zeroes upto 3 digits. E.g. 0001, 0002.

Example:

{: “subarrayID”:1, “dish”: { “receptorIDList”: [

“0001”, “0002”

}

Note: Enter the json string without spaces as an input.

Returns:

None

Raises:

ValueError if input argument json string contains invalid value

KeyError if input argument json string contains invalid key

DevFailed if the command execution is not successful

class tmcprototype.cspsubarrayleafnode.src.cspsubarrayleafnode.release_all_resources_command.ReleaseAllResourcesCommand(*args, **kwargs)¶

A class for CspSubarrayLeafNode’s ReleaseAllResources() command. ReleaseAllResources command is inherited from BaseCommand.

It invokes RemoveAllReceptors command on CspSubarray and releases all the resources assigned to CspSubarray.

do()¶

Method to invoke ReleaseAllResources command on CSP Subarray.

Returns:	None
Raises:	DevFailed if the command execution is not successful

class tmcprototype.cspsubarrayleafnode.src.cspsubarrayleafnode.configure_command.ConfigureCommand(*args, **kwargs)¶

A class for CspSubarrayLeafNode’s Configure() command. Configure command is inherited from BaseCommand.

This command configures a scan. It accepts configuration information in JSON string format and invokes Configure command on CspSubarray.

do(argin)¶

Method to invoke Configure command on CSP Subarray.

Parameters:	The string in JSON format. The JSON contains following values (argin:DevString.) –

Example: {“interface”:”https://schema.skatelescope.org/ska-csp-configure/1.0”,”subarray”:{“subarrayName”:”science period 23”},”common”:{“id”:”sbi-mvp01-20200325-00001-science_A”,”frequencyBand”:”1”,”subarrayID”:”1”}, “cbf”:{“fsp”:[{“fspID”:1,”functionMode”:”CORR”,”frequencySliceID”:1,”integrationTime”:1400,”corrBandwidth”:0,”channelAveragingMap”:[[0,2],[744,0]],”ChannelOffset”:0,”outputLinkMap”:[[0,0],[200,1]],”outputHost” :[[0,”192.168.1.1”]],”outputPort”:[[0,9000,1]]},{“fspID”:2,”functionMode”:”CORR”,”frequencySliceID”:2,”integrationTime”:1400,”corrBandwidth”:0,”channelAveragingMap”:[[0,2],[744,0]],”fspChannelOffset”:744, “outputLinkMap”:[[0,4],[200,5]],”outputHost”:[[0,”192.168.1.1”]],”outputPort”:[[0,9744,1]]}],”vlbi”:{},”delayModelSubscriptionPoint”:”ska_mid/tm_leaf_node/csp_subarray01/delayModel”},”pss”:{},”pst”:{}, “pointing”:{“target”:{“system”:”ICRS”,”name”:”Polaris Australis”,”RA”:”21:08:47.92”,”dec”:”-88:57:22.9”}}}

Note: Enter the json string without spaces as a input.

Returns:

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

Return type:

(ReturnCode, str)

Raises:

DevFailed if the command execution is not successful

ValueError if input argument json string contains invalid value

class tmcprototype.cspsubarrayleafnode.src.cspsubarrayleafnode.scan_command.StartScanCommand(*args, **kwargs)¶

A class for CspSubarrayLeafNode’s StartScan() command. StartScan command is inherited from BaseCommand.

This command invokes Scan command on CspSubarray. It is allowed only when CspSubarray is in ObsState READY.

do(argin)¶

Method to invoke StartScan command on CSP Subarray.

Parameters:	argin – JSON string consists of scan id (int).

Example: {“id”:1}

Note: Enter the json string without spaces as a input.

Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ReturnCode, str)
Raises:	DevFailed if the command execution is not successful

class tmcprototype.cspsubarrayleafnode.src.cspsubarrayleafnode.end_scan_command.EndScanCommand(*args, **kwargs)¶

A class for CspSubarrayLeafNode’s EndScan() command. EndScan command is inherited from BaseCommand.

It invokes EndScan command on CspSubarray. This command is allowed when CspSubarray is in obsState SCANNING.

do()¶

Method to invoke Endscan command on CSP Subarray.

Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ReturnCode, str)
Raises:	DevFailed if the command execution is not successful

class tmcprototype.cspsubarrayleafnode.src.cspsubarrayleafnode.end_command.GoToIdleCommand(*args, **kwargs)¶

A class for CspSubarrayLeafNode’s GoToIdle() command. GoToIdle command is inherited from BaseCommand.

This command invokes GoToIdle command on CSP Subarray in order to end current scheduling block.

do()¶

Method to invoke GoToIdle command on CSP Subarray.

Returns:	None
Raises:	DevFailed if the command execution is not successful

class tmcprototype.cspsubarrayleafnode.src.cspsubarrayleafnode.abort_command.AbortCommand(*args, **kwargs)¶

A class for CSPSubarrayLeafNode’s Abort() command.

Command to abort the current operation being done on the CSP subarray.

do()¶

This command invokes Abort command on CSP Subarray.

Returns:	None
Raises:	DevFailed if error occurs while invoking command on CSPSubarray.

class tmcprototype.cspsubarrayleafnode.src.cspsubarrayleafnode.restart_command.RestartCommand(*args, **kwargs)¶

A class for CSPSubarrayLeafNode’s Restart() command. Restart command is inherited from BaseCommand.

This command invokes Restart command on CSPSubarray.

do()¶

Method to invoke Restart command on CSP Subarray.

Returns:	None
Raises:	DevFailed if error occurs while invoking the command on CSpSubarray.

class tmcprototype.cspsubarrayleafnode.src.cspsubarrayleafnode.obsreset_command.ObsResetCommand(*args, **kwargs)¶

A class for CSPSubarrayLeafNode’s ObsReset() command. ObsReset command is inherited from BaseCommand.

Command to reset the CSP subarray and bring it to its RESETTING state.

do()¶

Method to invoke ObsReset command on CSP Subarray.

Parameters:	argin – None
Returns:	None
Raises:	DevFailed if error occurs while invoking the command on CSpSubarray.