DioGetAuxiliaryToTimingInput

Applies To

GX5295, File

Purpose

Returns the specified Auxiliary channel connections to the timing inputs signals.

Syntax

DioGetAuxiliaryToTimingInput (nHandle, nAuxChannel, pdwInputComparator, pdwInputSignal, pnStatus)

Parameters

Name
Type
Comments
nHandle
SHORT
Board or File board handle.
nAuxChannel
SHORT
Specified Auxiliary Pin Electronics channel in the DIO board, channel can be as follows:
1000 DIO_AUX_CHANNEL_0: Auxiliary Pin Electronics channel 0.
1001 DIO_AUX_CHANNEL_1: Auxiliary Pin Electronics channel 1.
1002 DIO_AUX_CHANNEL_2: Auxiliary Pin Electronics channel 2.
1003 DIO_AUX_CHANNEL_3: Auxiliary Pin Electronics channel 3.
pdwInputComparator
PDWORD
The Auxiliary channel inputs signal can be programmatically connected to either the low voltage level comparator or the high voltage level comparator. Each bit represents one of the possible inputs as defined in pdwInputSignal. See Comments for details.
pdwInputSignal
PDWORD
The Auxiliary channel can be connected to any of the following signals (see comments for details):
  • DIO_AUX_TO_EXTERNAL_DISABLED = 0x0
  • DIO_AUX_TO_EXTERNAL_CLOCK = 0x1
  • DIO_AUX_TO_EXTERNAL_STROBE = 0x2
  • DIO_AUX_TO_EXTERNAL_TRIGGER = 0x4
  • DIO_AUX_TO_EXTERNAL_PAUSE = 0x8
  • DIO_AUX_TO_EXTERNAL_CLOCK_ENABLE = 0x10.
  • DIO_AUX_TO_EXTERNAL_STROBE_ENABLE = 0x20
  • DIO_AUX_TO_EXTERNAL_EVENT_LINE_0 = 0x100
  • DIO_AUX_TO_EXTERNAL_EVENT_LINE_1 = 0x200
  • DIO_AUX_TO_EXTERNAL_EVENT_LINE_2 = 0x400
  • DIO_AUX_TO_EXTERNAL_EVENT_LINE_3 = 0x800
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

The Auxiliary channel can be connected to configure to any of the following timing signals:

●     DIO_AUX_TO_EXTERNAL_INPUT_DISABLED = 0x0: Disconnect all external input signals to the specified Auxiliary channel, default state after calling DioReset API.

●     DIO_AUX_TO_EXTERNAL_CLOCK = 0x1: Auxiliary channel is connected to External Clock Input (reference to the internal clock PLL or sample clock source) pin number 31 on the Timing connector (J3). If pdwInputComparator=0x1 high voltage level comparator, otherwise uses the low voltage level comparator.

●     DIO_AUX_TO_EXTERNAL_STROBE = 0x2: Auxiliary channel is connected to External Strobe Input pin number 32 on the Timing connector (J3). If pdwInputComparator=0x2 high voltage level comparator, otherwise uses the low voltage level comparator.

●     DIO_AUX_TO_EXTERNAL_TRIGGER = 0x4: Auxiliary channel is connected to External Trigger Input (Overrides Run Command) pin number 26 on the Timing connector (J3). If pdwInputComparator=0x4 high voltage level comparator, otherwise uses the low voltage level comparator.

●     DIO_AUX_TO_EXTERNAL_PAUSE = 0x8: Auxiliary channel is connected to External Pause Input (Overrides Pause Command) pin number 27 on the Timing connector (J3). If pdwInputComparator=0x8 high voltage level comparator, otherwise uses the low voltage level comparator.

●     DIO_AUX_TO_EXTERNAL_CLOCK_ENABLE = 0x10: Auxiliary channel is connected to External Clock Enable Input (active low) pin number 28 on the Timing connector (J3). If pdwInputComparator=0x10 high voltage level comparator, otherwise uses the low voltage level comparator.

●     DIO_AUX_TO_EXTERNAL_STROBE_ENABLE = 0x20: Auxiliary channel is connected to External Strobe. If pdwInputComparator=0x20 high voltage level comparator, otherwise uses the low voltage level comparator.

●     DIO_AUX_TO_EXTERNAL_EVENT_LINE_0 = 0x100: Auxiliary channel is connected to Input External event 0 pin number 1 on the Timing connector (J3). If pdwInputComparator=0x100 high voltage level comparator, otherwise uses the low voltage level comparator.

●     DIO_AUX_TO_EXTERNAL_EVENT_LINE_1 = 0x200: Auxiliary channel is connected to Input External event 1 pin number 2 on the Timing connector (J3) If pdwInputComparator=0x200 high voltage level comparator, otherwise uses the low voltage level comparator.

●     DIO_AUX_TO_EXTERNAL_EVENT_LINE_2 = 0x400: Auxiliary channel is connected to Input External event 2 pin number 3 on the Timing connector (J3). If pdwInputComparator=0x400 high voltage level comparator, otherwise uses the low voltage level comparator.

●     DIO_AUX_TO_EXTERNAL_EVENT_LINE_3 = 0x800: Auxiliary channel is connected to Input External event 3 pin number 4 on the Timing connector (J3) If pdwInputComparator=0x800 high voltage level comparator, otherwise uses the low voltage level comparator.

Example

The following example returns Auxiliary channel 0 connections to the timing inputs signals:

 

DWORD dwInputSignal, dwInputComparator;

DioGetAuxiliaryToTimingInput (nHandle, DIO_AUX_CHANNEL_0, &dwInputComparator, &dwInputSignal, &nStatus);

 

See Also

DioSetupAuxiliaryToTimingInput, DioSetupAuxiliaryToTimingOutput, DioGetErrorString