T A B L E O F C O N T E N T S

1 INTRODUCTION 11

1.1 PURPOSE 11

1.2 SCOPE 11

1.3 APPLICABLE DOCUMENTS 11

1.4 REFERENCE DOCUMENTS 11

1.5 ABBREVIATIONS AND ACRONYMS 12

1.6 GLOSSARY 13

1.7 STYLISTIC CONVENTIONS 13

1.7.1 Data Flow and Processor Model Diagrams 13

1.7.2 Class Diagrams 13

1.8 NAMING CONVENTIONS 14

1.9 PROBLEM REPORTING/CHANGE REQUEST 14

2 OVERVIEW 15

2.1 INTRODUCTION 15

2.2 NAMING CONVENTIONS 15

2.3 ARCHITECTURE 16

2.3.1 Panels and Scripts 16

2.3.2 Applications, Panels and Processes 16

2.3.3 Standard Instrumentation Software 17

2.4 SOFTWARE MODULES 18

3 GETTING STARTED 19

4 USER'S GUIDE 21

4.1 USER STATION: INSTRUMENT DESKTOP ROOT MENU 21

4.2 START/STOP FROM ANY WORKSTATION 22

4.3 STARTUP PANELS 22

4.4 START/STOP DURING DEVELOPMENT 24

4.4.1 Start/Stop Individual Applications (e.g. ICS, DCS, OS) 24

4.4.2 Start/Stop Individual Panels 24

4.4.3 List Known Applications and Panels 24

5 TUTORIAL: IMPLEMENTING A STARTUP TOOL FROM SCRATCH 25

5.1 ROADMAP 25

5.2 IMPLEMENTATION ORDER OF ICS, DCS, OS AND STARTUP SCRIPTS 25

5.3 INSTRUMENT IDENTIFIER AND SOFTWARE MODULE PREFIX 25

5.4 RETRIEVING THE TEMPLATE INSTRUMENT MODULES 26

5.5 DEFINING THE STARTUP TOOL CONFIGURATION 26

5.6 ADAPTING THE TEMPLATE MODULES TO A NEW INSTRUMENT 26

5.6.1 Module nnins 27

5.6.2 Module nnmcfg (MS/nnmcfg) 28

5.7 IMPLEMENTING AN INSTRUMENT SPECIFIC STARTUP PANEL 29

5.8 INSTALLING AND TESTING 29

5.8.1 Installation 29

5.8.2 Testing the Startup Tool 30

5.9 FINAL REMARKS 30

6 CONFIGURATION GUIDE 31

6.1 INTRODUCTION 31

6.2 CONFIGURATION FILES 31

6.3 FROM THE CONFIGURATION FILES TO THE RUNNING SYSTEM 31

6.4 DESIGN CONFIG. PARAMETERS VS. NORMAL CONFIG. PARAMETERS 31

6.4.1 Design Config. Parameters 32

6.4.2 Normal Config. Parameters 32

6.5 UPDATING AND TESTING THE STARTUP CONFIGURATION 32

6.5.1 Updating Design Config. Parameters 32

6.5.2 Updating Normal Config. Parameters 32

6.6 THE xxmcfgINS.cfg AND xxmcfgSTART.cfg FILES 33

6.7 GENERAL STARTUP AND INSTRUMENT CONFIGURATION 34

6.7.1 Startup Application Type 34

6.7.2 Instrument Identifier 34

6.7.3 Software Module Prefix 34

6.7.4 Instrument Workstation Environment 34

6.7.5 Startup Application Name 35

6.7.6 Start Application if Panel is Started 35

6.7.7 Send STANDBY Command to Applications 35

6.7.8 Instrument Specific Startup Code 35

6.7.9 MIDAS Available Flag 35

6.8 OS GENERAL CONFIGURATION 36

6.8.1 Release Date 36

6.8.2 Origin 36

6.8.3 Logging Level 36

6.8.4 Start OS Application on start-up 36

6.8.5 Flag indicating if OS exists 36

6.9 TCS SUBSYSTEM CONFIGURATION 37

6.9.1 Telescope UT Number 37

6.9.2 Telescope Focus 37

6.9.3 TCS Access Mode 37

6.9.4 TCS Server Process Name 38

6.9.5 TCS Environment Name 38

6.9.6 TCS Command Timeout 38

6.10 ICS SUBSYSTEM CONFIGURATION 39

6.10.1 Number of ICS Subsystems 39

6.10.2 ICS Name 39

6.10.3 ICS Access Mode 40

6.10.4 ICS Simulation Mode 40

6.10.5 Start ICS Stand-alone Panel 40

6.10.6 ICS Server and Environment Name 40

6.10.7 ICS Command Timeout 40

6.10.8 ICS Local Flag 40

6.10.9 ICS State OLDB Attribute Location 40

6.10.10 ICS Dictionary and Alias File 41

6.10.11 ICS Keyword Filter 41

6.10.12 Start ICS Application on start-up 41

6.11 DCS ACE AND FIERA SUBSYSTEM CONFIGURATION 41

6.11.1 Number of DCS Subsystems 42

6.11.2 DCS Name 42

6.11.3 DCS Type 42

6.11.4 DCS Associated Camera Name 42

6.11.5 DCS LCU Environment 42

6.11.6 DCS OLDB Configuration File 43

6.11.7 DCS Access Mode 43

6.11.8 DCS Simulation Mode 43

6.11.9 Start DCS Stand-alone Panel 43

6.11.10 Start DCS related RTD 43

6.11.11 DCS Server and Environment Name 43

6.11.12 DCS Command Timeout 43

6.11.13 DCS State OLDB Attribute Location 44

6.11.14 DCS Keyword Filter 44

6.11.15 DCS World Coordinate System 44

6.11.16 Start DCS Application on start-up 44

