FspPssSubarray Class
- class ska_mid_cbf_mcs.fsp.fsp_pss_subarray_device.FspPssSubarray(cl, name)[source]
Bases:
CspSubElementObsDevice
FspPssSubarray TANGO device class for the FspPssSubarray prototype
- SubID
TANGO property
- FspID
TANGO property
- CbfControllerAddress
FQDN of CBF Controller
- CbfSubarrayAddress
FQDN of CBF Subarray
- VCC
TANGO property
- vccIDs
List of VCCs used for PSS beamforming
- searchBeams
List of searchBeams assigned to fspsubarray
- searchWindowID
Identifier of the Search Window to be used as input for beamforming on this FSP.
- searchBeamID
Identifier of the Search Window to be used as input for beamforming on this FSP.
- outputEnable
Enable/disable transmission of output products.
- class InitCommand(target, op_state_model, logger=None)[source]
Bases:
InitCommand
A class for the FspPssSubarray’s init_device() “command”.
- create_component_manager() FspPssSubarrayComponentManager [source]
Create and return a component manager for this device.
- Returns:
a component manager for this device.
- read_vccIDs() List[int] [source]
Read the vccIDs attribute; FSP deals with VCC, not DISH (receptor) IDs.
- Returns:
the list of assigned VCC IDs
- Return type:
List[int]
- read_searchBeams() List[str] [source]
Read the searchBeams attribute.
- Returns:
the searchBeams attribute.
- Return type:
List[str]
- read_searchBeamID() List[int] [source]
Read the searchBeamID attribute.
- Returns:
the searchBeamID attribute.
- Return type:
List[int]
- read_searchWindowID() List[int] [source]
Read the searchWindowID attribute.
- Returns:
the searchWindowID attribute.
- Return type:
List[int]
- read_outputEnable() bool [source]
Read the outputEnable attribute. Used to enable/disable transmission of the output products.
- Returns:
the outputEnable attribute.
- Return type:
- write_scanID(value: int) None [source]
Write the scanID attribute.
- Parameters:
value – the scanID attribute value.
- read_configID() str [source]
Read the configID attribute.
- Returns:
the configID attribute.
- Return type:
- write_configID(value: str) None [source]
Write the configID attribute.
- Parameters:
value – the configID attribute value.
- class OnCommand(target, op_state_model, logger=None)[source]
Bases:
OnCommand
A class for the FspPssSubarray’s On() command.
- class OffCommand(target, op_state_model, logger=None)[source]
Bases:
OffCommand
A class for the FspPssSubarray’s Off() command.
- class StandbyCommand(target, op_state_model, logger=None)[source]
Bases:
StandbyCommand
A class for the FspPssSubarray’s Standby() command.
- class ConfigureScanCommand(target, op_state_model, obs_state_model, logger=None)[source]
Bases:
ConfigureScanCommand
A class for the FspPssSubarray’s ConfigureScan() command.
- do(argin: str) Tuple[ResultCode, str] [source]
Stateless hook for ConfigureScan() command functionality.
- 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 FspPssSubarray’s Scan() command.
- 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 FspPssSubarray’s Scan() 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 FspPssSubarray’s GoToIdle command.
- class ObsResetCommand(target, op_state_model, obs_state_model, logger=None)[source]
Bases:
ObsResetCommand
A class for FSPPssSubarray’s ObsReset() command.
- class AbortCommand(target, op_state_model, obs_state_model, logger=None)[source]
Bases:
AbortCommand
A class for FspPssSubarray’s Abort() command.
- 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
andsubgroups
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
andsubgroups
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
FspPssSubarrayClass
- TangoClassName = 'FspPssSubarray'
- 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.