Subarray Device

SKASubarray.

A SubArray handling device. It allows the assigning/releasing of resources into/from Subarray, configuring capabilities, and exposes the related information like assigned resources, configured capabilities, etc.

class ska_tango_base.subarray.subarray_device.SKASubarray

A generic subarray device for SKA.

SKASubarray inherits from the SKAObsDevice and AbstractSubarrayInterface, and expects a component manager to be provided by implementing the create_component_manager() method.

__init__(*args: Any, **kwargs: Any) → None

Initialise a new instance.

Parameters:

• args – positional arguments.

• kwargs – keyword arguments.

class InitCommand

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

do(*args: Any, **kwargs: Any) → tuple[ResultCode, str]

Stateless hook for device initialisation.

Parameters:

• args – positional arguments to the command. This command does not take any, so this should be empty.

• kwargs – keyword arguments to the command. This command does not take any, so this should be empty.

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

on_new_shared_bus() → None

Initialise signals.

create_component_manager() → ComponentManagerT

Create and return a component manager for this device.

Raises:

NotImplementedError – because it is not implemented.

_component_state_changed(fault: bool | None = None, power: PowerState | None = None, obsfault: bool | None = None, resourced: bool | None = None, configured: bool | None = None, scanning: bool | None = None) → None

Update the device about the component’s state.

Subclasses should ensure that this is called by the component_state_callback callback passed to their component manager.

Parameters:

• fault – The new fault state of the device, or None if unchanged

• power – The new power state of the device, or None if unchanged

read_assignedResources() → list[str]

Read the resources assigned to the device.

The list of resources assigned to the subarray.

Returns:

Resources assigned to the device.

read_configuredCapabilities() → list[str]

Read capabilities configured in the Subarray.

A list of capability types with no. of instances in use on this subarray; e.g. Correlators:512, PssBeams:4 PstBeams:4, VlbiBeams:0.

Returns:

A list of capability types with no. of instances used in the Subarray

class AssignResourcesCommand

A class for SKASubarray’s AssignResources() command.

__init__(command_tracker: CommandTrackerProtocol, component_manager: SubarrayComponentManager, callback: Callable[[bool], None] | None = None, logger: Logger | None = None, schema: dict[str, Any] | None = None) → None

Initialise a new instance.

Parameters:

• command_tracker – the device’s command tracker

• component_manager – the device’s component manager

• callback – an optional callback to be called when this command starts and finishes.

• logger – a logger for this command to log with.

• schema – an optional JSON schema for the command argument.

class ReleaseResourcesCommand

A class for SKASubarray’s ReleaseResources() command.

__init__(command_tracker: CommandTrackerProtocol, component_manager: SubarrayComponentManager, callback: Callable[[bool], None] | None = None, logger: Logger | None = None, schema: dict[str, Any] | None = None) → None

Initialise a new instance.

Parameters:

• command_tracker – the device’s command tracker

• component_manager – the device’s component manager

• callback – an optional callback to be called when this command starts and finishes.

• logger – a logger for this command to log with.

• schema – an optional JSON schema for the command argument.

class ReleaseAllResourcesCommand

A class for SKASubarray’s ReleaseAllResources() command.

__init__(command_tracker: CommandTrackerProtocol, component_manager: SubarrayComponentManager, callback: Callable[[bool], None] | None = None, logger: Logger | None = None) → None

Initialise a new instance.

Parameters:

• command_tracker – the device’s command tracker

• component_manager – the device’s component manager

• callback – an optional callback to be called when this command starts and finishes.

• logger – a logger for this command to log with.

class ConfigureCommand

A class for SKASubarray’s Configure() command.

__init__(command_tracker: CommandTrackerProtocol, component_manager: SubarrayComponentManager, callback: Callable[[bool], None] | None = None, logger: Logger | None = None, schema: dict[str, Any] | None = None) → None

Initialise a new instance.

Parameters:

• command_tracker – the device’s command tracker

• component_manager – the device’s component manager

• callback – an optional callback to be called when this command starts and finishes.

• logger – a logger for this command to log with.

• schema – an optional JSON schema for the command argument.

class ScanCommand

A class for SKASubarray’s Scan() command.

