ska_tmc_dishleafnode.dish_leaf_node module

This is DishLeafNode TANGO device.

class ska_tmc_dishleafnode.dish_leaf_node.MidTmcLeafNodeDish(*args: Any, **kwargs: Any)

Bases: TMCBaseLeafDevice

A Leaf control node for DishMaster.

Device Properties:

MidDishControl:

FQDN of Dish Master Device

Device Attributes:

CommandExecuted:

Stores command executed on the device.

DishMasterDevName:

Stores Dish Master Device name.

class InitCommand(*args: Any, **kwargs: Any)

Bases: InitCommand

A class for the TMC DishLeafNode init_device() method.

do()

Initializes the attributes and properties of the MidTmcLeafNodeDish.

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

rtype:

(ResultCode, str)

create_component_manager()

delete_device()

globalPointingModelParams() → str

Returns the globalpointingModelparam attribute value.

init_command_objects() → None

Initializes the command handlers for commands supported by this device.

init_device()

is_Abort_allowed() → bool

Checks whether this command is allowed to be run in current device state

Returns:

True if this command is allowed to be run in current device state

Return type:

boolean

is_ApplyPointingModel_allowed() → bool

Checks whether this command is allowed to be run in the current device state.

Returns:

True if this command is allowed to be run in current device state.

Return type:

boolean

is_ConfigureBand_allowed() → bool

Checks whether this command is allowed to be run in the current device state.

Returns:

True if this command is allowed to be run in current device state.

Return type:

boolean

is_Configure_allowed() → bool

Checks whether this command is allowed to be run in the current dish mode.

Returns:

True if this command is allowed to be run in current dish mode.

Return type:

boolean

is_EndScan_allowed() → Union[bool, ska_tmc_common.CommandNotAllowed, ska_tmc_common.DeviceUnresponsive]

Checks whether this command is allowed to be run in the current dish mode.

Returns:

True if this command is allowed to be run in current dish mode, raises CommandNotAllowed in case is is not allowed and DeviceUnresponsive in case Device is not responsive.

Return type:

Union[bool, CommandNotAllowed, DeviceUnresponsive]

is_ObsReset_allowed() → bool

Checks whether this command is allowed to be run in current device state

Returns:

True if this command is allowed to be run in current device state

Return type:

boolean

is_Restart_allowed() → bool

Checks whether this command is allowed to be run in current device state

Returns:

True if this command is allowed to be run in current device state

Return type:

boolean

is_Scan_allowed() → Union[bool, ska_tmc_common.CommandNotAllowed, ska_tmc_common.DeviceUnresponsive]

Checks whether this command is allowed to be run in the current dish mode.

Returns:

True if this command is allowed to be run in current dish mode, raises CommandNotAllowed in case is is not allowed and DeviceUnresponsive in case Device is not responsive.

Return type:

Union[bool, CommandNotAllowed, DeviceUnresponsive]

is_SetKValue_allowed() → bool

Checks whether this command is allowed to be run in current device state

Returns:

True if this command is allowed to be run in current device state

Return type:

boolean

is_SetOperateMode_allowed() → bool

Checks whether this command is allowed to be run in the current dish mode.

Returns:

True if this command is allowed to be run in current dish mode.

Return type:

boolean

is_SetStandbyFPMode_allowed() → bool

Checks whether this command is allowed to be run in the current dish mode.

Returns:

True if this command is allowed to be run in current dish mode.

Return type:

boolean

is_SetStandbyLPMode_allowed() → bool

Checks whether this command is allowed to be run in the current dish mode.

Returns:

True if this command is allowed to be run in current dish mode

Return type:

boolean

is_SetStowMode_allowed() → bool

Checks whether this command is allowed to be run in the current dish mode.

Returns:

True if this command is allowed to be run in current dish mode.

Return type:

boolean

is_StartCapture_allowed() → bool

Checks whether this command is allowed to be run in the current device state.

Returns:

True if this command is allowed to be run in current device state.

Return type:

boolean

is_StopCapture_allowed() → bool

Checks whether this command is allowed to be run in the current device state.

Returns:

True if this command is allowed to be run in current device state.

Return type:

boolean

is_TrackLoadStaticOff_allowed() → bool

Checks whether this command is allowed to be run in the current device state.

Returns:

True if this command is allowed to be run in current device state.

Return type:

boolean

is_TrackStop_allowed() → bool

Checks whether this command is allowed to be run in the current device state.

Returns:

True if this command is allowed to be run in current device state.

Return type:

boolean

is_Track_allowed() → bool

Checks whether this command is allowed to be run in the current device state.

