This project is developing the TMC CSP Leaf Nodes component of the Telescope Monitoring and Control (TMC) prototype, for the Square Kilometre Array.

Getting started

This page contains instructions for software developers who want to get started with usage and development of the TMC Leaf Nodes.

Background

Detailed information on how the SKA Software development community works is available at the SKA software developer portal. There you will find guidelines, policies, standards and a range of other documentation.

Set up your development environment

This project is structured to use k8s for development and testing so that the build environment, test environment and test results are all completely reproducible and are independent of host environment. It uses make to provide a consistent UI (run make help for targets documentation).

Install minikube

You will need to install minikube or equivalent k8s installation in order to set up your test environment. You can follow the instruction here: :: git clone git@gitlab.com:ska-telescope/sdi/deploy-minikube.git cd deploy-minikube make all eval $(minikube docker-env)

Please note that the command `eval $(minikube docker-env)` will point your local docker client at the docker-in-docker for minikube. Use this only for building the docker image and another shell for other work.

How to Use

Clone this repo: :: git clone https://gitlab.com/ska-telescope/ska-tmc-cspleafnodes.git cd ska-tmc-cspleafnodes

Install dependencies :: apt update apt install -y curl git build-essential libboost-python-dev libtango-dev curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python3 - source $HOME/.poetry/env

Please note that:

  • the libtango-dev will install an old version of the TANGO-controls framework (9.2.5);

  • the best way to get the framework is compiling it (instructions can be found here);

  • the above script has been tested with Ubuntu 20.04.

During this step, `libtango-dev` instalation can ask for the Tango Server IP:PORT. Just accept the default proposed value.

Install python requirements for linting and unit testing: :: $ poetry install

Activate the poetry environment: :: $ source $(poetry env info –path)/bin/activate

Follow the steps till installation of dependencies then run below command: :: $ virtualenv cn_venv $ source cn_venv/bin/activate $ make requirements

Run python-test: :: $ make python-test PyTango 9.3.3 (9, 3, 3) PyTango compiled with: Python : 3.8.5 Numpy : 0.0.0 ## output generated from a WSL windows machine Tango : 9.2.5 Boost : 1.71.0

PyTango runtime is: Python : 3.8.5 Numpy : None Tango : 9.2.5

