niTuner_configReadySignal

NI Tuner

niTuner_configReadySignal

Function Prototype

int niTuner_configReadySignal (int taskID, unsigned int signalDestination, unsigned int signalType, unsigned int signalPolarity, double pulseLength);

Purpose

This function configures the PXI-5600 downconverter ready signal output, which is sent on one of the RTSI lines when the downconverter has finished settling to a specified frequency.

Parameters

Name Type Description
taskID int The Task ID obtained from niTuner_init that identifies the session of a particular device.
signalDestination unsigned int Identifies the destination of the ready signal output:

Defined Values:

NITUNER_SIGNAL_NO_DESTINATION

NITUNER_SIGNAL_RTSI0

NITUNER_SIGNAL_RTSI1

NITUNER_SIGNAL_RTSI2

NITUNER_SIGNAL_RTSI3

NITUNER_SIGNAL_RTSI4

NITUNER_SIGNAL_RTSI5

NITUNER_SIGNAL_RTSI6

Default Value:

NITUNER_SIGNAL_NO_DESTINATION

signalType unsigned int Configures the type of signal the PXI-5600 downconverter generates when it has settled to a frequency. The signal may be represented as a pulse of pulseLength seconds in the direction of the polarity, or as a level signal that returns to the state specified by signalPolarity.

For more information about these signal types, see the trigger timing diagram.

Defined Values:

NITUNER_SIGNAL_PULSE

NITUNER_SIGNAL_LEVEL

Default Value:

NITUNER_SIGNAL_PULSE

signalPolarity unsigned int Configures the PXI-5600 downconverter to send a ready signal of selected type with polarity of active low or active high.

Defined Values:

NITUNER_SIGNAL_ACTIVE_LOW

NITUNER_SIGNAL_ACTIVE_HIGH

Default Value:

NITUNER_SIGNAL_ACTIVE_LOW

pulseLength double Time in seconds to generate a signal of type pulse in the direction specified by signalPolarity.

Return Value

Returns the status of the function. To see an explanation of common error and warning codes, see Error and Status Codes. To see a text explanation of the status code, call niTuner_errorHandler.