FspPstSubarray Class

class ska_mid_cbf_mcs.fsp.fsp_pst_subarray_device.FspPstSubarray(cl, name)[source]

Bases: CspSubElementObsDevice

FspPstSubarray TANGO device class for the FspPstSubarray prototype

SubID: TANGO property

FspID: TANGO property

CbfControllerAddress: TANGO property

CbfSubarrayAddress: TANGO property

VCC: TANGO property

outputEnable: Enable/disable transmission of output products.

receptors: List of receptors assigned to the subarray.

timingBeams: List of timing beams assigned to FSP PST Subarray.

timingBeamID: Identifiers of timing beams assigned to FSP PST Subarray

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

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

Bases: InitCommand

A class for the FspPstSubarray’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)

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

create_component_manager() → FspPstSubarrayComponentManager[source]

Create and return a component manager for this device.

Returns:: a component manager for this device.

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

read_outputEnable() → bool[source]

Read the outputEnable attribute. Used to enable/disable transmission of the output products.

Returns:: the outputEnable attribute.
Return type:: bool

read_receptors() → List[int][source]

Read the receptors attribute.

Returns:: the list of receptors.
Return type:: List[int]

write_receptors(value: List[int]) → None[source]

Write the receptors attribute.

Parameters:: value – the receptors attribute value.

read_timingBeams() → List[str][source]

Read the timingBeams attribute.

Returns:: the timingBeams attribute.
Return type:: List[int]

read_timingBeamID() → List[int][source]

Read the list of Timing Beam IDs.

Returns:: the timingBeamID attribute.
Return type:: List[int]

read_scanID() → int[source]

Read the scanID attribute.

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

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

Write the scanID attribute.

Parameters:: value – the scanID attribute value.

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

Bases: OnCommand

A class for the FspPstSubarray’s On() command.

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

Stateless hook for On() 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 OffCommand(target, op_state_model, logger=None)[source]

Bases: OffCommand

A class for the FspPstSubarray’s Off() command.

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

Stateless hook for Off() 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 StandbyCommand(target, op_state_model, logger=None)[source]

Bases: StandbyCommand

A class for the FspPstSubarray’s Standby() command.

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

Stateless hook for Standby() 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 ConfigureScanCommand(target, op_state_model, obs_state_model, logger=None)[source]

Bases: ConfigureScanCommand

A class for the FspPstSubarray’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: str) → Tuple[ResultCode, str][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 FspPstSubarray’s Scan() command.

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

Stateless hook for Scan() command functionality.

Parameters:: argin (int) – 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)
Raises:: CommandError if the configuration data validation fails.

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 FspPstSubarray’s EndScan() command.

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

Stateless hook for Scan() 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)
Raises:: CommandError if the configuration data validation fails.

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

Bases: GoToIdleCommand

A class for the FspPstSubarray’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 AbortCommand(target, op_state_model, obs_state_model, logger=None)[source]

Bases: AbortCommand

A class for FspPstSubarray’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)

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 FspPstSubarrayClass

TangoClassName = 'FspPstSubarray'

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.

scanID: Device attribute.

sdpDestinationAddresses: Device attribute.

sdpLinkActive: Device attribute.

sdpLinkCapacity: Device attribute.

simulationMode: Device attribute.

testMode: Device attribute.

versionId: Device attribute.