Welcome to TMC Prototype’s documentation!

Central Node

class tmcprototype.centralnode.src.centralnode.central_node.CentralNode(*args, **kwargs)

Central Node is a coordinator of the complete M&C system.

Device Properties

CentralAlarmHandler:
 Device name of CentralAlarmHandler
TMAlarmHandler:Device name of TMAlarmHandler
TMMidSubarrayNodes:
 List of TM Mid Subarray Node devices
NumDishes:Number of Dishes
DishLeafNodePrefix:
 Device name prefix for Dish Leaf Node
CspMasterLeafNodeFQDN:
 FQDN of CSP Master Leaf Node.
SdpMasterLeafNodeFQDN:
 FQDN of SDP Master Leaf Node.

Device Attributes

TelescopeHealthState:
 Health state of Telescope
Subarray1HealthState:
 Health state of Subarray1
Subarray2HealthState:
 Health state of Subarray2
Subarray3HealthState:
 Health state of Subarray3
ActivityMessage:
 String providing information about the current activity in Central Node.
class tmcprototype.centralnode.src.centralnode.assign_resources_command.AssignResources(*args, **kwargs)

A class for CentralNode’s AssignResources() command.

Assigns resources to given subarray. It accepts the subarray id, receptor id list and SDP block in JSON string format. Upon successful execution, the ‘receptorIDList’ attribute of the given subarray is populated with the given receptors.Also checking for duplicate allocation of resources is done. If already allocated it will throw error message regarding the prior existence of resource.

do(argin)

Method to invoke AssignResources command on Subarray.

Parameters:argin –

The string in JSON format. The JSON contains following values:

subarrayID:
DevShort. Mandatory.
dish:
Mandatory JSON object consisting of
receptorIDList:
DevVarStringArray The individual string should contain dish numbers in string format with preceding zeroes upto 3 digits. E.g. 0001, 0002.
sdp:
Mandatory JSON object consisting of
id:
DevString The SBI id.
max_length:
DevDouble Maximum length of the SBI in seconds.
scan_types:
array of the blocks each consisting following parameters id:
DevString The scan id.
coordinate_system:
DevString
ra:
DevString
Dec:
DevString
processing_blocks:
array of the blocks each consisting following parameters id:
DevString The Processing Block id.
workflow:
type:
DevString
id:
DevString
version:
DevString
parameters:
{}
Example:
{“subarrayID”:1,”dish”:{“receptorIDList”:[“0001”,”0002”]},”sdp”:{“id”:”sbi-mvp01-20200325-00001”, “max_length”:100.0,”scan_types”:[{“id”:”science_A”,”coordinate_system”:”ICRS”,”ra”:”02:42:40.771” ,”dec”:”-00:00:47.84”,”channels”:[{“count”:744,”start”:0,”stride”:2,”freq_min”: 0.35e9,”freq_max”:0.368e9,”link_map”:[[0,0],[200,1],[744,2],[944,3]]},{“count”:744,”start”:2000, “stride”:1,”freq_min”:0.36e9,”freq_max”:0.368e9,”link_map”:[[2000,4],[2200,5]]}]},{“id”: “calibration_B”,”coordinate_system”:”ICRS”,”ra”:”12:29:06.699”,”dec”:”02:03:08.598”, “channels”:[{“count”:744,”start”:0,”stride”:2,”freq_min”:0.35e9,”freq_max”:0.368e9,”link_map”: [[0,0],[200,1],[744,2],[944,3]]},{“count”:744,”start”:2000,”stride”:1,”freq_min”:0.36e9, “freq_max”:0.368e9,”link_map”:[[2000,4],[2200,5]]}]}],”processing_blocks”:[{“id”: “pb-mvp01-20200325-00001”,”workflow”:{“type”:”realtime”,”id”:”vis_receive”,”version”: “0.1.0”},”parameters”:{}},{“id”:”pb-mvp01-20200325-00002”,”workflow”:{“type”:”realtime”, “id”:”test_realtime”,”version”:”0.1.0”},”parameters”:{}},{“id”:”pb-mvp01-20200325-00003”, “workflow”:{“type”:”batch”,”id”:”ical”,”version”:”0.1.0”},”parameters”:{},”dependencies”: [{“pb_id”:”pb-mvp01-20200325-00001”,”type”:[“visibilities”]}]},{“id”:”pb-mvp01-20200325-00004” ,”workflow”:{“type”:”batch”,”id”:”dpreb”,”version”:”0.1.0”},”parameters”:{},”dependencies”: [{“pb_id”:”pb-mvp01-20200325-00003”,”type”:[“calibration”]}]}]}}

Note: From Jive, enter above input string without any space.

Returns:A tuple containing a return code and a string in JSON format on successful assignment of given resources. The JSON string contains following values:
dish:
Mandatory JSON object consisting of
receptorIDList_success:
DevVarStringArray Contains ids of the receptors which are successfully allocated. Empty on unsuccessful allocation.
Example:
{ “dish”: { “receptorIDList_success”: [“0001”, “0002”] } }

Note: Enter input without spaces as:{“dish”:{“receptorIDList_success”:[“0001”,”0002”]}}
Return type:None
Raises:DevFailed when the API fails to allocate resources.
class tmcprototype.centralnode.src.centralnode.release_resources_command.ReleaseResources(*args, **kwargs)

A class for CentralNode’s ReleaseResources() command.

Release all the resources assigned to the given Subarray. It accepts the subarray id, releaseALL flag and receptorIDList in JSON string format. When the releaseALL flag is True, ReleaseAllResources command is invoked on the respective SubarrayNode. In this case, the receptorIDList tag is empty as all the resources of the Subarray are to be released. When releaseALL is False, ReleaseResources will be invoked on the SubarrayNode and the resources provided in receptorIDList tag, are to be released from the Subarray. The selective release of the resources when releaseALL Flag is False is not yet supported.

do(argin)

Method to invoke ReleaseResources command on Subarray.

Parameters:argin –

The string in JSON format. The JSON contains following values:

subarrayID:
DevShort. Mandatory.
releaseALL:
Boolean(True or False). Mandatory. True when all the resources to be released from Subarray.
receptorIDList:
DevVarStringArray. Empty when releaseALL tag is True.
Example:
{
“subarrayID”: 1, “releaseALL”: true, “receptorIDList”: []

}

Note: From Jive, enter input as: {“subarrayID”:1,”releaseALL”:true,”receptorIDList”:[]} without any space.

Returns:A tuple containing a return code and a string in josn format on successful release of all the resources. The JSON string contains following values:
releaseALL:
Boolean(True or False). If True, all the resources are successfully released from the Subarray.
receptorIDList:
DevVarStringArray. If releaseALL is True, receptorIDList is empty. Else list returns resources (device names) that are noe released from the subarray.
Example:
argout = {
”ReleaseAll” : True, “receptorIDList” : []

}

rtype:

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 or command invocation on SubarrayNode is not successful
class tmcprototype.centralnode.src.centralnode.stand_by_telescope_command.StandByTelescope(*args, **kwargs)

A class for CentralNode’s StandByTelescope() command.

Sets the CentralNode into OFF state. Invokes the respective command on lower level nodes. Invokes command on DishLeaf node, SDPMasterLeaf node, CSPMasterLeaf node and Subarray Node.

do()

Method to invoke Off command on Lower level devices.

Param:None
Returns:A tuple containing a return code and a string message indicating status. The message is for information
Return type:(ResultCode, str)
class tmcprototype.centralnode.src.centralnode.start_up_telescope_command.StartUpTelescope(*args, **kwargs)

A class for CentralNode’s StartupCommand() command.

Setting the startup state to TRUE enables the telescope to accept subarray commands as per the subarray model. Set the CentralNode into ON state. Invokes ‘On’ command on DishLeaf node, SDPMasterLeaf node, CSPMasterLeaf node and Subarray Node.

