DioPmuSetupForcedCurrentCommutatingVoltage

Applies To

GX5055, GX5295, File

Purpose

Sets the channel PMU forced current commutating voltage.

Syntax

DioPmuSetupForcedCurrentCommutatingVoltage (nHandle, nChannelListMode, nCountOrFirstChannel, panChannelList, nLastChannel, pdVComHi, pdVComLo, pnStatus)

Parameters

Name
Type
Comments
nHandle
SHORT
Master board handle, Board handle or File board handle.
nChannelListMode
SHORT
Channel list mode dictates how nCountOrFirstChannel and panChannelList parameters are used. Channel list mode options are as follows:
0  DIO_CH_LIST_MODE_ARRAY_OF_CHANNELS: The user specifies an array of channels where nCountOrFirstChannel is the number of elements in the list array and panChannelList is an array contains the channels numbers. In this mode nLastChannel is ignored.
1  DIO_CH_LIST_MODE_ALL_BOARD_CHANNELS: Apply the settings to all the board’s channels associated with this board handle. In this mode nCountOrFirstChannel, panChannelList and nLastChannel variavles are ignored.
2  DIO_CH_LIST_MODE_ALL_DOMAIN_CHANNELS: Apply the settings to all the channels in the domain, e.g. if there are two boards in the domain (Master and a Slave), then all 64 channels will be set. In this mode nCountOrFirstChannel, panChannelList and nLastChannel variavles are ignored.
3  DIO_CH_LIST_MODE_RANGE_OF_CHANNELS: Apply settings to a range of channels where nCountOrFirstChannel is the first channel number and nLastChannel is the last channel number. In this mode panChannelList variavle is ignored.
nCountOrFirstChannel
SHORT
If nChannelListMode parameter is set to DIO_CH_LIST_MODE_ARRAY_OF_CHANNELS, then it is specifying the number of elements in the panChannelList array parameter.
If nChannelListMode parameter is set to DIO_CH_LIST_MODE_RANGE_OF_CHANNELS, then it is specifying the first channel number to apply the settings to,
otherwise it is ignored and should set to zero.
Channel number in the DIO domain, each DIO board adds 32 I/O channels. I/O channels number range is 0-991 (1 master and 30 slaves).
Gx5295: Each DIO board adds 4 Auxiliary channels, Auxiliary channels number range is 0-123 (1 master and 30 slaves).
panChannelList
PSHORT
Array of channels numbers. Channels numbers can be from 0 to the last channel in the domain. E.g., if the domain has two boards then the last channel is 63.
This parameter is only used if nChannelListMode parameter is set to DIO_CH_LIST_MODE_ARRAY_OF_CHANNELS, otherwise is should be passed as NULL.
Channel number in the DIO domain, each DIO board adds 32 I/O channels. I/O channels number range is 0-991 (1 master and 30 slaves).
Gx5295: Each DIO board adds 4 Auxiliary channels, Auxiliary channels number range is 0-123 (1 master and 30 slaves).
nLastChannel
SHORT
If nChannelListMode parameter is set to DIO_CH_LIST_MODE_RANGE_OF_CHANNELS, then it is specifying the last channel number to apply the settings to,
otherwise it is ignored and should set to zero.
Channel number in the DIO domain, each DIO board adds 32 I/O channels. I/O channels number range is 0-991 (1 master and 30 slaves).
Gx5295: Each DIO board adds 4 Auxiliary channels, Auxiliary channels number range is 0-123 (1 master and 30 slaves).
pdVComHi
PDOUBLE
Gx5055: Input channel high commutating voltages value, voltage can be set from negative voltage rail voltage (VDD) + 2V to positive voltage rail voltage (VEE) -2V.
Gx5295: Input channel high commutating voltages value, voltage can be set from --2V to +7V.
pdVComLo
PDOUBLE
Gx5055: Input channel low commutating voltages value, voltage can be set from negative voltage rail voltage (VDD) + 2V to positive voltage rail voltage (VEE) -2V.
Gx5295: Input channel low commutating voltages value, voltage can be set from --2V to +7V.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

Each PMU has a set of programmable commutating voltage that limit the voltage swing when the PMU is forcing current. These 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.

Example

The following example uses an array of channels list set PMU forced current commutating voltage

SHORT anChannelList[]={0, 2, 5, 7, 9, 13, 14, 27};

DioPmuSetupForcedCurrentCommutatingVoltage (nHandle, DIO_CH_LIST_MODE_ARRAY_OF_CHANNELS, 8, anChannelList, 0, 3.5, -1, &nStatus);

The following example sets all the board’s channels PMU forced current commutating voltage:

DioPmuSetupForcedCurrentCommutatingVoltage (nHandle, DIO_CH_LIST_MODE_ALL_BOARD_CHANNELS, 0, NULL , 0, 3.5, -1, &nStatus);

The following example sets all the boards channels PMU forced current commutating voltage:

DioPmuSetupForcedCurrentCommutatingVoltage (nHandle, DIO_CH_LIST_MODE_ALL_DOMAIN_CHANNELS, 0, NULL , 0, 3.5, -1, &nStatus);

The following example sets channels 5 to 10 PMU forced current commutating voltage:

DioPmuSetupForcedCurrentCommutatingVoltage (nHandle, DIO_CH_LIST_MODE_RANGE_OF_CHANNELS, 5, NULL, 10, 3.5, -1, &nStatus);

 

See Also

DioSetupChannelMode, DioPmuSetupForcedCurrent, DioPmuSetupForcedVoltage, DioPmuSetupForcedCurrentCommutatingVoltage, DioGetErrorString