=====================================
MidTmcLeafNodeCspControl Tango Device
=====================================

    Tango device class for TMC CSP Controller leaf node MID.
    

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

.. py:attribute:: AdapterTimeOut
	:module: MidTmcLeafNodeCspControl

	:data type: DevFloat
	:default value: 2

.. index::
	single: CommandTimeOutDefault; MidTmcLeafNodeCspControl.CommandTimeOutDefault

.. py:attribute:: CommandTimeOutDefault
	:module: MidTmcLeafNodeCspControl

	:data type: DevFloat
	:default value: 30

.. index::
	single: CspMasterFQDN; MidTmcLeafNodeCspControl.CspMasterFQDN

.. py:attribute:: CspMasterFQDN
	:module: MidTmcLeafNodeCspControl

	FQDN of the CSP Master Tango Device Server.

	:data type: DevString

.. index::
	single: EventSubscriptionCheckPeriod; MidTmcLeafNodeCspControl.EventSubscriptionCheckPeriod

.. py:attribute:: EventSubscriptionCheckPeriod
	:module: MidTmcLeafNodeCspControl

	:data type: DevFloat
	:default value: 1

.. index::
	single: GroupDefinitions; MidTmcLeafNodeCspControl.GroupDefinitions

.. py:attribute:: GroupDefinitions
	:module: MidTmcLeafNodeCspControl

	:data type: DevVarStringArray

.. index::
	single: LivelinessCheckPeriod; MidTmcLeafNodeCspControl.LivelinessCheckPeriod

.. py:attribute:: LivelinessCheckPeriod
	:module: MidTmcLeafNodeCspControl

	:data type: DevFloat
	:default value: 1

.. index::
	single: LoggingLevelDefault; MidTmcLeafNodeCspControl.LoggingLevelDefault

.. py:attribute:: LoggingLevelDefault
	:module: MidTmcLeafNodeCspControl

	:data type: DevUShort
	:default value: 4

.. index::
	single: LoggingTargetsDefault; MidTmcLeafNodeCspControl.LoggingTargetsDefault

.. py:attribute:: LoggingTargetsDefault
	:module: MidTmcLeafNodeCspControl

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

.. index::
	single: SkaLevel; MidTmcLeafNodeCspControl.SkaLevel

.. py:attribute:: SkaLevel
	:module: MidTmcLeafNodeCspControl

	:data type: DevShort
	:default value: 4

Attributes
----------
.. index::
	single: DishVccMapValidationResult; MidTmcLeafNodeCspControl.DishVccMapValidationResult

.. py:attribute:: DishVccMapValidationResult
	:module: MidTmcLeafNodeCspControl

	Dish Vcc Validation Result status

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

.. index::
	single: State; MidTmcLeafNodeCspControl.State

.. py:attribute:: State
	:module: MidTmcLeafNodeCspControl

	The operational state of the device as enumeration.

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

.. index::
	single: Status; MidTmcLeafNodeCspControl.Status

.. py:attribute:: Status
	:module: MidTmcLeafNodeCspControl

	More detailed textual information about the device's status.

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

.. index::
	single: adminMode; MidTmcLeafNodeCspControl.adminMode

.. py:attribute:: adminMode
	:module: MidTmcLeafNodeCspControl

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

.. py:attribute:: buildState
	:module: MidTmcLeafNodeCspControl

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

.. py:attribute:: commandTimeOut
	:module: MidTmcLeafNodeCspControl

	Command execution time limit.

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

.. index::
	single: commandedState; MidTmcLeafNodeCspControl.commandedState

.. py:attribute:: commandedState
	:module: MidTmcLeafNodeCspControl

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

.. py:attribute:: controlMode
	:module: MidTmcLeafNodeCspControl

	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: cspControllerAdminMode; MidTmcLeafNodeCspControl.cspControllerAdminMode

.. py:attribute:: cspControllerAdminMode
	:module: MidTmcLeafNodeCspControl

	Csp Controller Admin Mode

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

.. index::
	single: cspMasterDevName; MidTmcLeafNodeCspControl.cspMasterDevName

.. py:attribute:: cspMasterDevName
	:module: MidTmcLeafNodeCspControl

	Returns the cspmasterdevname attribute.

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

.. index::
	single: dishVccConfig; MidTmcLeafNodeCspControl.dishVccConfig

.. py:attribute:: dishVccConfig
	:module: MidTmcLeafNodeCspControl

	No description

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

.. index::
	single: healthInfo; MidTmcLeafNodeCspControl.healthInfo

.. py:attribute:: healthInfo
	:module: MidTmcLeafNodeCspControl

	JSON string representing the health information.

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

.. index::
	single: healthState; MidTmcLeafNodeCspControl.healthState

.. py:attribute:: healthState
	:module: MidTmcLeafNodeCspControl

	Health state of the monitored CSP Controller device.

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

.. index::
	single: isAdminModeEnabled; MidTmcLeafNodeCspControl.isAdminModeEnabled

.. py:attribute:: isAdminModeEnabled
	:module: MidTmcLeafNodeCspControl

	No description

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

.. index::
	single: isSubsystemAvailable; MidTmcLeafNodeCspControl.isSubsystemAvailable

