ska_tmc_mccsmasterleafnode package

Subpackages

Submodules

ska_tmc_mccsmasterleafnode._mccs_master_leaf_node module

This module uses the SKA Control Model for health state definitions and SKA Tango Base for the base device class.

class ska_tmc_mccsmasterleafnode.mccs_master_leaf_node.MccsMasterLeafNode(*args: Any, **kwargs: Any)

Bases: SKABaseDevice

MccsMasterLeafNode class acts as a MCCS contact point for Master Node and also to monitor and issue commands to the MCCS Master.

AssignResources(argin: str) → tuple

This command invokes the AssignResources() command on MCCS Controller.

Parameters:

argin – JSON-formatted string containing an integer subarray ID, and resources to be allocated to that subarray

Returns:

A tuple containing a return code, a string message indicating status and message UID. The string message is for information purposes only, but the message UID is for message management use.

Example:

>>> proxy = tango.DeviceProxy("ska_low/tm_leaf_node/mccs_master")
>>> proxy.AssignResources(
        json.dumps(
        {
            "interface": "https://schema.skao.int/
            ska-low-mccs-controller-allocate/3.0",
            "subarray_id": 1,
                "subarray_beams": [
                {
                    "subarray_beam_id": 1,
                    "apertures": [
                    {
                        "station_id": 1,
                        "aperture_id": "AP001.01"
                    },
                    {
                        "station_id": 1,
                        "aperture_id": "AP001.02"
                    },
                    {
                        "station_id": 2,
                        "aperture_id": "AP002.01"
                    },
                    {
                        "station_id": 2,
                        "aperture_id": "AP002.02"
                    },
                    {
                        "station_id": 3,
                        "aperture_id": "AP003.01"
                    }
                    ],
                    "number_of_channels": 32
                }
            ]
            }
        )

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

Bases: InitCommand

A class for MCCSMasterLeafNode’s init_device() method.

do()

Initializes the attributes and properties of the MccsMasterLeafNode.

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

rtype:: (ResultCode, str)

Off() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: This command invokes Off() command on MCCS Controller.

On() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: This command invokes On() command on MCCS Controller.

ReleaseAllResources(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Remove all resources to tear down to an empty subarray.

Parameters:

argin – JSON-formatted string containing an integer subarray ID to release resources of that subarray that subarray

Returns:

A tuple containing a return code, a string message indicating status and message UID. The string message is for information purposes only, but the message UID is for message management use.

Example:

>>> proxy = tango.DeviceProxy
("ska_low/tm_leaf_node/mccs_master")
>>> proxy.AssignResources(
        json.dumps(
        {
        {
  "interface": hello jayant mi konta bug gheu
"https://schema.skatelescope.org/
ska-low-mccs-controller-release/2.0",
  "subarray_id": 1,
  "release_all": true
  }
}

Standby() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: This command invokes Standby() command on MCCS Controller.

always_executed_hook()

create_component_manager(): Returns Mccs Master Leaf Node component manager object

delete_device()

init_command_objects(): Initialises the command handlers for commands supported by this device.

is_AssignResources_allowed() → bool

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

Returns:: True if AssignResources command is allowed to be run in

current device state.

Return type:: boolean

is_Off_allowed(): Checks whether this command is allowed to be run in current device state. :return: True if this command is allowed to be run in current device state. :rtype: boolean

is_On_allowed(): Checks whether this command is allowed to be run in current device state. :return: True if this command is allowed to be run in current device state. :rtype: boolean

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_Standby_allowed(): Checks whether this command is allowed to be run in current device state. :return: True if this command is allowed to be run in current device state. :rtype: boolean

read_isSubsystemAvailable(): Returns the MccsMasterLeafNode isSubsystemAvailable attribute.

read_mccsMasterDevName(): Returns the mccsmasterdevname attribute.

update_availablity_callback(availablity): Change event callback for isSubsystemAvailable

write_mccsMasterDevName(value): Sets the mccsmasterdevname attribute.

ska_tmc_mccsmasterleafnode.mccs_master_leaf_node.main(args=None, **kwargs)

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

Parameters:: kwargs – Arguments internal to TANGO
Returns:: MccsMasterLeafNode TANGO object.

Module contents

MccsMasterLeafNode