===============================
LowTmcLeafNodeMccs Tango Device
===============================

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

Properties
----------
.. index::
	single: AdapterTimeOut; LowTmcLeafNodeMccs.AdapterTimeOut

.. py:attribute:: AdapterTimeOut
	:module: LowTmcLeafNodeMccs

	:data type: DevFloat
	:default value: 2

.. index::
	single: CommandTimeOutDefault; LowTmcLeafNodeMccs.CommandTimeOutDefault

.. py:attribute:: CommandTimeOutDefault
	:module: LowTmcLeafNodeMccs

	:data type: DevFloat
	:default value: 30

.. index::
	single: EventSubscriptionCheckPeriod; LowTmcLeafNodeMccs.EventSubscriptionCheckPeriod

.. py:attribute:: EventSubscriptionCheckPeriod
	:module: LowTmcLeafNodeMccs

	:data type: DevFloat
	:default value: 1

.. index::
	single: GroupDefinitions; LowTmcLeafNodeMccs.GroupDefinitions

.. py:attribute:: GroupDefinitions
	:module: LowTmcLeafNodeMccs

	:data type: DevVarStringArray

.. index::
	single: LivelinessCheckPeriod; LowTmcLeafNodeMccs.LivelinessCheckPeriod

.. py:attribute:: LivelinessCheckPeriod
	:module: LowTmcLeafNodeMccs

	:data type: DevFloat
	:default value: 1

.. index::
	single: LoggingLevelDefault; LowTmcLeafNodeMccs.LoggingLevelDefault

.. py:attribute:: LoggingLevelDefault
	:module: LowTmcLeafNodeMccs

	:data type: DevUShort
	:default value: 4

.. index::
	single: LoggingTargetsDefault; LowTmcLeafNodeMccs.LoggingTargetsDefault

.. py:attribute:: LoggingTargetsDefault
	:module: LowTmcLeafNodeMccs

	:data type: DevVarStringArray
	:default value: ['tango::logger']

.. index::
	single: MccsMasterFQDN; LowTmcLeafNodeMccs.MccsMasterFQDN

.. py:attribute:: MccsMasterFQDN
	:module: LowTmcLeafNodeMccs

	FQDN of the MCCS Master Tango Device Server.

	:data type: DevString

.. index::
	single: SkaLevel; LowTmcLeafNodeMccs.SkaLevel

.. py:attribute:: SkaLevel
	:module: LowTmcLeafNodeMccs

	:data type: DevShort
	:default value: 4

Attributes
----------
.. index::
	single: State; LowTmcLeafNodeMccs.State

.. py:attribute:: State
	:module: LowTmcLeafNodeMccs

	The operational state of the device as enumeration.

	:access: READ
	:data type: DevState
	:data format: SCALAR

.. index::
	single: Status; LowTmcLeafNodeMccs.Status

.. py:attribute:: Status
	:module: LowTmcLeafNodeMccs

	More detailed textual information about the device's status.

	:access: READ
	:data type: DevString
	:data format: SCALAR

.. index::
	single: adminMode; LowTmcLeafNodeMccs.adminMode

.. py:attribute:: adminMode
	:module: LowTmcLeafNodeMccs

	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; LowTmcLeafNodeMccs.buildState

.. py:attribute:: buildState
	:module: LowTmcLeafNodeMccs

	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; LowTmcLeafNodeMccs.commandTimeOut

.. py:attribute:: commandTimeOut
	:module: LowTmcLeafNodeMccs

	Command execution time limit.

	:access: READ_WRITE
	:data type: DevUShort
	:data format: SCALAR

.. index::
	single: commandedState; LowTmcLeafNodeMccs.commandedState

.. py:attribute:: commandedState
	:module: LowTmcLeafNodeMccs

	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; LowTmcLeafNodeMccs.controlMode

.. py:attribute:: controlMode
	:module: LowTmcLeafNodeMccs

	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; LowTmcLeafNodeMccs.healthInfo

.. py:attribute:: healthInfo
	:module: LowTmcLeafNodeMccs

	JSON string representing the health information.

	:access: READ
	:data type: DevString
	:data format: SCALAR

