DioGetInputLoadCurrent

Applies To

GX5055, GX5295, File.

Purpose

Returns the channel input source and sink load currents.

Syntax

DioGetInputLoadCurrent (nHandle, nChannel, pdISink, pdISource,  pnStatus)

Parameters

Name
Type
Comments
nHandle
SHORT
DIO 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 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 maste and 30 slaves).
pdISink
PDOUBLE
Input channel constant current sink value in mA. Input channel constant current sink value can be set from 0mA to 24mA with 0.3662 μA resolution.
GX5055:
The input channel current sink force the specified constant current to be active when the input voltage is below the low commutating voltage value.
GX5295:
The input channel current sink force the specified constant current to be active when the input voltage is below the commutating voltage value.
pdISource
PDOUBLE
Input channel constant current source value.
Input channel constant current source value can be set from 0mA to 24mA with 0.3662 μA resolution.
GX5055:
The input channel current source force the specified constant current to be active when the input voltage is above the high commutating voltage value.
GX5295:
The input channel current source force the specified constant current to be active when the input voltage is above the commutating voltage value.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

GX5055:

Each channel has an independent load with the following capabilities:

●     Channels’ Input constant source and sink currents up to 24 mA – DioSetupInputLoadCurrent  function.

●     Maintain high impedance over a wide voltage.

●     Separate high and low commutating voltages – DioSetupInputLoadCommutatingVoltage function.

●     Channels’ Input Resistive load options - DioSetupInputLoadResistance function.

With independent high and low commutating voltages, the source and sink currents each have their own threshold voltage. If the voltage on the input, when the load is activated, is between the two commutating voltages, the load will remain in a high impedance state.

GX5295:

Each channel has an independent load with the following capabilities:

●     Channels’ Input constant source and sink currents up to 24 mA – DioSetupInputLoadCurrent  function.

●     Maintain high impedance over a wide voltage.

●     Single commutating voltage – DioSetupInputLoadCommutatingVoltage function.

With a single commutating voltage, the source and sink currents have a single threshold voltage.

Channels input source and sink constant currents can be read back and set dynamically at any time even while the DIO is running mode.

Example

The following example returns the Input constant current settings for channel 0 in mA:

 

DOUBLE dISource, dISink;

DioGetInputLoadCurrent  (nHandle, 0, &dISource, &dISink, &nStatus);

 

See Also

DioSetupInputLoadState, DioSetupInputLoadCurrent, DioSetupInputLoadCommutatingVoltage, DioSetupInputLoadResistance, DioSetupInputThresholdVoltages, DioGetErrorString