======================
SPFDevice Tango Device
======================
SPF simulator for testing DISH LMC.

Properties
----------
.. index::
	single: GroupDefinitions; SPFDevice.GroupDefinitions

.. py:attribute:: GroupDefinitions
	:module: SPFDevice

	:data type: DevVarStringArray

.. index::
	single: LoggingLevelDefault; SPFDevice.LoggingLevelDefault

.. py:attribute:: LoggingLevelDefault
	:module: SPFDevice

	:data type: DevUShort
	:default value: 4

.. index::
	single: LoggingTargetsDefault; SPFDevice.LoggingTargetsDefault

.. py:attribute:: LoggingTargetsDefault
	:module: SPFDevice

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

.. index::
	single: SkaLevel; SPFDevice.SkaLevel

.. py:attribute:: SkaLevel
	:module: SPFDevice

	:data type: DevShort
	:default value: 4

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

.. py:attribute:: State
	:module: SPFDevice

	The operational state of the device as enumeration.

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

.. index::
	single: Status; SPFDevice.Status

.. py:attribute:: Status
	:module: SPFDevice

	More detailed textual information about the device's status.

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

.. index::
	single: adminMode; SPFDevice.adminMode

.. py:attribute:: adminMode
	:module: SPFDevice

	Read 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: b1CapabilityState; SPFDevice.b1CapabilityState

.. py:attribute:: b1CapabilityState
	:module: SPFDevice

	Report the device b1CapabilityState

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

.. index::
	single: b1LnaHPowerState; SPFDevice.b1LnaHPowerState

.. py:attribute:: b1LnaHPowerState
	:module: SPFDevice

	Switches the B1 LNA H-channel power on/off

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

.. index::
	single: b1LnaVPowerState; SPFDevice.b1LnaVPowerState

.. py:attribute:: b1LnaVPowerState
	:module: SPFDevice

	Switches the B1 LNA V-channel power on/off

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

.. index::
	single: b2CapabilityState; SPFDevice.b2CapabilityState

.. py:attribute:: b2CapabilityState
	:module: SPFDevice

	Report the device b2CapabilityState

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

.. index::
	single: b2LnaHPowerState; SPFDevice.b2LnaHPowerState

.. py:attribute:: b2LnaHPowerState
	:module: SPFDevice

	Switch the B2 LNA H-channel power on/off

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

.. index::
	single: b2LnaVPowerState; SPFDevice.b2LnaVPowerState

.. py:attribute:: b2LnaVPowerState
	:module: SPFDevice

	Switch the B2 LNA V-channel power on/off

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

.. index::
	single: b3CapabilityState; SPFDevice.b3CapabilityState

.. py:attribute:: b3CapabilityState
	:module: SPFDevice

	Report the device b3CapabilityState

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

.. index::
	single: b3LnaPowerState; SPFDevice.b3LnaPowerState

.. py:attribute:: b3LnaPowerState
	:module: SPFDevice

	Switches the B3 LNA power on/off

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

.. index::
	single: b4CapabilityState; SPFDevice.b4CapabilityState

.. py:attribute:: b4CapabilityState
	:module: SPFDevice

	Report the device b4CapabilityState

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

.. index::
	single: b4LnaPowerState; SPFDevice.b4LnaPowerState

.. py:attribute:: b4LnaPowerState
	:module: SPFDevice

	Switches the B4 LNA power on/off

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

.. index::
	single: b5aCapabilityState; SPFDevice.b5aCapabilityState

.. py:attribute:: b5aCapabilityState
	:module: SPFDevice

	Report the device b5aCapabilityState

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

.. index::
	single: b5aLnaPowerState; SPFDevice.b5aLnaPowerState

.. py:attribute:: b5aLnaPowerState
	:module: SPFDevice

	Switches the B5a LNA power on/off

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

.. index::
	single: b5bCapabilityState; SPFDevice.b5bCapabilityState