.. py:attribute:: isSubsystemAvailable
	:module: MidTmcLeafNodeCspControl

	Boolean Flag for sub system available

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

.. index::
	single: loggingLevel; MidTmcLeafNodeCspControl.loggingLevel

.. py:attribute:: loggingLevel
	:module: MidTmcLeafNodeCspControl

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

.. py:attribute:: loggingTargets
	:module: MidTmcLeafNodeCspControl

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

.. py:attribute:: longRunningCommandIDsInQueue
	:module: MidTmcLeafNodeCspControl

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

.. py:attribute:: longRunningCommandInProgress
	:module: MidTmcLeafNodeCspControl

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

.. py:attribute:: longRunningCommandProgress
	:module: MidTmcLeafNodeCspControl

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

.. py:attribute:: longRunningCommandResult
	:module: MidTmcLeafNodeCspControl

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

.. py:attribute:: longRunningCommandStatus
	:module: MidTmcLeafNodeCspControl

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

.. py:attribute:: longRunningCommandsInQueue
	:module: MidTmcLeafNodeCspControl

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

.. py:attribute:: lrcExecuting
	:module: MidTmcLeafNodeCspControl

	Expose a signal as a Tango attribute.

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

.. index::
	single: lrcFinished; MidTmcLeafNodeCspControl.lrcFinished

.. py:attribute:: lrcFinished
	:module: MidTmcLeafNodeCspControl

	Expose a signal as a Tango attribute.

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

.. index::
	single: lrcProtocolVersions; MidTmcLeafNodeCspControl.lrcProtocolVersions

.. py:attribute:: lrcProtocolVersions
	:module: MidTmcLeafNodeCspControl

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

.. py:attribute:: lrcQueue
	:module: MidTmcLeafNodeCspControl

	Expose a signal as a Tango attribute.

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

.. index::
	single: memorizedDishVccMap; MidTmcLeafNodeCspControl.memorizedDishVccMap

.. py:attribute:: memorizedDishVccMap
	:module: MidTmcLeafNodeCspControl

	This attribute stores the latest dish VCC map version data

	in the Tango DB. The attribute is memorized so that when the device
	restarts, the last set dish VCC map version will be used for loading
	dish VCC config on the CSP master.

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

.. index::
	single: simulationMode; MidTmcLeafNodeCspControl.simulationMode

.. py:attribute:: simulationMode
	:module: MidTmcLeafNodeCspControl

	When TRUE the device is using a simulator

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

.. index::
	single: sourceDishVccConfig; MidTmcLeafNodeCspControl.sourceDishVccConfig

.. py:attribute:: sourceDishVccConfig
	:module: MidTmcLeafNodeCspControl

	source Dish Vcc Config data

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

.. index::
	single: testMode; MidTmcLeafNodeCspControl.testMode

.. py:attribute:: testMode
	:module: MidTmcLeafNodeCspControl

	If TEST the device is using testing logic

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

.. index::
	single: versionId; MidTmcLeafNodeCspControl.versionId

.. py:attribute:: versionId
	:module: MidTmcLeafNodeCspControl

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

.. py:method:: Abort() -> DevVarLongStringArray
	:module: MidTmcLeafNodeCspControl

	No input parameter (DevVoid)

	:returns: [ResultCode.STARTED][command_id]

.. index::
	single: AbortCommands; MidTmcLeafNodeCspControl.AbortCommands

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

	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; MidTmcLeafNodeCspControl.CheckLongRunningCommandStatus

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

	command id

	:returns: TaskStatus

.. index::
	single: DebugDevice; MidTmcLeafNodeCspControl.DebugDevice

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

	No input parameter (DevVoid)

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

.. index::
	single: GetVersionInfo; MidTmcLeafNodeCspControl.GetVersionInfo

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

	No input parameter (DevVoid)

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

.. index::
	single: Init; MidTmcLeafNodeCspControl.Init

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

	Init

.. index::
	single: LoadDishCfg; MidTmcLeafNodeCspControl.LoadDishCfg

.. py:method:: LoadDishCfg(DevString) -> DevVarLongStringArray
	:module: MidTmcLeafNodeCspControl

	argin (None): JSON formatted string with data source, path,

	and interface.

	:returns: returns (None): A tuple containing a list of ResultCodes and a list of
		informational messages.

.. index::
	single: Off; MidTmcLeafNodeCspControl.Off

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

	No input parameter (DevVoid)

	:returns: :return: (not documented)
		:rtype: DevVarLongStringArray

.. index::
	single: On; MidTmcLeafNodeCspControl.On

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

	No input parameter (DevVoid)

	:returns: :return: (not documented)
		:rtype: DevVarLongStringArray

.. index::
	single: Reset; MidTmcLeafNodeCspControl.Reset

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

	No input parameter (DevVoid)

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

.. index::
	single: SetAdminMode; MidTmcLeafNodeCspControl.SetAdminMode

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

	The input string in JSON format.

	:returns: (ReturnType, 'informational message')

.. index::
	single: Standby; MidTmcLeafNodeCspControl.Standby

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

	No input parameter (DevVoid)

	:returns: :return: (not documented)
		:rtype: DevVarLongStringArray