ska_tmc_dishleafnode.dish_leaf_node module

Link to the TMC User documentation is here <https://confluence.skatelescope.org/display/UD/TMC+User+Documentation>_.

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.

InitCommand = None

arrayLayout(array_layout: str) → None

Set the dish array-layout.

Parameters:

array_layout (str) – array layout to be set.

create_component_manager() → DishLNComponentManager

Creates component manger instance.

Returns:

Instance of DishLNComponentManager.

Return type:

DishLNComponentManager

delete_device() → None

gpmFilePath(gpm_file_path: str) → None

Set the GPM file path.

Parameters:

gpm_file_path (str) – string in json dumps format

gpmSourcePath(gpm_source_path: str) → None

Set the GPM source path.

Parameters:

gpm_source_path (str) – string in json dumps format

gpmValidationResult() → str

Returns the band-specific GPM validation result. (dictionary stored in component manager). Format: {“band”: ResultCode(UNKNOWN/OK/FAILED)}.

Returns:

JSON string of band-to-GPM validation result mapping

Return type:

str

gpmVersion(gpm_version: str) → None

Set the GPM version.

Parameters:

gpm_version (str) – string in json dumps format

gustWindspeedMeasurementTimeWindow(mean_gust_speed_duration: float) → None

Set the gustWindspeedMeasurementTimeWindow attribute value.

Parameters:

mean_gust_speed_duration (float) – value to update

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(request_type: ska_tango_base.long_running_commands.LRCReqType = ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ) → 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(request_type: ska_tango_base.long_running_commands.LRCReqType = ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ) → 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(request_type: ska_tango_base.long_running_commands.LRCReqType = ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ) → 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(request_type: ska_tango_base.long_running_commands.LRCReqType = ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ) → 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(request_type: ska_tango_base.long_running_commands.LRCReqType = ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ) → 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(request_type: ska_tango_base.long_running_commands.LRCReqType = ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ) → 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_SetStandbyFPMode_allowed(request_type: ska_tango_base.long_running_commands.LRCReqType = ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ) → 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(request_type: ska_tango_base.long_running_commands.LRCReqType = ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ) → 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(request_type: ska_tango_base.long_running_commands.LRCReqType = ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ) → 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(request_type: ska_tango_base.long_running_commands.LRCReqType = ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ) → 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(request_type: ska_tango_base.long_running_commands.LRCReqType = ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ) → 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(request_type: ska_tango_base.long_running_commands.LRCReqType = ska_tango_base.long_running_commands.LRCReqType.ENQUEUE_REQ)

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.

Parameters:

k_value (int) – k-value to be set.

kvalue_validation_callback(result: ska_tango_base.commands.ResultCode) → None

Push an event for the kValueValidationResult attribute.

lastPointingData()

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

Returns:

str

maxAllowedGustWindspeed(gust_speed_threshold: float) → None

Set the maxAllowedGustWindspeed attribute value.

Parameters:

gust_speed_threshold (float) – value to update

maxAllowedOpsMeanWindspeedMeasurementTimeWindow(operational_perc_mean_diff_duration: float) → None

Set the opsPercMeanDiffDuration attribute value.

Parameters:

operational_perc_mean_diff_duration (float) – value to update

maxAllowedOpsWindspeed(operational_wind_speed_threshold: float) → None

Set the maxAllowedOpsWindspeed attribute value.

Parameters:

operational_wind_speed_threshold (float) – value to update

maxAllowedWindspeed(wind_speed_threshold: float) → None

Set the maxAllowedWindspeed attribute value.

Parameters:

wind_speed_threshold (float) – value to update

maxAllowedWindspeedDifference(operational_perc_mean_diff_threshold: float) → None

Set the maxAllowedWindspeedDifference attribute value.

Parameters:

operational_perc_mean_diff_threshold (float) – value to update

maxTemperatureThreshold(max_temp_threshold: float) → None

Set the maxTemperatureThreshold attribute value.

Parameters:

max_temp_threshold (float) – value to update

meanWindspeedMeasurementTimeWindow(mean_wind_speed_duration: float) → None

Set the meanWindspeedMeasurementTimeWindow attribute value.

Parameters:

mean_wind_speed_duration (float) – value to update

minTemperatureThreshold(min_temp_threshold: float) → None

Set the minTemperatureThreshold attribute value.

Parameters:

min_temp_threshold (float) – value to update

