CspMaster Class Documentation

CSP.LMC Common CspMaster

CSP.LMC Common Class for the CSPMaster TANGO Device.

class csp_lmc_common.CspMaster.CspMaster(*args: Any, **kwargs: Any)

Bases: ska.base.

CSP.LMC Common Class for the CSPMaster TANGO Device.

Properties:

• Device Property

  CspCbf

  • FQDN of the CBF Sub-element Master

  • Type:’DevString’

  CspPss

  • TANGO FQDN of the PSS Sub-element Master

  • Type:’DevString’

  CspPst

  • TANGO FQDN of the PST Sub-element Master

  • Type:’DevString’

  CspSubarrays

  • TANGO FQDN of the CSP.LMC Subarrays

  • Type:’DevVarStringArray’

  SearchBeamsMonitor

  • TANGO Device to monitor the CSP SearchBeams Capability

devices.

• Type:’DevString’

TimingBeamsMonitor

• TANGO Device to monitor the CSP TimingBeams Capability

devices.

• Type:’DevString’

VlbiBeamsMonitor

• TANGO Device to monitor the CSP VlbiBeams Capability

devices.

• Type:’DevString’

CspCbf

TANGO property

CspPss

TANGO property

CspPst

TANGO property

CspSubarrays

TANGO property

SearchBeamsMonitor

TANGO property

TimingBeamsMonitor

TANGO property

VlbiBeamsMonitor

TANGO property

adminMode

The admin mode reported for this device. It may interpret thecurrent device condition and condition of all managed devicesto set this. Most possibly an aggregate attribute.

onCommandProgress

Percentage progress implemented for commands that result in state/modetransitions for a large number of components and/or are executed in stages (e.g power up, power down)

offCommandProgress

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)

standbyCommandProgress

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)

onCmdDurationExpected

Set/Report the duration expected (in sec.) for the On command execution

offCmdDurationExpected

Set/Report the duration expected (in sec.) for the Off command execution

standbyCmdDurationExpected

Set/Report the duration expected (in sec.) for the Standby command

onCmdDurationMeasured

Report the measured duration (in sec.) of the On command execution

offCmdDurationMeasured

Report the measured duration (in sec.) of the Off command execution

standbyCmdDurationMeasured

Report the measured duration (in sec.) of the Standby command

onCmdTimeoutExpired

Signal the occurence of a timeout during the execution of commands on CBF Sub-element

offCmdTimeoutExpired

Signal the occurence of a timeout during the execution of commands on PSS Sub-element

standbyCmdTimeoutExpired

Signal the occurence of a timeout during the execution of commands on PST Sub-element

cspCbfState

The CBF sub-element Device State. Allowed values are ON, STANDBY, OFF, DISABLE, ALARM, FAULT, UNKNOWN

cspPssState

The PSS sub-element Device State. Allowed values are ON, STANDBY, OFF, DISABLE, ALARM, FAULT, UNKNOWN

cspPstState

The PST sub-element Device State. Allowed values are ON, STANDBY,OFF, DISABLE, ALARM, FAULT, UNKNOWN

cspCbfHealthState

The CBF sub-element healthState.

cspPssHealthState

The PSS sub-element healthState

cspPstHealthState

The PST sub-element healthState.

cbfMasterAddress

TANGO FQDN of the CBF sub-element Master

pssMasterAddress

TANGO FQDN of the PSS sub-element Master

pstMasterAddress

TANGO FQDN of the PST sub-element Master

cspCbfAdminMode

The CBF sub-lement adminMode. Allowed values are ON-LINE, MAINTENANCE, OFF-LINE, NOT-FITTED, RESERVED

cspPssAdminMode

The PSS sub-lement adminMode. Allowed values are ON-LINE, MAINTENANCE, OFF-LINE, NOT-FITTED, RESERVED

cspPstAdminMode

The PST sub-lement adminMode. Allowed values are ON-LINE, MAINTENANCE, OFF-LINE, NOT-FITTED, RESERVED

numOfDevCompletedTask

Number of devices that completed the task

onCmdFailure

Alarm flag set when the On command fails with error(s).

onFailureMessage

Alarm message when the On command fails with error(s).

offCmdFailure

Alarm flag set when the Off command fails with error(s).

offFailureMessage

Alarm message when the Off command fails with error(s).

standbyCmdFailure