.. py:attribute:: b5bCapabilityState
	:module: SPFDevice

	Report the device b5CapabilityState

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

.. index::
	single: b5bLnaPowerState; SPFDevice.b5bLnaPowerState

.. py:attribute:: b5bLnaPowerState
	:module: SPFDevice

	Switches the B5b LNA power on/off

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

.. index::
	single: bandInFocus; SPFDevice.bandInFocus

.. py:attribute:: bandInFocus
	:module: SPFDevice

	Returns the BandInFocus.

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

.. index::
	single: buildState; SPFDevice.buildState

.. py:attribute:: buildState
	:module: SPFDevice

	Read the Build State of the device.

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

.. index::
	single: commandedState; SPFDevice.commandedState

.. py:attribute:: commandedState
	:module: SPFDevice

	Read 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 start of the Off(), Standby(), On() or Reset()
	long running commands.

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

.. index::
	single: controlMode; SPFDevice.controlMode

.. py:attribute:: controlMode
	:module: SPFDevice

	Read the Control Mode of the device.

	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: fwVersions; SPFDevice.fwVersions

.. py:attribute:: fwVersions
	:module: SPFDevice

	Firmware serial numbers

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

.. index::
	single: healthState; SPFDevice.healthState

.. py:attribute:: healthState
	:module: SPFDevice

	Returns the healthState of the device.

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

.. index::
	single: loggingLevel; SPFDevice.loggingLevel

.. py:attribute:: loggingLevel
	:module: SPFDevice

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

.. py:attribute:: loggingTargets
	:module: SPFDevice

	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: longRunningCommandResult; SPFDevice.longRunningCommandResult

.. py:attribute:: longRunningCommandResult
	:module: SPFDevice

	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: lrcFinished; SPFDevice.lrcFinished

.. py:attribute:: lrcFinished
	:module: SPFDevice

	Read info of the finished long running commands.

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

.. index::
	single: lrcProtocolVersions; SPFDevice.lrcProtocolVersions

.. py:attribute:: lrcProtocolVersions
	:module: SPFDevice

	Return supported protocol versions.

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

.. index::
	single: operatingMode; SPFDevice.operatingMode

.. py:attribute:: operatingMode
	:module: SPFDevice

	Returns the operating mode of the device.

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

.. index::
	single: powerState; SPFDevice.powerState

.. py:attribute:: powerState
	:module: SPFDevice

	Returns the powerstate this device.

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

.. index::
	single: raiseCmdException; SPFDevice.raiseCmdException

.. py:attribute:: raiseCmdException
	:module: SPFDevice

	Raises an exception on commands when flagged True

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

.. index::
	single: serialNumbers; SPFDevice.serialNumbers

.. py:attribute:: serialNumbers
	:module: SPFDevice

	Hardware serial numbers

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

.. index::
	single: simulationMode; SPFDevice.simulationMode

.. py:attribute:: simulationMode
	:module: SPFDevice

	Read the Simulation Mode of the device.

	Some devices may implement
	both modes, while others will have simulators that set simulationMode
	to True while the real devices always set simulationMode to False.

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

.. index::
	single: skipAttributeUpdates; SPFDevice.skipAttributeUpdates

.. py:attribute:: skipAttributeUpdates
	:module: SPFDevice

	Skip or apply attribute update in command execution

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

.. index::
	single: swVersions; SPFDevice.swVersions

.. py:attribute:: swVersions
	:module: SPFDevice

	Software module serial number

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

.. index::
	single: testMode; SPFDevice.testMode

.. py:attribute:: testMode
	:module: SPFDevice

	Read the Test Mode of the device.

	Either no test mode or an indication of the test mode.

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

.. index::
	single: versionId; SPFDevice.versionId

.. py:attribute:: versionId
	:module: SPFDevice

	Read the Version Id of the device.

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

Commands
--------
.. index::
	single: Abort; SPFDevice.Abort

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

	Abort

