Session 

class nirfsg.Session(self, resource_name, id_query=False, reset_device=False, options={})

Opens a session to the device you specify as the nirfsg.Session.RESOURCE_NAME and returns a ViSession handle that you use to identify the NI-RFSG device in all subsequent NI-RFSG method calls.

This method also configures the device through the nirfsg.Session.OPTION_STRING input.

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/5842/5860

Related Topics

Simulating an NI RF Signal Generator

Note

For multichannel devices such as the PXIe-5860, the resource name must include the channel number to use. The channel number is specified by appending /ChannelNumber to the device name, where ChannelNumber is the channel number (0, 1, etc.). For example, if the device name is PXI1Slot2 and you want to use channel 0, use the resource name PXI1Slot2/0.

Note

One or more of the referenced properties are not in the Python API for this driver.

Parameters:

resource_name (str) –
Specifies the resource name of the device to initialize.

For NI-DAQmx devices, the syntax is the device name specified in MAX. Typical default names for NI-DAQmx devices in MAX are Dev2 or PXISlot2. You can rename an NI-DAQmx device in MAX.

You can also specify the name of an IVI logical name configured with the IVI Configuration utility. Refer to the IVI topic of the Measurement & Automation Explorer Help for more information.

Note

NI-RFSG device names are not case-sensitive. However, all IVI names, such as logical names, are case-sensitive. If you use an IVI logical name, make sure the name is identical to the name shown in the IVI Configuration Utility.
id_query (bool) –
Specifies whether you want NI-RFSG to perform an ID query.

Defined Values :

Value

Description

True (1)

Perform ID query.

False (0)

Do not perform ID query.
reset_device (bool) –
Specifies whether you want to reset the NI-RFSG device during the initialization procedure.

Defined Values :

Value

Description

True (1)

Reset device.

False (0)

Do not reset device.
options (dict) –
Specifies the initial value of certain properties for the session. The syntax for options is a dictionary of properties with an assigned value. For example:

{ ‘simulate’: False }

You do not have to specify a value for all the properties. If you do not specify a value for a property, the default value is used.

Advanced Example: { ‘simulate’: True, ‘driver_setup’: { ‘Model’: ‘<model number>’, ‘BoardType’: ‘<type>’ } }

Property

Default

range_check

True

query_instrument_status

False

cache

True

simulate

False

record_value_coersions

False

driver_setup

{}

Methods 

abort 

nirfsg.Session.abort()

Stops signal generation.

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/5842/5860

Related Topics

NI-RFSG Programming State Model

allocate_arb_waveform 

nirfsg.Session.allocate_arb_waveform(waveform_name, size_in_samples)

Allocates onboard memory space for the arbitrary waveform.

Use this method to specify the total size of a waveform before writing the data. Use this method only if you are calling the nirfsg.Session.WriteArbWaveform() method multiple times to write a large waveform in smaller blocks.

The NI-RFSG device must be in the Configuration state before you call this method.

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

Related Topics

Streaming Waveform Data

Parameters:

waveform_name (str) – Specifies the name used to identify the waveform. This string is case-insensitive and alphanumeric, and it does not use reserved words.

size_in_samples (int) – Specifies the number of samples to reserve in the onboard memory for the specified waveform. Each I/Q pair is considered one sample.

change_external_calibration_password 

nirfsg.Session.change_external_calibration_password(old_password, new_password)

Changes the external calibration password of the device.

Supported Devices: PXIe-5611, PXIe-5653/5654, PXIe-5673/5673E, PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842/5860

Parameters:

old_password (str) – Specifies the old (current) external calibration password. This password is case sensitive.

new_password (str) – Specifies the new (desired) external calibration password.

check_generation_status 

nirfsg.Session.check_generation_status()

Checks the status of the generation.

Call this method to check for any errors that might occur during the signal generation or to check whether the device has finished generating.

Supported Devices : 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/5842/5860

Related Topics

NI-RFSG Instrument Driver Programming Flow <https://www.ni.com/docs/en-US/bundle/rfsg/page/rfsg/progflow.html>

Return type:

bool

Returns:

Returns information about the completion of signal generation.

Defined Values :

Value

Description

True

Signal generation is complete.

False

Signal generation is occurring.

check_if_script_exists 

nirfsg.Session.check_if_script_exists(script_name)

Returns whether the script that you specify as nirfsg.Session.SCRIPT_NAME exists.

Supported Devices : PXIe-5673/5673E. PXIe-5830/5831/5840/5841/5842/5860

Note

One or more of the referenced properties are not in the Python API for this driver.

Parameters:

script_name (str) – Specifies the name of the script. This string is case-insensitive.

Return type:

bool

Returns:

Returns True if the script exists.

Defined Values :

Value

Description

True

The script exists.

False

The script does not exist.

check_if_waveform_exists 

nirfsg.Session.check_if_waveform_exists(waveform_name)

Returns whether the waveform that you specify as nirfsg.Session.WAVEFORM_NAME exists.

Supported Devices : PXIe-5673/5673E, PXIe-5830/5831/5840/5841/5842/5860

Note

One or more of the referenced properties are not in the Python API for this driver.

Parameters:

waveform_name (str) – Specifies the name used to store the waveform. This string is case-insensitive.

Return type:

bool

Returns:

Returns True if the waveform exists.

Defined Values :

Value

Description

True

The waveform exists.

False

The waveform does not exist.

clear_all_arb_waveforms 

nirfsg.Session.clear_all_arb_waveforms()

Deletes all currently defined waveforms and scripts.

The NI-RFSG device must be in the Configuration state before you call this method.

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

clear_arb_waveform 

nirfsg.Session.clear_arb_waveform(waveform_name)

Deletes a specified waveform from the pool of currently defined waveforms.

The NI-RFSG device must be in the Configuration state before you call this method.

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

Parameters:

waveform_name (str) – Name of the stored waveform to delete.

clear_self_calibrate_range 

nirfsg.Session.clear_self_calibrate_range()

Clears the data obtained from the nirfsg.Session.self_calibrate_range() method.

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

close 

nirfsg.Session.close()

Aborts any signal generation in progress and destroys the instrument driver session.

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/5842/5860

Related Topics

NI-RFSG Instrument Driver Programming Flow

NI-RFSG Programming State Model

Note

This method is not needed when using the session context manager

commit 

nirfsg.Session.commit()

Programs the device with the correct settings.

Calling this method moves the NI-RFSG device from the Configuration state to the Committed state. After this method executes, a change to any property reverts the NI-RFSG device to the Configuration state.

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/5842/5860

Related Topics

NI-RFSG Programming State Model

configure_deembedding_table_interpolation_linear 

nirfsg.Session.configure_deembedding_table_interpolation_linear(port, table_name, format)

Selects the linear interpolation method.

If the carrier frequency does not match a row in the de-embedding table, NI-RFSG performs a linear interpolation based on the entries in the de-embedding table to determine the parameters to use for de-embedding.

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

Parameters:

port (str) – Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842/5860 is “” (empty string).

table_name (str) – Specifies the name of the table.

format (nirfsg.Format) –
Specifies the format of parameters to interpolate. Defined Values :

Name

Value

Description

REAL_AND_IMAGINARY

26000 (0x6590)

Results in a linear interpolation of the real portion of the complex number and a separate linear interpolation of the complex portion.

MAGNITUDE_AND_PHASE

26001 (0x6591)

Results in a linear interpolation of the magnitude and a separate linear interpolation of the phase.

MAGNITUDE_DB_AND_PHASE

26002 (0x6592)

Results in a linear interpolation of the magnitude, in decibels, and a separate linear interpolation of the phase.

configure_deembedding_table_interpolation_nearest 

nirfsg.Session.configure_deembedding_table_interpolation_nearest(port, table_name)

Selects the nearest interpolation method.

NI-RFSG uses the parameters of the table nearest to the carrier frequency for de-embedding.

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

Parameters:

port (str) – Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842/5860 is “” (empty string).

table_name (str) – Specifies the name of the table.

configure_deembedding_table_interpolation_spline 

nirfsg.Session.configure_deembedding_table_interpolation_spline(port, table_name)

Selects the spline interpolation method.

If the carrier frequency does not match a row in the de-embedding table, NI-RFSG performs a spline interpolation based on the entries in the de-embedding table to determine the parameters to use for de-embedding.

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

Parameters:

port (str) – Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842/5860 is “” (empty string).

table_name (str) – Specifies the name of the table.

configure_digital_edge_script_trigger 

nirfsg.Session.configure_digital_edge_script_trigger(source, edge)

Configures the specified Script Trigger for digital edge triggering.

The NI-RFSG device must be in the Configuration state before calling this method.

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

Related Topics

Script Trigger

Digital Edge Trigger

Tip

This method can be called on specific script_triggers within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container script_triggers to specify a subset, and then call this method on the result.

Example: my_session.script_triggers[ ... ].configure_digital_edge_script_trigger()

To call the method on all script_triggers, you can call it directly on the nirfsg.Session.

Example: my_session.configure_digital_edge_script_trigger()

Parameters:

source (str) – Specifies the source terminal for the digital edge Script Trigger. NI-RFSG sets the nirfsg.Session.digital_edge_script_trigger_source property to this value.

edge (nirfsg.ScriptTriggerDigitalEdgeEdge) – Specifies the active edge for the digital edge Script Trigger. NI-RFSG sets the nirfsg.Session.digital_edge_script_trigger_edge property to this value.

configure_digital_edge_start_trigger 

nirfsg.Session.configure_digital_edge_start_trigger(source, edge)

Configures the Start Trigger for digital edge triggering.

The NI-RFSG device must be in the Configuration state before calling this method.

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

Related Topics

Start Trigger

Digital Edge Trigger

Note

For the PXIe-5654/5654 with PXIe-5696, the Start Trigger is valid only with a timer-based list when RF list mode is enabled.

Parameters:

source (str) – Specifies the source terminal for the digital edge trigger. NI-RFSG sets the nirfsg.Session.digital_edge_start_trigger_source property to this value.

edge (nirfsg.StartTriggerDigitalEdgeEdge) – Specifies the active edge for the Start Trigger. NI-RFSG sets the nirfsg.Session.digital_edge_start_trigger_edge property to this value.

configure_digital_level_script_trigger 

nirfsg.Session.configure_digital_level_script_trigger(source, level)

Configures a specified Script Trigger for digital level triggering.

The NI-RFSG device must be in the Configuration state before calling this method.

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

Related Topics

Script Trigger

Digital Level Trigger

Tip

This method can be called on specific script_triggers within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container script_triggers to specify a subset, and then call this method on the result.

Example: my_session.script_triggers[ ... ].configure_digital_level_script_trigger()

To call the method on all script_triggers, you can call it directly on the nirfsg.Session.

Example: my_session.configure_digital_level_script_trigger()

Parameters:

source (str) – Specifies the trigger source terminal for the digital level Script Trigger. NI-RFSG sets the nirfsg.Session.digital_level_script_trigger_source property to this value.

level (int) – Specifies the active level for the digital level Script Trigger. NI-RFSG sets the nirfsg.Session.digital_level_script_trigger_active_level property to this value.

configure_ref_clock 

nirfsg.Session.configure_ref_clock(ref_clock_source, ref_clock_rate)

Configures the NI-RFSG device Reference Clock.

The Reference Clock ensures that the NI-RFSG devices are operating from a common timebase. The NI-RFSG device must be in the Configuration state before calling this method.

Supported Devices : PXI-5610, PXIe-5644/5645/5646, 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/5842/5860

Related Topics

PXIe-5672 Timing Configurations

PXIe-5673 Timing Configurations

PXIe-5673E Timing Configurations

PXIe-5830 Timing Configurations

PXIe-5831 Timing Configurations

Parameters:

ref_clock_source (str) –
Specifies the source of Reference Clock signal.

Possible Values

Description

”OnboardClock”

Uses the onboard Reference Clock as the clock source. PXIe-5830/5831/5832 :For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. For the PXIe-5832, connect the PXIe-5820 REF IN connector to the PXIe-3623 REF OUT connector. PXIe-5831 with PXIe-5653 :Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. PXIe-5832 with PXIe-5653 :Connect the PXIe-5820 REF IN connector to the PXIe-3623 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3623 REF IN connector. PXIe-5841 with PXIe-5655 :Lock to the PXIe-5655 onboard clock. Connect the REF OUT connector on the PXIe-5655 to the PXIe-5841 REF IN connector. PXIe-5842 :Lock to the PXIe-5655 onboard clock. Cables between modules are required as shown in the Getting Started Guide for the instrument.

”RefIn”

Uses the clock signal present at the front panel REF IN connector as the clock source. PXIe-5830/5831/5832 :For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. For the PXIe-5832, connect the PXIe-5820 REF IN connector to the PXIe-3623 REF OUT connector. For the PXIe-5830, lock the external signal to the PXIe-3621 REF IN connector. For the PXIe-5831, lock the external signal to the PXIe-3622 REF IN connector. For the PXIe-5832, lock the external signal to the PXIe-3623 REF IN connector. PXIe-5831 with PXIe-5653 :Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. Lock the external signal to the PXIe-5653 REF IN connector. PXIe-5832 with PXIe-5653 :Connect the PXIe-5820 REF IN connector to the PXIe-3623 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3623 REF IN connector. Lock the external signal to the PXIe-5653 REF IN connector. PXIe-5841 with PXIe-5655 :Lock to the signal at the REF IN connector on the associated PXIe-5655. Connect the PXIe-5655 REF OUT connector to the PXIe-5841 REF IN connector. PXIe-5842 :Lock to the signal at the REF IN connector on the associated PXIe-5655. Cables between modules are required as shown in the Getting Started Guide for the instrument.

”PXI_CLK”

Uses the PXI_CLK signal, which is present on the PXI backplane, as the clock source.

”ClkIn”

Uses the clock signal present at the front panel CLK IN connector as the clock source. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5831 with PXIe-5653/5832/5832 with PXIe-5653/5840/5841/5841 with PXIe-5655/5842.

”RefIn2”

-

“PXI_ClkMaster”

This value is valid on only the PXIe-5831 with PXIe-5653 and PXIe-5832 with PXIe-5653. PXIe-5831 with PXIe-5653 :NI-RFSG configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3622 to use PXI_Clk as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. PXIe-5832 with PXIe-5653 :NI-RFSG configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3623 to use PXI_Clk as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector.

ref_clock_rate (float) –
Specifies the Reference Clock rate, in hertz (Hz), of the signal present at the REF IN or CLK IN connector. The default value is NIRFSG_VAL_AUTO, which allows NI-RFSG to use the default Reference Clock rate for the device or automatically detect the Reference Clock rate, if supported. This parameter is only valid when the nirfsg.Session.ref_clock_source parameter is set to ClkIn, RefIn or RefIn2. Refer to the nirfsg.Session.ref_clock_rate property for possible values.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

configure_rf 

nirfsg.Session.configure_rf(frequency, power_level)

Configures the frequency and power level of the RF output signal.

The PXI-5670/5671, PXIe-5672, and PXIe-5860 device must be in the Configuration state before calling this method. 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/5842 device can be in the Configuration or Generation state when you call this method.

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

Related Topics

NI-RFSG Instrument Driver Programming Flow

Parameters:

frequency (float) –
Specifies the frequency of the generated RF signal, in hertz. For arbitrary waveform generation, this parameter specifies the center frequency of the signal.

Units : hertz (Hz)

power_level (float) –
Specifies either the average power level or peak power level of the generated RF signal, depending on the nirfsg.Session.power_level_type property.

Units : dBm

configure_software_script_trigger 

nirfsg.Session.configure_software_script_trigger()

Configures the Script Trigger for software triggering.

Refer to the nirfsg.Session.send_software_edge_trigger() method for more information about using the software Script Trigger. The NI-RFSG device must be in the Configuration state before calling this method.

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

Related Topics

Script Trigger

Trigger Types

Tip

This method can be called on specific script_triggers within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container script_triggers to specify a subset, and then call this method on the result.

Example: my_session.script_triggers[ ... ].configure_software_script_trigger()

To call the method on all script_triggers, you can call it directly on the nirfsg.Session.

Example: my_session.configure_software_script_trigger()

configure_software_start_trigger 

nirfsg.Session.configure_software_start_trigger()

Configures the Start Trigger for software triggering.

Refer to the nirfsg.Session.send_software_edge_trigger() method for more information about using a software trigger. The NI-RFSG device must be in the Configuration state before calling this method.

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

Related Topics

Start Trigger

Trigger Types

create_deembedding_sparameter_table_array 

nirfsg.Session.create_deembedding_sparameter_table_array(port, table_name, frequencies, sparameter_table, sparameter_orientation)

Creates an s-parameter de-embedding table for the port from the input data.

If you only create one table for a port, NI-RFSG automatically selects that table to de-embed the measurement.

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

Related Topics

`De-embedding Overview<https://www.ni.com/docs/en-US/bundle/pxie-5840/page/de-embedding-overview.html>`_

Parameters:

port (str) – Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842/5860 is “” (empty string).

table_name (str) – Specifies the name of the table. The name must be unique for a given port, but not across ports. If you use the same name as an existing table, the table is replaced.

frequencies (numpy.array(dtype=numpy.float64)) –
Specifies the frequencies for the nirfsg.Session.SPARAMETER_TABLE rows. Frequencies must be unique and in ascending order.

Note

One or more of the referenced properties are not in the Python API for this driver.

sparameter_table (numpy.array(dtype=numpy.complex128)) – Specifies the S-parameters for each frequency. S-parameters for each frequency are placed in the array in the following order: s11, s12, s21, s22.

sparameter_orientation (nirfsg.SparameterOrientation) –
Specifies the orientation of the input data relative to the port on the DUT port.

Defined Values :

Name

Value

Description

PORT1_TOWARDS_DUT

24000 (0x5dc0)

Port 1 of the S2P is oriented towards the DUT port.

PORT2_TOWARDS_DUT

24001 (0x5dc1)

Port 2 of the S2P is oriented towards the DUT port.

create_deembedding_sparameter_table_s2p_file 

nirfsg.Session.create_deembedding_sparameter_table_s2p_file(port, table_name, s2p_file_path, sparameter_orientation)

Creates an S-parameter de-embedding table for the port based on the specified S2P file.

If you only create one table for a port, NI-RFSG automatically selects that table to de-embed the measurement.

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

Related Topics

De-embedding Overview

S-parameters

Parameters:

port (str) – Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842 is empty string.

table_name (str) – Specifies the name of the table. The name must be unique for a given port, but not across ports. If you use the same name as an existing table, the table is replaced.

s2p_file_path (str) – Specifies the path to the S2P file that contains de-embedding information for the specified port.

sparameter_orientation (nirfsg.SparameterOrientation) –
Specifies the orientation of the data in the S2P file relative to the port on the DUT port. Defined Values :

Name

Value

Description

PORT1_TOWARDS_DUT

24000 (0x5dc0)

Port 1 of the S2P is oriented towards the DUT port.

PORT2_TOWARDS_DUT

24001 (0x5dc1)

Port 2 of the S2P is oriented towards the DUT port.

delete_all_deembedding_tables 

nirfsg.Session.delete_all_deembedding_tables()

Deletes all configured de-embedding tables for the session.

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

delete_deembedding_table 

nirfsg.Session.delete_deembedding_table(port, table_name)

Deletes the selected de-embedding table for a given port.

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

Parameters:

port (str) – Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842/5860 is “” (empty string).

table_name (str) – Specifies the name of the table.

disable_script_trigger 

nirfsg.Session.disable_script_trigger()

Configures the device not to wait for the specified Script Trigger.

Call this method only if you previously configured a Script Trigger and now want it disabled. The NI-RFSG device must be in the Configuration state before you call this method.

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

Related Topics

Script Trigger

Tip

This method can be called on specific script_triggers within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container script_triggers to specify a subset, and then call this method on the result.

Example: my_session.script_triggers[ ... ].disable_script_trigger()

To call the method on all script_triggers, you can call it directly on the nirfsg.Session.

Example: my_session.disable_script_trigger()

disable_start_trigger 

nirfsg.Session.disable_start_trigger()

Configures the device not to wait for a Start Trigger.

This method is necessary only if you previously configured a Start Trigger and now want it disabled. The NI-RFSG device must be in the Configuration state before calling this method.

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

Related Topics

Start Trigger

error_message 

nirfsg.Session.error_message(error_code, error_message)

Converts an error code returned by an NI-RFSG method into a user-readable string.

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/5842/5860

Parameters:

error_code (int) –
Pass the status parameter that is returned from any NI-RFSG method.

Default Value : 0 (VI_SUCCESS)

error_message (str) –
Returns the user-readable message string that corresponds to the status code you specify.

You must pass a ViChar array with at least 256 bytes to this parameter.

get_all_named_waveform_names 

nirfsg.Session.get_all_named_waveform_names()

Return names of the waveforms present in the memory.

Supported Devices :PXIe-5830/5831/5840/5841/5842E

Return type:

list of str

Returns:

Returns a list of string having waveform names.

get_all_script_names 

nirfsg.Session.get_all_script_names()

Return names of the scripts present in the memory.

Supported Devices :PXIe-5830/5831/5840/5841/5842E

Return type:

list of str

Returns:

Returns a list of string having script names.

get_deembedding_sparameters 

nirfsg.Session.get_deembedding_sparameters()

Returns the S-parameters used for de-embedding a measurement on the selected port.

This includes interpolation of the parameters based on the configured carrier frequency. This method returns an empty array if no de-embedding is done.

If you want to call this method just to get the required buffer size, you can pass 0 for S-parameter Size and VI_NULL for the S-parameters buffer.

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

Note

The port orientation for the returned S-parameters is normalized to PORT1_TOWARDS_DUT.

Return type:

numpy.array(dtype=numpy.complex128)

Returns:

Returns an array of S-parameters. The S-parameters are returned in the following order: s11, s12, s21, s22.

get_error 

nirfsg.Session.get_error()

Retrieves and then clears the IVI error information for the session or the current execution thread.

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/5840/5841/5842/5860

Note

If the bufferSize parameter is 0, this method does not clear the error information. By passing 0 to the bufferSize parameter, you can determine the buffer size required to obtain the entire nirfsg.Session.ERROR_DESCRIPTION string. You can then call this method again with a sufficiently large buffer. If you specify a valid IVI session for the nirfsg.Session.VI parameter, this method retrieves and clears the error information for the session. If you pass VI_NULL for the nirfsg.Session.VI parameter, this method retrieves and clears the error information for the current execution thread. If the nirfsg.Session.VI parameter is an invalid session, this method does nothing and returns an error. Normally, the error information describes the first error that occurred since the user last called this method or the nirfsg.Session.ClearError() method.

Note

One or more of the referenced methods are not in the Python API for this driver.

Note

One or more of the referenced properties are not in the Python API for this driver.

Return type:

tuple (error_code, error_description)

WHERE

error_code (int):

Returns the error code for the session or execution thread. If you pass 0 for the BufferSize parameter, you can pass VI_NULL for this parameter.

error_description (str):

Returns the nirfsg.Session.ERROR_DESCRIPTION for the IVI session or execution thread.

If there is no description, the method returns an empty string. The buffer must contain at least as many elements as the value you specify with the bufferSize parameter. If the nirfsg.Session.ERROR_DESCRIPTION, including the terminating NULL byte, contains more bytes than you indicate with the bufferSize parameter, the method copies bufferSize - 1 bytes into the buffer, places an ASCII NULL byte at the end of the buffer, and returns the buffer size you must pass to get the entire value. For example, if the value is 123456 and the buffer size is 4, the method places 123 into the buffer and returns 7. If you pass 0, you can pass VI_NULL for this parameter.

Note

One or more of the referenced properties are not in the Python API for this driver.

get_ext_cal_last_date_and_time 

nirfsg.Session.get_ext_cal_last_date_and_time()

Returns the date and time of the last successful external calibration.

The time returned is 24-hour (military) local time; for example, if the device was calibrated at 2:30PM, this method returns

14 for the hours parameter and

30 for the minutes parameter.

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

Return type:

hightime.datetime

Returns:

get_max_settable_power 

nirfsg.Session.get_max_settable_power()

Returns the maximum settable output power level for the current configuration.

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

Return type:

float

Returns:

Returns maximum settable power level in dBm.

get_self_cal_last_date_and_time 

nirfsg.Session.get_self_cal_last_date_and_time(module=nirfsg.Module.PRIMARY_MODULE)

Returns the date and time of the last successful self-calibration.

The time returned is 24-hour local time. For example, if the device was calibrated at 2:30PM, this method returns

14 for the hours parameter and

30 for the minutes parameter.

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

Parameters:

module (nirfsg.Module) – Specifies from which stand-alone module to retrieve the last successful self-calibration date and time.

Return type:

hightime.datetime

Returns:

get_self_calibration_temperature 

nirfsg.Session.get_self_calibration_temperature(module=nirfsg.Module.PRIMARY_MODULE)

Returns the temperature, in degrees Celsius, of the device at the last successful self-calibration.

Supported Devices : PXI-5610, PXIe-5653, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831 (IF only)/5832 (IF only)/5840/5841/5842/5860

Parameters:

module (nirfsg.Module) –

Specifies from which stand-alone module to retrieve the last successful self-calibration temperature.
Default Value : PRIMARY_MODULE Defined Values :

Name

Value

Description

PRIMARY_MODULE

13000 (0x32c8)

The stand-alone device or the main module in a multi-module device.

AWG

13001 (0x32c9)

The AWG associated with the primary module.

LO

13002 (0x32ca)

The LO associated with the primary module.

Return type:

float

Returns:

Returns the temperature, in degrees Celsius, of the device at the last successful self-calibration.

get_terminal_name 

nirfsg.Session.get_terminal_name(signal, signal_identifier)

Returns the fully-qualified name of the specified signal.

The fully-qualified name is helpful to automatically route signals in a multisegment chassis.

Supported Devices : 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/5842/5860

Related Topics

Triggers

Events

Syntax for Terminal Names

Parameters:

signal (nirfsg.Signal) –
Specifies the signal to query. Defined Values :

Name

Value

Description

START_TRIGGER

0 (0x0)

Exports a Start Trigger.

SCRIPT_TRIGGER

1 (0x1)

Exports a Script Trigger.

MARKER_EVENT

2 (0x2)

Exports a Marker Event.

REF_CLOCK

3 (0x3)

Exports the Reference Clock.

STARTED_EVENT

4 (0x4)

Exports a Started Event.

DONE_EVENT

5 (0x5)

Exports a Done Event.

NIRFSG_VAL_CONFIGURATION_LIST_STEP_TRIGGER

6 (0x6)

Exports a Configuration List Step Trigger.

NIRFSG_VAL_CONFIGURATION_SETTLED_EVENT

7 (0x7)

Exports a Configuration Settled Event.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

signal_identifier (str) –
Specifies which instance of the selected signal to query. This parameter is necessary when you set the nirfsg.Session.SIGNAL parameter to NIRFSG_VAL_SCRIPT_TRIGGER or MARKER_EVENT . Otherwise, set the nirfsg.Session.SIGNAL_IDENTIFIER parameter to “” (empty string). Possible Values :

Possible Value

Description

”marker0”

Specifies Marker 0.

”marker1”

Specifies Marker 1.

”marker2”

Specifies Marker 2.

”marker3”

Specifies Marker 3.

”scriptTrigger0”

Specifies Script Trigger 0.

”scriptTrigger1”

Specifies Script Trigger 1.

”scriptTrigger2”

Specifies Script Trigger 2.

”scriptTrigger3”

Specifies Script Trigger 3.

Note

One or more of the referenced properties are not in the Python API for this driver.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

Return type:

str

Returns:

Returns the string to use as the source for other devices.

get_waveform_burst_start_locations 

nirfsg.Session.get_waveform_burst_start_locations()

Returns the burst start locations of the waveform stored in the NI-RFSG session.

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

Tip

This method can be called on specific waveforms within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container waveforms to specify a subset, and then call this method on the result.

Example: my_session.waveforms[ ... ].get_waveform_burst_start_locations()

To call the method on all waveforms, you can call it directly on the nirfsg.Session.

Example: my_session.get_waveform_burst_start_locations()

Return type:

list of float

Returns:

Returns the burst start locations stored in the NI-RFSG session for the waveform that you specified in the nirfsg.Session.CHANNEL_NAME parameter. This value is expressed in samples.

Note

One or more of the referenced properties are not in the Python API for this driver.

get_waveform_burst_stop_locations 

nirfsg.Session.get_waveform_burst_stop_locations()

Returns the burst stop locations of the waveform stored in the NI-RFSG session.

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

Tip

This method can be called on specific waveforms within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container waveforms to specify a subset, and then call this method on the result.

Example: my_session.waveforms[ ... ].get_waveform_burst_stop_locations()

To call the method on all waveforms, you can call it directly on the nirfsg.Session.

Example: my_session.get_waveform_burst_stop_locations()

Return type:

list of float

Returns:

Returns the burst start locations stored in the NI-RFSG session for the waveform that you specified in the nirfsg.Session.CHANNEL_NAME parameter. This value is expressed in samples.

Note

One or more of the referenced properties are not in the Python API for this driver.

get_waveform_marker_event_locations 

nirfsg.Session.get_waveform_marker_event_locations()

Returns the marker locations associated with the waveform and the marker stored in the NI-RFSG session.

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

Tip

This method can be called on specific markers within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container markers to specify a subset, and then call this method on the result.

Example: my_session.markers[ ... ].get_waveform_marker_event_locations()

To call the method on all markers, you can call it directly on the nirfsg.Session.

Example: my_session.get_waveform_marker_event_locations()

Return type:

list of float

Returns:

Returns the marker locations stored in the NI-RFSG database for the channel you specified in the nirfsg.Session.CHANNEL_NAME parameter. This value is expressed in samples.

Note

One or more of the referenced properties are not in the Python API for this driver.

initiate 

nirfsg.Session.initiate()

Initiates signal generation, causing the NI-RFSG device to leave the Configuration state and enter the Generation state.

If the settings have not been committed to the device before you call this method, they are committed by this method. The operation returns when the RF output signal settles. To return to the Configuration state, call the nirfsg.Session.abort() method.

Supported Devices : 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/5842/5860

Related Topics

NI-RFSG Instrument Driver Programming Flow

Note

This method will return a Python context manager that will initiate on entering and abort on exit.

load_configurations_from_file 

nirfsg.Session.load_configurations_from_file(file_path)

Loads the configurations from the specified file to the NI-RFSG driver session.

The VI does an implicit reset before loading the configurations from the file.

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

Tip

This method can be called on specific channels within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container channels to specify a subset, and then call this method on the result.

Example: my_session.channels[ ... ].load_configurations_from_file()

To call the method on all channels, you can call it directly on the nirfsg.Session.

Example: my_session.load_configurations_from_file()

Parameters:

file_path (str) – Specifies the absolute path of the file from which the NI-RFSG loads the configurations.

lock 

nirfsg.Session.lock()

Obtains a multithread lock on the device session. Before doing so, the software waits until all other execution threads release their locks on the device session.

Other threads may have obtained a lock on this session for the following reasons:

The application called the nirfsg.Session.lock() method.

A call to NI-RFSG locked the session.

After a call to the nirfsg.Session.lock() method returns successfully, no other threads can access the device session until you call the nirfsg.Session.unlock() method or exit out of the with block when using lock context manager.

Use the nirfsg.Session.lock() method and the nirfsg.Session.unlock() method around a sequence of calls to instrument driver methods if you require that the device retain its settings through the end of the sequence.

You can safely make nested calls to the nirfsg.Session.lock() method within the same thread. To completely unlock the session, you must balance each call to the nirfsg.Session.lock() method with a call to the nirfsg.Session.unlock() method.

One method for ensuring there are the same number of unlock method calls as there is lock calls is to use lock as a context manager

with nirfsg.Session('dev1') as session:
    with session.lock():
        # Calls to session within a single lock context
The first with block ensures the session is closed regardless of any exceptions raised

The second with block ensures that unlock is called regardless of any exceptions raised

Return type:: context manager
Returns:: When used in a with statement, nirfsg.Session.lock() acts as a context manager and unlock will be called when the with block is exited

perform_power_search 

nirfsg.Session.perform_power_search()

Performs a power search if the nirfsg.Session.alc_control property is disabled.

Calling this method disables modulation for a short time while the device levels the output signal.

Supported Devices : PXIe-5654 with PXIe-5696

Related Topics

Power Search

Note

Power search temporarily enables the ALC, so ensure the appropriate included cable is connected between the PXIe-5654 ALCIN connector and the PXIe-5696 ALCOUT connector to successfully perform a power search.

perform_thermal_correction 

nirfsg.Session.perform_thermal_correction()

Corrects for any signal drift due to environmental temperature variation when generating the same signal for extended periods of time without a parameter change.

Under normal circumstances of short-term signal generation, NI-RFSG performs thermal correction automatically by ensuring stable power levels, and you do not need to call this method.

Use this method when generating the same signal for an extended period of time in a temperature-fluctuating environment. The NI-RFSG device must be in the Generation state before calling this method.

Supported Devices : PXIe-5611, 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/5842/5860

Related Topics

Thermal Management

Impairment Calibration

query_arb_waveform_capabilities 

nirfsg.Session.query_arb_waveform_capabilities()

Queries and returns the waveform capabilities of the NI-RFSG device.

These capabilities are related to the current device configuration. The NI-RFSG device must be in the Configuration or the Generation state before calling this method.

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

Return type:

tuple (max_number_waveforms, waveform_quantum, min_waveform_size, max_waveform_size)

WHERE

max_number_waveforms (int):

Returns the value of the nirfsg.Session.arb_max_number_waveforms property. This value is the maximum number of waveforms you can write.

waveform_quantum (int):

Returns the value of the nirfsg.Session.arb_waveform_quantum property. If the waveform quantum is q, then the size of the waveform that you write should be a multiple of q. The units are expressed in samples.

min_waveform_size (int):

Returns the value of the nirfsg.Session.arb_waveform_size_min property. The number of samples of the waveform that you write must be greater than or equal to this value.

max_waveform_size (int):

Returns the value of the nirfsg.Session.arb_waveform_size_max property. The number of samples of the waveform that you write must be less than or equal to this value.

read_and_download_waveform_from_file_tdms 

nirfsg.Session.read_and_download_waveform_from_file_tdms(waveform_name, file_path, waveform_index)

Reads the waveforms from a TDMS file and downloads one waveform into each of the NI RF vector signal generators.

This method reads the following information from the TDMS file and writes it into the NI-RFSG session:

Sample Rate

PAPR

Runtime Scaling

RF Blanking Marker Locations

RF Blanking Enabled

Burst Start Locations

Burst Stop Locations

RF Blanking Marker Source

Signal Bandwidth

Waveform Size

If RF blanking marker locations are present in the file but burst locations are not present, burst locations are calculated from RF blanking marker locations and stored in the NI-RFSG session.

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

Parameters:

waveform_name (str) –
Specifies the name used to store the waveform. This string is case-insensitive.

Example:

”waveform::waveform0”

file_path (str) – Specifies the absolute path to the TDMS file from which the NI-RFSG reads the waveforms.

waveform_index (int) – Specifies the index of the waveform to be read from the TDMS file.

reset 

nirfsg.Session.reset()

Resets all properties to their default values and moves the NI-RFSG device to the Configuration state.

This method aborts the generation, deletes all de-embedding tables, clears all routes, and resets session properties to their initial values. During a reset, routes of signals between this and other devices are released, regardless of which device created the route.

Generally, calling this method instead of the nirfsg.Session.reset_device() method is acceptable. The nirfsg.Session.Reset() method executes faster than the nirfsg.Session.reset_device() method.

To avoid resetting routes on the PXIe-5644/5645/5646 and PXIe-5820/5830/5831/5832/5840/5841/5842/5860 that are in use by NI-RFSA sessions, NI recommends using the nirfsg.Session.reset_with_options() method, with stepsToOmit set to ROUTES .

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/5842/5860

Note

This method resets all configured routes for the PXIe-5644/5645/5646 and PXIe-5820/5830/5831/5832/5840/5841/5842/5860 in NI-RFSA and NI-RFSG.

reset_device 

nirfsg.Session.reset_device()

Performs a hard reset on the device which consists of the following actions:

Signal generation is stopped.

All routes are released.

External bidirectional terminals are tristated.

FPGAs are reset.

Hardware is configured to its default state.

All session properties are reset to their default states.

During a device reset, routes of signals between this and other devices are released, regardless of which device created the route.

PXI-5610, PXI-5670/5671, PXIe-5672– After calling this method, the device requires 25 seconds before returning to full functionality. NI-RFSG enforces this condition by adding a wait, if needed, the next time you try to access the device.

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

Related Topics

Thermal Shutdown

Note

You must call the nirfsg.Session.reset_device() method if the NI-RFSG device has shut down because of a high-temperature condition.

reset_with_defaults 

nirfsg.Session.reset_with_defaults()

Performs a software reset of the device, returning it to the default state and applying any initial default settings from the IVI Configuration Store.

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

reset_with_options 

nirfsg.Session.reset_with_options(steps_to_omit)

Resets all properties to default values and specifies steps to omit during the reset process, such as signal routes.

By default, this method exhibits the same behavior as nirfsg.Session.Reset(). You can specify steps to omit using the steps to omit parameter. For example, if you specify ROUTES for the nirfsg.Session.STEPS_TO_OMIT parameter, this method does not release signal routes during the reset process.

When routes of signals between two devices are released, they are released regardless of which device created the route.

To avoid resetting routes on PXIe-5820/5830/5831/5832/5840/5841/5842/5860 that are in use by NI-RFSA sessions, NI recommends using this method instead of nirfsg.Session.Reset(), with nirfsg.Session.STEPS_TO_OMIT set to ROUTES.

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

Related Topics

Triggers

Events

Note

One or more of the referenced properties are not in the Python API for this driver.

Parameters:

steps_to_omit (nirfsg.ResetWithOptionsStepsToOmit) –
Specifies a list of steps to skip during the reset process. The default value is NONE, which specifies that no step is omitted during reset. Defined Values :

Name

Value

Description

NONE

0 (0x0)

No step is omitted during reset.

WAVEFORMS

1 (0x1)

Omits clearing waveforms.

SCRIPTS

2 (0x2)

Omits clearing scripts.

ROUTES

4 (0x4)

Omits the routing reset step. Routing is preserved after a reset. However, routing related properties are reset to default, and routing is released if the default properties are committed after a reset.

DEEMBEDDING_TABLES

8 (0x8)

Omits deleting de-embedding tables. This step is valid only for the PXIe-5830/5831/5832/5840.

Note

ROUTES is not supported in external calibration or alignment sessions. You can combine multiple enums.ResetWithOptionsStepsToOmit flags using the bitwise OR (|) operator.

save_configurations_to_file 

nirfsg.Session.save_configurations_to_file(file_path)

Saves the configurations of the session to the specified file.

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

Tip

This method can be called on specific channels within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container channels to specify a subset, and then call this method on the result.

Example: my_session.channels[ ... ].save_configurations_to_file()

To call the method on all channels, you can call it directly on the nirfsg.Session.

Example: my_session.save_configurations_to_file()

Parameters:

file_path (str) – Specifies the absolute path of the file to which the NI-RFSG saves the configurations.

select_arb_waveform 

nirfsg.Session.select_arb_waveform(waveform_name)

Specifies the waveform that is generated upon a call to the nirfsg.Session._initiate() method when the generation_mode property is set to ARB_WAVEFORM.

You must specify a waveform using the nirfsg.Session.NAME parameter if you have written multiple waveforms. The NI-RFSG device must be in the Configuration state before you call this method.

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

Related Topics

Assigning Properties or Properties to a Waveform

Note

One or more of the referenced properties are not in the Python API for this driver.

Parameters:

waveform_name (str) – Specifies the name of the stored waveform to generate. This is a case-insensitive alphanumeric string that does not use reserved words. NI-RFSG sets the nirfsg.Session.arb_selected_waveform property to this value.

self_cal 

nirfsg.Session.self_cal()

Performs an internal self-calibration on the device and associated modules that support self-calibration.

If the calibration is successful, new calibration data and constants are stored in the onboard nonvolatile memory of the module.

The PXIe-5841 maintains separate self-calibration data for both the PXIe-5841 standalone and when associated with the PXIe-5655. Use this method once for each intended configuration.

Supported Devices : PXI-5610, PXIe-5653, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860

Note

If there is an existing NI-RFSA session open for the same PXIe-5820/5830/5831/5832/5840/5841/5842/5860 while this method runs, it may remain open but cannot be used for operations that access the hardware, for example niRFSA_Commit or niRFSA_Initiate.

self_calibrate_range 

nirfsg.Session.self_calibrate_range(steps_to_omit, min_frequency, max_frequency, min_power_level, max_power_level)

Self-calibrates all configurations within the specified frequency and peak power level limits.

Self-calibration range data is valid until you restart the system or call the nirfsg.Session.clear_self_calibrate_range() method.

NI recommends that no external signals are present on the RF In or IQ In ports during the calibration.

For best results, NI recommends that you perform self-calibration without omitting any steps. However, if certain aspects of performance are less important for your application, you can omit certain steps for faster calibration.

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

Note

This method does not update self-calibration date and temperature.

If there is an existing NI-RFSA session open for the same PXIe-5644/5645/5646, it may remain open but cannot be used while this method runs.

If there is an existing NI-RFSA session open for the same PXIe-5820/5830/5831/5832/5840/5841/5842 while this method runs, it may remain open but cannot be used for operations that access the hardware, for example niRFSA_Commit or niRFSA_Initiate.

Parameters:

steps_to_omit (nirfsg.SelfCalibrateRangeStepsToOmit) –
Specifies which calibration steps to skip during the self-calibration process. The default value is an empty array, which indicates that no calibration steps are omitted.

Default Value : OMIT_NONE

Defined Values:

Name

Value

Description

OMIT_NONE

0 (0x0)

No calibration steps are omitted.

LO_SELF_CAL

1 (0x1)

Omits the LO Self Cal step. If you omit this step, the power level of the LO is not adjusted.

POWER_LEVEL_ACCURACY

2 (0x2)

Omits the Power Level Accuracy step. If you omit this step, the power level accuracy of the device is not adjusted.

RESIDUAL_LO_POWER

4 (0x4)

Omits the Residual LO Power step. If you omit this step, the Residual LO Power performance is not adjusted.

IMAGE_SUPPRESSION

8 (0x8)

Omits the Image Suppression step. If you omit this step, the Residual Sideband Image performance is not adjusted.

SYNTHESIZER_ALIGNMENT

16 (0x10)

Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.

Note

You can combine multiple enums.SelfCalibrateRangeStepsToOmit flags using the bitwise OR (|) operator.

min_frequency (float) – Specifies the minimum frequency to calibrate.

max_frequency (float) – Specifies the maximum frequency to calibrate.

min_power_level (float) – Specifies the minimum power level to calibrate.

max_power_level (float) – Specifies the maximum power level to calibrate.

self_test 

nirfsg.Session.self_test()

Performs a self-test on the NI-RFSG device and returns the test results.

This method performs a simple series of tests to ensure that the NI-RFSG device is powered up and responding.

This method does not affect external I/O connections or connections between devices. Complete functional testing and calibration are not performed by this method. The NI-RFSG device must be in the Configuration state before you call this method.

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/5842/5860

Related Topics

Device Warm-Up

Self-Test Code

Description

0

Passed self-test

1

Self-test failed

send_software_edge_trigger 

nirfsg.Session.send_software_edge_trigger(trigger, trigger_identifier)

Forces a trigger to occur.

The specified trigger generates regardless of whether the trigger has been configured as a software trigger.

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

Related Topics

Triggers

Parameters:

trigger (nirfsg.SoftwareTriggerType) –
Specifies the trigger to send.

Default Value: START

Defined Values:

Name

Value

Description

START

0 (0x0)

Specifies the Start Trigger.

SCRIPT

1 (0x1)

Specifies the Script Trigger.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

trigger_identifier (nirfsg.TriggerIdentifier) –
Specifies the Script Trigger to configure. This parameter is valid only when you set the nirfsg.Session.TRIGGER parameter to NIRFSG_VAL_START_TRIGGER. Otherwise, set the nirfsg.Session.TRIGGER_IDENTIFIER parameter to “” (empty string).

Default Value: “” (empty string)

Possible Values:

Possible Value

Description

scriptTrigger0

Specifies Script Trigger 0.

scriptTrigger1

Specifies Script Trigger 1.

scriptTrigger2

Specifies Script Trigger 2.

scriptTrigger3

Specifies Script Trigger 3.

None (no signal to export)

Note

One or more of the referenced properties are not in the Python API for this driver.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

set_arb_waveform_next_write_position 

nirfsg.Session.set_arb_waveform_next_write_position(waveform_name, relative_to, offset)

Configures the start position to use for writing a waveform before calling the nirfsg.Session.WriteArbWaveform() method.

This method allows you to write to arbitrary locations within the waveform. These settings apply only to the next write to the waveform specified by the name input of the nirfsg.Session.allocate_arb_waveform() method or the nirfsg.Session.WriteArbWaveform() method. Subsequent writes to that waveform begin where the last write ended, unless this method is called again.

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

Note

If you use this method to write the waveform that is currently generating, an undefined output may result.

Parameters:

waveform_name (str) – Specifies the name of the waveform. This string is case-insensitive and alphanumeric, and it cannot use reserved words.

relative_to (nirfsg.RelativeTo) –
Specifies the reference position in the waveform. The position and nirfsg.Session.OFFSET together determine where to start loading data into the waveform.

Defined Values:

Name

Value

Description

START_OF_WAVEFORM

8000 (0x1f40)

The reference position is relative to the start of the waveform.

CURRENT_POSITION

8001 (0x1f41)

The reference position is relative to the current position.

Note

One or more of the referenced properties are not in the Python API for this driver.

offset (int) – Specifies the offset from the relative to parameter at which to start loading the data into the waveform.

set_waveform_burst_start_locations 

nirfsg.Session.set_waveform_burst_start_locations(locations)

Configures the start location of the burst in samples where the burst refers to the active portion of a waveform.

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

Tip

This method can be called on specific waveforms within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container waveforms to specify a subset, and then call this method on the result.

Example: my_session.waveforms[ ... ].set_waveform_burst_start_locations()

To call the method on all waveforms, you can call it directly on the nirfsg.Session.

Example: my_session.set_waveform_burst_start_locations()

Parameters:

locations (list of float) –
Returns the burst start locations stored in the NI-RFSG session for the waveform that you specified in the nirfsg.Session.CHANNEL_NAME parameter. This value is expressed in samples.

Note

One or more of the referenced properties are not in the Python API for this driver.

set_waveform_burst_stop_locations 

nirfsg.Session.set_waveform_burst_stop_locations(locations)

Configures the stop location of the burst in samples where the burst refers to the active portion of a waveform.

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

Tip

This method can be called on specific waveforms within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container waveforms to specify a subset, and then call this method on the result.

Example: my_session.waveforms[ ... ].set_waveform_burst_stop_locations()

To call the method on all waveforms, you can call it directly on the nirfsg.Session.

Example: my_session.set_waveform_burst_stop_locations()

Parameters:

locations (list of float) – Specifies the burst stop locations, in samples, to store in the NI-RFSG session.

set_waveform_marker_event_locations 

nirfsg.Session.set_waveform_marker_event_locations(locations)

Configures the marker locations associated with waveform and marker in the NI-RFSG session.

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

Tip

This method can be called on specific markers within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container markers to specify a subset, and then call this method on the result.

Example: my_session.markers[ ... ].set_waveform_marker_event_locations()

To call the method on all markers, you can call it directly on the nirfsg.Session.

Example: my_session.set_waveform_marker_event_locations()

Parameters:

locations (list of float) – Specifies the marker location, in samples, to store in the NI-RFSG database.

unlock 

nirfsg.Session.unlock(): Releases a lock that you acquired on an device session using nirfsg.Session.lock(). Refer to nirfsg.Session.unlock() for additional information on session locks.

wait_until_settled 

nirfsg.Session.wait_until_settled(max_time_milliseconds=hightime.timedelta(seconds=10.0))

Waits until the RF output signal has settled. This method is useful for devices that support changes while in the Generation state.

Call this method after making a dynamic change to wait for the output signal to settle.

You can also call this method after calling the nirfsg.Session.commit() method to wait for changes to settle. The nirfsg.Session.wait_until_settled() method is not required after calling the nirfsg.Session._initiate() method because the nirfsg.Session._initiate() automatically waits for the output to settle.

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/5842/5860

Parameters:

max_time_milliseconds (hightime.timedelta, datetime.timedelta, or int in milliseconds) –
Specifies the maximum time the method waits for the output to settle. If the maximum time is exceeded, this method returns an error. The units are expressed in milliseconds.

Default Value : 10000

write_arb_waveform 

nirfsg.Session.write_arb_waveform(waveform_name, waveform_data_array, more_data_pending=False)

Writes an arbitrary waveform to the NI-RFSG device starting at the position of the last data written in onboard memory.

This method accepts the complex baseband data in the form of numpy array of numpy.complex64 or numpy.complex128 or interleaved numpy array of numpy.int16. If the waveform to write is already allocated using the nirfsg.Session.allocate_arb_waveform(), the more_data_pending parameter is ignored. The PXI-5670/5671 must be in the Configuration state before you call this method. When streaming is enabled, you can call this method when the PXIe-5672/5673/5673E or PXIe-5820/5830/5831/5832/5840/5841/5842/5860 is in the Generation state.

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

Related Topics

Streaming

Assigning Properties or Properties to a Waveform

Note

On the PXIe-5644/5645/5646, PXIe-5672/5673/5673E, and PXIe-5820/5830/5831/5832/5840/5841/5842/5860, the more_data_pending parameter is always ignored. To write data in blocks on these devices, you must allocate the waveform before writing it. If you are writing interleaved numpy array of numpy.int16, then this method only supports PEAK mode as specified in the nirfsg.Session.power_level_type property. If you download a waveform as interleaved numpy array of numpy.int16 when using this method, you cannot set the nirfsg.Session.power_level_type to AVERAGE without causing error in the output.

Parameters:

waveform_name (str) – Specifies the name used to identify the waveform. This string is case-insensitive and alphanumeric, and it does not use reserved words.

waveform_data_array (numpy array of numpy.complex64, numpy array of numpy.complex128 or interleaved complex data in the form of numpy array of numpy.int16) – Specifies the array of data to load into the waveform. The array must have at least as many elements as the value in the size_in_samples parameter in the nirfsg.Session.allocate_arb_waveform() method.

more_data_pending (bool) – Specifies whether or not the data block contains the end of the waveform. Set this parameter to True to allow data to be appended later to the waveform. Splitting the waveform into multiple data blocks can reduce the memory requirements of the write operation. Append data to a previously written waveform by using the same waveform in the name parameter. Set more_data_pending to False to indicate that this data block contains the end of the waveform. If the waveform is already allocated, this parameter is ignored.

write_script 

nirfsg.Session.write_script(script)

Writes a script to the device to control waveform generation in Script mode.

First, configure your device for Script mode by setting the generation_mode property. The NI-RFSG device must be in the Configuration state before calling the nirfsg.Session.write_script() method.

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

Related Topics

Scripting Instructions–Refer to this topic for more information about VST restrictions on scripts.

Common Scripting Use Cases

Note

If you are using an RF vector signal transceiver (VST) device, some script instructions may not be supported.

Parameters:

script (str) –
Specifies a string containing a syntactically correct script. NI-RFSG supports multiple scripts that are selected with the nirfsg.Session.selected_script property. Refer to Scripting Instructions for more information about using scripts.

Properties 

absolute_delay 

nirfsg.Session.absolute_delay

Specifies the sub-Sample Clock delay, in seconds, to apply to the I/Q waveform. Use this property to reduce the trigger jitter when synchronizing multiple devices with NI-TClk. This property can also help maintain synchronization repeatability by writing the absolute delay value of a previous measurement to the current session.

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

Units: Seconds

Valid Values: Plus or minus half of one Sample Clock period

Supported Devices: PXIe-5820/5840/5841/5842

Note

The resolution of this property is a method of the I/Q sample period at 15E(-6) times that sample period.

If this property is set, NI-TClk cannot perform any sub-Sample Clock adjustment.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

hightime.timedelta, datetime.timedelta, or float in seconds

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:Signal Path:Absolute Delay

C Attribute: NIRFSG_ATTR_ABSOLUTE_DELAY

ae_temperature 

nirfsg.Session.ae_temperature

Returns the amplitude extender module temperature in degrees Celsius.

Units: degrees Celsius (°C)

Supported Devices: PXIe-5654 with PXIe-5696

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Characteristics:AE Temperature (Degrees C)

C Attribute: NIRFSG_ATTR_AE_TEMPERATURE

alc_control 

nirfsg.Session.alc_control

Enables or disables the automatic leveling control (ALC).

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

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

Default Value:

PXIe-5654: DISABLE

PXIe-5654 with PXIe-5696: ENABLE

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

Related Topics

Power Level Adjustment

ALC Closed Loop Versus Open Loop

Power Search

Defined Values:

Name

Value

Description

DISABLE

0 (0x0)

Disables ALC.

ENABLE

1 (0x1)

Enables the ALC.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.AutomaticLevelControl

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:ALC Control

C Attribute: NIRFSG_ATTR_ALC_CONTROL

allow_out_of_specification_user_settings 

nirfsg.Session.allow_out_of_specification_user_settings

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.Session.allow_out_of_specification_user_settings property, the driver does not report out-of-specification warnings or errors.

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

Default Value: DISABLE

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

Defined Values:

Name

Value

Description

DISABLE

0 (0x0)

Disables out-of-specification user settings.

ENABLE

1 (0x1)

Enables out-of-specification user settings.

Note

Accuracy cannot be guaranteed outside of device specifications, and results may vary by module.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.AllowOutOfSpecificationUserSettings

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Allow Out Of Specification User Settings

C Attribute: NIRFSG_ATTR_ALLOW_OUT_OF_SPECIFICATION_USER_SETTINGS

amplitude_settling 

nirfsg.Session.amplitude_settling

Configures the amplitude settling accuracy in decibels. NI-RFSG waits until the RF power settles within the specified accuracy level after calling the nirfsg.Session._initiate() method or nirfsg.Session.wait_until_settled() method 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 property 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/5842/5860: 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/5842/5860: 0.01 to 1

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

