VTI Instruments EX1629 - Vtex1629_Get_Completion_Resistor

VTI Instruments Corp.
138 EX1629 Command Set
vtex1629_get_completion_resistor
FUNCTION PROTOTYPE
ViStatus vtex1629_get_completion_resistor (ViSession vi, ViInt32 channel, ViPInt32 completionResistorMode,
ViPReal64 calibratedValue);
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.
channel = an integer input value indicating the channel for which the completion resistor is desired. Valid input
values: 0 to 47.
completionResistorMode = an integer return value indicating the completion resistor mode. Valid return values: 0,
3, 4, 120, or 350.
calibratedValue = a real return value that indicates the calibrated value of the currently configured completion
resistor. This value is retrieved from the non-volatile, factory calibration file that is stored within the device.
DATA ITEM RESET VALUE
Not applicable to this function.
DESCRIPTION
This function queries and returns the mode and value of the completion resistor for a specific channel. The valid
return values are as follows:
Decimal
Value
Hex
Value
#define Symbol
Resistor Mode
calibratedValue
0
0x00
VTEX1629_COMPRES_FULL
Full
0.0 (N/A)
3
0x03
VTEX1629_COMPRES_USER
User-Defined
Actual value installed, 0.0 (N/A) otherwise
4
0x04
VTEX1629_COMPRES_OFF
OFF
0.0 (N/A)
120
0x78
VTEX1629_COMPRES_120
120 Ω
Actual value
350
0x15E
VTEX1629_COMPRES_350
350 Ω
Actual value
Referring to the “Full” completion resistor is a bit of a misnomer – it really represents a short in the leg of the bridge
circuit that contains the completion resistor. It is used in Full and Half-Bridge mode.
EXAMPLE
ViSession instrumentHandle;
ViStatus status;
ViInt32 compmode;
ViReal64 resvalue;
…
status = vtex1629_get_completion_resistor(instrumentHandle, 0, &compmode, &resvalue);