VTI Instruments EX1000A - Vtex10 Xxa_Self_Cal_Init_Ex

www.vtiinstruments.com
EX10xxA Function Calls 275
vtex10xxA_self_cal_init_ex
FUNCTION PROTOTYPE
ViStatus vtex10xxA_self_cal_init_ex (ViSession vi, ViPInt32 override, ViPInt32 current_uptime);
FUNCTION PARAMETERS
vi = contains a session handle to the instrument. This handle is obtained by the function and remains valid until the
session is closed.
override = an integer output value in decimal that represents an override code. If self-calibration is attempted before
the EX10xxA has been powered on continuously for 60 minutes, an error will be generated, and an integer value
will be placed in the override variable. If appropriate, resending the function will override the error and initiate self-
calibration.
current_uptime = an integer output value in decimal that represents the time elapsed in seconds since the
instrument is turned on.
DATA ITEM RESET VALUE
Not applicable to this function.
DESCRIPTION
This function performs an instrument self-calibration. In general, self-calibration should not be performed until the
instrument has been powered on continuously for 60 minutes. In fact, if self-calibration is attempted prior to the
required uptime, an error will be generated. When appropriate, as described below, this error can be overridden by
resending the function.
NOTES 1) In order to perform a self-calibration, a lock on the instrument must first be acquired.
Attempting to self-calibrate without the acquisition of a lock will generate an error that is not
able to be overridden. See the vtex10xxA_lock function.
2) The self-calibration uptime requirement is in place to protect the measurement integrity of the
instrument. Overriding the requirement must only be done when the operating conditions allow
it. An example of this is where the unit has actually been warmed up, but has simply been
subjected to a quick power cycle or reboot. In order to ensure that the override is
intentional, it is strongly recommended that user intervention be required in the software
application to employ it.
3) Once self-calibration has been successfully initiated, its percentage completion status is
accessible through the vtex10xxA_self_cal_get_status function. Additional instrument
driver calls should not be performed until the completion status reaches 100 percent. To
determine if calibration is still running, use the vtex10xxA_get_calibration_running function.
If calibration fails, it status will not reach 100%.
EXAMPLE