User and Maintenance Manual

EUROPEAN SOUTHERN OBSERVATORY

Organisation Européenne pour des Recherches Astronomiques dans l'Hémisphère Austral

Europäische Organisation für astronomische Forschung in der südlichen Hemisphäre

VLT PROGRAMME

VERY LARGE TELESCOPE

VLT Software

---

Template Instrument Software

User and Maintenance Manual

Doc. No.: VLT-MAN-ESO-17240-1973

Issue: 4

Date: 31/03/2003

Name Date Signature

Prepared: A.Longinotti 31/03/2003

Name Date Signature

Approved: K.Wirenstrand

Name Date Signature

Released: K.Wirenstrand

VLT PROGRAMME * TELEPHONE: (089) 3 20 06-0 * FAX: (089) 3 20 06 514

CHANGE RECORD

ISSUE	DATE	SECTION/PAGE AFFECTED	REASON/INITIATION DOCUMENTS/REMARKS
1.0	28/11/1999	All	First issue, containing only ICS part
2.0	08/04/2001	All	Second issue, containing the whole instrument, including OS
3	28/03/2002	4.7.2 5.3 10.5 10.10.4	MAR2002, Added ICS stand-alone GUI, SPR VLTSW20010501, VLTSW20010502.
4	31/03/2003	3.2 Appendix B	APR2003

TABLE OF CONTENTS 3

1 INTRODUCTION 7

1.1 Purpose 7

1.2 Scope 7

1.3 Applicable Documents 7

1.4 Reference Documents 8

1.5 Abbreviations and Acronyms 9

1.6 Glossary 9

1.7 Stylistic Conventions 9

1.7.1 Data Flow and Processor Model Diagrams 9

1.8 Naming Conventions 10

1.9 Problem Reporting/Change Request 10

2 OVERVIEW 11

2.1 Hardware architecture 11

2.1.1 Devices 11

2.1.2 Computers 11

2.1.3 LANs 11

2.1.4 Special connections 11

2.2 Software Architecture 13

2.2.1 Software Modules 13

2.2.2 Environments 13

2.2.3 Standards 13

3 INSTALLATION GUIDE 15

3.1 Requirements 15

3.1.1 Hardware 15

3.1.2 Software 15

3.2 Installation procedure 15

3.2.1 Preparation 15

3.2.2 Operational hw configuration (all LCUs available) 16

3.2.3 Development hw configuration (not all LCUs available) 16

4 OPERATOR’S GUIDE 17

4.1 System Start-up 17

4.1.1 Log-in 17

4.1.2 Telescope availability 17

4.1.3 Midas availability 18

4.1.4 Instrument Software Start-up 18

4.1.5 Begin of operations 19

4.1.6 End of operations 19

4.2 System Shut-down 19

4.3 User Station 20

4.4 Observations with Templates 21

4.5 Alarms 21

4.6 Data files location 21

4.7 Engineering 21

4.7.1 OS Engineering GUI 21

4.7.2 ICS Engineering GUI 21

5 PROGRAMMER'S GUIDE 23

5.1 Instrument Modes 23

5.2 Subsystems Identifiers 23

5.3 ICS Software Devices 23

5.3.1 ICS Special devices 24

5.3.2 ICS Assemblies 24

5.4 Exposures 25

5.4.1 Exposure types 25

5.4.2 Exposure Id 25

5.4.3 Exposure Status 25

5.4.4 Exposure Parallelism 25

5.4.5 Exposure Life Cycle 25

5.4.6 Exposure execution 26

5.5 Operational States 26

5.6 Commands 26

5.6.1 OS Special commands 26

5.6.2 ICS Special commands 26

5.6.3 DCS Special commands 26

5.7 Tcl libraries 26

5.8 Dictionaries 26

5.9 Alias files 27

5.10 Configuration files 27

5.11 Setup files and keywords 27

5.11.1 OCS keywords 27

5.11.2 INS keywords 27

5.11.3 DCS keywords 28

5.12 FITS files 28

5.13 Public on-line database attributes 28

5.14 Operational logs 28

5.15 Templates 28

5.15.1 Acquisition Templates 29

5.15.2 Calibration Templates 29

5.15.3 Observation Templates 29

6 CONFIGURATION 30

6.1 Change Instrument Configuration Parameters 30

7 MAINTENANCE 32

7.1 General 32

7.1.1 Instrument Self-Test 32

7.1.2 Module xxins 32

7.1.3 Module dicXXXX 32

7.2 OS 33

7.2.1 Module xxo 33

7.2.2 Module xxopan 33

7.2.3 Module xxotsf 33

7.2.4 Module xxoseq 34

7.3 ICS 35

7.3.1 ICS Self-Test 35

7.3.2 Module xxi 35

7.3.3 Module xxipan 36

7.3.4 Module xxidev 36

7.4 DCS 36

7.4.1 Engineering 36

7.5 MS 37

7.5.1 Maintenance Templates 37

7.5.2 Module xxmcfg 37

7.5.3 Module xxmseq 37

7.5.4 Module xxmtsf 37

8 FAQ AND TROUBLESHOOTING 38

8.1 Problems at System Start-up 38

8.1.1 Log-in fails 38

8.1.2 Start-up of GUIs fails 38

8.1.3 Start-up of control processes fails 38

8.1.4 xxiControl starts with a wrong simulation level 38

8.1.5 TCCD starts with a wrong simulation level and fails to go STANDBY 38

8.1.6 xxoControl tries to access sub-systems declared as not available 38

8.1.7 Going ONLINE fails 38

8.2 Problems when running exposures 39

8.2.1 Cannot send commands to TCS or access tif 39

8.2.2 Templates cannot access Midas 39

9 ERROR DEFINITIONS 40

10 REFERENCE 41

10.1 Programs 41

10.1.1 Command Definition Table for program xxoControl 41

10.2 Scripts 42

10.2.1 xxinsStartup 42

10.2.2 xxinsStart 43

10.2.3 xxinsStop 44

10.2.4 xxinsCreateNewInstrument 45

10.3 Include Files 46

10.4 Tcl libraries 47

10.4.1 xxoseqICS 47

10.5 Configuration files 48

10.5.1 xxmcfgCONFIG.cfg 48

10.5.2 xxmcfgINS.cfg 49

10.5.3 xxmcfgSTART.cfg 50

10.6 Setup files 51

10.6.1 Example of Reference Setup file 51

10.6.2 Example of Instrument Setup File 51

10.7 Templates 52

10.7.1 IR Imaging acquisition template 52

10.7.2 IR Imaging observation template 53

10.7.3 IR Spectroscopy acquisition template 54

10.7.4 IR Spectroscopy observation template 55

10.7.5 Optical Imaging acquisition template 56

10.7.6 Optical Imaging observation template 57

10.7.7 Optical Imaging bias calibration template 58

10.7.8 Optical Imaging flat-field calibration template 59

10.7.9 Optical Imaging detector linearity calibration template 60

10.7.10 Optical Imaging focus calibration template 61

10.8 FITS files 62

10.8.1 Example of FITS header 62

10.9 Log files 63

10.9.1 Example of Operational Log (FITS format) 63

10.10 Panels 64

10.10.1 OS Control 64

10.10.2 OS Status 65

10.10.3 OS Engineering 66

10.10.4 ICS stand-alone 67

10.11 Error files 68

10.11.1 xxoErrors.h 68

10.11.2 xxo_ERRORS 69

Appendix A. Create a new Instrument 70

.1 OS sub-classing and method overloading 70

.2 Add special commands to OS 70

.3 Add special handling of set-up keywords in OS 70

.4 Implement a class library for templates 70

.5 Implement an ICS special device on LCU 70

.6 Implement an ICS special device on WS 70

.7 ICS WS sub-classing and method overloading 71

.8 ICS WS Assemblies 71

Appendix B. Installation using different environments 72

1 INTRODUCTION

The software described in this manual is intended to be used in the ESO VLT project by ESO and authorized external contractors only.

While every precaution has been taken in the development of the software and in the preparation of this documentation, ESO assumes no responsibility for errors or omissions, or for damage resulting from the use of the software or of the information contained herein.

1.1 Purpose

The Template Instrument (called XXXX) is a fictitious instrument, which incorporates the basic functionality of VLT instruments.

It is supposed to help Instrumentation Software developers, by providing them with examples of code and related files. It is also used internally at ESO to validate, through a complete instrument, the Instrumentation Common Software packages before a new VLT sw release is issued.

This document is the User Manual of the Template Instrument Control Software.

This package is fully based on VLT Instrumentation Common Software packages, such as icb (base ICS, see [RD 16] and [RD 26]), boss (base OS, see [RD 17]), tpl (library for templates, see [RD 24]).pkgin (installation tool, see [RD 18]), ctoo (configuration tool, see [RD 25]) and stoo (startup tool, see [RD 19]).

This document can also be used as template for the User and Maintenance Manual of another instrument.

1.2 Scope

This document covers only the control part of the Template Instrument Software. It does not deal with other parts of the Data Flow, such as the pipeline.

It is aimed at operators of the instrument and software developers, who are responsible for its installation and maintenance.

This document is also aimed at software developers, who need to develop Instrumentation Software for VLT instruments or in general instrumentation according to VLT standards.

It is also meant for ESO engineers, responsible for the integration of new VLT Software releases, to validate the VLT Instrumentation Common Software packages.

1.3 Applicable Documents

The following documents, of the exact issue shown, form a part of this document to the extent specified herein. In the event of conflict between the documents referenced herein and the contents of this document, the contents of this document shall be considered as a superseding requirement.