6.11.17 Stop DCS Application on shutdown 44

6.11.18 DCS Min. Free Disk Space 44

6.11.19 FIERA Image Directory 44

6.12 DCS IRACE SUBSYSTEM CONFIGURATION 45

6.12.1 Number of DCS Subsystems 46

6.12.2 DCS Name 46

6.12.3 DCS Type 46

6.12.4 DCS Pre-Processor Host Name 46

6.12.5 DCS System Configuration File 46

6.12.6 DCS Access Mode 46

6.12.7 DCS Simulation Mode 47

6.12.8 Start DCS Stand-alone Panel 47

6.12.9 Start DCS related RTD 47

6.12.10 DCS Server, Data Transfer Task and Environment Name 47

6.12.11 DCS Front End Command Server Port Number 47

6.12.12 DCS UIF Plug-In Software Module 47

6.12.13 DCS Command Timeout 48

6.12.14 DCS State OLDB Attribute Location 48

6.12.15 DCS Keyword Filter 48

6.12.16 DCS World Coordinate System 48

6.12.17 Start DCS Application on start-up 48

6.12.18 Stop DCS Application on shutdown 48

6.12.19 DCS Min. Free Disk Space 48

6.13 OS SUBSYSTEMS (INSTRUMENTS CONTROLLED BY AN SOS) 49

6.13.1 Number of OS Subsystems 50

6.13.2 OS Subsystem Name 50

6.13.3 OS Subsystem Environment 50

6.13.4 BOB Available Flag 51

6.13.5 BOB Stop Flag 51

6.13.6 BOB Configuration File 51

6.13.7 Panel Available Flags 51

6.14 INSTRUMENT SPECIFIC PANELS 52

6.14.1 Panel Name and Description 52

6.14.2 Panel Executable and Directory 52

6.14.3 Panel Stop Flag 52

6.14.4 Panel Default Flag 53

6.15 STARTUP CONFIGURATION 53

6.15.1 Panel Default Flags 54

7 PROGRAMMER'S GUIDE 55

7.1 DEBUGGING FACILITIES 55

7.1.1 Log Levels 55

7.1.2 TCL Errors 55

7.1.3 Internal Object List 55

7.1.4 Internal Object Variables 56

7.2 INSTRUMENT SPECIFIC STARTUP CODE 57

7.2.1 Registering File xxinsStoo 57

7.2.2 The Global Array stooType 57

7.2.3 Example: Overloading Class STARTUP 59

7.2.4 Example: Using Specific startup code for STRAP and RTC 59

7.3 ADJUSTING THE INSTRUMENT CONFIGURATION 59

7.3.1 Adding a Single Process 59

7.3.2 Setting an Option of an Application, Panel or Process 60

7.3.3 Changing the Startup Order of an Application or Panel 60

7.3.4 Removing a Process or Panel 60

7.4 INSTRUMENT SPECIFIC PANELS 62

7.4.1 Adding New Panels 62

7.4.2 Modifying/Replacing an Existing Panel 62

7.5 INSTRUMENT SPECIFIC APPLICATIONS 62

7.5.1 Starting/Stopping an Instrument Specific OS or ICS 62

7.6 INTERFACES 64

7.6.1 Human Interfaces 64

7.6.2 Hardware Interfaces 64

7.6.3 Software Interfaces 64

8 FAQ AND TROUBLESHOOTING 65

8.1 CONFIGURATION FILES 65

8.1.1 Why are there two configuration files: xxmcfgINS.cfg and xxmcfgSTART.cfg ? 65

8.1.2 What keywords are stored in file xxmcfgINS.cfg, what keywords in xxmcfgSTART.cfg ? 65

8.1.3 During development we need to store the configuration in different files (managed by different teams). Is this possible ? 65

8.1.4 Why does the Configuration Guide describe keywords that are not used by the startup tool ? 65

8.2 PROCESSES AND PANELS 66

8.2.1 Some processes and panels of our instrument have different names to the ones expected by the startup tool. 66

8.3 xxinsStart (stooStart) 66

8.3.1 We only need to start ICS, however xxinsStart insists in starting also OS and DCS by default (when xxinsStart is called without arguments). Can this be suppressed ? 66

8.3.2 Startup tool does not start the ICS process. What could be wrong? 66

8.3.3 Can we also select what panels to start by default ? 66

8.3.4 Sometimes when a panel is started, the corresponding application is started. Can this be suppressed during development ? Can we suppress sending the STANDBY command to applications when they are started/stopped ? 66

8.3.5 Environment variables are not passed to the started processes! What is going on ? 66

8.3.6 There are three ICSs in my instrument. I overloaded the first one, i.e. stooType(ICS), but it seems that the other ICSs are overloaded as well! What is going on ? 66

8.4 xxinsStop (stooStop) 67

8.4.1 Sometimes panels are not stopped by xxinsStop. 67

8.4.2 Our instrument specific panel is never stopped. 67

8.4.3 Our detector should always stay ONLINE, but it is always stopped by xxinsStop. 67

9 INSTALLATION GUIDE 69

9.1 INSTALLATION OF STOO 69

9.2 INSTALLATION OF THE TEMPLATE INSTRUMENT 69

10 REFERENCE 71

10.1 PANELS 71

10.1.1 stooStartup 71

10.1.2 stooSosStartup 73

10.2 SCRIPTS 75

10.2.1 stooStart 75

10.2.2 stooStop 78

10.3 TCL CLASSES 81

10.3.1 stooAPPLICATION 81

10.3.2 stooBASE 82

10.3.3 stooLOG 84

10.3.4 stooPANEL 85

10.3.5 stooPROCESS 87

Quadralay Corporation http://www.webworks.com Voice: (512) 719-3399 Fax: (512) 719-3606 sales@webworks.com