DioPmuGetForcedVoltage

Applies To

GX5055, GX5295

Purpose

Returns the channel programmed PMU forced current value and the output current range.

Syntax

DioPmuGetForcedCurrent (nHandle, nChannel, , pdVoltage, pnCurrentRange, pnStatus)

Parameters

Name
Type
Comments
nHandle
SHORT
Master board handle, Board handle or File board handle
nChannel
SHORT
If Board Handle was passed:
Channel number in the DIO board, each board has 32 I/O channels. I/O channels number range is 0-31.
Gx5295: Each DIO board has 4 Auxiliary channels. Auxiliary channels number range is 0-3.
If Master Board Handle was passed:
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)
pdVoltage
PDOUBLE
Returned programmed PMU forced voltage value.
Gx5055: PMU forced voltage can be set from negative voltage rail voltage (VCC) + 2V to positive voltage rail voltage (VEE) -2V.
Gx5295: PMU forced voltage value can be between -2V to 7V.
pnCurrentRange
PSHORT
Programmed PMU I/O current range, current range can be as follows:
Gx5055:
0.      GX5055_PMU_CURRENT_RANGE_N200MA_TO_P200MA: PMU current range -200mA to +200mA
1.      GX5055_PMU_CURRENT_RANGE_N25MA_TO_P25MA: PMU current range -32mA to +32mA
Gx5295:
0.   GX529X_PMU_CURRENT_RANGE_N32MA_TO_P32MA: PMU current range is between -32mA to +32mA.
1.   GX529X_PMU_CURRENT_RANGE_N8MA_TO_P8MA: PMU current range is between -8mA to +8mA.
2.   GX529X_PMU_CURRENT_RANGE_N2MA_TO_P2MA: PMU Programmed PMU I/O current range, current range can be as follows current range is between -2mA to +2mA.
3.   GX529X_PMU_CURRENT_RANGE_N512UA_TO_P512UA: PMU Programmed PMU I/O current range, current range can be as follows current range is between -512uA to +512uA.
4.   GX529X_PMU_CURRENT_RANGE_N128UA_TO_P128UA: PMU Programmed PMU I/O current range, current range can be as follows current range is between -128uA to +128uA.
5.   GX529X_PMU_CURRENT_RANGE_N32UA_TO_P32UA: PMU Programmed PMU I/O current range, current range can be as follows current range is between -32uA to +32uA.
6.   GX529X_PMU_CURRENT_RANGE_N8UA_TO_P8UA6: PMU Programmed PMU I/O current range, current range can be as follows current range is between -8uA to +8uA.
7.   GX529X_PMU_CURRENT_RANGE_N2UA_TO_P2UA7: PMU Programmed PMU I/O current range, current range can be as follows current range is between -2uA to +2uA.
pnStatus
PSHORT
Returns panel window handle. Returns 0 on error.

Comments

The board must be in the PMU Forced current mode prior calling this function otherwise the function returns an error.

In order to achieve greater accuracy when measuring PMU current while in Forced Voltage mode, the user can specify a smaller current range that better fits the expected I/O load and forced voltage condition then the default range of -32mA to +32mA. It is recommended that the estimated current will be less or equal to 80% of the specified current range when no using the default range of -32mA to +32mA., otherwise the current measurement can be inaccurate as well as the actual current might exceed the specified range causing the output voltage to be clamped.

Gx5055: VCC may be between 10V to +28V. The maximum voltage swing between VCC and VEE may not exceed 33.5 V. The Vee voltage must may not exceed 18V and must not be less than 3V. The maximum voltage swing between VCC and VEE may not exceed 33.5 V.

Example

The following example returns channel 0 programmed PMU forced current value and the current range:

 

SHORT nCurrentRange, nStatus;

DOUBLE dCurrent;

DioPmuGetForcedCurrent (nHandle, 0, &dCurrent, &nCurrentRange, &nStatus);

 

See Also

DioSetupChannelMode, DioPmuSetupForcedCurrent, DioPmuSetupForcedVoltage, DioGetErrorString