Uploaded image for project: 'SAFe architectural decision records'
  1. SAFe architectural decision records
  2. ADR-9

Update naming conventions for TANGO Devices and Servers, add naming conventions for other aspects such as containers.

    XporterXMLWordPrintable

Details

    Description

      Why now?  The project is still in early stages, but more and more software is being developed. We now have some experience, and will be able to improve the guidelines. 

      The SKA software naming conventions were adopted (see ADR-25) and there is a plan to update (and review) the document CS Guidelines. 

      Scope: SKA Control System.

      Quality: Usability, Monitorability, Debuggability.

      While updating the naming conventions for Mid.CBF, it was noticed that the current naming and numbering scheme does not represent the actual functionality well.

      References:

      1. SKA Control System Guidelines

      2. https://confluence.skatelescope.org/display/SWSI/TANGO+Device+Names

      The proposed changes are listed here; a broader review is needed:

      1. Support comment by Elisabetta Giani that the subarray IDs should be two digit number - that will look better on the screens and will be easier to sort. 
      2. Device names should use camel format - underscores are very unfortunate choice - the names are longer and will look bad on screens (Lise commented long ago that underscores look bad on the screens (can  be invisible and it is difficult to know whether there is an underscore or blank). 
      3. When two or more IDs are required to identify device, the preference should be to start with higher-level device or concept  (see example for Search Windows,  where the sub-array is identified first, then the search window in that sub-array). 
      4. Consider elimination of elt and sub-elt from the TANGO Fully Qualified Device Names (FQDNs), replace  those with more meaningful names that reflect the actual device role. 
      5. Naming conventions should include software entities (classes, device servers, containers, commands/methods, attributes, properties).
      6. Should integer identifiers start from zero or from 1 ?  Current implementation: subarray IDs start from 1, channel IDs start from zero.  There is no convention at the system level. Any convention adopted by SKA cannot be applied to COTS equipment.

      Related links

      https://confluence.skatelescope.org/display/SWSI/ADR-9+Update+naming+conventions+for+TANGO+Devices+and+Servers

      https://jira.skatelescope.org/browse/ADR-25?src=confmacro

       

       

      Attachments

        Issue Links

          Structure

            Activity

              People

                s.vrcic Vrcic, Sonja
                s.vrcic Vrcic, Sonja
                Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  Structure Helper Panel