========================
SPFRxDevice Tango Device
========================
SPFRx simulator for testing DISH LMC.

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

.. py:attribute:: GroupDefinitions
	:module: SPFRxDevice

	:data type: DevVarStringArray

.. index::
	single: LoggingLevelDefault; SPFRxDevice.LoggingLevelDefault

.. py:attribute:: LoggingLevelDefault
	:module: SPFRxDevice

	:data type: DevUShort
	:default value: 4

.. index::
	single: LoggingTargetsDefault; SPFRxDevice.LoggingTargetsDefault

.. py:attribute:: LoggingTargetsDefault
	:module: SPFRxDevice

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

.. index::
	single: SkaLevel; SPFRxDevice.SkaLevel

.. py:attribute:: SkaLevel
	:module: SPFRxDevice

	:data type: DevShort
	:default value: 4

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

.. py:attribute:: State
	:module: SPFRxDevice

	The operational state of the device as enumeration.

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

.. index::
	single: Status; SPFRxDevice.Status

.. py:attribute:: Status
	:module: SPFRxDevice

	More detailed textual information about the device's status.

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

.. index::
	single: adminMode; SPFRxDevice.adminMode

.. py:attribute:: adminMode
	:module: SPFRxDevice

	Return the admin mode.

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

.. index::
	single: attenuation1PolHX; SPFRxDevice.attenuation1PolHX

.. py:attribute:: attenuation1PolHX
	:module: SPFRxDevice

	The currently applied attenuation values along the active band's signal chain on the
	H/X polarization.

	:access: READ_WRITE
	:data type: DevDouble
	:data format: SCALAR

.. index::
	single: attenuation1PolVY; SPFRxDevice.attenuation1PolVY

.. py:attribute:: attenuation1PolVY
	:module: SPFRxDevice

	The currently applied attenuation values along the active band's signal chain on the
	V/Y polarization.

	:access: READ_WRITE
	:data type: DevDouble
	:data format: SCALAR

.. index::
	single: attenuation2PolHX; SPFRxDevice.attenuation2PolHX

.. py:attribute:: attenuation2PolHX
	:module: SPFRxDevice

	The currently applied attenuation values along the active band's signal chain on the
	H/X polarization.

	:access: READ_WRITE
	:data type: DevDouble
	:data format: SCALAR

.. index::
	single: attenuation2PolVY; SPFRxDevice.attenuation2PolVY

.. py:attribute:: attenuation2PolVY
	:module: SPFRxDevice

	The currently applied attenuation values along the active band's signal chain on the
	V/Y polarization.

	:access: READ_WRITE
	:data type: DevDouble
	:data format: SCALAR

.. index::
	single: attenuationPolHX; SPFRxDevice.attenuationPolHX

.. py:attribute:: attenuationPolHX
	:module: SPFRxDevice

	The currently applied attenuation values along the active band's signal chain on the
	H/X polarization.

	:access: READ_WRITE
	:data type: DevDouble
	:data format: SCALAR

.. index::
	single: attenuationPolVY; SPFRxDevice.attenuationPolVY

.. py:attribute:: attenuationPolVY
	:module: SPFRxDevice

	The currently applied attenuation values along the active band's signal chain on the
	V/Y polarization.

	:access: READ_WRITE
	:data type: DevDouble
	:data format: SCALAR

.. index::
	single: b1CapabilityState; SPFRxDevice.b1CapabilityState

.. py:attribute:: b1CapabilityState
	:module: SPFRxDevice

	Report the device b1CapabilityState

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

.. index::
	single: b2CapabilityState; SPFRxDevice.b2CapabilityState

.. py:attribute:: b2CapabilityState
	:module: SPFRxDevice

	Report the device b2CapabilityState

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

.. index::
	single: b3CapabilityState; SPFRxDevice.b3CapabilityState

.. py:attribute:: b3CapabilityState
	:module: SPFRxDevice

	Report the device b3CapabilityState

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

.. index::
	single: b4CapabilityState; SPFRxDevice.b4CapabilityState

.. py:attribute:: b4CapabilityState
	:module: SPFRxDevice

	Report the device b4CapabilityState

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

.. index::
	single: b5aCapabilityState; SPFRxDevice.b5aCapabilityState

.. py:attribute:: b5aCapabilityState
	:module: SPFRxDevice

	Report the device b5CapabilityState

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

.. index::
	single: b5bCapabilityState; SPFRxDevice.b5bCapabilityState

.. py:attribute:: b5bCapabilityState
	:module: SPFRxDevice

	Report the device b5bCapabilityState

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

.. index::
	single: buildState; SPFRxDevice.buildState

.. py:attribute:: buildState
	:module: SPFRxDevice

	Read the Build State of the device.

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

.. index::
	single: capturingData; SPFRxDevice.capturingData

.. py:attribute:: capturingData
	:module: SPFRxDevice

	Indicate whether the receiver is receiving data from the RXS along the JESD.

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

