Fsp Class

class ska_mid_cbf_mcs.fsp.fsp_device.Fsp(cl, name)[source]

Bases: SKACapability

Fsp TANGO device class for the prototype

FspID: TANGO property

FspCorrSubarray: TANGO property

FspPssSubarray: TANGO property

FspPstSubarray: TANGO property

HpsFspControllerAddress: TANGO property

HpsFspCorrControllerAddress: TANGO property

functionMode: Function mode; an int in the range [0, 4]

subarrayMembership: Subarray membership

scanID: scan ID, set when transition to SCANNING is performed

configID: set when transition to READY is performed

jonesMatrix: Jones Matrix, given per frequency slice

delayModel: Differential off-boresight beam delay model

timingBeamWeights: Amplitude weights used in the tied-array beamforming

simulationMode: Device attribute.

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

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

create_component_manager() → FspComponentManager[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.

write_simulationMode(value: SimulationMode) → None[source]

Set the simulation mode of the device.

Parameters:: value – SimulationMode

read_functionMode() → tango.DevEnum[source]

Read the functionMode attribute.

Returns:: a DevEnum representing the mode.
Return type:: tango.DevEnum

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

Read the subarrayMembership attribute.

Returns:: an array of affiliations of the FSP.
Return type:: List[int]

read_scanID() → int[source]

Read the scanID attribute.

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

read_configID() → str[source]

Read the configID attribute.

Returns:: the configID attribute.
Return type:: str

write_configID(value: str) → None[source]

Write the configID attribute.

Parameters:: value – the configID value.

read_jonesMatrix() → str[source]

Read the jonesMatrix attribute.

Returns:: the jonesMatrix attribute.
Return type:: string

read_delayModel() → str[source]

Read the delayModel attribute.

Returns:: the delayModel attribute.
Return type:: string

read_timingBeamWeights() → str[source]

Read the timingBeamWeights attribute.

Returns:: the timingBeamWeights attribute.
Return type:: string

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

Bases: InitCommand

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

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

Bases: OnCommand

A class for the Fsp’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 Fsp’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 Fsp’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 SetFunctionModeCommand(target, *args, logger=None, **kwargs)[source]

Bases: ResponseCommand

A class for the Fsp’s SetFunctionMode() command.

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

Stateless hook for SetFunctionMode() command functionality.

Parameters:: argin – one of ‘IDLE’,’CORR’,’PSS-BF’,’PST-BF’, or ‘VLBI’
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

SetFunctionMode(argin: str) → None[source]

Set the Fsp Function Mode, either IDLE, CORR, PSS-BF, PST-BF, or VLBI If IDLE set the pss, pst, corr and vlbi devicess to DISABLE. OTherwise, turn one of them ON according to argin, and all others DISABLE.

Parameters:: argin – one of ‘IDLE’,’CORR’,’PSS-BF’,’PST-BF’, or ‘VLBI’

is_SetFunctionMode_allowed() → bool[source]

Determine if SetFunctionMode is allowed (allowed if FSP state is ON).

Returns:: if SetFunctionMode is allowed
Return type:: bool

class AddSubarrayMembershipCommand(target, *args, logger=None, **kwargs)[source]

Bases: ResponseCommand

A class for the Fsp’s AddSubarrayMembership() command.

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

Stateless hook for AddSubarrayMembership() command functionality.

Parameters:: argin – an integer representing the subarray affiliation
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

AddSubarrayMembership(argin: str) → None[source]

Add a subarray to the subarrayMembership list.

Parameters:: argin – an integer representing the subarray affiliation

is_AddSubarrayMembership_allowed() → bool[source]

Determine if AddSubarrayMembership is allowed (allowed if FSP state is ON).

Returns:: if AddSubarrayMembership is allowed
Return type:: bool

class RemoveSubarrayMembershipCommand(target, *args, logger=None, **kwargs)[source]

Bases: ResponseCommand

A class for the Fsp’s RemoveSubarrayMembership() command.

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

Stateless hook for RemoveSubarrayMembership() command functionality.

Parameters:: argin – an integer representing the subarray affiliation
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

RemoveSubarrayMembership(argin: str) → None[source]

Remove subarray from the subarrayMembership list. If subarrayMembership is empty after removing (no subarray is using this FSP), set function mode to empty.

Parameters:: argin – an integer representing the subarray affiliation

is_RemoveSubarrayMembership_allowed() → bool[source]

Determine if RemoveSubarrayMembership is allowed (allowed if FSP state is ON).

Returns:: if RemoveSubarrayMembership is allowed
Return type:: bool

getConfigID() → str[source]

Get the configID for all the fspCorrSubarray

Returns:: the configID
Return type:: str

class UpdateJonesMatrixCommand(target, *args, logger=None, **kwargs)[source]

Bases: ResponseCommand

A class for the Fsp’s UpdateJonesMatrix() command.

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

Stateless hook for UpdateJonesMatrix() command functionality.

Parameters:: argin – the jones matrix data
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

UpdateJonesMatrix(argin: str) → None[source]

Update the FSP’s jones matrix (serialized JSON object)

Parameters:: argin – the jones matrix data

is_UpdateJonesMatrix_allowed() → bool[source]

Determine if UpdateJonesMatrix is allowed (allowed if FSP state is ON and ObsState is READY OR SCANNINNG).

Returns:: if UpdateJonesMatrix is allowed
Return type:: bool

class UpdateDelayModelCommand(target, *args, logger=None, **kwargs)[source]

Bases: ResponseCommand

A class for the Fsp’s UpdateDelayModel() command.

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

Stateless hook for UpdateDelayModel() command functionality.

Parameters:: argin – the delay model data
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

UpdateDelayModel(argin: str) → None[source]

Update the FSP’s delay model (serialized JSON object)

Parameters:: argin – the delay model data

is_UpdateDelayModel_allowed() → bool[source]

Determine if UpdateDelayModelis allowed (allowed if FSP state is ON and ObsState is READY OR SCANNINNG).

Returns:: if UpdateDelayModel is allowed
Return type:: bool

class UpdateTimingBeamWeightsCommand(target, *args, logger=None, **kwargs)[source]

Bases: ResponseCommand

A class for the Fsp’s UpdateTimingBeamWeights() command.

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

Stateless hook for UpdateTimingBeamWeights() command functionality.

Parameters:: argin – the timing beam weight data
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

UpdateTimingBeamWeights(argin: str) → None[source]

Update the FSP’s timing beam weights (serialized JSON object)

Parameters:: argin – the timing beam weight data

is_UpdateTimingBeamWeights_allowed() → bool[source]

Determine if UpdateTimingBeamWeights is allowed (allowed if FSP state is ON and ObsState is READY OR SCANNINNG).

Returns:: if UpdateTimingBeamWeights is allowed
Return type:: bool

CapID: TANGO property

CapType: TANGO property

ConfigureInstances(argin)

Specify the number of instances of the current capacity to be configured.

To modify behaviour for this command, modify the do() method of the command class.

Parameters:: argin – Number of instances to configure
Returns:: None.

DebugDevice()

Enable remote debugging of this device.

To modify behaviour for this command, modify the do() method of the command class: DebugDeviceCommand.

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.

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.

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 FspClass

TangoClassName = 'Fsp'

activationTime: Device attribute.

adminMode: Device attribute.

buildState: Device attribute.

configurationDelayExpected: Device attribute.

configurationProgress: Device attribute.

configuredInstances: Device attribute.

controlMode: Device attribute.

healthState: Device attribute.

loggingLevel

Device attribute.

See LoggingLevel

loggingTargets: Device attribute.

obsMode: Device attribute.

obsState: Device attribute.

subID: TANGO property

testMode: Device attribute.

usedComponents: Device attribute.

versionId: Device attribute.