Wrapper Common SRS 20110405.pdf

WRAPPER COMMON

SOFTWARE REQUIREMENTS

SPECIFICATION

FOR THE

VERSATILE DEPOT AUTOMATIC TEST

STATION (VDATS)

Document No. 283-001-WRAPPERCOMMON-SRS

Revision 002

05 April 2011

Prepared by:

st Software Maintenance Squadron

402d Software Maintenance Group

402d Maintenance Wing

Warner Robins Air Logistics Center

Doc. No. 283-001-WRAPPERCOMMON-SRS-REV000

Table of Contents

1. Introduction

1.1. Purpose

1.2. Scope

1.3. Definitions, acronyms, and abbreviations

1.4. References

1.5. Overview

2. Overall description

2.1. Product perspective

2.2. Product functions

2.3. User characteristics

2.4. Constraints

3. Specific requirements

3.1. External interfaces

3.2. Functions

1. Introduction

1.1. Purpose

The purpose of this Software Requirements Specification (SRS) is to specify the design requirements for the Wrapper Common function library used on the Versatile Depot Automated

Test Station (VDATS).

1.2. Scope

The software product covered by this document is the Wrapper Common function library for

VDATS.

1.3. Definitions, acronyms, and abbreviations

The following acronyms and abbreviations are used.

Acronym Description

ASCII

CPIN

DLL

GPIB

IEEE

SRS

American Standard Code for Information Interchange

Computer Program Identification Number

Dynamically Linked Library

General Purpose Interface Bus

Institute of Electrical and Electronics Engineers

Software Requirement Specification

TPS Test Program Set

VDATS

VISA

Versatile Depot Automated Test Station

Virtual Instrument Software Architecture

1.4. References

The following documents are referenced.

- IEEE Std 488.1-1987, IEEE Standard Digital Interface for Programmable

Instrumentation

- IEEE Std 488.2-1992 IEEE Standard Codes, Formats, Protocols, and Common

Commands for Use With IEEE Std 488.1-1987, IEEE Standard Digital Interface for

Programmable Instrumentation

- LabWindows / CVI Release Notes, Version 8.1, November 2006

- VPP-4.3: The VISA Library

- M9-Series Diagnostics User’s Guide, Version 6.0, Teradyne, Inc.

The following documents are referenced for formatting purposes.

- IEEE Std 830-1998, IEEE Recommended Practice for Software Requirements

Specifications, 25 June 1998

1.5. Overview

This document contains an overview of the capabilities and uses of Wrapper Common function library utilized on VDATS.

2. Overall description

2.1. Product perspective

Wrapper Common function library shall be contained in the VDATS Wrappers Installation

Media, which will be referenced by a unique Computer Program Identification Number (CPIN).

2.1.1. System Interfaces

Wrapper Common function library shall be used in conjunction with the VDATS system software.

2.1.2. User Interfaces

Wrapper Common function library shall require no user interface.

2.1.3. Hardware Interfaces

Wrapper Common function library interfaces with the General Purpose Interface Bus (GPIB) instruments using the GPIB or IEEE-488 digital communications bus specifications. The requirements specification for GPIB can be found in the documents “IEEE Std 488.2-1992 IEEE

Standard Codes, Formats, Protocols, and Common Commands for Use With IEEE Std 488.1-

1987, IEEE Standard Digital Interface for Programmable Instrumentation” and “IEEE Std 488.1-

1987, IEEE Standard Digital Interface for Programmable Instrumentation”.

2.1.4. Software Interfaces

Wrapper Common function library shall require the VDATS system software which includes:

- Microsoft Windows XP, Service Pack 3

- National Instruments LabWindows / CVI 8.1

The requirements specification for LabWindows / CVI 8.1 can be found in the document

“LabWindows / CVI Release Notes”.

2.2. Product functions

Wrapper Common function library shall make VDATS more user-friendly to the TPS developer by containing commonly used functions. This will prevent the developer from having to generate these commonly used functions within the test program.

2.3. User characteristics