do()

Method to invoke On command on Lower level devices.

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.centralnode.src.centralnode.stow_antennas_command.StowAntennas(*args, **kwargs)

A class for CentralNode’s StowAntennas() command.

Invokes the command SetStowMode on the specified receptors.

do(argin)

Method to invoke StowAntennas command.

Parameters:

argin – List of Receptors to be stowed.
Returns:

None
Raises:

DevFailed if error occurs while invoking command of DishLeafNode

ValueError if error occurs if input argument json string contains invalid value

Central Node

class tmcprototype.centralnodelow.src.centralnodelow.central_node_low.CentralNode(*args, **kwargs)

Central Node is a coordinator of the complete M&C system.

Device Properties

CentralAlarmHandler:
 Device name of CentralAlarmHandler
TMAlarmHandler:Device name of TMAlarmHandler
TMLowSubarrayNodes:
 List of TM Low Subarray Node devices
MCCSMasterLeafNodeFQDN:
 FQDN of Mccs Master Leaf Node.

Device Attributes

TelescopeHealthState:
 Health state of Telescope
Subarray1HealthState:
 Health state of Subarray1
ActivityMessage:
 String providing information about the current activity in Central Node.
class tmcprototype.centralnodelow.src.centralnodelow.assign_resources_command.AssignResources(*args, **kwargs)

A class for CentralNode’s AssignResources() command.

Assigns resources to given subarray. It accepts the subarray id, station ids, station beam id and channels in JSON string format.

do(argin)

Method to invoke AssignResources command on Subarray.

Parameters:argin –

The string in JSON format. The JSON contains following values:

subarray_id:
DevShort. Mandatory. Sub-Array to allocate resources to
station_ids:
DevArray. Mandatory list of stations contributing beams to the data set
channels:
DevArray. Mandatory list of frequency channels used
station_beam_ids:
DevArray. Mandatory logical ID of beam
Example:
{“mccs”:{“subarray_id”:1,”station_ids”:[1,2],”channels”:[[0,8,1,1],[8,8,2,1],[24,16,2,1]],”station_beam_ids”:[1]}}

Note: Enter input without spaces as:{“subarray_id”:1,”station_ids”:[1,2],”channels”:[1,2,3,4,5,6,7,8],”station_beam_ids”:[1]}

Returns:

None
Raises:

KeyError if input argument json string contains invalid key

ValueError if input argument json string contains invalid value
class tmcprototype.centralnodelow.src.centralnodelow.release_resources_command.ReleaseResources(*args, **kwargs)

A class for CentralNodeLow’s ReleaseResources() command.

do(argin)

Release all the resources assigned to the given Subarray. It accepts the subarray id, release_all flag in JSON string format. When the release_all flag is True, ReleaseAllResources command is invoked on the respective SubarrayNode.

Parameters:

argin –

The string in JSON format. The JSON contains following values:

subarray_id:

DevShort. Mandatory.

release_all:

Boolean(True or False). Mandatory. True when all the resources to be released from Subarray.

Example:

{“mccs”:{“subarray_id”:1,”release_all”:true}}

Note: From Jive, enter input as:

{“mccs”:{“subarray_id”:1,”release_all”:true}} without any space.
Raises:

ValueError if input argument json string contains invalid value

KeyError if input argument json string contains invalid key

DevFailed if the command execution or command invocation on SubarrayNode is not successful
class tmcprototype.centralnodelow.src.centralnodelow.standby_telescope_command.StandByTelescope(*args, **kwargs)

A class for Low CentralNode’s StandByTelescope() command.

Sets the CentralNodeLow into OFF state. Invokes the respective command on lower level nodes and devices.

do()

Method to invoke StartBy command.

param 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)
Raises:AssertionError if command is not completed.
class tmcprototype.centralnodelow.src.centralnodelow.startup_telescope_command.StartUpTelescope(*args, **kwargs)

A class for Low CentralNode’s StartupCommand() command.

Setting the startup state to TRUE enables the telescope to accept subarray commands as per the subarray model. Set the CentralNode into ON state.

do()

Method to invoke StartUp command.

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)
Raises:AssertionError if command is not completed.

Subarray Node

class tmcprototype.subarraynode.src.subarraynode.subarray_node.SubarrayNode(*args, **kwargs)

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

ScanID:ID of ongoing SCAN
SbID:ID of ongoing Scheduling Block
ActivityMessage:
 String providing information about the current activity in SubarrayNode.
ReceptorIDList:ID List of the Receptors assigned in the Subarray.
class tmcprototype.subarraynode.src.subarraynode.on_command.On(*args, **kwargs)

A class for the SubarrayNode’s On() command.

This command invokes On Command on CSPSubarray and SDPSubarray through respective leaf nodes. This comamnd changes Subaray device state from OFF to ON.

do()

Method to invoke On command.

Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:(ResultCode, str)
Raises:DevFailed if the command execution is not successful
class tmcprototype.subarraynode.src.subarraynode.off_command.Off(*args, **kwargs)

A class for the SubarrayNodes’s Off() command.

This command invokes Off Command on CSPSubarray and SDPSubarray through respective leaf nodes. This comamnd changes Subaray device state from ON to OFF.

do()

Method to invoke Off command.

Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:(ResultCode, str)
Raises:DevFailed if the command execution is not successful
class tmcprototype.subarraynode.src.subarraynode.assign_resources_command.AssignResources(*args, **kwargs)

A class for SubarrayNode’s AssignResources() command.

Assigns resources to the subarray. It accepts receptor id list as well as SDP resources string as a DevString. Upon successful execution, the ‘receptorIDList’ attribute of the subarray is updated with the list of receptors and SDP resources string is pass to SDPSubarrayLeafNode, and returns list of assigned resources as well as passed SDP string as a DevString.

Note: Resource allocation for CSP and SDP resources is also implemented but currently CSP accepts only receptorIDList and SDP accepts resources allocated to it.

do(argin)

Method to invoke AssignResources command.

Parameters:argin – DevString.

Example:

{“subarraID”:1,”dish”:{“receptorIDList”:[“0002”,”0001”]},”sdp”:{“id”: “sbi-mvp01-20200325-00001”,”max_length”:100.0,”scan_types”:[{“id”:”science_A”, “coordinate_system”:”ICRS”,”ra”:”02:42:40.771”,”dec”:”-00:00:47.84”,”channels”: [{“count”:744,”start”:0,”stride”:2,”freq_min”:0.35e9,”freq_max”:0.368e9, “link_map”:[[0,0],[200,1],[744,2],[944,3]]},{“count”:744,”start”:2000,”stride”:1, “freq_min”:0.36e9,”freq_max”:0.368e9,”link_map”:[[2000,4],[2200,5]]}]},{“id”: “calibration_B”,”coordinate_system”:”ICRS”,”ra”:”12:29:06.699”,”dec”:”02:03:08.598”, “channels”:[{“count”:744,”start”:0,”stride”:2,”freq_min”:0.35e9, “freq_max”:0.368e9,”link_map”:[[0,0],[200,1],[744,2],[944,3]]},{“count”:744, “start”:2000,”stride”:1,”freq_min”:0.36e9,”freq_max”:0.368e9,”link_map”:[[2000,4], [2200,5]]}]}],”processing_blocks”:[{“id”:”pb-mvp01-20200325-00001”,”workflow”: {“type”:”realtime”,”id”:”vis_receive”,”version”:”0.1.0”},”parameters”:{}}, {“id”:”pb-mvp01-20200325-00002”,”workflow”:{“type”:”realtime”,”id”:”test_realtime”, “version”:”0.1.0”},”parameters”:{}},{“id”:”pb-mvp01-20200325-00003”,”workflow”: {“type”:”batch”,”id”:”ical”,”version”:”0.1.0”},”parameters”:{},”dependencies”:[ {“pb_id”:”pb-mvp01-20200325-00001”,”type”:[“visibilities”]}]},{“id”: “pb-mvp01-20200325-00004”,”workflow”:{“type”:”batch”,”id”:”dpreb”,”version”:”0.1.0”}, “parameters”:{},”dependencies”:[{“pb_id”:”pb-mvp01-20200325-00003”,”type”: [“calibration”]}]}]}}

