Master

SKAMaster

Master device

Tango Device Class

class ska_tango_base.SKAMaster(*args: Any, **kwargs: Any)

Master device

init_command_objects()

Sets up the command objects

class InitCommand(target, state_model, logger=None)

A class for the SKAMaster’s init_device() “command”.

Create a new InitCommand

Parameters

• target (object) – the object that this command acts upon; for example, the SKASubarray device for which this class implements the command

• state_model (DeviceStateModel) – the state model that this command uses to check that it is allowed to run, and that it drives with actions.

• logger (a logger that implements the standard library logger interface) – the logger to be used by this Command. If not provided, then a default module logger will be used.

do()

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)

MaxCapabilities = tango.server.device_property(dtype=('str',))

elementLoggerAddress = tango.server.attribute(dtype=str, doc=FQDN of Element Logger)

Device attribute.

elementAlarmAddress = tango.server.attribute(dtype=str, doc=FQDN of Element Alarm Handlers)

Device attribute.

elementTelStateAddress = tango.server.attribute(dtype=str, doc=FQDN of Element TelState device)

Device attribute.

elementDatabaseAddress = tango.server.attribute(dtype=str, doc=FQDN of Element Database device)

Device attribute.

maxCapabilities = tango.server.attribute(dtype=('str',), max_dim_x=20, doc=Maximum number of instances of each capability type, e.g. 'CORRELATOR:512', 'PSS-BEAMS:4'.)

Device attribute.

availableCapabilities = tango.server.attribute(dtype=('str',), max_dim_x=20, doc=A list of available number of instances of each capability type, e.g. 'CORRELATOR:512', 'PSS-BEAMS:4'.)

Device attribute.

always_executed_hook()

Method that is always executed before any device command gets executed.

delete_device()

Method to cleanup when device is stopped.

read_elementLoggerAddress()

Reads FQDN of Element Logger device

read_elementAlarmAddress()

Reads FQDN of Element Alarm device

read_elementTelStateAddress()

Reads FQDN of Element TelState device

read_elementDatabaseAddress()

Reads FQDN of Element Database device

read_maxCapabilities()

Reads maximum number of instances of each capability type

read_availableCapabilities()

Reads list of available number of instances of each capability type

class IsCapabilityAchievableCommand(target, state_model, logger=None)

A class for the SKAMaster’s IsCapabilityAchievable() command.

Creates a new BaseCommand object for a device.

Parameters

• state_model (SKABaseClassStateModel or a subclass of same) – the state model that this command uses, for example to raise a fatal error if the command errors out.

• target (object) – the object that this base command acts upon. For example, the device that this BaseCommand implements the command for.

• logger (a logger that implements the standard library logger interface) – the logger to be used by this Command. If not provided, then a default module logger will be used.

do(argin)

Stateless hook for device IsCapabilityAchievable() command.

Returns

Whether the capability is achievable

Return type

bool

isCapabilityAchievable(argin)

Checks of provided capabilities can be achieved by the resource(s).

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

Parameters

argin (tango.DevVarLongStringArray.) –

An array consisting pair of

• [nrInstances]: DevLong. Number of instances of the capability.

• [Capability types]: DevString. Type of capability.

Returns

True if capability can be achieved, False if cannot

Return type

DevBoolean