GtDio6xChannelSetPmuForcedCurrentCommutatingVoltage

Applies To

GX5296, GX5961, GX5964, File

Purpose

Sets the channel forced current commutating voltage (voltage clamp).

Syntax

GtDio6xChannelSetPmuForcedCurrentCommutatingVoltage (nHandle, lChannelListArraySize, palChannelListArray, dVComHi, dVComLo, pnStatus)

Parameters

Name
Type
Comments
nHandle
SHORT
Session identifier:

●     Board handle is used when communicating with the hardware. The Board handle session identifier is returned by calling GtDio6xInitialize or GtDio6xSetupInitialization.

●     File handle is used when communicating with a file. The File handle session identifier is  returned by calling GtDio6xFileOpen.
lChannelListArraySize
LONG
Used to specify the number of channels to set. This parameter should not be greater than the size of palChannelListArray. If GTDIO6X_ALL_DOMAIN is passed in, then the palChannelListArray parameter can be set to NULL and the settings will be applied to all channels in the Domain.
palChannelListArrary
PLONG
Array containing channels numbers that will be set by this function, channels numbers are 0-based and refers to any channel in the Domain. Auxiliary channel numbers begin with 1000.
GX5296: Each GX5296 board has 4 auxiliary channels that support all the Pin Electronics API functions.
GX5961: Each GX5961 board has 4 fully programmable auxiliary channels, and 8 TTL I/O channels. First 4 auxiliary channels may use all the Pin Electronics API.
GX5964: Does not have Auxiliary channels.
dVComHi
DOUBLE
High Commutating Voltage for forced current voltage clamp:
GX5296: high commutating voltages value can be set from --2V to +7V.
dVComLo
DOUBLE
Low Commutating Voltage for forced current voltage clamp:
GX5296: low commutating voltages value can be set from --2V to +7V.
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

Each PMU has a set of programmable commutating voltage that limit the voltage swing when the PMU is forcing current. Commutating voltage protect the DUT when current is being forced into a high impedance node at the DUT.

If the sensed voltage exceeds the high or low commutating voltage the PMU reduces the output current in order for the output voltage to not exceed the commutating voltage. If the voltage subsequently returns back to within the commutating voltage thresholds, the PMU resumes forcing the programmed current.

The Channels PMU forced current commutating voltage can be read back and set dynamically at any time even while the DIO is running mode.

NOTE: dVComLo can only be equal or smaller thandVComHi (dVComLo<=dVComHi), otherwise returns an error.

Example

The following example channels 0 and 2 forced current voltage clamps to +2.5V AND -1.0VM and read back the settings form channel 0:

 

SHORT nStatus;

LONG alChannelList[2];

DOUBLE dVComHi, dVComLo;

 

// Fill channel array

alChannelList[0] = 0;

alChannelList[1] = 2;

GtDio6xChannelSetPmuForcedCurrentCommutatingVoltage(nHandle, 2, alChannelList, 2.5, -1.0, &nStatus);

GtDio6xChannelGetPmuForcedCurrentCommutatingVoltage(nHandle, 0, &dVComHi, &dVComLo, &nStatus);

 

See Also

GtDio6xChannelGetPmuForcedCurrentCommutatingVoltage,  GtDio6xChannelSetPmuForcedCurrent, GtDio6xChannelGetPmuForcedCurrent, GtDio6xChannelSetMode, GtDio6xChannelGetMode, GtDio6xChannelSetPmuForcedVoltage, GtDio6xChannelGetPmuForcedVoltage, GtDio6xGetErrorString