.. index::
	single: healthState; LowTmcLeafNodeMccs.healthState

.. py:attribute:: healthState
	:module: LowTmcLeafNodeMccs

	Health state of the MCCS Master leaf node

	:access: READ
	:data type: DevEnum
	:data format: SCALAR

.. index::
	single: isAdminModeEnabled; LowTmcLeafNodeMccs.isAdminModeEnabled

.. py:attribute:: isAdminModeEnabled
	:module: LowTmcLeafNodeMccs

	No description

	:access: READ_WRITE
	:data type: DevBoolean
	:data format: SCALAR

.. index::
	single: isSubsystemAvailable; LowTmcLeafNodeMccs.isSubsystemAvailable

.. py:attribute:: isSubsystemAvailable
	:module: LowTmcLeafNodeMccs

	Boolean Flag for sub system available

	:access: READ
	:data type: DevBoolean
	:data format: SCALAR

.. index::
	single: loggingLevel; LowTmcLeafNodeMccs.loggingLevel

.. py:attribute:: loggingLevel
	:module: LowTmcLeafNodeMccs

	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; LowTmcLeafNodeMccs.loggingTargets

.. py:attribute:: loggingTargets
	:module: LowTmcLeafNodeMccs

	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; LowTmcLeafNodeMccs.longRunningCommandIDsInQueue

.. py:attribute:: longRunningCommandIDsInQueue
	:module: LowTmcLeafNodeMccs

	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; LowTmcLeafNodeMccs.longRunningCommandInProgress

.. py:attribute:: longRunningCommandInProgress
	:module: LowTmcLeafNodeMccs

	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; LowTmcLeafNodeMccs.longRunningCommandProgress

.. py:attribute:: longRunningCommandProgress
	:module: LowTmcLeafNodeMccs

	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; LowTmcLeafNodeMccs.longRunningCommandResult

.. py:attribute:: longRunningCommandResult
	:module: LowTmcLeafNodeMccs

	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; LowTmcLeafNodeMccs.longRunningCommandStatus

.. py:attribute:: longRunningCommandStatus
	:module: LowTmcLeafNodeMccs

	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; LowTmcLeafNodeMccs.longRunningCommandsInQueue

.. py:attribute:: longRunningCommandsInQueue
	:module: LowTmcLeafNodeMccs

	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; LowTmcLeafNodeMccs.lrcExecuting

.. py:attribute:: lrcExecuting
	:module: LowTmcLeafNodeMccs

	Expose a signal as a Tango attribute.

	:access: READ
	:data type: DevString
	:data format: SPECTRUM
	:max_dim_x: 2

.. index::
	single: lrcFinished; LowTmcLeafNodeMccs.lrcFinished

.. py:attribute:: lrcFinished
	:module: LowTmcLeafNodeMccs

	Expose a signal as a Tango attribute.

	:access: READ
	:data type: DevString
	:data format: SPECTRUM
	:max_dim_x: 100

.. index::
	single: lrcProtocolVersions; LowTmcLeafNodeMccs.lrcProtocolVersions

.. py:attribute:: lrcProtocolVersions
	:module: LowTmcLeafNodeMccs

	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; LowTmcLeafNodeMccs.lrcQueue

.. py:attribute:: lrcQueue
	:module: LowTmcLeafNodeMccs

	Expose a signal as a Tango attribute.

	:access: READ
	:data type: DevString
	:data format: SPECTRUM
	:max_dim_x: 32

.. index::
	single: mccsControllerAdminMode; LowTmcLeafNodeMccs.mccsControllerAdminMode

.. py:attribute:: mccsControllerAdminMode
	:module: LowTmcLeafNodeMccs

	MCCS Controller Admin Mode

	:access: READ
	:data type: DevEnum
	:data format: SCALAR

.. index::
	single: mccsMasterDevName; LowTmcLeafNodeMccs.mccsMasterDevName

.. py:attribute:: mccsMasterDevName
	:module: LowTmcLeafNodeMccs

	Name of the MCCS Master device.

	:access: READ_WRITE
	:data type: DevString
	:data format: SCALAR

