niHSDIO Configure Ref Clock VI

Download PDF

Updated2023-02-21
4 minute(s) read

Installed With: NI-HSDIO

Configures the Reference clock. Use this VI when you are using the On Board Clock as a Sample clock and you want the Sample clock to be phase-locked to a reference signal. Phase-locking the Sample clock to a Reference clock prevents the Sample clock from losing alignment with the Reference clock. The driver ignores the Reference clock rate input when the Reference clock source is PXI Clock.

Refer to Clocks for Digital Waveform Generator/Analyzers for more information about the Reference clock.

Related Topics

niHSDIO Configure Ref Clock

instrument handle identifies your instrument session. instrument handle is obtained from the niHSDIO Init Acquisition Session VI, the niHSDIO Init Generation Session VI, or the niHSDIO Init Ext Cal VI.

source specifies the phase-lock loop (PLL) reference clock source.

None	Configures the device to not phase lock the onboard clock with a Reference clock.
ClkIn	Configures the device to phase lock the onboard clock with the clock signal present at the CLK IN connector.
PXI Clock	Configures the device to phase lock the onboard clock with the clock signal present at the PXI reference clock pin on the PXI backplane. PXI_CLK10 is available for PXI devices, and PXIe_CLK100 is available for PXI Express devices. This clock signal is not supported on PCI devices.
RTSI 7	Configures the device to phase lock the onboard clock with the clock signal present at the RTSI 7 pin on the PCI backplane. This clock signal is not supported on PXI devices.
PXIe DStarA	Configures the device to phase lock the onboard clock with the PXIe_DStarA signal present on the PXI Express backplane. This clock signal is supported only on NI 6555/6556 devices.

clock rate specifies the Reference clock rate, expressed in Hz.

error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.

	status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
	code is the error or warning code. The default is 0. If status is TRUE, code is a negative error code. If status is FALSE, code is 0 or a warning code.
	source identifies where an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.

instrument handle out passes a reference to your instrument session to the next VI. instrument handle is obtained from the niHSDIO Init Acquisition Session VI or the niHSDIO Init Generation Session VI.

error out contains error information. This output provides standard error out functionality.

	status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
	code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
	source identifies where and why an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.

NI-HSDIO LabVIEW VIs

Table of Contents

niHSDIO Configure Ref Clock VI