VCC Class

class ska_mid_cbf_mcs.vcc.vcc_device.Vcc(cl, name)[source]

Bases: CspSubElementObsDevice

Vcc TANGO device class for the prototype

VccID: TANGO property

TalonLRUAddress: TANGO property

VccControllerAddress: TANGO property

Band1And2Address: TANGO property

Band3Address: TANGO property

Band4Address: TANGO property

Band5Address: TANGO property

SW1Address: TANGO property

SW2Address: TANGO property

dishID: DISH ID

subarrayMembership: Subarray membership

frequencyBand: Frequency band; an int in the range [0, 5]

band5Tuning: Stream tuning (GHz)

frequencyBandOffsetStream1: Frequency band offset (stream 1) (Hz)

frequencyBandOffsetStream2: Frequency band offset (stream 2) (Hz)

dopplerPhaseCorrection: Doppler phase correction coefficients

rfiFlaggingMask: RFI Flagging Mask

delayModel: Delay model coefficients, given per frequency slice

jonesMatrix: Jones Matrix elements, given per frequency slice

scanID: Device attribute.

configID: config ID

simulationMode: Device attribute.

init_command_objects() → None[source]: Sets up the command objects

create_component_manager() → VccComponentManager[source]: Create and return the component manager for this device.

always_executed_hook() → None[source]: Hook to be executed before any commands.

delete_device() → None[source]: Hook to delete device.

write_simulationMode(value: SimulationMode) → None[source]

Set the simulation mode of the device.

Parameters:: value – SimulationMode

read_dishID() → str[source]

Read the dishID attribute.

Returns:: the Vcc’s DISH ID.
Return type:: str

write_dishID(value: str) → None[source]

Write the dishID attribute.

Parameters:: value – the dishID value.

read_subarrayMembership() → int[source]

Read the subarrayMembership attribute.

Returns:: the subarray membership (0 = no affiliation).
Return type:: int

write_subarrayMembership(value: int) → None[source]

Write the subarrayMembership attribute.

Parameters:: value – the subarray membership value (0 = no affiliation).

read_frequencyBand() → tango.DevEnum[source]

Read the frequencyBand attribute.

Returns:: the frequency band (being observed by the current scan, one of [“1”, “2”, “3”, “4”, “5a”, “5b”]).
Return type:: tango.DevEnum

read_band5Tuning() → List[float][source]

Read the band5Tuning attribute.

Returns:: the band5Tuning attribute (stream tuning (GHz)).
Return type:: list of float

read_frequencyBandOffsetStream1() → int[source]

Read the frequencyBandOffsetStream1 attribute.

Returns:: the frequencyBandOffsetStream1 attribute.
Return type:: int

read_frequencyBandOffsetStream2() → int[source]

Read the frequencyBandOffsetStream2 attribute.

Returns:: the frequencyBandOffsetStream2 attribute.
Return type:: int

read_dopplerPhaseCorrection() → List[float][source]

Read the dopplerPhaseCorrection attribute.

Returns:: the dopplerPhaseCorrection attribute.
Return type:: list of float

write_dopplerPhaseCorrection(value: List[float]) → None[source]

Write the dopplerPhaseCorrection attribute.

Parameters:: value – the dopplerPhaseCorrection attribute value.

read_rfiFlaggingMask() → str[source]

Read the rfiFlaggingMask attribute.

Returns:: the rfiFlaggingMask attribute.
Return type:: str/JSON

read_delayModel() → str[source]

Read the delayModel attribute.

