SKAController Tango Device

A generic controller device for SKA.

SKAController inherits from the SKABaseDevice and ControllerInterface, and expects a component manager to be provided by implementing the create_component_manager() method.

Properties

SKAController.GroupDefinitions

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.

Data type:: DevVarStringArray

SKAController.LoggingLevelDefault

Default logging level at device startup.

Data type:: DevUShort
Default value:: 4

SKAController.LoggingTargetsDefault

Default logging targets at device startup.

Data type:: DevVarStringArray
Default value:: [‘tango::logger’]

SKAController.MaxCapabilities

List of maximum number of instances per capability type provided by this element.

Data type:: DevVarStringArray

SKAController.SkaLevel

Indication of importance of the device in the SKA hierarchy to support drill-down navigation: 1..6, with 1 highest.

Data type:: DevShort
Default value:: 4

Attributes

SKAController.State

The operational state of the device as enumeration.

Access:: READ
Data type:: DevState
Data format:: SCALAR

SKAController.Status

More detailed textual information about the device’s status.

Access:: READ
Data type:: DevString
Data format:: SCALAR

SKAController.adminMode

The Admin Mode of the device.

It may interpret the current device condition and condition of all managed devices to set this.

Access:: READ_WRITE
Data type:: DevEnum
Data format:: SCALAR

SKAController.availableCapabilities

A list of available number of instances of each capability type, e.g. ‘CORRELATOR:512’, ‘PSS-BEAMS:4’.

Access:: READ
Data type:: DevString
Data format:: SPECTRUM
Max_dim_x:: 20

SKAController.buildState

Read the Build State of the device.

Access:: READ
Data type:: DevString
Data format:: SCALAR

SKAController.commandedState

The last commanded Operating State of the device.

Initial string is “None”. Only other strings it can change to is “OFF”, “STANDBY” or “ON”, following the Off(), Standby() or On() commands. If the state transition commands are long running commands the commanded state will only update when the long running command starts executing.

Access:: READ
Data type:: DevString
Data format:: SCALAR

SKAController.controlMode

The control mode of the device.

A Tango Device accepts only from a ‘local’ client and ignores commands and queries received from TM or any other ‘remote’ clients. The local client has to release LOCAL control before REMOTE clients can take control again.

Access:: READ_WRITE
Data type:: DevEnum
Data format:: SCALAR

SKAController.healthInfo

(‘Read the Health Info of the device.nnIt provides an explanation for the currently reported Health State’,)

Access:: READ
Data type:: DevString
Data format:: SPECTRUM
Max_dim_x:: 256

SKAController.healthState

Read the Health State of the device.

It interprets the current device condition and condition of all managed devices to set this.

Access:: READ
Data type:: DevEnum
Data format:: SCALAR

SKAController.loggingLevel

Read the logging level of the device.

Initialises to LoggingLevelDefault on startup. See LoggingLevel

Access:: READ_WRITE
Data type:: DevEnum
Data format:: SCALAR

SKAController.loggingTargets

Read the additional logging targets of the device.

Note that this excludes the handlers provided by the ska_ser_logging library defaults - initialises to LoggingTargetsDefault on startup.

Access:: READ_WRITE
Data type:: DevString
Data format:: SPECTRUM
Max_dim_x:: 4

SKAController.longRunningCommandIDsInQueue

Read the IDs of the long running commands in the queue.

Every client that executes a command will receive a command ID as response. Keep track of IDs currently allocated. Entries are removed self._command_tracker._removal_time seconds after they have finished.

DEPRECATED: A client can check for the queued command(s) in ‘lrcQueue’.

Access:: READ
Data type:: DevString
Data format:: SPECTRUM
Max_dim_x:: 32

SKAController.longRunningCommandInProgress

Read the name(s) of the currently executing long running command(s).

Name(s) of command and possible abort in progress or empty string(s).

DEPRECATED: A client can check for the command(s) in progress in ‘lrcExecuting’.

Access:: READ
Data type:: DevString
Data format:: SPECTRUM
Max_dim_x:: 2

SKAController.longRunningCommandProgress

Read the progress of the currently executing long running command(s).

ID, progress of the currently executing command(s). Clients can subscribe to on change event and wait for the ID they are interested in.

DEPRECATED: A client can check the progress of command(s) in ‘lrcExecuting’.

Access:: READ
Data type:: DevString
Data format:: SPECTRUM
Max_dim_x:: 4

SKAController.longRunningCommandResult

Read the result of the completed long running command.

Reports unique ID and json-encoded result. Clients can subscribe to on change event and wait for the ID they are interested in.

DEPRECATED: A client can check for the result of a command in ‘lrcFinished’.

Access:: READ
Data type:: DevString
Data format:: SPECTRUM
Max_dim_x:: 2

SKAController.longRunningCommandStatus

Read the status of the currently executing long running commands.

ID, status pairs of the currently executing commands. Clients can subscribe to on change event and wait for the ID they are interested in.

DEPRECATED: A client can check for the status of a command in the ‘lrcQueue’, ‘lrcExecuting’ and ‘lrcFinished’ attributes.

Access:: READ
Data type:: DevString
Data format:: SPECTRUM
Max_dim_x:: 64

SKAController.longRunningCommandsInQueue

Read the long running commands in the queue.

Keep track of which commands are that are currently known about. Entries are removed self._command_tracker._removal_time seconds after they have finished.

DEPRECATED: A client can check for the queued command(s) in ‘lrcQueue’.

Access:: READ
Data type:: DevString
Data format:: SPECTRUM
Max_dim_x:: 32

SKAController.lrcExecuting

A list of info JSON blobs of the currently executing commands.

Access:: READ
Data type:: DevString
Data format:: SPECTRUM
Max_dim_x:: 2

SKAController.lrcFinished

A list of info JSON blobs of the finished long running commands.

Access:: READ
Data type:: DevString
Data format:: SPECTRUM
Max_dim_x:: 100

SKAController.lrcProtocolVersions

Return supported protocol versions.

Access:: READ
Data type:: DevLong64
Data format:: SPECTRUM
Max_dim_x:: 2

SKAController.lrcQueue

A list of info JSON blobs of the commands in queue.

Access:: READ
Data type:: DevString
Data format:: SPECTRUM

SKAController.maxCapabilities

Maximum number of instances of each capability type, e.g. ‘CORRELATOR:512’, ‘PSS-BEAMS:4’.

Access:: READ
Data type:: DevString
Data format:: SPECTRUM
Max_dim_x:: 20

SKAController.simulationMode

When TRUE the device is using a simulator.

Access:: READ_WRITE
Data type:: DevEnum
Data format:: SCALAR

SKAController.testMode

If TEST the device is using testing logic.

Access:: READ_WRITE
Data type:: DevEnum
Data format:: SCALAR

SKAController.versionId

Read the Version Id of the device.

Access:: READ
Data type:: DevString
Data format:: SCALAR

Commands

SKAController.Abort() → DevVarLongStringArray

Abort any executing long running command(s) and empty the queue.

Returns:: [ResultCode.STARTED][Command ID]

SKAController.AbortCommands() → DevVarLongStringArray

Empty out long running commands in queue.

DEPRECATED: A client should call the tracked ‘Abort’ long running command instead.

Returns:: [ResultCode.STARTED][‘Aborting commands’]

SKAController.CheckLongRunningCommandStatus(DevString) → DevString

Check the status of a long running command by ID.

Returns:: Status of the asynchronous task.

SKAController.DebugDevice() → DevUShort

Enable remote debugging of this device.

Returns:: The TCP port the debugger is listening on.

SKAController.GetVersionInfo() → DevVarStringArray

Get the version information of the device.

Returns:: The device class name and its package information.

SKAController.Init() → DevVoid: Reinitialise the Tango device.

SKAController.IsCapabilityAchievable(DevVarLongStringArray) → DevBoolean

Check if provided capabilities can be achieved by the resource(s).

Parameter:: [No. of instances][Capability types]
Returns:: [ResultCode][Command ID]

SKAController.Off() → DevVarLongStringArray

Turn the device off.

Returns:: [ResultCode][Status message or command ID]

SKAController.On() → DevVarLongStringArray

Turn the device on.

Returns:: [ResultCode][Status message or command ID]

SKAController.Reset() → DevVarLongStringArray

Reset the device.

Returns:: [ResultCode][Status message or command ID]

SKAController.Standby() → DevVarLongStringArray

Put the device into standby mode.

Returns:: [ResultCode][Status message or command ID]