CspMaster Class Documentation¶
CspMaster Tango device prototype
CSPMaster TANGO device class for the CSPMaster prototype
-
class
CspMaster.
CspMaster
(*args, **kwargs)¶ Bases:
sphinx.ext.autodoc.importer._MockObject
CSPMaster TANGO device class for the CSPMaster prototype
-
CspMidCbf
¶ Device property
The CspMidCbf FQDN.
Type: DevString
-
CspMidPss
¶ Device property
The CspMidPss FQDN.
Type: DevString
-
CspMidPst
¶ Device property
The CspMidPst FQDN.
Type: DevString
-
CspSubarrays
¶ Device property
The CspSubarrays FQDN.
Type: array of DevString
-
SearchBeams
¶ Device property
The CSP Search Beam Capabilities FQDNs.
Type: array of DevString
-
TimingBeams
¶ Device property
The CSP Timing Beam Capabilities FQDNs.
Type: array DevString
-
VlbiBeams
¶ Device property
The CSP Vlbi Beam Capabilities FQDNs.
Type: array of DevString
-
CspTelState
¶ Device property
The CSP TelStatem FQDN.
Type: DevString
-
adminMode
¶ Class attribute
The device admininistrative mode.
Note
This attribute is defined in SKABaseDevice Class from which CspMaster class inherits. To override the attribute write method, the adminMode attribute is added again (“overload” button enabled in POGO).
-
commandProgress
¶ Class attribute
Percentage progress implemented for commands that result in state/mode transitions for a large number of components and/or are executed in stages (e.g power up, power down)
Type: DevUShort
-
cspCbfState
¶ Class attribute
The CbfMaster State attribute value.
Type: DevState
-
cspPssState
¶ Class attribute
The PssMaster State attribute value.
Type: DevState
-
cspPstState
¶ Class attribute
The PstMaster State attribute value.
Type: DevState
-
cspCbfHealthState
¶ Class attribute
The CbfMaster healthState attribute value.
Type: DevUShort
-
cspPssHealthState
¶ Class attribute
The PssMaster healthState attribute value.
Type: DevUShort
-
cspPstHealthState
¶ Class attribute
The PstMaster healthState attribute value.
Type: DevUShort
-
cbfMasterAddress
¶ Class attribute
The CbfMaster FQDN.
Type: DevString
-
pssMasterAddress
¶ Class attribute
The PssMaster FQDN.
Type: DevString
-
pstMasterAddress
¶ Class attribute
The PstMaster FQDN.
Type: DevString
-
cbfAdminMode
¶ Class attribute
The CbfMaster adminMode attribute value.
Type: DevUShort
-
pssAdminMode
¶ Class attribute
The PssMaster adminMode attribute value.
Type: DevUShort
-
pstAdminMode
¶ Class attribute
The PstMaster adminMode attribute value.
Type: DevUShort
-
availableCapabilities
¶ Class attribute
The list of available instances of each capability type.
Note
This attribute is defined in SKAMaster Class from which CspMaster class inherits. To override the attribute read method, the availableCapabilities attribute is added again (“overload” button enabled in POGO).
-
reportSearchBeamState
¶ Class attribute
The State attribute value of the CSP SearchBeam Capabilities.
Type: array of DevState.
-
reportSearchBeamHealthState
¶ Class attribute
The healthState attribute value of the CSP SearchBeam Capabilities.
Type: array of DevUShort.
-
reportSearchBeamAdminMode
¶ Class attribute
The adminMode attribute value of the CSP SearchBeam Capabilities.
Type: array of DevUShort.
-
reportTimingBeamState
¶ Class attribute
The State attribute value of the CSP TimingBeam Capabilities.
Type: array of DevState.
-
reportTimingBeamHealthState
¶ Class attribute
The healthState attribute value of the CSP TimingBeam Capabilities.
Type: array of DevUShort.
-
reportTimingBeamAdminMode
¶ Class attribute
The adminMode attribute value of the CSP TimingBeam Capabilities.
Type: array of DevUShort.
-
reportVlbiBeamState
¶ Class attribute
The State attribute value of the CSP VlbiBeam Capabilities.
Type: array of DevState.
-
reportVlbiBeamHealthState
¶ Class attribute
The healthState attribute value of the CSP VlbiBeam Capabilities.
Type: array of DevUShort.
-
reportVlbiBeamAdminMode
¶ Class attribute
The adminMode attribute value of the CSP VlbiBeam Capabilities.
Type: array of DevUShort.
-
cspSubarrayAddress
¶ Class attribute
The CSPSubarray FQDNs.
Type: Array of DevString
-
searchBeamCapAddress
¶ Class attribute
The CSP SearchBeam Cpabailities FQDNs.
Type: Array of DevString
-
timingBeamCapAddress
¶ Class attribute
The CSP TimingBeam Cpabailities FQDNs.
Type: Array of DevString
-
vlbiCapAddress
¶ Class attribute
The CSP VlbiBeam Cpabailities FQDNs.
Type: Array of DevString
-
receptorMembership
¶ Class attribute
The receptors subarray affiliation.
Type: array of DevUShort.
-
searchBeamMembership
¶ Class attribute
The SearchBeam Capabilities subarray affiliation.
Type: array of DevUShort.
-
timingBeamMembership
¶ Class attribute
The TimingBeam Capabilities subarray affiliation.
Type: array of DevUShort.
-
vlbiBeamMembership
¶ Class attribute
The VlbiBeam Capabilities subarray affiliation.
Type: array of DevUShort.
-
availableReceptorIDs
¶ Class attribute
The available receptor IDs.
Type: array of DevUShort.
-
reportVCCState
¶ TANGO Forwarded attribute.
The State attribute value of the Mid CBF Very Coarse Channel TANGO Devices.
Type: array of DevState.
__root_att: /mid_csp_cbf/sub_elt/master/reportVCCState
Note
If the __root_att attribute property is not specified in the TANGO DB or the value doesn’t correspond to a valid attribute FQDN, the CspMaster State goes in ALARM.
-
reportVCCHealthState
¶ TANGO Forwarded attribute.
The healthState attribute value of the Mid CBF Very Coarse Channel TANGO Devices.
Type: an array of DevUShort.
__root_att: /mid_csp_cbf/sub_elt/master/reportVCCHealthState
-
reportVCCAdminMode
¶ TANGO Forwarded attribute.
The adminMode attribute value of the Mid CBF Very Coarse Channel TANGO devices.
Type: array of DevUShort.
__root_att: /mid_csp_cbf/sub_elt/master/reportVccAdminMode
-
reportFSPState
¶ TANGO Forwarded attribute.
The State attribute value of the Mid CBF Frequency Slice Processor TANGO devices.
Type: array of DevState.
__root_att: /mid_csp_cbf/sub_elt/master/reportFSPHealthState
-
reportFSPHealthState
¶ TANGO Forwarded attribute.
The healthState attribute value of the Mid CBF Frequency SLice Processor TANGO Devices.
Type: an array of DevUShort.
__root_att: /mid_csp_cbf/sub_elt/master/reportFSPHealthState
-
reportFSPAdminMode
¶ TANGO Forwarded attribute.
The adminMode attribute value of the Mid CBF Frequency SLice Processor TANGO Devices.
Type: an array of DevUShort.
__root_att: /mid_csp_cbf/sub_elt/master/reportFSPAdminMode
-
fspMembership
¶ TANGO Forwarded attribute.
The subarray affiliation of the Mid CBF Frequency SLice Processor TANGO Devices.
Type: an array of DevUShort.
__root_att: /mid_csp_cbf/sub_elt/master/fspMembership
-
vccMembership
¶ TANGO Forwarded attribute.
The subarray affiliation of the Mid CBF VCC TANGO Devices.
Type: an array of DevUShort.
__root_att: /mid_csp_cbf/sub_elt/master/reportVCCSubarrayMembership
-
init_device
()¶
-
always_executed_hook
()¶
-
delete_device
()¶ Method called on stop/reinit of the device. Release all the allocated resources.
-
write_adminMode
(value)¶ Write attribute method.
Set the administration mode for the whole CSP element.
Parameters: value – one of the administration mode value (ON-LINE, OFF-LINE, MAINTENANCE, NOT-FITTED, RESERVED). Returns: None
-
read_commandProgress
()¶ Read attribute method.
Returns: The commandProgress attribute value.
-
read_cspCbfState
()¶ Read attribute method.
Returns: The CBF Sub-element State attribute value.
-
read_cspPssState
()¶ Read attribute method.
Returns: The PSS Sub-element State attribute value.
-
read_cspPstState
()¶ Read attribute method.
Returns: The PST Sub-element State attribute value.
-
read_cspCbfHealthState
()¶ Read attribute method.
Returns: The CBF Sub-element healthState attribute value.
-
read_cspPssHealthState
()¶ Read attribute method.
Returns: The PSS Sub-element healthState attribute value.
-
read_cspPstHealthState
()¶ Read attribute method.
Returns: The PST Sub-element healthState attribute value.
-
read_cbfMasterAddress
()¶ Read attribute method.
Returns: Return the CBS sub-element Master TANGO Device address.
-
read_pssMasterAddress
()¶ Read attribute method.
Returns: The PSS sub-element Master TANGO Device address.
-
read_pstMasterAddress
()¶ Read attribute method.
Returns: The PST sub-element Master TANGO Device address.
-
read_cbfAdminMode
()¶ Read attribute method.
Returns: The CBF sub-element adminMode attribute value.
-
write_cbfAdminMode
(value)¶ Write attribute method.
Set the CBF sub-element adminMode attribute value.
Parameters: value – one of the administration mode value (ON-LINE, OFF-LINE, MAINTENANCE, NOT-FITTED, RESERVED). Returns: None Raises: tango.DevFailed
– raised when there is no DeviceProxy providing interface to the CBF sub-element Master, or an exception is caught in command execution.
-
read_pssAdminMode
()¶ Read attribute method.
Returns: The PSS sub-element adminMode attribute value.
-
write_pssAdminMode
(value)¶ Write attribute method.
Set the PSS sub-element adminMode attribute value.
Parameters: value – one of the administration mode value (ON-LINE, OFF-LINE, MAINTENANCE, NOT-FITTED, RESERVED).
Returns: None
Raises: tango.DevFailed
– raised when there is no DeviceProxy providing- interface to the PSS sub-element Master, or an exception is caught
- in command execution.
-
read_pstAdminMode
()¶ Read attribute method.
Returns: The PST sub-element adminMode attribute value.
-
write_pstAdminMode
(value)¶ Write attribute method.
Set the PST sub-element adminMode attribute value.
Parameters: value – one of the administration mode value (ON-LINE, OFF-LINE, MAINTENANCE, NOT-FITTED, RESERVED).
Returns: None
Raises: tango.DevFailed
– raised when there is no DeviceProxy providing- interface to the PST sub-element Master, or an exception is caught in command execution.
-
read_availableCapabilities
()¶ Override read attribute method.
Returns: A list of strings with the number of available resources for each capability/resource type. Example
[“Receptors:95”, “SearchBeam:1000”, “TimingBeam:16”, “VlbiBeam:20”]
Raises: tango.DevFailed
-
read_reportSearchBeamState
()¶ Class attribute method.
Returns: The State value of the CSP SearchBeam Capabilities. Type: array of DevState.
-
read_reportSearchBeamHealthState
()¶ Class attribute method.
Returns: The healthState attribute value of the CSP SearchBeam Capabilities. Type: array of DevUShort
-
read_reportSearchBeamAdminMode
()¶ Class attribute method.
Returns: The adminMode of the CSP SearchBeam Capabilities. Type: array of DevUShort
-
read_reportTimingBeamState
()¶ Class attribute method.
Returns: The State value of the CSP TimingBeam Capabilities. Type: array of DevState.
-
read_reportTimingBeamHealthState
()¶ Class attribute method.
Returns: The healthState value of the CSP TimingBeam Capabilities. Type: array of DevUShort.
-
read_reportTimingBeamAdminMode
()¶ Class attribute method.
Returns: The adminMode value of the CSP TimingBeam Capabilities. Type: array of DevUShort.
-
read_reportVlbiBeamState
()¶ Class attribute method.
Returns: The State value of the CSP VlbiBeam Capabilities. Type: array of DevState.
-
read_reportVlbiBeamHealthState
()¶ Class attribute method.
Returns: The healthState value of the CSP VlbiBeam Capabilities. Type: array of DevUShort.
-
read_reportVlbiBeamAdminMode
()¶ Read attribute method.
Returns: The adminMode value of the CSP VlbiBeam Capabilities. Type: array of DevUShort.
-
read_cspSubarrayAddress
()¶ Class attribute method.
Returns: The CSP Subarrays FQDNs if the associated Device Property is defined, otherwise None. Type: array of DevString
-
read_searchBeamCapAddress
()¶ Class attribute method.
Returns: The CSP SearchBeam Capabilities FQDNs if the associated Device Property is defined, otherwise None. Type: array of DevString
-
read_timingBeamCapAddress
()¶ Class attribute method.
Returns: The CSP TimingBeam Capabilities FQDNs if the associated Device Property is defined, otherwise None. Type: array of DevString
-
read_vlbiCapAddress
()¶ Class attribute method.
Returns: The CSP VlbiBeam Capabilities FQDNs if the associated Device Property is defined, otherwise None. Type: array of DevString
-
read_receptorMembership
()¶ Class attribute method.
Returns: The subarray affiliation of the receptors.
-
read_searchBeamMembership
()¶ Class attribute method.
Returns: The subarray affilitiaion of the Search Beams.
-
read_timingBeamMembership
()¶ Class attribute method.
Returns: The subarray affilitiaion of the Timing Beams.
-
read_vlbiBeamMembership
()¶ Class attribute method.
Returns: The subarray affilitiaion of the Vlbi Beams.
-
read_availableReceptorIDs
()¶ Class attribute method.
Returns: The list of the available receptors IDs. The list includes all the receptors that are not assigned to any subarray and, from the side of CSP, are considered “full working”. This means: - a valid link connection receptor-VCC
- the connected VCC healthState OK
Type: array of DevUShort
Raises: tango.DevFailed
– if there is no DeviceProxy providing interface to the CBF sub-element Master Device or an error is caught during command execution.
-
is_On_allowed
()¶ TANGO is_allowed method
Command On is allowed when:
- state is STANDBY and adminMode = MAINTENACE or ONLINE (end state = ON)
- state is DISABLE and adminMode = MAINTENACE or ONLINE (end state = ON)
Returns: True if the method is allowed, otherwise False.
-
On
(argin)¶ Class method
Switch-on the CSP sub-elements specified by the input argument. If no argument is specified, the command is issued on all the CSP sub-elements.
The command is executed if the AdminMode is ONLINE or MAINTENANCE.
If the AdminMode is OFFLINE, NOT-FITTED or RESERVED, the method throws an exception.
Parameters: - argin – the list of sub-element FQDNs to switch-on or an empty list to switch-on the whole CSP Element.
- Type – DevVarStringArray
Returns: None
Raises: tango.DevFailed
– an exception is caught processing the On command for the CBF sub-element or there are no DeviceProxy providing interface to the CSP sub-elements or the AdminMode is not correct.
-
is_Off_allowed
()¶ TANGO is_allowed method
Command Off is allowed when the device State is STANDBY.
Returns: True if the method is allowed, otherwise False.
-
Off
(argin)¶ Switch-off the CSP sub-elements specified by the input argument. If no argument is specified, the command is issued to all the CSP sub-elements.
Parameters: - argin – The list of sub-elements to switch-off. If the array length is 0, the command applies to the whole CSP Element. If the array length is > 1, each array element specifies the FQDN of the CSP SubElement to switch OFF
- Type – DevVarStringArray
Returns: None
-
is_Standby_allowed
()¶ TANGO is_allowed method
Command Standby is allowed when the device State is ON, DISABLE or ALARM.
Returns: True if the method is allowed, otherwise False.
-
Standby
(argin)¶ Transit to STANDBY the CSP sub-elements specified by the input argument. If no argument is specified, the command is issued to all the CSP sub-elements.
Parameters: - argin – The list of the Sub-element devices FQDNs
- Type – DevVarStringArray
Returns: None
Raises: tango.DevFailed
– if command fails or if no DeviceProxy associated to the FQDNs.
-
-
CspMaster.
main
(args=None, **kwargs)¶