================================
ControllerInterface Tango Device
================================
Provides the Tango interface for a SKA controller device.

Properties
----------
.. index::
	single: LoggingLevelDefault; ControllerInterface.LoggingLevelDefault

.. py:attribute:: LoggingLevelDefault
	:module: ControllerInterface

	Default logging level at device startup.

	:data type: DevUShort
	:default value: 4

.. index::
	single: LoggingTargetsDefault; ControllerInterface.LoggingTargetsDefault

.. py:attribute:: LoggingTargetsDefault
	:module: ControllerInterface

	Default logging targets at device startup.

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

.. index::
	single: MaxCapabilities; ControllerInterface.MaxCapabilities

.. py:attribute:: MaxCapabilities
	:module: ControllerInterface

	List of maximum number of instances per capability type provided by this element.

	:data type: DevVarStringArray

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

.. py:attribute:: State
	:module: ControllerInterface

	The operational state of the device as enumeration.

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

.. index::
	single: Status; ControllerInterface.Status

.. py:attribute:: Status
	:module: ControllerInterface

	More detailed textual information about the device's status.

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

.. index::
	single: adminMode; ControllerInterface.adminMode

.. py:attribute:: adminMode
	:module: ControllerInterface

	The Admin Mode of the device.

	Set by a client to mark the device for science or only engineering.

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

.. index::
	single: availableCapabilities; ControllerInterface.availableCapabilities

.. py:attribute:: availableCapabilities
	:module: ControllerInterface

	A list of available number of instances of each capability type, e.g. 'CORRELATOR:512', 'PSS-BEAMS:4'.

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

.. index::
	single: buildState; ControllerInterface.buildState

.. py:attribute:: buildState
	:module: ControllerInterface

	Read the Build State of the device.

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

.. index::
	single: healthInfo; ControllerInterface.healthInfo

.. py:attribute:: healthInfo
	:module: ControllerInterface

	Read the Health Info of the device.

	It provides an explanation for the currently reported Health State

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

.. index::
	single: healthState; ControllerInterface.healthState

.. py:attribute:: healthState
	:module: ControllerInterface

	Read the Health State of the device.

	It interprets the current device condition and condition of all managed devices to set this.

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

.. index::
	single: loggingLevel; ControllerInterface.loggingLevel

.. py:attribute:: loggingLevel
	:module: ControllerInterface

	Read the logging level of the device.

	Initialises to LoggingLevelDefault on startup.
	See :py:class:`~ska_control_model.LoggingLevel`

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

.. index::
	single: loggingTargets; ControllerInterface.loggingTargets

.. py:attribute:: loggingTargets
	:module: ControllerInterface

	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.

	:access: READ_WRITE
	:data type: DevString
	:data format: SPECTRUM
	:max_dim_x: 4

.. index::
	single: maxCapabilities; ControllerInterface.maxCapabilities

.. py:attribute:: maxCapabilities
	:module: ControllerInterface

	Maximum number of instances of each capability type, e.g. 'CORRELATOR:512', 'PSS-BEAMS:4'.

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

.. index::
	single: versionId; ControllerInterface.versionId

.. py:attribute:: versionId
	:module: ControllerInterface

	Read the Version Id of the device.

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

Commands
--------
.. index::
	single: GetVersionInfo; ControllerInterface.GetVersionInfo

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

	Get the version information of the device.

	:returns: The device class name and its package information.

.. index::
	single: Init; ControllerInterface.Init

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

	Reinitialise the Tango device.

.. index::
	single: IsCapabilityAchievable; ControllerInterface.IsCapabilityAchievable

.. py:method:: IsCapabilityAchievable(DevVarLongStringArray) -> DevBoolean
	:module: ControllerInterface

	Check if provided capabilities can be achieved by the resource(s).

	:parameter: [No. of instances][Capability types]

	:returns: [ResultCode][Command ID]