GxSmuSourceGetConstantCurrent

Applies To

GX3104, GX3116e

Purpose

Returns the specified channel’s current range, output current, GX3104: voltage limit, GX3116e: Voltage Clamp High, Voltage Clamp Low, and ramp time when in constant current mode.

Syntax

GxSmuSourceGetConstantCurrent (nHandle, nChannel, pnCurrentRange, pdCurrent, pdVoltageLimitOrClampHigh, pdVoltageClampLow, pdRampTimeInMiliSec, pnStatus)

Parameters

Name
Type
Description
nHandle
SHORT
Handle to a GX3104 or GX3116e board.
nChannel
SHORT
GX3104: Specifies the channel number (0-3): GX3104_CHANNEL_1 to GX3104_CHANNEL_4
GX3116e: Specifies channel number (0-15) is GX3116_CHANNEL_1 to GX3116_CHANNEL_16
pnCurrentRange
PSHORT
Returns the specified channel’s current range for each current range is as follows:
GX3104:
0.      GX3104_SOURCE_CURRENT_RANGE_1000MA: Source Current Range +/-1000mA, supported by channel 1 only, channels 2-4 can be set up to +/-500mA
1.      GX3104_SOURCE_CURRENT_RANGE_250MA: Source Current Range +/-250mA
2.      GX3104_SOURCE_CURRENT_RANGE_25MA: Source Current Range +/-25mA (default after reset).
3.      GX3104_SOURCE_CURRENT_RANGE_2500UA: Source Current Range +/-2.5mA
4.      GX3104_SOURCE_CURRENT_RANGE_250UA: Source Current Range +/-250uA
5.      GX3104_SOURCE_CURRENT_RANGE_25UA: Source Current Range -+/-25uA
6.      GX3104_SOURCE_CURRENT_RANGE_2500NA: Source Current Range -2.5uA to -1uA, and 1uA to 2.5uA
GX3116e:
0.      GX3116_SOURCE_CURRENT_RANGE_512MA: Source Current Range -512mA to +512mA
1.      GX3116_SOURCE_CURRENT_RANGE_25_POINT_6MA: Source Current Range -25.6mA to +25.6mA (default)
2.      GX3116_SOURCE_CURRENT_RANGE_2_POINT_56MA: Source Current Range -2.56mA to +2.56mA
pdCurrent
PDOUBLE
Returns the specified channel’s current, the specified value must match the current limit range settings, as it was set by the nCurrentRange parameter.
pdVoltageLimitOrClampHigh
PDOUBLE
GX3104:
Returns the specified channel’s voltage limit settings when in constant current mode. Voltage range is -20.0V to +20.0V.
GX3116e:
Returns the specified channel’s voltage clamp high settings when in constant current mode.
Current range 512mA: Voltage range is 0V to +9.0.
Current range 25.6 mA and 2.56mA: Voltage range is -2.0V to +10.5V.
pdVoltageClampLow
PDOUBLE
GX3104:
Not used, can be pass as NULL.
GX3116e:
Returns the specified channel’s voltage clamp high settings when in constant current mode.
Current range 512mA: Voltage range is 0V to +9.0.
Current range 25.6 mA and 2.56mA: Voltage range is -2.0V to +10.5V.
pdRampTimeInMiliSec
PDOUBLE
Returns the specified ramp time in mSec, value can be 0 mSec to 4000 mSec.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

GX3104:

Returns the specified channel’s current range, output current, voltage limit, and ramp time when in constant current mode.

GX3116e:

Returns the specified channel’s current range, output current, voltage clamp high, voltage clamp low, and ramp time when in constant current mode.

Note: the channel must be in constant current mode prior calling this function.

Example

GX3104:

The following example sets channel 1 current range to +/-250mA, voltage limit to +10V, current to 200mA, in 10 mSec:

 

SHORT nStatus;

 

GxSmuSourceSetConstantCurrent (nHandle, GX3104_CHANNEL_1, GX3104_SOURCE_CURRENT_RANGE_250MA, 200.0, 10.0, 0.0, 10, &nStatus);

 

GX3116e:

The following example sets channel 1 current range to +/-512mA, voltage clamp high to +10V and voltage clamp low to 0.0, and set current to 200mA,in 10 mSec:

 

SHORT nStatus;

 

GxSmuSourceSetConstantCurrentEx (nHandle, GX3116_CHANNEL_1, GX3116_SOURCE_CURRENT_RANGE_512MA, 200.0, 10.0, 0.0, &nStatus);

 

See Also

GxSmuSourceSetConstantCurrent, GxSmuSourceSetConstantVoltage, GxSmuSourceGetCurrent, GxSmuSourceSetCurrentLimit, GxSmuSourceSetCurrentClamps, GxSmuSourceSetCurrentRange, GxSmuSourceSetMode, GxSmuSourceSetOutputState, GxSmuSourceSetRangeMode, GxSmuSourceSetVoltage, GxSmuSourceSetVoltageLimit, GxSmuGetErrorString