Chip 1997 September

home *** CD-ROM | disk | FTP | other *** search

/ Chip 1997 September / CHIP_CD_1997_09_PL.iso / software / testsoft / labwind / demo.6 / main / instr / fl45.doc < prev next >

Wrap

Text File | 1996-08-02 | 77.7 KB | 2,135 lines

Fluke 45 Digital Multimeter (VISA I/O) ________________________________________________________________________________ Introduction: This instrument driver provides programming support for Fluke 45 Digital Multimeter (VISA I/O). It contains functions for opening, configuring, taking measurements from, and closing the instrument. ________________________________________________________________________________ Assumptions: To successfully use this module, the following conditions must be met: - the instrument is connected to the GPIB. - the GPIB address supplied to the initialize function must match the GPIB address of the instrument. ________________________________________________________________________________ Error Codes: Error codes are returned as the return value of each instrument driver function. A program should examine this value after each call to an instrument driver function to determine if any error occurred. Possible error codes and their meanings are listed with the corresponding instrument driver function. ________________________________________________________________________________ How To Use This Document: This document is intended to be used as a programming reference manual. It describes each function in the Fluke 45 Digital Multimeter (VISA I/O) instrument. The functions are listed in alphabetical order with a description of the function, C syntax of the function, a description of each parameter, and possible error codes. ________________________________________________________________________________ Function Tree Layout: Fluke 45 Digital Multimeter (VISA I/O) Function Name: Initialize fl45_init Application Functions Set Up & Read Measurements fl45_applicReadMeas Configuration Functions Configure Measurements fl45_configMeas Configure Range fl45_configRange Configure Trigger fl45_configTrig Configure Modifiers Config Compare fl45_configCompare Config Hold fl45_configHold Config Decibel fl45_configDecibel Config Relative fl45_configRelative Config Min/Max fl45_configMinMax Action/Status Functions Trigger Measurement fl45_trigger Data Functions Read Primary Display fl45_measPrimDisp Read Secondary Display fl45_measSecDisp Display Compare Results fl45_measCompare Utility Functions Write To Instrument fl45_writeInstrData Read Instrument Data fl45_readInstrData Reset fl45_reset Self-Test fl45_selfTest Error-Query fl45_errorQuery Error Message fl45_errorMessage Revision Query fl45_revisionQuery Close fl45_close ________________________________________________________________________________ Fluke 45 Digital Multimeter (VISA I/O) This instrument module provides programming support for the Fluke 45 Digital Multimeter. The module is divided into the following functions: Functions/Classes: (1) Initialize: This function initializes the instrument and sets it to a default configuration. (2) Application Functions: (Class) This class contains high-level, test and measurement routines. These examples call other instrument driver functions to configure, and read from the instrument. (3) Configuration Functions: (Class) This class of functions configures the instrument by setting the measurement function, autorange, rate, trigger and sensitivity of the primary display, and the measurement function of the secondary display. (4) Action/Status Functions: (Class) This class of functions begins an acquisition by the generation of an external 'software' trigger. (5) Data Functions: (Class) This class of functions transfers data from the instrument by taking a reading from the corresponding display. (6) Utility Functions: (Class) This class of functions provides lower level functions to communicate with the instrument, and change instrument parameters. (7) Close: This function takes the instrument offline. ________________________________________________________________________________ The following functions are in alphabetical order. ________________________________________________________________________________ fl45_applicReadMeas ViStatus fl45_applicReadMeas (ViSession instrumentHandle, ViBoolean readOnly, ViInt16 setPrimaryDisplay, ViInt16 setSecondaryDisplay, ViReal64 *primaryDisplayValue, ViReal64 *secondaryDisplayValue); Purpose This function sets the measurement functions of the primary and secondary displays, and reads their current values. This function does not perform any configuration of the triggering or range settings, nor does it configure any of the measurement modifiers. Notes: (1) If the Secondary Display is OFF, then this function does not attempt to read from that display or update the value of that variable. (2) The secondary display must be set to "7 - Clear" if "1 or 8 - AC + DC" (Current or Volts) is selected in the primary display. Parameter List instrumentHandle Variable Type ViSession This control accepts the Instrument Handle returned by the Initialize function to select the desired instrument driver session. Default Value: None readOnly Variable Type ViBoolean This control determines whether the function will both set and read the primary and secondary displays of the instrument or just read the current value of the displays. Valid Range: VI_OFF (0) - Set and Read (Default Value) VI_ON (1) - Read Only setPrimaryDisplay Variable Type ViInt16 Specifies the measurement function of the Primary Display. See NOTE below. Valid Range: 0 - AC Current 1 - AC + DC rms Current 2 - DC Current 3 - Continuity 4 - Diode 5 - Frequency 6 - Ohms 7 - AC Volts 8 - AC + DC rms Volts 9 - DC Volts (Default Value) Notes: (1) When the Primary Display is executed, the Secondary Display is cleared, and set to the value of the Secondary Display Control. The Default for the Secondary Display is "Clear". setSecondaryDisplay Variable Type ViInt16 Specifies the measurement function of the Secondary Display. See NOTES below. Valid Range: 0 - AC Current 1 - DC Current 2 - Diode 3 - Frequency 4 - Ohms 5 - AC Volts 6 - DC Volts 7 - Clear Measurement (Default Value) Notes: (1) When the Primary Display is executed, the Secondary Display is cleared and set to the current value of this Control. (2) The secondary display must be set to "7 - Clear" if "1 or 8 - AC + DC" (Current or Volts) is selected in the primary display. primaryDisplayValue Variable Type ViReal64 (passed by reference) This control displays the most recent measurement read from the primary display. secondaryDisplayValue Variable Type ViReal64 (passed by reference) This control displays the most recent measurement read from the Secondary display. Return Value This control contains the status code returned by the function call. Status Codes: Status Description ------------------------------------------------- 0 No error (the call was successful). 3FFF0005 The specified termination character was read. 3FFF0006 The specified number of bytes was read. BFFC0002 Parameter 2 (Read Only) out of range. BFFC0003 Parameter 3 (Set Primary Display) out of range. BFFC0004 Parameter 4 (Set Secondary Display) out of range. BFFF0000 Miscellaneous or system error occurred. BFFF000E Invalid session handle. BFFF0015 Timeout occurred before operation could complete. BFFF0034 Violation of raw write protocol occurred. BFFF0035 Violation of raw read protocol occurred. BFFF0036 Device reported an output protocol error. BFFF0037 Device reported an input protocol error. BFFF0038 Bus error occurred during transfer. BFFF003A Invalid setup (attributes are not consistent). BFFF005F No listeners condition was detected. BFFF0060 This interface is not the controller in charge. BFFF0067 Operation is not supported on this session. BFFF0900 Instrument Status Error BFFF0901 Instrument Configuration Error BFFF0902 Instrument Range Configuration Error ________________________________________________________________________________ fl45_close ViStatus fl45_close (ViSession instrumentHandle); Purpose This function performs the following operations: viClose (instrSession) and viClose (rmSession). Notes: (1) The instrument must be reinitialized to use it again. Parameter List instrumentHandle Variable Type ViSession This control accepts the Instrument Handle returned by the Initialize function to select the desired instrument driver session. Default Value: None Return Value This control contains the status code returned by the function call. Status Codes: Status Description ------------------------------------------------- 0 No error (the call was successful). 3FFF0005 The specified termination character was read. 3FFF0006 The specified number of bytes was read. BFFF0000 Miscellaneous or system error occurred. BFFF000E Invalid session handle. BFFF0015 Timeout occurred before operation could complete. BFFF0034 Violation of raw write protocol occurred. BFFF0035 Violation of raw read protocol occurred. BFFF0036 Device reported an output protocol error. BFFF0037 Device reported an input protocol error. BFFF0038 Bus error occurred during transfer. BFFF003A Invalid setup (attributes are not consistent). BFFF005F No listeners condition was detected. BFFF0060 This interface is not the controller in charge. BFFF0067 Operation is not supported on this session. ________________________________________________________________________________ fl45_configCompare ViStatus fl45_configCompare (ViSession instrumentHandle, ViBoolean compare, ViReal64 compareLow, ViReal64 compareHi); Purpose This function enables or disables the compare function and allows high and low values to be specified. When executed, the Hold modifier is also activated. The result can be seen in the Compare Display function. Parameter List instrumentHandle Variable Type ViSession This control accepts the Instrument Handle returned by the Initialize function to select the desired instrument driver session. Default Value: None compare Variable Type ViBoolean This control enters the compare modifier. 'Touch Hold' is automatically turned on. (Touch Hold can be turned off afterwards by executing the Hold panel with Hold set to off). The Compare Display function displays the outcome. Valid Range: VI_OFF (0) - Off VI_ON (1) - On (Default) compareLow Variable Type ViReal64 This control sets the compare low value. Valid Range: -2.0e7 to 2.0e7 Default Value: 0.0 compareHi Variable Type ViReal64 This control sets the compare hi value. Valid Range: -2.0e7 to 2.0e7 Default Value: 0.0 Return Value This control contains the status code returned by the function call. Status Codes: Status Description ------------------------------------------------- 0 No error (the call was successful). 3FFF0005 The specified termination character was read. 3FFF0006 The specified number of bytes was read. BFFC0002 Parameter 2 (Compare) out of range. BFFC0003 Parameter 3 (Compare Low) out of range. BFFC0004 Parameter 4 (Compare High) out of range. BFFF0000 Miscellaneous or system error occurred. BFFF000E Invalid session handle. BFFF0015 Timeout occurred before operation could complete. BFFF0034 Violation of raw write protocol occurred. BFFF0035 Violation of raw read protocol occurred. BFFF0036 Device reported an output protocol error. BFFF0037 Device reported an input protocol error. BFFF0038 Bus error occurred during transfer. BFFF003A Invalid setup (attributes are not consistent). BFFF005F No listeners condition was detected. BFFF0060 This interface is not the controller in charge. BFFF0067 Operation is not supported on this session. ________________________________________________________________________________ fl45_configDecibel ViStatus fl45_configDecibel (ViSession instrumentHandle, ViInt16 decibel, ViInt16 referenceImpedanceohms); Purpose This function enables or disables dBm or dB power, and allows a dB reference impedance to be specified. The dB function must be configured appropriately. For dB power, the dB reference impedance must be set less than or equal to 16 ohms. For dB, the measurement function must be set to voltage. Parameter List instrumentHandle Variable Type ViSession This control accepts the Instrument Handle returned by the Initialize function to select the desired instrument driver session. Default Value: None decibel Variable Type ViInt16 This control switches the primary channel from normal to dBm or dB power modifiers. See NOTES Valid Range: 0 - Off (Default Value) 1 - dBm 2 - dB power NOTES: (1) The dB modifier can only be activated when the measurement function is in Volts. (2) The dB Power modifier requires the reference impedance not exceed 16 ohms. referenceImpedanceohms Variable Type ViInt16 This control sets the reference impedance to one of twenty-one discrete values in the range 2 to 8000 ohms. Valid Range: 1 - 2 ohms 2 - 4 3 - 8 4 - 16 (Default Value) 5 - 50 6 - 75 7 - 93 8 - 110 9 - 124 10 - 125 11 - 135 12 - 150 13 - 250 14 - 300 15 - 500 16 - 600 17 - 800 18 - 900 19 - 1000 20 - 1200 21 - 8000 Return Value This control contains the status code returned by the function call. Status Codes: Status Description ------------------------------------------------- 0 No error (the call was successful). 3FFF0005 The specified termination character was read. 3FFF0006 The specified number of bytes was read. BFFC0002 Parameter 2 (Decibel) out of range. BFFC0003 Parameter 3 (Reference Impedance) out of range. BFFF0000 Miscellaneous or system error occurred. BFFF000E Invalid session handle. BFFF0015 Timeout occurred before operation could complete. BFFF0034 Violation of raw write protocol occurred. BFFF0035 Violation of raw read protocol occurred. BFFF0036 Device reported an output protocol error. BFFF0037 Device reported an input protocol error. BFFF0038 Bus error occurred during transfer. BFFF003A Invalid setup (attributes are not consistent). BFFF005F No listeners condition was detected. BFFF0060 This interface is not the controller in charge. BFFF0067 Operation is not supported on this session. ________________________________________________________________________________ fl45_configHold ViStatus fl45_configHold (ViSession instrumentHandle, ViBoolean hold, ViInt16 holdThreshold); Purpose This function enables or disables the hold function, and allows a hold threshold to be specified. WARNING: If the instrument has the hold modifier and an external trigger mode activated; two sequential triggers may cause the instrument to lock up. If this occurs, it may be necessary to clear the instrument by turning it off and on and then reinitializing it. Notes: (1) The Hold function holds the next triggered value. Therefore, if an external trigger is specified, a trigger must be performed to display a value. Parameter List instrumentHandle Variable Type ViSession This control accepts the Instrument Handle returned by the Initialize function to select the desired instrument driver session. Default Value: None hold Variable Type ViBoolean This control enables or disables the Touch Hold modifier. Valid Range: VI_OFF (0) - Off VI_ON (1) - On (Default) holdThreshold Variable Type ViInt16 This control sets the hold measurement threshold. Valid Range: 1 - Very Stable 2 - Stable (Default Value) 3 - Noisy Return Value This control contains the status code returned by the function call. Status Codes: Status Description ------------------------------------------------- 0 No error (the call was successful). 3FFF0005 The specified termination character was read. 3FFF0006 The specified number of bytes was read. BFFC0002 Parameter 2 (Hold) out of range. BFFC0003 Parameter 3 (Hold Threshold) out of range. BFFF0000 Miscellaneous or system error occurred. BFFF000E Invalid session handle. BFFF0015 Timeout occurred before operation could complete. BFFF0034 Violation of raw write protocol occurred. BFFF0035 Violation of raw read protocol occurred. BFFF0036 Device reported an output protocol error. BFFF0037 Device reported an input protocol error. BFFF0038 Bus error occurred during transfer. BFFF003A Invalid setup (attributes are not consistent). BFFF005F No listeners condition was detected. BFFF0060 This interface is not the controller in charge. BFFF0067 Operation is not supported on this session. ________________________________________________________________________________ fl45_configMeas ViStatus fl45_configMeas (ViSession instrumentHandle, ViInt16 primaryDisplay, ViInt16 secondaryDisplay); Purpose This function sets the measurement functions of the primary and secondary displays. Notes: (1) When changing the measurement function of the primary display, a delay may be required before executing a modifier to give the instrument time to settle; otherwise the instrument may return a 300 error code. (2) The secondary display must be set to "7 - Clear" if "1 or 8 - AC + DC" (Current or Volts) is selected in the primary display. Parameter List instrumentHandle Variable Type ViSession This control accepts the Instrument Handle returned by the Initialize function to select the desired instrument driver session. Default Value: None primaryDisplay Variable Type ViInt16 Specifies the measurement function of the Primary Display. See NOTE below. Valid Range: 0 - AC Current 1 - AC + DC rms Current 2 - DC Current 3 - Continuity 4 - Diode 5 - Frequency 6 - Ohms 7 - AC Volts 8 - AC + DC rms Volts 9 - DC Volts (Default Value) Notes: (1) When the Primary Display is executed, the Secondary Display is cleared, and set to the value of the Secondary Display Control. The Default for the secondary display is "Clear". secondaryDisplay Variable Type ViInt16 Specifies the measurement function of the Secondary Display. See NOTES below. Valid Range: 0 - AC Current 1 - DC Current 2 - Diode 3 - Frequency 4 - Ohms 5 - AC Volts 6 - DC Volts 7 - Clear Measurement (Default Value) Notes: (1) When the Primary Display is executed, the Secondary Display is cleared and set to the current value of this Control. (2) The secondary display must be set to "7 - Clear" if "1 or 8 - AC + DC" (Current or Volts) is selected in the primary display. Return Value This control contains the status code returned by the function call. Status Codes: Status Description ------------------------------------------------- 0 No error (the call was successful). 3FFF0005 The specified termination character was read. 3FFF0006 The specified number of bytes was read. BFFC0002 Parameter 2 (Primary Display) out of range. BFFC0003 Parameter 3 (Secondary Display) out of range. BFFF0000 Miscellaneous or system error occurred. BFFF000E Invalid session handle. BFFF0015 Timeout occurred before operation could complete. BFFF0034 Violation of raw write protocol occurred. BFFF0035 Violation of raw read protocol occurred. BFFF0036 Device reported an output protocol error. BFFF0037 Device reported an input protocol error. BFFF0038 Bus error occurred during transfer. BFFF003A Invalid setup (attributes are not consistent). BFFF005F No listeners condition was detected. BFFF0060 This interface is not the controller in charge. BFFF0067 Operation is not supported on this session. BFFF0900 Instrument Status Error BFFF0901 Instrument Configuration Error BFFF0902 Instrument Range Configuration Error ________________________________________________________________________________ fl45_configMinMax ViStatus fl45_configMinMax (ViSession instrumentHandle, ViInt16 minMax, ViReal64 minSet, ViReal64 maxSet); Purpose This function allows the Min and Max modifiers to be enabled or disabled and also allows the min and max values to be initialized. Parameter List instrumentHandle Variable Type ViSession This control accepts the Instrument Handle returned by the Initialize function to select the desired instrument driver session. Default Value: None minMax Variable Type ViInt16 This control enters the Min/Max modifier. When Min On is selected, the present reading becomes the minimum value. When Min Set is selected, a minimum value can be specified. When Max On is selected, the present reading becomes the maximum value. Max Set allows a maximum value to be specified. Since autorange is disabled, the correct range should be selected prior to using this control. Valid Range: 0 - Off (Default Value) 1 - Min On 2 - Min Set 3 - Max On 4 - Max Set minSet Variable Type ViReal64 This control allows a minimum value to be input upon entering the Min/Max modifier. Autorange is disabled, so the input number must be appropriate for the range selected. Valid Range: Min Set must be within the measurement range. Default Value: 0.0 maxSet Variable Type ViReal64 This control allows a maximum value to be input upon entering the Min/Max modifier. Autorange is disabled, so the input number must be appropriate for the range selected. Valid Range: Max Set must be within the measurement range. Default Value: 0.0 Return Value This control contains the status code returned by the function call. Status Codes: Status Description ------------------------------------------------- 0 No error (the call was successful). 3FFF0005 The specified termination character was read. 3FFF0006 The specified number of bytes was read. BFFC0002 Parameter 2 (Min Max) out of range. BFFC0003 Parameter 3 (Min Set) out of range. BFFC0004 Parameter 4 (Max Set) out of range. BFFF0000 Miscellaneous or system error occurred. BFFF000E Invalid session handle. BFFF0015 Timeout occurred before operation could complete. BFFF0034 Violation of raw write protocol occurred. BFFF0035 Violation of raw read protocol occurred. BFFF0036 Device reported an output protocol error. BFFF0037 Device reported an input protocol error. BFFF0038 Bus error occurred during transfer. BFFF003A Invalid setup (attributes are not consistent). BFFF005F No listeners condition was detected. BFFF0060 This interface is not the controller in charge. BFFF0067 Operation is not supported on this session. ________________________________________________________________________________ fl45_configRange ViStatus fl45_configRange (ViSession instrumentHandle, ViBoolean range, ViInt16 sensitivity); Purpose This function sets the autorange or sensitivity (if autorange is off) of the primary display. The Primary Display must be configured appropriately; for autorange, the measurement function must be set to current, frequency, ohms or voltage, also the Relative, Min/Max or Decibel modifiers cannot be in use. Parameter List instrumentHandle Variable Type ViSession This control accepts the Instrument Handle returned by the Initialize function to select the desired instrument driver session. Default Value: None range Variable Type ViBoolean This control switches the primary channel from auto to fixed (manual) ranging. See NOTE below. Valid Range: VI_OFF (0) - Fixed VI_ON (1) - Auto (Default Value) Notes: (1) The Primary Display must be configured appropriately. For autorange, the function must be set to current, frequency, ohms or voltage. Also, the Relative, Min/Max or Decibel modifiers cannot be in use. sensitivity Variable Type ViInt16 This control specifies the measurement range of the primary channel of the meter, if autorange is off. Not all ranges are available for all of the functions. Valid Range: Range is dependent on the function and triggering rate selected. See tables below. Default Value: 8 - * Valid ranges at fast & medium measurement rates: Valid Range | Volts | Ohms | Amps | Frequency ----------------------------------------------------- 1 | 300 mV | 300 Ohm | 30 mA | 1000 Hz 2 | 3 V | 3 kOhm | 100 mA | 10 kHz 3 | 30 V | 30 kOhm | 10 A | 100 kHz 4 | 300 V | 300 kOhm | error | 1000 kHz 5 | 1000 V | 3 MOhm | error | 1 MHz 6 | error | 30 MOhm | error | error 7 | error | 300 MOhm | error | error * | if exiting from autorange, the present range becomes the selected range. Valid ranges at slow measurement rates: Valid Range | Volts | Ohms | Amps | Frequency ------------------------------------------------------- 1 | 100 mV | 100 Ohm | 10 mA | 1000 Hz 2 | 1000 mV | 1000 Ohm | 100 mA | 10 kHz 3 | 10 V | 10 kOhm | 10 A | 100 kHz 4 | 100 V | 100 kOhm | error | 1000 kHz 5 | 1000 V | 1000 kOhm | error | 1 MHz 6 | error | 10 MOhm | error | error 7 | error | 100 MOhm | error | error * | if exiting from autorange, the present range becomes the selected range. Return Value This control contains the status code returned by the function call. Status Codes: Status Description ------------------------------------------------- 0 No error (the call was successful). 3FFF0005 The specified termination character was read. 3FFF0006 The specified number of bytes was read. BFFC0002 Parameter 2 (Range) out of range. BFFC0003 Parameter 3 (Sensitivity) out of range. BFFF0000 Miscellaneous or system error occurred. BFFF000E Invalid session handle. BFFF0015 Timeout occurred before operation could complete. BFFF0034 Violation of raw write protocol occurred. BFFF0035 Violation of raw read protocol occurred. BFFF0036 Device reported an output protocol error. BFFF0037 Device reported an input protocol error. BFFF0038 Bus error occurred during transfer. BFFF003A Invalid setup (attributes are not consistent). BFFF005F No listeners condition was detected. BFFF0060 This interface is not the controller in charge. BFFF0067 Operation is not supported on this session. BFFF0900 Instrument Status Error BFFF0901 Instrument Configuration Error BFFF0902 Instrument Range Configuration Error ________________________________________________________________________________ fl45_configRelative ViStatus fl45_configRelative (ViSession instrumentHandle, ViInt16 relative, ViReal64 baseSet); Purpose This function enables or disables the relative modifier. Allows a relative setting to be specified. Parameter List instrumentHandle Variable Type ViSession This control accepts the Instrument Handle returned by the Initialize function to select the desired instrument driver session. Default Value: None relative Variable Type ViInt16 This control enters the relative modifier. If Base is selected, the value shown on the primary display becomes the relative base. If Base Set is selected, a relative base can be input. Since autorange is disabled, the number that is input must be within the selected sensitivity range. Valid Range: 0 - Off (Default Value) 1 - Base 2 - Base Set baseSet Variable Type ViReal64 This control allows a relative base to be input. The reading on the primary display is the difference between the base and an input measurement. For example, if the relative base is 15.000 Volts, and the present reading is 14.100 Volts, the display will show -0.900 Autorange is disabled, so the input number must be appropriate for the range selected. Valid Range: Base Set must be within the measurement range. Default Value: 0.0 Return Value This control contains the status code returned by the function call. Status Codes: Status Description ------------------------------------------------- 0 No error (the call was successful). 3FFF0005 The specified termination character was read. 3FFF0006 The specified number of bytes was read. BFFC0002 Parameter 2 (Relative) out of range. BFFC0003 Parameter 3 (Base Set) out of range. BFFF0000 Miscellaneous or system error occurred. BFFF000E Invalid session handle. BFFF0015 Timeout occurred before operation could complete. BFFF0034 Violation of raw write protocol occurred. BFFF0035 Violation of raw read protocol occurred. BFFF0036 Device reported an output protocol error. BFFF0037 Device reported an input protocol error. BFFF0038 Bus error occurred during transfer. BFFF003A Invalid setup (attributes are not consistent). BFFF005F No listeners condition was detected. BFFF0060 This interface is not the controller in charge. BFFF0067 Operation is not supported on this session. ________________________________________________________________________________ fl45_configTrig ViStatus fl45_configTrig (ViSession instrumentHandle, ViInt16 trigger, ViInt16 rate); Purpose This function sets the trigger mode and rate. WARNING: If the instrument has the hold modifier and external trigger mode activated, two sequential triggers may cause the instrument to lock up. If the instrument locks up, it may be necessary to reboot the instrument. Parameter List instrumentHandle Variable Type ViSession This control accepts the Instrument Handle returned by the Initialize function to select the desired instrument driver session. Default Value: None trigger Variable Type ViInt16 This control sets the trigger configuration. See NOTE: Valid Range: 1 (Internal) - (Default) 2 (External) 3 (External) 4 (External) 5 (External) See table below. Type Trig Rear Trig Settling Delay ---------------------------------------------- 1 Internal Disabled - 2 External Disabled Off 3 External Disabled On 4 External Enabled Off 5 External Enabled On Notes: (1) A Trigger can be supplied to all the external triggers through the Trigger function, or pressing the 'down arrow' on the front panel of the instrument. Triggers 4 or 5 can also be trigged with a pulse applied to the RS-232 connector (pins 2 and 4). If an external trigger is selected, a trigger must be applied for a measurement to be available. rate Variable Type ViInt16 This control sets the sampling rate of the meter. Valid Range: 0 - Slow 1 - Medium (Default) 2 - Fast Return Value This control contains the status code returned by the function call. Status Codes: Status Description ------------------------------------------------- 0 No error (the call was successful). 3FFF0005 The specified termination character was read. 3FFF0006 The specified number of bytes was read. BFFC0002 Parameter 2 (Trigger) out of range. BFFC0003 Parameter 3 (Rate) out of range. BFFF0000 Miscellaneous or system error occurred. BFFF000E Invalid session handle. BFFF0015 Timeout occurred before operation could complete. BFFF0034 Violation of raw write protocol occurred. BFFF0035 Violation of raw read protocol occurred. BFFF0036 Device reported an output protocol error. BFFF0037 Device reported an input protocol error. BFFF0038 Bus error occurred during transfer. BFFF003A Invalid setup (attributes are not consistent). BFFF005F No listeners condition was detected. BFFF0060 This interface is not the controller in charge. BFFF0067 Operation is not supported on this session. BFFF0900 Instrument Status Error BFFF0901 Instrument Configuration Error ________________________________________________________________________________ fl45_errorMessage ViStatus fl45_errorMessage (ViSession instrumentHandle, ViStatus errorCode, ViChar errorMessage[]); Purpose This function takes the Status Code returned by the instrument driver functions, interprets it and returns it as a user readable string. Parameter List instrumentHandle Variable Type ViSession This control accepts the Instrument Handle returned by the Initialize function to select the desired instrument driver session. Default Value: VI_NULL errorCode Variable Type ViStatus This control accepts the Status Code returned from the instrument driver functions. Default Value: 0 - VI_SUCCESS errorMessage Variable Type ViChar[] This control returns the interpreted Status Code as a user readable message string. Notes: (1) The array must be contain at least 256 elements ViChar[256]. Return Value This control contains the status code returned by the function call. Status Codes: Status Description ------------------------------------------------- 0 No error (the call was successful). 3FFF0005 The specified termination character was read. 3FFF0006 The specified number of bytes was read. BFFF0000 Miscellaneous or system error occurred. BFFF000E Invalid session handle. BFFF0015 Timeout occurred before operation could complete. BFFF0034 Violation of raw write protocol occurred. BFFF0035 Violation of raw read protocol occurred. BFFF0036 Device reported an output protocol error. BFFF0037 Device reported an input protocol error. BFFF0038 Bus error occurred during transfer. BFFF003A Invalid setup (attributes are not consistent). BFFF005F No listeners condition was detected. BFFF0060 This interface is not the controller in charge. BFFF0067 Operation is not supported on this session. ________________________________________________________________________________ fl45_errorQuery ViStatus fl45_errorQuery (ViSession instrumentHandle, ViInt32 *errorCode, ViChar errorMessage[]); Purpose This function reads an error code from the instrument's error queue. Notes: (1) This instrument does not support an Error Query, so this function returns the Warning Code 0x3FFC0104 - VI_WARN_NSUP_ERROR_QUERY Parameter List instrumentHandle Variable Type ViSession This control accepts the Instrument Handle returned by the Initialize function to select the desired instrument driver session. Default Value: None errorCode Variable Type ViInt32 (passed by reference) This control returns the error code read from the instrument's error queue. errorMessage Variable Type ViChar[] This control returns the error message string read from the instrument's error message queue. Notes: (1) The array must be contain at least 256 elements ViChar[256]. Return Value This control contains the status code returned by the function call. Status Codes: Status Description ------------------------------------------------- 0 No error (the call was successful). 3FFC0104 Error Query not supported - VI_WARN_NSUP_ERROR_QUERY 3FFF0005 The specified termination character was read. 3FFF0006 The specified number of bytes was read. BFFF0000 Miscellaneous or system error occurred. BFFF000E Invalid session handle. BFFF0015 Timeout occurred before operation could complete. BFFF0034 Violation of raw write protocol occurred. BFFF0035 Violation of raw read protocol occurred. BFFF0036 Device reported an output protocol error. BFFF0037 Device reported an input protocol error. BFFF0038 Bus error occurred during transfer. BFFF003A Invalid setup (attributes are not consistent). BFFF005F No listeners condition was detected. BFFF0060 This interface is not the controller in charge. BFFF0067 Operation is not supported on this session. ________________________________________________________________________________ fl45_init ViStatus fl45_init (ViRsrc resourceName, ViBoolean IDQuery, ViBoolean resetDevice, ViSession *instrumentHandle); Purpose This function performs the following initialization actions: - Opens a session to the Default Resource Manager resource and a session to the specified device using the interface and address specified in the Resource_Name control. - Performs an identification query on the Instrument. - Resets the instrument to a known state. - Sends initialization commands to the instrument that set any necessary programmatic variables such as Headers Off, Short Command form, and Data Transfer Binary to the state necessary for the operation of the instrument driver. - Returns an Instrument Handle which is used to differentiate between different sessions of this instrument driver. - Each time this function is invoked a Unique Session is opened. It is possible to have more than one session open for the same resource. Parameter List resourceName Variable Type ViRsrc This control specifies the interface and address of the device that is to be initialized (Instrument Descriptor). The exact grammar to be used in this control is shown in the note below. Default Value: "GPIB::1" NOTE: Based on the Instrument Descriptor, this operation establishes a communication session with a device. The grammar for the Instrument Descriptor is shown below. Optional parameters are shown in square brackets ([]). Interface Grammar ------------------------------------------------------ GPIB GPIB[board]::primary address[::secondary address] [::INSTR] The GPIB keyword is used with GPIB instruments. The default value for optional parameters are shown below. Optional Parameter Default Value ----------------------------------------- board 0 secondary address none - 31 IDQuery Variable Type ViBoolean This control specifies if an ID Query is sent to the instrument during the initialization procedure. Valid Range: VI_OFF (0) - Skip Query VI_ON (1) - Do Query (Default Value) Notes: (1) Under normal circumstances the ID Query ensures that the instrument initialized is the type supported by this driver. However circumstances may arise where it is undesirable to send an ID Query to the instrument. In those cases; set this control to "Skip Query" and this function will initialize the selected interface, without doing an ID Query. resetDevice Variable Type ViBoolean This control specifies if the instrument is to be reset to its power-on settings during the initialization procedure. Valid Range: VI_OFF (0) - Don't Reset VI_ON (1) - Reset Device (Default Value) Notes: (1) If you do not want the instrument reset. Set this control to "Don't Reset" while initializing the instrument. instrumentHandle Variable Type ViSession (passed by reference) This control returns an Instrument Handle that is used in all subsequent function calls to differentiate between different sessions of this instrument driver. Notes: (1) Each time this function is invoked a Unique Session is opened. It is possible to have more than one session open for the same resource. Return Value This control contains the status code returned by the function call. Status Codes: Status Description ------------------------------------------------- 0 No error (the call was successful). 3FFF0005 The specified termination character was read. 3FFF0006 The specified number of bytes was read. BFFC0002 Parameter 2 (ID Query) out of range. BFFC0003 Parameter 3 (Reset Device) out of range. BFFC0011 Instrument returned invalid response to ID Query BFFF0000 Miscellaneous or system error occurred. BFFF000E Invalid session handle. BFFF0015 Timeout occurred before operation could complete. BFFF0034 Violation of raw write protocol occurred. BFFF0035 Violation of raw read protocol occurred. BFFF0036 Device reported an output protocol error. BFFF0037 Device reported an input protocol error. BFFF0038 Bus error occurred during transfer. BFFF003A Invalid setup (attributes are not consistent). BFFF005F No listeners condition was detected. BFFF0060 This interface is not the controller in charge. BFFF0067 Operation is not supported on this session. ________________________________________________________________________________ fl45_measCompare ViStatus fl45_measCompare (ViSession instrumentHandle, ViChar compareOutput[], ViInt16 *integerOutput); Purpose This function displays the results of the compare function in both string and integer form. The Compare Configuration function must be executed prior to calling the Display Compare Results function. Parameter List instrumentHandle Variable Type ViSession This control accepts the Instrument Handle returned by the Initialize function to select the desired instrument driver session. Default Value: None compareOutput Variable Type ViChar[] This control displays the compare modifier in string form. (If the compare modifier is selected). Output | Description ---------------------------------------- HI | Exceeds the range LO | Below the range PASS | Within the range -- | Measurement not completed Notes: (1) For '--' or measurement not complete, the instrument may be waiting for a trigger or has not completed the Compare Configuration function call. integerOutput Variable Type ViInt16 (passed by reference) This control displays the compare modifier in integer form. (If the compare modifier is selected). Output | Description ---------------------------------------- 0 | Within the range 1 | Exceeds the range -1 | Below the range -999 | Measurement not completed Notes: (1) For '-999' or Measurement not complete, the instrument may be waiting for a trigger or has not completed the Compare Configuration function call. Return Value This control contains the status code returned by the function call. Status Codes: Status Description ------------------------------------------------- 0 No error (the call was successful). 3FFF0005 The specified termination character was read. 3FFF0006 The specified number of bytes was read. BFFF0000 Miscellaneous or system error occurred. BFFF000E Invalid session handle. BFFF0015 Timeout occurred before operation could complete. BFFF0034 Violation of raw write protocol occurred. BFFF0035 Violation of raw read protocol occurred. BFFF0036 Device reported an output protocol error. BFFF0037 Device reported an input protocol error. BFFF0038 Bus error occurred during transfer. BFFF003A Invalid setup (attributes are not consistent). BFFF005F No listeners condition was detected. BFFF0060 This interface is not the controller in charge. BFFF0067 Operation is not supported on this session. BFFF0803 Error interpreting the instrument's response BFFF0903 Instrument Compare Configuration Error ________________________________________________________________________________ fl45_measPrimDisp ViStatus fl45_measPrimDisp (ViSession instrumentHandle, ViBoolean output, ViReal64 *primaryDisplay); Purpose This function takes one reading from the instrument's primary display based on the instrument configuration. Parameter List instrumentHandle Variable Type ViSession This control accepts the Instrument Handle returned by the Initialize function to select the desired instrument driver session. Default Value: None output Variable Type ViBoolean This control causes the display to show the current value or the next triggered value. See NOTES Below. Valid Range: VI_OFF (0) - Currently Displayed Value (Default) VI_ON (1) - Next Trigger Notes: (1) This control is not valid for internal triggering. (2) 'Next Trigger' requires either a rear or front panel trigger within the timeout. Because this function will not return until the instrument receives a trigger, a trigger must be provided. primaryDisplay Variable Type ViReal64 (passed by reference) This control displays the most recent measurement read from the primary display. Return Value This control contains the status code returned by the function call. Status Codes: Status Description ------------------------------------------------- 0 No error (the call was successful). 3FFF0005 The specified termination character was read. 3FFF0006 The specified number of bytes was read. BFFC0002 Parameter 2 (Output) out of range. BFFF0000 Miscellaneous or system error occurred. BFFF000E Invalid session handle. BFFF0015 Timeout occurred before operation could complete. BFFF0034 Violation of raw write protocol occurred. BFFF0035 Violation of raw read protocol occurred. BFFF0036 Device reported an output protocol error. BFFF0037 Device reported an input protocol error. BFFF0038 Bus error occurred during transfer. BFFF003A Invalid setup (attributes are not consistent). BFFF005F No listeners condition was detected. BFFF0060 This interface is not the controller in charge. BFFF0067 Operation is not supported on this session. ________________________________________________________________________________ fl45_measSecDisp ViStatus fl45_measSecDisp (ViSession instrumentHandle, ViBoolean output, ViReal64 *secondaryDisplay); Purpose This function takes one reading from the instrument's secondary display based on the instrument configuration. Parameter List instrumentHandle Variable Type ViSession This control accepts the Instrument Handle returned by the Initialize function to select the desired instrument driver session. Default Value: None output Variable Type ViBoolean This control causes the display to show the current value or the next triggered value. See NOTES Below. Valid Range: VI_OFF (0) - Currently Displayed Value (Default) VI_ON (1) - Next Trigger Notes: (1) This control is not valid for internal triggering. (2) 'Next Trigger' requires either a rear or front panel trigger within the timeout. Because this function will not return until the instrument receives a trigger, a trigger must be provided. secondaryDisplay Variable Type ViReal64 (passed by reference) This control displays the most recent measurement read from the Secondary display. Return Value This control contains the status code returned by the function call. Status Codes: Status Description ------------------------------------------------- 0 No error (the call was successful). 3FFF0005 The specified termination character was read. 3FFF0006 The specified number of bytes was read. BFFC0002 Parameter 2 (Output) out of range. BFFF0000 Miscellaneous or system error occurred. BFFF000E Invalid session handle. BFFF0015 Timeout occurred before operation could complete. BFFF0034 Violation of raw write protocol occurred. BFFF0035 Violation of raw read protocol occurred. BFFF0036 Device reported an output protocol error. BFFF0037 Device reported an input protocol error. BFFF0038 Bus error occurred during transfer. BFFF003A Invalid setup (attributes are not consistent). BFFF005F No listeners condition was detected. BFFF0060 This interface is not the controller in charge. BFFF0067 Operation is not supported on this session. ________________________________________________________________________________ fl45_readInstrData ViStatus fl45_readInstrData (ViSession instrumentHandle, ViInt16 numberBytesToRead, ViChar readBuffer[], ViInt32 *numBytesRead); Purpose This function reads data from the instrument's output buffer and returns it to the specified variable in memory. NOTES: (1) Because the instrument may return both numeric and text data in response to queries this function returns the data in string format. (2) If valid data is not available at the instrument's output buffer when this function is called the instrument will hang up and the function will not return until it times out. If the time-out is disabled this function will hang indefinitely and it may be necessary to reboot the computer to break out. Parameter List instrumentHandle Variable Type ViSession This control accepts the Instrument Handle returned by the Initialize function to select the desired instrument driver session. Default Value: None numberBytesToRead Variable Type ViInt16 The number of bytes specified by this control should be greater than or equal to the number of bytes which are to be read from the instrument. If the actual number of bytes to be read is greater than the number this control specifies then multiple reads will be required to empty the instrument's output buffer. If the instrument's output buffer is not emptied the instrument may return invalid data when future reads are performed. Default Value: 50 (See NOTE 2) Notes: (1) If NO DATA is available at the instrument's output buffer when this function is called the instrument will hang up and the function will not return until it times out. If the time-out is disabled, this function will hang indefinitely and it may be necessary to reboot the computer. (2) If the number of bytes expected is greater than 50 the value of this control may be increased. If the actual number of bytes read is larger than the declared size of the read buffer a run-time error will be generated. readBuffer Variable Type ViChar[] The incoming data from the instrument is placed into this variable. Notes: (1) Because the instrument may return both numeric and text data in response to queries this function returns the data in string format. (2) This function does not overwrite any old data left in the string variable from the last time the function was called. String data in LabWindows/CVI is terminated with an ASCII null(0x0) and string manipulation functions will only recognize data before the ASCII null. (3) The declared size of the string variable must be greater than the actual number of bytes read from the instrument if it is not a run-time error will be generated. numBytesRead Variable Type ViInt32 (passed by reference) This variable contains the actual number of bytes read from the instrument. This is the value which is returned by the read function. Notes: (1) If the actual number of bytes read is less than the number of bytes specified in the Number Bytes To Read control then the output buffer has probably been emptied. If the read function fails and the number of bytes read is 0, the most probable cause for the failure is there was no data available at the instrument's output buffer. Return Value This control contains the status code returned by the function call. Status Codes: Status Description ------------------------------------------------- 0 No error (the call was successful). 3FFF0005 The specified termination character was read. 3FFF0006 The specified number of bytes was read. BFFF0000 Miscellaneous or system error occurred. BFFF000E Invalid session handle. BFFF0015 Timeout occurred before operation could complete. BFFF0034 Violation of raw write protocol occurred. BFFF0035 Violation of raw read protocol occurred. BFFF0036 Device reported an output protocol error. BFFF0037 Device reported an input protocol error. BFFF0038 Bus error occurred during transfer. BFFF003A Invalid setup (attributes are not consistent). BFFF005F No listeners condition was detected. BFFF0060 This interface is not the controller in charge. BFFF0067 Operation is not supported on this session. ________________________________________________________________________________ fl45_reset ViStatus fl45_reset (ViSession instrumentHandle); Purpose This function resets the instrument to a known state and sends initialization commands to the instrument that set any necessary programmatic variables such as Headers Off, Short Command form, and Data Transfer Binary to the state necessary for the operation of the instrument driver. Parameter List instrumentHandle Variable Type ViSession This control accepts the Instrument Handle returned by the Initialize function to select the desired instrument driver session. Default Value: None Return Value This control contains the status code returned by the function call. Status Codes: Status Description ------------------------------------------------- 0 No error (the call was successful). 3FFF0005 The specified termination character was read. 3FFF0006 The specified number of bytes was read. BFFF0000 Miscellaneous or system error occurred. BFFF000E Invalid session handle. BFFF0015 Timeout occurred before operation could complete. BFFF0034 Violation of raw write protocol occurred. BFFF0035 Violation of raw read protocol occurred. BFFF0036 Device reported an output protocol error. BFFF0037 Device reported an input protocol error. BFFF0038 Bus error occurred during transfer. BFFF003A Invalid setup (attributes are not consistent). BFFF005F No listeners condition was detected. BFFF0060 This interface is not the controller in charge. BFFF0067 Operation is not supported on this session. ________________________________________________________________________________ fl45_revisionQuery ViStatus fl45_revisionQuery (ViSession instrumentHandle, ViChar instrumentDriverRevision[], ViChar firmwareRevision[]); Purpose This function returns the revision numbers of the instrument driver and instrument firmware, and tells the user what firmware the driver is compatible. This instrument driver's Revision is "Rev 1.0, 9/95, CVI 3.1" and is compatible with Instrument Firmware Revision "1.6 D1.0". Parameter List instrumentHandle Variable Type ViSession This control accepts the Instrument Handle returned by the Initialize function to select the desired instrument driver session. Default Value: None instrumentDriverRevision Variable Type ViChar[] This control returns the Instrument Driver Software Revision. Notes: (1) The array must be contain at least 256 elements ViChar[256]. firmwareRevision Variable Type ViChar[] This control returns the Instrument Firmware Revision. Notes: (1) The array must be contain at least 256 elements ViChar[256]. Return Value This control contains the status code returned by the function call. Status Codes: Status Description ------------------------------------------------- 0 No error (the call was successful). 3FFF0005 The specified termination character was read. 3FFF0006 The specified number of bytes was read. BFFF0000 Miscellaneous or system error occurred. BFFF000E Invalid session handle. BFFF0015 Timeout occurred before operation could complete. BFFF0034 Violation of raw write protocol occurred. BFFF0035 Violation of raw read protocol occurred. BFFF0036 Device reported an output protocol error. BFFF0037 Device reported an input protocol error. BFFF0038 Bus error occurred during transfer. BFFF003A Invalid setup (attributes are not consistent). BFFF005F No listeners condition was detected. BFFF0060 This interface is not the controller in charge. BFFF0067 Operation is not supported on this session. ________________________________________________________________________________ fl45_selfTest ViStatus fl45_selfTest (ViSession instrumentHandle, ViInt16 *selfTestResult, ViChar selfTestMessage[]); Purpose This function runs the instrument's self test routine and returns the test result(s). Parameter List instrumentHandle Variable Type ViSession This control accepts the Instrument Handle returned by the Initialize function to select the desired instrument driver session. Default Value: None selfTestResult Variable Type ViInt16 (passed by reference) This control contains the value returned from the instrument self test. Zero means success. For any other code, see the device's operator's manual. Number | State --------------------------------------- 0 | Passed self test 1 | A/D self test failed 2 | A/D dead 4 | EEPROM instrument configuration | bad 8 | EEPROM calibration data bad 16 | Display dead 32 | Display self-test failed 64 | ROM test failed 128 | External RAM test failed 256 | Internal RAM test failed selfTestMessage Variable Type ViChar[] This control contains the string returned from the self test. See the device's operation manual for an explanation of the string's contents. Notes: (1) The array must be contain at least 256 elements ViChar[256]. Return Value This control contains the status code returned by the function call. Status Codes: Status Description ------------------------------------------------- 0 No error (the call was successful). 3FFF0005 The specified termination character was read. 3FFF0006 The specified number of bytes was read. BFFF0000 Miscellaneous or system error occurred. BFFF000E Invalid session handle. BFFF0015 Timeout occurred before operation could complete. BFFF0034 Violation of raw write protocol occurred. BFFF0035 Violation of raw read protocol occurred. BFFF0036 Device reported an output protocol error. BFFF0037 Device reported an input protocol error. BFFF0038 Bus error occurred during transfer. BFFF003A Invalid setup (attributes are not consistent). BFFF005F No listeners condition was detected. BFFF0060 This interface is not the controller in charge. BFFF0067 Operation is not supported on this session. BFFF0803 Error Scanning Response VI_ERROR_INTERPRETING_RESPONSE ________________________________________________________________________________ fl45_trigger ViStatus fl45_trigger (ViSession instrumentHandle); Purpose This function will send a trigger signal to the instrument. WARNING: If the instrument has the hold modifier and an external trigger mode activated; two sequential triggers may cause the instrument to lock up. If this occurs, it will be necessary to clear the instrument by turning it off and on and then reinitializing it. Notes: (1) A software Trigger can be supplied with this Trigger function, or by pressing the 'down arrow' on the front panel of the instrument. Triggers 4 or 5 can also be trigged with a pulse applied to the RS-232 connector pins 2 and 4 -- See Manual figure 5-2. If an external trigger mode is selected, the instrument must receive a trigger before a measurement will be available. Parameter List instrumentHandle Variable Type ViSession This control accepts the Instrument Handle returned by the Initialize function to select the desired instrument driver session. Default Value: None Return Value This control contains the status code returned by the function call. Status Codes: Status Description ------------------------------------------------- 0 No error (the call was successful). 3FFF0005 The specified termination character was read. 3FFF0006 The specified number of bytes was read. BFFF0000 Miscellaneous or system error occurred. BFFF000E Invalid session handle. BFFF0015 Timeout occurred before operation could complete. BFFF0034 Violation of raw write protocol occurred. BFFF0035 Violation of raw read protocol occurred. BFFF0036 Device reported an output protocol error. BFFF0037 Device reported an input protocol error. BFFF0038 Bus error occurred during transfer. BFFF003A Invalid setup (attributes are not consistent). BFFF005F No listeners condition was detected. BFFF0060 This interface is not the controller in charge. BFFF0067 Operation is not supported on this session. ________________________________________________________________________________ fl45_writeInstrData ViStatus fl45_writeInstrData (ViSession instrumentHandle, ViString writeBuffer); Purpose This function writes commands and queries to the instrument to modify parameters and query device settings. Parameter List instrumentHandle Variable Type ViSession This control accepts the Instrument Handle returned by the Initialize function to select the desired instrument driver session. Default Value: None writeBuffer Variable Type ViString The user can use this control to send common commands and queries to the instrument. This control can also be used to write any valid command to the instrument. Default Value: "*RST" Notes: (1) The command or query to be sent to the instrument may be a literal enclosed in double quotes i.e. "*RST" or may be contained in a variable of type string. Return Value This control contains the status code returned by the function call. Status Codes: Status Description ------------------------------------------------- 0 No error (the call was successful). 3FFF0005 The specified termination character was read. 3FFF0006 The specified number of bytes was read. BFFF0000 Miscellaneous or system error occurred. BFFF000E Invalid session handle. BFFF0015 Timeout occurred before operation could complete. BFFF0034 Violation of raw write protocol occurred. BFFF0035 Violation of raw read protocol occurred. BFFF0036 Device reported an output protocol error. BFFF0037 Device reported an input protocol error. BFFF0038 Bus error occurred during transfer. BFFF003A Invalid setup (attributes are not consistent). BFFF005F No listeners condition was detected. BFFF0060 This interface is not the controller in charge. BFFF0067 Operation is not supported on this session.