CompuScope SDK Manua.. - Egmont Instruments

gage_input_control
Syntax
C:
int16 GAGEAPI gage_input_control (int16 channel, int16 enable, int16 coupling, int16 gain);
Visual BASIC:
Function gage_input_control (ByVal channel As Integer, ByVal enable As Integer,
ByVal coupling As Integer, ByVal gain As Integer) As Integer
Remarks
gage_input_control is used to set up the input parameters for each signal input channel on CompuScope
hardware.
The channel parameter is either channel A (constant GAGE_CHAN_A defined in GAGE_DRV.H) or
channel B (constant GAGE_CHAN_B defined in GAGE_DRV.H).
The enable parameter either enables the channel to capture data or disables the data capture on that
channel. The constants GAGE_INPUT_ENABLE or GAGE_INPUT_DISABLE should be used. This
functionality is not useful on modern CompuScopes and the user should simply enable all channels.
coupling controls the input coupling (either DC or AC ) and is set using the constants GAGE_DC and
GAGE_AC.
The gain parameter controls the input ranges for each input channel. Possible constants are listed in the
Appendix: Data Structures Used by CompuScope Drivers in the CompuScope C/C++ SDK Manual. For
instance, in order to set the input range to ±1 Volts, the user should assign GAGE_PM_1_V to the gain
parameter.
In single channel mode, both channels should be set to the same parameters.
To set the impedance for an input channel, the gain should be bitwise "ORed" with the desired impedance,
either GAGE_1_MOHM_INPUT or GAGE_50_OHM_INPUT. For instance, in order to set the input
range to ±1 Volts with an input impedance of 50 Ohms, the user should assign (GAGE_PM_1_V |
GAGE_50_OHM_INPUT) to the gain parameter, where "|" is C syntax for bit-wise OR.
Some CompuScopes, such as the CompuScope 1610, support two input types: single-ended or differential.
To set the input type for an input channel, the gain should be bitwise "ORed" with the desired input type,
either GAGE_SINGLE_ENDED_INPUT or GAGE_DIFFERENTIAL_INPUT. For instance, in order to
set the input range to ±1 Volts and input type of differential, the user should assign (GAGE_PM_1_V |
GAGE_DIFFERENTIAL_INPUT) to the gain parameter, where "|" is C syntax for bit-wise OR.
Return Value
A 1 is returned if the routine has successfully set the requested input control parameters. A 0 is returned if
the routine fails to implement requested input control parameters. gage_get_error_code may be called to
obtain the error code. You should always check the return value.
See also: gage_trigger_control_2 and gage_capture_mode
Examples
C: gage_input_control (GAGE_CHAN_A, GAGE_INPUT_ENABLE, GAGE_DC, GAGE_PM_1_V |
GAGE_1_MOHM_INPUT);
Visual BASIC: dummy = gage_input_control (GAGE_CHAN_A, GAGE_INPUT_ENABLE,
GAGE_DC,GAGE_PM_1_V OR GAGE_1_MOHM_INPUT)
CompuScope API Reference Manual 38