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 CCD control software is going to be used by several categories of users. The information related to this software package has been spread over several documents, in order to give each user an easier access only to the information he needs.
1. If you want to
install from scratch the CCD software, read this manual, section
Installation Guide.
a. Experience with the installation of other VLT sw packages.
b. Knowledge of UNIX and VxWorks operating systems
c. Familiarity with the VLT sw standard environment.
2. If you want to
configure the CCD camera you intend to use, read
[16].
a. What at point
1. must already have been done.
b. Knowledge of the CCD camera characteristics.
3. If you want to
operate the CCD camera as simple stand-alone instrument, read
[14]:
a. What at point
2. must already have been done.
b. Some experience with CCD cameras operations.
4. If you want to
interact programmatically with the CCD sw, read this manual, section
User's Guide.
a. What at point
2. must already have been done.
b. Experience with programming within the VLT sw environment.
5. If you have to
develop software to control special hardware for a CCD camera sub-system (e.g. shutter), read
[17]
a. What at point
2. must already have been done.
b. Experience with programming within the VLT sw environment, and in particular with LCU common software.
This document is the User Manual of the CCD DCS Software.
It is intended to provide people, who implement applications using the CCD DCS Software programmatically, with all the necessary information.
The manual assumes that the reader has some knowledge of C language, UNIX and VxWorks Operating Systems and the VLT Software, in particular CCS and LCC. It is not intended to be an introduction to CCD cameras, and therefore it uses common terminology in this field(e.g. pixel, binning, readout, frame-transfer chip, etc.) without further explanations.
In addition to the Introduction, this manual contains three major chapters:
User's Guide: it contains information about:
1. Definitions: exposure id, type and status, operational mode and state.
4. Command Interface to the CCD DCS software
5. Function Interface (C library) to the CCD DCS software
6. GUI panel classes for applications using the CCD DCS software.
8. Setup parameters and files
9. Image files. Interface with Observation Software: who does what and when.
10. Public section of the CCD DCS on-line database.
11. Configuration and operational logs
12. Example of usage of the CCD DCS Software from applications using scientific or technical CCD cameras.
Reference: manual pages of functions available to external software, as well as scripts and processes interacting with external sw and their Command Definition Tables, include files and examples of files of various type to be used as templates.
Installation Guide: It contains a step-by-step description of the procedure to be followed to install the software.
Error Messages: reference to files containing information about errors produced by the CCD software.
The following table presents the complete list of documents available about the CCD software, together with a summary of the contents and the category of users who may be interested in reading them.
|
|
|
|
|
| VLT-MAN-ESO-17240-0672 |
CCD Software - User Manual |
|
· Responsible for VLT sw installation
|
| VLT-MAN-ESO-17240-0917 |
CCD Cameras - User Manual - Software part |
CCD stand-alone |
· Responsible for CCD cameras and chips tests.
|
| VLT-MAN-ESO-17240-0918 |
CCD Cameras - Maintenance Manual - Software part |
|
· Responsible for camera installation.
|
| VLT-MAN-ESO-17240-0919 |
CCD Software - Device Control Libraries - User Manual |
Integration of special hardware in the CCD sw (e.g. FORS shutter). |
· Software developers (only if special hw used).
|
1.2 Scope
The present document is intended to be used for both scientific and technical CCD cameras based on the ACE controller.
For CCD cameras using the FIERA controller, refer to [28].
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.
[1] VLT-PRO-ESO-10000-0228, 1.0 10/03/93 ---- VLT Software Programming Standards
[2] VLT-SPE-ESO-17212-0001, 2.0 12/04/95 ---- VLT Instrumentation Sw Specification
[3] VLT-SPE-ESO-17240-0227, 1.0 08/04/93 ---- CCD Detectors Control Software Specification
[4] VLT-SPE-ESO-17240-0385, 2.1 15/07/96 ---- INS Common Software Specification
[5] GEN-SPE-ESO-19400-0794, 1.1 25/11/97 ---- ESO Data Interface Control Document
[6] VLT-ICD-ESO-17240-19400, 2.6 23/05/97 ---- ICD between VLT Control sw and Archive
1.4 Reference Documents
The following documents contain additional information and are referenced in the text.
[7] VLT-MAN-ESO-17200-0642, 1.8 31/05/97 ---- VLT Common Software Installation Manual
[8] VLT-MAN-ESO-17200-0888, 1.0 17/08/95 ---- VLT Common Software Overview
[9] VLT-MAN-SBI-17210-0001, OCT98 ---- LCU Common Software User Manual
[10] VLT-MAN-ESO-17210-0619, 1.7 30/04/97 ---- Central Control Software User Manual
[11] VLT-MAN-ESO-17240-0816, 1.0 28/09/95 ---- CCD DCS Sw Maintenance Manual WS part
[12] VLT-MAN-ESO-17240-0932, 1.0 28/09/95 ---- CCD Stand-alone Sw Maint. Manual WS part
[13] VLT-MAN-ESO-17240-0817, 1.0 28/09/95 ---- CCD Sw Maintenance Manual LCU part
[14] VLT-MAN-ESO-17240-0917, 1.5 19/11/97 ---- CCD Cameras User Manual, Sw part
[15] VLT-MAN-DJO-11700-0001, 1.0 03/05/96 ---- Technical CCD Systems User Manual
[16] VLT-MAN-ESO-17240-0918, 1.4 19/11/97 ---- CCD Cameras Maintenance Manual, Sw part
[17] VLT-MAN-ESO-17240-0919, 1.0 28/09/95 ---- CCD Software DCL User Manual
[18] VLT-MAN-ESO-13600-0789, 2.0 in prep. ---- B016 Driver for VxWorks. User manual
[19] VLT-MAN-ESO-13600-0527, 2.0 10/03/95 ---- INMOS SW on VxWorks. User manual
[20] VLT-MAN-ESO-13600-0686, 1.2 20/10/95 ---- LCU-Transputer Interface Sw User Manual
[21] VLT-MAN-ESO-17210-0707, 1.5 30/04/97 ---- On Line Database Loader User Manual
[22] VLT-MAN-ESO-17210-0690, 3.1 05/05/97 ---- Graphical User Interface User Manual
[23] VLT-MAN-ESO-17240-0637, 2.3 30/10/96 ---- INS Common Sw - dxf User Manual
[24] VLT-MAN-ESO-17240-0726, 1.7 07/05/97 ---- INS Common Sw - slx User Manual
[25] VLT-MAN-ESO-17240-0853, 1.2 07/05/96 ---- INS Common Sw - oslx User Manual
[26] VLT-MAN-ESO-17240-0866, 2.4 01/10/96 ---- INS Common Sw - rtd User Manual
[27] VLT-MAN-ESO-17240-0725, 1.3 07/05/96 ---- INS Common Sw - pco User Manual
[28] VLT-MAN-ESO-13640-1388, 1.0 13/11/97 ---- FIERA sw User Manual
1.5 Abbreviations and Acronyms
The following abbreviations and acronyms are used in this document:
ACE Array Control Electronics
CCD Charge-Coupled Device
CCS Central Control Software
CDT Command Definition Table
CPU Central Processing Unit
DCL Device Control Library
DCS Detector Control Software
ESO European Southern Observatory
FDDI Fiber Distributed Data Interface
FIERA Fast Imager Electronic Readout Assembly
FITS Flexible Image Transport Format
INS Instrumentation Software Package
MIDAS Munich Image Data Analysis System
TCS Telescope Control Software
TIM Time Interface Module
TRS Time Reference System
UIF (Portable) User Interface (Toolkit)
VME Versa Module Eurocard
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, file names, etc. 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.
The bold and italic styles are also used to highlight words.
1.8 Naming conventions
This implementation follows the naming conventions as outlined in [2].
1.9 Problem Reporting/Change Request
The form described in [7] shall be used.
