VccComponentManager Class

class ska_mid_cbf_mcs.vcc.vcc_component_manager.VccComponentManager(*args: Any, **kwargs: Any)[source]

Bases: CbfComponentManager, CspObsComponentManager

Component manager for Vcc class.

property config_id: str

Configuration ID

Returns:: the configuration ID

property scan_id: int

Scan ID

Returns:: the scan ID

property dish_id: str

DISH ID

Returns:: the DISH ID

property frequency_band: int

Frequency Band

Returns:: the frequency band as the integer index in an array of frequency band labels: [“1”, “2”, “3”, “4”, “5a”, “5b”]

property stream_tuning: List[float]

Band 5 Stream Tuning

Returns:: the band 5 stream tuning

property frequency_band_offset_stream1: int

Frequency Band Offset Stream 1

Returns:: the frequency band offset for stream 1

property frequency_band_offset_stream2: int

Frequency Band Offset Stream 2

Returns:: the frequency band offset for stream 2, this is only use when band 5 is active

property rfi_flagging_mask: str

RFI Flagging Mask

Returns:: the RFI flagging mask

property jones_matrix: str

Jones Matrix

Returns:: the last received Jones matrix

property delay_model: str

Delay Model

Returns:: the last received delay model

property doppler_phase_correction: List[float]

Doppler Phase Correction

Returns:: the last received Doppler phase correction array

property simulation_mode: SimulationMode

Get the simulation mode of the component manager.

Returns:: simulation mode of the component manager

start_communicating() → None[source]: Establish communication with the component, then start monitoring.

stop_communicating() → None[source]: Stop communication with the component.

on() → Tuple[ResultCode, str][source]

Turn on VCC component. This attempts to establish communication with the VCC devices on the HPS.

Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)
Raises:: ConnectionError – if unable to connect to HPS VCC devices

off() → Tuple[ResultCode, str][source]

Turn off VCC component; currently unimplemented.

Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

standby() → Tuple[ResultCode, str][source]

Turn VCC component to standby; currently unimplemented.

Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

configure_band(argin: str) → Tuple[ResultCode, str][source]

Configure the corresponding band. At the HPS level, this reconfigures the FPGA to the correct bitstream and enables the respective band device. All other band devices are disabled.

Parameters:: argin – the frequency band name
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

deconfigure() → None[source]: Deconfigure scan configuration parameters.

configure_scan(argin: str) → Tuple[ResultCode, str][source]

Execute configure scan operation.

Parameters:: argin – JSON string with the configure scan parameters
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

scan(scan_id: int) → Tuple[ResultCode, str][source]

Begin scan operation.

Parameters:: argin – scan ID integer
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

end_scan() → Tuple[ResultCode, str][source]

End scan operation.

Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

abort()[source]: Tell the current VCC band device to abort whatever it was doing.

obsreset()[source]: Reset the configuration.

configure_search_window(argin: str) → Tuple[ResultCode, str][source]

Configure a search window by sending parameters from the input(JSON) to SearchWindow self. This function is called by the subarray after the configuration has already been validated, so the checks here have been removed to reduce overhead.

Parameters:: argin – JSON string with the search window parameters
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

update_doppler_phase_correction(argin: str) → None[source]

Update Vcc’s doppler phase correction

Parameters:: argin – the doppler phase correction JSON string

update_delay_model(argin: str) → None[source]

Update Vcc’s delay model

Parameters:: argin – the delay model JSON string

update_jones_matrix(argin: str) → None[source]

Update Vcc’s jones matrix

Parameters:: argin – the jones matrix JSON string