ska_tmc_sdpmasterleafnode.commands package

Link to the TMC User documentation is here.

Submodules

ska_tmc_sdpmasterleafnode.commands.sdp_mln_command module

SDP Master Leaf Node Base Command Class for SDP Master Leaf Node

class ska_tmc_sdpmasterleafnode.commands.sdp_mln_command.SdpMLNCommand(*args: Any, **kwargs: Any)

Bases: TmcLeafNodeCommand

Abstract command class for all SdpMasterLeafNode

do(argin: Optional[Any] = None)

Abstract Method from TmcLeafNodeCommand is defined here but not utilized by this Class.

Parameters:

argin (_type_, optional) – Accepts argument if required. Defaults to None.

do_low(argin: Optional[Any] = None)

Abstract Method from TmcLeafNodeCommand is defined here but not utilized by this Class.

Parameters:

argin (_type_, optional) – Accepts argument if required. Defaults to None.

do_mid(argin: Optional[Any] = None)

Abstract Method from TmcLeafNodeCommand is defined here but not utilized by this Class.

Parameters:

argin (_type_, optional) – Accepts argument if required. Defaults to None.

init_adapter() → Tuple[ska_tango_base.commands.ResultCode, str]

Initialises required adapters

Returns:

Tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

init_adapter_low()

Initialises required adapters for low

init_adapter_mid()

Initialises required adapters for mid

update_task_status(**kwargs)

Abstract Method from TmcLeafNodeCommand is defined here but not utilized by this Class.

ska_tmc_sdpmasterleafnode.commands.off_command module

Off command class for SdpMasterLeafNode.

class ska_tmc_sdpmasterleafnode.commands.off_command.Off(*args: Any, **kwargs: Any)

Bases: SdpMLNCommand

A class for SdpMasterLeafNode’s Off() command.

Off command on SdpMasterLeafNode enables the telescope to perform further operations and observations. It Invokes Off command on Sdp Master device.

do(argin: Optional[Any] = None) → Tuple[ska_tango_base.commands.ResultCode, str]

Method to invoke Off command on Sdp Master.

Parameters:

argin – Optional argument.

Returns:

Tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

off(logger: Logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Optional[Event] = None) → None

A method to invoke the Off command. It sets the task_callback status according to command progress.

Parameters:

• logger (logging.Logger) – logger

• task_callback (TaskCallbackType) – Update task state, defaults to None

• task_abort_event (Event, optional) – Check for abort, defaults to None

ska_tmc_sdpmasterleafnode.commands.on_command module

On command class for SdpMasterLeafNode.

class ska_tmc_sdpmasterleafnode.commands.on_command.On(*args: Any, **kwargs: Any)

Bases: SdpMLNCommand

A class for SdpMasterLeafNode’s On() command.

On command on SdpmasterLeafNode enables the telescope to perform further operations and observations. It Invokes On command on Sdp Master device.

do(argin: Optional[Any] = None) → Tuple[ska_tango_base.commands.ResultCode, str]

Method to invoke On command on Sdp Master.

Parameters:

argin – Optional argument.

Returns:

Tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

on(logger: Logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Optional[Event] = None) → None

A method to invoke the On command. It sets the task_callback status according to command progress.

Parameters:

• logger (logging.Logger) – logger

• task_callback (TaskCallbackType) – Update task state, defaults to None

• task_abort_event (Event, optional) – Check for abort, defaults to None

ska_tmc_sdpmasterleafnode.commands.standby_command module

Standby command class for SdpMaster Leaf Node

class ska_tmc_sdpmasterleafnode.commands.standby_command.Standby(*args: Any, **kwargs: Any)

Bases: SdpMLNCommand

A class for SDP MasterLeafNode’s Standby() command.

Standby command on SDP MasterLeafNode invokes Standby command on SDP Master device.

do(argin: Optional[Any] = None) → Tuple[ska_tango_base.commands.ResultCode, str]

Method to invoke Standby command on Sdp Master.

Parameters:

argin – Optional argument.

Returns:

Tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

standby(logger: Logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Optional[Event] = None) → None

A method to invoke the Standby command. It sets the task_callback status according to command progress.

Parameters:

• logger (logging.Logger) – logger

