TMC Common AdapterFactory

1. AdapterFactory

class ska_tmc_common.adapters.AdapterFactory

This class is used for creating and managing adapterss for CSP subarray devices .

Get a generic adapter for a device if already created or create new adapter as per the device type and add to adpter list

Parameters:: dev_name – device name
Returns:: adapter

2. AdapterType

class ska_tmc_common.adapters.AdapterType(value)

This class assigns enum value to different adapters.

BASE = 0

SUBARRAY = 1

DISH = 2

MCCS_MASTER_LEAF_NODE = 3

CSPSUBARRAY = 4

CSPMASTER = 5

SDPSUBARRAY = 6

MCCS_CONTROLLER = 7

CSP_MASTER_LEAF_NODE = 8

DISH_LEAF_NODE = 9

DISHLN_POINTING_DEVICE = 10

3. BaseAdapter

class ska_tmc_common.adapters.BaseAdapter(dev_name: str, proxy: tango.DeviceProxy)

It is base class used in creating adapters.

property proxy: tango.DeviceProxy: Sets proxy of device :return: proxy of device

property healthState: ska_tango_base.control_model.HealthState: Get the healthState of the Device. :return: HealthState

property dev_name: str: Returns device name. :return: device name

property adminMode: Return AdminMode of adapter :return: AdminMode of adapter

On() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Sets device proxies to ON state. :return: proxy of device

Off() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Sets device proxies to OFF state. :return: proxy of device

Standby() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Sets device proxies to Standby state. :return: proxy of device

Reset() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Sets device proxies to Reset state. :return: proxy of device

Disable() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Sets device proxies to Disable state. :return: proxy of device

State() → tango.DevState: Gives the current device state. :return: Device state.

SetAdminMode(argin) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Sets adminMode on device proxies :return: proxy of device

4. CspMasterAdapter

class ska_tmc_common.adapters.CspMasterAdapter(dev_name: str, proxy: tango.DeviceProxy)

This class is used for creating and managing adapterss for CSP master devices.

property state: Return current state of CSP Master :return: state of CSP Master

property sourceDishVccConfig: Return sourceDishVccConfig value of Csp Master proxy :return: sourceDishVccConfig value of Csp Master proxy

property dishVccConfig: Return dishVccConfig value of Csp Master proxy :return: dishVccConfig value of Csp Master proxy

On(argin) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Sets device proxies to ON state :return: proxy of device

Standby(argin) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Sets device proxies to Standby state :return: proxy of device

Off(argin) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Sets device proxies to Off state :return: proxy of device

