RECV TANGO Device

Module for providing the RECV.MGMT capability for the Pulsar Timing Sub-element.

class ska_pst_lmc.receive.receive_device.PstReceive(*args: Any, **kwargs: Any)[source]

A software TANGO device for managing the RECV component of the PST.LMC system.

init_device() None[source]

Initialise the attributes and properties of the PstReceive.

This overrides the SKABaseDevice.

create_component_manager() PstReceiveComponentManager[source]

Create and return a component manager for this device.

Returns

a component manager for this device.

always_executed_hook() None[source]

Execute call before any TANGO command is executed.

delete_device() None[source]

Delete resources allocated in init_device.

This method allows for any memory or other resources allocated in the init_device method to be released. This method is called by the device destructor and by the device Init command.

handle_monitor_data_update(monitor_data: ReceiveData) None[source]

Handle monitoring data.

Parameters

monitor_data (ReceiveData) – the latest monitoring data that has been reported.

dataReceiveRate() float

Get the current data receive rate from the CBF interface.

Returns

current data receive rate from the CBF interface in Gb/s.

Return type

float

dataReceived() int

Get the total amount of data received from CBF interface for current scan.

Returns

total amount of data received from CBF interface for current scan in Bytes

Return type

int

dataDropRate() float

Get the current rate of CBF ingest data being dropped or lost by the receiving proces.

Returns

current rate of CBF ingest data being dropped or lost in B/s.

Return type

float

dataDropped() int

Get the total number of bytes dropped in the current scan.

Returns

total number of bytes dropped in the current scan.

Return type

int

misorderedPackets() int

Get the total number of packets received out of order in the current scan.

Returns

total number of packets received out of order in the current scan.

Return type

int

misorderedPacketRate() float

Get the current rate of misordered packets.

Returns

the current rate of misordered packets in packets/seconds.

Return type

float

malformedPackets() int

Get the total number of packets marked as malformed for current scan.

Returns

the total number of packets marked as malformed for current scan.

Return type

int

malformedPacketRate() float

Get current rate of malformed packets.

Returns

current rate of malformed packets in packets/seconds.

Return type

float

misdirectedPackets() int

Get the total number of packets as marked as misdirected for current scan.

Returns

the total number of packets as marked as misdirected for current scan.

Return type

int

misdirectedPacketRate() float

Get the current rate of misdirected packets.

Returns

the current rate of misdirected packets in packets/seconds.

Return type

float

checksumFailurePackets() int

Get the total number of packets with checksum failures for current scan.

Returns

the total number of packets with checksum failures for current scan.

Return type

int

checksumFailurePacketRate() float

Get the current rate of packets with checkesum failures.

Returns

the current rate of packets with checkesum failures in packets/seconds.

Return type

float

timestampSyncErrorPackets() int

Get the total number of packets with a timestamp sync error for current scan.

Returns

the total number of packets with a timestamp sync error for current scan.

Return type

int

timestampSyncErrorPacketRate() float

Get the current rate of packets with a timestamp sync error.

Returns

the current rate of packets with a timestamp sync error in packets/seconds.

Return type

float

seqNumberSyncErrorPackets() int

Get the total number of packets with a seq num sync error in current scan.

Returns

the total number of packets with a seq num sync error in current scan.

Return type

int

seqNumberSyncErrorPacketRate() float

Get the current rate of packets with a sequence number sync error.

Returns

the current rate of packets with a sequence number sync error in packets/seconds.

Return type

float

dataReceiveIpAddress() str

Get the data receive IP address.

It is only valid to call this method when the TANGO device is turned on and communicating.

subbandBeamConfiguration() str

Get current subband beam configuration.

Retrieves the current subband configuration that is calculated during the ConfigureBeam request. When RECV is deconfigured for beam then the response is an empty JSON object {}.

Returns

current subband beam configuration.

Return type

str

ska_pst_lmc.receive.receive_device.main(args: Optional[list] = None, **kwargs: Any) int[source]

Entry point for module.

Parameters
  • args – positional arguments

  • kwargs – named arguments

Returns

exit code

Return type

int