CSP LMC Prototype’s documentation

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)

CSP Subarrays

The core CSP functionality, configuration and execution of signal processing, is configured, controlled and monitored via subarrays.

CSP Subarray makes provision to TM to configure a subarray, select Processing Mode and related parameters, specify when to start/stop signal processing and/or generation of output products. TM accesses directly a CSP Subarray to:

  • Assign resources
  • Configure a scan
  • Control and monitor states/operations

Resources assignment

The assignment of Capabilities to a subarray (subarray composition) is performed in advance of a scan configuration. Assignable Capabilities for CSP Mid subarrays are:

  • receptors and the associated CBF Very Coarse Channelizers:each VCC processes the input from one receptor.
  • CBF Frequency Slice Processors performing one of the available Processing Mode Functions: Correlation, Pulsar Timing Beamforming, Pulsar Search Beamforming, VLBI Beamforming.
  • tied-array beams: Search Beams, Timing Beams and Vlbi Beams.

In general resource assignment to a subarray is exclusive, but in some cases (FSPs) the same Capability instance may be used in shared manner by more then one subarray.

Note: of all the listed Capabilities, only FSPs are assigned to subarrays via a scan configuration.

Inherent Capabilities

Each CSP subarray has also four permanently assigned inherent Capabilities:

  • Correlation
  • PSS
  • PST
  • VLBI

An inherent Capability can be enabled or disabled, but cannot assigned or removed to/from a subarray. They correspond to the CSP Mid Processing Modes and are configured via a scan configuration.

Scan configuration

TM provides a complete scan configuration to a subarray via an ASCII JSON encoded string. Parameters specified via a JSON string are implemented as TANGO Device attributes and can be accessed and modified directly using the buil-in TANGO method write_attribute. When a complete and coherent scan configuration is received and the subarray configuration (or re-configuration) completed, the subarray it’s ready to observe.

Control and Monitoring

Each CSP Subarray maintains and report the status and state transitions for the CSP subarray as a whole and for the individual assigned resources.

In addition to pre-configured status reporting, a CSP Subarray makes provision for the TM and any authorized client, to obtain the value of any subarray attribute.

Class Documentation

CspSubarray TANGO Device Class

CSP subarray functionality is modeled via a TANGO Device Class, named CspSubarray. This class exports a set of attributes and methods required for configuration, control and monitoring of the subarray.

class CspSubarray.CspSubarray(*args, **kwargs)

CSP subarray functionality is modeled via a TANGO Device Class, named CspSubarray. This class exports a set of attributes and methods required for configuration, control and monitoring of the subarray.

CbfSubarrayPrefix

Class property

The CBF sub-element subarray FQDN prefix.

Type: DevString

Example

mid_csp_cbf/sub_elt/subarray_

PssSubarrayPrefix

Class property

The PSS sub-element subarray FQDN prefix.

Type: DevString

Example

mid_csp_pss/sub_elt/subarray_

CspMaster

Device property

The CspMaster FQDN.

Type: DevString

scanID

Class attribute

The identification number of the scan.

Type: DevULong64

corrInherentCap

Class attribute

The CspSubarray Correlation inherent Capability FQDN.

Type: DevString

pssInherentCap

Class attribute

The CspSubarray Pss inherent Capability FQDN.

Type: DevString

pstInherentCap

Class attribute

The CspSubarray Pst inherent Capability FQDN.

Type: DevString

vlbiInherentCap

Class attribute

The CspSubarray Vlbi inherent Capability FQDN.

Type: DevString

cbfSubarrayState

Class attribute

The CBF sub-element subarray State attribute value.

Type: DevState

pssSubarrayState

Class attribute

The PSS sub-element subarray State attribute value.

Type: DevState

cbfSubarrayHealthState

Class attribute

The CBF sub-element subarray healthState attribute value.

Type: DevEnum

enum_labels: [“OK”, “DEGRADED”, “FAILED”, “UNKNOWN”, ]

pssSubarrayHealthState

Class attribute

The PSS sub-element subarray healthState attribute value.

Type: DevEnum

enum_labels: [“OK”, “DEGRADED”, “FAILED”, “UNKNOWN”, ]

cbfSubarrayObsState

Class attribute

The CBF sub-element subarray obsState attribute value.

Type: DevEnum

enum_labels: [“IDLE”, “CONFIGURING”, “READY”, “SCANNING”, “PAUSED”, “ABORTED”, “FAULT”, ]

pssSubarrayObsState

Class attribute

The PSS sub-element subarray obsState attribute value.

Type: DevEnum

enum_labels: [“IDLE”, “CONFIGURING”, “READY”, “SCANNING”, “PAUSED”, “ABORTED”, “FAULT”, ]

pssSubarrayAddr

Class attribute

The PSS sub-element subarray FQDN.

Type: DevString

cbfSubarrayAddr

Class attribute

The CBF sub-element subarray FQDN.

Type: DevString

validScanConfiguration

Class attribute

The last valid scan configuration JSON-encoded string.

Type: DevString

fsp

Class attribute

The list of receptor IDs assigned to the subarray.

Type: array of DevUShort

vcc

Class attribute

The list of VCC IDs assigned to the subarray.

Type: array of DevUShort

searchBeams

Class attribute

The list of Search Beam Capability IDs assigned to the subarray.

Type: array of DevUShort

timingBeams

Class attribute

The list of Timing Beam Capability IDs assigned to the subarray.

Type: array of DevUShort

vlbiBeams

Class attribute

The list of Vlbi Beam Capability IDs assigned to the subarray.

Type: array of DevUShort

searchBeamsState

Class attribute

The State attribue value of the Search Beam Capabilities assigned to the subarray.

Type: array of DevState

timingBeamsState

Class attribute

The State attribue value of the Timing Beam Capabilities assigned to the subarray.

Type: array of DevState

vlbiBeamsState

Class attribute

The State attribue value of the Vlbi Beam Capabilities assigned to the subarray.

Type: array of DevState

searchBeamsHealthState

Class attribute

The healthState attribute value of the Search Beams Capbilities assigned to the subarray.

Type: array of DevUShort.

References

See Common definition paragraph for corrispondences among Ushort values and label

timingBeamsHealthState

Class attribute

The healthState attribute value of the Timing Beams Capbilities assigned to the subarray.

Type: array of DevUShort.

References

See Common definition paragraph for corrispondences among Ushort values and label

vlbiBeamsHealthState

Class attribute

The healthState attribute value of the Vlbi Beams Capbilities assigned to the subarray.

Type: array of DevUShort.

References

See Common definition paragraph for corrispondences among Ushort values and healthState labels.

timingBeamsObsState

Class attribute

The obsState attribute value of the Timing Beams Capbilities assigned to the subarray.

Type: array of DevUShort.

References

See Common definition paragraph for corrispondences among Ushort values and obsState labels.

receptors

The list of receptors assigned to the subarray.

Forwarded attribute

_root_att: mid_csp_cbf/sub_elt/subarray_N/receptors

vccState

The State attribute value of the VCCs assigned to the subarray.

Forwarded attribute

_root_att: mid_csp_cbf/sub_elt/subarray_N/reportVCCState

vccHealthState

The healthState attribute value of the VCCs assigned to the subarray.

Forwarded attribute

_root_att: mid_csp_cbf/sub_elt/subarray_N/reportVCChealthState

The CBF Subarray output links information.

Forwarded attribute

_root_att: mid_csp_cbf/sub_elt/subarray_N/cbfOutputLinksDistribution

init_device()

Class method

Perform device initialization. during initiazlization the CspSubarray device : * connects to CSP Master and sub-element master devices

  • sub-element sub-array devices with the same subarray ID
  • subscribes to the sub-element subarrays State,healthState, obsState attributes for change event