.. index::
	single: simulationMode; LowTmcLeafNodeMccs.simulationMode

.. py:attribute:: simulationMode
	:module: LowTmcLeafNodeMccs

	When TRUE the device is using a simulator

	:access: READ_WRITE
	:data type: DevEnum
	:data format: SCALAR

.. index::
	single: testMode; LowTmcLeafNodeMccs.testMode

.. py:attribute:: testMode
	:module: LowTmcLeafNodeMccs

	If TEST the device is using testing logic

	:access: READ_WRITE
	:data type: DevEnum
	:data format: SCALAR

.. index::
	single: versionId; LowTmcLeafNodeMccs.versionId

.. py:attribute:: versionId
	:module: LowTmcLeafNodeMccs

	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; LowTmcLeafNodeMccs.Abort

.. py:method:: Abort(DevEnum) -> DevVarLongStringArray
	:module: LowTmcLeafNodeMccs

	The input string in JSON format.

	:returns: (ReturnType, 'informational message')

.. index::
	single: AbortCommands; LowTmcLeafNodeMccs.AbortCommands

.. py:method:: AbortCommands() -> DevVarLongStringArray
	:module: LowTmcLeafNodeMccs

	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: AssignResources; LowTmcLeafNodeMccs.AssignResources

.. py:method:: AssignResources(DevString) -> DevVarLongStringArray
	:module: LowTmcLeafNodeMccs

	argin (str): JSON-formatted string containing an integer

	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: CheckLongRunningCommandStatus; LowTmcLeafNodeMccs.CheckLongRunningCommandStatus

.. py:method:: CheckLongRunningCommandStatus(DevString) -> DevString
	:module: LowTmcLeafNodeMccs

	command id

	:returns: TaskStatus

.. index::
	single: DebugDevice; LowTmcLeafNodeMccs.DebugDevice

.. py:method:: DebugDevice() -> DevUShort
	:module: LowTmcLeafNodeMccs

	No input parameter (DevVoid)

	:returns: The TCP port the debugger is listening on.

.. index::
	single: GetVersionInfo; LowTmcLeafNodeMccs.GetVersionInfo

.. py:method:: GetVersionInfo() -> DevVarStringArray
	:module: LowTmcLeafNodeMccs

	No input parameter (DevVoid)

	:returns: returns (None): The result code and the command unique ID

.. index::
	single: Init; LowTmcLeafNodeMccs.Init

.. py:method:: Init() -> DevVoid
	:module: LowTmcLeafNodeMccs

	Init

.. index::
	single: Off; LowTmcLeafNodeMccs.Off

.. py:method:: Off() -> DevVarLongStringArray
	:module: LowTmcLeafNodeMccs

	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: On; LowTmcLeafNodeMccs.On

.. py:method:: On() -> DevVarLongStringArray
	:module: LowTmcLeafNodeMccs

	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: ReleaseAllResources; LowTmcLeafNodeMccs.ReleaseAllResources

.. py:method:: ReleaseAllResources(DevString) -> DevVarLongStringArray
	:module: LowTmcLeafNodeMccs

	argin (None): JSON-formatted string containing the subarray ID to

	release resources from.

	:returns: returns (Tuple[List[ResultCode], List[str]]): A tuple containing a list of result codes and a list of
		unique IDs.

.. index::
	single: Reset; LowTmcLeafNodeMccs.Reset

.. py:method:: Reset() -> DevVarLongStringArray
	:module: LowTmcLeafNodeMccs

	No input parameter (DevVoid)

	:returns: [ResultCode][message or command id]

.. index::
	single: SetAdminMode; LowTmcLeafNodeMccs.SetAdminMode

.. py:method:: SetAdminMode(DevEnum) -> DevVarLongStringArray
	:module: LowTmcLeafNodeMccs

	The input string in JSON format.

	:returns: (ReturnType, 'informational message')

.. index::
	single: Standby; LowTmcLeafNodeMccs.Standby

.. py:method:: Standby() -> DevVarLongStringArray
	:module: LowTmcLeafNodeMccs

	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.