ska_tmc_centralnode package

Subpackages

• ska_tmc_centralnode.commands package
  • Submodules
  • ska_tmc_centralnode.commands.abstract_command module
    • AssignReleaseResources
      • AssignReleaseResources.init_adapters_low()
      • AssignReleaseResources.init_adapters_mid()
    • CentralNodeCommand
      • CentralNodeCommand.adapter_error_message()
      • CentralNodeCommand.do()
      • CentralNodeCommand.init_adapters()
      • CentralNodeCommand.invoke_command()
      • CentralNodeCommand.reject_command()
      • CentralNodeCommand.send_command()
    • LoadDishCfgCommand
      • LoadDishCfgCommand.init_adapters_mid()
    • SetadMinMode
      • SetadMinMode.init_adapters_low()
    • TelescopeOnOff
      • TelescopeOnOff.init_adapters_low()
      • TelescopeOnOff.init_adapters_mid()
    • task_callback_default()
  • ska_tmc_centralnode.commands.set_admin_mode_command module
    • SetAdminMode
      • SetAdminMode.do_low()
      • SetAdminMode.do_mid()
      • SetAdminMode.init_adapters_mid()
      • SetAdminMode.invoke_setadminmode()
      • SetAdminMode.set_admin_mode_generic()
      • SetAdminMode.update_task_status()
  • ska_tmc_centralnode.commands.assign_resources_command module
    • AssignResources
      • AssignResources.create_mccs_cmd_data()
      • AssignResources.do_low()
      • AssignResources.do_mid()
      • AssignResources.get_subarray_adapter()
      • AssignResources.update_resource_config_file()
      • AssignResources.update_task_status()
  • ska_tmc_centralnode.commands.release_resources_command module
    • ReleaseResources
      • ReleaseResources.create_mccs_input_data()
      • ReleaseResources.do_low()
      • ReleaseResources.do_mid()
      • ReleaseResources.release_all_resources()
      • ReleaseResources.release_all_resources_mccs()
      • ReleaseResources.update_task_status()
  • ska_tmc_centralnode.commands.stow_antennas_command module
    • StowAntennas
      • StowAntennas.check_allowed()
      • StowAntennas.do()
      • StowAntennas.init_adapters()
      • StowAntennas.set_stow_mode_dishes()
  • ska_tmc_centralnode.commands.telescope_off_command module
    • TelescopeOff
      • TelescopeOff.do_low()
      • TelescopeOff.do_mid()
      • TelescopeOff.telescope_off()
      • TelescopeOff.turn_off_csp()
      • TelescopeOff.turn_off_dishes()
      • TelescopeOff.turn_off_mccs()
      • TelescopeOff.turn_off_sdp()
      • TelescopeOff.turn_off_subarrays()
      • TelescopeOff.update_task_status()
  • ska_tmc_centralnode.commands.telescope_on_command module
    • TelescopeOn
      • TelescopeOn.do_low()
      • TelescopeOn.do_mid()
      • TelescopeOn.set_standby_fp_mode_dishes()
      • TelescopeOn.telescope_on()
      • TelescopeOn.turn_on_csp()
      • TelescopeOn.turn_on_mccs()
      • TelescopeOn.turn_on_sdp()
      • TelescopeOn.turn_on_subarrays()
      • TelescopeOn.update_task_status()
  • ska_tmc_centralnode.commands.telescope_standby_command module
    • TelescopeStandby
      • TelescopeStandby.do_low()
      • TelescopeStandby.do_mid()
      • TelescopeStandby.telescope_standby()
      • TelescopeStandby.turn_off_dishes()
      • TelescopeStandby.turn_standby_csp()
      • TelescopeStandby.turn_standby_mccs()
      • TelescopeStandby.turn_standby_sdp()
      • TelescopeStandby.turn_standby_subarrays()
      • TelescopeStandby.update_task_status()
  • ska_tmc_centralnode.commands.load_dish_config_command module
    • LoadDishCfg
      • LoadDishCfg.do()
      • LoadDishCfg.fetch_dishid_vcc_map()
      • LoadDishCfg.get_dishid_vcc_map_json()
      • LoadDishCfg.load_dish_cfg()
      • LoadDishCfg.load_dish_config_json_validator()
      • LoadDishCfg.update_memorized_attribute()
      • LoadDishCfg.update_task_status()
  • Module contents