Returns:

A tuple containing a return code and string of Resources added to the Subarray. Example of string of Resources :

[“0001”,”0002”]

as argout if allocation successful.
Return type:

(ResultCode, str)
Raises:

ValueError if input argument json string contains invalid value

DevFailed if the command execution is not successful
class tmcprototype.subarraynode.src.subarraynode.release_all_resources_command.ReleaseAllResources(*args, **kwargs)

A class for SKASubarray’s ReleaseAllResources() command.

It checks whether all resources are already released. If yes then it throws error while executing command. If not it Releases all the resources from the subarray i.e. Releases resources from TMC Subarray Node, CSP Subarray and SDP Subarray. If the command execution fails, array of receptors(device names) which are failed to be released from the subarray, is returned to Central Node. Upon successful execution, all the resources of a given subarray get released and empty array is returned. Selective release is not yet supported.

do()

Method to invoke ReleaseAllResources command.

Returns:A tuple containing a return code and “[]” as a string on successful release all resources.

Example: “[]” as string on successful release all resources.

Return type:(ResultCode, str)
Raises:DevFailed if the command execution is not successful
class tmcprototype.subarraynode.src.subarraynode.configure_command.Configure(*args, **kwargs)

A class for SubarrayNode’s Configure() command.

Configures the resources assigned to the Subarray.The configuration data for SDP, CSP and Dish is extracted out of the input configuration string and relayed to the respective underlying devices (SDP Subarray Leaf Node, CSP Subarray Leaf Node and Dish Leaf Node).

do(argin)

Method to invoke Configure command.

Parameters:argin – DevString.

JSON string that includes pointing parameters of Dish - Azimuth and Elevation Angle, CSP Configuration and SDP Configuration parameters. JSON string example is: {“pointing”:{“target”:{“system”:”ICRS”,”name”:”Polaris Australis”,”RA”:”21:08:47.92”,”dec”:”-88:57:22.9”}} ,”dish”:{“receiverBand”:”1”},”csp”:{“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”:{}},”pss”:{},”pst”:{}},”sdp”:{“scan_type”:”science_A”},”tmc”:{“scanDuration”:10.0}}

Note: While invoking this command from JIVE, provide above JSON string without any space.

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:JSONDecodeError if input argument json string contains invalid value
class tmcprototype.subarraynode.src.subarraynode.scan_command.Scan(*args, **kwargs)

A class for SubarrayNode’s Scan() command.

This command accepts id as input. And it Schedule scan on subarray from where scan command is invoked on respective CSP and SDP subarray node for the provided interval of time. It checks whether the scan is already in progress. If yes it throws error showing duplication of command.

do(argin)

Method to invoke Scan command.

Parameters:argin – DevString. JSON string containing id.
Example:{“id”: 1}

Note: Above JSON string can be used as an input argument while invoking this command from JIVE.

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.subarraynode.src.subarraynode.end_scan_command.EndScan(*args, **kwargs)

A class for SubarrayNode’s EndScan() command.

Ends the scan. It is invoked on subarray after completion of the scan duration. It can also be invoked by an external client while a scan is in progress, Which stops the scan immediately irrespective of the provided scan duration.

do()

Method to invoke Endscan command.

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.subarraynode.src.subarraynode.end_command.End(*args, **kwargs)

A class for SubarrayNode’s End() command.

This command on Subarray Node invokes EndSB command on CSP Subarray Leaf Node and SDP Subarray Leaf Node, and stops tracking of all the assigned dishes.

do()

Method to invoke End command.

Returns:A tuple containing a return code and a string message indicating status.

The message is for information purpose only.

Return type:(ResultCode, str)
Raises:DevFailed if the command execution is not successful.
class tmcprototype.subarraynode.src.subarraynode.abort_command.Abort(*args, **kwargs)

A class for SubarrayNode’s Abort() command.

This command on Subarray Node invokes Abort command on CSP Subarray Leaf Node and SDP Subarray Leaf Node, and stops tracking of all the assigned dishes.

do()

Method to invoke Abort command.

Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:(ResultCode, str)
Raises:DevFailed if error occurs in invoking command on any of the devices like CSPSubarrayLeafNode, SDPSubarrayLeafNode or DishLeafNode
class tmcprototype.subarraynode.src.subarraynode.restart_command.Restart(*args, **kwargs)

A class for SubarrayNode’s Restart() command.

This command invokes Restart command on CSPSubarrayLeafNode, SDpSubarrayLeafNode and DishLeafNode.

do()

Method to invoke Restart command.

Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:(ResultCode, str)
Raises:DevFailed if error occurs while invoking command on CSPSubarrayLeafNode, SDpSubarrayLeafNode or DishLeafNode.
class tmcprototype.subarraynode.src.subarraynode.obsreset_command.ObsReset(*args, **kwargs)

A class for SubarrayNode’s ObsReset() command.

This command invokes ObsReset command on CspSubarrayLeafNode, SdpSubarrayLeafNode and DishLeafNode.

do()

Method to invoke ObsReset command.

Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:(ResultCode, str)
Raises:DevFailed if error occurs while invoking command on CspSubarrayLeafNode, SdpSubarrayLeafNode or DishLeafNode.
class tmcprototype.subarraynode.src.subarraynode.track_command.Track(*args, **kwargs)

A class for SubarrayNode’s Track command.

Invokes Track command on the Dishes assigned to the Subarray.

do(argin)

Method to invoke Track command.

Parameters:argin – DevString

Example: radec|21:08:47.92|-88:57:22.9 as argin Argin to be provided is the Ra and Dec values where first value is tag that is radec, second value is Ra in Hr:Min:Sec, and third value is Dec in Deg:Min:Sec.

Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:(ResultCode, str)

Subarray Node Low

class tmcprototype.subarraynodelow.src.subarraynodelow.subarray_node_low.SubarrayNode(*args, **kwargs)

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

ScanID:ID of ongoing SCAN
ActivityMessage:
 String providing information about the current activity in SubarrayNode.
class tmcprototype.subarraynodelow.src.subarraynodelow.on_command.On(*args, **kwargs)

A class for the SubarrayNodeLow’s On() command.

This command invokes On Command on MCCSSubarray through MCCS Subarray Leaf node. This comamnd changes Subarray device state from OFF to ON.

do()

Method to invoke On command.

Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:(ResultCode, str)
Raises:DevFailed if the command execution is not successful
class tmcprototype.subarraynodelow.src.subarraynodelow.off_command.Off(*args, **kwargs)

A class for the SubarrayNodes’s Off() command.

This command invokes Off Command on MCCSSubarray through mccs subarray leaf node. This comamnd changes Subaray device state from ON to OFF.

do()

Method to invoke Off command.

Returns:A tuple containing a return code and a string message indicating status.

The message is for information purpose only.

Return type:(ResultCode, str)
Raises:DevFailed if the command execution is not successful
class tmcprototype.subarraynodelow.src.subarraynodelow.assign_resources_command.AssignResources(*args, **kwargs)

A class for SubarrayNodelow’s AssignResources() command.

Assigns the resources to the subarray. It accepts station ids, channels, station beam ids

do(argin)

Method to invoke AssignResources command.

Parameters:argin –

DevString in JSON form containing following fields: station_ids: list of integers

channels: list of integers

station_beam_ids: list of integers

Example:

