1 INTRODUCTION

1.1 Purpose

This document¹ provides the User Manual of the software module LCU Q-Server (lqs).

It is intended to provide all the necessary information to use this software, to develop the LCU message system.

The manual assumes that the reader has a good knowledge of UNIX, C-language, the VxWorks operation system and is familiar with the VxWorks development environment.

In addition to the Introduction section, this manual contains the following chapters:

· Users's Guide: describes the tasks that can be done by this module, including examples.

· Reference: Describes all the functions available to the user and user applications.

· Installation Guide: Describes how to install and make the software ready to be used. This section also contains test procedures.

· Error Messages and Recovery:. Provides a list of errors and diagnostic messages and possible recovery actions.

1.2 Scope

This manual describes the software module lqs in its version 2.3.

The lqs module is responsible for the communication between LCUs and workstations, using the protocol defined by HP's RTAP (Real Time Application Platform) product. The LCU message system makes use of this software module to transport messages between hosts. A prototype message system is available as part of the lqs module and is documented in Appendix. This prototype does not conform to the VLT message system and does not replace the LCU message system. This version has introduced a timeout for acknowledge messages and a polling of connected environments for detection of connection break.

This implementation includes the following C libraries:

· lqs - library of routines to access the lqs module.

· qsLib - prototype message system to prove the functionality of the lqs module.

The following hardware and software environment is required to run the driver software described:

· a standard 6U VMEbus chassis with bus backplane and power supply

· at least one Motorola MVME167 CPU board, any version

· VxWorks 5.1 operating system

1.3 Reference Documents

The following documents contain additional information and are referenced in the text.

[1] VxWorks Version 5.1 Programmer's Guide
Wind River Systems

[2] VxWorks Version 5.1 Reference Manual
Wind River Systems

[3] RTAP/Plus Reference Manual
Version 6.0

[4] VLT Software Programming Standards
VLT-PRO-ESO-10000-0228, Issue 1.0, 10/03/93

[5] VLT SW Rel1 - Overview and Installation
VLT-MAN-ESO-17200-0642, Issue 1.2, 15/12/94

[6] CCS-LCU Driver Development Guide
VLT-SPE-ESO-17210-0375, Issue 1.0, 12/09/94

[7] CCS Q-Server Emulator User Manual
VLT-MAN-ESO-17210-0422, Issue 2.3, 11.11.1994

[8] CCS User Manual
VLT-MAN-ESO-17210-0619, Issue 1.1, 15/12/94

[9] LCC User Manual
VLT-MAN-SBI-17210-0001, Issue 1.6, 28/09/94

1.4 Abbreviations And Acronyms

The following abbreviations and acronyms are used in this document:

CCS Central Control Software

HW Hardware

IEEE Institute of Electrical and Electronics Engineers

LAN Local Area Network

LCC LCU Common Software

LCU Local Control Unit

lqs LCU Q-Server module

N/A Not Applicable

OS Operating System

QS Queue Server

RTAP Real Time Application Platform (software by Hewlett-Packard)

SW Software

TBD To Be Defined

VLT Very Large Telescope

WS Workstation

1.5 Stylistic Conventions

The following styles are used:

bold - in the text, for commands, filenames, prefixes/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.

Items which are subject to change in future versions are marked in this way (AuthorRemark).

7 Very important items are marked in this way (Warning).

Changes to the previous issue of this document are marked with Change-Bars.

1.6 Naming Conventions

This implementation follows the naming conventions as outlined in the VLT Programming Standards [4].

1.7 Problem Reporting/Change Request

To:

· report a problem/error encountered using the software and/or the documentation,

· suggest changes in the software or documentation

fill an SPR-form² (shown in the following page) and send it with any other additional material that you think could be helpful, to ESO:

· by mail or fax for the attention of:

VLT/ELE- SOFTWARE GROUP/Software Configuration Control Manager

· by e-mail to:

vltsccm@eso.org

Your request will be checked-in the SPR data base and processed according to ESO change control procedure. The registration number will be communicated to you for further reference and you will be kept informed of the outcome of your SPR.

Please provide all information that is requested in the following SPR form.

==============================================================================
E. S. O. ---- VERY LARGE TELESCOPE PROJECT ----
------------------------------------------------------------------------------
SOFTWARE PROBLEM REPORT/CHANGE REQUEST FORM DATE: <dd/mm/yy>
------------------------------------------------------------------------------
From:
<contract number>
<consortium name>
<institute name/company name>
<address>

<name of the submitter with its e-mail adress/fax number/phone number>

------------------------------------------------------------------------------
Subject: < module name / document title + version number >
Title: < problem short description >
------------------------------------------------------------------------------
Please mark one of the following categories

_ software error
_ error in the documentation
_ change request
------------------------------------------------------------------------------
Description:

>>>>> Please delete these lines and provide:
>>>>> for software errors:
>>>>> - the description of the anomaly, uncluding outputs,
>>>>> - how to reproduce it,
>>>>> - if existing, the temporary solution,
>>>>> - if known, the reference to where it was specified correctly
>>>>> - if known, the way to fix it.
>>>>>
>>>>> for errors in the documentation:
>>>>> - the exact location of the error (DocNr, issue, page, etc.)
>>>>> - the text that is wrong
>>>>> - if known, to what should it be changed.
>>>>>
>>>>> for change request
>>>>> - the description of what you would like to have
>>>>> - if available, possible implementation hints.
>>>>>
>>>>>

==============================================================================

The document is prepared according to the IEEE 1063-1987 (Standard for SW User Documentation) as recommended in sect. 4.2.14 page 34 of the SW Management Plan - Issue 2.0, 21/05/92.

The utility getTemplate provides such form as editable file.