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.
-
Abort
()¶ Invokes Abort command on the DishMaster.
-
class
AbortCommand
(*args, **kwargs)¶ A class for DishLeafNode’s Abort 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
-
do
()¶ Invokes TrackStop command on the DishMaster.
Raises: DevFailed – If error occurs while invoking TrackStop command on 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
-
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”}}Raises: DevFailed – If error occurs while invoking ConfigureBand<> command on DishMaster or if the json string contains invalid data.
-
-
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
-
do
(argin)¶ Invokes StopCapture command on DishMaster.
Parameters: argin – timestamp Raises: DevFailed – If error occurs while invoking StopCapture command on DishMaster.
-
-
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 a DeviceProxy instance for DishMaster
-
-
ObsReset
()¶ Invokes ObsReset command on the DishLeafNode.
-
class
ObsResetCommand
(*args, **kwargs)¶ A class for DishLeafNode’s ObsReset 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
-
do
()¶ Invokes SetStandbyFPMode command on the DishMaster.
Raises: DevFailed – If error occurs while invoking SetStandbyFPMode command on DishMaster.
-
-
Restart
()¶ Invokes Restart command on the DishMaster.
-
class
RestartCommand
(*args, **kwargs)¶ A class for DishLeafNode’s Restart 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
-
do
()¶ Invokes StopCapture command on the DishMaster.
Raises: DevFailed – If error occurs while invoking StopCapture command 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
-
do
(argin)¶ Invokes Scan command on DishMaster.
Parameters: argin – timestamp Raises: DevFailed – If error occurs while invoking Scan command on DishMaster.
-
-
SetOperateMode
()¶ Invokes SetOperateMode command on DishMaster.
-
class
SetOperateModeCommand
(*args, **kwargs)¶ A class for DishLeafNode’s SetOperateMode() command.
-
do
()¶ Invokes SetOperateMode command on DishMaster.
Raises: DevFailed – If error occurs while invoking SetOperateMode command on DishMaster.
-
-
SetStandbyFPMode
()¶ Invokes SetStandbyFPMode command on DishMaster (Standby-Full power) mode.
-
class
SetStandbyFPModeCommand
(*args, **kwargs)¶ A class for DishLeafNode’s SetStandbyFPMode() command.
-
do
()¶ Invokes SetStandbyFPMode command on DishMaster (Standby-Full power) mode.
Raises: DevFailed – If error occurs while invoking SetStandbyFPMode command on DishMaster.
-
-
SetStandbyLPMode
()¶ Invokes SetStandbyLPMode (i.e. Low Power State) command on DishMaster.
-
class
SetStandbyLPModeCommand
(*args, **kwargs)¶ A class for DishLeafNode’s SetStandbyLPMode() command.
-
do
()¶ Invokes SetStandbyLPMode (i.e. Low Power State) command on DishMaster.
Raises: DevFailed – If error occurs while invoking SetStandbyLPMode command on DishMaster.
-
-
SetStowMode
()¶ Invokes SetStowMode command on DishMaster.
-
class
SetStowModeCommand
(*args, **kwargs)¶ A class for DishLeafNode’s SetStowMode() command.
-
do
()¶ Invokes SetStowMode command on DishMaster.
Raises: DevFailed – If error occurs while invoking SetStowMode command on DishMaster.
-
-
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
-
do
(argin)¶ Invokes Slew command on DishMaster to slew the dish towards the set pointing coordinates.
Parameters: argin – list [0] = Azimuth, in degrees [1] = Elevation, in degrees Raises: DevFailed – If error occurs while invoking Slew 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
-
do
(argin)¶ Invokes StartCapture command on DishMaster on the set configured band.
Parameters: argin – timestamp Raises: DevFailed – If error occurs while invoking StartCapture 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
-
do
(argin)¶ Invokes StopCapture command on DishMaster on the set configured band.
Parameters: argin – timestamp Raises: DevFailed – If error occurs while invoking StopCapture 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
-
do
()¶ Invokes TrackStop command on the DishMaster.
Raises: DevFailed – If error occurs while invoking TrackStop 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
-
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”}}
Raises: DevFailed – If error occurs while invoking Track command on DishMaster.
-
-
activityMessage
¶ Used by autodoc_mock_imports.
-
attribute_event_handler
(event_data)¶ Retrieves the subscribed attribute of DishMaster.
Parameters: evt – A TANGO_CHANGE event on attribute.
-
convert_radec_to_azel
(target, timestamp)¶ Converts RaDec coordinate in to AzEl coordinate using KATPoint library.
Parameters: - target – str Argin to be provided is the Ra and Dec values in the following format: radec,21:08:47.92,89:15:51.4
- timestamp – str 2020-12-11 10:06:34.970731
Returns: list Azimuth and elevation angle, in degrees
Raises: ValueError – If error occurs when creating katpoint Target or Timestamp.
-
dishHealthState
¶ Used by autodoc_mock_imports.
-
dishPointingState
¶ Used by autodoc_mock_imports.
-
init_command_objects
()¶ Initialises the command handlers for commands supported by this device.
-
is_Abort_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
-
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
-
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
-
is_ObsReset_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
-
is_Restart_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
-
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
-
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
-
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
-
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
-
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
-
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
-
read_activityMessage
()¶ Returns the activityMessage
-
set_dish_name_number
()¶
-
set_observer_lat_long_alt
()¶
-
track_thread
()¶ This thread writes coordinates to desiredPointing on DishMaster at the rate of 20 Hz.
-
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.