{“station_ids”:[1,2],”channels”:[[0,8,1,1],[8,8,2,1],[24,16,2,1]],”station_beam_ids”:[1]}

Returns:A tuple containing ResultCode and string.
class tmcprototype.subarraynodelow.src.subarraynodelow.release_all_resources_command.ReleaseAllResources(*args, **kwargs)

A class for SKASubarrayLow’s ReleaseAllResources() command.

It invokes ReleaseAllResources command on Subarraylow.

do()

Method to invoke ReleaseAllResources command.

Returns:A tuple containing a return code and RELEASEALLRESOURCES command invoked successfully as a string on successful release all resources.

Example: RELEASEALLRESOURCES command invoked successfully as string on successful release all resources.

Return type:(ResultCode, str)
class tmcprototype.subarraynodelow.src.subarraynodelow.configure_command.Configure(*args, **kwargs)

A class for SubarrayNodeLow’s Configure() command.

Configures the resources assigned to the Mccs Subarray.

do(argin)

Method to invoke Configure command.

Parameters:argin – DevString.

JSON string example is:

{“mccs”:{“stations”:[{“station_id”:1},{“station_id”:2}],”subarray_beams”:[{“subarray_id”:1, “subarray_beam_id”:1,”target”:{“system”:”HORIZON”,”name”:”DriftScan”,”Az”:180.0,”El”:45.0}, “update_rate”:0.0,”channels”:[[0,8,1,1],[8,8,2,1],[24,16,2,1]]}]},”tmc”:{“scanDuration”:10.0}}
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:JSONDecodeError if input argument json string contains invalid value DevFailed if the command execution is not successful.
class tmcprototype.subarraynodelow.src.subarraynodelow.scan_command.Scan(*args, **kwargs)

A class for SubarrayNodeLow’s Scan() command.

This command accepts id as input. And it Schedule scan on subarray from where scan command is invoked on MCCS subarray Leaf Node for the provided interval of time. It checks whether the scan is already in progress. If yes it throws error showing duplication of command.

do(argin)

Method to invoke Scan command.

Parameters:argin – DevString. JSON string containing id.

JSON string example as follows:

{“mccs”:{“id”:1,”scan_time”:0.0}} Note: Above JSON string can be used as an input argument while invoking this command from JIVE.

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.subarraynodelow.src.subarraynodelow.end_scan_command.EndScan(*args, **kwargs)

A class for SubarrayNodeLow’s EndScan() command.

Ends the scan. It is invoked on subarrayLow after completion of the scan duration. It can also be invoked by an external client while a scan is in progress, Which stops the scan immediately irrespective of the provided scan duration.

do()

Method to invoke EndScan command.

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.subarraynodelow.src.subarraynodelow.end_command.End(*args, **kwargs)

A class for SubarrayNodeLow’s End() command.

This command on Subarray Node Low invokes End command on MCCS Subarray Leaf Node.

do()

Method to invoke End command.

Returns:A tuple containing a return code and a string message indicating status.

The message is for information purpose only.

Return type:(ResultCode, str)
Raises:DevFailed if the command execution is not successful.
class tmcprototype.subarraynodelow.src.subarraynodelow.abort_command.Abort(*args, **kwargs)

A class for SubarrayNode’s Abort() command.

This command on Subarray Node Low invokes Abort command on MCCS Subarray Leaf Node and aborts ongoing activity.

do()

Method to invoke Abort command.

Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:(ResultCode, str)
Raises:DevFailed if error occurs in invoking command on MCCS Subarrayleaf node.
class tmcprototype.subarraynodelow.src.subarraynodelow.obsreset_command.ObsReset(*args, **kwargs)

A class for Low SubarrayNode’s ObsReset() command.

This command invokes ObsReset command on MccsSubarrayLeafNode.

do()

Method to invoke ObsReset command.

Returns:A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:(ResultCode, str)
Raises:DevFailed if error occurs while invoking command on MccsSubarrayLeafNode.

Dish Leaf Node

class tmcprototype.dishleafnode.src.dishleafnode.dish_leaf_node.DishLeafNode(*args, **kwargs)

A Leaf control node for DishMaster.

Device Properties

DishMasterFQDN:FQDN of Dish Master Device

Attributes

ActivityMessage:
 String providing information about the current activity in DishLeaf Node.
DishHealthState:
 Forwarded attribute to provide Dishleafnode Health State
DishPointingState:
 Forwarded attribute to provide Dishleafnode Pointing State
class tmcprototype.dishleafnode.src.dishleafnode.setoperatemode_command.SetOperateMode(*args, **kwargs)

A class for DishLeafNode’s SetOperateMode() command.

Invokes SetOperateMode command on DishMaster.

do()

Method to invoke SetOperateMode command on DishMaster.

Parameters:argin – None
Returns:None
Raises:DevFailed If error occurs while invoking SetOperateMode command on DishMaster.
class tmcprototype.dishleafnode.src.dishleafnode.setstandbyfpmode_command.SetStandbyFPMode(*args, **kwargs)

A class for DishLeafNode’s SetStandbyFPMode() command.

Invokes SetStandbyFPMode command on DishMaster (Standby-Full power) mode.

do()

Method to Invoke SetStandbyFPMode on DishMaster.

Parameters:argin – None
Returns:None
Raises:DevFailed If error occurs while invoking SetStandbyFPMode command on DishMaster.
class tmcprototype.dishleafnode.src.dishleafnode.setstandbylpmode_command.SetStandbyLPMode(*args, **kwargs)

A class for DishLeafNode’s SetStandbyLPMode() command.

Invokes SetStandbyLPMode (i.e. Low Power State) command on DishMaster.

do()

Method to invoke SetStandbyLPMode command on DishMaster.

Parameters:argin – None

:return:None

Raises:DevFailed If error occurs while invoking SetStandbyLPMode command on DishMaster.
class tmcprototype.dishleafnode.src.dishleafnode.setstowmode_command.SetStowMode(*args, **kwargs)

A class for DishLeafNode’s SetStowMode() command.

do()

Invokes SetStowMode command on DishMaster.

Parameters:argin – None
Returns:None
Raises:DevFailed If error occurs while invoking SetStowMode command on DishMaster.
class tmcprototype.dishleafnode.src.dishleafnode.configure_command.Configure(*args, **kwargs)

A class for DishLeafNode’s Configure() command.

Configures the Dish by setting pointing coordinates for a given scan. This function accepts the input json and calculate pointing parameters of Dish- Azimuth and Elevation Angle. Calculated parameters are again converted to json and fed to the dish master.

do(argin)

Method to invoke Configure command on dish.

Parameters:argin –

A String in a JSON format that includes pointing parameters of Dish- Azimuth and Elevation Angle.

Example: {“pointing”:{“target”:{“system”:”ICRS”,”name”:”Polaris Australis”,”RA”:”21:08:47.92”,”dec”:”-88:57:22.9”}}, “dish”:{“receiverBand”:”1”}}
Raises:DevFailed If error occurs while invoking ConfigureBand<> command on DishMaster or if the json string contains invalid data.
class tmcprototype.dishleafnode.src.dishleafnode.scan_command.Scan(*args, **kwargs)

A class for DishLeafNode’s Scan() command.

do(argin)

Invokes Scan command on DishMaster.

Parameters:argin – timestamp
Raises:DevFailed If error occurs while invoking Scan command on DishMaster.
class tmcprototype.dishleafnode.src.dishleafnode.endscan_command.EndScan(*args, **kwargs)

A class for DishLeafNode’s EndScan() command.

do(argin)

Invokes Endscan command on DishMaster.

Parameters:argin – timestamp
Raises:DevFailed If error occurs while invoking StopCapture command on DishMaster.
class tmcprototype.dishleafnode.src.dishleafnode.slew_command.Slew(*args, **kwargs)

