Skip to content

NI RFSA Signal Path Attributes

Greg Stoll edited this page Nov 11, 2021 · 1 revision

Signal Path Attributes

NIRFSA_ATTR_DIGITAL_IF_EQUALIZATION_ENABLED

Specific Attribute

Data
type
Access High Level Functions
ViBoolean R/W None

Description

Enables use of the digital equalization filter for the RF downconverter.

PXIe-5820/5830/5831/5832/5840/5841—The only valid value for this attribute is VI_TRUE.

Note Note  For PXIe-5665/5667 devices, digital IF equalization is supported only with a 150 MHz clock. You cannot set this attribute to VI_TRUE if the NIRFSA_ATTR_DIGITIZER_SAMPLE_CLOCK_TIMEBASE_SOURCE attribute is set to NIRFSA_VAL_LO_REF_CLK_STR.
Note Note  For the PXIe-5665 (14 GHz)/5667 (7 GHz)/5668, the preselector is not part of the IF filter path, so NI-RFSA does not equalize the preselector distortions.
Defined Values:
VI_TRUE Enables digital IF equalization on the RF downconverter.
VI_FALSE Disables digital IF equalization on the RF downconverter.
Default Value: VI_TRUE, if the device configuration is supported.

Supported Devices: PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841

NIRFSA_ATTR_LO_FREQUENCY

Specific Attribute

Data
type
Access High Level Functions
ViReal64 R/W None

Description

Specifies the LO signal frequency for the configured center frequency.

If you are using the NI RF vector signal analyzer with an external LO, use this attribute to specify the LO frequency that the external LO source passes into the LO IN or LO1 IN connector on the RF downconverter front panel. If you are using an external LO, reading the value of this attribute after configuring the rest of the parameters returns the LO frequency needed by the device.

Set this attribute to the actual LO frequency because NI-RFSA corrects for any difference between expected and actual LO frequencies.

To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the niRFSA_SetAttributeViReal64 function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string).

Default Values:

PXIe-5694: 215 MHz

All other devices: 0

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

Related Topics

PXIe-5830 Frequency and Bandwidth Configuration

PXIe-5831/5832 Frequency and Bandwidth Configuration

PXIe-5841 Frequency and Bandwidth Configuration

NIRFSA_ATTR_LO_SOURCE

Specific Attribute

Data
type
Access High Level Functions
Vistring R/W None

Description

Specifies the LO signal source used to downconvert the RF input signal. If no signal downconversion is required, this attribute is ignored. If this attribute is set to "" (empty string), NI-RFSA uses the internal LO source.

To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the niRFSA_SetAttributeViString function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string).

Note Note For the PXIe-5841 with PXIe-5655, RF list mode is not supported when this attribute is set to NIRFSA_VAL_LO_SOURCE_SG_SA_SHARED_STR.
Defined Values:
NIRFSA_VAL_NONE_STR Specifies that no LO source is required to downconvert the RF input signal.
NIRFSA_VAL_LO_IN_STR ("LO_In") Specifies that the LO source used to downconvert the RF input signal is connected to the LO IN connector on the front panel.
NIRFSA_VAL_ONBOARD_STR ("Onboard") Specifies that the onboard synthesizer is used to generate the LO signal that downconverts the RF input signal.

PXIe-5831/5832—This configuration uses the onboard LO of the PXIe-3622, using the LO2 stage.

PXIe-5831/5832 with PXIe-5653—This configuration uses the onboard LO of the PXIe-5653 when associated with the PXIe-3622.

PXIe-5841 with PXIe-5655—This configuration uses the onboard LO of the PXIe-5655.
NIRFSA_VAL_LO_SOURCE_SECONDARY_STR ("Secondary") Uses the PXIe-5831/5840 internal LO as the LO source. This value is valid on only the PXIe-5831 with PXIe-5653 (LO1 stage only) or PXIe-5832 with PCIe-5653 (LO1 stage only).
NIRFSA_VAL_LO_SOURCE_SG_SA_SHARED_STR ("SG_SA_Shared") Uses the same internal LO during NI-RFSA and NI-RFSG sessions. NI-RFSA selects an internal synthesizer and the synthesizer signal is switched to both the RF Out and RF In mixers. This value is valid on only the PXIe-5830/5831/5832/5841 with PXIe-5655.
Default Value: NIRFSA_VAL_ONBOARD_STR ("Onboard")

Supported Devices: PXIe-5644/5645/5646, PXIe-5694, PXIe-5830/5831/5832/5840/5841

Related Topics

PXIe-5830 LO Sharing Using NI-RFSA and NI-RFSG

PXIe-5831/5832 LO Sharing Using NI-RFSA and NI-RFSG

NIRFSA_ATTR_LO_EXPORT_ENABLED

Specific Attribute

Data
type
Access High Level Functions
ViBoolean R/W None

Description

Specifies whether to enable the LO OUT terminals on the installed devices.

PXIe-5601—The only valid value for this attribute is VI_TRUE.

PXIe-5603/5605/5606—If you want to daisy-chain multiple devices together using the same LO source, set this attribute to TRUE to export the LO input signals on the LO1 IN, LO2 IN, and LO3 IN terminals to LO1 OUT, LO2 OUT, and LO3 OUT, respectively.

PXIe-5694—You can enable this attribute only if you set the NIRFSA_ATTR_LO_SOURCE attribute to NIRFSA_VAL_LO_IN_STR, or if you set the NIRFSA_ATTR_LO_SOURCE attribute to NIRFSA_VAL_ONBOARD_STR and the NIRFSA_ATTR_IF_CONDITIONING_DOWN_CONVERSION_ENABLED attribute to NIRFSA_VAL_ENABLED.

PXIe-5830/5831—To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the niRFSA_SetAttributeViBoolean function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the only valid value for the channel string is "" (empty string).

Note Note  If you are sharing an LO for the PXIe-5830/5831/5832 between an NI-RFSA and NI-RFSG session, ensure both sessions use the same shared setting.
Defined Values:
VI_TRUE Enables the LO OUT terminals.
VI_FALSE Disables the LO OUT terminals.
Default Values:

PXIe-5601, PXIe-5663/5663E—VI_TRUE

PXIe-5603/5605/5606, PXIe-5644/5645/5646, PXIe-5665/5667/5668, PXIe-5694, PXIe-5830/5831/5832/5840/5841—VI_FALSE

Supported Devices: PXIe-5601/5603/5605 (external digitizer mode), PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5667, PXIe-5694, PXIe-5830/5831/5832/5840/5841

NIRFSA_ATTR_LO2_EXPORT_ENABLED

Data
type
Access Coercion High Level Functions
ViBoolean R/W None None

Description

Specifies whether to enable the LO2 OUT terminal on the installed devices.

Set this attribute to TRUE to export the 4 GHz LO signal from the device LO2 IN terminal to the LO2 OUT terminal.

You can also export the LO2 signal by setting the NIRFSA_ATTR_LO_EXPORT_ENABLED attribute and the NIRFSA_ATTR_DIGITIZER_SAMPLE_CLOCK_TIMEBASE_SOURCE attribute.

Defined Values:

VI_TRUE Enables the LO2 OUT terminal.
VI_FALSE Disables the LO2 OUT terminal.
Default Value: VI_FALSE

Supported Devices: PXIe-5603/5605/5606 (external digitizer mode), PXIe-5665/5668

NIRFSA_ATTR_RF_OUT_LO_EXPORT_ENABLED

Specific Attribute

Data
type
Access High Level Functions
ViInt32 R/W None

Description

Specifies whether to enable the RF OUT LO OUT terminal on the PXIe-5840/5841.

When this attribute is enabled, if the NIRFSA_ATTR_LO_SOURCE attribute is set to NIRFSA_VAL_LO_IN_STR and you do not set the NIRFSA_ATTR_LO_FREQUENCY or NIRFSA_ATTR_DOWNCONVERTER_CENTER_FREQUENCY attributes, NI-RFSA rounds the LO frequency to approximately an LO step size as if the source was NIRFSA_VAL_ONBOARD_STR. This ensures that when you configure NI-RFSA and NI-RFSG with compatible settings that result in the same LO frequency, the rounding also is compatible.

Defined Values:

NIRFSA_VAL_DISABLED (1900) The LO signal is not exported from the RF OUT LO OUT terminal.
NIRFSA_VAL_ENABLED (1901) The LO signal is exported from the RF OUT LO OUT terminal.
NIRFSA_VAL_UNSPECIFIED (1902) The LO signal may or may not be exported to the RF OUT LO OUT terminal, because NI-RFSG may be controlling it.
Default Value: NIRFSA_VAL_UNSPECIFIED

Supported Devices: PXIe-5840/5841

NIRFSA_ATTR_LO_OUT_EXPORT_CONFIGURE_FROM_RFSG

Specific Attribute

Data
type
Access High Level Functions
ViInt32 R/W None

Description

Specifies whether to allow NI-RFSG to control the NI-RFSA LO out export.

Set this attribute to NIRFSA_VAL_ENABLED to allow NI-RFSG to control the LO out export. Use the NIRFSG_ATTR_RF_IN_LO_EXPORT_ENABLED attribute to control the NI-RFSA LO out export from NI-RFSG.

Defined Values:

NIRFSA_VAL_DISABLED (1900) Does not allow NI-RFSG to control the NI-RFSA local oscillator export.
NIRFSA_VAL_ENABLED (1901) Enables NI-RFSG to control the NI-RFSA local oscillator export.
Default Value: NIRFSA_VAL_DISABLED

Supported Devices: PXIe-5840/5841

NIRFSA_ATTR_ENABLE_FRACTIONAL_RESAMPLING

Specific Attribute

Data
type
Access High Level Functions
ViBoolean R/W None

Description

Specifies whether fractional resampling is enabled on the digitizer. Fractional resampling allows the digitizer to achieve very fine resolution on the I/Q rate value. Setting this attribute to VI_FALSE improves spectral performance.

PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841—The only valid value for this attribute is VI_TRUE.

PXIe-5668—When using a 400 MHz FPGA image, the only valid value for this attribute is VI_TRUE. When using a 800 MHz FPGA image, the only valid value for this attribute is VI_FALSE. Refer to NI-RFSA Instrument Driver FPGA Extensions for more information about FPGA images.

Defined Values:

VI_TRUE Enables fractional resampling.
VI_FALSE Disables fractional resampling.
Default Value: VI_TRUE

Supported Devices: PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841

NIRFSA_ATTR_DIGITIZER_DITHER_ENABLED

Specific Attribute

Data
type
Access High Level Functions
ViInt32 R/W None

Description

Specifies whether dithering is enabled on the digitizer.

Dithering adds band-limited noise in the analog signal path to help reduce the quantization effects of the A/D converter and improve spectral performance. On the PXIe-5622, this out-of-band noise is added at low frequencies up to approximately 12 MHz. On the PXIe-5624, this out-of-band noise is added at low frequencies up to approximately 50 MHz.

PXIe-5663/5663E/5665/5667—When you enable dithering, the maximum signal level is reduced by up to 3 dB. This signal level reduction is accounted for in the nominal input ranges of the PXIe-5622. Therefore, you can overrange the input by up to 3 dB with dither disabled. For example, the +4 dBm input range can handle signal levels up to +7 dBm with dither disabled. For wider bandwidth acquisitions, such as 40 MHz, disable dithering to eliminate residual leakage of the dither signal into the lower frequencies of the IF passband, which starts at 12.5 MHz and ends at 62.5 MHz. This leakage can slightly raise the noise floor in the lower frequencies, thus degrading the performance in high-sensitivity applications. When taking spectral measurements, this leakage can also appear as a wide, low-amplitude signal near 12.5 MHz and 62.5 MHz. The width and amplitude of the signal depends on your resolution bandwidth and the type of time-domain window you apply to your FFT.

PXIe-5668—When you enable dithering, the maximum signal level is reduced by up to 2 dB. For the PXIe-5624, the maximum input power with dither off is 8 dBm and the maximum input power with dither on is 6 dBm. When acquiring an 800 MHz bandwidth signal, the I/Q data contains the dither even if the dither signal is not in the displayed spectrum. The dither can affect actions like power level triggering.

Note Note  For the PXIe-5668, disabling dithering can negatively affect absolute amplitude accuracy.
Defined Values:
NIRFSA_VAL_DISABLED (1900) Disables dithering.
NIRFSA_VAL_ENABLED (1901) Enables dithering.
Note Note  For the PXIe-5820/5830/5831/5832/5840/5841, only NIRFSA_VAL_ENABLED is supported.
Default Value: NIRFSA_VAL_ENABLED

Supported Devices: PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841

NIRFSA_ATTR_IF_FILTER_BANDWIDTH

Specific Attribute

Data
type
Access High Level Functions
ViReal64 R/W None

Description

Specifies the IF filter path bandwidth for your device configuration.

Note Note  For composite devices, such as the PXIe-5665/5667/5668, the IF filter path bandwidth includes all IF filters across the component modules of a composite device.
NI-RFSA uses this attribute in conjunction with the NIRFSA_ATTR_DEVICE_INSTANTANEOUS_BANDWIDTH attribute and the NIRFSA_ATTR_DIGITAL_IF_EQUALIZATION_ENABLED attribute to determine the settings for your measurement. NI-RFSA selects the next highest available filter based on the value you specify. The following table lists the IF filters available for NI devices. You may specify a higher value than your device instantaneous bandwidth if your measurement requires it, but specifying a lower value returns an error.
Device IF Filter Bandwidth Range IF Filter
PXIe-5603/5665 (3.6 GHz) ≤300 kHz 300 kHz IF filter
>300 kHz and ≤5 MHz Through IF filter
>5 MHz Through IF filter
PXIe-5605/5665 (14 GHz) ≤300 kHz 300 kHz IF filter
>300 kHz and ≤5 MHz 5 MHz IF filter
>5 MHz Through IF filter
PXIe-5668 ≤300 kHz 300 kHz IF filter
>300 kHz and ≤5 MHz 5 MHz IF filter
>5 MHz and ≤100 MHz 100 MHz IF filter
>100 MHz and ≤320 MHz 320 MHz IF filter
>320 MHz 765 MHz IF filter
Valid Values:

PXIe-5603/5605: 0 to 80 MHz

PXIe-5665/5667: 0 to 50 MHz

PXIe-5668: 0 to 765 MHz

PXIe-5694: 0 to 50 MHz

Note Note  To set this attribute to values greater than 20 MHz, you must set the NIRFSA_ATTR_SIGNAL_CONDITIONING_ENABLED attribute to NIRFSA_VAL_SIGNAL_CONDITIONING_BYPASSED
Default Values: For spectrum acquisition types the default is greater than or equal to the NIRFSA_ATTR_SPECTRUM_SPAN attribute. NI-RFSA chooses the default value of the NIRFSA_ATTR_IF_FILTER_BANDWIDTH attribute to correspond to the appropriate IF filter. For I/Q acquisition types NI-RFSA chooses the default value corresponding to the widest IF filter possible for your equipment setup.

Supported Devices: PXIe-5603/5605/5606, PXIe-5665/5667/5668, PXIe-5694

Advanced

NIRFSA_ATTR_DOWNCONVERTER_LOOP_BANDWIDTH

Specific Attribute

Data
type
Access High Level Functions
ViInt32 R/W None

Description

Configures the loop bandwidth of the RF downconverter tuning PLLs. To set this attribute, the NI-RFSA device must be in the Configuration state.

PXI-5600/5661—For signal bandwidths greater than 10 MHz, NIRFSA_VAL_WIDE is the only value supported for this attribute.

PXIe-5601/5663/5663E—The PXIe-5601 does not support the NIRFSA_VAL_MEDIUM value. This attribute is not supported if you are using an external LO.

PXIe-5830/5831/5832/5840/5841—The PXIe-5840/5841 supports only NIRFSA_VAL_MEDIUM for this attribute. This attribute is not supported if you are using an external LO.

To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the niRFSA_SetAttributeViInt32 function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string).

Defined Values:

NIRFSA_VAL_NARROW (800) Specifies that the downconverter module uses a narrow loop bandwidth.
NIRFSA_VAL_MEDIUM (801) Specifies that the downconverter module uses a medium loop bandwidth.
NIRFSA_VAL_WIDE (802) Specifies that the downconverter module uses a wide loop bandwidth.
Default Values:

PXI-5600—NIRFSA_VAL_WIDE

PXIe-5601—NIRFSA_VAL_NARROW

PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841—NIRFSA_VAL_MEDIUM

Supported Devices: PXI-5600, PXIe-5601 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E, PXIe-5830/5831/5832/5840/5841

NIRFSA_ATTR_INPUT_ISOLATION_ENABLED

Specific Attribute

Data
type
Access High Level Functions
ViInt32 R/W None

Description

Specifies whether input isolation is enabled.

Enabling this attribute isolates the input signal at the RF IN connector on the RF downconverter from the rest of the RF downconverter signal path. Disabling this attribute reintegrates the input signal into the RF downconverter signal path.

Note Note  If you enable input isolation for your device, the device impedance is changed from the characteristic 50 Ω impedance. A change in the device impedance may also cause a VSWR value higher than the device specifications.
For the PXIe-5830/5831/5832, input isolation is supported for all available ports for your hardware configuration.

Defined Values:

NIRFSA_VAL_ENABLED Enables input isolation on the RF downconverter.
NIRFSA_VAL_DISABLED Disables input isolation on the RF downconverter.
Default Value: NIRFSA_VAL_DISABLED, if the device configuration is supported.

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

NIRFSA_ATTR_LO_INJECTION_SIDE

Specific Attribute

Data
type
Access High Level Functions
ViInt32 R/W None

Description

Specifies the LO injection side.

PXIe-5601/5663/5663E—For frequencies below 517.5 MHz or above 6.4125 GHz, the LO injection side is fixed and NI-RFSA returns an error if you specify the incorrect value. If you do not configure this attribute, NI-RFSA selects the default LO injection side based on the downconverter center frequency. Reset this attribute to return to automatic behavior.

PXIe-5603/5605/5665 (3.6 GHz)/5667 (3.6 GHz)—Setting this attribute to NIRFSA_VAL_LO_INJECTION_LOW_SIDE is not supported for this device.

PXIe-5605/5665 (14 GHz)/5667 (7 GHz)—Setting this attribute to NIRFSA_VAL_LO_INJECTION_LOW_SIDE is supported for this device for frequencies greater than 4 GHz, but this configuration is not calibrated, and device specifications are not guaranteed.

PXIe-5606/5668—Setting this attribute to NIRFSA_VAL_LO_INJECTION_LOW_SIDE is supported for certain frequencies in high band, varying by final IF frequency. This configuration is not calibrated and device specifications are not guaranteed.

Defined Values:

NIRFSA_VAL_LO_INJECTION_HIGH_SIDE (1300) Configures the LO signal that the NI-RFSA device generates at a frequency higher than the RF frequency. This LO frequency is given by the formula fLO = fRF + fIF .
NIRFSA_VAL_LO_INJECTION_LOW_SIDE (1301) Configures the LO signal that the NI-RFSA device generates at a frequency lower than the RF frequency. This LO frequency is given by the formula fLO = fRF – fIF .
Default Values:

PXIe-5601 (external digitizer mode), PXIe-5663/5663E (frequencies < 3.0 GHz)—NIRFSA_VAL_LO_INJECTION_HIGH_SIDE

PXIe-5601 (external digitizer mode), PXIe-5663/5663E (frequencies ≥ 3.0 GHz)—NIRFSA_VAL_LO_INJECTION_LOW_SIDE

PXIe-5603/5605/5606 (external digitizer mode), PXIe-5665/5667/5668—NIRFSA_VAL_LO_INJECTION_HIGH_SIDE

Supported Devices: PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5663/5663E/5665/5667/5668

NIRFSA_ATTR_FREQUENCY_SETTLING_UNITS

Specific Attribute

Data
type
Access High Level Functions
ViInt32 R/W None

Description

Specifies the delay duration units and interpretation for LO settling. Specify the actual settling value using the NIRFSA_ATTR_FREQUENCY_SETTLING attribute. This attribute is not supported if you are using an external LO.

Defined Values:

NIRFSA_VAL_FSU_PPM (2000) Specifies the frequency settling time in parts per million (PPM).
NIRFSA_VAL_FSU_SECONDS_AFTER_LOCK (2001) Specifies the frequency settling in time after lock (seconds).
NIRFSA_VAL_FSU_SECONDS_AFTER_IO (2002) Specifies the frequency settling time after I/O (seconds).
Default Value: NIRFSA_VAL_FSU_PPM

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

NIRFSA_ATTR_FREQUENCY_SETTLING

Specific Attribute

Data
type
Access High Level Functions
ViReal64 R/W None

Description

Specifies the value used for local oscillator (LO) frequency settling. The units and interpretation for this scalar value are specified using the NIRFSA_ATTR_FREQUENCY_SETTLING_UNITS attribute. This attribute is not supported if you are using an external LO.

The valid values for this attribute depend on the NIRFSA_ATTR_FREQUENCY_SETTLING_UNITS attribute.

Valid Values:

Device NIRFSA_ATTR_FREQUENCY_SETTLING_UNITS Attribute Value
NIRFSA_VAL_FSU_SECONDS_AFTER_LOCK NIRFSA_VAL_FSU_SECONDS_AFTER_IO NIRFSA_VAL_FSU_PPM
PXIe-5663/5663E 2 microseconds1 to 80 milliseconds, resolution of approximately 2 microseconds 0 microseconds to 80 milliseconds2, resolution of 1 microsecond 1.0, 0.1, 0.01
PXIe-5665/5667/5668 4 microseconds to 80 milliseconds, resolution of approximately 4 microseconds 0 microseconds to 80 milliseconds2, resolution of 1 microsecond 1.0, 0.1, 0.01, 0.001
PXIe-5644/5645/5646 1 microsecond1 to 65 milliseconds, resolution of 1 microsecond 1 microsecond1 to 65 milliseconds, resolution of 1 microsecond 1.0, 0.1, 0.01
PXIe-5830/5831/5832/5840/5841 1 microsecond1 to 10 seconds, resolution of 1 microsecond 0 microseconds to 10 seconds, resolution of 1 microsecond 1.0 to 0.01
PXIe-5831/5832 with PXIe-5653 (using PXIe-3622 LO)3
PXIe-5831/5832 with PXIe-5653 (using PXIe-5653 LO)3 4 microseconds to 80 milliseconds, resolution of approximately 4 microseconds 0 microseconds to 80 milliseconds, resolution of 1 microsecond
1If the NIRFSA_ATTR_FREQUENCY_SETTLING_UNITS attribute is set to NIRFSA_VAL_FSU_TIME_AFTER_LOCK and the NIRFSA_ATTR_DOWNCONVERTER_LOOP_BANDWIDTH attribute is set to NIRFSA_VAL_NARROW, NI recommends a minimum settling time of 128 microseconds to ensure that the phase-locked loop (PLL) lock stabilizes. If the NIRFSA_ATTR_DOWNCONVERTER_LOOP_BANDWIDTH is set to NIRFSA_VAL_WIDE, NI recommends a minimum settling time of 16 microseconds.
2When in RF list mode, the valid values for NIRFSA_VAL_FSU_TIME_AFTER_IO are 0 microseconds to 50 milliseconds.
3The valid values for this configuration depend on the module used as the LO source. Refer to the NIRFSA_ATTR_LO_SOURCE attribute for more information.
Default Value: 0.1

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

NIRFSA_ATTR_LO_YIG_MAIN_COIL_DRIVE

Data
type
Access High Level Functions
ViInt32 R/W None

Description

Adjusts the dynamics of the current driving the YIG main coil.

Note Note  Setting this attribute to NIRFSA_VAL_LO_YIG_MAIN_COIL_DRIVE_FAST allows the frequency to settle significantly faster for some frequency transitions at the expense of increased phase noise. This attribute is not supported if you are using an external LO.
Defined Values:
NIRFSA_VAL_LO_YIG_MAIN_COIL_DRIVE_NORMAL (2400) Adjusts the YIG main coil on the LO for an underdamped response.
NIRFSA_VAL_LO_YIG_MAIN_COIL_DRIVE_FAST (2401) Adjusts the YIG main coil on the LO for an overdamped response.
Default Value: NIRFSA_VAL_LO_YIG_MAIN_COIL_DRIVE_NORMAL

Supported Devices: PXIe-5603/5605/5606 (external digitizer mode), PXIe-5665/5667/5668

NIRFSA_ATTR_DOWNCONVERTER_PRESELECTOR_ENABLED

Data
type
Access High Level Functions
ViInt32 R/W None

Description

Specifies whether the tunable preselector is enabled on the downconverter.

Note Note  All devices support setting this attribute to NIRFSA_VAL_DISABLED or NIRFSA_VAL_PRESELECTOR_ENABLED_WHEN_IN_SIGNAL_PATH. Only devices with a preselector support setting this attribute to NIRFSA_VAL_PRESELECTOR_ENABLED.
Defined Values:
NIRFSA_VAL_PRESELECTOR_DISABLED (2600) Disables the preselector.
NIRFSA_VAL_PRESELECTOR_ENABLED_WHEN_IN_SIGNAL_PATH (2601) The preselector is automatically enabled when it is in the signal path and is automatically disabled when it is not in the signal path. Use the NIRFSA_ATTR_PRESELECTOR_PRESENT attribute to determine if the downconverter has an preselector.
NIRFSA_VAL_PRESELECTOR_ENABLED (2602) Enables the preselector. If the preselector is not in the signal path or if the preselector is not supported on the device, NI-RFSA returns an error. Select the NIRFSA_VAL_PRESELECTOR_ENABLED_WHEN_IN_SIGNAL_PATH whenever possible avoid an error.
Default Value: NIRFSA_VAL_PRESELECTOR_DISABLED if the device has no preselector. NIRFSA_VAL_PRESELECTOR_ENABLED_WHEN_IN_SIGNAL_PATH if the device has a preselector.

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-5830/5831/5832/5840/5841

NIRFSA_ATTR_NOTCH_FILTER_ENABLED

Specific Attribute

Data
type
Access High Level Functions
ViInt32 R/W None

Description

Specifies whether the notch filter is enabled on the RF conditioning module.

Note Note  The PXI-5661 and PXIe-5663/5663E/5665 only support setting this attribute to NIRFSA_VAL_NOTCH_FILTER_DISABLED.
Defined Values:
NIRFSA_VAL_NOTCH_FILTER_DISABLED (3400) Disables the notch filter.
NIRFSA_VAL_NOTCH_FILTER_ENABLED_WHEN_IN_SIGNAL_PATH (3401) The notch filter is automatically enabled when it is in the signal path and automatically disabled when it is not in the signal path.
NIRFSA_VAL_NOTCH_FILTER_ENABLED (3402) Enables the notch filter. If the notch filter is not in the signal path or if the notch filter is not supported on the device, NI-RFSA returns an error. Select NIRFSA_VAL_NOTCH_FILTER_ENABLED_WHEN_IN_SIGNAL_PATH whenever possible to avoid an error.
Default Value: NIRFSA_VAL_NOTCH_FILTER_DISABLED

Supported Devices: PXI-5661, PXIe-5663/5663E/5665/5667, PXIe-5693

NIRFSA_ATTR_RF_PRESELECTOR_FILTER

Specific Attribute

Data
type
Access High Level Functions
ViInt32 R/W None

Description

Specifies the RF preselector filter to use.

Note  You can write to this attribute when using only the PXIe-5693 as a stand-alone device.
Defined Values:
NIRFSA_VAL_RF_PRESELECTOR_FILTER_PATH_NONE (3300) Specifies that no preselector path is used.
NIRFSA_VAL_RF_PRESELECTOR_FILTER_PATH_1 (3301) Specifies that the 19 MHz to 35 MHz preselector filter is used.
NIRFSA_VAL_RF_PRESELECTOR_FILTER_PATH_2 (3302) Specifies that the 33 MHz to 61 MHz preselector filter is used.
NIRFSA_VAL_RF_PRESELECTOR_FILTER_PATH_3 (3303) Specifies that the 59 MHz to 110 MHz preselector filter is used.
NIRFSA_VAL_RF_PRESELECTOR_FILTER_PATH_4 (3304) Specifies that the 90 MHz to 170 MHz preselector filter is used.
NIRFSA_VAL_RF_PRESELECTOR_FILTER_PATH_5 (3305) Specifies that the 140 MHz to 245 MHz preselector filter is used.
NIRFSA_VAL_RF_PRESELECTOR_FILTER_PATH_6 (3306) Specifies that the 205 MHz to 370 MHz preselector filter is used.
NIRFSA_VAL_RF_PRESELECTOR_FILTER_PATH_7 (3307) Specifies that the 330 MHz to 575 MHz preselector filter is used.
NIRFSA_VAL_RF_PRESELECTOR_FILTER_PATH_8 (3308) Specifies that the 530 MHz to 975 MHz preselector filter is used.
NIRFSA_VAL_RF_PRESELECTOR_FILTER_PATH_9 (3309) Specifies that the 910 MHz to 1,640 MHz preselector filter is used.
NIRFSA_VAL_RF_PRESELECTOR_FILTER_PATH_10 (3310) Specifies that the 1,560 MHz to 2,040 MHz preselector filter is used.
NIRFSA_VAL_RF_PRESELECTOR_FILTER_PATH_11 (3311) Specifies that the 1,960 MHz to 2,540 MHz pre-elector filter is used.
NIRFSA_VAL_RF_PRESELECTOR_FILTER_PATH_12 (3312) Specifies that the 2,460 MHz to 3,040 MHz preselector filter is used.
NIRFSA_VAL_RF_PRESELECTOR_FILTER_PATH_13 (3313) Specifies that the 2,960 MHz to 3,840 MHz preselector filter is used.
NIRFSA_VAL_RF_PRESELECTOR_FILTER_PATH_14 (3314) Specifies that the 3,760 MHz to 4,640 MHz preselector filter is used.
NIRFSA_VAL_RF_PRESELECTOR_FILTER_PATH_15 (3315) Specifies that the 4,560 MHz to 5,840 MHz preselector filter is used.
NIRFSA_VAL_RF_PRESELECTOR_FILTER_PATH_16 (3316) Specifies that the 5,760 MHz to 7,040 MHz preselector filter is used.
NIRFSA_VAL_RF_PRESELECTOR_FILTER_PATH_EXTERNAL_FILTER (3317) Specifies that the 20 MHz to 3.04 GHz external filter filter path is used.
Default Values:

PXIe-5667, PXIe-5693: NIRFSA_VAL_RF_PRESELECTOR_FILTER_PATH_9

PXIe-5665: NIRFSA_VAL_RF_PRESELECTOR_FILTER_PATH_NONE

Supported Devices: PXIe-5665/5667, PXIe-5693

NIRFSA_ATTR_LOW_FREQUENCY_BYPASS_ENABLED

Specific Attribute

Data
type
Access High Level Functions
ViInt32 R/W None

Description

Specifies whether to use the low-frequency bypass path for the incoming RF signal.

NIRFSA_VAL_DISABLED (1900) Disables the low-frequency bypass path.
NIRFSA_VAL_ENABLED (1901) Enables the low-frequency bypass path.
Default Value: NIRFSA_VAL_DISABLED

Supported Devices: PXIe-5693, PXIe-5667

NIRFSA_ATTR_IF_CONDITIONING_DOWN_CONVERSION_ENABLED

Specific Attribute

Data
type
Access High Level Functions
ViInt32 R/W None

Description

Specifies whether downconversion to 21.4 MHz is enabled for the IF conditioning module. The IF output frequency is 21.4 MHz when you enable this attribute, and it is 193.6 MHz when you disable this attribute.

Note Note  If you set the NIRFSA_ATTR_SIGNAL_CONDITIONING_ENABLED attribute to NIRFSA_VAL_SIGNAL_CONDITIONING_BYPASSED, you cannot set the NIRFSA_ATTR_IF_CONDITIONING_DOWN_CONVERSION_ENABLED attribute to NIRFSA_VAL_ENABLED.
Note Note  For the PXI-5661, PXIe-5663/5663E/5665, the only valid value for this attribute is NIRFSA_VAL_DISABLED.
Defined Values:
NIRFSA_VAL_ENABLED (1901) The attribute is enabled.
NIRFSA_VAL_DISABLED (1900) The attribute is disabled.
Default Values: NIRFSA_VAL_DISABLED

Supported Devices: PXIe-5667, PXIe-5694

NIRFSA_ATTR_RF_HIGH_PASS_FILTERING

Specific Attribute

Data
type
Access High Level Functions
ViReal64 R/W None

Description

Specifies the maximum corner frequency of the highpass filter in the RF signal path. The device uses the highest frequency highpass filter option below or equal to the value you specify and returns a coerced value. Specifying a value of 0 disables highpass filtering.

For multispan acquisitions, the device uses the appropriate filter for each subspan during acquisition, depending on the details of your application and the value you specify. In multispan acquisition spectrum applications, this attribute returns the value you specified rather than a coerced value if multiple highpass filters are used during the acquisition.

The PXIe-5606 features highpass filters at 1.35 GHz and 2.2 GHz.

Valid Values: 0 to 26.5

Default Value: 0

Supported Devices: PXIe-5606, PXIe-5668

NIRFSA_ATTR_SELECTED_PORTS

Specific Attribute

Data
type
Access High Level Functions
ViString R/W None

Description

Specifies the port to configure.

Note Note  When using RF list mode, ports cannot be shared with NI-RFSA.
Valid Values:

PXIe-5644/5645/5646, PXIe-5820/5840/5841: "" (empty string)

PXIe-5830: if0, if1

PXIe-5831/5832: if0, if1, rf*<0-1>/port*, where 0-1 indicates one (0) or two (1) mmRH-5582 connections and x is the port number on the mmRH-5582 front panel.

Default Value:

PXIe-5830/5831/5832: if1

PXIe-5644/5645/5646, PXIe-5820/5840/5841: "" (empty string)

Supported Devices: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

NIRFSA_ATTR_AVAILABLE_PORTS

NIRFSA_ATTR_AVAILABLE_PORTS

Specific Attribute

Data
type
Access High Level Functions
ViString RO None

Description

Returns a comma-separated list of the available ports for use based on your instrument configuration.

Supported Devices: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841

NI 5663

NIRFSA_ATTR_IF_FILTER

Specific Attribute

Data
type
Access High Level Functions
ViInt32 R/W None

Description

Specifies the desired IF filter path, regardless of the RF band chosen by NI-RFSA.

Defined Values:

NIRFSA_VAL_187_5_MHZ_WIDE (1400) The device uses the 187.5 MHz wide bandwidth filter.
NIRFSA_VAL_187_5_MHZ_NARROW (1401) The device uses the 187.5 MHz narrow bandwidth filter.
NIRFSA_VAL_53_MHZ (1402) The device uses the 53 MHz filter.
NIRFSA_VAL_BYPASS (1403) The device bypasses the IF filter.
Default Value: N/A

Supported Devices: PXIe-5601

NIRFSA_ATTR_RF_ATTENUATION_TABLE

Specific Attribute

Data
type
Access High Level Functions
ViInt32 R/W None

Description

Specifies which RF attenuator table to use.

Valid Values: 0 to 1

Default Value: N/A

Supported Devices: PXIe-5601 (external digitizer mode), PXIe-5663/5663E

NIRFSA_ATTR_RF_ATTENUATION_INDEX

Specific Attribute

Data
type
Access High Level Functions
ViInt32 R/W None

Description

Specifies the value of the RF attenuation from a table of valid configurations. This attribute is valid only during a calibration session and when you set the NIRFSA_ATTR_LOW_FREQUENCY_BYPASS_ENABLED attribute to NIRFSA_VAL_DISABLED.

Valid Values: 0 to 64

Default Value: N/A

Supported Devices: PXIe-5693

NIRFSA_ATTR_IF_ATTENUATION

Specific Attribute

Data
type
Access High Level Functions
ViReal64 R/W None

Description

Configures the device attenuation to a value that has the actual calibrated IF attenuation closest to the desired value.

Valid Values: 0 to 30

Default Value: N/A

Supported Devices: PXIe-5601/5603/5605 (external digitizer mode), PXIe-5663/5663E/5665/5667, PXIe-5693

NIRFSA_ATTR_IF1_ATTEN_VALUE

Specific Attribute

Data
type
Access High Level Functions
ViReal64 R/W None

Description

Specifies the IF1 attenuation, in dB. The device IF1 attenuator is set to this nominal value. Use this attribute, along with the NIRFSA_ATTR_IF2_ATTEN_VALUE attribute, when you set the NIRFSA_ATTR_IF_FILTER attribute to NIRFSA_VAL_BYPASS.

Valid Values: 0 to 15

Units: dB

Default Value: N/A

Supported Devices: PXIe-5601 (external digitizer mode), PXIe-5663/5663E

NIRFSA_ATTR_IF2_ATTEN_VALUE

Specific Attribute

Data
type
Access High Level Functions
ViReal64 R/W None

Description

Specifies the IF2 attenuation, in dB. The device IF2 attenuator is set to this nominal value. Use this attribute, along with the NIRFSA_ATTR_IF1_ATTEN_VALUE attribute, when you set the NIRFSA_ATTR_IF_FILTER attribute to NIRFSA_VAL_BYPASS.

Valid Values: 0 to 15

Units: dB

Default Value: N/A

Supported Devices: PXIe-5601 (external digitizer mode), PXIe-5663/5663E

NI 5694

NIRFSA_ATTR_SIGNAL_CONDITIONING_ENABLED

Specific Attribute

Data
type
Access High Level Functions
ViInt32 R/W None

Description

Specifies whether all signal conditioning is enabled on the PXIe-5694.

Note Note  If you set this attribute to NIRFSA_VAL_SIGNAL_CONDITIONING_BYPASSED, NI-RFSA bypasses all signal conditioning, prevents any signal downconversion, and fixes the values for NIRFSA_ATTR_DOWNCONVERTER_GAIN attribute, the NIRFSA_ATTR_DEVICE_INSTANTANEOUS_BANDWIDTH attribute, and the NIRFSA_ATTR_IF_FILTER_BANDWIDTH attribute.
Defined Values:
NIRFSA_VAL_SIGNAL_CONDITIONING_ENABLED (3600) Enables signal conditioning.
NIRFSA_VAL_SIGNAL_CONDITIONING_BYPASSED (3601) Bypasses all signal conditioning.
Default Value: NIRFSA_VAL_SIGNAL_CONDITIONING_ENABLED

Supported Devices: PXIe-5694

Table of Contents

Internal Development

Creating and Setting Up a gRPC Server

Server Security Support

Creating a gRPC Client

gRPC Client Examples

Session Utilities API Reference

Driver Documentation

gRPC API Differences From C API

Sharing Driver Sessions Between Clients

C API Docs
NI-DAQmx
NI-DCPOWER
NI-DIGITAL PATTERN DRIVER
NI-DMM
NI-FGEN
NI-FPGA
NI-RFmx Bluetooth
NI-RFmx NR
NI-RFmx WCDMA
NI-RFmx GSM
NI-RFmx CDMA2k
NI-RFmx Instr
NI-RFmx LTE
NI-RFmx SpecAn
NI-RFmx TD-SCDMA
NI-RFmx WLAN
NI-RFSA
NI-RFSG
NI-SCOPE
NI-SWITCH
NI-TCLK
NI-XNET
Clone this wiki locally