Alarm flag set when the Standby command fails with error(s).

standbyFailureMessage

Alarm message when the Standby command fails with error(s).

searchBeamsAddresses

The SearchBeam Capabilityies FQDNs

timingBeamsAddresses

The list of Timing Beam Capabilities FQDNs

vlbiBeamsAddresses

The list of VlbiBeam Capabilities FQDNs

cspSubarrayAddresses

CSPSubarrays FQDN

listOfDevCompletedTask

List of devices that completed the task

reservedSearchBeamIDs

For each sub-array idm reports the list of the reserved SearchBeam IDs

reportSearchBeamState

TANGO attribute

reportSearchBeamHealthState

TANGO attribute

reportSearchBeamObsState

TANGO attribute

reportSearchBeamAdminMode

TANGO attribute

reportTimingBeamState

TANGO attribute

reportTimingBeamHealthState

TANGO attribute

reportTimingBeamObsState

TANGO attribute

reportTimingBeamAdminMode

TANGO attribute

reportVlbiBeamState

TANGO attribute

reportVlbiBeamHealthState

TANGO attribute

reportVlbiBeamObsState

TANGO attribute

reportVlbiBeamAdminMode

TANGO attribute

unassignedVlbiBeamIDs

TANGO attribute

unassignedTimingBeamIDs

TANGO attribute

unassignedSearchBeamIDs

TANGO attribute

numOfUnassignedVlbiBeams

TANGO attribute

numOfUnassignedTimingBeams

TANGO attribute

numOfUnassignedSearchBeams

TANGO attribute

searchBeamMembership

TANGO attribute

timingBeamMembership

TANGO attribute

vlbiBeamMembership

TANGO attribute

init_device()

Initialises the attributes and properties of the CspMaster.

always_executed_hook()

Method always executed before any TANGO command is executed.

delete_device()

Hook to delete resources allocated in init_device.

This method allows for any memory or other resources allocated in the init_device method to be released. This method is called by the device destructor and by the device Init command.

read_adminMode()

Return the adminMode attribute.

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).

Type

DevEnum

Returns

None

read_onCommandProgress()

Return the onCommandProgress attribute.

read_offCommandProgress()

Return the offCommandProgress attribute.

read_standbyCommandProgress()

Return the standbyCommandProgress attribute.

read_onCmdDurationExpected()

Return the onCmdDurationExpected attribute.

write_onCmdDurationExpected(value)

Set the onCmdDurationExpected attribute.

read_offCmdDurationExpected()

Return the offCmdDurationExpected attribute.

write_offCmdDurationExpected(value)

Set the offCmdDurationExpected attribute.

read_standbyCmdDurationExpected()

Return the standbyCmdDurationExpected attribute.

write_standbyCmdDurationExpected(value)

Set the standbyCmdDurationExpected attribute.

read_onCmdDurationMeasured()

Return the onCmdDurationMeasured attribute.

read_offCmdDurationMeasured()

Return the offCmdDurationMeasured attribute.

read_standbyCmdDurationMeasured()

Return the standbyCmdDurationMeasured attribute.

read_onCmdTimeoutExpired()

Return the onCmdTimeoutExpired attribute.

read_offCmdTimeoutExpired()

Return the offCmdTimeoutExpired attribute.

read_standbyCmdTimeoutExpired()

Return the standbyCmdTimeoutExpired attribute.

read_cspCbfState()

Return the cspCbfState attribute.

read_cspPssState()

Return the cspPssState attribute.

read_cspPstState()

Return the cspPstState attribute.

read_cspCbfHealthState()

Return the cspCbfHealthState attribute.

read_cspPssHealthState()

Return the cspPssHealthState attribute.

read_cspPstHealthState()

Return the cspPstHealthState attribute.

read_cbfMasterAddress()

Return the cbfMasterAddress attribute.

read_pssMasterAddress()

Return the pssMasterAddress attribute.

read_pstMasterAddress()

Return the pstMasterAddress attribute.

read_cspCbfAdminMode()

Return the cspCbfAdminMode attribute.

