CbfDevice Class

class ska_mid_cbf_mcs.base.base_device.CbfDevice(*args: Any, **kwargs: Any)[source]

Bases: SKABaseDevice

A generic base device for Mid.CBF. Extends SKABaseDevice to override certain key values.

InitCommand = None
On: Callable[[BaseInterface], DevVarLongStringArrayType] | None = None
Off: Callable[[BaseInterface], DevVarLongStringArrayType] | None = None
Standby: Callable[[BaseInterface], DevVarLongStringArrayType] | None = None
Reset: Callable[[BaseInterface], DevVarLongStringArrayType] | None = None
is_On_allowed = None
is_Off_allowed = None
is_Standby_allowed = None
is_Reset_allowed = None
health_info_signal: AttrSignal[str]

Signal for the healthInfo attribute. Values are emitted for this signal whenever a client changes the attribute.

healthInfo: attribute_from_signal

healthInfo device attribute

init_device() None[source]

Initialise the tango device after startup.

delete_device() None[source]

Clean up device at shutdown.

write_adminMode(value: ska_control_model.AdminMode) None[source]

Set the Admin Mode of the device. Overriding SKABaseDevice to submit AdminMode-related component manager methods to task executor.

Parameters:

value – Admin Mode of the device.

Raises:

ValueError – for disallowed or unknown AdminMode value

submit_long_running_command(command_name: str, task: callable, args: list[Any] | None = None, kwargs: dict[str, Any] | None = None, started_callback: callable | None = None, completed_callback: callable | None = None) ska_tango_base.type_hints.DevVarLongStringArrayType[source]

Allocate a long-running command and submit the task to the task executor.

Parameters:
  • command_name – LRC name

  • task – LRC task, typically a method of the component manager

  • args – optional list of positional arguments for the task

  • kwargs – optional dict of keyword arguments for the task

  • started_callback – optional callback to call when the task’s status is set to TaskStatus.IN_PROGRESS

  • completed_callback – optional callback to call when the task’s status is set to TaskStatus.COMPLETED

Returns:

tuple containing a result code and either a unique command identifier or a message