SLS functional device naming convention

History

This note on the SLS device naming convention supersedes the documents

The device naming as proposed here is based on these previous documents and on the ESRF [4] and SSC naming conventions [5].
After 2 years of discussion a binding convention for functional device naming was established as agreed upon at the meeting of Jan. 23rd, 1998. A final upgrade was done in August 1998 for unification with the new PSI-ABS (PSI Anlagenbezeichnungssystem)
to integrate also the complete infrastructure naming for all future PSI installations.


[1] A. Streun, SLS functional device naming convention, SLS-TME-TA-1998-0001+2 (May 1998)
[2] A. Streun, Naming conventions for SLS complex and SLS Teststand, SLS-TME-TA-1996-0012z
[3] A. Streun, SLS Device naming convention, SLS-TME-TA-1997-1000z
[4] P. Berkvens, Nomenclature for ESRF machine elements, ESRF, 23.1.1991
[5] P.A. Gurd et al., Mnemonic device naming convention, SSC P40-000151


The concept of functional devices

The functional device naming as described in this note deals with functions fulfilled by complex devices regardless of the number and type of the hardware components involved. Thus it reflects the control system's and machine operator's point of view.

The functional devices names are not identifiers of individual pieces of hardware, but identifiers of the function to be fulfilled by the hardware! Hardware naming itself follows completely different rules and may vary for different kinds of components.

To give a simple example: The functional device ARIMA-QLA-01 (the first quadrupole for matching to the long straight in sector 1 of the storage ring) contains several pieces of hardware: First we have the magnet itself, which could be QAW03 (wide short ring quad, serial number 3), with the name QAW03 given by the magnet group and rigidly attached as a metal plate to the physical magnet itself. We further have the cable between magnet and power supply, which correspondingly has a name as given by the cabeling group, the power supply feeding the magnet and its controller, both with names as given by the power supply group. The mapping of hardware serial numbers to the functional device names will show no correlation, since assigning will be determined by procedeure like magnet sorting for example. Further mixing will occur due to replacement of broken components, etc.

The functional device ARIMA-QLA-01 also has channels, i.e. signals to be controlled by the control system. These will be the magnet current (setpoint, readback, etc.), the waterflow status of the magnet, some temperature control, and many more. The signal channelswill be named with the functional device name followed by the channel name.

With regard to the database implementation, every entry defined by a functional device name as appearing in the mastertable, contains a list of hardware components and a list of channels.

General guidelines for device naming

Functionality
Devices are arranged in a hierachical structure, so that one can »zoom in« onto a particular device by successive branchings. Every device has a unique name. This makes the device naming akin to the well-tried biological classification system invented by Linné.
The system is open for future development, i.e. for adding more and other components than expected now according to name giving rules.

Convenience
The device names are reasonable compromises between the demand for mnemonic descriptors, i.e.names providing some information on the kind, location or function of the device, and for compact descriptors, i.e short names avoiding redundant characters. In order to be well legible names are segmented by delimiters, i.e. special characters between the relevant sections.

Centralization
The naming convention is managed from a central database. Particular device names were established through discussions with responsible persons working on the different systems: on one hand no unfamiliar device names should be forced on people who work with these devices, on the other hand all names should follow the same logic.