ska_tmc_centralnode package
Link to the TMC User documentation is here.
Subpackages
- ska_tmc_centralnode.commands package
- Submodules
- ska_tmc_centralnode.commands.central_node_command module
- ska_tmc_centralnode.commands.assign_resources_command module
- ska_tmc_centralnode.commands.release_resources_command module
- ska_tmc_centralnode.commands.stow_antennas_command module
- ska_tmc_centralnode.commands.telescope_off_command module
- ska_tmc_centralnode.commands.telescope_on_command module
- ska_tmc_centralnode.commands.telescope_standby_command module
TelescopeStandbyTelescopeStandby.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
- Module contents
- ska_tmc_centralnode.manager package
- Subpackages
- Submodules
- ska_tmc_centralnode.manager.aggregators module
- ska_tmc_centralnode.manager.aggregate_process module
- ska_tmc_centralnode.manager.component_manager module
CNComponentManagerCNComponentManager.add_device()CNComponentManager.add_multiple_devices()CNComponentManager.aggregate_process_monitor()CNComponentManager.assign_resources()CNComponentManager.build_device_attribute_map()CNComponentManager.check_device_responsiveness_command()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_devicesCNComponentManager.command_not_allowed_callable()CNComponentManager.componentCNComponentManager.devicesCNComponentManager.event_queueCNComponentManager.get_adapter_by_device_name()CNComponentManager.get_csp_controller_admin_mode()CNComponentManager.get_csp_master_dev_name()CNComponentManager.get_csp_master_leaf_node_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_mccs_controller_admin_mode()CNComponentManager.get_mccs_master_dev_name()CNComponentManager.get_mccs_master_leaf_node_dev_name()CNComponentManager.get_sdp_controller_admin_mode()CNComponentManager.get_sdp_master_dev_name()CNComponentManager.get_sdp_master_leaf_node_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_parameterCNComponentManager.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_aggregators()CNComponentManager.set_telescope_availability()CNComponentManager.setup_event_subscription()CNComponentManager.standby()CNComponentManager.start_communicating()CNComponentManager.stop()CNComponentManager.stop_aggregation_process()CNComponentManager.stop_all_process()CNComponentManager.stop_communicating()CNComponentManager.telescope_off()CNComponentManager.telescope_on()CNComponentManager.telescope_standby()CNComponentManager.update_device_admin_mode()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()
- ska_tmc_centralnode.manager.component_manager_mid module
CNComponentManagerMidCNComponentManagerMid.add_dishes()CNComponentManagerMid.aggregate_load_dish_cfg_results()CNComponentManagerMid.check_device_responsiveness_command()CNComponentManagerMid.check_if_csp_all_dish_ready()CNComponentManagerMid.check_if_dishes_are_responsive()CNComponentManagerMid.dish_vcc_command_statusCNComponentManagerMid.dish_vcc_validation_statusCNComponentManagerMid.get_command_id()CNComponentManagerMid.get_default_dish_vcc_config_params()CNComponentManagerMid.get_dish_leaf_node_device_names()CNComponentManagerMid.get_load_disg_cfg_resultcode()CNComponentManagerMid.handle_dish_vcc_validation_result()CNComponentManagerMid.is_command_allowed()CNComponentManagerMid.is_csp_dish_ready()CNComponentManagerMid.is_dish_vcc_config_setCNComponentManagerMid.is_valid_admin_mode()CNComponentManagerMid.load_dish_cfg()CNComponentManagerMid.reset_load_dish_cfg_data()CNComponentManagerMid.stop_aggregation_process()CNComponentManagerMid.update_device_dish_mode()CNComponentManagerMid.update_device_state()CNComponentManagerMid.update_dish_vcc_flag()CNComponentManagerMid.update_k_value_validation()CNComponentManagerMid.update_load_dish_cfg_results()CNComponentManagerMid.update_load_dish_cfg_results_async()CNComponentManagerMid.update_long_running_command_result()CNComponentManagerMid.update_telescope_availability()
- ska_tmc_centralnode.manager.component_manager_low module
CNComponentManagerLowCNComponentManagerLow.assign_resources_schema_versionCNComponentManagerLow.check_device_responsiveness_command()CNComponentManagerLow.check_if_mccs_mln_is_available()CNComponentManagerLow.check_if_mccs_mln_is_responsive()CNComponentManagerLow.get_unique_ids()CNComponentManagerLow.is_command_allowed()CNComponentManagerLow.is_valid_admin_mode()CNComponentManagerLow.release_resources_schema_versionCNComponentManagerLow.reset_event_count()CNComponentManagerLow.stop_aggregation_process()CNComponentManagerLow.update_device_state()CNComponentManagerLow.update_long_running_command_result()CNComponentManagerLow.update_long_running_command_result_callback()CNComponentManagerLow.update_telescope_availability()
- ska_tmc_centralnode.manager.event_data_manager module
- ska_tmc_centralnode.manager.event_manager module
CentralNodeEventManagerCentralNodeEventManager.adminmode_event_callback()CentralNodeEventManager.assignedresources_event_callback()CentralNodeEventManager.cspcontrolleradminmode_event_callback()CentralNodeEventManager.dishmode_event_callback()CentralNodeEventManager.dishvccmapvalidationresult_event_callback()CentralNodeEventManager.healthstate_event_callback()CentralNodeEventManager.issubarrayavailable_event_callback()CentralNodeEventManager.issubsystemavailable_event_callback()CentralNodeEventManager.kvaluevalidationresult_event_callback()CentralNodeEventManager.longrunningcommandresult_event_callback()CentralNodeEventManager.mccscontrolleradminmode_event_callback()CentralNodeEventManager.obsstate_event_callback()CentralNodeEventManager.sdpcontrolleradminmode_event_callback()CentralNodeEventManager.state_event_callback()
- Module contents
- ska_tmc_centralnode.model package
- Submodules
- ska_tmc_centralnode.model.component module
CentralComponentCentralComponent.desired_telescope_stateCentralComponent.devicesCentralComponent.get_device()CentralComponent.imagingCentralComponent.pssCentralComponent.pstCentralComponent.remove_device()CentralComponent.set_op_callbacks()CentralComponent.telescope_availabilityCentralComponent.telescope_health_stateCentralComponent.telescope_stateCentralComponent.tmc_op_stateCentralComponent.to_dict()CentralComponent.to_json()CentralComponent.update_device()CentralComponent.update_device_exception()CentralComponent.vlbi
MCCSDeviceInfodev_state_2_str()
- ska_tmc_centralnode.model.enum module
- ska_tmc_centralnode.model.input module
- Module contents
- ska_tmc_centralnode.utils package
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, **kwargs)
Bases:
TMCBaseDeviceCentral 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, **kwargs)
Bases:
InitCommandA 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)
- 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_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_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
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.LowTmcCentralNode(*args, **kwargs)
Bases:
AbstractCentralNodeCentral Node is a coordinator of the complete Telescope system
- class InitCommand(*args, **kwargs)
Bases:
InitCommandA 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)
- assignResourcesSchemaVersion()
Get the version of the AssignResources schema being used.
- Return type:
str
- assignResourcesSchemaVersion_write(version)
Set or update the AssignResources schema version.
- Return type:
None
- create_component_manager()
Create component manager object for command invocation.
- releaseResourcesSchemaVersion()
Get the version of the ReleaseResources schema being used.
- Return type:
str
- releaseResourcesSchemaVersion_write(version)
Set or update the ReleaseResources schema version.
- Return type:
None
- ska_tmc_centralnode.central_node_low.main(args=None, **kwargs)
Runs the CentralNode. :type args: :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.MidTmcCentralNode(*args, **kwargs)
Bases:
AbstractCentralNodeCentral Node is a coordinator of the complete Telescope system
- class InitCommand(*args, **kwargs)
Bases:
InitCommandA 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.
- dishvcccommandstatus_cb(dish_vcc_command_status)
Update dish_vcc_command_status callbacks
- Parameters:
dish_vcc_command_status (DishConfigStatus) – Dish VCC command status
- Return type:
None
- dishvccvalidation_callback(dishvccvalidationstatus)
Update DishVccValidationStatus callbacks
- Parameters:
dishvccvalidationstatus – Dish VCC Validation status
- Return type:
None
- 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_DishVccCommandStatus()
Return the DishVccCommandStatus attribute.
- 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. :type args: :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:
objectClass 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.
- Parameters:
input_string (str) – A JSON string
- Returns:
Deserialized JSON object if successful.
- Return type:
dict
- Raises:
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:
objectClass 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.
- Parameters:
input_string (str) – A JSON string
- Returns:
Deserialized JSON object if successful.
- Return type:
dict
- Raises:
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 |