Related Topics

Amplitude Settling Times

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Amplitude Settling

C Attribute: NIRFSG_ATTR_AMPLITUDE_SETTLING

amp_path 

nirfsg.Session.amp_path

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 property based on power and frequency settings. Setting this property overrides the value chosen by NI-RFSG.

Default Value: LOW_HARMONIC

Supported Devices: PXIe-5654 with PXIe-5696

Related Topics

Low Harmonic Path Versus High Power Path

Defined Values:

Name

Value

Description

HIGH_POWER

16000 (0x3e80)

Sets the amplification path to use the high power path.

LOW_HARMONIC

16001 (0x3e81)

Sets the amplification path to use the low harmonic path.

Note

Resetting this property reverts back to the default unset behavior.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.AmpPath

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Advanced:Amp Path

C Attribute: NIRFSG_ATTR_AMP_PATH

analog_modulation_am_sensitivity 

nirfsg.Session.analog_modulation_am_sensitivity

Specifies an uncalibrated digital-to-analog converter (DAC) value that scales the input signal before the signal modulates the carrier. A value of 0 completely attenuates the signal, and a value of 100 passes the full-scale signal to the modulator.

When using the PXIe-5654 with PXIe-5696, NI-RFSG may coerce AM sensitivity. Coercing the AM sensitivity prevents overpower conditions at the PXIe-5696 input. Read this property to determine the coerced value.

Default Value: 100

Valid Values: 0 to 100

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

Related Topics

Amplitude Modulation

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Modulation:Analog:AM Sensitivity

C Attribute: NIRFSG_ATTR_ANALOG_MODULATION_AM_SENSITIVITY

analog_modulation_fm_band 

nirfsg.Session.analog_modulation_fm_band

Specifies the analog modulation frequency modulation (FM) band to use. Wideband FM allows for modulating signals higher than 100kHz. Narrowband FM allows for modulating lower frequency signals.

Default Value: WIDEBAND

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

Related Topics

Frequency Modulation

Defined Values:

Name

Value

Description

NARROWBAND

17000 (0x4268)

Specifies narrowband frequency modulation.

WIDEBAND

17001 (0x4269)

Specifies wideband frequency modulation.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.AnalogModulationFmBand

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Modulation:Analog:FM Band

C Attribute: NIRFSG_ATTR_ANALOG_MODULATION_FM_BAND

analog_modulation_fm_narrowband_integrator 

nirfsg.Session.analog_modulation_fm_narrowband_integrator

Specifies the narrowband frequency modulation (FM) range to apply by sending the signal through an integrator.

This property is valid only when you set the nirfsg.Session.analog_modulation_type property to FM and the nirfsg.Session.analog_modulation_fm_band property to NARROWBAND.

Default Value: RANGE_100_HERTZ_TO_1_KILOHERTZ

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

Related Topics

Frequency Modulation

Defined Values:

Name

Value

Description

RANGE_100_HERTZ_TO_1_KILOHERTZ

18000 (0x4650)

Specifies a range from 100Â Hz to 1Â kHz.

RANGE_10_KILOHERTZ_TO_100_KILOHERTZ

18002 (0x4652)

Specifies a range from 10Â kHz to 100Â kHz.

RANGE_1_KILOHERTZ_TO_10_KILOHERTZ

18001 (0x4651)

Specifies a range from 1Â kHz to 10Â kHz.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.AnalogModulationFmNarrowbandIntegrator

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Modulation:Analog:FM Narrowband Integrator

C Attribute: NIRFSG_ATTR_ANALOG_MODULATION_FM_NARROWBAND_INTEGRATOR

analog_modulation_fm_sensitivity 

nirfsg.Session.analog_modulation_fm_sensitivity

Specifies an uncalibrated digital-to-analog converter (DAC) value that scales the input signal before the signal modulates the carrier. A value of 0 completely attenuates the signal, and a value of 100 passes the full-scale signal to the modulator.

Default Value: 100

Valid Values: 0 to 100

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

Related Topics

Frequency Modulation

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Modulation:Analog:FM Sensitivity

C Attribute: NIRFSG_ATTR_ANALOG_MODULATION_FM_SENSITIVITY

analog_modulation_pm_deviation 

nirfsg.Session.analog_modulation_pm_deviation

Specifies the deviation to use in phase modulation, in degrees.

Units: degrees (°)

Default Value: 90°

Supported Devices: PXI/PXIe-5650/5651/5652, PXIe-5653

Related Topics

Modulation Schemes

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Modulation:Analog:PM Deviation (Degrees)

C Attribute: NIRFSG_ATTR_ANALOG_MODULATION_PM_DEVIATION

analog_modulation_pm_mode 

nirfsg.Session.analog_modulation_pm_mode

Specifies the phase modulation (PM) mode to use.

Default Value: LOW_PHASE_NOISE

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

Related Topics

Phase Modulation

Defined Values:

Name

Value

Description

HIGH_DEVIATION

19000 (0x4a38)

Specifies high deviation. High deviation comes at the expense of a higher phase noise.

LOW_PHASE_NOISE

19001 (0x4a39)

Specifies low phase noise. Low phase noise comes at the expense of a lower maximum deviation.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.AnalogModulationPmMode

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Modulation:Analog:PM Mode

C Attribute: NIRFSG_ATTR_ANALOG_MODULATION_PM_MODE

analog_modulation_pm_sensitivity 

nirfsg.Session.analog_modulation_pm_sensitivity

Specifies an uncalibrated digital-to-analog converter (DAC) value that scales the input signal before the signal modulates the carrier. A value of 0 completely attenuates the signal, and a value of 100 passes the full-scale signal to the modulator.

Default Value: 100

Valid Values: 0 to 100

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

Related Topics

Phase Modulation

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Modulation:Analog:PM Sensitivity

C Attribute: NIRFSG_ATTR_ANALOG_MODULATION_PM_SENSITIVITY

analog_modulation_type 

nirfsg.Session.analog_modulation_type

Specifies the analog modulation format to use.

Default Value: NONE

Supported Devices: PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696

Related Topics

Modulation

PXI/PXIe-5650/5651/5652 Modulation Schemes

PXIe-5654/5654 with PXIe-5696 Modulation Schemes

Defined Values:

Name

Value

Description

AM

2002 (0x7d2)

Specifies that the analog modulation type is AM.

FM

2000 (0x7d0)

Specifies that the analog modulation type is FM.

NONE

0 (0x0)

Disables analog modulation.

PM

2001 (0x7d1)

Specifies that the analog modulation type is PM.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.AnalogModulationType

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Modulation:Analog:Modulation Type

C Attribute: NIRFSG_ATTR_ANALOG_MODULATION_TYPE

arb_carrier_frequency 

nirfsg.Session.arb_carrier_frequency

Units: hertz (Hz)

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

Related Topics

Assigning Properties or Properties to a Waveform—Refer to this topic for more information about using this property to associate a carrier frequency with a waveform. Indicates the carrier frequency generated by the arbitrary waveform generator (AWG) module. The specified carrier frequency is related to the RF output as shown in the following equations:

Device

Equations

PXI-5610, PXI-5670/5671, PXIe-5672

RF Frequency (MHz) = Upconverter Center Frequency + Arb Carrier Frequency – 25 MHz

PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841/5842/5860

RF Frequency (MHz) = Upconverter Center Frequency + Arb Carrier Frequency.Note that - the nirfsg.Session.upconverter_center_frequency property and the nirfsg.Session.arb_carrier_frequency property cannot be set at the same time. The only time the carrier frequency is nonzero on these devices is when in-band retuning is used.

Note

Use this property to associate a carrier frequency with a waveform.

This property is read-only on the PXI-5670/5671 and PXIe-5672.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Arb Carrier Frequency (Hz)

C Attribute: NIRFSG_ATTR_ARB_CARRIER_FREQUENCY

arb_digital_gain 

nirfsg.Session.arb_digital_gain

Specifies the digital gain, in decibels. The digital gain is applied to the waveform data after filtering. Use this property to adjust the output power of the device while keeping the analog path fixed. This may cause clipping, overflows, or quantization noise if used improperly.

To set this property, the NI-RFSG device must be in the Configuration or Generation state.

Default Value: 0 dB

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

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

C Attribute: NIRFSG_ATTR_ARB_DIGITAL_GAIN

arb_max_number_waveforms 

nirfsg.Session.arb_max_number_waveforms

Returns the maximum number of waveforms the device can hold in memory.

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

High-Level Methods:

nirfsg.Session.query_arb_waveform_capabilities()

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

int

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Waveform Capabilities:Max Number Waveforms

C Attribute: NIRFSG_ATTR_ARB_MAX_NUMBER_WAVEFORMS

arb_onboard_sample_clock_mode 

nirfsg.Session.arb_onboard_sample_clock_mode

Specifies the Sample Clock mode on the device. To set this property, the device must be in the Configuration state.

PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: DIVIDE_DOWN is the only supported value for this device.

Default Values:

PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: DIVIDE_DOWN

PXIe-5673/5673E: HIGH_RESOLUTION

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

Related Topics

Clocking Modes

Valid Values:

Name

Description

HIGH_RESOLUTION

Sample rates are generated by a high-resolution clock.

DIVIDE_DOWN

Sample rates are generated by dividing the source frequency.

Note

Using the high resolution clock may result in increased phase noise.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.ArbOnboardSampleClockMode

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Clock:Arb Onboard Sample Clock Mode

C Attribute: NIRFSG_ATTR_ARB_ONBOARD_SAMPLE_CLOCK_MODE

arb_pre_filter_gain 

nirfsg.Session.arb_pre_filter_gain

Specifies the AWG prefilter gain. The prefilter gain is applied to the waveform data before any other signal processing. Reduce this value to prevent overflow in the AWG interpolation filters. Other gains on the NI-RFSG device are automatically adjusted to compensate for nonunity AWG prefilter gain. The PXI-5671, PXIe-5672 must be in the Configuration state to use this property. However, the PXIe-5644/5645/5646, PXIe-5673/5673E, and PXIe-5820/5830/5831/5832/5840/5841/5842 can be in either the Configuration or the Generation state to use this property. PXIe-5860 can only be in the Configuration state to use this property.

On the PXI-5671, this property applies only when the nirfsg.Session.iq_rate property is set to a value less than or equal to 8.33MS/s. On the PXIe-5644/5645/5646, PXIe-5672/5673/5673E, and PXIe-5820/5830/5831/5832/5840/5841/5842/5860, this property is always applicable.

Units: dB

Default Value: 0dB

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

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Pre-filter Gain (dB)

C Attribute: NIRFSG_ATTR_ARB_PRE_FILTER_GAIN

arb_sample_clock_rate 

nirfsg.Session.arb_sample_clock_rate

Returns the rate of the Sample Clock on the device.

Units: hertz (Hz)

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

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Clock:Arb Sample Clock Rate (Hz)

C Attribute: NIRFSG_ATTR_ARB_SAMPLE_CLOCK_RATE

arb_sample_clock_source 

nirfsg.Session.arb_sample_clock_source

Specifies the Sample Clock source for the device. To set this property, the NI-RFSG device must be in the Configuration state.

PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: OnboardClock is the only supported value for this device.

Default Value: OnboardClock

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

Related Topics

Timing Configurations

Possible Values:

Possible Value

Description

“ClkIn”

Uses the external clock as the Sample Clock source.

“OnboardClock”

Uses the AWG module onboard clock as the Sample Clock source.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.ArbSampleClockSource

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Clock:Arb Sample Clock Source

C Attribute: NIRFSG_ATTR_ARB_SAMPLE_CLOCK_SOURCE

arb_selected_waveform 

nirfsg.Session.arb_selected_waveform

Specifies the waveform in onboard memory to generate upon calling the nirfsg.Session.Init() method when the nirfsg.Session.generation_mode property is set to ARB_WAVEFORM. The nirfsg.Session.arb_selected_waveform property is ignored when the nirfsg.Session.generation_mode property is set to SCRIPT or CW. To set the nirfsg.Session.arb_selected_waveform property, the NI-RFSG device must be in the Configuration state.

Default Value: “” (empty string)

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

Related Topics

Assigning Properties or Properties to a Waveform

High-Level Methods:

nirfsg.Session.select_arb_waveform()

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Waveform Capabilities:Selected Waveform

C Attribute: NIRFSG_ATTR_ARB_SELECTED_WAVEFORM

arb_temperature 

nirfsg.Session.arb_temperature

Returns the AWG module temperature in degrees Celsius.

PXIe-5820/5840/5841/5842: If you query this property during RF list mode, list steps may take longer to complete during list execution.

Units: degrees Celsius (°C)

Supported Devices: PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Characteristics:AWG Temperature (Degrees C)

C Attribute: NIRFSG_ATTR_ARB_TEMPERATURE

arb_waveform_quantum 

nirfsg.Session.arb_waveform_quantum

Returns the waveform quantum for the device. The number of samples in a waveform must be an integer multiple of the waveform quantum. The other restrictions on the length of the waveform are the nirfsg.Session.arb_waveform_size_min and nirfsg.Session.arb_waveform_size_max arbitrary waveform sizes.

PXI-5671, PXIe-5672: The value of this property depends on the I/Q rate. Set the nirfsg.Session.iq_rate property before reading this property.

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

High-Level Methods:

nirfsg.Session.query_arb_waveform_capabilities()

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

int

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Waveform Capabilities:Waveform Quantum

C Attribute: NIRFSG_ATTR_ARB_WAVEFORM_QUANTUM

arb_waveform_repeat_count 

nirfsg.Session.arb_waveform_repeat_count

Specifies the repeat count of a waveform when you set the nirfsg.Session.arb_waveform_repeat_count_is_finite property to True. This property is valid only when you set the nirfsg.Session.generation_mode property to ARB_WAVEFORM. To set this property, the NI-RFSG device must be in the Configuration state.

Default Value: 1

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

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

int

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Waveform Repeat Count

C Attribute: NIRFSG_ATTR_ARB_WAVEFORM_REPEAT_COUNT

arb_waveform_repeat_count_is_finite 

nirfsg.Session.arb_waveform_repeat_count_is_finite

Specifies the repetition mode of a waveform when you set the nirfsg.Session.generation_mode property to ARB_WAVEFORM. If you set this property to True, the number of repetitions is determined by the nirfsg.Session.arb_waveform_repeat_count property. To set this property, the NI-RFSG device must be in the Configuration state.

Default Value: False

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

Defined Values:

Value

Description

True

Repeats the waveform a finite number of times.

False

Repeats the waveform continuously until you abort the generation.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

bool

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Waveform Repeat Count Is Finite

C Attribute: NIRFSG_ATTR_ARB_WAVEFORM_REPEAT_COUNT_IS_FINITE

arb_waveform_size_max 

nirfsg.Session.arb_waveform_size_max

Returns the size of the largest waveform that is allowed.

To read this property, the NI-RFSG device must be in the Configuration state.

For the PXI-5671 and PXIe-5672, the value of this property depends on the I/Q rate. Set the nirfsg.Session.iq_rate before reading this property. For the PXIe-5673/5673E, the maximum waveform size is reduced to account for the amount of device memory currently used.

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

High-Level Methods:

nirfsg.Session.query_arb_waveform_capabilities()

Note

Not all onboard memory is available for waveform storage. A portion of onboard memory stores scripts that specify how the waveforms are generated. These scripts typically require less than 1KB of onboard memory.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

int

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Waveform Capabilities:Max Waveform Size

C Attribute: NIRFSG_ATTR_ARB_WAVEFORM_SIZE_MAX

arb_waveform_size_min 

nirfsg.Session.arb_waveform_size_min

Returns the smallest allowable waveform size. For the PXI-5671 and PXIe-5672, the value of this property depends on the I/Q rate. Set the nirfsg.Session.iq_rate property before reading this property.

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

High-Level Methods:

nirfsg.Session.query_arb_waveform_capabilities()

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

int

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Waveform Capabilities:Min Waveform Size

C Attribute: NIRFSG_ATTR_ARB_WAVEFORM_SIZE_MIN

arb_waveform_software_scaling_factor 

nirfsg.Session.arb_waveform_software_scaling_factor

Specifies how much to scale the data before writing it with the nirfsg.Session.WriteArbWaveform() method. The resulting waveform must be smaller than 1.0 in complex magnitude. This property is supported only if you set the nirfsg.Session.power_level_type property to PEAK.

Default Value: 1.0

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

Related Topics

Spurious Performance

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Software Scaling Factor

C Attribute: NIRFSG_ATTR_ARB_WAVEFORM_SOFTWARE_SCALING_FACTOR

attenuator_setting 

nirfsg.Session.attenuator_setting

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

Units: dB

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

Supported Devices: PXIe-5654 with PXIe-5696

Note

Resetting this property reverts back to the default unset behavior.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Attenuator Setting (dB)

C Attribute: NIRFSG_ATTR_ATTENUATOR_SETTING

automatic_thermal_correction 

nirfsg.Session.automatic_thermal_correction

Enables or disables automatic thermal correction. When this property is enabled, changes to settings cause NI-RFSG to check whether the device temperature has changed and adjusts the settings as needed. When this property is disabled, you must explicitly call the nirfsg.Session.perform_thermal_correction() method to adjust the device for temperature changes.

Default Value: 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/5842/5860

Related Topics

Temperature Monitoring

Settling Times

Defined Values:

Name

Value

Description

DISABLE

0 (0x0)

Automatic thermal correction is disabled.

ENABLE

1 (0x1)

Automatic thermal correction is enabled.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.AutomaticThermalCorrection

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Automatic Thermal Correction

C Attribute: NIRFSG_ATTR_AUTOMATIC_THERMAL_CORRECTION

auto_power_search 

nirfsg.Session.auto_power_search

Enables or disables automatic power search. When this property 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 property is disabled, NI-RFSG does not perform a power search unless you call the nirfsg.Session.perform_power_search() method.

This property is ignored when the nirfsg.Session.alc_control property is enabled.

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

Default Value:

PXIe-5654: DISABLE

PXIe-5654 with PXIe-5696: ENABLE

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

Related Topics

Power Search

Defined Values:

Name

Value

Description

DISABLE

0 (0x0)

Disables automatic power search.

ENABLE

1 (0x1)

Enables automatic power search.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.AutomaticPowerSearch

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Automatic Power Search

C Attribute: NIRFSG_ATTR_AUTO_POWER_SEARCH

available_paths 

nirfsg.Session.available_paths

Returns a list of the configurable paths available for use based on your instrument configuration.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

list of str

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Signal Path:Advanced:Available Paths

C Attribute: NIRFSG_ATTR_AVAILABLE_PATHS

available_ports 

nirfsg.Session.available_ports

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

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

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

list of str

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:Signal Path:Available Ports

C Attribute: NIRFSG_ATTR_AVAILABLE_PORTS

configuration_settled_event_terminal_name 

nirfsg.Session.configuration_settled_event_terminal_name

Returns the name of the fully qualified signal name as a string.

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

Default Values:

PXIe-5654/5654 with PXIe-5696: /ModuleName/ConfigurationSettledEvent, where ModuleName is the name of your device in MAX.

PXIe-5830/5831/5832: /BasebandModule/ao/0/ConfigurationSettledEvent, where BasebandModule is the name of the baseband module of your device in MAX.

PXIe-5820/5840/5841/5842: /ModuleName/ao/0/ConfigurationSettledEvent, where ModuleName is the name of your device in MAX.

Related Topics

Events

Syntax for Terminal Names

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Events:Configuration Settled Event Terminal Name

C Attribute: NIRFSG_ATTR_CONFIGURATION_SETTLED_EVENT_TERMINAL_NAME

correction_temperature 

nirfsg.Session.correction_temperature

Specifies the temperature, in degrees Celsius, to use for adjusting the device settings to correct for temperature changes. If you set this property, 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 property, NI-RFSG checks the current device temperature in the Committed state and automatically sets the value of this property.

PXIe-5820/5830/5831/5832/5840/5841/5842/5860: This property 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/5842/5860

Note

Resetting this property reverts back to the default unset behavior.

Use this property 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.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Advanced:Correction Temperature

C Attribute: NIRFSG_ATTR_CORRECTION_TEMPERATURE

deembedding_compensation_gain 

nirfsg.Session.deembedding_compensation_gain

Returns the de-embedding gain applied to compensate for the mismatch on the specified port. If de-embedding is enabled, NI-RFSG uses the returned compensation gain to remove the effects of the external network between the instrument and the DUT.

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

Tip

This property can be set/get on specific ports within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container ports to specify a subset.

Example: my_session.ports[ ... ].deembedding_compensation_gain

To set/get on all ports, you can call the property directly on the nirfsg.Session.

Example: my_session.deembedding_compensation_gain

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read only

Repeated Capabilities

ports

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: De-embedding:Compensation Gain

C Attribute: NIRFSG_ATTR_DEEMBEDDING_COMPENSATION_GAIN

deembedding_selected_table 

nirfsg.Session.deembedding_selected_table

Selects the de-embedding table to apply to the measurements on the specified port.

To use this property, you must use the channelName parameter of the nirfsg.Session._set_attribute_vi_string() method to specify the name of the port to configure for de-embedding.

If de-embedding is enabled, NI-RFSG uses the specified table to remove the effects of the external network between the instrument and the DUT.

Use the create deembedding sparameter table array method to create tables.

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

Tip

This property can be set/get on specific ports within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container ports to specify a subset.

Example: my_session.ports[ ... ].deembedding_selected_table

To set/get on all ports, you can call the property directly on the nirfsg.Session.

Example: my_session.deembedding_selected_table

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read-write

Repeated Capabilities

ports

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: De-embedding:Selected Table

C Attribute: NIRFSG_ATTR_DEEMBEDDING_SELECTED_TABLE

deembedding_type 

nirfsg.Session.deembedding_type

Specifies the type of de-embedding to apply to measurements on the specified port.

To use this property, you must use the channelName parameter of the nirfsg.Session._set_attribute_vi_int32() method to specify the name of the port to configure for de-embedding.

If you set this property to SCALAR or VECTOR, NI-RFSG adjusts the instrument settings and the returned data to remove the effects of the external network between the instrument and the DUT.

Default Value: SCALAR

Valid Values for PXIe-5830/5832/5840/5841/5842/5860 : SCALAR or NONE

Valid Values for PXIe-5831 SCALAR, VECTOR, or NONE. VECTOR is only supported for TRX Ports in a Semiconductor Test System (STS).

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

Defined Values:

Name

Value

Description

NONE

25000 (0x61a8)

De-embedding is not applied to the measurement.

SCALAR

25001 (0x61a9)

De-embeds the measurement using only the gain term.

VECTOR

25002 (0x61aa)

De-embeds the measurement using the gain term and the reflection term.

Tip

This property can be set/get on specific ports within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container ports to specify a subset.

Example: my_session.ports[ ... ].deembedding_type

To set/get on all ports, you can call the property directly on the nirfsg.Session.

Example: my_session.deembedding_type

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.DeembeddingType

Permissions

read-write

Repeated Capabilities

ports

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: De-embedding:Type

C Attribute: NIRFSG_ATTR_DEEMBEDDING_TYPE

device_instantaneous_bandwidth 

nirfsg.Session.device_instantaneous_bandwidth

Specifies the bandwidth of the device. The instantaneous bandwidth is the effective real-time bandwidth of the signal path for your configuration.

The nirfsg.Session.signal_bandwidth centered at the nirfsg.Session.frequency must fit within the device instantaneous bandwidth, which is centered at the nirfsg.Session.upconverter_center_frequency.

Units: Hz

Default Value: N/A

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

Related Topics

PXIe-5830 Frequency and Bandwidth Selection

PXIe-5831/5832 Frequency and Bandwidth Selection

PXIe-5841 Frequency and Bandwidth Selection

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Device Instantaneous Bandwidth (Hz)

C Attribute: NIRFSG_ATTR_DEVICE_INSTANTANEOUS_BANDWIDTH

device_temperature 

nirfsg.Session.device_temperature

Returns the device temperature. If the NI-RFSG session is controlling multiple devices, this property returns the temperature of the primary NI RF device. The NI-RFSG session is opened using the primary RF device name.

Serial signals between the sensor and the system control unit could modulate the signal being generated, thus causing phase spurs. After the device thoroughly warms up, its temperature varies only slightly (less than 1 degree Celsius) and slowly, and it is not necessary to constantly poll this temperature sensor.

PXIe-5644/5645/5646, PXIe-5820/5840/5841: If you query this property during RF list mode, list steps may take longer to complete during list execution.

PXIe-5830/5831/5832: To use this property, you must first set the channelName parameter of the nirfsg.Session._set_attribute_vi_real64() method to using the appropriate string for your instrument configuration. Setting the nirfsg.Session._set_attribute_vi_real64() method is not required for the PXIe-3621/3622. Refer to the following table to determine which strings are valid for your configuration.

Units: degrees Celsius (°C)

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/5842/5860

Related Topics

Temperature Monitoring

Thermal Shutdown

Hardware Module

TRX Port Type

Active Channel String

PXIe-3621/3622

—

if or “” (empty string)

PXIe-5820

—

fpga

First connected mmRH-5582

DIRECT TRX PORTS Only

rf0

First connected mmRH-5582

SWITCHED TRX PORTS [0-7]

rf0switch0

First connected mmRH-5582

SWITCHED TRX PORTS [0-7]

rf0switch1

Second connected mmRH-5582

DIRECT TRX PORTS Only

rf1

Second connected mmRH-5582

SWITCHED TRX PORTS [0-7]

rf1switch0

Second connected mmRH-5582

SWITCHED TRX PORTS [0-7]

rf1switch1

Tip

This property can be set/get on specific device_temperatures within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container device_temperatures to specify a subset.

Example: my_session.device_temperatures[ ... ].device_temperature

To set/get on all device_temperatures, you can call the property directly on the nirfsg.Session.

Example: my_session.device_temperature

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read only

Repeated Capabilities

device_temperatures

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Characteristics:Device Temperature (Degrees C)

C Attribute: NIRFSG_ATTR_DEVICE_TEMPERATURE

digital_edge_script_trigger_edge 

nirfsg.Session.digital_edge_script_trigger_edge

Specifies the active edge for the Script Trigger. This property is used when the nirfsg.Session.script_trigger_type property is set to digital edge. To set the nirfsg.Session.digital_edge_script_trigger_edge property, the NI-RFSG device must be in the Configuration state.

Default Value: RISING

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

Related Topics

Script Trigger

Digital Edge Trigger

High-Level Methods:

nirfsg.Session.configure_digital_edge_script_trigger()

Defined Values:

Name

Value

Description

FALLING

1 (0x1)

Asserts the trigger when the signal transitions from high level to low level.

RISING

0 (0x0)

Asserts the trigger when the signal transitions from low level to high level.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

Tip

This property can be set/get on specific script_triggers within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container script_triggers to specify a subset.

Example: my_session.script_triggers[ ... ].digital_edge_script_trigger_edge

To set/get on all script_triggers, you can call the property directly on the nirfsg.Session.

Example: my_session.digital_edge_script_trigger_edge

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.ScriptTriggerDigitalEdgeEdge

Permissions

read-write

Repeated Capabilities

script_triggers

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Triggers:Script:Digital Edge:Edge

C Attribute: NIRFSG_ATTR_DIGITAL_EDGE_SCRIPT_TRIGGER_EDGE

