diff --git a/docs/nirfsg/class.rst b/docs/nirfsg/class.rst index 0400287c1..66f22baa2 100644 --- a/docs/nirfsg/class.rst +++ b/docs/nirfsg/class.rst @@ -9,13 +9,13 @@ Session Opens a session to the device you specify as the :py:attr:`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 :py:attr:`nirfsg.Session.OPTION_STRING` input. + This method also configures the device through the :py:attr:`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 + **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** + **Related Topics** - `Simulating an NI RF Signal Generator `_ + `Simulating an NI RF Signal Generator `_ @@ -30,9 +30,9 @@ Session 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. + 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. + 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. @@ -80,7 +80,7 @@ Session Specifies whether you want NI-RFSG to perform an ID query. - **Defined Values** : + **Defined Values** : +-----------+--------------------------+ | Value | Description | @@ -98,7 +98,7 @@ Session Specifies whether you want to reset the NI-RFSG device during the initialization procedure. - **Defined Values** : + **Defined Values** : +-----------+----------------------+ | Value | Description | @@ -124,11 +124,11 @@ 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 + **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** + **Related Topics** - `NI-RFSG Programming State Model `_ + `NI-RFSG Programming State Model `_ @@ -143,15 +143,15 @@ allocate_arb_waveform 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 :py:meth:`nirfsg.Session.WriteArbWaveform` method multiple times to write a large waveform in smaller blocks. + Use this method to specify the total size of a waveform before writing the data. Use this method only if you are calling the :py:meth:`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. + 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 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Streaming Waveform Data `_ + `Streaming Waveform Data `_ @@ -185,7 +185,7 @@ change_external_calibration_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 + **Supported Devices:** PXIe-5611, PXIe-5653/5654, PXIe-5673/5673E, PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -472,15 +472,15 @@ 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. + 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 + **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** + **Related Topics** - `NI-RFSG Instrument Driver Programming Flow `_ + `NI-RFSG Instrument Driver Programming Flow `_ - `Stopping Pear-to-Peer Generation `_ + `Stopping Pear-to-Peer Generation `_ @@ -492,7 +492,7 @@ check_generation_status Returns information about the completion of signal generation. - **Defined Values** : + **Defined Values** : +-------+---------------------------------+ | Value | Description | @@ -513,7 +513,7 @@ check_if_script_exists Returns whether the script that you specify as :py:attr:`nirfsg.Session.SCRIPT_NAME` exists. - **Supported Devices** : PXIe-5673/5673E. PXIe-5830/5831/5840/5841/5842/5860 + **Supported Devices** : PXIe-5673/5673E. PXIe-5830/5831/5840/5841/5842/5860 @@ -537,7 +537,7 @@ check_if_script_exists Returns True if the script exists. - **Defined Values** : + **Defined Values** : +-------+----------------------------+ | Value | Description | @@ -558,7 +558,7 @@ check_if_waveform_exists Returns whether the waveform that you specify as :py:attr:`nirfsg.Session.WAVEFORM_NAME` exists. - **Supported Devices** : PXIe-5673/5673E, PXIe-5830/5831/5840/5841/5842/5860 + **Supported Devices** : PXIe-5673/5673E, PXIe-5830/5831/5840/5841/5842/5860 @@ -582,7 +582,7 @@ check_if_waveform_exists Returns True if the waveform exists. - **Defined Values** : + **Defined Values** : +-------+------------------------------+ | Value | Description | @@ -603,9 +603,9 @@ 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. + 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 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -620,9 +620,9 @@ clear_arb_waveform 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. + 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 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -647,11 +647,11 @@ clear_error Clears the error information associated with the session. - If you pass VI_NULL for the :py:attr:`nirfsg.Session.VI` parameter, this method clears the error information for the current execution thread. + If you pass VI_NULL for the :py:attr:`nirfsg.Session.VI` parameter, this method clears the error information for the current execution thread. - The IVI Engine also maintains this error information separately for each thread. This feature of the IVI Engine is useful if you do not have a session handle to pass to the :py:meth:`nirfsg.Session.clear_error` method or the :py:meth:`nirfsg.Session.get_error` method, which occurs when a call to the :py:meth:`nirfsg.Session.Init` method or the :py:meth:`nirfsg.Session.__init__` method fails. + The IVI Engine also maintains this error information separately for each thread. This feature of the IVI Engine is useful if you do not have a session handle to pass to the :py:meth:`nirfsg.Session.clear_error` method or the :py:meth:`nirfsg.Session.get_error` method, which occurs when a call to the :py:meth:`nirfsg.Session.Init` method or the :py:meth:`nirfsg.Session.__init__` method fails. - **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 + **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 @@ -670,7 +670,7 @@ clear_self_calibrate_range Clears the data obtained from the :py:meth:`nirfsg.Session.self_calibrate_range` method. - **Supported Devices** : PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices** : PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842 @@ -685,13 +685,13 @@ 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 + **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** + **Related Topics** - `NI-RFSG Instrument Driver Programming Flow `_ + `NI-RFSG Instrument Driver Programming Flow `_ - `NI-RFSG Programming State Model `_ + `NI-RFSG Programming State Model `_ @@ -708,13 +708,13 @@ 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. + 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 + **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** + **Related Topics** - `NI-RFSG Programming State Model `_ + `NI-RFSG Programming State Model `_ @@ -729,9 +729,9 @@ configure_deembedding_table_interpolation_linear 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. + 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 + **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860 @@ -782,9 +782,9 @@ configure_deembedding_table_interpolation_nearest Selects the nearest interpolation method. - NI-RFSG uses the parameters of the table nearest to the carrier frequency for de-embedding. + 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 + **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860 @@ -818,9 +818,9 @@ configure_deembedding_table_interpolation_spline 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. + 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 + **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860 @@ -852,19 +852,17 @@ configure_digital_edge_script_trigger .. py:method:: configure_digital_edge_script_trigger(trigger_id, source, edge) - Purpose - - Configures the specified Script Trigger for digital edge triggering. + Configures the specified Script Trigger for digital edge triggering. - The NI-RFSG device must be in the Configuration state before calling this method. + 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 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Script Trigger `_ + `Script Trigger `_ - `Digital Edge Trigger `_ + `Digital Edge Trigger `_ @@ -907,15 +905,15 @@ configure_digital_edge_start_trigger Configures the Start Trigger for digital edge triggering. - The NI-RFSG device must be in the Configuration state before calling this method. + 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 + **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** + **Related Topics** - `Start Trigger `_ + `Start Trigger `_ - `Digital Edge Trigger `_ + `Digital Edge Trigger `_ @@ -951,15 +949,15 @@ configure_digital_level_script_trigger Configures a specified Script Trigger for digital level triggering. - The NI-RFSG device must be in the Configuration state before calling this method. + 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 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Script Trigger `_ + `Script Trigger `_ - `Digital Level Trigger `_ + `Digital Level Trigger `_ @@ -1002,7 +1000,7 @@ configure_digital_modulation_user_defined_waveform Specifies the message signal used for digital modulation when the :py:attr:`nirfsg.Session.digital_modulation_waveform_type` property is set to :py:data:`~nirfsg.NIRFSG_VAL_USER_DEFINED`. - **Supported Devices** : PXI/PXIe-5650/5651/5652 + **Supported Devices** : PXI/PXIe-5650/5651/5652 @@ -1038,15 +1036,15 @@ configure_generation_mode Configures the NI-RFSG device to generate a continuous sine tone (CW), apply I/Q (vector) modulation to the RF output signal, or generate arbitrary waveforms according to scripts. - The NI-RFSG device must be in the Configuration state before you call this method. + The NI-RFSG device must be in the Configuration state before you call this method. - **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 + **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** + **Related Topics** - `Assigning Properties or Properties to a Waveform `_ + `Assigning Properties or Properties to a Waveform `_ - `Scripting Instructions `_--Refer to this topic for more information about VST restrictions on scripts. + `Scripting Instructions `_--Refer to this topic for more information about VST restrictions on scripts. @@ -1087,17 +1085,17 @@ configure_output_enabled Enables or disables signal output. - Setting :py:attr:`nirfsg.Session.output_enabled` to False while in the Generation state attenuates the generated signal so that no signal is output. + Setting :py:attr:`nirfsg.Session.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/5860 + **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** + **Related Topics** - `Output Enabled `_ + `Output Enabled `_ - `NI-RFSG Instrument Driver Programming Flow `_ + `NI-RFSG Instrument Driver Programming Flow `_ - `RF List Mode `_ + `RF List Mode `_ @@ -1122,13 +1120,13 @@ configure_p2p_endpoint_fullness_start_trigger Configures the Start Trigger to detect peer-to-peer endpoint fullness. - Generation begins when the number of samples in the peer-to-peer endpoint reaches the threshold specified by the :py:attr:`nirfsg.Session.P2P_ENDPOINT_FULLNESS_LEVEL` parameter. The NI-RFSG device must be in the Configuration state before calling this method. + Generation begins when the number of samples in the peer-to-peer endpoint reaches the threshold specified by the :py:attr:`nirfsg.Session.P2P_ENDPOINT_FULLNESS_LEVEL` parameter. The NI-RFSG device must be in the Configuration state before calling this method. - **Supported Devices** : PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices** : PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Start Trigger `_ + `Start Trigger `_ @@ -1157,15 +1155,15 @@ configure_power_level_type Specifies the way the driver interprets the :py:attr:`nirfsg.Session.power_level` property. - In average power mode, NI-RFSG automatically scales waveform data to use the maximum dynamic range. In peak power mode, waveforms are scaled according to the :py:attr:`nirfsg.Session.arb_waveform_software_scaling_factor` property. + In average power mode, NI-RFSG automatically scales waveform data to use the maximum dynamic range. In peak power mode, waveforms are scaled according to the :py:attr:`nirfsg.Session.arb_waveform_software_scaling_factor` property. - **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Spurious Performance `_ + `Spurious Performance `_ - `Optimizing for Low Power Generation `_ + `Optimizing for Low Power Generation `_ @@ -1196,15 +1194,15 @@ configure_pxi_chassis_clk10 Specifies the signal to drive the 10MHz Reference Clock on the PXI backplane. - This option can only be configured when the PXI-5610 is in Slot 2 of the PXI chassis. The NI-RFSG device must be in the Configuration state before you call this method. + This option can only be configured when the PXI-5610 is in Slot 2 of the PXI chassis. The NI-RFSG device must be in the Configuration state before you call this method. - **Supported Devices** : PXI-5610, PXI-5670/5671 + **Supported Devices** : PXI-5610, PXI-5670/5671 - **Related Topics** + **Related Topics** - `Timing Configurations `_ + `Timing Configurations `_ - `System Reference Clock `_ + `System Reference Clock `_ @@ -1229,21 +1227,21 @@ configure_ref_clock 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. + 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 + **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** + **Related Topics** - `PXIe-5672 Timing Configurations `_ + `PXIe-5672 Timing Configurations `_ - `PXIe-5673 Timing Configurations `_ + `PXIe-5673 Timing Configurations `_ - `PXIe-5673E Timing Configurations `_ + `PXIe-5673E Timing Configurations `_ - `PXIe-5830 Timing Configurations `_ + `PXIe-5830 Timing Configurations `_ - `PXIe-5831 Timing Configurations `_ + `PXIe-5831 Timing Configurations `_ @@ -1254,30 +1252,28 @@ configure_ref_clock Specifies the source of Reference Clock signal. - +-----------------------------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Reference Clock Constant | Value | Description | - +===========================================================+===============+=================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | :py:data:`~nirfsg.NIRFSG_VAL_ONBOARD_CLOCK_STR` (default) | 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. | - +-----------------------------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.NIRFSG_VAL_REF_IN_STR` | 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. | - +-----------------------------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.NIRFSG_VAL_PXI_CLK_STR` | PXI_CLK | Uses the PXI_CLK signal, which is present on the PXI backplane, as the clock source. | - +-----------------------------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.NIRFSG_VAL_CLK_IN_STR` | 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. | - +-----------------------------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.NIRFSG_VAL_REF_IN_2_STR` | RefIn2 | \- | - +-----------------------------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.NIRFSG_VAL_PXI_CLK_MASTER_STR` | 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. | - +-----------------------------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. 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. + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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. | + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ :type ref_clock_source: str :param ref_clock_rate: - Specifies the Reference Clock rate, in hertz (Hz), of the signal present at the REF IN or CLK IN connector. The default value is :py:data:`~nirfsg.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 :py:attr:`nirfsg.Session.ref_clock_source` parameter is set to :py:data:`~nirfsg.NIRFSG_VAL_CLK_IN_STR`, :py:data:`~nirfsg.NIRFSG_VAL_REF_IN_STR` or :py:data:`~nirfsg.NIRFSG_VAL_REF_IN_2_STR`. Refer to the :py:attr:`nirfsg.Session.ref_clock_rate` property for possible values. + Specifies the Reference Clock rate, in hertz (Hz), of the signal present at the REF IN or CLK IN connector. The default value is :py:data:`~nirfsg.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 :py:attr:`nirfsg.Session.ref_clock_source` parameter is set to ClkIn, RefIn or RefIn2. Refer to the :py:attr:`nirfsg.Session.ref_clock_rate` property for possible values. @@ -1295,13 +1291,13 @@ configure_rf 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. + 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 + **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** + **Related Topics** - `NI-RFSG Instrument Driver Programming Flow `_ + `NI-RFSG Instrument Driver Programming Flow `_ @@ -1312,7 +1308,7 @@ configure_rf 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) + **Units** : hertz (Hz) @@ -1323,7 +1319,7 @@ configure_rf Specifies either the average power level or peak power level of the generated RF signal, depending on the :py:attr:`nirfsg.Session.power_level_type` property. - **Units** : dBm + **Units** : dBm @@ -1339,11 +1335,11 @@ configure_signal_bandwidth Configures the signal bandwidth of the arbitrary waveform. - The NI-RFSG device must be in the Configuration state before you call this method. + The NI-RFSG device must be in the Configuration state before you call this method. - NI-RFSG defines *signal bandwidth* as twice the maximum baseband signal deviation from 0 Hz. Usually, the baseband signal center frequency is 0Hz. In such cases, the signal bandwidth is simply the baseband signal minimum frequency subtracted from its maximum frequency, or *f* max minus *f* min. NI-RFSG uses this value to optimally configure the center frequency of the upconverter to help minimize phase noise. The generated signal is not filtered to achieve the set bandwidth. However, specifying a bandwidth smaller than the actual bandwidth of the signal could potentially result in spectral distortion. + NI-RFSG defines *signal bandwidth* as twice the maximum baseband signal deviation from 0 Hz. Usually, the baseband signal center frequency is 0Hz. In such cases, the signal bandwidth is simply the baseband signal minimum frequency subtracted from its maximum frequency, or *f* max minus *f* min. NI-RFSG uses this value to optimally configure the center frequency of the upconverter to help minimize phase noise. The generated signal is not filtered to achieve the set bandwidth. However, specifying a bandwidth smaller than the actual bandwidth of the signal could potentially result in spectral distortion. - **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -1370,15 +1366,15 @@ configure_software_script_trigger Configures the Script Trigger for software triggering. - Refer to the :py:meth:`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. + Refer to the :py:meth:`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 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Script Trigger `_ + `Script Trigger `_ - `Trigger Types `_ + `Trigger Types `_ @@ -1403,17 +1399,15 @@ configure_software_start_trigger Configures the Start Trigger for software triggering. - Refer to the :py:meth:`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. + Refer to the :py:meth:`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 + **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 `_ - **Related Topics** - - `Start Trigger `_ - - `Trigger Types `_ + `Trigger Types `_ @@ -1428,15 +1422,15 @@ create_deembedding_sparameter_table_s2p_file 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. + 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 + **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `De-embedding Overview `_ + `De-embedding Overview `_ - `S-parameters `_ + `S-parameters `_ @@ -1494,7 +1488,7 @@ delete_all_deembedding_tables Deletes all configured de-embedding tables for the session. - **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860 + **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860 @@ -1509,7 +1503,7 @@ delete_deembedding_table Deletes the selected de-embedding table for a given port. - **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860 + **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860 @@ -1543,7 +1537,7 @@ disable Places the instrument in a quiescent state where it has minimal or no impact on the system to which it is connected. - **Supported Devices** : PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXI-5670/5671, PXIe-5672/5673/5673E + **Supported Devices** : PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXI-5670/5671, PXIe-5672/5673/5673E @@ -1558,13 +1552,13 @@ 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. + 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 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Script Trigger `_ + `Script Trigger `_ @@ -1589,13 +1583,13 @@ 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. + 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 + **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** + **Related Topics** - `Start Trigger `_ + `Start Trigger `_ @@ -1686,21 +1680,21 @@ export_signal Routes signals (triggers, clocks, and events) to a specified output terminal. - The NI-RFSG device must be in the Configuration state before you call this method. + The NI-RFSG device must be in the Configuration state before you call this method. - You can clear a previously routed signal by exporting the signal to "" (empty string). + You can clear a previously routed signal by exporting the signal to "" (empty string). - **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 + **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** + **Related Topics** - `Triggers `_ + `Triggers `_ - `Events `_ + `Events `_ - `PFI Lines `_ + `PFI Lines `_ - `PXI Trigger Lines `_ + `PXI Trigger Lines `_ @@ -1709,7 +1703,9 @@ export_signal :param signal: - Specifies the type of signal to route. **Defined Values** : + Specifies the type of signal to route. + + **Defined Values** : +-----------------------------------------------------------+---------+--------------------------------------------+ | Name | Value | Description | @@ -1738,27 +1734,29 @@ export_signal :param signal_identifier: - Specifies which instance of the selected signal to export. This parameter is useful when you set the :py:attr:`nirfsg.Session.SIGNAL` parameter to :py:data:`~nirfsg.NIRFSG_VAL_SCRIPT_TRIGGER` or :py:data:`~nirfsg.NIRFSG_VAL_MARKER_EVENT`. Otherwise, set the :py:attr:`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. | - +----------------+-----------------------------+ + Specifies which instance of the selected signal to export. This parameter is useful when you set the :py:attr:`nirfsg.Session.SIGNAL` parameter to :py:data:`~nirfsg.NIRFSG_VAL_SCRIPT_TRIGGER` or :py:data:`~nirfsg.Signal.MARKER_EVENT`. Otherwise, set the :py:attr:`nirfsg.Session.SIGNAL_IDENTIFIER` parameter to "". + + **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. @@ -1769,18 +1767,20 @@ export_signal :param output_terminal: - Specifies the terminal where the signal is exported. You can choose not to export any signal. For the PXIe-5841 with PXIe-5655, the signal is exported to the terminal on the PXIe-5841. **Possible Values** : + Specifies the terminal where the signal is exported. You can choose not to export any signal. For the PXIe-5841 with PXIe-5655, the signal is exported to the terminal on the PXIe-5841. + + **Possible Values** : +----------------+--------------------------------------------------------------------------------------------+ | Possible Value | Description | +================+============================================================================================+ - | ClkOut | Exports the Reference Clock signal to the CLK OUT connector of the device. | + | "ClkOut" | Exports the Reference Clock signal to the CLK OUT connector of the device. | +----------------+--------------------------------------------------------------------------------------------+ - | | The Reference Clock signal is not exported. | + | "" | The Reference Clock signal is not exported. | +----------------+--------------------------------------------------------------------------------------------+ - | RefOut | Exports the Reference Clock signal to the REF OUT connector of the device. | + | "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. | + | "RefOut2" | Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable. | +----------------+--------------------------------------------------------------------------------------------+ @@ -1795,7 +1795,7 @@ get_all_named_waveform_names Return names of the waveforms present in the memory. - **Supported Devices** :PXIe-5830/5831/5840/5841/5842E + **Supported Devices** :PXIe-5830/5831/5840/5841/5842E @@ -1818,7 +1818,7 @@ get_all_named_waveform_names Fetch the number of bytes needed to pass in the :py:attr:`nirfsg.Session.BUFFER_SIZE` parameter. - It can be fetch by passing VI_NULL in the :py:attr:`nirfsg.Session.WAVEFORM_NAMES` parameter. + It can be fetch by passing VI_NULL in the :py:attr:`nirfsg.Session.WAVEFORM_NAMES` parameter. @@ -1835,7 +1835,7 @@ get_all_script_names Return names of the scripts present in the memory. - **Supported Devices** :PXIe-5830/5831/5840/5841/5842E + **Supported Devices** :PXIe-5830/5831/5840/5841/5842E @@ -1858,7 +1858,7 @@ get_all_script_names Fetch the number of bytes needed to pass in the :py:attr:`nirfsg.Session.BUFFER_SIZE` parameter. - It can be fetch by passing VI_NULL in the :py:attr:`nirfsg.Session.SCRIPT_NAMES` parameter. + It can be fetch by passing VI_NULL in the :py:attr:`nirfsg.Session.SCRIPT_NAMES` parameter. @@ -1875,7 +1875,7 @@ get_channel_name Returns the channel string that is in the channel table at an index you specify. - **Supported Devices** : PXI-5670/5671, PXIe-5672/5673/5673E + **Supported Devices** : PXI-5670/5671, PXIe-5672/5673/5673E @@ -1910,7 +1910,7 @@ 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 + **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 @@ -1937,7 +1937,7 @@ get_error Returns the :py:attr:`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 :py:attr:`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. + 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 :py:attr:`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. @@ -1975,7 +1975,7 @@ 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 + **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860 @@ -2021,7 +2021,7 @@ get_self_calibration_temperature 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 + **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 @@ -2066,13 +2066,13 @@ get_stream_endpoint_handle Returns a reader endpoint handle that can be used with NI-P2P to configure a peer-to-peer stream with an RF signal generator endpoint. - **Supported Devices** : PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices** : PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Configuring a Peer-to-Peer Stream `_ + `Configuring a Peer-to-Peer Stream `_ - `Configuring Flow Control `_ + `Configuring Flow Control `_ @@ -2107,17 +2107,17 @@ get_terminal_name Returns the fully-qualified name of the specified signal. - The fully-qualified name is helpful to automatically route signals in a multisegment chassis. + 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 + **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** + **Related Topics** - `Triggers `_ + `Triggers `_ - `Events `_ + `Events `_ - `Syntax for Terminal Names `_ + `Syntax for Terminal Names `_ @@ -2155,27 +2155,27 @@ get_terminal_name :param signal_identifier: - Specifies which instance of the selected signal to query. This parameter is necessary when you set the :py:attr:`nirfsg.Session.SIGNAL` parameter to :py:data:`~nirfsg.NIRFSG_VAL_SCRIPT_TRIGGER` or :py:data:`~nirfsg.NIRFSG_VAL_MARKER_EVENT` . Otherwise, set the :py:attr:`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. | - +----------------+-----------------------------+ + Specifies which instance of the selected signal to query. This parameter is necessary when you set the :py:attr:`nirfsg.Session.SIGNAL` parameter to :py:data:`~nirfsg.NIRFSG_VAL_SCRIPT_TRIGGER` or :py:data:`~nirfsg.Signal.MARKER_EVENT` . Otherwise, set the :py:attr:`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. @@ -2381,13 +2381,13 @@ 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 :py:meth:`nirfsg.Session.abort` method. + 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 :py:meth:`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 + **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** + **Related Topics** - `NI-RFSG Instrument Driver Programming Flow `_ + `NI-RFSG Instrument Driver Programming Flow `_ @@ -2404,9 +2404,9 @@ 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. + The VI does an implicit reset before loading the configurations from the file. - **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -2489,13 +2489,13 @@ perform_power_search Performs a power search if the :py:attr:`nirfsg.Session.alc_control` property is disabled. - Calling this method disables modulation for a short time while the device levels the output signal. + Calling this method disables modulation for a short time while the device levels the output signal. - **Supported Devices** : PXIe-5654 with PXIe-5696 + **Supported Devices** : PXIe-5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Power Search `_ + `Power Search `_ @@ -2512,17 +2512,17 @@ 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. + 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. + 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 + **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** + **Related Topics** - `Thermal Management `_ + `Thermal Management `_ - `Impairment Calibration `_ + `Impairment Calibration `_ @@ -2537,9 +2537,9 @@ 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. + 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 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -2591,22 +2591,22 @@ read_and_download_waveform_from_file_tdms 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: + 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 + - 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. + 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 + **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842 @@ -2617,9 +2617,9 @@ read_and_download_waveform_from_file_tdms Specifies the name used to store the waveform. This string is case-insensitive. - Example: + Example: - "waveform::waveform0" + "waveform::waveform0" @@ -2653,13 +2653,13 @@ 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. + 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 :py:meth:`nirfsg.Session.reset_device` method is acceptable. The :py:meth:`nirfsg.Session.reset` method executes faster than the :py:meth:`nirfsg.Session.reset_device` method. + Generally, calling this method instead of the :py:meth:`nirfsg.Session.reset_device` method is acceptable. The :py:meth:`nirfsg.Session.reset` method executes faster than the :py:meth:`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 :py:meth:`nirfsg.Session.ResetWithOptions` method, with **stepsToOmit** set to :py:data:`~nirfsg.ResetWithOptionsStepsToOmit.ROUTES` . + 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 :py:meth:`nirfsg.Session.ResetWithOptions` method, with **stepsToOmit** set to :py:data:`~nirfsg.ResetWithOptionsStepsToOmit.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 + **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 @@ -2676,7 +2676,7 @@ reset_attribute Resets the property to its default 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 + **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 @@ -2711,22 +2711,22 @@ 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. + - 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. + 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. + - 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 + **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** + **Related Topics** - `Thermal Shutdown `_ + `Thermal Shutdown `_ @@ -2743,7 +2743,7 @@ 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 + **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 @@ -2758,7 +2758,7 @@ 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/5860 + **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 @@ -2773,7 +2773,7 @@ revision_query Returns the value of the :py:attr:`nirfsg.Session.specific_driver_revision` property in the form of a string. - You must pass a ViChar array with at least 256 bytes. + You must pass a ViChar array with at least 256 bytes. @@ -2783,7 +2783,7 @@ revision_query Returns the value of the :py:attr:`nirfsg.Session.instrument_firmware_revision` property in the form of a string. - You must pass a ViChar array with at least 256 bytes. + You must pass a ViChar array with at least 256 bytes. @@ -2798,7 +2798,7 @@ save_configurations_to_file Saves the configurations of the session to the specified file. - **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -2833,13 +2833,13 @@ select_arb_waveform Specifies the waveform that is generated upon a call to the :py:meth:`nirfsg.Session._initiate` method when the **generationMode** parameter of the :py:meth:`nirfsg.Session.configure_generation_mode` method is set to :py:data:`~nirfsg.GenerationMode.ARB_WAVEFORM`. - You must specify a waveform using the :py:attr:`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. + You must specify a waveform using the :py:attr:`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 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Assigning Properties or Properties to a Waveform `_ + `Assigning Properties or Properties to a Waveform `_ @@ -2866,11 +2866,11 @@ 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. + 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. + 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 + **Supported Devices** : PXI-5610, PXIe-5653, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -2887,13 +2887,13 @@ self_calibrate_range 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 :py:meth:`nirfsg.Session.clear_self_calibrate_range` method. + Self-calibration range data is valid until you restart the system or call the :py:meth:`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. + 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. + 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 + **Supported Devices** : PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842 @@ -2910,9 +2910,9 @@ self_calibrate_range 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** : :py:data:`~nirfsg.SelfCalibrateRangeStepsToOmit.OMIT_NONE` + **Default Value** : :py:data:`~nirfsg.SelfCalibrateRangeStepsToOmit.OMIT_NONE` - **Defined Values:** + **Defined Values:** +------------------------------------------------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------+ | Name | Value | Description | @@ -2930,8 +2930,6 @@ self_calibrate_range | :py:data:`~nirfsg.SelfCalibrateRangeStepsToOmit.SYNTHESIZER_ALIGNMENT` | 16 (0x10) | Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted. | +------------------------------------------------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------+ - .. 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. - :type steps_to_omit: :py:data:`nirfsg.SelfCalibrateRangeStepsToOmit` :param min_frequency: @@ -2980,15 +2978,15 @@ 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 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. + 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 + **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** + **Related Topics** - `Device Warm-Up `_ + `Device Warm-Up `_ @@ -2999,7 +2997,7 @@ self_test Returns the self-test response string from the NI-RFSG device. For an explanation of the string contents, refer to the **status** parameter of this method. - You must pass a ViChar array with at least 256 bytes. + You must pass a ViChar array with at least 256 bytes. @@ -3031,13 +3029,13 @@ send_software_edge_trigger Forces a trigger to occur. - The specified trigger generates regardless of whether the trigger has been configured as a software trigger. + 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 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Triggers `_ + `Triggers `_ @@ -3048,9 +3046,9 @@ send_software_edge_trigger Specifies the trigger to send. - **Default Value:** :py:data:`~nirfsg.SoftwareTriggerType.START` + **Default Value:** :py:data:`~nirfsg.SoftwareTriggerType.START` - **Defined Values:** + **Defined Values:** +-----------------------------------------------+---------+-------------------------------+ | Name | Value | Description | @@ -3069,9 +3067,9 @@ send_software_edge_trigger Specifies the Script Trigger to configure. This parameter is valid only when you set the :py:attr:`nirfsg.Session.TRIGGER` parameter to :py:data:`~nirfsg.NIRFSG_VAL_START_TRIGGER`. Otherwise, set the :py:attr:`nirfsg.Session.TRIGGER_IDENTIFIER` parameter to "" (empty string). - **Default Value:** "" (empty string) + **Default Value:** "" (empty string) - **Possible Values:** + **Possible Values:** +----------------+-----------------------------+ | Possible Value | Description | @@ -3103,9 +3101,9 @@ set_arb_waveform_next_write_position Configures the start position to use for writing a waveform before calling the :py:meth:`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 :py:meth:`nirfsg.Session.allocate_arb_waveform` method or the :py:meth:`nirfsg.Session.WriteArbWaveform` method. Subsequent writes to that waveform begin where the last write ended, unless this method is called again. + 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 :py:meth:`nirfsg.Session.allocate_arb_waveform` method or the :py:meth:`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 + **Supported Devices** : PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -3127,7 +3125,7 @@ set_arb_waveform_next_write_position Specifies the reference position in the waveform. The position and :py:attr:`nirfsg.Session.OFFSET` together determine where to start loading data into the waveform. - **Defined Values:** + **Defined Values:** +-------------------------------------------------+---------------+------------------------------------------------------------------+ | Name | Value | Description | @@ -3305,11 +3303,11 @@ wait_until_settled 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. + 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 :py:meth:`nirfsg.Session.commit` method to wait for changes to settle. The :py:meth:`nirfsg.Session.wait_until_settled` method is not required after calling the :py:meth:`nirfsg.Session._initiate` method because the :py:meth:`nirfsg.Session._initiate` automatically waits for the output to settle. + You can also call this method after calling the :py:meth:`nirfsg.Session.commit` method to wait for changes to settle. The :py:meth:`nirfsg.Session.wait_until_settled` method is not required after calling the :py:meth:`nirfsg.Session._initiate` method because the :py:meth:`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 + **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 @@ -3320,7 +3318,7 @@ wait_until_settled 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 + **Default Value** : 10000 @@ -3336,19 +3334,19 @@ write_p2p_endpoint_i16 Writes an array of 16-bit integer data to the peer-to-peer endpoint. - Use this method to write initial data from the host to the endpoint before starting generation to avoid an underflow when you start the generation. + Use this method to write initial data from the host to the endpoint before starting generation to avoid an underflow when you start the generation. - **Supported Devices** : PXIe-5673E + **Supported Devices** : PXIe-5673E - **Related Topics** + **Related Topics** - `Peer-to-Peer Data Streaming `_--Refer to this topic for more information about configuring a stream. + `Peer-to-Peer Data Streaming `_--Refer to this topic for more information about configuring a stream. - `Configuring Flow Control `_ + `Configuring Flow Control `_ - `Starting Peer-to-Peer Generation `_ + `Starting Peer-to-Peer Generation `_ - `Reconfiguring a Stream `_ + `Reconfiguring a Stream `_ @@ -3391,15 +3389,15 @@ write_script Writes a script to the device to control waveform generation in Script mode. - First, configure your device for Script mode by calling the :py:meth:`nirfsg.Session.configure_generation_mode` method. The NI-RFSG device must be in the Configuration state before calling the :py:meth:`nirfsg.Session.write_script` method. + First, configure your device for Script mode by calling the :py:meth:`nirfsg.Session.configure_generation_mode` method. The NI-RFSG device must be in the Configuration state before calling the :py:meth:`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 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Scripting Instructions `_--Refer to this topic for more information about VST restrictions on scripts. + `Scripting Instructions `_--Refer to this topic for more information about VST restrictions on scripts. - `Common Scripting Use Cases `_ + `Common Scripting Use Cases `_ @@ -3428,13 +3426,13 @@ 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. + To set this property, the NI-RFSG device must be in the Configuration state. - **Units:** Seconds + **Units:** Seconds - **Valid Values:** Plus or minus half of one Sample Clock period + **Valid Values:** Plus or minus half of one Sample Clock period - **Supported Devices:** PXIe-5820/5840/5841/5842 + **Supported Devices:** PXIe-5820/5840/5841/5842 @@ -3467,9 +3465,9 @@ ae_temperature Returns the amplitude extender module temperature in degrees Celsius. - **Units**: degrees Celsius (°C) + **Units**: degrees Celsius (°C) - **Supported Devices:** PXIe-5654 with PXIe-5696 + **Supported Devices:** PXIe-5654 with PXIe-5696 The following table lists the characteristics of this property. @@ -3496,27 +3494,27 @@ 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 :py:attr:`nirfsg.Session.alc_control` property also allows for NI-RFSG to perform an automatic power search. + 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 :py:attr:`nirfsg.Session.alc_control` property also allows for NI-RFSG to perform an automatic power search. - PXIe-5654: :py:data:`~nirfsg.AutomaticLevelControl.DISABLE` is the only supported value for this device. The PXIe-5654 does not support the ALC when used as a stand-alone device. + PXIe-5654: :py:data:`~nirfsg.AutomaticLevelControl.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:** + **Default Value:** - PXIe-5654: :py:data:`~nirfsg.AutomaticLevelControl.DISABLE` + PXIe-5654: :py:data:`~nirfsg.AutomaticLevelControl.DISABLE` - PXIe-5654 with PXIe-5696: :py:data:`~nirfsg.AutomaticLevelControl.ENABLE` + PXIe-5654 with PXIe-5696: :py:data:`~nirfsg.AutomaticLevelControl.ENABLE` - **Supported Devices:** PXIe-5654/5654 with PXIe-5696 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Power Level Adjustment `_ + `Power Level Adjustment `_ - `ALC Closed Loop Versus Open Loop `_ + `ALC Closed Loop Versus Open Loop `_ - `Power Search `_ + `Power Search `_ - **Defined Values**: + **Defined Values**: +--------------------------------------------------+---------+------------------+ | Name | Value | Description | @@ -3553,13 +3551,13 @@ 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 :py:attr:`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. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** :py:data:`~nirfsg.AllowOutOfSpecificationUserSettings.DISABLE` + **Default Value:** :py:data:`~nirfsg.AllowOutOfSpecificationUserSettings.DISABLE` - **Supported Devices:** PXI/PXIe-5650/5651/5652, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **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**: + **Defined Values**: +----------------------------------------------------------------+---------+----------------------------------------------+ | Name | Value | Description | @@ -3598,37 +3596,37 @@ 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 :py:meth:`nirfsg.Session._initiate` method or :py:meth:`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. + 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. + PXI/PXIe-5650/5651/5652: This property is for NI internal use only. - **Units**: dB + **Units**: dB - **Default Value:** + **Default Value:** - PXIe-5654: 4 + PXIe-5654: 4 - PXIe-5654 with PXIe-5696 (ALC disabled): 4 + PXIe-5654 with PXIe-5696 (ALC disabled): 4 - PXIe-5654 with PXIe-5696 (ALC enabled): 0.2 + PXIe-5654 with PXIe-5696 (ALC enabled): 0.2 - PXIe-5820/5830/5831/5832/5840/5841/5842/5860: 0.5 + PXIe-5820/5830/5831/5832/5840/5841/5842/5860: 0.5 - **Valid Values:** + **Valid Values:** - PXIe-5654: 1.5, 2, 4 + PXIe-5654: 1.5, 2, 4 - PXIe-5654 with PXIe-5696 (ALC disabled): 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-5654 with PXIe-5696 (ALC enabled): 0.2, 0.5 - PXIe-5820/5830/5831/5832/5840/5841/5842/5860: 0.01 to 1 + 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 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Amplitude Settling Times `_ + `Amplitude Settling Times `_ The following table lists the characteristics of this property. @@ -3655,17 +3653,17 @@ 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. + 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:** :py:data:`~nirfsg.AmpPath.LOW_HARMONIC` + **Default Value:** :py:data:`~nirfsg.AmpPath.LOW_HARMONIC` - **Supported Devices:** PXIe-5654 with PXIe-5696 + **Supported Devices:** PXIe-5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Low Harmonic Path Versus High Power Path `_ + `Low Harmonic Path Versus High Power Path `_ - **Defined Values**: + **Defined Values**: +-----------------------------------------+----------------+-----------------------------------------------------------+ | Name | Value | Description | @@ -3702,17 +3700,17 @@ 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. + 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 + **Default Value:** 100 - **Valid Values:** 0 to 100 + **Valid Values:** 0 to 100 - **Supported Devices:** PXIe-5654/5654 with PXIe-5696 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Amplitude Modulation `_ + `Amplitude Modulation `_ The following table lists the characteristics of this property. @@ -3739,15 +3737,15 @@ 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:** :py:data:`~nirfsg.AnlgModFmBand.WIDEBAND` + **Default Value:** :py:data:`~nirfsg.AnlgModFmBand.WIDEBAND` - **Supported Devices:** PXIe-5654/5654 with PXIe-5696 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Frequency Modulation `_ + `Frequency Modulation `_ - **Defined Values**: + **Defined Values**: +---------------------------------------------+----------------+--------------------------------------------+ | Name | Value | Description | @@ -3782,15 +3780,15 @@ analog_modulation_fm_deviation Specifies the frequency deviation to use in frequency modulation. - **Units**: hertz (Hz) + **Units**: hertz (Hz) - **Default Value:** 1kHz + **Default Value:** 1kHz - **Supported Devices:** PXI/PXIe-5650/5651/5652 + **Supported Devices:** PXI/PXIe-5650/5651/5652 - **Related Topics** + **Related Topics** - `Modulation Schemes `_ + `Modulation Schemes `_ The following table lists the characteristics of this property. @@ -3817,17 +3815,17 @@ 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 :py:attr:`nirfsg.Session.analog_modulation_type` property to :py:data:`~nirfsg.AnlgModType.FM` and the :py:attr:`nirfsg.Session.analog_modulation_fm_band` property to :py:data:`~nirfsg.AnlgModFmBand.NARROWBAND`. + This property is valid only when you set the :py:attr:`nirfsg.Session.analog_modulation_type` property to :py:data:`~nirfsg.AnlgModType.FM` and the :py:attr:`nirfsg.Session.analog_modulation_fm_band` property to :py:data:`~nirfsg.AnlgModFmBand.NARROWBAND`. - **Default Value:** :py:data:`~nirfsg.AnlgModFmNarrowbandIntegrator._100hzto1khz` + **Default Value:** :py:data:`~nirfsg.AnlgModFmNarrowbandIntegrator._100hzto1khz` - **Supported Devices:** PXIe-5654/5654 with PXIe-5696 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Frequency Modulation `_ + `Frequency Modulation `_ - **Defined Values**: + **Defined Values**: +-----------------------------------------------------------------+----------------+---------------------------------------------+ | Name | Value | Description | @@ -3864,15 +3862,15 @@ 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 + **Default Value:** 100 - **Valid Values:** 0 to 100 + **Valid Values:** 0 to 100 - **Supported Devices:** PXIe-5654/5654 with PXIe-5696 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Frequency Modulation `_ + `Frequency Modulation `_ The following table lists the characteristics of this property. @@ -3899,15 +3897,15 @@ analog_modulation_pm_deviation Specifies the `deviation `_ to use in phase modulation, in degrees. - **Units**: degrees (°) + **Units**: degrees (°) - **Default Value:** 90° + **Default Value:** 90° - **Supported Devices:** PXI/PXIe-5650/5651/5652, PXIe-5653 + **Supported Devices:** PXI/PXIe-5650/5651/5652, PXIe-5653 - **Related Topics** + **Related Topics** - `Modulation Schemes `_ + `Modulation Schemes `_ The following table lists the characteristics of this property. @@ -3934,15 +3932,15 @@ analog_modulation_pm_mode Specifies the phase modulation (PM) mode to use. - **Default Value:** :py:data:`~nirfsg.AnlgModPmMode.LOW_PHASE_NOISE` + **Default Value:** :py:data:`~nirfsg.AnlgModPmMode.LOW_PHASE_NOISE` - **Supported Devices:** PXIe-5654/5654 with PXIe-5696 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Phase Modulation `_ + `Phase Modulation `_ - **Defined Values**: + **Defined Values**: +--------------------------------------------------+----------------+-----------------------------------------------------------------------------------------------+ | Name | Value | Description | @@ -3977,15 +3975,15 @@ 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 + **Default Value:** 100 - **Valid Values:** 0 to 100 + **Valid Values:** 0 to 100 - **Supported Devices:** PXIe-5654/5654 with PXIe-5696 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Phase Modulation `_ + `Phase Modulation `_ The following table lists the characteristics of this property. @@ -4012,19 +4010,19 @@ analog_modulation_type Specifies the analog modulation format to use. - **Default Value:** :py:data:`~nirfsg.AnlgModType.NONE` + **Default Value:** :py:data:`~nirfsg.AnlgModType.NONE` - **Supported Devices:** PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696 + **Supported Devices:** PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Modulation `_ + `Modulation `_ - `PXI/PXIe-5650/5651/5652 Modulation Schemes `_ + `PXI/PXIe-5650/5651/5652 Modulation Schemes `_ - `PXIe-5654/5654 with PXIe-5696 Modulation Schemes `_ + `PXIe-5654/5654 with PXIe-5696 Modulation Schemes `_ - **Defined Values**: + **Defined Values**: +-------------------------------------+--------------+--------------------------------------------------+ | Name | Value | Description | @@ -4065,15 +4063,15 @@ analog_modulation_waveform_frequency Specifies the frequency of the waveform to use as the message signal in analog modulation. - **Units:** hertz (Hz) + **Units:** hertz (Hz) - **Default Value:** 1kHz + **Default Value:** 1kHz - **Supported Devices:** PXI/PXIe-5650/5651/5652 + **Supported Devices:** PXI/PXIe-5650/5651/5652 - **Related Topics** + **Related Topics** - `Modulation Schemes `_ + `Modulation Schemes `_ The following table lists the characteristics of this property. @@ -4100,15 +4098,15 @@ analog_modulation_waveform_type Specifies the type of waveform to use as the message signal for analog modulation. - **Default Value:** :py:data:`~nirfsg.AnlgModWfmType.SINE` + **Default Value:** :py:data:`~nirfsg.AnlgModWfmType.SINE` - **Supported Devices:** PXI/PXIe-5650/5651/5652 + **Supported Devices:** PXI/PXIe-5650/5651/5652 - **Related Topics** + **Related Topics** - `Modulation Schemes `_ + `Modulation Schemes `_ - **Defined Values**: + **Defined Values**: +--------------------------------------------+--------------+-----------------------------------------------------------------+ | Name | Value | Description | @@ -4145,12 +4143,12 @@ 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 + **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** + **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: + `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 | @@ -4189,11 +4187,11 @@ 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. + To set this property, the NI-RFSG device must be in the Configuration or Generation state. - **Default Value:** 0 dB + **Default Value:** 0 dB - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 The following table lists the characteristics of this property. @@ -4219,7 +4217,7 @@ arb_filter_raised_cosine_alpha Specifies the alpha value to use when calculating the pulse-shaping filter coefficients. You can use this property only when the :py:attr:`nirfsg.Session.arb_filter_type` property is set to :py:data:`~nirfsg.FilterType.ARB_FILTER_TYPE_RAISED_COSINE` and with signal generators that support onboard signal processing (OSP). NI-RFSG returns an error if you use this property with a device that does not support OSP. - **Supported Devices:** PXI-5671, PXIe-5672/5673/5673E + **Supported Devices:** PXI-5671, PXIe-5672/5673/5673E The following table lists the characteristics of this property. @@ -4246,7 +4244,7 @@ arb_filter_root_raised_cosine_alpha Specifies the alpha value to use when calculating the pulse-shaping FIR filter coefficients. You can use this property only when the :py:attr:`nirfsg.Session.arb_filter_type` property is set to :py:data:`~nirfsg.FilterType.ARB_FILTER_TYPE_ROOT_RAISED_COSINE` and with signal generators that support onboard signal processing (OSP). NI-RFSG returns an error if you use this property with a device that does not support OSP. - **Supported Devices:** PXI-5671, PXIe-5672/5673/5673E + **Supported Devices:** PXI-5671, PXIe-5672/5673/5673E The following table lists the characteristics of this property. @@ -4273,11 +4271,11 @@ arb_filter_type Specifies the pulse-shaping filter type for the FIR filter. You can use this property only with signal generators that support onboard signal processing (OSP). NI-RFSG returns an error if you use this property with a device that does not support OSP. - **Default Value:** :py:data:`~nirfsg.FilterType.NONE` + **Default Value:** :py:data:`~nirfsg.FilterType.NONE` - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - **Defined Values**: + **Defined Values**: +------------------------------------------------------------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Value | Description | @@ -4316,11 +4314,11 @@ 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 + **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**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.query_arb_waveform_capabilities` + - :py:meth:`nirfsg.Session.query_arb_waveform_capabilities` The following table lists the characteristics of this property. @@ -4347,21 +4345,21 @@ 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: :py:data:`~nirfsg.ArbOnboardSampleClockMode.DIVIDE_DOWN` is the only supported value for this device. + PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: :py:data:`~nirfsg.ArbOnboardSampleClockMode.DIVIDE_DOWN` is the only supported value for this device. - **Default Values:** + **Default Values:** - PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: :py:data:`~nirfsg.ArbOnboardSampleClockMode.DIVIDE_DOWN` + PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: :py:data:`~nirfsg.ArbOnboardSampleClockMode.DIVIDE_DOWN` - PXIe-5673/5673E: :py:data:`~nirfsg.ArbOnboardSampleClockMode.HIGH_RESOLUTION` + PXIe-5673/5673E: :py:data:`~nirfsg.ArbOnboardSampleClockMode.HIGH_RESOLUTION` - **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Clocking Modes `_ + `Clocking Modes `_ - **Valid Values**: + **Valid Values**: +--------------------------------------------------------------+--------------------------------------------------------------+ | Name | Description | @@ -4396,17 +4394,13 @@ arb_oscillator_phase_dac_value .. py:attribute:: arb_oscillator_phase_dac_value - Specifies the oscillator phase digital-to-analog converter (DAC) value on the arbitrary waveform generator (AWG). 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 a previous measurement's phase DAC value to the current session. This property is applicable only when using the :py:attr:`nirfsg.Session.arb_sample_clock_source` property set to :py:data:`~nirfsg.NIRFSG_VAL_CLK_IN_STR`. - - **Supported Devices:** PXIe-5673/5673E + Specifies the oscillator phase digital-to-analog converter (DAC) value on the arbitrary waveform generator (AWG). 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 a previous measurement's phase DAC value to the current session. This property is applicable only when using the :py:attr:`nirfsg.Session.arb_sample_clock_source` property set to ClkIn. - **Related Topics** + **Supported Devices:** PXIe-5673/5673E - `NI-TClk Overview `_ + **Related Topics** - - - .. 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. + `NI-TClk Overview `_ The following table lists the characteristics of this property. @@ -4433,9 +4427,9 @@ arb_power Indicates the average output power from the PXI-5421, PXI-5441, PXIe-5442, and PXIe-5450 AWG module. If an arbitrary waveform is being generated, this property specifies either the average power or the peak power of the signal, depending on the :py:attr:`nirfsg.Session.power_level_type` property setting. - **Units**: dBm + **Units**: dBm - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E The following table lists the characteristics of this property. @@ -4462,13 +4456,13 @@ 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 :py:attr:`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. + On the PXI-5671, this property applies only when the :py:attr:`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 + **Units**: dB - **Default Value:** 0dB + **Default Value:** 0dB - **Supported Devices:** PXIe-5644/5645/5646, PXI-5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **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. @@ -4495,9 +4489,9 @@ arb_sample_clock_rate Returns the rate of the Sample Clock on the device. - **Units**: hertz (Hz) + **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 + **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. @@ -4524,28 +4518,26 @@ 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: :py:data:`~nirfsg.NIRFSG_VAL_ONBOARD_CLOCK_STR` is the only supported value for this device. + PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: OnboardClock is the only supported value for this device. - **Default Value:** :py:data:`~nirfsg.NIRFSG_VAL_ONBOARD_CLOCK_STR` + **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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Timing Configurations `_ + `Timing Configurations `_ - **Possible Values**: + **Possible Values**: +----------------+---------------------------------------------------------------+ | Possible Value | Description | +================+===============================================================+ - | ClkIn | Uses the external clock as the Sample Clock source. | + | "ClkIn" | Uses the external clock as the Sample Clock source. | +----------------+---------------------------------------------------------------+ - | OnboardClock | Uses the AWG module onboard clock as the Sample Clock source. | + | "OnboardClock" | Uses the AWG module onboard clock as the Sample Clock 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. - The following table lists the characteristics of this property. +-----------------------+------------+ @@ -4571,17 +4563,17 @@ arb_selected_waveform Specifies the waveform in onboard memory to generate upon calling the :py:meth:`nirfsg.Session.Init` method when the :py:attr:`nirfsg.Session.generation_mode` property is set to :py:data:`~nirfsg.GenerationMode.ARB_WAVEFORM`. The :py:attr:`nirfsg.Session.arb_selected_waveform` property is ignored when the :py:attr:`nirfsg.Session.generation_mode` property is set to :py:data:`~nirfsg.GenerationMode.SCRIPT` or :py:data:`~nirfsg.GenerationMode.CW`. To set the :py:attr:`nirfsg.Session.arb_selected_waveform` property, the NI-RFSG device must be in the Configuration state. - **Default Value:** "" (empty string) + **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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Assigning Properties or Properties to a Waveform `_ + `Assigning Properties or Properties to a Waveform `_ - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.select_arb_waveform` + - :py:meth:`nirfsg.Session.select_arb_waveform` The following table lists the characteristics of this property. @@ -4608,11 +4600,11 @@ 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. + 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) + **Units**: degrees Celsius (°C) - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860 + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860 The following table lists the characteristics of this property. @@ -4639,13 +4631,13 @@ 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 :py:attr:`nirfsg.Session.arb_waveform_size_min` and :py:attr:`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 :py:attr:`nirfsg.Session.iq_rate` property before reading this property. + PXI-5671, PXIe-5672: The value of this property depends on the I/Q rate. Set the :py:attr:`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 + **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**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.query_arb_waveform_capabilities` + - :py:meth:`nirfsg.Session.query_arb_waveform_capabilities` The following table lists the characteristics of this property. @@ -4672,9 +4664,9 @@ arb_waveform_repeat_count Specifies the repeat count of a waveform when you set the :py:attr:`nirfsg.Session.arb_waveform_repeat_count_is_finite` property to True. This property is valid only when you set the :py:attr:`nirfsg.Session.generation_mode` property to :py:data:`~nirfsg.GenerationMode.ARB_WAVEFORM`. To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** 1 + **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 + **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. @@ -4701,11 +4693,11 @@ arb_waveform_repeat_count_is_finite Specifies the repetition mode of a waveform when you set the :py:attr:`nirfsg.Session.generation_mode` property to :py:data:`~nirfsg.GenerationMode.ARB_WAVEFORM`. If you set this property to True, the number of repetitions is determined by the :py:attr:`nirfsg.Session.arb_waveform_repeat_count` property. To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** False + **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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Defined Values**: + **Defined Values**: +-------+-------------------------------------------------------------------+ | Value | Description | @@ -4740,15 +4732,15 @@ 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. + 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 :py:attr:`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. + For the PXI-5671 and PXIe-5672, the value of this property depends on the I/Q rate. Set the :py:attr:`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 + **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**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.query_arb_waveform_capabilities` + - :py:meth:`nirfsg.Session.query_arb_waveform_capabilities` @@ -4779,11 +4771,11 @@ 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 :py:attr:`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 + **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**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.query_arb_waveform_capabilities` + - :py:meth:`nirfsg.Session.query_arb_waveform_capabilities` The following table lists the characteristics of this property. @@ -4810,13 +4802,13 @@ arb_waveform_software_scaling_factor Specifies how much to scale the data before writing it with the :py:meth:`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 :py:attr:`nirfsg.Session.power_level_type` property to :py:data:`~nirfsg.PowerLevelType.PEAK`. - **Default Value:** 1.0 + **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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Spurious Performance `_ + `Spurious Performance `_ The following table lists the characteristics of this property. @@ -4843,26 +4835,25 @@ attenuator_hold_enabled Specifies whether attenuator hold is enabled. While this property is set to True, changing the power level causes NI-RFSG to scale the digital data sent to the AWG instead of adjusting the attenuators. Changing power levels in this manner allows the device to increase or decrease the power level in more accurate increments, but it may affect signal-to-noise ratios (noise density). + Setting the :py:attr:`nirfsg.Session.attenuator_hold_enabled` property to True limits the power levels that can be attained. With attenuator hold enabled, the power level must satisfy the following conditions: - Setting the :py:attr:`nirfsg.Session.attenuator_hold_enabled` property to True limits the power levels that can be attained. With attenuator hold enabled, the power level must satisfy the following conditions: - - - Power level less than or equal to :py:attr:`nirfsg.Session.attenuator_hold_max_power` - - Power level greater than or equal to (maximum power level -70dB) - - Power level greater than or equal to -145dBm + - Power level less than or equal to :py:attr:`nirfsg.Session.attenuator_hold_max_power` + - Power level greater than or equal to (maximum power level -70dB) + - Power level greater than or equal to -145dBm - To set this property, the NI-RFSG device must be in the Configuration state. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** False + **Default Value:** False - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - **Related Topics** + **Related Topics** - `Attenuator Hold `_ + `Attenuator Hold `_ - `Settling Times `_ + `Settling Times `_ - **Defined Values**: + **Defined Values**: +-------+---------------------------+ | Value | Description | @@ -4899,26 +4890,26 @@ attenuator_hold_max_power Specifies the maximum power level of the RF output signal when the :py:attr:`nirfsg.Session.attenuator_hold_enabled` property is set to True. - To set this property, the NI-RFSG device must be in the Configuration state. + To set this property, the NI-RFSG device must be in the Configuration state. - **Units**: dBm + **Units**: dBm - **Defined Values**: - Refer to the specifications document for your device for allowable maximum power levels. + **Defined Values**: + Refer to the specifications document for your device for allowable maximum power levels. - **Default Value:** + **Default Value:** - PXI-5670/5671, PXIe-5672: 17 + PXI-5670/5671, PXIe-5672: 17 - PXIe-5673/5673E: 10 + PXIe-5673/5673E: 10 - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - **Related Topics** + **Related Topics** - `Attenuator Hold `_ + `Attenuator Hold `_ - `Settling Times `_ + `Settling Times `_ The following table lists the characteristics of this property. @@ -4945,11 +4936,11 @@ 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 + **Units**: dB - **Valid Values**: 0dB to 110dB in steps of 10 + **Valid Values**: 0dB to 110dB in steps of 10 - **Supported Devices:** PXIe-5654 with PXIe-5696 + **Supported Devices:** PXIe-5654 with PXIe-5696 @@ -4980,17 +4971,17 @@ 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 :py:meth:`nirfsg.Session.perform_thermal_correction` method to adjust the device for temperature changes. - **Default Value:** :py:data:`~nirfsg.AutomaticThermalCorrection.ENABLE` + **Default Value:** :py:data:`~nirfsg.AutomaticThermalCorrection.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 + **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** + **Related Topics** - `Temperature Monitoring `_ + `Temperature Monitoring `_ - `Settling Times `_ + `Settling Times `_ - **Defined Values**: + **Defined Values**: +-------------------------------------------------------+---------+-------------------------------------------+ | Name | Value | Description | @@ -5027,23 +5018,23 @@ 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 :py:meth:`nirfsg.Session.perform_power_search` method. - This property is ignored when the :py:attr:`nirfsg.Session.alc_control` property is enabled. + This property is ignored when the :py:attr:`nirfsg.Session.alc_control` property is enabled. - PXIe-5654: :py:data:`~nirfsg.AutomaticPowerSearch.DISABLE` is the only supported value for this device. + PXIe-5654: :py:data:`~nirfsg.AutomaticPowerSearch.DISABLE` is the only supported value for this device. - **Default Value:** + **Default Value:** - PXIe-5654: :py:data:`~nirfsg.AutomaticPowerSearch.DISABLE` + PXIe-5654: :py:data:`~nirfsg.AutomaticPowerSearch.DISABLE` - PXIe-5654 with PXIe-5696: :py:data:`~nirfsg.AutomaticPowerSearch.ENABLE` + PXIe-5654 with PXIe-5696: :py:data:`~nirfsg.AutomaticPowerSearch.ENABLE` - **Supported Devices:** PXIe-5654/5654 with PXIe-5696 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Power Search `_ + `Power Search `_ - **Defined Values**: + **Defined Values**: +-------------------------------------------------+---------+----------------------------------+ | Name | Value | Description | @@ -5105,7 +5096,7 @@ available_ports Returns a comma-separated 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 + **Supported Devices**: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 The following table lists the characteristics of this property. @@ -5132,11 +5123,11 @@ cache Specifies whether to cache the value of properties. When caching is enabled, NI-RFSG tracks the current NI-RFSG device settings and avoids sending redundant commands to the device. NI-RFSG can always cache or never cache particular properties, regardless of the setting of this property. Call the :py:meth:`nirfsg.Session.__init__` method to override the default value. - **Default Value:** True + **Default Value:** True - **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 + **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 - **Defined Values**: + **Defined Values**: +-------+-------------------+ | Value | Description | @@ -5171,13 +5162,13 @@ compensate_for_filter_group_delay Enables or disables compensation for filter group delay on the AWG module. This property also accounts for the upconverter group delay and aligns the RF output with the Started Event, Done Event, and Marker Events. - At a low I/Q rate, the group delay can become so large that some devices may not be able to align the events with the RF output, in which case you must increase the I/Q rate or disable this property. + At a low I/Q rate, the group delay can become so large that some devices may not be able to align the events with the RF output, in which case you must increase the I/Q rate or disable this property. - **Default Value:** False + **Default Value:** False - **Supported Devices:** PXIe-5672 + **Supported Devices:** PXIe-5672 - **Defined Values**: + **Defined Values**: +-------+-----------------------------------------------+ | Value | Description | @@ -5212,21 +5203,21 @@ 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 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Default Values**: + **Default Values**: - PXIe-5654/5654 with PXIe-5696: /*ModuleName*/ConfigurationSettledEvent, where *ModuleName* is the name of your device in MAX. + 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-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. + PXIe-5820/5840/5841/5842: /*ModuleName*/ao/0/ConfigurationSettledEvent, where *ModuleName* is the name of your device in MAX. - **Related Topics** + **Related Topics** - `Events `_ + `Events `_ - `Syntax for Terminal Names `_ + `Syntax for Terminal Names `_ The following table lists the characteristics of this property. @@ -5253,11 +5244,11 @@ 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. + PXIe-5820/5830/5831/5832/5840/5841/5842/5860: This property is read only. - **Units**: Degrees Celsius + **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 + **Supported Devices**: PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -5290,11 +5281,11 @@ data_transfer_block_size Indicates the number of samples to transfer at one time from the device to host memory. This property is useful when the total data to be transferred to onboard memory is large. - **Units**: samples (s) + **Units**: samples (s) - **Default Value**: 1Ms + **Default Value**: 1Ms - **Supported Devices:** PXIe-5672/5673/5673E + **Supported Devices:** PXIe-5672/5673/5673E The following table lists the characteristics of this property. @@ -5321,15 +5312,15 @@ data_transfer_maximum_bandwidth Specifies the maximum amount of bus bandwidth to use for data transfers. - **Units**: bytes per second + **Units**: bytes per second - **Default Value**: Device maximum + **Default Value**: Device maximum - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - **Related Topics** + **Related Topics** - `Improving Streaming Performance `_ + `Improving Streaming Performance `_ The following table lists the characteristics of this property. @@ -5356,19 +5347,19 @@ data_transfer_maximum_in_flight_reads Specifies the maximum number of concurrent PCI Express read requests the RF signal generator can issue. - When transferring data from computer memory to device onboard memory across the PCI Express bus, the signal generator can issue multiple memory reads at the same time. In general, the larger the number of read requests, the more efficiently the device uses the bus because the multiple read requests keep the data flowing, even in a PCI Express topology that has high latency due to PCI Express switches in the data path. Most NI devices can issue a large number of read requests (typically 8 or 16). By default, this property is set to the highest value the RF signal generator supports. + When transferring data from computer memory to device onboard memory across the PCI Express bus, the signal generator can issue multiple memory reads at the same time. In general, the larger the number of read requests, the more efficiently the device uses the bus because the multiple read requests keep the data flowing, even in a PCI Express topology that has high latency due to PCI Express switches in the data path. Most NI devices can issue a large number of read requests (typically 8 or 16). By default, this property is set to the highest value the RF signal generator supports. - If other devices in your system cannot tolerate long data latencies, it may be helpful to decrease the number of in-flight read requests the RF signal generator issues. This helps to reduce the amount of data the signal generator reads at one time. + If other devices in your system cannot tolerate long data latencies, it may be helpful to decrease the number of in-flight read requests the RF signal generator issues. This helps to reduce the amount of data the signal generator reads at one time. - **Units**: number of packets + **Units**: number of packets - **Default Value**: Device maximum + **Default Value**: Device maximum - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - **Related Topics** + **Related Topics** - `Improving Streaming Performance `_ + `Improving Streaming Performance `_ The following table lists the characteristics of this property. @@ -5395,19 +5386,19 @@ data_transfer_preferred_packet_size Specifies the preferred size of the data field in a PCI Express read request packet. - In general, the larger the packet size, the more efficiently the device uses the bus. By default, NI RF signal generators use the largest packet size allowed by the system. However, due to different system implementations, some systems may perform better with smaller packet sizes. + In general, the larger the packet size, the more efficiently the device uses the bus. By default, NI RF signal generators use the largest packet size allowed by the system. However, due to different system implementations, some systems may perform better with smaller packet sizes. - Recommended values for this property are powers of two between 64 and 512. + Recommended values for this property are powers of two between 64 and 512. - **Units**: bytes + **Units**: bytes - **Default Value**: Device maximum + **Default Value**: Device maximum - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - **Related Topics** + **Related Topics** - `Improving Streaming Performance `_ + `Improving Streaming Performance `_ @@ -5438,7 +5429,7 @@ 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 + **Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860 @@ -5477,13 +5468,13 @@ 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 :py:meth:`nirfsg.Session._set_attribute_vi_string` method to specify the name of the port to configure for de-embedding. + To use this property, you must use the channelName parameter of the :py:meth:`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. + 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. + Use the create deembedding sparameter table array method to create tables. - **Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860 + **Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860 @@ -5522,19 +5513,19 @@ 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 :py:meth:`nirfsg.Session._set_attribute_vi_int32` method to specify the name of the port to configure for de-embedding. + To use this property, you must use the channelName parameter of the :py:meth:`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 :py:data:`~nirfsg.DeembeddingTypeAttrVals.SCALAR` or :py:data:`~nirfsg.DeembeddingTypeAttrVals.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. + If you set this property to :py:data:`~nirfsg.DeembeddingTypeAttrVals.SCALAR` or :py:data:`~nirfsg.DeembeddingTypeAttrVals.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**: :py:data:`~nirfsg.DeembeddingTypeAttrVals.SCALAR` + **Default Value**: :py:data:`~nirfsg.DeembeddingTypeAttrVals.SCALAR` - **Valid Values for PXIe-5830/5832/5840/5841/5842/5860** : :py:data:`~nirfsg.DeembeddingTypeAttrVals.SCALAR` or :py:data:`~nirfsg.DeembeddingTypeAttrVals.NONE` + **Valid Values for PXIe-5830/5832/5840/5841/5842/5860** : :py:data:`~nirfsg.DeembeddingTypeAttrVals.SCALAR` or :py:data:`~nirfsg.DeembeddingTypeAttrVals.NONE` - **Valid Values for PXIe-5831** :py:data:`~nirfsg.DeembeddingTypeAttrVals.SCALAR`, :py:data:`~nirfsg.DeembeddingTypeAttrVals.VECTOR`, or :py:data:`~nirfsg.DeembeddingTypeAttrVals.NONE`. :py:data:`~nirfsg.DeembeddingTypeAttrVals.VECTOR` is only supported for TRX Ports in a Semiconductor Test System (STS). + **Valid Values for PXIe-5831** :py:data:`~nirfsg.DeembeddingTypeAttrVals.SCALAR`, :py:data:`~nirfsg.DeembeddingTypeAttrVals.VECTOR`, or :py:data:`~nirfsg.DeembeddingTypeAttrVals.NONE`. :py:data:`~nirfsg.DeembeddingTypeAttrVals.VECTOR` is only supported for TRX Ports in a Semiconductor Test System (STS). - **Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860 + **Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860 - **Defined Values**: + **Defined Values**: +---------------------------------------------------+----------------+------------------------------------------------------------------------+ | Name | Value | Description | @@ -5581,21 +5572,21 @@ 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 :py:attr:`nirfsg.Session.signal_bandwidth` centered at the :py:attr:`nirfsg.Session.frequency` must fit within the device instantaneous bandwidth, which is centered at the :py:attr:`nirfsg.Session.upconverter_center_frequency`. + The :py:attr:`nirfsg.Session.signal_bandwidth` centered at the :py:attr:`nirfsg.Session.frequency` must fit within the device instantaneous bandwidth, which is centered at the :py:attr:`nirfsg.Session.upconverter_center_frequency`. - **Units**: Hz + **Units**: Hz - **Default Value**: N/A + **Default Value**: N/A - **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `PXIe-5830 Frequency and Bandwidth Selection `_ + `PXIe-5830 Frequency and Bandwidth Selection `_ - `PXIe-5831/5832 Frequency and Bandwidth Selection `_ + `PXIe-5831/5832 Frequency and Bandwidth Selection `_ - `PXIe-5841 Frequency and Bandwidth Selection `_ + `PXIe-5841 Frequency and Bandwidth Selection `_ The following table lists the characteristics of this property. @@ -5622,21 +5613,21 @@ 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. + 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-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 :py:meth:`nirfsg.Session._set_attribute_vi_real64` method to using the appropriate string for your instrument configuration. Setting the :py:meth:`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. + PXIe-5830/5831/5832: To use this property, you must first set the channelName parameter of the :py:meth:`nirfsg.Session._set_attribute_vi_real64` method to using the appropriate string for your instrument configuration. Setting the :py:meth:`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) + **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 + **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** + **Related Topics** - `Temperature Monitoring `_ + `Temperature Monitoring `_ - `Thermal Shutdown `_ + `Thermal Shutdown `_ +----------------------------+--------------------------+-------------------------+ | Hardware Module | TRX Port Type | Active Channel String | @@ -5683,21 +5674,21 @@ digital_edge_script_trigger_edge Specifies the active edge for the Script Trigger. This property is used when the :py:attr:`nirfsg.Session.script_trigger_type` property is set to digital edge. To set the :py:attr:`nirfsg.Session.digital_edge_script_trigger_edge` property, the NI-RFSG device must be in the Configuration state. - **Default Value:** :py:data:`~nirfsg.ScriptTrigDigEdgeEdge.RISING` + **Default Value:** :py:data:`~nirfsg.ScriptTrigDigEdgeEdge.RISING` - **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Script Trigger `_ + `Script Trigger `_ - `Digital Edge Trigger `_ + `Digital Edge Trigger `_ - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.configure_digital_edge_script_trigger` + - :py:meth:`nirfsg.Session.configure_digital_edge_script_trigger` - **Defined Values**: + **Defined Values**: +--------------------------------------------------+---------+-------------------------------------------------------------------------------+ | Name | Value | Description | @@ -5744,72 +5735,72 @@ digital_edge_script_trigger_source Specifies the source terminal for the Script Trigger. This property is used when the :py:attr:`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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Script Trigger `_ + `Script Trigger `_ - `PFI Lines `_ + `PFI Lines `_ - `PXI Trigger Lines `_ + `PXI Trigger Lines `_ - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.configure_digital_edge_script_trigger` + - :py:meth:`nirfsg.Session.configure_digital_edge_script_trigger` - **Possible Values**: + **Possible Values**: +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | Possible Value | Description | +================+=========================================================================================================================================+ - | PFI0 | The trigger is received on PFI 0. | + | "PFI0" | The trigger is received on PFI 0. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI1 | The trigger is received on PFI 1. | + | "PFI1" | The trigger is received on PFI 1. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI2 | The trigger is received on PFI 2. | + | "PFI2" | The trigger is received on PFI 2. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI3 | The trigger is received on PFI 3. | + | "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_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_Trig0" | The trigger is received on PXI trigger line 0. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + | "PXI_Trig1" | The trigger is received on PXI trigger line 1. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + | "PXI_Trig2" | The trigger is received on PXI trigger line 2. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + | "PXI_Trig3" | The trigger is received on PXI trigger line 3. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + | "PXI_Trig4" | The trigger is received on PXI trigger line 4. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + | "PXI_Trig5" | The trigger is received on PXI trigger line 5. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + | "PXI_Trig6" | The trigger is received on PXI trigger line 6. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig7 | The trigger is received on PXI trigger line 7. | + | "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. | + | "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. | + | "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/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/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/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/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/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/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/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. | + | "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. | + | "Sync_Script" | The trigger is received on the Sync Script trigger line. This value is valid on only the PXIe-5644/5645/5646. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ @@ -5847,23 +5838,23 @@ digital_edge_start_trigger_edge Specifies the active edge for the Start Trigger. This property is used when the :py:attr:`nirfsg.Session.start_trigger_type` property is set to digital edge. To set the :py:attr:`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. + 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:** :py:data:`~nirfsg.StartTrigDigEdgeEdge.RISING` + **Default Value:** :py:data:`~nirfsg.StartTrigDigEdgeEdge.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 + **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** + **Related Topics** - `Start Trigger `_ + `Start Trigger `_ - `Digital Edge Trigger `_ + `Digital Edge Trigger `_ - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.configure_digital_edge_start_trigger` + - :py:meth:`nirfsg.Session.configure_digital_edge_start_trigger` - **Defined Values**: + **Defined Values**: +-------------------------------------------------+---------+------------------------------------------------------------------+ | Name | Value | Description | @@ -5900,74 +5891,74 @@ digital_edge_start_trigger_source Specifies the source terminal for the Start Trigger. This property is used when the :py:attr:`nirfsg.Session.start_trigger_type` property is set to digital edge. The :py:attr:`nirfsg.Session.digital_edge_start_trigger_source` property is not case-sensitive. To set the :py:attr:`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. + 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 + **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** + **Related Topics** - `Start Trigger `_ + `Start Trigger `_ - `PFI Lines `_ + `PFI Lines `_ - `PXI Trigger Lines `_ + `PXI Trigger Lines `_ - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.configure_digital_edge_start_trigger` + - :py:meth:`nirfsg.Session.configure_digital_edge_start_trigger` - **Possible Values**: + **Possible Values**: +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ | Possible Value | Description | +================+========================================================================================================================================+ - | PFI0 | The trigger is received on PFI 0. | + | "PFI0" | The trigger is received on PFI 0. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI1 | The trigger is received on PFI 1. | + | "PFI1" | The trigger is received on PFI 1. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI2 | The trigger is received on PFI 2. | + | "PFI2" | The trigger is received on PFI 2. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI3 | The trigger is received on PFI 3. | + | "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_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_Trig0" | The trigger is received on PXI trigger line 0. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + | "PXI_Trig1" | The trigger is received on PXI trigger line 1. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + | "PXI_Trig2" | The trigger is received on PXI trigger line 2. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + | "PXI_Trig3" | The trigger is received on PXI trigger line 3. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + | "PXI_Trig4" | The trigger is received on PXI trigger line 4. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + | "PXI_Trig5" | The trigger is received on PXI trigger line 5. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + | "PXI_Trig6" | The trigger is received on PXI trigger line 6. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig7 | The trigger is received on PXI trigger line 7. | + | "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. | + | "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. | + | "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/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/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/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/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/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/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/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. | + | "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. | + | "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. @@ -5995,27 +5986,27 @@ 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. + 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 :py:attr:`nirfsg.Session.generation_mode` property is set to :py:data:`~nirfsg.GenerationMode.ARB_WAVEFORM` or :py:data:`~nirfsg.GenerationMode.SCRIPT`. To set this property, the NI-RFSG device must be in the Configuration state. + This property applies only when the :py:attr:`nirfsg.Session.generation_mode` property is set to :py:data:`~nirfsg.GenerationMode.ARB_WAVEFORM` or :py:data:`~nirfsg.GenerationMode.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: :py:data:`~nirfsg.DigitalEqualizationEnabled.ENABLE` is the only supported value for this device. + PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: :py:data:`~nirfsg.DigitalEqualizationEnabled.ENABLE` is the only supported value for this device. - **Default Value:** + **Default Value:** - PXI-5670/5671: :py:data:`~nirfsg.DigitalEqualizationEnabled.DISABLE` + PXI-5670/5671: :py:data:`~nirfsg.DigitalEqualizationEnabled.DISABLE` - PXIe-5644/5645/5646, PXIe-5672, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: :py:data:`~nirfsg.DigitalEqualizationEnabled.ENABLE` + PXIe-5644/5645/5646, PXIe-5672, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: :py:data:`~nirfsg.DigitalEqualizationEnabled.ENABLE` - **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Response and Software Equalization `_—Refer to this topic for more information about equalization performed in software. + `Response and Software Equalization `_—Refer to this topic for more information about equalization performed in software. - `Frequency Tuning Times `_ + `Frequency Tuning Times `_ - **Defined Values**: + **Defined Values**: +-------------------------------------------------------+---------+-----------------------+ | Name | Value | Description | @@ -6052,19 +6043,17 @@ digital_level_script_trigger_active_level Specifies the active level for the Script Trigger. This property is used when the :py:attr:`nirfsg.Session.script_trigger_type` property is set to :py:data:`~nirfsg.ScriptTrigType.DIGITAL_LEVEL`. - **Default Value:** :py:data:`~nirfsg.ScriptTrigDigLevelActiveLevel.HIGH` + **Default Value:** :py:data:`~nirfsg.ScriptTrigDigLevelActiveLevel.HIGH` - **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **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 `_ - **Related Topics** + `Digital Level Trigger `_ - `Script Trigger `_ - - `Digital Level Trigger `_ - - **Defined Values**: + **Defined Values**: +-------------------------------------------------------+---------------+--------------------------------------------------+ | Name | Value | Description | @@ -6109,68 +6098,68 @@ digital_level_script_trigger_source Specifies the source terminal for the Script Trigger. This property is used when the :py:attr:`nirfsg.Session.script_trigger_type` property is set to :py:data:`~nirfsg.ScriptTrigType.DIGITAL_LEVEL`. The :py:attr:`nirfsg.Session.digital_level_script_trigger_source` property is not case-sensitive. - To set the :py:attr:`nirfsg.Session.digital_level_script_trigger_source` property, the NI-RFSG device must be in the Configuration state. + To set the :py:attr:`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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Script Trigger `_ + `Script Trigger `_ - `PFI Lines `_ + `PFI Lines `_ - `PXI Trigger Lines `_ + `PXI Trigger Lines `_ - **Possible Values**: + **Possible Values**: +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | Possible Value | Description | +================+=========================================================================================================================================+ - | PFI0 | The trigger is received on PFI 0. | + | "PFI0" | The trigger is received on PFI 0. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI1 | The trigger is received on PFI 1. | + | "PFI1" | The trigger is received on PFI 1. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI2 | The trigger is received on PFI 2. | + | "PFI2" | The trigger is received on PFI 2. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI3 | The trigger is received on PFI 3. | + | "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_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_Trig0" | The trigger is received on PXI trigger line 0. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + | "PXI_Trig1" | The trigger is received on PXI trigger line 1. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + | "PXI_Trig2" | The trigger is received on PXI trigger line 2. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + | "PXI_Trig3" | The trigger is received on PXI trigger line 3. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + | "PXI_Trig4" | The trigger is received on PXI trigger line 4. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + | "PXI_Trig5" | The trigger is received on PXI trigger line 5. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + | "PXI_Trig6" | The trigger is received on PXI trigger line 6. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig7 | The trigger is received on PXI trigger line 7. | + | "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. | + | "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. | + | "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/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/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/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/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/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/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/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. | + | "DIO/PFI7" | The trigger is received on PFI7 from the front panel DIO terminal. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ @@ -6208,15 +6197,15 @@ digital_modulation_fsk_deviation Specifies the deviation to use in FSK modulation. - **Units**: hertz (Hz) + **Units**: hertz (Hz) - **Default Value:** 1,000 + **Default Value:** 1,000 - **Supported Devices:** PXI/PXIe-5650/5651/5652 + **Supported Devices:** PXI/PXIe-5650/5651/5652 - **Related Topics** + **Related Topics** - `Modulation Schemes `_ + `Modulation Schemes `_ The following table lists the characteristics of this property. @@ -6243,13 +6232,13 @@ digital_modulation_prbs_order Specifies the order of pseudorandom bit sequence (PRBS) internally generated by hardware and used as the message signal in digital modulation. - **Default Value:** 16 + **Default Value:** 16 - **Supported Devices:** PXI/PXIe-5650/5651/5652 + **Supported Devices:** PXI/PXIe-5650/5651/5652 - **Related Topics** + **Related Topics** - `Modulation Schemes `_ + `Modulation Schemes `_ The following table lists the characteristics of this property. @@ -6276,13 +6265,13 @@ digital_modulation_prbs_seed Specifies the seed of the internally generated pseudorandom bit sequence (PRBS). - **Default Value:** 1 + **Default Value:** 1 - **Supported Devices:** PXI/PXIe-5650/5651/5652 + **Supported Devices:** PXI/PXIe-5650/5651/5652 - **Related Topics** + **Related Topics** - `Modulation Schemes `_ + `Modulation Schemes `_ The following table lists the characteristics of this property. @@ -6309,15 +6298,15 @@ digital_modulation_symbol_rate Specifies the symbol rate of the bit stream for digital modulation. - **Units**: hertz (Hz) + **Units**: hertz (Hz) - **Default Value:** 1kHz + **Default Value:** 1kHz - **Supported Devices:** PXI/PXIe-5650/5651/5652 + **Supported Devices:** PXI/PXIe-5650/5651/5652 - **Related Topics** + **Related Topics** - `Modulation Schemes `_ + `Modulation Schemes `_ The following table lists the characteristics of this property. @@ -6344,15 +6333,15 @@ digital_modulation_type Specifies the digital modulation format to use. - **Default Value:** :py:data:`~nirfsg.DigModType.NONE` + **Default Value:** :py:data:`~nirfsg.DigModType.NONE` - **Supported Devices:** PXI/PXIe-5650/5651/5652 + **Supported Devices:** PXI/PXIe-5650/5651/5652 - **Related Topics** + **Related Topics** - `Modulation Schemes `_ + `Modulation Schemes `_ - **Defined Values**: + **Defined Values**: +------------------------------------+--------------+-----------------------------------------------------------------------------+ | Name | Value | Description | @@ -6393,15 +6382,15 @@ digital_modulation_waveform_type Specifies the type of waveform to use as the message signal in digital modulation. - **Default Value:** :py:data:`~nirfsg.DigModWfmType.PRBS` + **Default Value:** :py:data:`~nirfsg.DigModWfmType.PRBS` - **Supported Devices:** PXI/PXIe-5650/5651/5652 + **Supported Devices:** PXI/PXIe-5650/5651/5652 - **Related Topics** + **Related Topics** - `Modulation Schemes `_ + `Modulation Schemes `_ - **Defined Values**: + **Defined Values**: +-----------------------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Value | Description | @@ -6438,13 +6427,13 @@ digital_pattern Enables or disables digital pattern on the PXI-5421/5441 AWG module. This property must be set to True to enable signal routing to and from the Digital Data & Control connector. - To set this property, the NI-RFSG device must be in the Configuration state. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** False + **Default Value:** False - **Supported Devices:** PXI-5670/5671 + **Supported Devices:** PXI-5670/5671 - **Defined Values**: + **Defined Values**: +-------+--------------------------+ | Value | Description | @@ -6479,25 +6468,23 @@ direct_download Specifies whether the :py:meth:`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. + For the PXI-5670, direct download is always disabled. For all other devices, direct download is always enabled. - Perform the following steps to enable direct download: + 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: + 1. Set the I/Q rate to less than or equal to 8.33MS/s with the :py:attr:`nirfsg.Session.iq_rate` property. - 1. Set the I/Q rate to less than or equal to 8.33MS/s with the :py:attr:`nirfsg.Session.iq_rate` property. + 2. Set the :py:attr:`nirfsg.Session.power_level_type` property to :py:data:`~nirfsg.PowerLevelType.PEAK`. - 2. Set the :py:attr:`nirfsg.Session.power_level_type` property to :py:data:`~nirfsg.PowerLevelType.PEAK`. + 3. Disable the :py:attr:`nirfsg.Session.iq_swap_enabled` property. - 3. Disable the :py:attr:`nirfsg.Session.iq_swap_enabled` property. + 4. Disable the :py:attr:`nirfsg.Session.digital_equalization_enabled` property. - 4. Disable the :py:attr:`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 - **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860 - - **Defined Values**: + **Defined Values**: +-----------------------------------------------+-----------+-----------------------------------------------------------------------------------------------------------------------------------------+ | Name | Value | Description | @@ -6536,27 +6523,27 @@ done_event_terminal_name Returns the name of the fully qualified signal name as a string. - **Default Values**: + **Default Values**: - PXI-5670/5671, PXIe-5672/5673/5673E: /*AWGName*/DoneEvent, where *AWGName* is the name of your associated AWG module in MAX. + 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-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-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). + 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 + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Events `_ + `Events `_ - `Syntax for Terminal Names `_ + `Syntax for Terminal Names `_ - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.get_terminal_name` + - :py:meth:`nirfsg.Session.get_terminal_name` The following table lists the characteristics of this property. @@ -6583,23 +6570,23 @@ 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. + 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 + **Units:** Seconds - **Valid Values:** + **Valid Values:** - PXIe-5644/5645: -1.217 μs to 67.050 μs + PXIe-5644/5645: -1.217 μs to 67.050 μs - PXIe-5646: -0.896 μs to 64.640 μs + PXIe-5646: -0.896 μs to 64.640 μs - PXIe-5820/5830/5831/5832/5840/5841/5842: 0 μs to 3.276 μ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 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Events `_ + `Events `_ @@ -6630,42 +6617,42 @@ 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 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Triggers `_ + `Triggers `_ - `Events `_ + `Events `_ - `PFI Lines `_ + `PFI Lines `_ - `PXI Trigger Lines `_ + `PXI Trigger Lines `_ - **Possible Values**: + **Possible Values**: +----------------+--------------------------------------------------------------------------------------------------------------------+ | Possible Value | Description | +================+====================================================================================================================+ - | empty | The signal is not exported. | + | "" | The signal is not exported. | +----------------+--------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + | "PXI_Trig0" | The trigger is received on PXI trigger line 0. | +----------------+--------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + | "PXI_Trig1" | The trigger is received on PXI trigger line 1. | +----------------+--------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + | "PXI_Trig2" | The trigger is received on PXI trigger line 2. | +----------------+--------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + | "PXI_Trig3" | The trigger is received on PXI trigger line 3. | +----------------+--------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + | "PXI_Trig4" | The trigger is received on PXI trigger line 4. | +----------------+--------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + | "PXI_Trig5" | The trigger is received on PXI trigger line 5. | +----------------+--------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + | "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. | + | "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. | + | "TrigOut" | TRIG IN/OUT terminal. | +----------------+--------------------------------------------------------------------------------------------------------------------+ The following table lists the characteristics of this property. @@ -6693,68 +6680,68 @@ 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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Triggers `_ + `Triggers `_ - `Events `_ + `Events `_ - `PFI Lines `_ + `PFI Lines `_ - `PXI Trigger Lines `_ + `PXI Trigger Lines `_ - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.export_signal` + - :py:meth:`nirfsg.Session.export_signal` - **Possible Values**: + **Possible Values**: +---------------+---------------------------------------------------------------------------------------------------------------------------------+ | Posible Value | Description | +===============+=================================================================================================================================+ - | empty | The signal is not exported. | + | "" | 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. | + | "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. | + | "PFI1" | The signal is exported to the PFI 1 connector. | +---------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PFI4 | The signal is exported to the PFI 4 connector. | + | "PFI4" | The signal is exported to the PFI 4 connector. | +---------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PFI5 | The signal is exported to the PFI 5 connector. | + | "PFI5" | The signal is exported to the PFI 5 connector. | +---------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + | "PXI_Trig0" | The trigger is received on PXI trigger line 0. | +---------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + | "PXI_Trig1" | The trigger is received on PXI trigger line 1. | +---------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + | "PXI_Trig2" | The trigger is received on PXI trigger line 2. | +---------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + | "PXI_Trig3" | The trigger is received on PXI trigger line 3. | +---------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + | "PXI_Trig4" | The trigger is received on PXI trigger line 4. | +---------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + | "PXI_Trig5" | The trigger is received on PXI trigger line 5. | +---------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + | "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. | + | "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/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/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/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/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/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/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/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. | + | "DIO/PFI7" | The trigger is received on PFI7 from the front panel DIO terminal. | +---------------+---------------------------------------------------------------------------------------------------------------------------------+ The following table lists the characteristics of this property. @@ -6782,66 +6769,66 @@ 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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Marker Events `_ + `Marker Events `_ - `PFI Lines `_ + `PFI Lines `_ - `PXI Trigger Lines `_ + `PXI Trigger Lines `_ - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.export_signal` + - :py:meth:`nirfsg.Session.export_signal` - **Possible Values**: + **Possible Values**: +----------------+---------------------------------------------------------------------------------------------------------------------------------+ | Possible Value | Description | +================+=================================================================================================================================+ - | empty | The signal is not exported. | + | "" | 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. | + | "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. | + | "PFI1" | The signal is exported to the PFI 1 connector. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PFI4 | The signal is exported to the PFI 4 connector. | + | "PFI4" | The signal is exported to the PFI 4 connector. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PFI5 | The signal is exported to the PFI 5 connector. | + | "PFI5" | The signal is exported to the PFI 5 connector. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + | "PXI_Trig0" | The trigger is received on PXI trigger line 0. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + | "PXI_Trig1" | The trigger is received on PXI trigger line 1. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + | "PXI_Trig2" | The trigger is received on PXI trigger line 2. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + | "PXI_Trig3" | The trigger is received on PXI trigger line 3. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + | "PXI_Trig4" | The trigger is received on PXI trigger line 4. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + | "PXI_Trig5" | The trigger is received on PXI trigger line 5. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + | "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. | + | "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/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/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/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/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/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/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/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. | + | "DIO/PFI7" | The trigger is received on PFI7 from the front panel DIO terminal. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ @@ -6879,11 +6866,11 @@ 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:** :py:data:`~nirfsg.ScriptTrigDigLevelActiveLevel.HIGH` + **Default Value:** :py:data:`~nirfsg.ScriptTrigDigLevelActiveLevel.HIGH` - **Supported Devices:** PXIe-5842 + **Supported Devices:** PXIe-5842 - **Defined Values**: + **Defined Values**: +-------------------------------------------------------+---------------+--------------------------------------------------+ | Name | Value | Description | @@ -6918,22 +6905,20 @@ 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:** :py:data:`~nirfsg.NIRFSG_VAL_PULSE_OUT_STR` + **Default Value:** PulseOut - **Supported Devices:** PXIe-5842 + **Supported Devices:** PXIe-5842 - **Possible Values**: + **Possible Values**: +----------------+---------------------------------------------------------------------+ | Possible Value | Description | +================+=====================================================================+ - | | Pulse modulation video signal is not exported. | + | "" | Pulse modulation video signal is not exported. | +----------------+---------------------------------------------------------------------+ - | PulseOut | Export the pulse modulation video signal on the pulse out terminal. | + | "PulseOut" | Export the pulse modulation video signal on the pulse out terminal. | +----------------+---------------------------------------------------------------------+ - .. 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. +-----------------------+------------+ @@ -6959,41 +6944,39 @@ 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 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. + "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. + "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. + "ClkOut" :Exports the Reference Clock signal to the CLK OUT connector of the device. - **Default Value:** :py:data:`~nirfsg.NIRFSG_VAL_DO_NOT_EXPORT_STR` + **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 + **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** + **Related Topics** - `Interconnecting Multiple NI 5673E Modules `_ + `Interconnecting Multiple NI 5673E Modules `_ - +-------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | Supported devices | - +=================================================+=========+============================================================================================+=======================================================================================================================================================================+ - | :py:data:`~nirfsg.NIRFSG_VAL_CLK_OUT_STR` | ClkOut | Exports the Reference Clock signal to the CLK OUT connector of the device. | Supported on PXIe-5673, 5673E | - +-------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.NIRFSG_VAL_DO_NOT_EXPORT_STR` | empty | 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) | - +-------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.NIRFSG_VAL_REF_OUT_STR` | 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, | - +-------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.NIRFSG_VAL_REF_OUT2_STR` | 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 | - +-------------------------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 :py:data:`~nirfsg.NIRFSG_VAL_REF_OUT2_STR` output terminal value is valid for only the PXIe-5650/5651/5652, not the PXI-5650/5651/5652. - - .. 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. + .. 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. @@ -7020,11 +7003,11 @@ 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:** :py:data:`~nirfsg.ReferenceClockExportedRate._10mhz` + **Default Value:** :py:data:`~nirfsg.ReferenceClockExportedRate._10mhz` - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Defined Values**: + **Defined Values**: +-------------------------------------------------------+--------------+-------------------------------------+ | Name | Value | Description | @@ -7063,66 +7046,66 @@ 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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Script Trigger `_ —Refer to this topic for information about trigger delay. + `Script Trigger `_ —Refer to this topic for information about trigger delay. - `PFI Lines `_ + `PFI Lines `_ - `PXI Trigger Lines `_ + `PXI Trigger Lines `_ - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.export_signal` + - :py:meth:`nirfsg.Session.export_signal` - **Possible Values**: + **Possible Values**: +----------------+---------------------------------------------------------------------------------------------------------------------------------+ | Possible Value | Description | +================+=================================================================================================================================+ - | empty | The signal is not exported. | + | "" | 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. | + | "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. | + | "PFI1" | The signal is exported to the PFI 1 connector. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PFI4 | The signal is exported to the PFI 4 connector. | + | "PFI4" | The signal is exported to the PFI 4 connector. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PFI5 | The signal is exported to the PFI 5 connector. | + | "PFI5" | The signal is exported to the PFI 5 connector. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + | "PXI_Trig0" | The trigger is received on PXI trigger line 0. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + | "PXI_Trig1" | The trigger is received on PXI trigger line 1. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + | "PXI_Trig2" | The trigger is received on PXI trigger line 2. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + | "PXI_Trig3" | The trigger is received on PXI trigger line 3. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + | "PXI_Trig4" | The trigger is received on PXI trigger line 4. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + | "PXI_Trig5" | The trigger is received on PXI trigger line 5. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + | "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. | + | "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/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/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/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/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/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/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/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. | + | "DIO/PFI7" | The trigger is received on PFI7 from the front panel DIO terminal. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ @@ -7160,66 +7143,66 @@ 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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Events `_ + `Events `_ - `PFI Lines `_ + `PFI Lines `_ - `PXI Trigger Lines `_ + `PXI Trigger Lines `_ - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.export_signal` + - :py:meth:`nirfsg.Session.export_signal` - **Possible Values**: + **Possible Values**: +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ | Possible Value | Description | +================+========================================================================================================================================+ - | empty | The signal is not exported. | + | "" | 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. | + | "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. | + | "PFI1" | The signal is exported to the PFI 1 connector. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI4 | The signal is exported to the PFI 4 connector. | + | "PFI4" | The signal is exported to the PFI 4 connector. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI5 | The signal is exported to the PFI 5 connector. | + | "PFI5" | The signal is exported to the PFI 5 connector. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + | "PXI_Trig0" | The trigger is received on PXI trigger line 0. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + | "PXI_Trig1" | The trigger is received on PXI trigger line 1. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + | "PXI_Trig2" | The trigger is received on PXI trigger line 2. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + | "PXI_Trig3" | The trigger is received on PXI trigger line 3. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + | "PXI_Trig4" | The trigger is received on PXI trigger line 4. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + | "PXI_Trig5" | The trigger is received on PXI trigger line 5. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + | "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. | + | "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/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/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/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/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/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/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/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. | + | "DIO/PFI7" | The trigger is received on PFI7 from the front panel DIO terminal. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ The following table lists the characteristics of this property. @@ -7247,66 +7230,66 @@ 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. + 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 + **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** + **Related Topics** - `Start Trigger `_ + `Start Trigger `_ - `PFI Lines `_ + `PFI Lines `_ - `PXI Trigger Lines `_ + `PXI Trigger Lines `_ - **Possible Values**: + **Possible Values**: +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ | Possible Value | Description | +================+========================================================================================================================================+ - | empty | The signal is not exported. | + | "" | 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. | + | "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. | + | "PFI1" | The signal is exported to the PFI 1 connector. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI4 | The signal is exported to the PFI 4 connector. | + | "PFI4" | The signal is exported to the PFI 4 connector. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI5 | The signal is exported to the PFI 5 connector. | + | "PFI5" | The signal is exported to the PFI 5 connector. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + | "PXI_Trig0" | The trigger is received on PXI trigger line 0. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + | "PXI_Trig1" | The trigger is received on PXI trigger line 1. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + | "PXI_Trig2" | The trigger is received on PXI trigger line 2. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + | "PXI_Trig3" | The trigger is received on PXI trigger line 3. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + | "PXI_Trig4" | The trigger is received on PXI trigger line 4. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + | "PXI_Trig5" | The trigger is received on PXI trigger line 5. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + | "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. | + | "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. | + | "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/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/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/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/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/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/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/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. | + | "DIO/PFI7" | The trigger is received on PFI7 from the front panel DIO terminal. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ The following table lists the characteristics of this property. @@ -7334,9 +7317,9 @@ external_calibration_recommended_interval Returns the recommended interval between each external calibration of the device. - **Units**: months + **Units**: months - **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 + **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. @@ -7363,9 +7346,9 @@ external_calibration_temperature Returns the temperature of the device at the time of the last external calibration. - **Units**: degrees Celsius (°C) + **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 + **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. @@ -7392,13 +7375,13 @@ 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. + Positive values for this property represent amplification, and negative values for this property represent attenuation. - **Valid Values:** -INF dB to +INF dB + **Valid Values:** -INF dB to +INF dB - **Default Value:** 0dB + **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 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5654/5654 with PXIe-5696, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -7431,13 +7414,13 @@ fast_tuning_option Returns whether the NI RF signal generator has the fast tuning option available. - **Supported Devices:** PXIe-5654/5654 with PXIe-5696 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Frequency Tuning Times for 5654 `_ + `Frequency Tuning Times for 5654 `_ - **Defined Values**: + **Defined Values**: +-------+------------------------------------------------------------+ | Value | Description | @@ -7473,7 +7456,7 @@ fixed_group_delay_across_ports Specifies a comma-separated list of ports for which to fix the group delay. - **Supported Devices:** PXIe-5831/5832 + **Supported Devices:** PXIe-5831/5832 The following table lists the characteristics of this property. @@ -7500,13 +7483,13 @@ 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 :py:meth:`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. + 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 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `NI-RFSG Instrument Driver FPGA Extensions `_ + `NI-RFSG Instrument Driver FPGA Extensions `_ The following table lists the characteristics of this property. @@ -7533,9 +7516,9 @@ 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. + This property is channel dependent if multiple FPGA targets are supported. - **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860 The following table lists the characteristics of this property. @@ -7562,9 +7545,9 @@ 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. + 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 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -7595,38 +7578,38 @@ 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. + 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) + **Units**: hertz (Hz) - **Defined Values**: - Refer to the specifications document for your device allowable frequency settings. + **Defined Values**: + Refer to the specifications document for your device allowable frequency settings. - **Default Value:** + **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-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-5653: 4GHz - PXIe-5820: 0Hz + PXIe-5820: 0Hz - PXIe-5830/5831/5832: 6.5 GHz + PXIe-5830/5831/5832: 6.5 GHz - PXIe-5840/5841/5860, PXI-5842 (500 MHz, 1 GHz, and 2 GHz bandwidth options): 1GHz + 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 Standard personality: 1GHz - PXIe-5842 (4 GHz bandwidth option) using the 4 GHz Bandwidth personality: 6.5GHz + 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 + **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** + **Related Topics** - `NI-RFSG Instrument Driver Programming Flow `_ + `NI-RFSG Instrument Driver Programming Flow `_ - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.ConfigureRf` + - :py:meth:`nirfsg.Session.ConfigureRf` @@ -7657,22 +7640,21 @@ frequency_settling Specifies the frequency settling time. Interpretation of this value depends on the :py:attr:`nirfsg.Session.frequency_settling_units` property. - **Valid Values:** + **Valid Values:** - The valid values for this property depend on the :py:attr:`nirfsg.Session.frequency_settling_units` property. + The valid values for this property depend on the :py:attr:`nirfsg.Session.frequency_settling_units` property. + **Default Value**: 1.0 - **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 - **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** - **Related Topics** + `Settling Times `_ - `Settling Times `_ - - `Events `_ + `Events `_ The following table lists the characteristics of this property. @@ -7699,19 +7681,19 @@ frequency_settling_units Specifies the interpretation of the value passed to the :py:attr:`nirfsg.Session.frequency_settling` property. - PXIe-5650/5651/5652/5653, PXIe-5673E: When the :py:attr:`nirfsg.Session.ACTIVE_CONFIGURATION_LIST` property is set to a valid list name, the :py:attr:`nirfsg.Session.frequency_settling_units` property supports only :py:data:`~nirfsg.FrequencySettlingUnits.TIME_AFTER_IO` as a valid value. + PXIe-5650/5651/5652/5653, PXIe-5673E: When the :py:attr:`nirfsg.Session.ACTIVE_CONFIGURATION_LIST` property is set to a valid list name, the :py:attr:`nirfsg.Session.frequency_settling_units` property supports only :py:data:`~nirfsg.FrequencySettlingUnits.TIME_AFTER_IO` as a valid value. - PXIe-5654/5654 with PXIe-5696: The :py:attr:`nirfsg.Session.frequency_settling_units` property supports only :py:data:`~nirfsg.FrequencySettlingUnits.TIME_AFTER_IO` and :py:data:`~nirfsg.FrequencySettlingUnits.PPM` as valid values. + PXIe-5654/5654 with PXIe-5696: The :py:attr:`nirfsg.Session.frequency_settling_units` property supports only :py:data:`~nirfsg.FrequencySettlingUnits.TIME_AFTER_IO` and :py:data:`~nirfsg.FrequencySettlingUnits.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 + **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**: :py:data:`~nirfsg.FrequencySettlingUnits.PPM` + **Default Value**: :py:data:`~nirfsg.FrequencySettlingUnits.PPM` - **Related Topics** + **Related Topics** - `Events `_ + `Events `_ - **Defined Values**: + **Defined Values**: +-----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | Name | Description | @@ -7752,19 +7734,19 @@ frequency_tolerance Specifies the allowable frequency error introduced during the software upconversion process. NI-RFSG may introduce a frequency error up to the specified amount to optimize computational speed and onboard memory usage while upconverting phase-continuous signals. - If the :py:attr:`nirfsg.Session.phase_continuity_enabled` property is set to :py:data:`~nirfsg.NIRFSG_VAL_DISABLE`, the :py:attr:`nirfsg.Session.frequency_tolerance` property is ignored, and the driver does not introduce a frequency error. On devices that do not use software upconversion, this property is ignored. The PXI-5670 always uses software upconversion, and the PXI-5671 uses software upconversion for I/Q rates greater than 8.33MS/s. + If the :py:attr:`nirfsg.Session.phase_continuity_enabled` property is set to :py:data:`~nirfsg.NIRFSG_VAL_DISABLE`, the :py:attr:`nirfsg.Session.frequency_tolerance` property is ignored, and the driver does not introduce a frequency error. On devices that do not use software upconversion, this property is ignored. The PXI-5670 always uses software upconversion, and the PXI-5671 uses software upconversion for I/Q rates greater than 8.33MS/s. - To set this property, the NI-RFSG device must be in the Configuration state. + To set this property, the NI-RFSG device must be in the Configuration state. - **Units**: hertz (Hz) + **Units**: hertz (Hz) - **Default Value:** 50 + **Default Value:** 50 - **Supported Devices:** PXI-5670/5671 + **Supported Devices:** PXI-5670/5671 - **Related Topics** + **Related Topics** - `Phase Continuity `_ + `Phase Continuity `_ @@ -7795,23 +7777,23 @@ generation_mode Specifies whether to generate a continuous wave (CW) signal, the arbitrary waveform specified by the :py:attr:`nirfsg.Session.arb_selected_waveform` property, or the script specified by the :py:attr:`nirfsg.Session.selected_script` property, upon calling the :py:meth:`nirfsg.Session._initiate` method. - To set this property, the NI-RFSG device must be in the Configuration state. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** :py:data:`~nirfsg.GenerationMode.CW` + **Default Value:** :py:data:`~nirfsg.GenerationMode.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 + **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** + **Related Topics** - `Assigning Properties or Properties to a Waveform `_ + `Assigning Properties or Properties to a Waveform `_ - `Scripting Instructions `_—Refer to this topic for more information about scripting. + `Scripting Instructions `_—Refer to this topic for more information about scripting. - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.configure_generation_mode` + - :py:meth:`nirfsg.Session.configure_generation_mode` - **Defined Values**: + **Defined Values**: +------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Value | Description | @@ -7848,7 +7830,7 @@ group_capabilities Returns a string that contains a comma-separated 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 + **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. @@ -7875,13 +7857,13 @@ 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. + A sufficiently large host DMA buffer improves performance by allowing large writes to be transferred more efficiently. - **Units:** bytes + **Units:** bytes - **Default Value:** 8MB + **Default Value:** 8MB - **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860 The following table lists the characteristics of this property. @@ -7908,11 +7890,11 @@ 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 + **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 - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.revision_query` + - :py:meth:`nirfsg.Session.revision_query` The following table lists the characteristics of this property. @@ -7939,7 +7921,7 @@ 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 + **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. @@ -7966,7 +7948,7 @@ 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 + **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. @@ -7993,11 +7975,11 @@ interchange_check Specifies whether to perform interchangeability checking and retrieve interchangeability warnings. - **Default Value:** False + **Default Value:** False - **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 + **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 - **Defined Values**: + **Defined Values**: +-------+--------------------------------+ | Value | Description | @@ -8034,11 +8016,11 @@ 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 + **Units:** Seconds - **Valid Values:** Plus or minus half of one I/Q sample period + **Valid Values:** Plus or minus half of one I/Q sample period - **Supported Devices:** PXIe-5644/5645/5646 + **Supported Devices:** PXIe-5644/5645/5646 The following table lists the characteristics of this property. @@ -8065,7 +8047,7 @@ 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 + **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. @@ -8092,22 +8074,21 @@ iq_gain_imbalance Specifies the gain imbalance of the I/Q modulator (I versus Q). - Gain imbalance is calculated with the following equation: - + Gain imbalance is calculated with the following equation: - **Units**: dB + **Units**: dB - **Valid Values:**-6dB to 6dB + **Valid Values:**-6dB to 6dB - **Default Value:** 0dB + **Default Value:** 0dB - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Impairment Calibration `_ + `Impairment Calibration `_ - `Spurious Performance `_ + `Spurious Performance `_ The following table lists the characteristics of this property. @@ -8134,11 +8115,11 @@ iq_impairment_enabled Enables or disables I/Q impairment. The :py:attr:`nirfsg.Session.iq_i_offset`, :py:attr:`nirfsg.Session.iq_q_offset`, :py:attr:`nirfsg.Session.iq_gain_imbalance`, and :py:attr:`nirfsg.Session.iq_skew` properties are ignored when the :py:attr:`nirfsg.Session.iq_impairment_enabled` property is disabled. - **Default Value:** True + **Default Value:** True - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Defined Values**: + **Defined Values**: +-------+-----------------------------+ | Value | Description | @@ -8173,15 +8154,15 @@ 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 :py:attr:`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 :py:attr:`nirfsg.Session.iq_offset_units` property. + 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 :py:attr:`nirfsg.Session.iq_offset_units` property. - **Valid Values:**-100 to 100% or -0.2V to 0.2V + **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 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Impairment Calibration `_ + `Impairment Calibration `_ The following table lists the characteristics of this property. @@ -8208,23 +8189,22 @@ iq_offset_units Specifies the units of the :py:attr:`nirfsg.Session.iq_i_offset` property and :py:attr:`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 :py:attr:`nirfsg.Session.iq_offset_units` property is set to :py:data:`~nirfsg.OffsetUnits.PERCENT`. Given perfect carrier leakage suppression, the following equation is satisfied - + The AWG or VST offset is the specified percentage of the AWG or VST peak power level when the :py:attr:`nirfsg.Session.iq_offset_units` property is set to :py:data:`~nirfsg.OffsetUnits.PERCENT`. Given perfect carrier leakage suppression, the following equation is satisfied - or equivalently + or equivalently - If the :py:attr:`nirfsg.Session.iq_i_offset` property is set to 100%, :py:attr:`nirfsg.Session.iq_q_offset` property is set to 0%, and :py:attr:`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. + If the :py:attr:`nirfsg.Session.iq_i_offset` property is set to 100%, :py:attr:`nirfsg.Session.iq_q_offset` property is set to 0%, and :py:attr:`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 :py:attr:`nirfsg.Session.power_level`, :py:attr:`nirfsg.Session.frequency`, :py:attr:`nirfsg.Session.iq_skew`, :py:attr:`nirfsg.Session.iq_gain_imbalance`, :py:attr:`nirfsg.Session.attenuator_hold_enabled`, and :py:attr:`nirfsg.Session.arb_pre_filter_gain` properties. When the :py:attr:`nirfsg.Session.iq_offset_units` property is set to :py:data:`~nirfsg.OffsetUnits.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 :py:attr:`nirfsg.Session.iq_offset_units` property is set to :py:data:`~nirfsg.OffsetUnits.PERCENT`, the carrier leakage, in dBc, remains at a consistent level. + The AWG or VST peak power level changes when settings change in other properties such as the :py:attr:`nirfsg.Session.power_level`, :py:attr:`nirfsg.Session.frequency`, :py:attr:`nirfsg.Session.iq_skew`, :py:attr:`nirfsg.Session.iq_gain_imbalance`, :py:attr:`nirfsg.Session.attenuator_hold_enabled`, and :py:attr:`nirfsg.Session.arb_pre_filter_gain` properties. When the :py:attr:`nirfsg.Session.iq_offset_units` property is set to :py:data:`~nirfsg.OffsetUnits.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 :py:attr:`nirfsg.Session.iq_offset_units` property is set to :py:data:`~nirfsg.OffsetUnits.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 :py:attr:`nirfsg.Session.iq_offset_units` property to :py:data:`~nirfsg.OffsetUnits.VOLTS`. Offset correction voltage is applied to the I/Q modulator or VST, regardless of changes to the AWG or VST peak power level. + If you are trying to eliminate residual carrier leakage due to calibration inaccuracies or drift, set the :py:attr:`nirfsg.Session.iq_offset_units` property to :py:data:`~nirfsg.OffsetUnits.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**: :py:data:`~nirfsg.OffsetUnits.PERCENT` + **Default Value**: :py:data:`~nirfsg.OffsetUnits.PERCENT` - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Defined Values**: + **Defined Values**: +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | Name | Description | @@ -8261,15 +8241,15 @@ 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) + **Units:** hertz (Hz) - **Valid Values:** + **Valid Values:** - PXIe-5645: -60MHz to 60MHz + PXIe-5645: -60MHz to 60MHz - PXIe-5820: -500MHz to 500MHz + PXIe-5820: -500MHz to 500MHz - **Supported Devices:** PXIe-5645, PXIe-5820 + **Supported Devices:** PXIe-5645, PXIe-5820 @@ -8302,19 +8282,19 @@ 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 :py:attr:`nirfsg.Session.iq_out_port_terminal_configuration` property to :py:data:`~nirfsg.IQOutPortTermCfg.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 :py:meth:`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 use this property, you must use the channelName parameter of the :py:meth:`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. + To set this property, the NI-RFSG device must be in the Configuration state. - **Units:** Volts + **Units:** Volts - **Valid Values:** + **Valid Values:** - PXIe-5645: -0.8V to 0.8V if you set the :py:attr:`nirfsg.Session.iq_out_port_load_impedance` property to 50 Ω. The valid values are -1.2V to 1.2V if you set the :py:attr:`nirfsg.Session.iq_out_port_load_impedance` property to 100 Ω. + PXIe-5645: -0.8V to 0.8V if you set the :py:attr:`nirfsg.Session.iq_out_port_load_impedance` property to 50 Ω. The valid values are -1.2V to 1.2V if you set the :py:attr:`nirfsg.Session.iq_out_port_load_impedance` property to 100 Ω. - PXIe-5820: -0.25V to 1.5V + PXIe-5820: -0.25V to 1.5V - **Supported Devices:** PXIe-5645, PXIe-5820 + **Supported Devices:** PXIe-5645, PXIe-5820 @@ -8347,27 +8327,27 @@ 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 :py:meth:`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 use this property, you must use the channelName parameter of the :py:meth:`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. + 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. + Refer to the specifications document for your device for allowable output levels. - **Units:** Volts, peak-to-peak (V :sub:`pk-pk` ) + **Units:** Volts, peak-to-peak (V :sub:`pk-pk` ) - **Valid Values:** + **Valid Values:** - PXIe-5645: 1V :sub:`pk-pk` maximum if you set the :py:attr:`nirfsg.Session.iq_out_port_terminal_configuration` property to :py:data:`~nirfsg.IQOutPortTermCfg.DIFFERENTIAL`, and 0.5V :sub:`pk-pk` + PXIe-5645: 1V :sub:`pk-pk` maximum if you set the :py:attr:`nirfsg.Session.iq_out_port_terminal_configuration` property to :py:data:`~nirfsg.IQOutPortTermCfg.DIFFERENTIAL`, and 0.5V :sub:`pk-pk` maximum if you set the :py:attr:`nirfsg.Session.iq_out_port_terminal_configuration` property to :py:data:`~nirfsg.IQOutPortTermCfg.SINGLE_ENDED`. - PXIe-5820: 3.4V :sub:`pk-pk` maximum for signal bandwidth less than 160MHz, and 2V :sub:`pk-pk` + PXIe-5820: 3.4V :sub:`pk-pk` maximum for signal bandwidth less than 160MHz, and 2V :sub:`pk-pk` maximum for signal bandwidth greater than 160MHz. - **Default Value:** 0.5volts + **Default Value:** 0.5volts - **Supported Devices:** PXIe-5645, PXIe-5820 + **Supported Devices:** PXIe-5645, PXIe-5820 @@ -8400,15 +8380,15 @@ 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 :py:meth:`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 use this property, you must use the channelName parameter of the :py:meth:`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 + **Units:** Ohms - **Valid Values:** Any value greater than 0. Values greater than or equal to 1 megaohms (MΩ) are interpreted as high impedance. + **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 :py:attr:`nirfsg.Session.iq_out_port_terminal_configuration` property to :py:data:`~nirfsg.IQOutPortTermCfg.SINGLE_ENDED`, and 100 Ω if you set the :py:attr:`nirfsg.Session.iq_out_port_terminal_configuration` property to :py:data:`~nirfsg.IQOutPortTermCfg.DIFFERENTIAL`. + **Default Value:** 50 Ω if you set the :py:attr:`nirfsg.Session.iq_out_port_terminal_configuration` property to :py:data:`~nirfsg.IQOutPortTermCfg.SINGLE_ENDED`, and 100 Ω if you set the :py:attr:`nirfsg.Session.iq_out_port_terminal_configuration` property to :py:data:`~nirfsg.IQOutPortTermCfg.DIFFERENTIAL`. - **Supported Devices:** PXIe-5645, PXIe-5820 + **Supported Devices:** PXIe-5645, PXIe-5820 @@ -8439,15 +8419,15 @@ 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 :py:meth:`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 use this property, you must use the channelName parameter of the :py:meth:`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-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 :py:attr:`nirfsg.Session.arb_pre_filter_gain` property to scale the waveform to provide additional headroom for offsets. + PXIe-5820: The waveform is not automatically scaled in DSP. To prevent DSP overflows, use the :py:attr:`nirfsg.Session.arb_pre_filter_gain` property to scale the waveform to provide additional headroom for offsets. - **Units:** Volts + **Units:** Volts - **Supported Devices:** PXIe-5645, PXIe-5820 + **Supported Devices:** PXIe-5645, PXIe-5820 @@ -8478,9 +8458,9 @@ iq_out_port_temperature Returns the temperature, in degrees Celsius, of the I/Q Out circuitry on the device. - **Units:** Degrees Celsius + **Units:** Degrees Celsius - **Supported Devices:** PXIe-5645, PXIe-5820 + **Supported Devices:** PXIe-5645, PXIe-5820 @@ -8511,23 +8491,23 @@ 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 :py:data:`~nirfsg.IQOutPortTermCfg.SINGLE_ENDED`, you must terminate the negative I and Q output connectors with a 50 Ohm termination. - If you set this property to :py:data:`~nirfsg.IQOutPortTermCfg.SINGLE_ENDED`, the positive I and Q connectors generate the resulting waveform. If you set this property to :py:data:`~nirfsg.IQOutPortTermCfg.DIFFERENTIAL`, both the positive and negative I and Q connectors generate the resulting waveform. + If you set this property to :py:data:`~nirfsg.IQOutPortTermCfg.SINGLE_ENDED`, the positive I and Q connectors generate the resulting waveform. If you set this property to :py:data:`~nirfsg.IQOutPortTermCfg.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 :py:meth:`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 use this property, you must use the channelName parameter of the :py:meth:`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. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** :py:data:`~nirfsg.IQOutPortTermCfg.DIFFERENTIAL` + **Default Value:** :py:data:`~nirfsg.IQOutPortTermCfg.DIFFERENTIAL` - PXIe-5820: The only valid value for this property is :py:data:`~nirfsg.IQOutPortTermCfg.DIFFERENTIAL`. + PXIe-5820: The only valid value for this property is :py:data:`~nirfsg.IQOutPortTermCfg.DIFFERENTIAL`. - **Supported Devices:** PXIe-5645, PXIe-5820 + **Supported Devices:** PXIe-5645, PXIe-5820 - **Related Topics** + **Related Topics** - `Differential and Single-Ended Operation (I/O Interface) `_ + `Differential and Single-Ended Operation (I/O Interface) `_ - **Defined Values**: + **Defined Values**: +--------------------------------------------------+----------------+--------------------------------------------------+ | Name | Value | Description | @@ -8563,16 +8543,11 @@ iq_q_offset .. py:attribute:: 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 :py:attr:`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 :py:attr:`nirfsg.Session.iq_q_offset` property is read-only and indicates the I/Q modulator Q-offset. Units are volts, as indicated by the :py:attr:`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 `_ + 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 :py:attr:`nirfsg.Session.iq_q_offset` property is read-only and indicates the I/Q modulator Q-offset. Units are volts, as indicated by the :py:attr:`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. @@ -8599,26 +8574,26 @@ 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 :py:attr:`nirfsg.Session.generation_mode` property is set to :py:data:`~nirfsg.GenerationMode.ARB_WAVEFORM` or :py:data:`~nirfsg.GenerationMode.SCRIPT`. + This property applies only when the :py:attr:`nirfsg.Session.generation_mode` property is set to :py:data:`~nirfsg.GenerationMode.ARB_WAVEFORM` or :py:data:`~nirfsg.GenerationMode.SCRIPT`. - To set this property, the NI-RFSG device must be in the Configuration state. + 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. + 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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Streaming `_ + `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. + `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 `_ + `Digital Upconverter `_ - **Valid Values**: + **Valid Values**: +--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Device | I/Q Rates | @@ -8675,17 +8650,17 @@ 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 :py:attr:`nirfsg.Session.iq_impairment_enabled` property is disabled. + This property is ignored when the :py:attr:`nirfsg.Session.iq_impairment_enabled` property is disabled. - **Units**: degrees (°) + **Units**: degrees (°) - **Valid Values:**-30° to 30° + **Valid Values:**-30° to 30° - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Impairment Calibration `_ + `Impairment Calibration `_ The following table lists the characteristics of this property. @@ -8712,13 +8687,13 @@ 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. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** False + **Default Value:** False - **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Defined Values**: + **Defined Values**: +-------+---------------------------------------------------------------------+ | Value | Description | @@ -8752,11 +8727,11 @@ load_configurations_from_file_load_options Specifies the configurations to skip while loading from a file. - **Default Value:** :py:data:`~nirfsg.NIRFSG_VAL_SKIP_NONE` + **Default Value:** :py:data:`~nirfsg.NIRFSG_VAL_SKIP_NONE` - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Defined Values**: + **Defined Values**: +--------------------------------------------------------------------+-------------------------------------------------------------------+ | Value | Description | @@ -8793,10 +8768,10 @@ load_configurations_from_file_reset_options Specifies the configurations to skip to reset while loading configurations from a file. - **Default Value:** :py:data:`~nirfsg.NIRFSG_VAL_SKIP_NONE` - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Default Value:** :py:data:`~nirfsg.NIRFSG_VAL_SKIP_NONE` + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Defined Values**: + **Defined Values**: +------------------------------------------------------------------------------+------------------------------------------------------+ | Value | Description | @@ -8814,15 +8789,15 @@ load_configurations_from_file_reset_options The following table lists the characteristics of this property. - +-----------------------+--------------------+ - | Characteristic | Value | - +=======================+====================+ - | Datatype | enums.ResetOptions | - +-----------------------+--------------------+ - | Permissions | read-write | - +-----------------------+--------------------+ - | Repeated Capabilities | None | - +-----------------------+--------------------+ + +-----------------------+-------------------------------------+ + | Characteristic | Value | + +=======================+=====================================+ + | Datatype | enums.LoadConfigurationResetOptions | + +-----------------------+-------------------------------------+ + | Permissions | read-write | + +-----------------------+-------------------------------------+ + | Repeated Capabilities | None | + +-----------------------+-------------------------------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: @@ -8837,7 +8812,7 @@ 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 :py:meth:`nirfsg.Session.Init` method or the :py:meth:`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 + **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. @@ -8864,25 +8839,25 @@ 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 :py:meth:`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). + To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the :py:meth:`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:** + **Default Value:** - PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842: :py:data:`~nirfsg.LoopBandwidth.MEDIUM` + PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842: :py:data:`~nirfsg.LoopBandwidth.MEDIUM` - PXI/PXIe-5650/5651/5652, PXIe-5673/5673E: :py:data:`~nirfsg.LoopBandwidth.NARROW` + PXI/PXIe-5650/5651/5652, PXIe-5673/5673E: :py:data:`~nirfsg.LoopBandwidth.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 + **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** + **Related Topics** - `Phase-Locked Loop Bandwidth `_ + `Phase-Locked Loop Bandwidth `_ - `Modulation Implementation `_ + `Modulation Implementation `_ - `Sinusoidal Tone Versus Modulation Operation `_ + `Sinusoidal Tone Versus Modulation Operation `_ - **Defined Values**: + **Defined Values**: +-----------------------------------------+---------+--------------------------------------------------------+ | Name | Value | Description | @@ -8896,6 +8871,8 @@ loop_bandwidth .. note:: Setting this property to :py:data:`~nirfsg.LoopBandwidth.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 :py:data:`~nirfsg.LoopBandwidth.MEDIUM` is not a valid option on the PXI/PXIe-5650/5651/5652 or PXIe-5673/5673E. :py:data:`~nirfsg.LoopBandwidth.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. + The following table lists the characteristics of this property. +-----------------------+---------------------+ @@ -8921,15 +8898,15 @@ 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 :py:meth:`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). + To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the :py:meth:`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 + **Supported Devices**: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `PXIe-5830 Frequency and Bandwidth Configuration `_ + `PXIe-5830 Frequency and Bandwidth Configuration `_ - `PXIe-5831/5832 Frequency and Bandwidth Configuration `_ + `PXIe-5831/5832 Frequency and Bandwidth Configuration `_ @@ -8960,36 +8937,36 @@ lo_frequency_step_size Specifies the step size for tuning the local oscillator (LO) phase-locked loop (PLL). - When the :py:attr:`nirfsg.Session.lo_pll_fractional_mode_enabled` property is enabled, the specified step size affects the fractional spur performance of the device. When the :py:attr:`nirfsg.Session.lo_pll_fractional_mode_enabled` property is disabled, the specified step size affects the phase noise performance of the device. + When the :py:attr:`nirfsg.Session.lo_pll_fractional_mode_enabled` property is enabled, the specified step size affects the fractional spur performance of the device. When the :py:attr:`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 :py:attr:`nirfsg.Session.lo_pll_fractional_mode_enabled` property. + The valid values for this property depend on the :py:attr:`nirfsg.Session.lo_pll_fractional_mode_enabled` property. - **PXIe-5644/5645/5646**—If you disable the :py:attr:`nirfsg.Session.lo_pll_fractional_mode_enabled` property, the specified value is coerced to the nearest valid value. + **PXIe-5644/5645/5646**—If you disable the :py:attr:`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 :py:attr:`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. + **PXIe-5840/5841**—If you disable the :py:attr:`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) + **Units:** hertz (Hz) - **Default Values:** + **Default Values:** - PXIe-5644/5645/5646: 200kHz + PXIe-5644/5645/5646: 200kHz - PXIe-5830: 2MHz + PXIe-5830: 2MHz - PXIe-5831/5832 (RF port): 8MHz + PXIe-5831/5832 (RF port): 8MHz - PXIe-5831/5832 (IF port): 2MHz, 4MHz + PXIe-5831/5832 (IF port): 2MHz, 4MHz - PXIe-5840/5841: + 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. + - 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-5841 with PXIe-5655: 500kHz - PXIe-5842: 1Hz + PXIe-5842: 1Hz - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842 +----------------------------------------------------------------------------------------------------------------------------+--------------------------------------+--------------------------------------------------+ | :py:attr:`nirfsg.Session.lo_pll_fractional_mode_enabled` Property Setting | :py:data:`~nirfsg.NIRFSG_VAL_ENABLE` | :py:data:`~nirfsg.NIRFSG_VAL_DISABLE` | @@ -9034,15 +9011,15 @@ 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 :py:meth:`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). + To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the :py:meth:`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 + **Units**: dBm - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `LO OUT `_ + `LO OUT `_ @@ -9075,17 +9052,17 @@ 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 :py:attr:`nirfsg.Session.output_enabled` property is set to False, the :py:meth:`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 :py:meth:`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). + To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the :py:meth:`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:** :py:data:`~nirfsg.NIRFSG_VAL_DISABLE` + **Default Value:** :py:data:`~nirfsg.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 + **Supported Devices:** PXI-5610, PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `LO OUT `_ + `LO OUT `_ - **Defined Values**: + **Defined Values**: +---------------------------------------+---------------------------------------------------------------------------------+ | Name | Description | @@ -9122,13 +9099,13 @@ lo_out_export_configure_from_rfsa Specifies whether to allow NI-RFSA to control the NI-RFSG LO out export. - Set this property to :py:data:`~nirfsg.LoOutExportConfigureFromRFSaEnable.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. + Set this property to :py:data:`~nirfsg.LoOutExportConfigureFromRFSaEnable.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:** :py:data:`~nirfsg.LoOutExportConfigureFromRFSaEnable.DISABLE` + **Default Value:** :py:data:`~nirfsg.LoOutExportConfigureFromRFSaEnable.DISABLE` - **Supported Devices**: PXIe-5840/5841/5842 + **Supported Devices**: PXIe-5840/5841/5842 - **Defined Values**: + **Defined Values**: +---------------------------------------------------------------+---------+----------------------------------------------------------------------+ | Name | Value | Description | @@ -9165,15 +9142,15 @@ 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 :py:meth:`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). + To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the :py:meth:`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 + **Units**: dBm - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `LO OUT `_ + `LO OUT `_ @@ -9204,19 +9181,19 @@ 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 :py:attr:`nirfsg.Session.lo_frequency_step_size` property. However, fractional mode may introduce non-harmonic spurs. - This property applies only if you set the :py:attr:`nirfsg.Session.lo_source` property to :py:data:`~nirfsg.NIRFSG_VAL_LO_SOURCE_ONBOARD_STR`. + This property applies only if you set the :py:attr:`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 :py:meth:`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). + To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the :py:meth:`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:** :py:data:`~nirfsg.LoPlLfractionalModeEnabled.ENABLE` + **Default Value:** :py:data:`~nirfsg.LoPlLfractionalModeEnabled.ENABLE` - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - Refer to the local oscillators topic appropriate to your device for more information about using fractional mode. + Refer to the local oscillators topic appropriate to your device for more information about using fractional mode. - **Defined Values**: + **Defined Values**: +-------------------------------------------------------+---------+------------------------------------------+ | Name | Value | Description | @@ -9255,37 +9232,35 @@ lo_source Specifies whether to use the internal or external local oscillator (LO) source. If the :py:attr:`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 :py:meth:`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:** :py:data:`~nirfsg.NIRFSG_VAL_LO_SOURCE_ONBOARD_STR` + To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the :py:meth:`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). - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842 + **Default Value:** Onboard - **Related Topics** + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842 - `PXIe-5830 LO Sharing Using NI-RFSA and NI-RFSG `_ + **Related Topics** - `PXIe-5831/5832 LO Sharing Using NI-RFSA and NI-RFSG `_ + `PXIe-5830 LO Sharing Using NI-RFSA and NI-RFSG `_ - **Possible Values**: + `PXIe-5831/5832 LO Sharing Using NI-RFSA and NI-RFSG `_ - +------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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 :py:attr:`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. | - +------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + **Possible Values**: - .. note:: For the PXIe-5841 with PXIe-5655, RF list mode is not supported when this property is set to :py:data:`~nirfsg.NIRFSG_VAL_LO_SOURCE_SG_SA_SHARED_STR`. + +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 :py:attr:`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:: 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. + .. note:: For the PXIe-5841 with PXIe-5655, RF list mode is not supported when this property is set to SG_SA_Shared. The following table lists the characteristics of this property. @@ -9312,11 +9287,11 @@ 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. + 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) + **Units**: degrees Celsius (°C) - **Supported Devices:** PXIe-5673/5673E, PXIe-5840/5841/5842 + **Supported Devices:** PXIe-5673/5673E, PXIe-5840/5841/5842 The following table lists the characteristics of this property. @@ -9343,15 +9318,15 @@ 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**: + **Valid Values**: - LO1: 1 Hz to 50 MHz + LO1: 1 Hz to 50 MHz - LO2: 1 Hz to 100 MHz + LO2: 1 Hz to 100 MHz - **Default Value**: 1 MHz + **Default Value**: 1 MHz - **Supported Devices**: PXIe-5830/5831/5832 + **Supported Devices**: PXIe-5830/5831/5832 The following table lists the characteristics of this property. @@ -9378,15 +9353,15 @@ 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:** :py:data:`~nirfsg.MarkerEventOutputBehavior.PULSE` + **Default Value:** :py:data:`~nirfsg.MarkerEventOutputBehavior.PULSE` - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Marker Events `_ + `Marker Events `_ - **Defined Values**: + **Defined Values**: +-----------------------------------------------------+----------------+-------------------------------------------------------+ | Name | Value | Description | @@ -9431,15 +9406,15 @@ marker_event_pulse_width Specifies the pulse width value for the Marker Event. Use the :py:attr:`nirfsg.Session.marker_event_pulse_width_units` property to set the units for the pulse width value. This property is valid only when the :py:attr:`nirfsg.Session.marker_event_output_behavior` property is set to :py:data:`~nirfsg.MarkerEventOutputBehavior.PULSE`. - To set this property, the NI-RFSG device must be in the Configuration state. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** 200 ns + **Default Value:** 200 ns - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Marker Events `_ + `Marker Events `_ @@ -9478,17 +9453,17 @@ marker_event_pulse_width_units Specifies the pulse width units for the Marker Event. This property is valid only when the :py:attr:`nirfsg.Session.marker_event_output_behavior` property is set to :py:data:`~nirfsg.MarkerEventOutputBehavior.PULSE`. - To set this property, the NI-RFSG device must be in the Configuration state. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** :py:data:`~nirfsg.MarkerEventPulseWidthUnits.SECONDS` + **Default Value:** :py:data:`~nirfsg.MarkerEventPulseWidthUnits.SECONDS` - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Marker Events `_ + `Marker Events `_ - **Defined Values**: + **Defined Values**: +-----------------------------------------------------+----------------+-------------------------------------------------------+ | Name | Value | Description | @@ -9533,25 +9508,25 @@ marker_event_terminal_name Returns the name of the fully qualified signal name as a string. - **Default Values**: + **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. + 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-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. + 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 + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Events `_ + `Events `_ - `Syntax for Terminal Names `_ + `Syntax for Terminal Names `_ - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.get_terminal_name` + - :py:meth:`nirfsg.Session.get_terminal_name` @@ -9590,17 +9565,17 @@ marker_event_toggle_initial_state Specifies the initial state for the Marker Event when the :py:attr:`nirfsg.Session.marker_event_output_behavior` property is set to :py:data:`~nirfsg.MarkerEventOutputBehavior.TOGGLE`. - To set this property, the NI-RFSG device must be in the Configuration state. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** :py:data:`~nirfsg.MarkerEventToggleInitialState.LOW` + **Default Value:** :py:data:`~nirfsg.MarkerEventToggleInitialState.LOW` - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Marker Events `_ + `Marker Events `_ - **Defined Values**: + **Defined Values**: +-------------------------------------------------------+----------------+----------------------------------------------------------------------------------+ | Name | Value | Description | @@ -9645,15 +9620,15 @@ memory_size The total amount of memory on the signal generator in bytes. - **Units:** 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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Memory Options `_ + `Memory Options `_ - `Phase Continuity `_ + `Phase Continuity `_ @@ -9684,9 +9659,9 @@ module_power_consumption Returns the total power consumption of the device. - **Units:** watts + **Units:** watts - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -9717,11 +9692,11 @@ 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 + **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** + **Related Topics** - `Identifying Module Revision `_ + `Identifying Module Revision `_ The following table lists the characteristics of this property. @@ -9748,21 +9723,21 @@ output_enabled Specifies whether signal output is enabled. Setting the :py:attr:`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 :py:attr:`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 + **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 + **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** + **Related Topics** - `Output Enabled `_ + `Output Enabled `_ - `NI-RFSG Instrument Driver Programming Flow `_ + `NI-RFSG Instrument Driver Programming Flow `_ - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.configure_output_enabled` + - :py:meth:`nirfsg.Session.configure_output_enabled` - **Defined Values**: + **Defined Values**: +-------+-------------------------+ | Value | Description | @@ -9805,19 +9780,19 @@ 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 :py:attr:`nirfsg.Session.iq_out_port_carrier_frequency` property to 0. If you set the :py:attr:`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. + 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 :py:attr:`nirfsg.Session.iq_out_port_carrier_frequency` property to 0. If you set the :py:attr:`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 :py:attr:`nirfsg.Session.output_port` property to :py:data:`~nirfsg.OutputPort.I_ONLY` or :py:data:`~nirfsg.OutputPort.IQ_OUT`, the :py:attr:`nirfsg.Session.iq_out_port_terminal_configuration` property applies. + If you set the :py:attr:`nirfsg.Session.output_port` property to :py:data:`~nirfsg.OutputPort.I_ONLY` or :py:data:`~nirfsg.OutputPort.IQ_OUT`, the :py:attr:`nirfsg.Session.iq_out_port_terminal_configuration` property applies. - **Default Value:** + **Default Value:** - PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842/5860: :py:data:`~nirfsg.OutputPort.RF_OUT` + PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842/5860: :py:data:`~nirfsg.OutputPort.RF_OUT` - PXIe-5820: :py:data:`~nirfsg.OutputPort.IQ_OUT` + PXIe-5820: :py:data:`~nirfsg.OutputPort.IQ_OUT` - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Defined Values**: + **Defined Values**: +---------------------------------------+----------------+------------------------------------------------------------------------------------------+ | Name | Value | Description | @@ -9856,11 +9831,11 @@ overflow_error_reporting Configures error reporting for onboard signal processing (OSP) overflows. Overflows lead to clipping of the waveform. - **Default Value:** :py:data:`~nirfsg.OverflowErrorReporting.WARNING` + **Default Value:** :py:data:`~nirfsg.OverflowErrorReporting.WARNING` - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Defined Values**: + **Defined Values**: +----------------------------------------------------+--------------+----------------------------------------------------------------------------+ | Name | Value | Description | @@ -9895,17 +9870,17 @@ p2p_data_transfer_permission_initial_credits Specifies the initial amount of data that the writer peer can transfer over the bus into the configured endpoint when the peer-to-peer data stream is enabled. If this property is not set and the endpoint is empty, credits equal to the full endpoint size are issued to the writer peer. If data is written to the endpoint using the :py:meth:`nirfsg.Session.WriteP2pEndpointI16` method prior to enabling the stream, credits equal to the remaining space available in the endpoint are issued to the writer peer. This property is coerced up by NI-RFSG to 8-byte boundaries. This property is endpoint-based. - **Units**: samples per channel + **Units**: samples per channel - **Default Value:** 1,024 + **Default Value:** 1,024 - **Supported Devices:** PXIe-5673E + **Supported Devices:** PXIe-5673E - **Related Topics** + **Related Topics** - `Configuring a Peer-to-Peer Endpoint `_ + `Configuring a Peer-to-Peer Endpoint `_ - `Configuring Flow Control `_ + `Configuring Flow Control `_ The following table lists the characteristics of this property. @@ -9932,15 +9907,15 @@ p2p_data_transfer_permission_interval Specifies the interval at which the RF signal generator issues credits to allow the writer peer to transfer data over the bus into the configured endpoint. This property is coerced up by NI-RFSG to the nearest 128-byte boundary. This property is endpoint-based. - **Units**: samples per channel + **Units**: samples per channel - **Supported Devices:** PXIe-5673E + **Supported Devices:** PXIe-5673E - **Related Topics** + **Related Topics** - `Configuring a Peer-to-Peer Endpoint `_ + `Configuring a Peer-to-Peer Endpoint `_ - `Configuring Flow Control `_ + `Configuring Flow Control `_ The following table lists the characteristics of this property. @@ -9967,15 +9942,15 @@ p2p_enabled Specifies whether the RF signal generator reads data from the peer-to-peer endpoint. This property is endpoint-based. - **Default Value**: False + **Default Value**: False - **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Configuring a Peer-to-Peer Endpoint `_ + `Configuring a Peer-to-Peer Endpoint `_ - **Defined Values**: + **Defined Values**: +-------+------------------------------------------+ | Value | Description | @@ -10010,11 +9985,11 @@ p2p_endpoint_count Returns the number of peer-to-peer FIFO endpoints supported by the device. - **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Configuring a Peer-to-Peer Endpoint `_ + `Configuring a Peer-to-Peer Endpoint `_ The following table lists the characteristics of this property. @@ -10041,13 +10016,13 @@ p2p_endpoint_fullness_start_trigger_level Specifies the number of samples the endpoint must receive before the device starts generation. If no level is specified, NI-RFSG automatically sets this value to -1. This property applies only when the :py:attr:`nirfsg.Session.start_trigger_type` property is set to :py:data:`~nirfsg.StartTrigType.P2P_ENDPOINT_FULLNESS` - **Default Value:** -1, which allows NI-RFSG to select the appropriate fullness value. + **Default Value:** -1, which allows NI-RFSG to select the appropriate fullness value. - **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Start Trigger `_ + `Start Trigger `_ @@ -10078,13 +10053,13 @@ p2p_endpoint_size Returns the size, in samples, of the device endpoint. This property is endpoint-based. - **Units**: samples (s) + **Units**: samples (s) - **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Configuring a Peer-to-Peer Endpoint `_ + `Configuring a Peer-to-Peer Endpoint `_ The following table lists the characteristics of this property. @@ -10111,7 +10086,7 @@ p2p_generation_fifo_sample_quantum Returns how many samples NI-RFSG pulls from the peer-to-peer FIFO per read. You can use this property to determine how many samples to send across the peer-to-peer bus to ensure that no samples are ignored. If you send a number of samples that is not a multiple of this value, the remaining samples are not read from the FIFO during generation. This property is endpoint-based. - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 The following table lists the characteristics of this property. @@ -10138,11 +10113,11 @@ p2p_is_finite_generation Specifies whether peer-to-peer should continuously generate data from the peer-to-peer stream or from only a finite number of samples, according to the :py:attr:`nirfsg.Session.p2p_number_of_samples_to_generate` property. To use this property, peer-to-peer must be enabled. This property is endpoint-based. - **Default Value**: False + **Default Value**: False - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 - **Defined Values**: + **Defined Values**: +-------+--------------------------------------------------------------+ | Value | Description | @@ -10177,15 +10152,15 @@ p2p_most_space_available_in_endpoint Returns the largest number of samples per channel available in the endpoint since this property was last read. You can use this property to determine how much endpoint space to use as a buffer against bus traffic latencies by reading the property and keeping track of the largest value returned. This property is endpoint-based. - If you want to minimize the latency for data to move through the endpoint and be generated by the RF signal generator, use the :py:attr:`nirfsg.Session.p2p_data_transfer_permission_initial_credits` property to grant fewer initial credits than the default of the entire endpoint size. + If you want to minimize the latency for data to move through the endpoint and be generated by the RF signal generator, use the :py:attr:`nirfsg.Session.p2p_data_transfer_permission_initial_credits` property to grant fewer initial credits than the default of the entire endpoint size. - **Units**: samples per channel + **Units**: samples per channel - **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Configuring a Peer-to-Peer Endpoint `_ + `Configuring a Peer-to-Peer Endpoint `_ The following table lists the characteristics of this property. @@ -10212,11 +10187,11 @@ p2p_number_of_samples_to_generate Specifies how many samples are generated from the peer-to-peer subsystem when it is enabled. To use this property, peer-to-peer must be enabled and set to finite generation. This property is endpoint-based. - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Configuring a Peer-to-Peer Endpoint `_ + `Configuring a Peer-to-Peer Endpoint `_ The following table lists the characteristics of this property. @@ -10243,15 +10218,15 @@ p2p_space_available_in_endpoint Returns the current space available in the endpoint. You can use this property when priming the endpoint with initial data using the :py:meth:`nirfsg.Session.WriteP2pEndpointI16` method to determine how many samples you can write. You also can use this property to characterize the performance and measure the latency of the peer-to-peer stream as data moves across the bus. This property is endpoint-based. - **Units**: samples per channel + **Units**: samples per channel - **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Configuring a Peer-to-Peer Endpoint `_ + `Configuring a Peer-to-Peer Endpoint `_ - `Starting Peer-to-Peer Generation `_ + `Starting Peer-to-Peer Generation `_ The following table lists the characteristics of this property. @@ -10278,9 +10253,9 @@ peak_envelope_power Returns the maximum instantaneous power of the RF output signal. - **Units**: dBm + **Units**: dBm - **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -10313,11 +10288,11 @@ peak_power_adjustment Specifies the adjustment for the :py:attr:`nirfsg.Session.power_level` property. This property is valid only when you set the :py:attr:`nirfsg.Session.power_level_type` property to :py:data:`~nirfsg.PowerLevelType.PEAK`. The value of the :py:attr:`nirfsg.Session.peak_power_adjustment` property adds to the :py:attr:`nirfsg.Session.power_level` property. The :py:attr:`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 :py:attr:`nirfsg.Session.power_level_type` property is set to :py:data:`~nirfsg.PowerLevelType.PEAK`. - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **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. + `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. @@ -10350,15 +10325,15 @@ peak_power_adjustment_inheritance Determines the inheritance behavior of the :py:attr:`nirfsg.Session.peak_power_adjustment` property when a script inherits values from specified waveforms. - **Default Value:** :py:data:`~nirfsg.PpaInheritance.EXACT_MATCH` + **Default Value:** :py:data:`~nirfsg.PpaInheritance.EXACT_MATCH` - **Supported Devices:** PXIe-5673/5673E + **Supported Devices:** PXIe-5673/5673E - **Related Topics** + **Related Topics** - `Assigning Properties or Properties to a Waveform `_ + `Assigning Properties or Properties to a Waveform `_ - **Defined Values**: + **Defined Values**: +-----------------------------------------------+------------------------------------------------------------+ | Value | Description | @@ -10393,21 +10368,21 @@ phase_continuity_enabled Specifies whether the driver maintains phase continuity in the arbitrary waveforms. When this property is set to :py:data:`~nirfsg.PhaseContinuityEnabled.ENABLE`, NI-RFSG may increase the waveform size. When this property is set to :py:data:`~nirfsg.PhaseContinuityEnabled.ENABLE`, the :py:attr:`nirfsg.Session.frequency_tolerance` property specifies the maximum allowable frequency error that can be introduced when keeping the signal phase-continuous. To set the :py:attr:`nirfsg.Session.phase_continuity_enabled` property, the NI-RFSG device must be in the Configuration state. :py:attr:`nirfsg.Session.phase_continuity_enabled` applies only when the :py:attr:`nirfsg.Session.generation_mode` property is set to :py:data:`~nirfsg.GenerationMode.ARB_WAVEFORM` or :py:data:`~nirfsg.GenerationMode.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. + 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. + 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:** :py:data:`~nirfsg.PhaseContinuityEnabled.AUTO` + **Default Value:** :py:data:`~nirfsg.PhaseContinuityEnabled.AUTO` - **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Phase Continuity `_ + `Phase Continuity `_ - `Arb Waveform Mode Tuning Speed Factors `_ + `Arb Waveform Mode Tuning Speed Factors `_ - **Defined Values**: + **Defined Values**: +---------------------------------------------------------------------+-----------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:attr:`nirfsg.Session.phase_continuity_enabled` Property Setting | Value | With I/Q Rates > 8.33 MS/s. | @@ -10446,15 +10421,15 @@ 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 (°) + **Units**: degrees (°) - **Default Value:** 0 + **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 + **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** + **Related Topics** - `Phase Synchronization and Phase Coherency `_ + `Phase Synchronization and Phase Coherency `_ The following table lists the characteristics of this property. @@ -10481,30 +10456,30 @@ power_level Specifies either the average power level or peak power level of the generated RF signal, depending on the :py:attr:`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. + 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. + Refer to the specifications document for your device for allowable power level settings. - **Units**: dBm + **Units**: dBm - **Default Values:** + **Default Values:** - PXIe-5644/5645/5646, PXIe-5673/5673E: -100 + PXIe-5644/5645/5646, PXIe-5673/5673E: -100 - PXI/PXIe-5650/5651/5652: -90 + PXI/PXIe-5650/5651/5652: -90 - PXIe-5654: -7 + PXIe-5654: -7 - PXIe-5654 with PXIe-5696: -110 + PXIe-5654 with PXIe-5696: -110 - PXI-5670/5671, PXIe-5672: -145 + PXI-5670/5671, PXIe-5672: -145 - PXIe-5830/5831/5832/5840/5841/5842/5860: -174 + 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**: + **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**: - - :py:meth:`nirfsg.Session.ConfigureRf` + - :py:meth:`nirfsg.Session.ConfigureRf` @@ -10537,38 +10512,35 @@ power_level_type Specifies how NI-RFSG interprets the value of the :py:attr:`nirfsg.Session.power_level` property. The :py:attr:`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 :py:data:`~nirfsg.PowerLevelType.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 :py:attr:`nirfsg.Session.power_level` property. You can disable this scaling operation by setting the :py:attr:`nirfsg.Session.power_level_type` property to :py:data:`~nirfsg.PowerLevelType.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 :py:data:`~nirfsg.PowerLevelType.PEAK`. - - Converting from Average Power to Peak Power - - Typically, this property is set to :py:data:`~nirfsg.PowerLevelType.AVERAGE`. However, some instrument modes require this property to be set to :py:data:`~nirfsg.PowerLevelType.PEAK`. Use the following equations to calculate the equivalent peak power given the desired average power for your waveform: + PXI-5670/5671: While in Script generation mode, if this property is set to :py:data:`~nirfsg.PowerLevelType.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 :py:attr:`nirfsg.Session.power_level` property. You can disable this scaling operation by setting the :py:attr:`nirfsg.Session.power_level_type` property to :py:data:`~nirfsg.PowerLevelType.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 :py:data:`~nirfsg.PowerLevelType.PEAK`. - Where 1 is the highest possible magnitude in the waveform. + Converting from Average Power to Peak Power + Typically, this property is set to :py:data:`~nirfsg.PowerLevelType.AVERAGE`. However, some instrument modes require this property to be set to :py:data:`~nirfsg.PowerLevelType.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:** + **Default Value:** - PXIe-5820: :py:data:`~nirfsg.PowerLevelType.PEAK` + PXIe-5820: :py:data:`~nirfsg.PowerLevelType.PEAK` - All other devices: :py:data:`~nirfsg.PowerLevelType.AVERAGE` + All other devices: :py:data:`~nirfsg.PowerLevelType.AVERAGE` - **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Spurious Performance `_ + `Spurious Performance `_ - `Optimizing for Low Power Generation `_ + `Optimizing for Low Power Generation `_ - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.configure_power_level_type` + - :py:meth:`nirfsg.Session.configure_power_level_type` - **Defined Values**: + **Defined Values**: +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Value | Description | @@ -10603,11 +10575,11 @@ 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:** :py:data:`~nirfsg.ScriptTrigDigLevelActiveLevel.HIGH` + **Default Value:** :py:data:`~nirfsg.ScriptTrigDigLevelActiveLevel.HIGH` - **Supported Devices:** PXIe-5842 + **Supported Devices:** PXIe-5842 - **Defined Values**: + **Defined Values**: +-------------------------------------------------------+---------------+--------------------------------------------------+ | Name | Value | Description | @@ -10642,21 +10614,21 @@ 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-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-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. + 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 + **Default Value:** False - **Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXIe-5673/5673E + **Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXIe-5673/5673E - **Related Topics** + **Related Topics** - `Pulse Modulation `_ + `Pulse Modulation `_ - **Defined Values**: + **Defined Values**: +-------+----------------------------+ | Value | Description | @@ -10691,13 +10663,13 @@ 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. + 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:** :py:data:`~nirfsg.PulseModulationMode.ANALOG` + **Default Value:** :py:data:`~nirfsg.PulseModulationMode.ANALOG` - **Supported Devices:** PXIe-5842/5654/5654 with PXIe-5696 + **Supported Devices:** PXIe-5842/5654/5654 with PXIe-5696 - **Defined Values**: + **Defined Values**: +----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | Value | Description | @@ -10738,28 +10710,26 @@ 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:** :py:data:`~nirfsg.NIRFSG_VAL_PULSE_IN_STR` + **Default Value:** PulseIn - **Supported Devices:** PXIe-5842 + **Supported Devices:** PXIe-5842 - **Possible Values**: + **Possible Values**: +----------------+----------------------------------------------------------------------------------------------+ | Possible Value | Description | +================+==============================================================================================+ - | PulseIn | The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842. | + | "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. | + | "Marker0" | The trigger is received from the Marker 0. | +----------------+----------------------------------------------------------------------------------------------+ - | Marker1 | The trigger is received from the Marker 1. | + | "Marker1" | The trigger is received from the Marker 1. | +----------------+----------------------------------------------------------------------------------------------+ - | Marker2 | The trigger is received from the Marker 2. | + | "Marker2" | The trigger is received from the Marker 2. | +----------------+----------------------------------------------------------------------------------------------+ - | Marker3 | The trigger is received from the Marker 3. | + | "Marker3" | The trigger is received from the Marker 3. | +----------------+----------------------------------------------------------------------------------------------+ - .. 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. +-----------------------+------------+ @@ -10785,41 +10755,41 @@ pxi_chassis_clk10_source Specifies the clock source for driving the PXI 10 MHz backplane Reference Clock. This property is configurable if the PXI-5610 upconverter module is installed in *only* Slot 2 of a PXI chassis. To set this property, the NI-RFSG device must be in the Configuration state. - **Possible Values**: + **Possible Values**: Possible Value: Description - empty :Do not drive the PXI_CLK10 signal. + "" :Do not drive the PXI_CLK10 signal. - OnboardClock :Uses the highly stable oven-controlled onboard Reference Clock to drive the PXI_CLK signal. + "OnboardClock" :Uses the highly stable oven-controlled onboard Reference Clock to drive the PXI_CLK signal. - RefIn :Uses the clock present at the front panel REF IN connector to drive the PXI_CLK signal. + "RefIn" :Uses the clock present at the front panel REF IN connector to drive the PXI_CLK signal. - **Default Value:** empty + **Default Value:** "" - **Supported Devices:** PXI-5610, PXI-5670/5671 + **Supported Devices:** PXI-5610, PXI-5670/5671 - **Related Topics** + **Related Topics** - `Timing Configurations `_ + `Timing Configurations `_ - `System Reference Clock `_ + `System Reference Clock `_ - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.configure_pxi_chassis_clk10` + - :py:meth:`nirfsg.Session.configure_pxi_chassis_clk10` - Only certain combinations of this property and the :py:attr:`nirfsg.Session.ref_clock_source` property are valid, as shown in the following table. + Only certain combinations of this property and the :py:attr:`nirfsg.Session.ref_clock_source` property are valid, as shown in the following table. +------------------------------------------------------------+----------------------------------------------------+ | :py:attr:`nirfsg.Session.pxi_chassis_clk10_source` Setting | :py:attr:`nirfsg.Session.ref_clock_source` Setting | +============================================================+====================================================+ - | empty, OnboardClock | OnboardClock | + | "", OnboardClock | OnboardClock | +------------------------------------------------------------+----------------------------------------------------+ - | empty, RefIn | RefIn | + | "", RefIn | RefIn | +------------------------------------------------------------+----------------------------------------------------+ - | empty, RefIn | PXI_CLK | + | "", RefIn | PXI_CLK | +------------------------------------------------------------+----------------------------------------------------+ The following table lists the characteristics of this property. @@ -10847,13 +10817,13 @@ query_instrument_status Specifies whether NI-RFSG queries the NI-RFSG device status after each operation. Querying the device status is useful for debugging. After you validate your program, set this property to False to disable status checking and maximize performance. - NI-RFSG can choose to ignore status checking for particular properties, regardless of the setting of this property. Use the :py:meth:`nirfsg.Session.__init__` method to override the default value. + NI-RFSG can choose to ignore status checking for particular properties, regardless of the setting of this property. Use the :py:meth:`nirfsg.Session.__init__` method to override the default value. - **Default Value:** False + **Default Value:** False - **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 + **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 - **Defined Values**: + **Defined Values**: +-------+-------------------------------------------------------------+ | Value | Description | @@ -10888,11 +10858,11 @@ range_check Specifies whether to validate property values and method parameters. Range checking parameters is very useful for debugging. After you validate your program, set this property to False to disable range checking and maximize performance. NI-RFSG can choose to ignore range checking for particular properties, regardless of the setting of this property. Use the :py:meth:`nirfsg.Session.__init__` method to override the default value. - **Default Value:** True + **Default Value:** True - **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 + **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 - **Defined Values**: + **Defined Values**: +-------+-------------------------+ | Value | Description | @@ -10927,11 +10897,11 @@ record_coercions Specifies whether the IVI engine keeps a list of the value coercions it makes for integer and real type properties. - **Default Value:** False + **Default Value:** False - **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 + **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 - **Defined Values**: + **Defined Values**: +-------+---------------------------------------------------+ | Value | Description | @@ -10966,39 +10936,39 @@ ref_clock_rate .. py:attribute:: 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 :py:attr:`nirfsg.Session.ref_clock_source` property is set to :py:data:`~nirfsg.NIRFSG_VAL_CLK_IN_STR`, :py:data:`~nirfsg.NIRFSG_VAL_REF_IN_STR`, or :py:data:`~nirfsg.NIRFSG_VAL_REF_IN_2_STR` + 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 :py:attr:`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. + 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 :py:data:`~nirfsg.ReferenceClockRate.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. + If you set this property to :py:data:`~nirfsg.ReferenceClockRate.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:** + **Valid Values:** - PXIe-5654/5654 with PXIe-5696: Values between 1MHz to 20MHz in 1MHz steps are supported in addition to the :py:data:`~nirfsg.ReferenceClockRate.AUTO` and :py:data:`~nirfsg.ReferenceClockRate._10mhz` values. + PXIe-5654/5654 with PXIe-5696: Values between 1MHz to 20MHz in 1MHz steps are supported in addition to the :py:data:`~nirfsg.ReferenceClockRate.AUTO` and :py:data:`~nirfsg.ReferenceClockRate._10mhz` values. - PXIe-5841 with PXIe-5655, PXIe-5842: 10 MHz, 100 MHz, 270 MHz, and 3.84 MHz + PXIe-5841 with PXIe-5655, PXIe-5842: 10 MHz, 100 MHz, 270 MHz, and 3.84 MHz - y, where + y, where - y is 4, 8, 16, 24, 25, or 32. + y is 4, 8, 16, 24, 25, or 32. - PXIe-5860: 10 MHz, 100 MHz + PXIe-5860: 10 MHz, 100 MHz - **Units**: hertz (Hz) + **Units**: hertz (Hz) - **Default Value:** :py:data:`~nirfsg.ReferenceClockRate.AUTO` + **Default Value:** :py:data:`~nirfsg.ReferenceClockRate.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 + **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** + **Related Topics** - `Timing Configurations `_ + `Timing Configurations `_ - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.configure_ref_clock` + - :py:meth:`nirfsg.Session.configure_ref_clock` - **Defined Values**: + **Defined Values**: +----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | Value | Description | @@ -11037,40 +11007,38 @@ ref_clock_source Specifies the Reference Clock source. To set this property, the NI-RFSG device must be in the Configuration state. Only certain combinations of this property and the :py:attr:`nirfsg.Session.pxi_chassis_clk10_source` property are valid, as shown in the following table. - **Default Value:** :py:data:`~nirfsg.NIRFSG_VAL_ONBOARD_CLOCK_STR` + **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 + **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** + **Related Topics** - `Timing Configurations `_ + `Timing Configurations `_ - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.configure_ref_clock` + - :py:meth:`nirfsg.Session.configure_ref_clock` - **Possible Values**: + **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 :py:data:`~nirfsg.NIRFSG_VAL_PXI_CLK_STR` as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. | - +----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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. | + +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. note:: The PXI-5670/5671 and PXIe-5672 devices also allow you to drive the PXI 10 MHz backplane clock on PXI chassis *only* using the :py:attr:`nirfsg.Session.pxi_chassis_clk10_source` property. - .. 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. +-----------------------+------------+ @@ -11096,37 +11064,39 @@ ref_pll_bandwidth Configures the loop bandwidth of the reference PLL. - **Default Value:** :py:data:`~nirfsg.LoopBandwidth.NARROW` + **Default Value:** :py:data:`~nirfsg.RefPllBandwidth.NARROW` + + **Supported Devices:** PXIe-5653 - **Supported Devices:** PXIe-5653 + **Related Topics** - **Related Topics** + `Phase-Locked Loop Bandwidth `_ - `Phase-Locked Loop Bandwidth `_ + **Defined Values**: - **Defined Values**: + +-------------------------------------------+--------------------------------------------------------+ + | Value | Description | + +===========================================+========================================================+ + | :py:data:`~nirfsg.RefPllBandwidth.NARROW` | Uses the narrowest loop bandwidth setting for the PLL. | + +-------------------------------------------+--------------------------------------------------------+ + | :py:data:`~nirfsg.RefPllBandwidth.MEDIUM` | Uses the medium loop bandwidth setting for the PLL. | + +-------------------------------------------+--------------------------------------------------------+ + | :py:data:`~nirfsg.RefPllBandwidth.WIDE` | Uses the widest loop bandwidth setting for the PLL. | + +-------------------------------------------+--------------------------------------------------------+ - +-----------------------------------------+--------------------------------------------------------+ - | Value | Description | - +=========================================+========================================================+ - | :py:data:`~nirfsg.LoopBandwidth.NARROW` | Uses the narrowest loop bandwidth setting for the PLL. | - +-----------------------------------------+--------------------------------------------------------+ - | :py:data:`~nirfsg.LoopBandwidth.MEDIUM` | Uses the medium loop bandwidth setting for the PLL. | - +-----------------------------------------+--------------------------------------------------------+ - | :py:data:`~nirfsg.LoopBandwidth.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.LoopBandwidth | - +-----------------------+---------------------+ - | Permissions | read-write | - +-----------------------+---------------------+ - | Repeated Capabilities | None | - +-----------------------+---------------------+ + +-----------------------+-----------------------+ + | Characteristic | Value | + +=======================+=======================+ + | Datatype | enums.RefPllBandwidth | + +-----------------------+-----------------------+ + | Permissions | read-write | + +-----------------------+-----------------------+ + | Repeated Capabilities | None | + +-----------------------+-----------------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: @@ -11141,23 +11111,23 @@ 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. + 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 + **Units:** Seconds - **Valid Values:** + **Valid Values:** - PXIe-PXIe-5820/5830/5831/5832/5840/5841: 0 μs to 3.2 μs + PXIe-PXIe-5820/5830/5831/5832/5840/5841: 0 μs to 3.2 μs - PXIe-5842: 0 μs to 6.5 μs + PXIe-5842: 0 μs to 6.5 μs - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `NI-TClk Overview `_ + `NI-TClk Overview `_ @@ -11190,39 +11160,39 @@ 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. + 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. + 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-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. + 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 :py:meth:`nirfsg.Session.reset` or `niRFSA_reset `_ on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call :py:meth:`nirfsg.Session.ResetWithOptions` or `niRFSA_ResetWithOptions `_. Select **Routes** in the **steps to omit** parameter. + For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any :py:meth:`nirfsg.Session.reset` or `niRFSA_reset `_ on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call :py:meth:`nirfsg.Session.ResetWithOptions` or `niRFSA_ResetWithOptions `_. Select **Routes** in the **steps to omit** parameter. - **Default Value:** "" (empty string) + **Default Value:** "" (empty string) - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Marker Events `_ + `Marker Events `_ - **Valid Values**: + **Valid Values**: - +-------------------+---------------------------------+ - | Value | Description | - +===================+=================================+ - | "" (empty string) | 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. | - +-------------------+---------------------------------+ + +-----------+---------------------------------+ + | 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. @@ -11251,15 +11221,15 @@ rf_in_lo_export_enabled Specifies whether to enable the RF IN LO OUT terminal on the PXIe-5840/5841. - Set this property to :py:data:`~nirfsg.RFInLoExportEnabled.ENABLE` to export the LO signal from the RF IN LO OUT terminal. + Set this property to :py:data:`~nirfsg.RFInLoExportEnabled.ENABLE` to export the LO signal from the RF IN LO OUT terminal. - When this property is enabled, if the :py:attr:`nirfsg.Session.lo_source` property is set to :py:data:`~nirfsg.NIRFSG_VAL_LO_SOURCE_LO_IN_STR` and you do not set the :py:attr:`nirfsg.Session.lo_frequency` or :py:attr:`nirfsg.Session.upconverter_center_frequency` properties, NI-RFSG rounds the LO frequency to approximately an LO step size as if the source was :py:data:`~nirfsg.NIRFSG_VAL_ONBOARD_CLOCK_STR`. This ensures that when you configure NI-RFSA and NI-RFSG with compatible settings that result in the same LO frequency, the rounding also is compatible. + When this property is enabled, if the :py:attr:`nirfsg.Session.lo_source` property is set to LO_In and you do not set the :py:attr:`nirfsg.Session.lo_frequency` or :py:attr:`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:** :py:data:`~nirfsg.RFInLoExportEnabled.UNSPECIFIED` + **Default Value:** :py:data:`~nirfsg.RFInLoExportEnabled.UNSPECIFIED` - **Supported Devices**: PXIe-5840/5841/5842 + **Supported Devices**: PXIe-5840/5841/5842 - **Defined Values**: + **Defined Values**: +----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | Value | Description | @@ -11298,27 +11268,27 @@ script_trigger_terminal_name Returns the name of the fully qualified signal name as a string. - **Default Values**: + **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. + 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-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-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. + 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 + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Triggers `_ + `Triggers `_ - `Syntax for Terminal Names `_ + `Syntax for Terminal Names `_ - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.get_terminal_name` + - :py:meth:`nirfsg.Session.get_terminal_name` @@ -11357,21 +11327,21 @@ 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:** :py:data:`~nirfsg.ScriptTrigType.NONE` + **Default Value:** :py:data:`~nirfsg.ScriptTrigType.NONE` - **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Script Trigger `_ + `Script Trigger `_ - `Trigger Types `_ + `Trigger Types `_ - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.configure_digital_edge_script_trigger` + - :py:meth:`nirfsg.Session.configure_digital_edge_script_trigger` - **Defined Values**: + **Defined Values**: +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Value | Description | @@ -11447,25 +11417,25 @@ selected_ports Specifies the port to configure. - **Valid Values**: + **Valid Values**: - PXIe-5644/5645/5646, PXIe-5820/5840/5841: "" (empty string) + PXIe-5644/5645/5646, PXIe-5820/5840/5841: "" (empty string) - PXIe-5830: if0, if1 + 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. + 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:** + **Default Value:** - PXIe-5644/5645/5646, PXIe-5820/5840/5841/5842/5860: "" (empty string) + PXIe-5644/5645/5646, PXIe-5820/5840/5841/5842/5860: "" (empty string) - PXIe-5830/5831/5832: if0 + PXIe-5830/5831/5832: if0 - **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - :py:attr:`nirfsg.Session.available_ports` + :py:attr:`nirfsg.Session.available_ports` @@ -11496,15 +11466,15 @@ selected_script Specifies the script in onboard memory to generate upon calling the :py:meth:`nirfsg.Session._initiate` method when the :py:attr:`nirfsg.Session.generation_mode` property is set to :py:data:`~nirfsg.GenerationMode.SCRIPT`. - The :py:attr:`nirfsg.Session.selected_script` property is ignored when the :py:attr:`nirfsg.Session.generation_mode` property is set to :py:data:`~nirfsg.GenerationMode.ARB_WAVEFORM` or :py:data:`~nirfsg.GenerationMode.CW`. To set the :py:attr:`nirfsg.Session.selected_script` property, the NI-RFSG device must be in the Configuration state. + The :py:attr:`nirfsg.Session.selected_script` property is ignored when the :py:attr:`nirfsg.Session.generation_mode` property is set to :py:data:`~nirfsg.GenerationMode.ARB_WAVEFORM` or :py:data:`~nirfsg.GenerationMode.CW`. To set the :py:attr:`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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Assigning Properties or Properties to a Waveform `_ + `Assigning Properties or Properties to a Waveform `_ - `Scripting Instructions `_ + `Scripting Instructions `_ The following table lists the characteristics of this property. @@ -11531,7 +11501,7 @@ 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 + **Supported Devices:** PXIe-5644/5645/5646 The following table lists the characteristics of this property. @@ -11558,7 +11528,7 @@ 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 + **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. @@ -11585,31 +11555,31 @@ signal_bandwidth Specifies the bandwidth of the arbitrary signal. This value must be less than or equal to (0.8× :py:attr:`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* :sub:`max` - *f* :sub:`min` . + 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* :sub:`max` - *f* :sub:`min` . - This property applies only when the :py:attr:`nirfsg.Session.generation_mode` property is set to :py:data:`~nirfsg.GenerationMode.ARB_WAVEFORM` or :py:data:`~nirfsg.GenerationMode.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 :py:attr:`nirfsg.Session.signal_bandwidth` property, the NI-RFSG device must be in the Configuration state. + This property applies only when the :py:attr:`nirfsg.Session.generation_mode` property is set to :py:data:`~nirfsg.GenerationMode.ARB_WAVEFORM` or :py:data:`~nirfsg.GenerationMode.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 :py:attr:`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. + 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-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. + 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) + **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 + **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** + **Related Topics** - `Phase-Locked Loop Bandwidth `_ + `Phase-Locked Loop Bandwidth `_ - `Frequency Tuning Times `_ + `Frequency Tuning Times `_ - `PXIe-5830 Frequency and Bandwidth Selection `_ + `PXIe-5830 Frequency and Bandwidth Selection `_ - `PXIe-5831/5832 Frequency and Bandwidth Selection `_ + `PXIe-5831/5832 Frequency and Bandwidth Selection `_ - `PXIe-5841 Frequency and Bandwidth Selection `_ + `PXIe-5841 Frequency and Bandwidth Selection `_ The following table lists the characteristics of this property. @@ -11636,9 +11606,9 @@ simulate Returns whether NI-RFSG simulates I/O operations. This property is useful for debugging applications without using hardware. After a session is opened, you cannot change the simulation state. Use the :py:meth:`nirfsg.Session.__init__` method to enable simulation. - **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 + **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 - **Defined Values**: + **Defined Values**: +-------+-------------------------+ | Value | Description | @@ -11673,7 +11643,7 @@ 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 + **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. @@ -11700,7 +11670,7 @@ 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 + **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. @@ -11727,9 +11697,9 @@ specific_driver_description Returns a string that contains a brief description of NI-RFSG. This property returns - National Instruments RF Signal Generator Instrument Driver. + 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 + **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. @@ -11756,9 +11726,9 @@ 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. + 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 + **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. @@ -11785,9 +11755,9 @@ 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. + 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 + **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. @@ -11814,9 +11784,9 @@ specific_driver_vendor Returns a string that contains the name of the vendor that supplies NI-RFSG. This property returns - National Instruments. + 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 + **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. @@ -11843,27 +11813,27 @@ started_event_terminal_name Returns the name of the fully qualified signal name as a string. - **Default Values**: + **Default Values**: - PXI-5670/5671, PXIe-5672/5673/5673E: /*AWGName*/StartedEvent, where *AWGName* is the name of your associated AWG module in MAX. + 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-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-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). + 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 + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Events `_ + `Events `_ - `Syntax for Terminal Names `_ + `Syntax for Terminal Names `_ - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.get_terminal_name` + - :py:meth:`nirfsg.Session.get_terminal_name` The following table lists the characteristics of this property. @@ -11890,29 +11860,29 @@ start_trigger_terminal_name Returns the name of the fully qualified signal name as a string. - **Default Values**: + **Default Values**: - PXIe-5654/5654 with PXIe-5696: /*ModuleName*/StartTrigger, where *ModuleName* is the name of your device in MAX. + 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. + 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-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-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). + 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 + **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** + **Related Topics** - `Start Trigger `_ + `Start Trigger `_ - `Syntax for Terminal Names `_ + `Syntax for Terminal Names `_ - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.get_terminal_name` + - :py:meth:`nirfsg.Session.get_terminal_name` The following table lists the characteristics of this property. @@ -11939,23 +11909,23 @@ 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:** :py:data:`~nirfsg.StartTrigType.NONE` + **Default Value:** :py:data:`~nirfsg.StartTrigType.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 + **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** + **Related Topics** - `Start Trigger `_ + `Start Trigger `_ - `Trigger Types `_ + `Trigger Types `_ - **High-Level Methods**: + **High-Level Methods**: - - :py:meth:`nirfsg.Session.configure_digital_edge_start_trigger` - - :py:meth:`nirfsg.Session.configure_software_start_trigger` - - :py:meth:`nirfsg.Session.disable_start_trigger` + - :py:meth:`nirfsg.Session.configure_digital_edge_start_trigger` + - :py:meth:`nirfsg.Session.configure_software_start_trigger` + - :py:meth:`nirfsg.Session.disable_start_trigger` - **Defined Values**: + **Defined Values**: +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Value | Description | @@ -11996,15 +11966,15 @@ streaming_enabled Enables and disables continuous streaming of waveform data. - **Default Value:** False + **Default Value:** False - **Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Streaming `_ + `Streaming `_ - **Defined Values**: + **Defined Values**: +-------+------------------------+ | Value | Description | @@ -12039,15 +12009,15 @@ 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. + To read this property, the NI-RFSG device must be in the Committed state. - **Units**: samples + **Units**: samples - **Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Streaming `_ + `Streaming `_ The following table lists the characteristics of this property. @@ -12074,15 +12044,15 @@ streaming_waveform_name Specifies the name of the waveform used to continually stream data during generation. - **Default Value:** "" (empty string) + **Default Value:** "" (empty string) - **Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Streaming `_ + `Streaming `_ - `Streaming Waveform Data `_ + `Streaming Waveform Data `_ The following table lists the characteristics of this property. @@ -12109,15 +12079,15 @@ streaming_write_timeout Indicates the maximum amount of time allowed to complete a streaming write operation. - **Default Value:** 10.0seconds + **Default Value:** 10.0seconds - **Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Streaming `_ + `Streaming `_ - `Streaming Waveform Data `_ + `Streaming Waveform Data `_ The following table lists the characteristics of this property. @@ -12144,7 +12114,7 @@ supported_instrument_models Returns a string that contains a model code of the NI-RFSG device. For drivers that support more than one device, this property contains 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 + **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. @@ -12171,17 +12141,17 @@ 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. + 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 + **Valid Values:** PXI_Trig0, PXI_Trig1, PXI_Trig2, PXI_Trig3, PXI_Trig4, PXI_Trig5, PXI_Trig6, PXI_Trig7, PFI0 - **Default Value:** "" (empty string) + **Default Value:** "" (empty string) - **Supported Devices:** PXIe-5646 + **Supported Devices:** PXIe-5646 - **Related Topics** + **Related Topics** - `Synchronization Using NI-RFSA and NI-RFSG `_—Refer to this topic for more information about PXIe-5646 device synchronization. + `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. @@ -12208,19 +12178,19 @@ 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. + 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. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** False + **Default Value:** False - **Supported Devices:** PXIe-5646 + **Supported Devices:** PXIe-5646 - **Related Topics** + **Related Topics** - `Synchronization Using NI-RFSA and NI-RFSG `_—Refer to this topic for more information about PXIe-5646 device synchronization. + `Synchronization Using NI-RFSA and NI-RFSG `_—Refer to this topic for more information about PXIe-5646 device synchronization. - **Defined Values**: + **Defined Values**: +-------+---------------------------------------------------------------------+ | Value | Description | @@ -12255,21 +12225,21 @@ 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. + 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 + **Valid Values:** PXI_Trig0, PXI_Trig1, PXI_Trig2, PXI_Trig3, PXI_Trig4, PXI_Trig5, PXI_Trig6, PXI_Trig7, PFI0 - **Default Value:** "" (empty string) + **Default Value:** "" (empty string) - **Supported Devices:** PXIe-5644/5645/5646 + **Supported Devices:** PXIe-5644/5645/5646 - **Related Topics** + **Related Topics** - `Script Trigger `_ + `Script Trigger `_ - `Synchronizing Sample Clock and Sampled Reference Clock Signals `_ + `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. + 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. @@ -12296,25 +12266,25 @@ 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. + 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 :py:attr:`nirfsg.Session.script_trigger_type` property to digital edge, and set the :py:attr:`nirfsg.Session.digital_edge_script_trigger_source` property to sync_script. + 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 :py:attr:`nirfsg.Session.script_trigger_type` property to digital edge, and set the :py:attr:`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. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** False + **Default Value:** False - **Supported Devices:** PXIe-5644/5645/5646 + **Supported Devices:** PXIe-5644/5645/5646 - **Related Topics** + **Related Topics** - `Script Trigger `_ + `Script Trigger `_ - `Synchronizing Sample Clock and Sampled Reference Clock Signals `_ + `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. + 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**: + **Defined Values**: +-------+-----------------------------------------------------------------------+ | Value | Description | @@ -12349,19 +12319,19 @@ 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. + 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 + **Valid Values:** PXI_Trig0, PXI_Trig1, PXI_Trig2, PXI_Trig3, PXI_Trig4, PXI_Trig5, PXI_Trig6, PXI_Trig7, PFI0 - **Default Value:** "" (empty string) + **Default Value:** "" (empty string) - **Supported Devices:** PXIe-5644/5645/5646 + **Supported Devices:** PXIe-5644/5645/5646 - **Related Topics** + **Related Topics** - `Start Trigger `_ + `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. + 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. @@ -12388,21 +12358,21 @@ 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 :py:attr:`nirfsg.Session.start_trigger_type` property to digital edge, and set the :py:attr:`nirfsg.Session.digital_edge_start_trigger_source` property to sync_script. + 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 :py:attr:`nirfsg.Session.start_trigger_type` property to digital edge, and set the :py:attr:`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. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** False + **Default Value:** False - **Supported Devices:** PXIe-5644/5645/5646 + **Supported Devices:** PXIe-5644/5645/5646 - **Related Topics** + **Related Topics** - `Start Trigger `_ + `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. + 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**: + **Defined Values**: +-------+----------------------------------------------------------------------+ | Value | Description | @@ -12437,9 +12407,9 @@ temperature_read_interval Specifies the minimum time between temperature sensor readings. - **Units:** Seconds + **Units:** Seconds - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 The following table lists the characteristics of this property. @@ -12466,17 +12436,17 @@ thermal_correction_headroom_range Specifies the expected thermal operating range of the instrument from the self-calibration temperature, in degrees Celsius, returned from the :py:attr:`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. + 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) + **Units:** degrees Celsius (°C) - **Default Value**: + **Default Value**: - **PXIe-5830/5831/5832/5842/5860**: 5 + **PXIe-5830/5831/5832/5842/5860**: 5 - **PXIe-5840/5841**: 10 + **PXIe-5840/5841**: 10 - **Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860 + **Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860 The following table lists the characteristics of this property. @@ -12503,15 +12473,15 @@ 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) + **Units:** degrees Celsius (°C) - **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Default Values:** + **Default Values:** - PXIe-5830/5831/5832/5842/5860: 0.2 + PXIe-5830/5831/5832/5842/5860: 0.2 - PXIe-5840/5841: 1.0 + PXIe-5840/5841: 1.0 The following table lists the characteristics of this property. @@ -12538,15 +12508,15 @@ 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) + **Units**: seconds (s) - **Default Value:** 0 + **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 + **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** + **Related Topics** - `Events `_ + `Events `_ @@ -12577,9 +12547,9 @@ 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) + **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 + **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 @@ -12616,33 +12586,33 @@ upconverter_frequency_offset This property offsets the :py:attr:`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:** + **Valid Values:** - PXIe-5644/5645: -42MHz to +42MHz + PXIe-5644/5645: -42MHz to +42MHz - PXIe-5646: -100MHz to +100MHz + PXIe-5646: -100MHz to +100MHz - PXIe-5830/5831/5832/5840/5841: -500MHz to +500MHz + PXIe-5830/5831/5832/5840/5841: -500MHz to +500MHz - PXI-5842 (500 MHz bandwidth option): -250MHz to +250MHz + PXI-5842 (500 MHz bandwidth option): -250MHz to +250MHz - PXI-5842 (1 GHz bandwidth option): -500MHz to +500MHz + PXI-5842 (1 GHz bandwidth option): -500MHz to +500MHz - PXI-5842 (2 GHz bandwidth option): -1GHz to +1GHz + 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 Standard personality: -1GHz to +1GHz - PXIe-5842 (4 GHz bandwidth option) using the 4 GHz Bandwidth personality: -2GHz to +2GHz + 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 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `PXIe-5830 Frequency and Bandwidth Selection `_ + `PXIe-5830 Frequency and Bandwidth Selection `_ - `PXIe-5831/5832 Frequency and Bandwidth Selection `_ + `PXIe-5831/5832 Frequency and Bandwidth Selection `_ - `PXIe-5841 Frequency and Bandwidth Selection `_ + `PXIe-5841 Frequency and Bandwidth Selection `_ @@ -12675,27 +12645,27 @@ 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. + 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 :py:data:`~nirfsg.UpconverterFrequencyOffsetMode.AUTO` or :py:data:`~nirfsg.UpconverterFrequencyOffsetMode.USER_DEFINED`, and set either the :py:attr:`nirfsg.Session.upconverter_center_frequency` or the :py:attr:`nirfsg.Session.upconverter_frequency_offset` property. + To set an offset yourself, set this property to :py:data:`~nirfsg.UpconverterFrequencyOffsetMode.AUTO` or :py:data:`~nirfsg.UpconverterFrequencyOffsetMode.USER_DEFINED`, and set either the :py:attr:`nirfsg.Session.upconverter_center_frequency` or the :py:attr:`nirfsg.Session.upconverter_frequency_offset` property. - To allow NI-RFSG to automatically select the upconverter frequency offset, set this property to :py:data:`~nirfsg.UpconverterFrequencyOffsetMode.AUTO` or :py:data:`~nirfsg.UpconverterFrequencyOffsetMode.ENABLE` and set the :py:attr:`nirfsg.Session.signal_bandwidth` to describe the bandwidth of your waveform. The signal bandwidth must be no greater than half the value of the :py:attr:`nirfsg.Session.device_instantaneous_bandwidth` property, minus a device-specific guard band. Do not set the :py:attr:`nirfsg.Session.upconverter_center_frequency` or :py:attr:`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 :py:data:`~nirfsg.UpconverterFrequencyOffsetMode.ENABLE` if you want to receive an error any time NI-RFSG is unable to apply automatic offset. + To allow NI-RFSG to automatically select the upconverter frequency offset, set this property to :py:data:`~nirfsg.UpconverterFrequencyOffsetMode.AUTO` or :py:data:`~nirfsg.UpconverterFrequencyOffsetMode.ENABLE` and set the :py:attr:`nirfsg.Session.signal_bandwidth` to describe the bandwidth of your waveform. The signal bandwidth must be no greater than half the value of the :py:attr:`nirfsg.Session.device_instantaneous_bandwidth` property, minus a device-specific guard band. Do not set the :py:attr:`nirfsg.Session.upconverter_center_frequency` or :py:attr:`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 :py:data:`~nirfsg.UpconverterFrequencyOffsetMode.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 :py:attr:`nirfsg.Session.upconverter_frequency_offset_mode` returns :py:data:`~nirfsg.UpconverterFrequencyOffsetMode.USER_DEFINED`. When NI-RFSG automatically sets an offset, the reference frequency for gain is near the :py:attr:`nirfsg.Session.frequency` and :py:attr:`nirfsg.Session.upconverter_frequency_offset_mode` returns :py:data:`~nirfsg.UpconverterFrequencyOffsetMode.ENABLE`. + When you set an offset yourself or do not use an offset, the reference frequency for gain is near the upconverter center frequency, and :py:attr:`nirfsg.Session.upconverter_frequency_offset_mode` returns :py:data:`~nirfsg.UpconverterFrequencyOffsetMode.USER_DEFINED`. When NI-RFSG automatically sets an offset, the reference frequency for gain is near the :py:attr:`nirfsg.Session.frequency` and :py:attr:`nirfsg.Session.upconverter_frequency_offset_mode` returns :py:data:`~nirfsg.UpconverterFrequencyOffsetMode.ENABLE`. - **Default Value:** :py:data:`~nirfsg.UpconverterFrequencyOffsetMode.AUTO` + **Default Value:** :py:data:`~nirfsg.UpconverterFrequencyOffsetMode.AUTO` - **Supported Devices**: PXIe-5830/5831/5832/5841/5842 + **Supported Devices**: PXIe-5830/5831/5832/5841/5842 - **Related Topics** + **Related Topics** - `PXIe-5830 Automatic Frequency Offset `_ + `PXIe-5830 Automatic Frequency Offset `_ - `PXIe-5831/5832 Automatic Frequency Offset `_ + `PXIe-5831/5832 Automatic Frequency Offset `_ - `PXIe-5841 Automatic Frequency Offset `_ + `PXIe-5841 Automatic Frequency Offset `_ - **Defined Values**: + **Defined Values**: +----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Value | Description | @@ -12736,9 +12706,9 @@ upconverter_gain Specifies the gain the upconverter applies to the signal. - **Units**: dB + **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 + **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 @@ -12769,15 +12739,15 @@ 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 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Streaming `_ + `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. + `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 `_ + `Digital Upconverter `_ @@ -12816,7 +12786,7 @@ waveform_papr Specifies the peak-to-average power ratio (PAPR). - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -12861,15 +12831,15 @@ waveform_rf_blanking :py:data:`~nirfsg.RFBlanking.ENABLE` (1): RF blanking is enabled. - **Default Value:** :py:data:`~nirfsg.RFBlanking.DISABLE` + **Default Value:** :py:data:`~nirfsg.RFBlanking.DISABLE` - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Marker Events `_ + `Marker Events `_ - Enables or disables RF blanking. + Enables or disables RF blanking. +---------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ | :py:attr:`nirfsg.Session.rf_blanking_source` | :py:attr:`nirfsg.Session.waveform_rf_blanking` | Behaviour | @@ -12922,9 +12892,9 @@ 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 + **Units**: dB - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860, PXIe-5841 with PXIe-5655 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860, PXIe-5841 with PXIe-5655 @@ -12963,9 +12933,9 @@ waveform_signal_bandwidth Specifies the bandwidth of the arbitrary signal. This value must be less than or equal to (0.8× :py:attr:`nirfsg.Session.iq_rate`). - **Units**: hertz (Hz) + **Units**: hertz (Hz) - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -13004,7 +12974,7 @@ 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 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5841 with PXIe-5655/5842/5860 @@ -13043,11 +13013,11 @@ 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 :py:meth:`nirfsg.Session.get_waveform_burst_start_locations` and :py:meth:`nirfsg.Session.get_waveform_burst_stop_locations` methods respectively. - **Default Value:** :py:data:`~nirfsg.WriteWaveformBurstDetection.DISABLE` + **Default Value:** :py:data:`~nirfsg.WriteWaveformBurstDetection.DISABLE` - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Defined Values**: + **Defined Values**: +--------------------------------------------------------+------------------------------+ | Value | Description | @@ -13088,11 +13058,11 @@ 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 :py:attr:`nirfsg.Session.write_waveform_burst_detection` property. When you set :py:attr:`nirfsg.Session.write_waveform_burst_detection_mode` to :py:data:`~nirfsg.WriteWaveformBurstDetectionMode.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 :py:data:`~nirfsg.WriteWaveformBurstDetectionMode.MANUAL` and specify the burst detection parameters using the write waveform burst detection minimum quiet time, :py:attr:`nirfsg.Session.write_waveform_burst_detection_power_threshold`, write waveform burst detection minimum burst time properties. - **Default Value:** :py:data:`~nirfsg.WriteWaveformBurstDetectionMode.AUTO` + **Default Value:** :py:data:`~nirfsg.WriteWaveformBurstDetectionMode.AUTO` - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Defined Values**: + **Defined Values**: +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------+ | Value | Description | @@ -13129,11 +13099,11 @@ 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 :py:attr:`nirfsg.Session.write_waveform_burst_detection` property or when you set the :py:attr:`nirfsg.Session.write_waveform_burst_detection_mode` property to :py:data:`~nirfsg.NIRFSG_VAL_AUTO`. - **Units:** dB + **Units:** dB - **Default Value:** 0 + **Default Value:** 0 - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -13164,11 +13134,11 @@ write_waveform_normalization Specifies whether to perform the normalization on a waveform. - **Default Value:** :py:data:`~nirfsg.WriteWaveformNormalization.DISABLE` + **Default Value:** :py:data:`~nirfsg.WriteWaveformNormalization.DISABLE` - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Defined Values**: + **Defined Values**: +-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | Value | Description | @@ -13207,11 +13177,11 @@ yig_main_coil_drive Adjusts the dynamics of the current driving the YIG main coil. - **Default Value:** :py:data:`~nirfsg.YigMainCoilDrive.MANUAL` + **Default Value:** :py:data:`~nirfsg.YigMainCoilDrive.MANUAL` - **Supported Devices:** PXIe-5653 + **Supported Devices:** PXIe-5653 - **Defined Values**: + **Defined Values**: +------------------------------------------+--------------------------------------------------------+ | Value | Description | diff --git a/docs/nirfsg/enums.rst b/docs/nirfsg/enums.rst index 94bb59629..04dc9bff9 100644 --- a/docs/nirfsg/enums.rst +++ b/docs/nirfsg/enums.rst @@ -848,6 +848,51 @@ LoPlLfractionalModeEnabled +LoadConfigurationResetOptions +----------------------------- + +.. py:class:: LoadConfigurationResetOptions + + .. py:attribute:: LoadConfigurationResetOptions.WAVEFORMS + + + + NI-RFSG skips resetting the waveform configurations. + + + + + + .. py:attribute:: LoadConfigurationResetOptions.DEEMBEDDING_TABLES + + + + NI-RFSG skips resetting the de-embedding tables. + + + + + + .. py:attribute:: LoadConfigurationResetOptions.SCRIPTS + + + + NI-RFSG skips resetting the scripts. + + + + + + .. py:attribute:: LoadConfigurationResetOptions.NONE + + + + NI-RFSG resets all configurations. + + + + + LoadOptions ----------- @@ -1363,10 +1408,6 @@ RFInLoExportEnabled - .. py:attribute:: RFInLoExportEnabled.MANUAL - - - .. py:attribute:: RFInLoExportEnabled.ENABLE @@ -1377,61 +1418,47 @@ RFInLoExportEnabled - .. py:attribute:: RFInLoExportEnabled.SCRIPT_TRIGGER - - +RefPllBandwidth +--------------- -ReferenceClockExportedRate --------------------------- +.. py:class:: RefPllBandwidth -.. py:class:: ReferenceClockExportedRate - - .. py:attribute:: ReferenceClockExportedRate._10mhz + .. py:attribute:: RefPllBandwidth.NARROW - Uses a 10MHz Reference Clock rate. + Uses the narrowest loop bandwidth setting for the PLL. Setting this property to :py:data:`~nirfsg.NIRFSG_VAL_NARROW` allows the PXIe-5653 to lock to a reference with worse phase noise than the PXIe-5653 and utilize the better phase noise of the PXIe-5653. - .. py:attribute:: ReferenceClockExportedRate._100mhz + .. py:attribute:: RefPllBandwidth.MEDIUM - Uses a 100MHz Reference Clock rate. + Uses the medium loop bandwidth setting for the PLL. - .. py:attribute:: ReferenceClockExportedRate._1ghz + .. py:attribute:: RefPllBandwidth.WIDE - Uses a 1GHz Reference Clock rate. + Uses the widest loop bandwidth setting for the PLL. Setting this property to :py:data:`~nirfsg.NIRFSG_VAL_WIDE` on the PXIe-5653 allows the reference PLL to lock to a better reference with better phase noise than the PXIe-5653 and utilize the better phase noise of the reference. -ReferenceClockRate ------------------- - -.. py:class:: ReferenceClockRate - - .. py:attribute:: ReferenceClockRate.AUTO - - - - Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it. - - - +ReferenceClockExportedRate +-------------------------- +.. py:class:: ReferenceClockExportedRate - .. py:attribute:: ReferenceClockRate._10mhz + .. py:attribute:: ReferenceClockExportedRate._10mhz @@ -1441,92 +1468,76 @@ ReferenceClockRate -RelativeTo ----------- - -.. py:class:: RelativeTo - - .. py:attribute:: RelativeTo.CURRENT_POSITION + .. py:attribute:: ReferenceClockExportedRate._100mhz - The reference position is relative to the current position. + Uses a 100MHz Reference Clock rate. - .. py:attribute:: RelativeTo.START_OF_WAVEFORM + .. py:attribute:: ReferenceClockExportedRate._1ghz - The reference position is relative to the start of the waveform. + Uses a 1GHz Reference Clock rate. -ResetOptions ------------- +ReferenceClockRate +------------------ -.. py:class:: ResetOptions +.. py:class:: ReferenceClockRate - .. py:attribute:: ResetOptions.RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_WAVEFORMS + .. py:attribute:: ReferenceClockRate.AUTO - NI-RFSG skips resetting the waveform configurations. + Uses the default Reference Clock rate for the device or automatically detects the Reference Clock rate if the device supports it. - .. py:attribute:: ResetOptions.MANUAL - - - - .. py:attribute:: ResetOptions.RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_DEEMBEDDING_TABLES + .. py:attribute:: ReferenceClockRate._10mhz - NI-RFSG skips resetting the de-embedding tables. + Uses a 10MHz Reference Clock rate. - .. py:attribute:: ResetOptions.SCRIPT_TRIGGER - +RelativeTo +---------- +.. py:class:: RelativeTo - .. py:attribute:: ResetOptions.RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_SCRIPTS + .. py:attribute:: RelativeTo.CURRENT_POSITION - NI-RFSG skips resetting the scripts. + The reference position is relative to the current position. - .. py:attribute:: ResetOptions.MARKER_EVENT - - - - .. py:attribute:: ResetOptions.RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_NONE + .. py:attribute:: RelativeTo.START_OF_WAVEFORM - NI-RFSG resets all configurations. + The reference position is relative to the start of the waveform. - .. py:attribute:: ResetOptions.SELF_CAL_IMAGE_SUPPRESSION - - - ResetWithOptionsStepsToOmit --------------------------- diff --git a/generated/nirfsg/nirfsg/enums.py b/generated/nirfsg/nirfsg/enums.py index 7d316a441..90240376d 100644 --- a/generated/nirfsg/nirfsg/enums.py +++ b/generated/nirfsg/nirfsg/enums.py @@ -364,6 +364,25 @@ class LoPlLfractionalModeEnabled(Enum): SCRIPT_TRIGGER = 1 +class LoadConfigurationResetOptions(Enum): + WAVEFORMS = 1 + r''' + NI-RFSG skips resetting the waveform configurations. + ''' + DEEMBEDDING_TABLES = 8 + r''' + NI-RFSG skips resetting the de-embedding tables. + ''' + SCRIPTS = 2 + r''' + NI-RFSG skips resetting the scripts. + ''' + NONE = 0 + r''' + NI-RFSG resets all configurations. + ''' + + class LoadOptions(Enum): NONE = 0 r''' @@ -585,12 +604,25 @@ class RFInLoExportEnabled(Enum): r''' The RF In local oscillator signal is not present at the front panel LO OUT connector. ''' - MANUAL = 0 ENABLE = 1 r''' The RF In local oscillator signal is present at the front panel LO OUT connector. ''' - SCRIPT_TRIGGER = 1 + + +class RefPllBandwidth(Enum): + NARROW = 0 + r''' + Uses the narrowest loop bandwidth setting for the PLL. Setting this property to NIRFSG_VAL_NARROW allows the PXIe-5653 to lock to a reference with worse phase noise than the PXIe-5653 and utilize the better phase noise of the PXIe-5653. + ''' + MEDIUM = 1 + r''' + Uses the medium loop bandwidth setting for the PLL. + ''' + WIDE = 2 + r''' + Uses the widest loop bandwidth setting for the PLL. Setting this property to NIRFSG_VAL_WIDE on the PXIe-5653 allows the reference PLL to lock to a better reference with better phase noise than the PXIe-5653 and utilize the better phase noise of the reference. + ''' class ReferenceClockExportedRate(Enum): @@ -630,29 +662,6 @@ class RelativeTo(Enum): ''' -class ResetOptions(Enum): - RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_WAVEFORMS = 1 - r''' - NI-RFSG skips resetting the waveform configurations. - ''' - MANUAL = 0 - RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_DEEMBEDDING_TABLES = 8 - r''' - NI-RFSG skips resetting the de-embedding tables. - ''' - SCRIPT_TRIGGER = 1 - RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_SCRIPTS = 2 - r''' - NI-RFSG skips resetting the scripts. - ''' - MARKER_EVENT = 2 - RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_NONE = 0 - r''' - NI-RFSG resets all configurations. - ''' - SELF_CAL_IMAGE_SUPPRESSION = 8 - - class ResetWithOptionsStepsToOmit(Enum): DEEMBEDDING_TABLES = 8 r''' diff --git a/generated/nirfsg/nirfsg/session.py b/generated/nirfsg/nirfsg/session.py index 90f5e9f72..661d8b273 100644 --- a/generated/nirfsg/nirfsg/session.py +++ b/generated/nirfsg/nirfsg/session.py @@ -100,13 +100,13 @@ class _SessionBase(object): 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. + To set this property, the NI-RFSG device must be in the Configuration state. - **Units:** Seconds + **Units:** Seconds - **Valid Values:** Plus or minus half of one Sample Clock period + **Valid Values:** Plus or minus half of one Sample Clock period - **Supported Devices:** PXIe-5820/5840/5841/5842 + **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. @@ -117,36 +117,36 @@ class _SessionBase(object): Returns the amplitude extender module temperature in degrees Celsius. - **Units**: degrees Celsius (°C) + **Units**: degrees Celsius (°C) - **Supported Devices:** PXIe-5654 with PXIe-5696 + **Supported Devices:** PXIe-5654 with PXIe-5696 ''' alc_control = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.AutomaticLevelControl, 1150195) '''Type: enums.AutomaticLevelControl 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 alc_control property also allows for NI-RFSG to perform an automatic power search. + 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 alc_control property also allows for NI-RFSG to perform an automatic power search. - PXIe-5654: AutomaticLevelControl.DISABLE is the only supported value for this device. The PXIe-5654 does not support the ALC when used as a stand-alone device. + PXIe-5654: AutomaticLevelControl.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:** + **Default Value:** - PXIe-5654: AutomaticLevelControl.DISABLE + PXIe-5654: AutomaticLevelControl.DISABLE - PXIe-5654 with PXIe-5696: AutomaticLevelControl.ENABLE + PXIe-5654 with PXIe-5696: AutomaticLevelControl.ENABLE - **Supported Devices:** PXIe-5654/5654 with PXIe-5696 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Power Level Adjustment `_ + `Power Level Adjustment `_ - `ALC Closed Loop Versus Open Loop `_ + `ALC Closed Loop Versus Open Loop `_ - `Power Search `_ + `Power Search `_ - **Defined Values**: + **Defined Values**: +-------------------------------+---------+------------------+ | Name | Value | Description | @@ -164,13 +164,13 @@ class _SessionBase(object): 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 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. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** AllowOutOfSpecificationUserSettings.DISABLE + **Default Value:** AllowOutOfSpecificationUserSettings.DISABLE - **Supported Devices:** PXI/PXIe-5650/5651/5652, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **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**: + **Defined Values**: +---------------------------------------------+---------+----------------------------------------------+ | Name | Value | Description | @@ -190,54 +190,54 @@ class _SessionBase(object): Configures the amplitude settling accuracy in decibels. NI-RFSG waits until the RF power settles within the specified accuracy level after calling the _initiate method or 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. + 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. + PXI/PXIe-5650/5651/5652: This property is for NI internal use only. - **Units**: dB + **Units**: dB - **Default Value:** + **Default Value:** - PXIe-5654: 4 + PXIe-5654: 4 - PXIe-5654 with PXIe-5696 (ALC disabled): 4 + PXIe-5654 with PXIe-5696 (ALC disabled): 4 - PXIe-5654 with PXIe-5696 (ALC enabled): 0.2 + PXIe-5654 with PXIe-5696 (ALC enabled): 0.2 - PXIe-5820/5830/5831/5832/5840/5841/5842/5860: 0.5 + PXIe-5820/5830/5831/5832/5840/5841/5842/5860: 0.5 - **Valid Values:** + **Valid Values:** - PXIe-5654: 1.5, 2, 4 + PXIe-5654: 1.5, 2, 4 - PXIe-5654 with PXIe-5696 (ALC disabled): 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-5654 with PXIe-5696 (ALC enabled): 0.2, 0.5 - PXIe-5820/5830/5831/5832/5840/5841/5842/5860: 0.01 to 1 + 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 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Amplitude Settling Times `_ + `Amplitude Settling Times `_ ''' amp_path = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.AmpPath, 1150185) '''Type: enums.AmpPath 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. + 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:** AmpPath.LOW_HARMONIC + **Default Value:** AmpPath.LOW_HARMONIC - **Supported Devices:** PXIe-5654 with PXIe-5696 + **Supported Devices:** PXIe-5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Low Harmonic Path Versus High Power Path `_ + `Low Harmonic Path Versus High Power Path `_ - **Defined Values**: + **Defined Values**: +----------------------+----------------+-----------------------------------------------------------+ | Name | Value | Description | @@ -254,32 +254,32 @@ class _SessionBase(object): 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. + 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 + **Default Value:** 100 - **Valid Values:** 0 to 100 + **Valid Values:** 0 to 100 - **Supported Devices:** PXIe-5654/5654 with PXIe-5696 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Amplitude Modulation `_ + `Amplitude Modulation `_ ''' analog_modulation_fm_band = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.AnlgModFmBand, 1150191) '''Type: enums.AnlgModFmBand 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:** AnlgModFmBand.WIDEBAND + **Default Value:** AnlgModFmBand.WIDEBAND - **Supported Devices:** PXIe-5654/5654 with PXIe-5696 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Frequency Modulation `_ + `Frequency Modulation `_ - **Defined Values**: + **Defined Values**: +--------------------------+----------------+--------------------------------------------+ | Name | Value | Description | @@ -294,32 +294,32 @@ class _SessionBase(object): Specifies the frequency deviation to use in frequency modulation. - **Units**: hertz (Hz) + **Units**: hertz (Hz) - **Default Value:** 1kHz + **Default Value:** 1kHz - **Supported Devices:** PXI/PXIe-5650/5651/5652 + **Supported Devices:** PXI/PXIe-5650/5651/5652 - **Related Topics** + **Related Topics** - `Modulation Schemes `_ + `Modulation Schemes `_ ''' analog_modulation_fm_narrowband_integrator = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.AnlgModFmNarrowbandIntegrator, 1150165) '''Type: enums.AnlgModFmNarrowbandIntegrator 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 analog_modulation_type property to AnlgModType.FM and the analog_modulation_fm_band property to AnlgModFmBand.NARROWBAND. + This property is valid only when you set the analog_modulation_type property to AnlgModType.FM and the analog_modulation_fm_band property to AnlgModFmBand.NARROWBAND. - **Default Value:** AnlgModFmNarrowbandIntegrator._100hzto1khz + **Default Value:** AnlgModFmNarrowbandIntegrator._100hzto1khz - **Supported Devices:** PXIe-5654/5654 with PXIe-5696 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Frequency Modulation `_ + `Frequency Modulation `_ - **Defined Values**: + **Defined Values**: +----------------------------------------------+----------------+---------------------------------------------+ | Name | Value | Description | @@ -336,45 +336,45 @@ class _SessionBase(object): 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 + **Default Value:** 100 - **Valid Values:** 0 to 100 + **Valid Values:** 0 to 100 - **Supported Devices:** PXIe-5654/5654 with PXIe-5696 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Frequency Modulation `_ + `Frequency Modulation `_ ''' analog_modulation_pm_deviation = _attributes.AttributeViReal64(1150062) '''Type: float Specifies the `deviation `_ to use in phase modulation, in degrees. - **Units**: degrees (°) + **Units**: degrees (°) - **Default Value:** 90° + **Default Value:** 90° - **Supported Devices:** PXI/PXIe-5650/5651/5652, PXIe-5653 + **Supported Devices:** PXI/PXIe-5650/5651/5652, PXIe-5653 - **Related Topics** + **Related Topics** - `Modulation Schemes `_ + `Modulation Schemes `_ ''' analog_modulation_pm_mode = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.AnlgModPmMode, 1150192) '''Type: enums.AnlgModPmMode Specifies the phase modulation (PM) mode to use. - **Default Value:** AnlgModPmMode.LOW_PHASE_NOISE + **Default Value:** AnlgModPmMode.LOW_PHASE_NOISE - **Supported Devices:** PXIe-5654/5654 with PXIe-5696 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Phase Modulation `_ + `Phase Modulation `_ - **Defined Values**: + **Defined Values**: +-------------------------------+----------------+-----------------------------------------------------------------------------------------------+ | Name | Value | Description | @@ -389,34 +389,34 @@ class _SessionBase(object): 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 + **Default Value:** 100 - **Valid Values:** 0 to 100 + **Valid Values:** 0 to 100 - **Supported Devices:** PXIe-5654/5654 with PXIe-5696 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Phase Modulation `_ + `Phase Modulation `_ ''' analog_modulation_type = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.AnlgModType, 1150032) '''Type: enums.AnlgModType Specifies the analog modulation format to use. - **Default Value:** AnlgModType.NONE + **Default Value:** AnlgModType.NONE - **Supported Devices:** PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696 + **Supported Devices:** PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Modulation `_ + `Modulation `_ - `PXI/PXIe-5650/5651/5652 Modulation Schemes `_ + `PXI/PXIe-5650/5651/5652 Modulation Schemes `_ - `PXIe-5654/5654 with PXIe-5696 Modulation Schemes `_ + `PXIe-5654/5654 with PXIe-5696 Modulation Schemes `_ - **Defined Values**: + **Defined Values**: +------------------+--------------+--------------------------------------------------+ | Name | Value | Description | @@ -438,30 +438,30 @@ class _SessionBase(object): Specifies the frequency of the waveform to use as the message signal in analog modulation. - **Units:** hertz (Hz) + **Units:** hertz (Hz) - **Default Value:** 1kHz + **Default Value:** 1kHz - **Supported Devices:** PXI/PXIe-5650/5651/5652 + **Supported Devices:** PXI/PXIe-5650/5651/5652 - **Related Topics** + **Related Topics** - `Modulation Schemes `_ + `Modulation Schemes `_ ''' analog_modulation_waveform_type = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.AnlgModWfmType, 1150033) '''Type: enums.AnlgModWfmType Specifies the type of waveform to use as the message signal for analog modulation. - **Default Value:** AnlgModWfmType.SINE + **Default Value:** AnlgModWfmType.SINE - **Supported Devices:** PXI/PXIe-5650/5651/5652 + **Supported Devices:** PXI/PXIe-5650/5651/5652 - **Related Topics** + **Related Topics** - `Modulation Schemes `_ + `Modulation Schemes `_ - **Defined Values**: + **Defined Values**: +-------------------------+--------------+-----------------------------------------------------------------+ | Name | Value | Description | @@ -478,12 +478,12 @@ class _SessionBase(object): **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 + **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** + **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: + `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 | @@ -502,36 +502,36 @@ class _SessionBase(object): 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. + To set this property, the NI-RFSG device must be in the Configuration or Generation state. - **Default Value:** 0 dB + **Default Value:** 0 dB - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 ''' arb_filter_raised_cosine_alpha = _attributes.AttributeViReal64(1150060) '''Type: float Specifies the alpha value to use when calculating the pulse-shaping filter coefficients. You can use this property only when the arb_filter_type property is set to FilterType.ARB_FILTER_TYPE_RAISED_COSINE and with signal generators that support onboard signal processing (OSP). NI-RFSG returns an error if you use this property with a device that does not support OSP. - **Supported Devices:** PXI-5671, PXIe-5672/5673/5673E + **Supported Devices:** PXI-5671, PXIe-5672/5673/5673E ''' arb_filter_root_raised_cosine_alpha = _attributes.AttributeViReal64(1150057) '''Type: float Specifies the alpha value to use when calculating the pulse-shaping FIR filter coefficients. You can use this property only when the arb_filter_type property is set to FilterType.ARB_FILTER_TYPE_ROOT_RAISED_COSINE and with signal generators that support onboard signal processing (OSP). NI-RFSG returns an error if you use this property with a device that does not support OSP. - **Supported Devices:** PXI-5671, PXIe-5672/5673/5673E + **Supported Devices:** PXI-5671, PXIe-5672/5673/5673E ''' arb_filter_type = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.FilterType, 1150056) '''Type: enums.FilterType Specifies the pulse-shaping filter type for the FIR filter. You can use this property only with signal generators that support onboard signal processing (OSP). NI-RFSG returns an error if you use this property with a device that does not support OSP. - **Default Value:** FilterType.NONE + **Default Value:** FilterType.NONE - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - **Defined Values**: + **Defined Values**: +-----------------------------------------------+----------------+---------------------------------------------------------------------------------------------------------------------------------------+ | Name | Value | Description | @@ -551,32 +551,32 @@ class _SessionBase(object): 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 + **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**: + **High-Level Methods**: - - query_arb_waveform_capabilities + - query_arb_waveform_capabilities ''' arb_onboard_sample_clock_mode = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.ArbOnboardSampleClockMode, 1150029) '''Type: enums.ArbOnboardSampleClockMode 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: ArbOnboardSampleClockMode.DIVIDE_DOWN is the only supported value for this device. + PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: ArbOnboardSampleClockMode.DIVIDE_DOWN is the only supported value for this device. - **Default Values:** + **Default Values:** - PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: ArbOnboardSampleClockMode.DIVIDE_DOWN + PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: ArbOnboardSampleClockMode.DIVIDE_DOWN - PXIe-5673/5673E: ArbOnboardSampleClockMode.HIGH_RESOLUTION + PXIe-5673/5673E: ArbOnboardSampleClockMode.HIGH_RESOLUTION - **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Clocking Modes `_ + `Clocking Modes `_ - **Valid Values**: + **Valid Values**: +-------------------------------------------+--------------------------------------------------------------+ | Name | Description | @@ -591,136 +591,130 @@ class _SessionBase(object): arb_oscillator_phase_dac_value = _attributes.AttributeViInt32(1150089) '''Type: int - Specifies the oscillator phase digital-to-analog converter (DAC) value on the arbitrary waveform generator (AWG). 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 a previous measurement's phase DAC value to the current session. This property is applicable only when using the arb_sample_clock_source property set to NIRFSG_VAL_CLK_IN_STR. - - **Supported Devices:** PXIe-5673/5673E + Specifies the oscillator phase digital-to-analog converter (DAC) value on the arbitrary waveform generator (AWG). 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 a previous measurement's phase DAC value to the current session. This property is applicable only when using the arb_sample_clock_source property set to ClkIn. - **Related Topics** + **Supported Devices:** PXIe-5673/5673E - `NI-TClk Overview `_ + **Related Topics** - 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. + `NI-TClk Overview `_ ''' arb_power = _attributes.AttributeViReal64(1150016) '''Type: float Indicates the average output power from the PXI-5421, PXI-5441, PXIe-5442, and PXIe-5450 AWG module. If an arbitrary waveform is being generated, this property specifies either the average power or the peak power of the signal, depending on the power_level_type property setting. - **Units**: dBm + **Units**: dBm - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E ''' arb_pre_filter_gain = _attributes.AttributeViReal64(1150025) '''Type: float 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 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. + On the PXI-5671, this property applies only when the 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 + **Units**: dB - **Default Value:** 0dB + **Default Value:** 0dB - **Supported Devices:** PXIe-5644/5645/5646, PXI-5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 ''' arb_sample_clock_rate = _attributes.AttributeViReal64(1150031) '''Type: float Returns the rate of the Sample Clock on the device. - **Units**: hertz (Hz) + **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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 ''' arb_sample_clock_source = _attributes.AttributeViString(1150030) '''Type: str 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: NIRFSG_VAL_ONBOARD_CLOCK_STR is the only supported value for this device. + PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: OnboardClock is the only supported value for this device. - **Default Value:** NIRFSG_VAL_ONBOARD_CLOCK_STR + **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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Timing Configurations `_ + `Timing Configurations `_ - **Possible Values**: + **Possible Values**: +----------------+---------------------------------------------------------------+ | Possible Value | Description | +================+===============================================================+ - | ClkIn | Uses the external clock as the Sample Clock source. | + | "ClkIn" | Uses the external clock as the Sample Clock source. | +----------------+---------------------------------------------------------------+ - | OnboardClock | Uses the AWG module onboard clock as the Sample Clock source. | + | "OnboardClock" | Uses the AWG module onboard clock as the Sample Clock 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. ''' arb_selected_waveform = _attributes.AttributeViString(1250451) '''Type: str Specifies the waveform in onboard memory to generate upon calling the Init method when the generation_mode property is set to GenerationMode.ARB_WAVEFORM. The arb_selected_waveform property is ignored when the generation_mode property is set to GenerationMode.SCRIPT or GenerationMode.CW. To set the arb_selected_waveform property, the NI-RFSG device must be in the Configuration state. - **Default Value:** "" (empty string) + **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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Assigning Properties or Properties to a Waveform `_ + `Assigning Properties or Properties to a Waveform `_ - **High-Level Methods**: + **High-Level Methods**: - - select_arb_waveform + - select_arb_waveform ''' arb_temperature = _attributes.AttributeViReal64(1150068) '''Type: float 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. + 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) + **Units**: degrees Celsius (°C) - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860 + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860 ''' arb_waveform_quantum = _attributes.AttributeViInt32(1250455) '''Type: int 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 arb_waveform_size_min and arb_waveform_size_max arbitrary waveform sizes. - PXI-5671, PXIe-5672: The value of this property depends on the I/Q rate. Set the iq_rate property before reading this property. + PXI-5671, PXIe-5672: The value of this property depends on the I/Q rate. Set the 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 + **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**: + **High-Level Methods**: - - query_arb_waveform_capabilities + - query_arb_waveform_capabilities ''' arb_waveform_repeat_count = _attributes.AttributeViInt32(1150158) '''Type: int Specifies the repeat count of a waveform when you set the arb_waveform_repeat_count_is_finite property to True. This property is valid only when you set the generation_mode property to GenerationMode.ARB_WAVEFORM. To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** 1 + **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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 ''' arb_waveform_repeat_count_is_finite = _attributes.AttributeViBoolean(1150157) '''Type: bool Specifies the repetition mode of a waveform when you set the generation_mode property to GenerationMode.ARB_WAVEFORM. If you set this property to True, the number of repetitions is determined by the arb_waveform_repeat_count property. To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** False + **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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Defined Values**: + **Defined Values**: +-------+-------------------------------------------------------------------+ | Value | Description | @@ -735,15 +729,15 @@ class _SessionBase(object): Returns the size of the largest waveform that is allowed. - To read this property, the NI-RFSG device must be in the Configuration state. + 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 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. + For the PXI-5671 and PXIe-5672, the value of this property depends on the I/Q rate. Set the 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 + **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**: + **High-Level Methods**: - - query_arb_waveform_capabilities + - 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. ''' @@ -752,50 +746,49 @@ class _SessionBase(object): 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 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 + **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**: + **High-Level Methods**: - - query_arb_waveform_capabilities + - query_arb_waveform_capabilities ''' arb_waveform_software_scaling_factor = _attributes.AttributeViReal64(1150052) '''Type: float Specifies how much to scale the data before writing it with the WriteArbWaveform method. The resulting waveform must be smaller than 1.0 in complex magnitude. This property is supported only if you set the power_level_type property to PowerLevelType.PEAK. - **Default Value:** 1.0 + **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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Spurious Performance `_ + `Spurious Performance `_ ''' attenuator_hold_enabled = _attributes.AttributeViBoolean(1150009) '''Type: bool Specifies whether attenuator hold is enabled. While this property is set to True, changing the power level causes NI-RFSG to scale the digital data sent to the AWG instead of adjusting the attenuators. Changing power levels in this manner allows the device to increase or decrease the power level in more accurate increments, but it may affect signal-to-noise ratios (noise density). + Setting the attenuator_hold_enabled property to True limits the power levels that can be attained. With attenuator hold enabled, the power level must satisfy the following conditions: - Setting the attenuator_hold_enabled property to True limits the power levels that can be attained. With attenuator hold enabled, the power level must satisfy the following conditions: + - Power level less than or equal to attenuator_hold_max_power + - Power level greater than or equal to (maximum power level -70dB) + - Power level greater than or equal to -145dBm - - Power level less than or equal to attenuator_hold_max_power - - Power level greater than or equal to (maximum power level -70dB) - - Power level greater than or equal to -145dBm + To set this property, the NI-RFSG device must be in the Configuration state. - To set this property, the NI-RFSG device must be in the Configuration state. + **Default Value:** False - **Default Value:** False + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E + **Related Topics** - **Related Topics** + `Attenuator Hold `_ - `Attenuator Hold `_ + `Settling Times `_ - `Settling Times `_ - - **Defined Values**: + **Defined Values**: +-------+---------------------------+ | Value | Description | @@ -812,37 +805,37 @@ class _SessionBase(object): Specifies the maximum power level of the RF output signal when the attenuator_hold_enabled property is set to True. - To set this property, the NI-RFSG device must be in the Configuration state. + To set this property, the NI-RFSG device must be in the Configuration state. - **Units**: dBm + **Units**: dBm - **Defined Values**: - Refer to the specifications document for your device for allowable maximum power levels. + **Defined Values**: + Refer to the specifications document for your device for allowable maximum power levels. - **Default Value:** + **Default Value:** - PXI-5670/5671, PXIe-5672: 17 + PXI-5670/5671, PXIe-5672: 17 - PXIe-5673/5673E: 10 + PXIe-5673/5673E: 10 - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - **Related Topics** + **Related Topics** - `Attenuator Hold `_ + `Attenuator Hold `_ - `Settling Times `_ + `Settling Times `_ ''' attenuator_setting = _attributes.AttributeViReal64(1150173) '''Type: float 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 + **Units**: dB - **Valid Values**: 0dB to 110dB in steps of 10 + **Valid Values**: 0dB to 110dB in steps of 10 - **Supported Devices:** PXIe-5654 with PXIe-5696 + **Supported Devices:** PXIe-5654 with PXIe-5696 Note: Resetting this property reverts back to the default unset behavior. ''' @@ -851,17 +844,17 @@ class _SessionBase(object): 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 perform_thermal_correction method to adjust the device for temperature changes. - **Default Value:** AutomaticThermalCorrection.ENABLE + **Default Value:** AutomaticThermalCorrection.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 + **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** + **Related Topics** - `Temperature Monitoring `_ + `Temperature Monitoring `_ - `Settling Times `_ + `Settling Times `_ - **Defined Values**: + **Defined Values**: +------------------------------------+---------+-------------------------------------------+ | Name | Value | Description | @@ -879,23 +872,23 @@ class _SessionBase(object): 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 perform_power_search method. - This property is ignored when the alc_control property is enabled. + This property is ignored when the alc_control property is enabled. - PXIe-5654: AutomaticPowerSearch.DISABLE is the only supported value for this device. + PXIe-5654: AutomaticPowerSearch.DISABLE is the only supported value for this device. - **Default Value:** + **Default Value:** - PXIe-5654: AutomaticPowerSearch.DISABLE + PXIe-5654: AutomaticPowerSearch.DISABLE - PXIe-5654 with PXIe-5696: AutomaticPowerSearch.ENABLE + PXIe-5654 with PXIe-5696: AutomaticPowerSearch.ENABLE - **Supported Devices:** PXIe-5654/5654 with PXIe-5696 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Power Search `_ + `Power Search `_ - **Defined Values**: + **Defined Values**: +------------------------------+---------+----------------------------------+ | Name | Value | Description | @@ -918,18 +911,18 @@ class _SessionBase(object): Returns a comma-separated 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 + **Supported Devices**: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 ''' cache = _attributes.AttributeViBoolean(1050004) '''Type: bool Specifies whether to cache the value of properties. When caching is enabled, NI-RFSG tracks the current NI-RFSG device settings and avoids sending redundant commands to the device. NI-RFSG can always cache or never cache particular properties, regardless of the setting of this property. Call the __init__ method to override the default value. - **Default Value:** True + **Default Value:** True - **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 + **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 - **Defined Values**: + **Defined Values**: +-------+-------------------+ | Value | Description | @@ -944,13 +937,13 @@ class _SessionBase(object): Enables or disables compensation for filter group delay on the AWG module. This property also accounts for the upconverter group delay and aligns the RF output with the Started Event, Done Event, and Marker Events. - At a low I/Q rate, the group delay can become so large that some devices may not be able to align the events with the RF output, in which case you must increase the I/Q rate or disable this property. + At a low I/Q rate, the group delay can become so large that some devices may not be able to align the events with the RF output, in which case you must increase the I/Q rate or disable this property. - **Default Value:** False + **Default Value:** False - **Supported Devices:** PXIe-5672 + **Supported Devices:** PXIe-5672 - **Defined Values**: + **Defined Values**: +-------+-----------------------------------------------+ | Value | Description | @@ -965,32 +958,32 @@ class _SessionBase(object): 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 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Default Values**: + **Default Values**: - PXIe-5654/5654 with PXIe-5696: /*ModuleName*/ConfigurationSettledEvent, where *ModuleName* is the name of your device in MAX. + 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-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. + PXIe-5820/5840/5841/5842: /*ModuleName*/ao/0/ConfigurationSettledEvent, where *ModuleName* is the name of your device in MAX. - **Related Topics** + **Related Topics** - `Events `_ + `Events `_ - `Syntax for Terminal Names `_ + `Syntax for Terminal Names `_ ''' correction_temperature = _attributes.AttributeViReal64(1150104) '''Type: float 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. + PXIe-5820/5830/5831/5832/5840/5841/5842/5860: This property is read only. - **Units**: Degrees Celsius + **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 + **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. @@ -1001,64 +994,64 @@ class _SessionBase(object): Indicates the number of samples to transfer at one time from the device to host memory. This property is useful when the total data to be transferred to onboard memory is large. - **Units**: samples (s) + **Units**: samples (s) - **Default Value**: 1Ms + **Default Value**: 1Ms - **Supported Devices:** PXIe-5672/5673/5673E + **Supported Devices:** PXIe-5672/5673/5673E ''' data_transfer_maximum_bandwidth = _attributes.AttributeViReal64(1150086) '''Type: float Specifies the maximum amount of bus bandwidth to use for data transfers. - **Units**: bytes per second + **Units**: bytes per second - **Default Value**: Device maximum + **Default Value**: Device maximum - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - **Related Topics** + **Related Topics** - `Improving Streaming Performance `_ + `Improving Streaming Performance `_ ''' data_transfer_maximum_in_flight_reads = _attributes.AttributeViInt32(1150088) '''Type: int Specifies the maximum number of concurrent PCI Express read requests the RF signal generator can issue. - When transferring data from computer memory to device onboard memory across the PCI Express bus, the signal generator can issue multiple memory reads at the same time. In general, the larger the number of read requests, the more efficiently the device uses the bus because the multiple read requests keep the data flowing, even in a PCI Express topology that has high latency due to PCI Express switches in the data path. Most NI devices can issue a large number of read requests (typically 8 or 16). By default, this property is set to the highest value the RF signal generator supports. + When transferring data from computer memory to device onboard memory across the PCI Express bus, the signal generator can issue multiple memory reads at the same time. In general, the larger the number of read requests, the more efficiently the device uses the bus because the multiple read requests keep the data flowing, even in a PCI Express topology that has high latency due to PCI Express switches in the data path. Most NI devices can issue a large number of read requests (typically 8 or 16). By default, this property is set to the highest value the RF signal generator supports. - If other devices in your system cannot tolerate long data latencies, it may be helpful to decrease the number of in-flight read requests the RF signal generator issues. This helps to reduce the amount of data the signal generator reads at one time. + If other devices in your system cannot tolerate long data latencies, it may be helpful to decrease the number of in-flight read requests the RF signal generator issues. This helps to reduce the amount of data the signal generator reads at one time. - **Units**: number of packets + **Units**: number of packets - **Default Value**: Device maximum + **Default Value**: Device maximum - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - **Related Topics** + **Related Topics** - `Improving Streaming Performance `_ + `Improving Streaming Performance `_ ''' data_transfer_preferred_packet_size = _attributes.AttributeViInt32(1150087) '''Type: int Specifies the preferred size of the data field in a PCI Express read request packet. - In general, the larger the packet size, the more efficiently the device uses the bus. By default, NI RF signal generators use the largest packet size allowed by the system. However, due to different system implementations, some systems may perform better with smaller packet sizes. + In general, the larger the packet size, the more efficiently the device uses the bus. By default, NI RF signal generators use the largest packet size allowed by the system. However, due to different system implementations, some systems may perform better with smaller packet sizes. - Recommended values for this property are powers of two between 64 and 512. + Recommended values for this property are powers of two between 64 and 512. - **Units**: bytes + **Units**: bytes - **Default Value**: Device maximum + **Default Value**: Device maximum - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - **Related Topics** + **Related Topics** - `Improving Streaming Performance `_ + `Improving Streaming Performance `_ Note: In some cases, the RF signal generator generates packets smaller than the preferred size you set with this property. ''' @@ -1067,7 +1060,7 @@ class _SessionBase(object): 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 + **Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860 Tip: This property can be set/get on specific deembedding_port within your :py:class:`nirfsg.Session` instance. @@ -1084,13 +1077,13 @@ class _SessionBase(object): 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 _set_attribute_vi_string method to specify the name of the port to configure for de-embedding. + To use this property, you must use the channelName parameter of the _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. + 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. + Use the create deembedding sparameter table array method to create tables. - **Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860 + **Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860 Tip: This property can be set/get on specific deembedding_port within your :py:class:`nirfsg.Session` instance. @@ -1107,19 +1100,19 @@ class _SessionBase(object): 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 _set_attribute_vi_int32 method to specify the name of the port to configure for de-embedding. + To use this property, you must use the channelName parameter of the _set_attribute_vi_int32 method to specify the name of the port to configure for de-embedding. - If you set this property to DeembeddingTypeAttrVals.SCALAR or DeembeddingTypeAttrVals.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. + If you set this property to DeembeddingTypeAttrVals.SCALAR or DeembeddingTypeAttrVals.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**: DeembeddingTypeAttrVals.SCALAR + **Default Value**: DeembeddingTypeAttrVals.SCALAR - **Valid Values for PXIe-5830/5832/5840/5841/5842/5860** : DeembeddingTypeAttrVals.SCALAR or DeembeddingTypeAttrVals.NONE + **Valid Values for PXIe-5830/5832/5840/5841/5842/5860** : DeembeddingTypeAttrVals.SCALAR or DeembeddingTypeAttrVals.NONE - **Valid Values for PXIe-5831** DeembeddingTypeAttrVals.SCALAR, DeembeddingTypeAttrVals.VECTOR, or DeembeddingTypeAttrVals.NONE. DeembeddingTypeAttrVals.VECTOR is only supported for TRX Ports in a Semiconductor Test System (STS). + **Valid Values for PXIe-5831** DeembeddingTypeAttrVals.SCALAR, DeembeddingTypeAttrVals.VECTOR, or DeembeddingTypeAttrVals.NONE. DeembeddingTypeAttrVals.VECTOR is only supported for TRX Ports in a Semiconductor Test System (STS). - **Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860 + **Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860 - **Defined Values**: + **Defined Values**: +--------------------------------+----------------+------------------------------------------------------------------------+ | Name | Value | Description | @@ -1146,42 +1139,42 @@ class _SessionBase(object): Specifies the bandwidth of the device. The instantaneous bandwidth is the effective real-time bandwidth of the signal path for your configuration. - The signal_bandwidth centered at the frequency must fit within the device instantaneous bandwidth, which is centered at the upconverter_center_frequency. + The signal_bandwidth centered at the frequency must fit within the device instantaneous bandwidth, which is centered at the upconverter_center_frequency. - **Units**: Hz + **Units**: Hz - **Default Value**: N/A + **Default Value**: N/A - **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `PXIe-5830 Frequency and Bandwidth Selection `_ + `PXIe-5830 Frequency and Bandwidth Selection `_ - `PXIe-5831/5832 Frequency and Bandwidth Selection `_ + `PXIe-5831/5832 Frequency and Bandwidth Selection `_ - `PXIe-5841 Frequency and Bandwidth Selection `_ + `PXIe-5841 Frequency and Bandwidth Selection `_ ''' device_temperature = _attributes.AttributeViReal64(1150017) '''Type: float 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. + 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-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 _set_attribute_vi_real64 method to using the appropriate string for your instrument configuration. Setting the _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. + PXIe-5830/5831/5832: To use this property, you must first set the channelName parameter of the _set_attribute_vi_real64 method to using the appropriate string for your instrument configuration. Setting the _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) + **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 + **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** + **Related Topics** - `Temperature Monitoring `_ + `Temperature Monitoring `_ - `Thermal Shutdown `_ + `Thermal Shutdown `_ +----------------------------+--------------------------+-------------------------+ | Hardware Module | TRX Port Type | Active Channel String | @@ -1208,21 +1201,21 @@ class _SessionBase(object): Specifies the active edge for the Script Trigger. This property is used when the script_trigger_type property is set to digital edge. To set the digital_edge_script_trigger_edge property, the NI-RFSG device must be in the Configuration state. - **Default Value:** ScriptTrigDigEdgeEdge.RISING + **Default Value:** ScriptTrigDigEdgeEdge.RISING - **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Script Trigger `_ + `Script Trigger `_ - `Digital Edge Trigger `_ + `Digital Edge Trigger `_ - **High-Level Methods**: + **High-Level Methods**: - - configure_digital_edge_script_trigger + - configure_digital_edge_script_trigger - **Defined Values**: + **Defined Values**: +-------------------------------+---------+-------------------------------------------------------------------------------+ | Name | Value | Description | @@ -1250,72 +1243,72 @@ class _SessionBase(object): Specifies the source terminal for the Script Trigger. This property is used when the 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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Script Trigger `_ + `Script Trigger `_ - `PFI Lines `_ + `PFI Lines `_ - `PXI Trigger Lines `_ + `PXI Trigger Lines `_ - **High-Level Methods**: + **High-Level Methods**: - - configure_digital_edge_script_trigger + - configure_digital_edge_script_trigger - **Possible Values**: + **Possible Values**: +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | Possible Value | Description | +================+=========================================================================================================================================+ - | PFI0 | The trigger is received on PFI 0. | + | "PFI0" | The trigger is received on PFI 0. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI1 | The trigger is received on PFI 1. | + | "PFI1" | The trigger is received on PFI 1. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI2 | The trigger is received on PFI 2. | + | "PFI2" | The trigger is received on PFI 2. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI3 | The trigger is received on PFI 3. | + | "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_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_Trig0" | The trigger is received on PXI trigger line 0. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + | "PXI_Trig1" | The trigger is received on PXI trigger line 1. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + | "PXI_Trig2" | The trigger is received on PXI trigger line 2. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + | "PXI_Trig3" | The trigger is received on PXI trigger line 3. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + | "PXI_Trig4" | The trigger is received on PXI trigger line 4. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + | "PXI_Trig5" | The trigger is received on PXI trigger line 5. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + | "PXI_Trig6" | The trigger is received on PXI trigger line 6. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig7 | The trigger is received on PXI trigger line 7. | + | "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. | + | "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. | + | "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/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/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/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/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/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/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/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. | + | "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. | + | "Sync_Script" | The trigger is received on the Sync Script trigger line. This value is valid on only the PXIe-5644/5645/5646. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ Tip: @@ -1333,23 +1326,23 @@ class _SessionBase(object): Specifies the active edge for the Start Trigger. This property is used when the start_trigger_type property is set to digital edge. To set the 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. + 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:** StartTrigDigEdgeEdge.RISING + **Default Value:** StartTrigDigEdgeEdge.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 + **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** + **Related Topics** - `Start Trigger `_ + `Start Trigger `_ - `Digital Edge Trigger `_ + `Digital Edge Trigger `_ - **High-Level Methods**: + **High-Level Methods**: - - configure_digital_edge_start_trigger + - configure_digital_edge_start_trigger - **Defined Values**: + **Defined Values**: +------------------------------+---------+------------------------------------------------------------------+ | Name | Value | Description | @@ -1367,74 +1360,74 @@ class _SessionBase(object): Specifies the source terminal for the Start Trigger. This property is used when the start_trigger_type property is set to digital edge. The digital_edge_start_trigger_source property is not case-sensitive. To set the 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. + 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 + **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** + **Related Topics** - `Start Trigger `_ + `Start Trigger `_ - `PFI Lines `_ + `PFI Lines `_ - `PXI Trigger Lines `_ + `PXI Trigger Lines `_ - **High-Level Methods**: + **High-Level Methods**: - - configure_digital_edge_start_trigger + - configure_digital_edge_start_trigger - **Possible Values**: + **Possible Values**: +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ | Possible Value | Description | +================+========================================================================================================================================+ - | PFI0 | The trigger is received on PFI 0. | + | "PFI0" | The trigger is received on PFI 0. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI1 | The trigger is received on PFI 1. | + | "PFI1" | The trigger is received on PFI 1. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI2 | The trigger is received on PFI 2. | + | "PFI2" | The trigger is received on PFI 2. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI3 | The trigger is received on PFI 3. | + | "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_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_Trig0" | The trigger is received on PXI trigger line 0. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + | "PXI_Trig1" | The trigger is received on PXI trigger line 1. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + | "PXI_Trig2" | The trigger is received on PXI trigger line 2. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + | "PXI_Trig3" | The trigger is received on PXI trigger line 3. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + | "PXI_Trig4" | The trigger is received on PXI trigger line 4. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + | "PXI_Trig5" | The trigger is received on PXI trigger line 5. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + | "PXI_Trig6" | The trigger is received on PXI trigger line 6. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig7 | The trigger is received on PXI trigger line 7. | + | "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. | + | "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. | + | "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/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/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/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/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/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/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/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. | + | "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. | + | "Sync_Script" | The trigger is received on the Sync Script trigger line. This value is valid on only the PXIe-5644/5645/5646. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ ''' digital_equalization_enabled = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.DigitalEqualizationEnabled, 1150012) @@ -1442,27 +1435,27 @@ class _SessionBase(object): 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. + 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 generation_mode property is set to GenerationMode.ARB_WAVEFORM or GenerationMode.SCRIPT. To set this property, the NI-RFSG device must be in the Configuration state. + This property applies only when the generation_mode property is set to GenerationMode.ARB_WAVEFORM or GenerationMode.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: DigitalEqualizationEnabled.ENABLE is the only supported value for this device. + PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: DigitalEqualizationEnabled.ENABLE is the only supported value for this device. - **Default Value:** + **Default Value:** - PXI-5670/5671: DigitalEqualizationEnabled.DISABLE + PXI-5670/5671: DigitalEqualizationEnabled.DISABLE - PXIe-5644/5645/5646, PXIe-5672, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: DigitalEqualizationEnabled.ENABLE + PXIe-5644/5645/5646, PXIe-5672, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: DigitalEqualizationEnabled.ENABLE - **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Response and Software Equalization `_—Refer to this topic for more information about equalization performed in software. + `Response and Software Equalization `_—Refer to this topic for more information about equalization performed in software. - `Frequency Tuning Times `_ + `Frequency Tuning Times `_ - **Defined Values**: + **Defined Values**: +------------------------------------+---------+-----------------------+ | Name | Value | Description | @@ -1480,19 +1473,17 @@ class _SessionBase(object): Specifies the active level for the Script Trigger. This property is used when the script_trigger_type property is set to ScriptTrigType.DIGITAL_LEVEL. - **Default Value:** ScriptTrigDigLevelActiveLevel.HIGH - - **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Default Value:** ScriptTrigDigLevelActiveLevel.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** - **Related Topics** + `Script Trigger `_ - `Script Trigger `_ + `Digital Level Trigger `_ - `Digital Level Trigger `_ - - **Defined Values**: + **Defined Values**: +------------------------------------+---------------+--------------------------------------------------+ | Name | Value | Description | @@ -1517,68 +1508,68 @@ class _SessionBase(object): Specifies the source terminal for the Script Trigger. This property is used when the script_trigger_type property is set to ScriptTrigType.DIGITAL_LEVEL. The digital_level_script_trigger_source property is not case-sensitive. - To set the digital_level_script_trigger_source property, the NI-RFSG device must be in the Configuration state. + To set the 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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Script Trigger `_ + `Script Trigger `_ - `PFI Lines `_ + `PFI Lines `_ - `PXI Trigger Lines `_ + `PXI Trigger Lines `_ - **Possible Values**: + **Possible Values**: +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | Possible Value | Description | +================+=========================================================================================================================================+ - | PFI0 | The trigger is received on PFI 0. | + | "PFI0" | The trigger is received on PFI 0. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI1 | The trigger is received on PFI 1. | + | "PFI1" | The trigger is received on PFI 1. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI2 | The trigger is received on PFI 2. | + | "PFI2" | The trigger is received on PFI 2. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI3 | The trigger is received on PFI 3. | + | "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_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_Trig0" | The trigger is received on PXI trigger line 0. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + | "PXI_Trig1" | The trigger is received on PXI trigger line 1. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + | "PXI_Trig2" | The trigger is received on PXI trigger line 2. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + | "PXI_Trig3" | The trigger is received on PXI trigger line 3. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + | "PXI_Trig4" | The trigger is received on PXI trigger line 4. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + | "PXI_Trig5" | The trigger is received on PXI trigger line 5. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + | "PXI_Trig6" | The trigger is received on PXI trigger line 6. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig7 | The trigger is received on PXI trigger line 7. | + | "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. | + | "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. | + | "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/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/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/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/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/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/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/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. | + | "DIO/PFI7" | The trigger is received on PFI7 from the front panel DIO terminal. | +----------------+-----------------------------------------------------------------------------------------------------------------------------------------+ Tip: @@ -1596,71 +1587,71 @@ class _SessionBase(object): Specifies the deviation to use in FSK modulation. - **Units**: hertz (Hz) + **Units**: hertz (Hz) - **Default Value:** 1,000 + **Default Value:** 1,000 - **Supported Devices:** PXI/PXIe-5650/5651/5652 + **Supported Devices:** PXI/PXIe-5650/5651/5652 - **Related Topics** + **Related Topics** - `Modulation Schemes `_ + `Modulation Schemes `_ ''' digital_modulation_prbs_order = _attributes.AttributeViInt32(1150039) '''Type: int Specifies the order of pseudorandom bit sequence (PRBS) internally generated by hardware and used as the message signal in digital modulation. - **Default Value:** 16 + **Default Value:** 16 - **Supported Devices:** PXI/PXIe-5650/5651/5652 + **Supported Devices:** PXI/PXIe-5650/5651/5652 - **Related Topics** + **Related Topics** - `Modulation Schemes `_ + `Modulation Schemes `_ ''' digital_modulation_prbs_seed = _attributes.AttributeViInt32(1150040) '''Type: int Specifies the seed of the internally generated pseudorandom bit sequence (PRBS). - **Default Value:** 1 + **Default Value:** 1 - **Supported Devices:** PXI/PXIe-5650/5651/5652 + **Supported Devices:** PXI/PXIe-5650/5651/5652 - **Related Topics** + **Related Topics** - `Modulation Schemes `_ + `Modulation Schemes `_ ''' digital_modulation_symbol_rate = _attributes.AttributeViReal64(1150037) '''Type: float Specifies the symbol rate of the bit stream for digital modulation. - **Units**: hertz (Hz) + **Units**: hertz (Hz) - **Default Value:** 1kHz + **Default Value:** 1kHz - **Supported Devices:** PXI/PXIe-5650/5651/5652 + **Supported Devices:** PXI/PXIe-5650/5651/5652 - **Related Topics** + **Related Topics** - `Modulation Schemes `_ + `Modulation Schemes `_ ''' digital_modulation_type = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.DigModType, 1150036) '''Type: enums.DigModType Specifies the digital modulation format to use. - **Default Value:** DigModType.NONE + **Default Value:** DigModType.NONE - **Supported Devices:** PXI/PXIe-5650/5651/5652 + **Supported Devices:** PXI/PXIe-5650/5651/5652 - **Related Topics** + **Related Topics** - `Modulation Schemes `_ + `Modulation Schemes `_ - **Defined Values**: + **Defined Values**: +-----------------+--------------+-----------------------------------------------------------------------------+ | Name | Value | Description | @@ -1682,15 +1673,15 @@ class _SessionBase(object): Specifies the type of waveform to use as the message signal in digital modulation. - **Default Value:** DigModWfmType.PRBS + **Default Value:** DigModWfmType.PRBS - **Supported Devices:** PXI/PXIe-5650/5651/5652 + **Supported Devices:** PXI/PXIe-5650/5651/5652 - **Related Topics** + **Related Topics** - `Modulation Schemes `_ + `Modulation Schemes `_ - **Defined Values**: + **Defined Values**: +----------------------------+---------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Value | Description | @@ -1708,13 +1699,13 @@ class _SessionBase(object): Enables or disables digital pattern on the PXI-5421/5441 AWG module. This property must be set to True to enable signal routing to and from the Digital Data & Control connector. - To set this property, the NI-RFSG device must be in the Configuration state. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** False + **Default Value:** False - **Supported Devices:** PXI-5670/5671 + **Supported Devices:** PXI-5670/5671 - **Defined Values**: + **Defined Values**: +-------+--------------------------+ | Value | Description | @@ -1729,25 +1720,23 @@ class _SessionBase(object): Specifies whether the 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: + 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: - 1. Set the I/Q rate to less than or equal to 8.33MS/s with the iq_rate property. + 1. Set the I/Q rate to less than or equal to 8.33MS/s with the iq_rate property. - 2. Set the power_level_type property to PowerLevelType.PEAK. + 2. Set the power_level_type property to PowerLevelType.PEAK. - 3. Disable the iq_swap_enabled property. + 3. Disable the iq_swap_enabled property. - 4. Disable the digital_equalization_enabled property. + 4. Disable the digital_equalization_enabled property. - **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860 - **Defined Values**: + **Defined Values**: +----------------------------+-----------+-----------------------------------------------------------------------------------------------------------------------------------------+ | Name | Value | Description | @@ -1767,50 +1756,50 @@ class _SessionBase(object): Returns the name of the fully qualified signal name as a string. - **Default Values**: + **Default Values**: - PXI-5670/5671, PXIe-5672/5673/5673E: /*AWGName*/DoneEvent, where *AWGName* is the name of your associated AWG module in MAX. + 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-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-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). + 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 + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Events `_ + `Events `_ - `Syntax for Terminal Names `_ + `Syntax for Terminal Names `_ - **High-Level Methods**: + **High-Level Methods**: - - get_terminal_name + - get_terminal_name ''' events_delay = _attributes.AttributeViReal64TimeDeltaSeconds(1150154) '''Type: hightime.timedelta, datetime.timedelta, or float in seconds 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. + 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 + **Units:** Seconds - **Valid Values:** + **Valid Values:** - PXIe-5644/5645: -1.217 μs to 67.050 μs + PXIe-5644/5645: -1.217 μs to 67.050 μs - PXIe-5646: -0.896 μs to 64.640 μs + PXIe-5646: -0.896 μs to 64.640 μs - PXIe-5820/5830/5831/5832/5840/5841/5842: 0 μs to 3.276 μ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 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Events `_ + `Events `_ Note: If you decrease the event delay during generation, some markers may be dropped. ''' @@ -1819,42 +1808,42 @@ class _SessionBase(object): 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 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Triggers `_ + `Triggers `_ - `Events `_ + `Events `_ - `PFI Lines `_ + `PFI Lines `_ - `PXI Trigger Lines `_ + `PXI Trigger Lines `_ - **Possible Values**: + **Possible Values**: +----------------+--------------------------------------------------------------------------------------------------------------------+ | Possible Value | Description | +================+====================================================================================================================+ - | empty | The signal is not exported. | + | "" | The signal is not exported. | +----------------+--------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + | "PXI_Trig0" | The trigger is received on PXI trigger line 0. | +----------------+--------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + | "PXI_Trig1" | The trigger is received on PXI trigger line 1. | +----------------+--------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + | "PXI_Trig2" | The trigger is received on PXI trigger line 2. | +----------------+--------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + | "PXI_Trig3" | The trigger is received on PXI trigger line 3. | +----------------+--------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + | "PXI_Trig4" | The trigger is received on PXI trigger line 4. | +----------------+--------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + | "PXI_Trig5" | The trigger is received on PXI trigger line 5. | +----------------+--------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + | "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. | + | "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. | + | "TrigOut" | TRIG IN/OUT terminal. | +----------------+--------------------------------------------------------------------------------------------------------------------+ ''' exported_done_event_output_terminal = _attributes.AttributeViString(1150063) @@ -1862,68 +1851,68 @@ class _SessionBase(object): 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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Triggers `_ + `Triggers `_ - `Events `_ + `Events `_ - `PFI Lines `_ + `PFI Lines `_ - `PXI Trigger Lines `_ + `PXI Trigger Lines `_ - **High-Level Methods**: + **High-Level Methods**: - - export_signal + - export_signal - **Possible Values**: + **Possible Values**: +---------------+---------------------------------------------------------------------------------------------------------------------------------+ | Posible Value | Description | +===============+=================================================================================================================================+ - | empty | The signal is not exported. | + | "" | 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. | + | "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. | + | "PFI1" | The signal is exported to the PFI 1 connector. | +---------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PFI4 | The signal is exported to the PFI 4 connector. | + | "PFI4" | The signal is exported to the PFI 4 connector. | +---------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PFI5 | The signal is exported to the PFI 5 connector. | + | "PFI5" | The signal is exported to the PFI 5 connector. | +---------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + | "PXI_Trig0" | The trigger is received on PXI trigger line 0. | +---------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + | "PXI_Trig1" | The trigger is received on PXI trigger line 1. | +---------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + | "PXI_Trig2" | The trigger is received on PXI trigger line 2. | +---------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + | "PXI_Trig3" | The trigger is received on PXI trigger line 3. | +---------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + | "PXI_Trig4" | The trigger is received on PXI trigger line 4. | +---------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + | "PXI_Trig5" | The trigger is received on PXI trigger line 5. | +---------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + | "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. | + | "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/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/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/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/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/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/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/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. | + | "DIO/PFI7" | The trigger is received on PFI7 from the front panel DIO terminal. | +---------------+---------------------------------------------------------------------------------------------------------------------------------+ ''' exported_marker_event_output_terminal = _attributes.AttributeViString(1150064) @@ -1931,66 +1920,66 @@ class _SessionBase(object): 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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Marker Events `_ + `Marker Events `_ - `PFI Lines `_ + `PFI Lines `_ - `PXI Trigger Lines `_ + `PXI Trigger Lines `_ - **High-Level Methods**: + **High-Level Methods**: - - export_signal + - export_signal - **Possible Values**: + **Possible Values**: +----------------+---------------------------------------------------------------------------------------------------------------------------------+ | Possible Value | Description | +================+=================================================================================================================================+ - | empty | The signal is not exported. | + | "" | 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. | + | "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. | + | "PFI1" | The signal is exported to the PFI 1 connector. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PFI4 | The signal is exported to the PFI 4 connector. | + | "PFI4" | The signal is exported to the PFI 4 connector. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PFI5 | The signal is exported to the PFI 5 connector. | + | "PFI5" | The signal is exported to the PFI 5 connector. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + | "PXI_Trig0" | The trigger is received on PXI trigger line 0. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + | "PXI_Trig1" | The trigger is received on PXI trigger line 1. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + | "PXI_Trig2" | The trigger is received on PXI trigger line 2. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + | "PXI_Trig3" | The trigger is received on PXI trigger line 3. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + | "PXI_Trig4" | The trigger is received on PXI trigger line 4. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + | "PXI_Trig5" | The trigger is received on PXI trigger line 5. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + | "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. | + | "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/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/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/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/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/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/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/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. | + | "DIO/PFI7" | The trigger is received on PFI7 from the front panel DIO terminal. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ Tip: @@ -2008,11 +1997,11 @@ class _SessionBase(object): 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:** ScriptTrigDigLevelActiveLevel.HIGH + **Default Value:** ScriptTrigDigLevelActiveLevel.HIGH - **Supported Devices:** PXIe-5842 + **Supported Devices:** PXIe-5842 - **Defined Values**: + **Defined Values**: +------------------------------------+---------------+--------------------------------------------------+ | Name | Value | Description | @@ -2027,75 +2016,69 @@ class _SessionBase(object): 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:** NIRFSG_VAL_PULSE_OUT_STR + **Default Value:** PulseOut - **Supported Devices:** PXIe-5842 + **Supported Devices:** PXIe-5842 - **Possible Values**: + **Possible Values**: +----------------+---------------------------------------------------------------------+ | Possible Value | Description | +================+=====================================================================+ - | | Pulse modulation video signal is not exported. | + | "" | Pulse modulation video signal is not exported. | +----------------+---------------------------------------------------------------------+ - | PulseOut | Export the pulse modulation video signal on the pulse out terminal. | + | "PulseOut" | Export the pulse modulation video signal on the pulse out terminal. | +----------------+---------------------------------------------------------------------+ - - 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. ''' exported_ref_clock_output_terminal = _attributes.AttributeViString(1150053) '''Type: str 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 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. + "RefOut" :Exports the Reference Clock signal to the REF OUT connector of the device. - ClkOut :Exports the Reference Clock signal to the CLK OUT connector of the device. + "RefOut2" :Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable. - **Default Value:** NIRFSG_VAL_DO_NOT_EXPORT_STR + "ClkOut" :Exports the Reference Clock signal to the CLK OUT connector of the device. - **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 + **Default Value:** '""' - **Related Topics** + **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 - `Interconnecting Multiple NI 5673E Modules `_ + **Related Topics** - +------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | Supported devices | - +==============================+=========+============================================================================================+=======================================================================================================================================================================+ - | NIRFSG_VAL_CLK_OUT_STR | ClkOut | Exports the Reference Clock signal to the CLK OUT connector of the device. | Supported on PXIe-5673, 5673E | - +------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | NIRFSG_VAL_DO_NOT_EXPORT_STR | empty | 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) | - +------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | NIRFSG_VAL_REF_OUT_STR | 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, | - +------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | NIRFSG_VAL_REF_OUT2_STR | 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 | - +------------------------------+---------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + `Interconnecting Multiple NI 5673E Modules `_ - Note: The NIRFSG_VAL_REF_OUT2_STR output terminal value is valid for only the PXIe-5650/5651/5652, not the PXI-5650/5651/5652. + +----------------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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: - 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. + Note: The RefOut2 output terminal value is valid for only the PXIe-5650/5651/5652, not the PXI-5650/5651/5652. ''' exported_ref_clock_rate = _attributes.AttributeEnum(_attributes.AttributeViReal64, enums.ReferenceClockExportedRate, 1150292) '''Type: enums.ReferenceClockExportedRate 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:** ReferenceClockExportedRate._10mhz + **Default Value:** ReferenceClockExportedRate._10mhz - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Defined Values**: + **Defined Values**: +------------------------------------+--------------+-------------------------------------+ | Name | Value | Description | @@ -2115,66 +2098,66 @@ class _SessionBase(object): 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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Script Trigger `_ —Refer to this topic for information about trigger delay. + `Script Trigger `_ —Refer to this topic for information about trigger delay. - `PFI Lines `_ + `PFI Lines `_ - `PXI Trigger Lines `_ + `PXI Trigger Lines `_ - **High-Level Methods**: + **High-Level Methods**: - - export_signal + - export_signal - **Possible Values**: + **Possible Values**: +----------------+---------------------------------------------------------------------------------------------------------------------------------+ | Possible Value | Description | +================+=================================================================================================================================+ - | empty | The signal is not exported. | + | "" | 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. | + | "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. | + | "PFI1" | The signal is exported to the PFI 1 connector. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PFI4 | The signal is exported to the PFI 4 connector. | + | "PFI4" | The signal is exported to the PFI 4 connector. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PFI5 | The signal is exported to the PFI 5 connector. | + | "PFI5" | The signal is exported to the PFI 5 connector. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + | "PXI_Trig0" | The trigger is received on PXI trigger line 0. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + | "PXI_Trig1" | The trigger is received on PXI trigger line 1. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + | "PXI_Trig2" | The trigger is received on PXI trigger line 2. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + | "PXI_Trig3" | The trigger is received on PXI trigger line 3. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + | "PXI_Trig4" | The trigger is received on PXI trigger line 4. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + | "PXI_Trig5" | The trigger is received on PXI trigger line 5. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + | "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. | + | "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/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/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/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/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/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/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/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. | + | "DIO/PFI7" | The trigger is received on PFI7 from the front panel DIO terminal. | +----------------+---------------------------------------------------------------------------------------------------------------------------------+ Tip: @@ -2192,66 +2175,66 @@ class _SessionBase(object): 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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Events `_ + `Events `_ - `PFI Lines `_ + `PFI Lines `_ - `PXI Trigger Lines `_ + `PXI Trigger Lines `_ - **High-Level Methods**: + **High-Level Methods**: - - export_signal + - export_signal - **Possible Values**: + **Possible Values**: +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ | Possible Value | Description | +================+========================================================================================================================================+ - | empty | The signal is not exported. | + | "" | 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. | + | "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. | + | "PFI1" | The signal is exported to the PFI 1 connector. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI4 | The signal is exported to the PFI 4 connector. | + | "PFI4" | The signal is exported to the PFI 4 connector. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI5 | The signal is exported to the PFI 5 connector. | + | "PFI5" | The signal is exported to the PFI 5 connector. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + | "PXI_Trig0" | The trigger is received on PXI trigger line 0. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + | "PXI_Trig1" | The trigger is received on PXI trigger line 1. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + | "PXI_Trig2" | The trigger is received on PXI trigger line 2. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + | "PXI_Trig3" | The trigger is received on PXI trigger line 3. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + | "PXI_Trig4" | The trigger is received on PXI trigger line 4. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + | "PXI_Trig5" | The trigger is received on PXI trigger line 5. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + | "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. | + | "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/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/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/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/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/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/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/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. | + | "DIO/PFI7" | The trigger is received on PFI7 from the front panel DIO terminal. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ ''' exported_start_trigger_output_terminal = _attributes.AttributeViString(1150003) @@ -2259,66 +2242,66 @@ class _SessionBase(object): 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. + 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 + **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** + **Related Topics** - `Start Trigger `_ + `Start Trigger `_ - `PFI Lines `_ + `PFI Lines `_ - `PXI Trigger Lines `_ + `PXI Trigger Lines `_ - **Possible Values**: + **Possible Values**: +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ | Possible Value | Description | +================+========================================================================================================================================+ - | empty | The signal is not exported. | + | "" | 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. | + | "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. | + | "PFI1" | The signal is exported to the PFI 1 connector. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI4 | The signal is exported to the PFI 4 connector. | + | "PFI4" | The signal is exported to the PFI 4 connector. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PFI5 | The signal is exported to the PFI 5 connector. | + | "PFI5" | The signal is exported to the PFI 5 connector. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig0 | The trigger is received on PXI trigger line 0. | + | "PXI_Trig0" | The trigger is received on PXI trigger line 0. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig1 | The trigger is received on PXI trigger line 1. | + | "PXI_Trig1" | The trigger is received on PXI trigger line 1. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig2 | The trigger is received on PXI trigger line 2. | + | "PXI_Trig2" | The trigger is received on PXI trigger line 2. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig3 | The trigger is received on PXI trigger line 3. | + | "PXI_Trig3" | The trigger is received on PXI trigger line 3. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig4 | The trigger is received on PXI trigger line 4. | + | "PXI_Trig4" | The trigger is received on PXI trigger line 4. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig5 | The trigger is received on PXI trigger line 5. | + | "PXI_Trig5" | The trigger is received on PXI trigger line 5. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | PXI_Trig6 | The trigger is received on PXI trigger line 6. | + | "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. | + | "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. | + | "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/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/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/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/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/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/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/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. | + | "DIO/PFI7" | The trigger is received on PFI7 from the front panel DIO terminal. | +----------------+----------------------------------------------------------------------------------------------------------------------------------------+ ''' external_calibration_recommended_interval = _attributes.AttributeViInt32(1150076) @@ -2326,31 +2309,31 @@ class _SessionBase(object): Returns the recommended interval between each external calibration of the device. - **Units**: months + **Units**: months - **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 + **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 ''' external_calibration_temperature = _attributes.AttributeViReal64(1150077) '''Type: float Returns the temperature of the device at the time of the last external calibration. - **Units**: degrees Celsius (°C) + **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 + **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 ''' external_gain = _attributes.AttributeViReal64(1150085) '''Type: float 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. + Positive values for this property represent amplification, and negative values for this property represent attenuation. - **Valid Values:** -INF dB to +INF dB + **Valid Values:** -INF dB to +INF dB - **Default Value:** 0dB + **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 + **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. @@ -2361,13 +2344,13 @@ class _SessionBase(object): Returns whether the NI RF signal generator has the fast tuning option available. - **Supported Devices:** PXIe-5654/5654 with PXIe-5696 + **Supported Devices:** PXIe-5654/5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Frequency Tuning Times for 5654 `_ + `Frequency Tuning Times for 5654 `_ - **Defined Values**: + **Defined Values**: +-------+------------------------------------------------------------+ | Value | Description | @@ -2383,38 +2366,38 @@ class _SessionBase(object): Specifies a comma-separated list of ports for which to fix the group delay. - **Supported Devices:** PXIe-5831/5832 + **Supported Devices:** PXIe-5831/5832 ''' fpga_bitfile_path = _attributes.AttributeViString(1150186) '''Type: str 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 __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. + 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 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `NI-RFSG Instrument Driver FPGA Extensions `_ + `NI-RFSG Instrument Driver FPGA Extensions `_ ''' fpga_target_name = _attributes.AttributeViString(1150251) '''Type: str 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. + This property is channel dependent if multiple FPGA targets are supported. - **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860 ''' fpga_temperature = _attributes.AttributeViReal64(1150211) '''Type: float 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. + 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 + **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. ''' @@ -2423,38 +2406,38 @@ class _SessionBase(object): 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. + 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) + **Units**: hertz (Hz) - **Defined Values**: - Refer to the specifications document for your device allowable frequency settings. + **Defined Values**: + Refer to the specifications document for your device allowable frequency settings. - **Default Value:** + **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-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-5653: 4GHz - PXIe-5820: 0Hz + PXIe-5820: 0Hz - PXIe-5830/5831/5832: 6.5 GHz + PXIe-5830/5831/5832: 6.5 GHz - PXIe-5840/5841/5860, PXI-5842 (500 MHz, 1 GHz, and 2 GHz bandwidth options): 1GHz + 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 Standard personality: 1GHz - PXIe-5842 (4 GHz bandwidth option) using the 4 GHz Bandwidth personality: 6.5GHz + 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 + **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** + **Related Topics** - `NI-RFSG Instrument Driver Programming Flow `_ + `NI-RFSG Instrument Driver Programming Flow `_ - **High-Level Methods**: + **High-Level Methods**: - - ConfigureRf + - ConfigureRf Note: For the PXIe-5645, this property is ignored if you are using the I/Q ports. ''' @@ -2463,41 +2446,40 @@ class _SessionBase(object): Specifies the frequency settling time. Interpretation of this value depends on the frequency_settling_units property. - **Valid Values:** + **Valid Values:** - The valid values for this property depend on the frequency_settling_units property. + The valid values for this property depend on the frequency_settling_units property. + **Default Value**: 1.0 - **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 - **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** - **Related Topics** + `Settling Times `_ - `Settling Times `_ - - `Events `_ + `Events `_ ''' frequency_settling_units = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.FrequencySettlingUnits, 1150082) '''Type: enums.FrequencySettlingUnits Specifies the interpretation of the value passed to the frequency_settling property. - PXIe-5650/5651/5652/5653, PXIe-5673E: When the ACTIVE_CONFIGURATION_LIST property is set to a valid list name, the frequency_settling_units property supports only FrequencySettlingUnits.TIME_AFTER_IO as a valid value. + PXIe-5650/5651/5652/5653, PXIe-5673E: When the ACTIVE_CONFIGURATION_LIST property is set to a valid list name, the frequency_settling_units property supports only FrequencySettlingUnits.TIME_AFTER_IO as a valid value. - PXIe-5654/5654 with PXIe-5696: The frequency_settling_units property supports only FrequencySettlingUnits.TIME_AFTER_IO and FrequencySettlingUnits.PPM as valid values. + PXIe-5654/5654 with PXIe-5696: The frequency_settling_units property supports only FrequencySettlingUnits.TIME_AFTER_IO and FrequencySettlingUnits.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 + **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**: FrequencySettlingUnits.PPM + **Default Value**: FrequencySettlingUnits.PPM - **Related Topics** + **Related Topics** - `Events `_ + `Events `_ - **Defined Values**: + **Defined Values**: +----------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | Name | Description | @@ -2519,19 +2501,19 @@ class _SessionBase(object): Specifies the allowable frequency error introduced during the software upconversion process. NI-RFSG may introduce a frequency error up to the specified amount to optimize computational speed and onboard memory usage while upconverting phase-continuous signals. - If the phase_continuity_enabled property is set to NIRFSG_VAL_DISABLE, the frequency_tolerance property is ignored, and the driver does not introduce a frequency error. On devices that do not use software upconversion, this property is ignored. The PXI-5670 always uses software upconversion, and the PXI-5671 uses software upconversion for I/Q rates greater than 8.33MS/s. + If the phase_continuity_enabled property is set to NIRFSG_VAL_DISABLE, the frequency_tolerance property is ignored, and the driver does not introduce a frequency error. On devices that do not use software upconversion, this property is ignored. The PXI-5670 always uses software upconversion, and the PXI-5671 uses software upconversion for I/Q rates greater than 8.33MS/s. - To set this property, the NI-RFSG device must be in the Configuration state. + To set this property, the NI-RFSG device must be in the Configuration state. - **Units**: hertz (Hz) + **Units**: hertz (Hz) - **Default Value:** 50 + **Default Value:** 50 - **Supported Devices:** PXI-5670/5671 + **Supported Devices:** PXI-5670/5671 - **Related Topics** + **Related Topics** - `Phase Continuity `_ + `Phase Continuity `_ 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. @@ -2541,23 +2523,23 @@ class _SessionBase(object): Specifies whether to generate a continuous wave (CW) signal, the arbitrary waveform specified by the arb_selected_waveform property, or the script specified by the selected_script property, upon calling the _initiate method. - To set this property, the NI-RFSG device must be in the Configuration state. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** GenerationMode.CW + **Default Value:** GenerationMode.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 + **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** + **Related Topics** - `Assigning Properties or Properties to a Waveform `_ + `Assigning Properties or Properties to a Waveform `_ - `Scripting Instructions `_—Refer to this topic for more information about scripting. + `Scripting Instructions `_—Refer to this topic for more information about scripting. - **High-Level Methods**: + **High-Level Methods**: - - configure_generation_mode + - configure_generation_mode - **Defined Values**: + **Defined Values**: +-----------------------------+--------------+------------------------------------------------------------------------------------------------------------------------+ | Name | Value | Description | @@ -2574,56 +2556,56 @@ class _SessionBase(object): Returns a string that contains a comma-separated 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 + **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 ''' host_dma_buffer_size = _attributes.AttributeViInt64(1150239) '''Type: int 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. + A sufficiently large host DMA buffer improves performance by allowing large writes to be transferred more efficiently. - **Units:** bytes + **Units:** bytes - **Default Value:** 8MB + **Default Value:** 8MB - **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860 ''' instrument_firmware_revision = _attributes.AttributeViString(1050510) '''Type: str 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 + **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 - **High-Level Methods**: + **High-Level Methods**: - - revision_query + - revision_query ''' instrument_manufacturer = _attributes.AttributeViString(1050511) '''Type: str 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 + **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 ''' instrument_model = _attributes.AttributeViString(1050512) '''Type: str 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 + **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 ''' interchange_check = _attributes.AttributeViBoolean(1050021) '''Type: bool Specifies whether to perform interchangeability checking and retrieve interchangeability warnings. - **Default Value:** False + **Default Value:** False - **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 + **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 - **Defined Values**: + **Defined Values**: +-------+--------------------------------+ | Value | Description | @@ -2640,51 +2622,50 @@ class _SessionBase(object): 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 + **Units:** Seconds - **Valid Values:** Plus or minus half of one I/Q sample period + **Valid Values:** Plus or minus half of one I/Q sample period - **Supported Devices:** PXIe-5644/5645/5646 + **Supported Devices:** PXIe-5644/5645/5646 ''' io_resource_descriptor = _attributes.AttributeViString(1050304) '''Type: str 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 + **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 ''' iq_gain_imbalance = _attributes.AttributeViReal64(1150072) '''Type: float Specifies the gain imbalance of the I/Q modulator (I versus Q). - Gain imbalance is calculated with the following equation: - + Gain imbalance is calculated with the following equation: - **Units**: dB + **Units**: dB - **Valid Values:**-6dB to 6dB + **Valid Values:**-6dB to 6dB - **Default Value:** 0dB + **Default Value:** 0dB - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Impairment Calibration `_ + `Impairment Calibration `_ - `Spurious Performance `_ + `Spurious Performance `_ ''' iq_impairment_enabled = _attributes.AttributeViBoolean(1150069) '''Type: bool Enables or disables I/Q impairment. The iq_i_offset, iq_q_offset, iq_gain_imbalance, and iq_skew properties are ignored when the iq_impairment_enabled property is disabled. - **Default Value:** True + **Default Value:** True - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Defined Values**: + **Defined Values**: +-------+-----------------------------+ | Value | Description | @@ -2699,38 +2680,37 @@ class _SessionBase(object): 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 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 iq_offset_units property. + 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 iq_offset_units property. - **Valid Values:**-100 to 100% or -0.2V to 0.2V + **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 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Impairment Calibration `_ + `Impairment Calibration `_ ''' iq_offset_units = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.OffsetUnits, 1150081) '''Type: enums.OffsetUnits Specifies the units of the iq_i_offset property and 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 iq_offset_units property is set to OffsetUnits.PERCENT. Given perfect carrier leakage suppression, the following equation is satisfied - + The AWG or VST offset is the specified percentage of the AWG or VST peak power level when the iq_offset_units property is set to OffsetUnits.PERCENT. Given perfect carrier leakage suppression, the following equation is satisfied - or equivalently + or equivalently - If the iq_i_offset property is set to 100%, iq_q_offset property is set to 0%, and power_level property set to 0 dBm, the desired RF signal is at 0 dBm and the carrier leakage is also at 0 dBm. + If the iq_i_offset property is set to 100%, iq_q_offset property is set to 0%, and 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 power_level, frequency, iq_skew, iq_gain_imbalance, attenuator_hold_enabled, and arb_pre_filter_gain properties. When the iq_offset_units property is set to OffsetUnits.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 iq_offset_units property is set to OffsetUnits.PERCENT, the carrier leakage, in dBc, remains at a consistent level. + The AWG or VST peak power level changes when settings change in other properties such as the power_level, frequency, iq_skew, iq_gain_imbalance, attenuator_hold_enabled, and arb_pre_filter_gain properties. When the iq_offset_units property is set to OffsetUnits.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 iq_offset_units property is set to OffsetUnits.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 iq_offset_units property to OffsetUnits.VOLTS. Offset correction voltage is applied to the I/Q modulator or VST, regardless of changes to the AWG or VST peak power level. + If you are trying to eliminate residual carrier leakage due to calibration inaccuracies or drift, set the iq_offset_units property to OffsetUnits.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**: OffsetUnits.PERCENT + **Default Value**: OffsetUnits.PERCENT - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Defined Values**: + **Defined Values**: +---------------------+----------------------------------------------------------------------+ | Name | Description | @@ -2747,15 +2727,15 @@ class _SessionBase(object): 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) + **Units:** hertz (Hz) - **Valid Values:** + **Valid Values:** - PXIe-5645: -60MHz to 60MHz + PXIe-5645: -60MHz to 60MHz - PXIe-5820: -500MHz to 500MHz + PXIe-5820: -500MHz to 500MHz - **Supported Devices:** PXIe-5645, PXIe-5820 + **Supported Devices:** PXIe-5645, PXIe-5820 Note: - For the PXIe-5820, NI recommends using the frequency property. @@ -2766,19 +2746,19 @@ class _SessionBase(object): Specifies the common-mode offset applied to the signals generated at each differential output terminal. This property applies only when you set the iq_out_port_terminal_configuration property to IQOutPortTermCfg.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 _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 use this property, you must use the channelName parameter of the _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. + To set this property, the NI-RFSG device must be in the Configuration state. - **Units:** Volts + **Units:** Volts - **Valid Values:** + **Valid Values:** - PXIe-5645: -0.8V to 0.8V if you set the iq_out_port_load_impedance property to 50 Ω. The valid values are -1.2V to 1.2V if you set the iq_out_port_load_impedance property to 100 Ω. + PXIe-5645: -0.8V to 0.8V if you set the iq_out_port_load_impedance property to 50 Ω. The valid values are -1.2V to 1.2V if you set the iq_out_port_load_impedance property to 100 Ω. - PXIe-5820: -0.25V to 1.5V + PXIe-5820: -0.25V to 1.5V - **Supported Devices:** PXIe-5645, PXIe-5820 + **Supported Devices:** PXIe-5645, PXIe-5820 Note: - For the PXIe-5645, this property is ignored if you are using the RF ports. @@ -2789,27 +2769,27 @@ class _SessionBase(object): 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 _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 use this property, you must use the channelName parameter of the _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. + 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. + Refer to the specifications document for your device for allowable output levels. - **Units:** Volts, peak-to-peak (V :sub:`pk-pk` ) + **Units:** Volts, peak-to-peak (V :sub:`pk-pk` ) - **Valid Values:** + **Valid Values:** - PXIe-5645: 1V :sub:`pk-pk` maximum if you set the iq_out_port_terminal_configuration property to IQOutPortTermCfg.DIFFERENTIAL, and 0.5V :sub:`pk-pk` + PXIe-5645: 1V :sub:`pk-pk` maximum if you set the iq_out_port_terminal_configuration property to IQOutPortTermCfg.DIFFERENTIAL, and 0.5V :sub:`pk-pk` maximum if you set the iq_out_port_terminal_configuration property to IQOutPortTermCfg.SINGLE_ENDED. - PXIe-5820: 3.4V :sub:`pk-pk` maximum for signal bandwidth less than 160MHz, and 2V :sub:`pk-pk` + PXIe-5820: 3.4V :sub:`pk-pk` maximum for signal bandwidth less than 160MHz, and 2V :sub:`pk-pk` maximum for signal bandwidth greater than 160MHz. - **Default Value:** 0.5volts + **Default Value:** 0.5volts - **Supported Devices:** PXIe-5645, PXIe-5820 + **Supported Devices:** PXIe-5645, PXIe-5820 Note: - For the PXIe-5645, this property is ignored if you are using the RF ports. @@ -2820,15 +2800,15 @@ class _SessionBase(object): 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 _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 use this property, you must use the channelName parameter of the _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 + **Units:** Ohms - **Valid Values:** Any value greater than 0. Values greater than or equal to 1 megaohms (MΩ) are interpreted as high impedance. + **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 iq_out_port_terminal_configuration property to IQOutPortTermCfg.SINGLE_ENDED, and 100 Ω if you set the iq_out_port_terminal_configuration property to IQOutPortTermCfg.DIFFERENTIAL. + **Default Value:** 50 Ω if you set the iq_out_port_terminal_configuration property to IQOutPortTermCfg.SINGLE_ENDED, and 100 Ω if you set the iq_out_port_terminal_configuration property to IQOutPortTermCfg.DIFFERENTIAL. - **Supported Devices:** PXIe-5645, PXIe-5820 + **Supported Devices:** PXIe-5645, PXIe-5820 Note: For the PXIe-5645, this property is ignored if you are using the RF ports. ''' @@ -2837,15 +2817,15 @@ class _SessionBase(object): 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 _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 use this property, you must use the channelName parameter of the _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-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 arb_pre_filter_gain property to scale the waveform to provide additional headroom for offsets. + PXIe-5820: The waveform is not automatically scaled in DSP. To prevent DSP overflows, use the arb_pre_filter_gain property to scale the waveform to provide additional headroom for offsets. - **Units:** Volts + **Units:** Volts - **Supported Devices:** PXIe-5645, PXIe-5820 + **Supported Devices:** PXIe-5645, PXIe-5820 Note: For the PXIe-5645, this property is ignored if you are using the RF ports. ''' @@ -2854,9 +2834,9 @@ class _SessionBase(object): Returns the temperature, in degrees Celsius, of the I/Q Out circuitry on the device. - **Units:** Degrees Celsius + **Units:** Degrees Celsius - **Supported Devices:** PXIe-5645, PXIe-5820 + **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. ''' @@ -2865,23 +2845,23 @@ class _SessionBase(object): Specifies whether to use the I/Q OUT port for differential configuration or single-ended configuration. If you set this property to IQOutPortTermCfg.SINGLE_ENDED, you must terminate the negative I and Q output connectors with a 50 Ohm termination. - If you set this property to IQOutPortTermCfg.SINGLE_ENDED, the positive I and Q connectors generate the resulting waveform. If you set this property to IQOutPortTermCfg.DIFFERENTIAL, both the positive and negative I and Q connectors generate the resulting waveform. + If you set this property to IQOutPortTermCfg.SINGLE_ENDED, the positive I and Q connectors generate the resulting waveform. If you set this property to IQOutPortTermCfg.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 _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 use this property, you must use the channelName parameter of the _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. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** IQOutPortTermCfg.DIFFERENTIAL + **Default Value:** IQOutPortTermCfg.DIFFERENTIAL - PXIe-5820: The only valid value for this property is IQOutPortTermCfg.DIFFERENTIAL. + PXIe-5820: The only valid value for this property is IQOutPortTermCfg.DIFFERENTIAL. - **Supported Devices:** PXIe-5645, PXIe-5820 + **Supported Devices:** PXIe-5645, PXIe-5820 - **Related Topics** + **Related Topics** - `Differential and Single-Ended Operation (I/O Interface) `_ + `Differential and Single-Ended Operation (I/O Interface) `_ - **Defined Values**: + **Defined Values**: +-------------------------------+----------------+--------------------------------------------------+ | Name | Value | Description | @@ -2897,42 +2877,37 @@ class _SessionBase(object): '''Type: float 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 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 iq_q_offset property is read-only and indicates the I/Q modulator Q-offset. Units are volts, as indicated by the 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 `_ + 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 iq_q_offset property is read-only and indicates the I/Q modulator Q-offset. Units are volts, as indicated by the 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 `_ ''' iq_rate = _attributes.AttributeViReal64(1250452) '''Type: float 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 generation_mode property is set to GenerationMode.ARB_WAVEFORM or GenerationMode.SCRIPT. + This property applies only when the generation_mode property is set to GenerationMode.ARB_WAVEFORM or GenerationMode.SCRIPT. - To set this property, the NI-RFSG device must be in the Configuration state. + 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. + 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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Streaming `_ + `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. + `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 `_ + `Digital Upconverter `_ - **Valid Values**: + **Valid Values**: +--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Device | I/Q Rates | @@ -2969,30 +2944,30 @@ class _SessionBase(object): 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 iq_impairment_enabled property is disabled. + This property is ignored when the iq_impairment_enabled property is disabled. - **Units**: degrees (°) + **Units**: degrees (°) - **Valid Values:**-30° to 30° + **Valid Values:**-30° to 30° - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Impairment Calibration `_ + `Impairment Calibration `_ ''' iq_swap_enabled = _attributes.AttributeViBoolean(1250404) '''Type: bool 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. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** False + **Default Value:** False - **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Defined Values**: + **Defined Values**: +-------+---------------------------------------------------------------------+ | Value | Description | @@ -3007,11 +2982,11 @@ class _SessionBase(object): Specifies the configurations to skip while loading from a file. - **Default Value:** NIRFSG_VAL_SKIP_NONE + **Default Value:** NIRFSG_VAL_SKIP_NONE - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Defined Values**: + **Defined Values**: +--------------------------------------------------------------------+-------------------------------------------------------------------+ | Value | Description | @@ -3024,15 +2999,15 @@ class _SessionBase(object): 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. ''' - load_configurations_from_file_reset_options = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.ResetOptions, 1150291) - '''Type: enums.ResetOptions + load_configurations_from_file_reset_options = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.LoadConfigurationResetOptions, 1150291) + '''Type: enums.LoadConfigurationResetOptions 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 + **Default Value:** NIRFSG_VAL_SKIP_NONE + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Defined Values**: + **Defined Values**: +------------------------------------------------------------------------------+------------------------------------------------------+ | Value | Description | @@ -3054,32 +3029,32 @@ class _SessionBase(object): Returns a string that contains the logical name you specified when opening the current IVI session. You can pass a logical name to the Init method or the __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 + **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 ''' loop_bandwidth = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.LoopBandwidth, 1150027) '''Type: enums.LoopBandwidth 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 _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). + To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the _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:** + **Default Value:** - PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842: LoopBandwidth.MEDIUM + PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842: LoopBandwidth.MEDIUM - PXI/PXIe-5650/5651/5652, PXIe-5673/5673E: LoopBandwidth.NARROW + PXI/PXIe-5650/5651/5652, PXIe-5673/5673E: LoopBandwidth.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 + **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** + **Related Topics** - `Phase-Locked Loop Bandwidth `_ + `Phase-Locked Loop Bandwidth `_ - `Modulation Implementation `_ + `Modulation Implementation `_ - `Sinusoidal Tone Versus Modulation Operation `_ + `Sinusoidal Tone Versus Modulation Operation `_ - **Defined Values**: + **Defined Values**: +----------------------+---------+--------------------------------------------------------+ | Name | Value | Description | @@ -3092,21 +3067,24 @@ class _SessionBase(object): +----------------------+---------+--------------------------------------------------------+ Note: Setting this property to LoopBandwidth.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 LoopBandwidth.MEDIUM is not a valid option on the PXI/PXIe-5650/5651/5652 or PXIe-5673/5673E. LoopBandwidth.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. ''' lo_frequency = _attributes.AttributeViReal64(1150199) '''Type: float 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 _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). + To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the _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 + **Supported Devices**: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `PXIe-5830 Frequency and Bandwidth Configuration `_ + `PXIe-5830 Frequency and Bandwidth Configuration `_ - `PXIe-5831/5832 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. ''' @@ -3115,36 +3093,36 @@ class _SessionBase(object): Specifies the step size for tuning the local oscillator (LO) phase-locked loop (PLL). - When the lo_pll_fractional_mode_enabled property is enabled, the specified step size affects the fractional spur performance of the device. When the lo_pll_fractional_mode_enabled property is disabled, the specified step size affects the phase noise performance of the device. + When the lo_pll_fractional_mode_enabled property is enabled, the specified step size affects the fractional spur performance of the device. When the 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 lo_pll_fractional_mode_enabled property. + The valid values for this property depend on the lo_pll_fractional_mode_enabled property. - **PXIe-5644/5645/5646**—If you disable the lo_pll_fractional_mode_enabled property, the specified value is coerced to the nearest valid value. + **PXIe-5644/5645/5646**—If you disable the lo_pll_fractional_mode_enabled property, the specified value is coerced to the nearest valid value. - **PXIe-5840/5841**—If you disable the 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. + **PXIe-5840/5841**—If you disable the 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) + **Units:** hertz (Hz) - **Default Values:** + **Default Values:** - PXIe-5644/5645/5646: 200kHz + PXIe-5644/5645/5646: 200kHz - PXIe-5830: 2MHz + PXIe-5830: 2MHz - PXIe-5831/5832 (RF port): 8MHz + PXIe-5831/5832 (RF port): 8MHz - PXIe-5831/5832 (IF port): 2MHz, 4MHz + PXIe-5831/5832 (IF port): 2MHz, 4MHz - PXIe-5840/5841: + 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. + - 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-5841 with PXIe-5655: 500kHz - PXIe-5842: 1Hz + PXIe-5842: 1Hz - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842 +--------------------------------------------------------------------------------------------------+-------------------+--------------------------------------------------+ | lo_pll_fractional_mode_enabled Property Setting | NIRFSG_VAL_ENABLE | NIRFSG_VAL_DISABLE | @@ -3169,15 +3147,15 @@ class _SessionBase(object): 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 _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). + To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the _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 + **Units**: dBm - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `LO OUT `_ + `LO OUT `_ Note: - This property is read/write if you are using an external LO. Otherwise, this property is read-only. @@ -3188,17 +3166,17 @@ class _SessionBase(object): 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 output_enabled property is set to False, the 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 _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). + To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the _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 + **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 + **Supported Devices:** PXI-5610, PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `LO OUT `_ + `LO OUT `_ - **Defined Values**: + **Defined Values**: +--------------------+---------------------------------------------------------------------------------+ | Name | Description | @@ -3216,13 +3194,13 @@ class _SessionBase(object): Specifies whether to allow NI-RFSA to control the NI-RFSG LO out export. - Set this property to LoOutExportConfigureFromRFSaEnable.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. + Set this property to LoOutExportConfigureFromRFSaEnable.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:** LoOutExportConfigureFromRFSaEnable.DISABLE + **Default Value:** LoOutExportConfigureFromRFSaEnable.DISABLE - **Supported Devices**: PXIe-5840/5841/5842 + **Supported Devices**: PXIe-5840/5841/5842 - **Defined Values**: + **Defined Values**: +--------------------------------------------+---------+----------------------------------------------------------------------+ | Name | Value | Description | @@ -3240,15 +3218,15 @@ class _SessionBase(object): 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 _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). + To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the _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 + **Units**: dBm - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `LO OUT `_ + `LO OUT `_ Note: For the PXIe-5644/5645/5646 and PXIe-5673/5673E, this property is always read-only. ''' @@ -3257,19 +3235,19 @@ class _SessionBase(object): 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 lo_frequency_step_size property. However, fractional mode may introduce non-harmonic spurs. - This property applies only if you set the lo_source property to NIRFSG_VAL_LO_SOURCE_ONBOARD_STR. + This property applies only if you set the lo_source property to Onboard. - To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the _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). + To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the _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:** LoPlLfractionalModeEnabled.ENABLE + **Default Value:** LoPlLfractionalModeEnabled.ENABLE - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - Refer to the local oscillators topic appropriate to your device for more information about using fractional mode. + Refer to the local oscillators topic appropriate to your device for more information about using fractional mode. - **Defined Values**: + **Defined Values**: +------------------------------------+---------+------------------------------------------+ | Name | Value | Description | @@ -3289,79 +3267,76 @@ class _SessionBase(object): Specifies whether to use the internal or external local oscillator (LO) source. If the 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 _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:** NIRFSG_VAL_LO_SOURCE_ONBOARD_STR + To use this property for the PXIe-5830/5831/5832, you must use the channelName parameter of the _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). - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842 + **Default Value:** Onboard - **Related Topics** + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842 - `PXIe-5830 LO Sharing Using NI-RFSA and NI-RFSG `_ + **Related Topics** - `PXIe-5831/5832 LO Sharing Using NI-RFSA and NI-RFSG `_ + `PXIe-5830 LO Sharing Using NI-RFSA and NI-RFSG `_ - **Possible Values**: + `PXIe-5831/5832 LO Sharing Using NI-RFSA and NI-RFSG `_ - +------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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 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. | - +------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + **Possible Values**: - Note: For the PXIe-5841 with PXIe-5655, RF list mode is not supported when this property is set to NIRFSG_VAL_LO_SOURCE_SG_SA_SHARED_STR. + +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 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: - 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. + Note: For the PXIe-5841 with PXIe-5655, RF list mode is not supported when this property is set to SG_SA_Shared. ''' lo_temperature = _attributes.AttributeViReal64(1150075) '''Type: float 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. + 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) + **Units**: degrees Celsius (°C) - **Supported Devices:** PXIe-5673/5673E, PXIe-5840/5841/5842 + **Supported Devices:** PXIe-5673/5673E, PXIe-5840/5841/5842 ''' lo_vco_frequency_step_size = _attributes.AttributeViReal64(1150257) '''Type: float Specifies the step size for tuning the internal voltage-controlled oscillator (VCO) used to generate the LO signal. - **Valid Values**: + **Valid Values**: - LO1: 1 Hz to 50 MHz + LO1: 1 Hz to 50 MHz - LO2: 1 Hz to 100 MHz + LO2: 1 Hz to 100 MHz - **Default Value**: 1 MHz + **Default Value**: 1 MHz - **Supported Devices**: PXIe-5830/5831/5832 + **Supported Devices**: PXIe-5830/5831/5832 ''' marker_event_output_behavior = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.MarkerEventOutputBehavior, 1150206) '''Type: enums.MarkerEventOutputBehavior Specifies the output behavior for the Marker Event. To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** MarkerEventOutputBehavior.PULSE + **Default Value:** MarkerEventOutputBehavior.PULSE - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Marker Events `_ + `Marker Events `_ - **Defined Values**: + **Defined Values**: +----------------------------------+----------------+-------------------------------------------------------+ | Name | Value | Description | @@ -3386,15 +3361,15 @@ class _SessionBase(object): Specifies the pulse width value for the Marker Event. Use the marker_event_pulse_width_units property to set the units for the pulse width value. This property is valid only when the marker_event_output_behavior property is set to MarkerEventOutputBehavior.PULSE. - To set this property, the NI-RFSG device must be in the Configuration state. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** 200 ns + **Default Value:** 200 ns - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Marker Events `_ + `Marker Events `_ Tip: This property can be set/get on specific markers within your :py:class:`nirfsg.Session` instance. @@ -3411,17 +3386,17 @@ class _SessionBase(object): Specifies the pulse width units for the Marker Event. This property is valid only when the marker_event_output_behavior property is set to MarkerEventOutputBehavior.PULSE. - To set this property, the NI-RFSG device must be in the Configuration state. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** MarkerEventPulseWidthUnits.SECONDS + **Default Value:** MarkerEventPulseWidthUnits.SECONDS - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Marker Events `_ + `Marker Events `_ - **Defined Values**: + **Defined Values**: +----------------------------------+----------------+-------------------------------------------------------+ | Name | Value | Description | @@ -3446,25 +3421,25 @@ class _SessionBase(object): Returns the name of the fully qualified signal name as a string. - **Default Values**: + **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. + 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-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. + 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 + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Events `_ + `Events `_ - `Syntax for Terminal Names `_ + `Syntax for Terminal Names `_ - **High-Level Methods**: + **High-Level Methods**: - - get_terminal_name + - get_terminal_name Tip: This property can be set/get on specific markers within your :py:class:`nirfsg.Session` instance. @@ -3481,17 +3456,17 @@ class _SessionBase(object): Specifies the initial state for the Marker Event when the marker_event_output_behavior property is set to MarkerEventOutputBehavior.TOGGLE. - To set this property, the NI-RFSG device must be in the Configuration state. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** MarkerEventToggleInitialState.LOW + **Default Value:** MarkerEventToggleInitialState.LOW - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Marker Events `_ + `Marker Events `_ - **Defined Values**: + **Defined Values**: +------------------------------------+----------------+----------------------------------------------------------------------------------+ | Name | Value | Description | @@ -3516,15 +3491,15 @@ class _SessionBase(object): The total amount of memory on the signal generator in bytes. - **Units:** 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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Memory Options `_ + `Memory Options `_ - `Phase Continuity `_ + `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. ''' @@ -3533,9 +3508,9 @@ class _SessionBase(object): Returns the total power consumption of the device. - **Units:** watts + **Units:** watts - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **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. ''' @@ -3544,32 +3519,32 @@ class _SessionBase(object): 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 + **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** + **Related Topics** - `Identifying Module Revision `_ + `Identifying Module Revision `_ ''' output_enabled = _attributes.AttributeViBoolean(1250004) '''Type: bool Specifies whether signal output is enabled. Setting the 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 output_enabled property while in the Committed state does not transition the device to the Configuration state, but output changes immediately. - **Default Value:** True + **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 + **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** + **Related Topics** - `Output Enabled `_ + `Output Enabled `_ - `NI-RFSG Instrument Driver Programming Flow `_ + `NI-RFSG Instrument Driver Programming Flow `_ - **High-Level Methods**: + **High-Level Methods**: - - configure_output_enabled + - configure_output_enabled - **Defined Values**: + **Defined Values**: +-------+-------------------------+ | Value | Description | @@ -3593,19 +3568,19 @@ class _SessionBase(object): 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 iq_out_port_carrier_frequency property to 0. If you set the 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. + 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 iq_out_port_carrier_frequency property to 0. If you set the 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 output_port property to OutputPort.I_ONLY or OutputPort.IQ_OUT, the iq_out_port_terminal_configuration property applies. + If you set the output_port property to OutputPort.I_ONLY or OutputPort.IQ_OUT, the iq_out_port_terminal_configuration property applies. - **Default Value:** + **Default Value:** - PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842/5860: OutputPort.RF_OUT + PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842/5860: OutputPort.RF_OUT - PXIe-5820: OutputPort.IQ_OUT + PXIe-5820: OutputPort.IQ_OUT - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Defined Values**: + **Defined Values**: +--------------------+----------------+------------------------------------------------------------------------------------------+ | Name | Value | Description | @@ -3624,11 +3599,11 @@ class _SessionBase(object): Configures error reporting for onboard signal processing (OSP) overflows. Overflows lead to clipping of the waveform. - **Default Value:** OverflowErrorReporting.WARNING + **Default Value:** OverflowErrorReporting.WARNING - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Defined Values**: + **Defined Values**: +---------------------------------+--------------+----------------------------------------------------------------------------+ | Name | Value | Description | @@ -3643,47 +3618,47 @@ class _SessionBase(object): Specifies the initial amount of data that the writer peer can transfer over the bus into the configured endpoint when the peer-to-peer data stream is enabled. If this property is not set and the endpoint is empty, credits equal to the full endpoint size are issued to the writer peer. If data is written to the endpoint using the WriteP2pEndpointI16 method prior to enabling the stream, credits equal to the remaining space available in the endpoint are issued to the writer peer. This property is coerced up by NI-RFSG to 8-byte boundaries. This property is endpoint-based. - **Units**: samples per channel + **Units**: samples per channel - **Default Value:** 1,024 + **Default Value:** 1,024 - **Supported Devices:** PXIe-5673E + **Supported Devices:** PXIe-5673E - **Related Topics** + **Related Topics** - `Configuring a Peer-to-Peer Endpoint `_ + `Configuring a Peer-to-Peer Endpoint `_ - `Configuring Flow Control `_ + `Configuring Flow Control `_ ''' p2p_data_transfer_permission_interval = _attributes.AttributeViInt64(1150134) '''Type: int Specifies the interval at which the RF signal generator issues credits to allow the writer peer to transfer data over the bus into the configured endpoint. This property is coerced up by NI-RFSG to the nearest 128-byte boundary. This property is endpoint-based. - **Units**: samples per channel + **Units**: samples per channel - **Supported Devices:** PXIe-5673E + **Supported Devices:** PXIe-5673E - **Related Topics** + **Related Topics** - `Configuring a Peer-to-Peer Endpoint `_ + `Configuring a Peer-to-Peer Endpoint `_ - `Configuring Flow Control `_ + `Configuring Flow Control `_ ''' p2p_enabled = _attributes.AttributeViBoolean(1150123) '''Type: bool Specifies whether the RF signal generator reads data from the peer-to-peer endpoint. This property is endpoint-based. - **Default Value**: False + **Default Value**: False - **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Configuring a Peer-to-Peer Endpoint `_ + `Configuring a Peer-to-Peer Endpoint `_ - **Defined Values**: + **Defined Values**: +-------+------------------------------------------+ | Value | Description | @@ -3698,24 +3673,24 @@ class _SessionBase(object): Returns the number of peer-to-peer FIFO endpoints supported by the device. - **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Configuring a Peer-to-Peer Endpoint `_ + `Configuring a Peer-to-Peer Endpoint `_ ''' p2p_endpoint_fullness_start_trigger_level = _attributes.AttributeViInt64(1150128) '''Type: int Specifies the number of samples the endpoint must receive before the device starts generation. If no level is specified, NI-RFSG automatically sets this value to -1. This property applies only when the start_trigger_type property is set to StartTrigType.P2P_ENDPOINT_FULLNESS - **Default Value:** -1, which allows NI-RFSG to select the appropriate fullness value. + **Default Value:** -1, which allows NI-RFSG to select the appropriate fullness value. - **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Start Trigger `_ + `Start Trigger `_ Note: Due to an additional internal FIFO in the RF signal generator, the writer peer actually needs to write 2,304 bytes more than the quantity of data specified by this property to satisfy the trigger level. ''' @@ -3724,31 +3699,31 @@ class _SessionBase(object): Returns the size, in samples, of the device endpoint. This property is endpoint-based. - **Units**: samples (s) + **Units**: samples (s) - **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Configuring a Peer-to-Peer Endpoint `_ + `Configuring a Peer-to-Peer Endpoint `_ ''' p2p_generation_fifo_sample_quantum = _attributes.AttributeViInt64(1150219) '''Type: int Returns how many samples NI-RFSG pulls from the peer-to-peer FIFO per read. You can use this property to determine how many samples to send across the peer-to-peer bus to ensure that no samples are ignored. If you send a number of samples that is not a multiple of this value, the remaining samples are not read from the FIFO during generation. This property is endpoint-based. - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 ''' p2p_is_finite_generation = _attributes.AttributeViBoolean(1150217) '''Type: bool Specifies whether peer-to-peer should continuously generate data from the peer-to-peer stream or from only a finite number of samples, according to the p2p_number_of_samples_to_generate property. To use this property, peer-to-peer must be enabled. This property is endpoint-based. - **Default Value**: False + **Default Value**: False - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 - **Defined Values**: + **Defined Values**: +-------+--------------------------------------------------------------+ | Value | Description | @@ -3763,50 +3738,50 @@ class _SessionBase(object): Returns the largest number of samples per channel available in the endpoint since this property was last read. You can use this property to determine how much endpoint space to use as a buffer against bus traffic latencies by reading the property and keeping track of the largest value returned. This property is endpoint-based. - If you want to minimize the latency for data to move through the endpoint and be generated by the RF signal generator, use the p2p_data_transfer_permission_initial_credits property to grant fewer initial credits than the default of the entire endpoint size. + If you want to minimize the latency for data to move through the endpoint and be generated by the RF signal generator, use the p2p_data_transfer_permission_initial_credits property to grant fewer initial credits than the default of the entire endpoint size. - **Units**: samples per channel + **Units**: samples per channel - **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Configuring a Peer-to-Peer Endpoint `_ + `Configuring a Peer-to-Peer Endpoint `_ ''' p2p_number_of_samples_to_generate = _attributes.AttributeViInt64(1150218) '''Type: int Specifies how many samples are generated from the peer-to-peer subsystem when it is enabled. To use this property, peer-to-peer must be enabled and set to finite generation. This property is endpoint-based. - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Configuring a Peer-to-Peer Endpoint `_ + `Configuring a Peer-to-Peer Endpoint `_ ''' p2p_space_available_in_endpoint = _attributes.AttributeViInt64(1150125) '''Type: int Returns the current space available in the endpoint. You can use this property when priming the endpoint with initial data using the WriteP2pEndpointI16 method to determine how many samples you can write. You also can use this property to characterize the performance and measure the latency of the peer-to-peer stream as data moves across the bus. This property is endpoint-based. - **Units**: samples per channel + **Units**: samples per channel - **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Configuring a Peer-to-Peer Endpoint `_ + `Configuring a Peer-to-Peer Endpoint `_ - `Starting Peer-to-Peer Generation `_ + `Starting Peer-to-Peer Generation `_ ''' peak_envelope_power = _attributes.AttributeViReal64(1150011) '''Type: float Returns the maximum instantaneous power of the RF output signal. - **Units**: dBm + **Units**: dBm - **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **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 power_level_type property is set to PowerLevelType.AVERAGE. @@ -3817,11 +3792,11 @@ class _SessionBase(object): Specifies the adjustment for the power_level property. This property is valid only when you set the power_level_type property to PowerLevelType.PEAK. The value of the peak_power_adjustment property adds to the power_level property. The 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 power_level_type property is set to PowerLevelType.PEAK. - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **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. + `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. @@ -3832,15 +3807,15 @@ class _SessionBase(object): Determines the inheritance behavior of the peak_power_adjustment property when a script inherits values from specified waveforms. - **Default Value:** PpaInheritance.EXACT_MATCH + **Default Value:** PpaInheritance.EXACT_MATCH - **Supported Devices:** PXIe-5673/5673E + **Supported Devices:** PXIe-5673/5673E - **Related Topics** + **Related Topics** - `Assigning Properties or Properties to a Waveform `_ + `Assigning Properties or Properties to a Waveform `_ - **Defined Values**: + **Defined Values**: +----------------------------+------------------------------------------------------------+ | Value | Description | @@ -3855,21 +3830,21 @@ class _SessionBase(object): Specifies whether the driver maintains phase continuity in the arbitrary waveforms. When this property is set to PhaseContinuityEnabled.ENABLE, NI-RFSG may increase the waveform size. When this property is set to PhaseContinuityEnabled.ENABLE, the frequency_tolerance property specifies the maximum allowable frequency error that can be introduced when keeping the signal phase-continuous. To set the phase_continuity_enabled property, the NI-RFSG device must be in the Configuration state. phase_continuity_enabled applies only when the generation_mode property is set to GenerationMode.ARB_WAVEFORM or GenerationMode.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. + 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. + 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:** PhaseContinuityEnabled.AUTO + **Default Value:** PhaseContinuityEnabled.AUTO - **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Phase Continuity `_ + `Phase Continuity `_ - `Arb Waveform Mode Tuning Speed Factors `_ + `Arb Waveform Mode Tuning Speed Factors `_ - **Defined Values**: + **Defined Values**: +-------------------------------------------+-----------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | phase_continuity_enabled Property Setting | Value | With I/Q Rates > 8.33 MS/s. | @@ -3889,45 +3864,45 @@ class _SessionBase(object): 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 (°) + **Units**: degrees (°) - **Default Value:** 0 + **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 + **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** + **Related Topics** - `Phase Synchronization and Phase Coherency `_ + `Phase Synchronization and Phase Coherency `_ ''' power_level = _attributes.AttributeViReal64(1250002) '''Type: float Specifies either the average power level or peak power level of the generated RF signal, depending on the 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. + 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. + Refer to the specifications document for your device for allowable power level settings. - **Units**: dBm + **Units**: dBm - **Default Values:** + **Default Values:** - PXIe-5644/5645/5646, PXIe-5673/5673E: -100 + PXIe-5644/5645/5646, PXIe-5673/5673E: -100 - PXI/PXIe-5650/5651/5652: -90 + PXI/PXIe-5650/5651/5652: -90 - PXIe-5654: -7 + PXIe-5654: -7 - PXIe-5654 with PXIe-5696: -110 + PXIe-5654 with PXIe-5696: -110 - PXI-5670/5671, PXIe-5672: -145 + PXI-5670/5671, PXIe-5672: -145 - PXIe-5830/5831/5832/5840/5841/5842/5860: -174 + 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**: + **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**: - - ConfigureRf + - ConfigureRf Note: - For the PXIe-5653, this property is read-only. @@ -3938,38 +3913,35 @@ class _SessionBase(object): Specifies how NI-RFSG interprets the value of the power_level property. The power_level_type property also affects how waveforms are scaled. - PXI-5670/5671: While in Script generation mode, if this property is set to PowerLevelType.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 power_level property. You can disable this scaling operation by setting the power_level_type property to PowerLevelType.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 PowerLevelType.PEAK. + PXI-5670/5671: While in Script generation mode, if this property is set to PowerLevelType.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 power_level property. You can disable this scaling operation by setting the power_level_type property to PowerLevelType.PEAK. - Converting from Average Power to Peak Power + 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 PowerLevelType.PEAK. - Typically, this property is set to PowerLevelType.AVERAGE. However, some instrument modes require this property to be set to PowerLevelType.PEAK. Use the following equations to calculate the equivalent peak power given the desired average power for your waveform: + Converting from Average Power to Peak Power + Typically, this property is set to PowerLevelType.AVERAGE. However, some instrument modes require this property to be set to PowerLevelType.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. + Where 1 is the highest possible magnitude in the waveform. + **Default Value:** + PXIe-5820: PowerLevelType.PEAK - **Default Value:** + All other devices: PowerLevelType.AVERAGE - PXIe-5820: PowerLevelType.PEAK + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - All other devices: PowerLevelType.AVERAGE + **Related Topics** - **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + `Spurious Performance `_ - **Related Topics** + `Optimizing for Low Power Generation `_ - `Spurious Performance `_ + **High-Level Methods**: - `Optimizing for Low Power Generation `_ + - configure_power_level_type - **High-Level Methods**: - - - configure_power_level_type - - **Defined Values**: + **Defined Values**: +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Value | Description | @@ -3984,11 +3956,11 @@ class _SessionBase(object): 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:** ScriptTrigDigLevelActiveLevel.HIGH + **Default Value:** ScriptTrigDigLevelActiveLevel.HIGH - **Supported Devices:** PXIe-5842 + **Supported Devices:** PXIe-5842 - **Defined Values**: + **Defined Values**: +------------------------------------+---------------+--------------------------------------------------+ | Name | Value | Description | @@ -4003,21 +3975,21 @@ class _SessionBase(object): 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-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-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. + 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 + **Default Value:** False - **Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXIe-5673/5673E + **Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXIe-5673/5673E - **Related Topics** + **Related Topics** - `Pulse Modulation `_ + `Pulse Modulation `_ - **Defined Values**: + **Defined Values**: +-------+----------------------------+ | Value | Description | @@ -4032,13 +4004,13 @@ class _SessionBase(object): 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. + 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:** PulseModulationMode.ANALOG + **Default Value:** PulseModulationMode.ANALOG - **Supported Devices:** PXIe-5842/5654/5654 with PXIe-5696 + **Supported Devices:** PXIe-5842/5654/5654 with PXIe-5696 - **Defined Values**: + **Defined Values**: +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | Value | Description | @@ -4060,69 +4032,66 @@ class _SessionBase(object): 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:** NIRFSG_VAL_PULSE_IN_STR + **Default Value:** PulseIn - **Supported Devices:** PXIe-5842 + **Supported Devices:** PXIe-5842 - **Possible Values**: + **Possible Values**: +----------------+----------------------------------------------------------------------------------------------+ | Possible Value | Description | +================+==============================================================================================+ - | PulseIn | The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842. | + | "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. | + | "Marker0" | The trigger is received from the Marker 0. | +----------------+----------------------------------------------------------------------------------------------+ - | Marker1 | The trigger is received from the Marker 1. | + | "Marker1" | The trigger is received from the Marker 1. | +----------------+----------------------------------------------------------------------------------------------+ - | Marker2 | The trigger is received from the Marker 2. | + | "Marker2" | The trigger is received from the Marker 2. | +----------------+----------------------------------------------------------------------------------------------+ - | Marker3 | The trigger is received from the Marker 3. | + | "Marker3" | The trigger is received from the Marker 3. | +----------------+----------------------------------------------------------------------------------------------+ - - 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. ''' pxi_chassis_clk10_source = _attributes.AttributeViString(1150004) '''Type: str Specifies the clock source for driving the PXI 10 MHz backplane Reference Clock. This property is configurable if the PXI-5610 upconverter module is installed in *only* Slot 2 of a PXI chassis. To set this property, the NI-RFSG device must be in the Configuration state. - **Possible Values**: + **Possible Values**: Possible Value: Description - empty :Do not drive the PXI_CLK10 signal. + "" :Do not drive the PXI_CLK10 signal. - OnboardClock :Uses the highly stable oven-controlled onboard Reference Clock to drive the PXI_CLK signal. + "OnboardClock" :Uses the highly stable oven-controlled onboard Reference Clock to drive the PXI_CLK signal. - RefIn :Uses the clock present at the front panel REF IN connector to drive the PXI_CLK signal. + "RefIn" :Uses the clock present at the front panel REF IN connector to drive the PXI_CLK signal. - **Default Value:** empty + **Default Value:** "" - **Supported Devices:** PXI-5610, PXI-5670/5671 + **Supported Devices:** PXI-5610, PXI-5670/5671 - **Related Topics** + **Related Topics** - `Timing Configurations `_ + `Timing Configurations `_ - `System Reference Clock `_ + `System Reference Clock `_ - **High-Level Methods**: + **High-Level Methods**: - - configure_pxi_chassis_clk10 + - configure_pxi_chassis_clk10 - Only certain combinations of this property and the ref_clock_source property are valid, as shown in the following table. + Only certain combinations of this property and the ref_clock_source property are valid, as shown in the following table. +----------------------------------+--------------------------+ | pxi_chassis_clk10_source Setting | ref_clock_source Setting | +==================================+==========================+ - | empty, OnboardClock | OnboardClock | + | "", OnboardClock | OnboardClock | +----------------------------------+--------------------------+ - | empty, RefIn | RefIn | + | "", RefIn | RefIn | +----------------------------------+--------------------------+ - | empty, RefIn | PXI_CLK | + | "", RefIn | PXI_CLK | +----------------------------------+--------------------------+ ''' query_instrument_status = _attributes.AttributeViBoolean(1050003) @@ -4130,13 +4099,13 @@ class _SessionBase(object): Specifies whether NI-RFSG queries the NI-RFSG device status after each operation. Querying the device status is useful for debugging. After you validate your program, set this property to False to disable status checking and maximize performance. - NI-RFSG can choose to ignore status checking for particular properties, regardless of the setting of this property. Use the __init__ method to override the default value. + NI-RFSG can choose to ignore status checking for particular properties, regardless of the setting of this property. Use the __init__ method to override the default value. - **Default Value:** False + **Default Value:** False - **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 + **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 - **Defined Values**: + **Defined Values**: +-------+-------------------------------------------------------------+ | Value | Description | @@ -4151,11 +4120,11 @@ class _SessionBase(object): Specifies whether to validate property values and method parameters. Range checking parameters is very useful for debugging. After you validate your program, set this property to False to disable range checking and maximize performance. NI-RFSG can choose to ignore range checking for particular properties, regardless of the setting of this property. Use the __init__ method to override the default value. - **Default Value:** True + **Default Value:** True - **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 + **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 - **Defined Values**: + **Defined Values**: +-------+-------------------------+ | Value | Description | @@ -4170,11 +4139,11 @@ class _SessionBase(object): Specifies whether the IVI engine keeps a list of the value coercions it makes for integer and real type properties. - **Default Value:** False + **Default Value:** False - **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 + **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 - **Defined Values**: + **Defined Values**: +-------+---------------------------------------------------+ | Value | Description | @@ -4189,39 +4158,39 @@ class _SessionBase(object): ref_clock_rate = _attributes.AttributeEnum(_attributes.AttributeViReal64, enums.ReferenceClockRate, 1250322) '''Type: enums.ReferenceClockRate - 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 ref_clock_source property is set to NIRFSG_VAL_CLK_IN_STR, NIRFSG_VAL_REF_IN_STR, or NIRFSG_VAL_REF_IN_2_STR + 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 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. + 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 ReferenceClockRate.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. + If you set this property to ReferenceClockRate.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:** + **Valid Values:** - PXIe-5654/5654 with PXIe-5696: Values between 1MHz to 20MHz in 1MHz steps are supported in addition to the ReferenceClockRate.AUTO and ReferenceClockRate._10mhz values. + PXIe-5654/5654 with PXIe-5696: Values between 1MHz to 20MHz in 1MHz steps are supported in addition to the ReferenceClockRate.AUTO and ReferenceClockRate._10mhz values. - PXIe-5841 with PXIe-5655, PXIe-5842: 10 MHz, 100 MHz, 270 MHz, and 3.84 MHz + PXIe-5841 with PXIe-5655, PXIe-5842: 10 MHz, 100 MHz, 270 MHz, and 3.84 MHz - y, where + y, where - y is 4, 8, 16, 24, 25, or 32. + y is 4, 8, 16, 24, 25, or 32. - PXIe-5860: 10 MHz, 100 MHz + PXIe-5860: 10 MHz, 100 MHz - **Units**: hertz (Hz) + **Units**: hertz (Hz) - **Default Value:** ReferenceClockRate.AUTO + **Default Value:** ReferenceClockRate.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 + **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** + **Related Topics** - `Timing Configurations `_ + `Timing Configurations `_ - **High-Level Methods**: + **High-Level Methods**: - - configure_ref_clock + - configure_ref_clock - **Defined Values**: + **Defined Values**: +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | Value | Description | @@ -4241,88 +4210,88 @@ class _SessionBase(object): Specifies the Reference Clock source. To set this property, the NI-RFSG device must be in the Configuration state. Only certain combinations of this property and the pxi_chassis_clk10_source property are valid, as shown in the following table. - **Default Value:** NIRFSG_VAL_ONBOARD_CLOCK_STR + **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 + **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** + **Related Topics** - `Timing Configurations `_ + `Timing Configurations `_ - **High-Level Methods**: + **High-Level Methods**: - - configure_ref_clock + - configure_ref_clock - **Possible Values**: + **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 NIRFSG_VAL_PXI_CLK_STR as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. | - +----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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. | + +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Note: The PXI-5670/5671 and PXIe-5672 devices also allow you to drive the PXI 10 MHz backplane clock on PXI chassis *only* using the pxi_chassis_clk10_source property. - - 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. ''' - ref_pll_bandwidth = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.LoopBandwidth, 1150133) - '''Type: enums.LoopBandwidth + ref_pll_bandwidth = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.RefPllBandwidth, 1150133) + '''Type: enums.RefPllBandwidth Configures the loop bandwidth of the reference PLL. - **Default Value:** LoopBandwidth.NARROW + **Default Value:** RefPllBandwidth.NARROW - **Supported Devices:** PXIe-5653 + **Supported Devices:** PXIe-5653 - **Related Topics** + **Related Topics** - `Phase-Locked Loop Bandwidth `_ + `Phase-Locked Loop Bandwidth `_ - **Defined Values**: + **Defined Values**: - +----------------------+--------------------------------------------------------+ - | Value | Description | - +======================+========================================================+ - | LoopBandwidth.NARROW | Uses the narrowest loop bandwidth setting for the PLL. | - +----------------------+--------------------------------------------------------+ - | LoopBandwidth.MEDIUM | Uses the medium loop bandwidth setting for the PLL. | - +----------------------+--------------------------------------------------------+ - | LoopBandwidth.WIDE | Uses the widest loop bandwidth setting for the PLL. | - +----------------------+--------------------------------------------------------+ + +------------------------+--------------------------------------------------------+ + | Value | Description | + +========================+========================================================+ + | RefPllBandwidth.NARROW | Uses the narrowest loop bandwidth setting for the PLL. | + +------------------------+--------------------------------------------------------+ + | RefPllBandwidth.MEDIUM | Uses the medium loop bandwidth setting for the PLL. | + +------------------------+--------------------------------------------------------+ + | RefPllBandwidth.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. ''' relative_delay = _attributes.AttributeViReal64(1150220) '''Type: float 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. + 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 + **Units:** Seconds - **Valid Values:** + **Valid Values:** - PXIe-PXIe-5820/5830/5831/5832/5840/5841: 0 μs to 3.2 μs + PXIe-PXIe-5820/5830/5831/5832/5840/5841: 0 μs to 3.2 μs - PXIe-5842: 0 μs to 6.5 μs + PXIe-5842: 0 μs to 6.5 μs - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `NI-TClk Overview `_ + `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. @@ -4333,39 +4302,39 @@ class _SessionBase(object): 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. + 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. + 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-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. + 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 reset or `niRFSA_reset `_ on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call ResetWithOptions or `niRFSA_ResetWithOptions `_. Select **Routes** in the **steps to omit** parameter. + For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any reset or `niRFSA_reset `_ on the same device, NI recommends calling it before committing blanking properties. Alternatively, you can call ResetWithOptions or `niRFSA_ResetWithOptions `_. Select **Routes** in the **steps to omit** parameter. - **Default Value:** "" (empty string) + **Default Value:** "" (empty string) - **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Marker Events `_ + `Marker Events `_ - **Valid Values**: + **Valid Values**: - +-------------------+---------------------------------+ - | Value | Description | - +===================+=================================+ - | "" (empty string) | 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. | - +-------------------+---------------------------------+ + +-----------+---------------------------------+ + | 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. ''' @@ -4374,15 +4343,15 @@ class _SessionBase(object): Specifies whether to enable the RF IN LO OUT terminal on the PXIe-5840/5841. - Set this property to RFInLoExportEnabled.ENABLE to export the LO signal from the RF IN LO OUT terminal. + Set this property to RFInLoExportEnabled.ENABLE to export the LO signal from the RF IN LO OUT terminal. - When this property is enabled, if the lo_source property is set to NIRFSG_VAL_LO_SOURCE_LO_IN_STR and you do not set the lo_frequency or upconverter_center_frequency properties, NI-RFSG rounds the LO frequency to approximately an LO step size as if the source was NIRFSG_VAL_ONBOARD_CLOCK_STR. This ensures that when you configure NI-RFSA and NI-RFSG with compatible settings that result in the same LO frequency, the rounding also is compatible. + When this property is enabled, if the lo_source property is set to LO_In and you do not set the lo_frequency or 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:** RFInLoExportEnabled.UNSPECIFIED + **Default Value:** RFInLoExportEnabled.UNSPECIFIED - **Supported Devices**: PXIe-5840/5841/5842 + **Supported Devices**: PXIe-5840/5841/5842 - **Defined Values**: + **Defined Values**: +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | Value | Description | @@ -4402,27 +4371,27 @@ class _SessionBase(object): Returns the name of the fully qualified signal name as a string. - **Default Values**: + **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. + 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-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-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. + 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 + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Triggers `_ + `Triggers `_ - `Syntax for Terminal Names `_ + `Syntax for Terminal Names `_ - **High-Level Methods**: + **High-Level Methods**: - - get_terminal_name + - get_terminal_name Tip: This property can be set/get on specific script_triggers within your :py:class:`nirfsg.Session` instance. @@ -4439,21 +4408,21 @@ class _SessionBase(object): 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:** ScriptTrigType.NONE + **Default Value:** ScriptTrigType.NONE - **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Script Trigger `_ + `Script Trigger `_ - `Trigger Types `_ + `Trigger Types `_ - **High-Level Methods**: + **High-Level Methods**: - - configure_digital_edge_script_trigger + - configure_digital_edge_script_trigger - **Defined Values**: + **Defined Values**: +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Value | Description | @@ -4490,25 +4459,25 @@ class _SessionBase(object): Specifies the port to configure. - **Valid Values**: + **Valid Values**: - PXIe-5644/5645/5646, PXIe-5820/5840/5841: "" (empty string) + PXIe-5644/5645/5646, PXIe-5820/5840/5841: "" (empty string) - PXIe-5830: if0, if1 + 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. + 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:** + **Default Value:** - PXIe-5644/5645/5646, PXIe-5820/5840/5841/5842/5860: "" (empty string) + PXIe-5644/5645/5646, PXIe-5820/5840/5841/5842/5860: "" (empty string) - PXIe-5830/5831/5832: if0 + PXIe-5830/5831/5832: if0 - **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - available_ports + available_ports Note: When using RF list mode, ports cannot be shared with NI-RFSA. ''' @@ -4517,69 +4486,69 @@ class _SessionBase(object): Specifies the script in onboard memory to generate upon calling the _initiate method when the generation_mode property is set to GenerationMode.SCRIPT. - The selected_script property is ignored when the generation_mode property is set to GenerationMode.ARB_WAVEFORM or GenerationMode.CW. To set the selected_script property, the NI-RFSG device must be in the Configuration state. + The selected_script property is ignored when the generation_mode property is set to GenerationMode.ARB_WAVEFORM or GenerationMode.CW. To set the 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 + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Assigning Properties or Properties to a Waveform `_ + `Assigning Properties or Properties to a Waveform `_ - `Scripting Instructions `_ + `Scripting Instructions `_ ''' self_calibration_temperature = _attributes.AttributeViReal64(1150136) '''Type: float Indicates, in degrees Celsius, the temperature of the device at the time of the last self calibration. - **Supported Devices:** PXIe-5644/5645/5646 + **Supported Devices:** PXIe-5644/5645/5646 ''' serial_number = _attributes.AttributeViString(1150026) '''Type: str 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 + **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 ''' signal_bandwidth = _attributes.AttributeViReal64(1150007) '''Type: float Specifies the bandwidth of the arbitrary signal. This value must be less than or equal to (0.8× 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* :sub:`max` - *f* :sub:`min` . + 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* :sub:`max` - *f* :sub:`min` . - This property applies only when the generation_mode property is set to GenerationMode.ARB_WAVEFORM or GenerationMode.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 signal_bandwidth property, the NI-RFSG device must be in the Configuration state. + This property applies only when the generation_mode property is set to GenerationMode.ARB_WAVEFORM or GenerationMode.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 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. + 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-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. + 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) + **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 + **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** + **Related Topics** - `Phase-Locked Loop Bandwidth `_ + `Phase-Locked Loop Bandwidth `_ - `Frequency Tuning Times `_ + `Frequency Tuning Times `_ - `PXIe-5830 Frequency and Bandwidth Selection `_ + `PXIe-5830 Frequency and Bandwidth Selection `_ - `PXIe-5831/5832 Frequency and Bandwidth Selection `_ + `PXIe-5831/5832 Frequency and Bandwidth Selection `_ - `PXIe-5841 Frequency and Bandwidth Selection `_ + `PXIe-5841 Frequency and Bandwidth Selection `_ ''' simulate = _attributes.AttributeViBoolean(1050005) '''Type: bool Returns whether NI-RFSG simulates I/O operations. This property is useful for debugging applications without using hardware. After a session is opened, you cannot change the simulation state. Use the __init__ method to enable simulation. - **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 + **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 - **Defined Values**: + **Defined Values**: +-------+-------------------------+ | Value | Description | @@ -4594,129 +4563,129 @@ class _SessionBase(object): 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 + **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 ''' specific_driver_class_spec_minor_version = _attributes.AttributeViInt32(1050516) '''Type: int 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 + **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 ''' specific_driver_description = _attributes.AttributeViString(1050514) '''Type: str Returns a string that contains a brief description of NI-RFSG. This property returns - National Instruments RF Signal Generator Instrument Driver. + 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 + **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 ''' specific_driver_prefix = _attributes.AttributeViString(1050302) '''Type: str 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. + 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 + **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 ''' specific_driver_revision = _attributes.AttributeViString(1050551) '''Type: str 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. + 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 + **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 ''' specific_driver_vendor = _attributes.AttributeViString(1050513) '''Type: str Returns a string that contains the name of the vendor that supplies NI-RFSG. This property returns - National Instruments. + 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 + **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 ''' started_event_terminal_name = _attributes.AttributeViString(1150112) '''Type: str Returns the name of the fully qualified signal name as a string. - **Default Values**: + **Default Values**: - PXI-5670/5671, PXIe-5672/5673/5673E: /*AWGName*/StartedEvent, where *AWGName* is the name of your associated AWG module in MAX. + 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-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-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). + 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 + **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Events `_ + `Events `_ - `Syntax for Terminal Names `_ + `Syntax for Terminal Names `_ - **High-Level Methods**: + **High-Level Methods**: - - get_terminal_name + - get_terminal_name ''' start_trigger_terminal_name = _attributes.AttributeViString(1150114) '''Type: str Returns the name of the fully qualified signal name as a string. - **Default Values**: + **Default Values**: - PXIe-5654/5654 with PXIe-5696: /*ModuleName*/StartTrigger, where *ModuleName* is the name of your device in MAX. + 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. + 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-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-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). + 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 + **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** + **Related Topics** - `Start Trigger `_ + `Start Trigger `_ - `Syntax for Terminal Names `_ + `Syntax for Terminal Names `_ - **High-Level Methods**: + **High-Level Methods**: - - get_terminal_name + - get_terminal_name ''' start_trigger_type = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.StartTrigType, 1250458) '''Type: enums.StartTrigType 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:** StartTrigType.NONE + **Default Value:** StartTrigType.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 + **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** + **Related Topics** - `Start Trigger `_ + `Start Trigger `_ - `Trigger Types `_ + `Trigger Types `_ - **High-Level Methods**: + **High-Level Methods**: - - configure_digital_edge_start_trigger - - configure_software_start_trigger - - disable_start_trigger + - configure_digital_edge_start_trigger + - configure_software_start_trigger + - disable_start_trigger - **Defined Values**: + **Defined Values**: +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Value | Description | @@ -4738,15 +4707,15 @@ class _SessionBase(object): Enables and disables continuous streaming of waveform data. - **Default Value:** False + **Default Value:** False - **Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Streaming `_ + `Streaming `_ - **Defined Values**: + **Defined Values**: +-------+------------------------+ | Value | Description | @@ -4761,88 +4730,88 @@ class _SessionBase(object): 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. + To read this property, the NI-RFSG device must be in the Committed state. - **Units**: samples + **Units**: samples - **Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Streaming `_ + `Streaming `_ ''' streaming_waveform_name = _attributes.AttributeViString(1150046) '''Type: str Specifies the name of the waveform used to continually stream data during generation. - **Default Value:** "" (empty string) + **Default Value:** "" (empty string) - **Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Streaming `_ + `Streaming `_ - `Streaming Waveform Data `_ + `Streaming Waveform Data `_ ''' streaming_write_timeout = _attributes.AttributeViReal64TimeDeltaSeconds(1150140) '''Type: hightime.timedelta, datetime.timedelta, or float in seconds Indicates the maximum amount of time allowed to complete a streaming write operation. - **Default Value:** 10.0seconds + **Default Value:** 10.0seconds - **Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Streaming `_ + `Streaming `_ - `Streaming Waveform Data `_ + `Streaming Waveform Data `_ ''' supported_instrument_models = _attributes.AttributeViString(1050327) '''Type: str Returns a string that contains a model code of the NI-RFSG device. For drivers that support more than one device, this property contains 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 + **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 ''' sync_sample_clock_dist_line = _attributes.AttributeViString(1150181) '''Type: str 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. + 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 + **Valid Values:** PXI_Trig0, PXI_Trig1, PXI_Trig2, PXI_Trig3, PXI_Trig4, PXI_Trig5, PXI_Trig6, PXI_Trig7, PFI0 - **Default Value:** "" (empty string) + **Default Value:** "" (empty string) - **Supported Devices:** PXIe-5646 + **Supported Devices:** PXIe-5646 - **Related Topics** + **Related Topics** - `Synchronization Using NI-RFSA and NI-RFSG `_—Refer to this topic for more information about PXIe-5646 device synchronization. + `Synchronization Using NI-RFSA and NI-RFSG `_—Refer to this topic for more information about PXIe-5646 device synchronization. ''' sync_sample_clock_master = _attributes.AttributeViBoolean(1150180) '''Type: bool 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. + 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. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** False + **Default Value:** False - **Supported Devices:** PXIe-5646 + **Supported Devices:** PXIe-5646 - **Related Topics** + **Related Topics** - `Synchronization Using NI-RFSA and NI-RFSG `_—Refer to this topic for more information about PXIe-5646 device synchronization. + `Synchronization Using NI-RFSA and NI-RFSG `_—Refer to this topic for more information about PXIe-5646 device synchronization. - **Defined Values**: + **Defined Values**: +-------+---------------------------------------------------------------------+ | Value | Description | @@ -4857,46 +4826,46 @@ class _SessionBase(object): 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. + 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 + **Valid Values:** PXI_Trig0, PXI_Trig1, PXI_Trig2, PXI_Trig3, PXI_Trig4, PXI_Trig5, PXI_Trig6, PXI_Trig7, PFI0 - **Default Value:** "" (empty string) + **Default Value:** "" (empty string) - **Supported Devices:** PXIe-5644/5645/5646 + **Supported Devices:** PXIe-5644/5645/5646 - **Related Topics** + **Related Topics** - `Script Trigger `_ + `Script Trigger `_ - `Synchronizing Sample Clock and Sampled Reference Clock Signals `_ + `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. + 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. ''' sync_script_trigger_master = _attributes.AttributeViBoolean(1150142) '''Type: bool 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. + 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 script_trigger_type property to digital edge, and set the digital_edge_script_trigger_source property to sync_script. + 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 script_trigger_type property to digital edge, and set the digital_edge_script_trigger_source property to sync_script. - To set this property, the NI-RFSG device must be in the Configuration state. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** False + **Default Value:** False - **Supported Devices:** PXIe-5644/5645/5646 + **Supported Devices:** PXIe-5644/5645/5646 - **Related Topics** + **Related Topics** - `Script Trigger `_ + `Script Trigger `_ - `Synchronizing Sample Clock and Sampled Reference Clock Signals `_ + `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. + 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**: + **Defined Values**: +-------+-----------------------------------------------------------------------+ | Value | Description | @@ -4911,40 +4880,40 @@ class _SessionBase(object): 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. + 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 + **Valid Values:** PXI_Trig0, PXI_Trig1, PXI_Trig2, PXI_Trig3, PXI_Trig4, PXI_Trig5, PXI_Trig6, PXI_Trig7, PFI0 - **Default Value:** "" (empty string) + **Default Value:** "" (empty string) - **Supported Devices:** PXIe-5644/5645/5646 + **Supported Devices:** PXIe-5644/5645/5646 - **Related Topics** + **Related Topics** - `Start Trigger `_ + `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. + 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. ''' sync_start_trigger_master = _attributes.AttributeViBoolean(1150155) '''Type: bool 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 start_trigger_type property to digital edge, and set the digital_edge_start_trigger_source property to sync_script. + 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 start_trigger_type property to digital edge, and set the digital_edge_start_trigger_source property to sync_script. - To set this property, the NI-RFSG device must be in the Configuration state. + To set this property, the NI-RFSG device must be in the Configuration state. - **Default Value:** False + **Default Value:** False - **Supported Devices:** PXIe-5644/5645/5646 + **Supported Devices:** PXIe-5644/5645/5646 - **Related Topics** + **Related Topics** - `Start Trigger `_ + `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. + 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**: + **Defined Values**: +-------+----------------------------------------------------------------------+ | Value | Description | @@ -4959,56 +4928,56 @@ class _SessionBase(object): Specifies the minimum time between temperature sensor readings. - **Units:** Seconds + **Units:** Seconds - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 ''' thermal_correction_headroom_range = _attributes.AttributeViReal64(1150258) '''Type: float Specifies the expected thermal operating range of the instrument from the self-calibration temperature, in degrees Celsius, returned from the 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. + 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) + **Units:** degrees Celsius (°C) - **Default Value**: + **Default Value**: - **PXIe-5830/5831/5832/5842/5860**: 5 + **PXIe-5830/5831/5832/5842/5860**: 5 - **PXIe-5840/5841**: 10 + **PXIe-5840/5841**: 10 - **Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860 + **Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860 ''' thermal_correction_temperature_resolution = _attributes.AttributeViReal64(1150244) '''Type: float 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) + **Units:** degrees Celsius (°C) - **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Default Values:** + **Default Values:** - PXIe-5830/5831/5832/5842/5860: 0.2 + PXIe-5830/5831/5832/5842/5860: 0.2 - PXIe-5840/5841: 1.0 + PXIe-5840/5841: 1.0 ''' timer_event_interval = _attributes.AttributeViReal64TimeDeltaSeconds(1150100) '''Type: hightime.timedelta, datetime.timedelta, or float in seconds 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) + **Units**: seconds (s) - **Default Value:** 0 + **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 + **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** + **Related Topics** - `Events `_ + `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. ''' @@ -5017,9 +4986,9 @@ class _SessionBase(object): 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) + **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 + **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. @@ -5034,33 +5003,33 @@ class _SessionBase(object): This property offsets the 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:** + **Valid Values:** - PXIe-5644/5645: -42MHz to +42MHz + PXIe-5644/5645: -42MHz to +42MHz - PXIe-5646: -100MHz to +100MHz + PXIe-5646: -100MHz to +100MHz - PXIe-5830/5831/5832/5840/5841: -500MHz to +500MHz + PXIe-5830/5831/5832/5840/5841: -500MHz to +500MHz - PXI-5842 (500 MHz bandwidth option): -250MHz to +250MHz + PXI-5842 (500 MHz bandwidth option): -250MHz to +250MHz - PXI-5842 (1 GHz bandwidth option): -500MHz to +500MHz + PXI-5842 (1 GHz bandwidth option): -500MHz to +500MHz - PXI-5842 (2 GHz bandwidth option): -1GHz to +1GHz + 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 Standard personality: -1GHz to +1GHz - PXIe-5842 (4 GHz bandwidth option) using the 4 GHz Bandwidth personality: -2GHz to +2GHz + 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 + **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `PXIe-5830 Frequency and Bandwidth Selection `_ + `PXIe-5830 Frequency and Bandwidth Selection `_ - `PXIe-5831/5832 Frequency and Bandwidth Selection `_ + `PXIe-5831/5832 Frequency and Bandwidth Selection `_ - `PXIe-5841 Frequency and Bandwidth Selection `_ + `PXIe-5841 Frequency and Bandwidth Selection `_ Note: - You cannot set the upconverter_center_frequency property or the arb_carrier_frequency property at the same time as the upconverter_frequency_offset property. @@ -5071,27 +5040,27 @@ class _SessionBase(object): 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. + 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 UpconverterFrequencyOffsetMode.AUTO or UpconverterFrequencyOffsetMode.USER_DEFINED, and set either the upconverter_center_frequency or the upconverter_frequency_offset property. + To set an offset yourself, set this property to UpconverterFrequencyOffsetMode.AUTO or UpconverterFrequencyOffsetMode.USER_DEFINED, and set either the upconverter_center_frequency or the upconverter_frequency_offset property. - To allow NI-RFSG to automatically select the upconverter frequency offset, set this property to UpconverterFrequencyOffsetMode.AUTO or UpconverterFrequencyOffsetMode.ENABLE and set the signal_bandwidth to describe the bandwidth of your waveform. The signal bandwidth must be no greater than half the value of the device_instantaneous_bandwidth property, minus a device-specific guard band. Do not set the upconverter_center_frequency or upconverter_frequency_offset properties. If all conditions are met, NI-RFSG places the upconverter center frequency outside the signal bandwidth. Set this property to UpconverterFrequencyOffsetMode.ENABLE if you want to receive an error any time NI-RFSG is unable to apply automatic offset. + To allow NI-RFSG to automatically select the upconverter frequency offset, set this property to UpconverterFrequencyOffsetMode.AUTO or UpconverterFrequencyOffsetMode.ENABLE and set the signal_bandwidth to describe the bandwidth of your waveform. The signal bandwidth must be no greater than half the value of the device_instantaneous_bandwidth property, minus a device-specific guard band. Do not set the upconverter_center_frequency or upconverter_frequency_offset properties. If all conditions are met, NI-RFSG places the upconverter center frequency outside the signal bandwidth. Set this property to UpconverterFrequencyOffsetMode.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 upconverter_frequency_offset_mode returns UpconverterFrequencyOffsetMode.USER_DEFINED. When NI-RFSG automatically sets an offset, the reference frequency for gain is near the frequency and upconverter_frequency_offset_mode returns UpconverterFrequencyOffsetMode.ENABLE. + When you set an offset yourself or do not use an offset, the reference frequency for gain is near the upconverter center frequency, and upconverter_frequency_offset_mode returns UpconverterFrequencyOffsetMode.USER_DEFINED. When NI-RFSG automatically sets an offset, the reference frequency for gain is near the frequency and upconverter_frequency_offset_mode returns UpconverterFrequencyOffsetMode.ENABLE. - **Default Value:** UpconverterFrequencyOffsetMode.AUTO + **Default Value:** UpconverterFrequencyOffsetMode.AUTO - **Supported Devices**: PXIe-5830/5831/5832/5841/5842 + **Supported Devices**: PXIe-5830/5831/5832/5841/5842 - **Related Topics** + **Related Topics** - `PXIe-5830 Automatic Frequency Offset `_ + `PXIe-5830 Automatic Frequency Offset `_ - `PXIe-5831/5832 Automatic Frequency Offset `_ + `PXIe-5831/5832 Automatic Frequency Offset `_ - `PXIe-5841 Automatic Frequency Offset `_ + `PXIe-5841 Automatic Frequency Offset `_ - **Defined Values**: + **Defined Values**: +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Value | Description | @@ -5113,9 +5082,9 @@ class _SessionBase(object): Specifies the gain the upconverter applies to the signal. - **Units**: dB + **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 + **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. ''' @@ -5124,15 +5093,15 @@ class _SessionBase(object): 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 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Streaming `_ + `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. + `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 `_ + `Digital Upconverter `_ Tip: This property can be set/get on specific waveform within your :py:class:`nirfsg.Session` instance. @@ -5149,7 +5118,7 @@ class _SessionBase(object): Specifies the peak-to-average power ratio (PAPR). - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 Tip: This property can be set/get on specific waveform within your :py:class:`nirfsg.Session` instance. @@ -5172,15 +5141,15 @@ class _SessionBase(object): RFBlanking.ENABLE (1): RF blanking is enabled. - **Default Value:** RFBlanking.DISABLE + **Default Value:** RFBlanking.DISABLE - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Marker Events `_ + `Marker Events `_ - Enables or disables RF blanking. + Enables or disables RF blanking. +-----------------------------------------------------------------------------------+----------------------+-----------------------------------------------------------------------------------------------------------+ | rf_blanking_source | waveform_rf_blanking | Behaviour | @@ -5214,9 +5183,9 @@ class _SessionBase(object): Specifies the waveform runtime scaling. The waveform runtime scaling is applied to the waveform data before any other signal processing. - **Units**: dB + **Units**: dB - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860, PXIe-5841 with PXIe-5655 + **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 waveform within your :py:class:`nirfsg.Session` instance. @@ -5233,9 +5202,9 @@ class _SessionBase(object): Specifies the bandwidth of the arbitrary signal. This value must be less than or equal to (0.8× iq_rate). - **Units**: hertz (Hz) + **Units**: hertz (Hz) - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 Tip: This property can be set/get on specific waveform within your :py:class:`nirfsg.Session` instance. @@ -5252,7 +5221,7 @@ class _SessionBase(object): 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 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5841 with PXIe-5655/5842/5860 Tip: This property can be set/get on specific waveform within your :py:class:`nirfsg.Session` instance. @@ -5269,11 +5238,11 @@ class _SessionBase(object): 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 get_waveform_burst_start_locations and get_waveform_burst_stop_locations methods respectively. - **Default Value:** WriteWaveformBurstDetection.DISABLE + **Default Value:** WriteWaveformBurstDetection.DISABLE - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Defined Values**: + **Defined Values**: +-------------------------------------+------------------------------+ | Value | Description | @@ -5295,11 +5264,11 @@ class _SessionBase(object): 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 write_waveform_burst_detection property. When you set write_waveform_burst_detection_mode to WriteWaveformBurstDetectionMode.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 WriteWaveformBurstDetectionMode.MANUAL and specify the burst detection parameters using the write waveform burst detection minimum quiet time, write_waveform_burst_detection_power_threshold, write waveform burst detection minimum burst time properties. - **Default Value:** WriteWaveformBurstDetectionMode.AUTO + **Default Value:** WriteWaveformBurstDetectionMode.AUTO - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Defined Values**: + **Defined Values**: +----------------------------------------+---------------------------------------------------------------------------------------------------+ | Value | Description | @@ -5317,11 +5286,11 @@ class _SessionBase(object): 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 write_waveform_burst_detection property or when you set the write_waveform_burst_detection_mode property to NIRFSG_VAL_AUTO. - **Units:** dB + **Units:** dB - **Default Value:** 0 + **Default Value:** 0 - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **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. @@ -5331,11 +5300,11 @@ class _SessionBase(object): Specifies whether to perform the normalization on a waveform. - **Default Value:** WriteWaveformNormalization.DISABLE + **Default Value:** WriteWaveformNormalization.DISABLE - **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Defined Values**: + **Defined Values**: +------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | Value | Description | @@ -5355,11 +5324,11 @@ class _SessionBase(object): Adjusts the dynamics of the current driving the YIG main coil. - **Default Value:** YigMainCoilDrive.MANUAL + **Default Value:** YigMainCoilDrive.MANUAL - **Supported Devices:** PXIe-5653 + **Supported Devices:** PXIe-5653 - **Defined Values**: + **Defined Values**: +-----------------------+--------------------------------------------------------+ | Value | Description | @@ -5590,10 +5559,10 @@ def _get_attribute_vi_boolean(self, attribute): Queries the value of a ViBoolean property. - Use this low-level method to get the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: + Use this low-level method to get the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: - - State caching is disabled for the entire session or for the particular property. - - State caching is enabled, and the currently cached value is invalid. + - State caching is disabled for the entire session or for the particular property. + - State caching is enabled, and the currently cached value is invalid. Tip: This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. @@ -5623,10 +5592,10 @@ def _get_attribute_vi_int32(self, attribute): Queries the value of a ViInt32 property. - Use this low-level method to get the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: + Use this low-level method to get the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: - - State caching is disabled for the entire session or for the particular property. - - State caching is enabled, and the currently cached value is invalid. + - State caching is disabled for the entire session or for the particular property. + - State caching is enabled, and the currently cached value is invalid. Tip: This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. @@ -5656,10 +5625,10 @@ def _get_attribute_vi_int64(self, attribute): Queries the value of a ViInt64 property. - You can use this low-level method to get the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: + You can use this low-level method to get the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: - - State caching is disabled for the entire session or for the particular property. - - State caching is enabled, and the currently cached value is invalid. + - State caching is disabled for the entire session or for the particular property. + - State caching is enabled, and the currently cached value is invalid. Tip: This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. @@ -5689,10 +5658,10 @@ def _get_attribute_vi_real64(self, attribute): Queries the value of a ViReal64 property. - Use this low-level method to get the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: + Use this low-level method to get the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: - - State caching is disabled for the entire session or for the particular property. - - State caching is enabled, and the currently cached value is invalid. + - State caching is disabled for the entire session or for the particular property. + - State caching is enabled, and the currently cached value is invalid. Tip: This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. @@ -5722,10 +5691,10 @@ def _get_attribute_vi_session(self, attribute): Queries the value of a ViSession property. - Use this low-level method to get the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: + Use this low-level method to get the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: - - State caching is disabled for the entire session or for the particular property. - - State caching is enabled, and the currently cached value is invalid. + - State caching is disabled for the entire session or for the particular property. + - State caching is enabled, and the currently cached value is invalid. Tip: This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. @@ -5755,14 +5724,14 @@ def _get_attribute_vi_string(self, attribute): Queries the value of a ViString property. - Use this low-level method to get the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: + Use this low-level method to get the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: - - State caching is disabled for the entire session or for the particular property. - - State caching is enabled, and the currently cached value is invalid. + - State caching is disabled for the entire session or for the particular property. + - State caching is enabled, and the currently cached value is invalid. - You must provide a ViString (ViChar array) to serve as a buffer for the value. Pass the number of bytes in the buffer as the Buffer Size parameter. If the current value of the property, including the terminating NULL byte, is larger than the size you indicate in the buffer size parameter, the method copies buffer size-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. + You must provide a ViString (ViChar array) to serve as a buffer for the value. Pass the number of bytes in the buffer as the Buffer Size parameter. If the current value of the property, including the terminating NULL byte, is larger than the size you indicate in the buffer size parameter, the method copies buffer size-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. - To call this method to get only the required buffer size, pass 0 for the buffer size and VI_NULL for the property value buffer. + To call this method to get only the required buffer size, pass 0 for the buffer size and VI_NULL for the property value buffer. Tip: This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. @@ -5782,7 +5751,7 @@ def _get_attribute_vi_string(self, attribute): Returns: value (str): The buffer in which the method returns the current value of the property. The buffer must be of type ViChar and have at least as many bytes as indicated in the **bufferSize** parameter. - If you specify 0 for the **bufferSize** parameter, you can pass VI_NULL for this parameter. + If you specify 0 for the **bufferSize** parameter, you can pass VI_NULL for this parameter. ''' value = self._interpreter.get_attribute_vi_string(self._repeated_capability, attribute) @@ -5905,9 +5874,9 @@ def load_configurations_from_file(self, 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. + The VI does an implicit reset before loading the configurations from the file. - **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842/5860 Tip: This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. @@ -5967,7 +5936,7 @@ def reset_attribute(self, attribute_id): Resets the property to its default 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 + **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 Tip: This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. @@ -5992,7 +5961,7 @@ def save_configurations_to_file(self, file_path): Saves the configurations of the session to the specified file. - **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842/5860 Tip: This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. @@ -6017,20 +5986,20 @@ def send_software_edge_trigger(self, trigger, trigger_identifier): Forces a trigger to occur. - The specified trigger generates regardless of whether the trigger has been configured as a software trigger. + 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 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Triggers `_ + `Triggers `_ Args: trigger (enums.SoftwareTriggerType): Specifies the trigger to send. - **Default Value:** SoftwareTriggerType.START + **Default Value:** SoftwareTriggerType.START - **Defined Values:** + **Defined Values:** +----------------------------+---------+-------------------------------+ | Name | Value | Description | @@ -6045,9 +6014,9 @@ def send_software_edge_trigger(self, trigger, trigger_identifier): trigger_identifier (str): Specifies the Script Trigger to configure. This parameter is valid only when you set the TRIGGER parameter to NIRFSG_VAL_START_TRIGGER. Otherwise, set the TRIGGER_IDENTIFIER parameter to "" (empty string). - **Default Value:** "" (empty string) + **Default Value:** "" (empty string) - **Possible Values:** + **Possible Values:** +----------------+-----------------------------+ | Possible Value | Description | @@ -6080,14 +6049,14 @@ def _set_attribute_vi_boolean(self, attribute, value): Sets the value of a ViBoolean property. - Use this low-level method to set the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: + Use this low-level method to set the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: - - State caching is disabled for the entire session or for the particular property. - - State caching is enabled, and the currently cached value is invalid or is different than the value you specify. + - State caching is disabled for the entire session or for the particular property. + - State caching is enabled, and the currently cached value is invalid or is different than the value you specify. - NI-RFSG contains high-level methods that set most of the instrument properties. Use the high-level driver methods as much as possible, as they handle order dependencies and multithread locking. The high-level methods also perform status checking only after setting all of the properties. In contrast, when you set multiple properties using the SetAttribute methods, the methods check the instrument status after each call. + NI-RFSG contains high-level methods that set most of the instrument properties. Use the high-level driver methods as much as possible, as they handle order dependencies and multithread locking. The high-level methods also perform status checking only after setting all of the properties. In contrast, when you set multiple properties using the SetAttribute methods, the methods check the instrument status after each call. - Also, when state caching is enabled, the high-level methods that configure multiple properties perform instrument I/O only for the properties whose value you change. Thus, you can safely call the high-level methods without the penalty of redundant instrument I/O. + Also, when state caching is enabled, the high-level methods that configure multiple properties perform instrument I/O only for the properties whose value you change. Thus, you can safely call the high-level methods without the penalty of redundant instrument I/O. Tip: This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. @@ -6116,14 +6085,14 @@ def _set_attribute_vi_int32(self, attribute, value): Sets the value of a ViInt32 property. - Use this low-level method to set the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: + Use this low-level method to set the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: - - State caching is disabled for the entire session or for the particular property. - - State caching is enabled, and the currently cached value is invalid or is different than the value you specify. + - State caching is disabled for the entire session or for the particular property. + - State caching is enabled, and the currently cached value is invalid or is different than the value you specify. - NI-RFSG contains high-level methods that set most of the instrument properties. Use the high-level driver methods as much as possible, as they handle order dependencies and multithread locking. The high-level methods also perform status checking only after setting all of the properties. In contrast, when you set multiple properties using the SetAttribute methods, the methods check the instrument status after each call. + NI-RFSG contains high-level methods that set most of the instrument properties. Use the high-level driver methods as much as possible, as they handle order dependencies and multithread locking. The high-level methods also perform status checking only after setting all of the properties. In contrast, when you set multiple properties using the SetAttribute methods, the methods check the instrument status after each call. - Also, when state caching is enabled, the high-level methods that configure multiple properties perform instrument I/O only for the properties whose value you change. Thus, you can safely call the high-level methods without the penalty of redundant instrument I/O. + Also, when state caching is enabled, the high-level methods that configure multiple properties perform instrument I/O only for the properties whose value you change. Thus, you can safely call the high-level methods without the penalty of redundant instrument I/O. Tip: This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. @@ -6152,14 +6121,14 @@ def _set_attribute_vi_int64(self, attribute, value): Sets the value of a ViInt64 property. - Use this low-level method to set the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: + Use this low-level method to set the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: - - State caching is disabled for the entire session or for the particular property. - - State caching is enabled, and the currently cached value is invalid or is different than the value you specify. + - State caching is disabled for the entire session or for the particular property. + - State caching is enabled, and the currently cached value is invalid or is different than the value you specify. - NI-RFSG contains high-level methods that set most of the instrument properties. Use the high-level driver methods as much as possible, as they handle order dependencies and multithread locking. The high-level methods also perform status checking only after setting all of the properties. In contrast, when you set multiple properties using the SetAttribute methods, the methods check the instrument status after each call. + NI-RFSG contains high-level methods that set most of the instrument properties. Use the high-level driver methods as much as possible, as they handle order dependencies and multithread locking. The high-level methods also perform status checking only after setting all of the properties. In contrast, when you set multiple properties using the SetAttribute methods, the methods check the instrument status after each call. - Also, when state caching is enabled, the high-level methods that configure multiple properties perform instrument I/O only for the properties whose value you change. Thus, you can safely call the high-level methods without the penalty of redundant instrument I/O. + Also, when state caching is enabled, the high-level methods that configure multiple properties perform instrument I/O only for the properties whose value you change. Thus, you can safely call the high-level methods without the penalty of redundant instrument I/O. Tip: This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. @@ -6177,9 +6146,9 @@ def _set_attribute_vi_int64(self, attribute, value): value (int): Pass the value to which you want to set the property. -
- Some values may not be valid. The allowed values depend on the current settings of the instrument session. -
+
+ Some values may not be valid. The allowed values depend on the current settings of the instrument session. +
''' self._interpreter.set_attribute_vi_int64(self._repeated_capability, attribute, value) @@ -6190,14 +6159,14 @@ def _set_attribute_vi_real64(self, attribute, value): Sets the value of a ViReal64 property. - Use this low-level method to set the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: + Use this low-level method to set the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: - - State caching is disabled for the entire session or for the particular property. - - State caching is enabled, and the currently cached value is invalid or is different than the value you specify. + - State caching is disabled for the entire session or for the particular property. + - State caching is enabled, and the currently cached value is invalid or is different than the value you specify. - NI-RFSG contains high-level methods that set most of the instrument properties. Use the high-level driver methods as much as possible, as they handle order dependencies and multithread locking. The high-level methods also perform status checking only after setting all of the properties. In contrast, when you set multiple properties using the SetAttribute methods, the methods check the instrument status after each call. + NI-RFSG contains high-level methods that set most of the instrument properties. Use the high-level driver methods as much as possible, as they handle order dependencies and multithread locking. The high-level methods also perform status checking only after setting all of the properties. In contrast, when you set multiple properties using the SetAttribute methods, the methods check the instrument status after each call. - Also, when state caching is enabled, the high-level methods that configure multiple properties perform instrument I/O only for the properties whose value you change. Thus, you can safely call the high-level methods without the penalty of redundant instrument I/O. + Also, when state caching is enabled, the high-level methods that configure multiple properties perform instrument I/O only for the properties whose value you change. Thus, you can safely call the high-level methods without the penalty of redundant instrument I/O. Tip: This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. @@ -6226,14 +6195,14 @@ def _set_attribute_vi_session(self, attribute): Sets the value of a ViSession property. - Use this low-level method to set the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: + Use this low-level method to set the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: - - State caching is disabled for the entire session or for the particular property. - - State caching is enabled, and the currently cached value is invalid or is different than the value you specify. + - State caching is disabled for the entire session or for the particular property. + - State caching is enabled, and the currently cached value is invalid or is different than the value you specify. - NI-RFSG contains high-level methods that set most of the instrument properties. Use the high-level driver methods as much as possible, as they handle order dependencies and multithread locking. The high-level methods also perform status checking only after setting all of the properties. In contrast, when you set multiple properties using the SetAttribute methods, the methods check the instrument status after each call. + NI-RFSG contains high-level methods that set most of the instrument properties. Use the high-level driver methods as much as possible, as they handle order dependencies and multithread locking. The high-level methods also perform status checking only after setting all of the properties. In contrast, when you set multiple properties using the SetAttribute methods, the methods check the instrument status after each call. - Also, when state caching is enabled, the high-level methods that configure multiple properties perform instrument I/O only for the properties whose value you change. Thus, you can safely call the high-level methods without the penalty of redundant instrument I/O. + Also, when state caching is enabled, the high-level methods that configure multiple properties perform instrument I/O only for the properties whose value you change. Thus, you can safely call the high-level methods without the penalty of redundant instrument I/O. Tip: This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. @@ -6258,14 +6227,14 @@ def _set_attribute_vi_string(self, attribute, value): Sets the value of a ViString property. - Use this low-level method to set the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: + Use this low-level method to set the values of inherent IVI properties, class-defined properties, and instrument-specific properties. If the property represents an instrument state, this method performs instrument I/O in the following cases: - - State caching is disabled for the entire session or for the particular property. - - State caching is enabled, and the currently cached value is invalid or is different than the value you specify. + - State caching is disabled for the entire session or for the particular property. + - State caching is enabled, and the currently cached value is invalid or is different than the value you specify. - NI-RFSG contains high-level methods that set most of the instrument properties. Use the high-level driver methods as much as possible, as they handle order dependencies and multithread locking. The high-level methods also perform status checking only after setting all of the properties. In contrast, when you set multiple properties using the SetAttribute methods, the methods check the instrument status after each call. + NI-RFSG contains high-level methods that set most of the instrument properties. Use the high-level driver methods as much as possible, as they handle order dependencies and multithread locking. The high-level methods also perform status checking only after setting all of the properties. In contrast, when you set multiple properties using the SetAttribute methods, the methods check the instrument status after each call. - Also, when state caching is enabled, the high-level methods that configure multiple properties perform instrument I/O only for the properties whose value you change. Thus, you can safely call the high-level methods without the penalty of redundant instrument I/O. + Also, when state caching is enabled, the high-level methods that configure multiple properties perform instrument I/O only for the properties whose value you change. Thus, you can safely call the high-level methods without the penalty of redundant instrument I/O. Tip: This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. @@ -6390,13 +6359,13 @@ def __init__(self, resource_name, options={}, id_query=False, reset_device=False Opens a session to the device you specify as the 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 OPTION_STRING input. + This method also configures the device through 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/5860 + **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** + **Related Topics** - `Simulating an NI RF Signal Generator `_ + `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. @@ -6406,9 +6375,9 @@ def __init__(self, resource_name, options={}, id_query=False, reset_device=False Args: 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. + 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. + 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. @@ -6442,7 +6411,7 @@ def __init__(self, resource_name, options={}, id_query=False, reset_device=False id_query (bool): Specifies whether you want NI-RFSG to perform an ID query. - **Defined Values** : + **Defined Values** : +-----------+--------------------------+ | Value | Description | @@ -6454,7 +6423,7 @@ def __init__(self, resource_name, options={}, id_query=False, reset_device=False reset_device (bool): Specifies whether you want to reset the NI-RFSG device during the initialization procedure. - **Defined Values** : + **Defined Values** : +-----------+----------------------+ | Value | Description | @@ -6520,13 +6489,13 @@ def initiate(self): 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 abort method. + 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 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 + **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** + **Related Topics** - `NI-RFSG Instrument Driver Programming Flow `_ + `NI-RFSG Instrument Driver Programming Flow `_ Note: This method will return a Python context manager that will initiate on entering and abort on exit. @@ -6538,13 +6507,13 @@ def close(self): 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 + **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** + **Related Topics** - `NI-RFSG Instrument Driver Programming Flow `_ + `NI-RFSG Instrument Driver Programming Flow `_ - `NI-RFSG Programming State Model `_ + `NI-RFSG Programming State Model `_ Note: This method is not needed when using the session context manager @@ -6564,11 +6533,11 @@ def abort(self): 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 + **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** + **Related Topics** - `NI-RFSG Programming State Model `_ + `NI-RFSG Programming State Model `_ ''' self._interpreter.abort() @@ -6578,15 +6547,15 @@ def allocate_arb_waveform(self, 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 WriteArbWaveform method multiple times to write a large waveform in smaller blocks. + Use this method to specify the total size of a waveform before writing the data. Use this method only if you are calling the 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. + 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 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Streaming Waveform Data `_ + `Streaming Waveform Data `_ Args: 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. @@ -6602,7 +6571,7 @@ def change_external_calibration_password(self, 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 + **Supported Devices:** PXIe-5611, PXIe-5653/5654, PXIe-5673/5673E, PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 Args: old_password (str): Specifies the old (current) external calibration password. This password is case sensitive. @@ -6618,20 +6587,20 @@ def check_generation_status(self): 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. + 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 + **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** + **Related Topics** - `NI-RFSG Instrument Driver Programming Flow `_ + `NI-RFSG Instrument Driver Programming Flow `_ - `Stopping Pear-to-Peer Generation `_ + `Stopping Pear-to-Peer Generation `_ Returns: is_done (bool): Returns information about the completion of signal generation. - **Defined Values** : + **Defined Values** : +-------+---------------------------------+ | Value | Description | @@ -6651,7 +6620,7 @@ def check_if_script_exists(self, script_name): Returns whether the script that you specify as SCRIPT_NAME exists. - **Supported Devices** : PXIe-5673/5673E. PXIe-5830/5831/5840/5841/5842/5860 + **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. @@ -6663,7 +6632,7 @@ def check_if_script_exists(self, script_name): Returns: script_exists (bool): Returns True if the script exists. - **Defined Values** : + **Defined Values** : +-------+----------------------------+ | Value | Description | @@ -6683,7 +6652,7 @@ def check_if_waveform_exists(self, waveform_name): Returns whether the waveform that you specify as WAVEFORM_NAME exists. - **Supported Devices** : PXIe-5673/5673E, PXIe-5830/5831/5840/5841/5842/5860 + **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. @@ -6695,7 +6664,7 @@ def check_if_waveform_exists(self, waveform_name): Returns: waveform_exists (bool): Returns True if the waveform exists. - **Defined Values** : + **Defined Values** : +-------+------------------------------+ | Value | Description | @@ -6715,9 +6684,9 @@ def clear_all_arb_waveforms(self): Deletes all currently defined waveforms and scripts. - The NI-RFSG device must be in the Configuration state before you call this method. + 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 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 ''' self._interpreter.clear_all_arb_waveforms() @@ -6727,9 +6696,9 @@ def clear_arb_waveform(self, 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. + 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 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 Args: name (str): Name of the stored waveform to delete. @@ -6743,11 +6712,11 @@ def clear_error(self): Clears the error information associated with the session. - If you pass VI_NULL for the VI parameter, this method clears the error information for the current execution thread. + If you pass VI_NULL for the VI parameter, this method clears the error information for the current execution thread. - The IVI Engine also maintains this error information separately for each thread. This feature of the IVI Engine is useful if you do not have a session handle to pass to the clear_error method or the get_error method, which occurs when a call to the Init method or the __init__ method fails. + The IVI Engine also maintains this error information separately for each thread. This feature of the IVI Engine is useful if you do not have a session handle to pass to the clear_error method or the get_error method, which occurs when a call to the Init method or the __init__ method fails. - **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 + **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: The get_error method clears the error information after it is retrieved. A call to the clear_error method is necessary only when you do not use a call to the get_error method to retrieve error information. @@ -6762,7 +6731,7 @@ def clear_self_calibrate_range(self): Clears the data obtained from the self_calibrate_range method. - **Supported Devices** : PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices** : PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842 ''' self._interpreter.clear_self_calibrate_range() @@ -6772,13 +6741,13 @@ def commit(self): 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. + 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 + **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** + **Related Topics** - `NI-RFSG Programming State Model `_ + `NI-RFSG Programming State Model `_ ''' self._interpreter.commit() @@ -6788,9 +6757,9 @@ def configure_deembedding_table_interpolation_linear(self, port, table_name, for 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. + 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 + **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860 Args: port (str): Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842/5860 is "" (empty string). @@ -6820,9 +6789,9 @@ def configure_deembedding_table_interpolation_nearest(self, port, table_name): Selects the nearest interpolation method. - NI-RFSG uses the parameters of the table nearest to the carrier frequency for de-embedding. + 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 + **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860 Args: port (str): Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842/5860 is "" (empty string). @@ -6838,9 +6807,9 @@ def configure_deembedding_table_interpolation_spline(self, 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. + 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 + **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860 Args: port (str): Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842/5860 is "" (empty string). @@ -6854,19 +6823,17 @@ def configure_deembedding_table_interpolation_spline(self, port, table_name): def configure_digital_edge_script_trigger(self, trigger_id, source, edge): r'''configure_digital_edge_script_trigger - Purpose - - Configures the specified Script Trigger for digital edge triggering. + Configures the specified Script Trigger for digital edge triggering. - The NI-RFSG device must be in the Configuration state before calling this method. + 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 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Script Trigger `_ + `Script Trigger `_ - `Digital Edge Trigger `_ + `Digital Edge Trigger `_ Args: trigger_id (str): Specifies the Script Trigger to configure. @@ -6884,15 +6851,15 @@ def configure_digital_edge_start_trigger(self, source, edge): Configures the Start Trigger for digital edge triggering. - The NI-RFSG device must be in the Configuration state before calling this method. + 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 + **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** + **Related Topics** - `Start Trigger `_ + `Start Trigger `_ - `Digital Edge 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. @@ -6910,15 +6877,15 @@ def configure_digital_level_script_trigger(self, trigger_id, 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. + 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 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Script Trigger `_ + `Script Trigger `_ - `Digital Level Trigger `_ + `Digital Level Trigger `_ Args: trigger_id (str): Specifies the Script Trigger to configure. @@ -6936,7 +6903,7 @@ def configure_digital_modulation_user_defined_waveform(self, number_of_samples, Specifies the message signal used for digital modulation when the digital_modulation_waveform_type property is set to NIRFSG_VAL_USER_DEFINED. - **Supported Devices** : PXI/PXIe-5650/5651/5652 + **Supported Devices** : PXI/PXIe-5650/5651/5652 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. @@ -6955,15 +6922,15 @@ def configure_generation_mode(self, generation_mode): Configures the NI-RFSG device to generate a continuous sine tone (CW), apply I/Q (vector) modulation to the RF output signal, or generate arbitrary waveforms according to scripts. - The NI-RFSG device must be in the Configuration state before you call this method. + The NI-RFSG device must be in the Configuration state before you call this method. - **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 + **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** + **Related Topics** - `Assigning Properties or Properties to a Waveform `_ + `Assigning Properties or Properties to a Waveform `_ - `Scripting Instructions `_--Refer to this topic for more information about VST restrictions on scripts. + `Scripting Instructions `_--Refer to this topic for more information about VST restrictions on scripts. Args: generation_mode (enums.GenerationMode): Specifies the mode used by NI-RFSG for generating an RF output signal. @@ -6997,17 +6964,17 @@ def configure_output_enabled(self, 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. + 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/5860 + **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** + **Related Topics** - `Output Enabled `_ + `Output Enabled `_ - `NI-RFSG Instrument Driver Programming Flow `_ + `NI-RFSG Instrument Driver Programming Flow `_ - `RF List Mode `_ + `RF List Mode `_ Args: output_enabled (bool): Specifies whether you want to enable or disable the output. @@ -7021,13 +6988,13 @@ def configure_p2p_endpoint_fullness_start_trigger(self, p2p_endpoint_fullness_le Configures the Start Trigger to detect peer-to-peer endpoint fullness. - Generation begins when the number of samples in the peer-to-peer endpoint reaches the threshold specified by the P2P_ENDPOINT_FULLNESS_LEVEL parameter. The NI-RFSG device must be in the Configuration state before calling this method. + Generation begins when the number of samples in the peer-to-peer endpoint reaches the threshold specified by the P2P_ENDPOINT_FULLNESS_LEVEL parameter. The NI-RFSG device must be in the Configuration state before calling this method. - **Supported Devices** : PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices** : PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Start Trigger `_ + `Start Trigger `_ Note: Due to an additional internal FIFO in the RF signal generator, the writer peer actually writes 2,304 bytes more than the quantity of data specified by this method to satisfy the trigger level. @@ -7046,15 +7013,15 @@ def configure_power_level_type(self, power_level_type): Specifies the way the driver interprets the power_level property. - In average power mode, NI-RFSG automatically scales waveform data to use the maximum dynamic range. In peak power mode, waveforms are scaled according to the arb_waveform_software_scaling_factor property. + In average power mode, NI-RFSG automatically scales waveform data to use the maximum dynamic range. In peak power mode, waveforms are scaled according to the arb_waveform_software_scaling_factor property. - **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Spurious Performance `_ + `Spurious Performance `_ - `Optimizing for Low Power Generation `_ + `Optimizing for Low Power Generation `_ Args: power_level_type (int): Specifies the way the driver interprets the value of the power_level property. NI-RFSG sets the power_level_type property to this value. @@ -7076,15 +7043,15 @@ def configure_pxi_chassis_clk10(self, pxi_clk10_source): Specifies the signal to drive the 10MHz Reference Clock on the PXI backplane. - This option can only be configured when the PXI-5610 is in Slot 2 of the PXI chassis. The NI-RFSG device must be in the Configuration state before you call this method. + This option can only be configured when the PXI-5610 is in Slot 2 of the PXI chassis. The NI-RFSG device must be in the Configuration state before you call this method. - **Supported Devices** : PXI-5610, PXI-5670/5671 + **Supported Devices** : PXI-5610, PXI-5670/5671 - **Related Topics** + **Related Topics** - `Timing Configurations `_ + `Timing Configurations `_ - `System Reference Clock `_ + `System Reference Clock `_ Args: pxi_clk10_source (str): Specifies the source of the Reference Clock signal. @@ -7098,22 +7065,22 @@ def configure_rf(self, 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. + 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 + **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** + **Related Topics** - `NI-RFSG Instrument Driver Programming Flow `_ + `NI-RFSG Instrument Driver Programming Flow `_ Args: 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) + **Units** : hertz (Hz) power_level (float): Specifies either the average power level or peak power level of the generated RF signal, depending on the power_level_type property. - **Units** : dBm + **Units** : dBm ''' self._interpreter.configure_rf(frequency, power_level) @@ -7124,45 +7091,42 @@ def configure_ref_clock(self, 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. + 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 + **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** + **Related Topics** - `PXIe-5672 Timing Configurations `_ + `PXIe-5672 Timing Configurations `_ - `PXIe-5673 Timing Configurations `_ + `PXIe-5673 Timing Configurations `_ - `PXIe-5673E Timing Configurations `_ + `PXIe-5673E Timing Configurations `_ - `PXIe-5830 Timing Configurations `_ + `PXIe-5830 Timing Configurations `_ - `PXIe-5831 Timing Configurations `_ + `PXIe-5831 Timing Configurations `_ Args: ref_clock_source (str): Specifies the source of Reference Clock signal. - +----------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Reference Clock Constant | Value | Description | - +========================================+===============+=================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | NIRFSG_VAL_ONBOARD_CLOCK_STR (default) | 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. | - +----------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | NIRFSG_VAL_REF_IN_STR | 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. | - +----------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | NIRFSG_VAL_PXI_CLK_STR | PXI_CLK | Uses the PXI_CLK signal, which is present on the PXI backplane, as the clock source. | - +----------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | NIRFSG_VAL_CLK_IN_STR | 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. | - +----------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | NIRFSG_VAL_REF_IN_2_STR | RefIn2 | \- | - +----------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | NIRFSG_VAL_PXI_CLK_MASTER_STR | 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. | - +----------------------------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - 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. - - 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 ref_clock_source parameter is set to NIRFSG_VAL_CLK_IN_STR, NIRFSG_VAL_REF_IN_STR or NIRFSG_VAL_REF_IN_2_STR. Refer to the ref_clock_rate property for possible values. + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 ref_clock_source parameter is set to ClkIn, RefIn or RefIn2. Refer to the 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. @@ -7176,11 +7140,11 @@ def configure_signal_bandwidth(self, signal_bandwidth): Configures the signal bandwidth of the arbitrary waveform. - The NI-RFSG device must be in the Configuration state before you call this method. + The NI-RFSG device must be in the Configuration state before you call this method. - NI-RFSG defines *signal bandwidth* as twice the maximum baseband signal deviation from 0 Hz. Usually, the baseband signal center frequency is 0Hz. In such cases, the signal bandwidth is simply the baseband signal minimum frequency subtracted from its maximum frequency, or *f* max minus *f* min. NI-RFSG uses this value to optimally configure the center frequency of the upconverter to help minimize phase noise. The generated signal is not filtered to achieve the set bandwidth. However, specifying a bandwidth smaller than the actual bandwidth of the signal could potentially result in spectral distortion. + NI-RFSG defines *signal bandwidth* as twice the maximum baseband signal deviation from 0 Hz. Usually, the baseband signal center frequency is 0Hz. In such cases, the signal bandwidth is simply the baseband signal minimum frequency subtracted from its maximum frequency, or *f* max minus *f* min. NI-RFSG uses this value to optimally configure the center frequency of the upconverter to help minimize phase noise. The generated signal is not filtered to achieve the set bandwidth. However, specifying a bandwidth smaller than the actual bandwidth of the signal could potentially result in spectral distortion. - **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 Note: Based on your signal bandwidth, NI-RFSG decides whether to configure the upconverter center frequency on the PXI-5670/5671 or PXIe-5672 in increments of 1MHz or 5MHz. Failure to configure signal bandwidth may result in the signal being placed outside the upconverter passband. @@ -7196,15 +7160,15 @@ def configure_software_script_trigger(self, trigger_id): Configures the Script Trigger for software triggering. - Refer to the 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. + Refer to the 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 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Script Trigger `_ + `Script Trigger `_ - `Trigger Types `_ + `Trigger Types `_ Args: trigger_id (str): Specifies the Script Trigger to configure. @@ -7218,17 +7182,15 @@ def configure_software_start_trigger(self): Configures the Start Trigger for software triggering. - Refer to the 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 - + Refer to the 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** + **Related Topics** - `Start Trigger `_ + `Start Trigger `_ - `Trigger Types `_ + `Trigger Types `_ ''' self._interpreter.configure_software_start_trigger() @@ -7238,15 +7200,15 @@ def create_deembedding_sparameter_table_s2p_file(self, port, table_name, s2p_fil 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. + 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 + **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `De-embedding Overview `_ + `De-embedding Overview `_ - `S-parameters `_ + `S-parameters `_ Args: port (str): Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842 is empty string. @@ -7276,7 +7238,7 @@ def delete_all_deembedding_tables(self): Deletes all configured de-embedding tables for the session. - **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860 + **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860 ''' self._interpreter.delete_all_deembedding_tables() @@ -7286,7 +7248,7 @@ def delete_deembedding_table(self, port, table_name): Deletes the selected de-embedding table for a given port. - **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860 + **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860 Args: port (str): Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842/5860 is "" (empty string). @@ -7302,7 +7264,7 @@ def disable(self): Places the instrument in a quiescent state where it has minimal or no impact on the system to which it is connected. - **Supported Devices** : PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXI-5670/5671, PXIe-5672/5673/5673E + **Supported Devices** : PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXI-5670/5671, PXIe-5672/5673/5673E ''' self._interpreter.disable() @@ -7312,13 +7274,13 @@ def disable_script_trigger(self, trigger_id): 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. + 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 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Script Trigger `_ + `Script Trigger `_ Args: trigger_id (str): Specifies the Script trigger to configure. @@ -7332,13 +7294,13 @@ def disable_start_trigger(self): 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. + 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 + **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** + **Related Topics** - `Start Trigger `_ + `Start Trigger `_ ''' self._interpreter.disable_start_trigger() @@ -7367,24 +7329,26 @@ def export_signal(self, signal, signal_identifier, output_terminal): Routes signals (triggers, clocks, and events) to a specified output terminal. - The NI-RFSG device must be in the Configuration state before you call this method. + The NI-RFSG device must be in the Configuration state before you call this method. - You can clear a previously routed signal by exporting the signal to "" (empty string). + You can clear a previously routed signal by exporting the signal to "" (empty string). - **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 + **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** + **Related Topics** - `Triggers `_ + `Triggers `_ - `Events `_ + `Events `_ - `PFI Lines `_ + `PFI Lines `_ - `PXI Trigger Lines `_ + `PXI Trigger Lines `_ Args: - signal (enums.Signal): Specifies the type of signal to route. **Defined Values** : + signal (enums.Signal): Specifies the type of signal to route. + + **Defined Values** : +----------------------------------------+---------+--------------------------------------------+ | Name | Value | Description | @@ -7409,27 +7373,29 @@ def export_signal(self, signal, signal_identifier, output_terminal): 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 export. This parameter is useful when you set the SIGNAL parameter to NIRFSG_VAL_SCRIPT_TRIGGER or NIRFSG_VAL_MARKER_EVENT. Otherwise, set the 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. | - +----------------+-----------------------------+ + signal_identifier (str): Specifies which instance of the selected signal to export. This parameter is useful when you set the SIGNAL parameter to NIRFSG_VAL_SCRIPT_TRIGGER or Signal.MARKER_EVENT. Otherwise, set the SIGNAL_IDENTIFIER parameter to "". + + **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. @@ -7437,18 +7403,20 @@ def export_signal(self, signal, signal_identifier, output_terminal): 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. - output_terminal (str): Specifies the terminal where the signal is exported. You can choose not to export any signal. For the PXIe-5841 with PXIe-5655, the signal is exported to the terminal on the PXIe-5841. **Possible Values** : + output_terminal (str): Specifies the terminal where the signal is exported. You can choose not to export any signal. For the PXIe-5841 with PXIe-5655, the signal is exported to the terminal on the PXIe-5841. + + **Possible Values** : +----------------+--------------------------------------------------------------------------------------------+ | Possible Value | Description | +================+============================================================================================+ - | ClkOut | Exports the Reference Clock signal to the CLK OUT connector of the device. | + | "ClkOut" | Exports the Reference Clock signal to the CLK OUT connector of the device. | +----------------+--------------------------------------------------------------------------------------------+ - | | The Reference Clock signal is not exported. | + | "" | The Reference Clock signal is not exported. | +----------------+--------------------------------------------------------------------------------------------+ - | RefOut | Exports the Reference Clock signal to the REF OUT connector of the device. | + | "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. | + | "RefOut2" | Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable. | +----------------+--------------------------------------------------------------------------------------------+ ''' @@ -7462,14 +7430,14 @@ def get_all_named_waveform_names(self): Return names of the waveforms present in the memory. - **Supported Devices** :PXIe-5830/5831/5840/5841/5842E + **Supported Devices** :PXIe-5830/5831/5840/5841/5842E Returns: waveform_names (str): Returns a string having waveform names separated by commas. actual_buffer_size (int): Fetch the number of bytes needed to pass in the BUFFER_SIZE parameter. - It can be fetch by passing VI_NULL in the WAVEFORM_NAMES parameter. + It can be fetch by passing VI_NULL in the WAVEFORM_NAMES parameter. Note: One or more of the referenced properties are not in the Python API for this driver. @@ -7484,14 +7452,14 @@ def get_all_script_names(self): Return names of the scripts present in the memory. - **Supported Devices** :PXIe-5830/5831/5840/5841/5842E + **Supported Devices** :PXIe-5830/5831/5840/5841/5842E Returns: script_names (str): Returns a string having script names separated by commas. actual_buffer_size (int): Fetch the number of bytes needed to pass in the BUFFER_SIZE parameter. - It can be fetch by passing VI_NULL in the SCRIPT_NAMES parameter. + It can be fetch by passing VI_NULL in the SCRIPT_NAMES parameter. Note: One or more of the referenced properties are not in the Python API for this driver. @@ -7506,7 +7474,7 @@ def get_channel_name(self, index): Returns the channel string that is in the channel table at an index you specify. - **Supported Devices** : PXI-5670/5671, PXIe-5672/5673/5673E + **Supported Devices** : PXI-5670/5671, PXIe-5672/5673/5673E Args: index (int): Specifies a one-based index into the channel table. @@ -7525,13 +7493,13 @@ def _get_external_calibration_last_date_and_time(self): 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 + 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 + 14 for the hours parameter and - 30 for the minutes parameter. + 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 + **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 Returns: year (int): Returns the year of the last successful calibration. @@ -7582,7 +7550,7 @@ def get_max_settable_power(self): Returns the maximum settable output power level for the current configuration. - **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860 + **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860 Returns: value (float): Returns maximum settable power level in dBm. @@ -7597,13 +7565,13 @@ def _get_self_calibration_date_and_time(self, 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 + 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 + 14 for the hours parameter and - 30 for the minutes parameter. + 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 + **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 Args: module (int): Specifies from which stand-alone module to retrieve the last successful self-calibration date and time. @@ -7632,7 +7600,7 @@ def get_self_calibration_temperature(self, 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 + **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 Args: module (enums.Module): Specifies from which stand-alone module to retrieve the last successful self-calibration temperature. @@ -7665,13 +7633,13 @@ def get_stream_endpoint_handle(self, stream_endpoint): Returns a reader endpoint handle that can be used with NI-P2P to configure a peer-to-peer stream with an RF signal generator endpoint. - **Supported Devices** : PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 + **Supported Devices** : PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842 - **Related Topics** + **Related Topics** - `Configuring a Peer-to-Peer Stream `_ + `Configuring a Peer-to-Peer Stream `_ - `Configuring Flow Control `_ + `Configuring Flow Control `_ Args: stream_endpoint (str): Specifies the stream endpoint FIFO to configure. @@ -7690,17 +7658,17 @@ def get_terminal_name(self, 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. + 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 + **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** + **Related Topics** - `Triggers `_ + `Triggers `_ - `Events `_ + `Events `_ - `Syntax for Terminal Names `_ + `Syntax for Terminal Names `_ Args: signal (enums.Signal): Specifies the signal to query. **Defined Values** : @@ -7728,27 +7696,27 @@ def get_terminal_name(self, signal, signal_identifier): 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 SIGNAL parameter to NIRFSG_VAL_SCRIPT_TRIGGER or NIRFSG_VAL_MARKER_EVENT . Otherwise, set the 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. | - +----------------+-----------------------------+ + signal_identifier (str): Specifies which instance of the selected signal to query. This parameter is necessary when you set the SIGNAL parameter to NIRFSG_VAL_SCRIPT_TRIGGER or Signal.MARKER_EVENT . Otherwise, set the 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. @@ -7771,13 +7739,13 @@ def _init_with_options(self, resource_name, option_string, id_query=False, reset Opens a session to the device you specify as the 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 OPTION_STRING input. + This method also configures the device through 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/5860 + **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** + **Related Topics** - `Simulating an NI RF Signal Generator `_ + `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. @@ -7787,23 +7755,23 @@ def _init_with_options(self, resource_name, option_string, id_query=False, reset Args: 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. + 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. + 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. option_string (str): Specifies the initial value of certain properties for the session. The following table lists the properties and the name you pass in this parameter to identify the property. - The format of this string consists of the following relations: - "AttributeName=Value" + The format of this string consists of the following relations: + "AttributeName=Value" - where - *AttributeName* is the name of the property and *Value* is the value to which the property is set. To set multiple properties, separate their assignments with a comma, as shown in the following option string: + where + *AttributeName* is the name of the property and *Value* is the value to which the property is set. To set multiple properties, separate their assignments with a comma, as shown in the following option string: - "RangeCheck=1,QueryInstrStatus=0,Cache=1,DriverSetup=AWG:pxi1slot4" + "RangeCheck=1,QueryInstrStatus=0,Cache=1,DriverSetup=AWG:pxi1slot4" - The `DriverSetup string `_ is required in order to simulate a specific device. + The `DriverSetup string `_ is required in order to simulate a specific device. +------------------+-------------------------+ | Name | Property Name | @@ -7821,7 +7789,7 @@ def _init_with_options(self, resource_name, option_string, id_query=False, reset id_query (bool): Specifies whether you want NI-RFSG to perform an ID query. - **Defined Values** : + **Defined Values** : +-----------+--------------------------+ | Value | Description | @@ -7833,7 +7801,7 @@ def _init_with_options(self, resource_name, option_string, id_query=False, reset reset_device (bool): Specifies whether you want to reset the NI-RFSG device during the initialization procedure. - **Defined Values** : + **Defined Values** : +-----------+----------------------+ | Value | Description | @@ -7857,13 +7825,13 @@ def _initiate(self): 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 abort method. + 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 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 + **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** + **Related Topics** - `NI-RFSG Instrument Driver Programming Flow `_ + `NI-RFSG Instrument Driver Programming Flow `_ ''' self._interpreter.initiate() @@ -7873,13 +7841,13 @@ def perform_power_search(self): Performs a power search if the alc_control property is disabled. - Calling this method disables modulation for a short time while the device levels the output signal. + Calling this method disables modulation for a short time while the device levels the output signal. - **Supported Devices** : PXIe-5654 with PXIe-5696 + **Supported Devices** : PXIe-5654 with PXIe-5696 - **Related Topics** + **Related Topics** - `Power Search `_ + `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. ''' @@ -7891,17 +7859,17 @@ def perform_thermal_correction(self): 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. + 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. + 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 + **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** + **Related Topics** - `Thermal Management `_ + `Thermal Management `_ - `Impairment Calibration `_ + `Impairment Calibration `_ ''' self._interpreter.perform_thermal_correction() @@ -7911,9 +7879,9 @@ def query_arb_waveform_capabilities(self): 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. + 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 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 Returns: max_number_waveforms (int): Returns the value of the arb_max_number_waveforms property. This value is the maximum number of waveforms you can write. @@ -7934,29 +7902,29 @@ def read_and_download_waveform_from_file_tdms(self, waveform_name, file_path, wa 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: + 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 + - 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. + 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 + **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842 Args: waveform_name (str): Specifies the name used to store the waveform. This string is case-insensitive. - Example: + Example: - "waveform::waveform0" + "waveform::waveform0" file_path (str): Specifies the absolute path to the TDMS file from which the NI-RFSG reads the waveforms. @@ -7971,13 +7939,13 @@ def reset(self): 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. + 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 reset_device method is acceptable. The reset method executes faster than the reset_device method. + Generally, calling this method instead of the reset_device method is acceptable. The reset method executes faster than the 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 ResetWithOptions method, with **stepsToOmit** set to ResetWithOptionsStepsToOmit.ROUTES . + 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 ResetWithOptions method, with **stepsToOmit** set to ResetWithOptionsStepsToOmit.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 + **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. ''' @@ -7989,22 +7957,22 @@ def reset_device(self): 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. + - 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. + 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. + - 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 + **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** + **Related Topics** - `Thermal Shutdown `_ + `Thermal Shutdown `_ Note: You must call the reset_device method if the NI-RFSG device has shut down because of a high-temperature condition. ''' @@ -8016,7 +7984,7 @@ def reset_with_defaults(self): 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 + **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 ''' self._interpreter.reset_with_defaults() @@ -8026,16 +7994,16 @@ def revision_query(self): 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/5860 + **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 Returns: instrument_driver_revision (str): Returns the value of the specific_driver_revision property in the form of a string. - You must pass a ViChar array with at least 256 bytes. + You must pass a ViChar array with at least 256 bytes. firmware_revision (str): Returns the value of the instrument_firmware_revision property in the form of a string. - You must pass a ViChar array with at least 256 bytes. + You must pass a ViChar array with at least 256 bytes. ''' instrument_driver_revision, firmware_revision = self._interpreter.revision_query() @@ -8047,13 +8015,13 @@ def select_arb_waveform(self, name): Specifies the waveform that is generated upon a call to the _initiate method when the **generationMode** parameter of the configure_generation_mode method is set to GenerationMode.ARB_WAVEFORM. - You must specify a waveform using the NAME parameter if you have written multiple waveforms. The NI-RFSG device must be in the Configuration state before you call this method. + You must specify a waveform using the 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 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Assigning Properties or Properties to a Waveform `_ + `Assigning Properties or Properties to a Waveform `_ Note: One or more of the referenced properties are not in the Python API for this driver. @@ -8070,11 +8038,11 @@ def self_cal(self): 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. + 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. + 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 + **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. ''' @@ -8086,13 +8054,13 @@ def self_calibrate_range(self, steps_to_omit, min_frequency, max_frequency, min_ 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 clear_self_calibrate_range method. + Self-calibration range data is valid until you restart the system or call the clear_self_calibrate_range method. - NI recommends that no external signals are present on the RF In or IQ In ports during the calibration. + 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. + 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 + **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. @@ -8103,9 +8071,9 @@ def self_calibrate_range(self, steps_to_omit, min_frequency, max_frequency, min_ Args: steps_to_omit (enums.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** : SelfCalibrateRangeStepsToOmit.OMIT_NONE + **Default Value** : SelfCalibrateRangeStepsToOmit.OMIT_NONE - **Defined Values:** + **Defined Values:** +-----------------------------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------+ | Name | Value | Description | @@ -8123,9 +8091,6 @@ def self_calibrate_range(self, steps_to_omit, min_frequency, max_frequency, min_ | SelfCalibrateRangeStepsToOmit.SYNTHESIZER_ALIGNMENT | 16 (0x10) | Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted. | +-----------------------------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------+ - 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. - min_frequency (float): Specifies the minimum frequency to calibrate. max_frequency (float): Specifies the maximum frequency to calibrate. @@ -8145,20 +8110,20 @@ def self_test(self, self_test_message): 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 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. + 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 + **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** + **Related Topics** - `Device Warm-Up `_ + `Device Warm-Up `_ Args: self_test_message (str): Returns the self-test response string from the NI-RFSG device. For an explanation of the string contents, refer to the **status** parameter of this method. - You must pass a ViChar array with at least 256 bytes. + You must pass a ViChar array with at least 256 bytes. Returns: @@ -8182,9 +8147,9 @@ def set_arb_waveform_next_write_position(self, waveform_name, relative_to, offse Configures the start position to use for writing a waveform before calling the 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 allocate_arb_waveform method or the WriteArbWaveform method. Subsequent writes to that waveform begin where the last write ended, unless this method is called again. + 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 allocate_arb_waveform method or the 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 + **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. @@ -8193,7 +8158,7 @@ def set_arb_waveform_next_write_position(self, waveform_name, relative_to, offse relative_to (enums.RelativeTo): Specifies the reference position in the waveform. The position and OFFSET together determine where to start loading data into the waveform. - **Defined Values:** + **Defined Values:** +------------------------------+---------------+------------------------------------------------------------------+ | Name | Value | Description | @@ -8219,16 +8184,16 @@ def wait_until_settled(self, max_time_milliseconds): 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. + 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 commit method to wait for changes to settle. The wait_until_settled method is not required after calling the _initiate method because the _initiate automatically waits for the output to settle. + You can also call this method after calling the commit method to wait for changes to settle. The wait_until_settled method is not required after calling the _initiate method because the _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 + **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 Args: max_time_milliseconds (int): 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 + **Default Value** : 10000 ''' self._interpreter.wait_until_settled(max_time_milliseconds) @@ -8239,19 +8204,19 @@ def write_p2p_endpoint_i16(self, stream_endpoint, number_of_samples, endpoint_da Writes an array of 16-bit integer data to the peer-to-peer endpoint. - Use this method to write initial data from the host to the endpoint before starting generation to avoid an underflow when you start the generation. + Use this method to write initial data from the host to the endpoint before starting generation to avoid an underflow when you start the generation. - **Supported Devices** : PXIe-5673E + **Supported Devices** : PXIe-5673E - **Related Topics** + **Related Topics** - `Peer-to-Peer Data Streaming `_--Refer to this topic for more information about configuring a stream. + `Peer-to-Peer Data Streaming `_--Refer to this topic for more information about configuring a stream. - `Configuring Flow Control `_ + `Configuring Flow Control `_ - `Starting Peer-to-Peer Generation `_ + `Starting Peer-to-Peer Generation `_ - `Reconfiguring a Stream `_ + `Reconfiguring a Stream `_ Args: stream_endpoint (str): Specifies the stream endpoint FIFO to configure. @@ -8269,15 +8234,15 @@ def write_script(self, script): Writes a script to the device to control waveform generation in Script mode. - First, configure your device for Script mode by calling the configure_generation_mode method. The NI-RFSG device must be in the Configuration state before calling the write_script method. + First, configure your device for Script mode by calling the configure_generation_mode method. The NI-RFSG device must be in the Configuration state before calling the 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 + **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **Related Topics** + **Related Topics** - `Scripting Instructions `_--Refer to this topic for more information about VST restrictions on scripts. + `Scripting Instructions `_--Refer to this topic for more information about VST restrictions on scripts. - `Common Scripting Use Cases `_ + `Common Scripting Use Cases `_ Note: If you are using an RF vector signal transceiver (VST) device, some script instructions may not be supported. @@ -8292,12 +8257,12 @@ def _close(self): 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 + **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** + **Related Topics** - `NI-RFSG Instrument Driver Programming Flow `_ + `NI-RFSG Instrument Driver Programming Flow `_ - `NI-RFSG Programming State Model `_ + `NI-RFSG Programming State Model `_ ''' self._interpreter.close() diff --git a/src/nirfsg/metadata/attributes.py b/src/nirfsg/metadata/attributes.py index d75d2dceb..8446ece40 100644 --- a/src/nirfsg/metadata/attributes.py +++ b/src/nirfsg/metadata/attributes.py @@ -5,7 +5,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies whether to validate attribute values and function parameters. Range checking parameters is very useful for debugging. After you validate your program, set this attribute to VI_FALSE to disable range checking and maximize performance. NI-RFSG can choose to ignore range checking for particular attributes, regardless of the setting of this attribute. Use the nirfsg_InitWithOptions function to override the default value.\n\n **Default Value:** VI_TRUE\n\n **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\n \n **Defined Values**:\n ', + 'description': 'Specifies whether to validate attribute values and function parameters. Range checking parameters is very useful for debugging. After you validate your program, set this attribute to VI_FALSE to disable range checking and maximize performance. NI-RFSG can choose to ignore range checking for particular attributes, regardless of the setting of this attribute. Use the nirfsg_InitWithOptions function to override the default value.\n\n**Default Value:** VI_TRUE\n\n**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\n\n**Defined Values**:', 'table_body': [ [ 'VI_TRUE', @@ -29,7 +29,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies whether NI-RFSG queries the NI-RFSG device status after each operation. Querying the device status is useful for debugging. After you validate your program, set this attribute to VI_FALSE to disable status checking and maximize performance.\n\n NI-RFSG can choose to ignore status checking for particular attributes, regardless of the setting of this attribute. Use the nirfsg_InitWithOptions function to override the default value.\n\n **Default Value:** VI_FALSE\n\n **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\n \n **Defined Values**:\n ', + 'description': 'Specifies whether NI-RFSG queries the NI-RFSG device status after each operation. Querying the device status is useful for debugging. After you validate your program, set this attribute to VI_FALSE to disable status checking and maximize performance.\n\nNI-RFSG can choose to ignore status checking for particular attributes, regardless of the setting of this attribute. Use the nirfsg_InitWithOptions function to override the default value.\n\n**Default Value:** VI_FALSE\n\n**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\n\n**Defined Values**:', 'table_body': [ [ 'VI_TRUE', @@ -53,7 +53,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies whether to cache the value of attributes. When caching is enabled, NI-RFSG tracks the current NI-RFSG device settings and avoids sending redundant commands to the device. NI-RFSG can always cache or never cache particular attributes, regardless of the setting of this attribute. Call the nirfsg_InitWithOptions function to override the default value.\n\n **Default Value:** VI_TRUE\n\n **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\n\n **Defined Values**:\n ', + 'description': 'Specifies whether to cache the value of attributes. When caching is enabled, NI-RFSG tracks the current NI-RFSG device settings and avoids sending redundant commands to the device. NI-RFSG can always cache or never cache particular attributes, regardless of the setting of this attribute. Call the nirfsg_InitWithOptions function to override the default value.\n\n**Default Value:** VI_TRUE\n\n**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\n\n**Defined Values**:', 'table_body': [ [ 'VI_TRUE', @@ -77,7 +77,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns whether NI-RFSG simulates I/O operations. This attribute is useful for debugging applications without using hardware. After a session is opened, you cannot change the simulation state. Use the nirfsg_InitWithOptions function to enable simulation.\n\n **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\n \n **Defined Values**:\n ', + 'description': 'Returns whether NI-RFSG simulates I/O operations. This attribute is useful for debugging applications without using hardware. After a session is opened, you cannot change the simulation state. Use the nirfsg_InitWithOptions function to enable simulation.\n\n**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\n\n**Defined Values**:', 'table_body': [ [ 'VI_TRUE', @@ -101,7 +101,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies whether the IVI engine keeps a list of the value coercions it makes for integer and real type attributes.\n\n **Default Value:** VI_FALSE\n\n **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\n \n **Defined Values**:\n ', + 'description': 'Specifies whether the IVI engine keeps a list of the value coercions it makes for integer and real type attributes.\n\n**Default Value:** VI_FALSE\n\n**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\n\n**Defined Values**:', 'note': 'Enabling record value coercions is not supported.', 'table_body': [ [ @@ -126,7 +126,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies whether to perform interchangeability checking and retrieve interchangeability warnings.\n\n **Default Value:** VI_FALSE\n\n **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\n\n **Defined Values**:\n ', + 'description': 'Specifies whether to perform interchangeability checking and retrieve interchangeability warnings.\n\n**Default Value:** VI_FALSE\n\n**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\n\n**Defined Values**:', 'note': 'Enabling interchangeability check is not supported.', 'table_body': [ [ @@ -151,7 +151,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns a string that contains the prefix for NI-RFSG. The name of each user-callable function in NI-RFSG starts with this prefix. This attribute returns\n\n niRFSG.\n\n **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\n ' + 'description': 'Returns a string that contains the prefix for NI-RFSG. The name of each user-callable function in NI-RFSG starts with this prefix. This attribute returns\n\nniRFSG.\n\n**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' }, 'lv_property': 'Inherent IVI Attributes:Driver Identification:Driver Prefix', 'name': 'SPECIFIC_DRIVER_PREFIX', @@ -161,7 +161,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' 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 attribute contains the resource name that corresponds to the entry in the IVI Configuration Utility. If you initialize NI-RFSG with the resource name, this attribute contains that value.\n\n **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\n ' + 'description': '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 attribute contains the resource name that corresponds to the entry in the IVI Configuration Utility. If you initialize NI-RFSG with the resource name, this attribute contains that value.\n\n**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' }, 'lv_property': 'Inherent IVI Attributes:Advanced Session Information:Resource Descriptor', 'name': 'IO_RESOURCE_DESCRIPTOR', @@ -171,7 +171,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' 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_Init function or the nirfsg_InitWithOptions function. 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.\n\n **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\n ' + 'description': '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_Init function or the nirfsg_InitWithOptions function. 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.\n\n**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' }, 'lv_property': 'Inherent IVI Attributes:Advanced Session Information:Logical Name', 'name': 'LOGICAL_NAME', @@ -181,7 +181,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns a string that contains a model code of the NI-RFSG device. For drivers that support more than one device, this attribute contains a comma-separated list of supported devices.\n\n **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\n ' + 'description': 'Returns a string that contains a model code of the NI-RFSG device. For drivers that support more than one device, this attribute contains a comma-separated list of supported devices.\n\n**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' }, 'lv_property': 'Inherent IVI Attributes:Driver Capabilities:Supported Instrument Models', 'name': 'SUPPORTED_INSTRUMENT_MODELS', @@ -191,7 +191,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns a string that contains a comma-separated list of class-extension groups that NI-RFSG implements.\n\n **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\n ' + 'description': 'Returns a string that contains a comma-separated list of class-extension groups that NI-RFSG implements.\n\n**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' }, 'lv_property': 'Inherent IVI Attributes:Driver Capabilities:Class Group Capabilities', 'name': 'GROUP_CAPABILITIES', @@ -201,7 +201,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns a string that contains the firmware revision information for the NI-RFSG device you are currently using.\n\n **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\n \n **High-Level Functions**:\n\n - nirfsg_RevisionQuery' + 'description': 'Returns a string that contains the firmware revision information for the NI-RFSG device you are currently using.\n\n**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\n\n**High-Level Functions**:\n\n- nirfsg_RevisionQuery' }, 'lv_property': 'Inherent IVI Attributes:Instrument Identification:Firmware Revision', 'name': 'INSTRUMENT_FIRMWARE_REVISION', @@ -211,7 +211,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns a string that contains the name of the manufacturer of the NI-RFSG device you are currently using.\n\n **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\n ' + 'description': 'Returns a string that contains the name of the manufacturer of the NI-RFSG device you are currently using.\n\n**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' }, 'lv_property': 'Inherent IVI Attributes:Instrument Identification:Manufacturer', 'name': 'INSTRUMENT_MANUFACTURER', @@ -221,7 +221,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' 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 attribute returns a comma-separated list of supported devices.\n\n **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\n ' + 'description': '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 attribute returns a comma-separated list of supported devices.\n\n**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' }, 'lv_property': 'Inherent IVI Attributes:Instrument Identification:Model', 'name': 'INSTRUMENT_MODEL', @@ -231,7 +231,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns a string that contains the name of the vendor that supplies NI-RFSG. This attribute returns\n\n National Instruments.\n\n **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\n ' + 'description': 'Returns a string that contains the name of the vendor that supplies NI-RFSG. This attribute returns\n\nNational Instruments.\n\n**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' }, 'lv_property': 'Inherent IVI Attributes:Driver Identification:Driver Vendor', 'name': 'SPECIFIC_DRIVER_VENDOR', @@ -241,7 +241,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns a string that contains a brief description of NI-RFSG. This attribute returns\n\n National Instruments RF Signal Generator Instrument Driver.\n\n **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\n ' + 'description': 'Returns a string that contains a brief description of NI-RFSG. This attribute returns\n\nNational Instruments RF Signal Generator Instrument Driver.\n\n**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' }, 'lv_property': 'Inherent IVI Attributes:Driver Identification:Description', 'name': 'SPECIFIC_DRIVER_DESCRIPTION', @@ -251,7 +251,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the major version number of the class specification with which NI-RFSG is compliant.\n\n **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\n ' + 'description': 'Returns the major version number of the class specification with which NI-RFSG is compliant.\n\n**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' }, 'lv_property': 'Inherent IVI Attributes:Driver Identification:Class Specification Major Version', 'name': 'SPECIFIC_DRIVER_CLASS_SPEC_MAJOR_VERSION', @@ -261,7 +261,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the minor version number of the class specification with which NI-RFSG is compliant.\n\n **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\n ' + 'description': 'Returns the minor version number of the class specification with which NI-RFSG is compliant.\n\n**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' }, 'lv_property': 'Inherent IVI Attributes:Driver Identification:Class Specification Minor Version', 'name': 'SPECIFIC_DRIVER_CLASS_SPEC_MINOR_VERSION', @@ -271,7 +271,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns a string that contains additional version information about NI-RFSG. For example, NI-RFSG can return\n\n Driver: NI-RFSG14.5.0, Compiler: MSVC9.00, Components: IVI Engine4.00, VISA-Spec4.00 as the value of this attribute.\n\n **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\n ' + 'description': 'Returns a string that contains additional version information about NI-RFSG. For example, NI-RFSG can return\n\nDriver: NI-RFSG14.5.0, Compiler: MSVC9.00, Components: IVI Engine4.00, VISA-Spec4.00 as the value of this attribute.\n\n**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' }, 'lv_property': 'Inherent IVI Attributes:Driver Identification:Revision', 'name': 'SPECIFIC_DRIVER_REVISION', @@ -281,32 +281,32 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the Reference Clock source. To set this attribute, the NI-RFSG device must be in the Configuration state. Only certain combinations of this attribute and the NIRFSG_ATTR_PXI_CHASSIS_CLK10_SOURCE attribute are valid, as shown in the following table.\n\n **Default Value:** NIRFSG_VAL_ONBOARD_CLOCK_STR\n\n **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\n\n **Related Topics**\n\n `Timing Configurations `_\n \n **High-Level Functions**:\n\n - nirfsg_ConfigureRefClock\n \n **Possible Values**:\n ', + 'description': 'Specifies the Reference Clock source. To set this attribute, the NI-RFSG device must be in the Configuration state. Only certain combinations of this attribute and the NIRFSG_ATTR_PXI_CHASSIS_CLK10_SOURCE attribute are valid, as shown in the following table.\n\n**Default Value:** OnboardClock\n\n**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\n\n**Related Topics**\n\n`Timing Configurations `_\n\n**High-Level Functions**:\n\n- nirfsg_ConfigureRefClock\n\n**Possible Values**:', 'note': 'The PXI-5670/5671 and PXIe-5672 devices also allow you to drive the PXI 10 MHz backplane clock on PXI chassis *only* using the NIRFSG_ATTR_PXI_CHASSIS_CLK10_SOURCE attribute.', 'table_body': [ [ - 'OnboardClock', + '"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', + '"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', + '"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', + '"PXI_CLK"', 'Uses the PXI_CLK signal, which is present on the PXI backplane, as the Reference Clock source.' ], [ - 'RefIn2', + '"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 NIRFSG_VAL_PXI_CLK_STR as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector.' + '"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.' ] ], 'table_header': [ @@ -322,102 +322,102 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the source terminal for the Start Trigger. This attribute is used when the NIRFSG_ATTR_START_TRIGGER_TYPE attribute is set to digital edge. The NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_SOURCE attribute is not case-sensitive. To set the NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_SOURCE attribute, the NI-RFSG device must be in the Configuration state.\n\n PXIe-5654/5654 with PXIe-5696: The Start Trigger is valid only with a timer-based list when RF list mode is enabled.\n\n **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\n\n **Related Topics**\n\n `Start Trigger `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **High-Level Functions**:\n\n - nirfsg_ConfigureDigitalEdgeStartTrigger\n \n **Possible Values**:\n ', + 'description': 'Specifies the source terminal for the Start Trigger. This attribute is used when the NIRFSG_ATTR_START_TRIGGER_TYPE attribute is set to digital edge. The NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_SOURCE attribute is not case-sensitive. To set the NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_SOURCE attribute, the NI-RFSG device must be in the Configuration state.\n\nPXIe-5654/5654 with PXIe-5696: The Start Trigger is valid only with a timer-based list when RF list mode is enabled.\n\n**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\n\n**Related Topics**\n\n`Start Trigger `_\n\n`PFI Lines `_\n\n`PXI Trigger Lines `_\n\n**High-Level Functions**:\n\n- nirfsg_ConfigureDigitalEdgeStartTrigger\n\n **Possible Values**:', 'table_body': [ [ - 'PFI0', + '"PFI0"', 'The trigger is received on PFI 0.' ], [ - 'PFI1', + '"PFI1"', 'The trigger is received on PFI 1.' ], [ - 'PFI2', + '"PFI2"', 'The trigger is received on PFI 2.' ], [ - 'PFI3', + '"PFI3"', 'The trigger is received on PFI 3.' ], [ - 'PXI_Star', + '"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', + '"PXI_Trig0"', 'The trigger is received on PXI trigger line 0.' ], [ - 'PXI_Trig1', + '"PXI_Trig1"', 'The trigger is received on PXI trigger line 1.' ], [ - 'PXI_Trig2', + '"PXI_Trig2"', 'The trigger is received on PXI trigger line 2.' ], [ - 'PXI_Trig3', + '"PXI_Trig3"', 'The trigger is received on PXI trigger line 3.' ], [ - 'PXI_Trig4', + '"PXI_Trig4"', 'The trigger is received on PXI trigger line 4.' ], [ - 'PXI_Trig5', + '"PXI_Trig5"', 'The trigger is received on PXI trigger line 5.' ], [ - 'PXI_Trig6', + '"PXI_Trig6"', 'The trigger is received on PXI trigger line 6.' ], [ - 'PXI_Trig7', + '"PXI_Trig7"', 'The trigger is received on PXI trigger line 7.' ], [ - 'PXIe_DStarB', + '"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', + '"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', + '"DIO/PFI0"', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'DIO/PFI1', + '"DIO/PFI1"', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'DIO/PFI2', + '"DIO/PFI2"', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'DIO/PFI3', + '"DIO/PFI3"', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'DIO/PFI4', + '"DIO/PFI4"', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'DIO/PFI5', + '"DIO/PFI5"', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'DIO/PFI6', + '"DIO/PFI6"', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'DIO/PFI7', + '"DIO/PFI7"', 'The trigger is received on PFI7 from the front panel DIO terminal.' ], [ - 'Sync_Script', + '"Sync_Script"', 'The trigger is received on the Sync Script trigger line. This value is valid on only the PXIe-5644/5645/5646.' ] ], @@ -434,94 +434,94 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the destination terminal for exporting the Start Trigger. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n PXIe-5654/5654 with PXIe-5696: The Start Trigger is valid only with a timer-based list when RF list mode is enabled.\n\n **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\n\n **Related Topics**\n\n `Start Trigger `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **Possible Values**:\n ', + 'description': 'Specifies the destination terminal for exporting the Start Trigger. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\nPXIe-5654/5654 with PXIe-5696: The Start Trigger is valid only with a timer-based list when RF list mode is enabled.\n\n**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\n\n**Related Topics**\n\n`Start Trigger `_\n\n`PFI Lines `_\n\n`PXI Trigger Lines `_\n\n**Possible Values**:', 'table_body': [ [ - 'empty', + '""', 'The signal is not exported.' ], [ - 'PFI0', + '"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', + '"PFI1"', 'The signal is exported to the PFI 1 connector.' ], [ - 'PFI4', + '"PFI4"', 'The signal is exported to the PFI 4 connector.' ], [ - 'PFI5', + '"PFI5"', 'The signal is exported to the PFI 5 connector.' ], [ - 'PXI_Trig0', + '"PXI_Trig0"', 'The trigger is received on PXI trigger line 0.' ], [ - 'PXI_Trig1', + '"PXI_Trig1"', 'The trigger is received on PXI trigger line 1.' ], [ - 'PXI_Trig2', + '"PXI_Trig2"', 'The trigger is received on PXI trigger line 2.' ], [ - 'PXI_Trig3', + '"PXI_Trig3"', 'The trigger is received on PXI trigger line 3.' ], [ - 'PXI_Trig4', + '"PXI_Trig4"', 'The trigger is received on PXI trigger line 4.' ], [ - 'PXI_Trig5', + '"PXI_Trig5"', 'The trigger is received on PXI trigger line 5.' ], [ - 'PXI_Trig6', + '"PXI_Trig6"', 'The trigger is received on PXI trigger line 6.' ], [ - 'PXIe_DStarC', + '"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', + '"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', + '"DIO/PFI0"', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'DIO/PFI1', + '"DIO/PFI1"', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'DIO/PFI2', + '"DIO/PFI2"', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'DIO/PFI3', + '"DIO/PFI3"', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'DIO/PFI4', + '"DIO/PFI4"', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'DIO/PFI5', + '"DIO/PFI5"', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'DIO/PFI6', + '"DIO/PFI6"', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'DIO/PFI7', + '"DIO/PFI7"', 'The trigger is received on PFI7 from the front panel DIO terminal.' ] ], @@ -538,18 +538,18 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the clock source for driving the PXI 10 MHz backplane Reference Clock. This attribute is configurable if the PXI-5610 upconverter module is installed in *only* Slot 2 of a PXI chassis. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Possible Values**:\n\nPossible Value: Description\n\nempty :Do not drive the PXI_CLK10 signal.\n\nOnboardClock :Uses the highly stable oven-controlled onboard Reference Clock to drive the PXI_CLK signal.\n\nRefIn :Uses the clock present at the front panel REF IN connector to drive the PXI_CLK signal.\n\n **Default Value:** empty\n\n **Supported Devices:** PXI-5610, PXI-5670/5671\n\n **Related Topics**\n\n `Timing Configurations `_\n\n `System Reference Clock `_\n \n **High-Level Functions**:\n\n - nirfsg_ConfigurePxiChassisClk10\n \n \n Only certain combinations of this attribute and the NIRFSG_ATTR_REF_CLOCK_SOURCE attribute are valid, as shown in the following table.\n ', + 'description': 'Specifies the clock source for driving the PXI 10 MHz backplane Reference Clock. This attribute is configurable if the PXI-5610 upconverter module is installed in *only* Slot 2 of a PXI chassis. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Possible Values**:\n\nPossible Value: Description\n\n"" :Do not drive the PXI_CLK10 signal.\n\n"OnboardClock" :Uses the highly stable oven-controlled onboard Reference Clock to drive the PXI_CLK signal.\n\n"RefIn" :Uses the clock present at the front panel REF IN connector to drive the PXI_CLK signal.\n\n**Default Value:** ""\n\n**Supported Devices:** PXI-5610, PXI-5670/5671\n\n**Related Topics**\n\n`Timing Configurations `_\n\n`System Reference Clock `_\n\n**High-Level Functions**:\n\n- nirfsg_ConfigurePxiChassisClk10\n\n\nOnly certain combinations of this attribute and the NIRFSG_ATTR_REF_CLOCK_SOURCE attribute are valid, as shown in the following table.', 'table_body': [ [ - 'empty, OnboardClock', + '"", OnboardClock', 'OnboardClock' ], [ - 'empty, RefIn', + '"", RefIn', 'RefIn' ], [ - 'empty, RefIn', + '"", RefIn', 'PXI_CLK' ] ], @@ -566,7 +566,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies whether the driver maintains phase continuity in the arbitrary waveforms. When this attribute is set to NIRFSG_VAL_ENABLE, NI-RFSG may increase the waveform size. When this attribute is set to NIRFSG_VAL_ENABLE, the NIRFSG_ATTR_FREQUENCY_TOLERANCE attribute specifies the maximum allowable frequency error that can be introduced when keeping the signal phase-continuous. To set the NIRFSG_ATTR_PHASE_CONTINUITY_ENABLED attribute, the NI-RFSG device must be in the Configuration state. NIRFSG_ATTR_PHASE_CONTINUITY_ENABLED applies only when the NIRFSG_ATTR_GENERATION_MODE attribute is set to NIRFSG_VAL_ARB_WAVEFORM or NIRFSG_VAL_SCRIPT.\n\n 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 attribute has no effect.\n\n 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.\n\n **Default Value:** NIRFSG_VAL_AUTO\n \n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n \n **Related Topics**\n\n `Phase Continuity `_\n\n `Arb Waveform Mode Tuning Speed Factors `_\n \n **Defined Values**:\n ', + 'description': 'Specifies whether the driver maintains phase continuity in the arbitrary waveforms. When this attribute is set to NIRFSG_VAL_ENABLE, NI-RFSG may increase the waveform size. When this attribute is set to NIRFSG_VAL_ENABLE, the NIRFSG_ATTR_FREQUENCY_TOLERANCE attribute specifies the maximum allowable frequency error that can be introduced when keeping the signal phase-continuous. To set the NIRFSG_ATTR_PHASE_CONTINUITY_ENABLED attribute, the NI-RFSG device must be in the Configuration state. NIRFSG_ATTR_PHASE_CONTINUITY_ENABLED applies only when the NIRFSG_ATTR_GENERATION_MODE attribute is set to NIRFSG_VAL_ARB_WAVEFORM or NIRFSG_VAL_SCRIPT.\n\nPXI-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 attribute has no effect.\n\nPXIe-5644/5645/5646, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: Phase continuity is *always* enabled on this device.\n\n**Default Value:** NIRFSG_VAL_AUTO\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Phase Continuity `_\n\n`Arb Waveform Mode Tuning Speed Factors `_\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_AUTO', @@ -599,7 +599,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the allowable frequency error introduced during the software upconversion process. NI-RFSG may introduce a frequency error up to the specified amount to optimize computational speed and onboard memory usage while upconverting phase-continuous signals.\n\n If the NIRFSG_ATTR_PHASE_CONTINUITY_ENABLED attribute is set to NIRFSG_VAL_DISABLE, the NIRFSG_ATTR_FREQUENCY_TOLERANCE attribute is ignored, and the driver does not introduce a frequency error. On devices that do not use software upconversion, this attribute is ignored. The PXI-5670 always uses software upconversion, and the PXI-5671 uses software upconversion for I/Q rates greater than 8.33MS/s.\n\n To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Units**: hertz (Hz)\n\n **Default Value:** 50\n\n **Supported Devices:** PXI-5670/5671\n\n **Related Topics**\n\n `Phase Continuity `_\n ' + 'description': 'Specifies the allowable frequency error introduced during the software upconversion process. NI-RFSG may introduce a frequency error up to the specified amount to optimize computational speed and onboard memory usage while upconverting phase-continuous signals.\n\nIf the NIRFSG_ATTR_PHASE_CONTINUITY_ENABLED attribute is set to NIRFSG_VAL_DISABLE, the NIRFSG_ATTR_FREQUENCY_TOLERANCE attribute is ignored, and the driver does not introduce a frequency error. On devices that do not use software upconversion, this attribute is ignored. The PXI-5670 always uses software upconversion, and the PXI-5671 uses software upconversion for I/Q rates greater than 8.33MS/s.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Units**: hertz (Hz)\n\n**Default Value:** 50\n\n**Supported Devices:** PXI-5670/5671\n\n**Related Topics**\n\n`Phase Continuity `_' }, 'lv_property': 'RF:Frequency Tolerance (Hz)', 'name': 'FREQUENCY_TOLERANCE', @@ -609,7 +609,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': " Specifies the bandwidth of the arbitrary signal. This value must be less than or equal to (0.8× NIRFSG_ATTR_IQ_RATE).\n\n 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* :sub:`max` - *f* :sub:`min` .\n\n This attribute applies only when the NIRFSG_ATTR_GENERATION_MODE attribute is set to NIRFSG_VAL_ARB_WAVEFORM or NIRFSG_VAL_SCRIPT, except for when using the PXIe-5830/5831/5832/5840/5841, which supports setting this attribute in all supported generation modes. To set the NIRFSG_ATTR_SIGNAL_BANDWIDTH attribute, the NI-RFSG device must be in the Configuration state.\n\n 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 attribute may result in the signal being placed outside the upconverter passband.\n\n PXIe-5644/5645/5646, PXIe-5673/5673E: This attribute is used only for error-checking purposes. Otherwise, this attribute is ignored.\n\n PXIe-5820/5830/5831/5832/5840/5841/5842/5860: Based on your signal bandwidth, NI-RFSG decides the equalized bandwidth. If this attribute 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.\n\n **Units**: hertz (Hz)\n\n **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\n\n **Related Topics**\n\n `Phase-Locked Loop Bandwidth `_\n\n `Frequency Tuning Times `_\n\n `PXIe-5830 Frequency and Bandwidth Selection `_\n\n `PXIe-5831/5832 Frequency and Bandwidth Selection `_\n\n `PXIe-5841 Frequency and Bandwidth Selection `_\n " + 'description': "Specifies the bandwidth of the arbitrary signal. This value must be less than or equal to (0.8× NIRFSG_ATTR_IQ_RATE).\n\nNI-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* :sub:`max` - *f* :sub:`min` .\n\nThis attribute applies only when the NIRFSG_ATTR_GENERATION_MODE attribute is set to NIRFSG_VAL_ARB_WAVEFORM or NIRFSG_VAL_SCRIPT, except for when using the PXIe-5830/5831/5832/5840/5841, which supports setting this attribute in all supported generation modes. To set the NIRFSG_ATTR_SIGNAL_BANDWIDTH attribute, the NI-RFSG device must be in the Configuration state.\n\nPXI-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 attribute may result in the signal being placed outside the upconverter passband.\n\nPXIe-5644/5645/5646, PXIe-5673/5673E: This attribute is used only for error-checking purposes. Otherwise, this attribute is ignored.\n\nPXIe-5820/5830/5831/5832/5840/5841/5842/5860: Based on your signal bandwidth, NI-RFSG decides the equalized bandwidth. If this attribute 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.\n\n**Units**: hertz (Hz)\n\n**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\n\n**Related Topics**\n\n`Phase-Locked Loop Bandwidth `_\n\n`Frequency Tuning Times `_\n\n`PXIe-5830 Frequency and Bandwidth Selection `_\n\n`PXIe-5831/5832 Frequency and Bandwidth Selection `_\n\n`PXIe-5841 Frequency and Bandwidth Selection `_" }, 'lv_property': 'Arb:Signal Bandwidth (Hz)', 'name': 'SIGNAL_BANDWIDTH', @@ -619,7 +619,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Enables or disables automatic thermal correction. When this attribute is enabled, changes to settings cause NI-RFSG to check whether the device temperature has changed and adjusts the settings as needed. When this attribute is disabled, you must explicitly call the nirfsg_PerformThermalCorrection function to adjust the device for temperature changes.\n\n **Default Value:** NIRFSG_VAL_ENABLE\n\n **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\n\n **Related Topics**\n\n `Temperature Monitoring `_\n\n `Settling Times `_\n\n **Defined Values**:\n ', + 'description': 'Enables or disables automatic thermal correction. When this attribute is enabled, changes to settings cause NI-RFSG to check whether the device temperature has changed and adjusts the settings as needed. When this attribute is disabled, you must explicitly call the nirfsg_PerformThermalCorrection function to adjust the device for temperature changes.\n\n**Default Value:** NIRFSG_VAL_ENABLE\n\n**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\n\n**Related Topics**\n\n`Temperature Monitoring `_\n\n`Settling Times `_\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_DISABLE', @@ -647,7 +647,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies whether attenuator hold is enabled. While this attribute is set to VI_TRUE, changing the power level causes NI-RFSG to scale the digital data sent to the AWG instead of adjusting the attenuators. Changing power levels in this manner allows the device to increase or decrease the power level in more accurate increments, but it may affect signal-to-noise ratios (noise density).\n\n\n Setting the NIRFSG_ATTR_ATTENUATOR_HOLD_ENABLED attribute to VI_TRUE limits the power levels that can be attained. With attenuator hold enabled, the power level must satisfy the following conditions:\n\n - Power level less than or equal to NIRFSG_ATTR_ATTENUATOR_HOLD_MAX_POWER\n - Power level greater than or equal to (maximum power level -70dB)\n - Power level greater than or equal to -145dBm\n\n To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** VI_FALSE\n\n **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E\n\n **Related Topics**\n\n `Attenuator Hold `_\n\n `Settling Times `_\n\n **Defined Values**:\n ', + 'description': 'Specifies whether attenuator hold is enabled. While this attribute is set to VI_TRUE, changing the power level causes NI-RFSG to scale the digital data sent to the AWG instead of adjusting the attenuators. Changing power levels in this manner allows the device to increase or decrease the power level in more accurate increments, but it may affect signal-to-noise ratios (noise density).\n\nSetting the NIRFSG_ATTR_ATTENUATOR_HOLD_ENABLED attribute to VI_TRUE limits the power levels that can be attained. With attenuator hold enabled, the power level must satisfy the following conditions:\n\n- Power level less than or equal to NIRFSG_ATTR_ATTENUATOR_HOLD_MAX_POWER\n- Power level greater than or equal to (maximum power level -70dB)\n- Power level greater than or equal to -145dBm\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** VI_FALSE\n\n**Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E\n\n**Related Topics**\n\n`Attenuator Hold `_\n\n`Settling Times `_\n\n**Defined Values**:', 'note': 'The frequency cannot be changed on the PXI-5670/5671 or PXIe-5672 while this attribute is set to VI_TRUE.', 'table_body': [ [ @@ -672,7 +672,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the maximum power level of the RF output signal when the NIRFSG_ATTR_ATTENUATOR_HOLD_ENABLED attribute is set to VI_TRUE.\n\n To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Units**: dBm\n\n **Defined Values**:\n Refer to the specifications document for your device for allowable maximum power levels.\n\n **Default Value:**\n\n PXI-5670/5671, PXIe-5672: 17\n\n PXIe-5673/5673E: 10\n\n **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E\n\n **Related Topics**\n\n `Attenuator Hold `_\n\n `Settling Times `_\n ' + 'description': 'Specifies the maximum power level of the RF output signal when the NIRFSG_ATTR_ATTENUATOR_HOLD_ENABLED attribute is set to VI_TRUE.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Units**: dBm\n\n**Defined Values**:\nRefer to the specifications document for your device for allowable maximum power levels.\n\n**Default Value:**\n\nPXI-5670/5671, PXIe-5672: 17\n\nPXIe-5673/5673E: 10\n\n**Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E\n\n**Related Topics**\n\n`Attenuator Hold `_\n\n`Settling Times `_' }, 'lv_property': 'RF:Attenuator Hold Max Power (dBm)', 'name': 'ATTENUATOR_HOLD_MAX_POWER', @@ -682,7 +682,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the maximum instantaneous power of the RF output signal.\n\n **Units**: dBm\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ', + 'description': 'Returns the maximum instantaneous power of the RF output signal.\n\n**Units**: dBm\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', 'note': '- This attribute is valid only when the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute is set to NIRFSG_VAL_AVERAGE_POWER.\n\n - The NIRFSG_ATTR_ARB_DIGITAL_GAIN attribute is not included in the calculation of the NIRFSG_ATTR_PEAK_ENVELOPE_POWER attribute.' }, 'lv_property': 'RF:Peak Envelope Power (dBm)', @@ -693,7 +693,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' When this attribute 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.\n\n 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.\n\n This attribute applies only when the NIRFSG_ATTR_GENERATION_MODE attribute is set to NIRFSG_VAL_ARB_WAVEFORM or NIRFSG_VAL_SCRIPT. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: NIRFSG_VAL_ENABLE is the only supported value for this device.\n\n **Default Value:**\n\n PXI-5670/5671: NIRFSG_VAL_DISABLE\n\n PXIe-5644/5645/5646, PXIe-5672, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: NIRFSG_VAL_ENABLE\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Response and Software Equalization `_—Refer to this topic for more information about equalization performed in software.\n\n `Frequency Tuning Times `_\n\n **Defined Values**:\n ', + 'description': 'When this attribute 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.\n\nOn 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.\n\nThis attribute applies only when the NIRFSG_ATTR_GENERATION_MODE attribute is set to NIRFSG_VAL_ARB_WAVEFORM or NIRFSG_VAL_SCRIPT. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\nPXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: NIRFSG_VAL_ENABLE is the only supported value for this device.\n\n**Default Value:**\n\nPXI-5670/5671: NIRFSG_VAL_DISABLE\n\nPXIe-5644/5645/5646, PXIe-5672, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: NIRFSG_VAL_ENABLE\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Response and Software Equalization `_—Refer to this topic for more information about equalization performed in software.\n\n`Frequency Tuning Times `_\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_DISABLE', @@ -721,7 +721,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies whether the local oscillator signal is present at the LO OUT front panel connector. The local oscillator signal remains at the LO OUT front panel connector until this attribute is set to VI_FALSE, even if the NIRFSG_ATTR_OUTPUT_ENABLED attribute is set to VI_FALSE, the nirfsg_Abort function is called, or the NI-RFSG session is closed.\n\n To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg_SetAttributeViBoolean function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string).\n\n **Default Value:** NIRFSG_VAL_DISABLE\n\n **Supported Devices:** PXI-5610, PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `LO OUT `_\n \n **Defined Values**:\n ', + 'description': 'Specifies whether the local oscillator signal is present at the LO OUT front panel connector. The local oscillator signal remains at the LO OUT front panel connector until this attribute is set to VI_FALSE, even if the NIRFSG_ATTR_OUTPUT_ENABLED attribute is set to VI_FALSE, the nirfsg_Abort function is called, or the NI-RFSG session is closed.\n\nTo use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg_SetAttributeViBoolean function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string).\n\n**Default Value:** NIRFSG_VAL_DISABLE\n\n**Supported Devices:** PXI-5610, PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`LO OUT `_\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_ENABLE', @@ -745,7 +745,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Enables or disables warnings or errors when you set the frequency, power, and bandwidth values beyond the limits of the NI-RFSG device specifications. When you enable the NIRFSG_ATTR_ALLOW_OUT_OF_SPECIFICATION_USER_SETTINGS attribute, the driver does not report out-of-specification warnings or errors.\n\n To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** NIRFSG_VAL_DISABLE\n\n **Supported Devices:** PXI/PXIe-5650/5651/5652, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Defined Values**:\n ', + 'description': 'Enables or disables warnings or errors when you set the frequency, power, and bandwidth values beyond the limits of the NI-RFSG device specifications. When you enable the NIRFSG_ATTR_ALLOW_OUT_OF_SPECIFICATION_USER_SETTINGS attribute, the driver does not report out-of-specification warnings or errors.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** NIRFSG_VAL_DISABLE\n\n**Supported Devices:** PXI/PXIe-5650/5651/5652, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', 'note': 'Accuracy cannot be guaranteed outside of device specifications, and results may vary by module.', 'table_body': [ [ @@ -774,7 +774,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': '\n **Units**: hertz (Hz)\n\n **Supported Devices:** PXI-5610, PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Assigning Properties or Attributes to a Waveform `_—Refer to this topic for more information about using this attribute to associate a carrier frequency with a waveform.\n 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:\n ', + 'description': '**Units**: hertz (Hz)\n\n**Supported Devices:** PXI-5610, PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Assigning Properties or Attributes to a Waveform `_—Refer to this topic for more information about using this attribute to associate a carrier frequency with a waveform.\nIndicates 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:', 'note': '- Use this attribute to associate a carrier frequency with a waveform.\n\n - This attribute is read-only on the PXI-5670/5671 and PXIe-5672.', 'table_body': [ [ @@ -799,7 +799,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Indicates the average output power from the PXI-5421, PXI-5441, PXIe-5442, and PXIe-5450 AWG module. If an arbitrary waveform is being generated, this attribute specifies either the average power or the peak power of the signal, depending on the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute setting.\n\n **Units**: dBm\n\n **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E\n ' + 'description': 'Indicates the average output power from the PXI-5421, PXI-5441, PXIe-5442, and PXIe-5450 AWG module. If an arbitrary waveform is being generated, this attribute specifies either the average power or the peak power of the signal, depending on the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute setting.\n\n**Units**: dBm\n\n**Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E' }, 'lv_property': 'Arb:Arb Power (dBm)', 'name': 'ARB_POWER', @@ -809,7 +809,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the device temperature. If the NI-RFSG session is controlling multiple devices, this attribute returns the temperature of the primary NI RF device. The NI-RFSG session is opened using the primary RF device name.\n\n 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.\n\n PXIe-5644/5645/5646, PXIe-5820/5840/5841: If you query this attribute during RF list mode, list steps may take longer to complete during list execution.\n\n PXIe-5830/5831/5832: To use this attribute, you must first set the channelName parameter of the nirfsg_SetAttributeViReal64 function to using the appropriate string for your instrument configuration. Setting the nirfsg_SetAttributeViReal64 function is not required for the PXIe-3621/3622. Refer to the following table to determine which strings are valid for your configuration.\n\n **Units**: degrees Celsius (°C)\n\n **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\n\n **Related Topics**\n\n `Temperature Monitoring `_\n\n `Thermal Shutdown `_\n ', + 'description': 'Returns the device temperature. If the NI-RFSG session is controlling multiple devices, this attribute returns the temperature of the primary NI RF device. The NI-RFSG session is opened using the primary RF device name.\n\nSerial 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.\n\nPXIe-5644/5645/5646, PXIe-5820/5840/5841: If you query this attribute during RF list mode, list steps may take longer to complete during list execution.\n\nPXIe-5830/5831/5832: To use this attribute, you must first set the channelName parameter of the nirfsg_SetAttributeViReal64 function to using the appropriate string for your instrument configuration. Setting the nirfsg_SetAttributeViReal64 function is not required for the PXIe-3621/3622. Refer to the following table to determine which strings are valid for your configuration.\n\n**Units**: degrees Celsius (°C)\n\n**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\n\n**Related Topics**\n\n`Temperature Monitoring `_\n\n`Thermal Shutdown `_', 'table_body': [ [ 'PXIe-3621/3622', @@ -866,7 +866,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies whether to generate a continuous wave (CW) signal, the arbitrary waveform specified by the NIRFSG_ATTR_ARB_SELECTED_WAVEFORM attribute, or the script specified by the NIRFSG_ATTR_SELECTED_SCRIPT attribute, upon calling the nirfsg_Initiate function.\n\n To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** NIRFSG_VAL_CW\n\n **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\n\n **Related Topics**\n\n `Assigning Properties or Attributes to a Waveform `_\n\n `Scripting Instructions `_—Refer to this topic for more information about scripting.\n \n **High-Level Functions**:\n\n - nirfsg_ConfigureGenerationMode\n \n **Defined Values**:\n ', + 'description': 'Specifies whether to generate a continuous wave (CW) signal, the arbitrary waveform specified by the NIRFSG_ATTR_ARB_SELECTED_WAVEFORM attribute, or the script specified by the NIRFSG_ATTR_SELECTED_SCRIPT attribute, upon calling the nirfsg_Initiate function.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** NIRFSG_VAL_CW\n\n**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\n\n**Related Topics**\n\n`Assigning Properties or Attributes to a Waveform `_\n\n`Scripting Instructions `_—Refer to this topic for more information about scripting.\n\n**High-Level Functions**:\n\n- nirfsg_ConfigureGenerationMode\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_ARB_WAVEFORM', @@ -899,7 +899,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the Script Trigger type. Depending upon the value of this attribute, more attributes may be needed to fully configure the trigger. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** NIRFSG_VAL_NONE\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Script Trigger `_\n\n `Trigger Types `_\n\n **High-Level Functions**:\n\n - nirfsg_ConfigureDigitalEdgeScriptTrigger\n \n **Defined Values**:\n ', + 'description': 'Specifies the Script Trigger type. Depending upon the value of this attribute, more attributes may be needed to fully configure the trigger. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** NIRFSG_VAL_NONE\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Script Trigger `_\n\n`Trigger Types `_\n\n**High-Level Functions**:\n\n- nirfsg_ConfigureDigitalEdgeScriptTrigger\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_NONE', @@ -935,102 +935,102 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the source terminal for the Script Trigger. This attribute is used when the NIRFSG_ATTR_SCRIPT_TRIGGER_TYPE attribute is set to digital edge. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Script Trigger `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **High-Level Functions**:\n\n - nirfsg_ConfigureDigitalEdgeScriptTrigger\n \n **Possible Values**:\n ', + 'description': 'Specifies the source terminal for the Script Trigger. This attribute is used when the NIRFSG_ATTR_SCRIPT_TRIGGER_TYPE attribute is set to digital edge. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Script Trigger `_\n\n`PFI Lines `_\n\n`PXI Trigger Lines `_\n\n**High-Level Functions**:\n\n- nirfsg_ConfigureDigitalEdgeScriptTrigger\n\n**Possible Values**:', 'table_body': [ [ - 'PFI0', + '"PFI0"', 'The trigger is received on PFI 0.' ], [ - 'PFI1', + '"PFI1"', 'The trigger is received on PFI 1.' ], [ - 'PFI2', + '"PFI2"', 'The trigger is received on PFI 2.' ], [ - 'PFI3', + '"PFI3"', 'The trigger is received on PFI 3.' ], [ - 'PXI_Star', + '"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', + '"PXI_Trig0"', 'The trigger is received on PXI trigger line 0.' ], [ - 'PXI_Trig1', + '"PXI_Trig1"', 'The trigger is received on PXI trigger line 1.' ], [ - 'PXI_Trig2', + '"PXI_Trig2"', 'The trigger is received on PXI trigger line 2.' ], [ - 'PXI_Trig3', + '"PXI_Trig3"', 'The trigger is received on PXI trigger line 3.' ], [ - 'PXI_Trig4', + '"PXI_Trig4"', 'The trigger is received on PXI trigger line 4.' ], [ - 'PXI_Trig5', + '"PXI_Trig5"', 'The trigger is received on PXI trigger line 5.' ], [ - 'PXI_Trig6', + '"PXI_Trig6"', 'The trigger is received on PXI trigger line 6.' ], [ - 'PXI_Trig7', + '"PXI_Trig7"', 'The trigger is received on PXI trigger line 7.' ], [ - 'PXIe_DStarB', + '"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', + '"PulseIn"', 'The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842.' ], [ - 'DIO/PFI0', + '"DIO/PFI0"', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'DIO/PFI1', + '"DIO/PFI1"', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'DIO/PFI2', + '"DIO/PFI2"', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'DIO/PFI3', + '"DIO/PFI3"', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'DIO/PFI4', + '"DIO/PFI4"', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'DIO/PFI5', + '"DIO/PFI5"', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'DIO/PFI6', + '"DIO/PFI6"', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'DIO/PFI7', + '"DIO/PFI7"', 'The trigger is received on PFI7 from the front panel DIO terminal.' ], [ - 'Sync_Script', + '"Sync_Script"', 'The trigger is received on the Sync Script trigger line. This value is valid on only the PXIe-5644/5645/5646.' ] ], @@ -1050,7 +1050,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the active edge for the Script Trigger. This attribute is used when the NIRFSG_ATTR_SCRIPT_TRIGGER_TYPE attribute is set to digital edge. To set the NIRFSG_ATTR_DIGITAL_EDGE_SCRIPT_TRIGGER_EDGE attribute, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** NIRFSG_VAL_RISING_EDGE\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Script Trigger `_\n\n `Digital Edge Trigger `_\n \n **High-Level Functions**:\n\n - nirfsg_ConfigureDigitalEdgeScriptTrigger\n \n **Defined Values**:\n ', + 'description': 'Specifies the active edge for the Script Trigger. This attribute is used when the NIRFSG_ATTR_SCRIPT_TRIGGER_TYPE attribute is set to digital edge. To set the NIRFSG_ATTR_DIGITAL_EDGE_SCRIPT_TRIGGER_EDGE attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** NIRFSG_VAL_RISING_EDGE\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Script Trigger `_\n\n`Digital Edge Trigger `_\n\n**High-Level Functions**:\n\n- nirfsg_ConfigureDigitalEdgeScriptTrigger\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_FALLING_EDGE', @@ -1081,90 +1081,90 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the destination terminal for exporting the Script Trigger. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Script Trigger `_ —Refer to this topic for information about trigger delay.\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **High-Level Functions**:\n\n - nirfsg_ExportSignal\n \n **Possible Values**:\n ', + 'description': 'Specifies the destination terminal for exporting the Script Trigger. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Script Trigger `_ —Refer to this topic for information about trigger delay.\n\n`PFI Lines `_\n\n`PXI Trigger Lines `_\n\n**High-Level Functions**:\n\n- nirfsg_ExportSignal\n\n**Possible Values**:', 'table_body': [ [ - 'empty', + '""', 'The signal is not exported.' ], [ - 'PFI0', + '"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', + '"PFI1"', 'The signal is exported to the PFI 1 connector.' ], [ - 'PFI4', + '"PFI4"', 'The signal is exported to the PFI 4 connector.' ], [ - 'PFI5', + '"PFI5"', 'The signal is exported to the PFI 5 connector.' ], [ - 'PXI_Trig0', + '"PXI_Trig0"', 'The trigger is received on PXI trigger line 0.' ], [ - 'PXI_Trig1', + '"PXI_Trig1"', 'The trigger is received on PXI trigger line 1.' ], [ - 'PXI_Trig2', + '"PXI_Trig2"', 'The trigger is received on PXI trigger line 2.' ], [ - 'PXI_Trig3', + '"PXI_Trig3"', 'The trigger is received on PXI trigger line 3.' ], [ - 'PXI_Trig4', + '"PXI_Trig4"', 'The trigger is received on PXI trigger line 4.' ], [ - 'PXI_Trig5', + '"PXI_Trig5"', 'The trigger is received on PXI trigger line 5.' ], [ - 'PXI_Trig6', + '"PXI_Trig6"', 'The trigger is received on PXI trigger line 6.' ], [ - 'PXIe_DStarC', + '"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', + '"DIO/PFI0"', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'DIO/PFI1', + '"DIO/PFI1"', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'DIO/PFI2', + '"DIO/PFI2"', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'DIO/PFI3', + '"DIO/PFI3"', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'DIO/PFI4', + '"DIO/PFI4"', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'DIO/PFI5', + '"DIO/PFI5"', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'DIO/PFI6', + '"DIO/PFI6"', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'DIO/PFI7', + '"DIO/PFI7"', 'The trigger is received on PFI7 from the front panel DIO terminal.' ] ], @@ -1184,7 +1184,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the script in onboard memory to generate upon calling the nirfsg_Initiate function when the NIRFSG_ATTR_GENERATION_MODE attribute is set to NIRFSG_VAL_SCRIPT.\n\n The NIRFSG_ATTR_SELECTED_SCRIPT attribute is ignored when the NIRFSG_ATTR_GENERATION_MODE attribute is set to NIRFSG_VAL_ARB_WAVEFORM or NIRFSG_VAL_CW. To set the NIRFSG_ATTR_SELECTED_SCRIPT attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Assigning Properties or Attributes to a Waveform `_\n\n `Scripting Instructions `_\n ' + 'description': 'Specifies the script in onboard memory to generate upon calling the nirfsg_Initiate function when the NIRFSG_ATTR_GENERATION_MODE attribute is set to NIRFSG_VAL_SCRIPT.\n\nThe NIRFSG_ATTR_SELECTED_SCRIPT attribute is ignored when the NIRFSG_ATTR_GENERATION_MODE attribute is set to NIRFSG_VAL_ARB_WAVEFORM or NIRFSG_VAL_CW. To set the NIRFSG_ATTR_SELECTED_SCRIPT attribute, the NI-RFSG device must be in the Configuration state.\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Assigning Properties or Attributes to a Waveform `_\n\n`Scripting Instructions `_' }, 'lv_property': 'Arb:Selected Script', 'name': 'SELECTED_SCRIPT', @@ -1194,7 +1194,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the phase of the RF output signal. Use this attribute to align the phase of the RF output with the phase of the RF output of another device, as long as the two devices are phase-coherent.\n\n **Units**: degrees (°)\n\n **Default Value:** 0\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Phase Synchronization and Phase Coherency `_\n ' + 'description': 'Specifies the phase of the RF output signal. Use this attribute to align the phase of the RF output with the phase of the RF output of another device, as long as the two devices are phase-coherent.\n\n**Units**: degrees (°)\n\n**Default Value:** 0\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Phase Synchronization and Phase Coherency `_' }, 'lv_property': 'RF:Phase Offset (Degrees)', 'name': 'PHASE_OFFSET', @@ -1204,7 +1204,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' 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 attribute. 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 attribute. PXIe-5860 can only be in the Configuration state to use this attribute.\n\n On the PXI-5671, this attribute applies only when the NIRFSG_ATTR_IQ_RATE attribute 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 attribute is always applicable.\n\n **Units**: dB\n\n **Default Value:** 0dB\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' + 'description': '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 attribute. 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 attribute. PXIe-5860 can only be in the Configuration state to use this attribute.\n\nOn the PXI-5671, this attribute applies only when the NIRFSG_ATTR_IQ_RATE attribute 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 attribute is always applicable.\n\n**Units**: dB\n\n**Default Value:** 0dB\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'lv_property': 'Arb:Pre-filter Gain (dB)', 'name': 'ARB_PRE_FILTER_GAIN', @@ -1214,7 +1214,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the serial number of the RF module. If the NI-RFSG session is controlling multiple modules, this attribute returns the serial number of the primary RF module.\n\n **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\n ' + 'description': 'Returns the serial number of the RF module. If the NI-RFSG session is controlling multiple modules, this attribute returns the serial number of the primary RF module.\n\n**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' }, 'lv_property': 'Device Characteristics:Serial Number', 'name': 'SERIAL_NUMBER', @@ -1224,7 +1224,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Configures the loop bandwidth of the tuning PLLs. This attribute is ignored on the PXI-5610, PXI-5670/5671, and PXIe-5672 for signal bandwidths greater than or equal to 10MHz. This attribute is ignored on the PXI/PXIe-5650/5651/5652 for RF frequencies less than 50MHz.\n\n To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg_SetAttributeViInt32 function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string).\n\n **Default Value:**\n\n PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842: NIRFSG_VAL_MEDIUM\n\n PXI/PXIe-5650/5651/5652, PXIe-5673/5673E: NIRFSG_VAL_NARROW\n\n **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\n\n **Related Topics**\n\n `Phase-Locked Loop Bandwidth `_\n\n `Modulation Implementation `_\n\n `Sinusoidal Tone Versus Modulation Operation `_\n \n **Defined Values**:\n ', + 'description': 'Configures the loop bandwidth of the tuning PLLs. This attribute is ignored on the PXI-5610, PXI-5670/5671, and PXIe-5672 for signal bandwidths greater than or equal to 10MHz. This attribute is ignored on the PXI/PXIe-5650/5651/5652 for RF frequencies less than 50MHz.\n\nTo use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg_SetAttributeViInt32 function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string).\n\n**Default Value:**\n\nPXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842: NIRFSG_VAL_MEDIUM\n\nPXI/PXIe-5650/5651/5652, PXIe-5673/5673E: NIRFSG_VAL_NARROW\n\n**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\n\n**Related Topics**\n\n`Phase-Locked Loop Bandwidth `_\n\n`Modulation Implementation `_\n\n`Sinusoidal Tone Versus Modulation Operation `_\n\n**Defined Values**:', 'note': 'Setting this attribute to NIRFSG_VAL_WIDE on the PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, or the PXIe-5673/5673E allows the frequency to settle significantly faster at the expense of increased phase noise. Setting this attribute to NIRFSG_VAL_MEDIUM is not a valid option on the PXI/PXIe-5650/5651/5652 or PXIe-5673/5673E. NIRFSG_VAL_MEDIUM is the only supported value for the PXIe-5840/5841/5842.', 'table_body': [ [ @@ -1258,7 +1258,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the Sample Clock mode on the device. To set this attribute, the device must be in the Configuration state.\n\n PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: NIRFSG_VAL_DIVIDE_DOWN is the only supported value for this device.\n\n **Default Values:**\n\n PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: NIRFSG_VAL_DIVIDE_DOWN\n\n PXIe-5673/5673E: NIRFSG_VAL_HIGH_RESOLUTION\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Clocking Modes `_\n\n **Valid Values**:\n ', + 'description': 'Specifies the Sample Clock mode on the device. To set this attribute, the device must be in the Configuration state.\n\nPXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: NIRFSG_VAL_DIVIDE_DOWN is the only supported value for this device.\n\n**Default Values:**\n\nPXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: NIRFSG_VAL_DIVIDE_DOWN\n\nPXIe-5673/5673E: NIRFSG_VAL_HIGH_RESOLUTION\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Clocking Modes `_\n\n**Valid Values**:', 'note': 'Using the high resolution clock may result in increased phase noise.', 'table_body': [ [ @@ -1284,14 +1284,14 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the Sample Clock source for the device. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: NIRFSG_VAL_ONBOARD_CLOCK_STR is the only supported value for this device.\n\n **Default Value:** NIRFSG_VAL_ONBOARD_CLOCK_STR\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Timing Configurations `_\n \n **Possible Values**:\n ', + 'description': 'Specifies the Sample Clock source for the device. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\nPXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: OnboardClock is the only supported value for this device.\n\n**Default Value:** OnboardClock\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Timing Configurations `_\n\n**Possible Values**:', 'table_body': [ [ - 'ClkIn', + '"ClkIn"', 'Uses the external clock as the Sample Clock source.' ], [ - 'OnboardClock', + '"OnboardClock"', 'Uses the AWG module onboard clock as the Sample Clock source.' ] ], @@ -1308,7 +1308,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the rate of the Sample Clock on the device.\n\n **Units**: hertz (Hz)\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' + 'description': 'Returns the rate of the Sample Clock on the device.\n\n**Units**: hertz (Hz)\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'lv_property': 'Clock:Arb Sample Clock Rate (Hz)', 'name': 'ARB_SAMPLE_CLOCK_RATE', @@ -1318,7 +1318,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the analog modulation format to use.\n\n **Default Value:** NIRFSG_VAL_NONE\n\n **Supported Devices:** PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696\n\n **Related Topics**\n\n `Modulation `_\n\n `PXI/PXIe-5650/5651/5652 Modulation Schemes `_\n\n `PXIe-5654/5654 with PXIe-5696 Modulation Schemes `_\n \n **Defined Values**:\n ', + 'description': 'Specifies the analog modulation format to use.\n\n**Default Value:** NIRFSG_VAL_NONE\n\n**Supported Devices:** PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696\n\n**Related Topics**\n\n`Modulation `_\n\n`PXI/PXIe-5650/5651/5652 Modulation Schemes `_\n\n`PXIe-5654/5654 with PXIe-5696 Modulation Schemes `_\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_AM', @@ -1356,7 +1356,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the type of waveform to use as the message signal for analog modulation.\n\n **Default Value:** NIRFSG_VAL_SINE\n\n **Supported Devices:** PXI/PXIe-5650/5651/5652\n\n **Related Topics**\n\n `Modulation Schemes `_\n \n **Defined Values**:\n ', + 'description': 'Specifies the type of waveform to use as the message signal for analog modulation.\n\n**Default Value:** NIRFSG_VAL_SINE\n\n**Supported Devices:** PXI/PXIe-5650/5651/5652\n\n**Related Topics**\n\n`Modulation Schemes `_\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_SINE', @@ -1389,7 +1389,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the frequency of the waveform to use as the message signal in analog modulation.\n\n **Units:** hertz (Hz)\n\n **Default Value:** 1kHz\n\n **Supported Devices:** PXI/PXIe-5650/5651/5652\n\n **Related Topics**\n\n `Modulation Schemes `_\n ' + 'description': 'Specifies the frequency of the waveform to use as the message signal in analog modulation.\n\n**Units:** hertz (Hz)\n\n**Default Value:** 1kHz\n\n**Supported Devices:** PXI/PXIe-5650/5651/5652\n\n**Related Topics**\n\n`Modulation Schemes `_' }, 'lv_property': 'Modulation:Analog:Waveform Frequency (Hz)', 'name': 'ANALOG_MODULATION_WAVEFORM_FREQUENCY', @@ -1399,7 +1399,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the frequency deviation to use in frequency modulation.\n\n **Units**: hertz (Hz)\n\n **Default Value:** 1kHz\n\n **Supported Devices:** PXI/PXIe-5650/5651/5652\n\n **Related Topics**\n\n `Modulation Schemes `_\n ' + 'description': 'Specifies the frequency deviation to use in frequency modulation.\n\n**Units**: hertz (Hz)\n\n**Default Value:** 1kHz\n\n**Supported Devices:** PXI/PXIe-5650/5651/5652\n\n**Related Topics**\n\n`Modulation Schemes `_' }, 'lv_property': 'Modulation:Analog:FM Deviation (Hz)', 'name': 'ANALOG_MODULATION_FM_DEVIATION', @@ -1409,7 +1409,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the digital modulation format to use.\n\n **Default Value:** NIRFSG_VAL_NONE\n\n **Supported Devices:** PXI/PXIe-5650/5651/5652\n\n **Related Topics**\n\n `Modulation Schemes `_\n \n **Defined Values**:\n ', + 'description': 'Specifies the digital modulation format to use.\n\n**Default Value:** NIRFSG_VAL_NONE\n\n**Supported Devices:** PXI/PXIe-5650/5651/5652\n\n**Related Topics**\n\n`Modulation Schemes `_\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_FSK', @@ -1447,7 +1447,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the symbol rate of the bit stream for digital modulation.\n\n **Units**: hertz (Hz)\n\n **Default Value:** 1kHz\n\n **Supported Devices:** PXI/PXIe-5650/5651/5652\n\n **Related Topics**\n\n `Modulation Schemes `_\n ' + 'description': 'Specifies the symbol rate of the bit stream for digital modulation.\n\n**Units**: hertz (Hz)\n\n**Default Value:** 1kHz\n\n**Supported Devices:** PXI/PXIe-5650/5651/5652\n\n**Related Topics**\n\n`Modulation Schemes `_' }, 'lv_property': 'Modulation:Digital:Symbol Rate', 'name': 'DIGITAL_MODULATION_SYMBOL_RATE', @@ -1457,7 +1457,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the type of waveform to use as the message signal in digital modulation.\n\n **Default Value:** NIRFSG_VAL_PRBS\n\n **Supported Devices:** PXI/PXIe-5650/5651/5652\n\n **Related Topics**\n\n `Modulation Schemes `_\n \n **Defined Values**:\n ', + 'description': 'Specifies the type of waveform to use as the message signal in digital modulation.\n\n**Default Value:** NIRFSG_VAL_PRBS\n\n**Supported Devices:** PXI/PXIe-5650/5651/5652\n\n**Related Topics**\n\n`Modulation Schemes `_\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_PRBS', @@ -1485,7 +1485,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the order of pseudorandom bit sequence (PRBS) internally generated by hardware and used as the message signal in digital modulation.\n\n **Default Value:** 16\n\n **Supported Devices:** PXI/PXIe-5650/5651/5652\n\n **Related Topics**\n\n `Modulation Schemes `_\n ' + 'description': 'Specifies the order of pseudorandom bit sequence (PRBS) internally generated by hardware and used as the message signal in digital modulation.\n\n**Default Value:** 16\n\n**Supported Devices:** PXI/PXIe-5650/5651/5652\n\n**Related Topics**\n\n`Modulation Schemes `_' }, 'lv_property': 'Modulation:Digital:PRBS Order', 'name': 'DIGITAL_MODULATION_PRBS_ORDER', @@ -1495,7 +1495,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the seed of the internally generated pseudorandom bit sequence (PRBS).\n\n **Default Value:** 1\n\n **Supported Devices:** PXI/PXIe-5650/5651/5652\n\n **Related Topics**\n\n `Modulation Schemes `_\n ' + 'description': 'Specifies the seed of the internally generated pseudorandom bit sequence (PRBS).\n\n**Default Value:** 1\n\n**Supported Devices:** PXI/PXIe-5650/5651/5652\n\n**Related Topics**\n\n`Modulation Schemes `_' }, 'lv_property': 'Modulation:Digital:PRBS Seed', 'name': 'DIGITAL_MODULATION_PRBS_SEED', @@ -1505,7 +1505,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the deviation to use in FSK modulation.\n\n **Units**: hertz (Hz)\n\n **Default Value:** 1,000\n\n **Supported Devices:** PXI/PXIe-5650/5651/5652\n\n **Related Topics**\n\n `Modulation Schemes `_\n ' + 'description': 'Specifies the deviation to use in FSK modulation.\n\n**Units**: hertz (Hz)\n\n**Default Value:** 1,000\n\n**Supported Devices:** PXI/PXIe-5650/5651/5652\n\n**Related Topics**\n\n`Modulation Schemes `_' }, 'lv_property': 'Modulation:Digital:FSK Deviation (Hz)', 'name': 'DIGITAL_MODULATION_FSK_DEVIATION', @@ -1515,7 +1515,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies whether the nirfsg_WriteArbWaveform function immediately writes waveforms to the device or copies the waveform to host memory for later download. NI-RFSG reads and validates this attribute when an arbitrary waveform is first allocated.\n\n For the PXI-5670, direct download is always disabled. For all other devices, direct download is always enabled.\n\n PXI-5671: To increase performance when using large waveforms, enable direct download. To maximize reconfigurability, disable direct download.\n\n Perform the following steps to enable direct download:\n\n\n\n 1. Set the I/Q rate to less than or equal to 8.33MS/s with the NIRFSG_ATTR_IQ_RATE attribute.\n\n 2. Set the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute to NIRFSG_VAL_PEAK_POWER.\n\n 3. Disable the NIRFSG_ATTR_IQ_SWAP_ENABLED attribute.\n\n 4. Disable the NIRFSG_ATTR_DIGITAL_EQUALIZATION_ENABLED attribute.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860\n\n **Defined Values**:\n ', + 'description': 'Specifies whether the nirfsg_WriteArbWaveform function immediately writes waveforms to the device or copies the waveform to host memory for later download. NI-RFSG reads and validates this attribute when an arbitrary waveform is first allocated.\n\nFor the PXI-5670, direct download is always disabled. For all other devices, direct download is always enabled.\n\nPXI-5671: To increase performance when using large waveforms, enable direct download. To maximize reconfigurability, disable direct download.\n\nPerform the following steps to enable direct download:\n\n1. Set the I/Q rate to less than or equal to 8.33MS/s with the NIRFSG_ATTR_IQ_RATE attribute.\n\n2. Set the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute to NIRFSG_VAL_PEAK_POWER.\n\n3. Disable the NIRFSG_ATTR_IQ_SWAP_ENABLED attribute.\n\n4. Disable the NIRFSG_ATTR_DIGITAL_EQUALIZATION_ENABLED attribute.\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_DISABLE', @@ -1548,7 +1548,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies how NI-RFSG interprets the value of the NIRFSG_ATTR_POWER_LEVEL attribute. The NIRFSG_ATTR_POWER_LEVEL_TYPE attribute also affects how waveforms are scaled.\n\n PXI-5670/5671: While in Script generation mode, if this attribute is set to NIRFSG_VAL_AVERAGE_POWER, NI-RFSG scales each waveform so that all waveforms have the same average power. The average power level of each waveform matches the value set with the NIRFSG_ATTR_POWER_LEVEL attribute. You can disable this scaling operation by setting the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute to NIRFSG_VAL_PEAK_POWER.\n\n PXIe-5644/5645/5646, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: While in Script generation mode, this attribute must be set to NIRFSG_VAL_PEAK_POWER.\n\n Converting from Average Power to Peak Power\n\n Typically, this attribute is set to NIRFSG_VAL_AVERAGE_POWER. However, some instrument modes require this attribute to be set to NIRFSG_VAL_PEAK_POWER. Use the following equations to calculate the equivalent peak power given the desired average power for your waveform:\n\n\n Where 1 is the highest possible magnitude in the waveform.\n\n\n\n **Default Value:**\n\n PXIe-5820: NIRFSG_VAL_PEAK_POWER\n\n All other devices: NIRFSG_VAL_AVERAGE_POWER\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Spurious Performance `_\n\n `Optimizing for Low Power Generation `_\n \n **High-Level Functions**:\n\n - nirfsg_ConfigurePowerLevelType \n \n **Defined Values**:\n ', + 'description': 'Specifies how NI-RFSG interprets the value of the NIRFSG_ATTR_POWER_LEVEL attribute. The NIRFSG_ATTR_POWER_LEVEL_TYPE attribute also affects how waveforms are scaled.\n\nPXI-5670/5671: While in Script generation mode, if this attribute is set to NIRFSG_VAL_AVERAGE_POWER, NI-RFSG scales each waveform so that all waveforms have the same average power. The average power level of each waveform matches the value set with the NIRFSG_ATTR_POWER_LEVEL attribute. You can disable this scaling operation by setting the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute to NIRFSG_VAL_PEAK_POWER.\n\nPXIe-5644/5645/5646, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: While in Script generation mode, this attribute must be set to NIRFSG_VAL_PEAK_POWER.\n\nConverting from Average Power to Peak Power\n\nTypically, this attribute is set to NIRFSG_VAL_AVERAGE_POWER. However, some instrument modes require this attribute to be set to NIRFSG_VAL_PEAK_POWER. Use the following equations to calculate the equivalent peak power given the desired average power for your waveform:\n\nWhere 1 is the highest possible magnitude in the waveform.\n\n**Default Value:**\n\nPXIe-5820: NIRFSG_VAL_PEAK_POWER\n\nAll other devices: NIRFSG_VAL_AVERAGE_POWER\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Spurious Performance `_\n\n`Optimizing for Low Power Generation `_\n\n**High-Level Functions**:\n\n- nirfsg_ConfigurePowerLevelType \n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_AVERAGE_POWER', @@ -1573,7 +1573,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Enables or disables digital pattern on the PXI-5421/5441 AWG module. This attribute must be set to VI_TRUE to enable signal routing to and from the Digital Data & Control connector.\n\n To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** VI_FALSE\n\n **Supported Devices:** PXI-5670/5671\n \n **Defined Values**:\n ', + 'description': 'Enables or disables digital pattern on the PXI-5421/5441 AWG module. This attribute must be set to VI_TRUE to enable signal routing to and from the Digital Data & Control connector.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** VI_FALSE\n\n**Supported Devices:** PXI-5670/5671\n\n**Defined Values**:', 'table_body': [ [ 'VI_TRUE', @@ -1597,7 +1597,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Enables and disables continuous streaming of waveform data.\n\n **Default Value:** VI_FALSE\n\n **Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Streaming `_\n \n **Defined Values**:\n ', + 'description': 'Enables and disables continuous streaming of waveform data.\n\n**Default Value:** VI_FALSE\n\n**Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Streaming `_\n\n**Defined Values**:', 'table_body': [ [ 'VI_TRUE', @@ -1621,7 +1621,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the name of the waveform used to continually stream data during generation.\n\n **Default Value:** "" (empty string)\n\n **Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Streaming `_\n\n `Streaming Waveform Data `_\n ' + 'description': 'Specifies the name of the waveform used to continually stream data during generation.\n\n**Default Value:** "" (empty string)\n\n**Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Streaming `_\n\n`Streaming Waveform Data `_' }, 'lv_property': 'Arb:Data Transfer:Streaming:Streaming Waveform Name', 'name': 'STREAMING_WAVEFORM_NAME', @@ -1631,7 +1631,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' 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.\n\n To read this attribute, the NI-RFSG device must be in the Committed state.\n\n **Units**: samples\n\n **Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Streaming `_\n ' + 'description': '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.\n\nTo read this attribute, the NI-RFSG device must be in the Committed state.\n\n**Units**: samples\n\n**Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Streaming `_' }, 'lv_property': 'Arb:Data Transfer:Streaming:Space Available In Streaming Waveform (Samples)', 'name': 'STREAMING_SPACE_AVAILABLE_IN_WAVEFORM', @@ -1641,7 +1641,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Indicates the number of samples to transfer at one time from the device to host memory. This attribute is useful when the total data to be transferred to onboard memory is large.\n\n **Units**: samples (s)\n\n **Default Value**: 1Ms\n\n **Supported Devices:** PXIe-5672/5673/5673E\n ' + 'description': 'Indicates the number of samples to transfer at one time from the device to host memory. This attribute is useful when the total data to be transferred to onboard memory is large.\n\n**Units**: samples (s)\n\n**Default Value**: 1Ms\n\n**Supported Devices:** PXIe-5672/5673/5673E' }, 'lv_property': 'Arb:Data Transfer:Data Transfer Block Size', 'name': 'DATA_TRANSFER_BLOCK_SIZE', @@ -1651,7 +1651,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies how much to scale the data before writing it with the nirfsg_WriteArbWaveform function. The resulting waveform must be smaller than 1.0 in complex magnitude. This attribute is supported only if you set the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute to NIRFSG_VAL_PEAK_POWER.\n\n **Default Value:** 1.0\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Spurious Performance `_\n ' + 'description': 'Specifies how much to scale the data before writing it with the nirfsg_WriteArbWaveform function. The resulting waveform must be smaller than 1.0 in complex magnitude. This attribute is supported only if you set the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute to NIRFSG_VAL_PEAK_POWER.\n\n**Default Value:** 1.0\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Spurious Performance `_' }, 'lv_property': 'Arb:Software Scaling Factor', 'name': 'ARB_WAVEFORM_SOFTWARE_SCALING_FACTOR', @@ -1661,37 +1661,32 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the destination terminal for exporting the Reference Clock on the RF signal generators. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Possible Values**:\n\nPossible Value: Description\n\n"" :The Reference Clock signal is not exported.\n\nRefOut :Exports the Reference Clock signal to the REF OUT connector of the device.\n\nRefOut2 :Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable.\n\nClkOut :Exports the Reference Clock signal to the CLK OUT connector of the device.\n\n **Default Value:** NIRFSG_VAL_DO_NOT_EXPORT_STR\n\n **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\n\n **Related Topics**\n\n `Interconnecting Multiple NI 5673E Modules `_\n ', - 'note': 'The NIRFSG_VAL_REF_OUT2_STR output terminal value is valid for only the PXIe-5650/5651/5652, not the PXI-5650/5651/5652.', + 'description': 'Specifies the destination terminal for exporting the Reference Clock on the RF signal generators. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Possible Values**:\n\nPossible Value: Description\n\n"" :The Reference Clock signal is not exported.\n\n"RefOut" :Exports the Reference Clock signal to the REF OUT connector of the device.\n\n"RefOut2" :Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable.\n\n"ClkOut" :Exports the Reference Clock signal to the CLK OUT connector of the device.\n\n**Default Value:** \'""\'\n\n**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\n\n**Related Topics**\n\n`Interconnecting Multiple NI 5673E Modules `_', + 'note': 'The RefOut2 output terminal value is valid for only the PXIe-5650/5651/5652, not the PXI-5650/5651/5652.', 'table_body': [ [ - 'NIRFSG_VAL_CLK_OUT_STR', - 'ClkOut', + '"ClkOut"', 'Exports the Reference Clock signal to the CLK OUT connector of the device.', 'Supported on PXIe-5673, 5673E' ], [ - 'NIRFSG_VAL_DO_NOT_EXPORT_STR', - 'empty', + '""', '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)' ], [ - 'NIRFSG_VAL_REF_OUT_STR', - 'RefOut', + '"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, ' ], [ - 'NIRFSG_VAL_REF_OUT2_STR', - 'RefOut2', + '"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' ] ], 'table_header': [ - 'Name', - 'Value', + 'Possible Value', 'Description', 'Supported devices' ] @@ -1704,98 +1699,98 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the source terminal for the Script Trigger. This attribute is used when the NIRFSG_ATTR_SCRIPT_TRIGGER_TYPE attribute is set to NIRFSG_VAL_DIGITAL_LEVEL. The NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_SOURCE attribute is not case-sensitive.\n\n To set the NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_SOURCE attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Script Trigger `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **Possible Values**:\n ', + 'description': 'Specifies the source terminal for the Script Trigger. This attribute is used when the NIRFSG_ATTR_SCRIPT_TRIGGER_TYPE attribute is set to NIRFSG_VAL_DIGITAL_LEVEL. The NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_SOURCE attribute is not case-sensitive.\n\nTo set the NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_SOURCE attribute, the NI-RFSG device must be in the Configuration state.\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Script Trigger `_\n\n`PFI Lines `_\n\n`PXI Trigger Lines `_\n\n**Possible Values**:', 'table_body': [ [ - 'PFI0', + '"PFI0"', 'The trigger is received on PFI 0.' ], [ - 'PFI1', + '"PFI1"', 'The trigger is received on PFI 1.' ], [ - 'PFI2', + '"PFI2"', 'The trigger is received on PFI 2.' ], [ - 'PFI3', + '"PFI3"', 'The trigger is received on PFI 3.' ], [ - 'PXI_Star', + '"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', + '"PXI_Trig0"', 'The trigger is received on PXI trigger line 0.' ], [ - 'PXI_Trig1', + '"PXI_Trig1"', 'The trigger is received on PXI trigger line 1.' ], [ - 'PXI_Trig2', + '"PXI_Trig2"', 'The trigger is received on PXI trigger line 2.' ], [ - 'PXI_Trig3', + '"PXI_Trig3"', 'The trigger is received on PXI trigger line 3.' ], [ - 'PXI_Trig4', + '"PXI_Trig4"', 'The trigger is received on PXI trigger line 4.' ], [ - 'PXI_Trig5', + '"PXI_Trig5"', 'The trigger is received on PXI trigger line 5.' ], [ - 'PXI_Trig6', + '"PXI_Trig6"', 'The trigger is received on PXI trigger line 6.' ], [ - 'PXI_Trig7', + '"PXI_Trig7"', 'The trigger is received on PXI trigger line 7.' ], [ - 'PXIe_DStarB', + '"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', + '"PulseIn"', 'The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842.' ], [ - 'DIO/PFI0', + '"DIO/PFI0"', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'DIO/PFI1', + '"DIO/PFI1"', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'DIO/PFI2', + '"DIO/PFI2"', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'DIO/PFI3', + '"DIO/PFI3"', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'DIO/PFI4', + '"DIO/PFI4"', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'DIO/PFI5', + '"DIO/PFI5"', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'DIO/PFI6', + '"DIO/PFI6"', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'DIO/PFI7', + '"DIO/PFI7"', 'The trigger is received on PFI7 from the front panel DIO terminal.' ] ], @@ -1815,7 +1810,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the active level for the Script Trigger. This attribute is used when the NIRFSG_ATTR_SCRIPT_TRIGGER_TYPE attribute is set to NIRFSG_VAL_DIGITAL_LEVEL.\n\n **Default Value:** NIRFSG_VAL_ACTIVE_HIGH\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n\n\n **Related Topics**\n\n `Script Trigger `_\n\n `Digital Level Trigger `_\n \n **Defined Values**:\n ', + 'description': 'Specifies the active level for the Script Trigger. This attribute is used when the NIRFSG_ATTR_SCRIPT_TRIGGER_TYPE attribute is set to NIRFSG_VAL_DIGITAL_LEVEL.\n\n**Default Value:** NIRFSG_VAL_ACTIVE_HIGH\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Script Trigger `_\n\n`Digital Level Trigger `_\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_ACTIVE_HIGH', @@ -1846,7 +1841,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the pulse-shaping filter type for the FIR filter. You can use this attribute only with signal generators that support onboard signal processing (OSP). NI-RFSG returns an error if you use this attribute with a device that does not support OSP.\n\n **Default Value:** NIRFSG_VAL_NONE\n\n **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E\n\n **Defined Values**:\n ', + 'description': 'Specifies the pulse-shaping filter type for the FIR filter. You can use this attribute only with signal generators that support onboard signal processing (OSP). NI-RFSG returns an error if you use this attribute with a device that does not support OSP.\n\n**Default Value:** NIRFSG_VAL_NONE\n\n**Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_NONE', @@ -1879,7 +1874,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the alpha value to use when calculating the pulse-shaping FIR filter coefficients. You can use this attribute only when the NIRFSG_ATTR_ARB_FILTER_TYPE attribute is set to NIRFSG_VAL_ARB_FILTER_TYPE_ROOT_RAISED_COSINE and with signal generators that support onboard signal processing (OSP). NI-RFSG returns an error if you use this attribute with a device that does not support OSP.\n\n **Supported Devices:** PXI-5671, PXIe-5672/5673/5673E\n ' + 'description': 'Specifies the alpha value to use when calculating the pulse-shaping FIR filter coefficients. You can use this attribute only when the NIRFSG_ATTR_ARB_FILTER_TYPE attribute is set to NIRFSG_VAL_ARB_FILTER_TYPE_ROOT_RAISED_COSINE and with signal generators that support onboard signal processing (OSP). NI-RFSG returns an error if you use this attribute with a device that does not support OSP.\n\n**Supported Devices:** PXI-5671, PXIe-5672/5673/5673E' }, 'lv_property': 'Arb:Pulse Shaping:Root Raised Cosine Alpha', 'name': 'ARB_FILTER_ROOT_RAISED_COSINE_ALPHA', @@ -1889,7 +1884,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the alpha value to use when calculating the pulse-shaping filter coefficients. You can use this attribute only when the NIRFSG_ATTR_ARB_FILTER_TYPE attribute is set to NIRFSG_VAL_ARB_FILTER_TYPE_RAISED_COSINE and with signal generators that support onboard signal processing (OSP). NI-RFSG returns an error if you use this attribute with a device that does not support OSP.\n\n **Supported Devices:** PXI-5671, PXIe-5672/5673/5673E\n ' + 'description': 'Specifies the alpha value to use when calculating the pulse-shaping filter coefficients. You can use this attribute only when the NIRFSG_ATTR_ARB_FILTER_TYPE attribute is set to NIRFSG_VAL_ARB_FILTER_TYPE_RAISED_COSINE and with signal generators that support onboard signal processing (OSP). NI-RFSG returns an error if you use this attribute with a device that does not support OSP.\n\n**Supported Devices:** PXI-5671, PXIe-5672/5673/5673E' }, 'lv_property': 'Arb:Pulse Shaping:Raised Cosine Alpha', 'name': 'ARB_FILTER_RAISED_COSINE_ALPHA', @@ -1899,7 +1894,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' The total amount of memory on the signal generator in bytes.\n\n **Units:** bytes\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Memory Options `_\n\n `Phase Continuity `_\n ', + 'description': 'The total amount of memory on the signal generator in bytes.\n\n**Units:** bytes\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Memory Options `_\n\n`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.' }, 'lv_property': 'Arb:Memory Size', @@ -1910,7 +1905,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the `deviation `_ to use in phase modulation, in degrees.\n\n **Units**: degrees (°)\n\n **Default Value:** 90°\n\n **Supported Devices:** PXI/PXIe-5650/5651/5652, PXIe-5653\n\n **Related Topics**\n\n `Modulation Schemes `_\n ' + 'description': 'Specifies the `deviation `_ to use in phase modulation, in degrees.\n\n**Units**: degrees (°)\n\n**Default Value:** 90°\n\n**Supported Devices:** PXI/PXIe-5650/5651/5652, PXIe-5653\n\n**Related Topics**\n\n`Modulation Schemes `_' }, 'lv_property': 'Modulation:Analog:PM Deviation (Degrees)', 'name': 'ANALOG_MODULATION_PM_DEVIATION', @@ -1920,90 +1915,90 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the destination terminal for exporting the Done event. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Triggers `_\n\n `Events `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **High-Level Functions**:\n\n - nirfsg_ExportSignal\n \n **Possible Values**:\n ', + 'description': 'Specifies the destination terminal for exporting the Done event. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_\n\n`Events `_\n\n`PFI Lines `_\n\n`PXI Trigger Lines `_\n\n**High-Level Functions**:\n\n- nirfsg_ExportSignal\n\n**Possible Values**:', 'table_body': [ [ - 'empty', + '""', 'The signal is not exported.' ], [ - 'PFI0', + '"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', + '"PFI1"', 'The signal is exported to the PFI 1 connector.' ], [ - 'PFI4', + '"PFI4"', 'The signal is exported to the PFI 4 connector.' ], [ - 'PFI5', + '"PFI5"', 'The signal is exported to the PFI 5 connector.' ], [ - 'PXI_Trig0', + '"PXI_Trig0"', 'The trigger is received on PXI trigger line 0.' ], [ - 'PXI_Trig1', + '"PXI_Trig1"', 'The trigger is received on PXI trigger line 1.' ], [ - 'PXI_Trig2', + '"PXI_Trig2"', 'The trigger is received on PXI trigger line 2.' ], [ - 'PXI_Trig3', + '"PXI_Trig3"', 'The trigger is received on PXI trigger line 3.' ], [ - 'PXI_Trig4', + '"PXI_Trig4"', 'The trigger is received on PXI trigger line 4.' ], [ - 'PXI_Trig5', + '"PXI_Trig5"', 'The trigger is received on PXI trigger line 5.' ], [ - 'PXI_Trig6', + '"PXI_Trig6"', 'The trigger is received on PXI trigger line 6.' ], [ - 'PXIe_DStarC', + '"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', + '"DIO/PFI0"', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'DIO/PFI1', + '"DIO/PFI1"', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'DIO/PFI2', + '"DIO/PFI2"', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'DIO/PFI3', + '"DIO/PFI3"', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'DIO/PFI4', + '"DIO/PFI4"', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'DIO/PFI5', + '"DIO/PFI5"', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'DIO/PFI6', + '"DIO/PFI6"', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'DIO/PFI7', + '"DIO/PFI7"', 'The trigger is received on PFI7 from the front panel DIO terminal.' ] ], @@ -2020,90 +2015,90 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the destination terminal for exporting the Marker Event. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Marker Events `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **High-Level Functions**:\n\n - nirfsg_ExportSignal\n \n **Possible Values**:\n ', + 'description': 'Specifies the destination terminal for exporting the Marker Event. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Marker Events `_\n\n`PFI Lines `_\n\n`PXI Trigger Lines `_\n\n**High-Level Functions**:\n\n- nirfsg_ExportSignal\n\n**Possible Values**:', 'table_body': [ [ - 'empty', + '""', 'The signal is not exported.' ], [ - 'PFI0', + '"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', + '"PFI1"', 'The signal is exported to the PFI 1 connector.' ], [ - 'PFI4', + '"PFI4"', 'The signal is exported to the PFI 4 connector.' ], [ - 'PFI5', + '"PFI5"', 'The signal is exported to the PFI 5 connector.' ], [ - 'PXI_Trig0', + '"PXI_Trig0"', 'The trigger is received on PXI trigger line 0.' ], [ - 'PXI_Trig1', + '"PXI_Trig1"', 'The trigger is received on PXI trigger line 1.' ], [ - 'PXI_Trig2', + '"PXI_Trig2"', 'The trigger is received on PXI trigger line 2.' ], [ - 'PXI_Trig3', + '"PXI_Trig3"', 'The trigger is received on PXI trigger line 3.' ], [ - 'PXI_Trig4', + '"PXI_Trig4"', 'The trigger is received on PXI trigger line 4.' ], [ - 'PXI_Trig5', + '"PXI_Trig5"', 'The trigger is received on PXI trigger line 5.' ], [ - 'PXI_Trig6', + '"PXI_Trig6"', 'The trigger is received on PXI trigger line 6.' ], [ - 'PXIe_DStarC', + '"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', + '"DIO/PFI0"', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'DIO/PFI1', + '"DIO/PFI1"', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'DIO/PFI2', + '"DIO/PFI2"', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'DIO/PFI3', + '"DIO/PFI3"', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'DIO/PFI4', + '"DIO/PFI4"', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'DIO/PFI5', + '"DIO/PFI5"', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'DIO/PFI6', + '"DIO/PFI6"', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'DIO/PFI7', + '"DIO/PFI7"', 'The trigger is received on PFI7 from the front panel DIO terminal.' ] ], @@ -2124,90 +2119,90 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the destination terminal for exporting the Started event. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Events `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n \n **High-Level Functions**:\n\n - nirfsg_ExportSignal\n \n **Possible Values**:\n ', + 'description': 'Specifies the destination terminal for exporting the Started event. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Events `_\n\n`PFI Lines `_\n\n`PXI Trigger Lines `_\n\n**High-Level Functions**:\n\n- nirfsg_ExportSignal\n\n**Possible Values**:', 'table_body': [ [ - 'empty', + '""', 'The signal is not exported.' ], [ - 'PFI0', + '"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', + '"PFI1"', 'The signal is exported to the PFI 1 connector.' ], [ - 'PFI4', + '"PFI4"', 'The signal is exported to the PFI 4 connector.' ], [ - 'PFI5', + '"PFI5"', 'The signal is exported to the PFI 5 connector.' ], [ - 'PXI_Trig0', + '"PXI_Trig0"', 'The trigger is received on PXI trigger line 0.' ], [ - 'PXI_Trig1', + '"PXI_Trig1"', 'The trigger is received on PXI trigger line 1.' ], [ - 'PXI_Trig2', + '"PXI_Trig2"', 'The trigger is received on PXI trigger line 2.' ], [ - 'PXI_Trig3', + '"PXI_Trig3"', 'The trigger is received on PXI trigger line 3.' ], [ - 'PXI_Trig4', + '"PXI_Trig4"', 'The trigger is received on PXI trigger line 4.' ], [ - 'PXI_Trig5', + '"PXI_Trig5"', 'The trigger is received on PXI trigger line 5.' ], [ - 'PXI_Trig6', + '"PXI_Trig6"', 'The trigger is received on PXI trigger line 6.' ], [ - 'PXIe_DStarC', + '"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', + '"DIO/PFI0"', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'DIO/PFI1', + '"DIO/PFI1"', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'DIO/PFI2', + '"DIO/PFI2"', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'DIO/PFI3', + '"DIO/PFI3"', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'DIO/PFI4', + '"DIO/PFI4"', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'DIO/PFI5', + '"DIO/PFI5"', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'DIO/PFI6', + '"DIO/PFI6"', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'DIO/PFI7', + '"DIO/PFI7"', 'The trigger is received on PFI7 from the front panel DIO terminal.' ] ], @@ -2224,7 +2219,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the power level of the signal at the LO OUT front panel connector.\n\n To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg_SetAttributeViReal64 function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string).\n\n **Units**: dBm\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `LO OUT `_\n ', + 'description': 'Specifies the power level of the signal at the LO OUT front panel connector.\n\nTo use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg_SetAttributeViReal64 function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string).\n\n**Units**: dBm\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`LO OUT `_', 'note': 'For the PXIe-5644/5645/5646 and PXIe-5673/5673E, this attribute is always read-only.' }, 'lv_property': 'RF:LO Out Power (dBm)', @@ -2235,7 +2230,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the power level of the signal at the LO IN front panel connector.\n\n To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg_SetAttributeViReal64 function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string).\n\n **Units**: dBm\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `LO OUT `_\n ', + 'description': 'Specifies the power level of the signal at the LO IN front panel connector.\n\nTo use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg_SetAttributeViReal64 function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string).\n\n**Units**: dBm\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`LO OUT `_', 'note': '- This attribute is read/write if you are using an external LO. Otherwise, this attribute is read-only.\n\n - For the PXIe-5644/5645/5646, this attribute is always read-only.' }, 'lv_property': 'RF:LO In Power (dBm)', @@ -2246,7 +2241,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the AWG module temperature in degrees Celsius.\n\n PXIe-5820/5840/5841/5842: If you query this attribute during RF list mode, list steps may take longer to complete during list execution.\n\n **Units**: degrees Celsius (°C)\n\n **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860\n ' + 'description': 'Returns the AWG module temperature in degrees Celsius.\n\nPXIe-5820/5840/5841/5842: If you query this attribute during RF list mode, list steps may take longer to complete during list execution.\n\n**Units**: degrees Celsius (°C)\n\n**Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860' }, 'lv_property': 'Device Characteristics:AWG Temperature (Degrees C)', 'name': 'ARB_TEMPERATURE', @@ -2256,7 +2251,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Enables or disables I/Q impairment. The NIRFSG_ATTR_IQ_I_OFFSET, NIRFSG_ATTR_IQ_Q_OFFSET, NIRFSG_ATTR_IQ_GAIN_IMBALANCE, and NIRFSG_ATTR_IQ_SKEW attributes are ignored when the NIRFSG_ATTR_IQ_IMPAIRMENT_ENABLED attribute is disabled.\n\n **Default Value:** VI_TRUE\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n \n **Defined Values**:\n ', + 'description': 'Enables or disables I/Q impairment. The NIRFSG_ATTR_IQ_I_OFFSET, NIRFSG_ATTR_IQ_Q_OFFSET, NIRFSG_ATTR_IQ_GAIN_IMBALANCE, and NIRFSG_ATTR_IQ_SKEW attributes are ignored when the NIRFSG_ATTR_IQ_IMPAIRMENT_ENABLED attribute is disabled.\n\n**Default Value:** VI_TRUE\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Defined Values**:', 'table_body': [ [ 'VI_TRUE', @@ -2280,7 +2275,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' When using a National Instruments AWG module or vector signal transceiver (VST), this attribute specifies the I-signal DC offset. Units are either percent (%) or volts (V), depending on the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute setting.\n\n PXIe-5673/5673E: Actual AWG signal offset is equal to the I/Q modulator offset correction plus the value specified by this attribute. When using an external AWG (non–National Instruments AWG), this attribute is read-only and indicates the I/Q modulator I-offset. Units are volts, as specified by the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute.\n\n **Valid Values:**-100 to 100% or -0.2V to 0.2V\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Impairment Calibration `_\n ' + 'description': 'When using a National Instruments AWG module or vector signal transceiver (VST), this attribute specifies the I-signal DC offset. Units are either percent (%) or volts (V), depending on the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute setting.\n\nPXIe-5673/5673E: Actual AWG signal offset is equal to the I/Q modulator offset correction plus the value specified by this attribute. When using an external AWG (non–National Instruments AWG), this attribute is read-only and indicates the I/Q modulator I-offset. Units are volts, as specified by the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute.\n\n**Valid Values:**-100 to 100% or -0.2V to 0.2V\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Impairment Calibration `_' }, 'lv_property': 'IQ Impairment:I Offset', 'name': 'IQ_I_OFFSET', @@ -2290,7 +2285,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' When using a National Instruments AWG module or VST device, this attribute specifies the Q-signal DC offset. Units are either percent (%) or volts (V), depending on the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute setting.\n\n PXIe-5673/5673E: Actual AWG signal offset is equal to the I/Q modulator offset correction plus the value specified by this attribute. When using an external AWG (non–National Instruments AWG), the NIRFSG_ATTR_IQ_Q_OFFSET attribute is read-only and indicates the I/Q modulator Q-offset. Units are volts, as indicated by the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute.\n\n **Valid Values**: -100% to 100% or -0.2V to 0.2V\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Impairment Calibration `_\n ' + 'description': 'When using a National Instruments AWG module or VST device, this attribute specifies the Q-signal DC offset. Units are either percent (%) or volts (V), depending on the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute setting.\nPXIe-5673/5673E: Actual AWG signal offset is equal to the I/Q modulator offset correction plus the value specified by this attribute. When using an external AWG (non–National Instruments AWG), the NIRFSG_ATTR_IQ_Q_OFFSET attribute is read-only and indicates the I/Q modulator Q-offset. Units are volts, as indicated by the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute.\n**Valid Values**: -100% to 100% or -0.2V to 0.2V\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n**Related Topics**\n`Impairment Calibration `_' }, 'lv_property': 'IQ Impairment:Q Offset', 'name': 'IQ_Q_OFFSET', @@ -2300,7 +2295,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the gain imbalance of the I/Q modulator (I versus Q).\n\n Gain imbalance is calculated with the following equation:\n\n\n **Units**: dB\n\n **Valid Values:**-6dB to 6dB\n\n **Default Value:** 0dB\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Impairment Calibration `_\n\n `Spurious Performance `_\n ' + 'description': 'Specifies the gain imbalance of the I/Q modulator (I versus Q).\n\nGain imbalance is calculated with the following equation:\n\n**Units**: dB\n\n**Valid Values:**-6dB to 6dB\n\n**Default Value:** 0dB\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Impairment Calibration `_\n\n`Spurious Performance `_' }, 'lv_property': 'IQ Impairment:Gain Imbalance (dB)', 'name': 'IQ_GAIN_IMBALANCE', @@ -2310,7 +2305,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the adjustment of the phase angle between the I and Q vectors. If the skew is zero, the phase angle is 90 degrees.\n\n This attribute is ignored when the NIRFSG_ATTR_IQ_IMPAIRMENT_ENABLED attribute is disabled.\n\n **Units**: degrees (°)\n\n **Valid Values:**-30° to 30°\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Impairment Calibration `_\n ' + 'description': 'Specifies the adjustment of the phase angle between the I and Q vectors. If the skew is zero, the phase angle is 90 degrees.\n\nThis attribute is ignored when the NIRFSG_ATTR_IQ_IMPAIRMENT_ENABLED attribute is disabled.\n\n**Units**: degrees (°)\n\n**Valid Values:**-30° to 30°\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Impairment Calibration `_' }, 'lv_property': 'IQ Impairment:IQ Skew (Degrees)', 'name': 'IQ_SKEW', @@ -2320,7 +2315,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the LO module temperature in degrees Celsius.\n\n PXIe-5840/5841: If you query this attribute during RF list mode, list steps may take longer to complete during list execution.\n\n **Units**: degrees Celsius (°C)\n\n **Supported Devices:** PXIe-5673/5673E, PXIe-5840/5841/5842\n ' + 'description': 'Returns the LO module temperature in degrees Celsius.\n\nPXIe-5840/5841: If you query this attribute during RF list mode, list steps may take longer to complete during list execution.\n\n**Units**: degrees Celsius (°C)\n\n**Supported Devices:** PXIe-5673/5673E, PXIe-5840/5841/5842' }, 'lv_property': 'Device Characteristics:LO Temperature (Degrees C)', 'name': 'LO_TEMPERATURE', @@ -2330,7 +2325,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the recommended interval between each external calibration of the device.\n\n **Units**: months\n\n **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\n ' + 'description': 'Returns the recommended interval between each external calibration of the device.\n\n**Units**: months\n\n**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' }, 'lv_property': 'External Calibration:Recommended Interval', 'name': 'EXTERNAL_CALIBRATION_RECOMMENDED_INTERVAL', @@ -2340,7 +2335,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the temperature of the device at the time of the last external calibration.\n\n **Units**: degrees Celsius (°C)\n\n **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\n ' + 'description': 'Returns the temperature of the device at the time of the last external calibration.\n\n**Units**: degrees Celsius (°C)\n\n**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' }, 'lv_property': 'External Calibration:Last External Calibration Temperature', 'name': 'EXTERNAL_CALIBRATION_TEMPERATURE', @@ -2350,7 +2345,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the units of the NIRFSG_ATTR_IQ_I_OFFSET attribute and NIRFSG_ATTR_IQ_Q_OFFSET attribute. Offset units are either percent or volts.\n\n The AWG or VST offset is the specified percentage of the AWG or VST peak power level when the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute is set to NIRFSG_VAL_PERCENT. Given perfect carrier leakage suppression, the following equation is satisfied\n \n\n or equivalently\n\n\n If the NIRFSG_ATTR_IQ_I_OFFSET attribute is set to 100%, NIRFSG_ATTR_IQ_Q_OFFSET attribute is set to 0%, and NIRFSG_ATTR_POWER_LEVEL attribute set to 0 dBm, the desired RF signal is at 0 dBm and the carrier leakage is also at 0 dBm.\n\n The AWG or VST peak power level changes when settings change in other attributes such as the NIRFSG_ATTR_POWER_LEVEL, NIRFSG_ATTR_FREQUENCY, NIRFSG_ATTR_IQ_SKEW, NIRFSG_ATTR_IQ_GAIN_IMBALANCE, NIRFSG_ATTR_ATTENUATOR_HOLD_ENABLED, and NIRFSG_ATTR_ARB_PRE_FILTER_GAIN attributes. When the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute is set to NIRFSG_VAL_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_ATTR_IQ_OFFSET_UNITS attribute is set to NIRFSG_VAL_PERCENT, the carrier leakage, in dBc, remains at a consistent level.\n\n If you are trying to eliminate residual carrier leakage due to calibration inaccuracies or drift, set the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute to NIRFSG_VAL_VOLTS. Offset correction voltage is applied to the I/Q modulator or VST, regardless of changes to the AWG or VST peak power level.\n\n **Default Value**: NIRFSG_VAL_PERCENT\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n \n **Defined Values**:\n ', + 'description': 'Specifies the units of the NIRFSG_ATTR_IQ_I_OFFSET attribute and NIRFSG_ATTR_IQ_Q_OFFSET attribute. Offset units are either percent or volts.\n\nThe AWG or VST offset is the specified percentage of the AWG or VST peak power level when the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute is set to NIRFSG_VAL_PERCENT. Given perfect carrier leakage suppression, the following equation is satisfied\n\n\nor equivalently\n\nIf the NIRFSG_ATTR_IQ_I_OFFSET attribute is set to 100%, NIRFSG_ATTR_IQ_Q_OFFSET attribute is set to 0%, and NIRFSG_ATTR_POWER_LEVEL attribute set to 0 dBm, the desired RF signal is at 0 dBm and the carrier leakage is also at 0 dBm.\n\nThe AWG or VST peak power level changes when settings change in other attributes such as the NIRFSG_ATTR_POWER_LEVEL, NIRFSG_ATTR_FREQUENCY, NIRFSG_ATTR_IQ_SKEW, NIRFSG_ATTR_IQ_GAIN_IMBALANCE, NIRFSG_ATTR_ATTENUATOR_HOLD_ENABLED, and NIRFSG_ATTR_ARB_PRE_FILTER_GAIN attributes. When the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute is set to NIRFSG_VAL_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_ATTR_IQ_OFFSET_UNITS attribute is set to NIRFSG_VAL_PERCENT, the carrier leakage, in dBc, remains at a consistent level.\n\nIf you are trying to eliminate residual carrier leakage due to calibration inaccuracies or drift, set the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute to NIRFSG_VAL_VOLTS. Offset correction voltage is applied to the I/Q modulator or VST, regardless of changes to the AWG or VST peak power level.\n\n**Default Value**: NIRFSG_VAL_PERCENT\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Defined Values**:', 'note': 'For any devices except PXIe-5820, if the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute is set to NIRFSG_VAL_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.', 'table_body': [ [ @@ -2376,7 +2371,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the interpretation of the value passed to the NIRFSG_ATTR_FREQUENCY_SETTLING attribute.\n\n PXIe-5650/5651/5652/5653, PXIe-5673E: When the NIRFSG_ATTR_ACTIVE_CONFIGURATION_LIST attribute is set to a valid list name, the NIRFSG_ATTR_FREQUENCY_SETTLING_UNITS attribute supports only NIRFSG_VAL_TIME_AFTER_IO as a valid value.\n\n PXIe-5654/5654 with PXIe-5696: The NIRFSG_ATTR_FREQUENCY_SETTLING_UNITS attribute supports only NIRFSG_VAL_TIME_AFTER_IO and NIRFSG_VAL_PPM as valid values.\n\n **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\n\n **Default Value**: NIRFSG_VAL_PPM\n\n **Related Topics**\n\n `Events `_\n\n **Defined Values**:\n ', + 'description': 'Specifies the interpretation of the value passed to the NIRFSG_ATTR_FREQUENCY_SETTLING attribute.\n\nPXIe-5650/5651/5652/5653, PXIe-5673E: When the NIRFSG_ATTR_ACTIVE_CONFIGURATION_LIST attribute is set to a valid list name, the NIRFSG_ATTR_FREQUENCY_SETTLING_UNITS attribute supports only NIRFSG_VAL_TIME_AFTER_IO as a valid value.\n\nPXIe-5654/5654 with PXIe-5696: The NIRFSG_ATTR_FREQUENCY_SETTLING_UNITS attribute supports only NIRFSG_VAL_TIME_AFTER_IO and NIRFSG_VAL_PPM as valid values.\n\n**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\n\n**Default Value**: NIRFSG_VAL_PPM\n\n**Related Topics**\n\n`Events `_\n\n**Defined Values**:', 'note': 'If you set this attribute to NIRFSG_VAL_TIME_AFTER_IO, the definition of settled for the Configuration Settled event changes.', 'table_body': [ [ @@ -2407,7 +2402,7 @@ 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the frequency settling time. Interpretation of this value depends on the NIRFSG_ATTR_FREQUENCY_SETTLING_UNITS attribute.\n\n **Valid Values:**\n\n The valid values for this attribute depend on the NIRFSG_ATTR_FREQUENCY_SETTLING_UNITS attribute.\n\n \n\n\n **Default Value**: 1.0\n\n **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\n\n **Related Topics**\n\n `Settling Times `_\n\n `Events `_\n ' + 'description': 'Specifies the frequency settling time. Interpretation of this value depends on the NIRFSG_ATTR_FREQUENCY_SETTLING_UNITS attribute.\n\n**Valid Values:**\n\nThe valid values for this attribute depend on the NIRFSG_ATTR_FREQUENCY_SETTLING_UNITS attribute.\n\n\n\n**Default Value**: 1.0\n\n**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\n\n**Related Topics**\n\n`Settling Times `_\n\n`Events `_' }, 'lv_property': 'RF:Frequency Settling', 'name': 'FREQUENCY_SETTLING', @@ -2418,7 +2413,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the module revision letter. If the NI-RFSG session is controlling multiple modules, this attribute returns the revision letter of the primary RF module. The NI-RFSG session is opened using the primary RF device name.\n\n **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\n\n **Related Topics**\n\n `Identifying Module Revision `_\n ' + 'description': 'Returns the module revision letter. If the NI-RFSG session is controlling multiple modules, this attribute returns the revision letter of the primary RF module. The NI-RFSG session is opened using the primary RF device name.\n\n**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\n\n**Related Topics**\n\n`Identifying Module Revision `_' }, 'lv_property': 'Device Characteristics:Module Revision', 'name': 'MODULE_REVISION', @@ -2428,7 +2423,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the external amplification or attenuation, if any, between the RF signal generator and the device under test.\n\n Positive values for this attribute represent amplification, and negative values for this attribute represent attenuation.\n\n **Valid Values:** -INF dB to +INF dB\n\n **Default Value:** 0dB\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5654/5654 with PXIe-5696, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ', + 'description': 'Specifies the external amplification or attenuation, if any, between the RF signal generator and the device under test.\n\nPositive values for this attribute represent amplification, and negative values for this attribute represent attenuation.\n\n**Valid Values:** -INF dB to +INF dB\n\n**Default Value:** 0dB\n\n**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 attribute adjusts the actual device output power to compensate for any amplification or attenuation between the RF signal generator and the device under test.\n\n - For the PXIe-5645, this attribute is ignored if you are using the I/Q ports.' }, 'lv_property': 'RF:External Gain (dB)', @@ -2439,7 +2434,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the maximum amount of bus bandwidth to use for data transfers.\n\n **Units**: bytes per second\n\n **Default Value**: Device maximum\n\n **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E\n\n **Related Topics**\n\n `Improving Streaming Performance `_\n ' + 'description': 'Specifies the maximum amount of bus bandwidth to use for data transfers.\n\n**Units**: bytes per second\n\n**Default Value**: Device maximum\n\n**Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E\n\n**Related Topics**\n\n`Improving Streaming Performance `_' }, 'lv_property': 'Arb:Data Transfer:Maximum Bandwidth', 'name': 'DATA_TRANSFER_MAXIMUM_BANDWIDTH', @@ -2449,7 +2444,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the preferred size of the data field in a PCI Express read request packet.\n\n In general, the larger the packet size, the more efficiently the device uses the bus. By default, NI RF signal generators use the largest packet size allowed by the system. However, due to different system implementations, some systems may perform better with smaller packet sizes.\n\n Recommended values for this attribute are powers of two between 64 and 512.\n\n **Units**: bytes\n\n **Default Value**: Device maximum\n\n **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E\n\n **Related Topics**\n\n `Improving Streaming Performance `_\n ', + 'description': 'Specifies the preferred size of the data field in a PCI Express read request packet.\n\nIn general, the larger the packet size, the more efficiently the device uses the bus. By default, NI RF signal generators use the largest packet size allowed by the system. However, due to different system implementations, some systems may perform better with smaller packet sizes.\n\nRecommended values for this attribute are powers of two between 64 and 512.\n\n**Units**: bytes\n\n**Default Value**: Device maximum\n\n**Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E\n\n**Related Topics**\n\n`Improving Streaming Performance `_', 'note': 'In some cases, the RF signal generator generates packets smaller than the preferred size you set with this attribute.' }, 'lv_property': 'Arb:Data Transfer:Advanced:Preferred Packet Size', @@ -2460,7 +2455,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the maximum number of concurrent PCI Express read requests the RF signal generator can issue.\n\n When transferring data from computer memory to device onboard memory across the PCI Express bus, the signal generator can issue multiple memory reads at the same time. In general, the larger the number of read requests, the more efficiently the device uses the bus because the multiple read requests keep the data flowing, even in a PCI Express topology that has high latency due to PCI Express switches in the data path. Most NI devices can issue a large number of read requests (typically 8 or 16). By default, this attribute is set to the highest value the RF signal generator supports.\n\n If other devices in your system cannot tolerate long data latencies, it may be helpful to decrease the number of in-flight read requests the RF signal generator issues. This helps to reduce the amount of data the signal generator reads at one time.\n\n **Units**: number of packets\n\n **Default Value**: Device maximum\n\n **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E\n\n **Related Topics**\n\n `Improving Streaming Performance `_\n ' + 'description': 'Specifies the maximum number of concurrent PCI Express read requests the RF signal generator can issue.\n\nWhen transferring data from computer memory to device onboard memory across the PCI Express bus, the signal generator can issue multiple memory reads at the same time. In general, the larger the number of read requests, the more efficiently the device uses the bus because the multiple read requests keep the data flowing, even in a PCI Express topology that has high latency due to PCI Express switches in the data path. Most NI devices can issue a large number of read requests (typically 8 or 16). By default, this attribute is set to the highest value the RF signal generator supports.\n\nIf other devices in your system cannot tolerate long data latencies, it may be helpful to decrease the number of in-flight read requests the RF signal generator issues. This helps to reduce the amount of data the signal generator reads at one time.\n\n**Units**: number of packets\n\n**Default Value**: Device maximum\n\n**Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E\n\n**Related Topics**\n\n`Improving Streaming Performance `_' }, 'lv_property': 'Arb:Data Transfer:Advanced:Maximum In-Flight Read Requests', 'name': 'DATA_TRANSFER_MAXIMUM_IN_FLIGHT_READS', @@ -2470,7 +2465,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': " Specifies the oscillator phase digital-to-analog converter (DAC) value on the arbitrary waveform generator (AWG). Use this attribute to reduce the trigger jitter when synchronizing multiple devices with NI-TClk. This attribute can also help maintain synchronization repeatability by writing a previous measurement's phase DAC value to the current session. This attribute is applicable only when using the NIRFSG_ATTR_ARB_SAMPLE_CLOCK_SOURCE attribute set to NIRFSG_VAL_CLK_IN_STR.\n\n **Supported Devices:** PXIe-5673/5673E\n\n **Related Topics**\n\n `NI-TClk Overview `_\n " + 'description': "Specifies the oscillator phase digital-to-analog converter (DAC) value on the arbitrary waveform generator (AWG). Use this attribute to reduce the trigger jitter when synchronizing multiple devices with NI-TClk. This attribute can also help maintain synchronization repeatability by writing a previous measurement's phase DAC value to the current session. This attribute is applicable only when using the NIRFSG_ATTR_ARB_SAMPLE_CLOCK_SOURCE attribute set to ClkIn.\n\n**Supported Devices:** PXIe-5673/5673E\n\n**Related Topics**\n\n`NI-TClk Overview `_" }, 'lv_property': 'Clock:Advanced:Arb Oscillator Phase DAC Value', 'name': 'ARB_OSCILLATOR_PHASE_DAC_VALUE', @@ -2481,7 +2476,7 @@ 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', 'codegen_method': 'public', 'documentation': { - 'description': ' 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.\n\n **Units**: seconds (s)\n\n **Default Value:** 0\n\n **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\n\n **Related Topics**\n\n `Events `_\n ', + 'description': '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.\n\n**Units**: seconds (s)\n\n**Default Value:** 0\n\n**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\n\n**Related Topics**\n\n`Events `_', 'note': 'For the PXIe-5820/5840/5841/5842/5860, this attribute must be set for the timer to start. If you do not set this attribute, the timer is disabled.' }, 'lv_property': 'Events:Timer:Interval', @@ -2493,7 +2488,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the temperature, in degrees Celsius, to use for adjusting the device settings to correct for temperature changes. If you set this attribute, NI-RFSG uses the value you specify and therefore no longer uses the actual device temperature as the correction temperature. If you do not set this attribute, NI-RFSG checks the current device temperature in the Committed state and automatically sets the value of this attribute.\n\n PXIe-5820/5830/5831/5832/5840/5841/5842/5860: This attribute is read only.\n\n **Units**: Degrees Celsius\n\n **Supported Devices**: PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ', + 'description': 'Specifies the temperature, in degrees Celsius, to use for adjusting the device settings to correct for temperature changes. If you set this attribute, NI-RFSG uses the value you specify and therefore no longer uses the actual device temperature as the correction temperature. If you do not set this attribute, NI-RFSG checks the current device temperature in the Committed state and automatically sets the value of this attribute.\n\nPXIe-5820/5830/5831/5832/5840/5841/5842/5860: This attribute is read only.\n\n**Units**: Degrees Celsius\n\n**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 attribute reverts back to the default unset behavior.\n\n - Use this attribute only when your application requires the same settings to be used every time, regardless of the temperature variation. In these cases, it is best to ensure that the temperature does not vary too much.' }, 'lv_property': 'RF:Advanced:Correction Temperature', @@ -2504,7 +2499,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the name of the fully qualified signal name as a string.\n\n **Default Values**:\n\n PXI-5670/5671, PXIe-5672/5673/5673E: /*AWGName*/StartedEvent, where *AWGName* is the name of your associated AWG module in MAX.\n\n PXIe-5830/5831/5832: /*BasebandModule*/ao/0/StartedEvent, where *BasebandModule* is the name of the baseband module of your device in MAX.\n\n PXIe-5820/5840/5841: /*ModuleName*/ao/0/StartedEvent, where *ModuleName* is the name of your device in MAX.\n\n 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).\n\n **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Events `_\n\n `Syntax for Terminal Names `_\n\n **High-Level Functions**:\n\n - nirfsg_GetTerminalName\n ' + 'description': 'Returns the name of the fully qualified signal name as a string.\n\n**Default Values**:\n\nPXI-5670/5671, PXIe-5672/5673/5673E: /*AWGName*/StartedEvent, where *AWGName* is the name of your associated AWG module in MAX.\n\nPXIe-5830/5831/5832: /*BasebandModule*/ao/0/StartedEvent, where *BasebandModule* is the name of the baseband module of your device in MAX.\n\nPXIe-5820/5840/5841: /*ModuleName*/ao/0/StartedEvent, where *ModuleName* is the name of your device in MAX.\n\nPXIe-5860: /*ModuleName*/ao/*ChannelNumber*/StartedEvent, where *ModuleName* is the name of your device in MAX and *ChannelNumber* is the channel number (0 or 1).\n\n**Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Events `_\n\n`Syntax for Terminal Names `_\n\n**High-Level Functions**:\n\n- nirfsg_GetTerminalName' }, 'lv_property': 'Events:Started Event Terminal Name', 'name': 'STARTED_EVENT_TERMINAL_NAME', @@ -2514,7 +2509,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the name of the fully qualified signal name as a string.\n\n **Default Values**:\n\n PXI-5670/5671, PXIe-5672/5673/5673E: /*AWGName*/DoneEvent, where *AWGName* is the name of your associated AWG module in MAX.\n\n PXIe-5830/5831/5832: /*BasebandModule*/ao/0/DoneEvent, where *BasebandModule* is the name of the baseband module of your device in MAX.\n\n PXIe-5820/5840/5841: /*ModuleName*/ao/0/DoneEvent, where *ModuleName* is the name of your device in MAX.\n\n 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).\n\n **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Events `_\n\n `Syntax for Terminal Names `_\n \n **High-Level Functions**:\n\n - nirfsg_GetTerminalName' + 'description': 'Returns the name of the fully qualified signal name as a string.\n\n**Default Values**:\n\nPXI-5670/5671, PXIe-5672/5673/5673E: /*AWGName*/DoneEvent, where *AWGName* is the name of your associated AWG module in MAX.\n\nPXIe-5830/5831/5832: /*BasebandModule*/ao/0/DoneEvent, where *BasebandModule* is the name of the baseband module of your device in MAX.\n\nPXIe-5820/5840/5841: /*ModuleName*/ao/0/DoneEvent, where *ModuleName* is the name of your device in MAX.\n\nPXIe-5860: /*ModuleName*/ao/*ChannelNumber*/DoneEvent, where *ModuleName* is the name of your device in MAX and *ChannelNumber* is the channel number (0 or 1).\n\n**Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Events `_\n\n`Syntax for Terminal Names `_\n\n**High-Level Functions**:\n\n- nirfsg_GetTerminalName' }, 'lv_property': 'Events:Done Event Terminal Name', 'name': 'DONE_EVENT_TERMINAL_NAME', @@ -2524,7 +2519,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the name of the fully qualified signal name as a string.\n\n **Default Values**:\n\n PXIe-5654/5654 with PXIe-5696: /*ModuleName*/StartTrigger, where *ModuleName* is the name of your device in MAX.\n\n PXI-5670/5671, PXIe-5672/5673/5673E: /*AWGName*/StartTrigger, where *ModuleName* is the name of your associated AWG module in MAX.\n\n PXIe-5830/5831/5832: /*BasebandModule*/ao/0/StartTrigger, where *BasebandModule* is the name of the baseband module of your device in MAX.\n\n PXIe-5820/5840/5841/5842: /*ModuleName*/ao/0/StartTrigger, where *ModuleName* is the name of your device in MAX.\n\n 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).\n\n **Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Start Trigger `_\n\n `Syntax for Terminal Names `_\n\n **High-Level Functions**:\n\n - nirfsg_GetTerminalName\n ' + 'description': 'Returns the name of the fully qualified signal name as a string.\n\n**Default Values**:\n\nPXIe-5654/5654 with PXIe-5696: /*ModuleName*/StartTrigger, where *ModuleName* is the name of your device in MAX.\n\nPXI-5670/5671, PXIe-5672/5673/5673E: /*AWGName*/StartTrigger, where *ModuleName* is the name of your associated AWG module in MAX.\n\nPXIe-5830/5831/5832: /*BasebandModule*/ao/0/StartTrigger, where *BasebandModule* is the name of the baseband module of your device in MAX.\n\nPXIe-5820/5840/5841/5842: /*ModuleName*/ao/0/StartTrigger, where *ModuleName* is the name of your device in MAX.\n\nPXIe-5860: /*ModuleName*/ao/*ChannelNumber*/StartTrigger, where *ModuleName* is the name of your device in MAX and *ChannelNumber* is the channel number (0 or 1).\n\n**Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Start Trigger `_\n\n`Syntax for Terminal Names `_\n\n**High-Level Functions**:\n\n- nirfsg_GetTerminalName' }, 'lv_property': 'Triggers:Start:Terminal Name', 'name': 'START_TRIGGER_TERMINAL_NAME', @@ -2534,7 +2529,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the name of the fully qualified signal name as a string.\n\n **Default Values**:\n\n 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.\n\n 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.\n\n 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.\n\n **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Events `_\n\n `Syntax for Terminal Names `_\n \n **High-Level Functions**:\n\n - nirfsg_GetTerminalName' + 'description': 'Returns the name of the fully qualified signal name as a string.\n\n**Default Values**:\n\nPXI-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.\n\nPXIe-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.\n\nPXIe-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.\n\n**Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Events `_\n\n`Syntax for Terminal Names `_\n\n**High-Level Functions**:\n\n- nirfsg_GetTerminalName' }, 'lv_property': 'Events:Marker:Terminal Name', 'name': 'MARKER_EVENT_TERMINAL_NAME', @@ -2548,7 +2543,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the name of the fully qualified signal name as a string.\n\n **Default Values**:\n\n 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.\n\n 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.\n\n 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.\n\n 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.\n\n **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Triggers `_\n\n `Syntax for Terminal Names `_\n\n **High-Level Functions**:\n\n - nirfsg_GetTerminalName\n ' + 'description': 'Returns the name of the fully qualified signal name as a string.\n\n**Default Values**:\n\nPXI-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.\n\nPXIe-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.\n\nPXIe-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.\n\nPXIe-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.\n\n**Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_\n\n`Syntax for Terminal Names `_\n\n**High-Level Functions**:\n\n- nirfsg_GetTerminalName' }, 'lv_property': 'Triggers:Script:Terminal Name', 'name': 'SCRIPT_TRIGGER_TERMINAL_NAME', @@ -2561,7 +2556,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Adjusts the dynamics of the current driving the YIG main coil.\n\n **Default Value:** NIRFSG_VAL_MANUAL\n\n **Supported Devices:** PXIe-5653\n \n **Defined Values**:\n ', + 'description': 'Adjusts the dynamics of the current driving the YIG main coil.\n\n**Default Value:** NIRFSG_VAL_MANUAL\n\n**Supported Devices:** PXIe-5653\n\n**Defined Values**:', 'note': 'Setting this attribute to NIRFSG_VAL_FAST on the PXIe-5653 allows the frequency to settle significantly faster for some frequency transitions at the expense of increased phase noise.', 'table_body': [ [ @@ -2587,7 +2582,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies whether the RF signal generator reads data from the peer-to-peer endpoint. This attribute is endpoint-based.\n\n **Default Value**: VI_FALSE\n\n **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Configuring a Peer-to-Peer Endpoint `_\n \n **Defined Values**:\n ', + 'description': 'Specifies whether the RF signal generator reads data from the peer-to-peer endpoint. This attribute is endpoint-based.\n\n**Default Value**: VI_FALSE\n\n**Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Configuring a Peer-to-Peer Endpoint `_\n\n**Defined Values**:', 'table_body': [ [ 'VI_TRUE', @@ -2611,7 +2606,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the size, in samples, of the device endpoint. This attribute is endpoint-based.\n\n **Units**: samples (s)\n\n **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Configuring a Peer-to-Peer Endpoint `_\n ' + 'description': 'Returns the size, in samples, of the device endpoint. This attribute is endpoint-based.\n\n**Units**: samples (s)\n\n**Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Configuring a Peer-to-Peer Endpoint `_' }, 'lv_property': 'Peer-to-Peer:Endpoint Size', 'name': 'P2P_ENDPOINT_SIZE', @@ -2621,7 +2616,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the current space available in the endpoint. You can use this attribute when priming the endpoint with initial data using the nirfsg_WriteP2pEndpointI16 function to determine how many samples you can write. You also can use this attribute to characterize the performance and measure the latency of the peer-to-peer stream as data moves across the bus. This attribute is endpoint-based.\n\n **Units**: samples per channel\n\n **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Configuring a Peer-to-Peer Endpoint `_\n\n `Starting Peer-to-Peer Generation `_\n ' + 'description': 'Returns the current space available in the endpoint. You can use this attribute when priming the endpoint with initial data using the nirfsg_WriteP2pEndpointI16 function to determine how many samples you can write. You also can use this attribute to characterize the performance and measure the latency of the peer-to-peer stream as data moves across the bus. This attribute is endpoint-based.\n\n**Units**: samples per channel\n\n**Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Configuring a Peer-to-Peer Endpoint `_\n\n`Starting Peer-to-Peer Generation `_' }, 'lv_property': 'Peer-to-Peer:Space Available In Endpoint', 'name': 'P2P_SPACE_AVAILABLE_IN_ENDPOINT', @@ -2631,7 +2626,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the largest number of samples per channel available in the endpoint since this attribute was last read. You can use this attribute to determine how much endpoint space to use as a buffer against bus traffic latencies by reading the attribute and keeping track of the largest value returned. This attribute is endpoint-based.\n\n If you want to minimize the latency for data to move through the endpoint and be generated by the RF signal generator, use the NIRFSG_ATTR_P2P_DATA_TRANSFER_PERMISSION_INITIAL_CREDITS attribute to grant fewer initial credits than the default of the entire endpoint size.\n\n **Units**: samples per channel\n\n **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Configuring a Peer-to-Peer Endpoint `_\n ' + 'description': 'Returns the largest number of samples per channel available in the endpoint since this attribute was last read. You can use this attribute to determine how much endpoint space to use as a buffer against bus traffic latencies by reading the attribute and keeping track of the largest value returned. This attribute is endpoint-based.\n\nIf you want to minimize the latency for data to move through the endpoint and be generated by the RF signal generator, use the NIRFSG_ATTR_P2P_DATA_TRANSFER_PERMISSION_INITIAL_CREDITS attribute to grant fewer initial credits than the default of the entire endpoint size.\n\n**Units**: samples per channel\n\n**Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Configuring a Peer-to-Peer Endpoint `_' }, 'lv_property': 'Peer-to-Peer:Most Space Available in Endpoint', 'name': 'P2P_MOST_SPACE_AVAILABLE_IN_ENDPOINT', @@ -2641,7 +2636,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the number of peer-to-peer FIFO endpoints supported by the device.\n\n **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Configuring a Peer-to-Peer Endpoint `_\n ' + 'description': 'Returns the number of peer-to-peer FIFO endpoints supported by the device.\n\n**Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Configuring a Peer-to-Peer Endpoint `_' }, 'lv_property': 'Peer-to-Peer:Endpoint Count', 'name': 'P2P_ENDPOINT_COUNT', @@ -2651,7 +2646,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the number of samples the endpoint must receive before the device starts generation. If no level is specified, NI-RFSG automatically sets this value to -1. This attribute applies only when the NIRFSG_ATTR_START_TRIGGER_TYPE attribute is set to NIRFSG_VAL_P2P_ENDPOINT_FULLNESS\n\n **Default Value:** -1, which allows NI-RFSG to select the appropriate fullness value.\n\n **Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Start Trigger `_\n ', + 'description': 'Specifies the number of samples the endpoint must receive before the device starts generation. If no level is specified, NI-RFSG automatically sets this value to -1. This attribute applies only when the NIRFSG_ATTR_START_TRIGGER_TYPE attribute is set to NIRFSG_VAL_P2P_ENDPOINT_FULLNESS\n\n**Default Value:** -1, which allows NI-RFSG to select the appropriate fullness value.\n\n**Supported Devices:** PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Start Trigger `_', 'note': 'Due to an additional internal FIFO in the RF signal generator, the writer peer actually needs to write 2,304 bytes more than the quantity of data specified by this attribute to satisfy the trigger level.' }, 'lv_property': 'Triggers:Start:P2P Endpoint Fullness:Level', @@ -2662,46 +2657,46 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the destination terminal for exporting the Configuration Settled event. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Triggers `_\n\n `Events `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n\n **Possible Values**:\n ', + 'description': 'Specifies the destination terminal for exporting the Configuration Settled event. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Triggers `_\n\n`Events `_\n\n`PFI Lines `_\n\n`PXI Trigger Lines `_\n\n**Possible Values**:', 'table_body': [ [ - 'empty', + '""', 'The signal is not exported.' ], [ - 'PXI_Trig0', + '"PXI_Trig0"', 'The trigger is received on PXI trigger line 0.' ], [ - 'PXI_Trig1', + '"PXI_Trig1"', 'The trigger is received on PXI trigger line 1.' ], [ - 'PXI_Trig2', + '"PXI_Trig2"', 'The trigger is received on PXI trigger line 2.' ], [ - 'PXI_Trig3', + '"PXI_Trig3"', 'The trigger is received on PXI trigger line 3.' ], [ - 'PXI_Trig4', + '"PXI_Trig4"', 'The trigger is received on PXI trigger line 4.' ], [ - 'PXI_Trig5', + '"PXI_Trig5"', 'The trigger is received on PXI trigger line 5.' ], [ - 'PXI_Trig6', + '"PXI_Trig6"', 'The trigger is received on PXI trigger line 6.' ], [ - 'PXIe_DStarC', + '"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', + '"TrigOut"', 'TRIG IN/OUT terminal.' ] ], @@ -2718,7 +2713,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the adjustment for the NIRFSG_ATTR_POWER_LEVEL attribute. This attribute is valid only when you set the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute to NIRFSG_VAL_PEAK_POWER. The value of the NIRFSG_ATTR_PEAK_POWER_ADJUSTMENT attribute adds to the NIRFSG_ATTR_POWER_LEVEL attribute. The NIRFSG_ATTR_PEAK_POWER_ADJUSTMENT attribute typically specifies the peak-to-average power ratio (PAPR) of a waveform. If the PAPR is specified, the specified power level becomes the average power level of the waveform, even if the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute is set to NIRFSG_VAL_PEAK_POWER.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Assigning Properties or Attributes to a Waveform `_—Refer to this topic for more information about using this attribute to associate a peak power adjustment with a waveform.\n ', + 'description': 'Specifies the adjustment for the NIRFSG_ATTR_POWER_LEVEL attribute. This attribute is valid only when you set the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute to NIRFSG_VAL_PEAK_POWER. The value of the NIRFSG_ATTR_PEAK_POWER_ADJUSTMENT attribute adds to the NIRFSG_ATTR_POWER_LEVEL attribute. The NIRFSG_ATTR_PEAK_POWER_ADJUSTMENT attribute typically specifies the peak-to-average power ratio (PAPR) of a waveform. If the PAPR is specified, the specified power level becomes the average power level of the waveform, even if the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute is set to NIRFSG_VAL_PEAK_POWER.\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Assigning Properties or Attributes to a Waveform `_—Refer to this topic for more information about using this attribute to associate a peak power adjustment with a waveform.', 'note': '- For the PXIe-5673/5673E only, use this attribute to associate a peak power adjustment with a waveform.\n\n - For the PXIe-5645, this attribute is ignored if you are using the I/Q ports.' }, 'lv_property': 'RF:Peak Power Adjustment (dB)', @@ -2729,7 +2724,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Configures the loop bandwidth of the reference PLL.\n\n **Default Value:** NIRFSG_VAL_NARROW\n\n **Supported Devices:** PXIe-5653\n\n **Related Topics**\n\n `Phase-Locked Loop Bandwidth `_\n \n **Defined Values**:\n ', + 'description': 'Configures the loop bandwidth of the reference PLL.\n\n**Default Value:** NIRFSG_VAL_NARROW\n\n**Supported Devices:** PXIe-5653\n\n**Related Topics**\n\n`Phase-Locked Loop Bandwidth `_\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_NARROW', @@ -2749,7 +2744,7 @@ 'Description' ] }, - 'enum': 'LoopBandwidth', + 'enum': 'RefPllBandwidth', 'lv_property': 'RF:Advanced:Ref PLL Bandwidth', 'name': 'REF_PLL_BANDWIDTH', 'type': 'ViInt32' @@ -2758,7 +2753,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the interval at which the RF signal generator issues credits to allow the writer peer to transfer data over the bus into the configured endpoint. This attribute is coerced up by NI-RFSG to the nearest 128-byte boundary. This attribute is endpoint-based.\n\n **Units**: samples per channel\n\n **Supported Devices:** PXIe-5673E\n\n **Related Topics**\n\n `Configuring a Peer-to-Peer Endpoint `_\n\n `Configuring Flow Control `_\n ' + 'description': 'Specifies the interval at which the RF signal generator issues credits to allow the writer peer to transfer data over the bus into the configured endpoint. This attribute is coerced up by NI-RFSG to the nearest 128-byte boundary. This attribute is endpoint-based.\n\n**Units**: samples per channel\n\n**Supported Devices:** PXIe-5673E\n\n**Related Topics**\n\n`Configuring a Peer-to-Peer Endpoint `_\n\n`Configuring Flow Control `_' }, 'lv_property': 'Peer-to-Peer:Data Transfer Permission Interval', 'name': 'P2P_DATA_TRANSFER_PERMISSION_INTERVAL', @@ -2768,7 +2763,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the initial amount of data that the writer peer can transfer over the bus into the configured endpoint when the peer-to-peer data stream is enabled. If this attribute is not set and the endpoint is empty, credits equal to the full endpoint size are issued to the writer peer. If data is written to the endpoint using the nirfsg_WriteP2pEndpointI16 function prior to enabling the stream, credits equal to the remaining space available in the endpoint are issued to the writer peer. This attribute is coerced up by NI-RFSG to 8-byte boundaries. This attribute is endpoint-based.\n\n **Units**: samples per channel\n\n **Default Value:** 1,024\n\n **Supported Devices:** PXIe-5673E\n\n **Related Topics**\n\n `Configuring a Peer-to-Peer Endpoint `_\n\n `Configuring Flow Control `_\n ' + 'description': 'Specifies the initial amount of data that the writer peer can transfer over the bus into the configured endpoint when the peer-to-peer data stream is enabled. If this attribute is not set and the endpoint is empty, credits equal to the full endpoint size are issued to the writer peer. If data is written to the endpoint using the nirfsg_WriteP2pEndpointI16 function prior to enabling the stream, credits equal to the remaining space available in the endpoint are issued to the writer peer. This attribute is coerced up by NI-RFSG to 8-byte boundaries. This attribute is endpoint-based.\n\n**Units**: samples per channel\n\n**Default Value:** 1,024\n\n**Supported Devices:** PXIe-5673E\n\n**Related Topics**\n\n`Configuring a Peer-to-Peer Endpoint `_\n\n`Configuring Flow Control `_' }, 'lv_property': 'Peer-to-Peer:Data Transfer Permission Initial Credits', 'name': 'P2P_DATA_TRANSFER_PERMISSION_INITIAL_CREDITS', @@ -2778,7 +2773,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Indicates, in degrees Celsius, the temperature of the device at the time of the last self calibration.\n\n **Supported Devices:** PXIe-5644/5645/5646\n ' + 'description': 'Indicates, in degrees Celsius, the temperature of the device at the time of the last self calibration.\n\n**Supported Devices:** PXIe-5644/5645/5646' }, 'lv_property': 'Self Calibration:Last Self Calibration Temperature', 'name': 'SELF_CALIBRATION_TEMPERATURE', @@ -2788,7 +2783,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Configures the amplitude settling accuracy in decibels. NI-RFSG waits until the RF power settles within the specified accuracy level after calling the nirfsg_Initiate function or nirfsg_WaitUntilSettled function or prior to advancing to next step if using RF list mode.\n\n Any specified amplitude settling value that is above the acceptable minimum value is coerced down to the closest valid value.\n\n PXI/PXIe-5650/5651/5652: This attribute is for NI internal use only.\n\n **Units**: dB\n\n **Default Value:**\n\n PXIe-5654: 4\n\n PXIe-5654 with PXIe-5696 (ALC disabled): 4\n\n PXIe-5654 with PXIe-5696 (ALC enabled): 0.2\n\n PXIe-5820/5830/5831/5832/5840/5841/5842/5860: 0.5\n\n **Valid Values:**\n\n PXIe-5654: 1.5, 2, 4\n\n PXIe-5654 with PXIe-5696 (ALC disabled): 1.5, 2, 4\n\n PXIe-5654 with PXIe-5696 (ALC enabled): 0.2, 0.5\n\n PXIe-5820/5830/5831/5832/5840/5841/5842/5860: 0.01 to 1\n\n **Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Amplitude Settling Times `_\n ' + 'description': 'Configures the amplitude settling accuracy in decibels. NI-RFSG waits until the RF power settles within the specified accuracy level after calling the nirfsg_Initiate function or nirfsg_WaitUntilSettled function or prior to advancing to next step if using RF list mode.\n\nAny specified amplitude settling value that is above the acceptable minimum value is coerced down to the closest valid value.\n\nPXI/PXIe-5650/5651/5652: This attribute is for NI internal use only.\n\n**Units**: dB\n\n**Default Value:**\n\nPXIe-5654: 4\n\nPXIe-5654 with PXIe-5696 (ALC disabled): 4\n\nPXIe-5654 with PXIe-5696 (ALC enabled): 0.2\n\nPXIe-5820/5830/5831/5832/5840/5841/5842/5860: 0.5\n\n**Valid Values:**\n\nPXIe-5654: 1.5, 2, 4\n\nPXIe-5654 with PXIe-5696 (ALC disabled): 1.5, 2, 4\n\nPXIe-5654 with PXIe-5696 (ALC enabled): 0.2, 0.5\n\nPXIe-5820/5830/5831/5832/5840/5841/5842/5860: 0.01 to 1\n\n**Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Amplitude Settling Times `_' }, 'lv_property': 'RF:Amplitude Settling', 'name': 'AMPLITUDE_SETTLING', @@ -2799,7 +2794,7 @@ 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', 'codegen_method': 'public', 'documentation': { - 'description': ' Indicates the maximum amount of time allowed to complete a streaming write operation.\n\n **Default Value:** 10.0seconds\n\n **Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Streaming `_\n\n `Streaming Waveform Data `_\n ' + 'description': 'Indicates the maximum amount of time allowed to complete a streaming write operation.\n\n**Default Value:** 10.0seconds\n\n**Supported Devices:** PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Streaming `_\n\n`Streaming Waveform Data `_' }, 'lv_property': 'Arb:Data Transfer:Streaming:Streaming Write Timeout', 'name': 'STREAMING_WRITE_TIMEOUT', @@ -2810,7 +2805,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Determines the inheritance behavior of the NIRFSG_ATTR_PEAK_POWER_ADJUSTMENT attribute when a script inherits values from specified waveforms.\n\n **Default Value:** NIRFSG_VAL_EXACT_MATCH\n\n **Supported Devices:** PXIe-5673/5673E\n\n **Related Topics**\n\n `Assigning Properties or Attributes to a Waveform `_\n \n **Defined Values**:\n ', + 'description': 'Determines the inheritance behavior of the NIRFSG_ATTR_PEAK_POWER_ADJUSTMENT attribute when a script inherits values from specified waveforms.\n\n**Default Value:** NIRFSG_VAL_EXACT_MATCH\n\n**Supported Devices:** PXIe-5673/5673E\n\n**Related Topics**\n\n`Assigning Properties or Attributes to a Waveform `_\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_EXACT_MATCH', @@ -2835,7 +2830,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies whether the device is the master device when synchronizing the Script Trigger.\n\n The master device distributes the synchronized Script Trigger to all devices in the system through the Script Trigger distribution line.\n\n 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_ATTR_SCRIPT_TRIGGER_TYPE attribute to digital edge, and set the NIRFSG_ATTR_DIGITAL_EDGE_SCRIPT_TRIGGER_SOURCE attribute to sync_script.\n\n To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** VI_FALSE\n\n **Supported Devices:** PXIe-5644/5645/5646\n\n **Related Topics**\n\n `Script Trigger `_\n\n `Synchronizing Sample Clock and Sampled Reference Clock Signals `_\n\n 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.\n \n **Defined Values**:\n ', + 'description': 'Specifies whether the device is the master device when synchronizing the Script Trigger.\n\nThe master device distributes the synchronized Script Trigger to all devices in the system through the Script Trigger distribution line.\n\nWhen 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_ATTR_SCRIPT_TRIGGER_TYPE attribute to digital edge, and set the NIRFSG_ATTR_DIGITAL_EDGE_SCRIPT_TRIGGER_SOURCE attribute to sync_script.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** VI_FALSE\n\n**Supported Devices:** PXIe-5644/5645/5646\n\n**Related Topics**\n\n`Script Trigger `_\n\n`Synchronizing Sample Clock and Sampled Reference Clock Signals `_\n\nRefer to the Synchronization Using NI-RFSA and NI-RFSG topic appropriate to your device for more information about device synchronization for vector signal transceivers.\n\n**Defined Values**:', 'table_body': [ [ 'VI_TRUE', @@ -2859,7 +2854,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' 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.\n\n To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Valid Values:** PXI_Trig0, PXI_Trig1, PXI_Trig2, PXI_Trig3, PXI_Trig4, PXI_Trig5, PXI_Trig6, PXI_Trig7, PFI0\n\n **Default Value:** "" (empty string)\n\n **Supported Devices:** PXIe-5644/5645/5646\n\n **Related Topics**\n\n `Script Trigger `_\n\n `Synchronizing Sample Clock and Sampled Reference Clock Signals `_\n\n 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.\n ' + 'description': '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.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Valid Values:** PXI_Trig0, PXI_Trig1, PXI_Trig2, PXI_Trig3, PXI_Trig4, PXI_Trig5, PXI_Trig6, PXI_Trig7, PFI0\n\n**Default Value:** "" (empty string)\n\n**Supported Devices:** PXIe-5644/5645/5646\n\n**Related Topics**\n\n`Script Trigger `_\n\n`Synchronizing Sample Clock and Sampled Reference Clock Signals `_\n\nRefer to the Synchronization Using NI-RFSA and NI-RFSG topic appropriate to your device for more information about device synchronization for vector signal transceivers.' }, 'lv_property': 'Device Specific:Vector Signal Transceiver:Triggers:Sync Script Trigger Dist Line', 'name': 'SYNC_SCRIPT_TRIGGER_DIST_LINE', @@ -2869,7 +2864,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the connector(s) to use to generate the signal. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n You must write complex I and Q data for all options. The Q data has no effect if you set this attribute to I Only and set the NIRFSG_ATTR_IQ_OUT_PORT_CARRIER_FREQUENCY attribute to 0. If you set the NIRFSG_ATTR_IQ_OUT_PORT_CARRIER_FREQUENCY attribute 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.\n\n If you set the NIRFSG_ATTR_OUTPUT_PORT attribute to NIRFSG_VAL_I_ONLY or NIRFSG_VAL_IQ_OUT, the NIRFSG_ATTR_IQ_OUT_PORT_TERMINAL_CONFIGURATION attribute applies.\n\n **Default Value:**\n\n PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842/5860: NIRFSG_VAL_RF_OUT\n\n PXIe-5820: NIRFSG_VAL_IQ_OUT\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n \n **Defined Values**:\n ', + 'description': 'Specifies the connector(s) to use to generate the signal. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\nYou must write complex I and Q data for all options. The Q data has no effect if you set this attribute to I Only and set the NIRFSG_ATTR_IQ_OUT_PORT_CARRIER_FREQUENCY attribute to 0. If you set the NIRFSG_ATTR_IQ_OUT_PORT_CARRIER_FREQUENCY attribute 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.\n\nIf you set the NIRFSG_ATTR_OUTPUT_PORT attribute to NIRFSG_VAL_I_ONLY or NIRFSG_VAL_IQ_OUT, the NIRFSG_ATTR_IQ_OUT_PORT_TERMINAL_CONFIGURATION attribute applies.\n\n**Default Value:**\n\nPXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842/5860: NIRFSG_VAL_RF_OUT\n\nPXIe-5820: NIRFSG_VAL_IQ_OUT\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_CAL_OUT', @@ -2907,7 +2902,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' 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 attribute, the NI-RFSG device must be in the Configuration state.\n\n **Units:** hertz (Hz)\n\n **Valid Values:**\n\n PXIe-5645: -60MHz to 60MHz\n\n PXIe-5820: -500MHz to 500MHz\n\n **Supported Devices:** PXIe-5645, PXIe-5820\n ', + 'description': '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 attribute, the NI-RFSG device must be in the Configuration state.\n\n**Units:** hertz (Hz)\n\n**Valid Values:**\n\nPXIe-5645: -60MHz to 60MHz\n\nPXIe-5820: -500MHz to 500MHz\n\n**Supported Devices:** PXIe-5645, PXIe-5820', 'note': '- For the PXIe-5820, NI recommends using the NIRFSG_ATTR_FREQUENCY attribute.\n\n - For the PXIe-5645, this attribute is ignored if you are using the RF ports.' }, 'lv_property': 'Device Specific:Vector Signal Transceiver:IQ Out Port:Carrier Frequency', @@ -2918,7 +2913,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies whether to use the I/Q OUT port for differential configuration or single-ended configuration. If you set this attribute to NIRFSG_VAL_SINGLE_ENDED, you must terminate the negative I and Q output connectors with a 50 Ohm termination.\n\n If you set this attribute to NIRFSG_VAL_SINGLE_ENDED, the positive I and Q connectors generate the resulting waveform. If you set this attribute to NIRFSG_VAL_DIFFERENTIAL, both the positive and negative I and Q connectors generate the resulting waveform.\n\n To use this attribute, you must use the channelName parameter of the nirfsg_SetAttributeViInt32 function 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).\n\n To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** NIRFSG_VAL_DIFFERENTIAL\n\n PXIe-5820: The only valid value for this attribute is NIRFSG_VAL_DIFFERENTIAL.\n\n **Supported Devices:** PXIe-5645, PXIe-5820\n\n **Related Topics**\n\n `Differential and Single-Ended Operation (I/O Interface) `_\n \n **Defined Values**:\n ', + 'description': 'Specifies whether to use the I/Q OUT port for differential configuration or single-ended configuration. If you set this attribute to NIRFSG_VAL_SINGLE_ENDED, you must terminate the negative I and Q output connectors with a 50 Ohm termination.\n\nIf you set this attribute to NIRFSG_VAL_SINGLE_ENDED, the positive I and Q connectors generate the resulting waveform. If you set this attribute to NIRFSG_VAL_DIFFERENTIAL, both the positive and negative I and Q connectors generate the resulting waveform.\n\nTo use this attribute, you must use the channelName parameter of the nirfsg_SetAttributeViInt32 function 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).\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** NIRFSG_VAL_DIFFERENTIAL\n\nPXIe-5820: The only valid value for this attribute is NIRFSG_VAL_DIFFERENTIAL.\n\n**Supported Devices:** PXIe-5645, PXIe-5820\n\n**Related Topics**\n\n`Differential and Single-Ended Operation (I/O Interface) `_\n\n**Defined Values**:', 'note': 'For the PXIe-5645, this attribute is ignored if you are using the RF ports.', 'table_body': [ [ @@ -2947,7 +2942,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the amplitude of the generated signal in volts, peak-to-peak (V). For example, if you set this attribute to 1.0, the output signal ranges from -0.5 volts to 0.5 volts.\n\n To use this attribute, you must use the channelName parameter of the nirfsg_SetAttributeViReal64 function 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).\n\n To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n Refer to the specifications document for your device for allowable output levels.\n\n **Units:** Volts, peak-to-peak (V :sub:`pk-pk` )\n\n **Valid Values:**\n\n PXIe-5645: 1V :sub:`pk-pk` maximum if you set the NIRFSG_ATTR_IQ_OUT_PORT_TERMINAL_CONFIGURATION attribute to NIRFSG_VAL_DIFFERENTIAL, and 0.5V :sub:`pk-pk` \n\nmaximum if you set the NIRFSG_ATTR_IQ_OUT_PORT_TERMINAL_CONFIGURATION attribute to NIRFSG_VAL_SINGLE_ENDED.\n\n PXIe-5820: 3.4V :sub:`pk-pk` maximum for signal bandwidth less than 160MHz, and 2V :sub:`pk-pk` \n\nmaximum for signal bandwidth greater than 160MHz.\n\n **Default Value:** 0.5volts\n\n **Supported Devices:** PXIe-5645, PXIe-5820\n ', + 'description': 'Specifies the amplitude of the generated signal in volts, peak-to-peak (V). For example, if you set this attribute to 1.0, the output signal ranges from -0.5 volts to 0.5 volts.\n\nTo use this attribute, you must use the channelName parameter of the nirfsg_SetAttributeViReal64 function 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).\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\nRefer to the specifications document for your device for allowable output levels.\n\n**Units:** Volts, peak-to-peak (V :sub:`pk-pk` )\n\n**Valid Values:**\n\nPXIe-5645: 1V :sub:`pk-pk` maximum if you set the NIRFSG_ATTR_IQ_OUT_PORT_TERMINAL_CONFIGURATION attribute to NIRFSG_VAL_DIFFERENTIAL, and 0.5V :sub:`pk-pk` \n\nmaximum if you set the NIRFSG_ATTR_IQ_OUT_PORT_TERMINAL_CONFIGURATION attribute to NIRFSG_VAL_SINGLE_ENDED.\n\nPXIe-5820: 3.4V :sub:`pk-pk` maximum for signal bandwidth less than 160MHz, and 2V :sub:`pk-pk` \n\nmaximum for signal bandwidth greater than 160MHz.\n\n**Default Value:** 0.5volts\n\n**Supported Devices:** PXIe-5645, PXIe-5820', 'note': '- For the PXIe-5645, this attribute is ignored if you are using the RF ports.\n\n - The valid values are only applicable when you set the NIRFSG_ATTR_IQ_OUT_PORT_LOAD_IMPEDANCE attribute to 50 Ω and when you set the NIRFSG_ATTR_IQ_OUT_PORT_OFFSET attribute to 0.' }, 'lv_property': 'Device Specific:Vector Signal Transceiver:IQ Out Port:Level', @@ -2958,7 +2953,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the common-mode offset applied to the signals generated at each differential output terminal. This attribute applies only when you set the NIRFSG_ATTR_IQ_OUT_PORT_TERMINAL_CONFIGURATION attribute to NIRFSG_VAL_DIFFERENTIAL. Common-mode offset shifts both positive and negative terminals in the same direction.\n\n To use this attribute, you must use the channelName parameter of the nirfsg_SetAttributeViReal64 function 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).\n\n To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Units:** Volts\n\n **Valid Values:**\n\n PXIe-5645: -0.8V to 0.8V if you set the NIRFSG_ATTR_IQ_OUT_PORT_LOAD_IMPEDANCE attribute to 50 Ω. The valid values are -1.2V to 1.2V if you set the NIRFSG_ATTR_IQ_OUT_PORT_LOAD_IMPEDANCE attribute to 100 Ω.\n\n PXIe-5820: -0.25V to 1.5V\n\n **Supported Devices:** PXIe-5645, PXIe-5820\n ', + 'description': 'Specifies the common-mode offset applied to the signals generated at each differential output terminal. This attribute applies only when you set the NIRFSG_ATTR_IQ_OUT_PORT_TERMINAL_CONFIGURATION attribute to NIRFSG_VAL_DIFFERENTIAL. Common-mode offset shifts both positive and negative terminals in the same direction.\n\nTo use this attribute, you must use the channelName parameter of the nirfsg_SetAttributeViReal64 function 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).\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Units:** Volts\n\n**Valid Values:**\n\nPXIe-5645: -0.8V to 0.8V if you set the NIRFSG_ATTR_IQ_OUT_PORT_LOAD_IMPEDANCE attribute to 50 Ω. The valid values are -1.2V to 1.2V if you set the NIRFSG_ATTR_IQ_OUT_PORT_LOAD_IMPEDANCE attribute to 100 Ω.\n\nPXIe-5820: -0.25V to 1.5V\n\n**Supported Devices:** PXIe-5645, PXIe-5820', 'note': '- For the PXIe-5645, this attribute is ignored if you are using the RF ports.\n\n - The valid range is dependent on the load impedance.' }, 'lv_property': 'Device Specific:Vector Signal Transceiver:IQ Out Port:Common Mode Offset', @@ -2969,7 +2964,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the value, in volts, that the signal generator adds to the arbitrary waveform data. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n To use this attribute, you must use the channelName parameter of the nirfsg_SetAttributeViReal64 function 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).\n\n 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.\n\n PXIe-5820: The waveform is not automatically scaled in DSP. To prevent DSP overflows, use the NIRFSG_ATTR_ARB_PRE_FILTER_GAIN attribute to scale the waveform to provide additional headroom for offsets.\n\n **Units:** Volts\n\n **Supported Devices:** PXIe-5645, PXIe-5820\n ', + 'description': 'Specifies the value, in volts, that the signal generator adds to the arbitrary waveform data. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\nTo use this attribute, you must use the channelName parameter of the nirfsg_SetAttributeViReal64 function 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).\n\nPXIe-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.\n\nPXIe-5820: The waveform is not automatically scaled in DSP. To prevent DSP overflows, use the NIRFSG_ATTR_ARB_PRE_FILTER_GAIN attribute to scale the waveform to provide additional headroom for offsets.\n\n**Units:** Volts\n\n**Supported Devices:** PXIe-5645, PXIe-5820', 'note': 'For the PXIe-5645, this attribute is ignored if you are using the RF ports.' }, 'lv_property': 'Device Specific:Vector Signal Transceiver:IQ Out Port:Offset', @@ -2980,27 +2975,27 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies whether to use the internal or external local oscillator (LO) source. If the NIRFSG_ATTR_LO_SOURCE attribute is set to "" (empty string), NI-RFSG uses the internal LO source. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg_SetAttributeViString function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string).\n\n **Default Value:** NIRFSG_VAL_LO_SOURCE_ONBOARD_STR\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `PXIe-5830 LO Sharing Using NI-RFSA and NI-RFSG `_\n\n `PXIe-5831/5832 LO Sharing Using NI-RFSA and NI-RFSG `_\n \n **Possible Values**:\n ', - 'note': 'For the PXIe-5841 with PXIe-5655, RF list mode is not supported when this attribute is set to NIRFSG_VAL_LO_SOURCE_SG_SA_SHARED_STR.', + 'description': 'Specifies whether to use the internal or external local oscillator (LO) source. If the NIRFSG_ATTR_LO_SOURCE attribute is set to "" (empty string), NI-RFSG uses the internal LO source. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\nTo use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg_SetAttributeViString function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string).\n\n**Default Value:** Onboard\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`PXIe-5830 LO Sharing Using NI-RFSA and NI-RFSG `_\n\n`PXIe-5831/5832 LO Sharing Using NI-RFSA and NI-RFSG `_\n\n**Possible Values**:', + 'note': 'For the PXIe-5841 with PXIe-5655, RF list mode is not supported when this attribute is set to SG_SA_Shared.', 'table_body': [ [ - 'Automatic_SG_SA_Shared', + '"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', + '"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_ATTR_UPCONVERTER_CENTER_FREQUENCY attribute to specify the LO frequency.' ], [ - 'Onboard', + '"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', + '"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', + '"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.' ] ], @@ -3017,7 +3012,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the step size for tuning the local oscillator (LO) phase-locked loop (PLL).\n\n When the NIRFSG_ATTR_LO_PLL_FRACTIONAL_MODE_ENABLED attribute is enabled, the specified step size affects the fractional spur performance of the device. When the NIRFSG_ATTR_LO_PLL_FRACTIONAL_MODE_ENABLED attribute is disabled, the specified step size affects the phase noise performance of the device.\n\n The valid values for this attribute depend on the NIRFSG_ATTR_LO_PLL_FRACTIONAL_MODE_ENABLED attribute.\n\n **PXIe-5644/5645/5646**—If you disable the NIRFSG_ATTR_LO_PLL_FRACTIONAL_MODE_ENABLED attribute, the specified value is coerced to the nearest valid value.\n\n **PXIe-5840/5841**—If you disable the NIRFSG_ATTR_LO_PLL_FRACTIONAL_MODE_ENABLED attribute, the specified value is coerced to the nearest valid value that is less than or equal to the desired step size.\n\n **Units:** hertz (Hz)\n\n **Default Values:**\n\n PXIe-5644/5645/5646: 200kHz\n\n PXIe-5830: 2MHz\n\n PXIe-5831/5832 (RF port): 8MHz\n\n PXIe-5831/5832 (IF port): 2MHz, 4MHz\n\n PXIe-5840/5841:\n\n - Fractional mode: 500 kHz\n - Integer mode: 10 MHz for frequencies less than or equal to 4 GHz. 20 MHz for frequencies greater than 4 GHz.\n\n PXIe-5841 with PXIe-5655: 500kHz\n\n PXIe-5842: 1Hz\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842\n\n ', + 'description': 'Specifies the step size for tuning the local oscillator (LO) phase-locked loop (PLL).\n\nWhen the NIRFSG_ATTR_LO_PLL_FRACTIONAL_MODE_ENABLED attribute is enabled, the specified step size affects the fractional spur performance of the device. When the NIRFSG_ATTR_LO_PLL_FRACTIONAL_MODE_ENABLED attribute is disabled, the specified step size affects the phase noise performance of the device.\n\nThe valid values for this attribute depend on the NIRFSG_ATTR_LO_PLL_FRACTIONAL_MODE_ENABLED attribute.\n\n**PXIe-5644/5645/5646**—If you disable the NIRFSG_ATTR_LO_PLL_FRACTIONAL_MODE_ENABLED attribute, the specified value is coerced to the nearest valid value.\n\n**PXIe-5840/5841**—If you disable the NIRFSG_ATTR_LO_PLL_FRACTIONAL_MODE_ENABLED attribute, the specified value is coerced to the nearest valid value that is less than or equal to the desired step size.\n\n**Units:** hertz (Hz)\n\n**Default Values:**\n\nPXIe-5644/5645/5646: 200kHz\n\nPXIe-5830: 2MHz\n\nPXIe-5831/5832 (RF port): 8MHz\n\nPXIe-5831/5832 (IF port): 2MHz, 4MHz\n\nPXIe-5840/5841:\n\n- Fractional mode: 500 kHz\n- Integer mode: 10 MHz for frequencies less than or equal to 4 GHz. 20 MHz for frequencies greater than 4 GHz.\n\nPXIe-5841 with PXIe-5655: 500kHz\n\nPXIe-5842: 1Hz\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842', 'note': 'Values up to 100 MHz are coerced to 50 MHz.', 'table_body': [ [ @@ -3065,7 +3060,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies whether to use fractional mode for the local oscillator (LO) phase-locked loop (PLL). This attribute enables or disables fractional frequency tuning in the LO. Fractional mode provides a finer frequency step resolution and allows smaller values for the NIRFSG_ATTR_LO_FREQUENCY_STEP_SIZE attribute. However, fractional mode may introduce non-harmonic spurs.\n\n This attribute applies only if you set the NIRFSG_ATTR_LO_SOURCE attribute to NIRFSG_VAL_LO_SOURCE_ONBOARD_STR.\n\n To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg_SetAttributeViInt32 function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string).\n\n **Default Value:** NIRFSG_VAL_ENABLE\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n Refer to the local oscillators topic appropriate to your device for more information about using fractional mode.\n \n **Defined Values**:\n ', + 'description': 'Specifies whether to use fractional mode for the local oscillator (LO) phase-locked loop (PLL). This attribute enables or disables fractional frequency tuning in the LO. Fractional mode provides a finer frequency step resolution and allows smaller values for the NIRFSG_ATTR_LO_FREQUENCY_STEP_SIZE attribute. However, fractional mode may introduce non-harmonic spurs.\n\nThis attribute applies only if you set the NIRFSG_ATTR_LO_SOURCE attribute to Onboard.\n\nTo use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg_SetAttributeViInt32 function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" .\n\n**Default Value:** NIRFSG_VAL_ENABLE\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\nRefer to the local oscillators topic appropriate to your device for more information about using fractional mode.\n\n**Defined Values**:', 'note': 'For the PXIe-5841 with PXIe-5655, this attribute is ignored if the PXIe-5655 is used as the LO source.', 'table_body': [ [ @@ -3094,7 +3089,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the delay, in seconds, to apply to the I/Q waveform. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Units:** Seconds\n\n **Valid Values:** Plus or minus half of one I/Q sample period\n\n **Supported Devices:** PXIe-5644/5645/5646\n ' + 'description': 'Specifies the delay, in seconds, to apply to the I/Q waveform. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Units:** Seconds\n\n**Valid Values:** Plus or minus half of one I/Q sample period\n\n**Supported Devices:** PXIe-5644/5645/5646' }, 'lv_property': 'Device Specific:Vector Signal Transceiver:Signal Path:Interpolation Delay', 'name': 'INTERPOLATION_DELAY', @@ -3105,7 +3100,7 @@ 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', 'codegen_method': 'public', 'documentation': { - 'description': ' 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 attribute, the NI-RFSG device must be in the Configuration or Generation state.\n\n By default, markers and events are delayed to align with the waveform data generated from the device. This attribute adds an additional delay to markers and events. Use this attribute to adjust the time delay between events and the corresponding data.\n\n **Units:** Seconds\n\n **Valid Values:**\n\n PXIe-5644/5645: -1.217 μs to 67.050 μs\n\n PXIe-5646: -0.896 μs to 64.640 μs\n\n PXIe-5820/5830/5831/5832/5840/5841/5842: 0 μs to 3.276 μs\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Events `_\n ', + 'description': '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 attribute, the NI-RFSG device must be in the Configuration or Generation state.\n\nBy default, markers and events are delayed to align with the waveform data generated from the device. This attribute adds an additional delay to markers and events. Use this attribute to adjust the time delay between events and the corresponding data.\n\n**Units:** Seconds\n\n**Valid Values:**\n\nPXIe-5644/5645: -1.217 μs to 67.050 μs\n\nPXIe-5646: -0.896 μs to 64.640 μs\n\nPXIe-5820/5830/5831/5832/5840/5841/5842: 0 μs to 3.276 μs\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Events `_', 'note': 'If you decrease the event delay during generation, some markers may be dropped.' }, 'lv_property': 'Device Specific:Vector Signal Transceiver:Events:Events Delay', @@ -3117,7 +3112,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' 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.\n\n 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_ATTR_START_TRIGGER_TYPE attribute to digital edge, and set the NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_SOURCE attribute to sync_script.\n\n To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** VI_FALSE\n\n **Supported Devices:** PXIe-5644/5645/5646\n\n **Related Topics**\n\n `Start Trigger `_\n\n 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.\n \n **Defined Values**:\n ', + 'description': '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.\n\nWhen 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_ATTR_START_TRIGGER_TYPE attribute to digital edge, and set the NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_SOURCE attribute to sync_script.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** VI_FALSE\n\n**Supported Devices:** PXIe-5644/5645/5646\n\n**Related Topics**\n\n`Start Trigger `_\n\nRefer to the Synchronization Using NI-RFSA and NI-RFSG topic appropriate to your device for more information about device synchronization for vector signal transceivers.\n\n**Defined Values**:', 'table_body': [ [ 'VI_TRUE', @@ -3141,7 +3136,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' 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.\n\n To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Valid Values:** PXI_Trig0, PXI_Trig1, PXI_Trig2, PXI_Trig3, PXI_Trig4, PXI_Trig5, PXI_Trig6, PXI_Trig7, PFI0\n\n **Default Value:** "" (empty string)\n\n **Supported Devices:** PXIe-5644/5645/5646\n\n **Related Topics**\n\n `Start Trigger `_\n\n 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.\n ' + 'description': '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.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Valid Values:** PXI_Trig0, PXI_Trig1, PXI_Trig2, PXI_Trig3, PXI_Trig4, PXI_Trig5, PXI_Trig6, PXI_Trig7, PFI0\n\n**Default Value:** "" (empty string)\n\n**Supported Devices:** PXIe-5644/5645/5646\n\n**Related Topics**\n\n`Start Trigger `_\n\nRefer to the Synchronization Using NI-RFSA and NI-RFSG topic appropriate to your device for more information about device synchronization for vector signal transceivers.' }, 'lv_property': 'Device Specific:Vector Signal Transceiver:Triggers:Sync Start Trigger Dist Line', 'name': 'SYNC_START_TRIGGER_DIST_LINE', @@ -3151,7 +3146,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the repetition mode of a waveform when you set the NIRFSG_ATTR_GENERATION_MODE attribute to NIRFSG_VAL_ARB_WAVEFORM. If you set this attribute to VI_TRUE, the number of repetitions is determined by the NIRFSG_ATTR_ARB_WAVEFORM_REPEAT_COUNT attribute. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** VI_FALSE\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n \n **Defined Values**:\n ', + 'description': 'Specifies the repetition mode of a waveform when you set the NIRFSG_ATTR_GENERATION_MODE attribute to NIRFSG_VAL_ARB_WAVEFORM. If you set this attribute to VI_TRUE, the number of repetitions is determined by the NIRFSG_ATTR_ARB_WAVEFORM_REPEAT_COUNT attribute. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** VI_FALSE\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', 'table_body': [ [ 'VI_TRUE', @@ -3175,7 +3170,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the repeat count of a waveform when you set the NIRFSG_ATTR_ARB_WAVEFORM_REPEAT_COUNT_IS_FINITE attribute to VI_TRUE. This attribute is valid only when you set the NIRFSG_ATTR_GENERATION_MODE attribute to NIRFSG_VAL_ARB_WAVEFORM. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** 1\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' + 'description': 'Specifies the repeat count of a waveform when you set the NIRFSG_ATTR_ARB_WAVEFORM_REPEAT_COUNT_IS_FINITE attribute to VI_TRUE. This attribute is valid only when you set the NIRFSG_ATTR_GENERATION_MODE attribute to NIRFSG_VAL_ARB_WAVEFORM. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** 1\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'lv_property': 'Arb:Waveform Repeat Count', 'name': 'ARB_WAVEFORM_REPEAT_COUNT', @@ -3185,7 +3180,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' This attribute offsets the NIRFSG_ATTR_UPCONVERTER_CENTER_FREQUENCY from the RF frequency. Use this attribute to keep the local oscillator (LO) leakage at a determined offset from the RF signal.\n\n **Valid Values:**\n\n PXIe-5644/5645: -42MHz to +42MHz\n\n PXIe-5646: -100MHz to +100MHz\n\n PXIe-5830/5831/5832/5840/5841: -500MHz to +500MHz\n\n PXI-5842 (500 MHz bandwidth option): -250MHz to +250MHz\n\n PXI-5842 (1 GHz bandwidth option): -500MHz to +500MHz\n\n PXI-5842 (2 GHz bandwidth option): -1GHz to +1GHz\n\n PXIe-5842 (4 GHz bandwidth option) using the Standard personality: -1GHz to +1GHz\n\n PXIe-5842 (4 GHz bandwidth option) using the 4 GHz Bandwidth personality: -2GHz to +2GHz\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `PXIe-5830 Frequency and Bandwidth Selection `_\n\n `PXIe-5831/5832 Frequency and Bandwidth Selection `_\n\n `PXIe-5841 Frequency and Bandwidth Selection `_\n ', + 'description': 'This attribute offsets the NIRFSG_ATTR_UPCONVERTER_CENTER_FREQUENCY from the RF frequency. Use this attribute to keep the local oscillator (LO) leakage at a determined offset from the RF signal.\n\n**Valid Values:**\n\nPXIe-5644/5645: -42MHz to +42MHz\n\nPXIe-5646: -100MHz to +100MHz\n\nPXIe-5830/5831/5832/5840/5841: -500MHz to +500MHz\n\nPXI-5842 (500 MHz bandwidth option): -250MHz to +250MHz\n\nPXI-5842 (1 GHz bandwidth option): -500MHz to +500MHz\n\nPXI-5842 (2 GHz bandwidth option): -1GHz to +1GHz\n\nPXIe-5842 (4 GHz bandwidth option) using the Standard personality: -1GHz to +1GHz\n\nPXIe-5842 (4 GHz bandwidth option) using the 4 GHz Bandwidth personality: -2GHz to +2GHz\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`PXIe-5830 Frequency and Bandwidth Selection `_\n\n`PXIe-5831/5832 Frequency and Bandwidth Selection `_\n\n`PXIe-5841 Frequency and Bandwidth Selection `_', 'note': '- You cannot set the NIRFSG_ATTR_UPCONVERTER_CENTER_FREQUENCY attribute or the NIRFSG_ATTR_ARB_CARRIER_FREQUENCY attribute at the same time as the NIRFSG_ATTR_UPCONVERTER_FREQUENCY_OFFSET attribute.\n\n - Resetting this attribute disables the upconverter frequency offset.' }, 'lv_property': 'Device Specific:Vector Signal Transceiver:Upconverter:Frequency Offset (Hz)', @@ -3196,7 +3191,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the temperature, in degrees Celsius, of the I/Q Out circuitry on the device.\n\n **Units:** Degrees Celsius\n\n **Supported Devices:** PXIe-5645, PXIe-5820\n ', + 'description': 'Returns the temperature, in degrees Celsius, of the I/Q Out circuitry on the device.\n\n**Units:** Degrees Celsius\n\n**Supported Devices:** PXIe-5645, PXIe-5820', 'note': 'If you query this attribute during RF list mode, list steps may take longer to complete during list execution.' }, 'lv_property': 'Device Specific:Vector Signal Transceiver:IQ Out Port:Temperature (Degrees C)', @@ -3207,27 +3202,27 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' 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.\n\n To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n You can specify Marker Events by using scripts to trigger blanking at a certain point in a waveform. For example, if you set this attribute 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.\n\n PXIe-5645: This attribute is ignored if you are using the I/Q ports.\n\n PXIe-5840/5841: RF blanking does not occur for frequencies below 120MHz.\n\n For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any nirfsg_Reset or `niRFSA_reset `_ on the same device, NI recommends calling it before committing blanking attributes. Alternatively, you can call nirfsg_ResetWithOptions or `niRFSA_ResetWithOptions `_. Select **Routes** in the **steps to omit** parameter.\n\n **Default Value:** "" (empty string)\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Marker Events `_\n \n **Valid Values**:\n ', + 'description': '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.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\nYou can specify Marker Events by using scripts to trigger blanking at a certain point in a waveform. For example, if you set this attribute 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.\n\nPXIe-5645: This attribute is ignored if you are using the I/Q ports.\n\nPXIe-5840/5841: RF blanking does not occur for frequencies below 120MHz.\n\nFor PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any nirfsg_Reset or `niRFSA_reset `_ on the same device, NI recommends calling it before committing blanking attributes. Alternatively, you can call nirfsg_ResetWithOptions or `niRFSA_ResetWithOptions `_. Select **Routes** in the **steps to omit** parameter.\n\n**Default Value:** "" (empty string)\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Marker Events `_\n\n**Valid Values**:', 'note': 'The shortest supported blanking interval is eight microseconds.', 'table_body': [ [ - '"" (empty string)', + '""', 'RF blanking is disabled.' ], [ - 'Marker0', + '"Marker0"', 'RF blanking is tied to marker0.' ], [ - 'Marker1', + '"Marker1"', 'RF blanking is tied to marker1.' ], [ - 'Marker2', + '"Marker2"', 'RF blanking is tied to marker2.' ], [ - 'Marker3', + '"Marker3"', 'RF blanking is tied to marker3.' ] ], @@ -3244,7 +3239,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the load impedance connected to the I/Q OUT port. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n To use this attribute, you must use the channelName parameter of the nirfsg_SetAttributeViReal64 function 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).\n\n **Units:** Ohms\n\n **Valid Values:** Any value greater than 0. Values greater than or equal to 1 megaohms (MΩ) are interpreted as high impedance.\n\n **Default Value:** 50 Ω if you set the NIRFSG_ATTR_IQ_OUT_PORT_TERMINAL_CONFIGURATION attribute to NIRFSG_VAL_SINGLE_ENDED, and 100 Ω if you set the NIRFSG_ATTR_IQ_OUT_PORT_TERMINAL_CONFIGURATION attribute to NIRFSG_VAL_DIFFERENTIAL.\n\n **Supported Devices:** PXIe-5645, PXIe-5820\n ', + 'description': 'Specifies the load impedance connected to the I/Q OUT port. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\nTo use this attribute, you must use the channelName parameter of the nirfsg_SetAttributeViReal64 function 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).\n\n**Units:** Ohms\n\n**Valid Values:** Any value greater than 0. Values greater than or equal to 1 megaohms (MΩ) are interpreted as high impedance.\n\n**Default Value:** 50 Ω if you set the NIRFSG_ATTR_IQ_OUT_PORT_TERMINAL_CONFIGURATION attribute to NIRFSG_VAL_SINGLE_ENDED, and 100 Ω if you set the NIRFSG_ATTR_IQ_OUT_PORT_TERMINAL_CONFIGURATION attribute to NIRFSG_VAL_DIFFERENTIAL.\n\n**Supported Devices:** PXIe-5645, PXIe-5820', 'note': 'For the PXIe-5645, this attribute is ignored if you are using the RF ports.' }, 'lv_property': 'Device Specific:Vector Signal Transceiver:IQ Out Port:Load Impedance', @@ -3255,7 +3250,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the narrowband frequency modulation (FM) range to apply by sending the signal through an integrator.\n\n This attribute is valid only when you set the NIRFSG_ATTR_ANALOG_MODULATION_TYPE attribute to NIRFSG_VAL_FM and the NIRFSG_ATTR_ANALOG_MODULATION_FM_BAND attribute to NIRFSG_VAL_NARROWBAND.\n \n **Default Value:** NIRFSG_VAL_100HZ_TO_1KHZ\n\n **Supported Devices:** PXIe-5654/5654 with PXIe-5696\n\n **Related Topics**\n\n `Frequency Modulation `_\n \n **Defined Values**:\n ', + 'description': 'Specifies the narrowband frequency modulation (FM) range to apply by sending the signal through an integrator.\n\nThis attribute is valid only when you set the NIRFSG_ATTR_ANALOG_MODULATION_TYPE attribute to NIRFSG_VAL_FM and the NIRFSG_ATTR_ANALOG_MODULATION_FM_BAND attribute to NIRFSG_VAL_NARROWBAND.\n\n**Default Value:** NIRFSG_VAL_100HZ_TO_1KHZ\n\n**Supported Devices:** PXIe-5654/5654 with PXIe-5696\n\n**Related Topics**\n\n`Frequency Modulation `_\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_100HZ_TO_1KHZ', @@ -3288,7 +3283,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' 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.\n\n **Default Value:** 100\n\n **Valid Values:** 0 to 100\n\n **Supported Devices:** PXIe-5654/5654 with PXIe-5696\n\n **Related Topics**\n\n `Frequency Modulation `_\n ' + 'description': '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.\n\n**Default Value:** 100\n\n**Valid Values:** 0 to 100\n\n**Supported Devices:** PXIe-5654/5654 with PXIe-5696\n\n**Related Topics**\n\n`Frequency Modulation `_' }, 'lv_property': 'Modulation:Analog:FM Sensitivity', 'name': 'ANALOG_MODULATION_FM_SENSITIVITY', @@ -3298,7 +3293,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' 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.\n\n 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 attribute to determine the coerced value.\n\n **Default Value:** 100\n\n **Valid Values:** 0 to 100\n\n **Supported Devices:** PXIe-5654/5654 with PXIe-5696\n\n **Related Topics**\n\n `Amplitude Modulation `_\n ' + 'description': '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.\n\nWhen 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 attribute to determine the coerced value.\n\n**Default Value:** 100\n\n**Valid Values:** 0 to 100\n\n**Supported Devices:** PXIe-5654/5654 with PXIe-5696\n\n**Related Topics**\n\n`Amplitude Modulation `_' }, 'lv_property': 'Modulation:Analog:AM Sensitivity', 'name': 'ANALOG_MODULATION_AM_SENSITIVITY', @@ -3308,7 +3303,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' 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.\n\n **Default Value:** 100\n\n **Valid Values:** 0 to 100\n\n **Supported Devices:** PXIe-5654/5654 with PXIe-5696\n\n **Related Topics**\n\n `Phase Modulation `_\n ' + 'description': '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.\n\n**Default Value:** 100\n\n**Valid Values:** 0 to 100\n\n**Supported Devices:** PXIe-5654/5654 with PXIe-5696\n\n**Related Topics**\n\n`Phase Modulation `_' }, 'lv_property': 'Modulation:Analog:PM Sensitivity', 'name': 'ANALOG_MODULATION_PM_SENSITIVITY', @@ -3318,7 +3313,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the level of attenuation in the attenuator path. Setting this attribute overrides the value chosen by NI-RFSG. Not all power levels are achievable if you set this attribute.\n\n **Units**: dB\n\n **Valid Values**: 0dB to 110dB in steps of 10\n\n **Supported Devices:** PXIe-5654 with PXIe-5696\n ', + 'description': 'Specifies the level of attenuation in the attenuator path. Setting this attribute overrides the value chosen by NI-RFSG. Not all power levels are achievable if you set this attribute.\n\n**Units**: dB\n\n**Valid Values**: 0dB to 110dB in steps of 10\n\n**Supported Devices:** PXIe-5654 with PXIe-5696', 'note': 'Resetting this attribute reverts back to the default unset behavior.' }, 'lv_property': 'RF:Attenuator Setting (dB)', @@ -3329,7 +3324,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' 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.\n\n 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.\n\n To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** VI_FALSE\n\n **Supported Devices:** PXIe-5646\n\n **Related Topics**\n\n `Synchronization Using NI-RFSA and NI-RFSG `_—Refer to this topic for more information about PXIe-5646 device synchronization.\n \n **Defined Values**:\n ', + 'description': '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.\n\nWhen synchronizing the Sample Clock, one device must always be designated as the master. The master device actively drives the Sample Clock sync distribution line.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** VI_FALSE\n\n**Supported Devices:** PXIe-5646\n\n**Related Topics**\n\n`Synchronization Using NI-RFSA and NI-RFSG `_—Refer to this topic for more information about PXIe-5646 device synchronization.\n\n**Defined Values**:', 'table_body': [ [ 'VI_TRUE', @@ -3353,7 +3348,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' 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.\n\n To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Valid Values:** PXI_Trig0, PXI_Trig1, PXI_Trig2, PXI_Trig3, PXI_Trig4, PXI_Trig5, PXI_Trig6, PXI_Trig7, PFI0\n\n **Default Value:** "" (empty string)\n\n **Supported Devices:** PXIe-5646\n\n **Related Topics**\n\n `Synchronization Using NI-RFSA and NI-RFSG `_—Refer to this topic for more information about PXIe-5646 device synchronization.\n ' + 'description': '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.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Valid Values:** PXI_Trig0, PXI_Trig1, PXI_Trig2, PXI_Trig3, PXI_Trig4, PXI_Trig5, PXI_Trig6, PXI_Trig7, PFI0\n\n**Default Value:** "" (empty string)\n\n**Supported Devices:** PXIe-5646\n\n**Related Topics**\n\n`Synchronization Using NI-RFSA and NI-RFSG `_—Refer to this topic for more information about PXIe-5646 device synchronization.' }, 'lv_property': 'Device Specific:Vector Signal Transceiver:Triggers:Sync Sample Clock Dist Line', 'name': 'SYNC_SAMPLE_CLOCK_DIST_LINE', @@ -3363,7 +3358,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the amplitude extender module temperature in degrees Celsius.\n\n **Units**: degrees Celsius (°C)\n\n **Supported Devices:** PXIe-5654 with PXIe-5696\n ' + 'description': 'Returns the amplitude extender module temperature in degrees Celsius.\n\n**Units**: degrees Celsius (°C)\n\n**Supported Devices:** PXIe-5654 with PXIe-5696' }, 'lv_property': 'Device Characteristics:AE Temperature (Degrees C)', 'name': 'AE_TEMPERATURE', @@ -3373,7 +3368,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the amplification path to use. The low harmonic path provides greater second and third harmonic spurious response, and the high power path provides higher output power.\n\n NI-RFSG automatically sets the value of this attribute based on power and frequency settings. Setting this attribute overrides the value chosen by NI-RFSG.\n\n **Default Value:** NIRFSG_VAL_LOW_HARMONIC\n\n **Supported Devices:** PXIe-5654 with PXIe-5696\n\n **Related Topics**\n\n `Low Harmonic Path Versus High Power Path `_\n \n **Defined Values**:\n ', + 'description': 'Specifies the amplification path to use. The low harmonic path provides greater second and third harmonic spurious response, and the high power path provides higher output power.\n\nNI-RFSG automatically sets the value of this attribute based on power and frequency settings. Setting this attribute overrides the value chosen by NI-RFSG.\n\n**Default Value:** NIRFSG_VAL_LOW_HARMONIC\n\n**Supported Devices:** PXIe-5654 with PXIe-5696\n\n**Related Topics**\n\n`Low Harmonic Path Versus High Power Path `_\n\n**Defined Values**:', 'note': 'Resetting this attribute reverts back to the default unset behavior.', 'table_body': [ [ @@ -3402,7 +3397,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' 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_InitWithOptions function.\n\n 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.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `NI-RFSG Instrument Driver FPGA Extensions `_\n ' + 'description': '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_InitWithOptions function.\n\nNI-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.\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`NI-RFSG Instrument Driver FPGA Extensions `_' }, 'lv_property': 'Device Specific:Vector Signal Transceiver:Device Characteristics:FPGA Bitfile Path', 'name': 'FPGA_BITFILE_PATH', @@ -3412,7 +3407,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns whether the NI RF signal generator has the fast tuning option available.\n\n **Supported Devices:** PXIe-5654/5654 with PXIe-5696\n\n **Related Topics**\n\n `Frequency Tuning Times for 5654 `_\n\n **Defined Values**:\n ', + 'description': 'Returns whether the NI RF signal generator has the fast tuning option available.\n\n**Supported Devices:** PXIe-5654/5654 with PXIe-5696\n\n**Related Topics**\n\n`Frequency Tuning Times for 5654 `_\n\n**Defined Values**:', 'table_body': [ [ 'VI_TRUE', @@ -3436,7 +3431,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' PXIe-5654/5654 with PXIe-5696: Specifies the pulse modulation mode to use.\n\n 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.\n\n **Default Value:** NIRFSG_VAL_ANALOG\n\n **Supported Devices:** PXIe-5842/5654/5654 with PXIe-5696\n \n **Defined Values**:\n ', + 'description': 'PXIe-5654/5654 with PXIe-5696: Specifies the pulse modulation mode to use.\n\nPXIe-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.\n\n**Default Value:** NIRFSG_VAL_ANALOG\n\n**Supported Devices:** PXIe-5842/5654/5654 with PXIe-5696\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_OPTIMAL_MATCH', @@ -3469,7 +3464,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' 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.\n\n **Default Value:** NIRFSG_VAL_WIDEBAND\n\n **Supported Devices:** PXIe-5654/5654 with PXIe-5696\n\n **Related Topics**\n\n `Frequency Modulation `_\n\n **Defined Values**:\n ', + 'description': '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.\n\n**Default Value:** NIRFSG_VAL_WIDEBAND\n\n**Supported Devices:** PXIe-5654/5654 with PXIe-5696\n\n**Related Topics**\n\n`Frequency Modulation `_\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_NARROWBAND', @@ -3497,7 +3492,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the phase modulation (PM) mode to use.\n\n **Default Value:** NIRFSG_VAL_LOW_PHASE_NOISE\n\n **Supported Devices:** PXIe-5654/5654 with PXIe-5696\n\n **Related Topics**\n\n `Phase Modulation `_\n\n **Defined Values**:\n ', + 'description': 'Specifies the phase modulation (PM) mode to use.\n\n**Default Value:** NIRFSG_VAL_LOW_PHASE_NOISE\n\n**Supported Devices:** PXIe-5654/5654 with PXIe-5696\n\n**Related Topics**\n\n`Phase Modulation `_\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_HIGH_DEVIATION', @@ -3525,7 +3520,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the name of the fully qualified signal name as a string.\n\n **Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Default Values**:\n\n PXIe-5654/5654 with PXIe-5696: /*ModuleName*/ConfigurationSettledEvent, where *ModuleName* is the name of your device in MAX.\n\n PXIe-5830/5831/5832: /*BasebandModule*/ao/0/ConfigurationSettledEvent, where *BasebandModule* is the name of the baseband module of your device in MAX.\n\n PXIe-5820/5840/5841/5842: /*ModuleName*/ao/0/ConfigurationSettledEvent, where *ModuleName* is the name of your device in MAX.\n\n **Related Topics**\n\n `Events `_\n\n `Syntax for Terminal Names `_\n ' + 'description': 'Returns the name of the fully qualified signal name as a string.\n\n**Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Default Values**:\n\nPXIe-5654/5654 with PXIe-5696: /*ModuleName*/ConfigurationSettledEvent, where *ModuleName* is the name of your device in MAX.\n\nPXIe-5830/5831/5832: /*BasebandModule*/ao/0/ConfigurationSettledEvent, where *BasebandModule* is the name of the baseband module of your device in MAX.\n\nPXIe-5820/5840/5841/5842: /*ModuleName*/ao/0/ConfigurationSettledEvent, where *ModuleName* is the name of your device in MAX.\n\n**Related Topics**\n\n`Events `_\n\n`Syntax for Terminal Names `_' }, 'lv_property': 'Events:Configuration Settled Event Terminal Name', 'name': 'CONFIGURATION_SETTLED_EVENT_TERMINAL_NAME', @@ -3535,7 +3530,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Enables or disables the automatic leveling control (ALC).\n\n PXIe-5654 with PXIe-5696: If this attribute is enabled, the ALC is closed (closed-loop mode) and allows for better amplitude accuracy and wider amplitude dynamic range. If this attribute is disabled, the ALC is open (open-loop mode), which is ideal when using modulation. Disabling the NIRFSG_ATTR_ALC_CONTROL attribute also allows for NI-RFSG to perform an automatic power search.\n\n PXIe-5654: NIRFSG_VAL_DISABLE is the only supported value for this device. The PXIe-5654 does not support the ALC when used as a stand-alone device.\n\n **Default Value:**\n\n PXIe-5654: NIRFSG_VAL_DISABLE\n\n PXIe-5654 with PXIe-5696: NIRFSG_VAL_ENABLE\n\n **Supported Devices:** PXIe-5654/5654 with PXIe-5696\n\n **Related Topics**\n\n `Power Level Adjustment `_\n\n `ALC Closed Loop Versus Open Loop `_\n\n `Power Search `_\n\n **Defined Values**:\n ', + 'description': 'Enables or disables the automatic leveling control (ALC).\n\nPXIe-5654 with PXIe-5696: If this attribute is enabled, the ALC is closed (closed-loop mode) and allows for better amplitude accuracy and wider amplitude dynamic range. If this attribute is disabled, the ALC is open (open-loop mode), which is ideal when using modulation. Disabling the NIRFSG_ATTR_ALC_CONTROL attribute also allows for NI-RFSG to perform an automatic power search.\n\nPXIe-5654: NIRFSG_VAL_DISABLE is the only supported value for this device. The PXIe-5654 does not support the ALC when used as a stand-alone device.\n\n**Default Value:**\n\nPXIe-5654: NIRFSG_VAL_DISABLE\n\nPXIe-5654 with PXIe-5696: NIRFSG_VAL_ENABLE\n\n**Supported Devices:** PXIe-5654/5654 with PXIe-5696\n\n**Related Topics**\n\n`Power Level Adjustment `_\n\n`ALC Closed Loop Versus Open Loop `_\n\n`Power Search `_\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_DISABLE', @@ -3563,7 +3558,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Enables or disables automatic power search. When this attribute is enabled, a power search performs after the device is initiated, after output power is enabled, or when the frequency or power level changes while the device is generating. When this attribute is disabled, NI-RFSG does not perform a power search unless you call the nirfsg_PerformPowerSearch function.\n\n This attribute is ignored when the NIRFSG_ATTR_ALC_CONTROL attribute is enabled.\n\n PXIe-5654: NIRFSG_VAL_DISABLE is the only supported value for this device.\n\n **Default Value:**\n\n PXIe-5654: NIRFSG_VAL_DISABLE\n\n PXIe-5654 with PXIe-5696: NIRFSG_VAL_ENABLE\n\n **Supported Devices:** PXIe-5654/5654 with PXIe-5696\n\n **Related Topics**\n\n `Power Search `_\n\n **Defined Values**:\n ', + 'description': 'Enables or disables automatic power search. When this attribute is enabled, a power search performs after the device is initiated, after output power is enabled, or when the frequency or power level changes while the device is generating. When this attribute is disabled, NI-RFSG does not perform a power search unless you call the nirfsg_PerformPowerSearch function.\n\nThis attribute is ignored when the NIRFSG_ATTR_ALC_CONTROL attribute is enabled.\n\nPXIe-5654: NIRFSG_VAL_DISABLE is the only supported value for this device.\n\n**Default Value:**\n\nPXIe-5654: NIRFSG_VAL_DISABLE\n\nPXIe-5654 with PXIe-5696: NIRFSG_VAL_ENABLE\n\n**Supported Devices:** PXIe-5654/5654 with PXIe-5696\n\n**Related Topics**\n\n`Power Search `_\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_DISABLE', @@ -3591,7 +3586,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the frequency of the LO source.\n\n To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg_SetAttributeViReal64 function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string).\n\n **Supported Devices**: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `PXIe-5830 Frequency and Bandwidth Configuration `_\n\n `PXIe-5831/5832 Frequency and Bandwidth Configuration `_\n ', + 'description': 'Specifies the frequency of the LO source.\n\nTo use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsg_SetAttributeViReal64 function to specify the name of the channel you are configuring. You can configure the LO1 and LO2 channels by using lo1 or lo2 as the channel string, or set the channel string to lo1,lo2 to configure both channels. For all other devices, the the only valid value for the channel string is "" (empty string).\n\n**Supported Devices**: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`PXIe-5830 Frequency and Bandwidth Configuration `_\n\n`PXIe-5831/5832 Frequency and Bandwidth Configuration `_', 'note': 'This attribute is read/write if you are using an external LO. Otherwise, this attribute is read-only.' }, 'lv_property': 'RF:LO Frequency (Hz)', @@ -3602,7 +3597,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the digital gain, in decibels. The digital gain is applied to the waveform data after filtering. Use this attribute 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.\n\n To set this attribute, the NI-RFSG device must be in the Configuration or Generation state.\n\n **Default Value:** 0 dB\n\n **Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' + 'description': 'Specifies the digital gain, in decibels. The digital gain is applied to the waveform data after filtering. Use this attribute 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.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration or Generation state.\n\n**Default Value:** 0 dB\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'name': 'ARB_DIGITAL_GAIN', 'type': 'ViReal64' @@ -3611,7 +3606,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the output behavior for the Marker Event. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** NIRFSG_VAL_PULSE\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Marker Events `_\n \n **Defined Values**:\n ', + 'description': 'Specifies the output behavior for the Marker Event. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** NIRFSG_VAL_PULSE\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Marker Events `_\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_PULSE', @@ -3643,7 +3638,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the pulse width value for the Marker Event. Use the NIRFSG_ATTR_MARKER_EVENT_PULSE_WIDTH_UNITS attribute to set the units for the pulse width value. This attribute is valid only when the NIRFSG_ATTR_MARKER_EVENT_OUTPUT_BEHAVIOR attribute is set to NIRFSG_VAL_PULSE.\n\n To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** 200 ns\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Marker Events `_\n ' + 'description': 'Specifies the pulse width value for the Marker Event. Use the NIRFSG_ATTR_MARKER_EVENT_PULSE_WIDTH_UNITS attribute to set the units for the pulse width value. This attribute is valid only when the NIRFSG_ATTR_MARKER_EVENT_OUTPUT_BEHAVIOR attribute is set to NIRFSG_VAL_PULSE.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** 200 ns\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Marker Events `_' }, 'lv_property': 'Events:Marker:Pulse:Width Value', 'name': 'MARKER_EVENT_PULSE_WIDTH', @@ -3657,7 +3652,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the pulse width units for the Marker Event. This attribute is valid only when the NIRFSG_ATTR_MARKER_EVENT_OUTPUT_BEHAVIOR attribute is set to NIRFSG_VAL_PULSE.\n\n To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** NIRFSG_VAL_SECONDS\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Marker Events `_\n \n **Defined Values**:\n ', + 'description': 'Specifies the pulse width units for the Marker Event. This attribute is valid only when the NIRFSG_ATTR_MARKER_EVENT_OUTPUT_BEHAVIOR attribute is set to NIRFSG_VAL_PULSE.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** NIRFSG_VAL_SECONDS\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Marker Events `_\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_PULSE', @@ -3689,7 +3684,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the initial state for the Marker Event when the NIRFSG_ATTR_MARKER_EVENT_OUTPUT_BEHAVIOR attribute is set to NIRFSG_VAL_TOGGLE.\n\n To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** NIRFSG_VAL_DIGITAL_LOW\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Marker Events `_\n \n **Defined Values**:\n ', + 'description': 'Specifies the initial state for the Marker Event when the NIRFSG_ATTR_MARKER_EVENT_OUTPUT_BEHAVIOR attribute is set to NIRFSG_VAL_TOGGLE.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** NIRFSG_VAL_DIGITAL_LOW\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Marker Events `_\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_DIGITAL_HIGH', @@ -3721,7 +3716,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the total power consumption of the device.\n\n **Units:** watts\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ', + 'description': 'Returns the total power consumption of the device.\n\n**Units:** watts\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860', 'note': 'If you query this attribute during RF list mode, list steps may take longer to complete during list execution.' }, 'lv_property': 'Device Characteristics:Module Power Consumption (W)', @@ -3732,7 +3727,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the FPGA temperature in degrees Celsius.\n\n 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.\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ', + 'description': 'Returns the FPGA temperature in degrees Celsius.\n\nSerial 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.\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860', 'note': 'If you query this attribute during RF list mode, list steps may take longer to complete during list execution.' }, 'lv_property': 'Device Characteristics:FPGA Temperature (Degrees C)', @@ -3744,7 +3739,7 @@ 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the minimum time between temperature sensor readings.\n\n **Units:** Seconds\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' + 'description': 'Specifies the minimum time between temperature sensor readings.\n\n**Units:** Seconds\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'lv_property': 'Device Characteristics:Temperature Read Interval', 'name': 'TEMPERATURE_READ_INTERVAL', @@ -3755,7 +3750,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies whether peer-to-peer should continuously generate data from the peer-to-peer stream or from only a finite number of samples, according to the NIRFSG_ATTR_P2P_NUMBER_OF_SAMPLES_TO_GENERATE attribute. To use this attribute, peer-to-peer must be enabled. This attribute is endpoint-based.\n\n **Default Value**: VI_FALSE\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842\n \n **Defined Values**:\n ', + 'description': 'Specifies whether peer-to-peer should continuously generate data from the peer-to-peer stream or from only a finite number of samples, according to the NIRFSG_ATTR_P2P_NUMBER_OF_SAMPLES_TO_GENERATE attribute. To use this attribute, peer-to-peer must be enabled. This attribute is endpoint-based.\n\n**Default Value**: VI_FALSE\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Defined Values**:', 'table_body': [ [ 'VI_TRUE', @@ -3779,7 +3774,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies how many samples are generated from the peer-to-peer subsystem when it is enabled. To use this attribute, peer-to-peer must be enabled and set to finite generation. This attribute is endpoint-based.\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Configuring a Peer-to-Peer Endpoint `_\n ' + 'description': 'Specifies how many samples are generated from the peer-to-peer subsystem when it is enabled. To use this attribute, peer-to-peer must be enabled and set to finite generation. This attribute is endpoint-based.\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Configuring a Peer-to-Peer Endpoint `_' }, 'lv_property': 'Peer-to-Peer:Number Of Samples To Generate', 'name': 'P2P_NUMBER_OF_SAMPLES_TO_GENERATE', @@ -3789,7 +3784,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns how many samples NI-RFSG pulls from the peer-to-peer FIFO per read. You can use this attribute to determine how many samples to send across the peer-to-peer bus to ensure that no samples are ignored. If you send a number of samples that is not a multiple of this value, the remaining samples are not read from the FIFO during generation. This attribute is endpoint-based.\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842\n ' + 'description': 'Returns how many samples NI-RFSG pulls from the peer-to-peer FIFO per read. You can use this attribute to determine how many samples to send across the peer-to-peer bus to ensure that no samples are ignored. If you send a number of samples that is not a multiple of this value, the remaining samples are not read from the FIFO during generation. This attribute is endpoint-based.\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842' }, 'lv_property': 'Peer-to-Peer:Generation FIFO Sample Quantum', 'name': 'P2P_GENERATION_FIFO_SAMPLE_QUANTUM', @@ -3799,7 +3794,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the delay, in seconds, to apply to the I/Q waveform.\n\n 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.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration or Generation state.\n\n **Units:** Seconds\n\n **Valid Values:**\n\n PXIe-PXIe-5820/5830/5831/5832/5840/5841: 0 μs to 3.2 μs\n\n PXIe-5842: 0 μs to 6.5 μs\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `NI-TClk Overview `_\n ', + 'description': 'Specifies the delay, in seconds, to apply to the I/Q waveform.\n\nRelative 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.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration or Generation state.\n\n**Units:** Seconds\n\n**Valid Values:**\n\nPXIe-PXIe-5820/5830/5831/5832/5840/5841: 0 μs to 3.2 μs\n\nPXIe-5842: 0 μs to 6.5 μs\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`NI-TClk Overview `_', 'note': '- To obtain a negative relative delay when synchronizing the PXIe-5840/5841 with a module that does not support this attribute, use the NITCLK_ATTR_SAMPLE_CLOCK_DELAY attribute.\n\n - The resolution of this attribute is a function of the I/Q sample period at 15E(-6) of the sample period but not worse than one Sample Clock period.' }, 'lv_property': 'Device Specific:Vector Signal Transceiver:Signal Path:Relative Delay', @@ -3811,7 +3806,7 @@ 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the sub-Sample Clock delay, in seconds, to apply to the I/Q waveform. Use this attribute to reduce the trigger jitter when synchronizing multiple devices with NI-TClk. This attribute can also help maintain synchronization repeatability by writing the absolute delay value of a previous measurement to the current session.\n\n To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Units:** Seconds\n\n **Valid Values:** Plus or minus half of one Sample Clock period\n\n **Supported Devices:** PXIe-5820/5840/5841/5842\n ', + 'description': 'Specifies the sub-Sample Clock delay, in seconds, to apply to the I/Q waveform. Use this attribute to reduce the trigger jitter when synchronizing multiple devices with NI-TClk. This attribute can also help maintain synchronization repeatability by writing the absolute delay value of a previous measurement to the current session.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Units:** Seconds\n\n**Valid Values:** Plus or minus half of one Sample Clock period\n\n**Supported Devices:** PXIe-5820/5840/5841/5842', 'note': '- The resolution of this attribute is a function of the I/Q sample period at 15E(-6) times that sample period.\n\n - If this attribute is set, NI-TClk cannot perform any sub-Sample Clock adjustment.' }, 'lv_property': 'Device Specific:Vector Signal Transceiver:Signal Path:Absolute Delay', @@ -3823,7 +3818,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the bandwidth of the device. The instantaneous bandwidth is the effective real-time bandwidth of the signal path for your configuration.\n\n The NIRFSG_ATTR_SIGNAL_BANDWIDTH centered at the NIRFSG_ATTR_FREQUENCY must fit within the device instantaneous bandwidth, which is centered at the NIRFSG_ATTR_UPCONVERTER_CENTER_FREQUENCY.\n\n **Units**: Hz\n\n **Default Value**: N/A\n\n **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `PXIe-5830 Frequency and Bandwidth Selection `_\n\n `PXIe-5831/5832 Frequency and Bandwidth Selection `_\n\n `PXIe-5841 Frequency and Bandwidth Selection `_\n ' + 'description': 'Specifies the bandwidth of the device. The instantaneous bandwidth is the effective real-time bandwidth of the signal path for your configuration.\n\nThe NIRFSG_ATTR_SIGNAL_BANDWIDTH centered at the NIRFSG_ATTR_FREQUENCY must fit within the device instantaneous bandwidth, which is centered at the NIRFSG_ATTR_UPCONVERTER_CENTER_FREQUENCY.\n\n**Units**: Hz\n\n**Default Value**: N/A\n\n**Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`PXIe-5830 Frequency and Bandwidth Selection `_\n\n`PXIe-5831/5832 Frequency and Bandwidth Selection `_\n\n`PXIe-5841 Frequency and Bandwidth Selection `_' }, 'lv_property': 'Arb:Device Instantaneous Bandwidth (Hz)', 'name': 'DEVICE_INSTANTANEOUS_BANDWIDTH', @@ -3833,7 +3828,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Configures error reporting for onboard signal processing (OSP) overflows. Overflows lead to clipping of the waveform.\n\n **Default Value:** NIRFSG_VAL_ERROR_REPORTING_WARNING\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n \n **Defined Values**:\n ', + 'description': 'Configures error reporting for onboard signal processing (OSP) overflows. Overflows lead to clipping of the waveform.\n\n**Default Value:** NIRFSG_VAL_ERROR_REPORTING_WARNING\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_ERROR_REPORTING_DISABLED', @@ -3861,7 +3856,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the size of the DMA buffer in computer memory, in bytes. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n A sufficiently large host DMA buffer improves performance by allowing large writes to be transferred more efficiently.\n\n **Units:** bytes\n\n **Default Value:** 8MB\n\n **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' + 'description': 'Specifies the size of the DMA buffer in computer memory, in bytes. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\nA sufficiently large host DMA buffer improves performance by allowing large writes to be transferred more efficiently.\n\n**Units:** bytes\n\n**Default Value:** 8MB\n\n**Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'lv_property': 'Arb:Data Transfer:Advanced:Host DMA Buffer Size', 'name': 'HOST_DMA_BUFFER_SIZE', @@ -3871,7 +3866,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the port to configure.\n\n **Valid Values**:\n\n PXIe-5644/5645/5646, PXIe-5820/5840/5841: "" (empty string)\n\n PXIe-5830: if0, if1\n\n 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.\n\n **Default Value:**\n\n PXIe-5644/5645/5646, PXIe-5820/5840/5841/5842/5860: "" (empty string)\n\n PXIe-5830/5831/5832: if0\n\n **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n NIRFSG_ATTR_AVAILABLE_PORTS\n ', + 'description': 'Specifies the port to configure.\n\n**Valid Values**:\n\nPXIe-5644/5645/5646, PXIe-5820/5840/5841: "" (empty string)\n\nPXIe-5830: if0, if1\n\nPXIe-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.\n\n**Default Value:**\n\nPXIe-5644/5645/5646, PXIe-5820/5840/5841/5842/5860: "" (empty string)\n\nPXIe-5830/5831/5832: if0\n\n**Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\nNIRFSG_ATTR_AVAILABLE_PORTS', 'note': 'When using RF list mode, ports cannot be shared with NI-RFSA.' }, 'lv_property': 'Device Specific:Vector Signal Transceiver:Signal Path:Selected Ports', @@ -3882,7 +3877,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies whether to allow NI-RFSA to control the NI-RFSG LO out export.\n\n Set this attribute to NIRFSG_VAL_ENABLE to allow NI-RFSA to control the LO out export. Use the RF OUT LO EXPORT ENABLED attribute to control the LO out export from NI-RFSA.\n\n **Default Value:** NIRFSG_VAL_DISABLE\n\n **Supported Devices**: PXIe-5840/5841/5842\n \n **Defined Values**:\n ', + 'description': 'Specifies whether to allow NI-RFSA to control the NI-RFSG LO out export.\n\nSet this attribute to NIRFSG_VAL_ENABLE to allow NI-RFSA to control the LO out export. Use the RF OUT LO EXPORT ENABLED attribute to control the LO out export from NI-RFSA.\n\n**Default Value:** NIRFSG_VAL_DISABLE\n\n**Supported Devices**: PXIe-5840/5841/5842\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_ENABLE', @@ -3910,7 +3905,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies whether to enable the RF IN LO OUT terminal on the PXIe-5840/5841.\n\n Set this attribute to NIRFSG_VAL_ENABLE to export the LO signal from the RF IN LO OUT terminal.\n\n When this attribute is enabled, if the NIRFSG_ATTR_LO_SOURCE attribute is set to NIRFSG_VAL_LO_SOURCE_LO_IN_STR and you do not set the NIRFSG_ATTR_LO_FREQUENCY or NIRFSG_ATTR_UPCONVERTER_CENTER_FREQUENCY attributes, NI-RFSG rounds the LO frequency to approximately an LO step size as if the source was NIRFSG_VAL_ONBOARD_CLOCK_STR. This ensures that when you configure NI-RFSA and NI-RFSG with compatible settings that result in the same LO frequency, the rounding also is compatible.\n\n **Default Value:** NIRFSG_VAL_UNSPECIFIED\n\n **Supported Devices**: PXIe-5840/5841/5842\n \n **Defined Values**:\n ', + 'description': 'Specifies whether to enable the RF IN LO OUT terminal on the PXIe-5840/5841.\n\nSet this attribute to NIRFSG_VAL_ENABLE to export the LO signal from the RF IN LO OUT terminal.\n\nWhen this attribute is enabled, if the NIRFSG_ATTR_LO_SOURCE attribute is set to LO_In and you do not set the NIRFSG_ATTR_LO_FREQUENCY or NIRFSG_ATTR_UPCONVERTER_CENTER_FREQUENCY attributes, NI-RFSG rounds the LO frequency to approximately an LO step size as if the source was 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.\n\n**Default Value:** NIRFSG_VAL_UNSPECIFIED\n\n**Supported Devices**: PXIe-5840/5841/5842\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_DISABLE', @@ -3939,7 +3934,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the temperature change, in degrees Celsius, that is required before NI-RFSG recalculates the thermal correction settings when entering the Generation state.\n\n **Units:** degrees Celsius (°C)\n\n **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Default Values:**\n\n PXIe-5830/5831/5832/5842/5860: 0.2\n\n PXIe-5840/5841: 1.0\n ' + 'description': 'Specifies the temperature change, in degrees Celsius, that is required before NI-RFSG recalculates the thermal correction settings when entering the Generation state.\n\n**Units:** degrees Celsius (°C)\n\n**Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Default Values:**\n\nPXIe-5830/5831/5832/5842/5860: 0.2\n\nPXIe-5840/5841: 1.0' }, 'lv_property': 'RF:Advanced:Thermal Correction Temperature Resolution (Degrees C)', 'name': 'THERMAL_CORRECTION_TEMPERATURE_RESOLUTION', @@ -3949,7 +3944,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies whether to allow NI-RFSG to select the upconverter frequency offset. You can either set an offset yourself or let NI-RFSG select one for you.\n\n Placing the upconverter center frequency outside the bandwidth of your waveform can help avoid issues such as LO leakage.\n\n To set an offset yourself, set this attribute to NIRFSG_VAL_AUTO or NIRFSG_VAL_USER_DEFINED, and set either the NIRFSG_ATTR_UPCONVERTER_CENTER_FREQUENCY or the NIRFSG_ATTR_UPCONVERTER_FREQUENCY_OFFSET attribute.\n\n To allow NI-RFSG to automatically select the upconverter frequency offset, set this attribute to NIRFSG_VAL_AUTO or NIRFSG_VAL_ENABLE and set the NIRFSG_ATTR_SIGNAL_BANDWIDTH to describe the bandwidth of your waveform. The signal bandwidth must be no greater than half the value of the NIRFSG_ATTR_DEVICE_INSTANTANEOUS_BANDWIDTH attribute, minus a device-specific guard band. Do not set the NIRFSG_ATTR_UPCONVERTER_CENTER_FREQUENCY or NIRFSG_ATTR_UPCONVERTER_FREQUENCY_OFFSET attributes. If all conditions are met, NI-RFSG places the upconverter center frequency outside the signal bandwidth. Set this attribute to NIRFSG_VAL_ENABLE if you want to receive an error any time NI-RFSG is unable to apply automatic offset.\n\n 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_ATTR_UPCONVERTER_FREQUENCY_OFFSET_MODE returns NIRFSG_VAL_USER_DEFINED. When NI-RFSG automatically sets an offset, the reference frequency for gain is near the NIRFSG_ATTR_FREQUENCY and NIRFSG_ATTR_UPCONVERTER_FREQUENCY_OFFSET_MODE returns NIRFSG_VAL_ENABLE.\n\n **Default Value:** NIRFSG_VAL_AUTO\n\n **Supported Devices**: PXIe-5830/5831/5832/5841/5842\n\n **Related Topics**\n\n `PXIe-5830 Automatic Frequency Offset `_\n\n `PXIe-5831/5832 Automatic Frequency Offset `_\n\n `PXIe-5841 Automatic Frequency Offset `_\n \n **Defined Values**:\n ', + 'description': 'Specifies whether to allow NI-RFSG to select the upconverter frequency offset. You can either set an offset yourself or let NI-RFSG select one for you.\n\nPlacing the upconverter center frequency outside the bandwidth of your waveform can help avoid issues such as LO leakage.\n\nTo set an offset yourself, set this attribute to NIRFSG_VAL_AUTO or NIRFSG_VAL_USER_DEFINED, and set either the NIRFSG_ATTR_UPCONVERTER_CENTER_FREQUENCY or the NIRFSG_ATTR_UPCONVERTER_FREQUENCY_OFFSET attribute.\n\nTo allow NI-RFSG to automatically select the upconverter frequency offset, set this attribute to NIRFSG_VAL_AUTO or NIRFSG_VAL_ENABLE and set the NIRFSG_ATTR_SIGNAL_BANDWIDTH to describe the bandwidth of your waveform. The signal bandwidth must be no greater than half the value of the NIRFSG_ATTR_DEVICE_INSTANTANEOUS_BANDWIDTH attribute, minus a device-specific guard band. Do not set the NIRFSG_ATTR_UPCONVERTER_CENTER_FREQUENCY or NIRFSG_ATTR_UPCONVERTER_FREQUENCY_OFFSET attributes. If all conditions are met, NI-RFSG places the upconverter center frequency outside the signal bandwidth. Set this attribute to NIRFSG_VAL_ENABLE if you want to receive an error any time NI-RFSG is unable to apply automatic offset.\n\nWhen you set an offset yourself or do not use an offset, the reference frequency for gain is near the upconverter center frequency, and NIRFSG_ATTR_UPCONVERTER_FREQUENCY_OFFSET_MODE returns NIRFSG_VAL_USER_DEFINED. When NI-RFSG automatically sets an offset, the reference frequency for gain is near the NIRFSG_ATTR_FREQUENCY and NIRFSG_ATTR_UPCONVERTER_FREQUENCY_OFFSET_MODE returns NIRFSG_VAL_ENABLE.\n\n**Default Value:** NIRFSG_VAL_AUTO\n\n**Supported Devices**: PXIe-5830/5831/5832/5841/5842\n\n**Related Topics**\n\n`PXIe-5830 Automatic Frequency Offset `_\n\n`PXIe-5831/5832 Automatic Frequency Offset `_\n\n`PXIe-5841 Automatic Frequency Offset `_\n\n**Defined Values**:', 'note': 'Below 120 MHz, the PXIe-5841 does not use an LO and NIRFSG_VAL_ENABLE is unavailable. Refer to the *PXIe-5841 Automatic Frequency Offset* topic for more information about using an automatic offset with an external LO.', 'table_body': [ [ @@ -3979,7 +3974,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns a comma-separated list of the ports available for use based on your instrument configuration.\n\n **Supported Devices**: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' + 'description': 'Returns a comma-separated list of the ports available for use based on your instrument configuration.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'lv_property': 'Device Specific:Vector Signal Transceiver:Signal Path:Available Ports', 'name': 'AVAILABLE_PORTS', @@ -3989,7 +3984,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' 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.\n\n This attribute is channel dependent if multiple FPGA targets are supported.\n\n **Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' + 'description': '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.\n\nThis attribute is channel dependent if multiple FPGA targets are supported.\n\n**Supported Devices**: PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'lv_property': 'Device Characteristics:FPGA Target Name', 'name': 'FPGA_TARGET_NAME', @@ -3999,7 +3994,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the type of de-embedding to apply to measurements on the specified port.\n\n To use this attribute, you must use the channelName parameter of the nirfsg_SetAttributeViInt32 function to specify the name of the port to configure for de-embedding.\n\n If you set this attribute to NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR or NIRFSG_VAL_DEEMBEDDING_TYPE_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.\n\n **Default Value**: NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR\n\n **Valid Values for PXIe-5830/5832/5840/5841/5842/5860** : NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR or NIRFSG_VAL_DEEMBEDDING_TYPE_NONE\n\n **Valid Values for PXIe-5831** NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR, NIRFSG_VAL_DEEMBEDDING_TYPE_VECTOR, or NIRFSG_VAL_DEEMBEDDING_TYPE_NONE. NIRFSG_VAL_DEEMBEDDING_TYPE_VECTOR is only supported for TRX Ports in a Semiconductor Test System (STS).\n\n **Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860\n \n **Defined Values**:\n ', + 'description': 'Specifies the type of de-embedding to apply to measurements on the specified port.\n\nTo use this attribute, you must use the channelName parameter of the nirfsg_SetAttributeViInt32 function to specify the name of the port to configure for de-embedding.\n\nIf you set this attribute to NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR or NIRFSG_VAL_DEEMBEDDING_TYPE_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.\n\n**Default Value**: NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR\n\n**Valid Values for PXIe-5830/5832/5840/5841/5842/5860** : NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR or NIRFSG_VAL_DEEMBEDDING_TYPE_NONE\n\n**Valid Values for PXIe-5831** NIRFSG_VAL_DEEMBEDDING_TYPE_SCALAR, NIRFSG_VAL_DEEMBEDDING_TYPE_VECTOR, or NIRFSG_VAL_DEEMBEDDING_TYPE_NONE. NIRFSG_VAL_DEEMBEDDING_TYPE_VECTOR is only supported for TRX Ports in a Semiconductor Test System (STS).\n\n**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_DEEMBEDDING_TYPE_NONE', @@ -4035,7 +4030,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Selects the de-embedding table to apply to the measurements on the specified port.\n\n To use this attribute, you must use the channelName parameter of the nirfsg_SetAttributeViString function to specify the name of the port to configure for de-embedding.\n\n 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.\n\n Use the create deembedding sparameter table array function to create tables.\n\n **Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860\n ' + 'description': 'Selects the de-embedding table to apply to the measurements on the specified port.\n\nTo use this attribute, you must use the channelName parameter of the nirfsg_SetAttributeViString function to specify the name of the port to configure for de-embedding.\n\nIf de-embedding is enabled, NI-RFSG uses the specified table to remove the effects of the external network between the instrument and the DUT.\n\nUse the create deembedding sparameter table array function to create tables.\n\n**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860' }, 'lv_property': 'De-embedding:Selected Table', 'name': 'DEEMBEDDING_SELECTED_TABLE', @@ -4048,7 +4043,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the step size for tuning the internal voltage-controlled oscillator (VCO) used to generate the LO signal.\n\n **Valid Values**:\n\n LO1: 1 Hz to 50 MHz\n\n LO2: 1 Hz to 100 MHz\n\n **Default Value**: 1 MHz\n\n **Supported Devices**: PXIe-5830/5831/5832\n ' + 'description': 'Specifies the step size for tuning the internal voltage-controlled oscillator (VCO) used to generate the LO signal.\n\n**Valid Values**:\n\nLO1: 1 Hz to 50 MHz\n\nLO2: 1 Hz to 100 MHz\n\n**Default Value**: 1 MHz\n\n**Supported Devices**: PXIe-5830/5831/5832' }, 'lv_property': 'Device Specific:Vector Signal Transceiver:Signal Path:LO VCO Frequency Step Size (Hz)', 'name': 'LO_VCO_FREQUENCY_STEP_SIZE', @@ -4058,7 +4053,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the expected thermal operating range of the instrument from the self-calibration temperature, in degrees Celsius, returned from the NIRFSG_ATTR_DEVICE_TEMPERATURE attribute.\n\n 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.\n\n **Units:** degrees Celsius (°C)\n\n **Default Value**:\n\n **PXIe-5830/5831/5832/5842/5860**: 5\n\n **PXIe-5840/5841**: 10\n\n **Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860\n ' + 'description': 'Specifies the expected thermal operating range of the instrument from the self-calibration temperature, in degrees Celsius, returned from the NIRFSG_ATTR_DEVICE_TEMPERATURE attribute.\n\nFor 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.\n\n**Units:** degrees Celsius (°C)\n\n**Default Value**:\n\n**PXIe-5830/5831/5832/5842/5860**: 5\n\n**PXIe-5840/5841**: 10\n\n**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860' }, 'lv_property': 'RF:Advanced:Thermal Correction Headroom Range (Degrees C)', 'name': 'THERMAL_CORRECTION_HEADROOM_RANGE', @@ -4068,7 +4063,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the I/Q rate of the waveform. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Streaming `_\n\n `Assigning Properties or Attributes to a Waveform `_—Refer to this topic for more information about using this attribute to associate an I/Q rate with a waveform.\n\n `Digital Upconverter `_\n ' + 'description': 'Specifies the I/Q rate of the waveform. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Streaming `_\n\n`Assigning Properties or Attributes to a Waveform `_—Refer to this topic for more information about using this attribute to associate an I/Q rate with a waveform.\n\n`Digital Upconverter `_' }, 'lv_property': 'Arb:Waveform Attributes:Waveform IQ Rate (S/s)', 'name': 'WAVEFORM_IQ_RATE', @@ -4081,7 +4076,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the bandwidth of the arbitrary signal. This value must be less than or equal to (0.8× NIRFSG_ATTR_IQ_RATE).\n\n **Units**: hertz (Hz)\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' + 'description': 'Specifies the bandwidth of the arbitrary signal. This value must be less than or equal to (0.8× NIRFSG_ATTR_IQ_RATE).\n\n**Units**: hertz (Hz)\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'lv_property': 'Arb:Waveform Attributes:Waveform Signal Bandwidth (Hz)', 'name': 'WAVEFORM_SIGNAL_BANDWIDTH', @@ -4094,7 +4089,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the waveform runtime scaling. The waveform runtime scaling is applied to the waveform data before any other signal processing.\n\n **Units**: dB\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860, PXIe-5841 with PXIe-5655\n ' + 'description': 'Specifies the waveform runtime scaling. The waveform runtime scaling is applied to the waveform data before any other signal processing.\n\n**Units**: dB\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860, PXIe-5841 with PXIe-5655' }, 'lv_property': 'Arb:Waveform Attributes:Waveform Runtime Scaling', 'name': 'WAVEFORM_RUNTIME_SCALING', @@ -4107,7 +4102,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the peak-to-average power ratio (PAPR).\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' + 'description': 'Specifies the peak-to-average power ratio (PAPR).\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'lv_property': 'Arb:Waveform Attributes:Waveform PAPR (dB)', 'name': 'WAVEFORM_PAPR', @@ -4120,7 +4115,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies a comma-separated list of ports for which to fix the group delay.\n \n\n **Supported Devices:** PXIe-5831/5832\n ' + 'description': 'Specifies a comma-separated list of ports for which to fix the group delay.\n\n\n**Supported Devices:** PXIe-5831/5832' }, 'lv_property': 'Device Specific:Vector Signal Transceiver:Signal Path:Fixed Group Delay Across Ports', 'name': 'FIXED_GROUP_DELAY_ACROSS_PORTS', @@ -4130,7 +4125,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' 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_GetWaveformBurstStartLocations and nirfsg_GetWaveformBurstStopLocations functions respectively.\n\n **Default Value:** NIRFSG_VAL_DISABLE\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n \n **Defined Values**:\n ', + 'description': '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_GetWaveformBurstStartLocations and nirfsg_GetWaveformBurstStopLocations functions respectively.\n\n**Default Value:** NIRFSG_VAL_DISABLE\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', 'note': '- When you download a waveform using nirfsg_ReadAndDownloadWaveformFromFileTdms function and if NIRFSG_ATTR_WAVEFORM_RF_BLANKING attribute is enabled, you must set the NIRFSG_ATTR_WRITE_WAVEFORM_BURST_DETECTION attribute to NIRFSG_VAL_DISABLE.\n\n - For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any nirfsg_Reset or `niRFSA_reset `_ on the same device, NI recommends calling it before committing blanking attributes. Alternatively, you can call nirfsg_ResetWithOptions or `niRFSA_ResetWithOptions `_. Select **Routes** in the **steps to omit** parameter.', 'table_body': [ [ @@ -4156,7 +4151,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' 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_ATTR_WRITE_WAVEFORM_BURST_DETECTION attribute. When you set NIRFSG_ATTR_WRITE_WAVEFORM_BURST_DETECTION_MODE to NIRFSG_VAL_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 attribute to NIRFSG_VAL_MANUAL and specify the burst detection parameters using the write waveform burst detection minimum quiet time, NIRFSG_ATTR_WRITE_WAVEFORM_BURST_DETECTION_POWER_THRESHOLD, write waveform burst detection minimum burst time attributes.\n\n **Default Value:** NIRFSG_VAL_AUTO\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n \n **Defined Values**:\n ', + 'description': '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_ATTR_WRITE_WAVEFORM_BURST_DETECTION attribute. When you set NIRFSG_ATTR_WRITE_WAVEFORM_BURST_DETECTION_MODE to NIRFSG_VAL_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 attribute to NIRFSG_VAL_MANUAL and specify the burst detection parameters using the write waveform burst detection minimum quiet time, NIRFSG_ATTR_WRITE_WAVEFORM_BURST_DETECTION_POWER_THRESHOLD, write waveform burst detection minimum burst time attributes.\n\n**Default Value:** NIRFSG_VAL_AUTO\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_AUTO', @@ -4181,7 +4176,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' 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 attribute. This attribute is ignored when you disable the NIRFSG_ATTR_WRITE_WAVEFORM_BURST_DETECTION attribute or when you set the NIRFSG_ATTR_WRITE_WAVEFORM_BURST_DETECTION_MODE attribute to NIRFSG_VAL_AUTO.\n\n **Units:** dB\n\n **Default Value:** 0\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' + 'description': '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 attribute. This attribute is ignored when you disable the NIRFSG_ATTR_WRITE_WAVEFORM_BURST_DETECTION attribute or when you set the NIRFSG_ATTR_WRITE_WAVEFORM_BURST_DETECTION_MODE attribute to NIRFSG_VAL_AUTO.\n\n**Units:** dB\n\n**Default Value:** 0\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'lv_property': 'Arb:Write Waveform Burst Detection:Power Threshold', 'name': 'WRITE_WAVEFORM_BURST_DETECTION_POWER_THRESHOLD', @@ -4191,7 +4186,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': '\n **Defined Values**:\n\nName (Value): Description\n\nNIRFSG_VAL_DISABLE (0):\tRF blanking is disabled.\n\nNIRFSG_VAL_ENABLE (1):\tRF blanking is enabled.\n\n **Default Value:** NIRFSG_VAL_DISABLE\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Marker Events `_\n \n Enables or disables RF blanking.\n ', + 'description': '\n**Defined Values**:\n\nName (Value): Description\n\nNIRFSG_VAL_DISABLE (0):\tRF blanking is disabled.\n\nNIRFSG_VAL_ENABLE (1):\tRF blanking is enabled.\n\n**Default Value:** NIRFSG_VAL_DISABLE\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Marker Events `_\n\nEnables or disables RF blanking.', 'note': 'For PXIe-5830/5831/5832: The RF Blanking reserves a PXI trigger line. If you are calling any nirfsg_Reset or `niRFSA_reset `_ on the same device, NI recommends calling it before committing blanking attributes. Alternatively, you can call nirfsg_ResetWithOptions or `niRFSA_ResetWithOptions `_. Select **Routes** in the **steps to omit** parameter.', 'table_body': [ [ @@ -4233,7 +4228,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' 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.\n\n **Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860\n ' + 'description': '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.\n\n**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860' }, 'lv_property': 'De-embedding:Compensation Gain', 'name': 'DEEMBEDDING_COMPENSATION_GAIN', @@ -4246,7 +4241,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the configurations to skip while loading from a file.\n\n **Default Value:** NIRFSG_VAL_SKIP_NONE\n \n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n \n **Defined Values**:\n ', + 'description': 'Specifies the configurations to skip while loading from a file.\n\n**Default Value:** NIRFSG_VAL_SKIP_NONE\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', 'table_body': [ [ 'RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_LOAD_OPTIONS_SKIP_NONE', @@ -4271,7 +4266,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the configurations to skip to reset while loading configurations from a file.\n\n **Default Value:** NIRFSG_VAL_SKIP_NONE\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n \n **Defined Values**:\n ', + 'description': 'Specifies the configurations to skip to reset while loading configurations from a file.\n\n**Default Value:** NIRFSG_VAL_SKIP_NONE\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', 'table_body': [ [ 'RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_NONE', @@ -4295,7 +4290,7 @@ 'Description' ] }, - 'enum': 'ResetOptions', + 'enum': 'LoadConfigurationResetOptions', 'lv_property': 'Load Configurations:Reset Options', 'name': 'LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS', 'type': 'ViInt32' @@ -4304,7 +4299,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the Reference Clock Rate, in Hz, of the signal sent to the Reference Clock Export Output Terminal. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** NIRFSG_VAL_10MHZ\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n \n **Defined Values**:\n ', + 'description': 'Specifies the Reference Clock Rate, in Hz, of the signal sent to the Reference Clock Export Output Terminal. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** NIRFSG_VAL_10MHZ\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_10MHZ', @@ -4337,7 +4332,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies whether to perform the normalization on a waveform.\n\n **Default Value:** NIRFSG_VAL_DISABLE\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n \n **Defined Values**:\n ', + 'description': 'Specifies whether to perform the normalization on a waveform.\n\n**Default Value:** NIRFSG_VAL_DISABLE\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', 'note': 'You can not set NIRFSG_ATTR_WRITE_WAVEFORM_NORMALIZATION and NIRFSG_ATTR_POWER_LEVEL_TYPE attributes at the same time.', 'table_body': [ [ @@ -4363,7 +4358,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the size of the waveform specified by an active channel.\n\n **Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5841 with PXIe-5655/5842/5860\n ' + 'description': 'Specifies the size of the waveform specified by an active channel.\n\n**Supported Devices:** PXIe-5820/5830/5831/5832/5840/5841/5841 with PXIe-5655/5842/5860' }, 'lv_property': 'Arb:Waveform Attributes:Waveform Size', 'name': 'WAVEFORM_WAVEFORM_SIZE', @@ -4376,7 +4371,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' 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.\n\n **Default Value:** NIRFSG_VAL_ACTIVE_HIGH\n\n **Supported Devices:** PXIe-5842\n \n **Defined Values**:\n ', + 'description': '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.\n\n**Default Value:** NIRFSG_VAL_ACTIVE_HIGH\n\n**Supported Devices:** PXIe-5842\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_ACTIVE_HIGH', @@ -4404,26 +4399,26 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' 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.\n\n **Default Value:** NIRFSG_VAL_PULSE_IN_STR\n\n **Supported Devices:** PXIe-5842\n \n **Possible Values**:\n ', + 'description': '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.\n\n**Default Value:** PulseIn\n\n**Supported Devices:** PXIe-5842\n\n **Possible Values**:', 'table_body': [ [ - 'PulseIn', + '"PulseIn"', 'The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842.' ], [ - 'Marker0', + '"Marker0"', 'The trigger is received from the Marker 0.' ], [ - 'Marker1', + '"Marker1"', 'The trigger is received from the Marker 1.' ], [ - 'Marker2', + '"Marker2"', 'The trigger is received from the Marker 2.' ], [ - 'Marker3', + '"Marker3"', 'The trigger is received from the Marker 3.' ] ], @@ -4440,14 +4435,14 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' 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.\n\n **Default Value:** NIRFSG_VAL_PULSE_OUT_STR\n\n **Supported Devices:** PXIe-5842\n \n **Possible Values**:\n ', + 'description': '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.\n\n**Default Value:** PulseOut\n\n**Supported Devices:** PXIe-5842\n\n**Possible Values**:', 'table_body': [ [ - '', + '""', 'Pulse modulation video signal is not exported.' ], [ - 'PulseOut', + '"PulseOut"', 'Export the pulse modulation video signal on the pulse out terminal.' ] ], @@ -4464,7 +4459,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the active level of the exported Pulse Modulation Event. When `attribute 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.\n\n **Default Value:** NIRFSG_VAL_ACTIVE_HIGH\n\n **Supported Devices:** PXIe-5842\n \n **Defined Values**:\n ', + 'description': 'Specifies the active level of the exported Pulse Modulation Event. When `attribute 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.\n\n**Default Value:** NIRFSG_VAL_ACTIVE_HIGH\n\n**Supported Devices:** PXIe-5842\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_ACTIVE_HIGH', @@ -4492,7 +4487,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies which path to configure to generate a signal.\n \n ' + 'description': 'Specifies which path to configure to generate a signal.' }, 'lv_property': 'Signal Path:Advanced:Selected Path', 'name': 'SELECTED_PATH', @@ -4502,7 +4497,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns a comma separated list of the configurable paths available for use based on your instrument configuration.\n \n ' + 'description': 'Returns a comma separated list of the configurable paths available for use based on your instrument configuration.' }, 'lv_property': 'Signal Path:Advanced:Available Paths', 'name': 'AVAILABLE_PATHS', @@ -4512,7 +4507,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Enables or disables compensation for filter group delay on the AWG module. This attribute also accounts for the upconverter group delay and aligns the RF output with the Started Event, Done Event, and Marker Events.\n\n At a low I/Q rate, the group delay can become so large that some devices may not be able to align the events with the RF output, in which case you must increase the I/Q rate or disable this attribute.\n\n **Default Value:** VI_FALSE\n\n **Supported Devices:** PXIe-5672\n \n **Defined Values**:\n ', + 'description': 'Enables or disables compensation for filter group delay on the AWG module. This attribute also accounts for the upconverter group delay and aligns the RF output with the Started Event, Done Event, and Marker Events.\n\nAt a low I/Q rate, the group delay can become so large that some devices may not be able to align the events with the RF output, in which case you must increase the I/Q rate or disable this attribute.\n\n**Default Value:** VI_FALSE\n\n**Supported Devices:** PXIe-5672\n\n**Defined Values**:', 'table_body': [ [ 'VI_TRUE', @@ -4536,7 +4531,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the gain the upconverter applies to the signal.\n\n **Units**: dB\n\n **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\n ', + 'description': 'Specifies the gain the upconverter applies to the signal.\n\n**Units**: dB\n\n**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 attribute is read/write on the PXI-5610 and PXIe-5611 and is read-only on the PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, and PXIe-5820/5830/5831/5832/5840/5841/5842/5860.' }, 'lv_property': 'RF:Upconverter:Gain (dB)', @@ -4547,7 +4542,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Indicates the center frequency of the passband containing the upconverted RF signal. Writing a value to this attribute while using the PXIe-5644/5645/5646, PXIe-5672/5673/5673E, or PXIe-5820/5840/5841 device enables in-band retuning. In-band retuning increases the speed of frequency sweeps by reducing the amount of upconverter retunes.\n\n **Units**: hertz (Hz)\n\n **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\n ', + 'description': 'Indicates the center frequency of the passband containing the upconverted RF signal. Writing a value to this attribute while using the PXIe-5644/5645/5646, PXIe-5672/5673/5673E, or PXIe-5820/5840/5841 device enables in-band retuning. In-band retuning increases the speed of frequency sweeps by reducing the amount of upconverter retunes.\n\n**Units**: hertz (Hz)\n\n**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 attribute is read/write on the PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXIe-5672/5673/5673E, and PXIe-5820/5830/5831/5832/5840/5841/5842, and is read-only on the PXI-5670/5671.\n\n - Resetting this attribute disables in-band retuning, however, for the PXIe-5820, in-band retuning is always enabled.\n\n - For the PXIe-5820, the only valid value for this attribute is 0.\n\n - Setting this attribute 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 attribute is set.' }, 'lv_property': 'RF:Upconverter:Center Frequency (Hz)', @@ -4558,7 +4553,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the frequency of the generated RF signal. For arbitrary waveform generation, this attribute specifies the center frequency of the signal.\n\n The PXI-5670/5671, PXIe-5672, PXIe-5820, and PXIe-5860 must be in the Configuration state to use this attribute. However, the PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXIe-5673/5673E, and PXIe-5830/5831/5832/5840/5841/5842 can be in the Configuration or the Generation state to use this attribute.\n\n **Units**: hertz (Hz)\n\n **Defined Values**:\n Refer to the specifications document for your device allowable frequency settings.\n\n **Default Value:**\n\n PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E: 100MHz\n\n PXIe-5653: 4GHz\n\n PXIe-5820: 0Hz\n\n PXIe-5830/5831/5832: 6.5 GHz\n\n PXIe-5840/5841/5860, PXI-5842 (500 MHz, 1 GHz, and 2 GHz bandwidth options): 1GHz\n\n PXIe-5842 (4 GHz bandwidth option) using the Standard personality: 1GHz\n\n PXIe-5842 (4 GHz bandwidth option) using the 4 GHz Bandwidth personality: 6.5GHz\n\n **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\n\n **Related Topics**\n\n `NI-RFSG Instrument Driver Programming Flow `_\n \n **High-Level Functions**:\n\n - nirfsg_ConfigureRf\n ', + 'description': 'Specifies the frequency of the generated RF signal. For arbitrary waveform generation, this attribute specifies the center frequency of the signal.\n\nThe PXI-5670/5671, PXIe-5672, PXIe-5820, and PXIe-5860 must be in the Configuration state to use this attribute. However, the PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXIe-5673/5673E, and PXIe-5830/5831/5832/5840/5841/5842 can be in the Configuration or the Generation state to use this attribute.\n\n**Units**: hertz (Hz)\n\n**Defined Values**:\nRefer to the specifications document for your device allowable frequency settings.\n\n**Default Value:**\n\nPXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E: 100MHz\n\nPXIe-5653: 4GHz\n\nPXIe-5820: 0Hz\n\nPXIe-5830/5831/5832: 6.5 GHz\n\nPXIe-5840/5841/5860, PXI-5842 (500 MHz, 1 GHz, and 2 GHz bandwidth options): 1GHz\n\nPXIe-5842 (4 GHz bandwidth option) using the Standard personality: 1GHz\n\nPXIe-5842 (4 GHz bandwidth option) using the 4 GHz Bandwidth personality: 6.5GHz\n\n**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\n\n**Related Topics**\n\n`NI-RFSG Instrument Driver Programming Flow `_\n\n**High-Level Functions**:\n\n- nirfsg_ConfigureRf', 'note': 'For the PXIe-5645, this attribute is ignored if you are using the I/Q ports.' }, 'lv_property': 'RF:Frequency (Hz)', @@ -4569,7 +4564,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies either the average power level or peak power level of the generated RF signal, depending on the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute setting.\n\n The PXI-5670/5671, PXIe-5672, and PXIe-5860 must be in the Configuration state to use this attribute. However, the PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696, PXIe-5673/5673E and PXIe-5830/5831/5832/5840/5841/5842 can be in the Configuration or the Generation state to use this attribute.\n\n Refer to the specifications document for your device for allowable power level settings.\n\n **Units**: dBm\n\n **Default Values:**\n\n PXIe-5644/5645/5646, PXIe-5673/5673E: -100\n\n PXI/PXIe-5650/5651/5652: -90\n\n PXIe-5654: -7\n\n PXIe-5654 with PXIe-5696: -110\n\n PXI-5670/5671, PXIe-5672: -145\n\n PXIe-5830/5831/5832/5840/5841/5842/5860: -174\n\n **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\n **High-Level Functions**:\n\n - nirfsg_ConfigureRf\n ', + 'description': 'Specifies either the average power level or peak power level of the generated RF signal, depending on the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute setting.\n\nThe PXI-5670/5671, PXIe-5672, and PXIe-5860 must be in the Configuration state to use this attribute. However, the PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696, PXIe-5673/5673E and PXIe-5830/5831/5832/5840/5841/5842 can be in the Configuration or the Generation state to use this attribute.\n\nRefer to the specifications document for your device for allowable power level settings.\n\n**Units**: dBm\n\n**Default Values:**\n\nPXIe-5644/5645/5646, PXIe-5673/5673E: -100\n\nPXI/PXIe-5650/5651/5652: -90\n\nPXIe-5654: -7\n\nPXIe-5654 with PXIe-5696: -110\n\nPXI-5670/5671, PXIe-5672: -145\n\nPXIe-5830/5831/5832/5840/5841/5842/5860: -174\n\n**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\n**High-Level Functions**:\n\n- nirfsg_ConfigureRf', 'note': '- For the PXIe-5653, this attribute is read-only.\n\n - For the PXIe-5645, this attribute is ignored if you are using the I/Q ports.' }, 'lv_property': 'RF:Power Level (dBm)', @@ -4580,7 +4575,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies whether signal output is enabled. Setting the NIRFSG_ATTR_OUTPUT_ENABLED attribute to VI_FALSE while in the Generation state stops signal output, although generation continues internally. For the PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653, PXI-5670/5671, and PXIe-5672/5673/5673E, setting the NIRFSG_ATTR_OUTPUT_ENABLED attribute while in the Committed state does not transition the device to the Configuration state, but output changes immediately.\n\n **Default Value:** VI_TRUE\n\n **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\n\n **Related Topics**\n\n `Output Enabled `_\n\n `NI-RFSG Instrument Driver Programming Flow `_\n \n **High-Level Functions**:\n\n - nirfsg_ConfigureOutputEnabled\n \n **Defined Values**:\n ', + 'description': 'Specifies whether signal output is enabled. Setting the NIRFSG_ATTR_OUTPUT_ENABLED attribute to VI_FALSE while in the Generation state stops signal output, although generation continues internally. For the PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653, PXI-5670/5671, and PXIe-5672/5673/5673E, setting the NIRFSG_ATTR_OUTPUT_ENABLED attribute while in the Committed state does not transition the device to the Configuration state, but output changes immediately.\n\n**Default Value:** VI_TRUE\n\n**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\n\n**Related Topics**\n\n`Output Enabled `_\n\n`NI-RFSG Instrument Driver Programming Flow `_\n\n**High-Level Functions**:\n\n- nirfsg_ConfigureOutputEnabled\n\n**Defined Values**:', 'note': '- For the PXIe-5653, this attribute controls only the LO1 terminal.\n\n - For the PXIe-5645, this attribute is ignored if you are using the I/Q ports.\n\n - When the NIRFSG_ATTR_ACTIVE_CONFIGURATION_LIST attribute is set to a valid list name, setting the NIRFSG_ATTR_OUTPUT_ENABLED attribute transitions the device to the Configuration state.', 'table_body': [ [ @@ -4605,7 +4600,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Enables or disables pulse modulation.\n\n PXIe-5654/5654 with PXIe-5696: If this attribute 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.\n\n PXIe-5673/5673E: If this attribute 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.\n\n PXIe-5842: If this attribute is enabled and the signal at the PULSE IN front panel connector is high, the device generates a signal. If the signal is low, output generation is disabled. This behavior can be modified by setting pulse modulation active level.\n\n **Default Value:** VI_FALSE\n\n **Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXIe-5673/5673E\n\n **Related Topics**\n\n `Pulse Modulation `_\n \n **Defined Values**:\n ', + 'description': 'Enables or disables pulse modulation.\n\nPXIe-5654/5654 with PXIe-5696: If this attribute 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.\n\nPXIe-5673/5673E: If this attribute 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.\n\nPXIe-5842: If this attribute is enabled and the signal at the PULSE IN front panel connector is high, the device generates a signal. If the signal is low, output generation is disabled. This behavior can be modified by setting pulse modulation active level.\n\n**Default Value:** VI_FALSE\n\n**Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXIe-5673/5673E\n\n**Related Topics**\n\n`Pulse Modulation `_\n\n**Defined Values**:', 'table_body': [ [ 'VI_TRUE', @@ -4629,7 +4624,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' 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_ATTR_REF_CLOCK_SOURCE attribute is set to NIRFSG_VAL_CLK_IN_STR, NIRFSG_VAL_REF_IN_STR, or NIRFSG_VAL_REF_IN_2_STR\n\n To set this attribute, 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 attribute. When you read this attribute, it returns the frequency the device is locked to during the Committed state.\n\n If you set this attribute to NIRFSG_VAL_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.\n\n **Valid Values:**\n\n PXIe-5654/5654 with PXIe-5696: Values between 1MHz to 20MHz in 1MHz steps are supported in addition to the NIRFSG_VAL_AUTO and NIRFSG_VAL_10MHZ values.\n\n PXIe-5841 with PXIe-5655, PXIe-5842: 10 MHz, 100 MHz, 270 MHz, and 3.84 MHz \n\n y, where\n\n y is 4, 8, 16, 24, 25, or 32.\n\n PXIe-5860: 10 MHz, 100 MHz\n\n **Units**: hertz (Hz)\n\n **Default Value:** NIRFSG_VAL_AUTO\n\n **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\n\n **Related Topics**\n\n `Timing Configurations `_\n \n **High-Level Functions**:\n\n - nirfsg_ConfigureRefClock\n \n **Defined Values**:\n ', + 'description': '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_ATTR_REF_CLOCK_SOURCE attribute is set to ClkIn, RefIn, or RefIn2\n\nTo set this attribute, 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 attribute. When you read this attribute, it returns the frequency the device is locked to during the Committed state.\n\nIf you set this attribute to NIRFSG_VAL_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.\n\n**Valid Values:**\n\nPXIe-5654/5654 with PXIe-5696: Values between 1MHz to 20MHz in 1MHz steps are supported in addition to the NIRFSG_VAL_AUTO and NIRFSG_VAL_10MHZ values.\n\nPXIe-5841 with PXIe-5655, PXIe-5842: 10 MHz, 100 MHz, 270 MHz, and 3.84 MHz \n\ny, where\n\ny is 4, 8, 16, 24, 25, or 32.\n\nPXIe-5860: 10 MHz, 100 MHz\n\n**Units**: hertz (Hz)\n\n**Default Value:** NIRFSG_VAL_AUTO\n\n**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\n\n**Related Topics**\n\n`Timing Configurations `_\n\n**High-Level Functions**:\n\n- nirfsg_ConfigureRefClock\n\n**Defined Values**:', '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.', 'table_body': [ [ @@ -4655,7 +4650,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Enables or disables the inverse phase rotation of the I/Q signal by swapping the I and Q inputs.\n\n To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** VI_FALSE\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n \n **Defined Values**:\n ', + 'description': 'Enables or disables the inverse phase rotation of the I/Q signal by swapping the I and Q inputs.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** VI_FALSE\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Defined Values**:', 'table_body': [ [ 'VI_TRUE', @@ -4678,7 +4673,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the waveform in onboard memory to generate upon calling the nirfsg_Init function when the NIRFSG_ATTR_GENERATION_MODE attribute is set to NIRFSG_VAL_ARB_WAVEFORM. The NIRFSG_ATTR_ARB_SELECTED_WAVEFORM attribute is ignored when the NIRFSG_ATTR_GENERATION_MODE attribute is set to NIRFSG_VAL_SCRIPT or NIRFSG_VAL_CW. To set the NIRFSG_ATTR_ARB_SELECTED_WAVEFORM attribute, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** "" (empty string)\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Assigning Properties or Attributes to a Waveform `_\n \n **High-Level Functions**:\n\n - nirfsg_SelectArbWaveform' + 'description': 'Specifies the waveform in onboard memory to generate upon calling the nirfsg_Init function when the NIRFSG_ATTR_GENERATION_MODE attribute is set to NIRFSG_VAL_ARB_WAVEFORM. The NIRFSG_ATTR_ARB_SELECTED_WAVEFORM attribute is ignored when the NIRFSG_ATTR_GENERATION_MODE attribute is set to NIRFSG_VAL_SCRIPT or NIRFSG_VAL_CW. To set the NIRFSG_ATTR_ARB_SELECTED_WAVEFORM attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** "" (empty string)\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Assigning Properties or Attributes to a Waveform `_\n\n**High-Level Functions**:\n\n- nirfsg_SelectArbWaveform' }, 'lv_property': 'Arb:Waveform Capabilities:Selected Waveform', 'name': 'ARB_SELECTED_WAVEFORM', @@ -4688,7 +4683,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' This attribute 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).\n\n This attribute applies only when the NIRFSG_ATTR_GENERATION_MODE attribute is set to NIRFSG_VAL_ARB_WAVEFORM or NIRFSG_VAL_SCRIPT.\n\n To set this attribute, the NI-RFSG device must be in the Configuration state.\n \n Setting this attribute to 50 MS/s on the PXI-5670/5671 and PXIe-5672 has the following implications:\n - 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. \n - Output signal bandwidth must be <5 MHz to avoid aliasing. \n - Close-in phase noise is higher.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Streaming `_\n\n `Assigning Properties or Attributes to a Waveform `_—Refer to this topic for more information about using this attribute to associate an I/Q rate with a waveform.\n\n `Digital Upconverter `_\n \n **Valid Values**:\n ', + 'description': 'This attribute 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).\n\nThis attribute applies only when the NIRFSG_ATTR_GENERATION_MODE attribute is set to NIRFSG_VAL_ARB_WAVEFORM or NIRFSG_VAL_SCRIPT.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\nSetting this attribute to 50 MS/s on the PXI-5670/5671 and PXIe-5672 has the following implications:\n- 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. \n- Output signal bandwidth must be <5 MHz to avoid aliasing. \n- Close-in phase noise is higher.\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Streaming `_\n\n`Assigning Properties or Attributes to a Waveform `_—Refer to this topic for more information about using this attribute to associate an I/Q rate with a waveform.\n\n`Digital Upconverter `_\n\n**Valid Values**:', 'note': 'Use this attribute to associate an I/Q rate with a waveform.', 'table_body': [ [ @@ -4753,7 +4748,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the maximum number of waveforms the device can hold in memory.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n \n **High-Level Functions**:\n\n - nirfsg_QueryArbWaveformCapabilities' + 'description': 'Returns the maximum number of waveforms the device can hold in memory.\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsg_QueryArbWaveformCapabilities' }, 'lv_property': 'Arb:Waveform Capabilities:Max Number Waveforms', 'name': 'ARB_MAX_NUMBER_WAVEFORMS', @@ -4763,7 +4758,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' 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_ATTR_ARB_WAVEFORM_SIZE_MIN and NIRFSG_ATTR_ARB_WAVEFORM_SIZE_MAX arbitrary waveform sizes.\n\n PXI-5671, PXIe-5672: The value of this attribute depends on the I/Q rate. Set the NIRFSG_ATTR_IQ_RATE attribute before reading this attribute.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n \n **High-Level Functions**:\n\n - nirfsg_QueryArbWaveformCapabilities' + 'description': '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_ATTR_ARB_WAVEFORM_SIZE_MIN and NIRFSG_ATTR_ARB_WAVEFORM_SIZE_MAX arbitrary waveform sizes.\n\nPXI-5671, PXIe-5672: The value of this attribute depends on the I/Q rate. Set the NIRFSG_ATTR_IQ_RATE attribute before reading this attribute.\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsg_QueryArbWaveformCapabilities' }, 'lv_property': 'Arb:Waveform Capabilities:Waveform Quantum', 'name': 'ARB_WAVEFORM_QUANTUM', @@ -4773,7 +4768,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the smallest allowable waveform size. For the PXI-5671 and PXIe-5672, the value of this attribute depends on the I/Q rate. Set the NIRFSG_ATTR_IQ_RATE attribute before reading this attribute.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n \n **High-Level Functions**:\n\n - nirfsg_QueryArbWaveformCapabilities' + 'description': 'Returns the smallest allowable waveform size. For the PXI-5671 and PXIe-5672, the value of this attribute depends on the I/Q rate. Set the NIRFSG_ATTR_IQ_RATE attribute before reading this attribute.\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsg_QueryArbWaveformCapabilities' }, 'lv_property': 'Arb:Waveform Capabilities:Min Waveform Size', 'name': 'ARB_WAVEFORM_SIZE_MIN', @@ -4783,7 +4778,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the size of the largest waveform that is allowed.\n\n To read this attribute, the NI-RFSG device must be in the Configuration state.\n\n For the PXI-5671 and PXIe-5672, the value of this attribute depends on the I/Q rate. Set the NIRFSG_ATTR_IQ_RATE before reading this attribute. For the PXIe-5673/5673E, the maximum waveform size is reduced to account for the amount of device memory currently used.\n\n **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n \n **High-Level Functions**:\n\n - nirfsg_QueryArbWaveformCapabilities\n ', + 'description': 'Returns the size of the largest waveform that is allowed.\n\nTo read this attribute, the NI-RFSG device must be in the Configuration state.\n\nFor the PXI-5671 and PXIe-5672, the value of this attribute depends on the I/Q rate. Set the NIRFSG_ATTR_IQ_RATE before reading this attribute. For the PXIe-5673/5673E, the maximum waveform size is reduced to account for the amount of device memory currently used.\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsg_QueryArbWaveformCapabilities', '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.' }, 'lv_property': 'Arb:Waveform Capabilities:Max Waveform Size', @@ -4794,7 +4789,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the Start Trigger type. Depending upon the value of this attribute, more attributes may be needed to fully configure the trigger. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n **Default Value:** NIRFSG_VAL_NONE\n\n **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\n\n **Related Topics**\n\n `Start Trigger `_\n\n `Trigger Types `_\n\n **High-Level Functions**:\n\n - nirfsg_ConfigureDigitalEdgeStartTrigger\n - nirfsg_ConfigureSoftwareStartTrigger\n - nirfsg_DisableStartTrigger\n \n **Defined Values**:\n ', + 'description': 'Specifies the Start Trigger type. Depending upon the value of this attribute, more attributes may be needed to fully configure the trigger. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** NIRFSG_VAL_NONE\n\n**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\n\n**Related Topics**\n\n`Start Trigger `_\n\n`Trigger Types `_\n\n**High-Level Functions**:\n\n- nirfsg_ConfigureDigitalEdgeStartTrigger\n- nirfsg_ConfigureSoftwareStartTrigger\n- nirfsg_DisableStartTrigger\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_NONE', @@ -4827,7 +4822,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': ' Specifies the active edge for the Start Trigger. This attribute is used when the NIRFSG_ATTR_START_TRIGGER_TYPE attribute is set to digital edge. To set the NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_EDGE attribute, the NI-RFSG device must be in the Configuration state.\n\n PXIe-5654/5654 with PXIe-5696: The Start Trigger is valid only with a timer-based list when RF list mode is enabled.\n\n **Default Value:** NIRFSG_VAL_RISING_EDGE\n\n **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\n\n **Related Topics**\n\n `Start Trigger `_\n\n `Digital Edge Trigger `_\n \n **High-Level Functions**:\n\n - nirfsg_ConfigureDigitalEdgeStartTrigger\n \n **Defined Values**:\n ', + 'description': 'Specifies the active edge for the Start Trigger. This attribute is used when the NIRFSG_ATTR_START_TRIGGER_TYPE attribute is set to digital edge. To set the NIRFSG_ATTR_DIGITAL_EDGE_START_TRIGGER_EDGE attribute, the NI-RFSG device must be in the Configuration state.\n\nPXIe-5654/5654 with PXIe-5696: The Start Trigger is valid only with a timer-based list when RF list mode is enabled.\n\n**Default Value:** NIRFSG_VAL_RISING_EDGE\n\n**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\n\n**Related Topics**\n\n`Start Trigger `_\n\n`Digital Edge Trigger `_\n\n**High-Level Functions**:\n\n- nirfsg_ConfigureDigitalEdgeStartTrigger\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_FALLING_EDGE', diff --git a/src/nirfsg/metadata/enums.py b/src/nirfsg/metadata/enums.py index f38c9fbbb..ffca2d350 100644 --- a/src/nirfsg/metadata/enums.py +++ b/src/nirfsg/metadata/enums.py @@ -801,6 +801,39 @@ } ] }, + 'LoadConfigurationResetOptions': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'NI-RFSG skips resetting the waveform configurations.' + }, + 'name': 'RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_WAVEFORMS', + 'value': 1 + }, + { + 'documentation': { + 'description': 'NI-RFSG skips resetting the de-embedding tables.' + }, + 'name': 'RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_DEEMBEDDING_TABLES', + 'value': 8 + }, + { + 'documentation': { + 'description': 'NI-RFSG skips resetting the scripts.' + }, + 'name': 'RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_SCRIPTS', + 'value': 2 + }, + { + 'documentation': { + 'description': 'NI-RFSG resets all configurations.' + }, + 'name': 'RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_NONE', + 'value': 0 + } + ] + }, 'LoadOptions': { 'codegen_method': 'public', 'values': [ @@ -1209,20 +1242,12 @@ 'name': 'NIRFSG_VAL_DISABLE', 'value': 0 }, - { - 'name': 'NIRFSG_VAL_MANUAL', - 'value': 0 - }, { 'documentation': { 'description': 'The RF In local oscillator signal is present at the front panel LO OUT connector.' }, 'name': 'NIRFSG_VAL_ENABLE', 'value': 1 - }, - { - 'name': 'NIRFSG_VAL_SCRIPT_TRIGGER', - 'value': 1 } ] }, @@ -1250,6 +1275,32 @@ } ] }, + 'RefPllBandwidth': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Uses the narrowest loop bandwidth setting for the PLL. Setting this attribute to NIRFSG_VAL_NARROW allows the PXIe-5653 to lock to a reference with worse phase noise than the PXIe-5653 and utilize the better phase noise of the PXIe-5653.' + }, + 'name': 'NIRFSG_VAL_NARROW', + 'value': 0 + }, + { + 'documentation': { + 'description': 'Uses the medium loop bandwidth setting for the PLL.' + }, + 'name': 'NIRFSG_VAL_MEDIUM', + 'value': 1 + }, + { + 'documentation': { + 'description': 'Uses the widest loop bandwidth setting for the PLL. Setting this attribute to NIRFSG_VAL_WIDE on the PXIe-5653 allows the reference PLL to lock to a better reference with better phase noise than the PXIe-5653 and utilize the better phase noise of the reference.' + }, + 'name': 'NIRFSG_VAL_WIDE', + 'value': 2 + } + ] + }, 'ReferenceClockExportedRate': { 'codegen_method': 'public', 'values': [ @@ -1318,55 +1369,6 @@ } ] }, - 'ResetOptions': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'NI-RFSG skips resetting the waveform configurations.' - }, - 'name': 'RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_WAVEFORMS', - 'value': 1 - }, - { - 'name': 'NIRFSG_VAL_MANUAL', - 'value': 0 - }, - { - 'documentation': { - 'description': 'NI-RFSG skips resetting the de-embedding tables.' - }, - 'name': 'RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_DEEMBEDDING_TABLES', - 'value': 8 - }, - { - 'name': 'NIRFSG_VAL_SCRIPT_TRIGGER', - 'value': 1 - }, - { - 'documentation': { - 'description': 'NI-RFSG skips resetting the scripts.' - }, - 'name': 'RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_SCRIPTS', - 'value': 2 - }, - { - 'name': 'NIRFSG_VAL_MARKER_EVENT', - 'value': 2 - }, - { - 'documentation': { - 'description': 'NI-RFSG resets all configurations.' - }, - 'name': 'RFSG_VAL_LOAD_CONFIGURATIONS_FROM_FILE_RESET_OPTIONS_SKIP_NONE', - 'value': 0 - }, - { - 'name': 'NIRFSG_VAL_SELF_CAL_IMAGE_SUPPRESSION', - 'value': 8 - } - ] - }, 'ResetWithOptionsStepsToOmit': { 'codegen_method': 'public', 'values': [ diff --git a/src/nirfsg/metadata/functions.py b/src/nirfsg/metadata/functions.py index 7af666fba..bebed2af1 100644 --- a/src/nirfsg/metadata/functions.py +++ b/src/nirfsg/metadata/functions.py @@ -4,7 +4,7 @@ 'Abort': { 'codegen_method': 'public', 'documentation': { - 'description': ' Stops signal generation.\n\n **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\n\n **Related Topics**\n\n `NI-RFSG Programming State Model `_\n ' + 'description': 'Stops signal generation.\n\n**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\n\n**Related Topics**\n\n`NI-RFSG Programming State Model `_' }, 'included_in_proto': True, 'method_templates': [ @@ -32,7 +32,7 @@ 'AllocateArbWaveform': { 'codegen_method': 'public', 'documentation': { - 'description': ' Allocates onboard memory space for the arbitrary waveform. \n \n Use this function to specify the total size of a waveform before writing the data. Use this function only if you are calling the nirfsg_WriteArbWaveform function multiple times to write a large waveform in smaller blocks.\n\n The NI-RFSG device must be in the Configuration state before you call this function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Streaming Waveform Data `_\n ' + 'description': 'Allocates onboard memory space for the arbitrary waveform. \n\nUse this function to specify the total size of a waveform before writing the data. Use this function only if you are calling the nirfsg_WriteArbWaveform function multiple times to write a large waveform in smaller blocks.\n\nThe NI-RFSG device must be in the Configuration state before you call this function.\n\n**Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Streaming Waveform Data `_' }, 'included_in_proto': True, 'method_templates': [ @@ -80,7 +80,7 @@ 'ChangeExternalCalibrationPassword': { 'codegen_method': 'public', 'documentation': { - 'description': ' Changes the external calibration password of the device.\n\n **Supported Devices:** PXIe-5611, PXIe-5653/5654, PXIe-5673/5673E, PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' + 'description': 'Changes the external calibration password of the device.\n\n**Supported Devices:** PXIe-5611, PXIe-5653/5654, PXIe-5673/5673E, PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'method_templates': [ @@ -128,7 +128,7 @@ 'CheckAttributeViBoolean': { 'codegen_method': 'public', 'documentation': { - 'description': '\n Checks the validity of a value you specify for a ViBoolean attribute.\n ' + 'description': '\nChecks the validity of a value you specify for a ViBoolean attribute.' }, 'included_in_proto': True, 'method_templates': [ @@ -153,7 +153,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the waveform name and the marker name.\n\n Example:\n\n "waveform::waveform0/marker0"\n ' + 'description': 'Specifies the waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' }, 'name': 'channelName', 'type': 'ViConstString', @@ -173,7 +173,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Pass the value that you want to verify as a valid value for the attribute.\n ', + 'description': 'Pass the value that you want to verify as a valid value for the attribute.', 'note': 'Some of the values might not be valid depending on the current settings of the instrument session.' }, 'name': 'value', @@ -187,7 +187,7 @@ 'CheckAttributeViInt32': { 'codegen_method': 'public', 'documentation': { - 'description': ' Checks the validity of a value you specify for a ViInt32 attribute.\n ' + 'description': 'Checks the validity of a value you specify for a ViInt32 attribute.' }, 'included_in_proto': True, 'method_templates': [ @@ -212,7 +212,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the waveform name and the marker name.\n\n Example:\n\n "waveform::waveform0/marker0"\n ' + 'description': 'Specifies the waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' }, 'name': 'channelName', 'type': 'ViConstString', @@ -232,7 +232,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Pass the value that you want to verify as a valid value for the attribute.\n ', + 'description': 'Pass the value that you want to verify as a valid value for the attribute.', 'note': 'Some of the values might not be valid depending on the current settings of the instrument session.' }, 'grpc_enum': 'NiRFSGInt32AttributeValues', @@ -247,7 +247,7 @@ 'CheckAttributeViInt64': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Checks the validity of a value you specify for a ViInt64 attribute.\n ' + 'description': '\nChecks the validity of a value you specify for a ViInt64 attribute.' }, 'included_in_proto': True, 'method_templates': [ @@ -272,7 +272,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the waveform name and the marker name.\n\n Example:\n\n "waveform::waveform0/marker0"\n ' + 'description': 'Specifies the waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' }, 'name': 'channelName', 'type': 'ViConstString', @@ -292,7 +292,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Pass the value that you want to verify as a valid value for the attribute.\n ', + 'description': 'Pass the value that you want to verify as a valid value for the attribute.', 'note': 'Some of the values might not be valid depending on the current settings of the instrument session.' }, 'grpc_enum': 'NiRFSGInt64AttributeValues', @@ -307,7 +307,7 @@ 'CheckAttributeViReal64': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Checks the validity of a value you specify for a ViReal64 attribute.\n ' + 'description': '\nChecks the validity of a value you specify for a ViReal64 attribute.' }, 'included_in_proto': True, 'method_templates': [ @@ -332,7 +332,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the waveform name and the marker name.\n\n Example:\n\n "waveform::waveform0/marker0"\n ' + 'description': 'Specifies the waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' }, 'name': 'channelName', 'type': 'ViConstString', @@ -352,7 +352,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Pass the value that you want to verify as a valid value for the attribute.\n ', + 'description': 'Pass the value that you want to verify as a valid value for the attribute.', 'note': 'Some of the values might not be valid depending on the current settings of the instrument session.' }, 'grpc_enum': 'NiRFSGReal64AttributeValues', @@ -367,7 +367,7 @@ 'CheckAttributeViSession': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Checks the validity of a value you specify for a ViSession attribute.\n ' + 'description': '\nChecks the validity of a value you specify for a ViSession attribute.' }, 'included_in_proto': True, 'method_templates': [ @@ -392,7 +392,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the waveform name and the marker name.\n\n Example:\n\n "waveform::waveform0/marker0"\n ' + 'description': 'Specifies the waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' }, 'name': 'channelName', 'type': 'ViConstString', @@ -412,7 +412,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Pass the value that you want to verify as a valid value for the attribute.\n ', + 'description': 'Pass the value that you want to verify as a valid value for the attribute.', 'note': 'Some of the values might not be valid depending on the current settings of the instrument session.' }, 'name': 'value', @@ -426,7 +426,7 @@ 'CheckAttributeViString': { 'codegen_method': 'public', 'documentation': { - 'description': '\n Checks the validity of a value you specify for a ViString attribute.\n ' + 'description': '\nChecks the validity of a value you specify for a ViString attribute.' }, 'included_in_proto': True, 'method_templates': [ @@ -451,7 +451,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the waveform name and the marker name.\n\n Example:\n\n "waveform::waveform0/marker0"\n ' + 'description': 'Specifies the waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' }, 'name': 'channelName', 'type': 'ViConstString', @@ -471,7 +471,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Pass the value that you want to verify as a valid value for the attribute. The value must be a NULL-terminated string.\n ', + 'description': 'Pass the value that you want to verify as a valid value for the attribute. The value must be a NULL-terminated string.', 'note': 'Some of the values might not be valid depending on the current settings of the instrument session.' }, 'grpc_mapped_enum': 'NiRFSGStringAttributeValuesMapped', @@ -486,7 +486,7 @@ 'CheckGenerationStatus': { 'codegen_method': 'public', 'documentation': { - 'description': '\n Checks the status of the generation. \n \n Call this function to check for any errors that might occur during the signal generation or to check whether the device has finished generating.\n\n **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\n\n **Related Topics**\n\n `NI-RFSG Instrument Driver Programming Flow `_\n\n `Stopping Pear-to-Peer Generation `_\n ' + 'description': '\nChecks the status of the generation. \n\nCall this function to check for any errors that might occur during the signal generation or to check whether the device has finished generating.\n\n**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\n\n**Related Topics**\n\n`NI-RFSG Instrument Driver Programming Flow `_\n\n`Stopping Pear-to-Peer Generation `_' }, 'included_in_proto': True, 'method_templates': [ @@ -511,7 +511,7 @@ { 'direction': 'out', 'documentation': { - 'description': ' Returns information about the completion of signal generation.\n\n **Defined Values** :\n ', + 'description': 'Returns information about the completion of signal generation.\n\n**Defined Values** :', 'table_body': [ [ 'VI_TRUE', @@ -538,7 +538,7 @@ 'CheckIfScriptExists': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Returns whether the script that you specify as NIRFSG_ATTR_SCRIPT_NAME exists.\n\n **Supported Devices** : PXIe-5673/5673E. PXIe-5830/5831/5840/5841/5842/5860\n ' + 'description': '\nReturns whether the script that you specify as NIRFSG_ATTR_SCRIPT_NAME exists.\n\n**Supported Devices** : PXIe-5673/5673E. PXIe-5830/5831/5840/5841/5842/5860' }, 'included_in_proto': True, 'method_templates': [ @@ -573,7 +573,7 @@ { 'direction': 'out', 'documentation': { - 'description': ' Returns VI_TRUE if the script exists.\n\n **Defined Values** :\n ', + 'description': 'Returns VI_TRUE if the script exists.\n\n**Defined Values** :', 'table_body': [ [ 'VI_TRUE', @@ -600,7 +600,7 @@ 'CheckIfWaveformExists': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Returns whether the waveform that you specify as NIRFSG_ATTR_WAVEFORM_NAME exists.\n\n **Supported Devices** : PXIe-5673/5673E, PXIe-5830/5831/5840/5841/5842/5860\n ' + 'description': '\n\nReturns whether the waveform that you specify as NIRFSG_ATTR_WAVEFORM_NAME exists.\n\n**Supported Devices** : PXIe-5673/5673E, PXIe-5830/5831/5840/5841/5842/5860' }, 'included_in_proto': True, 'method_templates': [ @@ -635,7 +635,7 @@ { 'direction': 'out', 'documentation': { - 'description': ' Returns VI_TRUE if the waveform exists.\n\n **Defined Values** :\n ', + 'description': 'Returns VI_TRUE if the waveform exists.\n\n**Defined Values** :', 'table_body': [ [ 'VI_TRUE', @@ -662,7 +662,7 @@ 'ClearAllArbWaveforms': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Deletes all currently defined waveforms and scripts. \n \n The NI-RFSG device must be in the Configuration state before you call this function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' + 'description': '\nDeletes all currently defined waveforms and scripts. \n\nThe NI-RFSG device must be in the Configuration state before you call this function.\n\n**Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'method_templates': [ @@ -690,7 +690,7 @@ 'ClearArbWaveform': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Deletes a specified waveform from the pool of currently defined waveforms. \n \n The NI-RFSG device must be in the Configuration state before you call this function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' + 'description': '\nDeletes a specified waveform from the pool of currently defined waveforms. \n\nThe NI-RFSG device must be in the Configuration state before you call this function.\n\n**Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'method_templates': [ @@ -728,7 +728,7 @@ 'ClearError': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Clears the error information associated with the session. \n \n If you pass VI_NULL for the NIRFSG_ATTR_VI parameter, this function clears the error information for the current execution thread.\n\n The IVI Engine also maintains this error information separately for each thread. This feature of the IVI Engine is useful if you do not have a session handle to pass to the nirfsg_ClearError function or the nirfsg_GetError function, which occurs when a call to the nirfsg_Init function or the nirfsg_InitWithOptions function fails.\n\n **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\n ', + 'description': '\nClears the error information associated with the session. \n\nIf you pass VI_NULL for the NIRFSG_ATTR_VI parameter, this function clears the error information for the current execution thread.\n\nThe IVI Engine also maintains this error information separately for each thread. This feature of the IVI Engine is useful if you do not have a session handle to pass to the nirfsg_ClearError function or the nirfsg_GetError function, which occurs when a call to the nirfsg_Init function or the nirfsg_InitWithOptions function fails.\n\n**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': 'The nirfsg_GetError function clears the error information after it is retrieved. A call to the nirfsg_ClearError function is necessary only when you do not use a call to the nirfsg_GetError function to retrieve error information.' }, 'included_in_proto': True, @@ -757,7 +757,7 @@ 'ClearSelfCalibrateRange': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Clears the data obtained from the nirfsg_SelfCalibrateRange function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842\n ' + 'description': '\nClears the data obtained from the nirfsg_SelfCalibrateRange function.\n\n**Supported Devices** : PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842' }, 'included_in_proto': True, 'method_templates': [ @@ -785,7 +785,7 @@ 'Commit': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Programs the device with the correct settings. \n \n Calling this function moves the NI-RFSG device from the Configuration state to the Committed state. After this function executes, a change to any attribute reverts the NI-RFSG device to the Configuration state.\n\n **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\n\n **Related Topics**\n\n `NI-RFSG Programming State Model `_\n ' + 'description': '\n\nPrograms the device with the correct settings. \n\nCalling this function moves the NI-RFSG device from the Configuration state to the Committed state. After this function executes, a change to any attribute reverts the NI-RFSG device to the Configuration state.\n\n**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\n\n**Related Topics**\n\n`NI-RFSG Programming State Model `_' }, 'included_in_proto': True, 'method_templates': [ @@ -813,7 +813,7 @@ 'ConfigureDeembeddingTableInterpolationLinear': { 'codegen_method': 'public', 'documentation': { - 'description': ' Selects the linear interpolation method. \n \n 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.\n\n **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860\n ' + 'description': 'Selects the linear interpolation method. \n\nIf 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.\n\n**Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'method_templates': [ @@ -894,7 +894,7 @@ 'ConfigureDeembeddingTableInterpolationNearest': { 'codegen_method': 'public', 'documentation': { - 'description': ' Selects the nearest interpolation method. \n \n NI-RFSG uses the parameters of the table nearest to the carrier frequency for de-embedding.\n\n **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860\n ' + 'description': 'Selects the nearest interpolation method. \n\nNI-RFSG uses the parameters of the table nearest to the carrier frequency for de-embedding.\n\n**Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'method_templates': [ @@ -942,7 +942,7 @@ 'ConfigureDeembeddingTableInterpolationSpline': { 'codegen_method': 'public', 'documentation': { - 'description': ' Selects the spline interpolation method. \n \n 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.\n\n **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860\n ' + 'description': 'Selects the spline interpolation method. \n\nIf 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.\n\n**Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'method_templates': [ @@ -990,7 +990,7 @@ 'ConfigureDigitalEdgeScriptTrigger': { 'codegen_method': 'public', 'documentation': { - 'description': ' Purpose\n\n Configures the specified Script Trigger for digital edge triggering. \n \n The NI-RFSG device must be in the Configuration state before calling this function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Script Trigger `_\n\n `Digital Edge Trigger `_\n ' + 'description': '\n\nConfigures the specified Script Trigger for digital edge triggering. \n\nThe NI-RFSG device must be in the Configuration state before calling this function.\n\n**Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Script Trigger `_\n\n`Digital Edge Trigger `_' }, 'included_in_proto': True, 'method_templates': [ @@ -1048,7 +1048,7 @@ 'ConfigureDigitalEdgeStartTrigger': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Configures the Start Trigger for digital edge triggering. \n \n The NI-RFSG device must be in the Configuration state before calling this function.\n\n **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\n\n **Related Topics**\n\n `Start Trigger `_\n\n `Digital Edge Trigger `_\n ', + 'description': '\n\nConfigures the Start Trigger for digital edge triggering. \n\nThe NI-RFSG device must be in the Configuration state before calling this function.\n\n**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\n\n**Related Topics**\n\n`Start Trigger `_\n\n`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.' }, 'included_in_proto': True, @@ -1097,7 +1097,7 @@ 'ConfigureDigitalLevelScriptTrigger': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Configures a specified Script Trigger for digital level triggering. \n \n The NI-RFSG device must be in the Configuration state before calling this function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Script Trigger `_\n\n `Digital Level Trigger `_\n ' + 'description': '\n\nConfigures a specified Script Trigger for digital level triggering. \n\nThe NI-RFSG device must be in the Configuration state before calling this function.\n\n**Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Script Trigger `_\n\n`Digital Level Trigger `_' }, 'included_in_proto': True, 'method_templates': [ @@ -1155,7 +1155,7 @@ 'ConfigureDigitalModulationUserDefinedWaveform': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Specifies the message signal used for digital modulation when the NIRFSG_ATTR_DIGITAL_MODULATION_WAVEFORM_TYPE attribute is set to NIRFSG_VAL_USER_DEFINED.\n\n **Supported Devices** : PXI/PXIe-5650/5651/5652\n ' + 'description': '\nSpecifies the message signal used for digital modulation when the NIRFSG_ATTR_DIGITAL_MODULATION_WAVEFORM_TYPE attribute is set to NIRFSG_VAL_USER_DEFINED.\n\n**Supported Devices** : PXI/PXIe-5650/5651/5652' }, 'included_in_proto': True, 'method_templates': [ @@ -1207,7 +1207,7 @@ 'ConfigureGenerationMode': { 'codegen_method': 'public', 'documentation': { - 'description': '\n Configures the NI-RFSG device to generate a continuous sine tone (CW), apply I/Q (vector) modulation to the RF output signal, or generate arbitrary waveforms according to scripts. \n \n The NI-RFSG device must be in the Configuration state before you call this function.\n\n **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\n\n **Related Topics**\n\n `Assigning Properties or Attributes to a Waveform `_\n\n `Scripting Instructions `_--Refer to this topic for more information about VST restrictions on scripts.\n ' + 'description': '\nConfigures the NI-RFSG device to generate a continuous sine tone (CW), apply I/Q (vector) modulation to the RF output signal, or generate arbitrary waveforms according to scripts. \n\nThe NI-RFSG device must be in the Configuration state before you call this function.\n\n**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\n\n**Related Topics**\n\n`Assigning Properties or Attributes to a Waveform `_\n\n`Scripting Instructions `_--Refer to this topic for more information about VST restrictions on scripts.' }, 'included_in_proto': True, 'method_templates': [ @@ -1269,7 +1269,7 @@ 'ConfigureOutputEnabled': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Enables or disables signal output. \n \n Setting NIRFSG_ATTR_OUTPUT_ENABLED to VI_FALSE while in the Generation state attenuates the generated signal so that no signal is output.\n\n **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\n\n **Related Topics**\n\n `Output Enabled `_\n\n `NI-RFSG Instrument Driver Programming Flow `_\n\n `RF List Mode `_\n ' + 'description': '\n\nEnables or disables signal output. \n\nSetting NIRFSG_ATTR_OUTPUT_ENABLED to VI_FALSE while in the Generation state attenuates the generated signal so that no signal is output.\n\n**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\n\n**Related Topics**\n\n`Output Enabled `_\n\n`NI-RFSG Instrument Driver Programming Flow `_\n\n`RF List Mode `_' }, 'included_in_proto': True, 'method_templates': [ @@ -1307,7 +1307,7 @@ 'ConfigureP2PEndpointFullnessStartTrigger': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Configures the Start Trigger to detect peer-to-peer endpoint fullness. \n \n Generation begins when the number of samples in the peer-to-peer endpoint reaches the threshold specified by the NIRFSG_ATTR_P2P_ENDPOINT_FULLNESS_LEVEL parameter. The NI-RFSG device must be in the Configuration state before calling this function.\n\n **Supported Devices** : PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Start Trigger `_\n ', + 'description': '\nConfigures the Start Trigger to detect peer-to-peer endpoint fullness. \n\nGeneration begins when the number of samples in the peer-to-peer endpoint reaches the threshold specified by the NIRFSG_ATTR_P2P_ENDPOINT_FULLNESS_LEVEL parameter. The NI-RFSG device must be in the Configuration state before calling this function.\n\n**Supported Devices** : PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Start Trigger `_', 'note': 'Due to an additional internal FIFO in the RF signal generator, the writer peer actually writes 2,304 bytes more than the quantity of data specified by this function to satisfy the trigger level.' }, 'included_in_proto': True, @@ -1346,7 +1346,7 @@ 'ConfigurePowerLevelType': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Specifies the way the driver interprets the NIRFSG_ATTR_POWER_LEVEL attribute. \n \n In average power mode, NI-RFSG automatically scales waveform data to use the maximum dynamic range. In peak power mode, waveforms are scaled according to the NIRFSG_ATTR_ARB_WAVEFORM_SOFTWARE_SCALING_FACTOR attribute.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Spurious Performance `_\n\n `Optimizing for Low Power Generation `_\n ' + 'description': '\n\nSpecifies the way the driver interprets the NIRFSG_ATTR_POWER_LEVEL attribute. \n\nIn average power mode, NI-RFSG automatically scales waveform data to use the maximum dynamic range. In peak power mode, waveforms are scaled according to the NIRFSG_ATTR_ARB_WAVEFORM_SOFTWARE_SCALING_FACTOR attribute.\n\n**Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Spurious Performance `_\n\n`Optimizing for Low Power Generation `_' }, 'included_in_proto': True, 'method_templates': [ @@ -1371,7 +1371,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the way the driver interprets the value of the NIRFSG_ATTR_POWER_LEVEL attribute. NI-RFSG sets the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute to this value.\n ', + 'description': 'Specifies the way the driver interprets the value of the NIRFSG_ATTR_POWER_LEVEL attribute. NI-RFSG sets the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute to this value.', 'table_body': [ [ 'Average Power (default)', @@ -1401,7 +1401,7 @@ 'ConfigurePxiChassisClk10': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Specifies the signal to drive the 10MHz Reference Clock on the PXI backplane. \n \n This option can only be configured when the PXI-5610 is in Slot 2 of the PXI chassis. The NI-RFSG device must be in the Configuration state before you call this function.\n\n **Supported Devices** : PXI-5610, PXI-5670/5671\n\n **Related Topics**\n\n `Timing Configurations `_\n\n `System Reference Clock `_\n ' + 'description': '\n\nSpecifies the signal to drive the 10MHz Reference Clock on the PXI backplane. \n\nThis option can only be configured when the PXI-5610 is in Slot 2 of the PXI chassis. The NI-RFSG device must be in the Configuration state before you call this function.\n\n**Supported Devices** : PXI-5610, PXI-5670/5671\n\n**Related Topics**\n\n`Timing Configurations `_\n\n`System Reference Clock `_' }, 'included_in_proto': True, 'method_templates': [ @@ -1439,7 +1439,7 @@ 'ConfigureRF': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Configures the frequency and power level of the RF output signal. \n \n The PXI-5670/5671, PXIe-5672, and PXIe-5860 device must be in the Configuration state before calling this function. 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 function.\n\n **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\n\n **Related Topics**\n\n `NI-RFSG Instrument Driver Programming Flow `_\n ' + 'description': '\nConfigures the frequency and power level of the RF output signal. \n\nThe PXI-5670/5671, PXIe-5672, and PXIe-5860 device must be in the Configuration state before calling this function. 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 function.\n\n**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\n\n**Related Topics**\n\n`NI-RFSG Instrument Driver Programming Flow `_' }, 'included_in_proto': True, 'method_templates': [ @@ -1464,7 +1464,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the frequency of the generated RF signal, in hertz. For arbitrary waveform generation, this parameter specifies the center frequency of the signal.\n\n **Units** : hertz (Hz)\n ' + 'description': 'Specifies the frequency of the generated RF signal, in hertz. For arbitrary waveform generation, this parameter specifies the center frequency of the signal.\n\n**Units** : hertz (Hz)' }, 'name': 'frequency', 'type': 'ViReal64', @@ -1474,7 +1474,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies either the average power level or peak power level of the generated RF signal, depending on the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute.\n\n **Units** : dBm\n ' + 'description': 'Specifies either the average power level or peak power level of the generated RF signal, depending on the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute.\n\n**Units** : dBm' }, 'name': 'powerLevel', 'type': 'ViReal64', @@ -1487,7 +1487,7 @@ 'ConfigureRefClock': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Configures the NI-RFSG device Reference Clock. \n \n 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 function.\n\n **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\n\n **Related Topics**\n\n `PXIe-5672 Timing Configurations `_\n\n `PXIe-5673 Timing Configurations `_\n\n `PXIe-5673E Timing Configurations `_\n\n `PXIe-5830 Timing Configurations `_\n\n `PXIe-5831 Timing Configurations `_\n ' + 'description': '\n\nConfigures the NI-RFSG device Reference Clock. \n\nThe 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 function.\n\n**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\n\n**Related Topics**\n\n`PXIe-5672 Timing Configurations `_\n\n`PXIe-5673 Timing Configurations `_\n\n`PXIe-5673E Timing Configurations `_\n\n`PXIe-5830 Timing Configurations `_\n\n`PXIe-5831 Timing Configurations `_' }, 'included_in_proto': True, 'method_templates': [ @@ -1515,39 +1515,32 @@ 'description': 'Specifies the source of Reference Clock signal.', 'table_body': [ [ - 'NIRFSG_VAL_ONBOARD_CLOCK_STR (default)', - 'OnboardClock', + '"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.' ], [ - 'NIRFSG_VAL_REF_IN_STR', - 'RefIn', + '"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.' ], [ - 'NIRFSG_VAL_PXI_CLK_STR', - 'PXI_CLK', + '"PXI_CLK"', 'Uses the PXI_CLK signal, which is present on the PXI backplane, as the clock source.' ], [ - 'NIRFSG_VAL_CLK_IN_STR', - 'ClkIn', + '"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.' ], [ - 'NIRFSG_VAL_REF_IN_2_STR', - 'RefIn2', + '"RefIn2"', '\\-' ], [ - 'NIRFSG_VAL_PXI_CLK_MASTER_STR', - 'PXI_ClkMaster', + '"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.' ] ], 'table_header': [ - 'Reference Clock Constant', - 'Value', + 'Possible Values', 'Description' ] }, @@ -1559,7 +1552,7 @@ { 'direction': 'in', 'documentation': { - 'description': '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_ATTR_REF_CLOCK_SOURCE parameter is set to NIRFSG_VAL_CLK_IN_STR, NIRFSG_VAL_REF_IN_STR or NIRFSG_VAL_REF_IN_2_STR. Refer to the NIRFSG_ATTR_REF_CLOCK_RATE attribute for possible values.' + 'description': '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_ATTR_REF_CLOCK_SOURCE parameter is set to ClkIn, RefIn or RefIn2. Refer to the NIRFSG_ATTR_REF_CLOCK_RATE attribute for possible values.' }, 'name': 'refClockRate', 'type': 'ViReal64', @@ -1572,7 +1565,7 @@ 'ConfigureSignalBandwidth': { 'codegen_method': 'public', 'documentation': { - 'description': ' Configures the signal bandwidth of the arbitrary waveform.\n\n The NI-RFSG device must be in the Configuration state before you call this function.\n\n NI-RFSG defines *signal bandwidth* as twice the maximum baseband signal deviation from 0 Hz. Usually, the baseband signal center frequency is 0Hz. In such cases, the signal bandwidth is simply the baseband signal minimum frequency subtracted from its maximum frequency, or *f* max minus *f* min. NI-RFSG uses this value to optimally configure the center frequency of the upconverter to help minimize phase noise. The generated signal is not filtered to achieve the set bandwidth. However, specifying a bandwidth smaller than the actual bandwidth of the signal could potentially result in spectral distortion.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ', + 'description': 'Configures the signal bandwidth of the arbitrary waveform.\n\nThe NI-RFSG device must be in the Configuration state before you call this function.\n\nNI-RFSG defines *signal bandwidth* as twice the maximum baseband signal deviation from 0 Hz. Usually, the baseband signal center frequency is 0Hz. In such cases, the signal bandwidth is simply the baseband signal minimum frequency subtracted from its maximum frequency, or *f* max minus *f* min. NI-RFSG uses this value to optimally configure the center frequency of the upconverter to help minimize phase noise. The generated signal is not filtered to achieve the set bandwidth. However, specifying a bandwidth smaller than the actual bandwidth of the signal could potentially result in spectral distortion.\n\n**Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', 'note': 'Based on your signal bandwidth, NI-RFSG decides whether to configure the upconverter center frequency on the PXI-5670/5671 or PXIe-5672 in increments of 1MHz or 5MHz. Failure to configure signal bandwidth may result in the signal being placed outside the upconverter passband.' }, 'included_in_proto': True, @@ -1611,7 +1604,7 @@ 'ConfigureSoftwareScriptTrigger': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Configures the Script Trigger for software triggering. \n \n Refer to the nirfsg_SendSoftwareEdgeTrigger function for more information about using the software Script Trigger. The NI-RFSG device must be in the Configuration state before calling this function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Script Trigger `_\n\n `Trigger Types `_\n ' + 'description': '\nConfigures the Script Trigger for software triggering. \n\nRefer to the nirfsg_SendSoftwareEdgeTrigger function for more information about using the software Script Trigger. The NI-RFSG device must be in the Configuration state before calling this function.\n\n**Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Script Trigger `_\n\n`Trigger Types `_' }, 'included_in_proto': True, 'method_templates': [ @@ -1649,7 +1642,7 @@ 'ConfigureSoftwareStartTrigger': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Configures the Start Trigger for software triggering. \n \n Refer to the nirfsg_SendSoftwareEdgeTrigger function for more information about using a software trigger. The NI-RFSG device must be in the Configuration state before calling this function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n\n\n **Related Topics**\n\n `Start Trigger `_\n\n `Trigger Types `_\n ' + 'description': '\n\nConfigures the Start Trigger for software triggering. \n\nRefer to the nirfsg_SendSoftwareEdgeTrigger function for more information about using a software trigger. The NI-RFSG device must be in the Configuration state before calling this function.\n\n**Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Start Trigger `_\n\n`Trigger Types `_' }, 'included_in_proto': True, 'method_templates': [ @@ -1677,7 +1670,7 @@ 'CreateDeembeddingSparameterTableS2PFile': { 'codegen_method': 'public', 'documentation': { - 'description': ' Creates an S-parameter de-embedding table for the port based on the specified S2P file.\n\n If you only create one table for a port, NI-RFSG automatically selects that table to de-embed the measurement.\n\n **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `De-embedding Overview `_\n\n `S-parameters `_\n ' + 'description': 'Creates an S-parameter de-embedding table for the port based on the specified S2P file.\n\nIf you only create one table for a port, NI-RFSG automatically selects that table to de-embed the measurement.\n\n**Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`De-embedding Overview `_\n\n`S-parameters `_' }, 'included_in_proto': True, 'method_templates': [ @@ -1763,7 +1756,7 @@ 'DeleteAllDeembeddingTables': { 'codegen_method': 'public', 'documentation': { - 'description': ' Deletes all configured de-embedding tables for the session.\n\n **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860\n ' + 'description': 'Deletes all configured de-embedding tables for the session.\n\n**Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'method_templates': [ @@ -1791,7 +1784,7 @@ 'DeleteDeembeddingTable': { 'codegen_method': 'public', 'documentation': { - 'description': ' Deletes the selected de-embedding table for a given port.\n\n **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860\n ' + 'description': 'Deletes the selected de-embedding table for a given port.\n\n**Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'method_templates': [ @@ -1839,7 +1832,7 @@ 'Disable': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Places the instrument in a quiescent state where it has minimal or no impact on the system to which it is connected.\n\n **Supported Devices** : PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXI-5670/5671, PXIe-5672/5673/5673E\n ' + 'description': '\nPlaces the instrument in a quiescent state where it has minimal or no impact on the system to which it is connected.\n\n**Supported Devices** : PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXI-5670/5671, PXIe-5672/5673/5673E' }, 'included_in_proto': True, 'method_templates': [ @@ -1867,7 +1860,7 @@ 'DisableScriptTrigger': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Configures the device not to wait for the specified Script Trigger. \n \n Call this function 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 function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Script Trigger `_\n ' + 'description': '\nConfigures the device not to wait for the specified Script Trigger. \n\nCall this function 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 function.\n\n**Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Script Trigger `_' }, 'included_in_proto': True, 'method_templates': [ @@ -1905,7 +1898,7 @@ 'DisableStartTrigger': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Configures the device not to wait for a Start Trigger. \n \n This function 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 function.\n\n **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\n\n **Related Topics**\n\n `Start Trigger `_\n ' + 'description': '\n\nConfigures the device not to wait for a Start Trigger. \n\nThis function 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 function.\n\n**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\n\n**Related Topics**\n\n`Start Trigger `_' }, 'included_in_proto': True, 'method_templates': [ @@ -2039,7 +2032,7 @@ 'ExportSignal': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Routes signals (triggers, clocks, and events) to a specified output terminal. \n \n The NI-RFSG device must be in the Configuration state before you call this function.\n\n You can clear a previously routed signal by exporting the signal to "" (empty string).\n\n **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\n\n **Related Topics**\n\n `Triggers `_\n\n `Events `_\n\n `PFI Lines `_\n\n `PXI Trigger Lines `_\n ' + 'description': '\n\nRoutes signals (triggers, clocks, and events) to a specified output terminal. \n\nThe NI-RFSG device must be in the Configuration state before you call this function.\n\nYou can clear a previously routed signal by exporting the signal to "" (empty string).\n\n**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\n\n**Related Topics**\n\n`Triggers `_\n\n`Events `_\n\n`PFI Lines `_\n\n`PXI Trigger Lines `_' }, 'included_in_proto': True, 'method_templates': [ @@ -2064,7 +2057,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the type of signal to route. **Defined Values** :', + 'description': ' Specifies the type of signal to route.\n\n **Defined Values** :', 'table_body': [ [ 'NIRFSG_VAL_START_TRIGGER', @@ -2122,38 +2115,38 @@ { 'direction': 'in', 'documentation': { - 'description': "Specifies which instance of the selected signal to export. This parameter is useful when you set the NIRFSG_ATTR_SIGNAL parameter to NIRFSG_VAL_SCRIPT_TRIGGER or NIRFSG_VAL_MARKER_EVENT. Otherwise, set the NIRFSG_ATTR_SIGNAL_IDENTIFIER parameter to '' (empty string). **Possible Values** :", + 'description': 'Specifies which instance of the selected signal to export. This parameter is useful when you set the NIRFSG_ATTR_SIGNAL parameter to NIRFSG_VAL_SCRIPT_TRIGGER or NIRFSG_VAL_MARKER_EVENT. Otherwise, set the NIRFSG_ATTR_SIGNAL_IDENTIFIER parameter to "".\n\n**Possible Values** :', 'table_body': [ [ - 'marker0', + '"marker0"', 'Specifies Marker 0.' ], [ - 'marker1', + '"marker1"', 'Specifies Marker 1.' ], [ - 'marker2', + '"marker2"', 'Specifies Marker 2.' ], [ - 'marker3', + '"marker3"', 'Specifies Marker 3.' ], [ - 'scriptTrigger0', + '"scriptTrigger0"', 'Specifies Script Trigger 0.' ], [ - 'scriptTrigger1', + '"scriptTrigger1"', 'Specifies Script Trigger 1.' ], [ - 'scriptTrigger2', + '"scriptTrigger2"', 'Specifies Script Trigger 2.' ], [ - 'scriptTrigger3', + '"scriptTrigger3"', 'Specifies Script Trigger 3.' ] ], @@ -2170,22 +2163,22 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the terminal where the signal is exported. You can choose not to export any signal. For the PXIe-5841 with PXIe-5655, the signal is exported to the terminal on the PXIe-5841. **Possible Values** :', + 'description': 'Specifies the terminal where the signal is exported. You can choose not to export any signal. For the PXIe-5841 with PXIe-5655, the signal is exported to the terminal on the PXIe-5841.\n\n **Possible Values** :', 'table_body': [ [ - 'ClkOut', + '"ClkOut"', 'Exports the Reference Clock signal to the CLK OUT connector of the device.' ], [ - '', + '""', 'The Reference Clock signal is not exported.' ], [ - 'RefOut', + '"RefOut"', 'Exports the Reference Clock signal to the REF OUT connector of the device.' ], [ - 'RefOut2', + '"RefOut2"', 'Exports the Reference Clock signal to the REF OUT2 connector of the device, if applicable.' ] ], @@ -2205,7 +2198,7 @@ 'GetAllNamedWaveformNames': { 'codegen_method': 'public', 'documentation': { - 'description': '\n Return names of the waveforms present in the memory.\n\n **Supported Devices** :PXIe-5830/5831/5840/5841/5842E\n ' + 'description': '\nReturn names of the waveforms present in the memory.\n\n**Supported Devices** :PXIe-5830/5831/5840/5841/5842E' }, 'included_in_proto': True, 'method_templates': [ @@ -2245,7 +2238,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Pass the number of bytes in the ViChar buffer you specify for the NIRFSG_ATTR_WAVEFORM_NAMES parameter.\n\n If you pass 0, you can pass VI_NULL for the NIRFSG_ATTR_WAVEFORM_NAMES parameter.\n ' + 'description': 'Pass the number of bytes in the ViChar buffer you specify for the NIRFSG_ATTR_WAVEFORM_NAMES parameter.\n\nIf you pass 0, you can pass VI_NULL for the NIRFSG_ATTR_WAVEFORM_NAMES parameter.' }, 'name': 'bufferSize', 'type': 'ViInt32', @@ -2255,7 +2248,7 @@ { 'direction': 'out', 'documentation': { - 'description': ' Fetch the number of bytes needed to pass in the NIRFSG_ATTR_BUFFER_SIZE parameter.\n\n It can be fetch by passing VI_NULL in the NIRFSG_ATTR_WAVEFORM_NAMES parameter.\n ' + 'description': 'Fetch the number of bytes needed to pass in the NIRFSG_ATTR_BUFFER_SIZE parameter.\n\nIt can be fetch by passing VI_NULL in the NIRFSG_ATTR_WAVEFORM_NAMES parameter.' }, 'name': 'actualBufferSize', 'type': 'ViInt32', @@ -2268,7 +2261,7 @@ 'GetAllScriptNames': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Return names of the scripts present in the memory.\n\n **Supported Devices** :PXIe-5830/5831/5840/5841/5842E\n ' + 'description': '\n\nReturn names of the scripts present in the memory.\n\n**Supported Devices** :PXIe-5830/5831/5840/5841/5842E' }, 'included_in_proto': True, 'method_templates': [ @@ -2307,7 +2300,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Pass the number of bytes in the ViChar buffer you specify for the **waveformNames** parameter.\n\n If you pass 0, you can pass VI_NULL for the **waveformNames** parameter.\n ' + 'description': 'Pass the number of bytes in the ViChar buffer you specify for the **waveformNames** parameter.\n\nIf you pass 0, you can pass VI_NULL for the **waveformNames** parameter.' }, 'name': 'bufferSize', 'type': 'ViInt32', @@ -2317,7 +2310,7 @@ { 'direction': 'out', 'documentation': { - 'description': ' Fetch the number of bytes needed to pass in the NIRFSG_ATTR_BUFFER_SIZE parameter.\n\n It can be fetch by passing VI_NULL in the NIRFSG_ATTR_SCRIPT_NAMES parameter.\n ' + 'description': 'Fetch the number of bytes needed to pass in the NIRFSG_ATTR_BUFFER_SIZE parameter.\n\nIt can be fetch by passing VI_NULL in the NIRFSG_ATTR_SCRIPT_NAMES parameter.' }, 'name': 'actualBufferSize', 'type': 'ViInt32', @@ -2330,7 +2323,7 @@ 'GetAttributeViBoolean': { 'codegen_method': 'private', 'documentation': { - 'description': ' \n Queries the value of a ViBoolean attribute.\n\n Use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid.\n ' + 'description': '\nQueries the value of a ViBoolean attribute.\n\nUse this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n- State caching is disabled for the entire session or for the particular attribute.\n- State caching is enabled, and the currently cached value is invalid.' }, 'included_in_proto': True, 'method_templates': [ @@ -2355,7 +2348,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the waveform name and the marker name.\n\n Example:\n\n "waveform::waveform0/marker0"\n ' + 'description': 'Specifies the waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' }, 'name': 'channelName', 'type': 'ViConstString', @@ -2388,7 +2381,7 @@ 'GetAttributeViInt32': { 'codegen_method': 'private', 'documentation': { - 'description': ' \n\n Queries the value of a ViInt32 attribute.\n\n Use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid.\n ' + 'description': '\n\nQueries the value of a ViInt32 attribute.\n\nUse this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n- State caching is disabled for the entire session or for the particular attribute.\n- State caching is enabled, and the currently cached value is invalid.' }, 'included_in_proto': True, 'method_templates': [ @@ -2413,7 +2406,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the waveform name and the marker name.\n\n Example:\n\n "waveform::waveform0/marker0"\n ' + 'description': 'Specifies the waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' }, 'name': 'channelName', 'type': 'ViConstString', @@ -2446,7 +2439,7 @@ 'GetAttributeViInt64': { 'codegen_method': 'private', 'documentation': { - 'description': ' \n Queries the value of a ViInt64 attribute.\n\n You can use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid.\n ' + 'description': '\nQueries the value of a ViInt64 attribute.\n\nYou can use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n- State caching is disabled for the entire session or for the particular attribute.\n- State caching is enabled, and the currently cached value is invalid.' }, 'included_in_proto': True, 'method_templates': [ @@ -2471,7 +2464,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the waveform name and the marker name.\n\n Example:\n\n "waveform::waveform0/marker0"\n ' + 'description': 'Specifies the waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' }, 'name': 'channelName', 'type': 'ViConstString', @@ -2504,7 +2497,7 @@ 'GetAttributeViReal64': { 'codegen_method': 'private', 'documentation': { - 'description': ' \n \n Queries the value of a ViReal64 attribute.\n\n Use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid.\n ' + 'description': '\n\nQueries the value of a ViReal64 attribute.\n\nUse this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n- State caching is disabled for the entire session or for the particular attribute.\n- State caching is enabled, and the currently cached value is invalid.' }, 'included_in_proto': True, 'method_templates': [ @@ -2529,7 +2522,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the waveform name and the marker name.\n\n Example:\n\n "waveform::waveform0/marker0"\n ' + 'description': 'Specifies the waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' }, 'name': 'channelName', 'type': 'ViConstString', @@ -2562,7 +2555,7 @@ 'GetAttributeViSession': { 'codegen_method': 'private', 'documentation': { - 'description': ' \n Queries the value of a ViSession attribute.\n\n Use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid.\n ' + 'description': '\nQueries the value of a ViSession attribute.\n\nUse this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n- State caching is disabled for the entire session or for the particular attribute.\n- State caching is enabled, and the currently cached value is invalid.' }, 'included_in_proto': True, 'method_templates': [ @@ -2587,7 +2580,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the waveform name and the marker name.\n\n Example:\n\n "waveform::waveform0/marker0"\n ' + 'description': 'Specifies the waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' }, 'name': 'channelName', 'type': 'ViConstString', @@ -2620,7 +2613,7 @@ 'GetAttributeViString': { 'codegen_method': 'private', 'documentation': { - 'description': ' \n \n\n Queries the value of a ViString attribute.\n\n Use this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid.\n\n You must provide a ViString (ViChar array) to serve as a buffer for the value. Pass the number of bytes in the buffer as the Buffer Size parameter. If the current value of the attribute, including the terminating NULL byte, is larger than the size you indicate in the buffer size parameter, the function copies buffer size-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 function places "123" into the buffer and returns 7.\n\n To call this function to get only the required buffer size, pass 0 for the buffer size and VI_NULL for the attribute value buffer.\n ' + 'description': '\n\n\nQueries the value of a ViString attribute.\n\nUse this low-level function to get the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n- State caching is disabled for the entire session or for the particular attribute.\n- State caching is enabled, and the currently cached value is invalid.\n\nYou must provide a ViString (ViChar array) to serve as a buffer for the value. Pass the number of bytes in the buffer as the Buffer Size parameter. If the current value of the attribute, including the terminating NULL byte, is larger than the size you indicate in the buffer size parameter, the function copies buffer size-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 function places "123" into the buffer and returns 7.\n\nTo call this function to get only the required buffer size, pass 0 for the buffer size and VI_NULL for the attribute value buffer.' }, 'included_in_proto': True, 'method_templates': [ @@ -2645,7 +2638,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the waveform name and the marker name.\n\n Example:\n\n "waveform::waveform0/marker0"\n ' + 'description': 'Specifies the waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' }, 'name': 'channelName', 'type': 'ViConstString', @@ -2665,7 +2658,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Pass the number of bytes in the ViChar buffer you specify for the **waveformNames** parameter.\n\n If you pass 0, you can pass VI_NULL for the **waveformNames** parameter.\n ' + 'description': 'Pass the number of bytes in the ViChar buffer you specify for the **waveformNames** parameter.\n\nIf you pass 0, you can pass VI_NULL for the **waveformNames** parameter.' }, 'name': 'bufSize', 'type': 'ViInt32', @@ -2675,7 +2668,7 @@ { 'direction': 'out', 'documentation': { - 'description': ' The buffer in which the function returns the current value of the attribute. The buffer must be of type ViChar and have at least as many bytes as indicated in the **bufferSize** parameter.\n\n If you specify 0 for the **bufferSize** parameter, you can pass VI_NULL for this parameter.\n ' + 'description': 'The buffer in which the function returns the current value of the attribute. The buffer must be of type ViChar and have at least as many bytes as indicated in the **bufferSize** parameter.\n\nIf you specify 0 for the **bufferSize** parameter, you can pass VI_NULL for this parameter.' }, 'name': 'value', 'size': { @@ -2692,7 +2685,7 @@ 'GetChannelName': { 'codegen_method': 'public', 'documentation': { - 'description': ' Returns the channel string that is in the channel table at an index you specify.\n\n **Supported Devices** : PXI-5670/5671, PXIe-5672/5673/5673E\n ' + 'description': 'Returns the channel string that is in the channel table at an index you specify.\n\n**Supported Devices** : PXI-5670/5671, PXIe-5672/5673/5673E' }, 'included_in_proto': True, 'method_templates': [ @@ -2754,7 +2747,7 @@ 'GetError': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Retrieves and then clears the IVI error information for the session or the current execution thread.\n\n **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\n ', + 'description': '\nRetrieves and then clears the IVI error information for the session or the current execution thread.\n\n**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 function 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_ATTR_ERROR_DESCRIPTION string. You can then call this function again with a sufficiently large buffer. If you specify a valid IVI session for the NIRFSG_ATTR_VI parameter, this function retrieves and clears the error information for the session. If you pass VI_NULL for the NIRFSG_ATTR_VI parameter, this function retrieves and clears the error information for the current execution thread. If the NIRFSG_ATTR_VI parameter is an invalid session, this function does nothing and returns an error. Normally, the error information describes the first error that occurred since the user last called this function or the niRFSG_ClearError function.' }, 'included_in_proto': True, @@ -2792,7 +2785,7 @@ 'default_value': '256', 'direction': 'in', 'documentation': { - 'description': ' Pass the number of bytes in the ViChar array you specify for the **description** parameter.\n\n If the NIRFSG_ATTR_ERROR_DESCRIPTION, including the terminating NULL byte, contains more bytes than you indicate in this parameter, the function 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. Forexample, if the value is 123456 and the buffer size is 4, the function places 123 into the buffer and returns 7. If you pass 0, you can pass VI_NULL for the **description** parameter.\n\n **Default Value** : None\n\n ' + 'description': 'Pass the number of bytes in the ViChar array you specify for the **description** parameter.\n\nIf the NIRFSG_ATTR_ERROR_DESCRIPTION, including the terminating NULL byte, contains more bytes than you indicate in this parameter, the function 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. Forexample, if the value is 123456 and the buffer size is 4, the function places 123 into the buffer and returns 7. If you pass 0, you can pass VI_NULL for the **description** parameter.\n\n**Default Value** : None' }, 'name': 'errorDescriptionBufferSize', 'type': 'ViInt32', @@ -2802,7 +2795,7 @@ { 'direction': 'out', 'documentation': { - 'description': ' Returns the NIRFSG_ATTR_ERROR_DESCRIPTION for the IVI session or execution thread.\n\n If there is no description, the function 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_ATTR_ERROR_DESCRIPTION, including the terminating NULL byte, contains more bytes than you indicate with the **bufferSize** parameter, the function 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 function places 123 into the buffer and returns 7. If you pass 0, you can pass VI_NULL for this parameter.\n\n ' + 'description': 'Returns the NIRFSG_ATTR_ERROR_DESCRIPTION for the IVI session or execution thread.\n\nIf there is no description, the function 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_ATTR_ERROR_DESCRIPTION, including the terminating NULL byte, contains more bytes than you indicate with the **bufferSize** parameter, the function 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 function places 123 into the buffer and returns 7. If you pass 0, you can pass VI_NULL for this parameter.' }, 'name': 'errorDescription', 'size': { @@ -2820,7 +2813,7 @@ 'GetExternalCalibrationLastDateAndTime': { 'codegen_method': 'private', 'documentation': { - 'description': ' \n Returns the date and time of the last successful external calibration. \n \n The time returned is 24-hour (military) local time; for example, if the device was calibrated at 2:30PM, this function returns\n\n 14 for the hours parameter and\n\n 30 for the minutes parameter.\n\n **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\n ' + 'description': '\nReturns the date and time of the last successful external calibration. \n\nThe time returned is 24-hour (military) local time; for example, if the device was calibrated at 2:30PM, this function returns\n\n14 for the hours parameter and\n\n30 for the minutes parameter.\n\n**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' }, 'included_in_proto': True, 'method_name_for_documentation': 'get_external_calibration_last_date_and_time', @@ -2961,7 +2954,7 @@ 'GetMaxSettablePower': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Returns the maximum settable output power level for the current configuration.\n\n **Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860\n ' + 'description': '\n\nReturns the maximum settable output power level for the current configuration.\n\n**Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'method_templates': [ @@ -2999,7 +2992,7 @@ 'GetSelfCalibrationDateAndTime': { 'codegen_method': 'private', 'documentation': { - 'description': '\n Returns the date and time of the last successful self-calibration. \n \n The time returned is 24-hour local time. For example, if the device was calibrated at 2:30PM, this function returns\n\n 14 for the hours parameter and\n\n 30 for the minutes parameter.\n\n **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\n ' + 'description': '\nReturns the date and time of the last successful self-calibration. \n\nThe time returned is 24-hour local time. For example, if the device was calibrated at 2:30PM, this function returns\n\n14 for the hours parameter and\n\n30 for the minutes parameter.\n\n**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' }, 'included_in_proto': True, 'method_name_for_documentation': 'get_self_calibration_date_and_time', @@ -3090,7 +3083,7 @@ 'GetSelfCalibrationTemperature': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Returns the temperature, in degrees Celsius, of the device at the last successful self-calibration.\n\n **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\n ' + 'description': '\nReturns the temperature, in degrees Celsius, of the device at the last successful self-calibration.\n\n**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' }, 'included_in_proto': True, 'method_templates': [ @@ -3161,7 +3154,7 @@ 'GetStreamEndpointHandle': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Returns a reader endpoint handle that can be used with NI-P2P to configure a peer-to-peer stream with an RF signal generator endpoint.\n\n **Supported Devices** : PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n\n `Configuring a Peer-to-Peer Stream `_\n\n `Configuring Flow Control `_\n ' + 'description': '\n\nReturns a reader endpoint handle that can be used with NI-P2P to configure a peer-to-peer stream with an RF signal generator endpoint.\n\n**Supported Devices** : PXIe-5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Related Topics**\n\n`Configuring a Peer-to-Peer Stream `_\n\n`Configuring Flow Control `_' }, 'included_in_proto': True, 'method_templates': [ @@ -3209,7 +3202,7 @@ 'GetTerminalName': { 'codegen_method': 'public', 'documentation': { - 'description': '\n Returns the fully-qualified name of the specified signal. \n \n The fully-qualified name is helpful to automatically route signals in a multisegment chassis.\n\n **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\n\n **Related Topics**\n\n `Triggers `_\n\n `Events `_\n\n `Syntax for Terminal Names `_\n ' + 'description': '\nReturns the fully-qualified name of the specified signal. \n\nThe fully-qualified name is helpful to automatically route signals in a multisegment chassis.\n\n**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\n\n**Related Topics**\n\n`Triggers `_\n\n`Events `_\n\n`Syntax for Terminal Names `_' }, 'included_in_proto': True, 'method_templates': [ @@ -3292,38 +3285,38 @@ { 'direction': 'in', 'documentation': { - 'description': "Specifies which instance of the selected signal to query. This parameter is necessary when you set the NIRFSG_ATTR_SIGNAL parameter to NIRFSG_VAL_SCRIPT_TRIGGER or NIRFSG_VAL_MARKER_EVENT . Otherwise, set the NIRFSG_ATTR_SIGNAL_IDENTIFIER parameter to '' (empty string). **Possible Values** :\n ", + 'description': 'Specifies which instance of the selected signal to query. This parameter is necessary when you set the NIRFSG_ATTR_SIGNAL parameter to NIRFSG_VAL_SCRIPT_TRIGGER or NIRFSG_VAL_MARKER_EVENT . Otherwise, set the NIRFSG_ATTR_SIGNAL_IDENTIFIER parameter to "" (empty string). **Possible Values** :\n ', 'table_body': [ [ - 'marker0', + '"marker0"', 'Specifies Marker 0.' ], [ - 'marker1', + '"marker1"', 'Specifies Marker 1.' ], [ - 'marker2', + '"marker2"', 'Specifies Marker 2.' ], [ - 'marker3', + '"marker3"', 'Specifies Marker 3.' ], [ - 'scriptTrigger0', + '"scriptTrigger0"', 'Specifies Script Trigger 0.' ], [ - 'scriptTrigger1', + '"scriptTrigger1"', 'Specifies Script Trigger 1.' ], [ - 'scriptTrigger2', + '"scriptTrigger2"', 'Specifies Script Trigger 2.' ], [ - 'scriptTrigger3', + '"scriptTrigger3"', 'Specifies Script Trigger 3.' ] ], @@ -3340,7 +3333,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Pass the number of bytes in the ViChar buffer you specify for the **NIRFSG_ATTR_TERMINAL_NAME** parameter.\n\n If you pass 0, you can pass VI_NULL for the **NIRFSG_ATTR_TERMINAL_NAME** parameter.\n ' + 'description': 'Pass the number of bytes in the ViChar buffer you specify for the **NIRFSG_ATTR_TERMINAL_NAME** parameter.\n\nIf you pass 0, you can pass VI_NULL for the **NIRFSG_ATTR_TERMINAL_NAME** parameter.' }, 'name': 'bufferSize', 'type': 'ViInt32', @@ -3583,7 +3576,7 @@ 'InitWithOptions': { 'codegen_method': 'private', 'documentation': { - 'description': '\n Opens a session to the device you specify as the NIRFSG_ATTR_RESOURCE_NAME and returns a ViSession handle that you use to identify the NI-RFSG device in all subsequent NI-RFSG function calls. \n \n This function also configures the device through the NIRFSG_ATTR_OPTION_STRING input.\n\n **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\n\n **Related Topics**\n\n `Simulating an NI RF Signal Generator `_\n ', + 'description': '\nOpens a session to the device you specify as the NIRFSG_ATTR_RESOURCE_NAME and returns a ViSession handle that you use to identify the NI-RFSG device in all subsequent NI-RFSG function calls. \n\nThis function also configures the device through the NIRFSG_ATTR_OPTION_STRING input.\n\n**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\n\n**Related Topics**\n\n`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.' }, 'included_in_proto': True, @@ -3600,7 +3593,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the resource name of the device to initialize.\n\n 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.\n\n 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.\n\n ', + 'description': 'Specifies the resource name of the device to initialize.\n\nFor 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.\n\nYou 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.' }, 'name': 'resourceName', @@ -3612,7 +3605,7 @@ 'default_value': False, 'direction': 'in', 'documentation': { - 'description': ' Specifies whether you want NI-RFSG to perform an ID query.\n\n **Defined Values** :\n ', + 'description': 'Specifies whether you want NI-RFSG to perform an ID query.\n\n**Defined Values** :', 'table_body': [ [ 'VI_TRUE (1)', @@ -3637,7 +3630,7 @@ 'default_value': False, 'direction': 'in', 'documentation': { - 'description': ' Specifies whether you want to reset the NI-RFSG device during the initialization procedure.\n\n **Defined Values** :\n\n ', + 'description': 'Specifies whether you want to reset the NI-RFSG device during the initialization procedure.\n\n**Defined Values** :', 'table_body': [ [ 'VI_TRUE (1)', @@ -3661,7 +3654,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the initial value of certain attributes for the session. The following table lists the attributes and the name you pass in this parameter to identify the attribute.\n\n The format of this string consists of the following relations:\n "AttributeName=Value"\n\n where\n *AttributeName* is the name of the attribute and *Value* is the value to which the attribute is set. To set multiple attributes, separate their assignments with a comma, as shown in the following option string:\n\n "RangeCheck=1,QueryInstrStatus=0,Cache=1,DriverSetup=AWG:pxi1slot4"\n\n The `DriverSetup string `_ is required in order to simulate a specific device.\n ', + 'description': 'Specifies the initial value of certain attributes for the session. The following table lists the attributes and the name you pass in this parameter to identify the attribute.\n\nThe format of this string consists of the following relations:\n"AttributeName=Value"\n\nwhere\n*AttributeName* is the name of the attribute and *Value* is the value to which the attribute is set. To set multiple attributes, separate their assignments with a comma, as shown in the following option string:\n\n"RangeCheck=1,QueryInstrStatus=0,Cache=1,DriverSetup=AWG:pxi1slot4"\n\nThe `DriverSetup string `_ is required in order to simulate a specific device.', 'table_body': [ [ 'RangeCheck', @@ -3711,7 +3704,7 @@ 'Initiate': { 'codegen_method': 'private', 'documentation': { - 'description': ' \n\n Initiates signal generation, causing the NI-RFSG device to leave the Configuration state and enter the Generation state. \n \n If the settings have not been committed to the device before you call this function, they are committed by this function. The operation returns when the RF output signal settles. To return to the Configuration state, call the nirfsg_Abort function.\n\n **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\n\n **Related Topics**\n\n `NI-RFSG Instrument Driver Programming Flow `_\n ' + 'description': '\n\nInitiates signal generation, causing the NI-RFSG device to leave the Configuration state and enter the Generation state. \n\nIf the settings have not been committed to the device before you call this function, they are committed by this function. The operation returns when the RF output signal settles. To return to the Configuration state, call the nirfsg_Abort function.\n\n**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\n\n**Related Topics**\n\n`NI-RFSG Instrument Driver Programming Flow `_' }, 'included_in_proto': True, 'parameters': [ @@ -3731,7 +3724,7 @@ 'LoadConfigurationsFromFile': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Loads the configurations from the specified file to the NI-RFSG driver session. \n \n The VI does an implicit reset before loading the configurations from the file.\n\n **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' + 'description': '\nLoads the configurations from the specified file to the NI-RFSG driver session. \n\nThe VI does an implicit reset before loading the configurations from the file.\n\n**Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'method_templates': [ @@ -3756,7 +3749,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the waveform name and the marker name.\n\n Example:\n\n "waveform::waveform0/marker0"\n ' + 'description': 'Specifies the waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' }, 'name': 'channelName', 'type': 'ViConstString', @@ -3779,7 +3772,7 @@ 'LockSession': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Obtains a multithread lock on the instrument session. \n \n Before doing so, this function waits until all other execution threads have released their locks on the instrument session.\n\n Other threads might have obtained a lock on this session in the following ways:\n\n - Your application already called the nirfsg_LockSession function.\n - A call to NI-RFSG locked the session.\n\n After the call to this function returns successfully, no other threads can access the instrument session until you call the nirfsg_UnlockSession function. Use the nirfsg_LockSession function and the nirfsg_UnlockSession function around a sequence of calls to NI-RFSG functions if you require that the NI-RFSG device retain its settings through the end of the sequence.\n\n You can safely make nested calls to the nirfsg_LockSession function within the same thread. To completely unlock the session, balance each call to the nirfsg_LockSession function with a call to the nirfsg_UnlockSession function. If, however, you use the NIRFSG_ATTR_CALLER_HAS_LOCK parameter in all calls to the nirfsg_LockSession function and the nirfsg_UnlockSession function within a function, the IVI Library locks the session only once within the function regardless of the number of calls you make to the nirfsg_LockSession function. Locking the session only once allows you to call nirfsg_UnlockSession just once at the end of the function.\n\n **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860\n ' + 'description': '\nObtains a multithread lock on the instrument session. \n\nBefore doing so, this function waits until all other execution threads have released their locks on the instrument session.\n\nOther threads might have obtained a lock on this session in the following ways:\n\n- Your application already called the nirfsg_LockSession function.\n- A call to NI-RFSG locked the session.\n\nAfter the call to this function returns successfully, no other threads can access the instrument session until you call the nirfsg_UnlockSession function. Use the nirfsg_LockSession function and the nirfsg_UnlockSession function around a sequence of calls to NI-RFSG functions if you require that the NI-RFSG device retain its settings through the end of the sequence.\n\nYou can safely make nested calls to the nirfsg_LockSession function within the same thread. To completely unlock the session, balance each call to the nirfsg_LockSession function with a call to the nirfsg_UnlockSession function. If, however, you use the NIRFSG_ATTR_CALLER_HAS_LOCK parameter in all calls to the nirfsg_LockSession function and the nirfsg_UnlockSession function within a function, the IVI Library locks the session only once within the function regardless of the number of calls you make to the nirfsg_LockSession function. Locking the session only once allows you to call nirfsg_UnlockSession just once at the end of the function.\n\n**Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860' }, 'included_in_proto': True, 'method_templates': [ @@ -3804,7 +3797,7 @@ { 'direction': 'out', 'documentation': { - 'description': ' Keeps track of whether you obtain a lock and therefore need to unlock the session. Pass the address of a local ViBoolean variable. In the declaration of the local variable, initialize it to VI_FALSE. Pass the address of the same local variable to any other calls you make to the nirfsg_LockSession function or the nirfsg_UnlockSession function in the same function.\n\n\n\n This parameter serves as a convenience. If you do not want to use this parameter, pass VI_NULL.\n\n The parameter is an input/output parameter. The nirfsg_LockSession function and the nirfsg_UnlockSession each inspect the current value and take the following actions:\n\n - If the value is VI_TRUE, the nirfsg_LockSession function does not lock the session again. If the value is VI_FALSE, the nirfsg_LockSession function obtains the lock and sets the value of the parameter to VI_TRUE.\n - If the value is VI_FALSE, the nirfsg_UnlockSession function does not attempt to unlock the session. If the value is VI_TRUE, the nirfsg_UnlockSession function releases the lock and sets the value of the parameter to VI_FALSE.\n\n Thus, you can call the nirfsg_UnlockSession function at the end of your function without worrying about whether you have the lock.\n\n Example:\n\n ViStatus TestFunc (ViSession vi, ViInt32 flags)\n {\n ViStatus error = VI_SUCCESS;\n ViBoolean haveLock = VI_FALSE;\n\n if (flags & BIT_1)\n {\n viCheckErr( nirfsg_LockSession(vi, &haveLock));\n viCheckErr( TakeAction1(vi));\n if (flags & BIT_2)\n {\n viCheckErr( nirfsg_UnlockSession(vi, &haveLock));\n viCheckErr( TakeAction2(vi));\n viCheckErr( nirfsg_LockSession(vi, &haveLock));\n }\n if (flags & BIT_3)\n viCheckErr( TakeAction3(vi));\n }\n\n Error:\n \n At this point, you cannot really be sure that you have the lock.\n Fortunately, the haveLock variable takes care of that for you.\n \n nirfsg_UnlockSession(vi, &haveLock);\n return error;\n }\n\n ' + 'description': 'Keeps track of whether you obtain a lock and therefore need to unlock the session. Pass the address of a local ViBoolean variable. In the declaration of the local variable, initialize it to VI_FALSE. Pass the address of the same local variable to any other calls you make to the nirfsg_LockSession function or the nirfsg_UnlockSession function in the same function.\n\nThis parameter serves as a convenience. If you do not want to use this parameter, pass VI_NULL.\n\nThe parameter is an input/output parameter. The nirfsg_LockSession function and the nirfsg_UnlockSession each inspect the current value and take the following actions:\n\n- If the value is VI_TRUE, the nirfsg_LockSession function does not lock the session again. If the value is VI_FALSE, the nirfsg_LockSession function obtains the lock and sets the value of the parameter to VI_TRUE.\n- If the value is VI_FALSE, the nirfsg_UnlockSession function does not attempt to unlock the session. If the value is VI_TRUE, the nirfsg_UnlockSession function releases the lock and sets the value of the parameter to VI_FALSE.\n\nThus, you can call the nirfsg_UnlockSession function at the end of your function without worrying about whether you have the lock.\n\nExample:\n\nViStatus TestFunc (ViSession vi, ViInt32 flags)\n{\nViStatus error = VI_SUCCESS;\nViBoolean haveLock = VI_FALSE;\n\nif (flags & BIT_1)\n{\nviCheckErr( nirfsg_LockSession(vi, &haveLock));\nviCheckErr( TakeAction1(vi));\nif (flags & BIT_2)\n{\nviCheckErr( nirfsg_UnlockSession(vi, &haveLock));\nviCheckErr( TakeAction2(vi));\nviCheckErr( nirfsg_LockSession(vi, &haveLock));\n}\nif (flags & BIT_3)\nviCheckErr( TakeAction3(vi));\n}\n\nError:\n\nAt this point, you cannot really be sure that you have the lock.\nFortunately, the haveLock variable takes care of that for you.\n\nnirfsg_UnlockSession(vi, &haveLock);\nreturn error;\n}' }, 'name': 'callerHasLock', 'type': 'ViBoolean', @@ -3820,7 +3813,7 @@ 'PerformPowerSearch': { 'codegen_method': 'public', 'documentation': { - 'description': '\n Performs a power search if the NIRFSG_ATTR_ALC_CONTROL attribute is disabled. \n \n Calling this function disables modulation for a short time while the device levels the output signal.\n\n **Supported Devices** : PXIe-5654 with PXIe-5696\n\n **Related Topics**\n\n `Power Search `_\n ', + 'description': '\nPerforms a power search if the NIRFSG_ATTR_ALC_CONTROL attribute is disabled. \n\nCalling this function disables modulation for a short time while the device levels the output signal.\n\n**Supported Devices** : PXIe-5654 with PXIe-5696\n\n**Related Topics**\n\n`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.' }, 'included_in_proto': True, @@ -3849,7 +3842,7 @@ 'PerformThermalCorrection': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Corrects for any signal drift due to environmental temperature variation when generating the same signal for extended periods of time without a parameter change. \n \n 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 function.\n\n Use this function 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 function.\n\n **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\n\n **Related Topics**\n\n `Thermal Management `_\n\n `Impairment Calibration `_\n ' + 'description': '\nCorrects for any signal drift due to environmental temperature variation when generating the same signal for extended periods of time without a parameter change. \n\nUnder 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 function.\n\nUse this function 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 function.\n\n**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\n\n**Related Topics**\n\n`Thermal Management `_\n\n`Impairment Calibration `_' }, 'included_in_proto': True, 'method_templates': [ @@ -3877,7 +3870,7 @@ 'QueryArbWaveformCapabilities': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Queries and returns the waveform capabilities of the NI-RFSG device. \n \n 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 function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' + 'description': '\nQueries and returns the waveform capabilities of the NI-RFSG device. \n\nThese capabilities are related to the current device configuration. The NI-RFSG device must be in the Configuration or the Generation state before calling this function.\n\n**Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'method_templates': [ @@ -3945,7 +3938,7 @@ 'ReadAndDownloadWaveformFromFileTDMS': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Reads the waveforms from a TDMS file and downloads one waveform into each of the NI RF vector signal generators.\n\n This function reads the following information from the TDMS file and writes it into the NI-RFSG session:\n\n - Sample Rate\n - PAPR\n - Runtime Scaling\n - RF Blanking Marker Locations\n - RF Blanking Enabled\n - Burst Start Locations\n - Burst Stop Locations\n - RF Blanking Marker Source\n - Signal Bandwidth\n - Waveform Size\n\n 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.\n\n **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842\n ' + 'description': '\nReads the waveforms from a TDMS file and downloads one waveform into each of the NI RF vector signal generators.\n\nThis function reads the following information from the TDMS file and writes it into the NI-RFSG session:\n\n- Sample Rate\n- PAPR\n- Runtime Scaling\n- RF Blanking Marker Locations\n- RF Blanking Enabled\n- Burst Start Locations\n- Burst Stop Locations\n- RF Blanking Marker Source\n- Signal Bandwidth\n- Waveform Size\n\nIf 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.\n\n**Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842' }, 'included_in_proto': True, 'method_templates': [ @@ -3970,7 +3963,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the name used to store the waveform. This string is case-insensitive.\n\n Example:\n\n "waveform::waveform0"\n ' + 'description': 'Specifies the name used to store the waveform. This string is case-insensitive.\n\nExample:\n\n"waveform::waveform0"' }, 'name': 'waveformName', 'type': 'ViConstString', @@ -4003,7 +3996,7 @@ 'Reset': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Resets all attributes to their default values and moves the NI-RFSG device to the Configuration state. \n \n This function aborts the generation, deletes all de-embedding tables, clears all routes, and resets session attributes to their initial values. During a reset, routes of signals between this and other devices are released, regardless of which device created the route.\n\n Generally, calling this function instead of the nirfsg_ResetDevice function is acceptable. The nirfsg_Reset function executes faster than the nirfsg_ResetDevice function.\n\n 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_ResetWithOptions function, with **stepsToOmit** set to NIRFSG_VAL_RESET_WITH_OPTIONS_ROUTES .\n\n **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\n ', + 'description': '\n\nResets all attributes to their default values and moves the NI-RFSG device to the Configuration state. \n\nThis function aborts the generation, deletes all de-embedding tables, clears all routes, and resets session attributes to their initial values. During a reset, routes of signals between this and other devices are released, regardless of which device created the route.\n\nGenerally, calling this function instead of the nirfsg_ResetDevice function is acceptable. The nirfsg_Reset function executes faster than the nirfsg_ResetDevice function.\n\nTo 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_ResetWithOptions function, with **stepsToOmit** set to NIRFSG_VAL_RESET_WITH_OPTIONS_ROUTES .\n\n**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 function 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.' }, 'included_in_proto': True, @@ -4032,7 +4025,7 @@ 'ResetAttribute': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Resets the attribute to its default value.\n\n **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\n ' + 'description': '\n\nResets the attribute to its default value.\n\n**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' }, 'included_in_proto': True, 'method_templates': [ @@ -4057,7 +4050,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the waveform name and the marker name.\n\n Example:\n\n "waveform::waveform0/marker0"\n ' + 'description': 'Specifies the waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' }, 'name': 'channelName', 'type': 'ViConstString', @@ -4080,7 +4073,7 @@ 'ResetDevice': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Performs a hard reset on the device which consists of the following actions:\n\n - Signal generation is stopped.\n - All routes are released.\n - External bidirectional terminals are tristated.\n - FPGAs are reset.\n - Hardware is configured to its default state.\n - All session attributes are reset to their default states.\n\n During a device reset, routes of signals between this and other devices are released, regardless of which device created the route.\n\n - PXI-5610, PXI-5670/5671, PXIe-5672-- After calling this function, 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.\n\n **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\n\n **Related Topics**\n\n `Thermal Shutdown `_\n ', + 'description': '\nPerforms a hard reset on the device which consists of the following actions:\n\n- Signal generation is stopped.\n- All routes are released.\n- External bidirectional terminals are tristated.\n- FPGAs are reset.\n- Hardware is configured to its default state.\n- All session attributes are reset to their default states.\n\nDuring a device reset, routes of signals between this and other devices are released, regardless of which device created the route.\n\n- PXI-5610, PXI-5670/5671, PXIe-5672-- After calling this function, 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.\n\n**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\n\n**Related Topics**\n\n`Thermal Shutdown `_', 'note': 'You must call the nirfsg_ResetDevice function if the NI-RFSG device has shut down because of a high-temperature condition.' }, 'included_in_proto': True, @@ -4109,7 +4102,7 @@ 'ResetWithDefaults': { 'codegen_method': 'public', 'documentation': { - 'description': '\n Performs a software reset of the device, returning it to the default state and applying any initial default settings from the IVI Configuration Store.\n\n **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\n ' + 'description': '\nPerforms a software reset of the device, returning it to the default state and applying any initial default settings from the IVI Configuration Store.\n\n**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' }, 'included_in_proto': True, 'method_templates': [ @@ -4137,7 +4130,7 @@ 'RevisionQuery': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Returns the revision numbers of the NI-RFSG driver and the instrument firmware.\n\n **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\n ' + 'description': '\nReturns the revision numbers of the NI-RFSG driver and the instrument firmware.\n\n**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' }, 'included_in_proto': True, 'method_templates': [ @@ -4162,7 +4155,7 @@ { 'direction': 'out', 'documentation': { - 'description': ' Returns the value of the NIRFSG_ATTR_SPECIFIC_DRIVER_REVISION attribute in the form of a string.\n\n You must pass a ViChar array with at least 256 bytes.\n\n ' + 'description': 'Returns the value of the NIRFSG_ATTR_SPECIFIC_DRIVER_REVISION attribute in the form of a string.\n\nYou must pass a ViChar array with at least 256 bytes.' }, 'name': 'instrumentDriverRevision', 'size': { @@ -4176,7 +4169,7 @@ { 'direction': 'out', 'documentation': { - 'description': ' Returns the value of the NIRFSG_ATTR_INSTRUMENT_FIRMWARE_REVISION attribute in the form of a string.\n\n You must pass a ViChar array with at least 256 bytes.\n\n ' + 'description': 'Returns the value of the NIRFSG_ATTR_INSTRUMENT_FIRMWARE_REVISION attribute in the form of a string.\n\nYou must pass a ViChar array with at least 256 bytes.' }, 'name': 'firmwareRevision', 'size': { @@ -4193,7 +4186,7 @@ 'SaveConfigurationsToFile': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Saves the configurations of the session to the specified file.\n\n **Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ' + 'description': '\n\nSaves the configurations of the session to the specified file.\n\n**Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'method_templates': [ @@ -4218,7 +4211,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the waveform name and the marker name.\n\n Example:\n\n "waveform::waveform0/marker0"\n ' + 'description': 'Specifies the waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' }, 'name': 'channelName', 'type': 'ViConstString', @@ -4241,7 +4234,7 @@ 'SelectArbWaveform': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Specifies the waveform that is generated upon a call to the nirfsg_Initiate function when the **generationMode** parameter of the nirfsg_ConfigureGenerationMode function is set to NIRFSG_VAL_ARB_WAVEFORM. \n \n You must specify a waveform using the NIRFSG_ATTR_NAME parameter if you have written multiple waveforms. The NI-RFSG device must be in the Configuration state before you call this function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Assigning Properties or Attributes to a Waveform `_\n ' + 'description': '\n\nSpecifies the waveform that is generated upon a call to the nirfsg_Initiate function when the **generationMode** parameter of the nirfsg_ConfigureGenerationMode function is set to NIRFSG_VAL_ARB_WAVEFORM. \n\nYou must specify a waveform using the NIRFSG_ATTR_NAME parameter if you have written multiple waveforms. The NI-RFSG device must be in the Configuration state before you call this function.\n\n**Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Assigning Properties or Attributes to a Waveform `_' }, 'included_in_proto': True, 'method_templates': [ @@ -4279,7 +4272,7 @@ 'SelfCal': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Performs an internal self-calibration on the device and associated modules that support self-calibration. \n \n If the calibration is successful, new calibration data and constants are stored in the onboard nonvolatile memory of the module.\n\n The PXIe-5841 maintains separate self-calibration data for both the PXIe-5841 standalone and when associated with the PXIe-5655. Use this function once for each intended configuration.\n\n **Supported Devices** : PXI-5610, PXIe-5653, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ', + 'description': '\nPerforms an internal self-calibration on the device and associated modules that support self-calibration. \n\nIf the calibration is successful, new calibration data and constants are stored in the onboard nonvolatile memory of the module.\n\nThe PXIe-5841 maintains separate self-calibration data for both the PXIe-5841 standalone and when associated with the PXIe-5655. Use this function once for each intended configuration.\n\n**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 function runs, it may remain open but cannot be used for operations that access the hardware, for example niRFSA_Commit or niRFSA_Initiate.' }, 'included_in_proto': True, @@ -4308,7 +4301,7 @@ 'SelfCalibrateRange': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Self-calibrates all configurations within the specified frequency and peak power level limits.\n\n Self-calibration range data is valid until you restart the system or call the nirfsg_ClearSelfCalibrateRange function.\n\n NI recommends that no external signals are present on the RF In or IQ In ports during the calibration.\n\n 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.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842\n ', + 'description': '\nSelf-calibrates all configurations within the specified frequency and peak power level limits.\n\nSelf-calibration range data is valid until you restart the system or call the nirfsg_ClearSelfCalibrateRange function.\n\nNI recommends that no external signals are present on the RF In or IQ In ports during the calibration.\n\nFor 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.\n\n**Supported Devices** : PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842', 'note': '- This function does not update self-calibration date and temperature.\n\n - 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 function runs.\n\n - If there is an existing NI-RFSA session open for the same PXIe-5820/5830/5831/5832/5840/5841/5842 while this function runs, it may remain open but cannot be used for operations that access the hardware, for example niRFSA_Commit or niRFSA_Initiate.' }, 'included_in_proto': True, @@ -4334,7 +4327,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' 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.\n\n **Default Value** : NIRFSG_VAL_SELF_CAL_OMIT_NONE\n\n **Defined Values:**\n ', + 'description': '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.\n\n**Default Value** : NIRFSG_VAL_SELF_CAL_OMIT_NONE\n\n**Defined Values:**', 'table_body': [ [ 'NIRFSG_VAL_SELF_CAL_OMIT_NONE', @@ -4425,7 +4418,7 @@ 'SelfTest': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Performs a self-test on the NI-RFSG device and returns the test results. \n \n This function performs a simple series of tests to ensure that the NI-RFSG device is powered up and responding.\n\n This function does not affect external I/O connections or connections between devices. Complete functional testing and calibration are not performed by this function. The NI-RFSG device must be in the Configuration state before you call this function.\n\n **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\n\n **Related Topics**\n\n `Device Warm-Up `_\n ' + 'description': '\nPerforms a self-test on the NI-RFSG device and returns the test results. \n\nThis function performs a simple series of tests to ensure that the NI-RFSG device is powered up and responding.\n\nThis function does not affect external I/O connections or connections between devices. Complete functional testing and calibration are not performed by this function. The NI-RFSG device must be in the Configuration state before you call this function.\n\n**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\n\n**Related Topics**\n\n`Device Warm-Up `_' }, 'included_in_proto': True, 'parameters': [ @@ -4440,7 +4433,7 @@ { 'direction': 'out', 'documentation': { - 'description': ' This parameter contains the value returned from the NI-RFSG device self test.\n\n ', + 'description': 'This parameter contains the value returned from the NI-RFSG device self test.', 'table_body': [ [ '0', @@ -4462,7 +4455,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Returns the self-test response string from the NI-RFSG device. For an explanation of the string contents, refer to the **status** parameter of this function.\n\n You must pass a ViChar array with at least 256 bytes.\n\n ' + 'description': 'Returns the self-test response string from the NI-RFSG device. For an explanation of the string contents, refer to the **status** parameter of this function.\n\nYou must pass a ViChar array with at least 256 bytes.' }, 'name': 'selfTestMessage', 'size': { @@ -4477,7 +4470,7 @@ 'SendSoftwareEdgeTrigger': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n Forces a trigger to occur. \n \n The specified trigger generates regardless of whether the trigger has been configured as a software trigger.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Triggers `_\n ' + 'description': '\nForces a trigger to occur. \n\nThe specified trigger generates regardless of whether the trigger has been configured as a software trigger.\n\n**Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_' }, 'included_in_proto': True, 'method_templates': [ @@ -4502,7 +4495,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the trigger to send.\n \n **Default Value:** NIRFSG_VAL_START_TRIGGER\n\n **Defined Values:**\n ', + 'description': 'Specifies the trigger to send.\n\n**Default Value:** NIRFSG_VAL_START_TRIGGER\n\n**Defined Values:**', 'table_body': [ [ 'NIRFSG_VAL_START_TRIGGER', @@ -4530,7 +4523,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the Script Trigger to configure. This parameter is valid only when you set the NIRFSG_ATTR_TRIGGER parameter to NIRFSG_VAL_START_TRIGGER. Otherwise, set the NIRFSG_ATTR_TRIGGER_IDENTIFIER parameter to "" (empty string).\n\n **Default Value:** "" (empty string)\n\n **Possible Values:**\n ', + 'description': 'Specifies the Script Trigger to configure. This parameter is valid only when you set the NIRFSG_ATTR_TRIGGER parameter to NIRFSG_VAL_START_TRIGGER. Otherwise, set the NIRFSG_ATTR_TRIGGER_IDENTIFIER parameter to "" (empty string).\n\n**Default Value:** "" (empty string)\n\n**Possible Values:**', 'table_body': [ [ 'scriptTrigger0', @@ -4570,7 +4563,7 @@ 'SetArbWaveformNextWritePosition': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Configures the start position to use for writing a waveform before calling the nirfsg_WriteArbWaveform function. \n \n This function 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_AllocateArbWaveform function or the nirfsg_WriteArbWaveform function. Subsequent writes to that waveform begin where the last write ended, unless this function is called again.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n ', + 'description': '\n\nConfigures the start position to use for writing a waveform before calling the nirfsg_WriteArbWaveform function. \n\nThis function 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_AllocateArbWaveform function or the nirfsg_WriteArbWaveform function. Subsequent writes to that waveform begin where the last write ended, unless this function is called again.\n\n**Supported Devices** : PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', 'note': 'If you use this function to write the waveform that is currently generating, an undefined output may result.' }, 'included_in_proto': True, @@ -4606,7 +4599,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the reference position in the waveform. The position and NIRFSG_ATTR_OFFSET together determine where to start loading data into the waveform.\n\n **Defined Values:**\n ', + 'description': 'Specifies the reference position in the waveform. The position and NIRFSG_ATTR_OFFSET together determine where to start loading data into the waveform.\n\n**Defined Values:**', 'table_body': [ [ 'NIRFSG_VAL_START_OF_WAVEFORM', @@ -4647,7 +4640,7 @@ 'SetAttributeViBoolean': { 'codegen_method': 'private', 'documentation': { - 'description': ' \n\n Sets the value of a ViBoolean attribute.\n\n Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid or is different than the value you specify.\n\n NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.\n\n Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.\n ' + 'description': '\n\nSets the value of a ViBoolean attribute.\n\nUse this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n- State caching is disabled for the entire session or for the particular attribute.\n- State caching is enabled, and the currently cached value is invalid or is different than the value you specify.\n\nNI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.\n\nAlso, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.' }, 'included_in_proto': True, 'method_templates': [ @@ -4672,7 +4665,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the waveform name and the marker name.\n\n Example:\n\n "waveform::waveform0/marker0"\n ' + 'description': 'Specifies the waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' }, 'name': 'channelName', 'type': 'ViConstString', @@ -4692,7 +4685,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Pass the value to which you want to set the attribute.\n ', + 'description': 'Pass the value to which you want to set the attribute.', 'note': 'Some values may not be valid. The allowed values depend on the current settings of the instrument session.' }, 'name': 'value', @@ -4706,7 +4699,7 @@ 'SetAttributeViInt32': { 'codegen_method': 'private', 'documentation': { - 'description': '\n Sets the value of a ViInt32 attribute.\n\n Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid or is different than the value you specify.\n\n NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.\n\n Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.\n ' + 'description': '\nSets the value of a ViInt32 attribute.\n\nUse this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n- State caching is disabled for the entire session or for the particular attribute.\n- State caching is enabled, and the currently cached value is invalid or is different than the value you specify.\n\nNI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.\n\nAlso, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.' }, 'included_in_proto': True, 'method_templates': [ @@ -4731,7 +4724,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the waveform name and the marker name.\n\n Example:\n\n "waveform::waveform0/marker0"\n ' + 'description': 'Specifies the waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' }, 'name': 'channelName', 'type': 'ViConstString', @@ -4751,7 +4744,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the value to which you want to set the attribute.\n ', + 'description': 'Specifies the value to which you want to set the attribute.', 'note': 'Some values may not be valid. The allowed values depend on the current settings of the instrument session.' }, 'grpc_enum': 'NiRFSGInt32AttributeValues', @@ -4766,7 +4759,7 @@ 'SetAttributeViInt64': { 'codegen_method': 'private', 'documentation': { - 'description': '\n Sets the value of a ViInt64 attribute.\n\n Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid or is different than the value you specify.\n\n NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.\n\n Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.\n ' + 'description': '\nSets the value of a ViInt64 attribute.\n\nUse this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n- State caching is disabled for the entire session or for the particular attribute.\n- State caching is enabled, and the currently cached value is invalid or is different than the value you specify.\n\nNI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.\n\nAlso, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.' }, 'included_in_proto': True, 'method_templates': [ @@ -4791,7 +4784,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the waveform name and the marker name.\n\n Example:\n\n "waveform::waveform0/marker0"\n ' + 'description': 'Specifies the waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' }, 'name': 'channelName', 'type': 'ViConstString', @@ -4811,7 +4804,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Pass the value to which you want to set the attribute.\n\n
\n Some values may not be valid. The allowed values depend on the current settings of the instrument session.\n
\n ' + 'description': 'Pass the value to which you want to set the attribute.\n\n
\nSome values may not be valid. The allowed values depend on the current settings of the instrument session.\n
' }, 'grpc_enum': 'NiRFSGInt64AttributeValues', 'name': 'value', @@ -4825,7 +4818,7 @@ 'SetAttributeViReal64': { 'codegen_method': 'private', 'documentation': { - 'description': ' \n Sets the value of a ViReal64 attribute.\n\n Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid or is different than the value you specify.\n\n NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.\n\n Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.\n ' + 'description': '\nSets the value of a ViReal64 attribute.\n\nUse this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n- State caching is disabled for the entire session or for the particular attribute.\n- State caching is enabled, and the currently cached value is invalid or is different than the value you specify.\n\nNI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.\n\nAlso, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.' }, 'included_in_proto': True, 'method_templates': [ @@ -4850,7 +4843,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the waveform name and the marker name.\n\n Example:\n\n "waveform::waveform0/marker0"\n ' + 'description': 'Specifies the waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' }, 'name': 'channelName', 'type': 'ViConstString', @@ -4870,7 +4863,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Pass the value to which you want to set the attribute.\n ', + 'description': 'Pass the value to which you want to set the attribute.', 'note': 'Some values may not be valid. The allowed values depend on the current settings of the instrument session.' }, 'grpc_enum': 'NiRFSGReal64AttributeValues', @@ -4885,7 +4878,7 @@ 'SetAttributeViSession': { 'codegen_method': 'private', 'documentation': { - 'description': ' \n Sets the value of a ViSession attribute.\n\n Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid or is different than the value you specify.\n\n NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.\n\n Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.\n ' + 'description': '\nSets the value of a ViSession attribute.\n\nUse this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n- State caching is disabled for the entire session or for the particular attribute.\n- State caching is enabled, and the currently cached value is invalid or is different than the value you specify.\n\nNI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.\n\nAlso, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.' }, 'included_in_proto': True, 'method_templates': [ @@ -4910,7 +4903,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the waveform name and the marker name.\n\n Example:\n\n "waveform::waveform0/marker0"\n ' + 'description': 'Specifies the waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' }, 'name': 'channelName', 'type': 'ViConstString', @@ -4930,7 +4923,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Pass the value to which you want to set the attribute.\n ', + 'description': 'Pass the value to which you want to set the attribute.', 'note': 'Some values may not be valid. The allowed values depend on the current settings of the instrument session.' }, 'name': 'value', @@ -4944,7 +4937,7 @@ 'SetAttributeViString': { 'codegen_method': 'private', 'documentation': { - 'description': ' \n Sets the value of a ViString attribute.\n\n Use this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n - State caching is disabled for the entire session or for the particular attribute.\n - State caching is enabled, and the currently cached value is invalid or is different than the value you specify.\n\n NI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.\n\n Also, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.\n ' + 'description': '\nSets the value of a ViString attribute.\n\nUse this low-level function to set the values of inherent IVI attributes, class-defined attributes, and instrument-specific attributes. If the attribute represents an instrument state, this function performs instrument I/O in the following cases:\n\n- State caching is disabled for the entire session or for the particular attribute.\n- State caching is enabled, and the currently cached value is invalid or is different than the value you specify.\n\nNI-RFSG contains high-level functions that set most of the instrument attributes. Use the high-level driver functions as much as possible, as they handle order dependencies and multithread locking. The high-level functions also perform status checking only after setting all of the attributes. In contrast, when you set multiple attributes using the SetAttribute functions, the functions check the instrument status after each call.\n\nAlso, when state caching is enabled, the high-level functions that configure multiple attributes perform instrument I/O only for the attributes whose value you change. Thus, you can safely call the high-level functions without the penalty of redundant instrument I/O.' }, 'included_in_proto': True, 'method_templates': [ @@ -4969,7 +4962,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the waveform name and the marker name.\n\n Example:\n\n "waveform::waveform0/marker0"\n ' + 'description': 'Specifies the waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' }, 'name': 'channelName', 'type': 'ViConstString', @@ -4989,7 +4982,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Pass the value to which you want to set the attribute.\n ', + 'description': 'Pass the value to which you want to set the attribute.', 'note': 'Some values may not be valid. The allowed values depend on the current settings of the instrument session.' }, 'grpc_mapped_enum': 'NiRFSGStringAttributeValuesMapped', @@ -5190,7 +5183,7 @@ 'UnlockSession': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Releases a lock obtained on an NI-RFSG device session by calling the nirfsg_LockSession function.\n\n **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860\n ' + 'description': '\n\nReleases a lock obtained on an NI-RFSG device session by calling the nirfsg_LockSession function.\n\n**Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860' }, 'included_in_proto': True, 'method_templates': [ @@ -5215,7 +5208,7 @@ { 'direction': 'out', 'documentation': { - 'description': ' Keeps track of whether you obtain a lock and therefore need to unlock the session. Pass the address of a local ViBoolean variable. In the declaration of the local variable, initialize it to VI_FALSE. Pass the address of the same local variable to any other calls you make to the nirfsg_LockSession function or the nirfsg_UnlockSession function in the same function.\n\n\n\n This parameter serves as a convenience. If you do not want to use this parameter, pass VI_NULL.\n\n The parameter is an input/output parameter. The nirfsg_LockSession function and the nirfsg_UnlockSession each inspect the current value and take the following actions:\n\n - If the value is VI_TRUE, the nirfsg_LockSession function does not lock the session again. If the value is VI_FALSE, the nirfsg_LockSession function obtains the lock and sets the value of the parameter to VI_TRUE.\n - If the value is VI_FALSE, the nirfsg_UnlockSession function does not attempt to unlock the session. If the value is VI_TRUE, the nirfsg_UnlockSession function releases the lock and sets the value of the parameter to VI_FALSE.\n\n Thus, you can call the nirfsg_UnlockSession function at the end of your function without worrying about whether you have the lock.\n\n Example:\n\n ViStatus TestFunc (ViSession vi, ViInt32 flags)\n {\n ViStatus error = VI_SUCCESS;\n ViBoolean haveLock = VI_FALSE;\n\n if (flags & BIT_1)\n {\n viCheckErr( nirfsg_LockSession(vi, &haveLock));\n viCheckErr( TakeAction1(vi));\n if (flags & BIT_2)\n {\n viCheckErr( nirfsg_UnlockSession(vi, &haveLock));\n viCheckErr( TakeAction2(vi));\n viCheckErr( nirfsg_LockSession(vi, &haveLock));\n }\n if (flags & BIT_3)\n viCheckErr( TakeAction3(vi));\n }\n\n Error:\n \n At this point, you cannot really be sure that you have the lock.\n Fortunately, the haveLock variable takes care of that for you.\n \n nirfsg_UnlockSession(vi, &haveLock);\n return error;\n }\n\n ' + 'description': 'Keeps track of whether you obtain a lock and therefore need to unlock the session. Pass the address of a local ViBoolean variable. In the declaration of the local variable, initialize it to VI_FALSE. Pass the address of the same local variable to any other calls you make to the nirfsg_LockSession function or the nirfsg_UnlockSession function in the same function.\n\nThis parameter serves as a convenience. If you do not want to use this parameter, pass VI_NULL.\n\nThe parameter is an input/output parameter. The nirfsg_LockSession function and the nirfsg_UnlockSession each inspect the current value and take the following actions:\n\n- If the value is VI_TRUE, the nirfsg_LockSession function does not lock the session again. If the value is VI_FALSE, the nirfsg_LockSession function obtains the lock and sets the value of the parameter to VI_TRUE.\n- If the value is VI_FALSE, the nirfsg_UnlockSession function does not attempt to unlock the session. If the value is VI_TRUE, the nirfsg_UnlockSession function releases the lock and sets the value of the parameter to VI_FALSE.\n\nThus, you can call the nirfsg_UnlockSession function at the end of your function without worrying about whether you have the lock.\n\nExample:\n\nViStatus TestFunc (ViSession vi, ViInt32 flags)\n{\nViStatus error = VI_SUCCESS;\nViBoolean haveLock = VI_FALSE;\n\nif (flags & BIT_1)\n{\nviCheckErr( nirfsg_LockSession(vi, &haveLock));\nviCheckErr( TakeAction1(vi));\nif (flags & BIT_2)\n{\nviCheckErr( nirfsg_UnlockSession(vi, &haveLock));\nviCheckErr( TakeAction2(vi));\nviCheckErr( nirfsg_LockSession(vi, &haveLock));\n}\nif (flags & BIT_3)\nviCheckErr( TakeAction3(vi));\n}\n\nError:\n\nAt this point, you cannot really be sure that you have the lock.\nFortunately, the haveLock variable takes care of that for you.\n\nnirfsg_UnlockSession(vi, &haveLock);\nreturn error;\n}' }, 'name': 'callerHasLock', 'type': 'ViBoolean', @@ -5231,7 +5224,7 @@ 'WaitUntilSettled': { 'codegen_method': 'public', 'documentation': { - 'description': '\n Waits until the RF output signal has settled. This function is useful for devices that support changes while in the Generation state. \n \n Call this function after making a dynamic change to wait for the output signal to settle.\n\n You can also call this function after calling the nirfsg_Commit function to wait for changes to settle. The nirfsg_WaitUntilSettled function is not required after calling the nirfsg_Initiate function because the nirfsg_Initiate automatically waits for the output to settle.\n\n **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\n ' + 'description': '\nWaits until the RF output signal has settled. This function is useful for devices that support changes while in the Generation state. \n\nCall this function after making a dynamic change to wait for the output signal to settle.\n\nYou can also call this function after calling the nirfsg_Commit function to wait for changes to settle. The nirfsg_WaitUntilSettled function is not required after calling the nirfsg_Initiate function because the nirfsg_Initiate automatically waits for the output to settle.\n\n**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' }, 'included_in_proto': True, 'method_templates': [ @@ -5256,7 +5249,7 @@ { 'direction': 'in', 'documentation': { - 'description': ' Specifies the maximum time the function waits for the output to settle. If the maximum time is exceeded, this function returns an error. The units are expressed in milliseconds.\n\n **Default Value** : 10000\n\n ' + 'description': 'Specifies the maximum time the function waits for the output to settle. If the maximum time is exceeded, this function returns an error. The units are expressed in milliseconds.\n\n**Default Value** : 10000' }, 'name': 'maxTimeMilliseconds', 'type': 'ViInt32', @@ -5269,7 +5262,7 @@ 'WriteP2PEndpointI16': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Writes an array of 16-bit integer data to the peer-to-peer endpoint. \n \n Use this function to write initial data from the host to the endpoint before starting generation to avoid an underflow when you start the generation.\n\n **Supported Devices** : PXIe-5673E\n\n **Related Topics**\n\n `Peer-to-Peer Data Streaming `_--Refer to this topic for more information about configuring a stream.\n\n `Configuring Flow Control `_\n\n `Starting Peer-to-Peer Generation `_\n\n `Reconfiguring a Stream `_\n ' + 'description': '\n\nWrites an array of 16-bit integer data to the peer-to-peer endpoint. \n\nUse this function to write initial data from the host to the endpoint before starting generation to avoid an underflow when you start the generation.\n\n**Supported Devices** : PXIe-5673E\n\n**Related Topics**\n\n`Peer-to-Peer Data Streaming `_--Refer to this topic for more information about configuring a stream.\n\n`Configuring Flow Control `_\n\n`Starting Peer-to-Peer Generation `_\n\n`Reconfiguring a Stream `_' }, 'included_in_proto': True, 'method_templates': [ @@ -5332,7 +5325,7 @@ 'WriteScript': { 'codegen_method': 'public', 'documentation': { - 'description': ' \n\n Writes a script to the device to control waveform generation in Script mode. \n \n First, configure your device for Script mode by calling the nirfsg_ConfigureGenerationMode function. The NI-RFSG device must be in the Configuration state before calling the nirfsg_WriteScript function.\n\n **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n **Related Topics**\n\n `Scripting Instructions `_--Refer to this topic for more information about VST restrictions on scripts.\n\n `Common Scripting Use Cases `_\n ', + 'description': '\n\nWrites a script to the device to control waveform generation in Script mode. \n\nFirst, configure your device for Script mode by calling the nirfsg_ConfigureGenerationMode function. The NI-RFSG device must be in the Configuration state before calling the nirfsg_WriteScript function.\n\n**Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Scripting Instructions `_--Refer to this topic for more information about VST restrictions on scripts.\n\n`Common Scripting Use Cases `_', 'note': 'If you are using an RF vector signal transceiver (VST) device, some script instructions may not be supported.' }, 'included_in_proto': True, @@ -5371,7 +5364,7 @@ 'close': { 'codegen_method': 'private', 'documentation': { - 'description': ' \n Aborts any signal generation in progress and destroys the instrument driver session.\n\n **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\n\n **Related Topics**\n\n `NI-RFSG Instrument Driver Programming Flow `_\n\n `NI-RFSG Programming State Model `_\n ' + 'description': '\nAborts any signal generation in progress and destroys the instrument driver session.\n\n**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\n\n**Related Topics**\n\n`NI-RFSG Instrument Driver Programming Flow `_\n\n`NI-RFSG Programming State Model `_' }, 'grpc_name': 'Close', 'included_in_proto': True,