======================
B5dcProxy Tango Device
======================
Implementation of the B5dcProxy Tango device.

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

.. py:attribute:: State
	:module: B5dcProxy

	The operational state of the device as enumeration.

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

.. index::
	single: Status; B5dcProxy.Status

.. py:attribute:: Status
	:module: B5dcProxy

	More detailed textual information about the device's status.

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

.. index::
	single: adminMode; B5dcProxy.adminMode

.. py:attribute:: adminMode
	:module: B5dcProxy

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

.. py:attribute:: buildState
	:module: B5dcProxy

	Get B5DC version information.

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

.. index::
	single: clkPhotodiodeCurrent; B5dcProxy.clkPhotodiodeCurrent

.. py:attribute:: clkPhotodiodeCurrent
	:module: B5dcProxy

	Reflects the photodiode current in mA.

	:access: READ
	:data type: DevDouble
	:data format: SCALAR

.. index::
	single: commandedState; B5dcProxy.commandedState

.. py:attribute:: commandedState
	:module: B5dcProxy

	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: connectionState; B5dcProxy.connectionState

.. py:attribute:: connectionState
	:module: B5dcProxy

	Return the status of the connection to the B5dc server endpoint

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

.. index::
	single: controlMode; B5dcProxy.controlMode

.. py:attribute:: controlMode
	:module: B5dcProxy

	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: hPolRfPowerIn; B5dcProxy.hPolRfPowerIn

.. py:attribute:: hPolRfPowerIn
	:module: B5dcProxy

	Reflects the RFCM RF power input for horizonal polarization in dBm.

	:access: READ
	:data type: DevDouble
	:data format: SCALAR

.. index::
	single: hPolRfPowerOut; B5dcProxy.hPolRfPowerOut

.. py:attribute:: hPolRfPowerOut
	:module: B5dcProxy

	Reflects the RFCM RF power output for horizonal polarization in dBm.

	:access: READ
	:data type: DevDouble
	:data format: SCALAR

.. index::
	single: healthState; B5dcProxy.healthState

.. py:attribute:: healthState
	:module: B5dcProxy

	Read the Health State of the device. It interprets the current device condition and condition of all managed devices to set this. Most possibly an aggregate attribute.

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

.. index::
	single: loggingLevel; B5dcProxy.loggingLevel

.. py:attribute:: loggingLevel
	:module: B5dcProxy

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

.. py:attribute:: loggingTargets
	:module: B5dcProxy

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

.. py:attribute:: longRunningCommandIDsInQueue
	:module: B5dcProxy

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

.. py:attribute:: longRunningCommandInProgress
	:module: B5dcProxy

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

.. py:attribute:: longRunningCommandProgress
	:module: B5dcProxy

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

.. py:attribute:: longRunningCommandResult
	:module: B5dcProxy

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

.. py:attribute:: longRunningCommandStatus
	:module: B5dcProxy

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

.. py:attribute:: longRunningCommandsInQueue
	:module: B5dcProxy

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

.. py:attribute:: lrcExecuting
	:module: B5dcProxy

	Expose a signal as a Tango attribute.

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

.. index::
	single: lrcFinished; B5dcProxy.lrcFinished

.. py:attribute:: lrcFinished
	:module: B5dcProxy

	Expose a signal as a Tango attribute.

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

.. index::
	single: lrcProtocolVersions; B5dcProxy.lrcProtocolVersions

.. py:attribute:: lrcProtocolVersions
	:module: B5dcProxy

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

.. py:attribute:: lrcQueue
	:module: B5dcProxy

	Expose a signal as a Tango attribute.

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

.. index::
	single: rfTemperature; B5dcProxy.rfTemperature

.. py:attribute:: rfTemperature
	:module: B5dcProxy

	Reflects the RFCM RF PCB temperature in deg C.

	:access: READ
	:data type: DevDouble
	:data format: SCALAR

.. index::
	single: rfcmFrequency; B5dcProxy.rfcmFrequency

.. py:attribute:: rfcmFrequency
	:module: B5dcProxy

	Indicates the PLL Output Frequency. The default value is 11.1 GHz

	:access: READ
	:data type: DevDouble
	:data format: SCALAR