A class for DishLeafNode’s SlewCommand() command.

Invokes Slew command on DishMaster to slew the dish towards the set pointing coordinates.

do(argin)

Method to invoke Slew command on Dish Master.

Parameters:argin – list [0] = Azimuth, in degrees [1] = Elevation, in degrees
Raises:DevFailed If error occurs while invoking Slew command on DishMaster.
class tmcprototype.dishleafnode.src.dishleafnode.startcapture_command.StartCapture(*args, **kwargs)

A class for DishLeafNode’s StartCapture() command.

do(argin)

Invokes StartCapture command on DishMaster on the set configured band.

Parameters:argin – timestamp
Raises:DevFailed If error occurs while invoking StartCapture command on DishMaster.
class tmcprototype.dishleafnode.src.dishleafnode.stopcapture_command.StopCapture(*args, **kwargs)

A class for DishLeafNode’s StopCapture() command.

do(argin)

Invokes StopCapture command on DishMaster on the set configured band.

Parameters:argin – timestamp
Raises:DevFailed If error occurs while invoking StopCapture command on DishMaster.
class tmcprototype.dishleafnode.src.dishleafnode.stoptrack_command.StopTrack(*args, **kwargs)

A class for DishLeafNode’s StopTrack() command.

do()

Invokes StopTrack command on the DishMaster.

Parameters:argin – None
Returns:None
Raises:DevFailed If error occurs while invoking TrackStop command on DishMaster.
class tmcprototype.dishleafnode.src.dishleafnode.track_command.Track(*args, **kwargs)

A class for DishLeafNode’s Track() command.

do(argin)

Invokes Track command on the DishMaster.

Parameters:argin –

DevString The elevation limit thread allows Dish to track a source till the observation capacity i.e. elevation limit of dish.

The tracking time thread allows dish to track a source for the prespecified Track Duration (provided elevation limit is not reached).

For Track command, argin to be provided is the Ra and Dec values in the following JSON format:

{“pointing”:{“target”:{“system”:”ICRS”,”name”:”Polaris Australis”,”RA”:”21:08:47.92”,”dec”:”-88:57:22.9”}}, “dish”:{“receiverBand”:”1”}}
Raises:DevFailed If error occurs while invoking Track command on DishMaster.
class tmcprototype.dishleafnode.src.dishleafnode.abort_command.Abort(*args, **kwargs)

A class for DishLeafNode’s Abort command.

do()

Invokes Abort command on the DishMaster.

Parameters:argin – None
Returns:None
Raises:DevFailed If error occurs while invoking TrackStop command on DishMaster.
class tmcprototype.dishleafnode.src.dishleafnode.restart_command.Restart(*args, **kwargs)

A class for DishLeafNode’s Restart command.

Invokes Restart command on the DishMaster.

do()

Method to invoke Restart command on the DishMaster.

Parameters:argin – None
Returns:None
Raises:DevFailed If error occurs while invoking StopCapture command on DishMaster.
class tmcprototype.dishleafnode.src.dishleafnode.obsreset_command.ObsReset(*args, **kwargs)

A class for DishLeafNode’s ObsReset command.

do()

Invokes ObsReset command on the DishMaster.

Parameters:argin – None
Returns:None
Raises:DevFailed If error occurs while invoking StopCapture command on DishMaster.

Dish Master

override class with command handlers for dsh-lmc.

class tmcprototype.dishmaster.src.dishmaster.dish_master_behaviour.AzEl(azim, elev)
azim

Alias for field number 0

elev

Alias for field number 1

class tmcprototype.dishmaster.src.dishmaster.dish_master_behaviour.OverrideDish
AZIM_DRIVE_MAX_RATE = 3.0
AZIM_IDX = 1
ELEV_DRIVE_MAX_RATE = 1.0
ELEV_IDX = 2
FAILED = 2
MAINT_AZIM = 90.0
MAX_DESIRED_AZIM = 270.0
MAX_DESIRED_ELEV = 90.0
MAX_SAMPLE_HISTORY = 2400
MIN_DESIRED_AZIM = -270.0
MIN_DESIRED_ELEV = 15.0
OK = 0
TS_IDX = 0
action_configureband1(model, tango_dev=None, data_input=None)

This command triggers the Dish to transition to the CONFIGURE Dish Element Mode, and returns to the caller. To configure the Dish to operate in frequency band 1. On completion of the band configuration, Dish will automatically revert to the previous Dish mode (OPERATE or STANDBY-FP).

Parameters:
  • model – tango_simlib.model.Model
  • data_input – None
Raises:

DevFailed – dishMode is not in any of the allowed modes (STANDBY-FP, OPERATE, STOW).
action_configureband2(model, tango_dev=None, data_input=None)

This command triggers the Dish to transition to the CONFIGURE Dish Element Mode, and returns to the caller. To configure the Dish to operate in frequency band 2. On completion of the band configuration, Dish will automatically revert to the previous Dish mode (OPERATE or STANDBY-FP).

Parameters:
  • model – tango_simlib.model.Model
  • data_input – None
Raises:

DevFailed – dishMode is not in any of the allowed modes (STANDBY-FP, OPERATE, STOW).
action_configureband3(model, tango_dev=None, data_input=None)

This command triggers the Dish to transition to the CONFIGURE Dish Element Mode, and returns to the caller. To configure the Dish to operate in frequency band 3. On completion of the band configuration, Dish will automatically revert to the previous Dish mode (OPERATE or STANDBY-FP).

Parameters:
  • model – tango_simlib.model.Model
  • data_input – None
Raises:

DevFailed – dishMode is not in any of the allowed modes (STANDBY-FP, OPERATE, STOW).
action_configureband4(model, tango_dev=None, data_input=None)

This command triggers the Dish to transition to the CONFIGURE Dish Element Mode, and returns to the caller. To configure the Dish to operate in frequency band 4. On completion of the band configuration, Dish will automatically revert to the previous Dish mode (OPERATE or STANDBY-FP).

Parameters:
  • model – tango_simlib.model.Model
  • data_input – None
Raises:

DevFailed – dishMode is not in any of the allowed modes (STANDBY-FP, OPERATE, STOW).
action_configureband5a(model, tango_dev=None, data_input=None)

This command triggers the Dish to transition to the CONFIGURE Dish Element Mode, and returns to the caller. To configure the Dish to operate in frequency band 5a. On completion of the band configuration, Dish will automatically revert to the previous Dish mode (OPERATE or STANDBY-FP).

Parameters:
  • model – tango_simlib.model.Model
  • data_input – None
Raises:

DevFailed – dishMode is not in any of the allowed modes (STANDBY-FP, OPERATE, STOW).
action_configureband5b(model, tango_dev=None, data_input=None)

This command triggers the Dish to transition to the CONFIGURE Dish Element Mode, and returns to the caller. To configure the Dish to operate in frequency band 5b. On completion of the band configuration, Dish will automatically revert to the previous Dish mode (OPERATE or STANDBY-FP).

Parameters:
  • model – tango_simlib.model.Model
  • data_input – None
Raises:

DevFailed – dishMode is not in any of the allowed modes (STANDBY-FP, OPERATE, STOW).
action_configureband5c(model, tango_dev=None, data_input=None)

This command triggers the Dish to transition to the CONFIGURE Dish Element Mode, and returns to the caller. To configure the Dish to operate in frequency band 5c. On completion of the band configuration, Dish will automatically revert to the previous Dish mode (OPERATE or STANDBY-FP).

Parameters:
  • model – tango_simlib.model.Model
  • data_input – None
Raises:

DevFailed – dishMode is not in any of the allowed modes (STANDBY-FP, OPERATE, STOW).
action_lowpower(model, tango_dev=None, data_input=None)

