************************************************************************************
*                                                                                  *
*  Copyright 2002, Racal Instruments Limited.   All rights reserved.              *
*                                                                                  *
*  Racal Instruments Limited, 2461 Modular Instrument System VXIplug&play Driver   *
*                                                                                  *
*  Software Number:  60-0087                                                       *
*  Revision       :  2.04                                                          *
*                                                                                  *
************************************************************************************


Introduction
------------

The Racal Instruments VXIplug&play instrument driver provides comprehensive access to the capabilities of the 2460 Series Modular Instrument System Universal Counter Timer.
The following information is provided to give the user a better idea of how and when to use these drivers and the supporting documentation.
It is highly recommended that the user read through this prior to using the drivers and soft front panel, particularly the sections titled Requirements and the Copyright and Licensing Agreement at the end.

This driver does not have any significance alone, but must be used in conjunction with a suitable Racal Instruments 2460 Series Main Unit driver, e.g. the Racal Instruments ri2461.


Inventory
---------

After executing the SETUP.EXE file in the install disks, the following files should be present in the vxipnp directory structure on the users hard disk.
If any of these files are missing, the user should attempt to re-install the software or contact Racal Instruments customer support at:
UK   +44 (0)8706 080134   or  helpdesk@racalinstruments.co.uk
USA  1-(800) 722-3262     or  helpdesk@racalinstruments.com

Directory             File                  Description
--------------------------------------------------------------------------------
vxipnp/winnt/bin      ri246cou_32.dll       Driver software in 32-bit DLL format
vxipnp/winnt/bin      ri246couSupp_32.dll   Supplementary Driver software in 32-bit DLL format

vxipnp/winnt/include  ri246cou_32.bas       Visual Basic header
vxipnp/winnt/include  ri246cou.h            ANSI "C" language header

vxipnp/winnt/lib/msc  ri246cou.lib          Microsoft "C" compatible library
vxipnp/winnt/lib/bc   ri246cou.lib          Borland "C" compatible library

vxipnp/winnt/ri2461   ri246cou.txt          This file
vxipnp/winnt/ri2461   ri246cou.c            ANSI "C" language source code
vxipnp/winnt/ri2461   ri246coufp_32.dll     Executable (32-bit) Soft Front Panel
vxipnp/winnt/ri2461   ri246cou.fp           LabWindows/CVI Driver front panels
vxipnp/winnt/ri2461   ri246cou.doc          Text file documenting the driver
vxipnp/winnt/ri2461   ri246cou.hlp          Microsoft Windows NT help file
vxipnp/winnt/ri2461   ri246coufp.hlp        Microsoft Windows NT help file


NOTE:  For Windows 95 installations, the default directory for the installation
	is "vxipnp/win95" in lieu of "vxipnp/winnt"




Important Notice for Users of Revision 1.03, ri246cou Instrument Driver
-----------------------------------------------------------------------

a. In line with the VXIplug&play Systems Alliance's decision (April, 1997) to discontinue "VPP-5: VXI Component Knowledge Base Specification" the knowledge base file ri246cou.kb is no longer distributed with this driver.

b. The following functions have had unsigned integer types replaced with signed integers in their parameter lists (VXIplug&play requirement):
	ri246cou_confInputConditioning ()
	ri246cou_confInputHysteresis ()
	ri246cou_confInputTriggering ()
	ri246cou_confInputSlopes ()
	ri246cou_confMinAutoTrigFreq ()
	ri246cou_confAutoTrigMode ()
	ri246cou_confArming ()
	ri246cou_confDelay ()
	ri246cou_confMeasurement ()
	ri246cou_confMeasRes ()
	ri246cou_mathCalculation ()
	ri246cou_confStandard ()
	ri246cou_outputGate ()
	ri246cou_queryInputConditioning ()
	ri246cou_queryInputHysteresis ()
	ri246cou_queryInputTriggering ()
	ri246cou_queryInputSlopes ()
	ri246cou_queryMinAutoTrigFreq ()
	ri246cou_queryAutoTrigMode ()
	ri246cou_queryArming ()
	ri246cou_queryDelay ()
	ri246cou_queryMeasurement ()
	ri246cou_queryMeasRes ()
	ri246cou_queryMathCalculation ()
	ri246cou_queryStandard ()
	ri246cou_queryOutputGate ()
	ri246cou_openCloseGate ()
	ri246cou_clearAccCount ()
	ri246cou_initiateTrigger ()
	ri246cou_triggerContinuous ()
	ri246cou_measureFunction ()
	ri246cou_reset ()
	ri246cou_diagnosticTests ()


Requirements
------------

In order successfully to utilize the various driver files, there are certain requirements that must be met regarding the system on which this software is to be used.  These minimum requirements are laid out in the VXIplug&play specification document VPP-2.  In general, the minimum hardware requirements for the WIN framework are:

- The system computer must be 100% IBM PC compatible and:
- It must be have an 80486/33 MHz or greater CPU with floating point
- It must have at least a 120-MB hard disk
- It must have a VGA or higher compatible monitor
- It must have a 3.5-inch, 1.44-MB floppy disk drive
- It must have at least 8-MB RAM (Racal Instruments recommends 32-MB)
- It must have a Windows compatible mouse
- It must have the capability to control VXI message-based and register-based instruments

In addition, there are certain minimum requirements in regard to software that must be met in order for the Racal Instruments 246X drivers to operate correctly.  These minimum requirements are:

- Microsoft Windows95 or WindowsNT version 4.0 or higher
- VISA Library version 1.1 or higher installed in the /WINDOWS/SYSTEM directory as VISA.DLL
- The minimum necessary resource manager software needed to support the current version of VISA.DLL

			***** WARNING *****
Attempting to run the Soft Front Panel or any executable based on the 2461 drivers without having the VISA DLL files installed will most likely result in a User Application Error or General Protection Fault and may lock up the users Windows environment.

If the user does not have VISA DLLs installed in the /WINDOWS/SYSTEM directory, then a VISA install disk should be obtained from the company that provided the Slot 0 Resource Manager device.


Using the Soft Front Panel
--------------------------

To run the 2461 soft front panel, either double click on the RI2461 icon in the VXIPNP group or double-click on the ri2461fp_32.exe file in the VXIPNP/WINNT/RI2461 directory in the Windows Explorer.

Before executing, verify that the following has been accomplished:

- At least one correctly configured 2461 module has been installed in the VXI chassis (See the
2461 Instruction Manual for information on how to correctly configure and install a 2461 module)
- The VXI chassis has power applied
- The appropriate resource manager software has been run; i.e. VXIInit and Resman for National Instruments based controllers or EPConnect for Radisys controllers
- The resource manager has correctly identified and initialized the 2461 module(s)

NOTE:  if VISA is installed, and no 2461s are found, the soft front panel will execute in a  "Demonstration Mode", which can be used to illustrate the capabilities of the 2461

If a single module is installed, the soft front panel will automatically connect to that device.  If multiple 2461 modules are installed, the soft front panel will display a dialog box titled "Select 2461" requesting that the user specify with which module to establish a communication channel.  This dialog box lists the interface type/interface number, slot number and logical address of each 2461.  To select a 2461, select the desired 2461.

If a successful connection has been made, the "Active" LED will be green.

Using the Drivers
-----------------

There are two functions that are crucial to the proper use of the 2461 drivers and three others of which the user should be aware.  The two crucial functions are ri2461_init and ri2461_close. (These functions are found in the 2461 Modular Instrument System VXIplug&play Driver, 60-0084.) 

The ri2461_init function is used to establish a communication channel with the 2461 instrument via the VISA I/O library.  It is necessary to call this function prior to calling any other driver functions.  To use this function, the user will need to construct a string called an "Instrument Descriptor".   This string specifies the type of interface, the interface address, the VXI logical address and for GPIB-VXI interfaces the GPIB primary address.
The syntax for this string may be obtained by looking at the help documentation under the ri2461_init function.  The function will return an error code that is a negative value if it encounters a problem.
If the function successfully connects to the instrument, then the last parameter of the function will contain a value known as an "Instrument Handle".  This Instrument Handle must be used when calling subsequent 2461 driver functions to allow those functions to utilize the communication channel that was established by the ri2461_init function.

			***** Note *****
Note that repeatedly calling the ri2461_init function with the same Instrument Descriptor will return unique Instrument Handles to the same instrument.  Doing this may cause unpredictable results since one session may affect another.

The ri2461_close function is used to close a communication channel that has previously been established via the ri2461_init function.  It is important that the user close the instrument sessions when all communications are complete since memory resources are being locked by that session.  Failure to close old unused sessions may result in unpredictable behaviour as more sessions are opened since memory resources may become scarce.  This is particularly important during the development process since errors may be made by the user that necessitate the need to re-establish communications to an instrument.  If there is any doubt, the user should call the close function to ensure that the channel is closed.

In addition to the two functions noted above, there is another function which the user may find useful.  This is the ri2461_error_message function.
The ri2461_error_message function will take the error return code from any of the 2461 driver functions and will provide a text string that describes the error.  This is useful since the meanings of the error codes that are listed in the VISA specification as well as the error codes that are specific to the 2461 instrument drivers may not be immediately available to the user.


			RACAL INSTRUMENTS LIMITED. PROGRAM LICENCE AGREEMENT

This is a legal agreement between you (either an individual or an entity) and Racal Instruments Limited. (Racal Instruments).
By using the Program provided on this disk, you agree to be bound by the terms of this Agreement.
If you do not agree to the terms of this Agreement, promptly remove all installed copies of the Program and return the installation disks to Racal Instruments.  The Program (including any images or text incorporated into the Program) and documentation on this installation disk are owned by Racal Instruments and must be treated as any other copyrighted material.  You are permitted to use this Program and have a royalty-free right to produce and distribute executable files created using this Program.  You are also permitted to modify the source files for your own use, as well as for re-distribution.  Also, when you (or any other party) modify and/or re-distribute the Program as permitted herein, Racal Instruments wishes to make certain all recipients of the modified Program understand that they will not be receiving the original version, so that any problems introduced by others will not reflect on Racal Instruments' reputation.

			Licence

You are granted a non-exclusive licence to use, copy, distribute and/or modify the Program.  Title and ownership of the original Program remains in Racal Instruments or its suppliers.  When copying the program in its original form, you agree to respect and not remove or conceal from view any copyright, trademark or confidentiality notices appearing on the Program, and to reproduce any such copyright, trademark or confidentiality notices on all copies of the Program or any portion thereof made by you as permitted hereunder and on all portions contained in or merged into other programs.

To the extent that Racal Instruments or its authorized suppliers provide to you after delivery of the Program any improvements or new releases for the Program, such improvements and new releases shall be subject to the terms and conditions of this Agreement, unless otherwise provided for under a separate agreement.

			Term

This licence is effective until terminated.  You may terminate it at any time by destroying the Program and documentation with all copies, modifications and merged portions in any form.  It will also terminate upon conditions set forth elsewhere in this Agreement if you fail to comply with any term or condition of this Agreement.
You agree upon such termination to destroy the Program and documentation together with all copies and merged portions in any form.

			NO WARRANTY

BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING, RACAL INSTRUMENTS PROVIDES THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. RACAL INSTRUMENTS DOES NOT WARRANT THAT THE FUNCTIONS CONTAINED IN THE PROGRAM WILL MEET YOUR REQUIREMENTS OR THAT THE OPERATION OF THE PROGRAM WILL BE UNINTERRUPTED OR ERROR FREE.  RACAL INSTRUMENTS AND/OR ITS SUPPLIERS ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY UNDER THIS AGREEMENT IS THAT RACAL INSTRUMENTS SHALL REPLACE ANY DISKETTE FAILING TO PERFORM SOLELY DUE TO DEFECTIVE MEDIA.

SOME U.S.A. STATES DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO THE ABOVE EXCLUSION MAY NOT APPLY TO YOU.
THIS WARRANTY GIVES YOU SPECIFIC LEGAL RIGHTS, AND YOU MAY ALSO HAVE OTHER RIGHTS WHICH VARY FROM STATE TO STATE.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAY OR AGREED TO IN WRITING WILL RACAL INSTRUMENTS OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IN SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

SOME U.S.A. STATES DO NOT ALLOW THE LIMITATION OR EXCLUSION OF LIABILITY FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES SO THE ABOVE LIMITATION OR EXCLUSION MAY NOT APPLY TO YOU.

This Agreement will be governed by the internal laws of the State of California.

YOU ACKNOWLEDGE THAT YOU HAVE READ THIS AGREEMENT, UNDERSTAND IT AND AGREE TO BE BOUND BY ITS TERMS AND CONDITIONS.
YOU FURTHER AGREE THAT IT IS THE COMPLETE AND EXCLUSIVE STATEMENT OF THE AGREEMENT BETWEEN YOU AND RACAL INSTRUMENTS (US) WHICHSUPERSEDES ANY PROPOSAL, PRIOR OR CONTEMPORANEOUS AGREEMENT, ORAL OR WRITTEN, AND ANY OTHER COMMUNICATIONS BETWEEN US RELATING TO THE SUBJECT MATTER OF THIS AGREEMENT.

			APPENDIX

How to Comply With These Terms if You Modify the Program:

IF YOU PROCEED TO MODIFY THE PROGRAM, AS THE AUTHOR OF THE MODIFIED VERSION, YOU ARE REQUIRED TO AFFIX AN APPROPRIATE "COPYRIGHT" NOTICE IDENTIFYING YOU AS THE AUTHOR OF THE REVISED PROGRAM, AND CONVEY THE EXCLUSION OF WARRANTY TERMS  TO EACH RECIPIENT.
IF THERE IS ANY QUESTION AS TO THE FORM OR PLACEMENT OF THE REQUIRED NOTICE, PLEASE CONTACT RACAL INSTRUMENTS AT THE ADDRESS RECITED ABOVE.