percentileForDiff(percentile_for_diff: float) → None

Set the percentileForDiff attribute value.

Parameters:

operational_perc_mean_diff_duration (float) – value to update

pointing_callback(actual_pointing: list) → None

Push an event for the actualPointing attribute.

read_actualPointing() → str

Gets the actualPointing attribute value.

Returns:

actualPointing attribute value.

Return type:

str

read_dishMasterDevName() → str

Reads the dishMasterDevName attribute value.

Returns:

dishMasterDevName attribute value.

Return type:

str

read_dishlnPointingDevName() → str

Reads the dishlnPointingDevName attribute value.

Returns:

dishlnPointingDevName attribute value.

read_isSubsystemAvailable() → bool

Read method for isSubsystemAvailable

Returns:

value of isSubsystemAvailable.

Return type:

bool

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.

Parameters:

sdpqc_fqdn (str) – sdpQueueConnectorFqdn

temperatureDelta(temp_delta: float) → None

Set the temperatureDelta attribute value.

Parameters:

temp_delta (float) – value to update

timeDelta(time_delta: float) → None

Set the timeDelta attribute value.

Parameters:

time_delta (float) – value to update

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)

Push an event for the change of dishMode attribute.

update_gpm_paths_data_callback(source_path: str, file_path: str) → None

Store GPM paths received from Central node (At the time of TMC initialization).

Parameters:

• source_path (str) – GPM source path.

• file_path (str) – GPM file path.

update_gpm_validation_result_callback(band: str, validation_result: str) → None

Callback to update gpmValidationResult attribute.

Parameters:

• gpm_validation_result (str) – GPM validation result.

• band (str) – Band name for which validation result is to be updated.

update_gpm_version_callback(gpm_version: str) → None

Callback to update gpmVersion attribute with the provided GPM version string. Stores the value in the device database, triggers change/archive events, and logs the memorized GPM version.

Parameters:

• gpm_version (str) – New GPM version string to set for

• attribute. (the gpmVersion) –

update_health_info_callback(health_info: dict) → None

Change event callback for healthInfo attribute :param health_info: New health info to be set. :type health_info: dict

update_health_state_callback(healthState: ska_control_model.HealthState) → None

Change event callback for healthState attribute :param healthState: New health state to be set. :type healthState: HealthState

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_mean_gust_speed_callback(mean_speed: float)

Callback to update the mean gust speed.

Parameters:

mean_speed (float) – mean gust speed.

update_mean_operational_diff_callback(mean_speed: float)

Callback to update the mean operational wind speed difference.

Parameters:

mean_speed (float) – ops_mean_difference

update_mean_operational_speed_callback(mean_speed: float)

Callback to update the mean operational speed.

Parameters:

mean_speed (float) – mean operational speed.

update_mean_wind_speed_callback(mean_speed: float)

Callback to update the mean wind speed.

Parameters:

mean_speed (float) – mean wind speed.

update_pointingstate_callback(pointing_state: ska_tmc_common.PointingState) → None

Push an event for change of pointingState attribute.

update_roc_temperature_callback(roc_temp: str)

Callback to update the rate of change in temperature

Parameters:

roc_temp (str) – rate of change in temperature

update_source_offset_callback(source_offset: List) → None

Change event callback for sourceOffset attribute

update_stow_status_callback(status: StowStatus)

Callback to update the stow status.

Parameters:

status (StowStatus) – stow status.

update_track_table_errors_callback(value: list)

Push an event for the trackTableErrors attribute.

windSpeedMeasurementTimeWindow(operational_wind_speed_duration: float) → None

Set the windSpeedMeasurementTimeWindow attribute value.

Parameters:

operational_wind_speed_duration (float) – value to update

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
gpmVersion	DevStringArray		Memorized	This attribute gives GPM version set for the bands on Dish.
gpmValidationResult	DevStringArray		READ	This attribute gives GPM validation result for the bands on Dish.
gpmSourcePath	DevStringArray		Memorized	This attribute gives telmodel source path, used for GPM validation
gpmFilePath	DevStringArray		Memorized	This attribute gives telmodel file path, which is used for GPM validation
kValue	DevLong		Memorized	This attribute gives kValue set on Dish leaf node
healthInfo	DevString		READ	This attribute gives health information about the Dish Leaf Node

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.
CommandTimeOutDefault	DevFloat	Default 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