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.