Dish Leaf Node¶

A Leaf control node for DishMaster.

class tmcprototype.dishleafnode.src.dishleafnode.dish_leaf_node.DishLeafNode(*args, **kwargs)¶

A Leaf control node for DishMaster.

Configure(argin)¶: Configures the Dish by setting pointing coordinates for a given observation.

class ConfigureCommand(*args, **kwargs)¶

A class for DishLeafNode’s Configure() command.

check_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
Raises:	DevFailed if this command is not allowed to be run in current device state.

do(argin)¶

Configures the Dish by setting pointing coordinates for a given scan. This function accepts the input json and calculate pointing parameters of Dish- Azimuth and Elevation Angle. Calculated parameters are again converted to json and fed to the dish master.

Parameters:	argin –

A String in a JSON format that includes pointing parameters of Dish- Azimuth and Elevation Angle.

Example: {“pointing”:{“target”:{“system”:”ICRS”,”name”:”Polaris Australis”,”RA”:”21:08:47.92”,”dec”:”-88:57:22.9”}}, “dish”:{“receiverBand”:”1”}}

Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ResultCode, str)
Raises:	DevFailed if error occurs while invoking this command on DishMaster. ValueError if argin is not in valid JSON format. KayError if JSON key is not present in argin

DishMasterFQDN¶: Used by autodoc_mock_imports.

EndScan(argin)¶: Invokes StopCapture command on DishMaster.

class EndScanCommand(*args, **kwargs)¶

A class for DishLeafNode’s EndScan() command.

check_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
Raises:	DevFailed if this command is not allowed to be run in current device state.

do(argin)¶

Invokes StopCapture command on DishMaster.

Parameters:	argin – timestamp
Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ResultCode, str)

Example: 10.0

Raises:	ValueError if argin is of invalid (other than float) data type while invoking this command.

class InitCommand(*args, **kwargs)¶

A class for the TMC DishLeafNode’s init_device() method.

do()¶

Initializes the attributes and properties of the DishLeafNode.

Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ResultCode, str)
Raises:	DevFailed if error occurs in creating proxy for DishMaster or in subscribing the event on DishMaster

Scan(argin)¶: Invokes Scan command on DishMaster.

class ScanCommand(*args, **kwargs)¶

A class for DishLeafNode’s Scan() command.

check_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
Raises:	DevFailed if this command is not allowed to be run in current device state.

do(argin)¶

Invokes Scan command on DishMaster.

Parameters:	argin – timestamp
Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ResultCode, str)

Example: 10.0

Raises:	ValurError if argin is of invalid (other than float) data type while invoking this command.

SetOperateMode()¶: Invokes SetOperateMode command on DishMaster.

class SetOperateModeCommand(*args, **kwargs)¶

A class for DishLeafNode’s SetOperateMode() command.

check_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
Raises:	DevFailed if this command is not allowed to be run in current device state.

do()¶

Invokes SetOperateMode command on DishMaster.

Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ResultCode, str)

SetStandByLPMode()¶: Invokes SetStandbyLPMode (i.e. Low Power State) command on DishMaster.

class SetStandByLPModeCommand(*args, **kwargs)¶

A class for DishLeafNode’s SetStandByLPMode() command.

check_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
Raises:	DevFailed if this command is not allowed to be run in current device state.

do()¶

Invokes SetStandbyLPMode (i.e. Low Power State) command on DishMaster.

Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ResultCode, str)

SetStandbyFPMode()¶: Invokes SetStandbyFPMode command on DishMaster (Standby-Full power) mode.

class SetStandbyFPModeCommand(*args, **kwargs)¶

A class for DishLeafNode’s SetStandByFPMode() command.

check_allowed()¶

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
Raises:	DevFailed if this command is not allowed to be run in current device state.

do()¶

Invokes SetStandbyFPMode command on DishMaster (Standby-Full power) mode.

Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ResultCode, str)

SetStowMode()¶: Invokes SetStowMode command on DishMaster.

class SetStowModeCommand(*args, **kwargs)¶

A class for DishLeafNode’s SetStowMode() command.

check_allowed()¶

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

Returns:	True if this command is allowed to be run in current device state.
Return type:	boolean
Raises:	DevFailed if this command is not allowed to be run in current device state.

do()¶

Invokes SetStowMode command on DishMaster.

Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ResultCode, str)

Slew(argin)¶: Invokes Slew command on DishMaster to slew the dish towards the set pointing coordinates.

class SlewCommand(*args, **kwargs)¶

A class for DishLeafNode’s SlewCommand() command.

check_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
Raises:	DevFailed if this command is not allowed to be run in current device state.

do(argin)¶

Invokes Slew command on DishMaster to slew the dish towards the set pointing coordinates.

Parameters:	argin – timestamp
Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ResultCode, str)
Raises:	ValueError if argin is not in valid JSON format while invoking this command on DishMaster.

StartCapture(argin)¶: Triggers the DishMaster to Start capture on the set configured band.

class StartCaptureCommand(*args, **kwargs)¶

A class for DishLeafNode’s StartCapture() command.

check_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
Raises:	DevFailed if this command is not allowed to be run in current device state.

do(argin)¶

Invokes StartCapture command on DishMaster on the set configured band.

Parameters:	argin – timestamp
Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ResultCode, str)
Raises:	ValueError if argin is not in valid JSON format while invoking this command on DishMaster.

StopCapture(argin)¶: Invokes StopCapture command on DishMaster on the set configured band.

class StopCaptureCommand(*args, **kwargs)¶

A class for DishLeafNode’s StopCapture() command.

check_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
Raises:	DevFailed if this command is not allowed to be run in current device state.

do(argin)¶

Invokes StopCapture command on DishMaster on the set configured band.

Parameters:	argin – timestamp
Returns:	A tuple containing a return code and a string message indicating status.

The message is for information purpose only.

Return type:	(ResultCode, str)
Raises:	ValueError if argin is not in valid JSON format while invoking this command on DishMaster.

StopTrack()¶: Invokes StopTrack command on the DishMaster.

class StopTrackCommand(*args, **kwargs)¶

A class for DishLeafNode’s StopTrack() command.

check_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
Raises:	DevFailed if this command is not allowed to be run in current device state.

do()¶

Invokes StopTrack command on the DishMaster.

Parameters:	argin – None.
Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ResultCode, str)
Raises:	DevFailed if error occurs while invoking this command on DishMaster.

Track(argin)¶: Invokes Track command on the DishMaster.

class TrackCommand(*args, **kwargs)¶

A class for DishLeafNode’s Track() command.

check_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
Raises:	DevFailed if this command is not allowed to be run in current device state.

do(argin)¶

Invokes Track command on the DishMaster.

Parameters:	argin – DevString

The elevation limit thread allows Dish to track a source till the observation capacity i.e. elevation limit of dish.

The tracking time thread allows dish to track a source for the prespecified Track Duration (provided elevation limit is not reached).

For Track command, argin to be provided is the Ra and Dec values in the following JSON format:

{“pointing”:{“target”:{“system”:”ICRS”,”name”:”Polaris Australis”,”RA”:”21:08:47.92”,”dec”:”-88:57:22.9”}}, “dish”:{“receiverBand”:”1”}}

Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ResultCode, str)
Raises:	ValueError if argin is not in valid JSON format, KayError if JSON key is not present in argin while invoking this command on DishMaster.

TrackDuration¶: Used by autodoc_mock_imports.

activityMessage¶: Used by autodoc_mock_imports.

always_executed_hook()¶: Internal construct of TANGO.

cmd_ended_cb(event)¶

Callback function immediately executed when the asynchronous invoked command returns. Checks whether the command has been successfully invoked on DishMaster.

Parameters:	event – a CmdDoneEvent object. This class is used to pass data to the callback method in asynchronous callback model for command execution.
Type:	CmdDoneEvent object It has the following members: device : (DeviceProxy) The DeviceProxy object on which the call was executed. cmd_name : (str) The command name argout_raw : (DeviceData) The command argout argout : The command argout err : (bool) A boolean flag set to true if the command failed. False otherwise errors : (sequence<DevError>) The error stack ext
Returns:	none
Raises:	Exception if error occurs in command callback method.

convert_radec_to_azel(data)¶

Converts RaDec coordinate in to AzEl coordinate using KATPoint library.

Parameters:	data – DevVarStringArray

Argin to be provided is the Ra and Dec values in the following format: radec|21:08:47.92|89:15:51.4 Where first value is tag that is radec, second value is Ra in Hr:Min:Sec,and third value is Dec in Deg:Min:Sec.

Returns:	None.
Raises:	Exception if error occurs in Ra-Dec to Az-El conversion

delete_device()¶: Internal construct of TANGO.

dishHealthState¶: Used by autodoc_mock_imports.

dishPointingState¶: Used by autodoc_mock_imports.

dish_achieved_pointing_cb(evt)¶

Retrieves the subscribed achievedPointing attribute of DishMaster.

Parameters:	evt – A TANGO_CHANGE event on achievedPointing attribute.
Returns:	None
Raises:	Exception if error occurs in dish pointing call back method.

dish_capturing_cb(evt)¶

Retrieves the subscribed capturing attribute of DishMaster.

Parameters:	evt – A TANGO_CHANGE event on capturing attribute.
Returns:	None
Raises:	Exception if error occurs in Dish Capturing Callback event.

dish_desired_pointing_cb(evt)¶

Retrieves the subscribed desiredPointing attribute of DishMaster.

Parameters:	evt – A TANGO_CHANGE event on desiredPointing attribute.
Returns:	None

dish_mode_cb(evt)¶

Retrieves the subscribed dishMode attribute of DishMaster.

Parameters:	evt – A TANGO_CHANGE event on dishMode attribute.
Returns:	None
Raises:	Exception if error occurs in Dish Mode call back event.

dms_to_rad(dms)¶

dmstodd(dish_antenna_latitude)¶

Converts latitude from deg:min:sec to decimal degree format.

Parameters:	dish_antenna_latitude – latitude of Dish location in Deg:Min:Sec.

Example: 18:31:48.0

Returns:	latitude of Dish location in decimal Degree.

Example : “18.529999999999998” is the returned value of dmstodd

init_command_objects()¶: Initialises the command handlers for commands supported by this device.

is_Configure_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
Raises:	DevFailed if this command is not allowed to be run in current device state.

is_EndScan_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
Raises:	DevFailed if this command is not allowed to be run in current device state.

is_Scan_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
Raises:	DevFailed if this command is not allowed to be run in current device state.

is_SetOperateMode_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
Raises:	DevFailed if this command is not allowed to be run in current device state.

is_SetStandByLPMode_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
Raises:	DevFailed if this command is not allowed to be run in current device state.

is_SetStandbyFPMode_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
Raises:	DevFailed if this command is not allowed to be run in current device state

is_SetStowMode_allowed()¶

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

Returns:	True if this command is allowed to be run in current device state.
Return type:	boolean
Raises:	DevFailed if this command is not allowed to be run in current device state.

is_Slew_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
Raises:	DevFailed if this command is not allowed to be run in current device state.

is_StartCapture_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
Raises:	DevFailed if this command is not allowed to be run in current device state.

is_StopCapture_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
Raises:	DevFailed if this command is not allowed to be run in current device state.

is_StopTrack_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
Raises:	DevFailed if this command is not allowed to be run in current device state.

is_Track_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
Raises:	DevFailed if this command is not allowed to be run in current device state.

rad_to_dms(rad_value)¶

read_activityMessage()¶: Returns the activityMessage

set_dish_name_number()¶

set_observer_lat_long_alt()¶

throw_exception(except_msg_list, read_actvity_msg)¶

track_thread(argin)¶

This thread invokes Track command on DishMaster at the rate of 20 Hz.

Parameters:	argin – DevVarStringArray

For Track thread, argin to be provided is the Ra and Dec values in the following format: radec|21:08:47.92|89:15:51.4 Where first value is tag that is radec, second value is Ra in Hr:Min:Sec, and third value is Dec in Deg:Min:Sec.

It takes system’s current time in UTC as timestamp and converts RaDec to AzEl using convert_radec_to_azel method of class DishLeafNode.

Returns:	None.
Raises:	Exception if error occurs in RaDec to AzEl conversion.

tracking_time_thread()¶

This thread allows the dish to track the source for a specified Duration.

Returns:	None.

write_activityMessage(value)¶: Internal construct of TANGO. Sets the activityMessage

tmcprototype.dishleafnode.src.dishleafnode.dish_leaf_node.main(args=None, **kwargs)¶: Runs the DishLeafNode. :param args: Arguments internal to TANGO :param kwargs: Arguments internal to TANGO :return: DishLeafNode TANGO object.