DioResetChannels

Applies To

GX5295

Purpose

Sets the specified channels range to default settings without resetting the whole board.

Syntax

DioResetChannels (nHandle, nChannelListMode, nCountOrFirstChannel, panChannelList, nLastChannel, 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
DWORD
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.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

The following are the default settings:

●     Channel mode set to Output enabled.

●     High output voltage set to 2.5V

●     Low output voltage set to 0.0V

●     High input threshold voltage  set to 2.5V

●     Low input threshold voltage set to 0.0V

●     Sink input load current set to 8.0Ma

●     Source input load current set to 8.0mA

●     Input Load Commutating Voltage set to 2.5V

●     Pmu Forced Current set to 0Ma.

●     Pmu Forced Current range set to -32mA to +32mA.

●     Pmu Forced Current Commutating high Voltage set to 2.5V.

●     Pmu Forced Current Commutating low Voltage set to 0V.

●     Pmu Forced Voltage set to 0V.

Example

The following example uses an array of channels list to be reset:

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

DioResetChannels (nHandle, DIO_CH_LIST_MODE_ARRAY_OF_CHANNELS, 8, anChannelList, 0, DIO_PMU_COMPARATORS_SOURCE_FORCED_CURRENT, &nStatus);

The following example reset all the board’s channels:

DioResetChannels (nHandle, DIO_CH_LIST_MODE_ALL_BOARD_CHANNELS, 0, NULL , 0, DIO_PMU_COMPARATORS_SOURCE_FORCED_CURRENT, &nStatus);

The following example resets all boards’ channels:

DioResetChannels (nHandle, DIO_CH_LIST_MODE_ALL_DOMAIN_CHANNELS, 0, NULL , 0, DIO_PMU_COMPARATORS_SOURCE_FORCED_CURRENT, &nStatus);

The following example resets channels 5 to 10

DioResetChannels (nHandle, DIO_CH_LIST_MODE_RANGE_OF_CHANNELS, 5, NULL, 10, DIO_PMU_COMPARATORS_SOURCE_FORCED_CURRENT, &nStatus);

 

See Also

DioSetupOutputVoltages, DioSetupInputThresholdVoltages, DioPmuSetupForcedCurrent, DioPmuSetupForcedCurrentCommutatingVoltage, DioPmuSetupForcedVoltage, DioReset, DioGetErrorString