LoadDishCfg(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes LoadDishCfg Command on the csp master device proxy. :return: command invocation on csp master device proxy

5. SubarrayAdapter

class ska_tmc_common.adapters.SubarrayAdapter(dev_name: str, proxy: tango.DeviceProxy)

This class is used for creating and managing adapters for Subarray devices.

AssignResources(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes AssignResources on subarray device proxy. :return: command invocation on subarray device proxy

ReleaseAllResources() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes ReleaseAllResources on subarray device proxy. :return: command invocation on subarray device proxy

ReleaseResources(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes ReleaseResources on subarray device proxy. :return: command invocation on subarray device proxy

Configure(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes Configure on subarray device proxy. :return: command invocation on subarray device proxy

Scan(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes Scan on subarray device proxy. :return: command invocation on subarray device proxy

EndScan() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes EndScan on subarray device proxy. :return: command invocation on subarray device proxy

End() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes End on subarray device proxy. :return: command invocation on subarray device proxy

Abort() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes Abort on subarray device proxy. :return: command invocation on subarray device proxy

Restart() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes Restart on subarray device proxy. :return: command invocation on subarray device proxy

ObsReset() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes Reset on subarray device proxy. :return: command invocation on subarray device proxy

6. SdpSubArrayAdapter

class ska_tmc_common.adapters.SdpSubArrayAdapter(dev_name: str, proxy: tango.DeviceProxy)

This class is used for creating and managing adapters for SdpSubarray devices.

AssignResources(argin: str, callback) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes AssignResources on SdpSubarray device proxy. :return: command invocation on sdp subarray device proxy

ReleaseAllResources(callback) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes ReleaseAllResources on SdpSubarray device proxy. :return: command invocation on sdp subarray device proxy

Configure(argin: str, callback) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes Configure on SdpSubarray device proxy. :return: command invocation on sdp subarray device proxy

Abort(callback: Callable) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Invokes Abort on SdpSubarray device proxy.

Parameters:: callback (callable) – callback to be called in asynchronous execution of Abort command.
Returns:: command invocation on sdp subarray device proxy
Return type:: Tuple[List[ResultCode], List[str]]

Restart(callback: Callable) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Invokes Restart on SdpSubarray device proxy.

Parameters:: callback (callable) – callback to be called in asynchronous execution of Restart command.
Returns:: command invocation on sdp subarray device proxy
Return type:: Tuple[List[ResultCode], List[str]]

7. MCCSMasterLeafNodeAdapter

class ska_tmc_common.adapters.MCCSMasterLeafNodeAdapter(dev_name: str, proxy: tango.DeviceProxy)

This class is used for creating and managing adapters for MCCS master leaf node device.

AssignResources(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes AssignResources on device proxy. :return: command invocation on MCCS master leaf node device proxy

ReleaseAllResources(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes ReleaseAllResources on device proxy. :return: command invocation on MCCS master leaf node device proxy

Abort(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes Abort on subarray device proxy. :return: command invocation on subarray device proxy

8. DishAdapter

class ska_tmc_common.adapters.DishAdapter(dev_name: str, proxy: tango.DeviceProxy)

This class is used as an Adapter for Dish Master Devices.

TrackLoadStaticOff(argin: List[float]) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes TrackLoadStaticOff on device proxy. :return: command invocation on Dish device proxy

property programTrackTable: List[float]: Returns Dish Manager’s programTrackTable attribute value.

property trackTableLoadMode: TrackTableLoadMode: Returns Dish Manager’s TrackTableLoadMode attribute value. :rtype: TrackTableLoadMode

property scanID: str: Returns Dish Manager’s scanID attribute value.

9. CspSubarrayAdapter

class ska_tmc_common.adapters.CspSubarrayAdapter(dev_name: str, proxy: tango.DeviceProxy)

This class is used for creating and managing adapterss for CSP subarray devices proxy.

End() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes End on device proxy. :return: command invocation on CSP Subarray device proxy

10. MCCSControllerAdapter

class ska_tmc_common.adapters.MCCSControllerAdapter(dev_name: str, proxy: tango.DeviceProxy)

This class is used for creating and managing adapters for MCCS controller devices.

Allocate(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes Allocate on MCCS controller device proxy. :return: command invocation on MCCS Controller device proxy

Release(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes Release on MCCS controller device proxy. :return: command invocation on MCCS Controller device proxy

RestartSubarray(argin: int) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes RestartSubarray on MCCS controller device proxy. :return: command invocation on MCCS Controller device proxy

11. DishLeafAdapter

class ska_tmc_common.adapters.DishLeafAdapter(dev_name: str, proxy: tango.DeviceProxy)

This class is used for creating and managing adapters for Dishes proxy.

property dishMode: DishMode

Get the dishMode from the dish manager.

Returns:: DishMode: dish mode of dish device.

property kValue: int: Get the kValue from the dish manager. :return: Kvalue

property sdpQueueConnectorFqdn: str: Get the sdpQueueConnectorFqdn from the dish manager. :return: sdpQueueConnectorFqdn

SetStandbyFPMode() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes SetStandbyFPMode on device proxy. :return: command invocation on Dish Leaf Node device proxy

SetOperateMode() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes SetOperateMode on device proxy. :return: command invocation on Dish Leaf Node device proxy

SetStandbyLPMode() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes SetStandbyLPMode on device proxy. :return: command invocation on Dish Leaf Node device proxy

SetStowMode() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes SetStowMode on device proxy. :return: command invocation on Dish Leaf Node device proxy

Configure(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes Configure on device proxy. :return: command invocation on Dish Leaf Node device proxy

ConfigureBand1(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes ConfigureBand1 on device proxy. :return: command invocation on Dish Leaf Node device proxy

ConfigureBand2(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes ConfigureBand2 on device proxy. :return: command invocation on Dish Leaf Node device proxy

ConfigureBand3(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes ConfigureBand3 on device proxy. :return: command invocation on Dish Leaf Node device proxy

ConfigureBand4(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes ConfigureBand4 on device proxy. :return: command invocation on Dish Leaf Node device proxy

ConfigureBand5a(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes ConfigureBand5a on device proxy. :return: command invocation on Dish Leaf Node device proxy

ConfigureBand5b(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes ConfigureBand5b on device proxy. :return: command invocation on Dish Leaf Node device proxy

Track() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes Track on device proxy. :return: command invocation on Dish Leaf Node device proxy

TrackStop() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes TrackStop on device proxy. :return: command invocation on Dish Leaf Node device proxy

TrackLoadStaticOff(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes TrackLoadStaticOff on device proxy. :return: command invocation on Dish Leaf Node device proxy

Scan(argin: str) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes Scan on device proxy. :return: command invocation on Dish Leaf Node device proxy

EndScan() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes EndScan on device proxy. :return: command invocation on Dish Leaf Node device proxy

Restart() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes Restart on device proxy. :return: command invocation on Dish Leaf Node device proxy

AbortCommands() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes Abort on device proxy. :return: command invocation on Dish Leaf Node device proxy

ObsReset() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes Reset on device proxy. :return: command invocation on Dish Leaf Node device proxy

Reset() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes Reset on device proxy. :return: command invocation on Dish Leaf Node device proxy

SetKValue(kvalue: int) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]: Invokes SetKValue Command on device proxy. :return: command invocation on Dish Leaf Node device proxy

ApplyPointingModel(argin: List[float]) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Invokes ApplyPointingModel on device proxy. Its a dummy command at present. Will be renamed, once Dish ICD gets updated.

Returns:: command invocation on Dish device proxy