always_executed_hook()
delete_device()
read_scanID()

Attribute method

Returns:The scan configuration ID.
write_scanID(value)

Note

Not yet implemented.

Attribute method

Set the scan configuration ID to the defined value.

Parameters:
  • value – the scan configuration ID
  • Type – DevUshort
Returns:

The scan configuration ID.
read_corrInherentCap()

Attribute method

Returns:The CspSubarray Correlation Inherent Capability FQDN.

Type: DevString
read_pssInherentCap()

Attribute method

Returns:The CspSubarray PSS Inherent Capability FQDN.

Type: DevString
read_pstInherentCap()

Attribute method

Returns:The CspSubarray PST Inherent Capability FQDN.

Type: DevString
read_vlbiInherentCap()

Attribute method

Returns:The CspSubarray VLBI Inherent Capability FQDN.

Type: DevString
read_cbfSubarrayState()

Attribute method

Returns:The CBF sub-element subarray State attribute value.

Type: DevState
read_pssSubarrayState()

Attribute method

Returns:The PSS sub-element subarray State attribute value.

Type: DevState
read_cbfSubarrayHealthState()

Attribute method

Returns:The CBF sub-element subarray healtState attribute value.

Type: DevUShort
read_pssSubarrayHealthState()

Attribute method

Returns:The PSS sub-element subarray healtState attribute value.

Type: DevUShort
read_cbfSubarrayObsState()

Attribute method

Returns:The CBF sub-element subarray obsState attribute value.

Type: DevUShort
read_pssSubarrayObsState()

Attribute method

Returns:The PSS sub-element subarray obsState attribute value.

Type: DevUShort
read_pssSubarrayAddr()

Attribute method

Returns:The PSS sub-element subarray FQDN.

Type: DevString
read_cbfSubarrayAddr()

Attribute method

Returns:The CSP sub-element subarray FQDN.

Type: DevString
read_validScanConfiguration()

Attribute method

Returns:The last programmed scan configuration.

Type: DevString (JSON-encoded)
read_fsp()

Attribute method

Returns:The list of FSP IDs assigned to the subarray.

Type: array of DevUShort.
read_vcc()

Attribute method

Returns:The list of VCC IDs assigned to the subarray.

Type: array of DevUShort.
read_searchBeams()

Attribute method

Returns:The list of Search Beam Capability IDs assigned to the subarray.

Type: array of DevUShort.
read_timingBeams()

Attribute method

Returns:The list of Timing Beam Capability IDs assigned to the subarray.

Type: array of DevUShort.
read_vlbiBeams()

Attribute method

Returns:The list of Vlbi Beam Capability IDs assigned to the subarray.

Type: array of DevUShort.
read_searchBeamsState()

Attribute method

Returns:The Search Beam Capabilities State attribute value.

Type: array of DevState
read_timingBeamsState()

Attribute method

Returns:The Timing Beam Capabilities State attribute value.

Type: array of DevState
read_vlbiBeamsState()

Attribute method

Returns:The Vlbi Beam Capabilities State attribute value.

Type: array of DevState
read_searchBeamsHealthState()

Attribute method

Returns:The Search Beam Capabilities healthState attribute value.

Type: array of DevUShort
read_timingBeamsHealthState()

Attribute method

Returns:The Timing Beam Capabilities healthState attribute value.

Type: array of DevUShort
read_vlbiBeamsHealthState()

Attribute method

Returns:The Vlbi Beam Capabilities healthState attribute value.

Type: array of DevUShort
read_timingBeamsObsState()

Attribute method

Returns:The Timing Beam Capabilities obsState attribute value.

Type: array of DevUShort
is_EndScan_allowed()

TANGO is_allowed method: filter the external request depending on the current device state.

Check if the Scan method can be issued on the subarray.

The Scan() method can be issue on a subarray if its State is ON.

Returns:True if the command can be executed, otherwise False
EndScan()