• ska_tmc_centralnode.manager package
  • Submodules
  • ska_tmc_centralnode.manager.aggregators module
    • DishkValueValidationResultAggregator
      • DishkValueValidationResultAggregator.aggregate()
      • DishkValueValidationResultAggregator.is_events_received_percentage_valid()
      • DishkValueValidationResultAggregator.update_central_node_with_result()
    • HealthStateAggregatorLow
      • HealthStateAggregatorLow.aggregate()
    • HealthStateAggregatorMid
      • HealthStateAggregatorMid.aggregate()
    • LoadDishCfgCommandResultAggregator
      • LoadDishCfgCommandResultAggregator.aggregate()
    • TMCOpStateAggregator
      • TMCOpStateAggregator.aggregate()
    • TelescopeAvailabilityAggregatorLow
      • TelescopeAvailabilityAggregatorLow.aggregate()
    • TelescopeAvailabilityAggregatorMid
      • TelescopeAvailabilityAggregatorMid.aggregate()
    • TelescopeStateAggregatorLow
      • TelescopeStateAggregatorLow.aggregate()
    • TelescopeStateAggregatorMid
      • TelescopeStateAggregatorMid.aggregate()
  • ska_tmc_centralnode.manager.component_manager module
    • CNComponentManager
      • CNComponentManager.add_device()
      • CNComponentManager.add_multiple_devices()
      • CNComponentManager.assign_resources()
      • CNComponentManager.check_device_responsiveness()
      • CNComponentManager.check_event_error()
      • CNComponentManager.check_if_csp_mln_is_available()
      • CNComponentManager.check_if_sdp_mln_is_available()
      • CNComponentManager.check_if_subarrays_are_responsive()
      • CNComponentManager.check_subarray_id_in_json()
      • CNComponentManager.checked_devices
      • CNComponentManager.command_not_allowed_callable()
      • CNComponentManager.component
      • CNComponentManager.devices
      • CNComponentManager.event_queues
      • CNComponentManager.get_csp_master_dev_name()
      • CNComponentManager.get_csp_subarray_dev_names()
      • CNComponentManager.get_device()
      • CNComponentManager.get_dish_device_names()
      • CNComponentManager.get_dish_leaf_node_device_names()
      • CNComponentManager.get_sdp_master_dev_name()
      • CNComponentManager.get_sdp_subarray_dev_names()
      • CNComponentManager.get_subarray_obsstate()
      • CNComponentManager.get_telescope_availability()
      • CNComponentManager.get_telescope_health_state()
      • CNComponentManager.get_telescope_state()
      • CNComponentManager.get_tmc_op_state()
      • CNComponentManager.input_parameter
      • CNComponentManager.is_already_assigned()
      • CNComponentManager.is_command_allowed()
      • CNComponentManager.is_input_json_valid()
      • CNComponentManager.log_state()
      • CNComponentManager.off()
      • CNComponentManager.on()
      • CNComponentManager.process_event()
      • CNComponentManager.release_resources()
      • CNComponentManager.reset()
      • CNComponentManager.set_admin_mode()
      • CNComponentManager.set_aggregators()
      • CNComponentManager.set_telescope_availability()
      • CNComponentManager.standby()
      • CNComponentManager.start_communicating()
      • CNComponentManager.stop()
      • CNComponentManager.stop_communicating()
      • CNComponentManager.stop_event_receiver()
      • CNComponentManager.telescope_off()
      • CNComponentManager.telescope_on()
      • CNComponentManager.telescope_standby()
      • CNComponentManager.update_device_assigned_resource()
      • CNComponentManager.update_device_health_state()
      • CNComponentManager.update_device_obs_state()
      • CNComponentManager.update_event_failure()
      • CNComponentManager.update_exception_for_unresponsiveness()
      • CNComponentManager.update_input_parameter()
      • CNComponentManager.update_responsiveness_info()
  • Module contents
• ska_tmc_centralnode.model package
  • Submodules
  • ska_tmc_centralnode.model.component module
    • CentralComponent
      • CentralComponent.desired_telescope_state
      • CentralComponent.devices
      • CentralComponent.get_device()
      • CentralComponent.imaging
      • CentralComponent.pss
      • CentralComponent.pst
      • CentralComponent.remove_device()
      • CentralComponent.set_op_callbacks()
      • CentralComponent.telescope_availability
      • CentralComponent.telescope_health_state
      • CentralComponent.telescope_state
      • CentralComponent.tmc_op_state
      • CentralComponent.to_dict()
      • CentralComponent.to_json()
      • CentralComponent.update_device()
      • CentralComponent.update_device_exception()
      • CentralComponent.vlbi
    • MCCSDeviceInfo
      • MCCSDeviceInfo.from_dev_info()
      • MCCSDeviceInfo.to_dict()
      • MCCSDeviceInfo.to_json()
    • dev_state_2_str()
  • ska_tmc_centralnode.model.enum module
    • ModesAvailability
      • ModesAvailability.available
      • ModesAvailability.not_available
  • ska_tmc_centralnode.model.input module
    • InputParameter
      • InputParameter.csp_master_dev_name
      • InputParameter.csp_mln_dev_name
      • InputParameter.csp_subarray_dev_names
      • InputParameter.sdp_master_dev_name
      • InputParameter.sdp_mln_dev_name
      • InputParameter.sdp_subarray_dev_names
      • InputParameter.subarray_dev_names
      • InputParameter.update()
    • InputParameterLow
      • InputParameterLow.mccs_master_dev_name
      • InputParameterLow.mccs_mln_dev_name
      • InputParameterLow.update()
    • InputParameterMid
      • InputParameterMid.dish_dev_names
      • InputParameterMid.dish_leaf_node_dev_names
      • InputParameterMid.dish_leaf_node_prefix
      • InputParameterMid.dish_master_identifier
      • InputParameterMid.update()
  • Module contents

Submodules

ska_tmc_centralnode.central_node module

Central Node is a coordinator of the complete M&C system. Central Node implements the standard set of state and mode attributes defined by the SKA Control Model.

class ska_tmc_centralnode.central_node.AbstractCentralNode(*args: Any, **kwargs: Any)

Bases: TMCBaseDevice

Central Node is a coordinator of the complete Telescope system. Central Node is inherited from TMCBaseDevice class which is further inherited from SKABaseDevice class. TMCBaseDevice class contains attributes common to CentralNode and SubarrayNode.

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

Bases: InitCommand

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

do()

Initializes the attributes and properties of the Central Node.

Returns:

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

Return type:

(ReturnCode, str)

Off()

This command invokes SetStandbyLPMode() command on DishLeafNode, TelescopeOff() command on CspMasterLeafNode and SdpMasterLeafNode.

TelescopeOff()

This command invokes SetStandbyLPMode() command on DishLeafNode, Off() command on CspMasterLeafNode and SdpMasterLeafNode.

always_executed_hook()

always executed hook method

create_component_manager()

Create component manager object for command invocation.

delete_device()

init_command_objects()

Initialises the command handlers for commands supported by this device.

is_AssignResources_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_Off_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_On_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_ReleaseResources_allowed()

Checks whether ReleaseResources command is allowed to be run in

current device state.

Returns:

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

Return type:

boolean

is_SetAdminMode_allowed() → bool

Check if the SetAdminMode command is allowed in the current device state.

Returns:

True if the command is allowed, otherwise False.

Return type:

bool

is_Standby_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_TelescopeOff_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_TelescopeOn_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_TelescopeStandby_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

read_desiredTelescopeState()

Read Desired TelescopeState

read_isAdminModeEnabled() → bool

Return the isAdminModeEnabled attribute value

read_telescopeAvailability()

Returns telescope availability

read_telescopeHealthState()

Read value of telescopeHealthState

read_telescopeState()

Reads telescopeState

read_tmOpState()

Return the tmOpState attribute.

transformedInternalModel_read()

Tranformed InternalModelRead

update_device_callback(devInfo)

Update device callabacks

update_telescope_availability_callback(telescope_availability)

Update device availabililty callabacks

update_telescope_health_state_callback(telescope_health_state)

Update Telescope health state callabacks

update_telescope_state_callback(telescope_state)

Update telescope state callback

update_tmc_op_state_callback(tmc_op_state)

Update tmc operational state callabacks

write_isAdminModeEnabled(value: bool)

Set the value of isAdminModeEnabled attribute

ska_tmc_centralnode.central_node_low module

Central Node is a coordinator of the complete M&C system. Central Node implements the standard set of state and mode attributes defined by the SKA Control Model.

class ska_tmc_centralnode.central_node_low.CentralNodeLow(*args: Any, **kwargs: Any)

Bases: AbstractCentralNode

Central Node is a coordinator of the complete Telescope system

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

Bases: InitCommand

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

do()

Initializes the attributes and properties of the Central Node.

Returns:

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

Return type:

(ReturnCode, str)

create_component_manager()

Create component manager object for command invocation.

ska_tmc_centralnode.central_node_low.main(args=None, **kwargs)

Runs the CentralNode. :param args: Arguments internal to TANGO

Parameters:

kwargs – Arguments internal to TANGO

Returns:

CentralNode TANGO object.

ska_tmc_centralnode.central_node_mid module

Central Node is a coordinator of the complete M&C system. Central Node implements the standard set of state and mode attributes defined by the SKA Control Model.

class ska_tmc_centralnode.central_node_mid.CentralNodeMid(*args: Any, **kwargs: Any)

Bases: AbstractCentralNode

Central Node is a coordinator of the complete Telescope system

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

Bases: InitCommand

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

do()

Initializes the attributes and properties of the Central Node.

Returns:

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

Return type:

(ReturnCode, str)

create_component_manager()

Create component manager object for command invocation.

dishvccvalidation_callback(dishvccvalidationstatus)

Update DishVccValidationStatus callbacks

init_command_objects()

Initialises the command handlers for commands supported by this device.

invoke_load_dish_cfg_command_callback()

This callback is called when dishVccValidationResult is Unknown and Central Node needs to load dish cfg on csp

is_LoadDishCfg_allowed()

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

Return type:

boolean

read_DishVccValidationStatus()

Return the DishVccValidationStatus

read_imaging()

Read Attribute for imaging

read_isDishVccConfigSet()

Return the isDishVccConfigSet attribute.

read_pss()

Read attribute for pss

read_pst()

Read attribute value of pst

read_vlbi()

Read attribute value of vlbi

update_dishvccconfig_callback(isdishvccconfigset)

Update isDishVccConfigSet callbacks

update_imaging_callback(imaging)

Callback for Update imaging

ska_tmc_centralnode.central_node_mid.main(args=None, **kwargs)

Runs the CentralNode. :param args: Arguments internal to TANGO

Parameters:

kwargs – Arguments internal to TANGO

Returns:

CentralNode TANGO object.

ska_tmc_centralnode.input_validator module

Input Validator class for central node