• task_callback (TaskCallbackType) – Update task state, defaults to None

• task_abort_event (Event, optional) – Check for abort, defaults to None

ska_tmc_sdpmasterleafnode.commands.set_controller_admin_mode_command module

SetAdminMode command class for SDPMasterLeafNode.

class ska_tmc_sdpmasterleafnode.commands.set_controller_admin_mode.SetAdminMode(*args: Any, **kwargs: Any)

Bases: SdpMLNCommand, FastCommand

A class for SdpMasterLeafNode’s SetAdminMode() command.

SetAdminMode command on SdpMasterLeafNode enables to set the adminMode of the SDP controller device

do(argin: ska_control_model.AdminMode) → Tuple[ska_tango_base.commands.ResultCode, str]

A method to set the adminMode of the SDP controller device

Parameters:

argin (AdminMode) – adminMode enum value to be set for SDP controller device.

Returns:

Tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

Module contents

Init module for SDP Master Leaf Node

class ska_tmc_sdpmasterleafnode.commands.Off(*args: Any, **kwargs: Any)

Bases: SdpMLNCommand

A class for SdpMasterLeafNode’s Off() command.

Off command on SdpMasterLeafNode enables the telescope to perform further operations and observations. It Invokes Off command on Sdp Master device.

do(argin: Optional[Any] = None) → Tuple[ska_tango_base.commands.ResultCode, str]

Method to invoke Off command on Sdp Master.

Parameters:

argin – Optional argument.

Returns:

Tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

off(logger: Logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Optional[Event] = None) → None

A method to invoke the Off command. It sets the task_callback status according to command progress.

Parameters:

• logger (logging.Logger) – logger

• task_callback (TaskCallbackType) – Update task state, defaults to None

• task_abort_event (Event, optional) – Check for abort, defaults to None

class ska_tmc_sdpmasterleafnode.commands.On(*args: Any, **kwargs: Any)

Bases: SdpMLNCommand

A class for SdpMasterLeafNode’s On() command.

On command on SdpmasterLeafNode enables the telescope to perform further operations and observations. It Invokes On command on Sdp Master device.

do(argin: Optional[Any] = None) → Tuple[ska_tango_base.commands.ResultCode, str]

Method to invoke On command on Sdp Master.

Parameters:

argin – Optional argument.

Returns:

Tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

on(logger: Logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Optional[Event] = None) → None

A method to invoke the On command. It sets the task_callback status according to command progress.

Parameters:

• logger (logging.Logger) – logger

• task_callback (TaskCallbackType) – Update task state, defaults to None

• task_abort_event (Event, optional) – Check for abort, defaults to None

class ska_tmc_sdpmasterleafnode.commands.SetAdminMode(*args: Any, **kwargs: Any)

Bases: SdpMLNCommand, FastCommand

A class for SdpMasterLeafNode’s SetAdminMode() command.

SetAdminMode command on SdpMasterLeafNode enables to set the adminMode of the SDP controller device

do(argin: ska_control_model.AdminMode) → Tuple[ska_tango_base.commands.ResultCode, str]

A method to set the adminMode of the SDP controller device

Parameters:

argin (AdminMode) – adminMode enum value to be set for SDP controller device.

Returns:

Tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

class ska_tmc_sdpmasterleafnode.commands.Standby(*args: Any, **kwargs: Any)

Bases: SdpMLNCommand

A class for SDP MasterLeafNode’s Standby() command.

Standby command on SDP MasterLeafNode invokes Standby command on SDP Master device.

do(argin: Optional[Any] = None) → Tuple[ska_tango_base.commands.ResultCode, str]

Method to invoke Standby command on Sdp Master.

Parameters:

argin – Optional argument.

Returns:

Tuple of ResultCode and message.

Return type:

Tuple[ResultCode, str]

standby(logger: Logger, task_callback: ska_tango_base.base.TaskCallbackType, task_abort_event: Optional[Event] = None) → None

A method to invoke the Standby command. It sets the task_callback status according to command progress.

Parameters:

• logger (logging.Logger) – logger

• task_callback (TaskCallbackType) – Update task state, defaults to None

• task_abort_event (Event, optional) – Check for abort, defaults to None