Returns:

True if this command is allowed to be run in current device state.

Return type:

boolean

is_off_allowed()

Checks whether this command is allowed to be run in the current device state.

Returns:

True if this command is allowed to be run in current device state.

Return type:

boolean

kValue(k_value: int) → None

Set the dish k-value.

kValueValidationResult() → str

Read method to get the k-value validation result

kvalue_validation_callback() → None

Push an event for the kValueValidationResult attribute.

lastPointingData()

This attribute is used to store the recent pointing data received in calibration scan :return: str

pointing_callback(actual_pointing: list) → None

Push an event for the actualPointing attribute.

read_actualPointing() → str

Returns the actualPointing attribute value.

read_dishMasterDevName() → str

Returns the dishMasterDevName attribute value.

read_dishMode() → ska_tmc_common.DishMode

Returns the dishMode attribute value.

Returns:

The current value of the dishMode attribute.

Return type:

DishMode

read_dishlnPointingDevName() → str

Returns the dishlnPointingDevName attribute value.

read_isSubsystemAvailable() → bool

Read method for isSubsystemAvailable

read_pointingState() → ska_tmc_common.PointingState

Returns the pointingState attribute value.

Returns:

The current value of the pointingState attribute.

Return type:

PointingState

read_trackTableErrors()

Read method for trackTableErrors

sdpQueueConnectorFqdn(sdpqc_fqdn: str) → None

This Method is used to get the SDP queue connector FQDN from subarray node and then Dish Leaf Node have to subscribe to its respective pointing_cal attribute on queue connector device.

sourceOffset() → list[float]

This attribute is used for storing the commanded offsets received as a part of delta/partial configuration. This attribute is subscribed by SDP queue connector device. delta/partial configuration values like ca_offset_arcsec and ie_offset_arcsec are provided in the partial configuration json. source offset example: [cross_elevation_offset, elevation_offset] [0, .5] [.5, 0] [0, -.5], etc :return: list[float]

update_availablity_callback(availability)

Change event callback for isSubsystemAvailable

update_dishmode_callback(dish_mode: ska_tmc_common.DishMode) → None

Push an event for the change of dishMode attribute.

update_global_pointing_param_callback(global_pointing_model_params: str) → None

Push an event for the change of dishMode attribute.

update_health_state_callback(healthState: ska_control_model.HealthState) → None

Change event callback for sourceOffset attribute

update_kvalue_callback() → None

Push an event for the kValue attribute.

update_last_pointing_data_cb(last_pointing_data: List) → None

Change event callback for lastPointingData attribute

update_pointingstate_callback(pointing_state: ska_tmc_common.PointingState) → None

Push an event for change of pointingState attribute.

update_source_offset_callback(source_offset: List) → None

Change event callback for sourceOffset attribute

update_track_table_errors_callback(value: list) → None

Push an event for the trackTableErrors attribute.

write_dishMasterDevName(value: str) → None

Set the dishMasterDevName attribute.

write_dishlnPointingDevName(value: str) → None

Set the dishlnPointingDevName attribute.

ska_tmc_dishleafnode.dish_leaf_node.main(args=None, **kwargs)

Runs the MidTmcLeafNodeDish.

Parameters:

• args – Arguments internal to TANGO

• kwargs – Arguments internal to TANGO

Returns:

MidTmcLeafNodeDish TANGO object.

Attributes in DishleafNode

Attribute Name | O/P Data Type | access/AttrWriteType | Description
dishMode | DishMode | READ | This attribute gives the DISH dishMode
pointingState | PointingState | READ | This attribute gives the DISH pointingState
trackTableErrors | DevStringArray | READ | This attribute gives errors occurred in program track table calculation

Properties in Dish Leaf Node

Property Name	Data Type	Description
DishMasterFQDN	DevString	FQDN of the Dish Master Tango Device Server
DishlnPointingDeviceFQDN	DevString	FQDN of the Dish Pointing device
LivelinessCheckPeriod	DevFloat	Period for the liveliness probe to monitor each device in a loop
EventSubscriptionCheckPeriod	DevFloat	Period for the event subscriber to check the device subscriptions in a loop
AdapterTimeOut	DevFloat	Timeout for the adapter creation. This property is for internal use.
CommandTimeOut	DevFloat	Timeout for the command execution
DishAvailabilityCheckTimeout	DevFloat	Timeout for the dish availability check during intialisation. This property is for internal use.
MaxTrackTableRetry	DevShort	Maximum retries for the programTrackTable write operations
TrackTableRetryDuration	DevFloat	Retry duration for programTrackTable write operation in seconds