PyTango running on: uname_result(system=’Linux’, node=’LAPTOP-5LBGJH83’, release=’4.19.128-microsoft-standard’, version=’#1 SMP Tue Jun 23 12:58:10 UTC 2020’, machine=’x86_64’, processor=’x86_64’)

============================= test session starts ============================== platform linux – Python 3.8.5, pytest-5.4.3, py-1.10.0, pluggy-0.13.1 – /home/ [….]

——————————— JSON report ———————————- JSON report written to: build/reports/report.json (165946 bytes)

———– coverage: platform linux, python 3.8.5-final-0 ———– Coverage HTML written to dir build/htmlcov Coverage XML written to file build/reports/code-coverage.xml

======================== 48 passed, 5 deselected in 42.42s ========================

Formatting the code: :: $ make python-format […] ——————————————————————– Your code has been rated at 10.00/10 (previous run: 10.00/10, +0.00)

Python linting: :: $ make python-lint […] ——————————————————————– Your code has been rated at 10.00/10 (previous run: 10.00/10, +0.00)

TMC CSP Leaf Nodes code quality guidelines

Code formatting / style

Black

TMC CSP Leaf Nodes uses the black code formatter to format its code. Formatting can be checked using the command make python-format.

The CI pipeline does check that if code has been formatted using black or not.

Linting

TMC CSP Leaf Nodes uses below libraries/utilities for linting. Linting can be checked using command make python-lint.

  • isort - It provides a command line utility, Python library and

    plugins for various editors to quickly sort all your imports.

  • black - It is used to check if the code has been blacked.

  • flake8 - It is used to check code base against coding style (PEP8),

    programming errors (like “library imported but unused” and “Undefined name”),etc.

  • pylint - It is looks for programming errors, helps enforcing a coding standard,

    sniffs for code smells and offers simple refactoring suggestions.

Test coverage

TMC CSP Leaf Nodes uses pytest to test its code, with the pytest-cov plugin for measuring coverage.

ska_tmc_cspmasterleafnode package

Subpackages

ska_tmc_cspmasterleafnode.commands package

Submodules

ska_tmc_cspmasterleafnode.commands.abstract_command module

Abstract command class for Csp Master Leaf Node

class ska_tmc_cspmasterleafnode.commands.abstract_command.CspMLNCommand(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

Abstract command class for all CspMasterLeafNode

check_allowed()

Checks whether this command is allowed It checks that the device is in the right state to execute this command and that all the component needed for the operation are not unresponsive

Returns

True if this command is allowed

Return type

boolean

check_unresponsive()

Checks if the device is unresponsive

Returns

None

init_adapter()

ska_tmc_cspmasterleafnode.commands.on_command module

On command class for CSPMasterLeafNode.

class ska_tmc_cspmasterleafnode.commands.on_command.On(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for CspMasterLeafNode’s On() command.

On command on CspmasterLeafNode enables the telescope to perform further operations and observations. It Invokes On command on Csp Master device.

do(argin=None)

Method to invoke On command on Csp Master.

ska_tmc_cspmasterleafnode.commands.standby_command module

Standby command class for Csp Master Leaf Node

class ska_tmc_cspmasterleafnode.commands.standby_command.Standby(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for CspMasterLeafNode’s Standby() command.

Standby command on CspMasterLeafNode invokes Standby command on Csp Master device.

do(argin=None)

Method to invoke Standby command on Csp Master.

Module contents

Init file for Csp Master Leaf Node Commands

class ska_tmc_cspmasterleafnode.commands.On(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for CspMasterLeafNode’s On() command.

On command on CspmasterLeafNode enables the telescope to perform further operations and observations. It Invokes On command on Csp Master device.

do(argin=None)

Method to invoke On command on Csp Master.

class ska_tmc_cspmasterleafnode.commands.Standby(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for CspMasterLeafNode’s Standby() command.

Standby command on CspMasterLeafNode invokes Standby command on Csp Master device.

do(argin=None)

Method to invoke Standby command on Csp Master.

ska_tmc_cspmasterleafnode.manager package

Submodules

ska_tmc_cspmasterleafnode.manager.component_manager module

This module implements ComponentManager class for the Csp Master Leaf Node.

class ska_tmc_cspmasterleafnode.manager.component_manager.CspMLNComponentManager(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_component_manager.ska_tmc_common.tmc_component_manager.TmcLeafNodeComponentManager._name

A component manager for The CSP Master Leaf Node component.

It supports in controlling the behaviour of CSP Master.

Module contents

Init file for Csp Master Leaf Node Manager

class ska_tmc_cspmasterleafnode.manager.CspMLNComponentManager(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_component_manager.ska_tmc_common.tmc_component_manager.TmcLeafNodeComponentManager._name

A component manager for The CSP Master Leaf Node component.

It supports in controlling the behaviour of CSP Master.

Submodules

ska_tmc_cspmasterleafnode._csp_master_leaf_node module

CSP Master Leaf node acts as a CSP contact point for Master Node and also to monitor and issue commands to the CSP Master.

class ska_tmc_cspmasterleafnode.csp_master_leaf_node.CspMasterLeafNode(*args: Any, **kwargs: Any)

Bases: ska_tango_base.ska_tango_base.SKABaseDevice._name

CSP Master Leaf node acts as a CSP contact point for Master Node and also to monitor and issue commands to the CSP Master.

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

Bases: ska_tango_base.SKABaseDevice.ska_tango_base.SKABaseDevice.InitCommand._name

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

do()

Initializes the attributes and properties of the CspMasterLeafNode.

Returns

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

rtype:

(ResultCode, str)

Off()

This command invokes Off() command on Csp Master.

always_executed_hook()
create_component_manager()
cspMasterDevName
delete_device()
init_command_objects()

Initialises the command handlers for commands supported by this device.

is_Off_allowed()

Checks whether this command is allowed to be run in current device state. :return: True if this command is allowed to be run in current device state. :rtype: boolean

is_On_allowed()

Checks whether this command is allowed to be run in current device state. :return: True if this command is allowed to be run in current device state. :rtype: boolean

is_Standby_allowed()

Checks whether this command is allowed to be run in current device state. :return: True if this command is allowed to be run in current device state. :rtype: boolean

read_commandExecuted()

Return the commandExecuted attribute.

ska_tmc_cspmasterleafnode.csp_master_leaf_node.main(args=None, **kwargs)

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

Parameters

kwargs – Arguments internal to TANGO

Returns

CspMasterLeafNodeMid TANGO object.

Module contents

CspMasterLeafNode

ska_tmc_cspsubarrayleafnode package

Subpackages

ska_tmc_cspsubarrayleafnode.commands package

Submodules

ska_tmc_cspsubarrayleafnode.commands.abstract_command module

Abstract Command Class for Csp Subarray Leaf Node

class ska_tmc_cspsubarrayleafnode.commands.abstract_command.AbstractOnOff(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

Abstract class for CspSubarrayLeafNode

check_allowed()

Checks whether this command is allowed. It checks that the device is in the right state to execute this command and that all the components needed for the operation are not unresponsive.

Returns

True if this command is allowed

Return type

boolean

class ska_tmc_cspsubarrayleafnode.commands.abstract_command.CspSLNCommand(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

Abstract command class for all CspSubarrayLeafNode

check_op_state(command_name)

Checks the operational state of device

check_unresponsive()

Checks whether the device is unresponsive

init_adapter()

ska_tmc_cspsubarrayleafnode.commands.on_command module

On command class for CSPSubarrayLeafNode.

class ska_tmc_cspsubarrayleafnode.commands.on_command.On(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for CspsubarrayLeafNode’s On() command.

On command on CspsubarrayLeafNode enables the telescope to perform further operations and observations. It Invokes On command on Csp Subarray device.

do(argin=None)

Method to invoke On command on Csp Subarray.

ska_tmc_cspsubarrayleafnode.commands.off_command module

Off command class for CSPSubarrayLeafNode.

class ska_tmc_cspsubarrayleafnode.commands.off_command.Off(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for CSPsubarrayLeafNode’s Off() command.

Off command on CSPsubarrayLeafNode enables the telescope to perform further operations and observations. It Invokes Off command on Csp Subarray device.

do(argin=None)

Method to invoke Telescope Off command on Csp Subarray.

ska_tmc_cspsubarrayleafnode.commands.assign_resources_command module

AssignResouces command class for CSPSubarrayLeafNode.

class ska_tmc_cspsubarrayleafnode.commands.assign_resources_command.AssignResources(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for CspSubarayLeafNode’s AssignResources() command.

It accepts subarrayID and receptor ids in JSON string format and invokes AssignResources command on CSP Subarray.

check_allowed()

Checks whether this command is allowed It checks that the device is in the right state to execute this command and that all the component needed for the operation are not unresponsive

Returns

True if this command is allowed

Return type

boolean

do(argin=None)

Method to invoke AssignResources command on CSP Subarray. :param argin:DevString. The string in JSON format. The JSON contains following values: subarray_id: integer dish: Mandatory JSON object consisting of receptor_ids: DevVarString The individual string should contain dish numbers in string format with preceding zeroes upto 3 digits. E.g. 0001, 0002. Example: { “interface”: “https: //schema.skao.int/ska-mid-csp-assignresources/2.0”, “subarray_id”: 1, “dish”: { “receptor_ids”: [ “0001”, “0002” ] } } Note: Enter the json string without spaces as an input. return: None

validate_json_argument(input_argin)

Validates the json argument

ska_tmc_cspsubarrayleafnode.commands.release_all_resources_command module

ReleaseAllResources command class for CSPSubarrayLeafNode.

class ska_tmc_cspsubarrayleafnode.commands.release_all_resources_command.ReleaseAllResources(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_command.ska_tmc_common.tmc_command.TmcLeafNodeCommand._name

A class for CspSubarayLeafNode’s ReleaseAllResources() command.

Releases all the resources of given CSP Subarray Leaf Node.

check_allowed()

Checks whether this command is allowed It checks that the device is in the right state to execute this command and that all the component needed for the operation are not unresponsive

Returns

True if this command is allowed

Return type

boolean

do(argin=None)

Method to invoke ReleaseAllResources command on CSP Subarray.

Parameters

argin – None.

Returns

None

Module contents

ska_tmc_cspsubarrayleafnode.manager package

Submodules

ska_tmc_cspsubarrayleafnode.manager.component_manager module

Component Manager class for CSP Subarray Leaf Node

class ska_tmc_cspsubarrayleafnode.manager.component_manager.CspSLNComponentManager(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_component_manager.ska_tmc_common.tmc_component_manager.TmcLeafNodeComponentManager._name

A component manager for The CSP Subarray Leaf Node component.

It supports:

  • Monitoring its component, e.g. detect that it has been turned off or on

get_device()

Return the device info our of the monitoring loop with name dev_name

Parameters

None –

Returns

a device info

Return type

SubArrayDeviceInfo

stop()
update_device_info(csp_subarray_dev_name)

Updates the device info

update_device_obs_state(obs_state)

Update a monitored device obs state, and call the relative callbacks if available

Parameters

  • dev_name (str) – name of the device

  • obs_state (ObsState) – obs state of the device

update_event_failure()

ska_tmc_cspsubarrayleafnode.manager.event_receiver module

Event Reciever for Csp Subarray Leaf Node

class ska_tmc_cspsubarrayleafnode.manager.event_receiver.CspSLNEventReceiver(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.event_receiver.ska_tmc_common.event_receiver.EventReceiver._name

The CspSLNEventReceiver class has the responsibility to receive events from the CSP Subarray managed by the Csp Subarray Leaf Node.

The ComponentManager uses the handle events methods for the attribute of interest. For each of them a callback is defined.

handle_obs_state_event(evt)
run()
subscribe_events(dev_info)

Module contents

Init file for Csp Subarray Leaf Node Manager

class ska_tmc_cspsubarrayleafnode.manager.CspSLNComponentManager(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.tmc_component_manager.ska_tmc_common.tmc_component_manager.TmcLeafNodeComponentManager._name

A component manager for The CSP Subarray Leaf Node component.

It supports:

  • Monitoring its component, e.g. detect that it has been turned off or on

get_device()

Return the device info our of the monitoring loop with name dev_name

Parameters

None –

Returns

a device info

Return type

SubArrayDeviceInfo

stop()
update_device_info(csp_subarray_dev_name)

Updates the device info

update_device_obs_state(obs_state)

Update a monitored device obs state, and call the relative callbacks if available

Parameters

  • dev_name (str) – name of the device

  • obs_state (ObsState) – obs state of the device

update_event_failure()
class ska_tmc_cspsubarrayleafnode.manager.CspSLNEventReceiver(*args: Any, **kwargs: Any)

Bases: ska_tmc_common.event_receiver.ska_tmc_common.event_receiver.EventReceiver._name

The CspSLNEventReceiver class has the responsibility to receive events from the CSP Subarray managed by the Csp Subarray Leaf Node.

The ComponentManager uses the handle events methods for the attribute of interest. For each of them a callback is defined.

handle_obs_state_event(evt)
run()
subscribe_events(dev_info)

Submodules

ska_tmc_cspsubarrayleafnode._csp_subarray_leaf_node module

CSP Subarray Leaf node monitors the CSP Subarray and issues control actions during an observation. It also acts as a CSP contact point for Subarray Node for observation execution for TMC.

class ska_tmc_cspsubarrayleafnode.csp_subarray_leaf_node.CspSubarrayLeafNode(*args: Any, **kwargs: Any)

Bases: ska_tango_base.ska_tango_base.SKABaseDevice._name

CSP Subarray Leaf node monitors the CSP Subarray and issues control actions during an observation.

Device Properties
CspSubarrayFQDN:

Property to provide FQDN of CSP Subarray Device

Device Attributes
commandExecuted:

Stores command executed on the device.

lastDeviceInfoChanged:

Json String representing the last device changed in the internal model.

cspSubarrayDevName:

Stores CSP Subarray Device name.

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

Bases: ska_tango_base.SKABaseDevice.ska_tango_base.SKABaseDevice.InitCommand._name

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

do()

Initializes the attributes and properties of the CspSubarrayLeafNode :return: A tuple containing a return code and a string message indicating status. The message is for information purpose only. :rtype: (ReturnCode, str)

Off()

This command invokes Off() command on Csp Subarray.

always_executed_hook()
create_component_manager()
delete_device()
init_command_objects()

Initialises the command handlers for commands supported by this device.

is_Abort_allowed()

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

Returns

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

rtype:

boolean

Raises

  • DevFailed if this command is not allowed to be run in current –

  • device state –

is_AssignResources_allowed()

Checks whether AssignResources command is allowed to be run in current device state. :return: True if AssignResources command is allowed to be run in current device state :rtype: boolean

is_Configure_allowed()

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

Returns

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

rtype:

boolean

is_EndScan_allowed()

Checks whether EndScan command is allowed to be run in current device state. return: True if EndScan command is allowed to be run in current device state. rtype: boolean

is_End_allowed()

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

Returns

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

rtype:

boolean

is_ObsReset_allowed()

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

Returns

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

rtype:

boolean

is_Off_allowed()

Checks whether Off command is allowed to be run in current device state. :return: True if Off command is allowed to be run in current device state. :rtype: boolean

is_On_allowed()

Checks whether On command is allowed to be run in current device state. :return: True if On command is allowed to be run in current device state. :rtype: boolean

is_ReleaseAllResources_allowed()

Checks whether ReleaseResources command is allowed to be run in current device state. :return: True if ReleaseResources command is allowed to be run in current device state. :rtype: boolean

is_Restart_allowed()

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

Returns

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

rtype:

boolean

Raises

  • DevFailed if this command is not allowed to be run in current –

  • device state –

is_Scan_allowed()

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

Returns

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

rtype:

boolean

read_commandExecuted()

Return the commandExecuted attribute.

read_cspSubarrayDevName()

Returns the CspSubarrayDevName attribute value.

read_lastDeviceInfoChanged()

Read method for Last Device info Changed

update_device_callback(devInfo)

Updates the device callback

write_cspSubarrayDevName(value)

Set the cspsubarraydevname attribute.

ska_tmc_cspsubarrayleafnode.csp_subarray_leaf_node.main(args=None, **kwargs)

Runs the CspSubarrayLeafNode Tango device. :param args: Arguments internal to TANGO

Parameters

kwargs – Arguments internal to TANGO

Returns

integer. Exit code of the run method.

Module contents

CspSubarrayLeafNode