__init__(command_tracker: CommandTrackerProtocol, component_manager: SubarrayComponentManager, callback: Callable[[bool], None] | None = None, logger: Logger | None = None, schema: dict[str, Any] | None = None) → None

Initialise a new instance.

Parameters:

• command_tracker – the device’s command tracker

• component_manager – the device’s component manager

• callback – an optional callback to be called when this command starts and finishes.

• logger – a logger for this command to log with.

• schema – an optional JSON schema for the command argument.

class EndScanCommand

A class for SKASubarray’s EndScan() command.

__init__(command_tracker: CommandTrackerProtocol, component_manager: SubarrayComponentManager, callback: Callable[[bool], None] | None = None, logger: Logger | None = None) → None

Initialise a new instance.

Parameters:

• command_tracker – the device’s command tracker

• component_manager – the device’s component manager

• callback – an optional callback to be called when this command starts and finishes.

• logger – a logger for this command to log with.

class EndCommand

A class for SKASubarray’s End() command.

__init__(command_tracker: CommandTrackerProtocol, component_manager: SubarrayComponentManager, callback: Callable[[bool], None] | None = None, logger: Logger | None = None) → None

Initialise a new instance.

Parameters:

• command_tracker – the device’s command tracker

• component_manager – the device’s component manager

• callback – an optional callback to be called when this command starts and finishes.

• logger – a logger for this command to log with.

class ObsResetCommand

A class for SKASubarray’s ObsReset() command.

__init__(command_tracker: CommandTrackerProtocol, component_manager: SubarrayComponentManager, callback: Callable[[bool], None] | None = None, logger: Logger | None = None) → None

Initialise a new instance.

Parameters:

• command_tracker – the device’s command tracker

• component_manager – the device’s component manager

• callback – an optional callback to be called when this command starts and finishes.

• logger – a logger for this command to log with.

class RestartCommand

A class for SKASubarray’s Restart() command.

__init__(command_tracker: CommandTrackerProtocol, component_manager: SubarrayComponentManager, callback: Callable[[bool], None] | None = None, logger: Logger | None = None) → None

Initialise a new instance.

Parameters:

• command_tracker – the device’s command tracker

• component_manager – the device’s component manager

• callback – an optional callback to be called when this command starts and finishes.

• logger – a logger for this command to log with.

init_command_objects() → None

Set up the command objects.

execute_AssignResources(argin: str) → DevVarLongStringArrayType

Assign resources to this subarray.

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

Parameters:

argin – the resources to be assigned

Returns:

A tuple containing a result code and a string message. If the result code indicates that the command was accepted, the message is the unique ID of the task that will execute the command. If the result code indicates that the command was not excepted, the message explains why.

execute_ReleaseResources(argin: str) → DevVarLongStringArrayType

Delta removal of assigned resources.

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

Parameters:

argin – the resources to be released

Returns:

A tuple containing a result code and the unique ID of the command

execute_ReleaseAllResources() → DevVarLongStringArrayType

Remove all resources to tear down to an empty subarray.

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

Returns:

A tuple containing a result code and the unique ID of the command

execute_Configure(argin: str) → DevVarLongStringArrayType

Configure the capabilities of this subarray.

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

Parameters:

argin – JSON-encoded string with the scan configuration”, configuration specification

Returns:

A tuple containing a result code and the unique ID of the command

execute_Scan(argin: str) → DevVarLongStringArrayType

Start scanning.

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

Parameters:

argin – JSON-encoded string with the per-scan configuration

Returns:

A tuple containing a result code and the unique ID of the command

execute_EndScan() → DevVarLongStringArrayType

End the scan.

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

Returns:

A tuple containing a result code and the unique ID of the command

execute_End() → DevVarLongStringArrayType

End the scan block.

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

Returns:

A tuple containing a result code and the unique ID of the command

execute_ObsReset() → DevVarLongStringArrayType

Reset the current observation process.

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

Returns:

A tuple containing a result code and the unique ID of the command

execute_Restart() → DevVarLongStringArrayType

Restart the subarray. That is, deconfigure and release all resources.

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

Returns:

A tuple containing a result code and the unique ID of the command

ska_tango_base.subarray.subarray_device.main(*args: str, **kwargs: str) → int

Entry point for module.

Parameters:

• args – positional arguments

• kwargs – named arguments

Returns:

exit code