3sigma LabVIEW Driver User Guide
Driver User Guide
Coherent-Molectron
Page
2
Table of Contents
1.1
COMPUTER SYSTEMS SUPPORTED ............................................................................... 3
1.2
INTRODUCTION .................................................................................................................. 3
1.3
3SIGMA LABVIEW DRIVER VIS......................................................................................... 3
1.3.1
T
REE
VI .......................................................................................................................... 4
1.3.1.1
3sigma VI Tree VI................................................................................................... 4
1.3.2
A
PPLICATION
VI
S
............................................................................................................. 5
1.3.2.1
3sigma Getting Started VI ................................................................................... 5
1.3.2.2
3sigma Example VI ............................................................................................. 6
1.3.3
C
OMPONENT
VI
S
............................................................................................................. 7
1.3.3.1
Initialize VI ........................................................................................................... 7
1.3.3.1.1
3sigma Initialize VI .......................................................................................................... 7
1.3.3.2
Configuration VIs.................................................................................................. 8
1.3.3.2.1
3sigma Area Correction VI .............................................................................................. 8
1.3.3.2.2
3sigma Attenuation VI ..................................................................................................... 9
1.3.3.2.3
Display Data Averaging VIs............................................................................................10
1.3.3.2.4
Measurement Data Format VI ........................................................................................12
1.3.3.2.5
Range VIs ......................................................................................................................13
1.3.3.2.6
Statistical Batch VIs .......................................................................................................16
1.3.3.2.7
Trigger VI .......................................................................................................................19
1.3.3.2.8
Miscellaneous VIs ..........................................................................................................20
1.3.3.2.9
Wavelength Correction VIs.............................................................................................22
1.3.3.3
Action/Status VIs ............................................................................................... 25
1.3.3.3.1
3sigma Zero VI...............................................................................................................25
1.3.3.3.2
3sigma System Status....................................................................................................26
1.3.3.4
Data VIs ............................................................................................................. 27
1.3.3.4.1
3sigma Data Initialize VI.................................................................................................27
1.3.3.4.2
3sigma Fetch Readings VI .............................................................................................28
1.3.3.4.3
3sigma Data Abort VI .....................................................................................................29
1.3.3.5
Utility VIs ........................................................................................................... 30
1.3.3.5.1
3sigma Probe Information VI..........................................................................................30
1.3.3.5.2
3sigma Instrument Information VI ..................................................................................31
1.3.3.5.3
3sigma Display Clear VI .................................................................................................32
1.3.3.5.4
3sigma Display Text VI...................................................................................................33
1.3.3.5.5
3sigma Error Query VI....................................................................................................34
1.3.3.5.6
3sigma Error Clear VI.....................................................................................................35
1.3.3.5.7
3sigma Function Switch Position VI ...............................................................................36
1.3.3.5.8
3sigma Revision Query VI..............................................................................................37
1.3.3.5.9
3sigma Self Test VI .......................................................................................................38
1.3.3.5.10
3sigma Reset VI ............................................................................................................39
1.3.3.6
Close VI ............................................................................................................. 40
1.3.3.6.1
3sigma Close VI .............................................................................................................40
1.3.4
S
UPPORT
VI .................................................................................................................. 41
1.3.4.1
3sigma Serial Read with Timeout VI .................................................................... 41
QI-D113639 Rev AA
3sigma LabVIEW Driver User Guide
Coherent-Molectron
Page
3
1.1 Computer Systems Supported
The 3sigma LabVIEW driver works on Win98, WinXP, WinME, WinNT, and Win2000 operating
systems. In order to operate properly with the driver, the computer must have an available RS-
232 port. A screen resolution of 1024 by 768 pixels or greater must be used to allow a VI to fit
within the screen. Version 6.02 of LabVIEW or later should be installed.
1.2 Introduction
The 3sigma LabVIEW driver has been designed to allow the construction of a wide variety of
custom applications in a small amount of time. The library only contains VIs useful for making the
3sigma function via remoteit does not contain plotting, charting, or file routines which are
already available in LabVIEW.
The VIs from the library can be strung in sequence to form an application. Normally, the 3sigma
Initialize VI is the first VI in the sequence. This VI configures the serial port for the host to
communicate with the instrument. The 3sigma Close VI should normally be the last VI in the
sequence. This VI ends the communication session with the 3sigma. A VI in driver can be
examined more thoroughly by double-clicking it.
1.3 3sigma LabVIEW Driver VIs
This section describes each VI that is included in the 3sigma LabVIEW Driver. Each VI listed
contains the following information:
NameThe name of the VI.
PurposeDescribes the intended use of the VI.
IconThe icon image used by the VI.
Front PanelThe front panel display used by the VI.
InputsConnector pane inputs of the VI. Each input has a name and a data type. If no
input is defined for the VI, the text None will be listed. The default value and allowable
range is also shown for each input.
OutputsConnector pane outputs of the VI. If no output is defined for the VI, the text
None will be listed.
The data type for each input and output is displayed within the characters < and >. The
following data types may be used for the VI inputs and outputs:
Floating PointLabVIEW double-precision, floating-point type.
Visa clusterLabVIEW visa-cluster type.
Error clusterLabVIEW error-cluster type.
BooleanLabVIEW boolean type.
Unsigned integerLabVIEW 32-bit, unsigned-integer type.
Text ringLabVIEW text-ring type.
ClusterLabVIEW cluster type.
Array of clusterA LabVIEW array containing LabVIEW clusters as the elements.
The following syntax will be used for the description of inputs and outputs:
Strings appearing in a text ring are enclosed within the characters { and }. A comma
delimiter separates the strings. Each string element is enclosed within quotes.
Data items appearing in a cluster type are enclosed within the characters [ and ].
Two side-by-side quote characters denote empty strings.
QI-D113639 Rev AA
3sigma LabVIEW Driver User Guide
Coherent-Molectron
Page
4
1.3.1 Tree VI
The Tree VI is a non-executable VI, designed to show the functional structure of the 3sigma
driver. It contains all VIs appearing in the driver.
1.3.1.1 3sigma VI Tree VI
Name:
3sigma VI Tree.vi
Purpose:
Shows the functional structure of the 3sigma driver.
Icon:
Front Panel:
Inputs:
None
Outputs:
None
QI-D113639 Rev AA
3sigma LabVIEW Driver User Guide
Coherent-Molectron
Page
5
1.3.2 Application VIs
These high-level VIs perform the most commonly-used instrument configurations and
measurements by calling the appropriate component-level VIs. They demonstrate high-level test
and measurement functionality by configuring the 3sigma for a common mode of operation,
triggering, and taking measurements.
1.3.2.1 3sigma Getting Started VI
Name:
3sigma Getting Started.vi
Purpose:
This VI includes the 3sigma Initialize.vi, 3sigma Application.vi, a