digital_edge_script_trigger_source 

nirfsg.Session.digital_edge_script_trigger_source

Specifies the source terminal for the Script Trigger. This property is used when the nirfsg.Session.script_trigger_type property is set to digital edge. To set this property, the NI-RFSG device must be in the Configuration state.

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

Related Topics

Script Trigger

PFI Lines

PXI Trigger Lines

High-Level Methods:

nirfsg.Session.configure_digital_edge_script_trigger()

Possible Values:

Possible Value

Description

“PFI0”

The trigger is received on PFI 0.

“PFI1”

The trigger is received on PFI 1.

“PFI2”

The trigger is received on PFI 2.

“PFI3”

The trigger is received on PFI 3.

“PXI_Star”

The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.

“PXI_Trig0”

The trigger is received on PXI trigger line 0.

“PXI_Trig1”

The trigger is received on PXI trigger line 1.

“PXI_Trig2”

The trigger is received on PXI trigger line 2.

“PXI_Trig3”

The trigger is received on PXI trigger line 3.

“PXI_Trig4”

The trigger is received on PXI trigger line 4.

“PXI_Trig5”

The trigger is received on PXI trigger line 5.

“PXI_Trig6”

The trigger is received on PXI trigger line 6.

“PXI_Trig7”

The trigger is received on PXI trigger line 7.

“PXIe_DStarB”

The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860.

“PulseIn”

The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842.

“DIO/PFI0”

The trigger is received on PFI0 from the front panel DIO terminal.

“DIO/PFI1”

The trigger is received on PFI1 from the front panel DIO terminal.

“DIO/PFI2”

The trigger is received on PFI2 from the front panel DIO terminal.

“DIO/PFI3”

The trigger is received on PFI3 from the front panel DIO terminal.

“DIO/PFI4”

The trigger is received on PFI4 from the front panel DIO terminal.

“DIO/PFI5”

The trigger is received on PFI5 from the front panel DIO terminal.

“DIO/PFI6”

The trigger is received on PFI6 from the front panel DIO terminal.

“DIO/PFI7”

The trigger is received on PFI7 from the front panel DIO terminal.

“Sync_Script”

The trigger is received on the Sync Script trigger line. This value is valid on only the PXIe-5644/5645/5646.

Tip

This property can be set/get on specific script_triggers within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container script_triggers to specify a subset.

Example: my_session.script_triggers[ ... ].digital_edge_script_trigger_source

To set/get on all script_triggers, you can call the property directly on the nirfsg.Session.

Example: my_session.digital_edge_script_trigger_source

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read-write

Repeated Capabilities

script_triggers

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Triggers:Script:Digital Edge:Source

C Attribute: NIRFSG_ATTR_DIGITAL_EDGE_SCRIPT_TRIGGER_SOURCE

digital_edge_start_trigger_edge 

nirfsg.Session.digital_edge_start_trigger_edge

Specifies the active edge for the Start Trigger. This property is used when the nirfsg.Session.start_trigger_type property is set to digital edge. To set the nirfsg.Session.digital_edge_start_trigger_edge property, the NI-RFSG device must be in the Configuration state.

PXIe-5654/5654 with PXIe-5696: The Start Trigger is valid only with a timer-based list when RF list mode is enabled.

Default Value: RISING

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

Related Topics

Start Trigger

Digital Edge Trigger

High-Level Methods:

nirfsg.Session.configure_digital_edge_start_trigger()

Defined Values:

Name

Value

Description

FALLING

1 (0x1)

Occurs when the signal transitions from high level to low level.

RISING

0 (0x0)

Occurs when the signal transitions from low level to high level.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.StartTriggerDigitalEdgeEdge

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Triggers:Start:Digital Edge

C Attribute: NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_EDGE

digital_edge_start_trigger_source 

nirfsg.Session.digital_edge_start_trigger_source

Specifies the source terminal for the Start Trigger. This property is used when the nirfsg.Session.start_trigger_type property is set to digital edge. The nirfsg.Session.digital_edge_start_trigger_source property is not case-sensitive. To set the nirfsg.Session.digital_edge_start_trigger_source property, the NI-RFSG device must be in the Configuration state.

PXIe-5654/5654 with PXIe-5696: The Start Trigger is valid only with a timer-based list when RF list mode is enabled.

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

Related Topics

Start Trigger

PFI Lines

PXI Trigger Lines

High-Level Methods:

nirfsg.Session.configure_digital_edge_start_trigger()

Possible Values:

Possible Value

Description

“PFI0”

The trigger is received on PFI 0.

“PFI1”

The trigger is received on PFI 1.

“PFI2”

The trigger is received on PFI 2.

“PFI3”

The trigger is received on PFI 3.

“PXI_Star”

The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.

“PXI_Trig0”

The trigger is received on PXI trigger line 0.

“PXI_Trig1”

The trigger is received on PXI trigger line 1.

“PXI_Trig2”

The trigger is received on PXI trigger line 2.

“PXI_Trig3”

The trigger is received on PXI trigger line 3.

“PXI_Trig4”

The trigger is received on PXI trigger line 4.

“PXI_Trig5”

The trigger is received on PXI trigger line 5.

“PXI_Trig6”

The trigger is received on PXI trigger line 6.

“PXI_Trig7”

The trigger is received on PXI trigger line 7.

“PXIe_DStarB”

The trigger is received on the PXI DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860.

“TrigIn”

The trigger is received on the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696.

“DIO/PFI0”

The trigger is received on PFI0 from the front panel DIO terminal.

“DIO/PFI1”

The trigger is received on PFI1 from the front panel DIO terminal.

“DIO/PFI2”

The trigger is received on PFI2 from the front panel DIO terminal.

“DIO/PFI3”

The trigger is received on PFI3 from the front panel DIO terminal.

“DIO/PFI4”

The trigger is received on PFI4 from the front panel DIO terminal.

“DIO/PFI5”

The trigger is received on PFI5 from the front panel DIO terminal.

“DIO/PFI6”

The trigger is received on PFI6 from the front panel DIO terminal.

“DIO/PFI7”

The trigger is received on PFI7 from the front panel DIO terminal.

“Sync_Script”

The trigger is received on the Sync Script trigger line. This value is valid on only the PXIe-5644/5645/5646.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Triggers:Start:Digital Edge:Source

C Attribute: NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_SOURCE

digital_equalization_enabled 

nirfsg.Session.digital_equalization_enabled

When this property is enabled, NI-RFSG equalizes the waveform data to correct for variations in the response of the NI-RFSG device. Enabling digital equalization improves the modulation error rates (MER) and error vector magnitude (EVM) for signals with large bandwidths (>500 kHz), but it increases tuning times.

On the PXI-5670/5671, equalization is performed in the software, so tuning time is increased. On the PXIe-5672, equalization is performed in the hardware so that there is no compromise in performance.

This property applies only when the nirfsg.Session.generation_mode property is set to ARB_WAVEFORM or SCRIPT. To set this property, the NI-RFSG device must be in the Configuration state.

PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: ENABLE is the only supported value for this device.

Default Value:

PXI-5670/5671: DISABLE

PXIe-5644/5645/5646, PXIe-5672, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: ENABLE

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

Related Topics

Response and Software Equalization—Refer to this topic for more information about equalization performed in software.

Frequency Tuning Times

Defined Values:

Name

Value

Description

DISABLE

0 (0x0)

Filter is not applied

ENABLE

1 (0x1)

Filter is applied.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.DigitalEqualizationEnabled

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Digital Equalization Enabled

C Attribute: NIRFSG_ATTR_DIGITAL_EQUALIZATION_ENABLED

digital_level_script_trigger_active_level 

nirfsg.Session.digital_level_script_trigger_active_level

Specifies the active level for the Script Trigger. This property is used when the nirfsg.Session.script_trigger_type property is set to DIGITAL_LEVEL.

Default Value: HIGH

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

Related Topics

Script Trigger

Digital Level Trigger

Defined Values:

Name

Value

Description

HIGH

9000 (0x2328)

Trigger when the digital trigger signal is high.

LOW

9001 (0x2329)

Trigger when the digital trigger signal is low.

Tip

This property can be set/get on specific script_triggers within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container script_triggers to specify a subset.

Example: my_session.script_triggers[ ... ].digital_level_script_trigger_active_level

To set/get on all script_triggers, you can call the property directly on the nirfsg.Session.

Example: my_session.digital_level_script_trigger_active_level

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.ScriptTriggerDigitalLevelActiveLevel

Permissions

read-write

Repeated Capabilities

script_triggers

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Triggers:Script:Digital Level:Active Level

C Attribute: NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_ACTIVE_LEVEL

digital_level_script_trigger_source 

nirfsg.Session.digital_level_script_trigger_source

Specifies the source terminal for the Script Trigger. This property is used when the nirfsg.Session.script_trigger_type property is set to DIGITAL_LEVEL. The nirfsg.Session.digital_level_script_trigger_source property is not case-sensitive.

To set the nirfsg.Session.digital_level_script_trigger_source property, the NI-RFSG device must be in the Configuration state.

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

Related Topics

Script Trigger

PFI Lines

PXI Trigger Lines

Possible Values:

Possible Value

Description

“PFI0”

The trigger is received on PFI 0.

“PFI1”

The trigger is received on PFI 1.

“PFI2”

The trigger is received on PFI 2.

“PFI3”

The trigger is received on PFI 3.

“PXI_Star”

The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.

“PXI_Trig0”

The trigger is received on PXI trigger line 0.

“PXI_Trig1”

The trigger is received on PXI trigger line 1.

“PXI_Trig2”

The trigger is received on PXI trigger line 2.

“PXI_Trig3”

The trigger is received on PXI trigger line 3.

“PXI_Trig4”

The trigger is received on PXI trigger line 4.

“PXI_Trig5”

The trigger is received on PXI trigger line 5.

“PXI_Trig6”

The trigger is received on PXI trigger line 6.

“PXI_Trig7”

The trigger is received on PXI trigger line 7.

“PXIe_DStarB”

The trigger is received on the PXIe DStar B trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860.

“PulseIn”

The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842.

“DIO/PFI0”

The trigger is received on PFI0 from the front panel DIO terminal.

“DIO/PFI1”

The trigger is received on PFI1 from the front panel DIO terminal.

“DIO/PFI2”

The trigger is received on PFI2 from the front panel DIO terminal.

“DIO/PFI3”

The trigger is received on PFI3 from the front panel DIO terminal.

“DIO/PFI4”

The trigger is received on PFI4 from the front panel DIO terminal.

“DIO/PFI5”

The trigger is received on PFI5 from the front panel DIO terminal.

“DIO/PFI6”

The trigger is received on PFI6 from the front panel DIO terminal.

“DIO/PFI7”

The trigger is received on PFI7 from the front panel DIO terminal.

Tip

This property can be set/get on specific script_triggers within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container script_triggers to specify a subset.

Example: my_session.script_triggers[ ... ].digital_level_script_trigger_source

To set/get on all script_triggers, you can call the property directly on the nirfsg.Session.

Example: my_session.digital_level_script_trigger_source

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read-write

Repeated Capabilities

script_triggers

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Triggers:Script:Digital Level:Source

C Attribute: NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_SOURCE

direct_download 

nirfsg.Session.direct_download

Specifies whether the nirfsg.Session.WriteArbWaveform() method immediately writes waveforms to the device or copies the waveform to host memory for later download. NI-RFSG reads and validates this property when an arbitrary waveform is first allocated.

For the PXI-5670, direct download is always disabled. For all other devices, direct download is always enabled.

PXI-5671: To increase performance when using large waveforms, enable direct download. To maximize reconfigurability, disable direct download.

Perform the following steps to enable direct download:

Set the I/Q rate to less than or equal to 8.33MS/s with the nirfsg.Session.iq_rate property.

Set the nirfsg.Session.power_level_type property to PEAK.

Disable the nirfsg.Session.iq_swap_enabled property.

Disable the nirfsg.Session.digital_equalization_enabled property.

Supported Devices: PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860

Defined Values:

Name

Value

Description

DISABLE

0 (0x0)

The RF In local oscillator signal is not present at the front panel LO OUT connector.

ENABLE

1 (0x1)

The RF In local oscillator signal is present at the front panel LO OUT connector.

UNSPECIFIED

-2 (-0x2)

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.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.DirectDownload

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Data Transfer:Direct Download

C Attribute: NIRFSG_ATTR_DIRECT_DOWNLOAD

done_event_terminal_name 

nirfsg.Session.done_event_terminal_name

Returns the name of the fully qualified signal name as a string.

Default Values:

PXI-5670/5671, PXIe-5672/5673/5673E: /AWGName/DoneEvent, where AWGName is the name of your associated AWG module in MAX.

PXIe-5830/5831/5832: /BasebandModule/ao/0/DoneEvent, where BasebandModule is the name of the baseband module of your device in MAX.

PXIe-5820/5840/5841: /ModuleName/ao/0/DoneEvent, where ModuleName is the name of your device in MAX.

PXIe-5860: /ModuleName/ao/ChannelNumber/DoneEvent, where ModuleName is the name of your device in MAX and ChannelNumber is the channel number (0 or 1).

Supported Devices: PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860

Related Topics

Events

Syntax for Terminal Names

High-Level Methods:

nirfsg.Session.get_terminal_name()

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Events:Done Event Terminal Name

C Attribute: NIRFSG_ATTR_DONE_EVENT_TERMINAL_NAME

events_delay 

nirfsg.Session.events_delay

Specifies the delay, in seconds, applied to the Started Event, Done Event, and all Marker Events with respect to the analog output of the RF signal generator. To set this property, the NI-RFSG device must be in the Configuration or Generation state.

By default, markers and events are delayed to align with the waveform data generated from the device. This property adds an additional delay to markers and events. Use this property to adjust the time delay between events and the corresponding data.

Units: Seconds

Valid Values:

PXIe-5644/5645: -1.217 μs to 67.050 μs

PXIe-5646: -0.896 μs to 64.640 μs

PXIe-5820/5830/5831/5832/5840/5841/5842: 0 μs to 3.276 μs

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

Related Topics

Events

Note

If you decrease the event delay during generation, some markers may be dropped.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

hightime.timedelta, datetime.timedelta, or float in seconds

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:Events:Events Delay

C Attribute: NIRFSG_ATTR_EVENTS_DELAY

exported_configuration_settled_event_output_terminal 

nirfsg.Session.exported_configuration_settled_event_output_terminal

Specifies the destination terminal for exporting the Configuration Settled event. To set this property, the NI-RFSG device must be in the Configuration state.

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

Related Topics

Triggers

Events

PFI Lines

PXI Trigger Lines

Possible Values:

Possible Value

Description

“”

The signal is not exported.

“PXI_Trig0”

The trigger is received on PXI trigger line 0.

“PXI_Trig1”

The trigger is received on PXI trigger line 1.

“PXI_Trig2”

The trigger is received on PXI trigger line 2.

“PXI_Trig3”

The trigger is received on PXI trigger line 3.

“PXI_Trig4”

The trigger is received on PXI trigger line 4.

“PXI_Trig5”

The trigger is received on PXI trigger line 5.

“PXI_Trig6”

The trigger is received on PXI trigger line 6.

“PXIe_DStarC”

The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5840/5841/5842.

“TrigOut”

TRIG IN/OUT terminal.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Events:Configuration Settled Event Export Output Terminal

C Attribute: NIRFSG_ATTR_EXPORTED_CONFIGURATION_SETTLED_EVENT_OUTPUT_TERMINAL

exported_done_event_output_terminal 

nirfsg.Session.exported_done_event_output_terminal

Specifies the destination terminal for exporting the Done event. To set this property, the NI-RFSG device must be in the Configuration state.

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

Related Topics

Triggers

Events

PFI Lines

PXI Trigger Lines

Possible Values:

Posible Value

Description

“”

The signal is not exported.

“PFI0”

The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0.

“PFI1”

The signal is exported to the PFI 1 connector.

“PFI4”

The signal is exported to the PFI 4 connector.

“PFI5”

The signal is exported to the PFI 5 connector.

“PXI_Trig0”

The trigger is received on PXI trigger line 0.

“PXI_Trig1”

The trigger is received on PXI trigger line 1.

“PXI_Trig2”

The trigger is received on PXI trigger line 2.

“PXI_Trig3”

The trigger is received on PXI trigger line 3.

“PXI_Trig4”

The trigger is received on PXI trigger line 4.

“PXI_Trig5”

The trigger is received on PXI trigger line 5.

“PXI_Trig6”

The trigger is received on PXI trigger line 6.

“PXIe_DStarC”

The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.

“DIO/PFI0”

The trigger is received on PFI0 from the front panel DIO terminal.

“DIO/PFI1”

The trigger is received on PFI1 from the front panel DIO terminal.

“DIO/PFI2”

The trigger is received on PFI2 from the front panel DIO terminal.

“DIO/PFI3”

The trigger is received on PFI3 from the front panel DIO terminal.

“DIO/PFI4”

The trigger is received on PFI4 from the front panel DIO terminal.

“DIO/PFI5”

The trigger is received on PFI5 from the front panel DIO terminal.

“DIO/PFI6”

The trigger is received on PFI6 from the front panel DIO terminal.

“DIO/PFI7”

The trigger is received on PFI7 from the front panel DIO terminal.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Events:Done Event Export Output Terminal

C Attribute: NIRFSG_ATTR_EXPORTED_DONE_EVENT_OUTPUT_TERMINAL

exported_marker_event_output_terminal 

nirfsg.Session.exported_marker_event_output_terminal

Specifies the destination terminal for exporting the Marker Event. To set this property, the NI-RFSG device must be in the Configuration state.

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

Related Topics

Marker Events

PFI Lines

PXI Trigger Lines

Possible Values:

Possible Value

Description

“”

The signal is not exported.

“PFI0”

The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0.

“PFI1”

The signal is exported to the PFI 1 connector.

“PFI4”

The signal is exported to the PFI 4 connector.

“PFI5”

The signal is exported to the PFI 5 connector.

“PXI_Trig0”

The trigger is received on PXI trigger line 0.

“PXI_Trig1”

The trigger is received on PXI trigger line 1.

“PXI_Trig2”

The trigger is received on PXI trigger line 2.

“PXI_Trig3”

The trigger is received on PXI trigger line 3.

“PXI_Trig4”

The trigger is received on PXI trigger line 4.

“PXI_Trig5”

The trigger is received on PXI trigger line 5.

“PXI_Trig6”

The trigger is received on PXI trigger line 6.

“PXIe_DStarC”

The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.

“DIO/PFI0”

The trigger is received on PFI0 from the front panel DIO terminal.

“DIO/PFI1”

The trigger is received on PFI1 from the front panel DIO terminal.

“DIO/PFI2”

The trigger is received on PFI2 from the front panel DIO terminal.

“DIO/PFI3”

The trigger is received on PFI3 from the front panel DIO terminal.

“DIO/PFI4”

The trigger is received on PFI4 from the front panel DIO terminal.

“DIO/PFI5”

The trigger is received on PFI5 from the front panel DIO terminal.

“DIO/PFI6”

The trigger is received on PFI6 from the front panel DIO terminal.

“DIO/PFI7”

The trigger is received on PFI7 from the front panel DIO terminal.

Tip

This property can be set/get on specific markers within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container markers to specify a subset.

Example: my_session.markers[ ... ].exported_marker_event_output_terminal

To set/get on all markers, you can call the property directly on the nirfsg.Session.

Example: my_session.exported_marker_event_output_terminal

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read-write

Repeated Capabilities

markers

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Events:Marker:Output Terminal

C Attribute: NIRFSG_ATTR_EXPORTED_MARKER_EVENT_OUTPUT_TERMINAL

exported_pulse_modulation_event_active_level 

nirfsg.Session.exported_pulse_modulation_event_active_level

Specifies the active level of the exported Pulse Modulation Event. When property pulse modulation enabled is Enabled, pulse modulation active level is active high, exported pulse modulation event output terminal is PulseOut, and this property is active high, then the Pulse Modulation Event will transition from Low to High after the the Pulse In signal is set to logic high, and the RF Output has settled. To set this property, the NI-RFSG device must be in the Configuration state.

Default Value: HIGH

Supported Devices: PXIe-5842

Defined Values:

Name

Value

Description

HIGH

9000 (0x2328)

Trigger when the digital trigger signal is high.

LOW

9001 (0x2329)

Trigger when the digital trigger signal is low.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.ScriptTriggerDigitalLevelActiveLevel

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Events:Pulse Modulation:Exported Pulse Modulation Event Active Level

C Attribute: NIRFSG_ATTR_EXPORTED_PULSE_MODULATION_EVENT_ACTIVE_LEVEL

exported_pulse_modulation_event_output_terminal 

nirfsg.Session.exported_pulse_modulation_event_output_terminal

Specifies the destination terminal for exporting the Pulse Modulation Event. The Pulse Modulation Event tracks the RF Envelope when Pulse Modulation is Enabled. If this property is set to a value other than do not export str, calling NI-RFSG Commit will cause the output terminal to be pulled to the logic level that is the inverse of exported pulse modulation event active level. You can tri-state this terminal by setting this property to do not export str or by calling niRFSG Reset. To set this property, the NI-RFSG device must be in the Configuration state.

Default Value: PulseOut

Supported Devices: PXIe-5842

Possible Values:

Possible Value

Description

“”

Pulse modulation video signal is not exported.

“PulseOut”

Export the pulse modulation video signal on the pulse out terminal.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.PulseModulationOutputTerminal

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Events:Pulse Modulation:Exported Pulse Modulation Event Output Terminal

C Attribute: NIRFSG_ATTR_EXPORTED_PULSE_MODULATION_EVENT_OUTPUT_TERMINAL

exported_ref_clock_output_terminal 

nirfsg.Session.exported_ref_clock_output_terminal

Specifies the destination terminal for exporting the Reference Clock on the RF signal generators. To set this property, the NI-RFSG device must be in the Configuration state.

Possible Values:

Possible Value: Description

“” :The Reference Clock signal is not exported.

“RefOut” :Exports the Reference Clock signal to the REF OUT connector of the device.

“RefOut2” :Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable.

“ClkOut” :Exports the Reference Clock signal to the CLK OUT connector of the device.

Default Value: ‘””’

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

Related Topics

Interconnecting Multiple NI 5673E Modules

Possible Value

Description

Supported devices

“ClkOut”

Exports the Reference Clock signal to the CLK OUT connector of the device.

Supported on PXIe-5673, 5673E

“”

The Reference Clock signal is not exported.

Supported on PXIe-5644/5645/5646, 5820/5830/5831/5832/5840/5841/5842/5860, 5650/5651/5652, 5654, 5673, 5673E, PXIe-5654 with PXIe-5696, PXI-5650/5651/5652 (See Note)

“RefOut”

Exports the Reference Clock signal to the REF OUT connector of the device.

Supported on PXIe-5644/5645/5646, 5820/5830/5831/5832/5840/5841/5842/5860, 5650/5651/5653, 5653, 5654, 5673, 5673E, PXIe-5654 with PXIe-5696, PXI-5650/5651/5653,

“RefOut2”

Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable.

Supported on PXIe-5650/5651/5652, 5654, 5673E, PXIe-5654 with PXIe-5696

Note

The RefOut2 output terminal value is valid for only the PXIe-5650/5651/5652, not the PXI-5650/5651/5652.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.ReferenceClockExportOutputTerminal

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Clock:Reference Clock Export Output Terminal

C Attribute: NIRFSG_ATTR_EXPORTED_REF_CLOCK_OUTPUT_TERMINAL

exported_ref_clock_rate 

nirfsg.Session.exported_ref_clock_rate

Specifies the Reference Clock Rate, in Hz, of the signal sent to the Reference Clock Export Output Terminal. To set this property, the NI-RFSG device must be in the Configuration state.

Default Value: 10MHz

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

Defined Values:

Value

Description

10000000.0

Uses a 10MHz Reference Clock rate.

100000000.0

Uses a 100MHz Reference Clock rate.

1000000000.0

Uses a 1GHz Reference Clock rate.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Clock:Reference Clock Exported Rate (Hz)

C Attribute: NIRFSG_ATTR_EXPORTED_REF_CLOCK_RATE

exported_script_trigger_output_terminal 

nirfsg.Session.exported_script_trigger_output_terminal

Specifies the destination terminal for exporting the Script Trigger. To set this property, the NI-RFSG device must be in the Configuration state.

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

Related Topics

Script Trigger —Refer to this topic for information about trigger delay.

PFI Lines

PXI Trigger Lines

Possible Values:

Possible Value

Description

“”

The signal is not exported.

“PFI0”

The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0.

“PFI1”

The signal is exported to the PFI 1 connector.

“PFI4”

The signal is exported to the PFI 4 connector.

“PFI5”

The signal is exported to the PFI 5 connector.

“PXI_Trig0”

The trigger is received on PXI trigger line 0.

“PXI_Trig1”

The trigger is received on PXI trigger line 1.

“PXI_Trig2”

The trigger is received on PXI trigger line 2.

“PXI_Trig3”

The trigger is received on PXI trigger line 3.

“PXI_Trig4”

The trigger is received on PXI trigger line 4.

“PXI_Trig5”

The trigger is received on PXI trigger line 5.

“PXI_Trig6”

The trigger is received on PXI trigger line 6.

“PXIe_DStarC”

The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.

“DIO/PFI0”

The trigger is received on PFI0 from the front panel DIO terminal.

“DIO/PFI1”

The trigger is received on PFI1 from the front panel DIO terminal.

“DIO/PFI2”

The trigger is received on PFI2 from the front panel DIO terminal.

“DIO/PFI3”

The trigger is received on PFI3 from the front panel DIO terminal.

“DIO/PFI4”

The trigger is received on PFI4 from the front panel DIO terminal.

“DIO/PFI5”

The trigger is received on PFI5 from the front panel DIO terminal.

“DIO/PFI6”

The trigger is received on PFI6 from the front panel DIO terminal.

“DIO/PFI7”

The trigger is received on PFI7 from the front panel DIO terminal.

Tip

This property can be set/get on specific script_triggers within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container script_triggers to specify a subset.

Example: my_session.script_triggers[ ... ].exported_script_trigger_output_terminal

To set/get on all script_triggers, you can call the property directly on the nirfsg.Session.

Example: my_session.exported_script_trigger_output_terminal

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read-write

Repeated Capabilities

script_triggers

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Triggers:Script:Export Output Terminal

C Attribute: NIRFSG_ATTR_EXPORTED_SCRIPT_TRIGGER_OUTPUT_TERMINAL

exported_started_event_output_terminal 

nirfsg.Session.exported_started_event_output_terminal

Specifies the destination terminal for exporting the Started event. To set this property, the NI-RFSG device must be in the Configuration state.

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

Related Topics

Events

PFI Lines

PXI Trigger Lines

Possible Values:

Possible Value

Description

“”

The signal is not exported.

“PFI0”

The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0.

“PFI1”

The signal is exported to the PFI 1 connector.

“PFI4”

The signal is exported to the PFI 4 connector.

“PFI5”

The signal is exported to the PFI 5 connector.

“PXI_Trig0”

The trigger is received on PXI trigger line 0.

“PXI_Trig1”

The trigger is received on PXI trigger line 1.

“PXI_Trig2”

The trigger is received on PXI trigger line 2.

“PXI_Trig3”

The trigger is received on PXI trigger line 3.

