ni-rfsg-lv-api-ref-doc

Table of Contents

Utility

  • Updated2024-05-08
  • 5 minute(s) read

Utility

Owning Palette: NI-RFSG VI Reference

Use the utility VIs to access additional features of the NI-RFSG instrument driver.

Palette Object Description
niRFSG Initialize With Options

Opens a session to the device you specify as the resource name and returns an instrument handle that you use to identify the instrument in all subsequent NI-RFSG VIs. This VI also configures the device using the 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

niRFSG Commit

Programs the device with the correct settings. Calling this VI moves the NI-RFSG device from the Configuration state to the Committed state. After this VI 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

niRFSG Wait Until Settled

Waits until the RF output signal settles. This VI is useful for devices that support changes while in the Generation state. Call this VI after making a dynamic change to wait for the output signal to settle. You can also call this VI after calling the niRFSG Commit VI to wait for changes to settle. The niRFSG Wait Until Settled VI is not required after calling the niRFSG Initiate VI because the niRFSG Initiate VI 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

niRFSG Configure Output Enabled

Enables or disables signal output. Setting output enabled to FALSE while in the Generation state attenuates the generated signal so that no signal is output.

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

niRFSG Self Test

Performs a self-test on the NI-RFSG device and returns the test results. This VI performs a simple series of tests to determine whether the NI-RFSG device is powered up and responding. This VI does not affect external I/O connections or connections between devices. Complete functional testing and calibration are not performed by this VI. The NI-RFSG device must be in the Configuration state before you call this VI.

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

niRFSG Reset

Resets all properties to their default values and moves the NI-RFSG device to the Configuration state. This VI aborts the signal generation, clears all routes, deletes all de-embedding tables, 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.

Note  This VI resets all configured routes for the PXIe-5644/5645/5646 and PXIe-5820/5830/5831/5832/5840/5841/5842 in NI-RFSA and NI-RFSG. To avoid resetting routes on the device that are in use by NI-RFSA sessions, NI recommends using the niRFSG Reset With Options VI with the steps to omit parameter 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

niRFSG Reset With Options

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

To avoid resetting routes on PXIe-5820/5830/5831/5832/5840/5841/5842 that are in use by NI-RFSA sessions, NI recommends using this VI instead of the niRFSG Reset VI, with the steps to omit parameter set to Routes.

niRFSG 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.

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

niRFSG Save Configurations To File

Saves the configurations of the session to the specified file.

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

niRFSG Load Configurations From File

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

niRFSG Perform Power Search

Performs a power search if the ALC Control property is disabled. Calling this VI disables modulation for a short time while the device levels the output signal.

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

Supported Devices:PXIe-5654 with PXIe-5696

niRFSG Get Session Reference

Extracts a session that can be passed to NI-TClk VIs. Session References are of generic data type, which means that the corresponding wires are blue-green, unlike the wires for regular instrument driver sessions.

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

Note  NI-RFSG does not support NI-TClk when driver session debugging is enabled.
niRFSG Revision Query

Returns the revision numbers of the NI-RFSG driver and the instrument firmware.

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

niRFSG Query Arb Waveform Capabilities

Queries and returns the arbitrary 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 Generation state before you call this VI.

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

niRFSG Perform Thermal Correction

Corrects for any signal drift due to 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 VI. Use this VI when generating the same signal for a long period of time in a temperature-fluctuating environment. The NI-RFSG device must be in the Generation state before you call this VI.

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

niRFSG Error Message

Converts an error code returned by an NI-RFSG VI 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



Log in to get a better experience