Lambda Genesys Instrument Driver Readme

Table of Contents:

1.  Overview
2.  Required Software
3.  Installation Instructions
4.  Accessing the Driver in LabVIEW
5.  Using the Instrument Driver
6.  Configuring the Instruments and Drivers
7.  Addressing the Instrument
8.  Checksum Message Checking 
9.  Custom Error Codes
10. Unsupported Features
11. Restrictions
12. Known Issues
13. Customer Support
14. Revision History

1. Overview

Instrument Driver Technology:	Plug and Play
Supported Language(s):  	LabVIEW  6.1
Supported Regional Settings:	English and Universal desktops
					(period or comma separator for 
					 number decimal point)

Supported Models:  		Lambda Genesys Series DC Power Supplies
Models Tested:  		750 and 1500 Watt, and Half-Rack
Interfaces:			Serial, RS-232 or RS-485
Firmware Revision Tested:  	Rev 1.9 and up

Certified:  			Yes
NI Supported:  			Yes
Source Code Available:  	Yes

Driver Revision:  		REV_B03, 07/2005, LV_6.1
Original Release Date:  	Aug 2003
Current Revision Date:  	Jul 2005

2. Required Software

Some software components need to be installed before using this 
instrument driver. The minimum versions of these components are listed below,
and can be downloaded from the Download Site.

LabView   6.1  or later
VISA      2.6  or later

Note: VISA has additional software requirements. For example, NI-VISA requires 
that NI-Serial be installed on your system. Check with VISA help for additional 
support software and hardware requirements.    

3. Installation Instructions

Obtain a copy of the driver software.  It is packaged in a file with a name 
similar to: 
                "GENser.zip" 

A)  Use Windows Explorer and navigate to folder:
	...\Program Files \National Instruments \LabVIEW...\instr.lib

B)  Create a new folder: GENser

C)  Use the ZIP utility, such as WinZip.exe,  to extract the driver files 
    into the "GENser" folder

D)  You will now have a "...\instr.lib\GENser\" folder containing:
	"GENser.llb"
	"_GENser.llb"
	five MNU menu files
	"lambda gen readme.htm" (this file)

The menu files and VI libraries (LLB) make up an instrument driver. 
The menu files allow you to view the driver VIs from the Functions palette.
The "GENser.llb" VI library contains the instrument driver VIs.
The "_GENser.llb"  VI library contains support drivers not normally used
  by the programmer and they do not appear on the Function pallet (see next)

4. Accessing the Driver in LabVIEW

There is normally no need to view the library file because the driver 
functions may be picked from a palette menu.

A)  Right-click on a blank place on the VI diagram
    See the "Functions" palette open.  Navigate:
	Functions ->  
		Instrument I/O ->  
			Instrument Drivers ->  
				Lambda GENESYS Serial DC-Power

B)  Alternately,  click diagram's menu bar:  
	Window ->  "Show Functions Palette" and navigate the above menus 

5. Using the Instrument Drivers

LabVIEW:
To verify communication with your instrument and test a typical remote
instrument operation, you should first open the Getting Started or Example 
VIs the instrument driver. Look over each of the controls and set them 
appropriately.  Generally, with the exception of the address field, the 
defaults for most controls will be sufficient for your first run. You will 
need to set the instrument resource name appropriately. After running the VI, 
check to see that reasonable data was returned and an error was not reported 
in the error cluster.

You can right-click any object on the driver panel to see its description.

After you have verified basic communication with your instrument, you might 
want to customize instrument control for your needs. If your application 
needs are similar to the Getting Started or Example VI, the simplest means of 
creating a customized VI is to save a copy of the Getting Started or Example 
VI by selecting "Save As" from the File menu. You can then modify this example 
to meet your specific needs.

For more details, reference the LabVIEW Help under:
                                       Help » VI, Function, and How-To Help. 

6. Configuring the Instruments and Drivers

The controls on the "Initialize.vi" driver must match the settings on the power
supply you want to communicate to. See the Genesys Technical Manual, Chapter 7, 
for details on setting the address and Baud rate for each instrument and for 
selecting and connecting the RS-232 or RS-485 cables.

On the "Initialize.vi" driver panel, click the "VISA name" control. A list of 
all available RS-232 and RS-485 serial ports should drop down. If they do not, 
there is a configuration problem with the VISA layer. The serial ports may be 
checked by using the NI Measurement & Automation Explorer (NI MAX) or similar 
program. Right-click the "VISA name" control and select "Description" for more 
information.

7. Addressing the Instrument

Every driver has a "GEN Addr" control terminal. This must be wired in the first 
driver "Initialize.vi". Communication with the first instrument is verified when
the driver is run.  

For any driver used after "Initialize.vi", wiring the "GEN Addr" control is 
optional. If the control is not wired, the driver command will be sent to the 
last instrument that was addressed. This is called a 'sticky' address or
address caching.

8. Checksum Message Checking

All messages sent to the Genesys power supply have a checksum added to the end
of the message. The checksum is in the form "dollar sign" plus "two hex digits". 
All responses from the power supply have a checksum which is verified by the 
drivers.