Wrapper Common function library shall have one user type. The test developer shall use

Wrapper Common function library by calling the functions in the library from within a test program.

2.4. Constraints

The constraints on Wrapper Common shall include execution on a VDATS using the VDATS system software and LabWindows / CVI 8.1.

3. Specific requirements

3.1. External interfaces

3.1.1. Software interfaces

The Wrapper Common function library shall interface with all Test Program Sets (TPS).

Wrapper Common function library shall consist of a Dynamically Linked Library (DLL), a statically linked library (.lib), a header file (.h), and a source file (.c), and a LabWindows/CVI project (.prj). The DLL is to interface the library into the Windows Operating System environment. An environmental path variable shall be set within Windows that points to the location of this DLL. Wrapper Common shall have a header file which contains the declarations of functions and variables to be used in test programs. Wrapper Common function library shall also have a .lib file, or a statically-linked library, to interface the test program to functions within the Wrapper Common library. Test programs shall be able make function calls within the

Wrapper Common function library by including a link to the header file and the statically-linked library in the test program’s LabWindows/CVI project. The source file (.c) contains the ANSI C coding for the functions developed in the Wrapper Common function library LabWindows/CVI project (.prj).

3.2. Functions

The function requirements for Wrapper common function library include handling instrument errors, splitting a null terminated string and calling the supplied callback function for each substring, establishing a handle, converting a double to a null terminated string, converting an integer to a null terminated string, sending a null terminated string to a GPIB instrument, reading a null terminated string from a GPIB instrument, writing an array of data to ASCII data file on disk, reading an array of data from ASCII data file on disk, clearing each cell of the pin list, removing specified channel names, retrieving the entire pinmap array, finding pin numbers associated with passed names, retrieving names associated with passed channel numbers, loading pinmap from text file, converting from string of channels to an integer array, and setting the name for a specified channel.

3.2.1. Error Handling

Wrapper Common function library shall contain functions to handle errors occurring in VDATS

System Software wrapper functions. Wrapper Common function library shall receive an error condition from the wrapper functions and process the error. Wrapper Common function library shall retrieve the error message from the wrapper function that had an error and return the error to the test program. Wrapper Common does not process the error condition but provides a common conduit for communicating the error from the wrapper functions to the test programs.

3.2.2. Miscellaneous Functions

3.2.2.1. The Wrapper Common function library shall be able to split a null terminated string calling the supplied callback function for each substring.

3.2.2.2. The Wrapper Common function library shall contain a function to acquire a handle from

Resource Manager. Resource Manager is the name given to the part of the Virtual

Instrument Software Architecture (VISA) that manages resources. This management includes support for opening, closing, and finding resources, setting and retrieving resource attributes, and generating events on resources. When Resource Manager establishes communication with an instrument, a handle is defined and used to identify the instrument in any further communication. The requirements specification for VISA can be found in the document “VPP-4.3: The VISA Library”.

3.2.2.3. The Wrapper Common function library shall be able to convert doubles and integers into null terminated strings.

3.2.2.4. The Wrapper Common function library shall be able to read and write null terminated strings to and from a GPIB instrument.

3.2.2.5. The Wrapper Common function library shall be able to read and write an array of data to and from an ASCII data file. The ASCII data file shall contain ASCII text.

3.2.3. Pin Map

Channel aliases allow test program developers to associate descriptive names for each channel number through character strings stored in memory. Associating string names with channel numbers makes developing and maintaining test programs more user friendly since the developer can input the alias name instead of a specific channel number. The resulting code will be easier to maintain since the code will contain descriptive names instead of integers. Use of channel aliases is optional. Prior to using the channel aliases, the developer shall associate each channel with an alias string.

3.2.3.1. The Wrapper Common function library shall contain functions to clear all channel aliases, delete specific channel aliases, retrieve all channel aliases, retrieve specific channel aliases, load channel aliases from a file, and set a specific channel alias. When loading the channel aliases from a file, the file shall follow the format of a pinmap file specified in the “M9-Series Diagnostics User’s Guide” document.