“PXI_Trig4”

The trigger is received on PXI trigger line 4.

“PXI_Trig5”

The trigger is received on PXI trigger line 5.

“PXI_Trig6”

The trigger is received on PXI trigger line 6.

“PXIe_DStarC”

The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860.

“DIO/PFI0”

The trigger is received on PFI0 from the front panel DIO terminal.

“DIO/PFI1”

The trigger is received on PFI1 from the front panel DIO terminal.

“DIO/PFI2”

The trigger is received on PFI2 from the front panel DIO terminal.

“DIO/PFI3”

The trigger is received on PFI3 from the front panel DIO terminal.

“DIO/PFI4”

The trigger is received on PFI4 from the front panel DIO terminal.

“DIO/PFI5”

The trigger is received on PFI5 from the front panel DIO terminal.

“DIO/PFI6”

The trigger is received on PFI6 from the front panel DIO terminal.

“DIO/PFI7”

The trigger is received on PFI7 from the front panel DIO terminal.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Events:Started Event Export Output Terminal

C Attribute: NIRFSG_ATTR_EXPORTED_STARTED_EVENT_OUTPUT_TERMINAL

exported_start_trigger_output_terminal 

nirfsg.Session.exported_start_trigger_output_terminal

Specifies the destination terminal for exporting the Start Trigger. To set this property, the NI-RFSG device must be in the Configuration state.

PXIe-5654/5654 with PXIe-5696: The Start Trigger is valid only with a timer-based list when RF list mode is enabled.

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

Related Topics

Start Trigger

PFI Lines

PXI Trigger Lines

Possible Values:

Possible Value

Description

“”

The signal is not exported.

“PFI0”

The signal is exported to the PFI 0 connector. For the PXIe-5841 with PXIe-5655, the signal is exported to the PXIe-5841 PFI 0.

“PFI1”

The signal is exported to the PFI 1 connector.

“PFI4”

The signal is exported to the PFI 4 connector.

“PFI5”

The signal is exported to the PFI 5 connector.

“PXI_Trig0”

The trigger is received on PXI trigger line 0.

“PXI_Trig1”

The trigger is received on PXI trigger line 1.

“PXI_Trig2”

The trigger is received on PXI trigger line 2.

“PXI_Trig3”

The trigger is received on PXI trigger line 3.

“PXI_Trig4”

The trigger is received on PXI trigger line 4.

“PXI_Trig5”

The trigger is received on PXI trigger line 5.

“PXI_Trig6”

The trigger is received on PXI trigger line 6.

“PXIe_DStarC”

The signal is exported to the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841/5842/5860.

“TrigOut”

The signal is exported to the TRIG IN/OUT terminal. This value is valid on only the PXIe-5654/5654 with PXIe-5696.

“DIO/PFI0”

The trigger is received on PFI0 from the front panel DIO terminal.

“DIO/PFI1”

The trigger is received on PFI1 from the front panel DIO terminal.

“DIO/PFI2”

The trigger is received on PFI2 from the front panel DIO terminal.

“DIO/PFI3”

The trigger is received on PFI3 from the front panel DIO terminal.

“DIO/PFI4”

The trigger is received on PFI4 from the front panel DIO terminal.

“DIO/PFI5”

The trigger is received on PFI5 from the front panel DIO terminal.

“DIO/PFI6”

The trigger is received on PFI6 from the front panel DIO terminal.

“DIO/PFI7”

The trigger is received on PFI7 from the front panel DIO terminal.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Triggers:Start:Export Output Terminal

C Attribute: NIRFSG_ATTR_EXPORTED_START_TRIGGER_OUTPUT_TERMINAL

external_calibration_recommended_interval 

nirfsg.Session.external_calibration_recommended_interval

Returns the recommended interval between each external calibration of the device.

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/5842/5860

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

hightime.timedelta

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: External Calibration:Recommended Interval

C Attribute: NIRFSG_ATTR_EXTERNAL_CALIBRATION_RECOMMENDED_INTERVAL

external_calibration_temperature 

nirfsg.Session.external_calibration_temperature

Returns the temperature of the device at the time of the last external calibration.

Units: degrees Celsius (°C)

Supported Devices: PXI-5610, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: External Calibration:Last External Calibration Temperature

C Attribute: NIRFSG_ATTR_EXTERNAL_CALIBRATION_TEMPERATURE

external_gain 

nirfsg.Session.external_gain

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

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

Valid Values: -INF dB to +INF dB

Default Value: 0dB

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

Note

Setting this property adjusts the actual device output power to compensate for any amplification or attenuation between the RF signal generator and the device under test.

For the PXIe-5645, this property is ignored if you are using the I/Q ports.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:External Gain (dB)

C Attribute: NIRFSG_ATTR_EXTERNAL_GAIN

fast_tuning_option 

nirfsg.Session.fast_tuning_option

Returns whether the NI RF signal generator has the fast tuning option available.

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

Related Topics

Frequency Tuning Times for 5654

Defined Values:

Value

Description

True

The RF signal generator has the fast 100 µs tuning option.

False

The RF signal generator has the 1 ms tuning option.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

bool

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Characteristics:Options:Fast Tuning Option

C Attribute: NIRFSG_ATTR_FAST_TUNING_OPTION

fixed_group_delay_across_ports 

nirfsg.Session.fixed_group_delay_across_ports

Specifies a list of ports for which to fix the group delay.

Supported Devices: PXIe-5831/5832

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

list of str

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:Signal Path:Fixed Group Delay Across Ports

C Attribute: NIRFSG_ATTR_FIXED_GROUP_DELAY_ACROSS_PORTS

fpga_bitfile_path 

nirfsg.Session.fpga_bitfile_path

Returns a string containing the path to the location of the current NI-RFSG instrument driver FPGA extensions bitfile, a .lvbitx file, that is programmed on the device. You can specify the bitfile location using the Driver Setup string in the optionString parameter of the nirfsg.Session.__init__() method.

NI-RFSG instrument driver FPGA extensions enable you to use pre-compiled FPGA bitfiles to customize the behavior of the vector signal transceiver FPGA while maintaining the functionality of the NI-RFSG instrument driver.

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

Related Topics

NI-RFSG Instrument Driver FPGA Extensions

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:Device Characteristics:FPGA Bitfile Path

C Attribute: NIRFSG_ATTR_FPGA_BITFILE_PATH

fpga_target_name 

nirfsg.Session.fpga_target_name

Returns a string that contains the name of the FPGA target being used. This name can be used with the RIO open session to open a reference to the FPGA.

This property is channel dependent if multiple FPGA targets are supported.

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

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Characteristics:FPGA Target Name

C Attribute: NIRFSG_ATTR_FPGA_TARGET_NAME

fpga_temperature 

nirfsg.Session.fpga_temperature

Returns the FPGA temperature in degrees Celsius.

Serial signals between the sensor and the system control unit can potentially modulate the signal being generated, thus causing phase spurs. After the device thoroughly warms up, its temperature varies only slightly (less than 1 degree Celsius) and slowly, and it is not necessary to constantly poll this temperature sensor.

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

Note

If you query this property during RF list mode, list steps may take longer to complete during list execution.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Characteristics:FPGA Temperature (Degrees C)

C Attribute: NIRFSG_ATTR_FPGA_TEMPERATURE

frequency 

nirfsg.Session.frequency

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

The PXI-5670/5671, PXIe-5672, PXIe-5820, and PXIe-5860 must be in the Configuration state to use this property. 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/5842 can be in the Configuration or the Generation state to use this property.

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: 100MHz

PXIe-5653: 4GHz

PXIe-5820: 0Hz

PXIe-5830/5831/5832: 6.5 GHz

PXIe-5840/5841/5860, PXI-5842 (500 MHz, 1 GHz, and 2 GHz bandwidth options): 1GHz

PXIe-5842 (4 GHz bandwidth option) using the Standard personality: 1GHz

PXIe-5842 (4 GHz bandwidth option) using the 4 GHz Bandwidth personality: 6.5GHz

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/5842/5860

Related Topics

NI-RFSG Instrument Driver Programming Flow

High-Level Methods:

nirfsg.Session.ConfigureRf()

Note

For the PXIe-5645, this property is ignored if you are using the I/Q ports.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Frequency (Hz)

C Attribute: NIRFSG_ATTR_FREQUENCY

frequency_settling 

nirfsg.Session.frequency_settling

Specifies the frequency settling time. Interpretation of this value depends on the nirfsg.Session.frequency_settling_units property.

Valid Values:

The valid values for this property depend on the nirfsg.Session.frequency_settling_units property.

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/5842

Related Topics

Settling Times

Events

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Frequency Settling

C Attribute: NIRFSG_ATTR_FREQUENCY_SETTLING

frequency_settling_units 

nirfsg.Session.frequency_settling_units

Specifies the interpretation of the value passed to the nirfsg.Session.frequency_settling property.

PXIe-5650/5651/5652/5653, PXIe-5673E: When the nirfsg.Session.ACTIVE_CONFIGURATION_LIST property is set to a valid list name, the nirfsg.Session.frequency_settling_units property supports only TIME_AFTER_IO as a valid value.

PXIe-5654/5654 with PXIe-5696: The nirfsg.Session.frequency_settling_units property supports only TIME_AFTER_IO and PPM as valid values.

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/5842

Default Value: PPM

Related Topics

Events

Defined Values:

Name

Description

TIME_AFTER_LOCK

Specifies the time to wait after the frequency PLL locks.

TIME_AFTER_IO

Specifies the time to wait after all writes occur to change the frequency.

PPM

Specifies the minimum frequency accuracy when settling completes. Units are in parts per million (PPM or 1E-6).

Note

If you set this property to TIME_AFTER_IO, the definition of settled for the Configuration Settled event changes.

Note

One or more of the referenced properties are not in the Python API for this driver.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.FrequencySettlingUnits

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Frequency Settling Units

C Attribute: NIRFSG_ATTR_FREQUENCY_SETTLING_UNITS

generation_mode 

nirfsg.Session.generation_mode

Specifies whether to generate a continuous wave (CW) signal, the arbitrary waveform specified by the nirfsg.Session.arb_selected_waveform property, or the script specified by the nirfsg.Session.selected_script property, upon calling the nirfsg.Session._initiate() method.

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

Default Value: CW

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

Related Topics

Assigning Properties or Properties to a Waveform

Scripting Instructions—Refer to this topic for more information about scripting.

Defined Values:

Name

Value

Description

ARB_WAVEFORM

1001 (0x3e9)

Configures the RF signal generator to generate the arbitrary waveform specified by the nirfsg.Session.arb_selected_waveform property.

CW

1000 (0x3e8)

Configures the RF signal generator to generate a CW signal.

SCRIPT

1002 (0x3ea)

Configures the RF signal generator to generate arbitrary waveforms as directed by the nirfsg.Session.selected_script property..

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.GenerationMode

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Generation Mode

C Attribute: NIRFSG_ATTR_GENERATION_MODE

group_capabilities 

nirfsg.Session.group_capabilities

Returns a list of class-extension groups that NI-RFSG implements.

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/5842/5860

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

list of str

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Inherent IVI Attributes:Driver Capabilities:Class Group Capabilities

C Attribute: NIRFSG_ATTR_GROUP_CAPABILITIES

host_dma_buffer_size 

nirfsg.Session.host_dma_buffer_size

Specifies the size of the DMA buffer in computer memory, in bytes. To set this property, the NI-RFSG device must be in the Configuration state.

A sufficiently large host DMA buffer improves performance by allowing large writes to be transferred more efficiently.

Units: bytes

Default Value: 8MB

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

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

int

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Data Transfer:Advanced:Host DMA Buffer Size

C Attribute: NIRFSG_ATTR_HOST_DMA_BUFFER_SIZE

instrument_firmware_revision 

nirfsg.Session.instrument_firmware_revision

Returns a string that contains the firmware revision information for the NI-RFSG device you are currently using.

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/5842/5860

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Inherent IVI Attributes:Instrument Identification:Firmware Revision

C Attribute: NIRFSG_ATTR_INSTRUMENT_FIRMWARE_REVISION

instrument_manufacturer 

nirfsg.Session.instrument_manufacturer

Returns a string that contains the name of the manufacturer of the NI-RFSG device you are currently using.

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/5842/5860

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Inherent IVI Attributes:Instrument Identification:Manufacturer

C Attribute: NIRFSG_ATTR_INSTRUMENT_MANUFACTURER

instrument_model 

nirfsg.Session.instrument_model

Returns a string that contains the model number or name of the NI-RFSG device that you are currently using. For drivers that support more than one device, this property returns a comma-separated list of supported devices.

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/5842/5860

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Inherent IVI Attributes:Instrument Identification:Model

C Attribute: NIRFSG_ATTR_INSTRUMENT_MODEL

interpolation_delay 

nirfsg.Session.interpolation_delay

Specifies the delay, in seconds, to apply to the I/Q waveform. To set this property, the NI-RFSG device must be in the Configuration state.

Units: Seconds

Valid Values: Plus or minus half of one I/Q sample period

Supported Devices: PXIe-5644/5645/5646

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

hightime.timedelta, datetime.timedelta, or float in seconds

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:Signal Path:Interpolation Delay

C Attribute: NIRFSG_ATTR_INTERPOLATION_DELAY

io_resource_descriptor 

nirfsg.Session.io_resource_descriptor

Returns a string that contains the resource name NI-RFSG uses to identify the physical device. If you initialize NI-RFSG with a logical name, this property contains the resource name that corresponds to the entry in the IVI Configuration Utility. If you initialize NI-RFSG with the resource name, this property contains that value.

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/5842/5860

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Inherent IVI Attributes:Advanced Session Information:Resource Descriptor

C Attribute: NIRFSG_ATTR_IO_RESOURCE_DESCRIPTOR

iq_gain_imbalance 

nirfsg.Session.iq_gain_imbalance

Specifies the gain imbalance of the I/Q modulator (I versus Q).

Gain imbalance is calculated with the following equation:

Units: dB

Valid Values:-6dB to 6dB

Default Value: 0dB

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

Related Topics

Impairment Calibration

Spurious Performance

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: IQ Impairment:Gain Imbalance (dB)

C Attribute: NIRFSG_ATTR_IQ_GAIN_IMBALANCE

iq_impairment_enabled 

nirfsg.Session.iq_impairment_enabled

Enables or disables I/Q impairment. The nirfsg.Session.iq_i_offset, nirfsg.Session.iq_q_offset, nirfsg.Session.iq_gain_imbalance, and nirfsg.Session.iq_skew properties are ignored when the nirfsg.Session.iq_impairment_enabled property is disabled.

Default Value: True

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

Defined Values:

Value

Description

True

I/Q impairment is enabled.

False

I/Q impairment is disabled.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

bool

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: IQ Impairment:Enabled

C Attribute: NIRFSG_ATTR_IQ_IMPAIRMENT_ENABLED

iq_i_offset 

nirfsg.Session.iq_i_offset

When using a National Instruments AWG module or vector signal transceiver (VST), this property specifies the I-signal DC offset. Units are either percent (%) or volts (V), depending on the nirfsg.Session.iq_offset_units property setting.

PXIe-5673/5673E: Actual AWG signal offset is equal to the I/Q modulator offset correction plus the value specified by this property. When using an external AWG (non–National Instruments AWG), this property is read-only and indicates the I/Q modulator I-offset. Units are volts, as specified by the nirfsg.Session.iq_offset_units property.

Valid Values:-100 to 100% or -0.2V to 0.2V

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

Related Topics

Impairment Calibration

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: IQ Impairment:I Offset

C Attribute: NIRFSG_ATTR_IQ_I_OFFSET

iq_offset_units 

nirfsg.Session.iq_offset_units

Specifies the units of the nirfsg.Session.iq_i_offset property and nirfsg.Session.iq_q_offset property. Offset units are either percent or volts.

The AWG or VST offset is the specified percentage of the AWG or VST peak power level when the nirfsg.Session.iq_offset_units property is set to PERCENT. Given perfect carrier leakage suppression, the following equation is satisfied

or equivalently

If the nirfsg.Session.iq_i_offset property is set to 100%, nirfsg.Session.iq_q_offset property is set to 0%, and nirfsg.Session.power_level property set to 0 dBm, the desired RF signal is at 0 dBm and the carrier leakage is also at 0 dBm.

The AWG or VST peak power level changes when settings change in other properties such as the nirfsg.Session.power_level, nirfsg.Session.frequency, nirfsg.Session.iq_skew, nirfsg.Session.iq_gain_imbalance and nirfsg.Session.arb_pre_filter_gain properties. When the nirfsg.Session.iq_offset_units property is set to PERCENT, the actual AWG or VST offset changes as the AWG or VST peak power level changes to satisfy the preceding equations. These changes are useful if you are intentionally adding carrier leakage to test the tolerance of a receiver. When the nirfsg.Session.iq_offset_units property is set to PERCENT, the carrier leakage, in dBc, remains at a consistent level.

If you are trying to eliminate residual carrier leakage due to calibration inaccuracies or drift, set the nirfsg.Session.iq_offset_units property to VOLTS. Offset correction voltage is applied to the I/Q modulator or VST, regardless of changes to the AWG or VST peak power level.

Default Value: PERCENT

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

Defined Values:

Name

Description

PERCENT

Specifies the nirfsg.Session.iq_i_offset and nirfsg.Session.iq_q_offset property units as percent.

VOLTS

Specifies the nirfsg.Session.iq_i_offset and nirfsg.Session.iq_q_offset property units as volts.

Note

For any devices except PXIe-5820, if the nirfsg.Session.iq_offset_units property is set to VOLTS, a 0.1 I offset results in a 0.1 V offset in the output. For PXIe-5820 devices, 0.1 I offset results in a 10% offset in the output.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.OffsetUnits

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: IQ Impairment:Offset Units

C Attribute: NIRFSG_ATTR_IQ_OFFSET_UNITS

iq_out_port_carrier_frequency 

nirfsg.Session.iq_out_port_carrier_frequency

Specifies the frequency of the I/Q OUT port signal. The onboard signal processing (OSP) applies the specified frequency shift to the I/Q data before the data is sent to the digital-to-analog converter (DAC). To set this property, the NI-RFSG device must be in the Configuration state.

Units: hertz (Hz)

Valid Values:

PXIe-5645: -60MHz to 60MHz

PXIe-5820: -500MHz to 500MHz

Supported Devices: PXIe-5645, PXIe-5820

Note

For the PXIe-5820, NI recommends using the nirfsg.Session.frequency property.

For the PXIe-5645, this property is ignored if you are using the RF ports.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:IQ Out Port:Carrier Frequency

C Attribute: NIRFSG_ATTR_IQ_OUT_PORT_CARRIER_FREQUENCY

iq_out_port_common_mode_offset 

nirfsg.Session.iq_out_port_common_mode_offset

Specifies the common-mode offset applied to the signals generated at each differential output terminal. This property applies only when you set the nirfsg.Session.iq_out_port_terminal_configuration property to DIFFERENTIAL. Common-mode offset shifts both positive and negative terminals in the same direction.

To use this property, you must use the channelName parameter of the nirfsg.Session._set_attribute_vi_real64() method to specify the name of the channel you are configuring. For the PXIe-5645, you can configure the I and Q channels by using I or Q as the channel string, or set the channel string to “” (empty string) to configure both channels. For the PXIe-5820, the only valid value for the channel string is “” (empty string).

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

Units: Volts

Valid Values:

PXIe-5645: -0.8V to 0.8V if you set the nirfsg.Session.iq_out_port_load_impedance property to 50 Ω. The valid values are -1.2V to 1.2V if you set the nirfsg.Session.iq_out_port_load_impedance property to 100 Ω.

PXIe-5820: -0.25V to 1.5V

Supported Devices: PXIe-5645, PXIe-5820

Note

For the PXIe-5645, this property is ignored if you are using the RF ports.

The valid range is dependent on the load impedance.

Tip

This property can be set/get on specific channels within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container channels to specify a subset.

Example: my_session.channels[ ... ].iq_out_port_common_mode_offset

To set/get on all channels, you can call the property directly on the nirfsg.Session.

Example: my_session.iq_out_port_common_mode_offset

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

channels

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:IQ Out Port:Common Mode Offset

C Attribute: NIRFSG_ATTR_IQ_OUT_PORT_COMMON_MODE_OFFSET

iq_out_port_level 

nirfsg.Session.iq_out_port_level

Specifies the amplitude of the generated signal in volts, peak-to-peak (V). For example, if you set this property to 1.0, the output signal ranges from -0.5 volts to 0.5 volts.

To use this property, you must use the channelName parameter of the nirfsg.Session._set_attribute_vi_real64() method to specify the name of the channel you are configuring. For the PXIe-5645, you can configure the I and Q channels by using I or Q as the channel string, or set the channel string to “” (empty string) to configure both channels. For the PXIe-5820, the only valid value for the channel string is “” (empty string).

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

Refer to the specifications document for your device for allowable output levels.

Units: Volts, peak-to-peak (V _pk-pk )

Valid Values:

PXIe-5645: 1V _pk-pk maximum if you set the nirfsg.Session.iq_out_port_terminal_configuration property to DIFFERENTIAL, and 0.5V _pk-pk

maximum if you set the nirfsg.Session.iq_out_port_terminal_configuration property to SINGLE_ENDED.

PXIe-5820: 3.4V _pk-pk maximum for signal bandwidth less than 160MHz, and 2V _pk-pk

maximum for signal bandwidth greater than 160MHz.

Default Value: 0.5volts

Supported Devices: PXIe-5645, PXIe-5820

Note

For the PXIe-5645, this property is ignored if you are using the RF ports.

The valid values are only applicable when you set the nirfsg.Session.iq_out_port_load_impedance property to 50 Ω and when you set the nirfsg.Session.iq_out_port_offset property to 0.

Tip

This property can be set/get on specific channels within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container channels to specify a subset.

Example: my_session.channels[ ... ].iq_out_port_level

To set/get on all channels, you can call the property directly on the nirfsg.Session.

Example: my_session.iq_out_port_level

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

channels

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:IQ Out Port:Level

C Attribute: NIRFSG_ATTR_IQ_OUT_PORT_LEVEL

iq_out_port_load_impedance 

nirfsg.Session.iq_out_port_load_impedance

Specifies the load impedance connected to the I/Q OUT port. To set this property, the NI-RFSG device must be in the Configuration state.

To use this property, you must use the channelName parameter of the nirfsg.Session._set_attribute_vi_real64() method to specify the name of the channel you are configuring. For the PXIe-5645, you can configure the I and Q channels by using I or Q as the channel string, or set the channel string to “” (empty string) to configure both channels. For the PXIe-5820, the only valid value for the channel string is “” (empty string).

Units: Ohms

Valid Values: Any value greater than 0. Values greater than or equal to 1 megaohms (MΩ) are interpreted as high impedance.

Default Value: 50 Ω if you set the nirfsg.Session.iq_out_port_terminal_configuration property to SINGLE_ENDED, and 100 Ω if you set the nirfsg.Session.iq_out_port_terminal_configuration property to DIFFERENTIAL.

Supported Devices: PXIe-5645, PXIe-5820

Note

For the PXIe-5645, this property is ignored if you are using the RF ports.

Tip

This property can be set/get on specific channels within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container channels to specify a subset.

Example: my_session.channels[ ... ].iq_out_port_load_impedance

To set/get on all channels, you can call the property directly on the nirfsg.Session.

Example: my_session.iq_out_port_load_impedance

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

channels

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:IQ Out Port:Load Impedance

C Attribute: NIRFSG_ATTR_IQ_OUT_PORT_LOAD_IMPEDANCE

iq_out_port_offset 

nirfsg.Session.iq_out_port_offset

Specifies the value, in volts, that the signal generator adds to the arbitrary waveform data. To set this property, the NI-RFSG device must be in the Configuration state.

To use this property, you must use the channelName parameter of the nirfsg.Session._set_attribute_vi_real64() method to specify the name of the channel you are configuring. For the PXIe-5645, you can configure the I and Q channels by using I or Q as the channel string, or set the channel string to “” (empty string) to configure both channels. For the PXIe-5820, the only valid value for the channel string is “” (empty string).

PXIe-5645: The waveform may be scaled in DSP prior to adding offset and the device state may be changed in order to accommodate the requested offset.

PXIe-5820: The waveform is not automatically scaled in DSP. To prevent DSP overflows, use the nirfsg.Session.arb_pre_filter_gain property to scale the waveform to provide additional headroom for offsets.

Units: Volts

Supported Devices: PXIe-5645, PXIe-5820

Note

For the PXIe-5645, this property is ignored if you are using the RF ports.

Tip

This property can be set/get on specific channels within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container channels to specify a subset.

Example: my_session.channels[ ... ].iq_out_port_offset

To set/get on all channels, you can call the property directly on the nirfsg.Session.

Example: my_session.iq_out_port_offset

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

channels

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:IQ Out Port:Offset

C Attribute: NIRFSG_ATTR_IQ_OUT_PORT_OFFSET

iq_out_port_temperature 

nirfsg.Session.iq_out_port_temperature

Returns the temperature, in degrees Celsius, of the I/Q Out circuitry on the device.

Units: Degrees Celsius

Supported Devices: PXIe-5645, PXIe-5820

Note

If you query this property during RF list mode, list steps may take longer to complete during list execution.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:IQ Out Port:Temperature (Degrees C)

C Attribute: NIRFSG_ATTR_IQ_OUT_PORT_TEMPERATURE

iq_out_port_terminal_configuration 

nirfsg.Session.iq_out_port_terminal_configuration

Specifies whether to use the I/Q OUT port for differential configuration or single-ended configuration. If you set this property to SINGLE_ENDED, you must terminate the negative I and Q output connectors with a 50 Ohm termination.

If you set this property to SINGLE_ENDED, the positive I and Q connectors generate the resulting waveform. If you set this property to DIFFERENTIAL, both the positive and negative I and Q connectors generate the resulting waveform.

To use this property, you must use the channelName parameter of the nirfsg.Session._set_attribute_vi_int32() method to specify the name of the channel you are configuring. For the PXIe-5645, you can configure the I and Q channels by using I or Q as the channel string, or set the channel string to “” (empty string) to configure both channels. For the PXIe-5820, the only valid value for the channel string is “” (empty string).

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

Default Value: DIFFERENTIAL

PXIe-5820: The only valid value for this property is DIFFERENTIAL.

Supported Devices: PXIe-5645, PXIe-5820

Related Topics

Differential and Single-Ended Operation (I/O Interface)

Defined Values:

Name

Value

Description

DIFFERENTIAL

15000 (0x3a98)

Sets the terminal configuration to differential.

SINGLE_ENDED

15001 (0x3a99)

Sets the terminal configuration to single-ended.

Note

For the PXIe-5645, this property is ignored if you are using the RF ports.

Tip

This property can be set/get on specific channels within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container channels to specify a subset.

Example: my_session.channels[ ... ].iq_out_port_terminal_configuration

To set/get on all channels, you can call the property directly on the nirfsg.Session.

Example: my_session.iq_out_port_terminal_configuration

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.IQOutPortTerminalConfiguration

Permissions

read-write

Repeated Capabilities

channels

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:IQ Out Port:Terminal Configuration

C Attribute: NIRFSG_ATTR_IQ_OUT_PORT_TERMINAL_CONFIGURATION