class ska_tmc_centralnode.input_validator.AssignResourceValidator(subarray_list, receptor_list, dish_leaf_node_prefix, logger=<Logger ska_tmc_centralnode.input_validator (WARNING)>)

Bases: object

Class to validate the input string of AssignResources command of Central Node

loads(input_string)

Validates the input string received as an argument of AssignResources command. If the request is correct, returns the deserialized JSON object. The ska-tmc-cdm is used to validate the JSON.

Param:

input_string: A JSON string

Returns:

Deserialized JSON object if successful.

Throws:

InvalidJSONError: When the JSON string is not formatted properly.

SubarrayNotPresentError: If the subarray is not present.

ResourceNotPresentError: When a receptor in the receptor_id_list is not present.

class ska_tmc_centralnode.input_validator.ReleaseResourceValidator(logger=<Logger ska_tmc_centralnode.input_validator (WARNING)>)

Bases: object

Class to validate the input string of ReleaseResources command of Central Node

loads(input_string)

Validates the input string received as an argument of ReleaseResources command. If the request is correct, returns the deserialized JSON object. The ska-tmc-cdm is used to validate the JSON.

Param:

input_string: A JSON string

Returns:

Deserialized JSON object if successful.

Throws:

InvalidJSONError: When the JSON string is not formatted properly.

SubarrayNotPresentError: If the subarray is not present.

ResourceNotPresentError: When a receptor in the receptor_id_list is not present.

ska_tmc_centralnode.release module

Release information for Python Package

Module contents

CentralNode

Central Node is a coordinator of the complete M&C system.

Properties in Central Node

Property Name	Data Type	Description
TMCSubarrayNodes	DevStringArray	List of TMC Mid Subarray Node devices
CspMasterLeafNodeFQDN	DevString	FQDN of the CSP Master Leaf Node device
CspMasterFQDN	DevString	FQDN of the CSP Master device
SdpMasterLeafNodeFQDN	DevString	FQDN of the SDP Master Leaf Node device
SdpMasterFQDN	DevString	FQDN of the SDP Master device
CspSubarrayLeafNodes	DevStringArray	List of the CSP Subarray Leaf Node devices
SdpSubarrayLeafNodes	DevStringArray	List of the CSP Subarray Leaf Node devices
SkuidService	DevString	Default value for SKUID service
CommandTimeOut	DevFloat	Timeout for the command execution
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

Additional Properties in Central Node Mid

Property Name	Data Type	Description
DishIDs	DevStringArray	List containing the ids of the dishes available . This property is for internal use. It needs to be changed only when there is update in the dishes available/usable.
DishLeafNodePrefix	DevString	Device name prefix for Dish Leaf Node. This property is for internal use.
DishMasterIdentifier	DevString	Device name tag/identifier for Dish Master device. This property is for internal use.
DishMasterFQDNs	DevStringArray	List of Dish Master devices. This property derived from the values of properties DishIDs and DishMasterIdentifier. It is for internal use.
DishVccUri	DevString	Default URI for Dish VCC Configuration.
DishVccFilePath	DevString	Default file path for Dish VCC Configuration
EnableDishVccInit	DevBoolean	This property is set to true to load the dish vcc during initialization.
DishKvalueAggregationAllowedPercent	DevDouble	Percentage of the dishes to be considered for DishKValue aggregation.
DishVccInitTimeout	DevUShort	Timeout for the dish vcc initialization
KValueValidRangeUpperLimit	int	Upper limit of the valid k-value range
KValueValidRangelowerLimit	int	Lower limit of the valid k-value range

Additional Properties in Central Node Low

Property Name	Data Type	Description
MCCSMasterLeafNodeFQDN	DevString	FQDN of the MCCS Master Leaf Node Tango Device Server
MCCSMasterFQDN	DevString	FQDN of the MCCS Master device
AssignResourcesInterface	DevString	Interface value of AsignResources schema
ReleaseResourcesInterface	DevString	Interface value of ReleaseResources schema