This command triggers the Dish to transition to the LOW power state. All subsystems go into a low power state to power only the essential equipment. Specifically the Helium compressor will be set to a low power consumption, and the drives will be disabled. When issued a STOW command while in LOW power, the DS controller should be able to turn the drives on, stow the dish and turn the drives off again. The purpose of this mode is to enable the observatory to perform power management (load curtailment), and also to conserve energy for non-operating dishes.

Parameters:
  • model – tango_simlib.model.Model
  • data_input – None
Raises:

DevFailed – dishMode is not in any of the allowed modes (STOW, MAINTENANCE).
action_resettracktable(model, tango_dev=None, data_input=None)

Resets the coordinates in the queue. Clear ACU’s table (should show number of coordinates drops to zero)

Parameters:
  • model – tango_simlib.model.Model
  • data_input – None
action_resettracktablebuffer(model, tango_dev=None, data_input=None)

Resets the Dish LMC’s buffer. (In our case it’s desired_pointings)

Parameters:
  • model – tango_simlib.model.Model
  • data_input – None
action_scan(model, tango_dev=None, data_input=None)

The Dish is tracking the commanded pointing positions within the specified SCAN pointing accuracy.

Parameters:
  • model – tango_simlib.model.Model
  • data_input – None
Raises:

DevFailed – dishMode is not in any of the allowed modes (OPERATE).
action_setmaintenancemode(model, tango_dev=None, data_input=None)

This command triggers the Dish to transition to the MAINTENANCE Dish Element Mode, and returns to the caller. To go into a state that is safe to approach the Dish by a maintainer, and to enable the Engineering interface to allow direct access to low level control and monitoring by engineers and maintainers. This mode will also enable engineers and maintainers to upgrade SW and FW. Dish also enters this mode when an emergency stop button is pressed.

Parameters:
  • model – tango_simlib.model.Model
  • data_input – None
Raises:

DevFailed – dishMode is not in any of the allowed modes (STANDBY-LP, STANDBY-FP).
action_setoperatemode(model, tango_dev=None, data_input=None)

This command triggers the Dish to transition to the OPERATE Dish Element Mode, and returns to the caller. This mode fulfils the main purpose of the Dish, which is to point to designated directions while capturing data and transmitting it to CSP.

Parameters:
  • model – tango_simlib.model.Model
  • data_input – None
Raises:

DevFailed – dishMode is not in any of the allowed modes (STANDBY-FP).
action_setstandbyfpmode(model, tango_dev=None, data_input=None)

This command triggers the Dish to transition to the STANDBY-FP Dish Element Mode, and returns to the caller. To prepare all subsystems for active observation, once a command is received by TM to go to the FULL_POWER mode.

Parameters:
  • model – tango_simlib.model.Model
  • data_input – None
Raises:

DevFailed – dishMode is not in any of the allowed modes (STANDBY-LP, STOW, OPERATE, MAINTENANCE).
action_setstandbylpmode(model, tango_dev=None, data_input=None)

This command triggers the Dish to transition to the STANDBY-LP Dish Element Mode, and returns to the caller. Standby_LP is the default mode when the Dish is configured for low power consumption, and is the mode wherein Dish ends after a start up procedure.

Parameters:
  • model – tango_simlib.model.Model
  • data_input – None
Raises:

DevFailed – dishMode is not in any of the allowed modes (OFF, STARTUP, SHUTDOWN, STANDBY-FP, MAINTENANCE, STOW, CONFIG, OPERATE).
action_setstowmode(model, tango_dev=None, data_input=None)

This command triggers the Dish to transition to the STOW Dish Element Mode, and returns to the caller. To point the dish in a direction that minimises the wind loads on the structure, for survival in strong wind conditions. The Dish is able to observe in the stow position, for the purpose of transient detection.

Parameters:
  • model – tango_simlib.model.Model
  • data_input – None
Raises:

DevFailed – dishMode is not in any of the allowed modes (OFF, STARTUP, SHUTDOWN, STANDBY-LP, STANDBY-FP, MAINTENANCE, CONFIG, OPERATE).
action_slew(model, tango_dev=None, data_input=None)

The Dish moves to the commanded pointing angle at the maximum speed, as defined by the specified slew rate.

Parameters:
  • model – tango_simlib.model.Model
  • data_input – list [0]: Azimuth [1]: Elevation
Raises:

DevFailed – dishMode is not in any of the allowed modes (OPERATE).
action_startcapture(model, tango_dev=None, data_input=None)

Triggers the dish to start capturing the data on the configured band.

Parameters:
  • model – tango_simlib.model.Model
  • data_input – None
Raises:

DevFailed – dishMode is not in any of the allowed modes (OPERATE) or configuredBand is (NONE, UNKNOWN, ERROR, UNDEFINED).
action_stopcapture(model, tango_dev=None, data_input=None)

Triggers the dish to stop capturing the data on the configured band.

Parameters:
  • model – tango_simlib.model.Model
  • data_input – None
action_track(model, tango_dev=None, data_input=None)

The Dish is tracking the commanded pointing positions within the specified TRACK pointing accuracy.

Parameters:
  • model – tango_simlib.model.Model
  • data_input – None
Raises:

DevFailed – dishMode is not in any of the allowed modes (OPERATE).
action_trackstop(model, tango_dev=None, data_input=None)

The Dish will stop tracking but will not apply brakes. Stops movement, but doesn’t clear tables/queues.

Parameters:
  • model – tango_simlib.model.Model
  • data_input – None
Raises:

DevFailed – dishMode is not in any of the allowed modes (OPERATE).
actual_position = AzEl(azim=0.0, elev=30.0)
desired_pointings = []
ensure_within_mechanical_limits(next_pos)
find_next_position(desired_pointings, sim_time)

Return the latest desiredPointing not in the future, or last requested.

get_new_unverified_pointings(model)

Return the latest list of coordinates

Parameters:model – Model The device Model
Returns:list - Empty if no updates have occured since the last time - 1 entry of desiredPointing if it is the latest - All the entries of programTrackTable if it is the latest (7 in testing)
get_new_valid_pointings(model)
get_rate_limited_position(current_pos, next_pos, dt)
static is_movement_allowed(model)
is_on_target()
last_coordinate_update_timestamp = 0.0
move_towards_target(sim_time, dt)
pre_update(model, sim_time, dt)
requested_position = AzEl(azim=0.0, elev=30.0)
set_achieved_pointing_attribute(model, sim_time, position)
static set_lock_attribute(model, target_reached)
update_desired_pointing_history(model)
update_movement_attributes(model, sim_time)
tmcprototype.dishmaster.src.dishmaster.dish_master_behaviour.get_direction_sign(here, there)

Return sign (+1 or -1) required to move from here to there.

tmcprototype.dishmaster.src.dishmaster.dish_master_behaviour.get_enum_str(quantity)

Returns the enum label of an enumerated data type

Parameters:quantity – object The quantity object of a DevEnum attribute
Returns:str Current string value of a DevEnum attribute
tmcprototype.dishmaster.src.dishmaster.dish_master_behaviour.set_enum(quantity, label, timestamp)

Sets the quantity last_val attribute to index of label

Parameters:
  • quantity – object The quantity object from model
  • label – str The desired label from enum list
  • timestamp – float The time now

CSP Master Leaf Node

class tmcprototype.cspmasterleafnode.src.cspmasterleafnode.csp_master_leaf_node.CspMasterLeafNode(*args, **kwargs)

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

Device Properties

CspMasterFQDN:Property to provide FQDN of CSP Master Device

Attributes

CspHealthState:Forwarded attribute to provide CSP Master Health State
ActivityMessage:
 Attribute to provide activity message
class tmcprototype.cspmasterleafnode.src.cspmasterleafnode.off_command.Off(*args, **kwargs)

A class for CspMasterLeafNode’s Off() command. Off command is inherited from SKABaseDevice.