Reference	Document Number	Issue	Date	Title
[AD 01]	GEN-SPE-ESO-19400-0794	1.1	25/11/1997	DICB - Data Interface Control Document
[AD 02]	VLT-SPE-ESO-10000-0011	2.0	30/09/1992	VLT Software Requirements Specification
[AD 03]	VLT-PRO-ESO-10000-0228	1.0	10/03/1993	VLT Software Programming Standards
[AD 04]	VLT-PLA-ESO-10000-0441	1.0	01/05/1995	VLT Science Operation Plan
[AD 05]	VLT-MAN-ESO-17210-0667	1.0	03/12/1997	Guidelines for VLT applications.
[AD 06]	VLT-SPE-ESO-17212-0001	2.0	23/02/1995	INS Software Specification
[AD 07]	VLT-SPE-ESO-17240-0385	2.1	15/07/1996	INS Common Software Specification
[AD 08]	VLT-ICD-ESO-17240-19400	2.6	17/11/1997	ICD between VCS and Archive
[AD 09]	VLT-ICD-ESO-17240-19200	1.3	07/06/2000	ICD between VCS and OH

1.4 Reference Documents

The following documents are referenced in this document.

Reference	Document Number	Issue	Date	Title
[RD 01]	VLT-MAN-ESO-17200-0888	1.0	17/08/1995	VLT Common Software Overview
[RD 02]	VLT-MAN-ESO-17200-0642	2	30/03/2002	VLT Common Software Installation Manual
[RD 03]	VLT-SPE-ESO-17120-1355	1.2	12/01/1999	Final Lay-out of VLT Control LANs
[RD 04]	VLT-MAN-SBI-17210-0001	3.6	01/03/2001	LCU Common Software User Manual
[RD 05]	VLT-MAN-ESO-17210-0600	1.7	02/10/1998	Motor Control sw User Manual API/ACI
[RD 06]	VLT-MAN-ESO-17210-0669	1.4	20/10/1997	Motor Engineering Interface User Manual
[RD 07]	VLT-MAN-ESO-17210-0619	2.2	31/03/2002	Central Control Software User Manual
[RD 08]	VLT-MAN-ESO-17210-0707	1.6	30/09/1999	On Line Database Loader User Manual
[RD 09]	VLT-MAN-ESO-17210-0771	1.8	06/10/2001	EVH User Manual
[RD 10]	VLT-MAN-ESO-17210-0770	1.8	30/09/2001	Extended CCS User Manual
[RD 11]	VLT-MAN-ESO-17210-0690	4.3	31/03/2002	Panel Editor User Manual
[RD 12]	VLT-MAN-ESO-17240-0853	1.4	25/04/2001	INS Common sw - oslx User Manual
[RD 13]	VLT-MAN-ESO-17240-0672	1.6	25/09/1998	CCD Detectors Control Software User Manual
[RD 14]	VLT-MAN-ESO-13640-1388	1.2	22/11/1999	FIERA Control Software User Manual
[RD 15]	VLT-MAN-ESO-14100-1878	1.1	19/10/1999	IRACE-DCS User Manual
[RD 16]	VLT-MAN-ESO-17240-0934	3	30/03/2002	Base ICS User Manual
[RD 17]	VLT-MAN-ESO-17240-2265	1.1	25/04/2001	Base OS Stub User Manual
[RD 18]	VLT-MAN-ESO-17240-1913	2	30/03/2002	Installation Tool for VLT Sw packages
[RD 19]	VLT-MAN-ESO-17240-2153	2	30/03/2002	INS Startup Tool User Manual
[RD 20]	VLT-MAN-ESO-17220-0737	3	28/03/2002	HOS - Sequencer User Manual
[RD 21]	P.Ward, S.Mellor, Yourdon Press,		1985	Structured Development for Real-Time Systems
[RD 22]	J. Rumbaugh et. al., Prentice Hall,		1991	Object-Oriented Modeling and Design
[RD 23]	VLT-MAN-ESO-17220-1999	2	27/03/2002	Broker for Observation Blocks User Manual
[RD 24]	VLT-MAN-ESO-17240-2240	2	28/03/2002	INS Common Software for Templates
[RD 25]	VLT-MAN-ESO-17240-2325	2	30/03/2002	INS Configuration tool User Manual
[RD 26]	VLT-MAN-ESO-17240-2606	3	30/03/2002	Base ICS GUI User Manual

1.5 Abbreviations and Acronyms

This document employs several abbreviations and acronyms to refer concisely to an item, after it has been introduced. The following list is aimed to help the reader in recalling the extended meaning of each short expression:

CCS	Central Control Software
CPU	Central Processing Unit
DCS	Detector Control Software
ESO	European Southern Observatory
FITS	Flexible Image Transport Format
GUI	Graphical User Interface
HW	Hardware
ICS	Instrument Control Software
INS	Instrumentation Software Package
I/O	Input/output
ISAAC	Infrared Spectrograph and Array Camera
IWS	Instrument Workstation
LAN	Local Area Network
LCC	LCU Common Software
LCU	Local Control Unit
MS	Maintenance Software
N/A	Not Applicable
OMT	Object Modeling Technique
OO	Object Oriented
OOD	Object Oriented Design
OS	Observation Software
RAM	Random Access Memory
SW	Software
TBC	To Be Clarified
TBD	To Be Defined
TCS	Telescope Control Software
TIM	Time Interface Module
TRS	Time Reference System
UIF	(Portable) User Interface (Toolkit)
UVES	UltraViolet Visual Echelle Spectrograph
VLT	Very Large Telescope
VME	Versa Module Eurocard
WS	Workstation

1.6 Glossary

No special definition is introduced in this manual

1.7 Stylistic Conventions

The following styles are used:

bold

in the text, for commands, filenames, pre/suffixes as they have to be typed.

italic

in the text, for parts that have to be substituted with the real content before typing.

teletype

for examples.

<name>

in the examples, for parts that have to be substituted with the real content before typing.

bold and italic are also used to highlight words.

1.7.1 Data Flow and Processor Model Diagrams

Data Flow and processor Model Diagrams are based on De Marco/Yourdon notation for real-time systems [RD 21].

1.8 Naming Conventions

This implementation follows the naming conventions as outlined in [AD 03].

1.9 Problem Reporting/Change Request

The form described in [RD 02] shall be used.

2 OVERVIEW

This chapter gives a short overview of the instrument and its architecture.

The rest of the manual is organized as follows:

· Chapter 3 is the installation guide.

· Chapter 4 is the operator’s guide, which describes how to operate the instrument at various levels.

· Chapter 5 is the programmer’s guide, which describes in detail specific items, such as ICS devices and commands.

· Chapter 6 is the configuration guide, which describes in detail the configuration of the instrument.

· Chapter 7 contains the Maintenance Guide

· Chapter 8 contains a FAQ and troubleshooting tips specific to the instrument

· Chapter 9 contains the list of errors defined by the instrument application

· Chapter 10 contains the manual pages extracted from the source code.

· Appendix A describes how to create from scratch a new instrument starting from the Template Instrument code

2.1 Hardware architecture

2.1.1 Devices

The Instrument consists of:

· 24 devices, controlled by ICS, on 2 LCUs:

q 14 motorized

q 1 calibration lamp

q 1 shutter

q 7 sensors

q 1 special device

· 2 scientific detectors

q 1 infrared (IRACE controller)

q 1 optical (FIERA controller)

· 1 technical CCD camera (ACE controller)

2.1.2 Computers

The computers on which the Instrument Software runs are shown in Figure 1:

· Instrument Workstation (wxxxx) with ATM board

· ICS LCU 1 (lxxics1) with TIM board

· ICS LCU 2 (lxxics2) with TIM board

· TCCD LCU (lxxtccd) with TIM board

· IRACE UltraSparc (wxxirac) with ATM board

· FIERA UltraSparc (wxxfier) with ATM board

Note: the ATM board belongs to the standard configuration of Instrumentation Workstation and detectors UltraSparc. They are however not needed to run the Template Instrument Software and are mentioned here just to remind that for real instruments they should be present. The same consideration applies to the LCU TIM boards, whereby also in the case of real instruments the presence of the TIM board is mandatory only if the time precision needed on that LCU requires it.

2.1.3 LANs

The Instrument LAN follows the lay-out of VLT Control LANs (see [RD 03]) and is shown in Figure 1

2.1.4 Special connections

The Template Instrument architecture does not foresee any special connection.

Figure 1 Hardware architecture

2.2 Software Architecture

The architecture of the Control Software follows the VLT standard operational scheme and is shown in Figure 2

Observation Blocks, created with the P2PP toolkit, are sent to the Broker for Observation Blocks (BOB), which executes sequentially the templates defined in them.

In turn, each template consists normally of a sequence of commands sent to the OS Server. This process is responsible to interpret the commands received and convert them into commands for the controlled sub-systems (ICS, DCSs and TCS), taking care of the corresponding replies.

At the end of an exposure, the OS Server process is also responsible for merging all data/information into one FITS file and archive it, through the dedicated processes VOLAC/VCSOLAC/OLAS.

2.2.1 Software Modules

The XXXX Instrument Software consists of the following modules (the prefix id xx corresponds to the Instrument ID):

cmm Module	INS Module	Platform	Description
xxins	N/A	WS	integration module
dicXXXX	N/A	WS	FITS dictionaries
xxi	ICS	WS	ICS WS front-end and LCU simulator
xxipan	ICS	WS	ICS stand-alone GUI
xxidev	ICS	LCU	ICS special devices.
xxo	OS	WS	OS Server
xxopan	OS	WS	OS GUI
xxoseq	OS	WS	Observation Template scripts
xxotsf	OS	WS	Observation Template Signature Files
xxmcfg	MS	WS	Instrument Configuration Files
xxmseq	MS	WS	Maintenance Template scripts
xxmtsf	MS	WS	Maintenance Template Signature Files

2.2.2 Environments

The Instrument uses the following CCS environments:

· wxxxx. IWS CCS environment (see RTAPENV)

· lxxics1. ICS LCU1 LCC environment.

· lxxics2. ICS LCU2 LCC environment.

· lxxtccd. TCCD DCS LCC environment.

· wxxfier. FIERA DCS CCS environment

· wxxtcs. TCS simulation CCS environment (see TCS_ENVNAME)

2.2.3 Standards

The Instrument Software is based on the standard packages distributed with VLT Software releases. In particular:

· TCCD DCS is based on the CCD Software (see [RD 13]).

· IR DCS is based on the IRACE Software (see [RD 15]).

· FIERA is based on the FIERA Software (see [RD 14]).

· ICS is based on the icb package (see [RD 16] and [RD 26]).

· OS is based on the BOSS package (see [RD 17])

· Templates are based on the tpl package (see [RD 24]).

· The Instrument Software installation is based on the pkgin package ([RD 18])

· The Instrument Configuration is based on the ctoo package (see [RD 25])

· The Instrument Software Start-up/Shutdown is based on the stoo package (see [RD 19]).

Figure 2 Template Instrument Architecture

3 INSTALLATION GUIDE

The installation uses the VLT standard tool pkgin (see [RD 18]).

3.1 Requirements

3.1.1 Hardware

The following computers must be available (see section 2.1.2):

· One Instrument Workstation (HP, model supported by the VLT sw, see [RD 02]).

Furthermore, a more complete functionality is achieved if also the following computers (some or all of them) are available:

· Two LCUs for ICS

· One LCU for the TCCD

· One Sparc LCU for IRACE

· One Sparc LCU for FIERA

3.1.2 Software

· The version of the UNIX Operating System installed on the IWS must be compatible with the VLT sw installation (see [RD 02])

· The VLT sw MAR2001 or higher must be installed, according to [RD 02].

XXXX runs both on fullCCS or CCSLite.

3.2 Installation procedure

Normally an Instrument Software User Manual should describe only the installation procedure needed in the operational configuration, i.e. when all computers used by that instrument are available (see3.2.2). However, due to the nature of XXXX (example for all instrument developers, working at different places under different hw configurations), we include also a section (3.2.3) describing the procedure to be followed depending on the computers availability.

This section describes the installation procedure used up to the Commissioning Phase. Once the instrument is at Paranal and enters into operations, the Installation procedure will slightly change. In fact, in order to minimize downtime on target Workstations, the first part of the Installation procedure at Paranal (up to step BUILD_ENV of pkginBuild) is executed on a dedicated off-line Workstation. The results are copied to the target IWS, where the remaining steps (from START_WSENV) are then executed.

The whole installation procedure must be executed as user xxxxmgr (in development environments this is not mandatory) and will take at least 30 minutes.

During the installation, it is recommended to have a logMonitor window active, in order to see possible error logs.

At the end of the installation, check for error logs in file $HOME/XXXXSource/INSTALL/pkginBuild.err.

3.2.1 Preparation

1.) Run the utility vccEnv and verify that the following CCS environments are known and correctly configured in the ACC database:

wxxxx for the instrument

wxxtcs for the simulated TCS

The same should be done for the environments associated to available LCUs, if any:

lxxics1 for ICS LCU 1

lxxics2 for ICS LCU 2

lxxtccd for TCCD DCS LCU

wxxfier for the FIERA SLCU

2.) Verify that the environment variables INTROOT and INS_ROOT are defined.

% echo $INTROOT

% echo $INS_ROOT

3.) Verify that the file $HOME/.bobrc exists and is a symbolic link to $INTROOT/config/xxins.bobrc. If not, run:

% ln –s $INTROOT/config/xxins.bobrc $HOME/.bobrc

4.) Retrieve version number to be used:

% cd <TAPE_ROOT_DIRECTORY>

% export XXXX_VERSION=`grep "@(#)" examples/insapp/XXXX/xxins/ChangeLog | awk '{print $4}'`

% echo $XXXX_VERSION

5.) Create an empty directory as root for the source code, e.g.:

% mkdir $HOME/XXXXSource

During the installation the following directories are created:

xxins Installation support module (for pkginBuild).

INSTALL It contains logs and error logs of the installation.

ICS It contains all ICS modules (see 2.2.1)

OS It contains all OS modules (see 2.2.1)

MS It contains all MS modules (see 2.2.1), in particular xxmcfg, with the whole set of configuration files.

VLTSW_new It contains an upgraded version of modules, if any, belonging to VLT sw releases. If all modules as from VLTROOT are taken, this directory is missing.

3.2.2 Operational hw configuration (all LCUs available)

% cd $HOME/XXXXSource

% cmmCopy xxins $XXXX_VERSION

% pkginBuild xxins

3.2.3 Development hw configuration (not all LCUs available)

The first step involves only WS environments and must be executed independently from the LCUs availability:

% cd $HOME/XXXXSource

% cmmCopy xxins $XXXX_VERSION

% pkginBuild xxins –env wxxxx wxxtcs

At the end of this step, if no error has been found, the WS environments must be active.

If not all LCUs are available, periodic errors are logged, because the logManager tries periodically to access all LCUs. In order to avoid this, edit the file $VLTDATA/ENVIRONMENTS/wxxxx/logLCU.config and remove the lines corresponding to not available LCUs.

The next steps are needed only if LCUs are available.

· TCCD LCU is available.

Run:

% pkginBuild xxins –env lxxtccd –fromstep BUILD_ENV

· Two ICS LCUs are available.

Run:

% pkginBuild xxins –env lxxics1 lxxics2 –fromstep BUILD_ENV

· Only one ICS LCU is available.

As a matter of fact, XXXX ICS is configured for two LCUs:

1. LCU 1 controls all motorized devices

2. LCU 2 controls all the other devices (lamps/shutters/sensors)

Assuming you are interested in motorized devices, you should declare LCU 1 available and LCU 2 not available (otherwise do the opposite):

q Edit file $INS_ROOT/SYSTEM/COMMON/CONFIGFILES/xxmcfgINS.cfg and uncomment:

##INS.CON.LCUAV2 F

q Run:

% cd $HOME/XXXXSource

% pkginBuild xxins –env lxxics1 –fromstep BUILD_ENV

4 OPERATOR’S GUIDE

This chapter is intended to give instrument operators all information they need to work with the Instrument Software through its Graphical User Interface.

Note: For Instruments operational at Paranal, after proper log-in on the User Station, the CDE (or VUE) menu is customized to the specific Instrument to be operated, such that dedicated options to start-up/shutdown control processes or individual panels are provided. An example of such functionality is not available for the Template Instrument yet.

4.1 System Start-up

In the following it is assumed that the installation (see chapter 3) has been successfully completed and environments are active.

4.1.1 Log-in

In order to operate the instrument properly, the user has to log-in on all terminals in the User Station as user xxxx (not mandatory in a development environment).

Unless otherwise specified, all UNIX shell commands, described in the next sections, have to be typed on a xterm window running on the Instrument Workstation.

After log-in, check that the environment variables needed to run properly the Instrument software are defined. To list the environment variables that should be defined type:

% osbEnvSet XXXX

The setting of these variables is done within the file $INTROOT/config/xxins-misc-all.env (or xxins.cshrc if vue is used). This file is automatically sourced whenever you login or any new xterm is opened. Make sure that this is the case.

4.1.2 Telescope availability

If TCS is supposed to be used, make sure that it is running and ONLINE, before starting the Instrumentation Software:

q If the real telescope is going to be used, check with the telescope operator.

q In a development environment, where no real telescope is available, the TCS simulation package is used. Run:

% xxinsStart –panel OS_ENGINEERING

Figure 3 OS Engineering panel

The OS engineering panel (see Figure 3) pops-up.

· If the state of TCS Simulator is not ONLINE, press the button STARTUP: after a while the state should change to ONLINE (if not, check, e.g. with scanei, that the scan system between wxxxx and wxxtcs works properly).

· Start the TCS Sim. GUI

· From the TCS Simulation GUI, start the TCS Control and TCS User Panel

· In the TCS User Panel, press Preset Name zenith and wait till the dark gray background color of the RA and DEC fields in the TCS Control Panel disappears.

· Close TCS Simulation GUI, TCS Control and TCS User Panel.

· Simulate TCS auto-guiding running, by selecting in the OS engineering panel the menu item

Simulation à TCS à Auto-guider à Stop and then Start

· Simulate TCS active optics running, by selecting in the OS engineering panel the menu item

Simulation à TCS à Active Optics à Stop and then Start

· Close the OS engineering panel (File à quit).

4.1.3 Midas availability

Normally the Instrumentation Software does not need any data reduction package installed and running on the Instrument Workstation. The only exception is when such a package is needed to perform on-line data reduction operations, whose results are then used by the Instrumentation Software. Even in this case, normally no control process accesses the on-line data reduction package, because this should be done at templates level.

Some XXXX templates need a data reduction package and Midas is used for this purpose.

Midas FEB2001 must therefore be installed. If this is not possible, for whatever reason, then templates can still be executed (e.g. for test purposes) by setting the environment variable DEBUG_MIDAS (access to Midas from templates is disabled):

%export DEBUG_MIDAS=1 (or setenv DEBUG_MIDAS 1 if vue is used)

4.1.4 Instrument Software Start-up

The system start-up is based on the common startup tool stoo (see [RD 19]).

There are two ways to start-up the Instrument Software:

1.) Through dedicated GUI. Recommended after a new installation or whenever some start-up configuration parameter needs to be changed. Type on a xterm window:

% xxinsStartup

The Start-up GUI (Figure 4) pops-up. This panel allows defining which sub-systems are available and at which level of simulation they should start, in particular if they have to access the LCUs or they should simulate the LCU functionality at WS level. It also allows specifying which GUIs will be automatically started.

Figure 4 Startup panel

Finally, by pressing the button Start, all specified GUIs and sub-systems control processes are started. A log window shows the various phases of the startup procedure.

When successfully completed, the log window disappears and all sub-systems should be in state STANDBY.

If any error occurs, the log window remains active and shows the reason of the failure.

2.) Directly from the UNIX shell. Type on a xterm window:

% xxinsStart

This command has the same effect of pressing the Start button in the start-up GUI.

4.1.5 Begin of operations

Before being able to operate the instrument and take exposures, it has to be ONLINE.

On the OS Control panel (see Figure 5), check the global State. If it is not ONLINE, select the menu option

