TMC Common AdapterFactory

1. AdapterFactory

class ska_tmc_common.adapters.AdapterFactory

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

Get a generic adapter for a device if already created, or create a new adapter as per the device type and add to adapter 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

MCCS_SUBARRAY_LEAF_NODE = 11

CSP_SUBARRAY_LEAF_NODE = 12

SDP_SUBARRAY_LEAF_NODE = 13

SDP_MASTER_LEAF_NODE = 14

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

Returns:: proxy of device

property healthState: ska_tango_base.control_model.HealthState

Get the healthState of the Device.

Returns:: HealthState

property dev_name: str

Returns device name.

Returns:: device name

property adminMode

Return AdminMode of adapter

Returns:: AdminMode of adapter

On() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Sets device proxies to ON state.

Returns:: proxy of device

Off() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Sets device proxies to OFF state.

Returns:: proxy of device

Standby() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Sets device proxies to Standby state.

Returns:: proxy of device

Reset() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Sets device proxies to Reset state.

Returns:: proxy of device

Disable() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Sets device proxies to Disable state.

Returns:: proxy of device

State() → tango.DevState

Gives the current device state.

Returns:: Device state.

SetAdminMode(argin) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Sets adminMode on device proxies

Returns:: 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

Returns:: state of CSP Master

property sourceDishVccConfig

Return sourceDishVccConfig value of Csp Master proxy

Returns:: sourceDishVccConfig value of Csp Master proxy

property dishVccConfig

Return dishVccConfig value of Csp Master proxy

Returns:: dishVccConfig value of Csp Master proxy

On(argin) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Sets device proxies to ON state

Returns:: proxy of device

Standby(argin) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Sets device proxies to Standby state

Returns:: proxy of device

Off(argin) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Sets device proxies to Off state

Returns:: proxy of device

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

Invokes LoadDishCfg Command on the csp master device proxy.

Returns:: 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.

Returns:: command invocation on subarray device proxy

ReleaseAllResources() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Invokes ReleaseAllResources on subarray device proxy.

Returns:: command invocation on subarray device proxy

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

Invokes ReleaseResources on subarray device proxy.

Returns:: command invocation on subarray device proxy

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

Invokes Configure on subarray device proxy.

Returns:: command invocation on subarray device proxy

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

Invokes Scan on subarray device proxy.

Returns:: command invocation on subarray device proxy

EndScan() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Invokes EndScan on subarray device proxy.

Returns:: command invocation on subarray device proxy

End() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Invokes End on subarray device proxy.

Returns:: command invocation on subarray device proxy

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

Invokes Abort on subarray device proxy.

Returns:: command invocation on subarray device proxy

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

Invokes Restart on subarray device proxy.

Returns:: command invocation on subarray device proxy

ObsReset() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Invokes Reset on subarray device proxy.

Returns:: 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.

property receive_addresses: str

Retrieves the ‘receiveAddresses’ attribute from the Sdp subarray device proxy.

Returns:: The value of proxy.receiveAddresses

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

Invokes AssignResources on SdpSubarray device proxy.

Returns:: command invocation on sdp subarray device proxy

ReleaseAllResources(callback) → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Invokes ReleaseAllResources on SdpSubarray device proxy.

Returns:: 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.

Returns:: 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]]

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

Invokes End on SdpSubarray device proxy.

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

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

Invokes EndScan on SdpSubarray device proxy.

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

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

Invokes Scan on SdpSubarray device proxy.

Parameters:: callback (callable) – callback to be called in asynchronous execution of Scan 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.

property mccsControllerAdminMode: ska_tango_base.control_model.AdminMode

Return mccs controller admin mode value of master leaf node proxy

Returns:: mccsControllerAdminMode value

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

Invokes AssignResources on device proxy.

Returns:: 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.

Returns:: 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.

Returns:: 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.

Returns:: command invocation on Dish device proxy

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

Invokes ConfigureBand on the dish device proxy.

Parameters:

argin (str) – configuration string.

Returns:

result codes and messages: returned by the device proxy.

Return type:

Tuple[List[ResultCode], List[str]]

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

property trackTableLoadMode: TrackTableLoadMode

Returns Dish Manager’s TrackTableLoadMode attribute value.

Return type:: 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.

Returns:: 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.

Returns:: 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.

Returns:: 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.

Returns:: 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:: dish mode of dish device.
Return type:: DishMode

property kValue: int

Get the kValue from the dish manager.

Returns:: Kvalue

property sdpQueueConnectorFqdn: str

Get the sdpQueueConnectorFqdn from the dish manager.

Returns:: sdpQueueConnectorFqdn

SetStandbyFPMode() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Invokes SetStandbyFPMode on device proxy.

Returns:: command invocation on Dish Leaf Node device proxy

SetStandbyLPMode() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Invokes SetStandbyLPMode on device proxy.

Returns:: command invocation on Dish Leaf Node device proxy

SetStowMode() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Invokes SetStowMode on device proxy.

Returns:: 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.

Returns:: 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.

Returns:: 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.

Returns:: 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.

Returns:: 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.

Returns:: 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.

Returns:: 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.

Returns:: command invocation on Dish Leaf Node device proxy

Track() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Invokes Track on device proxy.

Returns:: command invocation on Dish Leaf Node device proxy

TrackStop() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Invokes TrackStop on device proxy.

Returns:: 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.

Returns:: 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.

Returns:: command invocation on Dish Leaf Node device proxy

EndScan() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Invokes EndScan on device proxy.

Returns:: command invocation on Dish Leaf Node device proxy

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

Invokes Restart on device proxy.

Returns:: command invocation on Dish Leaf Node device proxy

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

Invokes Abort on device proxy.

Returns:: command invocation on Dish Leaf Node device proxy

ObsReset() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Invokes Reset on device proxy.

Returns:: command invocation on Dish Leaf Node device proxy

Reset() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

Invokes Reset on device proxy.

Returns:: 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.

Returns:: 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

12. DishlnPointingDeviceAdapter

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

This class is used for creating and managing adapter of DishLeaf node pointing device.

property pointingProgramTrackTable: str

Get the programTrackTable from the DishLeaf Node Pointing Device.

Returns:: str

property targetData: str

Get the target data from DishLeaf Node Pointing Device.

Returns:: str

GenerateProgramTrackTable() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

This command instructs dish pointing device to start generating program track table.

Returns:: ResultCode and message
Return type:: Tuple[List[ResultCode], List[str]]

StopProgramTrackTable() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

This command instructs dish pointing device to stop generation of program track table.

Returns:: ResultCode and message
Return type:: Tuple[List[ResultCode], List[str]]

NextPointingOffset() → Tuple[List[ska_tango_base.commands.ResultCode], List[str]]

This command sets next pointing offset for given scan.

Returns:: ResultCode and message
Return type:: Tuple[List[ResultCode], List[str]]