iq_q_offset 

nirfsg.Session.iq_q_offset

When using a National Instruments AWG module or VST device, this property specifies the Q-signal DC offset. Units are either percent (%) or volts (V), depending on the nirfsg.Session.iq_offset_units property setting. PXIe-5673/5673E: Actual AWG signal offset is equal to the I/Q modulator offset correction plus the value specified by this property. When using an external AWG (non–National Instruments AWG), the nirfsg.Session.iq_q_offset property is read-only and indicates the I/Q modulator Q-offset. Units are volts, as indicated by the nirfsg.Session.iq_offset_units property. Valid Values: -100% to 100% or -0.2V to 0.2V Supported Devices: PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 Related Topics Impairment Calibration

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: IQ Impairment:Q Offset

C Attribute: NIRFSG_ATTR_IQ_Q_OFFSET

iq_rate 

nirfsg.Session.iq_rate

This property specifies the I/Q rate of the arbitrary waveform. The I/Q rate is coerced to a value the hardware can achieve. Read this value back after setting it to see the actual I/Q rate. NI-RFSG internally uses an FIR filter with flat response up to (0.4 × IQ rate). Given a desired signal with the maximum frequency content f, sample the signal at an I/Q rate greater than or equal to ( f/0.4).

This property applies only when the nirfsg.Session.generation_mode property is set to ARB_WAVEFORM or SCRIPT.

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

Setting this property to 50 MS/s on the PXI-5670/5671 and PXIe-5672 has the following implications: - NI-RFSG is forced to place the carrier frequency at 18 MHz ± 1 MHz to avoid aliasing. This means that NI-RFSG cannot select a carrier frequency that could optimize waveform size if phase continuity is enabled. - Output signal bandwidth must be <5 MHz to avoid aliasing. - Close-in phase noise is higher.

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

Related Topics

Streaming

Assigning Properties or Properties to a Waveform—Refer to this topic for more information about using this property to associate an I/Q rate with a waveform.

Digital Upconverter

Valid Values:

Device

I/Q Rates

PXIe-5644/5645

Up to 120 MS/s.

PXIe-5646

Up to 250 MS/s.

PXI-5670

50 MS/s ((100 MS/s)/n, where n is divisible by 2 between 12 to 512, and divisible by 4 between 512 to 1,024 (n = 12, 14, 16, …, 512, 516, 520, …, 1,024). Setting the I/Q rate to one of these value enables the DUC.)

100 MS/s ((100 MS/s)/n, where n is divisible by 2 between 12 to 512, and divisible by 4 between 512 to 1,024 (n = 12, 14, 16, …, 512, 516, 520, …, 1,024). Setting the I/Q rate to one of these value enables the DUC.)

PXI-5671

50 MS/s ((100 MS/s)/n, where n is divisible by 2 between 12 to 512, and divisible by 4 between 512 to 1,024 (n = 12, 14, 16, …, 512, 516, 520, …, 1,024). Setting the I/Q rate to one of these value enables the DUC.)

100 MS/s

PXIe-5672

Up to 100 MS/s.

PXIe-5673/5673E

Up to 200 MS/s. Note that - If an PXIe-5450 with module revisions A or B is used as part of your PXIe-5673/5673E, the NI-FGEN NIFGEN_ATTR_COMPENSATE_FOR_FILTER_GROUP_DELAY property is disabled if the requested I/Q rate is less than 1.5 MS/s.

PXIe-5820/5830/5831/5832/5840/5841/5860

Up to 1.25 GS/s.

PXI-5842 (500 MHz, 1 GHz, and 2 GHz bandwidth options)

Up to 2.5 GS/s

PXIe-5842 (4 GHz bandwidth option) using the Standard personality

Up to 2.5 GS/s

PXIe-5842 (4 GHz bandwidth option) using the 4 GHz Bandwidth personality

5 GS/s only.

Note

Use this property to associate an I/Q rate with a waveform.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Acquisition:IQ

C Attribute: NIRFSG_ATTR_IQ_RATE

iq_skew 

nirfsg.Session.iq_skew

Specifies the adjustment of the phase angle between the I and Q vectors. If the skew is zero, the phase angle is 90 degrees.

This property is ignored when the nirfsg.Session.iq_impairment_enabled property is disabled.

Units: degrees (°)

Valid Values:-30° to 30°

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

Related Topics

Impairment Calibration

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: IQ Impairment:IQ Skew (Degrees)

C Attribute: NIRFSG_ATTR_IQ_SKEW

iq_swap_enabled 

nirfsg.Session.iq_swap_enabled

Enables or disables the inverse phase rotation of the I/Q signal by swapping the I and Q inputs.

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

Default Value: False

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

Defined Values:

Value

Description

True

NI-RFSG device applies noninverse phase rotation of the I/Q signal.

False

NI-RFSG device applies inverse phase rotation of the I/Q signal.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

bool

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

C Attribute: NIRFSG_ATTR_IQ_SWAP_ENABLED

load_configurations_from_file_load_options 

nirfsg.Session.load_configurations_from_file_load_options

Specifies the configurations to skip while loading from a file.

Default Value: NIRFSG_VAL_SKIP_NONE

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

Defined Values:

Value

Description

RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_LOAD_OPTIONS_SKIP_NONE

NI-RFSG loads all the configurations to the session.

RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_LOAD_OPTIONS_SKIP_WAVEFORMS

NI-RFSG skips loading the waveform configurations to the session.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.LoadOptions

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Load Configurations:Load Options

C Attribute: NIRFSG_ATTR_LOAD_CONFIGURATIONS_FROM_FILE_LOAD_OPTIONS

load_configurations_from_file_reset_options 

nirfsg.Session.load_configurations_from_file_reset_options

Specifies the configurations to skip to reset while loading configurations from a file.

Default Value: NIRFSG_VAL_SKIP_NONE Supported Devices: PXIe-5820/5830/5831/5832/5840/5841/5842/5860

Defined Values:

Value

Description

RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_NONE

NI-RFSG resets all configurations.

RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_WAVEFORMS

NI-RFSG skips resetting the waveform configurations.

RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_SCRIPTS

NI-RFSG skips resetting the scripts.

RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_DEEMBEDDING_TABLES

NI-RFSG skips resetting the de-embedding tables.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.LoadConfigurationResetOptions

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Load Configurations:Reset Options

C Attribute: NIRFSG_ATTR_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS

logical_name 

nirfsg.Session.logical_name

Returns a string that contains the logical name you specified when opening the current IVI session. You can pass a logical name to the nirfsg.Session.Init() method or the nirfsg.Session.__init__() method. The IVI Configuration Utility must contain an entry for the logical name. The logical name entry refers to a driver session section in the IVI Configuration file. The driver session section specifies a physical device and initial user options.

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/5842/5860

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Inherent IVI Attributes:Advanced Session Information:Logical Name

C Attribute: NIRFSG_ATTR_LOGICAL_NAME

loop_bandwidth 

nirfsg.Session.loop_bandwidth

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

To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg.Session._set_attribute_vi_int32() method 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 Value:

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

PXI/PXIe-5650/5651/5652, PXIe-5673/5673E: 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/5842

Related Topics

Phase-Locked Loop Bandwidth

Modulation Implementation

Sinusoidal Tone Versus Modulation Operation

Defined Values:

Name

Value

Description

MEDIUM

1 (0x1)

Uses the medium loop bandwidth setting for the PLL.

NARROW

0 (0x0)

Uses the narrowest loop bandwidth setting for the PLL.

WIDE

2 (0x2)

Uses the widest loop bandwidth setting for the PLL.

Note

Setting this property to 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 property to MEDIUM is not a valid option on the PXI/PXIe-5650/5651/5652 or PXIe-5673/5673E. MEDIUM is the only supported value for the PXIe-5840/5841/5842.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

Tip

This property can be set/get on specific los within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container los to specify a subset.

Example: my_session.los[ ... ].loop_bandwidth

To set/get on all los, you can call the property directly on the nirfsg.Session.

Example: my_session.loop_bandwidth

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.LoopBandwidth

Permissions

read-write

Repeated Capabilities

los

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Loop Bandwidth

C Attribute: NIRFSG_ATTR_LOOP_BANDWIDTH

lo_frequency 

nirfsg.Session.lo_frequency

Specifies the frequency of the LO source.

To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg.Session._set_attribute_vi_real64() method 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/5842

Related Topics

PXIe-5830 Frequency and Bandwidth Configuration

PXIe-5831/5832 Frequency and Bandwidth Configuration

Note

This property is read/write if you are using an external LO. Otherwise, this property is read-only.

Tip

This property can be set/get on specific los within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container los to specify a subset.

Example: my_session.los[ ... ].lo_frequency

To set/get on all los, you can call the property directly on the nirfsg.Session.

Example: my_session.lo_frequency

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

los

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:LO Frequency (Hz)

C Attribute: NIRFSG_ATTR_LO_FREQUENCY

lo_frequency_step_size 

nirfsg.Session.lo_frequency_step_size

Specifies the step size for tuning the local oscillator (LO) phase-locked loop (PLL).

When the nirfsg.Session.lo_pll_fractional_mode_enabled property is enabled, the specified step size affects the fractional spur performance of the device. When the nirfsg.Session.lo_pll_fractional_mode_enabled property is disabled, the specified step size affects the phase noise performance of the device.

The valid values for this property depend on the nirfsg.Session.lo_pll_fractional_mode_enabled property.

PXIe-5644/5645/5646—If you disable the nirfsg.Session.lo_pll_fractional_mode_enabled property, the specified value is coerced to the nearest valid value.

PXIe-5840/5841—If you disable the nirfsg.Session.lo_pll_fractional_mode_enabled property, the specified value is coerced to the nearest valid value that is less than or equal to the desired step size.

Units: hertz (Hz)

Default Values:

PXIe-5644/5645/5646: 200kHz

PXIe-5830: 2MHz

PXIe-5831/5832 (RF port): 8MHz

PXIe-5831/5832 (IF port): 2MHz, 4MHz

PXIe-5840/5841:

Fractional mode: 500 kHz

Integer mode: 10 MHz for frequencies less than or equal to 4 GHz. 20 MHz for frequencies greater than 4 GHz.

PXIe-5841 with PXIe-5655: 500kHz

PXIe-5842: 1Hz

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

nirfsg.Session.lo_pll_fractional_mode_enabled Property Setting

NIRFSG_VAL_ENABLE

NIRFSG_VAL_DISABLE

nirfsg.Session.lo_frequency_step_size Property Valid Values on PXIe-5644/5645

50 kHz to 24 MHz

4 MHz, 5 MHz, 6 MHz, 12 MHz, or 24 MHz

nirfsg.Session.lo_frequency_step_size Property Valid Values on PXIe-5646

50 kHz to 25 MHz

2 MHz, 5 MHz, 10 MHz, or 25 MHz

nirfsg.Session.lo_frequency_step_size Property Valid Values on PXIe-5840/5841

50 kHz to 100 MHz

1 MHz, 5 MHz, 10 MHz, 25 MHz, 50 MHz, or 100 MHz

nirfsg.Session.lo_frequency_step_size Property Valid Values on PXIe-5830/5831/ 5832 LO1

8 Hz to 400 MHz

—

nirfsg.Session.lo_frequency_step_size Property Valid Values on PXIe-5830/5831/ 5832 LO2

4 Hz to 400 MHz

—

nirfsg.Session.lo_frequency_step_size Property Valid Values on PXIe-5841 with PXIe-5655/NI PXIe-5842 (See note)

1 nHz to 100 MHz

1 nHz to 50 MHz

Note

Values up to 100 MHz are coerced to 50 MHz.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:Signal Path:LO Frequency Step Size (Hz)

C Attribute: NIRFSG_ATTR_LO_FREQUENCY_STEP_SIZE

lo_in_power 

nirfsg.Session.lo_in_power

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

To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg.Session._set_attribute_vi_real64() method 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/5842

Related Topics

LO OUT

Note

This property is read/write if you are using an external LO. Otherwise, this property is read-only.

For the PXIe-5644/5645/5646, this property is always read-only.

Tip

This property can be set/get on specific los within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container los to specify a subset.

Example: my_session.los[ ... ].lo_in_power

To set/get on all los, you can call the property directly on the nirfsg.Session.

Example: my_session.lo_in_power

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

los

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:LO In Power (dBm)

C Attribute: NIRFSG_ATTR_LO_IN_POWER

lo_out_enabled 

nirfsg.Session.lo_out_enabled

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 property is set to False, even if the nirfsg.Session.output_enabled property is set to False, the nirfsg.Session.abort() method is called, or the NI-RFSG session is closed.

To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg.Session._set_attribute_vi_boolean() method 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 Value: NIRFSG_VAL_DISABLE

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

Related Topics

LO OUT

Defined Values:

Name

Description

NIRFSG_VAL_ENABLE

The local oscillator signal is present at the LO OUT front panel connector.

NIRFSG_VAL_DISABLE

The local oscillator signal is not present at the LO OUT front panel connector.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

Tip

This property can be set/get on specific los within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container los to specify a subset.

Example: my_session.los[ ... ].lo_out_enabled

To set/get on all los, you can call the property directly on the nirfsg.Session.

Example: my_session.lo_out_enabled

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

bool

Permissions

read-write

Repeated Capabilities

los

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:LO Out Enabled

C Attribute: NIRFSG_ATTR_LO_OUT_ENABLED

lo_out_export_configure_from_rfsa 

nirfsg.Session.lo_out_export_configure_from_rfsa

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

Set this property to ENABLE to allow NI-RFSA to control the LO out export. Use the RF OUT LO EXPORT ENABLED property to control the LO out export from NI-RFSA.

Default Value: DISABLE

Supported Devices: PXIe-5840/5841/5842

Defined Values:

Name

Value

Description

ENABLE

0 (0x0)

Do not allow NI-RFSA to control the NI-RFSG local oscillator export.

DISABLE

1 (0x1)

Allow NI-RFSA to control the NI-RFSG local oscillator export.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.LoOutExportConfigureFromRfsaEnable

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:LO Out Export Configure From RFSA

C Attribute: NIRFSG_ATTR_LO_OUT_EXPORT_CONFIGURE_FROM_RFSA

lo_out_power 

nirfsg.Session.lo_out_power

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

To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg.Session._set_attribute_vi_real64() method 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/5842

Related Topics

LO OUT

Note

For the PXIe-5644/5645/5646 and PXIe-5673/5673E, this property is always read-only.

Tip

This property can be set/get on specific los within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container los to specify a subset.

Example: my_session.los[ ... ].lo_out_power

To set/get on all los, you can call the property directly on the nirfsg.Session.

Example: my_session.lo_out_power

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

los

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:LO Out Power (dBm)

C Attribute: NIRFSG_ATTR_LO_OUT_POWER

lo_pll_fractional_mode_enabled 

nirfsg.Session.lo_pll_fractional_mode_enabled

Specifies whether to use fractional mode for the local oscillator (LO) phase-locked loop (PLL). This property enables or disables fractional frequency tuning in the LO. Fractional mode provides a finer frequency step resolution and allows smaller values for the nirfsg.Session.lo_frequency_step_size property. However, fractional mode may introduce non-harmonic spurs.

This property applies only if you set the nirfsg.Session.lo_source property to Onboard.

To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg.Session._set_attribute_vi_int32() method 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 “” .

Default Value: ENABLE

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

Related Topics

Refer to the local oscillators topic appropriate to your device for more information about using fractional mode.

Defined Values:

Name

Value

Description

ENABLE

0 (0x0)

Disables fractional mode for the LO PLL.

DISABLE

1 (0x1)

Enables fractional mode for the LO PLL.

Note

For the PXIe-5841 with PXIe-5655, this property is ignored if the PXIe-5655 is used as the LO source.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

Tip

This property can be set/get on specific los within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container los to specify a subset.

Example: my_session.los[ ... ].lo_pll_fractional_mode_enabled

To set/get on all los, you can call the property directly on the nirfsg.Session.

Example: my_session.lo_pll_fractional_mode_enabled

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.LoPllFractionalModeEnabled

Permissions

read-write

Repeated Capabilities

los

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:Signal Path:LO PLL Fractional Mode Enabled

C Attribute: NIRFSG_ATTR_LO_PLL_FRACTIONAL_MODE_ENABLED

lo_source 

nirfsg.Session.lo_source

Specifies whether to use the internal or external local oscillator (LO) source. If the nirfsg.Session.lo_source property is set to “” (empty string), NI-RFSG uses the internal LO source. To set this property, the NI-RFSG device must be in the Configuration state.

To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg.Session._set_attribute_vi_string() method 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 Value: Onboard

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

Related Topics

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

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

Possible Values:

Possible Value

Description

“Automatic_SG_SA_Shared”

NI-RFSG internally makes the configuration to share the LO between NI-RFSA and NI-RFSG. This value is valid only on the PXIe-5820/5830/5831/5832/5840/5841/5842.

“LO_In”

Uses an external LO as the LO source. Connect a signal to the LO IN connector on the device and use the nirfsg.Session.upconverter_center_frequency property to specify the LO frequency.

“Onboard”

Uses an internal LO as the LO source. If you specify an internal LO source, the LO is generated inside the device itself.

“SG_SA_Shared”

Uses the same internal LO during NI-RFSA and NI-RFSG sessions. NI-RFSG selects an internal synthesizer and the synthesizer signal is switched to both the RF In and RF Out mixers. This value is valid only on the PXIe-5830/5831/5832/5841 with PXIe-5655/5842.

“Secondary”

Uses the PXIe-5831/5840 internal LO as the LO source. This value is valid only on the PXIe-5831 with PXIe-5653 and PXIe-5832 with PXIe-5653.

Note

For the PXIe-5841 with PXIe-5655, RF list mode is not supported when this property is set to SG_SA_Shared.

Tip

This property can be set/get on specific los within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container los to specify a subset.

Example: my_session.los[ ... ].lo_source

To set/get on all los, you can call the property directly on the nirfsg.Session.

Example: my_session.lo_source

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.LoSource

Permissions

read-write

Repeated Capabilities

los

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:Signal Path:LO Source

C Attribute: NIRFSG_ATTR_LO_SOURCE

lo_temperature 

nirfsg.Session.lo_temperature

Returns the LO module temperature in degrees Celsius.

PXIe-5840/5841: If you query this property during RF list mode, list steps may take longer to complete during list execution.

Units: degrees Celsius (°C)

Supported Devices: PXIe-5673/5673E, PXIe-5840/5841/5842

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Characteristics:LO Temperature (Degrees C)

C Attribute: NIRFSG_ATTR_LO_TEMPERATURE

lo_vco_frequency_step_size 

nirfsg.Session.lo_vco_frequency_step_size

Specifies the step size for tuning the internal voltage-controlled oscillator (VCO) used to generate the LO signal.

Valid Values:

LO1: 1 Hz to 50 MHz

LO2: 1 Hz to 100 MHz

Default Value: 1 MHz

Supported Devices: PXIe-5830/5831/5832

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:Signal Path:LO VCO Frequency Step Size (Hz)

C Attribute: NIRFSG_ATTR_LO_VCO_FREQUENCY_STEP_SIZE

marker_event_output_behavior 

nirfsg.Session.marker_event_output_behavior

Specifies the output behavior for the Marker Event. To set this property, the NI-RFSG device must be in the Configuration state.

Default Value: PULSE

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

Related Topics

Marker Events

Defined Values:

Name

Value

Description

PULSE

23000 (0x59d8)

Specifies the Marker Event output behavior as pulse.

TOGGLE

23001 (0x59d9)

Specifies the Marker Event output behavior as toggle.

Tip

This property can be set/get on specific markers within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container markers to specify a subset.

Example: my_session.markers[ ... ].marker_event_output_behavior

To set/get on all markers, you can call the property directly on the nirfsg.Session.

Example: my_session.marker_event_output_behavior

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.MarkerEventOutputBehavior

Permissions

read-write

Repeated Capabilities

markers

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Events:Marker:Output Behavior

C Attribute: NIRFSG_ATTR_MARKER_EVENT_OUTPUT_BEHAVIOR

marker_event_pulse_width 

nirfsg.Session.marker_event_pulse_width

Specifies the pulse width value for the Marker Event. Use the nirfsg.Session.marker_event_pulse_width_units property to set the units for the pulse width value. This property is valid only when the nirfsg.Session.marker_event_output_behavior property is set to PULSE.

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

Default Value: 200 ns

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

Related Topics

Marker Events

Tip

This property can be set/get on specific markers within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container markers to specify a subset.

Example: my_session.markers[ ... ].marker_event_pulse_width

To set/get on all markers, you can call the property directly on the nirfsg.Session.

Example: my_session.marker_event_pulse_width

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

markers

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Events:Marker:Pulse:Width Value

C Attribute: NIRFSG_ATTR_MARKER_EVENT_PULSE_WIDTH

marker_event_pulse_width_units 

nirfsg.Session.marker_event_pulse_width_units

Specifies the pulse width units for the Marker Event. This property is valid only when the nirfsg.Session.marker_event_output_behavior property is set to PULSE.

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

Default Value: SECONDS

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

Related Topics

Marker Events

Defined Values:

Name

Value

Description

PULSE

23000 (0x59d8)

Specifies the Marker Event output behavior as pulse.

TOGGLE

23001 (0x59d9)

Specifies the Marker Event output behavior as toggle.

Tip

This property can be set/get on specific markers within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container markers to specify a subset.

Example: my_session.markers[ ... ].marker_event_pulse_width_units

To set/get on all markers, you can call the property directly on the nirfsg.Session.

Example: my_session.marker_event_pulse_width_units

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.MarkerEventPulseWidthUnits

Permissions

read-write

Repeated Capabilities

markers

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Events:Marker:Pulse:Width Units

C Attribute: NIRFSG_ATTR_MARKER_EVENT_PULSE_WIDTH_UNITS

marker_event_terminal_name 

nirfsg.Session.marker_event_terminal_name

Returns the name of the fully qualified signal name as a string.

Default Values:

PXI-5670/5671, PXIe-5672/5673/5673E: /AWGName/Marker X Event, where AWGName is the name of your associated AWG module in MAX and X is Marker Event 0 through 3.

PXIe-5830/5831/5832: /BasebandModule/ao/0/Marker X Event, where BasebandModule is the name of the baseband module of your device in MAX and X is Marker Event 0 through 3.

PXIe-5820/5840/5841: /ModuleName/ao/0/Marker X Event, where ModuleName is the name of your device in MAX and X is Marker Event 0 through 3.

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

Related Topics

Events

Syntax for Terminal Names

High-Level Methods:

nirfsg.Session.get_terminal_name()

Tip

This property can be set/get on specific markers within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container markers to specify a subset.

Example: my_session.markers[ ... ].marker_event_terminal_name

To set/get on all markers, you can call the property directly on the nirfsg.Session.

Example: my_session.marker_event_terminal_name

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read only

Repeated Capabilities

markers

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Events:Marker:Terminal Name

C Attribute: NIRFSG_ATTR_MARKER_EVENT_TERMINAL_NAME

marker_event_toggle_initial_state 

nirfsg.Session.marker_event_toggle_initial_state

Specifies the initial state for the Marker Event when the nirfsg.Session.marker_event_output_behavior property is set to TOGGLE.

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

Default Value: LOW

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

Related Topics

Marker Events

Defined Values:

Name

Value

Description

HIGH

21001 (0x5209)

Specifies the initial state of the Marker Event toggle behavior as digital high.

LOW

21000 (0x5208)

Specifies the initial state of the Marker Event toggle behavior as digital low.

Tip

This property can be set/get on specific markers within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container markers to specify a subset.

Example: my_session.markers[ ... ].marker_event_toggle_initial_state

To set/get on all markers, you can call the property directly on the nirfsg.Session.

Example: my_session.marker_event_toggle_initial_state

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.MarkerEventToggleInitialState

Permissions

read-write

Repeated Capabilities

markers

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Events:Marker:Toggle:Initial State

C Attribute: NIRFSG_ATTR_MARKER_EVENT_TOGGLE_INITIAL_STATE

memory_size 

nirfsg.Session.memory_size

The total amount of memory on the signal generator in bytes.

Units: bytes

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

Related Topics

Memory Options

Phase Continuity

Note

Not all onboard memory is available for waveform storage. A portion of onboard memory stores scripts that specify how the waveforms are generated. These scripts typically require less than 1KB of onboard memory.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

int

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Memory Size

C Attribute: NIRFSG_ATTR_MEMORY_SIZE

module_power_consumption 

nirfsg.Session.module_power_consumption

Returns the total power consumption of the device.

Units: watts

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

Note

If you query this property during RF list mode, list steps may take longer to complete during list execution.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Characteristics:Module Power Consumption (W)

C Attribute: NIRFSG_ATTR_MODULE_POWER_CONSUMPTION

module_revision 

nirfsg.Session.module_revision

Returns the module revision letter. If the NI-RFSG session is controlling multiple modules, this property returns the revision letter of the primary RF module. The NI-RFSG session is opened using the primary RF device name.

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

Related Topics

Identifying Module Revision

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Characteristics:Module Revision

C Attribute: NIRFSG_ATTR_MODULE_REVISION

output_enabled 

nirfsg.Session.output_enabled

Specifies whether signal output is enabled. Setting the nirfsg.Session.output_enabled property to 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.Session.output_enabled property while in the Committed state does not transition the device to the Configuration state, but output changes immediately.

Default Value: 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/5842/5860

Related Topics

Output Enabled

NI-RFSG Instrument Driver Programming Flow

Defined Values:

Value

Description

True

Enables signal output.

False

Disables signal output.

Note

For the PXIe-5653, this property controls only the LO1 terminal.

For the PXIe-5645, this property is ignored if you are using the I/Q ports.

When the nirfsg.Session.ACTIVE_CONFIGURATION_LIST property is set to a valid list name, setting the nirfsg.Session.output_enabled property transitions the device to the Configuration state.

Note

One or more of the referenced properties are not in the Python API for this driver.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

bool

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Output Enabled

C Attribute: NIRFSG_ATTR_OUTPUT_ENABLED

output_port 

nirfsg.Session.output_port

Specifies the connector(s) to use to generate the signal. To set this property, the NI-RFSG device must be in the Configuration state.

You must write complex I and Q data for all options. The Q data has no effect if you set this property to I Only and set the nirfsg.Session.iq_out_port_carrier_frequency property to 0. If you set the nirfsg.Session.iq_out_port_carrier_frequency property to a value other than 0, the onboard signal processing (OSP) frequency shifts I and Q as a complex value and outputs the real portion of the result on the I connector(s) of the device.

If you set the nirfsg.Session.output_port property to I_ONLY or IQ_OUT, the nirfsg.Session.iq_out_port_terminal_configuration property applies.

Default Value:

PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842/5860: RF_OUT

PXIe-5820: IQ_OUT

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

Defined Values:

Name

Value

Description

CAL_OUT

14002 (0x36b2)

Enables the CAL OUT port.

I_ONLY

14003 (0x36b3)

Enables the I connectors of the I/Q OUT port. This value is valid on only the PXIe-5645.

IQ_OUT

14001 (0x36b1)

Enables the I/Q OUT port. This value is valid on only the PXIe-5645 and PXIe-5820.

RF_OUT

14000 (0x36b0)

Enables the RF OUT port. This value is not valid for the PXIe-5820.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.OutputPort

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:Signal Path:Output Port

