Company Events Academic Community Support Solutions Products & Services Contact NI MyNI

RFmxInstr Initialize NIRFSA (VI)

NI-RFmx SpecAn 2.3 Help

Edition Date: May 2017

Part Number: 374264G-01

»View Product Info
Download Help (Windows Only)
Owning Palette: RFmxInstr VIs

Creates an NI-RFmx session to the NI-RFSA supported device you specify through the Resource Name parameter, and returns an Instrument Handle Out that identifies the device in all subsequent RFmx VIs.

RFmxInstr Initialize NIRFSA


Resource Name specifies the resource name of the device to initialize.

The following table shows examples of how to specify the resource name.

Example # Device Type Syntax
1 myRFmxDevice NI-RFmx device, device name is "myRFmxDevice"
2 myLogicalName IVI logical name or virtual instrument, name is "myLogicalName"

For NI-DAQmx devices, the syntax is the device name specified in MAX, as shown in Example 1. Typical default names for NI-DAQmx devices in MAX are Dev1 or PXI1Slot2. You can rename an NI-DAQmx device by right-clicking the name in MAX, selecting Rename from the pull-down menu, and entering a new name. You can also pass the name of an IVI logical name configured with the IVI Configuration utility. For additional information about IVI, refer to the IVI section of the Measurement & Automation Explorer Help.


Option String sets the initial value of certain properties for the session.

The following properties are used in this parameter:

  • RFmxSetup
  • Simulate
  • AnalysisOnly

For more information about properties used in this parameter, refer to NI RF Vector Signal Analyzers Help.

The format of this string is "PropertyName=Value", where PropertyName is the name of the property and Value is the value to which the property is set. For example, you can simulate an NI 5663E using either of the following strings:

"Simulate=1, RFmxSetup=Model:5663E"

"Simulate=1, RFmxSetup=Model:5601; Digitizer:5622; LO:5652; LOBoardType:PXIe"

To set multiple properties, separate their assignments with a comma.

To use FPGA extensions, specify the custom LabVIEW FPGA bitfile to use with the bitfile specifier within the RFmxSetup string. For example, "RFmxSetup=bitfile:yourbitfile.lvbitx" specified that RFmx use yourbitfile.lvbitx as the LabVIEW FPGA bitfile for the session.

To use AnalysisOnly mode, specify the string as "AnalysisOnly=1". While using this mode, you are responsible for waveform acquisition and the NI-RFmx driver will perform analysis on the I/Q waveform or Spectrum you specify. You must use personality specific Analyze functions to perform the measurements.

Note  To simulate a device using the NI 5622 (25 MHz) digitizer, set the Digitizer field to 5622_25MHz_DDC and the Simulate field to 1. You can set the Digitizer field to 5622_25MHz_DDC only when using the NI 5665.

To use external NI Source Measure Units (SMU) as the noise source power supply for the Noise Figure (NF) measurement, use "NoiseSourcePowerSupply" as the specifier within the RFmxSetup string. For example, "RFmxSetup= NoiseSourcePowerSupply:myDCPower[0]" configures NI-RFmx to use channel 0 on myDCPower SMU device for powering the noise source. You should allocate a dedicated SMU channel for NI-RFmx.

Note  NI-RFmx supports NI PXIe-4138 and NI PXIe-4139 SMUs.

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


Instrument Handle Out passes a reference of the instrument session to the next VI.


Created New? is TRUE if the VI created a new session, or FALSE if the VI returned a reference to an existing session.


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


Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit