ska_tmc_mccsmasterleafnode.manager package

Submodules

ska_tmc_mccsmasterleafnode.manager.component_manager module

This module implements ComponentManager class for the Mccs Master Leaf Node.

class ska_tmc_mccsmasterleafnode.manager.component_manager.MccsMLNComponentManager(*args: Any, **kwargs: Any)

Bases: TmcLeafNodeComponentManager

A component manager for MCCSMasterLeafNode component.

It supports:

  • Monitoring its component, e.g. detect that it has been turned off or on

  • Controlling the behaviour of MCCS Master.

call_off_command(task_callback: Callable) Tuple[ska_control_model.TaskStatus, str]

Submits the Off command for execution.

Return type:

tuple

call_on_command(task_callback: Callable) Tuple[ska_control_model.TaskStatus, str]

Submits the On command for execution.

Return type:

tuple

call_standby_command(task_callback: Callable) Tuple[ska_control_model.TaskStatus, str]

Submits the Standby command for execution. :rtype: tuple

device_failed(device_info: ska_tmc_common.DeviceInfo, exception: Exception) None

Mark a device as failed and invoke the corresponding callback if it exists

param device_info:

a device info

type device_info:

DeviceInfo

param exception:

an exception

type:

Exception

is_command_allowed(command_name: str) bool

Checks whether this command is allowed. It checks that the device is not in the FAULT and UNKNOWN state before executing the command and that all the components needed for the operation are not unresponsive.

Returns:

True if this command is allowed

Return type:

boolean

is_mccs_master_responsive() None

Checks if MCCS Master device is responsive.

property mccs_master_device_name: str

Returns device name for the MCCS Master Device.

update_ping_info(ping: int, dev_name: str) None

Update a device with the correct ping information. :param ping: device response time :type ping: int

Module contents

Init file for MCCSMasterLeafNode Manager

class ska_tmc_mccsmasterleafnode.manager.MccsMLNComponentManager(*args: Any, **kwargs: Any)

Bases: TmcLeafNodeComponentManager

A component manager for MCCSMasterLeafNode component.

It supports:

  • Monitoring its component, e.g. detect that it has been turned off or on

  • Controlling the behaviour of MCCS Master.

call_off_command(task_callback: Callable) Tuple[ska_control_model.TaskStatus, str]

Submits the Off command for execution.

Return type:

tuple

call_on_command(task_callback: Callable) Tuple[ska_control_model.TaskStatus, str]

Submits the On command for execution.

Return type:

tuple

call_standby_command(task_callback: Callable) Tuple[ska_control_model.TaskStatus, str]

Submits the Standby command for execution. :rtype: tuple

device_failed(device_info: ska_tmc_common.DeviceInfo, exception: Exception) None

Mark a device as failed and invoke the corresponding callback if it exists

param device_info:

a device info

type device_info:

DeviceInfo

param exception:

an exception

type:

Exception

is_command_allowed(command_name: str) bool

Checks whether this command is allowed. It checks that the device is not in the FAULT and UNKNOWN state before executing the command and that all the components needed for the operation are not unresponsive.

Returns:

True if this command is allowed

Return type:

boolean

is_mccs_master_responsive() None

Checks if MCCS Master device is responsive.

property mccs_master_device_name: str

Returns device name for the MCCS Master Device.

update_ping_info(ping: int, dev_name: str) None

Update a device with the correct ping information. :param ping: device response time :type ping: int