Guidelines and conventions for ALICE PVSSII control software

1. Guidelines and conventions for ALICE PVSSII control software Graphical User Interface Naming and Numbering conventions Project organization Alice DCS workshop, CERN S.Popescu

2. Selected tools and standards • Control applications shall run on Windows XP Operating System • Linux Operating System can be used exceptionally  approval from the ACC team is mandatory. • PVSS II shall be use as the SCADA system • Framework tools shall be used for development of control applications (-not reinventing the wheel!) • Finite State Machine is the selected tool for implementing the full control hierarchy in Alice • Sub-detector operation (states, actions, transitions..) will be performed via the FSMs therefore • FSM toolkit integrated in PVSSII and available with the Framework (SMI++) shall be used. • Any deviation from the above standards must be discussed before development with the ACC team • Already assigned name and standards (e.g. PVSS II and Framework) shall not be changed by sub-detectors Alice DCS workshop, CERN S.Popescu

3. Who is doing what? • ACC team will ensure the support for all future tools developments (Fw, PVSS.. )and integration (alice.dcs@cern.ch) • Every sub-detector shall nominate a person responsible or the control software (development and maintenance) and communicate this to the ACC team • Sub-detector responsible must ensure that the control software follow the guidelines, its integration and functionality. • Any control software prior to the final installation shall be validated in the DCS lab with a reference system, therefore a time schedule is need it from the sub-detector responsible Alice DCS workshop, CERN S.Popescu

4. General naming • Two standards are available: • interCapNotation and the name splitting using underscore. • Abbreviations are considered as single words. • For sub-detector identification  mandatory the standard three-letter sub-detector code shall be used (as defined in Appendix C of the document). • For ‘geographical’ identification  the standard ALICE naming, numbering (and ‘numbering direction’) and coordinate system shall be used (ALICE-INT-2003-038). • Names shall be meaningful. • Numbering starts at 0. Alice DCS workshop, CERN S.Popescu

5. Guidelines and conventions – PVSS project name • Project shall be developed in the US english (en_US.iso88591) • Every project shall be created as distributed system • The name for the detector top level* (in the FSM hierarchy) Control Unit should follow the rule <dc_dcs> where dc  Detector Code (ALICE-INT-2003-039) dcs abbreviation from Detector Control System • Ex: tpc_dcs, phs_dcs, sdd_dcs…. *It is recommended to have one PVSSII project per detector i.e. with small number of channels (hv, lv, cooling, fero) Alice DCS workshop, CERN S.Popescu

6. Guidelines and conventions – PVSS system name and number(1) • System name and number – are assigned at the creation time Alice DCS workshop, CERN S.Popescu

7. Guidelines and conventions – PVSS system name and number(2) • Names shall be in lowercase, underscore “_” shall be used to separate words. • Names starts with the standard three-letter sub-detector code followed by the underscore character “_“. .. <dc_..> • should intuitively describe its function or the sub-system it controls • Shall be documented by sub-detector responsible and made available to ACC team prior its installation in the production environment. • ACC will provide the PVSSII system number per sub-detector following a written request. An electronic form will be soon available on the Alice DCS web page • Abbreviations are considered as single words • If ‘geographical’ identification is needed, the standard ALICE naming, numbering and coordinate system shall be used (ALICE–INT-2003-038) Alice DCS workshop, CERN S.Popescu

8. Guidelines and conventions – OPC and Dim servers • OPC and DIM servers • The same naming formula • <dc_opcsn>  where opcsn = opc server name, dc  detector code • <dc_dimsn>  where dimsn = dim server name, dc  detector code Ex: tpc_opcwiener tpc_dimfero Alice DCS workshop, CERN S.Popescu

9. Guidelines and conventions – OPC and Dim servers • OPC driver numbers • Some PVSS OPC + Simulator driver numbers are reserved by the Framework ex: • Caen PVSSopc –num 6 PVSSsim –num 6 • Wiener PVSSopc –num 11, PVSSsim –num 11 • ELMB PVSSopc –num 7, PVSSsim –num 7 • DIP PVSSsim –num 13, PVSSdim –num 13 • Iseg PVSSopc –num 8, PVSSsim –num 8 • If there is a need to have another OPC client of the hw mentioned before, running on the same PVSS system the ACC must be contacted first. A new number will be assigned by the ACC team. • For any new hardware integrated in the ALICE DCS control , the OPC and Dim driver numbers will be assigned by the ACC team, following a written request. • An electronic form will be soon available on the Alice DCS web page Alice DCS workshop, CERN S.Popescu