.. index::
	single: commandedState; SPFRxDevice.commandedState

.. py:attribute:: commandedState
	:module: SPFRxDevice

	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: configuredBand; SPFRxDevice.configuredBand

.. py:attribute:: configuredBand
	:module: SPFRxDevice

	Returns the configuredBand.

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

.. index::
	single: controlMode; SPFRxDevice.controlMode

.. py:attribute:: controlMode
	:module: SPFRxDevice

	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: dataFiberCheck; SPFRxDevice.dataFiberCheck

.. py:attribute:: dataFiberCheck
	:module: SPFRxDevice

	Indicate whether the receiver is receiving data from the RXS along the JESD.

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

.. index::
	single: fwVersions; SPFRxDevice.fwVersions

.. py:attribute:: fwVersions
	:module: SPFRxDevice

	Firmware serial numbers

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

.. index::
	single: healthState; SPFRxDevice.healthState

.. py:attribute:: healthState
	:module: SPFRxDevice

	Returns the healthState of the device.

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

.. index::
	single: isKLocked; SPFRxDevice.isKLocked

.. py:attribute:: isKLocked
	:module: SPFRxDevice

	Mimics SPFRx functionality which would check the SAT.RM module to see if
	the k- value is locked. If not, it will return false.

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

.. index::
	single: kValue; SPFRxDevice.kValue

.. py:attribute:: kValue
	:module: SPFRxDevice

	Return the k value.

	:access: READ_WRITE
	:data type: DevLong64
	:data format: SCALAR

.. index::
	single: loggingLevel; SPFRxDevice.loggingLevel

.. py:attribute:: loggingLevel
	:module: SPFRxDevice

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

.. py:attribute:: loggingTargets
	:module: SPFRxDevice

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

.. py:attribute:: longRunningCommandResult
	:module: SPFRxDevice

	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; SPFRxDevice.lrcFinished

.. py:attribute:: lrcFinished
	:module: SPFRxDevice

	Read info of the finished long running commands.

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

.. index::
	single: lrcProtocolVersions; SPFRxDevice.lrcProtocolVersions

.. py:attribute:: lrcProtocolVersions
	:module: SPFRxDevice

	Return supported protocol versions.

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

.. index::
	single: noiseDiodeMode; SPFRxDevice.noiseDiodeMode

.. py:attribute:: noiseDiodeMode
	:module: SPFRxDevice

	Noise diode mode.

	0: OFF, 1: PERIODIC, 2: PSEUDO-RANDOM

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

.. index::
	single: operatingMode; SPFRxDevice.operatingMode

.. py:attribute:: operatingMode
	:module: SPFRxDevice

	Returns the operating mode of the device.

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

.. index::
	single: periodicNoiseDiodePars; SPFRxDevice.periodicNoiseDiodePars

.. py:attribute:: periodicNoiseDiodePars
	:module: SPFRxDevice

	Periodic noise diode pars (units are in time quanta).

	[0]: period, [1]: duty cycle, [2]: phase shift

	:access: READ_WRITE
	:data type: DevULong
	:data format: SPECTRUM
	:max_dim_x: 3

.. index::
	single: pseudoRandomNoiseDiodePars; SPFRxDevice.pseudoRandomNoiseDiodePars

.. py:attribute:: pseudoRandomNoiseDiodePars
	:module: SPFRxDevice

	Pseudo random noise diode pars (units are in time quanta).

	[0]: binary polynomial, [1]: seed, [2]: dwell

	:access: READ_WRITE
	:data type: DevULong
	:data format: SPECTRUM
	:max_dim_x: 3

.. index::
	single: raiseCmdException; SPFRxDevice.raiseCmdException

.. py:attribute:: raiseCmdException
	:module: SPFRxDevice

	Raises an exception on commands when flagged True

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

.. index::
	single: serialNumbers; SPFRxDevice.serialNumbers

.. py:attribute:: serialNumbers
	:module: SPFRxDevice

	Hardware serial numbers

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

.. index::
	single: simulationMode; SPFRxDevice.simulationMode

.. py:attribute:: simulationMode
	:module: SPFRxDevice

	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: spectralInversion; SPFRxDevice.spectralInversion

.. py:attribute:: spectralInversion
	:module: SPFRxDevice

	Spectral inversion to correct the frequency sense of the currently
	configured band with respect to the RF signal.

	Logic 0: Output signal in the same frequency sense as input.

	Logic 1: Output signal in the opposite frequency sense as input.

	Setting this attribute to true will set the
	spectrum to be flipped.

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

.. index::
	single: swVersions; SPFRxDevice.swVersions

.. py:attribute:: swVersions
	:module: SPFRxDevice

	Software module serial number

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

.. index::
	single: testMode; SPFRxDevice.testMode

.. py:attribute:: testMode
	:module: SPFRxDevice

	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; SPFRxDevice.versionId