.. index::
	single: rfcmHAttenuation; B5dcProxy.rfcmHAttenuation

.. py:attribute:: rfcmHAttenuation
	:module: B5dcProxy

	Reflects the RFCM H-polarization attenuation value in dB.

	:access: READ
	:data type: DevDouble
	:data format: SCALAR

.. index::
	single: rfcmPllLock; B5dcProxy.rfcmPllLock

.. py:attribute:: rfcmPllLock
	:module: B5dcProxy

	Status flags for RFCM PLL lock and lock loss detection.

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

.. index::
	single: rfcmPsuPcbTemperature; B5dcProxy.rfcmPsuPcbTemperature

.. py:attribute:: rfcmPsuPcbTemperature
	:module: B5dcProxy

	Reflects RFCM PSU PCB temperature in deg C.

	:access: READ
	:data type: DevDouble
	:data format: SCALAR

.. index::
	single: rfcmVAttenuation; B5dcProxy.rfcmVAttenuation

.. py:attribute:: rfcmVAttenuation
	:module: B5dcProxy

	Reflects the RFCM V-polarization attenuation value in dB.

	:access: READ
	:data type: DevDouble
	:data format: SCALAR

.. index::
	single: simulationMode; B5dcProxy.simulationMode

.. py:attribute:: simulationMode
	:module: B5dcProxy

	When TRUE the device is using a simulator

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

.. index::
	single: testMode; B5dcProxy.testMode

.. py:attribute:: testMode
	:module: B5dcProxy

	If TEST the device is using testing logic

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

.. index::
	single: vPolRfPowerIn; B5dcProxy.vPolRfPowerIn

.. py:attribute:: vPolRfPowerIn
	:module: B5dcProxy

	Reflects the RFCM RF power input for vertical polarization in dBm.

	:access: READ
	:data type: DevDouble
	:data format: SCALAR

.. index::
	single: vPolRfPowerOut; B5dcProxy.vPolRfPowerOut

.. py:attribute:: vPolRfPowerOut
	:module: B5dcProxy

	Reflects the RFCM RF power output for vertical polarization in dBm.

	:access: READ
	:data type: DevDouble
	:data format: SCALAR

.. index::
	single: versionId; B5dcProxy.versionId

.. py:attribute:: versionId
	:module: B5dcProxy

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

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

	No input parameter (DevVoid)

	:returns: [ResultCode.STARTED][command_id]

.. index::
	single: AbortCommands; B5dcProxy.AbortCommands

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

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

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

	command id

	:returns: TaskStatus

.. index::
	single: DebugDevice; B5dcProxy.DebugDevice

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

	No input parameter (DevVoid)

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

.. index::
	single: GetVersionInfo; B5dcProxy.GetVersionInfo

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

	No input parameter (DevVoid)

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

.. index::
	single: Init; B5dcProxy.Init

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

	Init

.. index::
	single: Off; B5dcProxy.Off

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

	No input parameter (DevVoid)

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

.. index::
	single: On; B5dcProxy.On

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

	No input parameter (DevVoid)

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

.. index::
	single: Reset; B5dcProxy.Reset

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

	No input parameter (DevVoid)

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

.. index::
	single: SetFrequency; B5dcProxy.SetFrequency

.. py:method:: SetFrequency(DevLong64) -> DevVarLongStringArray
	:module: B5dcProxy

	Set the frequency on the band 5 down converter.

	B5dcFrequency.F_13_2_GHZ(2) or B5dcFrequency.F_13_86_GHZ(3)]

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

.. index::
	single: SetHPolAttenuation; B5dcProxy.SetHPolAttenuation

.. py:method:: SetHPolAttenuation(DevLong64) -> DevVarLongStringArray
	:module: B5dcProxy

	Set the horizontal polarization attenuation on the band 5 down converter.

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

.. index::
	single: SetVPolAttenuation; B5dcProxy.SetVPolAttenuation

.. py:method:: SetVPolAttenuation(DevLong64) -> DevVarLongStringArray
	:module: B5dcProxy

	Set the vertical polarization attenuation on the band 5 down converter.

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

.. index::
	single: Standby; B5dcProxy.Standby

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

	No input parameter (DevVoid)

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