See "GENser Checksum Append.vi" and "GENser Checksum Verify.vi" in _GENser.llb.

9. Custom Error Codes

Every driver checks for errors and any found are returned in the "error out"
cluster. There are three sources of errors and only the highest priority 
error is returned:

			ERROR TYPES
Priority
Type
Description
Highest
VISA Error
Returned by VISA functions such as Write or Read
Examples: After command sent, no response received

 

Instrument Error
Error code returned by instrument. Expected an 
"OK" response but received error such as "C01".
Examples: see "COMMAND ERRORS" table below
Lowest
Driver Error
Driver found the command has a bad format or a
response message is corrupted.
Examples: see "RESPONSE ERRORS" table below
The VISA standard allows custom error codes in the range:
		-1073999873 to -1074001919  ( BFFC0801 to BFFC0FFF hex)
The instrument errors are formulated in "GENser Convert Errors.vi".
All returns are errors; there are no warnings.

			EXAMPLES:  INSTRUMENT ERRORS
Decimal Code
Hex Code
Meaning
-1074001663
BFFC0901
Execution error "E01". The voltage setting is too
high and conflicts with over-voltage protection
-1074001662
BFFC0902
Execution error "E02". The voltage setting is too
low and conflicts with under-voltage limit
-1074001660
BFFC0904
Execution error "E04". The over-voltage protection
is too low and conflicts with the voltage setting
-1074001658
BFFC0906
Execution error "E06". The under-voltage limit
is too high and conflicts with the voltage setting
-1074001657
BFFC0907
Execution error "E07". Attempt to turn the output
ON while a fault is keeping the output OFF
-1074001407
BFFC0A01
Command error "C01". Illegal command or query
-1074001406
BFFC0A02
Command error "C02". Missing parameter. Command
requires a value but the value is missing
-1074001405
BFFC0A03
Command error "C03". Illegal parameter. Command
requires a value but value is wrong type
-1074001404
BFFC0A04
Command error "C04". Checksum error. Genesys  
received message with checksum but checksum 
calculation was not the same as received checksum 
-1074001403
BFFC0A05
Command error "C05". Setting out of range. Attempt
to program a setting outside of the model rating

			EXAMPLES: DRIVER ERRORS
Decimal Code
Hex Code
Meaning
-1074003951
BFFC0011
No response from "ID Query" in "Initialize.vi".
May be an incorrect address setting or the
instrument is not communicating
-1074001912
BFFC0808
No response when switching to a new GEN address
-1074001910
BFFC080A
When switching to a new GEN address, a response 
was received but it was not "OK"
-1074001908
BFFC080C
Did not get response from GEN instrument when 
first sending its address command
-1074001906
BFFC080E
When first sending a GEN it's address command, 
received a response but it was not "OK" 
-1074001902
BFFC0812
Could not parse identity fields to get the
model number ("GENvvv-ccc")
-1074001900
BFFC0814
Attempt to send query to "Write to Instrument".
Cannot have "?" in command string
-1074001898
BFFC0816
Attempt to send command to "Read Instrument Data".
Must have "?" in query string
-1074001896
BFFC0818
After command, received a response but it was
not "OK" or any valid error code
-1074001888
BFFC0820
Checksum error: did not verify CS returned in
instrument response
-1074001886
BFFC0822
Checksum error: CS missing or wrong format

10. Unsupported Features

The following Genesys capabilities are not supported by these drivers:
- Event and Enable registers (FEVE, FENA, SEVE and SENA commands)
- SRQ interrupts 
- Calibration commands
- Calibration Date (DATE? query)

11. Restrictions

A. Applicable Genesys Firmware Revisions
The Genesys firmware revision may be read by using the driver:
	"GENser Revision Query.vi" 

These drivers are fully compatible with Genesys units having firmware
revision "1.9" or later (made after Aug 2004)
B. Restriction for Service Requesting
These drivers are not compatible with any programs that enables the
Genesys Service Request registers (the "SENA nn" and "FENA nn" commands). 
This is because the SRQ message from the Genesys (form "!nn") will be
added to any response messages and interpreted as illegal characters

12. Known Issues

There are currently no known issues with this instrument driver.

13. Customer Support

For technical support and driver upgrades, you can contact Lambda at 
the following telephone number:

      Lambda Americas		(732)922-9300 Ext 209 
      Customer Service          dave.ransom@lambda.com
      405 Essex Road
      Neptune, New Jersey, 07753  USA

Or visit our support web page at: 
				http://www.lambda-hp.com/service.htm

Or contact your Lambda Representative

14. Revision History

    REV_A00, 08/2003, LV_6.1
	Original Release
    	by Walter Heyck
	   Lambda Americas

    REV_B03, 07/2005, LV_6.1
	Updated to make Plug-n-Play compatible, including:
		Adding the MNU files for the function pallet.
		Making error codes VISA compliant.
		Deleting the "GEN_Errors.txt" file
	by Walter Heyck
	   Lambda Americas