Returns:: the delayModel attribute (delay model coefficients, :return: the delayModel attribute (delay model coefficients,
Returns:: the delayModel attribute (delay model coefficients, given per frequency slice).
Return type:: list of list of float

read_jonesMatrix() → str[source]

Read the jonesMatrix attribute.

Returns:: the jonesMatrix attribute (jones matrix values, given per frequency slice).
Return type:: str

read_scanID() → int[source]

Read the scanID attribute.

Returns:: the scanID attribute.
Return type:: int

read_configID() → str[source]

Read the configID attribute.

Returns:: the configID attribute.
Return type:: str

class InitCommand(target, op_state_model, logger=None)[source]

Bases: InitCommand

A class for the Vcc’s init_device() “command”.

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

Stateless hook for device initialisation.

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

class OnCommand(target, op_state_model, logger=None)[source]

Bases: OnCommand

A class for the Vcc’s on command.

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

Stateless hook for device initialisation.

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

class OffCommand(target, op_state_model, logger=None)[source]

Bases: OffCommand

A class for the Vcc’s off command.

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

Stateless hook for device initialisation.

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

class StandbyCommand(target, op_state_model, logger=None)[source]

Bases: StandbyCommand

A class for the Vcc’s standby command.

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

Stateless hook for device initialisation.

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

class ConfigureBandCommand(target, *args, logger=None, **kwargs)[source]

Bases: ResponseCommand

A class for the Vcc’s ConfigureBand() command.

Turn on the corresponding band device and disable all the others.

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

Stateless hook for ConfigureBand() command functionality.

Parameters:: freq_band_name – 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)

ConfigureBand(band_config: str) → Tuple[ResultCode, str][source]

Turn on the corresponding band device and disable all the others.

Parameters:: band_config – json string containing: the frequency band name, dish sample rate, and number of samples per frame
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

class ConfigureScanCommand(target, op_state_model, obs_state_model, logger=None)[source]

Bases: ConfigureScanCommand

A class for the Vcc’s ConfigureScan() command.

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

Stateless hook for ConfigureScan() command functionality.

Parameters:: argin (str) – The configuration as JSON formatted string
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:: CommandError if the configuration data validation fails.

validate_input(argin: str) → Tuple[bool, str][source]

Validate the configuration parameters against allowed values, as needed.

Parameters:: argin – The JSON formatted string with configuration for the device. :type argin: ‘DevString’
Returns:: A tuple containing a boolean and a string message.
Return type:: (bool, str)

ConfigureScan(argin)[source]

Configure the observing device parameters for the current scan.

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

class ScanCommand(target, op_state_model, obs_state_model, logger=None)[source]

Bases: ScanCommand

A class for the Vcc’s Scan() command.

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

Stateless hook for Scan() command functionality.

Parameters:: argin (int) – The scan ID as JSON formatted string
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(argin)[source]

Start an observing scan.

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

class EndScanCommand(target, op_state_model, obs_state_model, logger=None)[source]

Bases: EndScanCommand

A class for the Vcc’s EndScan() command.

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

Stateless hook for EndScan() command functionality.

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

class ObsResetCommand(target, op_state_model, obs_state_model, logger=None)[source]

Bases: ObsResetCommand

A class for the VCC’s ObsReset command.

do()[source]

Stateless hook for ObsReset() command functionality.

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

class AbortCommand(target, op_state_model, obs_state_model, logger=None)[source]

Bases: AbortCommand

A class for the VCC’s Abort command.

do()[source]

Stateless hook for Abort() command functionality.

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

class GoToIdleCommand(target, op_state_model, obs_state_model, logger=None)[source]

Bases: GoToIdleCommand

A class for the Vcc’s GoToIdle command.

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

Stateless hook for GoToIdle() command functionality.

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

class UpdateDopplerPhaseCorrectionCommand(target, *args, logger=None, **kwargs)[source]

Bases: BaseCommand

A class for the Vcc’s UpdateDopplerPhaseCorrection() command.

Update Vcc’s doppler phase correction.

is_allowed() → bool[source]

Determine if UpdateDopplerPhaseCorrection is allowed (allowed when Devstate is ON and ObsState is READY OR SCANNING).

Returns:: if UpdateDopplerPhaseCorrection is allowed
Return type:: bool

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

Stateless hook for UpdateDopplerPhaseCorrection() command functionality.

Parameters:: argin – the doppler phase correction JSON

UpdateDopplerPhaseCorrection(argin: str)[source]: Update Vcc’s doppler phase correction.

class UpdateDelayModelCommand(target, *args, logger=None, **kwargs)[source]

Bases: BaseCommand

A class for the Vcc’s UpdateDelayModel() command.

Update Vcc’s delay model.

is_allowed() → bool[source]

Determine if UpdateDelayModel is allowed (allowed when Devstate is ON and ObsState is READY OR SCANNING).

Returns:: if UpdateDelayModel is allowed
Return type:: bool

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

Stateless hook for UpdateDelayModel() command functionality.

Parameters:: argin – the delay model JSON

UpdateDelayModel(argin: str)[source]: Update Vcc’s delay model.

class UpdateJonesMatrixCommand(target, *args, logger=None, **kwargs)[source]

Bases: BaseCommand

A class for the Vcc’s UpdateJonesMatrix() command.

Update Vcc’s Jones matrix.

is_allowed() → bool[source]

Determine if UpdateJonesMatrix is allowed (allowed when Devstate is ON and ObsState is READY OR SCANNING).

Returns:: if UpdateJonesMatrix is allowed
Return type:: bool

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

Stateless hook for UpdateJonesMatrix() command functionality.

Parameters:: argin – the Jones Matrix JSON

UpdateJonesMatrix(argin: str)[source]: Update Vcc’s Jones matrix.

class ConfigureSearchWindowCommand(target, *args, logger=None, **kwargs)[source]

Bases: ResponseCommand

A class for the Vcc’s ConfigureSearchWindow() command.

Configure a search window by sending parameters from the input(JSON) to SearchWindow device. This function is called by the subarray after the configuration has already been validated.

is_allowed() → bool[source]

Determine if ConfigureSearchWindow is allowed (allowed if DevState is ON and ObsState is CONFIGURING)

Returns:: if ConfigureSearchWindow is allowed
Return type:: bool

validate_input(argin: str) → Tuple[bool, str][source]

Validate a search window configuration

Parameters:: argin – JSON object with the search window parameters

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

Stateless hook for ConfigureSearchWindow() command functionality.

Parameters:: argin – JSON object 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)