Instrument à ONLINE.

Please wait till the global State turns to ONLINE.

Figure 5 OS Control panel

4.1.6 End of operations

After operating the instrument, whenever it is foreseen to leave it idle for long time (e.g. during daytime), the instrument has to be brought to a safe state, also called STANDBY.

On the OS Control panel (see Figure 5), select the menu option

Instrument à STANDBY.

Please wait till the global State turns to STANDBY.

4.2 System Shut-down

There are two ways to shutdown the Instrument Software:

1. From the OS Control GUI select the menu item Instrument à SHUTDOWN.

Only the control processes are terminated. Panels remain up.

2. Type on a xterm window:

% xxinsStop

All control processes and panels are terminated.

4.3 User Station

The GUIs distribution on the User Station screens is shown in Figure 6 and Figure 7.

Figure 6 User Station screen #1

Figure 7 User Station screen #2

4.4 Observations with Templates

This is the usual way to do observations at the VLT.

In this section we illustrate a simple example of observing run. We run the Observation Block (OB) defined in the file XXXX_gen_tec_SelfTest.obd. This OB executes sequentially all templates defined for XXXX. It is supposed to be used as self-test procedure to verify that the instrument is working properly (see also [RD 24]).

Normally Observation Blocks (OBs) exercise all instrument sub-systems, as well as the telescope (if declared available).

It is therefore VERY IMPORTANT to verify the status of instrument and telescope before starting this OB, to avoid damages.

OBs are prepared through the P2PP tool on a separate Workstation (wxxdhs).

In order to run them:

1.) Select the OB to be executed in the P2PP GUI

2.) Load this OB in the BOB GUI (File à Load Obs à 1).

3.) Press the Start button.

4.) Wait till the OB has been completely executed.

If necessary, during the execution of the OB, one can abort it (button Abort in BOB).

The running exposure can be aborted by pressing the Abort button in the OS Control panel.

See sections 5.15 and 7.2.3 for a more detailed description of the available templates.

4.5 Alarms

No alarms are at present defined for the instrument.

Description	Severity	Operator’s Action

4.6 Data files location

All data files used and/or generated by the Instrument Software are located under $INS_ROOT as follows:

· Configuration files:

$INS_ROOT/SYSTEM/COMMON/CONFIGFILES

· Image FITS files, results of exposures:

$INS_ROOT/SYSTEM/DETDATA

· Setup files:

$INS_ROOT/SYSTEM/COMMON/SETUPFILES/<type>

<type> is one of the following: REF, INS, DET, TARG

· Template Signature File:

$INS_ROOT/SYSTEM/COMMON/TEMPLATES/TSF

· Observation Block Description files:

$INS_ROOT/SYSTEM/COMMON/TEMPLATES/OBD

4.7 Engineering

4.7.1 OS Engineering GUI

The OS Engineering GUI (see Figure 3) allows to startup/shutdown, change state and startup the stand-alone GUI of single sub-systems, e.g. whenever there are problems with one specific sub-systems. To start it up:

%xxinsStart –panel OS_ENGINEERING

4.7.2 ICS Engineering GUI

While the detectors and the telescope stand-alone GUIs are provided by the associated standard software packages, the ICS GUI is necessarily specific to the instrument (see Figure 8). It is based on icbpan (see [RD 26]). To start it up:

%xxinsStart –panel ICS

Figure 8 ICS Engineering GUI

5 PROGRAMMER'S GUIDE

This part of the document provides a description of the programmatic interface of the Instrument Software.

For people having no experience with Instrumentation software yet, it is recommended, although not necessary, before starting to read this section, first to have a look at the interactive usage of the instrument at chapter 4 and possibly try it out. It can help to get a better idea of how Instrumentation software works.

5.1 Instrument Modes

XXXX defines the following modes:

· IR_IMAGING. Its purpose is to take images in the infrared.

Subsystems involved are IRACE, ICS and TCS.

· GUIDING. Its purpose is to perform guiding operations.

Subsystems involved are TCCD, ICS and TCS.

· IR_SPECTROSCOPY. Its purpose is to take spectra in the infrared.

Subsystems involved are IRACE, TCCD, ICS and TCS.

In this mode two independent exposure, one for each detector (IR and TCCD), can be executed in a semi-parallel way, i.e. the exposures on the two detectors are started at different points in time, however there is a time interval, during which both exposures are running. For more information see [RD 17].

· OPT_IMAGING. Its purpose is to take images in the optical range.

Subsystems involved are FIERA, ICS and TCS.

5.2 Subsystems Identifiers

OS must be able to associate one or more sub-systems to each short-FITS keyword associated to a SETUP command. The filtering criteria are defined in the configuration file $INS_ROOT/SYSTEM/COMMON/CONFIGFILES/xxmcfgINS.cfg

(see also 10.5.2).

The table below provides a summary.

Subsystem	FITS Prefix
OS	OCS
ICS	INS
IRDCS	DET1
TCCD	DET2
FIERA	DET3
TCS	TEL

5.3 ICS Software Devices

The ICS Software devices are defined in the configuration file $INS_ROOT/SYSTEM/COMMON/CONFIGFILES/xxmcfgINS.cfg (see also 10.5.2):

#	Name	Description	Positions	Motor Axis	FITS Prefix	ICB Class	LCU
1	lamp	Sample lamp	ON/OFF	N/A	INS.LAMP1	icbLAMP	2
2	tsh	Sample shutter	OPEN/CLOSED	N/A	INS.SHUT1	icbSHUTTER	2
3	adc	Sample ADC device	continuous	circular	INS.ADC1	icbMOT_ADC	1
4	dpor	Sample depolarizer	continuous	circular	INS.DPOR	icbMOT_DPOR	1
5	drot	Sample derotator	continuous	circular	INS.DROT	icbMOT_DROT	1
6	filt	Sample filter wheel	discrete	circular	INS.FILT1	icbMOT_FILTER	1
7	grat	Sample grating wheel	continuous	circular	INS.GRAT1	icbMOT_GRATING2	1
8	mirr	Sample mirror wheel /slide	discrete	circ./lin.	INS.MIRR1	icbMOT_MIRROR	1
9	iods	Sample slide	discrete	linear	INS.OPTI1	icbMOT_OPTI	1
10	gris	Sample wheel	discrete	circular	INS.GRIS1	icbMOT_OPTI	1
11	focu	Sample slide	continuous	linear	INS.FOCU1	icbMOT_POS	1
12	rot	Sample wheel	continuous	circular	INS.ROT1	icbMOT_POS	1
13	dekk	Sample dekker (two jaws)	continuous	excentric	INS.SLIT1.LEN	icbMOT_SLIT2_LEN	1
14	slit	Sample slit (two jaws)	continuous	excentric	INS.SLIT1.WID	icbMOT_SLIT2_WID	1
15	slits	Sample slit wheel/slide	discrete	circ./lin.	INS.SLIT2	icbMOT_SLITS	1
16	tilt	Sample tilt device	continuous	excentric	INS.TILT1	icbMOT_TILT	1
17	fcs	Cryostat sensor	N/A	N/A	INS.SENSOR1	icbSEN_ADAM	2
18	baro	Pressure sensor	N/A	N/A	INS.SENSOR2	icbSEN_BAROMETER	2
19	fctc	Cryostat temp. sensor	N/A	N/A	INS.SENSOR3	icbSEN_CN77000	2
20	ccc1	Cooling control sensor	N/A	N/A	INS.SENSOR4	icbSEN_COOLING	2
21	dis1	Digital sensors	N/A	N/A	INS.SENSOR5	icbSEN_DIGITAL	2
22	ench	Humidity sensor	N/A	N/A	INS.SENSOR6	icbSEN_HUMIDITY	2
23	temp	Temperature sensor	N/A	N/A	INS.SENSOR7	icbSEN_ESTERS	2
24	yyyy	Sample special device	N/A	N/A	INS.MIRR2	Special device	2

Some remarks:

· All motorized devices use ESO standard motion control (Maccon) and amplifier boards.

· All motors with continuous positioning do so with a two step absolute motion to overcome possible backlash problems (see [RD 16]).

· Devices focu and rot use a linear formula for user units versus encoder units conversion.

· Devices dekk and slit have two motors each

· Device dpor rotates continuously when asked to move.

· Device adc1 uses ADC tracking mode (see [RD 16]).

· Device drot uses various tracking modes (see [RD 16]).

· Device fcs is connected to the hw device ADAM 4017 (RS-485)

· Device baro is connected to the hw device VAISALA PTB220B (RS-485)

· Device fctc is connected to the hw device OMEGA CN77000 (RS-485)

· Device ccc1 is connected to the ESO standard cabinet cooling hw device (RS-232)

· Device dis1 is connected to the ESO standard Acromag digital I/O board

· Device temp is connected to the ESO standard temperature acquisition unit Esters DC24 (RS-232).

5.3.1 ICS Special devices

The only special device is yyyy. It is a simple sample software device that has two double attributes in its OLDB point. These two double attributes can be set with the SETUP command (with FITS keywords INS.MIRR2.DATA1 and INS.MIRR2.DATA2). These values can be retrieved with the STATUS command.

5.3.2 ICS Assemblies

The ICS assemblies are defined in the configuration file $INS_ROOT/SYSTEM/COMMON/CONFIGFILES/xxmcfgINS.cfg (see also 10.5.2):

#	Name	Description	Commands	Values
1	INS.PRESLIT	All pre-slit devices	STATUS	N/A
2	INS.INFRARED	All devices used in the infrared arm	STATUS	N/A
3	INS.OPTICAL	All devices used in the optical arm	STATUS	N/A
4	INS.MODE	Instrument mode	SETUP STATUS	See 5.1
5	INS.PATH	Light path	EXPSTRT EXPEND STATUS	INFRARED OPT_TCCD OPT_SCCD <blank>

5.4 Exposures

5.4.1 Exposure types