Class method End the execution of a running scan. After successful execution, the CspSubarray ObsState is IDLE.

Raises:
  • tango.DevFailed – if the subarray obsState is not SCANNING or if an exception
  • is caught during the command execution.

Note

Still to implement the check on AdminMode values: the command can be processed only when the CspSubarray is ONLINE or MAINTENANCE

is_Scan_allowed()

TANGO is_allowed method: filter the external request depending on the current device state.

Check if the Scan method can be issued on the subarray.

A scan configuration can be performed when the subarray State is ON (that is, at least one receptor is assigned to it)

Returns:True if the command can be executed, otherwise False
Scan(argin)

Class method

Start the execution of scan.

Raises:tango.DevFailed – if the subarray obsState is not READY or if an exception is caught during the command execution.

Note

Still to implement the check on AdminMode values: the command can be processed only when the CspSubarray is ONLINE or MAINTENANCE

is_AddReceptors_allowed()

TANGO is_allowed method: filter the external request depending on the current device state.

Check if the AddReceptors method can be issued on the subarray.

Receptors can be added to a Subarray when its State is OFF or ON.

Returns:True if the command can be executed, otherwise False
AddReceptors(argin)

Class method

Add the specified receptor IDs to the subarray.

The command can be executed only if the CspSubarray ObsState is IDLE.

Parameters:
  • argin – the list of receptor IDs
  • Type – array of DevUShort
Returns:

None
Raises:

tango.DevFailed – if the CbfSubarray is not available or if an exception is caught during command execution.

Note

Still to implement the check on AdminMode values: the command can be processed only when the CspSubarray is ONLINE or MAINTENANCE

is_RemoveReceptors_allowed()

TANGO is_allowed method: filter the external request depending on the current device state.

Check if the method can be issued on the subarray.

Re can be removed from a subarray when its State is ON or OFF-

Returns:True if the command can be executed, otherwise False
RemoveReceptors(argin)

Remove the receptor IDs from the subarray.

Parameters:
  • argin – The list of the receptor IDs to remove from the subarray.
  • Type – array of DevUShort
Returns:

None
Raises:

tango.DevFailed – raised if the subarray obState attribute is not IDLE, or when an exception is caught during command execution.
is_RemoveAllReceptors_allowed()

TANGO is_allowed method: filter the external request depending on the current device state.

Check if the method can be issued on the subarray.

Resources can be removed from a subarray when its State is ON or OFF-

Returns:True if the command can be executed, otherwise False
RemoveAllReceptors()

Class method.

Remove all the assigned receptors from the subarray. :returns: None

Raises:tango.DevFailed – raised if the subarray obState attribute is not IDLE or READY, or when an exception is caught during command execution.
is_ConfigureScan_allowed()

TANGO is_allowed method: filter the external request depending on the current device state.

Check if the ConfigureScan method can be issued on the subarray.

A scan configuration can be performed when the subarray State is ON (that is, at least one receptor is assigned to it)

Returns:True if the command can be executed, otherwise False
ConfigureScan(argin)

Note

Part of this code (the input string parsing) comes from the CBF project developed by J.Jjang (NRC-Canada)

Class method.

Configure a scan for the subarray.

The command can be execuced when the CspSubarray State is ON and the ObsState is IDLE or READY.

If the configuration for the scan is not correct (invalid parameters or invalid JSON) the configuration is not applied and the ObsState of the CspSubarray remains IDLE.

Parameters:argin – a JSON-encoded string with the parameters to configure a scan.
Returns:None
Raises:tango.DevFailed exception if the CspSubarray ObsState is not valid or if an exception is caught during command execution.

Note

Still to implement the check on AdminMode values: the command can be processed only when the CspSubarray is ONLINE or MAINTENANCE

AddNumOfSearchBeams(argin)

Note

Still to be implemented

Class method

Add the specified number of Search Beams capabilities to the subarray.