ConfigureSearchWindow(argin)[source]

Configure the observing device parameters for a search window.

Parameters:: argin ('DevString') – JSON formatted string with the search window configuration.
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()

Abort the current observing process and move the device to ABORTED obsState.

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

DebugDevice()

Enable remote debugging of this device.

To modify behaviour for this command, modify the do() method of the command class: DebugDeviceCommand.

DeviceID: TANGO property

EndScan()

End a running scan.

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

GetVersionInfo()

Return the version information of the device.

To modify behaviour for this command, modify the do() method of the command class.

Returns:: Version details of the device.

GoToIdle()

Transit the device from READY to IDLE obsState.

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

GroupDefinitions

Device property.

Each string in the list is a JSON serialised dict defining the group_name, devices and subgroups in the group. A Tango Group object is created for each item in the list, according to the hierarchy defined. This provides easy access to the managed devices in bulk, or individually.

The general format of the list is as follows, with optional devices and subgroups keys:

[ {"group_name": "<name>",
   "devices": ["<dev name>", ...]},
  {"group_name": "<name>",
   "devices": ["<dev name>", "<dev name>", ...],
   "subgroups" : [{<nested group>},
                    {<nested group>}, ...]},
  ...
  ]

For example, a hierarchy of racks, servers and switches:

[ {"group_name": "servers",
   "devices": ["elt/server/1", "elt/server/2",
                 "elt/server/3", "elt/server/4"]},
  {"group_name": "switches",
   "devices": ["elt/switch/A", "elt/switch/B"]},
  {"group_name": "pdus",
   "devices": ["elt/pdu/rackA", "elt/pdu/rackB"]},
  {"group_name": "racks",
   "subgroups": [
        {"group_name": "rackA",
         "devices": ["elt/server/1", "elt/server/2",
                       "elt/switch/A", "elt/pdu/rackA"]},
        {"group_name": "rackB",
         "devices": ["elt/server/3", "elt/server/4",
                       "elt/switch/B", "elt/pdu/rackB"],
         "subgroups": []}
   ]} ]

LoggingLevelDefault

Device property.

Default logging level at device startup. See LoggingLevel

LoggingTargetsDefault

Device property.

Default logging targets at device startup. See the project readme for details.

ObsReset()

Reset the observing device from a FAULT/ABORTED obsState to IDLE.

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

Off()

Turn the device off.

To modify behaviour for this command, modify the do() method of the command class.

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

On()

Turn device on.

To modify behaviour for this command, modify the do() method of the command class.

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

Reset()

Reset the device from the FAULT state.

To modify behaviour for this command, modify the do() method of the command class.

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

SkaLevel

Device property.

Indication of importance of the device in the SKA hierarchy to support drill-down navigation: 1..6, with 1 highest.

Standby()

Put the device into standby mode.

To modify behaviour for this command, modify the do() method of the command class.

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

TangoClassClass: alias of VccClass

TangoClassName = 'Vcc'

adminMode: Device attribute.

buildState: Device attribute.

configurationDelayExpected: Device attribute.

configurationID: Device attribute.

configurationProgress: Device attribute.

controlMode: Device attribute.

deviceID: Device attribute.

healthFailureMessage: Device attribute.

healthState: Device attribute.

lastScanConfiguration: Device attribute.

loggingLevel

Device attribute.

See LoggingLevel

loggingTargets: Device attribute.

obsMode: Device attribute.

obsState: Device attribute.

sdpDestinationAddresses: Device attribute.

sdpLinkActive: Device attribute.

sdpLinkCapacity: Device attribute.

testMode: Device attribute.

versionId: Device attribute.