Station Device
This module implements the MCCS station device.
- class SpsStation(*args, **kwargs)
An implementation of an SPS Station Tango device for MCCS.
- ApplyCalibration(argin)
Load the calibration coefficients at the specified time delay.
- Parameters:
argin (
str) – switch time, in ISO formatted time. Default: now- Return type:
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purpose only.
- Example:
>>> dp = tango.DeviceProxy("mccs/tile/01") >>> dp.command_inout("ApplyCalibration", "")
- ApplyPointingDelays(argin)
Set the pointing delay parameters of this Station’s Tiles.
- Parameters:
argin (
str) – switch time, in ISO formatted time. Default: now- Return type:
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purpose only.
- Example:
>>> dp = tango.DeviceProxy("mccs/station/01") >>> time_string = switch time as ISO formatted time >>> dp.command_inout("ApplyPointingDelays", time_string)
- ConfigureIntegratedBeamData(argin)
Configure the transmission of integrated beam data.
Using the provided integration time, the first channel and the last channel. The data are sent continuously until the StopIntegratedData command is run.
- Parameters:
argin (
str) – json dictionary with optional keywords:
integration_time - (float) in seconds (default = 0.5)
first_channel - (int) default 0
last_channel - (int) default 191
- Return type:
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purpose only.
- Example:
>>> dp = tango.DeviceProxy("mccs/tile/01") >>> dict = {"integration_time": 0.2, "first_channel":0, "last_channel": 191} >>> jstr = json.dumps(dict) >>> dp.command_inout("ConfigureIntegratedBeamData", jstr)
- ConfigureIntegratedChannelData(argin)
Configure and start the transmission of integrated channel data.
Using the provided integration time, first channel and last channel. Data are sent continuously until the StopIntegratedData command is run.
- Parameters:
argin (
str) – json dictionary with optional keywords:
integration_time - (float) in seconds (default = 0.5)
first_channel - (int) default 0
last_channel - (int) default 511
- Return type:
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purpose only.
- Example:
>>> dp = tango.DeviceProxy("mccs/tile/01") >>> dict = {"integration_time": 0.2, "first_channel":0, "last_channel": 191} >>> jstr = json.dumps(dict) >>> dp.command_inout("ConfigureIntegratedChannelData", jstr)
- ConfigureTestGenerator(argin)
Set the test signal generator.
- Parameters:
argin (
str) – json dictionary with keywords:
- tone_frequency: first tone frequency, in Hz. The frequency
is rounded to the resolution of the generator. If this is not specified, the tone generator is disabled.
- tone_amplitude: peak tone amplitude, normalized to 31.875 ADC
units. The amplitude is rounded to 1/8 ADC unit. Default is 1.0. A value of -1.0 keeps the previously set value.
- tone_2_frequency: frequency for the second tone. Same
as ToneFrequency.
- tone_2_amplitude: peak tone amplitude for the second tone.
Same as ToneAmplitude.
- noise_amplitude: RMS amplitude of the pseudorandom Gaussian
white noise, normalized to 26.03 ADC units.
- pulse_frequency: frequency of the periodic pulse. A code
in the range 0 to 7, corresponding to (16, 12, 8, 6, 4, 3, 2) times the ADC frame frequency.
- pulse_amplitude: peak amplitude of the periodic pulse, normalized
to 127 ADC units. Default is 1.0. A value of -1.0 keeps the previously set value.
- set_time: time at which the generator is set, for synchronization
among different TPMs. In UTC ISO format (string)
- adc_channels: list of adc channels which will be substituted with
the generated signal. It is a 32 integer, with each bit representing an input channel. Default: all if at least q source is specified, none otherwises.
- Return type:
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purpose only.
- Example:
>>> dp = tango.DeviceProxy("mccs/tile/01") >>> dict = {"tone_frequency": 150e6, "tone_amplitude": 0.1, "noise_amplitude": 0.9, "pulse_frequency": 7, "set_time": "2022-08-09T12:34:56.7Z"} >>> jstr = json.dumps(dict) >>> values = dp.command_inout("ConfigureTestGenerator", jstr)
- class InitCommand(*args, **kwargs)
A class for
SpsStation’s Init command.The
do()method below is called uponSpsStation’s initialisation.- do(*args, **kwargs)
Initialise the
SpsStation.- Parameters:
- Return type:
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purpose only.
- Initialise()
Initialise the station.
- LoadCalibrationCoefficients(argin)
Load the calibration coefficients, but does not apply them.
This is performed by apply_calibration. The calibration coefficients may include any rotation matrix (e.g. the parallactic angle), but do not include the geometric delay.
antenna - (int) is the antenna to which the coefficients will be applied.
- calibration_coefficients - [array] a bidimensional complex array comprising
calibration_coefficients[channel, polarization], with each element representing a normalized coefficient, with (1.0, 0.0) being the normal, expected response for an ideal antenna.
- channel - (int) channel is the index specifying the channels at the
beamformer output, i.e. considering only those channels actually processed and beam assignments.
polarization index ranges from 0 to 3.
0: X polarization direct element
1: X->Y polarization cross element
2: Y->X polarization cross element
3: Y polarization direct element
- Return type:
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purpose only.
- Raises:
ValueError – if parameters are illegal or inconsistent
- Example:
>>> antenna = 2 >>> complex_coefficients = [[complex(3.4, 1.2), complex(2.3, 4.1), >>> complex(4.6, 8.2), complex(6.8, 2.4)]]*5 >>> inp = list(itertools.chain.from_iterable(complex_coefficients)) >>> out = ([v.real, v.imag] for v in inp] >>> coefficients = list(itertools.chain.from_iterable(out)) >>> coefficients.insert(0, float(antenna)) >>> input = list(itertools.chain.from_iterable(coefficients)) >>> dp = tango.DeviceProxy("mccs/tile/01") >>> dp.command_inout("LoadCalibrationCoefficients", input)
- LoadPointingDelays(argin)
Set the pointing delay parameters of this Station’s Tiles.
- Parameters:
argin (
list[float]) – an array containing a beam index followed by pairs of antenna delays + delay rates, delay in seconds and the delay rate in seconds/second- Return type:
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purpose only.
- Raises:
ValueError – if parameters are illegal or inconsistent
- Example:
>>> # example delays: 256 values from -32 to +32 ns, rates = 0 >>> delays = [step * 0.25e-9 for step in list(range(-128, 128))] >>> rates = [0.0]*256 >>> beam = 0.0 >>> dp = tango.DeviceProxy("mccs/station/01") >>> arg = [beam] >>> for i in range(256) >>> arg.append(delays[i]) >>> arg.append(rates[i]) >>> dp.command_inout("LoadPointingDelays", arg)
- RunTest(argin)
Run a self-check test and optional amount of times.
- Parameters:
argin (
str) – json-ified args, containing a required ‘test_name’, and optional ‘count’- Return type:
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purpose only.
- Example:
>>> dp = tango.DeviceProxy("low-mccs/spsstation/aavs3") >>> dp.RunTest(json.dumps({"test_name" : "my_test", "count" : 5}))
- SelfCheck()
Run all the self-check tests once.
- SendDataSamples(argin)
Transmit a snapshot containing raw antenna data.
- Parameters:
argin (
str) – json dictionary with optional keywords:
- data_type - type of snapshot data (mandatory): “raw”, “channel”,
“channel_continuous”, “narrowband”, “beam”
start_time - Time (UTC string) to start sending data. Default immediately
seconds - (float) Delay if timestamp is not specified. Default 0.2 seconds
Depending on the data type: raw:
- sync: bool: send synchronised samples for all antennas, vs. round robin
larger snapshot from each antenna
channel:
n_samples: Number of samples per channel, default 1024
first_channel - (int) first channel to send, default 0
last_channel - (int) last channel to send, default 511
channel_continuous
channel_id - (int) channel_id (Mandatory)
n_samples - (int) number of samples to send per packet, default 128
narrowband:
frequency - (int) Sky frequency for band centre, in Hz (Mandatory)
round_bits - (int) Specify whow many bits to round
n_samples - (int) number of spectra to send
- Return type:
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purpose only.
- Raises:
ValueError – if mandatory parameters are missing
- Example:
>>> dp = tango.DeviceProxy("mccs/tile/01") >>> dict = {"data_type": "raw", "Sync":True, "Seconds": 0.2} >>> jstr = json.dumps(dict) >>> dp.command_inout("SendDataSamples", jstr)
- SetBeamFormerRegions(argin)
Set the frequency regions which are going to be beamformed into each beam.
region_array is defined as a flattened 2D array, for a maximum of 48 regions. Total number of channels must be <= 384.
start_channel - (int) region starting channel, must be even in range 0 to 510
num_channels - (int) size of the region, must be a multiple of 8
beam_index - (int) beam used for this region with range 0 to 47
subarray_id - (int) Subarray
subarray_logical_channel - (int) logical channel # in the subarray
subarray_beam_id - (int) ID of the subarray beam
substation_id - (int) Substation
aperture_id: ID of the aperture (station*100+substation?)
- Return type:
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purpose only.
- Raises:
ValueError – if parameters are illegal or inconsistent
- Example:
>>> regions = [[4, 24, 0, 0, 0, 3, 1, 101], [26, 40, 1, 0, 24, 4, 2, 102]] >>> input = list(itertools.chain.from_iterable(regions)) >>> dp = tango.DeviceProxy("mccs/tile/01") >>> dp.command_inout("SetBeamFormerRegions", input)
- SetBeamFormerTable(argin)
Set the beamformer table which are going to be beamformed into each beam.
region_array is defined as a flattened 2D array, for a maximum of 48 entries. Each entry corresponds to 8 consecutive frequency channels. This is equivalent to SetBeamformerRegions, with a different way to specify the bandwidth of each spectral region. Input is consistent with the beamformerTable attribute
start_channel - (int) region starting channel, must be even in range 0 to 510
beam_index - (int) beam used for this region with range 0 to 47
subarray_id - (int) Subarray
subarray_logical_channel - (int) logical channel # in the subarray
subarray_beam_id - (int) ID of the subarray beam
substation_id - (int) Substation
aperture_id: ID of the aperture (station*100+substation?)
- Return type:
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purpose only.
- Raises:
ValueError – if parameters are illegal or inconsistent
- Example:
>>> regions = [[4, 0, 0, 0, 3, 1, 101], [26, 1, 0, 24, 4, 2, 102]] >>> input = list(itertools.chain.from_iterable(regions)) >>> dp = tango.DeviceProxy("mccs/station/01") >>> dp.command_inout("SetBeamFormerRegions", input)
- SetChanneliserRounding(channeliser_rounding)
Set the ChanneliserRounding to all Tiles in this Station.
Number of LS bits dropped in each channeliser frequency channel. Valid values 0-7 Same value applies to all antennas and polarizations
- Parameters:
channeliser_rounding (
ndarray) – list of 512 values, one per channel. this will apply to all Tiles in this station.- Return type:
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purpose only.
- Example:
>>> dp = tango.DeviceProxy("low-mccs/station/aavs3") >>> dp.command_inout("SetChanneliserRounding", np.array([2]*512))
- SetCspIngest(argin)
Configure link for beam data packets to CSP.
- Parameters:
argin (
str) –json dictionary with optional keywords:
destination_ip - (string) Destination IP
source_port - (int) Source port for integrated data streams
destination_port - (int) Destination port for integrated data streams
- Return type:
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purpose only.
- Example:
>>> dp = tango.DeviceProxy("mccs/tile/01") >>> dict = {"destination_ip"="10.0.1.23"} >>> jstr = json.dumps(dict) >>> dp.command_inout("SetCspIngest", jstr)
- SetLmcDownload(argin)
Specify whether control data will be transmitted over 1G or 40G networks.
- Parameters:
argin (
str) –json dictionary with optional keywords:
mode - (string) ‘1G’ or ‘10G’ (Mandatory) (use ‘10G’ for 40G also)
payload_length - (int) SPEAD payload length for channel data
destination_ip - (string) Destination IP.
source_port - (int) Source port for integrated data streams
destination_port - (int) Destination port for integrated data streams
- Return type:
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purpose only.
- Example:
>> dp = tango.DeviceProxy(“mccs/tile/01”) >> dict = {“mode”: “1G”, “payload_length”: 1024, “destination_ip”: “10.0.1.23”} >> jstr = json.dumps(dict) >> dp.command_inout(“SetLmcDownload”, jstr)
- SetLmcIntegratedDownload(argin)
Configure link and size for integrated data packets, for all tiles.
- Parameters:
argin (
str) –json dictionary with optional keywords:
mode - (string) ‘1G’ ‘10G’ ‘40G’ - default 40G
- channel_payload_length - (int) SPEAD payload length for integrated
channel data
beam_payload_length - (int) SPEAD payload length for integrated beam data
destination_ip - (string) Destination IP
source_port - (int) Source port for integrated data streams
destination_port - (int) Destination port for integrated data streams
- Return type:
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purpose only.
- Example:
>>> dp = tango.DeviceProxy("mccs/tile/01") >>> dict = {"mode": "1G", "channel_payload_length":4, "beam_payload_length": 1024, "destination_ip"="10.0.1.23"} >>> jstr = json.dumps(dict) >>> dp.command_inout("SetLmcIntegratedDownload", jstr)
- StartAcquisition(argin)
Start the acquisition synchronously for all tiles, checks for synchronisation.
- Parameters:
argin (
str) – Start acquisition time in ISO9601 format- Return type:
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purpose only.
- Example:
>>> dp = tango.DeviceProxy("mccs/station/001") >>> dp.command_inout("StartAcquisition", "20230101T12:34:55.000Z")
- StartBeamformer(argin)
Start the beamformer at the specified time delay.
- Parameters:
argin (
str) – json dictionary with optional keywords:
start_time - (str, ISO UTC time) start time
- duration - (int) if > 0 is a duration in seconds
if < 0 run forever
- subarray_beam_id - (int)Subarray beam ID of the channels to be started
Command affects only beamformed channels for given subarray ID Default -1: all channels
scan_id - (int) The unique ID for the started scan. Default 0
- Return type:
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purpose only.
- Example:
>>> dp = tango.DeviceProxy("mccs/tile/01") >>> dict = {"StartTime": "2022-01-02T34:56:08.987Z", "Duration": 30.0} >>> jstr = json.dumps(dict) >>> dp.command_inout("StartBeamformer", jstr)
- StopBeamformer()
Stop the beamformer.
- Return type:
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purpose only.
- Example:
>>> dp = tango.DeviceProxy("mccs/tile/01") >>> dp.command_inout("StopBeamformer")
- StopDataTransmission()
Stop data transmission from board.
- Return type:
- Returns:
A tuple containing a return code and a string message indicating status. The message is for information purpose only.
- Example:
>>> dp = tango.DeviceProxy("mccs/tile/01") >>> dp.command_inout("StopDataTransmission")
- StopIntegratedData()
Stop the integrated data.
- TriggerAdcEqualisation()
Get the equalised ADC values.
Getting the equalised values takes up to 20 seconds (to get an average to avoid spikes). So we trigger the collection and publish to dbmPowers
- UpdateStaticDelays()
Update static delays from TelModel.
- __init__(*args, **kwargs)
Initialise this device object.
- adcPower()
Get the ADC RMS input levels for all input signals.
Returns an array of 2 values (X and Y polarizations) per antenna, 32 per tile, 512 per station
- antennaInfo()
Return antenna information.
- Returns a json string representing a dictionary coded
by antenna number and presenting that antenna’s station_id, tile_id and location information.
- Return type:
- Returns:
json string containing antenna information.
- antennasMapping()
Return the mappings of the antennas.
- Returns a mapping of antenna number to
TPM port number.
- Return type:
- Returns:
json string containing antenna mappings
- beamformerTable()
Get beamformer region table.
Bidimensional array of one row for each 8 channels, with elements: 0. start physical channel 1. beam number 2. subarray ID 3. subarray_logical_channel 4. subarray_beam_id 5. substation_id 6. aperture_id
Each row is a set of 7 consecutive elements in the list.
- boardTemperaturesSummary()
Get summary of board temperatures (minimum, average, maximum).
- channeliserRounding()
Channeliser rounding.
Number of LS bits dropped in each channeliser frequency channel. Valid values 0-7 Same value applies to all antennas and polarizations
- Return type:
- Returns:
A list of 512 values for every tile, one per channel.
- clockPresentSummary()
Get summary of clock present status for all tiles.
- Return type:
- Returns:
True if 10 MHz clock signal is present in all tiles
- create_component_manager()
Create and return a component manager for this device.
- Return type:
- Returns:
a component manager for this device.
- cspIngestAddress()
Get CSP ingest IP address.
CSP ingest address and port are set by the SetCspIngest command
- Return type:
- Returns:
IP net address for CSP ingest port
- cspIngestPort()
Get CSP ingest port.
CSP ingest address and port are set by the SetCspIngest command
- Return type:
- Returns:
UDP port for the CSP ingest port
- cspRounding(rounding)
Set CSP formatter rounding.
- cspSourcePort()
Get CSP source port.
CSP source port is set by the SetCspIngest command
- Return type:
- Returns:
UDP port for the CSP source port
- daqTRL(value)
Set the Tango Resource Locator for this SpsStation’s DAQ instance.
- fortyGbNetworkAddress()
Get 40Gb network address for this station.
- Return type:
- Returns:
IP subnet address
- fortyGbNetworkErrors()
Get number of network errors for all 40 Gb interfaces.
- fpgaTemperaturesSummary()
Get summary of FPGA temperatures (minimum, average, maximum).
- healthModelParams(argin)
Set the params for health transition rules.
- init_device()
Initialise the device.
This is overridden here to change the Tango serialisation model.
- Return type:
- isBeamformerRunning()
Get the state of the test generator.
- Return type:
- Returns:
true if the test generator is active in at least one tile
- isCalibrated()
Return a flag indicating whether this station is currently calibrated or not.
- Return type:
- Returns:
a flag indicating whether this station is currently calibrated or not.
- isConfigured()
Return a flag indicating whether this station is currently configured or not.
- Return type:
- Returns:
a flag indicating whether this station is currently configured or not.
- isProgrammed()
Return a flag indicating whether of not the TPM boards are programmed.
Attribute is False if at least one TPM is not programmed.
- Return type:
- Returns:
whether of not the TPM boards are programmed
- is_On_allowed()
Check if command On is allowed in the current device state.
- Return type:
- Returns:
Trueif the command is allowed
- is_Standby_allowed()
Check if command Standby is allowed in the current device state.
- Return type:
- Returns:
Trueif the command is allowed
- pllLockedSummary()
Get summary of PLL locked status for all tiles.
- Return type:
- Returns:
True if PLL is locked to reference in all tiles
- ppsDelayCorrections(delays)
Set PPS delay correction, one per tile.
Note: this will be set in the next initialisation.
- ppsDelaySummary()
Get summary of PPS delay (minimum, average, maximum).
- ppsDelays()
Get PPS delay correction, one per tile.
- ppsPresentSummary()
Get summary of PPS present status for all tiles.
- Return type:
- Returns:
True if PPS signal is present in all tiles
- preaduLevels(levels)
Set attenuator level of preADU channels, one per input channel.
- staticTimeDelays(delays)
Set static time delay.
- sysrefPresentSummary()
Get summary of sysrf present status for all tiles.
- Return type:
- Returns:
True if SYSREF signal is present in all tiles
- testGeneratorActive()
Get the state of the test generator.
- Return type:
- Returns:
true if the test generator is active in at least one tile
- testList()
Get the list of self-check tests available.
- testLogs()
Get logs of the most recently run self-check test.
- Return type:
- Returns:
the logs of the most recently run self-check test.
- testReport()
Get the report for the most recently run self-check test set.
- Return type:
- Returns:
the report for the most recently run self-check test set.
- tileProgrammingState()
Get the tile programming state.
- xPolBandpass()
Read the last bandpass plot data for the x-polarisation.
- Return type:
- Returns:
The last block of x-polarised bandpass data.