The Exposure types accepted are those defined by the standard IRACE, FIERA and TCCD Software packages (see respective manuals).

5.4.2 Exposure Id

The OS exposure Id is a positive integer value uniquely identifying an exposure from the OS point of view.

The first SETUP command must be issued with the –expoId 0 parameter, and the Exposure Id returned by the successful completion of this command must be used for every other SETUP command, as well any other command (START, END, PAUSE, CONTINUE, ABORT, WAIT, STATUS) referring to the same exposure.

5.4.3 Exposure Status

OS keeps track of the global exposure status, taking into account the current status of each detector and possible parallel exposures. It is stored in the OLDB attribute <alias>xxo:exposure.expStatus and its values are those specified by the BOSS package (see [RD 17]).

5.4.4 Exposure Parallelism

In mode IR_SPECTROSCOPY, where two detectors are involved (IRDCS and TCCD), the instrument has the same level of exposures parallelism supported by BOSS (see [RD 17]).

5.4.5 Exposure Life Cycle

1. An exposure is initially defined with a SETUP command with

· -expoId 0

· INS.MODE keyword present (as part of the –function parameter or within a setup file specified with the –file parameter)

2. A new Exposure Id is generated and returned in the reply. Every Additional SETUP command shall contain this Id.

3. A command START –expoId <exposure Id> will initiate the Exposure, that will go through the following phases:

a) Exposure preparation:

· OS requests TCS, through tif library call, to provide FITS information at start of the exposure

· OS sends the command START to the DCS(s) involved in the exposure

· OS sends the EXPSTRT command to ICS

Note: the default behavior of BOSS is to send first EXPSTRT to ICS and then START to DCS(s). The reversed order in XXXX has the sole purpose to provide an example of BOSS method overloading (see Appendix A.1)

b) Exposure execution. It consists of:

q DCS Integration

q DCS Read-out

q DCS Data transfer to IWS

c) Exposure termination:

· DCS writes all image data in the FITS file, as well as some header information

· OS requests TCS, through tif library call, to provide FITS information at end of the exposure

· OS sends the EXPEND command to ICS

· OS sends the STATUS –header –dumpFits command to ICS

· OS merges the partial header files produced by OS itself, TCS, ICS and DCS in the FITS image file

· OS informs Archive (volac) that a new data file is available for archiving.

5.4.6 Exposure execution

The following is an example of sequence of commands needed to define and execute exposures:

SETUP –expoId 0 –file mySetup.ref–function INS.MODE OPT_IMAGING DET3.WIN1.UIT1 5.0

14 ß returned exposure Id

START –expoId 14

WAIT –expoId 14

5.5 Operational States

The instrument global state is the lowest state of its sub-systems and is recorded in the OLDB attribute <alias>xxo:status.state

The table below gives the list of available states and the commands (uppercase) and/or scripts (italics) needed to change the current state.

To From	OFF	LOADED	STAND-BY	ON-LINE
OFF	---	xxinsStart	xxinsStart	---
LOADED	xxinsStop	---	STANDBY	ONLINE
STAND-BY	xxinsStop	---	---	ONLINE
ON-LINE	xxinsStop	---	STANDBY	---

5.6 Commands

According to the standard VLT Instrumentation Software architecture, all commands to the instrument must be sent to the OS Server process xxoControl. The commands available are listed in the Command Definition Table file $INTROOT/CDT/xxoControl.cdt

5.6.1 OS Special commands

In addition to the standard commands defined by BOSS, OS implements the special command TESTCMD (not in the present release).

The sole purpose of TESTCMD is to show an example how to add a command to an OS based on BOSS. See also Appendix A.2.

5.6.2 ICS Special commands

None

5.6.3 DCS Special commands

None

5.7 Tcl libraries

The tcl class library for templates xxoseq uses the base classes provided by the standard VLT library for templates tpl (see [RD 24]). See also Appendix A.4.

This library is registered in the BOB configuration file ($INTROOT/config/xxins.bobrc)

5.8 Dictionaries

The Instrument Software uses several dictionaries to handle setup keywords and to create FITS files with proper header:

· ESO-VLT-DIC.CCDDCS for the keywords belonging to the TCCD sub-system

· ESO-VLT-DIC.FCDDCS for the keywords belonging to the FIERA sub-system

· ESO-VLT-DIC.IRACE for the keywords belonging to the IRDCS sub-system

· ESO-VLT-DIC.TCS for the keywords belonging to the TCS sub-system

· ESO-VLT-DIC.XXXX_ICS for the keywords belonging to the ICS sub-system

· ESO-VLT-DIC.OSB for the standard keywords belonging to the OS sub-system

· ESO-VLT-DIC.XXXX_OS for the special keywords belonging to the XXXX OS sub-system

· ESO-VLT-DIC.DPR for the keywords belonging to templates

· ESO-VLT-DIC.TPL for the keywords belonging to templates

· ESO-VLT-DIC.OBS for the keywords belonging to templates

The following dictionaries are instead not used at runtime, but for installation and/or startup purposes:

· ESO-VLT-DIC.ICB_CFG for the standard keywords belonging to the ICS configuration

· ESO-VLT-DIC.XXXX_CFG for the special keywords belonging to the instrument specific configuration

· ESO-VLT-DIC.STOO_CFG for the keywords used by the startup tool stoo

All instrument specific dictionaries are contained in module dicXXXX.

After installation, the dictionaries can be found in one of the following directories

$INS_ROOT/SYSTEM/Dictionary

$INTROOT/config

$VLTROOT/config

5.9 Alias files

No alias file is used.

5.10 Configuration files

After installation, all configuration files used by the Instrument Software are located in the directory $INS_ROOT/SYSTEM/COMMON/CONFIGFILES.

See chapter 6 and 10.5 for more detailed information on the contents of the individual files.

5.11 Setup files and keywords

5.11.1 OCS keywords

OS treats these keywords. The instrument does not implement any special OCS keyword: it uses only standard keywords defined by the BOSS package (see [RD 17]) and described in the dictionary ESO-VLT-DIC.OSB.

5.11.2 INS keywords

OS and ICS treat these keywords.

The table below shows the keywords used:

Setup keyword	Device	Units	Description	Values
INS.MODE	(assembly)	N/A	Instrument mode	See 5.1
INS.LAMP1.ST	lamp	N/A	Turn ON/OFF	T/F
INS.SHUT1.ST	tsh	N/A	OPEN/CLOSE	T/F
INS.ADC1.MODE	adc	N/A	ADC mode	OFF/AUTO
INS.DPOR.ST	dpor	N/A	Start/Stop continuous rotation	T/F
INS.DROT.RA INS.DROT.DEC INS.DROT.POSANG INS.DROT.MODE INS.DROT.STATINDX	drot	hhmmss.mm ddmmss.mm deg none none	Right Ascension Declination Start position angle Derotator mode Offset index for STAT mode	0-360 STAT/SKY/ELEV See 10.5.1
INS.FILT1.NAME	filt	N/A	Filter name	See 10.5.1
INS.GRAT1.NAME INS.GRAT1.WLEN	grat	N/A nm	Grating name Central wavelength	See 10.5.1 See 10.5.1
INS.MIRR1.NAME	mirr	N/A	Mirror name	See 10.5.1
INS.OPTI1.NAME	iods	N/A	Slide position name	See 10.5.1
INS.GRIS1.NAME	gris	N/A	Slide position name	See 10.5.1
INS.FOCU2.POS	focu	mm	Focus position	See 10.5.1
INS.ROT1.POS	rot	deg	Position angle	See 10.5.1
INS.SLIT1.LEN	dekk	mm	Decker length	See 10.5.1
INS.SLIT1.WID	slit	mm	Slit width	See 10.5.1
INS.SLIT2.NAME	slits	N/A.	Position name	See 10.5.1
INS.TILT1.POS	tilt	micron	Tilt position	See 10.5.1
INS.MIRR2.DATA1 INS.MIRR2.DATA2	yyyy	mm deg	Sample special device setup keyw. Sample special device setup keyw.	any float number any float number

Remarks:

· All motorized devices with encoder can also be addressed to a specific absolute or relative encoder value using the keywords .ENC and .ENCREL (e.g. INS.FILT1.ENC 15000 or INS.FILT1.ENCREL 1000). The usage of these keywords is however limited to engineering/maintenance operations.

5.11.3 DCS keywords

OS and DCS treat these keywords.

The instrument does not implement any special DCS keyword: it uses only keywords defined by the standard DCS packages IRACE (see [RD 15]), FIERA (see [RD 14]) and CCD (see [RD 13]).

5.12 FITS files

Images, as result of exposures, are written on WS disk in FITS format (see [AD 01]).

An example of complete FITS header is given in 10.8.1

The VLT on-line Archive is informed of each new complete file ready for archiving, according to the standard protocol defined in [AD 08].

5.13 Public on-line database attributes

This section is applicable only to those instruments, which are supposed to work in conjunction with other instruments (e.g. through Super-OS).

No OLDB attribute is publicly available.

5.14 Operational logs

An example of operational log in FITS format is given in 10.9.1.

5.15 Templates

This section describes briefly the templates implemented for the instrument.

5.15.1 Acquisition Templates

· XXXX_irimg_acq. It is the acquisition template for the IR_IMAGING Mode.

· XXXX_irspec_acq. It is the acquisition template for the IR_SPECTROSCOPY Mode.

· XXXX_optimg_acq. It is the acquisition template for the OPT_IMAGING Mode.

5.15.2 Calibration Templates

· XXXX_optimg_cal_bias. It executes bias exposures with the FIERA DCS in OPT_IMAGING Mode

· XXXX_optimg_cal_flatfield. It executed flat field exposures with the FIERA DCS in OPT_IMAGING Mode

· XXXX_optimg_cal_focus. It checks the FIERA camera focus in OPT_IMAGING Mode

· XXXX_optimg_cal_linearity. It does a CCD chip linearity check with the FIERA DCS in OPT_IMAGING Mode

5.15.3 Observation Templates