Parameters:argin – The number of SearchBeams Capabilities to assign to the subarray
Returns:None
RemoveNumOfSearchBeams(argin)

Note

Still to be implemented

Class method

Remove the specified number of Search Beams capabilities from the subarray.

Parameters:argin – The number of SearchBeams Capabilities to remove from the subarray. If equal to the max number of search bem capabilities (1500 for MID), all the search beams are removed.
Returns:None
AddTimingBeams(argin)

Note

Still to be implemented

Class method

Add the specified Timing Beams Capability IDs to the subarray.

Parameters:
  • argin – The list of Timing Beams Capability IDs to assign to the subarray.
  • Type – array of DevUShort
Returns:

None
AddVlbiBeams(argin)

Note

Still to be implemented

Class method

Add the specified Vlbi Beams Capability IDs to the subarray.

Parameters:
  • argin – The list of Vlbi Beams Capability IDs to assign to the subarray.
  • Type – array of DevUShort
Returns:

None
AddSearchBeamsID(argin)

Note

Still to be implemented

Class method

Add the specified Search Beams Capability IDs to the subarray. This method requires some knowledge of the internal behavior of the PSS machine, because Seach Beam capabilities with PSS pipelines belonging to the same PSS node, can’t be assigned to different subarrays.

Parameters:
  • argin – The list of Search Beams Capability IDs to assign to the subarray.
  • Type – array of DevUShort
Returns:

None

References

AddNumOfSearchBeams

RemoveSearchBeamsID(argin)

Note

Still to be implemented

Class method

Remove the specified Search Beam Capability IDs from the subarray.

Parameters:
  • argin – The list of Timing Beams Capability IDs to remove from the subarray.
  • Type – Array of unsigned short
Returns:

None
RemoveTimingBeams()

Note

Still to be implemented

Class method

Remove the specified Timing Beam Capability IDs from the subarray.

Parameters:
  • argin – The list of Timing Beams Capability IDs to remove from the subarray.
  • Type – Array of DevUShort
Returns:

None
RemoveVlbiBeams()

Note

Still to be implemented

Class method

Remove the specified Vlbi Beam Capability IDs from the subarray.

Parameters:
  • argin – The list of Timing Beams Capability IDs to remove from the subarray.
  • Type – Array of DevUShort
Returns:

None
is_EndSB_allowed()

TANGO is_allowed method: filter the external request depending on the current device state.

Check if the EndSB method can be issued on the subarray. The EndSB method can be issued on a subarrays when its State is ON.

Returns:True if the command can be executed, otherwise False
EndSB()

Class method

Set the subarray ObsState to IDLE.

The command is executed only when the CspSubarray State is ON and ObsState is READY or IDLE.

Raises:tango.DevFailed exception if the CspSubarray ObsState is not valid or if an exception is caught during command execution.

Note

Still to implement the check on AdminMode values: the command can be processed only when the CspSubarray is ONLINE or MAINTENANCE

CspSubarray.main(args=None, **kwargs)

CspMaster Class Documentation

class global_enum.HealthState

An enumeration.

OK = 0
DEGRADED = 1
FAILED = 2
UNKNOWN = 3
class global_enum.AdminMode

An enumeration.

ONLINE = 0
OFFLINE = 1
MAINTENANCE = 2
NOTFITTED = 3
RESERVED = 4
class global_enum.ControlMode

An enumeration.

REMOTE = 0
LOCAL = 1
class global_enum.ObsMode

An enumeration.

IDLE = 0
IMAGING = 1
PULSARSEARCH = 2
PULSARTIMING = 3
DYNAMICSPECTRUM = 4
TRANSIENTSEARCH = 5
VLBI = 6
CALIBRATION = 7
class global_enum.ObsState

An enumeration.

IDLE = 0
CONFIGURING = 1
READY = 2
SCANNING = 3
PAUSED = 4
ABORTED = 5
FAULT = 6

Indices and tables