.. py:attribute:: versionId
	:module: SPFRxDevice

	Read the Version Id of the device.

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

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

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

	Abort

.. index::
	single: AbortCommands; SPFRxDevice.AbortCommands

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

	Abort commands

.. index::
	single: CheckLongRunningCommandStatus; SPFRxDevice.CheckLongRunningCommandStatus

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

	Check long running command status

.. index::
	single: ConfigureBand; SPFRxDevice.ConfigureBand

.. py:method:: ConfigureBand(DevString) -> DevVoid
	:module: SPFRxDevice

	General configure band command containing all relevant information.
	Input is JSON string with the following format:
	{
	"dish": {
	"receiver_band": <string>,
	"sub_band": <string>,
	"spfrx_processing_parameters": [{
	"dishes": List[<string>],
	"sync_pps":  <bool>,
	"attenuation_pol_x": <float>,
	"attenuation_pol_y": <float>,
	"attenuation_1_pol_x": <float>,
	"attenuation_1_pol_y": <float>,
	"attenuation_2_pol_x": <float>,
	"attenuation_2_pol_y": <float>,
	"saturation_threshold": <float>,
	"noise_diode": {
	"pseudo_random": {
	"binary_polynomial": <long>,
	"seed": <long>,
	"dwell": <long>,
	},
	"periodic": {
	"period": <long>,
	"duty_cycle": <long>,
	"phase_shift": <long>,
	}
	}
	}]
	}
	}

.. index::
	single: ConfigureBand1; SPFRxDevice.ConfigureBand1

.. py:method:: ConfigureBand1(DevBoolean) -> DevVoid
	:module: SPFRxDevice

	Set ConfigureBand1

.. index::
	single: ConfigureBand2; SPFRxDevice.ConfigureBand2

.. py:method:: ConfigureBand2(DevBoolean) -> DevVoid
	:module: SPFRxDevice

	Set ConfigureBand2

.. index::
	single: ConfigureBand3; SPFRxDevice.ConfigureBand3

.. py:method:: ConfigureBand3(DevBoolean) -> DevVoid
	:module: SPFRxDevice

	Set ConfigureBand3

.. index::
	single: ConfigureBand4; SPFRxDevice.ConfigureBand4

.. py:method:: ConfigureBand4(DevBoolean) -> DevVoid
	:module: SPFRxDevice

	Set ConfigureBand4

.. index::
	single: ConfigureBand5a; SPFRxDevice.ConfigureBand5a

.. py:method:: ConfigureBand5a(DevBoolean) -> DevVoid
	:module: SPFRxDevice

	Set ConfigureBand5a

.. index::
	single: ConfigureBand5b; SPFRxDevice.ConfigureBand5b

.. py:method:: ConfigureBand5b(DevBoolean) -> DevVoid
	:module: SPFRxDevice

	Set ConfigureBand5b

.. index::
	single: DebugDevice; SPFRxDevice.DebugDevice

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

	Debug device

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

.. index::
	single: ExecutePendingOperations; SPFRxDevice.ExecutePendingOperations

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

	Execute pending operations

.. index::
	single: GetAttenuation1PolVYQuality; SPFRxDevice.GetAttenuation1PolVYQuality

.. py:method:: GetAttenuation1PolVYQuality() -> DevString
	:module: SPFRxDevice

	Used to get the attribute quality of the attr
	"attenuation1PolVY". Used in testing

.. index::
	single: GetVersionInfo; SPFRxDevice.GetVersionInfo

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

	Get version info

.. index::
	single: Init; SPFRxDevice.Init

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

	Reinitialise the Tango device.

.. index::
	single: MonitorPing; SPFRxDevice.MonitorPing

.. py:method:: MonitorPing() -> DevVoid
	:module: SPFRxDevice

	Command to check that a client is connected

.. index::
	single: Off; SPFRxDevice.Off

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

	Off

.. index::
	single: On; SPFRxDevice.On

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

	On

.. index::
	single: Reset; SPFRxDevice.Reset

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

	Reset

.. index::
	single: ResetToDefault; SPFRxDevice.ResetToDefault

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

	Used to reset device to default values. Used in testing

.. index::
	single: SetAttenuation1PolVYQuality; SPFRxDevice.SetAttenuation1PolVYQuality

.. py:method:: SetAttenuation1PolVYQuality(DevEnum) -> DevVoid
	:module: SPFRxDevice

	Used to set the attribute quality of the attr "attenuation1PolVY".
	Used in testing

.. index::
	single: SetKValue; SPFRxDevice.SetKValue

.. py:method:: SetKValue(DevLong64) -> DevVoid
	:module: SPFRxDevice

	Set SPFRX KValue

.. index::
	single: SetStandbyMode; SPFRxDevice.SetStandbyMode

.. py:method:: SetStandbyMode() -> DevVoid
	:module: SPFRxDevice

	Set SPFRXOperatingMode

.. index::
	single: Standby; SPFRxDevice.Standby

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

	Standby