=========================
ObsInterface Tango Device
=========================
Provides the Tango interface for a SKA device with an Observation State.

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

.. py:attribute:: LoggingLevelDefault
	:module: ObsInterface

	Default logging level at device startup.

	:data type: DevUShort
	:default value: 4

.. index::
	single: LoggingTargetsDefault; ObsInterface.LoggingTargetsDefault

.. py:attribute:: LoggingTargetsDefault
	:module: ObsInterface

	Default logging targets at device startup.

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

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

.. py:attribute:: State
	:module: ObsInterface

	The operational state of the device as enumeration.

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

.. index::
	single: Status; ObsInterface.Status

.. py:attribute:: Status
	:module: ObsInterface

	More detailed textual information about the device's status.

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

.. index::
	single: adminMode; ObsInterface.adminMode

.. py:attribute:: adminMode
	:module: ObsInterface

	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: buildState; ObsInterface.buildState

.. py:attribute:: buildState
	:module: ObsInterface

	Read the Build State of the device.

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

.. index::
	single: commandedObsState; ObsInterface.commandedObsState

.. py:attribute:: commandedObsState
	:module: ObsInterface

	The last commanded stable Observation State of the device.

	Initial value is EMPTY.  The only stable states it can
	change to are EMPTY, IDLE, READY or ABORTED, following the start
	of any state transition command.

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

.. index::
	single: configurationDelayExpected; ObsInterface.configurationDelayExpected

.. py:attribute:: configurationDelayExpected
	:module: ObsInterface

	The expected configuration delay of the device in seconds.

	:access: READ
	:data type: DevUShort
	:data format: SCALAR
	:unit: seconds

.. index::
	single: configurationProgress; ObsInterface.configurationProgress

.. py:attribute:: configurationProgress
	:module: ObsInterface

	The percentage configuration progress of the device.

	:access: READ
	:data type: DevUShort
	:data format: SCALAR
	:unit: %

.. index::
	single: healthInfo; ObsInterface.healthInfo

.. py:attribute:: healthInfo
	:module: ObsInterface

	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; ObsInterface.healthState

.. py:attribute:: healthState
	:module: ObsInterface

	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; ObsInterface.loggingLevel

.. py:attribute:: loggingLevel
	:module: ObsInterface

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

.. py:attribute:: loggingTargets
	:module: ObsInterface

	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: obsState; ObsInterface.obsState

.. py:attribute:: obsState
	:module: ObsInterface

	The Observation State of the device.

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

.. index::
	single: versionId; ObsInterface.versionId

.. py:attribute:: versionId
	:module: ObsInterface

	Read the Version Id of the device.

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

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

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

	Get the version information of the device.

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

.. index::
	single: Init; ObsInterface.Init

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

	Reinitialise the Tango device.