DioSetupInputLoadCurrent

Applies To

GX5055, GX5295, File.

Purpose

Sets the channels range input source and sink load currents.

Syntax

DioSetupInputLoadCurrent (nHandle, nChannelListMode, nCountOrFirstChannel, panChannelList, nLastChannel, dISink, dISource, pnStatus)

Parameters

Name
Type
Comments
nHandle
SHORT
DIO Master handle, Slave 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 n LastChannel 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.
Gx5295: Auxiliary channels numbers are 1000 to 1003.
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).
dISink
DOUBLE

 
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.
dISource
DOUBLE

 
Input channel constant current source value in mA. 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 uses an array of channels list to set the Input sink current to 10mA and sink current to 5mA:

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

DioSetupInputLoadCurrent (nHandle, DIO_CH_LIST_MODE_ARRAY_OF_CHANNELS, 8, anChannelList, 0, 0.01, 0.005, &nStatus);

The following example sets all the board’s channels set the Input sink current to 10mA and sink current to 5mA:

DioSetupInputLoadCurrent (nHandle, DIO_CH_LIST_MODE_ALL_BOARD_CHANNELS, 0, NULL , 0, 0.01, 0.005, &nStatus);

The following example sets all the boards channels set the Input sink current to 10mA and sink current to 5mA:

DioSetupInputLoadCurrent (nHandle, DIO_CH_LIST_MODE_ALL_DOMAIN_CHANNELS, 0, NULL , 0, 0.01, 0.005, &nStatus);

The following example sets channels 5 to 10 set the Input sink current to 10mA and sink current to 5mA:

DioSetupInputLoadCurrent (nHandle, DIO_CH_LIST_MODE_RANGE_OF_CHANNELS, 5, NULL, 10, 0.01, 0.005, &nStatus);

 

See Also

DioSetupInputLoadCurrent,DioSetupInputLoadCommutatingVoltage, DioSetupInputLoadResistance,  DioSetupInputThresholdVoltages, DioGetErrorString