Configures the NI-RFSA device Reference Clock.

Syntax

ViStatus _VI_FUNC niRFSA_ConfigureRefClock(ViSession vi, ViConstString clockSource, ViReal64 refClockRate)

Remarks

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5694, PXIe-5820/5830/5831/5832/5840/5841/5842/5860

Related Topics

PXI-5661 Reference Clock

PXIe-5663 Timing Configurations

PXIe-5665 Timing Configurations

PXIe-5667 Timing Configurations

PXIe-5668 Timing Configurations

PXIe-5830 Timing Configurations

PXIe-5831 Timing Configurations

Parameters

NameDirectionTypeDescription
vi[in]ViSession

Identifies your instrument session. vi is obtained from the niRFSA_Init or niRFSA_InitWithOptions function

clockSource[in]ViConstString

specifies the source of the Reference Clock signal.

Clock Source

Description

Onboard Clock (default)

Uses the onboard Reference Clock as the clock source. PXIe-5830/5831/5832-
- PXIe-5830: Connect PXIe-5820 REF IN to PXIe-3621 REF OUT.
- PXIe-5831: Connect PXIe-5820 REF IN to PXIe-3622 REF OUT.
- PXIe-5832: Connect PXIe-5820 REF IN to PXIe-3623 REF OUT. PXIe-5831 with PXIe-5653-
- Connect PXIe-5820 REF IN to PXIe-3622 REF OUT.
- Connect PXIe-5653 REF OUT (10 MHz) to PXIe-3622 REF IN. PXIe-5832 with PXIe-5653-
- Connect PXIe-5820 REF IN to PXIe-3623 REF OUT.
- Connect PXIe-5653 REF OUT (10 MHz) to PXIe-3623 REF IN. PXIe-5841 with PXIe-5655-
- Lock to PXIe-5655 onboard clock. Connect REF OUT on PXIe-5655 to PXIe-5841 REF IN. PXIe-5842-
- Lock to PXIe-5655 onboard clock. Use cables as shown in the Getting Started Guide.

RefIn

Uses the signal at the front panel REF IN connector. PXIe-5830/5831/5832-
- PXIe-5830: Connect PXIe-5820 REF IN to PXIe-3621 REF OUT; lock external signal to PXIe-3621 REF IN.
- PXIe-5831: Connect PXIe-5820 REF IN to PXIe-3622 REF OUT; lock external signal to PXIe-3622 REF IN.
- PXIe-5832: Connect PXIe-5820 REF IN to PXIe-3623 REF OUT; lock external signal to PXIe-3623 REF IN. PXIe-5831 with PXIe-5653-
- Connect PXIe-5820 REF IN to PXIe-3622 REF OUT.
- Connect PXIe-5653 REF OUT (10 MHz) to PXIe-3622 REF IN.
- Lock external signal to PXIe-5653 REF IN. PXIe-5832 with PXIe-5653-
- Connect PXIe-5820 REF IN to PXIe-3623 REF OUT.
- Connect PXIe-5653 REF OUT (10 MHz) to PXIe-3623 REF IN.
- Lock external signal to PXIe-5653 REF IN. PXIe-5841 with PXIe-5655-
- Lock to signal at REF IN on PXIe-5655. Connect REF OUT on PXIe-5655 to PXIe-5841 REF IN. PXIe-5842-
- Lock to signal at REF IN on PXIe-5655. Use cables as shown in the Getting Started Guide.

PXI Clock

Uses the PXI_CLK signal present on the PXI backplane.

PXI_ClkMaster

Valid only for PXIe-5831 with PXIe-5653 and PXIe-5832 with PXIe-5653. PXIe-5831 with PXIe-5653-
- NI-RFSG configures PXIe-5653 to export Reference Clock.
- Configures PXIe-5820 and PXIe-3622 to use PXI_Clk.
- Connect PXIe-5653 REF OUT (10 MHz) to PXI chassis REF IN. PXIe-5832 with PXIe-5653-
- NI-RFSG configures PXIe-5653 to export Reference Clock.
- Configures PXIe-5820 and PXIe-3623 to use PXI_Clk.
- Connect PXIe-5653 REF OUT (10 MHz) to PXI chassis REF IN.

refClockRate[in]ViReal64

specifies the Reference Clock rate, in hertz (Hz), of the signal present at the REF IN or CLK IN connector. This parameter is only valid when the ref clock source parameter is set to RefIn. The default value is Auto (-1.0), which allows NI-RFSG to use the default Reference Clock rate for the device or automatically detect the Reference Clock rate, if supported. Refer to the Reference Clock Rate property for possible values.

Returns

Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an NI-RFSA function to determine if an error has occurred. To obtain a text description of the status code and additional information about the error condition, call the niRFSA_GetError function. To clear the error information from NI-RFSA, call the niRFSA_ClearError function. The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors