FHS VCC Commands

Ref: FHS VCC Commands

Name

Input Type

Input Parameter

Allowed in modes

Description

ConfigureScan()

JSON String

See below.

IDLE, READY

Configure parameters for the next scan(s). Parameters are propagated down to low-level device servers. Sets the state to CONFIGURING, if the inputted JSON can be successfully parsed the state is set to READY.

Scan()

String

The identifier of the current scan

READY

Start the scan using the last set of parameters passed via the ConfigureScan() command. The state is then set to SCANNING.

If Transient Buffer Capture (TBC) is configured, scan will begin buffering of FS packets dependent on the number of configured search windows.

GoToIdle()

void

n/a

READY

Resets the device and changes the state to IDLE

Abort()

void

n/a

IDLE, READY, SCANNING

Sets the device state to ABORTED and aborts all running/queued commands

EndScan()

void

n/a

SCANNING

Completes the scan and changes the device back to the READY state.

If Transient Buffer Capture is configured, ending the scan will stop buffering packets and clear the applicable buffers.

ObsReset()

void

n/a

ABORTED, FAULT

Reset the observing device from a FAULT/ABORTED obsState to IDLE. Initially sets the state to RESETTING, resets the configuration of the device to the default and then sets the state to IDLE on completion.

AutoSetFilterGain()

Scalar

Requested RFI headroom.

SCANNING

This command triggers the algorithm to determine and adjust filter gains and levels and takes as input the optional parameter Headroom.

AutoSetTBCGain()

Scalar

Dwell Time

SCANNING

This command triggers algorithm that measures and adjusts Transient Buffer Capture (TBC) re-quantizer gain settings to provide optimal sensitivity. ‘Dwell time” specifies how long to integrate to determine the quantizer gain settings (seconds). 

Applies gain corrections on fine channels.

UpdateSubarrayMembership()

int

Subarray ID

Command to update the current subarray membership of the VCC. If the VCC is not currently assigned to a subarray, i.e. its subarray_id attribute is 0, then its membership is updated and the subarray_id attribute is set appropriately. Otherwise, if the current subarray_id > 0, indicating the VCC has already been assigned to a differing subarray, then the command is REJECTED.

The VCC’s subarray membership can also be cleared using this command, by providing a subarray ID of 0.

OffloadTransientDataCapture()

Timestamp

Starting epoch to begin transient data capture

SCANNING

Command which triggers the offload of transient data for the given VCC. Data is offloaded relative to the start time of the capture and the duration configured within the scan. On command execution, writing to the transient buffer is locked, and it is iterated over to construct a capture, starting at the provided start time and lasting for the provided duration, before it is transmitted over the 400GbE to SDP.

UpdateDelayModels()

JSON string

See below.

READY, SCANNING

Update delay tracking with new High order delay models required for PSS processing.

GetBandpassCorrectionCoefficients()

int

Optional - Index for a frequency band {1-6}

N/A

Returns a 2-Dimensional list of previously set auto-set gains. 

- Valid band index provided - Returns a 2-Dim arr with at index 0 the gains applied for the given band
- Valid band index provided with no prior scan for that band - Returns an empty list
- No index provided - Returns a 2-Dim arr of format [i → frequency band, j → gain value for channel i, pol % 2]

UpdateJonesMatrix()

(TBD)

Placeholder: Applies updates to Jones Matrix polarization correction for fine channels.