Skip to content

NI RFSG RF Attributes

Jump to bottom
Greg Stoll edited this page Nov 11, 2021 · 2 revisions

RF Attributes

RF Advanced

NIRFSG_ATTR_AMP_PATH

Specific Attribute

Numeric Value Data
type		 Access Applies to Coercion High Level Functions
1150185 ViInt32 R/W N/A None None

Description

Specifies the amplification path to use. The low harmonic path provides greater second and third harmonic spurious response, and the high power path provides higher output power.

NI-RFSG automatically sets the value of this attribute based on power and frequency settings. Setting this attribute overrides the value chosen by NI-RFSG.

Note Note  Resetting this attribute reverts back to the default unset behavior.
Defined Values:
NIRFSG_VAL_HIGH_POWER Sets the amplification path to use the high power path.
NIRFSG_VAL_LOW_HARMONIC Sets the amplification path to use the low harmonic path.
Default Value: NIRFSG_VAL_LOW_HARMONIC

Supported Devices: PXIe-5654 with PXIe-5696

Related Topics

Low Harmonic Path Versus High Power Path

NIRFSG_ATTR_CORRECTION_TEMPERATURE

Numeric Value Data
type		 Access Coercion High Level Functions
1150104 ViReal64 R/W None None

Description

Specifies the temperature, in degrees Celsius, to use for adjusting the device settings to correct for temperature changes. If you set this attribute, NI-RFSG uses the value you specify and therefore no longer uses the actual device temperature as the correction temperature. If you do not set this attribute, NI-RFSG checks the current device temperature in the Committed state and automatically sets the value of this attribute.

Note Note  Resetting this attribute reverts back to the default unset behavior.
Note Note  Use this attribute only when your application requires the same settings to be used every time, regardless of the temperature variation. In these cases, it is best to ensure that the temperature does not vary too much.
PXIe-5820/5830/5831/5832/5840/5841: This attribute is read only.

Units: Degrees Celsius

Supported Devices: PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

NIRFSG_ATTR_PULSE_MODULATION_MODE

Specific Attribute

Numeric Value Data
type		 Access Applies to Coercion High Level Functions
1150190 ViInt32 R/W N/A None None

Description

Specifies the pulse modulation mode to use.

Defined Values:

NIRFSG_VAL_OPTIMAL_MATCH Provides for a more optimal power output match for the device during the off cycle of the pulse mode operation.
NIRFSG_VAL_HIGH_ISOLATION Allows for the best on/off power ratio of the pulsed signal.
Default Value: NIRFSG_VAL_HIGH_ISOLATION

Supported Devices: PXIe-5654/5654 with PXIe-5696

NIRFSG_ATTR_REF_PLL_BANDWIDTH

Numeric Value Data
type		 Access Coercion High Level Functions
1150133 ViInt32 R/W None None

Description

Configures the loop bandwidth of the reference PLL.

Defined Values:

NIRFSG_VAL_NARROW Uses the narrowest loop bandwidth setting for the PLL. Setting this attribute to NIRFSG_VAL_NARROW allows the PXIe-5653 to lock to a reference with worse phase noise than the PXIe-5653 and utilize the better phase noise of the PXIe-5653.
NIRFSG_VAL_MEDIUM Uses the medium loop bandwidth setting for the PLL.
NIRFSG_VAL_WIDE Uses the widest loop bandwidth setting for the PLL. Setting this attribute to NIRFSG_VAL_WIDE on the PXIe-5653 allows the reference PLL to lock to a better reference with better phase noise than the PXIe-5653 and utilize the better phase noise of the reference.
Default Value: NIRFSG_VAL_NARROW

Supported Devices: PXIe-5653

Related Topics

Phase-Locked Loop Bandwidth

NIRFSG_ATTR_THERMAL_CORRECTION_HEADROOM_RANGE

Specific Attribute

Data
type		 Access High Level Functions
ViReal64 R/W None

Description

Specifies the expected thermal operating range of the instrument from the self-calibration temperature, in degrees Celsius, returned from the NIRFSG_ATTR_DEVICE_TEMPERATURE attribute.

For example, if this property is set to 5.0, and the device is self-calibrated at 35 °C, then you can expect to run the device from 30 °C to 40 °C with corrected accuracy and no overflows. Setting this property with a smaller value can result in improved dynamic range, but you must ensure thermal stability while the instrument is running. Operating the instrument outside of the specified range may cause degraded performance or DSP overflows.

Units: degrees Celsius (°C)

Default Value:

PXIe-5830/5831/5832: 5

PXIe-5840/5841: 10

Supported Devices: PXIe-5830/5831/5832/5840/5841

NIRFSG_ATTR_THERMAL_CORRECTION_TEMPERATURE_RESOLUTION

Specific Attribute

Data
type		 Access High Level Functions
ViReal64 R/W None

Description

Specifies the temperature change, in degrees Celsius, that is required before NI-RFSG recalculates the thermal correction settings when entering the Generation state.

Units: degrees Celsius (°C)

Supported Devices: PXIe-5820/5830/5831/5832/5840/5841

Default Values:

PXIe-5830/5831/5832: 0.2

PXIe-5840/5841: 1.0

NIRFSG_ATTR_YIG_MAIN_COIL_DRIVE

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

Description

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

Note Note  Setting this attribute to NIRFSG_VAL_FAST on the PXIe-5653 allows the frequency to settle significantly faster for some frequency transitions at the expense of increased phase noise.
Defined Values:
NIRFSG_VAL_SLOW Adjusts the YIG main coil for an underdamped response.
NIRFSG_VAL_FAST Adjusts the YIG main coil for an overdamped response.
Default Value: NIRFSG_VAL_SLOW

Supported Devices: PXIe-5653

NIRFSG_ATTR_ALC_CONTROL

Numeric Value Data
type		 Access Coercion High Level Functions
1150179 ViInt32 R/W None None

Description

Enables or disables the automatic leveling control (ALC).

PXIe-5654 with PXIe-5696: If this attribute is enabled, the ALC is closed (closed-loop mode) and allows for better amplitude accuracy and wider amplitude dynamic range. If this attribute is disabled, the ALC is open (open-loop mode), which is ideal when using modulation. Disabling the NIRFSG_ATTR_ALC_CONTROL attribute also allows for NI-RFSG to perform an automatic power search.

PXIe-5654: NIRFSG_VAL_DISABLE is the only supported value for this device. The PXIe-5654 does not support the ALC when used as a stand-alone device.

Defined Values:

NIRFSG_VAL_DISABLE Disables ALC.
NIRFSG_VAL_ENABLE Enables the ALC.
Default Value:

PXIe-5654: NIRFSG_VAL_DISABLE

PXIe-5654 with PXIe-5696: NIRFSG_VAL_ENABLE

Supported Devices: PXIe-5654/5654 with PXIe-5696

Related Topics

Power Level Adjustment

ALC Closed Loop Versus Open Loop

Power Search

NIRFSG_ATTR_ALLOW_OUT_OF_SPECIFICATION_USER_SETTINGS

Numeric Value Data
type		 Access Coercion High Level Functions
1150014 ViInt32 R/W None None

Description

Enables or disables warnings or errors when you set the frequency, power, and bandwidth values beyond the limits of the NI-RFSG device specifications. When you enable the NIRFSG_ATTR_ALLOW_OUT_OF_SPECIFICATION_USER_SETTINGS attribute, the driver does not report out-of-specification warnings or errors.

To set this attribute, the NI-RFSG device must be in the Configuration state.

Note  Accuracy cannot be guaranteed outside of device specifications, and results may vary by module.
Defined Values:
NIRFSG_VAL_DISABLED Disables out-of-specification user settings.
NIRFSG_VAL_ENABLE Enables out-of-specification user settings.
Default Value: NIRFSG_VAL_DISABLED

Supported Devices: PXI/PXIe-5650/5651/5652, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

NIRFSG_ATTR_AMPLITUDE_SETTLING

Numeric Value Data
type		 Access Coercion High Level Functions
1150137 ViReal64 R/W None None

Description

Configures the amplitude settling accuracy in decibels. NI-RFSG waits until the RF power settles within the specified accuracy level after calling the niRFSG_Initiate function or niRFSG_WaitUntilSettled function or prior to advancing to next step if using RF list mode.

Any specified amplitude settling value that is above the acceptable minimum value is coerced down to the closest valid value.

PXI/PXIe-5650/5651/5652: This attribute is for NI internal use only.

Units: dB

Default Value:

PXIe-5654: 4

PXIe-5654 with PXIe-5696 (ALC disabled): 4

PXIe-5654 with PXIe-5696 (ALC enabled): 0.2

PXIe-5820/5830/5831/5832/5840/5841: 0.5

Valid Values:

PXIe-5654: 1.5, 2, 4

PXIe-5654 with PXIe-5696 (ALC disabled): 1.5, 2, 4

PXIe-5654 with PXIe-5696 (ALC enabled): 0.2, 0.5

PXIe-5820/5830/5831/5832/5840/5841: 0.01 to 1

Supported Devices: PXIe-5654/5654 with PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Amplitude Settling Times

NIRFSG_ATTR_ATTENUATOR_HOLD_ENABLED

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

Description

Specifies whether attenuator hold is enabled. While this attribute is set to VI_TRUE, changing the power level causes NI-RFSG to scale the digital data sent to the AWG instead of adjusting the attenuators. Changing power levels in this manner allows the device to increase or decrease the power level in more accurate increments, but it may affect signal-to-noise ratios (noise density).

Setting the NIRFSG_ATTR_ATTENUATOR_HOLD_ENABLED attribute to VI_TRUE limits the power levels that can be attained. With attenuator hold enabled, the power level must satisfy the following conditions:

  • Power level less than or equal to maximum power level
  • Power level greater than or equal to (maximum power level -70 dB)
  • Power level greater than or equal to -145 dBm

To set this attribute, the NI-RFSG device must be in the Configuration state.

Note  The frequency cannot be changed on the PXI-5670/5671 or PXIe-5672 while this attribute is set to VI_TRUE.
Defined Values:
VI_TRUE Enables attenuator hold.
VI_FALSE Disables attenuator hold.
Default Value: VI_FALSE

Supported Devices: PXI-5670/5671, PXIe-5672/5673/5673E

Related Topics

Attenuator Hold

Settling Times

NIRFSG_ATTR_ATTENUATOR_HOLD_MAX_POWER

Numeric Value Data
type		 Access Coercion High Level Functions
1150010 ViReal64 R/W None None

Description

Specifies the maximum power level of the RF output signal when the NIRFSG_ATTR_ATTENUATOR_HOLD_ENABLED attribute is set to VI_TRUE.

To set this attribute, the NI-RFSG device must be in the Configuration state.

Units: dBm

Defined Values: Refer to the specifications document for your device for allowable maximum power levels.

Default Value:

PXI-5670/5671, PXIe-5672: 17

PXIe-5673/5673E: 10

Supported Devices: PXI-5670/5671, PXIe-5672/5673/5673E

Related Topics

Attenuator Hold

Settling Times

NIRFSG_ATTR_ATTENUATOR_SETTING

Numeric Value Data
type		 Access Coercion High Level Functions
1150173 ViReal64 RW None None

Description

Specifies the level of attenuation in the attenuator path. Setting this attribute overrides the value chosen by NI-RFSG. Not all power levels are achievable if you set this attribute.

Note Note  Resetting this attribute reverts back to the default unset behavior.
Units: dB

Valid Values: 0 dB to 110 dB in steps of 10

Supported Devices: PXIe-5654 with PXIe-5696

NIRFSG_ATTR_AUTO_POWER_SEARCH

Numeric Value Data
type		 Access Coercion High Level Functions
1150196 ViInt32 R/W None None

Description

Enables or disables automatic power search. When this attribute is enabled, a power search performs after the device is initiated, after output power is enabled, or when the frequency or power level changes while the device is generating. When this attribute is disabled, NI-RFSG does not perform a power search unless you call the niRFSG_PerformPowerSearch function.

This attribute is ignored when the NIRFSG_ATTR_ALC_CONTROL attribute is enabled.

PXIe-5654: NIRFSG_VAL_DISABLE is the only supported value for this device.

Defined Values:

NIRFSG_VAL_DISABLE Disables automatic power search.
NIRFSG_VAL_ENABLE Enables automatic power search.
Default Value:

PXIe-5654: NIRFSG_VAL_DISABLE

PXIe-5654 with PXIe-5696: NIRFSG_VAL_ENABLE

Supported Devices: PXIe-5654/5654 with PXIe-5696

Related Topics

Power Search

NIRFSG_ATTR_AUTOMATIC_THERMAL_CORRECTION

Numeric Value Data
type		 Access Coercion High Level Functions
1150008 ViInt32 R/W None None

Description

Enables or disables automatic thermal correction. When this attribute is enabled, changes to settings cause NI-RFSG to check whether the device temperature has changed and adjusts the settings as needed. When this attribute is disabled, you must explicitly call the niRFSG_PerformThermalCorrection function to adjust the device for temperature changes.

Defined Values:

NIRFSG_VAL_ENABLE Automatic thermal correction is enabled.
NIRFSG_VAL_DISABLED Automatic thermal correction is disabled.
Default Value: NIRFSG_VAL_ENABLE

Supported Devices: PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Temperature Monitoring

Settling Times

NIRFSG_ATTR_EXTERNAL_GAIN

Numeric Value Data
type		 Access Coercion High Level Functions
1150085 ViReal64 R/W None None

Description

Specifies the external amplification or attenuation, if any, between the RF signal generator and the device under test.

Positive values for this attribute represent amplification, and negative values for this attribute represent attenuation.

Note Note  Setting this attribute adjusts the actual device output power to compensate for any amplification or attenuation between the RF signal generator and the device under test.
Note  For the PXIe-5645, this attribute is ignored if you are using the I/Q ports.
Valid Values: -INF dB to +INF dB

Default Value: 0 dB

Supported Devices: PXIe-5644/5645/5646, PXIe-5654/5654 with PXIe-5696, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

NIRFSG_ATTR_FREQUENCY

Numeric Value Data
type		 Access Coercion High Level Functions
1250001 ViReal64 R/W None niRFSG_ConfigureRF

Description

Specifies the frequency of the generated RF signal. For arbitrary waveform generation, this attribute specifies the center frequency of the signal.

The PXI-5670/5671, PXIe-5672, and PXIe-5820 must be in the Configuration state to use this attribute. However, the PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXIe-5673/5673E, and PXIe-5830/5831/5832/5840/5841 can be in the Configuration or the Generation state to use this attribute.

Note  For the PXIe-5645, this attribute is ignored if you are using the I/Q ports.
Units: hertz (Hz)

Defined Values: Refer to the specifications document for your device allowable frequency settings.

Default Value:

PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E: 100 MHz

PXIe-5653: 4 GHz

PXIe-5820: 0 Hz

PXIe-5830/5831/5832: 6.5 GHz

PXIe-5840/5841: 1 GHz

Supported Devices: PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

NI-RFSG Instrument Driver Programming Flow

NIRFSG_ATTR_FREQUENCY_SETTLING

Numeric Value Data
type		 Access Coercion High Level Functions
1150083 ViInt32 R/W None None

Description

Specifies the frequency settling time. Interpretation of this value depends on the NIRFSG_ATTR_FREQUENCY_SETTLING_UNITS attribute.

Valid Values:

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

Device NIRFSG_ATTR_FREQUENCY_SETTLING_UNITS Attribute Value
NIRFSG_VAL_TIME_AFTER_LOCK NIRFSG_VAL_TIME_AFTER_IO NIRFSG_VAL_PPM2
PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5673/5673E 2 microseconds1 to 80 milliseconds, resolution of approximately 2 microseconds 0 microseconds to 80 milliseconds,
resolution of 1 microsecond		 1.0, 0.1, 0.01
PXIe-5653 1.0, 0.1, 0.01, 0.001
PXIe-5654/5654 with PXIe-5696 Not supported 0 microseconds to 65,535 microseconds, 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 2 microseconds1 to 80 milliseconds, resolution of approximately 2 microseconds 0 microseconds to 80 milliseconds, resolution of 1 microsecond
1To ensure that the PLL lock stabilizes when the NIRFSG_ATTR_FREQUENCY_SETTLING_UNITS attribute is set to NIRFSG_VAL_TIME_AFTER_LOCK, NI recommends a time of 128 microseconds, minimum, if the NIRFSG_ATTR_LOOP_BANDWIDTH attribute is set to NIRFSG_VAL_NARROW, and 16 microseconds, minimum, if the NIRFSG_ATTR_LOOP_BANDWIDTH attribute is set to NIRFSG_VAL_WIDE.
2Any specified PPM value that is above the acceptable minimum value is coerced down to the closest valid value.
3The valid values for this configuration depend on the module used as the LO source. Refer to the NIRFSG_ATTR_LO_SOURCE attribute for more information.
Default Value: 1.0

Supported Devices: PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841

Related Topics

Settling Times

Events

NIRFSG_ATTR_FREQUENCY_SETTLING_UNITS

Numeric Value Data
type		 Access Coercion High Level Functions
1150082 ViInt32 R/W None None

Description

Specifies the interpretation of the value passed to the NIRFSG_ATTR_FREQUENCY_SETTLING attribute.

Note Note If you set this attribute to NIRFSG_VAL_TIME_AFTER_IO, the definition of settled for the Configuration Settled event changes.
PXIe-5650/5651/5652/5653, PXIe-5673E: When the NIRFSG_ATTR_ACTIVE_CONFIGURATION_LIST attribute is set to a valid list name, the NIRFSG_ATTR_FREQUENCY_SETTLING_UNITS attribute supports only NIRFSG_VAL_TIME_AFTER_IO as a valid value.

PXIe-5654/5654 with PXIe-5696: The NIRFSG_ATTR_FREQUENCY_SETTLING_UNITS attribute supports only NIRFSG_VAL_TIME_AFTER_IO and NIRFSG_VAL_PPM as valid values.

NIRFSG_VAL_TIME_AFTER_LOCK Specifies the time to wait after the frequency PLL locks.
NIRFSG_VAL_TIME_AFTER_IO Specifies the time to wait after all writes occur to change the frequency.
NIRFSG_VAL_PPM Specifies the minimum frequency accuracy when settling completes. Units are in parts per million (PPM or 1E-6).
Supported Devices: PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841

Default Value: NIRFSG_VAL_PPM

Related Topics

Events

NIRFSG_ATTR_FREQUENCY_TOLERANCE

Numeric Value Data
type		 Access Coercion High Level Functions
1150006 ViReal64 R/W None None

Description

Specifies the allowable frequency error introduced during the software upconversion process. NI-RFSG may introduce a frequency error up to the specified amount to optimize computational speed and onboard memory usage while upconverting phase-continuous signals.

If the NIRFSG_ATTR_PHASE_CONTINUITY_ENABLED attribute is set to NIRFSG_VAL_DISABLE, the NIRFSG_ATTR_FREQUENCY_TOLERANCE attribute is ignored, and the driver does not introduce a frequency error. On devices that do not use software upconversion, this attribute is ignored. The PXI-5670 always uses software upconversion, and the PXI-5671 uses software upconversion for I/Q rates greater than 8.33 MS/s.

To set this attribute, the NI-RFSG device must be in the Configuration state.

Units: hertz (Hz)

Default Value: 50

Supported Devices: PXI-5670/5671

Related Topics

Phase Continuity

NIRFSG_ATTR_LO_FREQUENCY

Specific Attribute

Numeric Value Data
type		 Access Coercion High Level Functions
1150199 ViReal64 R/W None None

Description

Specifies the frequency of the LO source.

Note This attribute is read/write if you are using an external LO. Otherwise, this attribute is read-only.
To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the niRFSG_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).

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

Related Topics

PXIe-5830 Frequency and Bandwidth Configuration

PXIe-5831/5832 Frequency and Bandwidth Configuration

NIRFSG_ATTR_LO_IN_POWER

Numeric Value Data
type		 Access Coercion High Level Functions
1150067 ViReal64 RO None None

Description

Specifies the power level of the signal at the LO IN front panel connector.

Note Note  This attribute is read/write if you are using an external LO. Otherwise, this attribute is read-only.
Note Note  For the PXIe-5644/5645/5646, this attribute is always read-only.
To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the niRFSG_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).

Units: dBm

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

Related Topics

LO OUT

NIRFSG_ATTR_LO_OUT_ENABLED

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

Description

Specifies whether the local oscillator signal is present at the LO OUT front panel connector. The local oscillator signal remains at the LO OUT front panel connector until this attribute is set to VI_FALSE, even if the NIRFSG_ATTR_OUTPUT_ENABLED attribute is set to VI_FALSE, the niRFSG_Abort function is called, or the NI-RFSG session is closed.

To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the niRFSG_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 the only valid value for the channel string is "" (empty string).

Defined Values:

VI_TRUE The local oscillator signal is present at the LO OUT front panel connector.
VI_FALSE The local oscillator signal is not present at the LO OUT front panel connector.
Default Value: VI_FALSE

Supported Devices: PXI-5610, PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5830/5831/5832/5840/5841

Related Topics

LO OUT

NIRFSG_ATTR_LO_OUT_POWER

Numeric Value Data
type		 Access Coercion High Level Functions
1150066 ViReal64 R/W None None

Description

Specifies the power level of the signal at the LO OUT front panel connector.

Note Note  For the PXIe-5644/5645/5646 and PXIe-5673/5673E, this attribute is always read-only.
To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the niRFSG_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).

Units: dBm

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

Related Topics

LO OUT

NIRFSG_ATTR_RF_IN_LO_EXPORT_ENABLED

Specific Attribute

Data
type		 Access High Level Functions
ViInt32 R/W None

Description

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

Set this attribute to NIRFSG_VAL_ENABLE to export the LO signal from the RF IN LO OUT terminal.

When this attribute is enabled, if the NIRFSG_ATTR_LO_SOURCE attribute is set to NIRFSG_VAL_LO_IN_STR and you do not set the NIRFSG_ATTR_LO_FREQUENCY or NIRFSG_ATTR_UPCONVERTER_CENTER_FREQUENCY attributes, NI-RFSG rounds the LO frequency to approximately an LO step size as if the source was NIRFSG_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:

NIRFSG_VAL_DISABLE The RF In local oscillator signal is not present at the front panel LO OUT connector.
NIRFSG_VAL_ENABLE The RF In local oscillator signal is present at the front panel LO OUT connector.
NIRFSG_VAL_UNSPECIFIED The RF IN local oscillator signal may or may not be present at the front panel LO OUT connector, because NI-RFSA may be controlling it.
Default Value: NIRFSA_VAL_UNSPECIFIED

Supported Devices: PXIe-5840/5841

NIRFSG_ATTR_LO_OUT_EXPORT_CONFIGURE_FROM_RFSA

Specific Attribute

Data
type		 Access High Level Functions
ViInt32 R/W None

Description

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

Set this attribute to NIRFSG_VAL_ENABLE to allow NI-RFSA to control the LO out export. Use the NIRFSA_ATTR_RF_OUT_LO_EXPORT_ENABLED attribute to control the LO out export from NI-RFSA.

Defined Values:

NIRFSG_VAL_DISABLE Do not allow NI-RFSA to control the NI-RFSG local oscillator export.
NIRFSG_VAL_ENABLE Allow NI-RFSA to control the NI-RFSG local oscillator export.
Default Value: NIRFSG_VAL_DISABLE

Supported Devices: PXIe-5840/5841

NIRFSG_ATTR_LOOP_BANDWIDTH

Specific Attribute

Numeric Value Data
type		 Access Applies to Coercion High Level Functions
1150027 ViInt32 R/W N/A None None

Description

Configures the loop bandwidth of the tuning PLLs. This attribute is ignored on the PXI-5610, PXI-5670/5671, and PXIe-5672 for signal bandwidths greater than or equal to 10 MHz. This attribute is ignored on the PXI/PXIe-5650/5651/5652 for RF frequencies less than 50 MHz.

Note  Setting this attribute to NIRFSG_VAL_WIDE on the PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, or the PXIe-
5673/5673E allows the frequency to settle significantly faster at the expense of increased phase noise. Setting this attribute to NIRFSG_VAL_MEDIUM is not a valid option on the PXI/PXIe-5650/5651/5652 or PXIe-5673/5673E. NIRFSG_VAL_MEDIUM is the only supported value for the PXIe-5840/5841.
To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the niRFSG_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:

NIRFSG_VAL_NARROW Uses the narrowest loop bandwidth setting for the PLL.
NIRFSG_VAL_MEDIUM Uses the medium loop bandwidth setting for the PLL.
NIRFSG_VAL_WIDE Uses the widest loop bandwidth setting for the PLL.
Default Value:

PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841: NIRFSG_VAL_MEDIUM

PXI/PXIe-5650/5651/5652, PXIe-5673/5673E: NIRFSG_VAL_NARROW

Supported Devices: PXI-5610, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5830/5831/5832/5840/5841

Related Topics

Phase-Locked Loop Bandwidth

Modulation Implementation

Sinusoidal Tone Versus Modulation Operation

NIRFSG_ATTR_OUTPUT_ENABLED

Numeric Value Data
type		 Access Coercion High Level Functions
1250004 ViBoolean R/W None niRFSG_ConfigureOutputEnabled

Description

Specifies whether signal output is enabled. Setting the NIRFSG_ATTR_OUTPUT_ENABLED attribute to VI_FALSE while in the Generation state stops signal output, although generation continues internally. For the PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653, PXI-5670/5671, and PXIe-5672/5673/5673E, setting the NIRFSG_ATTR_OUTPUT_ENABLED attribute while in the Committed state does not transition the device to the Configuration state, but output changes immediately.

Note Note  For the PXIe-5653, this attribute controls only the LO1 terminal.
Note  For the PXIe-5645, this attribute is ignored if you are using the I/Q ports.
Note Note   When the NIRFSG_ATTR_ACTIVE_CONFIGURATION_LIST attribute is set to a valid list name, setting the NIRFSG_ATTR_OUTPUT_ENABLED attribute transitions the device to the Configuration state.
Defined Values:
VI_TRUE Enables signal output.
VI_FALSE Disables signal output.
Default Value: VI_TRUE

Supported Devices: PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Output Enabled

NI-RFSG Instrument Driver Programming Flow

NIRFSG_ATTR_PEAK_ENVELOPE_POWER

Numeric Value Data
type		 Access Coercion High Level Functions
1150011 ViReal64 RO None None

Description

Returns the maximum instantaneous power of the RF output signal.

Note  This attribute is valid only when the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute is set to NIRFSG_VAL_AVERAGE_POWER.
Note  The NIRFSG_ATTR_ARB_DIGITAL_GAIN attribute is not included in the calculation of the NIRFSG_ATTR_PEAK_ENVELOPE_POWER attribute.
Units: dBm

Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

NIRFSG_ATTR_PEAK_POWER_ADJUSTMENT

Numeric Value Data
type		 Access Coercion High Level Functions
1150132 ViReal64 R/W None None

Description

Specifies the adjustment for the NIRFSG_ATTR_POWER_LEVEL attribute. This attribute is valid only when you set the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute to NIRFSG_VAL_PEAK_POWER. The value of the NIRFSG_ATTR_PEAK_POWER_ADJUSTMENT attribute adds to the NIRFSG_ATTR_POWER_LEVEL attribute. The NIRFSG_ATTR_PEAK_POWER_ADJUSTMENT attribute typically specifies the peak-to-average power ratio (PAPR) of a waveform. If the PAPR is specified, the specified power level becomes the average power level of the waveform, even if the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute is set to NIRFSG_VAL_PEAK_POWER.

Note Note  For the PXIe-5673/5673E only, use this attribute to associate a peak power adjustment with a waveform.
Note  For the PXIe-5645, this attribute is ignored if you are using the I/Q ports.
Supported Devices: PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841

Related Topics

Assigning Properties or Attributes to a Waveform—Refer to this topic for more information about using this attribute to associate a peak power adjustment with a waveform.

NIRFSG_ATTR_PEAK_POWER_ADJUSTMENT_INHERITANCE

Numeric Value Data
type		 Access Coercion High Level Functions
1150141 ViInt32 R/W None None

Description

Determines the inheritance behavior of the NIRFSG_ATTR_PEAK_POWER_ADJUSTMENT attribute when a script inherits values from specified waveforms.

Defined Values:

NIRFSG_VAL_EXACT_MATCH Errors out if different values are detected in the script.
NIRFSG_VAL_MINIMUM Uses the minimum value found in the script.
Default Value: NIRFSG_VAL_EXACT_MATCH

Supported Devices: PXIe-5673/5673E

Related Topics

Assigning Properties or Attributes to a Waveform

NIRFSG_ATTR_PHASE_OFFSET

Numeric Value Data
type		 Access Coercion High Level Functions
1150024 ViReal64 R/W None None

Description

Specifies the phase of the RF output signal. Use this attribute to align the phase of the RF output with the phase of the RF output of another device, as long as the two devices are phase-coherent.

Units: degrees (°)

Default Value: 0

Supported Devices: PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Phase Synchronization and Phase Coherency

NIRFSG_ATTR_POWER_LEVEL

Numeric Value Data
type		 Access Coercion High Level Functions
1250002 ViReal64 R/W None niRFSG_ConfigureRF

Description

Specifies either the average power level or peak power level of the generated RF signal, depending on the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute setting.

The PXI-5670/5671 and PXIe-5672 must be in the Configuration state to use this attribute. However, the PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696, PXIe-5673/5673E and PXIe-5830/5831/5832/5840/5841 can be in the Configuration or the Generation state to use this attribute.

Refer to the specifications document for your device for allowable power level settings.

Note Note  For the PXIe-5653, this attribute is read-only.
Note  For the PXIe-5645, this attribute is ignored if you are using the I/Q ports.
Units: dBm

Default Values:

PXIe-5644/5645/5646, PXIe-5673/5673E: -100

PXI/PXIe-5650/5651/5652: -90

PXIe-5654: -7

PXIe-5654 with PXIe-5696: -110

PXI-5670/5671, PXIe-5672: -145

PXIe-5830/5831/5832/5840/5841: -174

Supported Devices: PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5830/5831/5832/5840/5841

NIRFSG_ATTR_POWER_LEVEL_TYPE

Numeric Value Data
type		 Access Coercion High Level Functions
1150043 ViInt32 R/W None niRFSG_ConfigurePowerLevelType

Description

Specifies how NI-RFSG interprets the value of the NIRFSG_ATTR_POWER_LEVEL attribute. The NIRFSG_ATTR_POWER_LEVEL_TYPE attribute also affects how waveforms are scaled.

Defined Values:

NIRFSG_VAL_AVERAGE_POWER Indicates the desired power averaged in time. The driver maximizes the dynamic range by scaling the I/Q waveform so that its peak magnitude is equal to one. If your write more than one waveform, NI-RFSG scales each waveform without preserving the power level ratio between the waveforms. This value is not valid for the PXIe-5820.
NIRFSG_VAL_PEAK_POWER Indicates the maximum power level of the RF signal averaged over one period of the RF carrier frequency (the peak envelope power). This setting requires that the magnitude of the I/Q waveform must always be less than or equal to one. When using peak power, the power level of the RF signal matches the specified power level at moments when the magnitude of the I/Q waveform equals one. If you write more than one waveform, the relative scaling between waveforms is preserved. In peak power mode, waveforms are scaled according to the NIRFSG_ATTR_ARB_WAVEFORM_SOFTWARE_SCALING_FACTOR attribute. You can use the NIRFSG_ATTR_PEAK_POWER_ADJUSTMENT attribute in conjunction with the NIRFSG_ATTR_POWER_LEVEL attribute when the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute is set to NIRFSG_VAL_PEAK_POWER.
PXI-5670/5671: While in Script generation mode, if this attribute is set to NIRFSG_VAL_AVERAGE_POWER, NI-RFSG scales each waveform so that all waveforms have the same average power. The average power level of each waveform matches the value set with the NIRFSG_ATTR_POWER_LEVEL attribute. You can disable this scaling operation by setting the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute to NIRFSG_VAL_PEAK_POWER.

PXIe-5644/5645/5646, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841: While in Script generation mode, this attribute must be set to NIRFSG_VAL_PEAK_POWER.

Converting from Average Power to Peak Power

Typically, this attribute is set to NIRFSG_VAL_AVERAGE_POWER. However, some instrument modes require this attribute to be set to NIRFSG_VAL_PEAK_POWER. Use the following equations to calculate the equivalent peak power given the desired average power for your waveform:

Where 1 is the highest possible magnitude in the waveform.

Default Value:

PXIe-5820: NIRFSG_VAL_PEAK_POWER

All other devices: NIRFSG_VAL_AVERAGE_POWER

Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Related Topics

Spurious Performance

Optimizing for Low Power Generation

NIRFSG_ATTR_PULSE_MODULATION_ENABLED

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

Description

Enables or disables pulse modulation.

PXIe-5654/5654 with PXIe-5696: If this attribute is enabled and the signal at the PULSE IN front panel connector is high, the device generates a signal. If the signal is low, output generation is disabled.

PXIe-5673/5673E: If this attribute is enabled and the signal at the PLS MOD front panel connector is high, the device generates a signal. If the signal is low, output generation is disabled.

Defined Values:

VI_TRUE Enables pulse modulation.
VI_FALSE Disables pulse modulation.
Default Value: VI_FALSE

Supported Devices: PXIe-5654/5654 with PXIe-5696, PXIe-5673/5673E

Related Topics

Pulse Modulation

RF Upconverter

NIRFSG_ATTR_UPCONVERTER_FREQUENCY_OFFSET_MODE

Specific Attribute

Numeric Value Data
type		 Access Coercion High Level Functions
1150248 ViInt32 R/W None None

Description

Specifies whether to allow NI-RFSG to select the upconverter frequency offset. You can either set an offset yourself or let NI-RFSG select one for you.

Placing the upconverter center frequency outside the bandwidth of your waveform can help avoid issues such as LO leakage.

To set an offset yourself, set this attribute to NIRFSG_VAL_AUTOMATIC or NIRFSG_VAL_USER_DEFINED, and set either the NIRFSG_ATTR_UPCONVERTER_CENTER_FREQUENCY or the NIRFSG_ATTR_UPCONVERTER_FREQUENCY_OFFSET attribute.

To allow NI-RFSG to automatically select the upconverter frequency offset, set this attribute to NIRFSG_VAL_AUTOMATIC or NIRFSG_VAL_ENABLED and set the NIRFSG_ATTR_SIGNAL_BANDWIDTH to describe the bandwidth of your waveform. The signal bandwidth must be no greater than half the value of the NIRFSG_ATTR_DEVICE_INSTANTANEOUS_BANDWIDTH attribute, minus a device-specific guard band. Do not set the NIRFSG_ATTR_UPCONVERTER_CENTER_FREQUENCY or NIRFSG_ATTR_UPCONVERTER_FREQUENCY_OFFSET attributes. If all conditions are met, NI-RFSG places the upconverter center frequency outside the signal bandwidth. Set this attribute to NIRFSG_VAL_ENABLED if you want to receive an error any time NI-RFSG is unable to apply automatic offset.

When you set an offset yourself or do not use an offset, the reference frequency for gain is near the upconverter center frequency, and NIRFSG_UPCONVERTER_FREQUENCY_OFFSET_MODE returns NIRFSG_VAL_USER_DEFINED. When NI-RFSG automatically sets an offset, the reference frequency for gain is near the RF frequency, and NIRFSG_UPCONVERTER_FREQUENCY_OFFSET_MODE returns NIRFSG_VAL_ENABLED.

Note Note  Below 120 MHz, the PXIe-5841 does not use an LO and NIRFSG_VAL_ENABLED is unavailable. Refer to the PXIe-5841 Automatic Frequency Offset topic for more information about using an automatic offset with an external LO.
Defined Values:
NIRFSG_VAL_ENABLE NI-RFSG places the upconverter center frequency outside of the signal bandwidth if the NIRFSG_ATTR_SIGNAL_BANDWIDTH attribute has been set and can be avoided. NI-RFSG returns an error if the NIRFSG_ATTR_SIGNAL_BANDWIDTH attribute has not been set, or if the signal bandwidth is too large.
NIRFSG_VAL_AUTO NI-RFSG places the upconverter center frequency outside of the signal bandwidth if the NIRFSG_ATTR_SIGNAL_BANDWIDTH attribute has been set and can be avoided.
NIRFSG_VAL_USER_DEFINED NI-RFSG uses the offset that you specified with the NIRFSG_ATTR_UPCONVERTER_FREQUENCY_OFFSET or NIRFSG_ATTR_UPCONVERTER_CENTER_FREQUENCY attributes.
Default Value: NIRFSG_VAL_AUTO

Supported Devices: PXIe-5830/5831/5832/5841

Related Topics

PXIe-5830 Automatic Frequency Offset

PXIe-5831/5832 Automatic Frequency Offset

PXIe-5841 Automatic Frequency Offset

NIRFSG_ATTR_UPCONVERTER_CENTER_FREQUENCY

Numeric Value Data
type		 Access Coercion High Level Functions
1154098 ViReal64 R/W None None

Description

Indicates the center frequency of the passband containing the upconverted RF signal. Writing a value to this attribute while using the PXIe-5644/5645/5646, PXIe-5672/5673/5673E, or PXIe-5820/5840/5841 device enables in-band retuning. In-band retuning increases the speed of frequency sweeps by reducing the amount of upconverter retunes.

Units: hertz (Hz)

Note This attribute is read/write on the PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXIe-5672/5673/5673E, and PXIe-5820/5830/5831/5832/5840/5841, and is read-only on the PXI-5670/5671.
Note Resetting this attribute disables in-band retuning, however, for the PXIe-5820, in-band retuning is always enabled.
Note For the PXIe-5820, the only valid value for this attribute is 0.
Note Setting this attribute while the PXIe-5644/5645/5646, PXIe-5673/5673E, or PXIe-5820/5830/5831/5832/5840/5841 device is generating has no effect until a dynamic attribute is set.
Supported Devices: PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

NIRFSG_ATTR_UPCONVERTER_GAIN

Numeric Value Data
type		 Access Coercion High Level Functions
1154097 ViReal64 R/W None None

Description

Specifies the gain the upconverter applies to the signal.

Note Note  This attribute is read/write on the PXI-5610 and PXIe-5611 and is read-only on the PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, and PXIe-5820/5830/5831/5832/5840/5841.
Units: dB

Supported Devices: PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841

Table of Contents

Home

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