It Sets the OpState to Off.

do()

Method to invoke Off command on CSP Element.

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.cspmasterleafnode.src.cspmasterleafnode.on_command.On(*args, **kwargs)

A class for CspMasterLeafNode’s On() command. On command is inherited from SKABaseDevice.

It Sets the OpState to On.

do()

Method to invoke On command on CSP Element.

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)
Raises:DevFailed on communication failure with CspMaster or CspMaster is in error state.
class tmcprototype.cspmasterleafnode.src.cspmasterleafnode.standby_command.Standby(*args, **kwargs)

A class for CspMasterLeafNode’s Standby() command. Standby command is inherited from BaseCommand.

It Sets the OpState to Standby.

do(argin)

Method to invoke Standby command on CSP Element.

Parameters:argin – DevStringArray.

If the array length is 0, the command applies to the whole CSP Element. If the array length is > 1 , each array element specifies the FQDN of the CSP SubElement to put in STANDBY mode.

Returns:None
Raises:DevFailed on communication failure with CspMaster or CspMaster is in error state.

SDP Subarray Leaf Node

class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.sdp_subarray_leaf_node.SdpSubarrayLeafNode(*args, **kwargs)

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

Device Properties

SdpSubarrayFQDN:
 FQDN of the SDP Subarray Tango Device Server.

Device Attributes

ReceiveAddresses:
 This attribute is used for testing purposes. In the unit test cases it is used to provide FQDN of receiveAddresses attribute from SDP.
ActivityMessage:
 String providing information about the current activity in SDPLeafNode.
ActiveProcessingBlocks:
 This is a attribute from SDP Subarray which depicts the active Processing Blocks in the SDP Subarray.
SdpSubarrayHealthState:
 Attribute to provide SDP Subarray Health State.
SdpSubarrayObsState:
 Attribute to show ObsState of Tango Device.
class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.abort_command.Abort(*args, **kwargs)

A class for sdpSubarrayLeafNode’s Abort() command.

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

do()

Method to invoke Abort command on SDP Subarray.

Returns:None
Raises:DevFailed if error occurs while invoking command on CSPSubarray.
class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.assign_resources_command.AssignResources(*args, **kwargs)

A class for SdpSubarayLeafNode’s AssignResources() command.

Assigns resources to given SDP subarray. This command is provided as a noop placeholder from SDP subarray. Eventually this will likely take a JSON string specifying the resource request.

do(argin)

Method to invoke AssignResources command on SDP SUbarray.

Parameters:argin – The string in JSON format. The JSON contains following values:
SBI ID and maximum length of the SBI:

Mandatory JSON object consisting of

SBI ID :
String
max_length:
Float
Scan types:

Consist of Scan type id name

scan_type:
DevVarStringArray
Processing blocks:

Mandatory JSON object consisting of

processing_blocks:
DevVarStringArray
Example:
{“id”:”sbi-mvp01-20200325-00001”,”max_length”:100.0,”scan_types”:[{“id”:”science_A”, “coordinate_system”:”ICRS”,”ra”:”02:42:40.771”,”dec”:”-00:00:47.84”,”channels”:[{“count” :744,”start”:0,”stride”:2,”freq_min”:0.35e9,”freq_max”:0.368e9,”link_map”:[[0,0],[200,1], [744,2],[944,3]]},{“count”:744,”start”:2000,”stride”:1,”freq_min”:0.36e9,”freq_max”:0.368e9, “link_map”:[[2000,4],[2200,5]]}]},{“id”:”calibration_B”,”coordinate_system”:”ICRS”,”ra”: “12:29:06.699”,”dec”:”02:03:08.598”,”channels”:[{“count”:744,”start”:0,”stride”:2, “freq_min”:0.35e9,”freq_max”:0.368e9,”link_map”:[[0,0],[200,1],[744,2],[944,3]]},{“count”:744, “start”:2000,”stride”:1,”freq_min”:0.36e9,”freq_max”:0.368e9,”link_map”:[[2000,4],[2200,5]]}]}] ,”processing_blocks”:[{“id”:”pb-mvp01-20200325-00001”,”workflow”:{“type”:”realtime”,”id”: “vis_receive”,”version”:”0.1.0”},”parameters”:{}},{“id”:”pb-mvp01-20200325-00002”,”workflow”: {“type”:”realtime”,”id”:”test_realtime”,”version”:”0.1.0”},”parameters”:{}},{“id”: “pb-mvp01-20200325-00003”,”workflow”:{“type”:”batch”,”id”:”ical”,”version”:”0.1.0”},”parameters” :{},”dependencies”:[{“pb_id”:”pb-mvp01-20200325-00001”,”type”:[“visibilities”]}]},{“id”: “pb-mvp01-20200325-00004”,”workflow”:{“type”:”batch”,”id”:”dpreb”,”version”:”0.1.0”},”parameters” :{},”dependencies”:[{“pb_id”:”pb-mvp01-20200325-00003”,”type”:[“calibration”]}]}]}

Note: Enter input without spaces

Returns:

None
Raises:

ValueError if input argument json string contains invalid value.

DevFailed if the command execution is not successful.
class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.configure_command.Configure(*args, **kwargs)

A class for SdpSubarrayLeafNode’s Configure() command.

Configures the SDP Subarray device by providing the SDP PB configuration needed to execute the receive workflow

do(argin)

Method to invoke Configure command on SDP Subarray.

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

Example:

{ “scan_type”: “science_A” }

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.sdpsubarrayleafnode.src.sdpsubarrayleafnode.end_command.End(*args, **kwargs)

A class for SdpSubarrayLeafNode’s End command.

This command invokes End command on SDP subarray to end the current Scheduling block.

do()

Method to invoke End command on SDP Subarray.

Returns:None
Raises:DevFailed if the command execution is not successful.
class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.endscan_command.EndScan(*args, **kwargs)

A class for SdpSubarrayLeafNode’s EndScan() command.

It invokes EndScan command on SdpSubarray. This command is allowed when SdpSubarray is in SCANNING state.

do()

Method to invoke EndScan command on SDP Subarray.

Parameters:argin – None
Returns:None
Raises:DevFailed if the command execution is not successful.
class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.obsreset_command.ObsReset(*args, **kwargs)

A class for SdpSubarrayLeafNode’s ObsResetCommand() command.

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

do()

Method to invoke ObsReset command on SDP Subarray.

Parameters:argin – None
Returns:None
Raises:DevFailed if error occurs while invoking command on SDPSubarray.
class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.off_command.Off(*args, **kwargs)

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

Invokes Off command on the SDP Subarray.

do()

Method to invoke Off command on SDP 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)
Raises:DevFailed if error occurs while invoking command on SDPSubarray.
class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.on_command.On(*args, **kwargs)

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

Invokes On command on the SDP Subarray.

do()

Method to invoke On command on SDP 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)
Raises:DevFailed if error occurs while invoking command on SDPSubarray.
class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.release_resources_command.ReleaseAllResources(*args, **kwargs)

A class for SdpSubarayLeafNode’s ReleaseAllResources() command.

Releases all the resources of given SDPSubarrayLeafNode. It accepts the subarray id, releaseALL flag and receptorIDList in JSON string format.

do()

Method to invoke ReleaseResources command on SDP Subarray.

Parameters:argin – None.
Returns:None
Raises:DevFailed if the command execution is not successful.
class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.restart_command.Restart(*args, **kwargs)

A class for sdpSubarrayLeafNode’s Restart() command.

Command to restart the SDP subarray and bring it to its ON state.

do()

Method to invoke Restart command on SDP Subarray.

Returns:None
Raises:DevFailed if error occurs while invoking command on SDPSubarray.
class tmcprototype.sdpsubarrayleafnode.src.sdpsubarrayleafnode.scan_command.Scan(*args, **kwargs)