· XXXX_irimg_obs_exp. It performs standard exposures in IR_IMAGING Mode

· XXXX_irspec_obs_exp. It performs standard exposures in IR_SPECTROSCOPY Mode

· XXXX_optimg_obs_exp. It performs standard exposures in OPT_IMAGING Mode

6 CONFIGURATION

This section is reserved to engineers responsible of the instrument maintenance.

It describes where instrument configuration parameters are stored and the way, in which they can be changed, saved and kept under configuration control.

The instrument configuration is based on the Configuration Tool (ctoo, see User Manual [RD 25]).

In order to be able to operate the instrument properly and reliably, the instrument configuration parameters must be kept under configuration control. For this reason, all files containing configuration parameter values are put in one single dedicated cmm module, called xxmcfg (directory config).

After installation, all configuration files are located in $INS_ROOT/SYSTEM/COMMON/CONFIGFILES, except IRACE configuration and clock files, located under $INS_ROOT/SYSTEM/MISC/IRACE.

The files containing information related to the instrument configuration are:

· xxmcfgCONFIG.cfg. It is the master file for the ctoo tool and contains basic information about which other files are involved and for what purpose.

See its contents in 10.5.1

· xxmcfgINS.cfg. It contains most of the Instrument configuration information.

See its contents in 10.5.2

· xxmcfgSTART.cfg. It contains only the startup information (e.g. which subsystems are available and at which level of simulation they should work) and is used by xxinsStartup, xxinsStart and xxinsStop, all based on the Startup Tool stoo (see [RD 19]).

See its contents in 10.5.3

· xxmcfg*M.dbcfg. Each of these files contains the configuration of one motor controlled by ICS. They have been created using the VLT Motor Engineering Interface Tool (motei, see [RD 06]).

· Other *.cfg and *.dbcfg files are created and used by the standard DCS and Real-Time Display (rtd/irtd) packages.

6.1 Change Instrument Configuration Parameters

For configuration changes to take effect, they have to be applied to the files stored in the $INS_ROOT.

Once a new stable configuration has been found, this configuration has to be stored in the xxmcfg module, as this is the only way to save permanently any change to the instrument configuration.

The accepted sequence of operations, which allow keeping control over changes to the instrument configuration, is:

1. Edit the files in the $INS_ROOT, that contain the parameters to be modified:

· use motei for the xxmcfg*M.dbcfg files

· use a normal text editor for the *.cfg files (they are ASCII files in PAF format).

2. If the changes done affect ICS LCU devices, run:

% icbConfigSet XXXX

3. Test the Instrument in the new configuration

4. Repeat the steps above as many times as needed.

5. At the end of the configuration change, one of the following steps MUST be performed to keep proper configuration control:

a) The configuration changes are rejected.

Re-install the latest well-known configuration stored in the xxmcfg module:

% cmmCopy xxmcfg

% cd xxmcfg/src

% make clean all man install

% icbConfigSet XXXX

b) The configuration changes are accepted:

Archive the new configuration in the xxmcfg module:

% ctooConfigArchive XXXX

ctooConfigArchive (should be accessible also from a GUI menu) executes the following steps:

· cmmModify xxmcfg

· copy the configuration files from $INS_ROOT to the xxmcfg module (as specified by the CONFIG.ARCHIVE.* keywords, see section 10.5.1 and [RD 25]).

· cmmArchive xxmcfg

When a complete software (re-)installation on the IWS is going to be done, a snapshot of the current instrument configuration (as described above in point 5b) MUST be archived before starting the new installation.

7 MAINTENANCE

7.1 General

7.1.1 Instrument Self-Test

A special OB executes sequentially all templates defined for the instrument. It is supposed to be used as self-test procedure to verify that the instrument is working properly (see also [RD 24]).

To run it:

1.) Load file XXXX_gen_tec_SelfTest.obd into the BOB panel (File à Load Obs à From File …).

2.) Press the Start button.

3.) Wait till the OB has been completely executed.

If necessary, during the execution of the OB, one can abort it (button Abort in BOB).

The running exposure can be aborted by pressing the Abort button in the OS Control panel.

7.1.2 Module xxins

This module is dedicated to the installation of the instrument software.

· src

· xxinsCreateNewInstrument. Script used to generate the code for a new instrument, duplicating the functionality of the Template Instrument, but having a different name and id.

· xxinsInstallHook. Plugin for pkginBuild (see xxinsINSTALL.cfg). It completes the installation with some steps needed by IRACE and TCS simulation.

· xxinsStartup. Script used to startup the instrument software after a rebuild or some major modifications to the hw configuration (panel pops-up allowing to configure the simulation levels).

· xxinsStartup.pan. File created with the VLT panel editor. It is an example of customization of the startup panel, instead of the default panel defined by stoo.

· xxinsStoo.tcl. It contains some instrument specific stoo sub-classes, overloading methods. It is an example how the startup behavior can be customized.

· xxinsStart. Script normally used to startup the whole instrument software or sub-systems. Simulation levels are kept as defined in the configuration files xxmcfgSTART.cfg.

· xxinsStop. Script normally used to stop the whole instrument software or sub-systems.

· ENVIRONMENTS

· lxxics1. Template directory to be taken by pkginBuild when building environment lxxics1

· lxxics2. Template directory to be taken by pkginBuild when building environment lxxics2

· lxxtccd. Template directory to be taken by pkginBuild when building environment lxxtccd

· wxxxx. Template directory to be taken by pkginBuild when building environment wxxxx

· wxxtcs. Template directory to be taken by pkginBuild when building environment wxxtcs

· config

· xxins.bobrc. Configuration file for BOB

· xxins.cshrc. File containing environment variable definitions, sourced automatically at login (if VUE used)

· xxins-misc-all.env. File containing environment variable definitions, sourced automatically at login (if CDE used)

· xxinsVuewmrc. File containing VUE menu configuration for a development environment

· xxinsUwsVuewmrc. File containing VUE menu configuration for the User Workstation

· xxinsINSTALL.cfg. Main configuration file for pkginBuild. It includes:

· xxinsINSTALL_TEST.cfg. It contains definitions to be used on a development WS only

· xxinsINSTALL_VLTSW.cfg. It contains definitions related to new versions of VLT sw modules.

7.1.3 Module dicXXXX

This module contains the instrument specific dictionaries.

· src

· dicXXXX_CFG.txt. It contains configuration keywords used in xxmcfgINS.cfg for the special device yyyy.

· dicXXXX_ICS.txt. It contains run-time keywords used by ICS

· dicXXXX_OS.txt. It contains run-time keywords used by OS

7.2 OS

7.2.1 Module xxo

This module contains the code for the OS processes.

· src

· xxoControl.C It contains the main of the OS front-end process xxoControl.

· xxoSERVER.C. It contains the code for class xxoSERVER, sub-class of bossSERVER. In particular, method SubsystemInterfaces creates instances of the proper interface class for each sub-system used by OS.

· xxoExpoCtrl.C. It contains the overloading of bossSERVER methods StartPostProc and StartPostProc. They are just examples of bossSERVER method overloading.

· include

· xxoErrors.h. It defines macros for the module errors

· xxoPrivate.h. It contains definitions used by xxoControl

· xxoSERVER.h. It contains definitions for the class xxoSERVER

· CDT

· xxoControl.cdt Command Definition Table for the process xxoControl

· ERRORS

· xxo_ERRORS Definition of errors for this module

· config

· ccd.det Detector Setup File used by module test sw

· guidingMode.ref Reference Setup File used by module test sw

· vnoAUTOCOLL.ref. Reference Setup file automatically read by OS whenever it receives INS.MODE AUTOCOLL in a SETUP command.

· dbl

· xxoSERVER.class. dbl class defining the branches for the sub-systems used.

· xxo.db. dbl include file defining the whole OS branch of the OLDB. This file must be included in wxxxx/dbl/DATABASE.db

· test

It contains various module test scripts

7.2.2 Module xxopan

This module contains the code for the OS GUIs.

· src

· xxopanControl.pan File created with the VLT panel editor for the OS Control GUI (see Figure 5)

· xxopanControl.doc. Source file for the panel xxopanControl manual page

· xxopanStatus.pan File created with the VLT panel editor for the OS Status GUI. Dummy.

· xxopanStatus.pan. Source file for the panel xxopanStatus manual page

· xxopanEngineering.pan. File created with the VLT panel editor for the OS Engineering GUI (see Figure 3)

· xxopanEngineering.pan. Source file for the panel xxopanEngineering manual page

· library xxopanPrivate

· xxopanMisc.tcl. It contains miscellaneous procedure used within OS GUI panels.

· xxopanStateSubSystems_uifClass.tcl. VLT panel editor class used within xxopanEngineering. It contains:

· xxopanStateIcs_uifClass.tcl. VLT panel editor class used to act on ICS

· vnopanStateIrDcs_uifClass.tcl VLT panel editor class used to act on IRDCS

· vnopanStateOs_uifClass.tcl VLT panel editor class used to act on xxoControl

· vnopanStateTccd_uifClass.tcl VLT panel editor class used to act on TCCD

· vnopanStateFiera_uifClass.tcl VLT panel editor class used to act on FIERA

· vnopanStateTcs_uifClass.tcl VLT panel editor class used to act on VLTISIM

7.2.3 Module xxotsf

This module contains the files contributing to the Instrument Package, needed by the DFS, and in particular P2PP.

· src

The VLT utility oslxCompileTsf is used by make to generate the .tsf files (directory config) from the tsfx files.

· XXXX_irimg_acq.tsfx. TSF source file for Target Acquisition in IR_IMAGING mode

· XXXX_irimg_obs_exp.tsfx. TSF source file for standard observations in IR_IMAGING mode

· XXXX_irspec_acq.tsfx. TSF source file for Target Acquisition in IR_SPECTROSCOPY mode

· XXXX_irspec_obs_exp.tsfx. TSF source file for standard observations in IR_SPECTROSCOPY mode

· XXXX_optimg_acq.tsfx. TSF source file for Target Acquisition in OPT_IMAGING mode

· XXXX_optimg_cal_bias.tsfx. TSF source file for bias exposures in OPT_IMAGING mode

· XXXX_optimg_cal_flatfield.tsfx. TSF source file for flat field exposures in OPT_IMAGING mode

· XXXX_optimg_cal_focus.tsfx. TSF source file for focus check in OPT_IMAGING mode

· XXXX_optimg_cal_linearity.tsfx. TSF source file for linearity check in OPT_IMAGING mode

· XXXX_optimg_obs_exp.tsfx. TSF source file for standard observations in OPT_IMAGING mode

· xxotsfDET_EXPLEVEL.tsfx. TSF include file. It contains the following keywords:

DET.EXPLEVEL

· xxotsfINS_FILT.tsfx. TSF include file. It contains the following keywords:

INS.FILT1.NAME

· xxotsfINS_MODE.tsfx. TSF include file. It contains the following keywords:

INS.MODE

· xxotsfIRDET.tsfx. TSF include file. It contains DET1 keywords for IRDCS and includes:

· xxotsfIRDET_DIT.tsfx. TSF include file. It contains the following keywords:

DET1.DIT

DET1.NDIT

· xxotsfSCCD.tsfx. TSF include file. It contains DET3 keywords for FIERA and includes:

DET3.WIN1.ST

DET3.WIN1.STRX

DET3.WIN1.STRY

DET3.WIN1.NX

DET3.WIN1.NY

· xxotsfISCCD_BIN.tsfx. TSF include file. It contains the following keywords:

DET3.WIN1.BINX

DET3.WIN1.BINY

· xxotsfISCCD_DIT.tsfx. TSF include file. It contains the following keywords:

DET3.WIN1.UIT1

· xxotsfISCCD_DIT_LIST.tsfx. TSF include file. It contains the following keywords:

DET3.WIN1.UIT1

· xxotsfISEQ.tsfx. TSF include file. It contains the following keywords:

SEQ.NEXPO

· xxotsfITCCD_DIT.tsfx. TSF include file. It contains the following keywords:

DET2.WIN1.UIT1

· xxotsfITEL.tsfx. TSF include file. It contains the following keywords:

TEL.PRESET.NEW

TEL.TARG.ALPHA

TEL.TARG.DELTA

TEL.TARG.EQUINOX

TEL.TARG.OFFANGLE

TEL.TARG.ADDVELALPHA

TEL.TARG.ADDVELDELTA

TEL.TARG.PMA

TEL.TARG.PMD

TEL.GS1.ALPHA

TEL.GS1.DELTA

TEL.GS1.MAG

7.2.4 Module xxoseq

This module contains the Template Script files, as well as the Reference Setup files used by Templates and test OBs.

· src

· XXXX_acq.seq. Template Script file used by acquisition templates in IR_IMAGING and OPT_IMAGING mode

· XXXX_irimg_obs_exp.seq. Template Script file used by standard observation templates in IR_IMAGING mode

· XXXX_irspec_acq.seq. Template Script file used by acquisition templates in IR_SPECTROSCOPY mode

· XXXX_irspec_obs_exp.seq. Template Script file used by standard observation templates in IR_SPECTROSCOPY mode

· XXXX_optimg_cal_bias.seq. Template Script file used by bias template in OPT_IMAGING mode

· XXXX_optimg_cal_flatfield.seq. Template Script file used by flat field template in OPT_IMAGING mode

· XXXX_optimg_cal_focus.seq. Template Script file used by focus check template in OPT_IMAGING mode

· XXXX_optimg_cal_linearity.seq. Template Script file used by linearity check template in OPT_IMAGING mode

· XXXX_optimg_obs_exp.seq. Template Script file used by standard observation templates in OPT_IMAGING mode

· library xxoseq

· xxoseqICS.tcl. Defines methods for the itcl class xxoseqICS, sub-class of tplICS

· config

· XXXX_acq.ref Reference Setup File used in acquisition templates in IR_IMAGING and OPT_IMAGING mode

· XXXX_irimg_obs_exp.ref. Reference Setup File used by standard observation templates in IR_IMAGING mode

· XXXX_irspec_acq.ref. Reference Setup File used by acquisition templates in IR_SPECTROSCOPY mode

· XXXX_irspec_obs_exp.ref. Reference Setup File used by standard observation templates in IR_SPECTROSCOPY mode

· XXXX_optimg_cal_bias.ref. Reference Setup File used by bias template in OPT_IMAGING mode

· XXXX_optimg_cal_flatfield.ref. Reference Setup File used by flat field template in OPT_IMAGING mode

· XXXX_optimg_cal_focus.ref. Reference Setup File used by focus check template in OPT_IMAGING mode

· XXXX_optimg_cal_linearity.ref. Reference Setup File used by linearity check template in OPT_IMAGING mode

· XXXX_optimg_obs_exp.ref. Reference Setup File used by standard observation templates in OPT_IMAGING mode

· XXXX_gen_tec_SelfTest.obd. OB Description File to test all templates

· XXXX_irimg_acq.obd OB Description File to test template XXXX_irimg_acq

· XXXX_irimg_obs_exp.obd OB Description File to test template XXXX_irimg_obs_exp

· XXXX_irspec_acq.obd OB Description File to test template XXXX_irspec_acq

· XXXX_irspec_obs_exp.obd OB Description File to test template XXXX_irspec_obs_exp

· XXXX_optimg_acq.obd OB Description File to test template XXXX_optimg_acq

· XXXX_optimg_cal_bias.obd OB Description File to test template XXXX_optimg_cal_bias

· XXXX_optimg_cal_flatfield.obd OB Description File to test template XXXX_optimg_cal_flatfield

· XXXX_optimg_cal_focus.obd OB Description File to test template XXXX_optimg_cal_focus

· XXXX_optimg_cal_linearity.obd OB Description File to test template XXXX_optimg_cal_linearity

· XXXX_optimg_obs_exp.obd OB Description File to test template XXXX_optimg_obs_exp

7.3 ICS

7.3.1 ICS Self-Test

A self-test of the ICS functionality can be executed by running:

%ic0SelfTest XXXX

The sequence of commands executed is defined by the keywords INS.TEST.* in the configuration file $INS_ROOT/SYSTEM/COMMON/CONFIGFILES/xxmcfgINS.cfg.

7.3.2 Module xxi

It contains the code and files for ICS WS part.

· src

· xxiConfigSet.tcl. Tcl script called by icbConfigSet to set the yyyy special device configuration values in the ICS LCU 2 OLDB (file $VLTDATA/config/lxxics2.dbcfg)

· xxiControl.C It contains the main for the ICS WS front-end process xxiControl

· xxiCtrlMAIN_HANDLER.C It contains the code for the class xxiCtrlMAIN_HANDLER, sub-class of ic0CtrlMAIN_HANDLER. It overloads the method NewServer, needed in order to create an instance of class xxiSERVER

· xxiSERVER.C. It contains the code for the class xxiSERVER, sub-class of ic0SERVER. It overloads, as example, the method StatusCB, callback for the command STATUS, and also the methods related to OLDB events (AttachDbEvents, DbEvtCB) and timers (AddTimers, TimerCB)

· xxiINS_ANALOG.C It contains the code for the class xxiINS_ANALOG, sub-class of ic0INS_DEVICE, for the special device yyyy. In particular, it overloads method DevTrigger.

· CDT

· xxiControl.cdt Command Definition Table for the WS ICS front-end process xxiControl

· xxiSimControl.cdt. Command Definition Table for the ICS LCU simulation process xxiSimControl

· config

· lxxics1.scan. Scan configuration file for the ICS LCU 1

· lxxics2.scan. Scan configuration file for the ICS LCU 2

· dbl

· xxiSIM_CONTROL.class. dbl class containing the OLDB branch used by xxiSimControl

· xxiEnv1.db. dbl include file for the ICS LCU 1 and WS

· xxiEnv2.db. dbl include file for the ICS LCU 2 and WS

· include

· xxiCtrMAIN_HANDLER.h Declaration of the class xxiMAIN_HANDLER

· xxiINS_ANALOG.h Declaration of the class xxiINS_ANALOG

· xxiSERVER.h Declaration of the class xxiSERVER

7.3.3 Module xxipan

This module contains the code for the ICS GUIs.

· src

· xxipanControl.pan ICS stand-alone panel, created with the CCS panel editor

· xxipanControl.tcl Procedures called from within the xxipanControl panel

· xxipanControl.doc Manual page for the xxipanControl panel

· xxipanGrat.tcl Example of device UIF behavior overloading

· xxipanSpecial_uifClass.tcl Example of special device uifClass, created with the CCS panel editor

· xxipanSpecial.tcl Example of special device behavior.

7.3.4 Module xxidev

It contains the code and files for ICS LCU part, in particular the yyyy special device.

· src

· xxidev.boot Boot file for the xxidev module, as requested by LCC

· xxidevDeviceCmds.c. It contains the callbacks for all implemented commands, as requested by icb

· xxidevDeviceDummies.c. It contains the dummy callbacks for commands not implemented.

· vnidevDeviceNewObj.c It contains constructor and destructor of a special device object

· xxidevServer.c It contains the code of the yyyy server task, as requested by icb

· xxidevServerInterface.c It contains the interface functions defined in the Command Interpreter Table file xxidevServer.cit

· CDT

· xxidevServer.cdt Command Definition Table for the process xxidevServer

· CIT

· xxidevServer.cit Command Interpreter Table for the process xxidevServer

· ERRORS

· xxidev_ERRORS. It contains error definitions used in this module

· dbl

· xxidevYYYY.db dbl include file adding the OLDB point for the device yyyy. It is included in xxiEnv2.db

· include

· xxidevErrors.h It contains macros for errors used in this module

· vnidevDevice.h. It contains definitions used by the device yyyy

· xxidevServer.h It contains function declarations used in the xxidevServer process

7.4 DCS

7.4.1 Engineering

Engineering/Maintenance Operations on DCS sub-systems can be performed through the standard stand-alone GUIs:

· TCCD

%xxinsStart –panel TCCD

· FIERA

%xxinsStart –panel FIERA

· IRDCS

%xxinsStart –panel IRDCS

7.5 MS

7.5.1 Maintenance Templates

At present no maintenance template is implemented.

7.5.2 Module xxmcfg

This module contain the files describing the current configuration of the instrument

· config

· xxmcfgCONFIG.cfg. Main configuration file used by the VLT tool ctoo

· xxmcfgINS.cfg It contains most of the instrument configuration, except the startup/simulation part

· xxmcfgSTART.cfg It contains the startup/simulation part of the instrument configuration

· xxmcfgIRDCS.cfg. It contains the IRDCS part of the instrument configuration

· xxmcfgADC1M.dbcfg. OLDB backup file, created by motei, containing the configuration of the ADC1 motor

· xxmcfgDEKK1M.dbcfg. OLDB backup file, created by motei, containing the configuration of the DEKK1 motor

· xxmcfgDEKK2M.dbcfg. OLDB backup file, created by motei, containing the configuration of the DEKK2 motor

· xxmcfgDPORM.dbcfg. OLDB backup file, created by motei, containing the configuration of the DPOR motor

· xxmcfgDROTM.dbcfg. OLDB backup file, created by motei, containing the configuration of the DROT motor

· xxmcfgFILTM.dbcfg. OLDB backup file, created by motei, containing the configuration of the FILT motor

· xxmcfgFOCUM.dbcfg. OLDB backup file, created by motei, containing the configuration of the FOCU motor

· xxmcfgGRATM.dbcfg. OLDB backup file, created by motei, containing the configuration of the GRAT motor

· xxmcfgGRISM.dbcfg. OLDB backup file, created by motei, containing the configuration of the GRIS motor

· xxmcfgIODSM.dbcfg. OLDB backup file, created by motei, containing the configuration of the IODS motor

· xxmcfgMIRRM.dbcfg. OLDB backup file, created by motei, containing the configuration of the MIRR motor

· xxmcfgROTM.dbcfg. OLDB backup file, created by motei, containing the configuration of the ROT motor

· xxmcfgSLIT1M.dbcfg. OLDB backup file, created by motei, containing the configuration of the SLIT1 motor

· xxmcfgSLIT2M.dbcfg. OLDB backup file, created by motei, containing the configuration of the SLIT2 motor

· xxmcfgSLITSM.dbcfg. OLDB backup file, created by motei, containing the configuration of the SLITS motor

· xxmcfgTILTM.dbcfg. OLDB backup file, created by motei, containing the configuration of the TILT motor

· xxmcfgIcsSelfTest_*.ins. Instrument setup files used by ic0SelfTest as the ICS self-test procedure

7.5.3 Module xxmseq

It should contain the maintenance Template Script Files.

At present it is empty

7.5.4 Module xxmtsf

It should contain the maintenance Template Signature Files.

At present it is empty

8 FAQ AND TROUBLESHOOTING

All suggestions presented in this chapter aim to allow the user to solve themselves the most common problems they may encounter.

In all cases, it is recommended to use the utility logMonitor to look for detailed reasons of the failure.

8.1 Problems at System Start-up

8.1.1 Log-in fails

1. Make sure that the terminal is booting from the right host (wxxxx)

2. Make sure you have entered the right user name (xxxx) and password.

8.1.2 Start-up of GUIs fails

1. Make sure you issued the command from a xterm running on the Instrument Workstation (wxxx) as user xxxx. Type:

%whoami

2. Check the Start-up configuration (file xxmcfgSTART.cfg, see also 10.5.3).

8.1.3 Start-up of control processes fails

1. Start the OS Engineering GUI:

%xxinsStart –panel OS_ENGINEERING

2. Make sure that the sub-system associated to the failing process is supposed to run at a simulation level compatible with the hw available (cross-check also with the contents of the file xxmcfgSTART.cfg).

3. If the failure is related to the LCU sw (e.g. LCU not responding), a reboot of the LCU may help.

8.1.4 xxiControl starts with a wrong simulation level

1. The simulation level at which xxiControl is supposed to start is specified by the keyword INS.CON.OPMODE, defined in xxmcfgSTART.cfg (NOT in xxmcfgINS.cfg !!).

8.1.5 TCCD starts with a wrong simulation level and fails to go STANDBY

1. If the TCCD LCU is available, but no TCCD system is connected to it, xxmcfgSTART.cfg should contain:

OCS.DET2.SWSIM "HW_SIM”

8.1.6 xxoControl tries to access sub-systems declared as not available

1. Information about availability of sub-systems is provided through the keywords OCS.*.ACCESS in the file xxmcfgSTART.cfg.

8.1.7 Going ONLINE fails

1. Start the OS Engineering GUI:

%xxinsStart –panel OS_ENGINEERING

2. Check which sub-system failed to go online

3. Start the related stand-alone panel

4. If the failing sub-system is ICS, the most common case is that one of its devices has been disconnected (e.g. one motor) or set to handset/manual mode (e.g. one lamp or shutter). The failing device can be immediately recognized because its state is NOT online.

· Check the hardware connections/hardware switches

· Try to re-initialize the device.

5. If the failing sub-system is TCCD, the most common case is that the connection to the ACE box is down

· Check all cables in particular the fiber optics cable.

6. If the failing sub-system is FIERA, the most common case is that the controller is powered off (e.g. because of overheating protections).

7. If the failing sub-system is IRACE, the most common case is that the WS part tries to access the Sparc, whereby this computer is not available. Check the definition of environment variables, in particular SDMA_HOST (it must be the host name of the IWS, when the Sparc is not available).

8.2 Problems when running exposures

8.2.1 Cannot send commands to TCS or access tif

1. Make sure that TCS is running and ONLINE.

2. Make sure that TCS RA and DEC are OK. If the RA and DEC background color in the OS Control Panel is gray, then probably TCS is not operational. See also 4.1.2.

8.2.2 Templates cannot access Midas

1. Make sure that MIDAS NOV99 or higher is installed on the IWS. If not, disable MIDAS access from templates (see 4.1.3)

9 ERROR DEFINITIONS

The Instrument Software uses the standard mechanism defined and provided by the CCS error system to log and return error information, both at functional and command level, on LCU and WS.

Errors are defined in the following files:

· xxoErrors.h OS error codes

· xxo_ERRORS OS error messages

.1 OS sub-classing and method overloading

An example of BOSS class bossSERVER method (StartPreProc) overloading is available in the file xxo/src/xxoExpCtrl.C.

.2 Add special commands to OS

TBD

.3 Add special handling of set-up keywords in OS

TBD

.4 Implement a class library for templates

An example of class for template is available in file xxoseq/src/xxoseqICS.tcl.

.5 Implement an ICS special device on LCU

Module xxidev contains the LCU code for the special device yyyy. The special device yyyy is a simple sample software device that has two double attributes in its OLDB point. These two double attributes can be set with the SETUP command (with FITS keywords INS.MIRR2.DATA1 and INS.MIRR2.DATA2). These values can be retrieved with the STATUS command.

File xxidevDeviceCmds.c contains the software device specific code for the CCS commands that the device is capable of receiving.

· Function xxidevDeviceSetup

This function receives the two FITS keywords DATA1 and DATA2, and stores them in the OLDB attributes data1 and data2.

· Function xxidevDeviceStatus

This function returns the values of the OLDB attributes data1 and data2, according to the received parameters DATA1 and DATA2.

.6 Implement an ICS special device on WS

Module xxi contains some examples for ICS WS sw. In particular, file xxiINS_ANALOG.C implements the WS part device yyyy.

Please note that a LCU special device does not necessarily need to have a special counter part on the WS: it might well happen that the default behavior provided by the class ic0INS_DEVICE perfectly fits the needs for that device at WS level.

The same applies also the other way around. There might be a device, which need some special treatment on WS, but perfectly falls into one of the standard ICS LCU device categories; in this case, it is sufficient to implement the special functionality on WS.

In the case of XXXX, we assume that yyyy needs a special treatment both on WS and LCU, just to provide a complete example.

Please note that the special device and related class (xxiINS_ANALOG) has to be registered in the xxiControl process (see file xxiControl.C).

.7 ICS WS sub-classing and method overloading

File xxiSERVER.C shows an example of sub-classing (xxiSERVER sub-class of ic0SERVER) and method overloading (StatusCB, callback for the STATUS command).

In order to let xxiControl use the xxiSERVER class in place of the ic0SERVER (default), also the method NewServer in ic0CtrlMAIN_HANDLER has to be overloaded (see file xxiCtrlMAIN_SERVER.C).

.8 ICS WS Assemblies

See 5.3.2. and [RD 16].

Appendix B. Installation using different environments

It is recommended to use the environment names specified in xxins/config/xxinsINSTALL.cfg and repeated in 2.2.2. However in some cases, for development or test purposes, it might be necessary to use different environment names. The procedure to adapt the XXXX code to this case is described here.

It is assumed that all steps described at 3.2.1 have been done.

Let’s assume that the environment names to be used are:

wyyxx (instead of wxxxx)

wyytcs (instead of wxxtcs)

lyyics1 (instead of lxxics1)

lyyics2 (instead of lxxics2)

lyytccd (instead of lxxtccd)

1. Retrieve modules from archive and add write permission to files

% cd $HOME/XXXXSource

% cmmCopy xxins $XXXX_VERSION

% pkginBuild xxins -step RETRIEVE

% chmod –R +w .

2. Set new prefix

% export XXXX_PREFIX=yy

3. Build test utilities

% cd xxins/test

% make clean all man install

% cd ../..

4. Run xxinsChangeEnvs utility

% xxins/bin/xxinsChangeEnvs

5. Build and install the XXXX Software

See 3.2.2 or 3.2.3 for the remaining part of the installation, according to the hw availability.

___oOo___