======================================= LowTmcLeafNodeMccsSubarray Tango Device ======================================= MCCS Subarray Leaf node acts as a contact point for MCCS Subarray Node and also monitors and issues commands to the MCCS Subarray. Properties ---------- .. index:: single: AdapterTimeOut; LowTmcLeafNodeMccsSubarray.AdapterTimeOut .. py:attribute:: AdapterTimeOut :module: LowTmcLeafNodeMccsSubarray :data type: DevFloat :default value: 2 .. index:: single: CommandTimeOutDefault; LowTmcLeafNodeMccsSubarray.CommandTimeOutDefault .. py:attribute:: CommandTimeOutDefault :module: LowTmcLeafNodeMccsSubarray :data type: DevFloat :default value: 30 .. index:: single: EventSubscriptionCheckPeriod; LowTmcLeafNodeMccsSubarray.EventSubscriptionCheckPeriod .. py:attribute:: EventSubscriptionCheckPeriod :module: LowTmcLeafNodeMccsSubarray :data type: DevFloat :default value: 1 .. index:: single: GroupDefinitions; LowTmcLeafNodeMccsSubarray.GroupDefinitions .. py:attribute:: GroupDefinitions :module: LowTmcLeafNodeMccsSubarray :data type: DevVarStringArray .. index:: single: LivelinessCheckPeriod; LowTmcLeafNodeMccsSubarray.LivelinessCheckPeriod .. py:attribute:: LivelinessCheckPeriod :module: LowTmcLeafNodeMccsSubarray :data type: DevFloat :default value: 1 .. index:: single: LoggingLevelDefault; LowTmcLeafNodeMccsSubarray.LoggingLevelDefault .. py:attribute:: LoggingLevelDefault :module: LowTmcLeafNodeMccsSubarray :data type: DevUShort :default value: 4 .. index:: single: LoggingTargetsDefault; LowTmcLeafNodeMccsSubarray.LoggingTargetsDefault .. py:attribute:: LoggingTargetsDefault :module: LowTmcLeafNodeMccsSubarray :data type: DevVarStringArray :default value: ['tango::logger'] .. index:: single: MccsMasterFQDN; LowTmcLeafNodeMccsSubarray.MccsMasterFQDN .. py:attribute:: MccsMasterFQDN :module: LowTmcLeafNodeMccsSubarray FQDN of the MCCS Master Tango Device Server. :data type: DevString .. index:: single: MccsMasterLeafNodeFQDN; LowTmcLeafNodeMccsSubarray.MccsMasterLeafNodeFQDN .. py:attribute:: MccsMasterLeafNodeFQDN :module: LowTmcLeafNodeMccsSubarray FQDN of the MCCS Master Leaf Node Tango Device Server. :data type: DevString .. index:: single: MccsSubarrayFQDN; LowTmcLeafNodeMccsSubarray.MccsSubarrayFQDN .. py:attribute:: MccsSubarrayFQDN :module: LowTmcLeafNodeMccsSubarray FQDN of the MCCS Subarray Tango Device Server. :data type: DevString .. index:: single: SkaLevel; LowTmcLeafNodeMccsSubarray.SkaLevel .. py:attribute:: SkaLevel :module: LowTmcLeafNodeMccsSubarray :data type: DevShort :default value: 4 Attributes ---------- .. index:: single: State; LowTmcLeafNodeMccsSubarray.State .. py:attribute:: State :module: LowTmcLeafNodeMccsSubarray The operational state of the device as enumeration. :access: READ :data type: DevState :data format: SCALAR .. index:: single: Status; LowTmcLeafNodeMccsSubarray.Status .. py:attribute:: Status :module: LowTmcLeafNodeMccsSubarray More detailed textual information about the device's status. :access: READ :data type: DevString :data format: SCALAR .. index:: single: adminMode; LowTmcLeafNodeMccsSubarray.adminMode .. py:attribute:: adminMode :module: LowTmcLeafNodeMccsSubarray The Admin Mode of the device. It may interpret the current device condition and condition of all managed devices to set this. Most possibly an aggregate attribute. :access: READ_WRITE :data type: DevEnum :data format: SCALAR .. index:: single: buildState; LowTmcLeafNodeMccsSubarray.buildState .. py:attribute:: buildState :module: LowTmcLeafNodeMccsSubarray Read the Build State of the device. :return: the build state of the device :access: READ :data type: DevString :data format: SCALAR .. index:: single: commandTimeOut; LowTmcLeafNodeMccsSubarray.commandTimeOut .. py:attribute:: commandTimeOut :module: LowTmcLeafNodeMccsSubarray Command execution time limit. :access: READ_WRITE :data type: DevUShort :data format: SCALAR .. index:: single: commandedState; LowTmcLeafNodeMccsSubarray.commandedState .. py:attribute:: commandedState :module: LowTmcLeafNodeMccsSubarray The last commanded Operating State of the device. Initial string is "None". Only other strings it can change to is "OFF", "STANDBY" or "ON", following the Off(), Standby() or On() commands. If the state transition commands are long running commands the commanded state will only update when the long running command starts executing. :access: READ :data type: DevString :data format: SCALAR .. index:: single: controlMode; LowTmcLeafNodeMccsSubarray.controlMode .. py:attribute:: controlMode :module: LowTmcLeafNodeMccsSubarray The control mode of the device are REMOTE, LOCAL Tango Device accepts only from a ‘local’ client and ignores commands and queries received from TM or any other ‘remote’ clients. The Local clients has to release LOCAL control before REMOTE clients can take control again. :access: READ_WRITE :data type: DevEnum :data format: SCALAR .. index:: single: healthInfo; LowTmcLeafNodeMccsSubarray.healthInfo .. py:attribute:: healthInfo :module: LowTmcLeafNodeMccsSubarray JSON string representing the health information. :access: READ :data type: DevString :data format: SCALAR .. index:: single: healthState; LowTmcLeafNodeMccsSubarray.healthState .. py:attribute:: healthState :module: LowTmcLeafNodeMccsSubarray Health state of the monitored MCCS Subarray :access: READ :data type: DevEnum :data format: SCALAR .. index:: single: isAdminModeEnabled; LowTmcLeafNodeMccsSubarray.isAdminModeEnabled .. py:attribute:: isAdminModeEnabled :module: LowTmcLeafNodeMccsSubarray Boolean Flag for admin mode enabled :access: READ :data type: DevBoolean :data format: SCALAR .. index:: single: isSubsystemAvailable; LowTmcLeafNodeMccsSubarray.isSubsystemAvailable .. py:attribute:: isSubsystemAvailable :module: LowTmcLeafNodeMccsSubarray Boolean Flag for sub system available :access: READ :data type: DevBoolean :data format: SCALAR .. index:: single: loggingLevel; LowTmcLeafNodeMccsSubarray.loggingLevel .. py:attribute:: loggingLevel :module: LowTmcLeafNodeMccsSubarray Read the logging level of the device. Initialises to LoggingLevelDefault on startup. See :py:class:`~ska_control_model.LoggingLevel` :return: Logging level of the device. :access: READ_WRITE :data type: DevEnum :data format: SCALAR .. index:: single: loggingTargets; LowTmcLeafNodeMccsSubarray.loggingTargets .. py:attribute:: loggingTargets :module: LowTmcLeafNodeMccsSubarray Read the additional logging targets of the device. Note that this excludes the handlers provided by the ska_ser_logging library defaults - initialises to LoggingTargetsDefault on startup. :return: Logging level of the device. :access: READ_WRITE :data type: DevString :data format: SPECTRUM :max_dim_x: 4 .. index:: single: longRunningCommandIDsInQueue; LowTmcLeafNodeMccsSubarray.longRunningCommandIDsInQueue .. py:attribute:: longRunningCommandIDsInQueue :module: LowTmcLeafNodeMccsSubarray Read the IDs of the long running commands in the queue. Every client that executes a command will receive a command ID as response. Keep track of IDs currently allocated. Entries are removed `self._command_tracker._removal_time` seconds after they have finished. :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 66 .. index:: single: longRunningCommandInProgress; LowTmcLeafNodeMccsSubarray.longRunningCommandInProgress .. py:attribute:: longRunningCommandInProgress :module: LowTmcLeafNodeMccsSubarray Read the name(s) of the currently executing long running command(s). Name(s) of command and possible abort in progress or empty string(s). :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 2 .. index:: single: longRunningCommandProgress; LowTmcLeafNodeMccsSubarray.longRunningCommandProgress .. py:attribute:: longRunningCommandProgress :module: LowTmcLeafNodeMccsSubarray Read the progress of the currently executing long running command(s). ID, progress of the currently executing command(s). Clients can subscribe to on_change event and wait for the ID they are interested in. :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 4 .. index:: single: longRunningCommandResult; LowTmcLeafNodeMccsSubarray.longRunningCommandResult .. py:attribute:: longRunningCommandResult :module: LowTmcLeafNodeMccsSubarray Read the result of the completed long running command. Reports unique_id, json-encoded result. Clients can subscribe to on_change event and wait for the ID they are interested in. :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 2 .. index:: single: longRunningCommandStatus; LowTmcLeafNodeMccsSubarray.longRunningCommandStatus .. py:attribute:: longRunningCommandStatus :module: LowTmcLeafNodeMccsSubarray Read the status of the currently executing long running commands. ID, status pairs of the currently executing commands. Clients can subscribe to on_change event and wait for the ID they are interested in. :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 132 .. index:: single: longRunningCommandsInQueue; LowTmcLeafNodeMccsSubarray.longRunningCommandsInQueue .. py:attribute:: longRunningCommandsInQueue :module: LowTmcLeafNodeMccsSubarray Read the long running commands in the queue. Keep track of which commands are that are currently known about. Entries are removed `self._command_tracker._removal_time` seconds after they have finished. :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 66 .. index:: single: lrcExecuting; LowTmcLeafNodeMccsSubarray.lrcExecuting .. py:attribute:: lrcExecuting :module: LowTmcLeafNodeMccsSubarray Expose a signal as a Tango attribute. :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 2 .. index:: single: lrcFinished; LowTmcLeafNodeMccsSubarray.lrcFinished .. py:attribute:: lrcFinished :module: LowTmcLeafNodeMccsSubarray Expose a signal as a Tango attribute. :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 100 .. index:: single: lrcProtocolVersions; LowTmcLeafNodeMccsSubarray.lrcProtocolVersions .. py:attribute:: lrcProtocolVersions :module: LowTmcLeafNodeMccsSubarray Return supported protocol versions. :return: A tuple containing the lower and upper bounds of supported long running command protocol versions. :access: READ :data type: DevLong64 :data format: SPECTRUM :max_dim_x: 2 .. index:: single: lrcQueue; LowTmcLeafNodeMccsSubarray.lrcQueue .. py:attribute:: lrcQueue :module: LowTmcLeafNodeMccsSubarray Expose a signal as a Tango attribute. :access: READ :data type: DevString :data format: SPECTRUM :max_dim_x: 32 .. index:: single: mccsSubarrayAdminMode; LowTmcLeafNodeMccsSubarray.mccsSubarrayAdminMode .. py:attribute:: mccsSubarrayAdminMode :module: LowTmcLeafNodeMccsSubarray MCCS Controller Admin Mode :access: READ :data type: DevEnum :data format: SCALAR .. index:: single: mccsSubarrayDevName; LowTmcLeafNodeMccsSubarray.mccsSubarrayDevName .. py:attribute:: mccsSubarrayDevName :module: LowTmcLeafNodeMccsSubarray No description :access: READ_WRITE :data type: DevString :data format: SCALAR .. index:: single: obsState; LowTmcLeafNodeMccsSubarray.obsState .. py:attribute:: obsState :module: LowTmcLeafNodeMccsSubarray No description :access: READ :data type: DevEnum :data format: SCALAR .. index:: single: simulationMode; LowTmcLeafNodeMccsSubarray.simulationMode .. py:attribute:: simulationMode :module: LowTmcLeafNodeMccsSubarray When TRUE the device is using a simulator :access: READ_WRITE :data type: DevEnum :data format: SCALAR .. index:: single: testMode; LowTmcLeafNodeMccsSubarray.testMode .. py:attribute:: testMode :module: LowTmcLeafNodeMccsSubarray If TEST the device is using testing logic :access: READ_WRITE :data type: DevEnum :data format: SCALAR .. index:: single: versionId; LowTmcLeafNodeMccsSubarray.versionId .. py:attribute:: versionId :module: LowTmcLeafNodeMccsSubarray Read the Version Id of the device. :return: the version id of the device :access: READ :data type: DevString :data format: SCALAR Commands -------- .. index:: single: Abort; LowTmcLeafNodeMccsSubarray.Abort .. py:method:: Abort() -> DevVarLongStringArray :module: LowTmcLeafNodeMccsSubarray No input parameter (DevVoid) :returns: A tuple containing a list of result codes and a list of unique IDs. .. index:: single: AbortCommands; LowTmcLeafNodeMccsSubarray.AbortCommands .. py:method:: AbortCommands() -> DevVarLongStringArray :module: LowTmcLeafNodeMccsSubarray No input parameter (DevVoid) :returns: returns (None): A tuple containing a return code and a string message indicating status. The message is for information purpose only. .. index:: single: CheckLongRunningCommandStatus; LowTmcLeafNodeMccsSubarray.CheckLongRunningCommandStatus .. py:method:: CheckLongRunningCommandStatus(DevString) -> DevString :module: LowTmcLeafNodeMccsSubarray command id :returns: TaskStatus .. index:: single: Configure; LowTmcLeafNodeMccsSubarray.Configure .. py:method:: Configure(DevString) -> DevVarLongStringArray :module: LowTmcLeafNodeMccsSubarray argin (str): JSON-formatted string containing the subarray ID and resources to be allocated. :returns: returns (Tuple[List[ResultCode], List[str]]): A tuple containing a list of result codes and a list of unique IDs. .. index:: single: DebugDevice; LowTmcLeafNodeMccsSubarray.DebugDevice .. py:method:: DebugDevice() -> DevUShort :module: LowTmcLeafNodeMccsSubarray No input parameter (DevVoid) :returns: The TCP port the debugger is listening on. .. index:: single: End; LowTmcLeafNodeMccsSubarray.End .. py:method:: End() -> DevVarLongStringArray :module: LowTmcLeafNodeMccsSubarray No input parameter (DevVoid) :returns: returns (Tuple[List[ResultCode], List[str]]): A tuple containing a list of result codes and a list of unique IDs. .. index:: single: EndScan; LowTmcLeafNodeMccsSubarray.EndScan .. py:method:: EndScan() -> DevVarLongStringArray :module: LowTmcLeafNodeMccsSubarray No input parameter (DevVoid) :returns: returns (Tuple[List[ResultCode], List[str]]): A tuple containing a list of result codes and a list of unique ids .. index:: single: GetVersionInfo; LowTmcLeafNodeMccsSubarray.GetVersionInfo .. py:method:: GetVersionInfo() -> DevVarStringArray :module: LowTmcLeafNodeMccsSubarray No input parameter (DevVoid) :returns: returns (None): The result code and the command unique ID .. index:: single: Init; LowTmcLeafNodeMccsSubarray.Init .. py:method:: Init() -> DevVoid :module: LowTmcLeafNodeMccsSubarray Init .. index:: single: Off; LowTmcLeafNodeMccsSubarray.Off .. py:method:: Off() -> DevVarLongStringArray :module: LowTmcLeafNodeMccsSubarray No input parameter (DevVoid) :returns: [ResultCode][message or command id] .. index:: single: On; LowTmcLeafNodeMccsSubarray.On .. py:method:: On() -> DevVarLongStringArray :module: LowTmcLeafNodeMccsSubarray No input parameter (DevVoid) :returns: [ResultCode][message or command id] .. index:: single: Reset; LowTmcLeafNodeMccsSubarray.Reset .. py:method:: Reset() -> DevVarLongStringArray :module: LowTmcLeafNodeMccsSubarray No input parameter (DevVoid) :returns: [ResultCode][message or command id] .. index:: single: Restart; LowTmcLeafNodeMccsSubarray.Restart .. py:method:: Restart() -> DevVarLongStringArray :module: LowTmcLeafNodeMccsSubarray No input parameter (DevVoid) :returns: returns (Tuple[List[ResultCode], List[str]]): A tuple containing a list of result codes and a list of unique IDs. .. index:: single: Scan; LowTmcLeafNodeMccsSubarray.Scan .. py:method:: Scan(DevString) -> DevVarLongStringArray :module: LowTmcLeafNodeMccsSubarray argin (str): JSON-formatted string containing scan configuration. :returns: returns (Tuple[List[ResultCode], List[str]]): A tuple containing a list of result codes and a list of unique IDs. .. index:: single: SetAdminMode; LowTmcLeafNodeMccsSubarray.SetAdminMode .. py:method:: SetAdminMode(DevEnum) -> DevVarLongStringArray :module: LowTmcLeafNodeMccsSubarray The input string in JSON format. :returns: (ReturnType, 'informational message') .. index:: single: Standby; LowTmcLeafNodeMccsSubarray.Standby .. py:method:: Standby() -> DevVarLongStringArray :module: LowTmcLeafNodeMccsSubarray No input parameter (DevVoid) :returns: [ResultCode][message or command id]