A class for SdpSubarrayLeafNode’s Scan() command.

Invoke Scan command to SDP subarray.

do(argin)

Method to invoke Scan command on SDP Subarray.

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

Example: {“id”:1}

Note: Enter input as without spaces:{“id”:1}

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

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.

SDP Master Leaf Node

class tmcprototype.sdpmasterleafnode.src.sdpmasterleafnode.sdp_master_leaf_node.SdpMasterLeafNode(*args, **kwargs)

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

Device Properties

SdpMasterFQDN:Property to provide FQDN of SDP Master Device

Device Attributes

VersionInfo:Provides Version information of TANGO device.
ActivityMessage:
 String providing information about the current activity in SDPLeafNode.
ProcessingBlockList:
 List of Processing Block devices
SdpHealthState:Forwarded attribute to provide SDP Master Health State
class tmcprototype.sdpmasterleafnode.src.sdpmasterleafnode.off_command.Off(*args, **kwargs)

A class for SDP master’s Off() command. Off command is inherited from SKABaseDevice.

It Sets the opState to Off.

do()

Method to invoke Off command on Sdp.

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.sdpmasterleafnode.src.sdpmasterleafnode.disable_command.Disable(*args, **kwargs)

A class for SDP master’s Disable() command. Disable command is inherited from BaseCommand.

Sets the opState to Disable.

do()

Method to invoke Disable command on sdp.

Parameters:argin – None.
Returns:None
class tmcprototype.sdpmasterleafnode.src.sdpmasterleafnode.on_command.On(*args, **kwargs)

A class for SDP master’s On() command. On command is inherited from SKABaseDevice.

Informs the SDP that it can start executing Processing Blocks. Sets the opState to ON.

do()

Method to invoke On command on sdp.

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.sdpmasterleafnode.src.sdpmasterleafnode.standby_command.Standby(*args, **kwargs)

A class for SDP Master’s Standby() command. Standby command is inherited from BaseCommand.

Informs the SDP to stop any executing Processing. To get into the STANDBY state all running PBs will be aborted. In normal operation we expect diable should be triggered without first going into STANDBY.

do()

Method to invoke Standby command on sdp.

Parameters:argin – None.
Returns:None

MCCS Master Leaf Node

class tmcprototype.mccsmasterleafnode.src.mccsmasterleafnode.mccs_master_leaf_node.MccsMasterLeafNode(*args, **kwargs)

Device Properties:

MccsMasterFQDN:Property to provide FQDN of MCCS Master Device

Attributes:

MccsHealthState:
 Forwarded attribute to provide MCCS Master Health State
ActivityMessage:
 String providing information about the current activity in MccsMasterLeafNode.
class tmcprototype.mccsmasterleafnode.src.mccsmasterleafnode.assign_resources_command.AssignResources(*args, **kwargs)

A class for MccsMasterLeafNode’s AssignResources() command.

It accepts stationiDList list, channels and stationBeamiDList in JSON string format and invokes allocate command on MccsMaster with JSON string as an input argument.
do(argin)

Method to invoke AssignResources command on Subarray.

Parameters:argin – StringType. The string in JSON format.
Example:
{
“subarray_id”: 1, “station_ids”:[1,2], “channels”: [[[0,8,1,1],[8,8,2,1],[24,16,2,1]], “station_beam_ids”: [1]

}

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.mccsmasterleafnode.src.mccsmasterleafnode.off_command.Off(*args, **kwargs)

A class for MccsMasterLeafNode’s Off() command. Off command is inherited from SKABaseDevice.

It Sets the OpState to Off.

do()

Method to invoke Off command on the MCCS.

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.mccsmasterleafnode.src.mccsmasterleafnode.on_command.On(*args, **kwargs)

A class for MccsMasterLeafNode’s On() command. On command is inherited from SKABaseDevice.

It Sets the OpState to On.

do()

Method to invoke On command on the MCCS.

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.mccsmasterleafnode.src.mccsmasterleafnode.release_resources_command.ReleaseResources(*args, **kwargs)

A class for MccsMasterLeafNode’s ReleaseResources() command.

It invokes ReleaseResources command on MccsMaster and releases all the resources assigned to MccsMaster.

do(argin)

Method to invoke ReleaseResources command on Subarray.

Parameters:argin – StringType. The string in JSON format.
Example:
{
“subarray_id”: 1, “release_all”: true

}

Returns:

None.
Raises:

DevFailed if the command execution is not successful

ValueError if invalid json string.

MCCS Subarray Leaf Node

class tmcprototype.mccssubarrayleafnode.src.mccssubarrayleafnode.mccs_subarray_leaf_node.MccsSubarrayLeafNode(*args, **kwargs)

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

Device Properties

MccsSubarrayFQDN:
 FQDN of MCCS Subarray.

Device Attributes

MccsSubarrayHealthState:
 Forwarded attribute to provide MCCS Subarray Health State.
MccsSubarrayObsState:
 Attribute to provide MCCS Subarray Observation State.
ActivityMessage:
 String providing information about the current activity in MCCS Subarray Leaf Node.
class tmcprototype.mccssubarrayleafnode.src.mccssubarrayleafnode.abort_command.Abort(*args, **kwargs)

A class for MccsSubarrayLeafNode’s Abort() command.

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

do()
Method to invoke Abort command on MCCS Subarray.
Parameters:argin – None
Returns:None
Return type:Void
Raises:DevFailed if the command execution is not successful
class tmcprototype.mccssubarrayleafnode.src.mccssubarrayleafnode.configure_command.Configure(*args, **kwargs)

A class for MccsSubarrayLeafNode’s Configure() command.

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

do(argin)

Method to invoke Configure command on MCCS Subarray.

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

Example: {“mccs”:{“stations”:[{“station_id”:1},{“station_id”:2}],”subarray_beams”:[{“subarray_id”:1,”subarray_beam_id”:1, “target”:{“system”:”HORIZON”,”name”:”DriftScan”,”Az”:180.0,”El”:45.0},”update_rate”:0.0,”channels”:[[0,8,1,1], [8,8,2,1],[24,16,2,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

ValueError if input argument json string contains invalid value

KeyError if input argument json string contains invalid key
class tmcprototype.mccssubarrayleafnode.src.mccssubarrayleafnode.end_command.End(*args, **kwargs)

A class for MccsSubarrayLeafNode’s End() command.

This command invokes End command on MCCS Subarray in order to end current scheduling block.

do()

Method to invoke end command on MCCS Subarray.

Returns:None
Return type:Void
Raises:DevFailed if the command execution is not successful.
class tmcprototype.mccssubarrayleafnode.src.mccssubarrayleafnode.end_scan_command.EndScan(*args, **kwargs)

A class for MccsSubarrayLeafNode’s EndScan() command.

This command invokes EndScan command on MccsSubarray. It is allowed only when MccsSubarray is in ObsState SCANNING.

do()

Method to invoke EndScan command on MCCS Subarray.

Raises:

DevFailed if the command execution is not successful.

AssertionError if MccsSubarray is not in SCANNING obsState.
class tmcprototype.mccssubarrayleafnode.src.mccssubarrayleafnode.obsreset_command.ObsReset(*args, **kwargs)

A class for MccsSubarrayLeafNode’s ObsReset() command.

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

do()

Method to invoke ObsReset command on MCCS Subarray.

Parameters:argin – None
Returns:None
Raises:DevFailed if error occurs while invoking the command on MccsSubarray.
class tmcprototype.mccssubarrayleafnode.src.mccssubarrayleafnode.scan_command.Scan(*args, **kwargs)

A class for MccsSubarrayLeafNode’s Scan() command.

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

do(argin)

Method to invoke Scan command on MCCS Subarray.

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

Example: {“id”:1, “scan_time”:0.0}

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

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

Indices and tables