NI DIGITAL PATTERN DRIVER Triggers And Events Functions - ni/grpc-device GitHub Wiki

Triggers And Events Functions

niDigital_ExportSignal

Routes trigger and event signals to the outputTerminal you specify.

C Function Prototype: ViStatus niDigital_ExportSignal (ViSession vi, ViInt32 signal, ViConstString signalIdentifier, ViConstString outputTerminal)

Parameter Description
vi The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns.
signal

The type of signal to export from a digital pattern instrument.

- NIDIGITAL_VAL_START_TRIGGER (2000): Specifies to route the Start trigger. You must specify an empty string in the signalIdentifier parameter.

- NIDIGITAL_VAL_CONDITIONAL_JUMP_TRIGGER (2001): Specifies to route a conditional jump trigger. You must specify a conditional jump trigger instance in the signalIdentifier parameter.

- NIDIGITAL_VAL_PATTERN_OPCODE_EVENT (2002): Specifies to route a pattern opcode event. You must specify a pattern opcode event instance in the signalIdentifier parameter.
signalIdentifier

Instance of the selected signals to export.

- VI_NULL ("")

- NIDIGITAL_VAL_CONDITIONAL_JUMP_TRIGGER0 ("conditionalJumpTrigger0")

- NIDIGITAL_VAL_CONDITIONAL_JUMP_TRIGGER1 ("conditionalJumpTrigger1")

- NIDIGITAL_VAL_CONDITIONAL_JUMP_TRIGGER2 ("conditionalJumpTrigger2")

- NIDIGITAL_VAL_CONDITIONAL_JUMP_TRIGGER3 ("conditionalJumpTrigger3")

- NIDIGITAL_VAL_PATTERN_OPCODE_EVENT0 ("patternOpcodeEvent0")

- NIDIGITAL_VAL_PATTERN_OPCODE_EVENT1 ("patternOpcodeEvent1")

- NIDIGITAL_VAL_PATTERN_OPCODE_EVENT2 ("patternOpcodeEvent2")

- NIDIGITAL_VAL_PATTERN_OPCODE_EVENT3 ("patternOpcodeEvent3")
outputTerminal

Parameter that configures properties depending on the type of signal you select in the signalIdentifier parameter.

- NIDIGITAL_VAL_DO_NOT_EXPORT_STR (""): Signal will not be exported.

- NIDIGITAL_VAL_PXI_TRIG0_STR ("PXI_Trig0"): Specifies PXI trigger line 0.

- NIDIGITAL_VAL_PXI_TRIG1_STR ("PXI_Trig1"): Specifies PXI trigger line 1.

- NIDIGITAL_VAL_PXI_TRIG2_STR ("PXI_Trig2"): Specifies PXI trigger line 2.

- NIDIGITAL_VAL_PXI_TRIG3_STR ("PXI_Trig3"): Specifies PXI trigger line 3.

- NIDIGITAL_VAL_PXI_TRIG4_STR ("PXI_Trig4"): Specifies PXI trigger line 4.

- NIDIGITAL_VAL_PXI_TRIG5_STR ("PXI_Trig5"): Specifies PXI trigger line 5.

- NIDIGITAL_VAL_PXI_TRIG6_STR ("PXI_Trig6"): Specifies PXI trigger line 6.

- NIDIGITAL_VAL_PXI_TRIG7_STR ("PXI_Trig7"): Specifies PXI trigger line 7.

Note These defined values for signalIdentifier and outputTerminal are currently not supported for gRPC, instead pass the raw values specified alongside, directly.

Return value: Reports the status of the operation.

niDigital_ConfigureDigitalEdgeStartTrigger

Configures the Start trigger for digital edge triggering. The digital pattern instrument responds to the trigger on a physical PXI chassis backplane trigger line and waits for this trigger after you call the niDigital_Initiate function or the niDigital_BurstPattern function. The pattern does not burst until it receives this trigger.

C Function Prototype: ViStatus niDigital_ConfigureDigitalEdgeStartTrigger (ViSession vi, ViConstString source, ViInt32 edge)

Parameter Description
vi The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns.
source The string identifier for a supported trigger source terminal to route into the instrument for the conditional jump trigger instance. The PXIe-6570/6571 supports triggering through the PXI trigger bus.
edge Specifies the polarity of the incoming trigger signal that will assert the Start trigger.

Return value: Reports the status of the operation.

niDigital_ConfigureSoftwareEdgeStartTrigger

Configures the Start trigger for software triggering. The digital pattern instrument waits for this trigger after you call niDigital_Initiate function or niDigital_BurstPattern function and does not burst a pattern until it receives this trigger. Use the niDigital_SendSoftwareEdgeTrigger function to send the software trigger to the digital pattern instrument.

C Function Prototype: ViStatus niDigital_ConfigureSoftwareEdgeStartTrigger (ViSession vi)

Parameter Description
vi The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns.

Return value: Reports the status of the operation.

niDigital_DisableStartTrigger

Disables a previously configured Start trigger. The digital pattern instrument does not wait for a Start trigger after you call the niDigital_Initiate function or the niDigital_BurstPattern function before bursting a pattern.

C Function Prototype: ViStatus niDigital_DisableStartTrigger (ViSession vi)

Parameter Description
vi The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns.

Return value: Reports the status of the operation.

niDigital_SendSoftwareEdgeTrigger

Forces a particular edge-based trigger to occur regardless of how the specified trigger is configured. You can use this function as a software override.

C Function Prototype: ViStatus niDigital_SendSoftwareEdgeTrigger (ViSession vi, ViInt32 trigger, ViConstString triggerIdentifier)

Parameter Description
vi The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns.
trigger

The trigger you want to override.

- NIDIGITAL_VAL_START_TRIGGER (2000): Overrides the Start trigger. You must specify an empty string in the triggerIdentifier parameter.

- NIDIGITAL_VAL_CONDITIONAL_JUMP_TRIGGER (2001): Overrides the conditional jump trigger. You must specify a conditional jump trigger instance in the triggerIdentifier parameter.
triggerIdentifier

Specifies which instance of the conditional jump trigger you want to override.

- VI_NULL ("")

- NIDIGITAL_VAL_CONDITIONAL_JUMP_TRIGGER0 ("conditionalJumpTrigger0")

- NIDIGITAL_VAL_CONDITIONAL_JUMP_TRIGGER1 ("conditionalJumpTrigger1")

- NIDIGITAL_VAL_CONDITIONAL_JUMP_TRIGGER2 ("conditionalJumpTrigger2")

- NIDIGITAL_VAL_CONDITIONAL_JUMP_TRIGGER3 ("conditionalJumpTrigger3")

Note These defined values for triggerIdentifier are currently not supported for gRPC, instead pass the raw values specified alongside, directly.

Return value: Reports the status of the operation.

⚠️ **GitHub.com Fallback** ⚠️