.. index::
	single: AbortCommands; SPFDevice.AbortCommands

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

	Abort commands

.. index::
	single: CheckLongRunningCommandStatus; SPFDevice.CheckLongRunningCommandStatus

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

	Check long running command status

.. index::
	single: DebugDevice; SPFDevice.DebugDevice

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

	Debug device

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

.. index::
	single: ExecutePendingOperations; SPFDevice.ExecutePendingOperations

.. py:method:: ExecutePendingOperations() -> DevVoid
	:module: SPFDevice

	Execute pending operations

.. index::
	single: GetVersionInfo; SPFDevice.GetVersionInfo

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

	Get version info

.. index::
	single: Init; SPFDevice.Init

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

	Reinitialise the Tango device.

.. index::
	single: Off; SPFDevice.Off

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

	Off

.. index::
	single: On; SPFDevice.On

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

	On

.. index::
	single: RemountSdCard; SPFDevice.RemountSdCard

.. py:method:: RemountSdCard() -> DevBoolean
	:module: SPFDevice

	RemountSdCard

.. index::
	single: Reset; SPFDevice.Reset

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

	Reset

.. index::
	single: ResetToDefault; SPFDevice.ResetToDefault

.. py:method:: ResetToDefault() -> DevVoid
	:module: SPFDevice

	Used to reset device to default values. Used in testing

.. index::
	single: Restart; SPFDevice.Restart

.. py:method:: Restart() -> DevVoid
	:module: SPFDevice

	Restart

.. index::
	single: SendFeedCommand; SPFDevice.SendFeedCommand

.. py:method:: SendFeedCommand(DevVarShortArray) -> DevVoid
	:module: SPFDevice

	SendFeedCommand

.. index::
	single: SendHeliumCommand; SPFDevice.SendHeliumCommand

.. py:method:: SendHeliumCommand(DevLong64) -> DevVoid
	:module: SPFDevice

	SendHeliumCommand

.. index::
	single: SetCapStateDegraded; SPFDevice.SetCapStateDegraded

.. py:method:: SetCapStateDegraded(DevFloat) -> DevVoid
	:module: SPFDevice

	Set CapabilityState

.. index::
	single: SetFeedMode; SPFDevice.SetFeedMode

.. py:method:: SetFeedMode(DevVarShortArray) -> DevVoid
	:module: SPFDevice

	SetFeedMode

.. index::
	single: SetHeliumMode; SPFDevice.SetHeliumMode

.. py:method:: SetHeliumMode(DevLong64) -> DevVoid
	:module: SPFDevice

	SetHeliumMode

.. index::
	single: SetMaintenanceMode; SPFDevice.SetMaintenanceMode

.. py:method:: SetMaintenanceMode() -> DevVoid
	:module: SPFDevice

	Set SetMaintenanceMode

.. index::
	single: SetOperateMode; SPFDevice.SetOperateMode

.. py:method:: SetOperateMode() -> DevVoid
	:module: SPFDevice

	Set SPFOperatingMode

.. index::
	single: SetStandbyLPMode; SPFDevice.SetStandbyLPMode

.. py:method:: SetStandbyLPMode() -> DevVoid
	:module: SPFDevice

	Set OperatingMode and PowerState

.. index::
	single: SetStartupMode; SPFDevice.SetStartupMode

.. py:method:: SetStartupMode() -> DevVoid
	:module: SPFDevice

	Set SetStartupMode

.. index::
	single: SetVacuumMode; SPFDevice.SetVacuumMode

.. py:method:: SetVacuumMode(DevLong64) -> DevVoid
	:module: SPFDevice

	SetVacuumMode

.. index::
	single: Shutdown; SPFDevice.Shutdown

.. py:method:: Shutdown() -> DevVoid
	:module: SPFDevice

	Shutdown

.. index::
	single: Standby; SPFDevice.Standby

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

	Standby