C Attribute: NIRFSG_ATTR_OUTPUT_PORT

overflow_error_reporting 

nirfsg.Session.overflow_error_reporting

Configures error reporting for onboard signal processing (OSP) overflows. Overflows lead to clipping of the waveform.

Default Value: WARNING

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

Defined Values:

Name

Value

Description

DISABLED

1302 (0x516)

NI-RFSG does not return an error or a warning when an OSP overflow occurs.

WARNING

1301 (0x515)

NI-RFSG returns a warning when an OSP overflow occurs.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.OverflowErrorReporting

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Advanced:Overflow Error Reporting

C Attribute: NIRFSG_ATTR_OVERFLOW_ERROR_REPORTING

peak_envelope_power 

nirfsg.Session.peak_envelope_power

Returns the maximum instantaneous power of the RF output signal.

Units: dBm

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

Note

This property is valid only when the nirfsg.Session.power_level_type property is set to AVERAGE.

The nirfsg.Session.arb_digital_gain property is not included in the calculation of the nirfsg.Session.peak_envelope_power property.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Peak Envelope Power (dBm)

C Attribute: NIRFSG_ATTR_PEAK_ENVELOPE_POWER

peak_power_adjustment 

nirfsg.Session.peak_power_adjustment

Specifies the adjustment for the nirfsg.Session.power_level property. This property is valid only when you set the nirfsg.Session.power_level_type property to PEAK. The value of the nirfsg.Session.peak_power_adjustment property adds to the nirfsg.Session.power_level property. The nirfsg.Session.peak_power_adjustment property 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.Session.power_level_type property is set to PEAK.

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

Related Topics

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

Note

For the PXIe-5673/5673E only, use this property to associate a peak power adjustment with a waveform.

For the PXIe-5645, this property is ignored if you are using the I/Q ports.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Peak Power Adjustment (dB)

C Attribute: NIRFSG_ATTR_PEAK_POWER_ADJUSTMENT

phase_continuity_enabled 

nirfsg.Session.phase_continuity_enabled

Specifies whether the driver maintains phase continuity in the arbitrary waveforms. When this property is set to ENABLE, NI-RFSG may increase the waveform size. To set the nirfsg.Session.phase_continuity_enabled property, the NI-RFSG device must be in the Configuration state. nirfsg.Session.phase_continuity_enabled applies only when the nirfsg.Session.generation_mode property is set to ARB_WAVEFORM or SCRIPT.

PXI-5671: When using the PXI-5671 with I/Q rates less than or equal to 8.33MS/s, an input phase-continuous signal is always phase-continuous upon output, and this property has no effect.

PXIe-5644/5645/5646, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: Phase continuity is always enabled on this device.

Default Value: AUTO

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

Related Topics

Phase Continuity

Arb Waveform Mode Tuning Speed Factors

Defined Values:

nirfsg.Session.phase_continuity_enabled Property Setting

Value

With I/Q Rates > 8.33 MS/s.

AUTO

-1 (-0x1)

When the Generation Mode property is set to Arb Waveform, the arbitrary waveform may be repeated to ensure phase continuity after upconversion. This setting could cause waveform size to increase. When the Generation Mode property is set to Script, the Phase Continuity Enabled property indicates a warning condition. NI-RFSG cannot guarantee a phase-continuous output signal in Script mode. Phase continuity is automatically disabled in script mode, and the arbitrary waveform plays back without regard to any possible phase discontinuities introduced by upconversion.

DISABLE

0 (0x0)

When the Generation Mode property is set to Arb Waveform, the arbitrary waveform is played back without regard to any possible phase discontinuities introduced by upconversion. The time duration of the original waveform is maintained. When the Generation Mode property is set to Script, the arbitrary waveform plays back without regard to any possible phase discontinuities introduced by upconversion. The time duration of the original waveform is maintained.

ENABLE

1 (0x1)

When the Generation Mode property is set to Arb Waveform, the arbitrary waveform may be repeated to ensure phase continuity after upconversion. Enabling this property could cause waveform size to increase. When the Generation Mode property is set to Script, the arbitrary waveform plays back without regard to any possible phase discontinuities introduced by upconversion. The time duration of the original waveform is maintained.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.PhaseContinuityEnabled

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Phase Continuity Enabled

C Attribute: NIRFSG_ATTR_PHASE_CONTINUITY_ENABLED

phase_offset 

nirfsg.Session.phase_offset

Specifies the phase of the RF output signal. Use this property 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/5842

Related Topics

Phase Synchronization and Phase Coherency

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Phase Offset (Degrees)

C Attribute: NIRFSG_ATTR_PHASE_OFFSET

power_level 

nirfsg.Session.power_level

Specifies either the average power level or peak power level of the generated RF signal, depending on the nirfsg.Session.power_level_type property setting.

The PXI-5670/5671, PXIe-5672, and PXIe-5860 must be in the Configuration state to use this property. 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/5842 can be in the Configuration or the Generation state to use this property.

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

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/5842/5860: -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/5842/5860 High-Level Methods:

nirfsg.Session.ConfigureRf()

Note

For the PXIe-5653, this property is read-only.

For the PXIe-5645, this property is ignored if you are using the I/Q ports.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Power Level (dBm)

C Attribute: NIRFSG_ATTR_POWER_LEVEL

power_level_type 

nirfsg.Session.power_level_type

Specifies how NI-RFSG interprets the value of the nirfsg.Session.power_level property. The nirfsg.Session.power_level_type property also affects how waveforms are scaled.

PXI-5670/5671: While in Script generation mode, if this property is set to AVERAGE, 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.Session.power_level property. You can disable this scaling operation by setting the nirfsg.Session.power_level_type property to PEAK.

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

Converting from Average Power to Peak Power

Typically, this property is set to AVERAGE. However, some instrument modes require this property to be set to PEAK. 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: PEAK

All other devices: AVERAGE

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

Related Topics

Spurious Performance

Optimizing for Low Power Generation

Defined Values:

Value

Description

AVERAGE

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.

PEAK

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.Session.arb_waveform_software_scaling_factor property. You can use the nirfsg.Session.peak_power_adjustment property in conjunction with the nirfsg.Session.power_level property when the nirfsg.Session.power_level_type property is set to PEAK.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.PowerLevelType

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Power Level Type

C Attribute: NIRFSG_ATTR_POWER_LEVEL_TYPE

pulse_modulation_active_level 

nirfsg.Session.pulse_modulation_active_level

Specifies the active level of the pulse modulation signal when pulse modulation is enabled. To set this property, the NI-RFSG device must be in the Configuration state.

Default Value: HIGH

Supported Devices: PXIe-5842

Defined Values:

Name

Value

Description

HIGH

9000 (0x2328)

Trigger when the digital trigger signal is high.

LOW

9001 (0x2329)

Trigger when the digital trigger signal is low.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.ScriptTriggerDigitalLevelActiveLevel

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Advanced:Pulse Modulation Active Level

C Attribute: NIRFSG_ATTR_PULSE_MODULATION_ACTIVE_LEVEL

pulse_modulation_enabled 

nirfsg.Session.pulse_modulation_enabled

Enables or disables pulse modulation.

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

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

PXIe-5842: If this property 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. This behavior can be modified by setting pulse modulation active level.

Default Value: False

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

Related Topics

Pulse Modulation

Defined Values:

Value

Description

True

Enables pulse modulation.

False

Disables pulse modulation.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

bool

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Modulation:Pulse:Pulse Modulation Enabled

C Attribute: NIRFSG_ATTR_PULSE_MODULATION_ENABLED

pulse_modulation_mode 

nirfsg.Session.pulse_modulation_mode

PXIe-5654/5654 with PXIe-5696: Specifies the pulse modulation mode to use.

PXIe-5842: This property allows you to choose a tradeoff between switching speed and On/Off Ratio when using pulse modulation. Refer to the product specifications document for the switching characteristics of each mode. This property is settable while the device is generating, but some output pulses may be dropped.

Default Value: ANALOG

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

Defined Values:

Value

Description

OPTIMAL_MATCH

Provides for a more optimal power output match for the device during the off cycle of the pulse mode operation. Not supported on PXIe-5842.

NIRFSG_VAL_PULSE_MODULATION_ANALOG_HIGH_ISOLATION

Allows for the best on/off power ratio of the pulsed signal.

NIRFSG_VAL_PULSE_MODULATION_ANALOG

Analog switch blanking. Balance between switching speed and on/off power ratio of the pulsed signal.

NIRFSG_VAL_PULSE_MODULATION_DIGITAL

Digital only modulation. Provides the best on/off switching speed of the pulsed signal at the cost of signal isolation.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.PulseModulationMode

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Advanced:Pulse Modulation Mode

C Attribute: NIRFSG_ATTR_PULSE_MODULATION_MODE

pulse_modulation_source 

nirfsg.Session.pulse_modulation_source

Specifies the source of the pulse modulation signal. When Pulse In in used, the pulse modulation is applied with the lowest latency and jitter, but is not aligned to any particular waveform sample. When a marker is used, the RF pulse is aligned to a specific sample in the arbitrary waveform. To set this property, the NI-RFSG device must be in the Configuration state.

Default Value: PulseIn

Supported Devices: PXIe-5842

Possible Values:

Possible Value

Description

“PulseIn”

The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842.

“Marker0”

The trigger is received from the Marker 0.

“Marker1”

The trigger is received from the Marker 1.

“Marker2”

The trigger is received from the Marker 2.

“Marker3”

The trigger is received from the Marker 3.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.PulseModulationSource

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Modulation:Pulse:Pulse Modulation Source

C Attribute: NIRFSG_ATTR_PULSE_MODULATION_SOURCE

ref_clock_rate 

nirfsg.Session.ref_clock_rate

Specifies the Reference Clock rate, in Hz, of the signal present at the REF IN or CLK IN connector. This property is only valid when the nirfsg.Session.ref_clock_source property is set to ClkIn, RefIn, or RefIn2

To set this property, the NI-RFSG device must be in the Configuration state. If you are using the PXIe-5654/5654 with PXIe-5696, the NI-RFSG device must be in the Committed state to read this property. When you read this property, it returns the frequency the device is locked to during the Committed state.

If you set this property to Auto, NI-RFSG uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if automatic detection is supported by the device.

Valid Values:

PXIe-5654/5654 with PXIe-5696: Values between 1MHz to 20MHz in 1MHz steps are supported in addition to the Auto and 10MHz values.

PXIe-5841 with PXIe-5655, PXIe-5842: 10 MHz, 100 MHz, 270 MHz, and 3.84 MHz

y, where

y is 4, 8, 16, 24, 25, or 32.

PXIe-5860: 10 MHz, 100 MHz

Units: hertz (Hz)

Default Value: Auto

Supported Devices: PXI-5610, 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/5842/5860

Related Topics

Timing Configurations

High-Level Methods:

nirfsg.Session.configure_ref_clock()

Defined Values:

Name

Value

Description

Auto

-1.0

Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it.

10MHz

10000000.0

Uses a 10 MHz Reference Clock rate.

Note

Automatic detection of the Reference Clock rate is supported on only the PXIe-5654/5654 with PXIe-5696. For all other supported devices, NI-RFSG uses the default Reference Clock rate of 10MHz.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Clock:Reference Clock Rate (Hz)

C Attribute: NIRFSG_ATTR_REF_CLOCK_RATE

ref_clock_source 

nirfsg.Session.ref_clock_source

Specifies the Reference Clock source. To set this property, the NI-RFSG device must be in the Configuration state.

Default Value: OnboardClock

Supported Devices: PXI-5610, 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/5842/5860

Related Topics

Timing Configurations

High-Level Methods:

nirfsg.Session.configure_ref_clock()

Possible Values:

Possible Value

Description

“OnboardClock”

Uses the onboard Reference Clock as the clock source. PXIe-5830/5831 —For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831/5832, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. ** PXIe-5831/5832 with PXIe-5653** —Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. PXIe-5841 with PXIe-5655 —Lock to the PXIe-5655 onboard clock. Connect the REF OUT connector on the PXIe-5655 to the PXIe-5841 REF IN connector.

“ClkIn”

Uses the clock signal present at the front panel CLK IN connector as the Reference Clock source. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5831 with PXIe-5653/5832/5832 with PXIe-5653/5840/5841/5841 with PXIe-5655.

“RefIn”

Uses the clock signal present at the front panel REF IN connector as the Reference Clock source. PXIe-5830/5831 —For the PXIe-5830, connect the PXIe-5820 REF IN connector to the PXIe-3621 REF OUT connector. For the PXIe-5831/5832, connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. For the PXIe-5830, lock the external signal to the PXIe-3621 REF IN connector. For the PXIe-5831/5832, lock the external signal to the PXIe-3622 REF IN connector. PXIe-5831/5832 with PXIe-5653 —Connect the PXIe-5820 REF IN connector to the PXIe-3622 REF OUT connector. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXIe-3622 REF IN connector. Lock the external signal to the PXIe-5653 REF IN connector. PXIe-5841 with PXIe-5655 —Lock to the signal at the REF IN connector on the associated PXIe-5655. Connect the PXIe-5655 REF OUT connector to the PXIe-5841 REF IN connector.

“PXI_CLK”

Uses the PXI_CLK signal, which is present on the PXI backplane, as the Reference Clock source.

“RefIn2”

This value is not valid on any supported devices.

“PXI_ClkMaster”

This value is valid on only the PXIe-5831/5832 with PXIe-5653. PXIe-5831/5832 with PXIe-5653 —NI-RFSG configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3622 to use PXI_CLK as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.ReferenceClockSource

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Clock:Reference Clock Source

C Attribute: NIRFSG_ATTR_REF_CLOCK_SOURCE

ref_pll_bandwidth 

nirfsg.Session.ref_pll_bandwidth

Configures the loop bandwidth of the reference PLL.

Default Value: NARROW

Supported Devices: PXIe-5653

Related Topics

Phase-Locked Loop Bandwidth

Defined Values:

Value

Description

NARROW

Uses the narrowest loop bandwidth setting for the PLL.

MEDIUM

Uses the medium loop bandwidth setting for the PLL.

WIDE

Uses the widest loop bandwidth setting for the PLL.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.ReferencePllBandwidth

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Advanced:Ref PLL Bandwidth

C Attribute: NIRFSG_ATTR_REF_PLL_BANDWIDTH

relative_delay 

nirfsg.Session.relative_delay

Specifies the delay, in seconds, to apply to the I/Q waveform.

Relative delay allows for delaying the generated signal from one device relative to the generated signal of another device after those devices have been synchronized. You can achieve a negative relative delay by delaying both synchronized devices by the same value (1 μs) before generation begins and then changing the relative delay to a smaller amount than the initial value on only one of the devices.

To set this property, the NI-RFSG device must be in the Configuration or Generation state.

Units: Seconds

Valid Values:

PXIe-PXIe-5820/5830/5831/5832/5840/5841: 0 μs to 3.2 μs

PXIe-5842: 0 μs to 6.5 μs

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

Related Topics

NI-TClk Overview

Note

To obtain a negative relative delay when synchronizing the PXIe-5840/5841 with a module that does not support this property, use the NITCLK_ATTR_SAMPLE_CLOCK_DELAY property.

The resolution of this property is a method of the I/Q sample period at 15E(-6) of the sample period but not worse than one Sample Clock period.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

hightime.timedelta, datetime.timedelta, or float in seconds

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:Signal Path:Relative Delay

C Attribute: NIRFSG_ATTR_RELATIVE_DELAY

rf_blanking_source 

nirfsg.Session.rf_blanking_source

Specifies the Marker Event at which RF blanking occurs. RF blanking quickly attenuates the RF OUT signal. Use Marker Events to toggle the state of RF blanking. The RF Output always starts in the unblanked state.

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

You can specify Marker Events by using scripts to trigger blanking at a certain point in a waveform. For example, if you set this property to marker0 str}, and marker0 occurs on samples 1,000 and 2,000 of a script, then the RF Output will be blanked (attenuated) between samples 1,000 and 2,000.

PXIe-5645: This property is ignored if you are using the I/Q ports.

PXIe-5840/5841: RF blanking does not occur for frequencies below 120MHz.

For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any nirfsg.Session.Reset() or niRFSA_reset on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call nirfsg.Session.reset_with_options() or niRFSA_ResetWithOptions. Select Routes in the steps to omit parameter.

Default Value: “” (empty string)

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

Related Topics

Marker Events

Valid Values:

Value

Description

“”

RF blanking is disabled.

“Marker0”

RF blanking is tied to marker0.

“Marker1”

RF blanking is tied to marker1.

“Marker2”

RF blanking is tied to marker2.

“Marker3”

RF blanking is tied to marker3.

Note

The shortest supported blanking interval is eight microseconds.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:Signal Path:RF Blanking Source

C Attribute: NIRFSG_ATTR_RF_BLANKING_SOURCE

rf_in_lo_export_enabled 

nirfsg.Session.rf_in_lo_export_enabled

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

Set this property to ENABLE to export the LO signal from the RF IN LO OUT terminal.

When this property is enabled, if the nirfsg.Session.lo_source property is set to LO_In and you do not set the nirfsg.Session.lo_frequency or nirfsg.Session.upconverter_center_frequency properties, NI-RFSG rounds the LO frequency to approximately an LO step size as if the source was OnboardClock. 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.

Default Value: UNSPECIFIED

Supported Devices: PXIe-5840/5841/5842

Defined Values:

Value

Description

DISABLE

The RF In local oscillator signal is not present at the front panel LO OUT connector.

ENABLE

The RF In local oscillator signal is present at the front panel LO OUT connector.

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.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.RFInLoExportEnabled

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:RF In LO Export Enabled

C Attribute: NIRFSG_ATTR_RF_IN_LO_EXPORT_ENABLED

script_trigger_terminal_name 

nirfsg.Session.script_trigger_terminal_name

Returns the name of the fully qualified signal name as a string.

Default Values:

PXI-5670/5671, PXIe-5672/5673/5673E: /AWGName/ScriptTrigger X, where AWGName is the name of your associated AWG module in MAX and X is Script Trigger 0 through 3.

PXIe-5830/5831/5832: /BasebandModule/ao/0/ScriptTrigger X, where BasebandModule is the name of the baseband module of your device in MAX and X is Script Trigger 0 through 3.

PXIe-5820/5840/5841/5842: /ModuleName/ao/0/ScriptTrigger X, where ModuleName is the name of your device in MAX and X is Script Trigger 0 through 3.

PXIe-5860: /ModuleName/ao/ChannelNumber/ScriptTrigger X, where ModuleName is the name of your device in MAX, ChannelNumber is the channel number (0 or 1), and X is Script Trigger 0 through 3.

Supported Devices: PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860

Related Topics

Triggers

Syntax for Terminal Names

High-Level Methods:

nirfsg.Session.get_terminal_name()

Tip

This property can be set/get on specific script_triggers within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container script_triggers to specify a subset.

Example: my_session.script_triggers[ ... ].script_trigger_terminal_name

To set/get on all script_triggers, you can call the property directly on the nirfsg.Session.

Example: my_session.script_trigger_terminal_name

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read only

Repeated Capabilities

script_triggers

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Triggers:Script:Terminal Name

C Attribute: NIRFSG_ATTR_SCRIPT_TRIGGER_TERMINAL_NAME

script_trigger_type 

nirfsg.Session.script_trigger_type

Specifies the Script Trigger type. Depending upon the value of this property, more properties may be needed to fully configure the trigger. To set this property, the NI-RFSG device must be in the Configuration state.

Default Value: NONE

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

Related Topics

Script Trigger

Trigger Types

High-Level Methods:

nirfsg.Session.configure_digital_edge_script_trigger()

Defined Values:

Value

Description

NONE

No trigger is configured. Signal generation starts immediately.

DIGITAL_EDGE

The data operation does not start until a digital edge is detected. The source of the digital edge is specified with the nirfsg.Session.digital_edge_start_trigger_source property, and the active edge is specified with the nirfsg.Session.digital_edge_start_trigger_edge property.

DIGITAL_LEVEL

The data operation does not start until the digital level is detected. The source of the digital level is specified in the nirfsg.Session.digital_level_script_trigger_source property, and the active level is specified in the nirfsg.Session.digital_level_script_trigger_active_level property.

SOFTWARE

The data operation does not start until a software trigger occurs. You can create a software event by calling the nirfsg.Session.send_software_edge_trigger() method.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

Tip

This property can be set/get on specific script_triggers within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container script_triggers to specify a subset.

Example: my_session.script_triggers[ ... ].script_trigger_type

To set/get on all script_triggers, you can call the property directly on the nirfsg.Session.

Example: my_session.script_trigger_type

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.ScriptTriggerType

Permissions

read-write

Repeated Capabilities

script_triggers

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Triggers:Script:Type

C Attribute: NIRFSG_ATTR_SCRIPT_TRIGGER_TYPE

selected_path 

nirfsg.Session.selected_path

Specifies which path to configure to generate a signal.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Signal Path:Advanced:Selected Path

C Attribute: NIRFSG_ATTR_SELECTED_PATH

selected_ports 

nirfsg.Session.selected_ports

Specifies the port to configure.

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*x*, 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-5644/5645/5646, PXIe-5820/5840/5841/5842/5860: “” (empty string)

PXIe-5830/5831/5832: if0

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

Related Topics

nirfsg.Session.available_ports

Note

When using RF list mode, ports cannot be shared with NI-RFSA.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:Signal Path:Selected Ports

C Attribute: NIRFSG_ATTR_SELECTED_PORTS

selected_script 

nirfsg.Session.selected_script

Specifies the script in onboard memory to generate upon calling the nirfsg.Session._initiate() method when the nirfsg.Session.generation_mode property is set to SCRIPT.

The nirfsg.Session.selected_script property is ignored when the nirfsg.Session.generation_mode property is set to ARB_WAVEFORM or CW. To set the nirfsg.Session.selected_script property, the NI-RFSG device must be in the Configuration state.

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

Related Topics

Assigning Properties or Properties to a Waveform

Scripting Instructions

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Selected Script

C Attribute: NIRFSG_ATTR_SELECTED_SCRIPT

self_calibration_temperature 

nirfsg.Session.self_calibration_temperature

Indicates, in degrees Celsius, the temperature of the device at the time of the last self calibration.

Supported Devices: PXIe-5644/5645/5646

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Self Calibration:Last Self Calibration Temperature

C Attribute: NIRFSG_ATTR_SELF_CALIBRATION_TEMPERATURE

serial_number 

nirfsg.Session.serial_number

Returns the serial number of the RF module. If the NI-RFSG session is controlling multiple modules, this property returns the serial number of the primary RF module.

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/5842/5860

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Characteristics:Serial Number

C Attribute: NIRFSG_ATTR_SERIAL_NUMBER

signal_bandwidth 

nirfsg.Session.signal_bandwidth

Specifies the bandwidth of the arbitrary signal. This value must be less than or equal to (0.8× nirfsg.Session.iq_rate).

NI-RFSG defines signal bandwidth as twice the maximum baseband signal deviation from 0 Hz. Usually, the baseband signal center frequency is 0 Hz. In such cases, the signal bandwidth is simply the baseband signal’s minimum frequency subtracted from its maximum frequency, or f _max - f _min .

This property applies only when the nirfsg.Session.generation_mode property is set to ARB_WAVEFORM or SCRIPT, except for when using the PXIe-5830/5831/5832/5840/5841, which supports setting this property in all supported generation modes. To set the nirfsg.Session.signal_bandwidth property, the NI-RFSG device must be in the Configuration state.

PXI-5670/5671, PXIe-5672: Based on your signal bandwidth, NI-RFSG determines whether to configure the upconverter center frequency in increments of 1MHz or 5MHz. Failure to configure this property may result in the signal being placed outside the upconverter passband.

PXIe-5644/5645/5646, PXIe-5673/5673E: This property is used only for error-checking purposes. Otherwise, this property is ignored.

PXIe-5820/5830/5831/5832/5840/5841/5842/5860: Based on your signal bandwidth, NI-RFSG decides the equalized bandwidth. If this property is not set, NI-RFSG uses the maximum available signal bandwidth. For the PXIe-5840/5841, the maximum allowed signal bandwidth depends on the upconverter center frequency. Refer to the specifications document for your device for more information about signal bandwidth. The device specifications depend on the signal bandwidth.

Units: hertz (Hz)

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

Related Topics

Phase-Locked Loop Bandwidth

Frequency Tuning Times

PXIe-5830 Frequency and Bandwidth Selection

PXIe-5831/5832 Frequency and Bandwidth Selection

PXIe-5841 Frequency and Bandwidth Selection

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Signal Bandwidth (Hz)

C Attribute: NIRFSG_ATTR_SIGNAL_BANDWIDTH

specific_driver_class_spec_major_version 

nirfsg.Session.specific_driver_class_spec_major_version

Returns the major version number of the class specification with which NI-RFSG is compliant.

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/5842/5860

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

int

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Inherent IVI Attributes:Driver Identification:Class Specification Major Version

C Attribute: NIRFSG_ATTR_SPECIFIC_DRIVER_CLASS_SPEC_MAJOR_VERSION

specific_driver_class_spec_minor_version 

nirfsg.Session.specific_driver_class_spec_minor_version

Returns the minor version number of the class specification with which NI-RFSG is compliant.

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/5842/5860

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

int

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Inherent IVI Attributes:Driver Identification:Class Specification Minor Version

C Attribute: NIRFSG_ATTR_SPECIFIC_DRIVER_CLASS_SPEC_MINOR_VERSION

specific_driver_description 

nirfsg.Session.specific_driver_description

Returns a string that contains a brief description of NI-RFSG. This property returns

National Instruments RF Signal Generator Instrument Driver.

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/5842/5860

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Inherent IVI Attributes:Driver Identification:Description

C Attribute: NIRFSG_ATTR_SPECIFIC_DRIVER_DESCRIPTION

specific_driver_prefix 

nirfsg.Session.specific_driver_prefix

Returns a string that contains the prefix for NI-RFSG. The name of each user-callable method in NI-RFSG starts with this prefix. This property returns

niRFSG.

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/5842/5860

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Inherent IVI Attributes:Driver Identification:Driver Prefix

C Attribute: NIRFSG_ATTR_SPECIFIC_DRIVER_PREFIX

specific_driver_revision 

nirfsg.Session.specific_driver_revision

Returns a string that contains additional version information about NI-RFSG. For example, NI-RFSG can return

Driver: NI-RFSG14.5.0, Compiler: MSVC9.00, Components: IVI Engine4.00, VISA-Spec4.00 as the value of this property.

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/5842/5860

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Inherent IVI Attributes:Driver Identification:Revision

C Attribute: NIRFSG_ATTR_SPECIFIC_DRIVER_REVISION

specific_driver_vendor 

nirfsg.Session.specific_driver_vendor

Returns a string that contains the name of the vendor that supplies NI-RFSG. This property returns

National Instruments.

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/5842/5860

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Inherent IVI Attributes:Driver Identification:Driver Vendor

C Attribute: NIRFSG_ATTR_SPECIFIC_DRIVER_VENDOR

started_event_terminal_name 

nirfsg.Session.started_event_terminal_name

Returns the name of the fully qualified signal name as a string.

Default Values:

PXI-5670/5671, PXIe-5672/5673/5673E: /AWGName/StartedEvent, where AWGName is the name of your associated AWG module in MAX.

