DioSetupTriStateTerminationMode

Applies To

GX5295, File.

Purpose

Setup the channel Tri-State termination mode.

Syntax

DioSetupTriStateTerminationMode (nHandle, nChannelListMode, nCountOrFirstChannel, panChannelList, nLastChannel, nMode, pnStatus)

Parameters

Name
Type
Comments
nHandle
SHORT
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.
Gx5295: Auxiliary channels numbers are 1000 to 1003.
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.
Gx5295: Auxiliary channels numbers are 1000 to 1003.
nMode
SHORT
Returned Tri-State termination mode:
0  DIO_TRI_STATE_TERMINATION_MODE_DEFAULT: Default termination mode, in this mode the channel will be set to Hi-Z whenever the channel direction is set to input.
1  DIO_TRI_STATE_TERMINATION_MODE_LEVEL: in this mode the channel will be set to the voltage as specified in DioSetupTriStateTerminationVoltage API whenever the channel direction is set to input.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

GX5295:

The specified termination voltage is the same voltage that is used by the input active load commutating voltage.

Channels termination voltage can be read back and set dynamically at any time even while the DIO is running mode.

Example

The following example returns the specified channel Tri-State termination mode:

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

DioSetupTriStateTerminationMode (nHandle, DIO_CH_LIST_MODE_ARRAY_OF_CHANNELS, 8, anChannelList, 0, DIO_TRI_STATE_TERMINATION_MODE_LEVEL, &nStatus);

 

The following example sets all the board’s channels Tri-State termination mode:

DioSetupTriStateTerminationMode (nHandle, DIO_CH_LIST_MODE_ALL_BOARD_CHANNELS, 0, NULL , 0, DIO_TRI_STATE_TERMINATION_MODE_LEVEL, &nStatus);

 

The following example sets all the boards’ channels Tri-State termination mode:

DioSetupTriStateTerminationMode (nHandle, DIO_CH_LIST_MODE_ALL_DOMAIN_CHANNELS, 0, NULL , 0, DIO_TRI_STATE_TERMINATION_MODE_LEVEL, &nStatus);

 

The following example sets channels 5 to 10 Tri-State termination mode:

DioSetupTriStateTerminationMode (nHandle, DIO_CH_LIST_MODE_RANGE_OF_CHANNELS, 5, NULL, 10, DIO_TRI_STATE_TERMINATION_MODE_LEVEL, &nStatus);

 

See Also

DioGetTriStateTerminationMode, DioSetupTriStateTerminationVoltage, DioSetupInputLoadCurrent, DioSetupInputLoadCommutatingVoltage, DioGetErrorString