10. Guidelines and Conventions - Panels • Look and feel • Will be displayed on screens with at least resolution of 1024 x 768 pixels. • Font to be used is: “Arial regular 10”; the background colour to be used is: “_3DFace” (more conventions in the FW guidelines) • Naming of sub-systems and parameters shall be as the ones listed (see Appendix A of the document). • Child panels shall be cascaded and have a close button at the bottom right corner. • ALICE logo shall appear at the top left corner. • help button located at the top right corner, and give access to the online help. • online help shall be provided in the standard format Alice DCS workshop, CERN S.Popescu

11. Guidelines and Conventions – FSM operational panels • FSM toolkit shall be used  a default layout is provided • Two zone –control zone and monitoring zone • Control zone must contain all the CU need it for operation • Monitoring zone can be used as the detector wants • It is recommended to fill this zone with complementary information for the operator ex: state diagram of the CU, some crucial parameters • ACC will soon provide some standard widgets Alice DCS workshop, CERN S.Popescu

12. Still under development!! Disregard the inconsistencies, it is shown as a working principle!! Alice DCS workshop, CERN S.Popescu

13. Guidelines and Conventions – Development • DataPointsTypes and DataPoints • PVSS II and Framework DP and DPT shall not be changed • For new hardware added the DP should reflect exactly the OPC or DIM items names • The prefix (detector code) is mandatory . For DPT first letter must be upper case for DP should be smaller case • The general naming scheme could be <dc_ss...> where dc is the Detector Code and ss is the Sub-System name Example: Tpc_hv_anodeforDPT, tpc_hvAnodeSect1 forDP A detailed description can be found at the following address http://alicedcs.web.cern.ch/AliceDCS/Documents/ Recommendations: • interCapNotation should be followed wherever possible tpc_HvAnode • If detector need to split the name it is generally recommended to have “underscore” as separation tpc_hv_anode Alice DCS workshop, CERN S.Popescu

14. Guidelines and Conventions – Development • Libraries and control scripts • Wherever applicable is recommended to use the Framework ones • Must have meaningful name • interCapNotation use is strongly recommended • Must be documented in the header file or as a separate text file in English. • …. Alice DCS workshop, CERN S.Popescu

15. Guidelines and Conventions - Panels • Path and subfolders • For new hardware integration the folder structure shall be ..newHardwareName/config – contains the config file ..newHardwareName/dplist -- contains dpfileDataPoint / DataPointTypes ex: newHardwareDP.dpl, newHardwareNameDPT.dpl ..newHardwareName/panels – contains the corresponding panels ..newHardwareName/scripts Alice DCS workshop, CERN S.Popescu

16. Guidelines and Conventions – Development • FSM objects • States, actions, alarms shall follow the rules defined by PVSS, Framework and Giacinto’s presentation. • Naming convention for: states and actions is uppercase • words can be separated by and underscore “_” (e.g. GO_PHYSICS). • All sub-detectors must provide written documentation on state diagram of their sub-detector, operation, action, alarms…. • Partitioning will be performed using the FSM tools in conjunction with the ECS partitioning tools Alice DCS workshop, CERN S.Popescu

17. Conclusions • A more detailed document can be found at the following address http://alicedcs.web.cern.ch/AliceDCS/Documents/ • It is in our common understanding that the sub-detector developer followed the PVSS and Framework training courses • It is mandatory to follow the present rules Alice DCS workshop, CERN S.Popescu

18. Conclusion • Still to come… • ACC will come soon with a proposed architecture for the FSM hierarchy • Alarms messages and alarm handling is still to be defined, a proposal will arrive in the following months • Alice DCS widgets will be made available soon by the ACC team • Strongly recommended to contact us if you are having doubts or missing information • This might avoid paint full tasks of renaming and an uncomfortable maintenance Alice DCS workshop, CERN S.Popescu

19. Alice DCS workshop, CERN S.Popescu

20. Alice DCS workshop, CERN S.Popescu