write_cspCbfAdminMode(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 when there is no DeviceProxy providing interface to the CBF sub-element Master, or an exception is caught in command execution.

read_cspPssAdminMode()

Return the cspPssAdminMode attribute.

write_cspPssAdminMode(value)

Set the cspPssAdminMode attribute.

read_cspPstAdminMode()

Return the cspPstAdminMode attribute.

write_cspPstAdminMode(value)

Set the cspPstAdminMode attribute.

read_numOfDevCompletedTask()

Return the numOfDevCompletedTask attribute.

read_onCmdFailure()

Return the onCmdFailure attribute.

read_onFailureMessage()

Return the onFailureMessage attribute.

read_offCmdFailure()

Return the offCmdFailure attribute.

read_offFailureMessage()

Return the offFailureMessage attribute.

read_standbyCmdFailure()

Return the standbyCmdFailure attribute.

read_standbyFailureMessage()

Return the standbyFailureMessage attribute.

read_cspSubarrayAddresses()

Return the cspSubarrayAddresses attribute.

read_listOfDevCompletedTask()

Return the listOfDevCompletedTask attribute.

read_reservedSearchBeamIDs()

Return the reservedSearchBeamIDs attribute.

read_searchBeamsAddresses()

Return the searchBeamsAddresses attribute. This attribute stores the list of the SearchBeams Capabilities TANGO addresses (FQDNs)

read_timingBeamsAddresses()

Return the timingBeamsAddresses attribute. This attribute stores the list of the TimingBeams Capabilities TANGO addresses (FQDNs)

read_vlbiBeamsAddresses()

Return the vlbiBeamsAddresses attribute. This attribute stores the list of the VlbiBeams Capabilities TANGO addresses (FQDNs)

is_On_allowed()

TANGO is_allowed method

Command On is allowed when the device State is STANDBY.

Returns

True if the method is allowed, otherwise False.

On(argin)

Class TANGO 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. The CSP.LMC commands sub-element transition from STANDBY to ON sequentially. It waits for the first sub-element (CBF) to complete the transition, then issues the command to the second sub-element (e.g. PST), waits for PST to complete and then issues command for PSS. Command is forwarded to the sub-element devices specified in the input list, only if their adminMode is ONLINE or MAINTENANCE.

Parameters

argin –

The list of sub-element FQDNs to switch-on or an empty list to switch-on the whole CSP Element.

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 ON.

Type

‘DevVarStringArray’

Returns

None

Raises

tango.DevFailed exception when:

• the CSP adminMode is not correct

• one or more sub-element devices are already running a power command

• there is no DeviceProxy providing interface to the CBF sub-element

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)

Class TANGO method

Power-down 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. The CSP.LMC commands sub-element transition from STANDBY to OFF sequentially.It waits for the first sub-element (CBF) to complete the transition, then issues the command to the second sub-element (e.g. PST), waits for PST to complete and then issues command for PSS. Command is forwarded to the sub-element devices specified in the input list, only if their adminMode is ONLINE or MAINTENANCE.

Parameters

argin – The list of sub-element FQDNs to power-down or an empty list to power-off the whole CSP Element. 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 power-off.

Type

‘DevVarStringArray’

Returns

None

Raises

tango.DevFailed exception when:

• the CSP adminMode is not correct

• one or more sub-element devices are already running a power command

• there is no DeviceProxy providing interface to the CBF sub-element

is_Standby_allowed()

TANGO is_allowed method

Command Standby is allowed when the device State is ON.

Returns

True if the method is allowed, otherwise False.

Standby(argin)

Transit CSP or one or more CSP SubElements from ON to STANDBY. The command is executed only if the AdminMode is ONLINE or MAINTENANCE. If the AdminMode is OFFLINE, NOT-FITTED or RESERVED, the method throws an exception. The CSP.LMC commands sub-element transition from ON to STANDBY sequentially. It waits for the first sub-element (CBF) to complete the transition, then issues the command to the second sub-element (e.g. PST), waits for PST to complete and then issues command for PSS. Command is forwarded to the sub-element devices specified in the input list, only if their adminMode is ONLINE or MAINTENANCE.

Parameters

argin – A list with the FQDN of the sub-elements to set in low-power. 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 put in STANDBY mode.

Type

‘DevVarStringArray’

Returns

None

Raises

tango.DevFailed exception when:

• the CSP adminMode is not correct

• one or more sub-element devices are already running a power command

• there is no DeviceProxy providing interface to the CBF sub-element

Upgrade()

Returns

None

csp_lmc_common.CspMaster.main(args=None, **kwargs)