SPFRxDevice Tango Device

SPFRx simulator for testing DISH LMC.

Properties

GroupDefinitions
Data type:

DevVarStringArray

LoggingLevelDefault
Data type:

DevUShort

Default value:

4

LoggingTargetsDefault
Data type:

DevVarStringArray

Default value:

[‘tango::logger’]

SkaLevel
Data type:

DevShort

Default value:

4

Attributes

State

The operational state of the device as enumeration.

Access:

READ

Data type:

DevState

Data format:

SCALAR

Status

More detailed textual information about the device’s status.

Access:

READ

Data type:

DevString

Data format:

SCALAR

adminMode

Return the admin mode.

Access:

READ_WRITE

Data type:

DevEnum

Data format:

SCALAR

attenuation1PolHX

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

attenuation1PolVY

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

attenuation2PolHX

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

attenuation2PolVY

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

attenuationPolHX

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

attenuationPolVY

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

b1CapabilityState

Report the device b1CapabilityState

Access:

READ_WRITE

Data type:

DevEnum

Data format:

SCALAR

b2CapabilityState

Report the device b2CapabilityState

Access:

READ_WRITE

Data type:

DevEnum

Data format:

SCALAR

b3CapabilityState

Report the device b3CapabilityState

Access:

READ_WRITE

Data type:

DevEnum

Data format:

SCALAR

b4CapabilityState

Report the device b4CapabilityState

Access:

READ_WRITE

Data type:

DevEnum

Data format:

SCALAR

b5aCapabilityState

Report the device b5CapabilityState

Access:

READ_WRITE

Data type:

DevEnum

Data format:

SCALAR

b5bCapabilityState

Report the device b5bCapabilityState

Access:

READ_WRITE

Data type:

DevEnum

Data format:

SCALAR

buildState

Read the Build State of the device.

Access:

READ

Data type:

DevString

Data format:

SCALAR

capturingData

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

Access:

READ_WRITE

Data type:

DevBoolean

Data format:

SCALAR

commandedState

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

configuredBand

Returns the configuredBand.

Access:

READ_WRITE

Data type:

DevEnum

Data format:

SCALAR

controlMode

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

dataFiberCheck

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

Access:

READ_WRITE

Data type:

DevBoolean

Data format:

SCALAR

fwVersions

Firmware serial numbers

Access:

READ

Data type:

DevString

Data format:

SPECTRUM

Max_dim_x:

100

healthState

Returns the healthState of the device.

Access:

READ_WRITE

Data type:

DevEnum

Data format:

SCALAR

isKLocked

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

kValue

Return the k value.

Access:

READ_WRITE

Data type:

DevLong64

Data format:

SCALAR

loggingLevel

Read the logging level of the device.

Initialises to LoggingLevelDefault on startup. See LoggingLevel

Access:

READ_WRITE

Data type:

DevEnum

Data format:

SCALAR

loggingTargets

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

longRunningCommandResult

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

lrcFinished

Read info of the finished long running commands.

Access:

READ

Data type:

DevString

Data format:

SPECTRUM

Max_dim_x:

100

lrcProtocolVersions

Return supported protocol versions.

Access:

READ

Data type:

DevLong64

Data format:

SPECTRUM

Max_dim_x:

2

noiseDiodeMode

Noise diode mode.

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

Access:

READ_WRITE

Data type:

DevEnum

Data format:

SCALAR

operatingMode

Returns the operating mode of the device.

Access:

READ_WRITE

Data type:

DevEnum

Data format:

SCALAR

periodicNoiseDiodePars

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

pseudoRandomNoiseDiodePars

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

raiseCmdException

Raises an exception on commands when flagged True

Access:

READ_WRITE

Data type:

DevBoolean

Data format:

SCALAR

serialNumbers

Hardware serial numbers

Access:

READ

Data type:

DevString

Data format:

SPECTRUM

Max_dim_x:

100

simulationMode

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

spectralInversion

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

spectrumSample

Spectrum sample data from the spectrometer as a packed DevFloat array. The array contains a UTC timestamp followed by multiple spectral datasets. Index layout: [0-1]: UTC timestamp in seconds, [2-1026]: P_on,X (1025 floats), [1027-2051]: P_on,Y (1025 floats), [2052-3076]: P_on,XY real (1025 floats), [3077-4101]: P_on,XY imaginary (1025 floats), [4102-5126]: P_off,X (1025 floats), [5127-6151]: P_off,Y (1025 floats), [6152-7176]: P_off,XY real (1025 floats), [7177-8201]: P_off,XY imaginary (1025 floats).

Access:

READ_WRITE

Data type:

DevDouble

Data format:

SPECTRUM

Max_dim_x:

8202

swVersions

Software module serial number

Access:

READ

Data type:

DevString

Data format:

SPECTRUM

Max_dim_x:

100

testMode

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

versionId

Read the Version Id of the device.

Access:

READ

Data type:

DevString

Data format:

SCALAR

Commands

Abort() DevVarLongStringArray

No input parameter (DevVoid)

Returns:

A tuple containing a result code and the unique ID of the command

AbortCommands() DevVarLongStringArray

No input parameter (DevVoid)

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

CheckLongRunningCommandStatus(DevString) DevString

argin (None): the command id

Returns:

command status

ConfigureBand(DevString) DevVoid

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>, } } }] } }

Returns:

No output parameter (DevVoid)

ConfigureBand1(DevBoolean) DevVoid

Set ConfigureBand1

Returns:

No output parameter (DevVoid)

ConfigureBand2(DevBoolean) DevVoid

Set ConfigureBand2

Returns:

No output parameter (DevVoid)

ConfigureBand3(DevBoolean) DevVoid

Set ConfigureBand3

Returns:

No output parameter (DevVoid)

ConfigureBand4(DevBoolean) DevVoid

Set ConfigureBand4

Returns:

No output parameter (DevVoid)

ConfigureBand5a(DevBoolean) DevVoid

Set ConfigureBand5a

Returns:

No output parameter (DevVoid)

ConfigureBand5b(DevBoolean) DevVoid

Set ConfigureBand5b

Returns:

No output parameter (DevVoid)

DebugDevice() DevUShort

No input parameter (DevVoid)

Returns:

The TCP port the debugger is listening on.

ExecutePendingOperations() DevVoid

No input parameter (DevVoid)

Returns:

No output parameter (DevVoid)

GetAttenuation1PolVYQuality() DevString

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

Returns:

return:

(not documented)

rtype:

DevString

GetVersionInfo() DevVarStringArray

No input parameter (DevVoid)

Returns:

The result code and the command unique ID

Init() DevVoid

Reinitialise the Tango device.

MonitorPing() DevVoid

Command to check that a client is connected

Returns:

No output parameter (DevVoid)

Off() DevVarLongStringArray

No input parameter (DevVoid)

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

On() DevVarLongStringArray

No input parameter (DevVoid)

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

Reset() DevVarLongStringArray

No input parameter (DevVoid)

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

ResetToDefault() DevVoid

Used to reset device to default values. Used in testing

Returns:

No output parameter (DevVoid)

SetAttenuation1PolVYQuality(DevEnum) DevVoid

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

Returns:

No output parameter (DevVoid)

SetKValue(DevLong64) DevVoid

Set SPFRX KValue

Returns:

No output parameter (DevVoid)

SetStandbyMode() DevVoid

Set SPFRXOperatingMode

Returns:

No output parameter (DevVoid)

Standby() DevVarLongStringArray

No input parameter (DevVoid)

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.