PXIe-5830/5831/5832: /BasebandModule/ao/0/StartedEvent, where BasebandModule is the name of the baseband module of your device in MAX.

PXIe-5820/5840/5841: /ModuleName/ao/0/StartedEvent, where ModuleName is the name of your device in MAX.

PXIe-5860: /ModuleName/ao/ChannelNumber/StartedEvent, where ModuleName is the name of your device in MAX and ChannelNumber is the channel number (0 or 1).

Supported Devices: PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860

Related Topics

Events

Syntax for Terminal Names

High-Level Methods:

nirfsg.Session.get_terminal_name()

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Events:Started Event Terminal Name

C Attribute: NIRFSG_ATTR_STARTED_EVENT_TERMINAL_NAME

start_trigger_terminal_name 

nirfsg.Session.start_trigger_terminal_name

Returns the name of the fully qualified signal name as a string.

Default Values:

PXIe-5654/5654 with PXIe-5696: /ModuleName/StartTrigger, where ModuleName is the name of your device in MAX.

PXI-5670/5671, PXIe-5672/5673/5673E: /AWGName/StartTrigger, where ModuleName is the name of your associated AWG module in MAX.

PXIe-5830/5831/5832: /BasebandModule/ao/0/StartTrigger, where BasebandModule is the name of the baseband module of your device in MAX.

PXIe-5820/5840/5841/5842: /ModuleName/ao/0/StartTrigger, where ModuleName is the name of your device in MAX.

PXIe-5860: /ModuleName/ao/ChannelNumber/StartTrigger, where ModuleName is the name of your device in MAX and ChannelNumber is the channel number (0 or 1).

Supported Devices: PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860

Related Topics

Start Trigger

Syntax for Terminal Names

High-Level Methods:

nirfsg.Session.get_terminal_name()

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Triggers:Start:Terminal Name

C Attribute: NIRFSG_ATTR_START_TRIGGER_TERMINAL_NAME

start_trigger_type 

nirfsg.Session.start_trigger_type

Specifies the Start Trigger type. Depending upon the value of this property, more properties may be needed to fully configure the trigger. To set this property, the NI-RFSG device must be in the Configuration state.

Default Value: NONE

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

Related Topics

Start Trigger

Trigger Types

High-Level Methods:

nirfsg.Session.configure_digital_edge_start_trigger()

nirfsg.Session.configure_software_start_trigger()

nirfsg.Session.disable_start_trigger()

Defined Values:

Value

Description

NONE

No trigger is configured.

DIGITAL_EDGE

The data operation does not start until a digital edge is detected. The source of the digital edge is specified with the nirfsg.Session.digital_edge_start_trigger_source property, and the active edge is specified in the nirfsg.Session.digital_edge_start_trigger_edge property.

SOFTWARE

The data operation does not start until a software event occurs. You may create a software trigger by calling the nirfsg.Session.send_software_edge_trigger() method.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.StartTriggerType

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Triggers:Start:Type

C Attribute: NIRFSG_ATTR_START_TRIGGER_TYPE

streaming_enabled 

nirfsg.Session.streaming_enabled

Enables and disables continuous streaming of waveform data.

Default Value: False

Supported Devices: PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860

Related Topics

Streaming

Defined Values:

Value

Description

True

Streaming is enabled.

False

Streaming is disabled.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

bool

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Data Transfer:Streaming:Streaming Enabled

C Attribute: NIRFSG_ATTR_STREAMING_ENABLED

streaming_space_available_in_waveform 

nirfsg.Session.streaming_space_available_in_waveform

Indicates the space available, in samples, in the streaming waveform for writing new data. For optimal performance, write new data to the waveform in a fixed size that is an integer divisor of the total size of the streaming waveform. This waveform size ensures that writes do not have to wrap around from the end to the beginning of the waveform buffer.

To read this property, the NI-RFSG device must be in the Committed state.

Units: samples

Supported Devices: PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860

Related Topics

Streaming

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

int

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Data Transfer:Streaming:Space Available In Streaming Waveform (Samples)

C Attribute: NIRFSG_ATTR_STREAMING_SPACE_AVAILABLE_IN_WAVEFORM

streaming_waveform_name 

nirfsg.Session.streaming_waveform_name

Specifies the name of the waveform used to continually stream data during generation.

Default Value: “” (empty string)

Supported Devices: PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860

Related Topics

Streaming

Streaming Waveform Data

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Data Transfer:Streaming:Streaming Waveform Name

C Attribute: NIRFSG_ATTR_STREAMING_WAVEFORM_NAME

streaming_write_timeout 

nirfsg.Session.streaming_write_timeout

Indicates the maximum amount of time allowed to complete a streaming write operation.

Default Value: 10.0seconds

Supported Devices: PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860

Related Topics

Streaming

Streaming Waveform Data

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

hightime.timedelta, datetime.timedelta, or float in seconds

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Data Transfer:Streaming:Streaming Write Timeout

C Attribute: NIRFSG_ATTR_STREAMING_WRITE_TIMEOUT

supported_instrument_models 

nirfsg.Session.supported_instrument_models

Returns a list of supported devices.

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/5842/5860

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

list of str

Permissions

read only

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Inherent IVI Attributes:Driver Capabilities:Supported Instrument Models

C Attribute: NIRFSG_ATTR_SUPPORTED_INSTRUMENT_MODELS

sync_sample_clock_dist_line 

nirfsg.Session.sync_sample_clock_dist_line

Specifies which external trigger line distributes the Sample Clock sync signal. When synchronizing the Sample Clock between multiple devices, configure all devices to use the same Sample Clock sync distribution line.

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

Valid Values: PXI_Trig0, PXI_Trig1, PXI_Trig2, PXI_Trig3, PXI_Trig4, PXI_Trig5, PXI_Trig6, PXI_Trig7, PFI0

Default Value: “” (empty string)

Supported Devices: PXIe-5646

Related Topics

Synchronization Using NI-RFSA and NI-RFSG—Refer to this topic for more information about PXIe-5646 device synchronization.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:Triggers:Sync Sample Clock Dist Line

C Attribute: NIRFSG_ATTR_SYNC_SAMPLE_CLOCK_DIST_LINE

sync_sample_clock_master 

nirfsg.Session.sync_sample_clock_master

Specifies whether the device is the master device when synchronizing the Sample Clock between multiple devices. The master device distributes the Sample Clock sync signal to all devices in the system through the Sample Clock sync distribution line.

When synchronizing the Sample Clock, one device must always be designated as the master. The master device actively drives the Sample Clock sync distribution line.

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

Default Value: False

Supported Devices: PXIe-5646

Related Topics

Synchronization Using NI-RFSA and NI-RFSG—Refer to this topic for more information about PXIe-5646 device synchronization.

Defined Values:

Value

Description

True

The device is the master device for synchronizing the Sample Clock.

False

The device is not the master for synchronizing the Sample Clock.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

bool

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:Triggers:Sync Sample Clock Master

C Attribute: NIRFSG_ATTR_SYNC_SAMPLE_CLOCK_MASTER

sync_script_trigger_dist_line 

nirfsg.Session.sync_script_trigger_dist_line

Specifies which external trigger line distributes the synchronized Script Trigger signal. When synchronizing the Script Trigger, configure all devices to use the same Script Trigger distribution line.

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

Valid Values: PXI_Trig0, PXI_Trig1, PXI_Trig2, PXI_Trig3, PXI_Trig4, PXI_Trig5, PXI_Trig6, PXI_Trig7, PFI0

Default Value: “” (empty string)

Supported Devices: PXIe-5644/5645/5646

Related Topics

Script Trigger

Synchronizing Sample Clock and Sampled Reference Clock Signals

Refer to the Synchronization Using NI-RFSA and NI-RFSG topic appropriate to your device for more information about device synchronization for vector signal transceivers.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:Triggers:Sync Script Trigger Dist Line

C Attribute: NIRFSG_ATTR_SYNC_SCRIPT_TRIGGER_DIST_LINE

sync_script_trigger_master 

nirfsg.Session.sync_script_trigger_master

Specifies whether the device is the master device when synchronizing the Script Trigger.

The master device distributes the synchronized Script Trigger to all devices in the system through the Script Trigger distribution line.

When synchronizing the Script trigger, one device must always be designated as the master. The master device actively drives the Script Trigger distribution line. For slave devices, set the nirfsg.Session.script_trigger_type property to digital edge, and set the nirfsg.Session.digital_edge_script_trigger_source property to sync_script.

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

Default Value: False

Supported Devices: PXIe-5644/5645/5646

Related Topics

Script Trigger

Synchronizing Sample Clock and Sampled Reference Clock Signals

Refer to the Synchronization Using NI-RFSA and NI-RFSG topic appropriate to your device for more information about device synchronization for vector signal transceivers.

Defined Values:

Value

Description

True

The device is the master device for synchronizing the Script Trigger.

False

The device is not the master for synchronizing the Script Trigger.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

bool

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:Triggers:Sync Script Trigger Master

C Attribute: NIRFSG_ATTR_SYNC_SCRIPT_TRIGGER_MASTER

sync_start_trigger_dist_line 

nirfsg.Session.sync_start_trigger_dist_line

Specifies which external trigger line distributes the synchronized Start Trigger signal. When synchronizing the Start Trigger, configure all devices to use the same Start Trigger distribution line.

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

Valid Values: PXI_Trig0, PXI_Trig1, PXI_Trig2, PXI_Trig3, PXI_Trig4, PXI_Trig5, PXI_Trig6, PXI_Trig7, PFI0

Default Value: “” (empty string)

Supported Devices: PXIe-5644/5645/5646

Related Topics

Start Trigger

Refer to the Synchronization Using NI-RFSA and NI-RFSG topic appropriate to your device for more information about device synchronization for vector signal transceivers.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

str

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:Triggers:Sync Start Trigger Dist Line

C Attribute: NIRFSG_ATTR_SYNC_START_TRIGGER_DIST_LINE

sync_start_trigger_master 

nirfsg.Session.sync_start_trigger_master

Specifies whether the device is the master device when synchronizing the Start Trigger. The master device distributes the synchronized Start Trigger to all devices in the system through the Start Trigger distribution line.

When synchronizing the Start Trigger, one device must always be designated as the master. The master device actively drives the Start Trigger distribution line. For slave devices, set the nirfsg.Session.start_trigger_type property to digital edge, and set the nirfsg.Session.digital_edge_start_trigger_source property to sync_script.

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

Default Value: False

Supported Devices: PXIe-5644/5645/5646

Related Topics

Start Trigger

Refer to the Synchronization Using NI-RFSA and NI-RFSG topic appropriate to your device for more information about device synchronization for vector signal transceivers.

Defined Values:

Value

Description

True

The device is the master device for synchronizing the Start Trigger.

False

The device is not the master for synchronizing the Start Trigger.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

bool

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:Triggers:Sync Start Trigger Master

C Attribute: NIRFSG_ATTR_SYNC_START_TRIGGER_MASTER

temperature_read_interval 

nirfsg.Session.temperature_read_interval

Specifies the minimum time between temperature sensor readings.

Units: Seconds

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

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

hightime.timedelta, datetime.timedelta, or float in seconds

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Characteristics:Temperature Read Interval

C Attribute: NIRFSG_ATTR_TEMPERATURE_READ_INTERVAL

thermal_correction_headroom_range 

nirfsg.Session.thermal_correction_headroom_range

Specifies the expected thermal operating range of the instrument from the self-calibration temperature, in degrees Celsius, returned from the nirfsg.Session.device_temperature property.

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/5842/5860: 5

PXIe-5840/5841: 10

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

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Advanced:Thermal Correction Headroom Range (Degrees C)

C Attribute: NIRFSG_ATTR_THERMAL_CORRECTION_HEADROOM_RANGE

thermal_correction_temperature_resolution 

nirfsg.Session.thermal_correction_temperature_resolution

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/5842/5860

Default Values:

PXIe-5830/5831/5832/5842/5860: 0.2

PXIe-5840/5841: 1.0

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Advanced:Thermal Correction Temperature Resolution (Degrees C)

C Attribute: NIRFSG_ATTR_THERMAL_CORRECTION_TEMPERATURE_RESOLUTION

timer_event_interval 

nirfsg.Session.timer_event_interval

Specifies the time before the timer emits an event after the task is started and specifies the time interval between Timer events after the first event.

Units: seconds (s)

Default Value: 0

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

Related Topics

Events

Note

For the PXIe-5820/5840/5841/5842/5860, this property must be set for the timer to start. If you do not set this property, the timer is disabled.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

hightime.timedelta, datetime.timedelta, or float in seconds

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Events:Timer:Interval

C Attribute: NIRFSG_ATTR_TIMER_EVENT_INTERVAL

upconverter_center_frequency 

nirfsg.Session.upconverter_center_frequency

Indicates the center frequency of the passband containing the upconverted RF signal. Writing a value to this property 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)

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

Note

This property 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/5842, and is read-only on the PXI-5670/5671.

Resetting this property disables in-band retuning, however, for the PXIe-5820, in-band retuning is always enabled.

For the PXIe-5820, the only valid value for this property is 0.

Setting this property while the PXIe-5644/5645/5646, PXIe-5673/5673E, or PXIe-5820/5830/5831/5832/5840/5841/5842 device is generating has no effect until a dynamic property is set.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Upconverter:Center Frequency (Hz)

C Attribute: NIRFSG_ATTR_UPCONVERTER_CENTER_FREQUENCY

upconverter_frequency_offset 

nirfsg.Session.upconverter_frequency_offset

This property offsets the nirfsg.Session.upconverter_center_frequency from the RF frequency. Use this property to keep the local oscillator (LO) leakage at a determined offset from the RF signal.

Valid Values:

PXIe-5644/5645: -42MHz to +42MHz

PXIe-5646: -100MHz to +100MHz

PXIe-5830/5831/5832/5840/5841: -500MHz to +500MHz

PXI-5842 (500 MHz bandwidth option): -250MHz to +250MHz

PXI-5842 (1 GHz bandwidth option): -500MHz to +500MHz

PXI-5842 (2 GHz bandwidth option): -1GHz to +1GHz

PXIe-5842 (4 GHz bandwidth option) using the Standard personality: -1GHz to +1GHz

PXIe-5842 (4 GHz bandwidth option) using the 4 GHz Bandwidth personality: -2GHz to +2GHz

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

Related Topics

PXIe-5830 Frequency and Bandwidth Selection

PXIe-5831/5832 Frequency and Bandwidth Selection

PXIe-5841 Frequency and Bandwidth Selection

Note

You cannot set the nirfsg.Session.upconverter_center_frequency property or the nirfsg.Session.arb_carrier_frequency property at the same time as the nirfsg.Session.upconverter_frequency_offset property.

Resetting this property disables the upconverter frequency offset.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Device Specific:Vector Signal Transceiver:Upconverter:Frequency Offset (Hz)

C Attribute: NIRFSG_ATTR_UPCONVERTER_FREQUENCY_OFFSET

upconverter_frequency_offset_mode 

nirfsg.Session.upconverter_frequency_offset_mode

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 property to AUTO or USER_DEFINED, and set either the nirfsg.Session.upconverter_center_frequency or the nirfsg.Session.upconverter_frequency_offset property.

To allow NI-RFSG to automatically select the upconverter frequency offset, set this property to AUTO or ENABLE and set the nirfsg.Session.signal_bandwidth to describe the bandwidth of your waveform. The signal bandwidth must be no greater than half the value of the nirfsg.Session.device_instantaneous_bandwidth property, minus a device-specific guard band. Do not set the nirfsg.Session.upconverter_center_frequency or nirfsg.Session.upconverter_frequency_offset properties. If all conditions are met, NI-RFSG places the upconverter center frequency outside the signal bandwidth. Set this property to ENABLE 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.Session.upconverter_frequency_offset_mode returns USER_DEFINED. When NI-RFSG automatically sets an offset, the reference frequency for gain is near the nirfsg.Session.frequency and nirfsg.Session.upconverter_frequency_offset_mode returns ENABLE.

Default Value: AUTO

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

Related Topics

PXIe-5830 Automatic Frequency Offset

PXIe-5831/5832 Automatic Frequency Offset

PXIe-5841 Automatic Frequency Offset

Defined Values:

Value

Description

ENABLE

NI-RFSG places the upconverter center frequency outside of the signal bandwidth if the nirfsg.Session.signal_bandwidth property has been set and can be avoided. NI-RFSG returns an error if the nirfsg.Session.signal_bandwidth property has not been set, or if the signal bandwidth is too large.

AUTO

NI-RFSG places the upconverter center frequency outside of the signal bandwidth if the nirfsg.Session.signal_bandwidth property has been set and can be avoided.

USER_DEFINED

NI-RFSG uses the offset that you specified with the nirfsg.Session.upconverter_frequency_offset or nirfsg.Session.upconverter_center_frequency properties.

Note

Below 120 MHz, the PXIe-5841 does not use an LO and ENABLE is unavailable. Refer to the PXIe-5841 Automatic Frequency Offset topic for more information about using an automatic offset with an external LO.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.UpconverterFrequencyOffsetMode

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Upconverter:Frequency Offset Mode

C Attribute: NIRFSG_ATTR_UPCONVERTER_FREQUENCY_OFFSET_MODE

upconverter_gain 

nirfsg.Session.upconverter_gain

Specifies the gain the upconverter applies to the signal.

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/5842/5860

Note

This property 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/5842/5860.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Upconverter:Gain (dB)

C Attribute: NIRFSG_ATTR_UPCONVERTER_GAIN

waveform_iq_rate 

nirfsg.Session.waveform_iq_rate

Specifies the I/Q rate of the waveform. To set this property, the NI-RFSG device must be in the Configuration state.

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

Related Topics

Streaming

Assigning Properties or Properties to a Waveform—Refer to this topic for more information about using this property to associate an I/Q rate with a waveform.

Digital Upconverter

Tip

This property can be set/get on specific waveforms within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container waveforms to specify a subset.

Example: my_session.waveforms[ ... ].waveform_iq_rate

To set/get on all waveforms, you can call the property directly on the nirfsg.Session.

Example: my_session.waveform_iq_rate

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

waveforms

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Waveform Attributes:Waveform IQ Rate (S/s)

C Attribute: NIRFSG_ATTR_WAVEFORM_IQ_RATE

waveform_papr 

nirfsg.Session.waveform_papr

Specifies the peak-to-average power ratio (PAPR).

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

Tip

This property can be set/get on specific waveforms within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container waveforms to specify a subset.

Example: my_session.waveforms[ ... ].waveform_papr

To set/get on all waveforms, you can call the property directly on the nirfsg.Session.

Example: my_session.waveform_papr

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

waveforms

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Waveform Attributes:Waveform PAPR (dB)

C Attribute: NIRFSG_ATTR_WAVEFORM_PAPR

waveform_rf_blanking 

nirfsg.Session.waveform_rf_blanking

Defined Values:

Name (Value): Description

DISABLE (0): RF blanking is disabled.

ENABLE (1): RF blanking is enabled.

Default Value: DISABLE

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

Related Topics

Marker Events

Enables or disables RF blanking.

nirfsg.Session.rf_blanking_source

nirfsg.Session.waveform_rf_blanking

Behaviour

“” (empty string)

DISABLE

No blanking performed.

“” (empty string)

ENABLE

Blanking performed based on burst start and stop values and blanking source set to private marker.

NIRFSG_VAL_MARKER0, NIRFSG_VAL_MARKER1, NIRFSG_VAL_MARKER2, or NIRFSG_VAL_MARKER3

DISABLE

Blanking performed based on the marker locations for the marker that the user set in the blanking source.

NIRFSG_VAL_MARKER0, NIRFSG_VAL_MARKER1, NIRFSG_VAL_MARKER2, or NIRFSG_VAL_MARKER3

ENABLE

Error is shown.

Note

For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any nirfsg.Session.Reset() or niRFSA_reset on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call nirfsg.Session.reset_with_options() or niRFSA_ResetWithOptions. Select Routes in the steps to omit parameter.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

Tip

This property can be set/get on specific waveforms within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container waveforms to specify a subset.

Example: my_session.waveforms[ ... ].waveform_rf_blanking

To set/get on all waveforms, you can call the property directly on the nirfsg.Session.

Example: my_session.waveform_rf_blanking

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.RFBlanking

Permissions

read-write

Repeated Capabilities

waveforms

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Waveform Attributes:Waveform RF Blanking

C Attribute: NIRFSG_ATTR_WAVEFORM_RF_BLANKING

waveform_runtime_scaling 

nirfsg.Session.waveform_runtime_scaling

Specifies the waveform runtime scaling. The waveform runtime scaling is applied to the waveform data before any other signal processing.

Units: dB

Supported Devices: PXIe-5820/5830/5831/5832/5840/5841/5842/5860, PXIe-5841 with PXIe-5655

Tip

This property can be set/get on specific waveforms within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container waveforms to specify a subset.

Example: my_session.waveforms[ ... ].waveform_runtime_scaling

To set/get on all waveforms, you can call the property directly on the nirfsg.Session.

Example: my_session.waveform_runtime_scaling

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

waveforms

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Waveform Attributes:Waveform Runtime Scaling

C Attribute: NIRFSG_ATTR_WAVEFORM_RUNTIME_SCALING

waveform_signal_bandwidth 

nirfsg.Session.waveform_signal_bandwidth

Specifies the bandwidth of the arbitrary signal. This value must be less than or equal to (0.8× nirfsg.Session.iq_rate).

Units: hertz (Hz)

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

Tip

This property can be set/get on specific waveforms within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container waveforms to specify a subset.

Example: my_session.waveforms[ ... ].waveform_signal_bandwidth

To set/get on all waveforms, you can call the property directly on the nirfsg.Session.

Example: my_session.waveform_signal_bandwidth

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

waveforms

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Waveform Attributes:Waveform Signal Bandwidth (Hz)

C Attribute: NIRFSG_ATTR_WAVEFORM_SIGNAL_BANDWIDTH

waveform_waveform_size 

nirfsg.Session.waveform_waveform_size

Specifies the size of the waveform specified by an active channel.

Supported Devices: PXIe-5820/5830/5831/5832/5840/5841/5841 with PXIe-5655/5842/5860

Tip

This property can be set/get on specific waveforms within your nirfsg.Session instance. Use Python index notation on the repeated capabilities container waveforms to specify a subset.

Example: my_session.waveforms[ ... ].waveform_waveform_size

To set/get on all waveforms, you can call the property directly on the nirfsg.Session.

Example: my_session.waveform_waveform_size

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

int

Permissions

read only

Repeated Capabilities

waveforms

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Waveform Attributes:Waveform Size

C Attribute: NIRFSG_ATTR_WAVEFORM_WAVEFORM_SIZE

write_waveform_burst_detection 

nirfsg.Session.write_waveform_burst_detection

Enables the detection of burst start and burst stop locations in the waveform. You can read the detected burst start and burst stop locations using nirfsg.Session.get_waveform_burst_start_locations() and nirfsg.Session.get_waveform_burst_stop_locations() methods respectively.

Default Value: DISABLE

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

Defined Values:

Value

Description

ENABLE

Burst detection is enabled.

DISABLE

Burst detection is disabled.

Note

When you download a waveform using nirfsg.Session.ReadAndDownloadWaveformFromFileTdms() method and if nirfsg.Session.waveform_rf_blanking property is enabled, you must set the nirfsg.Session.write_waveform_burst_detection property to DISABLE.

For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any nirfsg.Session.Reset() or niRFSA_reset on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call nirfsg.Session.reset_with_options() or niRFSA_ResetWithOptions. Select Routes in the steps to omit parameter.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.WriteWaveformBurstDetection

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Write Waveform Burst Detection:Enabled

C Attribute: NIRFSG_ATTR_WRITE_WAVEFORM_BURST_DETECTION

write_waveform_burst_detection_mode 

nirfsg.Session.write_waveform_burst_detection_mode

Specifies the algorithm that NI-RFSG uses to detect the burst start and burst stop locations in the waveform when burst detection is enabled using the nirfsg.Session.write_waveform_burst_detection property. When you set nirfsg.Session.write_waveform_burst_detection_mode to AUTO, NI-RFSG automatically detects the burst start and burst stop locations by analyzing the waveform. To fine-tune the burst detection process parameters yourself, you can set this property to MANUAL and specify the burst detection parameters using the write waveform burst detection minimum quiet time, nirfsg.Session.write_waveform_burst_detection_power_threshold, write waveform burst detection minimum burst time properties.

Default Value: AUTO

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

Defined Values:

Value

Description

AUTO

NI-RFSG automatically detects the burst start and burst stop locations by analyzing the waveform.

MANUAL

User sets the burst detection parameters.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.WriteWaveformBurstDetectionMode

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Write Waveform Burst Detection:Mode

C Attribute: NIRFSG_ATTR_WRITE_WAVEFORM_BURST_DETECTION_MODE

write_waveform_burst_detection_power_threshold 

nirfsg.Session.write_waveform_burst_detection_power_threshold

Specifies the relative power level at which burst start or stop locations are detected. The threshold is relative to the peak power in the waveform. NI-RFSG detects burst start (or burst stop) locations when the signal exceeds (or falls below) the level specified by this property. This property is ignored when you disable the nirfsg.Session.write_waveform_burst_detection property or when you set the nirfsg.Session.write_waveform_burst_detection_mode property to NIRFSG_VAL_AUTO.

Units: dB

Default Value: 0

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

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

float

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Write Waveform Burst Detection:Power Threshold

C Attribute: NIRFSG_ATTR_WRITE_WAVEFORM_BURST_DETECTION_POWER_THRESHOLD

write_waveform_normalization 

nirfsg.Session.write_waveform_normalization

Specifies whether to perform the normalization on a waveform.

Default Value: DISABLE

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

Defined Values:

Value

Description

ENABLE

Enables normalization on a waveform to transform the waveform data so that its maximum is 1.00 and its minimum is -1.00

DISABLE

Disables normalization on the waveform.

Note

You can not set nirfsg.Session.write_waveform_normalization and nirfsg.Session.power_level_type properties at the same time.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.WriteWaveformNormalization

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: Arb:Write Waveform Normalization

C Attribute: NIRFSG_ATTR_WRITE_WAVEFORM_NORMALIZATION

yig_main_coil_drive 

nirfsg.Session.yig_main_coil_drive

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

Default Value: MANUAL

Supported Devices: PXIe-5653

Defined Values:

Value

Description

NIRFSG_VAL_SLOW

Adjusts the YIG main coil for an underdamped response.

FAST

Adjusts the YIG main coil for an overdamped response.

Note

Setting this property to FAST on the PXIe-5653 allows the frequency to settle significantly faster for some frequency transitions at the expense of increased phase noise.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic

Value

Datatype

enums.YigMainCoilDrive

Permissions

read-write

Repeated Capabilities

None

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

LabVIEW Property: RF:Advanced:YIG Main Coil Drive

C Attribute: NIRFSG_ATTR_YIG_MAIN_COIL_DRIVE

NI-TClk Support 

nirfsg.Session.tclk

This is used to get and set NI-TClk attributes on the session.

See also

See nitclk.SessionReference for a complete list of attributes.

Property	Default
range_check	True
query_instrument_status	False
cache	True
simulate	False
record_value_coersions	False
driver_setup	{}