diff --git a/docs/nirfsa/class.rst b/docs/nirfsa/class.rst index b80743063..4e472127e 100644 --- a/docs/nirfsa/class.rst +++ b/docs/nirfsa/class.rst @@ -4996,13 +4996,13 @@ exported_digitizer_sample_clock_output_terminal **Defined Values**: - +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Description | - +=================================================================+==========================================================================================================================================================+ - | :py:data:`~nirfsa.DigitizerSampleClockExportedTerminal.NONE` | The Reference Clock is not exported. This value is not valid for the PXIe-5644/5645/5646. | - +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsa.DigitizerSampleClockExportedTerminal.CLK_OUT` | Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841. | - +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Description | + +==================================================================+==========================================================================================================================================================+ + | :py:data:`~nirfsa.DigitizerSampleClockExportedTerminal.NONE_STR` | The Reference Clock is not exported. This value is not valid for the PXIe-5644/5645/5646. | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :py:data:`~nirfsa.DigitizerSampleClockExportedTerminal.CLK_OUT` | Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841. | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ .. 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. @@ -5497,7 +5497,7 @@ exported_ref_clock_output_terminal +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Description | +===================================================================+=================================================================================================================================================================================================================+ - | :py:data:`~nirfsa.ReferenceClockExportedTerminal.NONE` | The Reference Clock is not exported. This value is not valid for the PXIe-5644/5645/5646. | + | :py:data:`~nirfsa.ReferenceClockExportedTerminal.NONE_STR` | The Reference Clock is not exported. This value is not valid for the PXIe-5644/5645/5646. | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:data:`~nirfsa.ReferenceClockExportedTerminal.REF_OUT` | Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841. | +-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -7918,8 +7918,6 @@ lo_source +----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Description | +====================================================+===================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | :py:data:`~nirfsa.LoSource.NONE` | Specifies that no LO source is required to downconvert the RF input signal. | - +----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:data:`~nirfsa.LoSource.ONBOARD` | Specifies that the onboard synthesizer is used to generate the LO signal that downconverts the RF input signal.**PXIe-5831/5832** This configuration uses the onboard LO of the PXIe-3622, using the LO2 stage.**PXIe-5831/5832 with PXIe-5653** This configuration uses the onboard LO of the PXIe-5653 when associated with the PXIe-3622.**PXIe-5841 with PXIe-5655** This configuration uses the onboard LO of the PXIe-5655. | +----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:data:`~nirfsa.LoSource.LO_IN` | Specifies that the LO source used to downconvert the RF input signal is connected to the LO IN connector on the front panel. | @@ -7929,8 +7927,6 @@ lo_source | :py:data:`~nirfsa.LoSource.LO_SOURCE_SG_SA_SHARED` | Uses the same internal LO during NI-RFSA and NI-RFSG sessions. NI-RFSA selects an internal synthesizer and the synthesizer signal is switched to both the RF Out and RF In mixers. This value is valid on only the PXIe-5830/5831/5832/5841 with PXIe-5655. | +----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. - .. tip:: This property can be set/get on specific los within your :py:class:`nirfsa.Session` instance. Use Python index notation on the repeated capabilities container los to specify a subset. @@ -9183,7 +9179,7 @@ ref_clock_source ---- **Note** - For the PXIe-5694, if your application requires an external LO source, set this property to :py:data:`~nirfsa.ReferenceClockSource.NONE`. + For the PXIe-5694, if your application requires an external LO source, set this property to :py:data:`~nirfsa.ReferenceClockSource.NONE_STR`. ---- @@ -9204,7 +9200,7 @@ ref_clock_source +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Description | +========================================================+===============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | :py:data:`~nirfsa.ReferenceClockSource.NONE` | No Reference Clock is required for the current device configuration. This value is valid only for the PXIe-5694 or the PXIe-5668. | + | :py:data:`~nirfsa.ReferenceClockSource.NONE_STR` | No Reference Clock is required for the current device configuration. This value is valid only for the PXIe-5694 or the PXIe-5668. | +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:data:`~nirfsa.ReferenceClockSource.ONBOARD_CLOCK` | **PXI-5661 **NI-RFSA locks the NI-RFSA device to the PXI-5600 RF downconverter onboard clock.**PXIe-5663/5663E **NI-RFSA locks the PXIe-5663/5663E to the PXI/PXIe-5652 LO source onboard clock. Connect the REF OUT2 connector (if it exists) on the PXI/PXIe-5652 to the CLK IN terminal on the PXIe-5622. On versions of the PXIe-5663/5663E that lack a REF OUT2 connector on the PXI/PXIe-5652, connect the REF IN/OUT connector on the PXI/PXIe-5652 to the CLK IN terminal on the PXI5622.**PXIe-5665 **NI-RFSA locks the PXIe-5665 to the PXIe-5653 LO source onboard clock. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN terminal on the PXIe-5622.**PXIe-5667 **NI-RFSA locks the PXIe-5667 to the PXIe-5653 LO source onboard clock. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN terminal on the PXIe-5622, and connect the 10 MHZ REF OUT terminal on the PXIe-5653 to the REF/LO IN connector on the PXIe-5694.**PXIe-5668 **Lock the PXIe-5668 to the PXIe-5653 LO SOURCE onboard clock. Connect the LO2 OUT connector on the PXIe-5606 to the CLK IN connector on the PXIe-5624.**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-5644/5645/5646, PXIe-5820/5840/5841 **Lock the NI-RFSA device to its onboard clock.**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 User Manual for the instrument.**PXIe-5860 **Lock to the PXIe-5860 onboard clock. | +--------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/docs/nirfsa/enums.rst b/docs/nirfsa/enums.rst index 9122e80bc..0270a87db 100644 --- a/docs/nirfsa/enums.rst +++ b/docs/nirfsa/enums.rst @@ -486,7 +486,7 @@ DigitizerSampleClockExportedTerminal .. py:class:: DigitizerSampleClockExportedTerminal - .. py:attribute:: DigitizerSampleClockExportedTerminal.NONE + .. py:attribute:: DigitizerSampleClockExportedTerminal.NONE_STR @@ -631,61 +631,61 @@ DownconverterLoopBandwidth -DownconverterPreselectorEnabled -------------------------------- +EnableAttrVals +-------------- -.. py:class:: DownconverterPreselectorEnabled +.. py:class:: EnableAttrVals - .. py:attribute:: DownconverterPreselectorEnabled.DISABLED + .. py:attribute:: EnableAttrVals.DISABLED - Disables the preselector. + The property is disabled. - .. py:attribute:: DownconverterPreselectorEnabled.ENABLED_WHEN_IN_SIGNAL_PATH + .. py:attribute:: EnableAttrVals.ENABLED - The preselector is automatically enabled when it is in the signal path and is automatically disabled when it is not in the signal path. Use the :py:attr:`nirfsa.Session.preselector_present` property to determine if the downconverter has an preselector. + The property is enabled. - .. py:attribute:: DownconverterPreselectorEnabled.ENABLED +DownconverterPreselectorEnabled +------------------------------- +.. py:class:: DownconverterPreselectorEnabled + .. py:attribute:: DownconverterPreselectorEnabled.DISABLED - Enables the preselector. If the preselector is not in the signal path or if the preselector is not supported on the device, NI-RFSA returns an error. Select the :py:data:`~nirfsa.DownconverterPreselectorEnabled.ENABLED_WHEN_IN_SIGNAL_PATH` whenever possible avoid an error. - + Disables the preselector. + -EnableAttrVals --------------- -.. py:class:: EnableAttrVals - .. py:attribute:: EnableAttrVals.DISABLED + .. py:attribute:: DownconverterPreselectorEnabled.ENABLED_WHEN_IN_SIGNAL_PATH - The property is disabled. + The preselector is automatically enabled when it is in the signal path and is automatically disabled when it is not in the signal path. Use the :py:attr:`nirfsa.Session.preselector_present` property to determine if the downconverter has an preselector. - .. py:attribute:: EnableAttrVals.ENABLED + .. py:attribute:: DownconverterPreselectorEnabled.ENABLED - The property is enabled. + Enables the preselector. If the preselector is not in the signal path or if the preselector is not supported on the device, NI-RFSA returns an error. Select the :py:data:`~nirfsa.DownconverterPreselectorEnabled.ENABLED_WHEN_IN_SIGNAL_PATH` whenever possible avoid an error. @@ -1576,16 +1576,6 @@ LoSource .. py:class:: LoSource - .. py:attribute:: LoSource.NONE - - - - Specifies that no LO source is required to downconvert the RF input signal. - - - - - .. py:attribute:: LoSource.ONBOARD @@ -2086,7 +2076,7 @@ PxiChassisClk10Source .. py:class:: PxiChassisClk10Source - .. py:attribute:: PxiChassisClk10Source.NONE + .. py:attribute:: PxiChassisClk10Source.NONE_STR @@ -2156,7 +2146,7 @@ ReferenceClockExportedTerminal .. py:class:: ReferenceClockExportedTerminal - .. py:attribute:: ReferenceClockExportedTerminal.NONE + .. py:attribute:: ReferenceClockExportedTerminal.NONE_STR @@ -2211,7 +2201,7 @@ ReferenceClockSource .. py:class:: ReferenceClockSource - .. py:attribute:: ReferenceClockSource.NONE + .. py:attribute:: ReferenceClockSource.NONE_STR diff --git a/generated/nirfsa/nirfsa/enums.py b/generated/nirfsa/nirfsa/enums.py index db345e3fc..9a89e035d 100644 --- a/generated/nirfsa/nirfsa/enums.py +++ b/generated/nirfsa/nirfsa/enums.py @@ -209,7 +209,7 @@ class DigitizerDitherEnabled(Enum): class DigitizerSampleClockExportedTerminal(Enum): - NONE = 'None' + NONE_STR = 'None' r''' The Reference Clock is not exported. This value is not valid for the PXIe-5644/5645/5646. ''' @@ -272,6 +272,17 @@ class DownconverterLoopBandwidth(Enum): ''' +class EnableAttrVals(Enum): + DISABLED = 1900 + r''' + The property is disabled. + ''' + ENABLED = 1901 + r''' + The property is enabled. + ''' + + class DownconverterPreselectorEnabled(Enum): DISABLED = 2600 r''' @@ -287,17 +298,6 @@ class DownconverterPreselectorEnabled(Enum): ''' -class EnableAttrVals(Enum): - DISABLED = 1900 - r''' - The property is disabled. - ''' - ENABLED = 1901 - r''' - The property is enabled. - ''' - - class EnableRfPreamp(Enum): DISABLED = 2500 r''' @@ -669,10 +669,6 @@ class LoPllFractionalModeEnabled(Enum): class LoSource(Enum): - NONE = 'None' - r''' - Specifies that no LO source is required to downconvert the RF input signal. - ''' ONBOARD = 'Onboard' r''' Specifies that the onboard synthesizer is used to generate the LO signal that downconverts the RF input signal.**PXIe-5831/5832** This configuration uses the onboard LO of the PXIe-3622, using the LO2 stage.**PXIe-5831/5832 with PXIe-5653** This configuration uses the onboard LO of the PXIe-5653 when associated with the PXIe-3622.**PXIe-5841 with PXIe-5655** This configuration uses the onboard LO of the PXIe-5655. @@ -881,7 +877,7 @@ class PowerSpectrumUnits(Enum): class PxiChassisClk10Source(Enum): - NONE = 'None' + NONE_STR = 'None' r''' The device does not drive the PXI 10 MHz backplane Reference Clock. ''' @@ -911,7 +907,7 @@ class ReferenceClockExportedRate(Enum): class ReferenceClockExportedTerminal(Enum): - NONE = 'None' + NONE_STR = 'None' r''' The Reference Clock is not exported. This value is not valid for the PXIe-5644/5645/5646. ''' @@ -934,7 +930,7 @@ class ReferenceClockExportedTerminal(Enum): class ReferenceClockSource(Enum): - NONE = 'None' + NONE_STR = 'None' r''' No Reference Clock is required for the current device configuration. This value is valid only for the PXIe-5694 or the PXIe-5668. ''' @@ -1112,27 +1108,27 @@ class SelfCalSteps(IntFlag): r''' Omits the Residual LO Power step. If you omit this step, the Residual LO Power performance is not adjusted. ''' - LO_SELF_CAL = 10 + LO_SELF_CAL = 16 r''' Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted. ''' - AMPLITUDE_ACCURACY = 20 + AMPLITUDE_ACCURACY = 32 r''' Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted. ''' - RESIDUAL_LO_POWER = 40 + RESIDUAL_LO_POWER = 64 r''' Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted. ''' - IMAGE_SUPPRESSION = 80 + IMAGE_SUPPRESSION = 128 r''' Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted. ''' - SYNTHESIZER_ALIGNMENT = 100 + SYNTHESIZER_ALIGNMENT = 256 r''' Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted. ''' - DC_OFFSET = 200 + DC_OFFSET = 512 r''' Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted. ''' @@ -1159,27 +1155,27 @@ class SelfCalibrateRangeStepsToOmit(IntFlag): r''' Omits the Residual LO Power step. If you omit this step, the Residual LO Power performance is not adjusted. ''' - LO_SELF_CAL = 10 + LO_SELF_CAL = 16 r''' Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted. ''' - AMPLITUDE_ACCURACY = 20 + AMPLITUDE_ACCURACY = 32 r''' Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted. ''' - RESIDUAL_LO_POWER = 40 + RESIDUAL_LO_POWER = 64 r''' Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted. ''' - IMAGE_SUPPRESSION = 80 + IMAGE_SUPPRESSION = 128 r''' Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted. ''' - SYNTHESIZER_ALIGNMENT = 100 + SYNTHESIZER_ALIGNMENT = 256 r''' Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted. ''' - DC_OFFSET = 200 + DC_OFFSET = 512 r''' Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted. ''' diff --git a/generated/nirfsa/nirfsa/session.py b/generated/nirfsa/nirfsa/session.py index b241e59f8..8dbdd8dac 100644 --- a/generated/nirfsa/nirfsa/session.py +++ b/generated/nirfsa/nirfsa/session.py @@ -1579,13 +1579,13 @@ class _SessionBase(object): **Defined Values**: - +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Description | - +==============================================+==========================================================================================================================================================+ - | DigitizerSampleClockExportedTerminal.NONE | The Reference Clock is not exported. This value is not valid for the PXIe-5644/5645/5646. | - +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | DigitizerSampleClockExportedTerminal.CLK_OUT | Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841. | - +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Description | + +===============================================+==========================================================================================================================================================+ + | DigitizerSampleClockExportedTerminal.NONE_STR | The Reference Clock is not exported. This value is not valid for the PXIe-5644/5645/5646. | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | DigitizerSampleClockExportedTerminal.CLK_OUT | Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841. | + +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ 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. @@ -1966,7 +1966,7 @@ class _SessionBase(object): +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Description | +================================================+=================================================================================================================================================================================================================+ - | ReferenceClockExportedTerminal.NONE | The Reference Clock is not exported. This value is not valid for the PXIe-5644/5645/5646. | + | ReferenceClockExportedTerminal.NONE_STR | The Reference Clock is not exported. This value is not valid for the PXIe-5644/5645/5646. | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ReferenceClockExportedTerminal.REF_OUT | Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841. | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -3372,8 +3372,6 @@ class _SessionBase(object): +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Description | +=================================+===================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | LoSource.NONE | Specifies that no LO source is required to downconvert the RF input signal. | - +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | LoSource.ONBOARD | Specifies that the onboard synthesizer is used to generate the LO signal that downconverts the RF input signal.**PXIe-5831/5832** This configuration uses the onboard LO of the PXIe-3622, using the LO2 stage.**PXIe-5831/5832 with PXIe-5653** This configuration uses the onboard LO of the PXIe-5653 when associated with the PXIe-3622.**PXIe-5841 with PXIe-5655** This configuration uses the onboard LO of the PXIe-5655. | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | LoSource.LO_IN | Specifies that the LO source used to downconvert the RF input signal is connected to the LO IN connector on the front panel. | @@ -3383,9 +3381,6 @@ class _SessionBase(object): | LoSource.LO_SOURCE_SG_SA_SHARED | Uses the same internal LO during NI-RFSA and NI-RFSG sessions. NI-RFSA selects an internal synthesizer and the synthesizer signal is switched to both the RF Out and RF In mixers. This value is valid on only the PXIe-5830/5831/5832/5841 with PXIe-5655. | +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - Note: - One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. - Tip: This property can be set/get on specific los within your :py:class:`nirfsa.Session` instance. Use Python index notation on the repeated capabilities container los to specify a subset. @@ -4018,7 +4013,7 @@ class _SessionBase(object): ---- **Note** - For the PXIe-5694, if your application requires an external LO source, set this property to ReferenceClockSource.NONE. + For the PXIe-5694, if your application requires an external LO source, set this property to ReferenceClockSource.NONE_STR. ---- @@ -4039,7 +4034,7 @@ class _SessionBase(object): +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Description | +=====================================+===========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | ReferenceClockSource.NONE | No Reference Clock is required for the current device configuration. This value is valid only for the PXIe-5694 or the PXIe-5668. | + | ReferenceClockSource.NONE_STR | No Reference Clock is required for the current device configuration. This value is valid only for the PXIe-5694 or the PXIe-5668. | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ReferenceClockSource.ONBOARD_CLOCK | **PXI-5661 **NI-RFSA locks the NI-RFSA device to the PXI-5600 RF downconverter onboard clock.**PXIe-5663/5663E **NI-RFSA locks the PXIe-5663/5663E to the PXI/PXIe-5652 LO source onboard clock. Connect the REF OUT2 connector (if it exists) on the PXI/PXIe-5652 to the CLK IN terminal on the PXIe-5622. On versions of the PXIe-5663/5663E that lack a REF OUT2 connector on the PXI/PXIe-5652, connect the REF IN/OUT connector on the PXI/PXIe-5652 to the CLK IN terminal on the PXI5622.**PXIe-5665 **NI-RFSA locks the PXIe-5665 to the PXIe-5653 LO source onboard clock. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN terminal on the PXIe-5622.**PXIe-5667 **NI-RFSA locks the PXIe-5667 to the PXIe-5653 LO source onboard clock. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN terminal on the PXIe-5622, and connect the 10 MHZ REF OUT terminal on the PXIe-5653 to the REF/LO IN connector on the PXIe-5694.**PXIe-5668 **Lock the PXIe-5668 to the PXIe-5653 LO SOURCE onboard clock. Connect the LO2 OUT connector on the PXIe-5606 to the CLK IN connector on the PXIe-5624.**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-5644/5645/5646, PXIe-5820/5840/5841 **Lock the NI-RFSA device to its onboard clock.**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 User Manual for the instrument.**PXIe-5860 **Lock to the PXIe-5860 onboard clock. | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -5303,6 +5298,95 @@ def _fetch_iq_multi_record_complex_i16(self, starting_record, number_of_records, wfm_info = self._interpreter.fetch_iq_multi_record_complex_i16(self._repeated_capability, starting_record, number_of_records, iq_data_arrays, timeout) return wfm_info + def fetch_iq_multi_record_into(self, iq_data_arrays, starting_record=0, number_of_records=None, number_of_samples=None, timeout=hightime.timedelta(seconds=10.0)): + '''fetch_iq_multi_record + + Fetches I/Q data from multiple records in an acquisition. + + A fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated. + + This method accepts a data_type parameter to specify the desired data format: numpy.complex64, numpy.complex128, or numpy.int16. + + **Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 + + **Related Topics** + + `None (Trigger Type) `_ + + Tip: + This method can be called on specific channels within your :py:class:`nirfsa.Session` instance. + Use Python index notation on the repeated capabilities container channels to specify a subset, + and then call this method on the result. + + Example: :py:meth:`my_session.channels[ ... ].fetch_iq_multi_record` + + To call the method on all channels, you can call it directly on the :py:class:`nirfsa.Session`. + + Example: :py:meth:`my_session.fetch_iq_multi_record` + + Args: + iq_data_arrays (2D numpy.array of numpy.complex64, 2D numpy.array of numpy.complex128 or interleaved complex data in the form of 2D numpy.array of numpy.int16): Specifies a pre-allocated 2D numpy array of shape (number_of_records, number_of_samples) to be filled with the acquired I/Q data. Each row corresponds to one record. The real and imaginary parts of this complex data array correspond to the in-phase (I) and quadrature-phase (Q) data, respectively. + + starting_record (int): Specifies the first record to retrieve. Record numbers are zero-based. The default value is 0. + + number_of_records (int): Specifies the number of records to fetch. + + number_of_samples (int): Specifies the number of samples per record. + + timeout (hightime.timedelta, datetime.timedelta, or float in seconds): **PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the method to complete before returning a timeout error. + + **PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger. + + ---- + + For all supported devices, a value of specifies the method waits until all data is available. A value of 0 specifies the method immediately returns available data. + + ---- + + ''' + import numpy + if str(type(iq_data_arrays)).find("'numpy.ndarray'") != -1: + if number_of_records is None: + number_of_records = self.number_of_records + + if number_of_samples is None: + number_of_samples = self.number_of_samples + + if iq_data_arrays.ndim != 2: + raise ValueError("iq_data_arrays must be a 2D numpy array (number_of_records x number_of_samples), but got {}D array".format(iq_data_arrays.ndim)) + if iq_data_arrays.shape[0] < number_of_records: + raise ValueError("iq_data_arrays must have at least {} rows (number_of_records), but has {}".format(number_of_records, iq_data_arrays.shape[0])) + if iq_data_arrays.dtype == numpy.int16: + expected_buffer_size = 2 * number_of_samples + else: + expected_buffer_size = number_of_samples + + if iq_data_arrays.shape[1] < expected_buffer_size: + try: + iq_data_arrays.resize((iq_data_arrays.shape[0], expected_buffer_size), refcheck=False) + except (MemoryError, ValueError) as e: + raise type(e)( + "Failed to resize iq_data_arrays from {} to {}: {}".format( + iq_data_arrays.shape, (iq_data_arrays.shape[0], expected_buffer_size), e + ) + ) from e + assert iq_data_arrays.shape[1] == expected_buffer_size, "iq_data_arrays width must match requested number_of_samples after resize" + + if iq_data_arrays.dtype == numpy.complex128: + wfm_info = self._fetch_iq_multi_record_complex_f64(starting_record, number_of_records, iq_data_arrays, timeout) + elif iq_data_arrays.dtype == numpy.complex64: + wfm_info = self._fetch_iq_multi_record_complex_f32(starting_record, number_of_records, iq_data_arrays, timeout) + elif iq_data_arrays.dtype == numpy.int16: + wfm_info = self._fetch_iq_multi_record_complex_i16(starting_record, number_of_records, iq_data_arrays, timeout) + else: + raise TypeError("Unsupported datatype. Is {}, expected {} or {} or {}".format(iq_data_arrays.dtype, numpy.complex128, numpy.complex64, numpy.int16)) + else: + raise TypeError("Unsupported datatype. Expected numpy array of {} or {} or {}".format(numpy.complex128, numpy.complex64, numpy.int16)) + + waveform_info._populate_samples_info(wfm_info, iq_data_arrays) + + return wfm_info + @ivi_synchronized def _fetch_iq_single_record_complex_f32(self, record_number, iq_data_array, timeout=hightime.timedelta(seconds=10.0)): r'''_fetch_iq_single_record_complex_f32 @@ -5549,95 +5633,6 @@ def _fetch_iq_single_record_complex_i16(self, record_number, iq_data_array, time wfm_info = self._interpreter.fetch_iq_single_record_complex_i16(self._repeated_capability, record_number, iq_data_array, timeout) return wfm_info - def fetch_iq_multi_record_into(self, iq_data_arrays, starting_record=0, number_of_records=None, number_of_samples=None, timeout=hightime.timedelta(seconds=10.0)): - '''fetch_iq_multi_record - - Fetches I/Q data from multiple records in an acquisition. - - A fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated. - - This method accepts a data_type parameter to specify the desired data format: numpy.complex64, numpy.complex128, or numpy.int16. - - **Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - - **Related Topics** - - `None (Trigger Type) `_ - - Tip: - This method can be called on specific channels within your :py:class:`nirfsa.Session` instance. - Use Python index notation on the repeated capabilities container channels to specify a subset, - and then call this method on the result. - - Example: :py:meth:`my_session.channels[ ... ].fetch_iq_multi_record` - - To call the method on all channels, you can call it directly on the :py:class:`nirfsa.Session`. - - Example: :py:meth:`my_session.fetch_iq_multi_record` - - Args: - iq_data_arrays (2D numpy.array of numpy.complex64, 2D numpy.array of numpy.complex128 or interleaved complex data in the form of 2D numpy.array of numpy.int16): Specifies a pre-allocated 2D numpy array of shape (number_of_records, number_of_samples) to be filled with the acquired I/Q data. Each row corresponds to one record. The real and imaginary parts of this complex data array correspond to the in-phase (I) and quadrature-phase (Q) data, respectively. - - starting_record (int): Specifies the first record to retrieve. Record numbers are zero-based. The default value is 0. - - number_of_records (int): Specifies the number of records to fetch. - - number_of_samples (int): Specifies the number of samples per record. - - timeout (hightime.timedelta, datetime.timedelta, or float in seconds): **PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the method to complete before returning a timeout error. - - **PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger. - - ---- - - For all supported devices, a value of specifies the method waits until all data is available. A value of 0 specifies the method immediately returns available data. - - ---- - - ''' - import numpy - if str(type(iq_data_arrays)).find("'numpy.ndarray'") != -1: - if number_of_records is None: - number_of_records = self.number_of_records - - if number_of_samples is None: - number_of_samples = self.number_of_samples - - if iq_data_arrays.ndim != 2: - raise ValueError("iq_data_arrays must be a 2D numpy array (number_of_records x number_of_samples), but got {}D array".format(iq_data_arrays.ndim)) - if iq_data_arrays.shape[0] < number_of_records: - raise ValueError("iq_data_arrays must have at least {} rows (number_of_records), but has {}".format(number_of_records, iq_data_arrays.shape[0])) - if iq_data_arrays.dtype == numpy.int16: - expected_buffer_size = 2 * number_of_samples - else: - expected_buffer_size = number_of_samples - - if iq_data_arrays.shape[1] < expected_buffer_size: - try: - iq_data_arrays.resize((iq_data_arrays.shape[0], expected_buffer_size), refcheck=False) - except (MemoryError, ValueError) as e: - raise type(e)( - "Failed to resize iq_data_arrays from {} to {}: {}".format( - iq_data_arrays.shape, (iq_data_arrays.shape[0], expected_buffer_size), e - ) - ) from e - assert iq_data_arrays.shape[1] == expected_buffer_size, "iq_data_arrays width must match requested number_of_samples after resize" - - if iq_data_arrays.dtype == numpy.complex128: - wfm_info = self._fetch_iq_multi_record_complex_f64(starting_record, number_of_records, iq_data_arrays, timeout) - elif iq_data_arrays.dtype == numpy.complex64: - wfm_info = self._fetch_iq_multi_record_complex_f32(starting_record, number_of_records, iq_data_arrays, timeout) - elif iq_data_arrays.dtype == numpy.int16: - wfm_info = self._fetch_iq_multi_record_complex_i16(starting_record, number_of_records, iq_data_arrays, timeout) - else: - raise TypeError("Unsupported datatype. Is {}, expected {} or {} or {}".format(iq_data_arrays.dtype, numpy.complex128, numpy.complex64, numpy.int16)) - else: - raise TypeError("Unsupported datatype. Expected numpy array of {} or {} or {}".format(numpy.complex128, numpy.complex64, numpy.int16)) - - waveform_info._populate_samples_info(wfm_info, iq_data_arrays) - - return wfm_info - def fetch_iq_single_record_into(self, iq_data_array, record_number=0, number_of_samples=None, timeout=hightime.timedelta(seconds=10.0)): '''fetch_iq_single_record diff --git a/src/nirfsa/metadata/attributes.py b/src/nirfsa/metadata/attributes.py index 6f9f78611..4fd281640 100644 --- a/src/nirfsa/metadata/attributes.py +++ b/src/nirfsa/metadata/attributes.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# This file is generated from NI-RFSA API metadata version 26.5.0d9999 +# This file is generated from NI-RFSA API metadata version 27.0.0d9999 attributes = { 1050007: { 'access': 'read only', @@ -265,14 +265,14 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': 'Specifies how the NIRFSA_ATTR_RESOLUTION_BANDWIDTH attribute is expressed.\n\n**Default Value**: NIRFSA_VAL_RBW_THREE_DECIBELS\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', + 'description': 'Specifies how the NIRFSA_ATTR_RESOLUTION_BANDWIDTH attribute is expressed.\n\n**Default Value**: NIRFSA_VAL_RBW_3DB\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', 'table_body': [ [ - 'NIRFSA_VAL_RBW_THREE_DECIBELS', + 'NIRFSA_VAL_RBW_3DB', 'Defines the resolution bandwidth (RBW) in terms of the 3 dB bandwidth of the window specified by the NIRFSA_ATTR_FFT_WINDOW_TYPE attribute.' ], [ - 'NIRFSA_VAL_RBW_SIX_DECIBELS', + 'NIRFSA_VAL_RBW_6DB', 'Defines the RBW in terms of the 6 dB bandwidth of the window specified by the NIRFSA_ATTR_FFT_WINDOW_TYPE attribute.' ], [ @@ -280,7 +280,7 @@ 'Defines the RBW in terms of the display resolution, which is the ratio of the sampling frequency to the number of samples that you acquire.' ], [ - 'NIRFSA_VAL_RBW_EQUIVALENT_NOISE_BANDWIDTH', + 'NIRFSA_VAL_RBW_ENBW', 'Defines the RBW in terms of the equivalent noise bandwidth (ENBW) of the window specified by the NIRFSA_ATTR_FFT_WINDOW_TYPE attribute.' ] ], @@ -428,34 +428,34 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': 'Specifies the Reference Clock source.\n\n----\n**Note**\nFor the PXIe-5694, if your application requires an external LO source, set this attribute to NIRFSA_VAL_NONE.\n\n----\n\n**Default Values**:\n\n**PXIe-5694**: NIRFSA_VAL_REF_IN\n\n**All other devices**: NIRFSA_VAL_ONBOARD_CLOCK\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5694, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureRefClock\n\n**Defined Values**:', + 'description': 'Specifies the Reference Clock source.\n\n----\n**Note**\nFor the PXIe-5694, if your application requires an external LO source, set this attribute to NIRFSA_VAL_NONE_STR.\n\n----\n\n**Default Values**:\n\n**PXIe-5694**: NIRFSA_VAL_REF_IN_STR\n\n**All other devices**: NIRFSA_VAL_ONBOARD_CLOCK_STR\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5694, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureRefClock\n\n**Defined Values**:', 'table_body': [ [ - 'NIRFSA_VAL_NONE', + 'NIRFSA_VAL_NONE_STR', 'No Reference Clock is required for the current device configuration. This value is valid only for the PXIe-5694 or the PXIe-5668.' ], [ - 'NIRFSA_VAL_ONBOARD_CLOCK', + 'NIRFSA_VAL_ONBOARD_CLOCK_STR', '**PXI-5661 **NI-RFSA locks the NI-RFSA device to the PXI-5600 RF downconverter onboard clock.**PXIe-5663/5663E **NI-RFSA locks the PXIe-5663/5663E to the PXI/PXIe-5652 LO source onboard clock. Connect the REF OUT2 connector (if it exists) on the PXI/PXIe-5652 to the CLK IN terminal on the PXIe-5622. On versions of the PXIe-5663/5663E that lack a REF OUT2 connector on the PXI/PXIe-5652, connect the REF IN/OUT connector on the PXI/PXIe-5652 to the CLK IN terminal on the PXI5622.**PXIe-5665 **NI-RFSA locks the PXIe-5665 to the PXIe-5653 LO source onboard clock. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN terminal on the PXIe-5622.**PXIe-5667 **NI-RFSA locks the PXIe-5667 to the PXIe-5653 LO source onboard clock. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN terminal on the PXIe-5622, and connect the 10 MHZ REF OUT terminal on the PXIe-5653 to the REF/LO IN connector on the PXIe-5694.**PXIe-5668 **Lock the PXIe-5668 to the PXIe-5653 LO SOURCE onboard clock. Connect the LO2 OUT connector on the PXIe-5606 to the CLK IN connector on the PXIe-5624.**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-5644/5645/5646, PXIe-5820/5840/5841 **Lock the NI-RFSA device to its onboard clock.**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 User Manual for the instrument.**PXIe-5860 **Lock to the PXIe-5860 onboard clock.' ], [ - 'NIRFSA_VAL_REF_IN', + 'NIRFSA_VAL_REF_IN_STR', '**PXI-5661 **NI-RFSA locks the NI-RFSA device to the signal at the external FREQ REF IN connector on the PXI-5600**PXIe-5663/5663E **Connect the external signal to the PXI/PXIe-5652 REF IN/OUT connector. Connect the REF OUT2 connector (if it exists) on the PXI/PXIe-5652 to the CLK IN terminal on the PXIe-5622. On versions of the PXIe-5663/5663E that lack a REF OUT2 connector on the PXI/PXIe-5652, this configuration can only be used in external digitizer mode.**PXIe-5665 **Connect the external signal to the PXIe-5653 REF IN connector. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN terminal on the PXIe-5622. If your external clock signal frequency is set to a frequency other than 10 MHz, set the NIRFSA_ATTR_REF_CLOCK_RATE attribute according to the frequency of your external clock signal.**PXIe-5667 **Connect the external signal to the PXIe-5653 REF IN connector. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN terminal on the PXIe-5622, and connect the 10 MHZ REF OUT terminal on the PXIe-5653 to the REF/LO IN connector on the PXIe-5694. If your external clock signal frequency is set to a frequency other than 10 MHz, set the NIRFSA_ATTR_REF_CLOCK_RATE attribute according to the frequency of your external clock signal.**PXIe-5668 **Connect the external signal to the PXIe-5653 REF IN connector. Connect the LO2 OUT on the PXIe-5606 to the CLK IN connector on the PXIe-5622. If your external clock signal frequency is set to a frequency other than 10 MHz, set the **clock rate** parameter according to the frequency of your external clock signal.**PXIe-5694 **Connect the Reference Clock signal to the REF/LO IN connector on the PXIe-5694 front panel.**PXIe-5644/5645/5646, PXIe-5820/5840/5841 **Lock the NI-RFSA device to the signal at the external REF IN connector.**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, 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 REF OUT connector on the PXIe-5655 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 User Manual for the instrument. PXIe-5860 Lock to the signal at the REF IN connector on the PXIe-5860.' ], [ - 'NIRFSA_VAL_PXI_CLK', + 'NIRFSA_VAL_PXI_CLK_STR', '**PXI-5661 **NI-RFSA locks the NI-RFSA device to the PXI backplane clock using the PXI-5600. You must connect the PXI 10 MHz connector to the REF IN connector on the PXI-5600 front panel to use this option. **PXIe-5668 **Lock the PXIe-5653 to the PXI backplane clock. Connect the PXIe-5606 LO2 OUT to the LO2 IN connector on the PXIe-5624.**PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5667, PXIe-5694, PXIe-5820/5830/5831/5831/5832 with PXIe-5653/5840/5840 with PXIe-5653/5841/5841 with PXIe-5655/5842/5860 **Lock the device to the PXI backplane clock.' ], [ - 'NIRFSA_VAL_CLK_IN', + 'NIRFSA_VAL_CLK_IN_STR', '**PXI-5661 **This configuration does not apply to the PXI-5661.**PXIe-5663/5663E **NI-RFSA locks the PXIe-5663/5663E to an external 10 MHz signal. Connect the external signal to the CLK IN connector on the PXIe-5622, and connect the PXIe-5622 CLK OUT connector to the FREQ REF IN connector on the PXI/PXIe-5652.**PXIe-5665 **NI-RFSA locks the PXIe-5665 to an external 100 MHz signal. Connect the external signal to the CLK IN connector on the PXIe-5622, and connect the PXIe-5622 CLK OUT connector to the REF IN connector on the PXIe-5653. Set the NIRFSA_ATTR_REF_CLOCK_RATE attribute to 100 MHz.**PXIe-5667 **NI-RFSA locks the PXIe-5667 to an external 100 MHz signal. Connect the external signal to the CLK IN connector on the PXIe-5622, and connect the PXIe-5622 CLK OUT connector to the REF IN connector on the PXIe-5653. Connect the 10 MHZ REF OUT terminal on the PXIe-5653 to the REF/LO IN connector on the PXIe-5694. Set the NIRFSA_ATTR_REF_CLOCK_RATE attribute to 100 MHz.**PXIe-5668 **Lock the PXIe-5668 to an external 100 MHz signal. Connect the external signal to the CLK IN connector on the PXIe-5624, and connect the PXIe-5624 CLK OUT connector to the REF IN connector on the PXIe-5653. Set the **clock rate** parameter to 100 MHz.**PXIe-5644/5645/5646, PXIe-5820/5830/5831/5831/5832 with PXIe-5653/5840/5840 with PXIe-5653/5841/5841 with PXIe-5655/5842/5860 **This configuration does not apply.' ], [ - 'NIRFSA_VAL_PXI_CLK_MASTER', + 'NIRFSA_VAL_PXI_CLK_MASTER_STR', '**PXIe-5831/5832 with PXIe-5653 **NI-RFSA 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.**PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5644/5645/5646, PXIe-5820/5840/5841/5841 with PXIe-5655 /5842/5860**This configuration does not apply.' ], [ - 'NIRFSA_VAL_REF_IN_2', + 'NIRFSA_VAL_REF_IN_2_STR', '**PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5644/5645/5646, PXIe-5820/5830/5831/5831/5832 with PXIe-5653/5840/5841/5841 with PXIe-5655 **This configuration does not apply.' ] ], @@ -473,7 +473,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. \n\nThis attribute is only valid when the NIRFSA_ATTR_REF_CLOCK_SOURCE attribute is set to NIRFSA_VAL_CLK_IN, NIRFSA_VAL_REF_IN, or NIRFSA_VAL_REF_IN_2.\n\n**Valid Values**:\n\n**PXIe-5644/5645/5646, PXIe-5601/5663/5663E, PXIe-5694, PXIe-5820/5830/5831/5832/5840/5841**: 10 MHz\n\n**PXIe-5603/5605/5665/5667/5668**: 5 MHz to 100 MHz, in increments of 1 MHz\n\n**PXIe-5841 with PXIe-5655, PXIe-5842**: 10 MHz, 100 MHz, 270 MHz, and 3.84 MHz *y*, where *y* is 4, 8, 16, 24, 25, or 32.\n\n**PXIe-5860**: 10 MHz, 100 MHz\n\n**Default Value**: 10 MHz\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureRefClock' + 'description': 'Specifies the Reference Clock rate, in Hz, of the signal present at the REF IN or CLK IN connector. \n\nThis attribute is only valid when the NIRFSA_ATTR_REF_CLOCK_SOURCE attribute is set to NIRFSA_VAL_CLK_IN, NIRFSA_VAL_REF_IN, or NIRFSA_VAL_REF_IN_2_STR.\n\n**Valid Values**:\n\n**PXIe-5644/5645/5646, PXIe-5601/5663/5663E, PXIe-5694, PXIe-5820/5830/5831/5832/5840/5841**: 10 MHz\n\n**PXIe-5603/5605/5665/5667/5668**: 5 MHz to 100 MHz, in increments of 1 MHz\n\n**PXIe-5841 with PXIe-5655, PXIe-5842**: 10 MHz, 100 MHz, 270 MHz, and 3.84 MHz *y*, where *y* is 4, 8, 16, 24, 25, or 32.\n\n**PXIe-5860**: 10 MHz, 100 MHz\n\n**Default Value**: 10 MHz\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ConfigureRefClock' }, 'lv_property': 'Clocking:Ref Clock Rate', 'name': 'REF_CLOCK_RATE', @@ -483,26 +483,26 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': 'Specifies the source of the Sample Clock timebase, which is the timebase used to control waveform sampling.\n\n**Default Value**: NIRFSA_VAL_ONBOARD_CLOCK\n\n**Supported Devices**: PXI-5661, PXIe-5663/5663E/5665/5667/5668\n\n**Defined Values**:', + 'description': 'Specifies the source of the Sample Clock timebase, which is the timebase used to control waveform sampling.\n\n**Default Value**: NIRFSA_VAL_ONBOARD_CLOCK_STR\n\n**Supported Devices**: PXI-5661, PXIe-5663/5663E/5665/5667/5668\n\n**Defined Values**:', 'table_body': [ [ - 'NIRFSA_VAL_ONBOARD_CLOCK', + 'NIRFSA_VAL_ONBOARD_CLOCK_STR', 'The digitizer uses its onboard clock as the Sample Clock timebase.' ], [ - 'NIRFSA_VAL_CLK_IN', + 'NIRFSA_VAL_CLK_IN_STR', 'The digitizer uses the signal present on the CLK IN connector as the Sample Clock timebase.' ], [ - 'NIRFSA_VAL_LO_REF_CLK', + 'NIRFSA_VAL_LO_REF_CLK_STR', 'The digitizer uses the signal generated on the 100 MHz REF OUT terminal on the PXIe-5653 as the Sample Clock timebase. This value is supported only for the PXIe-5665.' ], [ - 'NIRFSA_VAL_PXI_STAR', + 'NIRFSA_VAL_PXI_STAR_STR', 'The digitizer uses the signal present at the PXI star trigger line as the Sample Clock timebase. This value is not supported for the PXIe-5668.' ], [ - 'NIRFSA_VAL_DOWNCONVERTER_LO2_OUT', + 'NIRFSA_VAL_DOWNCONVERTER_LO2_OUT_STR', 'The digitizer uses the signal present on the LO2 OUT connector on the downconverter as the Sample Clock timebase. This value is supported only for the PXIe-5668.' ] ], @@ -520,7 +520,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': 'Specifies the frequency, in hertz (Hz), of the external clock used as the timebase source if you set the NIRFSA_ATTR_DIGITIZER_SAMPLE_CLOCK_TIMEBASE_SOURCE attribute to an external source, such as NIRFSA_VAL_CLK_IN, NIRFSA_VAL_LO_REF_CLK, or NIRFSA_VAL_DOWNCONVERTER_LO2_OUT\n\n**PXI-5661**If this attribute is set to a value less than 60 MHz, signals at frequencies just above the 20 MHz passband of the downconverter may be aliased back into the passband. This aliasing occurs because the IF frequency of the downconverter is 15 MHz, and the upper end of the passband is 25 MHz. At sampling rates below 60 MHz, the Nyquist frequency is close to the end of the passband and creates aliases that are not filtered effectively by the downconverter.\n\n**Units**: hertz (Hz)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668\n\n**Valid and Default Values**:', + 'description': 'Specifies the frequency, in hertz (Hz), of the external clock used as the timebase source if you set the NIRFSA_ATTR_DIGITIZER_SAMPLE_CLOCK_TIMEBASE_SOURCE attribute to an external source, such as NIRFSA_VAL_CLK_IN, NIRFSA_VAL_LO_REF_CLK_STR, or NIRFSA_VAL_DOWNCONVERTER_LO2_OUT_STR\n\n**PXI-5661**If this attribute is set to a value less than 60 MHz, signals at frequencies just above the 20 MHz passband of the downconverter may be aliased back into the passband. This aliasing occurs because the IF frequency of the downconverter is 15 MHz, and the upper end of the passband is 25 MHz. At sampling rates below 60 MHz, the Nyquist frequency is close to the end of the passband and creates aliases that are not filtered effectively by the downconverter.\n\n**Units**: hertz (Hz)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668\n\n**Valid and Default Values**:', 'table_body': [ [ 'PXI-5661', @@ -644,7 +644,7 @@ 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' ], [ - 'NIRFSA_VAL_PXIE_DSTARB', + 'NIRFSA_VAL_PXIE_DSTARB_STR', '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.' ], [ @@ -680,7 +680,7 @@ 'The trigger is received on PFI7 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_TIMER_EVENT', + 'NIRFSA_VAL_TIMER_EVENT_STR', 'The trigger is received from the Timer Event. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841, and for digital edge Advance Triggers on the PXIe-5663E/5665.' ] ], @@ -728,99 +728,99 @@ 'description': 'Specifies the destination terminal for the exported Start Trigger.\n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ExportSignal\n\n**Defined Values**:', 'table_body': [ [ - 'NIRFSA_VAL_DO_NOT_EXPORT', + 'NIRFSA_VAL_DO_NOT_EXPORT_STR', 'The signal is not exported.' ], [ - 'NIRFSA_VAL_CLK_OUT', + 'NIRFSA_VAL_CLK_OUT_STR', 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_REF_OUT', + 'NIRFSA_VAL_REF_OUT_STR', 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_REF_OUT2', + 'NIRFSA_VAL_REF_OUT2_STR', 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' ], [ - 'NIRFSA_VAL_PFI0', + 'NIRFSA_VAL_PFI0_STR', 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' ], [ - 'NIRFSA_VAL_PFI1', + 'NIRFSA_VAL_PFI1_STR', 'The trigger is received on PFI 1.' ], [ - 'NIRFSA_VAL_PXI_TRIG0', + 'NIRFSA_VAL_PXI_TRIG0_STR', 'The trigger is received on PXI trigger line 0.' ], [ - 'NIRFSA_VAL_PXI_TRIG1', + 'NIRFSA_VAL_PXI_TRIG1_STR', 'The trigger is received on PXI trigger line 1.' ], [ - 'NIRFSA_VAL_PXI_TRIG2', + 'NIRFSA_VAL_PXI_TRIG2_STR', 'The trigger is received on PXI trigger line 2.' ], [ - 'NIRFSA_VAL_PXI_TRIG3', + 'NIRFSA_VAL_PXI_TRIG3_STR', 'The trigger is received on PXI trigger line 3.' ], [ - 'NIRFSA_VAL_PXI_TRIG4', + 'NIRFSA_VAL_PXI_TRIG4_STR', 'The trigger is received on PXI trigger line 4.' ], [ - 'NIRFSA_VAL_PXI_TRIG5', + 'NIRFSA_VAL_PXI_TRIG5_STR', 'The trigger is received on PXI trigger line 5.' ], [ - 'NIRFSA_VAL_PXI_TRIG6', + 'NIRFSA_VAL_PXI_TRIG6_STR', 'The trigger is received on PXI trigger line 6.' ], [ - 'NIRFSA_VAL_PXI_TRIG7', + 'NIRFSA_VAL_PXI_TRIG7_STR', 'The trigger is received on PXI trigger line 7.' ], [ - 'NIRFSA_VAL_PXI_STAR', + 'NIRFSA_VAL_PXI_STAR_STR', 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' ], [ - 'NIRFSA_VAL_PXIE_DSTARC', + 'NIRFSA_VAL_PXIE_DSTARC_STR', 'The trigger is received on the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_DIO_PFI0', + 'NIRFSA_VAL_DIO_PFI0_STR', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI1', + 'NIRFSA_VAL_DIO_PFI1_STR', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI2', + 'NIRFSA_VAL_DIO_PFI2_STR', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI3', + 'NIRFSA_VAL_DIO_PFI3_STR', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI4', + 'NIRFSA_VAL_DIO_PFI4_STR', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI5', + 'NIRFSA_VAL_DIO_PFI5_STR', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI6', + 'NIRFSA_VAL_DIO_PFI6_STR', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI7', + 'NIRFSA_VAL_DIO_PFI7_STR', 'The trigger is received on PFI7 from the front panel DIO terminal.' ] ], @@ -938,7 +938,7 @@ 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' ], [ - 'NIRFSA_VAL_PXIE_DSTARB', + 'NIRFSA_VAL_PXIE_DSTARB_STR', '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.' ], [ @@ -974,7 +974,7 @@ 'The trigger is received on PFI7 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_TIMER_EVENT', + 'NIRFSA_VAL_TIMER_EVENT_STR', 'The trigger is received from the Timer Event. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841, and for digital edge Advance Triggers on the PXIe-5663E/5665.' ] ], @@ -1019,99 +1019,99 @@ 'description': 'Specifies the destination terminal for the exported Reference Trigger.\n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ExportSignal\n\n**Defined Values**:', 'table_body': [ [ - 'NIRFSA_VAL_DO_NOT_EXPORT', + 'NIRFSA_VAL_DO_NOT_EXPORT_STR', 'The signal is not exported.' ], [ - 'NIRFSA_VAL_CLK_OUT', + 'NIRFSA_VAL_CLK_OUT_STR', 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_REF_OUT', + 'NIRFSA_VAL_REF_OUT_STR', 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_REF_OUT2', + 'NIRFSA_VAL_REF_OUT2_STR', 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' ], [ - 'NIRFSA_VAL_PFI0', + 'NIRFSA_VAL_PFI0_STR', 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' ], [ - 'NIRFSA_VAL_PFI1', + 'NIRFSA_VAL_PFI1_STR', 'The trigger is received on PFI 1.' ], [ - 'NIRFSA_VAL_PXI_TRIG0', + 'NIRFSA_VAL_PXI_TRIG0_STR', 'The trigger is received on PXI trigger line 0.' ], [ - 'NIRFSA_VAL_PXI_TRIG1', + 'NIRFSA_VAL_PXI_TRIG1_STR', 'The trigger is received on PXI trigger line 1.' ], [ - 'NIRFSA_VAL_PXI_TRIG2', + 'NIRFSA_VAL_PXI_TRIG2_STR', 'The trigger is received on PXI trigger line 2.' ], [ - 'NIRFSA_VAL_PXI_TRIG3', + 'NIRFSA_VAL_PXI_TRIG3_STR', 'The trigger is received on PXI trigger line 3.' ], [ - 'NIRFSA_VAL_PXI_TRIG4', + 'NIRFSA_VAL_PXI_TRIG4_STR', 'The trigger is received on PXI trigger line 4.' ], [ - 'NIRFSA_VAL_PXI_TRIG5', + 'NIRFSA_VAL_PXI_TRIG5_STR', 'The trigger is received on PXI trigger line 5.' ], [ - 'NIRFSA_VAL_PXI_TRIG6', + 'NIRFSA_VAL_PXI_TRIG6_STR', 'The trigger is received on PXI trigger line 6.' ], [ - 'NIRFSA_VAL_PXI_TRIG7', + 'NIRFSA_VAL_PXI_TRIG7_STR', 'The trigger is received on PXI trigger line 7.' ], [ - 'NIRFSA_VAL_PXI_STAR', + 'NIRFSA_VAL_PXI_STAR_STR', 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' ], [ - 'NIRFSA_VAL_PXIE_DSTARC', + 'NIRFSA_VAL_PXIE_DSTARC_STR', 'The trigger is received on the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_DIO_PFI0', + 'NIRFSA_VAL_DIO_PFI0_STR', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI1', + 'NIRFSA_VAL_DIO_PFI1_STR', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI2', + 'NIRFSA_VAL_DIO_PFI2_STR', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI3', + 'NIRFSA_VAL_DIO_PFI3_STR', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI4', + 'NIRFSA_VAL_DIO_PFI4_STR', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI5', + 'NIRFSA_VAL_DIO_PFI5_STR', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI6', + 'NIRFSA_VAL_DIO_PFI6_STR', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI7', + 'NIRFSA_VAL_DIO_PFI7_STR', 'The trigger is received on PFI7 from the front panel DIO terminal.' ] ], @@ -1255,7 +1255,7 @@ 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' ], [ - 'NIRFSA_VAL_PXIE_DSTARB', + 'NIRFSA_VAL_PXIE_DSTARB_STR', '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.' ], [ @@ -1291,7 +1291,7 @@ 'The trigger is received on PFI7 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_TIMER_EVENT', + 'NIRFSA_VAL_TIMER_EVENT_STR', 'The trigger is received from the Timer Event. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841, and for digital edge Advance Triggers on the PXIe-5663E/5665.' ] ], @@ -1311,99 +1311,99 @@ 'description': 'Specifies the destination terminal for the exported Advance Trigger.\n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ExportSignal\n\n**Defined Values**:', 'table_body': [ [ - 'NIRFSA_VAL_DO_NOT_EXPORT', + 'NIRFSA_VAL_DO_NOT_EXPORT_STR', 'The signal is not exported.' ], [ - 'NIRFSA_VAL_CLK_OUT', + 'NIRFSA_VAL_CLK_OUT_STR', 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_REF_OUT', + 'NIRFSA_VAL_REF_OUT_STR', 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_REF_OUT2', + 'NIRFSA_VAL_REF_OUT2_STR', 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' ], [ - 'NIRFSA_VAL_PFI0', + 'NIRFSA_VAL_PFI0_STR', 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' ], [ - 'NIRFSA_VAL_PFI1', + 'NIRFSA_VAL_PFI1_STR', 'The trigger is received on PFI 1.' ], [ - 'NIRFSA_VAL_PXI_TRIG0', + 'NIRFSA_VAL_PXI_TRIG0_STR', 'The trigger is received on PXI trigger line 0.' ], [ - 'NIRFSA_VAL_PXI_TRIG1', + 'NIRFSA_VAL_PXI_TRIG1_STR', 'The trigger is received on PXI trigger line 1.' ], [ - 'NIRFSA_VAL_PXI_TRIG2', + 'NIRFSA_VAL_PXI_TRIG2_STR', 'The trigger is received on PXI trigger line 2.' ], [ - 'NIRFSA_VAL_PXI_TRIG3', + 'NIRFSA_VAL_PXI_TRIG3_STR', 'The trigger is received on PXI trigger line 3.' ], [ - 'NIRFSA_VAL_PXI_TRIG4', + 'NIRFSA_VAL_PXI_TRIG4_STR', 'The trigger is received on PXI trigger line 4.' ], [ - 'NIRFSA_VAL_PXI_TRIG5', + 'NIRFSA_VAL_PXI_TRIG5_STR', 'The trigger is received on PXI trigger line 5.' ], [ - 'NIRFSA_VAL_PXI_TRIG6', + 'NIRFSA_VAL_PXI_TRIG6_STR', 'The trigger is received on PXI trigger line 6.' ], [ - 'NIRFSA_VAL_PXI_TRIG7', + 'NIRFSA_VAL_PXI_TRIG7_STR', 'The trigger is received on PXI trigger line 7.' ], [ - 'NIRFSA_VAL_PXI_STAR', + 'NIRFSA_VAL_PXI_STAR_STR', 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' ], [ - 'NIRFSA_VAL_PXIE_DSTARC', + 'NIRFSA_VAL_PXIE_DSTARC_STR', 'The trigger is received on the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_DIO_PFI0', + 'NIRFSA_VAL_DIO_PFI0_STR', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI1', + 'NIRFSA_VAL_DIO_PFI1_STR', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI2', + 'NIRFSA_VAL_DIO_PFI2_STR', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI3', + 'NIRFSA_VAL_DIO_PFI3_STR', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI4', + 'NIRFSA_VAL_DIO_PFI4_STR', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI5', + 'NIRFSA_VAL_DIO_PFI5_STR', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI6', + 'NIRFSA_VAL_DIO_PFI6_STR', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI7', + 'NIRFSA_VAL_DIO_PFI7_STR', 'The trigger is received on PFI7 from the front panel DIO terminal.' ] ], @@ -1513,7 +1513,7 @@ 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' ], [ - 'NIRFSA_VAL_PXIE_DSTARB', + 'NIRFSA_VAL_PXIE_DSTARB_STR', '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.' ], [ @@ -1549,7 +1549,7 @@ 'The trigger is received on PFI7 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_TIMER_EVENT', + 'NIRFSA_VAL_TIMER_EVENT_STR', 'The trigger is received from the Timer Event. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841, and for digital edge Advance Triggers on the PXIe-5663E/5665.' ] ], @@ -1569,99 +1569,99 @@ 'description': 'Specifies the destination terminal for the Ready for Start Event.\n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ExportSignal\n\n**Defined Values**:', 'table_body': [ [ - 'NIRFSA_VAL_DO_NOT_EXPORT', + 'NIRFSA_VAL_DO_NOT_EXPORT_STR', 'The signal is not exported.' ], [ - 'NIRFSA_VAL_CLK_OUT', + 'NIRFSA_VAL_CLK_OUT_STR', 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_REF_OUT', + 'NIRFSA_VAL_REF_OUT_STR', 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_REF_OUT2', + 'NIRFSA_VAL_REF_OUT2_STR', 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' ], [ - 'NIRFSA_VAL_PFI0', + 'NIRFSA_VAL_PFI0_STR', 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' ], [ - 'NIRFSA_VAL_PFI1', + 'NIRFSA_VAL_PFI1_STR', 'The trigger is received on PFI 1.' ], [ - 'NIRFSA_VAL_PXI_TRIG0', + 'NIRFSA_VAL_PXI_TRIG0_STR', 'The trigger is received on PXI trigger line 0.' ], [ - 'NIRFSA_VAL_PXI_TRIG1', + 'NIRFSA_VAL_PXI_TRIG1_STR', 'The trigger is received on PXI trigger line 1.' ], [ - 'NIRFSA_VAL_PXI_TRIG2', + 'NIRFSA_VAL_PXI_TRIG2_STR', 'The trigger is received on PXI trigger line 2.' ], [ - 'NIRFSA_VAL_PXI_TRIG3', + 'NIRFSA_VAL_PXI_TRIG3_STR', 'The trigger is received on PXI trigger line 3.' ], [ - 'NIRFSA_VAL_PXI_TRIG4', + 'NIRFSA_VAL_PXI_TRIG4_STR', 'The trigger is received on PXI trigger line 4.' ], [ - 'NIRFSA_VAL_PXI_TRIG5', + 'NIRFSA_VAL_PXI_TRIG5_STR', 'The trigger is received on PXI trigger line 5.' ], [ - 'NIRFSA_VAL_PXI_TRIG6', + 'NIRFSA_VAL_PXI_TRIG6_STR', 'The trigger is received on PXI trigger line 6.' ], [ - 'NIRFSA_VAL_PXI_TRIG7', + 'NIRFSA_VAL_PXI_TRIG7_STR', 'The trigger is received on PXI trigger line 7.' ], [ - 'NIRFSA_VAL_PXI_STAR', + 'NIRFSA_VAL_PXI_STAR_STR', 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' ], [ - 'NIRFSA_VAL_PXIE_DSTARC', + 'NIRFSA_VAL_PXIE_DSTARC_STR', 'The trigger is received on the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_DIO_PFI0', + 'NIRFSA_VAL_DIO_PFI0_STR', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI1', + 'NIRFSA_VAL_DIO_PFI1_STR', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI2', + 'NIRFSA_VAL_DIO_PFI2_STR', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI3', + 'NIRFSA_VAL_DIO_PFI3_STR', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI4', + 'NIRFSA_VAL_DIO_PFI4_STR', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI5', + 'NIRFSA_VAL_DIO_PFI5_STR', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI6', + 'NIRFSA_VAL_DIO_PFI6_STR', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI7', + 'NIRFSA_VAL_DIO_PFI7_STR', 'The trigger is received on PFI7 from the front panel DIO terminal.' ] ], @@ -1682,99 +1682,99 @@ 'description': 'Specifies the destination terminal for the Ready for Advance Event.\n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ExportSignal\n\n**Defined Values**:', 'table_body': [ [ - 'NIRFSA_VAL_DO_NOT_EXPORT', + 'NIRFSA_VAL_DO_NOT_EXPORT_STR', 'The signal is not exported.' ], [ - 'NIRFSA_VAL_CLK_OUT', + 'NIRFSA_VAL_CLK_OUT_STR', 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_REF_OUT', + 'NIRFSA_VAL_REF_OUT_STR', 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_REF_OUT2', + 'NIRFSA_VAL_REF_OUT2_STR', 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' ], [ - 'NIRFSA_VAL_PFI0', + 'NIRFSA_VAL_PFI0_STR', 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' ], [ - 'NIRFSA_VAL_PFI1', + 'NIRFSA_VAL_PFI1_STR', 'The trigger is received on PFI 1.' ], [ - 'NIRFSA_VAL_PXI_TRIG0', + 'NIRFSA_VAL_PXI_TRIG0_STR', 'The trigger is received on the PXI trigger line 0.' ], [ - 'NIRFSA_VAL_PXI_TRIG1', + 'NIRFSA_VAL_PXI_TRIG1_STR', 'The trigger is received on the PXI trigger line 1.' ], [ - 'NIRFSA_VAL_PXI_TRIG2', + 'NIRFSA_VAL_PXI_TRIG2_STR', 'The trigger is received on the PXI trigger line 2.' ], [ - 'NIRFSA_VAL_PXI_TRIG3', + 'NIRFSA_VAL_PXI_TRIG3_STR', 'The trigger is received on the PXI trigger line 3.' ], [ - 'NIRFSA_VAL_PXI_TRIG4', + 'NIRFSA_VAL_PXI_TRIG4_STR', 'The trigger is received on the PXI trigger line 4.' ], [ - 'NIRFSA_VAL_PXI_TRIG5', + 'NIRFSA_VAL_PXI_TRIG5_STR', 'The trigger is received on the PXI trigger line 5.' ], [ - 'NIRFSA_VAL_PXI_TRIG6', + 'NIRFSA_VAL_PXI_TRIG6_STR', 'The trigger is received on the PXI trigger line 6.' ], [ - 'NIRFSA_VAL_PXI_TRIG7', + 'NIRFSA_VAL_PXI_TRIG7_STR', 'The trigger is received on the PXI trigger line 7.' ], [ - 'NIRFSA_VAL_PXI_STAR', + 'NIRFSA_VAL_PXI_STAR_STR', 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' ], [ - 'NIRFSA_VAL_PXIE_DSTARC', + 'NIRFSA_VAL_PXIE_DSTARC_STR', 'The trigger is received on the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_DIO_PFI0', + 'NIRFSA_VAL_DIO_PFI0_STR', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI1', + 'NIRFSA_VAL_DIO_PFI1_STR', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI2', + 'NIRFSA_VAL_DIO_PFI2_STR', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI3', + 'NIRFSA_VAL_DIO_PFI3_STR', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI4', + 'NIRFSA_VAL_DIO_PFI4_STR', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI5', + 'NIRFSA_VAL_DIO_PFI5_STR', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI6', + 'NIRFSA_VAL_DIO_PFI6_STR', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI7', + 'NIRFSA_VAL_DIO_PFI7_STR', 'The trigger is received on PFI7 from the front panel DIO terminal.' ] ], @@ -1795,99 +1795,99 @@ 'description': 'Specifies the destination terminal for the Ready for Reference Event.\n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ExportSignal\n\n**Defined Values**:', 'table_body': [ [ - 'NIRFSA_VAL_DO_NOT_EXPORT', + 'NIRFSA_VAL_DO_NOT_EXPORT_STR', 'The signal is not exported.' ], [ - 'NIRFSA_VAL_CLK_OUT', + 'NIRFSA_VAL_CLK_OUT_STR', 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_REF_OUT', + 'NIRFSA_VAL_REF_OUT_STR', 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_REF_OUT2', + 'NIRFSA_VAL_REF_OUT2_STR', 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' ], [ - 'NIRFSA_VAL_PFI0', + 'NIRFSA_VAL_PFI0_STR', 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' ], [ - 'NIRFSA_VAL_PFI1', + 'NIRFSA_VAL_PFI1_STR', 'The trigger is received on PFI 1.' ], [ - 'NIRFSA_VAL_PXI_TRIG0', + 'NIRFSA_VAL_PXI_TRIG0_STR', 'The trigger is received on PXI trigger line 0.' ], [ - 'NIRFSA_VAL_PXI_TRIG1', + 'NIRFSA_VAL_PXI_TRIG1_STR', 'The trigger is received on PXI trigger line 1.' ], [ - 'NIRFSA_VAL_PXI_TRIG2', + 'NIRFSA_VAL_PXI_TRIG2_STR', 'The trigger is received on PXI trigger line 2.' ], [ - 'NIRFSA_VAL_PXI_TRIG3', + 'NIRFSA_VAL_PXI_TRIG3_STR', 'The trigger is received on PXI trigger line 3.' ], [ - 'NIRFSA_VAL_PXI_TRIG4', + 'NIRFSA_VAL_PXI_TRIG4_STR', 'The trigger is received on PXI trigger line 4.' ], [ - 'NIRFSA_VAL_PXI_TRIG5', + 'NIRFSA_VAL_PXI_TRIG5_STR', 'The trigger is received on PXI trigger line 5.' ], [ - 'NIRFSA_VAL_PXI_TRIG6', + 'NIRFSA_VAL_PXI_TRIG6_STR', 'The trigger is received on PXI trigger line 6.' ], [ - 'NIRFSA_VAL_PXI_TRIG7', + 'NIRFSA_VAL_PXI_TRIG7_STR', 'The trigger is received on PXI trigger line 7.' ], [ - 'NIRFSA_VAL_PXI_STAR', + 'NIRFSA_VAL_PXI_STAR_STR', 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' ], [ - 'NIRFSA_VAL_PXIE_DSTARC', + 'NIRFSA_VAL_PXIE_DSTARC_STR', 'The trigger is received on the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_DIO_PFI0', + 'NIRFSA_VAL_DIO_PFI0_STR', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI1', + 'NIRFSA_VAL_DIO_PFI1_STR', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI2', + 'NIRFSA_VAL_DIO_PFI2_STR', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI3', + 'NIRFSA_VAL_DIO_PFI3_STR', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI4', + 'NIRFSA_VAL_DIO_PFI4_STR', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI5', + 'NIRFSA_VAL_DIO_PFI5_STR', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI6', + 'NIRFSA_VAL_DIO_PFI6_STR', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI7', + 'NIRFSA_VAL_DIO_PFI7_STR', 'The trigger is received on PFI7 from the front panel DIO terminal.' ] ], @@ -1908,99 +1908,99 @@ 'description': 'Specifies the destination terminal for the End of Record Event.\n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_\n\n`Events `_\n\n`Signal Routing `_\n\n**High-Level Functions**:\n\n- nirfsa_ExportSignal\n\n**Defined Values**:', 'table_body': [ [ - 'NIRFSA_VAL_DO_NOT_EXPORT', + 'NIRFSA_VAL_DO_NOT_EXPORT_STR', 'The signal is not exported.' ], [ - 'NIRFSA_VAL_CLK_OUT', + 'NIRFSA_VAL_CLK_OUT_STR', 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_REF_OUT', + 'NIRFSA_VAL_REF_OUT_STR', 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_REF_OUT2', + 'NIRFSA_VAL_REF_OUT2_STR', 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' ], [ - 'NIRFSA_VAL_PFI0', + 'NIRFSA_VAL_PFI0_STR', 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' ], [ - 'NIRFSA_VAL_PFI1', + 'NIRFSA_VAL_PFI1_STR', 'The trigger is received on PFI 1.' ], [ - 'NIRFSA_VAL_PXI_TRIG0', + 'NIRFSA_VAL_PXI_TRIG0_STR', 'The trigger is received on PXI trigger line 0.' ], [ - 'NIRFSA_VAL_PXI_TRIG1', + 'NIRFSA_VAL_PXI_TRIG1_STR', 'The trigger is received on PXI trigger line 1.' ], [ - 'NIRFSA_VAL_PXI_TRIG2', + 'NIRFSA_VAL_PXI_TRIG2_STR', 'The trigger is received on PXI trigger line 2.' ], [ - 'NIRFSA_VAL_PXI_TRIG3', + 'NIRFSA_VAL_PXI_TRIG3_STR', 'The trigger is received on PXI trigger line 3.' ], [ - 'NIRFSA_VAL_PXI_TRIG4', + 'NIRFSA_VAL_PXI_TRIG4_STR', 'The trigger is received on PXI trigger line 4.' ], [ - 'NIRFSA_VAL_PXI_TRIG5', + 'NIRFSA_VAL_PXI_TRIG5_STR', 'The trigger is received on PXI trigger line 5.' ], [ - 'NIRFSA_VAL_PXI_TRIG6', + 'NIRFSA_VAL_PXI_TRIG6_STR', 'The trigger is received on PXI trigger line 6.' ], [ - 'NIRFSA_VAL_PXI_TRIG7', + 'NIRFSA_VAL_PXI_TRIG7_STR', 'The trigger is received on PXI trigger line 7.' ], [ - 'NIRFSA_VAL_PXI_STAR', + 'NIRFSA_VAL_PXI_STAR_STR', 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' ], [ - 'NIRFSA_VAL_PXIE_DSTARC', + 'NIRFSA_VAL_PXIE_DSTARC_STR', 'The trigger is received on the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_DIO_PFI0', + 'NIRFSA_VAL_DIO_PFI0_STR', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI1', + 'NIRFSA_VAL_DIO_PFI1_STR', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI2', + 'NIRFSA_VAL_DIO_PFI2_STR', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI3', + 'NIRFSA_VAL_DIO_PFI3_STR', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI4', + 'NIRFSA_VAL_DIO_PFI4_STR', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI5', + 'NIRFSA_VAL_DIO_PFI5_STR', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI6', + 'NIRFSA_VAL_DIO_PFI6_STR', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI7', + 'NIRFSA_VAL_DIO_PFI7_STR', 'The trigger is received on PFI7 from the front panel DIO terminal.' ] ], @@ -2075,7 +2075,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': 'Enables use of the digital equalization filter for the RF downconverter.\n\n**PXIe-5820/5830/5831/5832/5840/5841/5842/5860**: The only valid value for this attribute is VI_TRUE.\n\n----\n**Note**\nFor PXIe-5665/5667 devices, digital IF equalization is supported only with a 150 MHz clock. You cannot set this attribute to VI_TRUE if the NIRFSA_ATTR_DIGITIZER_SAMPLE_CLOCK_TIMEBASE_SOURCE attribute is set to NIRFSA_VAL_LO_REF_CLK.\n\n----\n\n----\n**Note**\nFor the PXIe-5665 (14 GHz)/5667 (7 GHz)/5668, the preselector is not part of the IF filter path, so NI-RFSA does not equalize the preselector distortions.\n\n----\n\n**Default Value**: VI_TRUE, if the device configuration is supported.\n\n**Supported Devices**: PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841\n\n**Defined Values**:', + 'description': 'Enables use of the digital equalization filter for the RF downconverter.\n\n**PXIe-5820/5830/5831/5832/5840/5841/5842/5860**: The only valid value for this attribute is VI_TRUE.\n\n----\n**Note**\nFor PXIe-5665/5667 devices, digital IF equalization is supported only with a 150 MHz clock. You cannot set this attribute to VI_TRUE if the NIRFSA_ATTR_DIGITIZER_SAMPLE_CLOCK_TIMEBASE_SOURCE attribute is set to NIRFSA_VAL_LO_REF_CLK_STR.\n\n----\n\n----\n**Note**\nFor the PXIe-5665 (14 GHz)/5667 (7 GHz)/5668, the preselector is not part of the IF filter path, so NI-RFSA does not equalize the preselector distortions.\n\n----\n\n**Default Value**: VI_TRUE, if the device configuration is supported.\n\n**Supported Devices**: PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841\n\n**Defined Values**:', 'table_body': [ [ 'VI_TRUE', @@ -2207,99 +2207,99 @@ 'description': 'Specifies the destination terminal for the Done Event.\n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ExportSignal\n\n**Defined Values**:', 'table_body': [ [ - 'NIRFSA_VAL_DO_NOT_EXPORT', + 'NIRFSA_VAL_DO_NOT_EXPORT_STR', 'The signal is not exported.' ], [ - 'NIRFSA_VAL_CLK_OUT', + 'NIRFSA_VAL_CLK_OUT_STR', 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_REF_OUT', + 'NIRFSA_VAL_REF_OUT_STR', 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_REF_OUT2', + 'NIRFSA_VAL_REF_OUT2_STR', 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' ], [ - 'NIRFSA_VAL_PFI0', + 'NIRFSA_VAL_PFI0_STR', 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' ], [ - 'NIRFSA_VAL_PFI1', + 'NIRFSA_VAL_PFI1_STR', 'The trigger is received on PFI 1.' ], [ - 'NIRFSA_VAL_PXI_TRIG0', + 'NIRFSA_VAL_PXI_TRIG0_STR', 'The trigger is received on PXI trigger line 0.' ], [ - 'NIRFSA_VAL_PXI_TRIG1', + 'NIRFSA_VAL_PXI_TRIG1_STR', 'The trigger is received on PXI trigger line 1.' ], [ - 'NIRFSA_VAL_PXI_TRIG2', + 'NIRFSA_VAL_PXI_TRIG2_STR', 'The trigger is received on PXI trigger line 2.' ], [ - 'NIRFSA_VAL_PXI_TRIG3', + 'NIRFSA_VAL_PXI_TRIG3_STR', 'The trigger is received on PXI trigger line 3.' ], [ - 'NIRFSA_VAL_PXI_TRIG4', + 'NIRFSA_VAL_PXI_TRIG4_STR', 'The trigger is received on PXI trigger line 4.' ], [ - 'NIRFSA_VAL_PXI_TRIG5', + 'NIRFSA_VAL_PXI_TRIG5_STR', 'The trigger is received on PXI trigger line 5.' ], [ - 'NIRFSA_VAL_PXI_TRIG6', + 'NIRFSA_VAL_PXI_TRIG6_STR', 'The trigger is received on PXI trigger line 6.' ], [ - 'NIRFSA_VAL_PXI_TRIG7', + 'NIRFSA_VAL_PXI_TRIG7_STR', 'The trigger is received on PXI trigger line 7.' ], [ - 'NIRFSA_VAL_PXI_STAR', + 'NIRFSA_VAL_PXI_STAR_STR', 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' ], [ - 'NIRFSA_VAL_PXIE_DSTARC', + 'NIRFSA_VAL_PXIE_DSTARC_STR', 'The trigger is received on the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_DIO_PFI0', + 'NIRFSA_VAL_DIO_PFI0_STR', 'The trigger is received on PFI0 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI1', + 'NIRFSA_VAL_DIO_PFI1_STR', 'The trigger is received on PFI1 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI2', + 'NIRFSA_VAL_DIO_PFI2_STR', 'The trigger is received on PFI2 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI3', + 'NIRFSA_VAL_DIO_PFI3_STR', 'The trigger is received on PFI3 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI4', + 'NIRFSA_VAL_DIO_PFI4_STR', 'The trigger is received on PFI4 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI5', + 'NIRFSA_VAL_DIO_PFI5_STR', 'The trigger is received on PFI5 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI6', + 'NIRFSA_VAL_DIO_PFI6_STR', 'The trigger is received on PFI6 from the front panel DIO terminal.' ], [ - 'NIRFSA_VAL_DIO_PFI7', + 'NIRFSA_VAL_DIO_PFI7_STR', 'The trigger is received on PFI7 from the front panel DIO terminal.' ] ], @@ -2525,19 +2525,19 @@ 'description': 'Specifies a comma-separated list of the terminals at which to export the Reference Clock.\n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5694, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsa_ExportSignal\n\n**Defined Values**:', 'table_body': [ [ - 'NIRFSA_VAL_NONE', + 'NIRFSA_VAL_NONE_STR', 'The Reference Clock is not exported. This value is not valid for the PXIe-5644/5645/5646.' ], [ - 'NIRFSA_VAL_REF_OUT', + 'NIRFSA_VAL_REF_OUT_STR', 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' ], [ - 'NIRFSA_VAL_REF_OUT2', + 'NIRFSA_VAL_REF_OUT2_STR', 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' ], [ - 'NIRFSA_VAL_CLK_OUT', + 'NIRFSA_VAL_CLK_OUT_STR', 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' ], [ @@ -2970,7 +2970,7 @@ 'Description' ] }, - 'enum': 'DownconverterPreselectorEnabled', + 'enum': 'EnablePreselector', 'lv_property': 'Signal Path:Advanced:Downconverter Preselector Enabled', 'name': 'DOWNCONVERTER_PRESELECTOR_ENABLED', 'type': 'ViInt32' @@ -2979,7 +2979,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': 'Specifies whether to enable the LO OUT terminals on the installed devices.\n\n**PXIe-5601**: The only valid value for this attribute is VI_TRUE.\n\n**PXIe-5603/5605/5606**: If you want to daisy-chain multiple devices together using the same LO source, set this attribute to TRUE to export the LO input signals on the LO1 IN, LO2 IN, and LO3 IN terminals to LO1 OUT, LO2 OUT, and LO3 OUT, respectively.\n\n**PXIe-5694**: You can enable this attribute only if you set the NIRFSA_ATTR_LO_SOURCE attribute to NIRFSA_VAL_LO_IN, or if you set the NIRFSA_ATTR_LO_SOURCE attribute to NIRFSA_VAL_ONBOARD and the NIRFSA_ATTR_IF_CONDITIONING_DOWN_CONVERSION_ENABLED attribute to NIRFSA_VAL_ENABLED.\n\n**PXIe-5830/5831**: To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsa_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 only valid value for the channel string is "" (empty string).\n\n----\n**Note**\nIf you are sharing an LO for the PXIe-5830/5831/5832 between an NI-RFSA and NI-RFSG session, ensure both sessions use the same shared setting.\n\n----\n\n**Defined Values:**\n\n| Value | Description |\n|:---------|:-------------------------------|\n| VI_TRUE | Enables the LO OUT terminals. |\n| VI_FALSE | Disables the LO OUT terminals. |\n\n**Default Values**:\n\n**PXIe-5601, PXIe-5663/5663E**: VI_TRUE\n\n**PXIe-5603/5605/5606, PXIe-5644/5645/5646, PXIe-5665/5667/5668, PXIe-5694, PXIe-5830/5831/5832/5840/5841/5842**: VI_FALSE\n\n**Supported Devices**: PXIe-5601/5603/5605 (external digitizer mode), PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5667, PXIe-5694, PXIe-5830/5831/5832/5840/5841/5842' + 'description': 'Specifies whether to enable the LO OUT terminals on the installed devices.\n\n**PXIe-5601**: The only valid value for this attribute is VI_TRUE.\n\n**PXIe-5603/5605/5606**: If you want to daisy-chain multiple devices together using the same LO source, set this attribute to TRUE to export the LO input signals on the LO1 IN, LO2 IN, and LO3 IN terminals to LO1 OUT, LO2 OUT, and LO3 OUT, respectively.\n\n**PXIe-5694**: You can enable this attribute only if you set the NIRFSA_ATTR_LO_SOURCE attribute to NIRFSA_VAL_LO_IN_STR, or if you set the NIRFSA_ATTR_LO_SOURCE attribute to NIRFSA_VAL_ONBOARD_STR and the NIRFSA_ATTR_IF_CONDITIONING_DOWN_CONVERSION_ENABLED attribute to NIRFSA_VAL_ENABLED.\n\n**PXIe-5830/5831**: To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsa_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 only valid value for the channel string is "" (empty string).\n\n----\n**Note**\nIf you are sharing an LO for the PXIe-5830/5831/5832 between an NI-RFSA and NI-RFSG session, ensure both sessions use the same shared setting.\n\n----\n\n**Defined Values:**\n\n| Value | Description |\n|:---------|:-------------------------------|\n| VI_TRUE | Enables the LO OUT terminals. |\n| VI_FALSE | Disables the LO OUT terminals. |\n\n**Default Values**:\n\n**PXIe-5601, PXIe-5663/5663E**: VI_TRUE\n\n**PXIe-5603/5605/5606, PXIe-5644/5645/5646, PXIe-5665/5667/5668, PXIe-5694, PXIe-5830/5831/5832/5840/5841/5842**: VI_FALSE\n\n**Supported Devices**: PXIe-5601/5603/5605 (external digitizer mode), PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5667, PXIe-5694, PXIe-5830/5831/5832/5840/5841/5842' }, 'lv_property': 'Signal Path:LO Export Enabled', 'name': 'LO_EXPORT_ENABLED', @@ -3175,26 +3175,22 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': 'Specifies the LO signal source used to downconvert the RF input signal.\n\n If no signal downconversion is required, this attribute is ignored. If this attribute is set to "" (empty string), NI-RFSA uses the internal LO source.\n\n To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsa_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 only valid value for the channel string is "" (empty string).\n\n ----\n **Note**\n For the PXIe-5841 with PXIe-5655, RF list mode is not supported when this attribute is set to NIRFSA_VAL_LO_SOURCE_SG_SA_SHARED.\n\n ----\n\n \n \n\n **Default Value**: NIRFSA_VAL_ONBOARD ("Onboard")\n\n **Supported Devices**: PXIe-5644/5645/5646, PXIe-5694, PXIe-5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n `PXIe-5830 LO Sharing Using NI-RFSA and NI-RFSG `_\n `PXIe-5831/5832 LO Sharing Using NI-RFSA and NI-RFSG `_\n\n**Defined Values**:', + 'description': 'Specifies the LO signal source used to downconvert the RF input signal.\n\n If no signal downconversion is required, this attribute is ignored. If this attribute is set to "" (empty string), NI-RFSA uses the internal LO source.\n\n To use this attribute for the PXIe-5830/5831/5832, you must use the channelName parameter of the nirfsa_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 only valid value for the channel string is "" (empty string).\n\n ----\n **Note**\n For the PXIe-5841 with PXIe-5655, RF list mode is not supported when this attribute is set to NIRFSA_VAL_LO_SOURCE_SG_SA_SHARED_STR.\n\n ----\n\n \n \n\n **Default Value**: NIRFSA_VAL_ONBOARD_STR ("Onboard")\n\n **Supported Devices**: PXIe-5644/5645/5646, PXIe-5694, PXIe-5830/5831/5832/5840/5841/5842\n\n **Related Topics**\n `PXIe-5830 LO Sharing Using NI-RFSA and NI-RFSG `_\n `PXIe-5831/5832 LO Sharing Using NI-RFSA and NI-RFSG `_\n\n**Defined Values**:', 'table_body': [ [ - 'NIRFSA_VAL_NONE', - 'Specifies that no LO source is required to downconvert the RF input signal.' - ], - [ - 'NIRFSA_VAL_ONBOARD', + 'NIRFSA_VAL_ONBOARD_STR', 'Specifies that the onboard synthesizer is used to generate the LO signal that downconverts the RF input signal.**PXIe-5831/5832** This configuration uses the onboard LO of the PXIe-3622, using the LO2 stage.**PXIe-5831/5832 with PXIe-5653** This configuration uses the onboard LO of the PXIe-5653 when associated with the PXIe-3622.**PXIe-5841 with PXIe-5655** This configuration uses the onboard LO of the PXIe-5655.' ], [ - 'NIRFSA_VAL_LO_IN', + 'NIRFSA_VAL_LO_IN_STR', 'Specifies that the LO source used to downconvert the RF input signal is connected to the LO IN connector on the front panel.' ], [ - 'NIRFSA_VAL_LO_SOURCE_SECONDARY', + 'NIRFSA_VAL_LO_SOURCE_SECONDARY_STR', 'Uses the PXIe-5831/5840 internal LO as the LO source. This value is valid on only the PXIe-5831 with PXIe-5653 (LO1 stage only) or PXIe-5832 with PCIe-5653 (LO1 stage only).' ], [ - 'NIRFSA_VAL_LO_SOURCE_SG_SA_SHARED', + 'NIRFSA_VAL_LO_SOURCE_SG_SA_SHARED_STR', 'Uses the same internal LO during NI-RFSA and NI-RFSG sessions. NI-RFSA selects an internal synthesizer and the synthesizer signal is switched to both the RF Out and RF In mixers. This value is valid on only the PXIe-5830/5831/5832/5841 with PXIe-5655.' ] ], @@ -3365,7 +3361,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': 'Returns the power level, in dBm, expected at the LO IN terminal when the NIRFSA_ATTR_LO_SOURCE attribute is set to NIRFSA_VAL_LO_IN.\n\n----\n**Note**\nFor the PXIe-5644/5645/5646, this attribute is always read-only.\n\n----\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842' + 'description': 'Returns the power level, in dBm, expected at the LO IN terminal when the NIRFSA_ATTR_LO_SOURCE attribute is set to NIRFSA_VAL_LO_IN_STR.\n\n----\n**Note**\nFor the PXIe-5644/5645/5646, this attribute is always read-only.\n\n----\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5830/5831/5832/5840/5841/5842' }, 'lv_property': 'Device Specific:Vector Signal Transceiver:Signal Path:LO In Power (dBm)', 'name': 'LO_IN_POWER', @@ -3649,11 +3645,11 @@ 'description': 'Specifies the terminal at which to export the Digitizer Sample Clock.\n\n**Valid Values**: \n\n**Default Value**: "" (empty string)\n\n**Supported Devices**: PXIe-5668\n\n**Defined Values**:', 'table_body': [ [ - 'NIRFSA_VAL_NONE', + 'NIRFSA_VAL_NONE_STR', 'The Reference Clock is not exported. This value is not valid for the PXIe-5644/5645/5646.' ], [ - 'NIRFSA_VAL_CLK_OUT', + 'NIRFSA_VAL_CLK_OUT_STR', 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' ] ], @@ -3871,7 +3867,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': 'Specifies whether to enable the RF OUT LO OUT terminal on the PXIe-5840/5841.\n\nWhen this attribute is enabled, if the NIRFSA_ATTR_LO_SOURCE attribute is set to NIRFSA_VAL_LO_IN and you do not set the NIRFSA_ATTR_LO_FREQUENCY or NIRFSA_ATTR_DOWNCONVERTER_CENTER_FREQUENCY attributes, NI-RFSA rounds the LO frequency to approximately an LO step size as if the source was NIRFSA_VAL_ONBOARD. 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:**: NIRFSA_VAL_UNSPECIFIED\n\n**Supported Devices**: PXIe-5840/5841/5842\n\n**Defined Values**:', + 'description': 'Specifies whether to enable the RF OUT LO OUT terminal on the PXIe-5840/5841.\n\nWhen this attribute is enabled, if the NIRFSA_ATTR_LO_SOURCE attribute is set to NIRFSA_VAL_LO_IN_STR and you do not set the NIRFSA_ATTR_LO_FREQUENCY or NIRFSA_ATTR_DOWNCONVERTER_CENTER_FREQUENCY attributes, NI-RFSA rounds the LO frequency to approximately an LO step size as if the source was NIRFSA_VAL_ONBOARD_STR. This ensures that when you configure NI-RFSA and NI-RFSG with compatible settings that result in the same LO frequency, the rounding also is compatible.\n\n**Default Value:**: NIRFSA_VAL_UNSPECIFIED\n\n**Supported Devices**: PXIe-5840/5841/5842\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSA_VAL_DISABLED', diff --git a/src/nirfsa/metadata/enums.py b/src/nirfsa/metadata/enums.py index cebe3d6c5..e677306ce 100644 --- a/src/nirfsa/metadata/enums.py +++ b/src/nirfsa/metadata/enums.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# This file is generated from NI-RFSA API metadata version 26.5.0d9999 +# This file is generated from NI-RFSA API metadata version 27.0.0d9999 enums = { 'AcquisitionType': { 'codegen_method': 'public', @@ -39,6 +39,25 @@ } ] }, + 'AdvanceTriggerDigitalEdgeEdge': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'The trigger asserts on the rising edge of the signal.' + }, + 'name': 'NIRFSA_VAL_RISING_EDGE', + 'value': 900 + }, + { + 'documentation': { + 'description': 'The trigger asserts on the falling edge of the signal.' + }, + 'name': 'NIRFSA_VAL_FALLING_EDGE', + 'value': 901 + } + ] + }, 'AdvanceTriggerType': { 'codegen_method': 'public', 'values': [ @@ -65,25 +84,6 @@ } ] }, - 'AdvanceTriggerDigitalEdgeEdge': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'The trigger asserts on the rising edge of the signal.' - }, - 'name': 'NIRFSA_VAL_RISING_EDGE', - 'value': 900 - }, - { - 'documentation': { - 'description': 'The trigger asserts on the falling edge of the signal.' - }, - 'name': 'NIRFSA_VAL_FALLING_EDGE', - 'value': 901 - } - ] - }, 'AllowOutOfSpecificationUserSettings': { 'codegen_method': 'public', 'values': [ @@ -360,14 +360,15 @@ 'documentation': { 'description': 'The Reference Clock is not exported. This value is not valid for the PXIe-5644/5645/5646.' }, - 'name': 'NIRFSA_VAL_NONE', + 'name': 'NIRFSA_VAL_NONE_STR', 'value': 'None' }, { 'documentation': { 'description': 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' }, - 'name': 'NIRFSA_VAL_CLK_OUT', + 'name': 'NIRFSA_VAL_CLK_OUT_STR', + 'python_name': 'CLK_OUT', 'value': 'ClkOut' } ] @@ -379,35 +380,40 @@ 'documentation': { 'description': 'The digitizer uses its onboard clock as the Sample Clock timebase.' }, - 'name': 'NIRFSA_VAL_ONBOARD_CLOCK', + 'name': 'NIRFSA_VAL_ONBOARD_CLOCK_STR', + 'python_name': 'ONBOARD_CLOCK', 'value': 'OnboardClock' }, { 'documentation': { 'description': 'The digitizer uses the signal present on the CLK IN connector as the Sample Clock timebase.' }, - 'name': 'NIRFSA_VAL_CLK_IN', + 'name': 'NIRFSA_VAL_CLK_IN_STR', + 'python_name': 'CLK_IN', 'value': 'ClkIn' }, { 'documentation': { 'description': 'The digitizer uses the signal generated on the 100 MHz REF OUT terminal on the PXIe-5653 as the Sample Clock timebase. This value is supported only for the PXIe-5665.' }, - 'name': 'NIRFSA_VAL_LO_REF_CLK', + 'name': 'NIRFSA_VAL_LO_REF_CLK_STR', + 'python_name': 'LO_REF_CLK', 'value': 'LORefClk' }, { 'documentation': { 'description': 'The digitizer uses the signal present at the PXI star trigger line as the Sample Clock timebase. This value is not supported for the PXIe-5668.' }, - 'name': 'NIRFSA_VAL_PXI_STAR', + 'name': 'NIRFSA_VAL_PXI_STAR_STR', + 'python_name': 'PXI_STAR', 'value': 'PXI_STAR' }, { 'documentation': { 'description': 'The digitizer uses the signal present on the LO2 OUT connector on the downconverter as the Sample Clock timebase. This value is supported only for the PXIe-5668.' }, - 'name': 'NIRFSA_VAL_DOWNCONVERTER_LO2_OUT', + 'name': 'NIRFSA_VAL_DOWNCONVERTER_LO2_OUT_STR', + 'python_name': 'DOWNCONVERTER_LO2_OUT', 'value': 'DownconverterLO2Out' } ] @@ -483,8 +489,9 @@ } ] }, - 'DownconverterPreselectorEnabled': { + 'EnablePreselector': { 'codegen_method': 'public', + 'python_name': 'DownconverterPreselectorEnabled', 'values': [ { 'documentation': { @@ -542,32 +549,6 @@ } ] }, - 'RfOutLoExport': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'The LO signal is not exported from the RF OUT LO OUT terminal.' - }, - 'name': 'NIRFSA_VAL_DISABLED', - 'value': 1900 - }, - { - 'documentation': { - 'description': 'The LO signal is exported from the RF OUT LO OUT terminal.' - }, - 'name': 'NIRFSA_VAL_ENABLED', - 'value': 1901 - }, - { - 'documentation': { - 'description': 'The LO signal may or may not be exported to the RF OUT LO OUT terminal, because NI-RFSG may be controlling it.' - }, - 'name': 'NIRFSA_VAL_UNSPECIFIED', - 'value': 1902 - } - ] - }, 'ExportOutputTerminal': { 'codegen_method': 'public', 'values': [ @@ -575,168 +556,192 @@ 'documentation': { 'description': 'The signal is not exported.' }, - 'name': 'NIRFSA_VAL_DO_NOT_EXPORT', + 'name': 'NIRFSA_VAL_DO_NOT_EXPORT_STR', + 'python_name': 'DO_NOT_EXPORT', 'value': '' }, { 'documentation': { 'description': 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' }, - 'name': 'NIRFSA_VAL_CLK_OUT', + 'name': 'NIRFSA_VAL_CLK_OUT_STR', + 'python_name': 'CLK_OUT', 'value': 'ClkOut' }, { 'documentation': { 'description': 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' }, - 'name': 'NIRFSA_VAL_REF_OUT', + 'name': 'NIRFSA_VAL_REF_OUT_STR', + 'python_name': 'REF_OUT', 'value': 'RefOut' }, { 'documentation': { 'description': 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' }, - 'name': 'NIRFSA_VAL_REF_OUT2', + 'name': 'NIRFSA_VAL_REF_OUT2_STR', + 'python_name': 'REF_OUT2', 'value': 'RefOut2' }, { 'documentation': { 'description': 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' }, - 'name': 'NIRFSA_VAL_PFI0', + 'name': 'NIRFSA_VAL_PFI0_STR', + 'python_name': 'PFI0', 'value': 'PFI0' }, { 'documentation': { 'description': 'The trigger is received on PFI 1.' }, - 'name': 'NIRFSA_VAL_PFI1', + 'name': 'NIRFSA_VAL_PFI1_STR', + 'python_name': 'PFI1', 'value': 'PFI1' }, { 'documentation': { 'description': 'The trigger is received on PXI trigger line 0.' }, - 'name': 'NIRFSA_VAL_PXI_TRIG0', + 'name': 'NIRFSA_VAL_PXI_TRIG0_STR', + 'python_name': 'PXI_TRIG0', 'value': 'PXI_Trig0' }, { 'documentation': { 'description': 'The trigger is received on PXI trigger line 1.' }, - 'name': 'NIRFSA_VAL_PXI_TRIG1', + 'name': 'NIRFSA_VAL_PXI_TRIG1_STR', + 'python_name': 'PXI_TRIG1', 'value': 'PXI_Trig1' }, { 'documentation': { 'description': 'The trigger is received on PXI trigger line 2.' }, - 'name': 'NIRFSA_VAL_PXI_TRIG2', + 'name': 'NIRFSA_VAL_PXI_TRIG2_STR', + 'python_name': 'PXI_TRIG2', 'value': 'PXI_Trig2' }, { 'documentation': { 'description': 'The trigger is received on PXI trigger line 3.' }, - 'name': 'NIRFSA_VAL_PXI_TRIG3', + 'name': 'NIRFSA_VAL_PXI_TRIG3_STR', + 'python_name': 'PXI_TRIG3', 'value': 'PXI_Trig3' }, { 'documentation': { 'description': 'The trigger is received on PXI trigger line 4.' }, - 'name': 'NIRFSA_VAL_PXI_TRIG4', + 'name': 'NIRFSA_VAL_PXI_TRIG4_STR', + 'python_name': 'PXI_TRIG4', 'value': 'PXI_Trig4' }, { 'documentation': { 'description': 'The trigger is received on PXI trigger line 5.' }, - 'name': 'NIRFSA_VAL_PXI_TRIG5', + 'name': 'NIRFSA_VAL_PXI_TRIG5_STR', + 'python_name': 'PXI_TRIG5', 'value': 'PXI_Trig5' }, { 'documentation': { 'description': 'The trigger is received on PXI trigger line 6.' }, - 'name': 'NIRFSA_VAL_PXI_TRIG6', + 'name': 'NIRFSA_VAL_PXI_TRIG6_STR', + 'python_name': 'PXI_TRIG6', 'value': 'PXI_Trig6' }, { 'documentation': { 'description': 'The trigger is received on PXI trigger line 7.' }, - 'name': 'NIRFSA_VAL_PXI_TRIG7', + 'name': 'NIRFSA_VAL_PXI_TRIG7_STR', + 'python_name': 'PXI_TRIG7', 'value': 'PXI_Trig7' }, { 'documentation': { 'description': 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' }, - 'name': 'NIRFSA_VAL_PXI_STAR', + 'name': 'NIRFSA_VAL_PXI_STAR_STR', + 'python_name': 'PXI_STAR', 'value': 'PXI_STAR' }, { 'documentation': { 'description': 'The trigger is received on the PXIe DStar C trigger line. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841.' }, - 'name': 'NIRFSA_VAL_PXIE_DSTARC', + 'name': 'NIRFSA_VAL_PXIE_DSTARC_STR', + 'python_name': 'PXIE_DSTARC', 'value': 'PXIe_DStarC' }, { 'documentation': { 'description': 'The trigger is received on PFI0 from the front panel DIO terminal.' }, - 'name': 'NIRFSA_VAL_DIO_PFI0', + 'name': 'NIRFSA_VAL_DIO_PFI0_STR', + 'python_name': 'DIO_PFI0', 'value': 'DIO/PFI0' }, { 'documentation': { 'description': 'The trigger is received on PFI1 from the front panel DIO terminal.' }, - 'name': 'NIRFSA_VAL_DIO_PFI1', + 'name': 'NIRFSA_VAL_DIO_PFI1_STR', + 'python_name': 'DIO_PFI1', 'value': 'DIO/PFI1' }, { 'documentation': { 'description': 'The trigger is received on PFI2 from the front panel DIO terminal.' }, - 'name': 'NIRFSA_VAL_DIO_PFI2', + 'name': 'NIRFSA_VAL_DIO_PFI2_STR', + 'python_name': 'DIO_PFI2', 'value': 'DIO/PFI2' }, { 'documentation': { 'description': 'The trigger is received on PFI3 from the front panel DIO terminal.' }, - 'name': 'NIRFSA_VAL_DIO_PFI3', + 'name': 'NIRFSA_VAL_DIO_PFI3_STR', + 'python_name': 'DIO_PFI3', 'value': 'DIO/PFI3' }, { 'documentation': { 'description': 'The trigger is received on PFI4 from the front panel DIO terminal.' }, - 'name': 'NIRFSA_VAL_DIO_PFI4', + 'name': 'NIRFSA_VAL_DIO_PFI4_STR', + 'python_name': 'DIO_PFI4', 'value': 'DIO/PFI4' }, { 'documentation': { 'description': 'The trigger is received on PFI5 from the front panel DIO terminal.' }, - 'name': 'NIRFSA_VAL_DIO_PFI5', + 'name': 'NIRFSA_VAL_DIO_PFI5_STR', + 'python_name': 'DIO_PFI5', 'value': 'DIO/PFI5' }, { 'documentation': { 'description': 'The trigger is received on PFI6 from the front panel DIO terminal.' }, - 'name': 'NIRFSA_VAL_DIO_PFI6', + 'name': 'NIRFSA_VAL_DIO_PFI6_STR', + 'python_name': 'DIO_PFI6', 'value': 'DIO/PFI6' }, { 'documentation': { 'description': 'The trigger is received on PFI7 from the front panel DIO terminal.' }, - 'name': 'NIRFSA_VAL_DIO_PFI7', + 'name': 'NIRFSA_VAL_DIO_PFI7_STR', + 'python_name': 'DIO_PFI7', 'value': 'DIO/PFI7' } ] @@ -934,38 +939,58 @@ } ] }, - 'InputIsolationEnabled': { + 'IQInPortTerminalConfiguration': { 'codegen_method': 'public', + 'python_name': 'IqInPortTerminalConfiguration', 'values': [ { 'documentation': { - 'description': 'Disables input isolation.' + 'description': 'Sets the terminal configuration to differential.' + }, + 'name': 'NIRFSA_VAL_DIFFERENTIAL', + 'value': 2100 + }, + { + 'documentation': { + 'description': 'Sets the terminal configuration to single-ended.' + }, + 'name': 'NIRFSA_VAL_SINGLE_ENDED', + 'value': 2101 + } + ] + }, + 'IfConditioningDownConversionEnabled': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Disables IF conditioning downconversion.' }, 'name': 'NIRFSA_VAL_DISABLED', 'value': 1900 }, { 'documentation': { - 'description': 'Enables input isolation.' + 'description': 'Enables IF conditioning downconversion.' }, 'name': 'NIRFSA_VAL_ENABLED', 'value': 1901 } ] }, - 'IfConditioningDownConversionEnabled': { + 'InputIsolationEnabled': { 'codegen_method': 'public', 'values': [ { 'documentation': { - 'description': 'Disables IF conditioning downconversion.' + 'description': 'Disables input isolation.' }, 'name': 'NIRFSA_VAL_DISABLED', 'value': 1900 }, { 'documentation': { - 'description': 'Enables IF conditioning downconversion.' + 'description': 'Enables input isolation.' }, 'name': 'NIRFSA_VAL_ENABLED', 'value': 1901 @@ -1005,108 +1030,6 @@ } ] }, - 'IQInPortTerminalConfiguration': { - 'codegen_method': 'public', - 'python_name': 'IqInPortTerminalConfiguration', - 'values': [ - { - 'documentation': { - 'description': 'Sets the terminal configuration to differential.' - }, - 'name': 'NIRFSA_VAL_DIFFERENTIAL', - 'value': 2100 - }, - { - 'documentation': { - 'description': 'Sets the terminal configuration to single-ended.' - }, - 'name': 'NIRFSA_VAL_SINGLE_ENDED', - 'value': 2101 - } - ] - }, - 'SelfCalSteps': { - 'class': 'IntFlag', - 'values': [ - { - 'documentation': { - 'description': 'Omits the Image Suppression step. If you omit this step, the Residual Sideband Image performance is not adjusted.' - }, - 'name': 'NIRFSA_VAL_SELF_CAL_DIGITIZER_SELF_CAL', - 'value': 8 - }, - { - 'documentation': { - 'description': 'Omits the LO Self Cal step. If you omit this step, the power level of the LO is not adjusted.' - }, - 'name': 'NIRFSA_VAL_SELF_CAL_PRESELECTOR_ALIGNMENT', - 'value': 1 - }, - { - 'documentation': { - 'description': 'No calibration steps are omitted.' - }, - 'name': 'NIRFSA_VAL_SELF_CAL_OMIT_NONE', - 'value': 0 - }, - { - 'documentation': { - 'description': 'Omits the Power Level Accuracy step. If you omit this step, the power level accuracy of the device is not adjusted.' - }, - 'name': 'NIRFSA_VAL_SELF_CAL_GAIN_REFERENCE', - 'value': 2 - }, - { - 'documentation': { - 'description': 'Omits the Residual LO Power step. If you omit this step, the Residual LO Power performance is not adjusted.' - }, - 'name': 'NIRFSA_VAL_SELF_CAL_IF_FLATNESS', - 'value': 4 - }, - { - 'documentation': { - 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' - }, - 'name': 'NIRFSA_VAL_SELF_CAL_LO_SELF_CAL', - 'value': 10 - }, - { - 'documentation': { - 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' - }, - 'name': 'NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY', - 'value': 20 - }, - { - 'documentation': { - 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' - }, - 'name': 'NIRFSA_VAL_SELF_CAL_RESIDUAL_LO_POWER', - 'value': 40 - }, - { - 'documentation': { - 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' - }, - 'name': 'NIRFSA_VAL_SELF_CAL_IMAGE_SUPPRESSION', - 'value': 80 - }, - { - 'documentation': { - 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' - }, - 'name': 'NIRFSA_VAL_SELF_CAL_SYNTHESIZER_ALIGNMENT', - 'value': 100 - }, - { - 'documentation': { - 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' - }, - 'name': 'NIRFSA_VAL_SELF_CAL_DC_OFFSET', - 'value': 200 - } - ] - }, 'LinearInterpolationFormat': { 'codegen_method': 'public', 'values': [ @@ -1283,39 +1206,36 @@ 'LoSource': { 'codegen_method': 'public', 'values': [ - { - 'documentation': { - 'description': 'Specifies that no LO source is required to downconvert the RF input signal.' - }, - 'name': 'NIRFSA_VAL_NONE', - 'value': 'None' - }, { 'documentation': { 'description': 'Specifies that the onboard synthesizer is used to generate the LO signal that downconverts the RF input signal.**PXIe-5831/5832** This configuration uses the onboard LO of the PXIe-3622, using the LO2 stage.**PXIe-5831/5832 with PXIe-5653** This configuration uses the onboard LO of the PXIe-5653 when associated with the PXIe-3622.**PXIe-5841 with PXIe-5655** This configuration uses the onboard LO of the PXIe-5655.' }, - 'name': 'NIRFSA_VAL_ONBOARD', + 'name': 'NIRFSA_VAL_ONBOARD_STR', + 'python_name': 'ONBOARD', 'value': 'Onboard' }, { 'documentation': { 'description': 'Specifies that the LO source used to downconvert the RF input signal is connected to the LO IN connector on the front panel.' }, - 'name': 'NIRFSA_VAL_LO_IN', + 'name': 'NIRFSA_VAL_LO_IN_STR', + 'python_name': 'LO_IN', 'value': 'LO_In' }, { 'documentation': { 'description': 'Uses the PXIe-5831/5840 internal LO as the LO source. This value is valid on only the PXIe-5831 with PXIe-5653 (LO1 stage only) or PXIe-5832 with PCIe-5653 (LO1 stage only).' }, - 'name': 'NIRFSA_VAL_LO_SOURCE_SECONDARY', + 'name': 'NIRFSA_VAL_LO_SOURCE_SECONDARY_STR', + 'python_name': 'LO_SOURCE_SECONDARY', 'value': 'Secondary' }, { 'documentation': { 'description': 'Uses the same internal LO during NI-RFSA and NI-RFSG sessions. NI-RFSA selects an internal synthesizer and the synthesizer signal is switched to both the RF Out and RF In mixers. This value is valid on only the PXIe-5830/5831/5832/5841 with PXIe-5655.' }, - 'name': 'NIRFSA_VAL_LO_SOURCE_SG_SA_SHARED', + 'name': 'NIRFSA_VAL_LO_SOURCE_SG_SA_SHARED_STR', + 'python_name': 'LO_SOURCE_SG_SA_SHARED', 'value': 'SG_SA_Shared' } ] @@ -1409,175 +1329,200 @@ 'documentation': { 'description': 'The signal is not exported.' }, - 'name': 'NIRFSA_VAL_DO_NOT_EXPORT', + 'name': 'NIRFSA_VAL_DO_NOT_EXPORT_STR', + 'python_name': 'DO_NOT_EXPORT', 'value': '' }, { 'documentation': { 'description': 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' }, - 'name': 'NIRFSA_VAL_CLK_OUT', + 'name': 'NIRFSA_VAL_CLK_OUT_STR', + 'python_name': 'CLK_OUT', 'value': 'ClkOut' }, { 'documentation': { 'description': 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' }, - 'name': 'NIRFSA_VAL_REF_OUT', + 'name': 'NIRFSA_VAL_REF_OUT_STR', + 'python_name': 'REF_OUT', 'value': 'RefOut' }, { 'documentation': { 'description': 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' }, - 'name': 'NIRFSA_VAL_REF_OUT2', + 'name': 'NIRFSA_VAL_REF_OUT2_STR', + 'python_name': 'REF_OUT2', 'value': 'RefOut2' }, { 'documentation': { 'description': 'The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0.' }, - 'name': 'NIRFSA_VAL_PFI0', + 'name': 'NIRFSA_VAL_PFI0_STR', + 'python_name': 'PFI0', 'value': 'PFI0' }, { 'documentation': { 'description': 'The trigger is received on PFI 1.' }, - 'name': 'NIRFSA_VAL_PFI1', + 'name': 'NIRFSA_VAL_PFI1_STR', + 'python_name': 'PFI1', 'value': 'PFI1' }, { 'documentation': { 'description': 'The trigger is received on PXI trigger line 0.' }, - 'name': 'NIRFSA_VAL_PXI_TRIG0', + 'name': 'NIRFSA_VAL_PXI_TRIG0_STR', + 'python_name': 'PXI_TRIG0', 'value': 'PXI_Trig0' }, { 'documentation': { 'description': 'The trigger is received on PXI trigger line 1.' }, - 'name': 'NIRFSA_VAL_PXI_TRIG1', + 'name': 'NIRFSA_VAL_PXI_TRIG1_STR', + 'python_name': 'PXI_TRIG1', 'value': 'PXI_Trig1' }, { 'documentation': { 'description': 'The trigger is received on PXI trigger line 2.' }, - 'name': 'NIRFSA_VAL_PXI_TRIG2', + 'name': 'NIRFSA_VAL_PXI_TRIG2_STR', + 'python_name': 'PXI_TRIG2', 'value': 'PXI_Trig2' }, { 'documentation': { 'description': 'The trigger is received on PXI trigger line 3.' }, - 'name': 'NIRFSA_VAL_PXI_TRIG3', + 'name': 'NIRFSA_VAL_PXI_TRIG3_STR', + 'python_name': 'PXI_TRIG3', 'value': 'PXI_Trig3' }, { 'documentation': { 'description': 'The trigger is received on PXI trigger line 4.' }, - 'name': 'NIRFSA_VAL_PXI_TRIG4', + 'name': 'NIRFSA_VAL_PXI_TRIG4_STR', + 'python_name': 'PXI_TRIG4', 'value': 'PXI_Trig4' }, { 'documentation': { 'description': 'The trigger is received on PXI trigger line 5.' }, - 'name': 'NIRFSA_VAL_PXI_TRIG5', + 'name': 'NIRFSA_VAL_PXI_TRIG5_STR', + 'python_name': 'PXI_TRIG5', 'value': 'PXI_Trig5' }, { 'documentation': { 'description': 'The trigger is received on PXI trigger line 6.' }, - 'name': 'NIRFSA_VAL_PXI_TRIG6', + 'name': 'NIRFSA_VAL_PXI_TRIG6_STR', + 'python_name': 'PXI_TRIG6', 'value': 'PXI_Trig6' }, { 'documentation': { 'description': 'The trigger is received on PXI trigger line 7.' }, - 'name': 'NIRFSA_VAL_PXI_TRIG7', + 'name': 'NIRFSA_VAL_PXI_TRIG7_STR', + 'python_name': 'PXI_TRIG7', 'value': 'PXI_Trig7' }, { 'documentation': { 'description': 'The trigger is received on the PXI star trigger line. This value is not valid for the PXIe-5644/5645/5646.' }, - 'name': 'NIRFSA_VAL_PXI_STAR', + 'name': 'NIRFSA_VAL_PXI_STAR_STR', + 'python_name': 'PXI_STAR', 'value': 'PXI_STAR' }, { 'documentation': { 'description': '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.' }, - 'name': 'NIRFSA_VAL_PXIE_DSTARB', + 'name': 'NIRFSA_VAL_PXIE_DSTARB_STR', + 'python_name': 'PXIE_DSTARB', 'value': 'PXIe_DStarB' }, { 'documentation': { 'description': 'The trigger is received on PFI0 from the front panel DIO terminal.' }, - 'name': 'NIRFSA_VAL_DIO_PFI0', + 'name': 'NIRFSA_VAL_DIO_PFI0_STR', + 'python_name': 'DIO_PFI0', 'value': 'DIO/PFI0' }, { 'documentation': { 'description': 'The trigger is received on PFI1 from the front panel DIO terminal.' }, - 'name': 'NIRFSA_VAL_DIO_PFI1', + 'name': 'NIRFSA_VAL_DIO_PFI1_STR', + 'python_name': 'DIO_PFI1', 'value': 'DIO/PFI1' }, { 'documentation': { 'description': 'The trigger is received on PFI2 from the front panel DIO terminal.' }, - 'name': 'NIRFSA_VAL_DIO_PFI2', + 'name': 'NIRFSA_VAL_DIO_PFI2_STR', + 'python_name': 'DIO_PFI2', 'value': 'DIO/PFI2' }, { 'documentation': { 'description': 'The trigger is received on PFI3 from the front panel DIO terminal.' }, - 'name': 'NIRFSA_VAL_DIO_PFI3', + 'name': 'NIRFSA_VAL_DIO_PFI3_STR', + 'python_name': 'DIO_PFI3', 'value': 'DIO/PFI3' }, { 'documentation': { 'description': 'The trigger is received on PFI4 from the front panel DIO terminal.' }, - 'name': 'NIRFSA_VAL_DIO_PFI4', + 'name': 'NIRFSA_VAL_DIO_PFI4_STR', + 'python_name': 'DIO_PFI4', 'value': 'DIO/PFI4' }, { 'documentation': { 'description': 'The trigger is received on PFI5 from the front panel DIO terminal.' }, - 'name': 'NIRFSA_VAL_DIO_PFI5', + 'name': 'NIRFSA_VAL_DIO_PFI5_STR', + 'python_name': 'DIO_PFI5', 'value': 'DIO/PFI5' }, { 'documentation': { 'description': 'The trigger is received on PFI6 from the front panel DIO terminal.' }, - 'name': 'NIRFSA_VAL_DIO_PFI6', + 'name': 'NIRFSA_VAL_DIO_PFI6_STR', + 'python_name': 'DIO_PFI6', 'value': 'DIO/PFI6' }, { 'documentation': { 'description': 'The trigger is received on PFI7 from the front panel DIO terminal.' }, - 'name': 'NIRFSA_VAL_DIO_PFI7', + 'name': 'NIRFSA_VAL_DIO_PFI7_STR', + 'python_name': 'DIO_PFI7', 'value': 'DIO/PFI7' }, { 'documentation': { 'description': 'The trigger is received from the Timer Event. This value is valid on only the PXIe-5820/5830/5831/5832/5840/5841, and for digital edge Advance Triggers on the PXIe-5663E/5665.' }, - 'name': 'NIRFSA_VAL_TIMER_EVENT', + 'name': 'NIRFSA_VAL_TIMER_EVENT_STR', + 'python_name': 'TIMER_EVENT', 'value': 'TimerEvent' } ] @@ -1655,44 +1600,27 @@ 'documentation': { 'description': 'The device does not drive the PXI 10 MHz backplane Reference Clock.' }, - 'name': 'NIRFSA_VAL_NONE', + 'name': 'NIRFSA_VAL_NONE_STR', 'value': 'None' }, { 'documentation': { 'description': 'The device drives the PXI 10 MHz backplane Reference Clock with the PXI-5600 onboard clock. You must connect the 10 MHz OUT connector to the PXI 10 MHz I/O connector on the PXI-5600 front panel to use this option.' }, - 'name': 'NIRFSA_VAL_ONBOARD_CLOCK', + 'name': 'NIRFSA_VAL_ONBOARD_CLOCK_STR', + 'python_name': 'ONBOARD_CLOCK', 'value': 'OnboardClock' }, { 'documentation': { 'description': 'The device drives the PXI 10 MHz backplane Reference Clock with the reference source attached to the PXI-5600 FREQ REF IN connector. You must connect the 10 MHz OUT connector to the PXI 10 MHz I/O connector on the PXI-5600 front panel to use this option.' }, - 'name': 'NIRFSA_VAL_REF_IN', + 'name': 'NIRFSA_VAL_REF_IN_STR', + 'python_name': 'REF_IN', 'value': 'RefIn' } ] }, - 'ReferenceTriggerOspDelayEnabled': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'Disables OSP delay for the Reference Trigger.' - }, - 'name': 'NIRFSA_VAL_DISABLED', - 'value': 1900 - }, - { - 'documentation': { - 'description': 'Enables OSP delay for the Reference Trigger.' - }, - 'name': 'NIRFSA_VAL_ENABLED', - 'value': 1901 - } - ] - }, 'ReferenceClockExportedRate': { 'codegen_method': 'public', 'values': [ @@ -1729,28 +1657,31 @@ 'documentation': { 'description': 'The Reference Clock is not exported. This value is not valid for the PXIe-5644/5645/5646.' }, - 'name': 'NIRFSA_VAL_NONE', + 'name': 'NIRFSA_VAL_NONE_STR', 'value': 'None' }, { 'documentation': { 'description': 'Export the clock on the REF IN/OUT terminal on the PXI/PXIe-5652, the REF OUT terminals on the PXIe-5653, or the REF OUT terminal on the PXIe-5644/5645/5646, PXIe-5694, or PXIe-5820/5830/5831/5832/5840/5841.' }, - 'name': 'NIRFSA_VAL_REF_OUT', + 'name': 'NIRFSA_VAL_REF_OUT_STR', + 'python_name': 'REF_OUT', 'value': 'RefOut' }, { 'documentation': { 'description': 'Export the clock on the REF OUT2 terminal on the PXIe-5652. This value is valid only for the PXIe-5663E.' }, - 'name': 'NIRFSA_VAL_REF_OUT2', + 'name': 'NIRFSA_VAL_REF_OUT2_STR', + 'python_name': 'REF_OUT2', 'value': 'RefOut2' }, { 'documentation': { 'description': 'Export the clock on the CLK OUT terminal on the IF digitizer. This value is not valid for the PXIe-5644/5645/5646 or PXIe-5820/5830/5831/5832/5840/5841.' }, - 'name': 'NIRFSA_VAL_CLK_OUT', + 'name': 'NIRFSA_VAL_CLK_OUT_STR', + 'python_name': 'CLK_OUT', 'value': 'ClkOut' }, { @@ -1769,49 +1700,55 @@ 'documentation': { 'description': 'No Reference Clock is required for the current device configuration. This value is valid only for the PXIe-5694 or the PXIe-5668.' }, - 'name': 'NIRFSA_VAL_NONE', + 'name': 'NIRFSA_VAL_NONE_STR', 'value': 'None' }, { 'documentation': { 'description': '**PXI-5661 **NI-RFSA locks the NI-RFSA device to the PXI-5600 RF downconverter onboard clock.**PXIe-5663/5663E **NI-RFSA locks the PXIe-5663/5663E to the PXI/PXIe-5652 LO source onboard clock. Connect the REF OUT2 connector (if it exists) on the PXI/PXIe-5652 to the CLK IN terminal on the PXIe-5622. On versions of the PXIe-5663/5663E that lack a REF OUT2 connector on the PXI/PXIe-5652, connect the REF IN/OUT connector on the PXI/PXIe-5652 to the CLK IN terminal on the PXI5622.**PXIe-5665 **NI-RFSA locks the PXIe-5665 to the PXIe-5653 LO source onboard clock. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN terminal on the PXIe-5622.**PXIe-5667 **NI-RFSA locks the PXIe-5667 to the PXIe-5653 LO source onboard clock. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN terminal on the PXIe-5622, and connect the 10 MHZ REF OUT terminal on the PXIe-5653 to the REF/LO IN connector on the PXIe-5694.**PXIe-5668 **Lock the PXIe-5668 to the PXIe-5653 LO SOURCE onboard clock. Connect the LO2 OUT connector on the PXIe-5606 to the CLK IN connector on the PXIe-5624.**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-5644/5645/5646, PXIe-5820/5840/5841 **Lock the NI-RFSA device to its onboard clock.**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 User Manual for the instrument.**PXIe-5860 **Lock to the PXIe-5860 onboard clock.' }, - 'name': 'NIRFSA_VAL_ONBOARD_CLOCK', + 'name': 'NIRFSA_VAL_ONBOARD_CLOCK_STR', + 'python_name': 'ONBOARD_CLOCK', 'value': 'OnboardClock' }, { 'documentation': { 'description': '**PXI-5661 **NI-RFSA locks the NI-RFSA device to the signal at the external FREQ REF IN connector on the PXI-5600**PXIe-5663/5663E **Connect the external signal to the PXI/PXIe-5652 REF IN/OUT connector. Connect the REF OUT2 connector (if it exists) on the PXI/PXIe-5652 to the CLK IN terminal on the PXIe-5622. On versions of the PXIe-5663/5663E that lack a REF OUT2 connector on the PXI/PXIe-5652, this configuration can only be used in external digitizer mode.**PXIe-5665 **Connect the external signal to the PXIe-5653 REF IN connector. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN terminal on the PXIe-5622. If your external clock signal frequency is set to a frequency other than 10 MHz, set the NIRFSA_ATTR_REF_CLOCK_RATE attribute according to the frequency of your external clock signal.**PXIe-5667 **Connect the external signal to the PXIe-5653 REF IN connector. Connect the 100 MHz REF OUT terminal on the PXIe-5653 to the CLK IN terminal on the PXIe-5622, and connect the 10 MHZ REF OUT terminal on the PXIe-5653 to the REF/LO IN connector on the PXIe-5694. If your external clock signal frequency is set to a frequency other than 10 MHz, set the NIRFSA_ATTR_REF_CLOCK_RATE attribute according to the frequency of your external clock signal.**PXIe-5668 **Connect the external signal to the PXIe-5653 REF IN connector. Connect the LO2 OUT on the PXIe-5606 to the CLK IN connector on the PXIe-5622. If your external clock signal frequency is set to a frequency other than 10 MHz, set the **clock rate** parameter according to the frequency of your external clock signal.**PXIe-5694 **Connect the Reference Clock signal to the REF/LO IN connector on the PXIe-5694 front panel.**PXIe-5644/5645/5646, PXIe-5820/5840/5841 **Lock the NI-RFSA device to the signal at the external REF IN connector.**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, 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 REF OUT connector on the PXIe-5655 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 User Manual for the instrument. PXIe-5860 Lock to the signal at the REF IN connector on the PXIe-5860.' }, - 'name': 'NIRFSA_VAL_REF_IN', + 'name': 'NIRFSA_VAL_REF_IN_STR', + 'python_name': 'REF_IN', 'value': 'RefIn' }, { 'documentation': { 'description': '**PXI-5661 **NI-RFSA locks the NI-RFSA device to the PXI backplane clock using the PXI-5600. You must connect the PXI 10 MHz connector to the REF IN connector on the PXI-5600 front panel to use this option. **PXIe-5668 **Lock the PXIe-5653 to the PXI backplane clock. Connect the PXIe-5606 LO2 OUT to the LO2 IN connector on the PXIe-5624.**PXIe-5644/5645/5646, PXIe-5663/5663E/5665/5667, PXIe-5694, PXIe-5820/5830/5831/5831/5832 with PXIe-5653/5840/5840 with PXIe-5653/5841/5841 with PXIe-5655/5842/5860 **Lock the device to the PXI backplane clock.' }, - 'name': 'NIRFSA_VAL_PXI_CLK', + 'name': 'NIRFSA_VAL_PXI_CLK_STR', + 'python_name': 'PXI_CLK', 'value': 'PXI_Clk' }, { 'documentation': { 'description': '**PXI-5661 **This configuration does not apply to the PXI-5661.**PXIe-5663/5663E **NI-RFSA locks the PXIe-5663/5663E to an external 10 MHz signal. Connect the external signal to the CLK IN connector on the PXIe-5622, and connect the PXIe-5622 CLK OUT connector to the FREQ REF IN connector on the PXI/PXIe-5652.**PXIe-5665 **NI-RFSA locks the PXIe-5665 to an external 100 MHz signal. Connect the external signal to the CLK IN connector on the PXIe-5622, and connect the PXIe-5622 CLK OUT connector to the REF IN connector on the PXIe-5653. Set the NIRFSA_ATTR_REF_CLOCK_RATE attribute to 100 MHz.**PXIe-5667 **NI-RFSA locks the PXIe-5667 to an external 100 MHz signal. Connect the external signal to the CLK IN connector on the PXIe-5622, and connect the PXIe-5622 CLK OUT connector to the REF IN connector on the PXIe-5653. Connect the 10 MHZ REF OUT terminal on the PXIe-5653 to the REF/LO IN connector on the PXIe-5694. Set the NIRFSA_ATTR_REF_CLOCK_RATE attribute to 100 MHz.**PXIe-5668 **Lock the PXIe-5668 to an external 100 MHz signal. Connect the external signal to the CLK IN connector on the PXIe-5624, and connect the PXIe-5624 CLK OUT connector to the REF IN connector on the PXIe-5653. Set the **clock rate** parameter to 100 MHz.**PXIe-5644/5645/5646, PXIe-5820/5830/5831/5831/5832 with PXIe-5653/5840/5840 with PXIe-5653/5841/5841 with PXIe-5655/5842/5860 **This configuration does not apply.' }, - 'name': 'NIRFSA_VAL_CLK_IN', + 'name': 'NIRFSA_VAL_CLK_IN_STR', + 'python_name': 'CLK_IN', 'value': 'ClkIn' }, { 'documentation': { 'description': '**PXIe-5831/5832 with PXIe-5653 **NI-RFSA 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.**PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5644/5645/5646, PXIe-5820/5840/5841/5841 with PXIe-5655 /5842/5860**This configuration does not apply.' }, - 'name': 'NIRFSA_VAL_PXI_CLK_MASTER', + 'name': 'NIRFSA_VAL_PXI_CLK_MASTER_STR', + 'python_name': 'PXI_CLK_MASTER', 'value': 'PXI_ClkMaster' }, { 'documentation': { 'description': '**PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5644/5645/5646, PXIe-5820/5830/5831/5831/5832 with PXIe-5653/5840/5841/5841 with PXIe-5655 **This configuration does not apply.' }, - 'name': 'NIRFSA_VAL_REF_IN_2', + 'name': 'NIRFSA_VAL_REF_IN_2_STR', + 'python_name': 'REF_IN_2', 'value': 'RefIn2' } ] @@ -1874,6 +1811,25 @@ } ] }, + 'ReferenceTriggerOspDelayEnabled': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Disables OSP delay for the Reference Trigger.' + }, + 'name': 'NIRFSA_VAL_DISABLED', + 'value': 1900 + }, + { + 'documentation': { + 'description': 'Enables OSP delay for the Reference Trigger.' + }, + 'name': 'NIRFSA_VAL_ENABLED', + 'value': 1901 + } + ] + }, 'ReferenceTriggerType': { 'codegen_method': 'public', 'values': [ @@ -1915,8 +1871,8 @@ ] }, 'ResetWithOptionsStepsToOmit': { - 'codegen_method': 'public', 'class': 'IntFlag', + 'codegen_method': 'public', 'values': [ { 'documentation': { @@ -1962,6 +1918,32 @@ } ] }, + 'RfOutLoExport': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'The LO signal is not exported from the RF OUT LO OUT terminal.' + }, + 'name': 'NIRFSA_VAL_DISABLED', + 'value': 1900 + }, + { + 'documentation': { + 'description': 'The LO signal is exported from the RF OUT LO OUT terminal.' + }, + 'name': 'NIRFSA_VAL_ENABLED', + 'value': 1901 + }, + { + 'documentation': { + 'description': 'The LO signal may or may not be exported to the RF OUT LO OUT terminal, because NI-RFSG may be controlling it.' + }, + 'name': 'NIRFSA_VAL_UNSPECIFIED', + 'value': 1902 + } + ] + }, 'RfPathSelection': { 'codegen_method': 'public', 'values': [ @@ -1999,75 +1981,82 @@ } ] }, - 'SelfCalibrationStep': { - 'codegen_method': 'public', + 'SelfCalSteps': { + 'class': 'IntFlag', 'values': [ { 'documentation': { - 'description': 'Calls for preselector alignment. ' + 'description': 'Omits the Image Suppression step. If you omit this step, the Residual Sideband Image performance is not adjusted.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_DIGITIZER_SELF_CAL', + 'value': 8 + }, + { + 'documentation': { + 'description': 'Omits the LO Self Cal step. If you omit this step, the power level of the LO is not adjusted.' }, 'name': 'NIRFSA_VAL_SELF_CAL_PRESELECTOR_ALIGNMENT', 'value': 1 }, { 'documentation': { - 'description': 'Measures the changes in gain since the last external calibration was run.' + 'description': 'No calibration steps are omitted.' }, - 'name': 'NIRFSA_VAL_SELF_CAL_GAIN_REFERENCE', - 'value': 2 + 'name': 'NIRFSA_VAL_SELF_CAL_OMIT_NONE', + 'value': 0 }, { 'documentation': { - 'description': 'Measures the IF response of the entire system for each of the supported IF filters' + 'description': 'Omits the Power Level Accuracy step. If you omit this step, the power level accuracy of the device is not adjusted.' }, - 'name': 'NIRFSA_VAL_SELF_CAL_IF_FLATNESS', - 'value': 4 + 'name': 'NIRFSA_VAL_SELF_CAL_GAIN_REFERENCE', + 'value': 2 }, { 'documentation': { - 'description': 'Calls for digitizer self-calibration, if the digitizer is associated with the RF downconverter.' + 'description': 'Omits the Residual LO Power step. If you omit this step, the Residual LO Power performance is not adjusted.' }, - 'name': 'NIRFSA_VAL_SELF_CAL_DIGITIZER_SELF_CAL', - 'value': 8 + 'name': 'NIRFSA_VAL_SELF_CAL_IF_FLATNESS', + 'value': 4 }, { 'documentation': { - 'description': 'Calls for LO self-calibration, if the LO source module is associated with the RF downconverter.' + 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' }, 'name': 'NIRFSA_VAL_SELF_CAL_LO_SELF_CAL', 'value': 16 }, { 'documentation': { - 'description': 'Selects the Amplitude Accuracy self-calibration step.' + 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' }, 'name': 'NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY', 'value': 32 }, { 'documentation': { - 'description': 'Selects the Residual LO Power self-calibration step.' + 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' }, 'name': 'NIRFSA_VAL_SELF_CAL_RESIDUAL_LO_POWER', 'value': 64 }, { 'documentation': { - 'description': 'Selects the Image Suppression self-calibration step.' + 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' }, 'name': 'NIRFSA_VAL_SELF_CAL_IMAGE_SUPPRESSION', 'value': 128 }, { 'documentation': { - 'description': 'Selects the Synthesizer Alignment self-calibration step.' + 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' }, 'name': 'NIRFSA_VAL_SELF_CAL_SYNTHESIZER_ALIGNMENT', 'value': 256 }, { 'documentation': { - 'description': 'Selects the DC Offset self-calibration step.' + 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' }, 'name': 'NIRFSA_VAL_SELF_CAL_DC_OFFSET', 'value': 512 @@ -2117,42 +2106,117 @@ 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' }, 'name': 'NIRFSA_VAL_SELF_CAL_LO_SELF_CAL', - 'value': 10 + 'value': 16 }, { 'documentation': { 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' }, 'name': 'NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY', - 'value': 20 + 'value': 32 }, { 'documentation': { 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' }, 'name': 'NIRFSA_VAL_SELF_CAL_RESIDUAL_LO_POWER', - 'value': 40 + 'value': 64 }, { 'documentation': { 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' }, 'name': 'NIRFSA_VAL_SELF_CAL_IMAGE_SUPPRESSION', - 'value': 80 + 'value': 128 }, { 'documentation': { 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' }, 'name': 'NIRFSA_VAL_SELF_CAL_SYNTHESIZER_ALIGNMENT', - 'value': 100 + 'value': 256 }, { 'documentation': { 'description': 'Omits the Voltage Controlled Oscillator (VCO) Alignment step. If you omit this step, the LO PLL is not adjusted.' }, 'name': 'NIRFSA_VAL_SELF_CAL_DC_OFFSET', - 'value': 200 + 'value': 512 + } + ] + }, + 'SelfCalibrationStep': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'Calls for preselector alignment. ' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_PRESELECTOR_ALIGNMENT', + 'value': 1 + }, + { + 'documentation': { + 'description': 'Measures the changes in gain since the last external calibration was run.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_GAIN_REFERENCE', + 'value': 2 + }, + { + 'documentation': { + 'description': 'Measures the IF response of the entire system for each of the supported IF filters' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_IF_FLATNESS', + 'value': 4 + }, + { + 'documentation': { + 'description': 'Calls for digitizer self-calibration, if the digitizer is associated with the RF downconverter.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_DIGITIZER_SELF_CAL', + 'value': 8 + }, + { + 'documentation': { + 'description': 'Calls for LO self-calibration, if the LO source module is associated with the RF downconverter.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_LO_SELF_CAL', + 'value': 16 + }, + { + 'documentation': { + 'description': 'Selects the Amplitude Accuracy self-calibration step.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY', + 'value': 32 + }, + { + 'documentation': { + 'description': 'Selects the Residual LO Power self-calibration step.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_RESIDUAL_LO_POWER', + 'value': 64 + }, + { + 'documentation': { + 'description': 'Selects the Image Suppression self-calibration step.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_IMAGE_SUPPRESSION', + 'value': 128 + }, + { + 'documentation': { + 'description': 'Selects the Synthesizer Alignment self-calibration step.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_SYNTHESIZER_ALIGNMENT', + 'value': 256 + }, + { + 'documentation': { + 'description': 'Selects the DC Offset self-calibration step.' + }, + 'name': 'NIRFSA_VAL_SELF_CAL_DC_OFFSET', + 'value': 512 } ] }, @@ -2262,6 +2326,39 @@ } ] }, + 'SoftwareTriggerType': { + 'codegen_method': 'public', + 'values': [ + { + 'documentation': { + 'description': 'NI-RFSA sends a Start software trigger.' + }, + 'name': 'NIRFSA_VAL_START_TRIGGER', + 'value': 1100 + }, + { + 'documentation': { + 'description': 'NI-RFSA sends a Reference software trigger. ' + }, + 'name': 'NIRFSA_VAL_REF_TRIGGER', + 'value': 702 + }, + { + 'documentation': { + 'description': 'NI-RFSA sends an Advance software trigger.' + }, + 'name': 'NIRFSA_VAL_ADVANCE_TRIGGER', + 'value': 1102 + }, + { + 'documentation': { + 'description': 'NI-RFSA sends an Arm Reference software trigger. This trigger is not valid for the PXIe-5668.' + }, + 'name': 'NIRFSA_VAL_ARM_REF_TRIGGER', + 'value': 1103 + } + ] + }, 'SparameterOrientation': { 'codegen_method': 'public', 'values': [ @@ -2433,14 +2530,16 @@ 'documentation': { 'description': 'Defines the resolution bandwidth (RBW) in terms of the 3 dB bandwidth of the window specified by the NIRFSA_ATTR_FFT_WINDOW_TYPE attribute.' }, - 'name': 'NIRFSA_VAL_RBW_THREE_DECIBELS', + 'name': 'NIRFSA_VAL_RBW_3DB', + 'python_name': 'RBW_THREE_DECIBELS', 'value': 300 }, { 'documentation': { 'description': 'Defines the RBW in terms of the 6 dB bandwidth of the window specified by the NIRFSA_ATTR_FFT_WINDOW_TYPE attribute.' }, - 'name': 'NIRFSA_VAL_RBW_SIX_DECIBELS', + 'name': 'NIRFSA_VAL_RBW_6DB', + 'python_name': 'RBW_SIX_DECIBELS', 'value': 301 }, { @@ -2454,7 +2553,8 @@ 'documentation': { 'description': 'Defines the RBW in terms of the equivalent noise bandwidth (ENBW) of the window specified by the NIRFSA_ATTR_FFT_WINDOW_TYPE attribute.' }, - 'name': 'NIRFSA_VAL_RBW_EQUIVALENT_NOISE_BANDWIDTH', + 'name': 'NIRFSA_VAL_RBW_ENBW', + 'python_name': 'RBW_EQUIVALENT_NOISE_BANDWIDTH', 'value': 303 } ] @@ -2549,39 +2649,6 @@ } ] }, - 'SoftwareTriggerType': { - 'codegen_method': 'public', - 'values': [ - { - 'documentation': { - 'description': 'NI-RFSA sends a Start software trigger.' - }, - 'name': 'NIRFSA_VAL_START_TRIGGER', - 'value': 1100 - }, - { - 'documentation': { - 'description': 'NI-RFSA sends a Reference software trigger. ' - }, - 'name': 'NIRFSA_VAL_REF_TRIGGER', - 'value': 702 - }, - { - 'documentation': { - 'description': 'NI-RFSA sends an Advance software trigger.' - }, - 'name': 'NIRFSA_VAL_ADVANCE_TRIGGER', - 'value': 1102 - }, - { - 'documentation': { - 'description': 'NI-RFSA sends an Arm Reference software trigger. This trigger is not valid for the PXIe-5668.' - }, - 'name': 'NIRFSA_VAL_ARM_REF_TRIGGER', - 'value': 1103 - } - ] - }, 'UserSourcePulseWidthUnits': { 'codegen_method': 'public', 'values': [ diff --git a/src/nirfsa/metadata/functions.py b/src/nirfsa/metadata/functions.py index 5d0eee1ae..198d5089d 100644 --- a/src/nirfsa/metadata/functions.py +++ b/src/nirfsa/metadata/functions.py @@ -1,10 +1,10 @@ # -*- coding: utf-8 -*- -# This file is generated from NI-RFSA API metadata version 26.5.0d9999 +# This file is generated from NI-RFSA API metadata version 27.0.0d9999 functions = { 'Abort': { 'codegen_method': 'public', 'documentation': { - 'description': 'Stops an acquisition previously started with the nirfsa_Initiate function or the nirfsa_ReadPowerSpectrumF64 function.\n\nYou can also use the nirfsa_Abort function to stop a self-calibration. Calling this function is optional, unless you want to stop an acquisition before it is complete or you are continuously acquiring data.\n\nYou can stop the following kinds of acquisitions:\n\n- Triggered spectrum acquisitions that have not yet been triggered\n- Multispan acquisitions in progress\n- Average spectrum acquisitions in progress\n- Single-record spectrum acquisitions in progress\n- Streaming in progress\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + 'description': 'Stops an acquisition previously started with the nirfsa_Initiate function or the nirfsa_ReadPowerSpectrumF64 function.\n\nYou can also use the nirfsa_Abort function to stop a self-calibration. Calling this function is optional, unless you want to stop an acquisition before it is complete or you are continuously acquiring data.\n\nYou can stop the following kinds of acquisitions:\n\n- Triggered spectrum acquisitions that have not yet been triggered\n- Multispan acquisitions in progress\n- Average spectrum acquisitions in progress\n- Single-record spectrum acquisitions in progress\n- Streaming in progress\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'is_error_handling': False, @@ -20,7 +20,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -34,8 +34,9 @@ 'ChangeExternalCalibrationPassword': { 'codegen_method': 'public', 'documentation': { - 'description': 'Changes the password that is required to initialize an external calibration session.\n\n**Supported Devices**: PXIe-5601/5603/5605/5606, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + 'description': 'Changes the password that is required to initialize an external calibration session.\n\n**Supported Devices**: PXIe-5601/5603/5605/5606, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, + 'grpc_name': 'ChangeExternalCalibrationPassword', 'included_in_proto': True, 'is_error_handling': False, 'method_templates': [ @@ -50,7 +51,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function and identifies a particular instrument session.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function and identifies a particular instrument session.' }, 'name': 'vi', 'type': 'ViSession', @@ -60,7 +61,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the old (current) external calibration password.\n\nThe maximum length of the password varies by device.', + 'description': 'Specifies the old (current) external calibration password.\n\nThe maximum length of the password varies by device.' }, 'name': 'oldPassword', 'type': 'ViConstString', @@ -70,7 +71,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the new (desired) external calibration password.\n\nThe maximum length of the password varies by device.', + 'description': 'Specifies the new (desired) external calibration password.\n\nThe maximum length of the password varies by device.' }, 'name': 'newPassword', 'type': 'ViConstString', @@ -78,13 +79,14 @@ 'use_in_python_api': True } ], + 'python_name': 'change_external_calibration_password', 'returns': 'ViStatus', 'use_session_lock': True }, 'CheckAcquisitionStatus': { 'codegen_method': 'public', 'documentation': { - 'description': 'Checks the status of the acquisition.\n\nUse this function to check for any errors that may occur during signal acquisition or to check whether the device has completed the acquisition operation.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`NI RF Vector Signal Analyzer State Diagram `_', + 'description': 'Checks the status of the acquisition.\n\nUse this function to check for any errors that may occur during signal acquisition or to check whether the device has completed the acquisition operation.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`NI RF Vector Signal Analyzer State Diagram `_' }, 'included_in_proto': True, 'is_error_handling': False, @@ -100,7 +102,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -110,7 +112,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns signal acquisition status.\n\n|Value |Description |\n|:---------|:------------------------------------|\n| VI_TRUE | Signal acquisition is complete. |\n| VI_FALSE | Signal acquisition is not complete. |', + 'description': 'Returns signal acquisition status.\n\n|Value |Description |\n|:---------|:------------------------------------|\n| VI_TRUE | Signal acquisition is complete. |\n| VI_FALSE | Signal acquisition is not complete. |' }, 'name': 'isDone', 'type': 'ViBoolean', @@ -124,7 +126,7 @@ 'ClearSelfCalibrateRange': { 'codegen_method': 'public', 'documentation': { - 'description': 'Clears the data obtained from the nirfsa_SelfCalibrateRange function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842', + 'description': 'Clears the data obtained from the nirfsa_SelfCalibrateRange function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842' }, 'included_in_proto': True, 'is_error_handling': False, @@ -140,7 +142,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -151,34 +153,10 @@ 'returns': 'ViStatus', 'use_session_lock': True }, - 'close': { - 'codegen_method': 'private', - 'documentation': { - 'description': 'Closes the session to the device.\n\nIf you close a session that has Soft Front Panel (SFP) session access enabled, any application connected to the shared device session is no longer usable. Refer to `Debugging Your Application Using SFP Session Access `_ for more information about using SFP session access.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', - }, - 'included_in_proto': True, - 'grpc_name': 'Close', - 'is_error_handling': False, - 'parameters': [ - { - 'direction': 'in', - 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', - }, - 'name': 'vi', - 'type': 'ViSession', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'python_name': '_close', - 'returns': 'ViStatus', - 'use_session_lock': False - }, 'Commit': { 'codegen_method': 'public', 'documentation': { - 'description': 'Commits settings to hardware.\n\nCalling this function is optional. Settings are automatically committed to hardware when you call the nirfsa_Initiate function, the read IQ single record complex F64 function, or the nirfsa_ReadPowerSpectrumF64 function.\n\n----\n**Note**\nThis function does not wait for settling time, unlike the nirfsa_Initiate function.\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`NI RF Vector Signal Analyzer State Diagram `_', + 'description': 'Commits settings to hardware.\n\nCalling this function is optional. Settings are automatically committed to hardware when you call the nirfsa_Initiate function, the read IQ single record complex F64 function, or the nirfsa_ReadPowerSpectrumF64 function.\n\n----\n**Note**\nThis function does not wait for settling time, unlike the nirfsa_Initiate function.\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`NI RF Vector Signal Analyzer State Diagram `_' }, 'included_in_proto': True, 'is_error_handling': False, @@ -194,7 +172,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -224,7 +202,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -303,7 +281,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -353,7 +331,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -387,7 +365,7 @@ 'ConfigureDigitalEdgeAdvanceTrigger': { 'codegen_method': 'public', 'documentation': { - 'description': 'Configures the device to wait for a digital edge Advance Trigger.\n\nThe Advance Trigger indicates where a new record begins.\n\n----\n**Note**\n This function is not supported if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function or if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_', + 'description': 'Configures the device to wait for a digital edge Advance Trigger.\n\nThe Advance Trigger indicates where a new record begins.\n\n----\n**Note**\n This function is not supported if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function or if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_' }, 'included_in_proto': True, 'is_error_handling': False, @@ -403,7 +381,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -413,7 +391,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the source of the digital edge for the Advance Trigger.\n\n| Value | Description |\n|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| NIRFSA_VAL_PFI0 (\'PFI0\') | The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0. |\n| NIRFSA_VAL_PFI1 (\'PFI1\') | The trigger is received on PFI 1. |\n| NIRFSA_VAL_PXI_TRIG0 (\'PXI_Trig0\') | The trigger is received on PXI trigger line 0. |\n| NIRFSA_VAL_PXI_TRIG1 (\'PXI_Trig1\') | The trigger is received on PXI trigger line 1. |\n| NIRFSA_VAL_PXI_TRIG2 (\'PXI_Trig2\') | The trigger is received on PXI trigger line 2. |\n| NIRFSA_VAL_PXI_TRIG3 (\'PXI_Trig3\') | The trigger is received on PXI trigger line 3. |\n| NIRFSA_VAL_PXI_TRIG4 (\'PXI_Trig4\') | The trigger is received on PXI trigger line 4. |\n| NIRFSA_VAL_PXI_TRIG5 (\'PXI_Trig5\') | The trigger is received on PXI trigger line 5. |\n| NIRFSA_VAL_PXI_TRIG6 (\'PXI_Trig6\') | The trigger is received on PXI trigger line 6. |\n| NIRFSA_VAL_PXI_TRIG7 (\'PXI_Trig7\') | The trigger is received on PXI trigger line 7. |\n| NIRFSA_VAL_PXI_STAR (\'PXI_STAR\') | The trigger is received on the PXI star trigger line. This value is not supported for PXIe-5644/5645/5646 devices. |\n| NIRFSA_VAL_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. |\n| NIRFSA_VAL_TIMER_EVENT (\'TimerEvent\') | The trigger is received from Timer Event on the digitizer. This value is valid on only the PXIe-5820/5840/5841/5842/5860 and for digital edge Advance Triggers on the PXIe-5644/5645/5646 and PXIe-5663E/5665. |\n| NIRFSA_VAL_DIO_PFI0 (\'PFI0\') | The trigger is received on PFI 0 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI1(\'PFI1\') | The trigger is received on PFI 1 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI2 (\'PFI2\') | The trigger is received on PFI 2 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI3 (\'PFI3\') | The trigger is received on PFI 3 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI4 (\'PFI4\') | The trigger is received on PFI 4 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI5 (\'PFI5\') | The trigger is received on PFI 5 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI6 (\'PFI6\') | The trigger is received on PFI 6 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI7 (\'PFI7\') | The trigger is received on PFI 7 of the DIO Terminal. |', + 'description': "Specifies the source of the digital edge for the Advance Trigger.\n\n| Value | Description |\n|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| NIRFSA_VAL_PFI0 ('PFI0') | The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0. |\n| NIRFSA_VAL_PFI1 ('PFI1') | The trigger is received on PFI 1. |\n| NIRFSA_VAL_PXI_TRIG0 ('PXI_Trig0') | The trigger is received on PXI trigger line 0. |\n| NIRFSA_VAL_PXI_TRIG1 ('PXI_Trig1') | The trigger is received on PXI trigger line 1. |\n| NIRFSA_VAL_PXI_TRIG2 ('PXI_Trig2') | The trigger is received on PXI trigger line 2. |\n| NIRFSA_VAL_PXI_TRIG3 ('PXI_Trig3') | The trigger is received on PXI trigger line 3. |\n| NIRFSA_VAL_PXI_TRIG4 ('PXI_Trig4') | The trigger is received on PXI trigger line 4. |\n| NIRFSA_VAL_PXI_TRIG5 ('PXI_Trig5') | The trigger is received on PXI trigger line 5. |\n| NIRFSA_VAL_PXI_TRIG6 ('PXI_Trig6') | The trigger is received on PXI trigger line 6. |\n| NIRFSA_VAL_PXI_TRIG7 ('PXI_Trig7') | The trigger is received on PXI trigger line 7. |\n| NIRFSA_VAL_PXI_STAR ('PXI_STAR') | The trigger is received on the PXI star trigger line. This value is not supported for PXIe-5644/5645/5646 devices. |\n| NIRFSA_VAL_PXIE_DSTARB_STR ('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. |\n| NIRFSA_VAL_TIMER_EVENT_STR ('TimerEvent') | The trigger is received from Timer Event on the digitizer. This value is valid on only the PXIe-5820/5840/5841/5842/5860 and for digital edge Advance Triggers on the PXIe-5644/5645/5646 and PXIe-5663E/5665. |\n| NIRFSA_VAL_DIO_PFI0 ('PFI0') | The trigger is received on PFI 0 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI1('PFI1') | The trigger is received on PFI 1 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI2 ('PFI2') | The trigger is received on PFI 2 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI3 ('PFI3') | The trigger is received on PFI 3 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI4 ('PFI4') | The trigger is received on PFI 4 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI5 ('PFI5') | The trigger is received on PFI 5 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI6 ('PFI6') | The trigger is received on PFI 6 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI7 ('PFI7') | The trigger is received on PFI 7 of the DIO Terminal. |" }, 'grpc_name': 'source_raw', 'name': 'source', @@ -424,7 +402,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the trigger edge to detect. The default value is NIRFSA_VAL_RISING_EDGE.\n\n| Value | Description |\n|:------------------------------|:--------------------------------|\n| NIRFSA_VAL_RISING_EDGE (900) | NI-RFSA detects a rising edge. |\n| NIRFSA_VAL_FALLING_EDGE (901) | NI-RFSA detects a falling edge. |', + 'description': 'Specifies the trigger edge to detect. The default value is NIRFSA_VAL_RISING_EDGE.\n\n| Value | Description |\n|:------------------------------|:--------------------------------|\n| NIRFSA_VAL_RISING_EDGE (900) | NI-RFSA detects a rising edge. |\n| NIRFSA_VAL_FALLING_EDGE (901) | NI-RFSA detects a falling edge. |' }, 'enum': 'AdvanceTriggerDigitalEdgeEdge', 'name': 'edge', @@ -439,7 +417,7 @@ 'ConfigureDigitalEdgeRefTrigger': { 'codegen_method': 'public', 'documentation': { - 'description': 'Configures the device to wait for a digital edge Reference Trigger to mark a reference point within the record.\n\nYou can use this trigger with the `NI-TClk API `_.\n\n----\n**Note**\n The PXIe-5644/5645/5646 does not support the NI-TClk API.\n\n----\n\n----\n**Note**\n This function is not supported if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function or if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_', + 'description': 'Configures the device to wait for a digital edge Reference Trigger to mark a reference point within the record.\n\nYou can use this trigger with the `NI-TClk API `_.\n\n----\n**Note**\n The PXIe-5644/5645/5646 does not support the NI-TClk API.\n\n----\n\n----\n**Note**\n This function is not supported if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function or if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_' }, 'included_in_proto': True, 'is_error_handling': False, @@ -455,7 +433,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -465,7 +443,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the source of the digital edge for the Reference trigger.\n\n|Value |Description |\n|:-------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| NIRFSA_VAL_PFI0 (\'PFI0\') | The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0. |\n| NIRFSA_VAL_PFI1 (\'PFI1\') | The trigger is received on PFI 1. |\n| NIRFSA_VAL_PXI_TRIG0 (\'PXI_Trig0\') | The trigger is received on PXI trigger line 0. |\n| NIRFSA_VAL_PXI_TRIG1 (\'PXI_Trig1\') | The trigger is received on PXI trigger line 1. |\n| NIRFSA_VAL_PXI_TRIG2 (\'PXI_Trig2\') | The trigger is received on PXI trigger line 2. |\n| NIRFSA_VAL_PXI_TRIG3 (\'PXI_Trig3\') | The trigger is received on PXI trigger line 3. |\n| NIRFSA_VAL_PXI_TRIG4 (\'PXI_Trig4\') | The trigger is received on PXI trigger line 4. |\n| NIRFSA_VAL_PXI_TRIG5 (\'PXI_Trig5\') | The trigger is received on PXI trigger line 5. |\n| NIRFSA_VAL_PXI_TRIG6 (\'PXI_Trig6\') | The trigger is received on PXI trigger line 6. |\n| NIRFSA_VAL_PXI_TRIG7 (\'PXI_Trig7\') | The trigger is received on PXI trigger line 7. |\n| NIRFSA_VAL_PXI_STAR (\'PXI_STAR\') | The trigger is received on the PXI star trigger line. This value is not supported for PXIe-5644/5645/5646 devices. |\n| NIRFSA_VAL_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. |\n| NIRFSA_VAL_TIMER_EVENT (\'TimerEvent\') | The trigger is received from Timer Event on the digitizer. This value is valid on only the PXIe-5820/5840/5841/5842/5860 and for digital edge Advance Triggers on the PXIe-5644/5645/5646 and PXIe-5663E/5665. |\n| NIRFSA_VAL_DIO_PFI0 (\'PFI0\') | The trigger is received on PFI 0 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI1(\'PFI1\') | The trigger is received on PFI 1 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI2 (\'PFI2\') | The trigger is received on PFI 2 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI3 (\'PFI3\') | The trigger is received on PFI 3 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI4 (\'PFI4\') | The trigger is received on PFI 4 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI5 (\'PFI5\') | The trigger is received on PFI 5 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI6 (\'PFI6\') | The trigger is received on PFI 6 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI7 (\'PFI7\') | The trigger is received on PFI 7 of the DIO Terminal. |', + 'description': "Specifies the source of the digital edge for the Reference trigger.\n\n|Value |Description |\n|:-------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| NIRFSA_VAL_PFI0 ('PFI0') | The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0. |\n| NIRFSA_VAL_PFI1 ('PFI1') | The trigger is received on PFI 1. |\n| NIRFSA_VAL_PXI_TRIG0 ('PXI_Trig0') | The trigger is received on PXI trigger line 0. |\n| NIRFSA_VAL_PXI_TRIG1 ('PXI_Trig1') | The trigger is received on PXI trigger line 1. |\n| NIRFSA_VAL_PXI_TRIG2 ('PXI_Trig2') | The trigger is received on PXI trigger line 2. |\n| NIRFSA_VAL_PXI_TRIG3 ('PXI_Trig3') | The trigger is received on PXI trigger line 3. |\n| NIRFSA_VAL_PXI_TRIG4 ('PXI_Trig4') | The trigger is received on PXI trigger line 4. |\n| NIRFSA_VAL_PXI_TRIG5 ('PXI_Trig5') | The trigger is received on PXI trigger line 5. |\n| NIRFSA_VAL_PXI_TRIG6 ('PXI_Trig6') | The trigger is received on PXI trigger line 6. |\n| NIRFSA_VAL_PXI_TRIG7 ('PXI_Trig7') | The trigger is received on PXI trigger line 7. |\n| NIRFSA_VAL_PXI_STAR ('PXI_STAR') | The trigger is received on the PXI star trigger line. This value is not supported for PXIe-5644/5645/5646 devices. |\n| NIRFSA_VAL_PXIE_DSTARB_STR ('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. |\n| NIRFSA_VAL_TIMER_EVENT_STR ('TimerEvent') | The trigger is received from Timer Event on the digitizer. This value is valid on only the PXIe-5820/5840/5841/5842/5860 and for digital edge Advance Triggers on the PXIe-5644/5645/5646 and PXIe-5663E/5665. |\n| NIRFSA_VAL_DIO_PFI0 ('PFI0') | The trigger is received on PFI 0 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI1('PFI1') | The trigger is received on PFI 1 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI2 ('PFI2') | The trigger is received on PFI 2 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI3 ('PFI3') | The trigger is received on PFI 3 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI4 ('PFI4') | The trigger is received on PFI 4 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI5 ('PFI5') | The trigger is received on PFI 5 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI6 ('PFI6') | The trigger is received on PFI 6 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI7 ('PFI7') | The trigger is received on PFI 7 of the DIO Terminal. |" }, 'grpc_name': 'source_raw', 'name': 'source', @@ -476,7 +454,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the trigger edge to detect. The default value is NIRFSA_VAL_RISING_EDGE.\n\n|Value |Description |\n|:------------------------------|:--------------------------------|\n| NIRFSA_VAL_RISING_EDGE (900) | NI-RFSA detects a rising edge. |\n| NIRFSA_VAL_FALLING_EDGE (901) | NI-RFSA detects a falling edge. |', + 'description': 'Specifies the trigger edge to detect. The default value is NIRFSA_VAL_RISING_EDGE.\n\n|Value |Description |\n|:------------------------------|:--------------------------------|\n| NIRFSA_VAL_RISING_EDGE (900) | NI-RFSA detects a rising edge. |\n| NIRFSA_VAL_FALLING_EDGE (901) | NI-RFSA detects a falling edge. |' }, 'enum': 'ReferenceTriggerDigitalEdgeEdge', 'name': 'edge', @@ -488,7 +466,7 @@ 'default_value': '0', 'direction': 'in', 'documentation': { - 'description': 'Specifies the number of samples to store for each record that was acquired in the time period immediately before the trigger occurred.', + 'description': 'Specifies the number of samples to store for each record that was acquired in the time period immediately before the trigger occurred.' }, 'name': 'pretriggerSamples', 'type': 'ViInt64', @@ -502,7 +480,7 @@ 'ConfigureDigitalEdgeStartTrigger': { 'codegen_method': 'public', 'documentation': { - 'description': 'Configures the device to wait for a digital edge Start Trigger at the beginning of the acquisition.\n\nYou can use this trigger with the `NI-TClk API `_.\n\n----\n**Note**\n The PXIe-5644/5645/5646 does not support the NI-TClk API.\n\n----\n\n----\n**Note**\n This function is not supported if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function or if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_', + 'description': 'Configures the device to wait for a digital edge Start Trigger at the beginning of the acquisition.\n\nYou can use this trigger with the `NI-TClk API `_.\n\n----\n**Note**\n The PXIe-5644/5645/5646 does not support the NI-TClk API.\n\n----\n\n----\n**Note**\n This function is not supported if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function or if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_' }, 'included_in_proto': True, 'is_error_handling': False, @@ -518,7 +496,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -528,7 +506,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the source of the digital edge for the Start Trigger.\n\n| Value | Description |\n|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| NIRFSA_VAL_PFI0 (\'PFI0\') | The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0. |\n| NIRFSA_VAL_PFI1 (\'PFI1\') | The trigger is received on PFI 1. |\n| NIRFSA_VAL_PXI_TRIG0 (\'PXI_Trig0\') | The trigger is received on PXI trigger line 0. |\n| NIRFSA_VAL_PXI_TRIG1 (\'PXI_Trig1\') | The trigger is received on PXI trigger line 1. |\n| NIRFSA_VAL_PXI_TRIG2 (\'PXI_Trig2\') | The trigger is received on PXI trigger line 2. |\n| NIRFSA_VAL_PXI_TRIG3 (\'PXI_Trig3\') | The trigger is received on PXI trigger line 3. |\n| NIRFSA_VAL_PXI_TRIG4 (\'PXI_Trig4\') | The trigger is received on PXI trigger line 4. |\n| NIRFSA_VAL_PXI_TRIG5 (\'PXI_Trig5\') | The trigger is received on PXI trigger line 5. |\n| NIRFSA_VAL_PXI_TRIG6 (\'PXI_Trig6\') | The trigger is received on PXI trigger line 6. |\n| NIRFSA_VAL_PXI_TRIG7 (\'PXI_Trig7\') | The trigger is received on PXI trigger line 7. |\n| NIRFSA_VAL_PXI_STAR (\'PXI_STAR\') | The trigger is received on the PXI star trigger line. This value is not supported for PXIe-5644/5645/5646 devices. |\n| NIRFSA_VAL_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. |\n| NIRFSA_VAL_TIMER_EVENT (\'TimerEvent\') | The trigger is received from Timer Event on the digitizer. This value is valid on only the PXIe-5820/5840/5841/5842/5860 and for digital edge Advance Triggers on the PXIe-5644/5645/5646 and PXIe-5663E/5665. |\n| NIRFSA_VAL_DIO_PFI0 (\'PFI1\') | The trigger is received on PFI 0 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI1(\'PFI2\') | The trigger is received on PFI 1 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI2 (\'PFI3\') | The trigger is received on PFI 2 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI3 (\'PFI4\') | The trigger is received on PFI 3 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI4 (\'PFI5\') | The trigger is received on PFI 4 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI5 (\'PFI6\') | The trigger is received on PFI 5 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI6 (\'PFI7\') | The trigger is received on PFI 6 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI7 (\'PFI8\') | The trigger is received on PFI 7 of the DIO Terminal. |', + 'description': "Specifies the source of the digital edge for the Start Trigger.\n\n| Value | Description |\n|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| NIRFSA_VAL_PFI0 ('PFI0') | The trigger is received on PFI 0. For the PXIe-5841 with PXIe-5655, the trigger is received on the PXIe-5841 PFI 0. |\n| NIRFSA_VAL_PFI1 ('PFI1') | The trigger is received on PFI 1. |\n| NIRFSA_VAL_PXI_TRIG0 ('PXI_Trig0') | The trigger is received on PXI trigger line 0. |\n| NIRFSA_VAL_PXI_TRIG1 ('PXI_Trig1') | The trigger is received on PXI trigger line 1. |\n| NIRFSA_VAL_PXI_TRIG2 ('PXI_Trig2') | The trigger is received on PXI trigger line 2. |\n| NIRFSA_VAL_PXI_TRIG3 ('PXI_Trig3') | The trigger is received on PXI trigger line 3. |\n| NIRFSA_VAL_PXI_TRIG4 ('PXI_Trig4') | The trigger is received on PXI trigger line 4. |\n| NIRFSA_VAL_PXI_TRIG5 ('PXI_Trig5') | The trigger is received on PXI trigger line 5. |\n| NIRFSA_VAL_PXI_TRIG6 ('PXI_Trig6') | The trigger is received on PXI trigger line 6. |\n| NIRFSA_VAL_PXI_TRIG7 ('PXI_Trig7') | The trigger is received on PXI trigger line 7. |\n| NIRFSA_VAL_PXI_STAR ('PXI_STAR') | The trigger is received on the PXI star trigger line. This value is not supported for PXIe-5644/5645/5646 devices. |\n| NIRFSA_VAL_PXIE_DSTARB_STR ('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. |\n| NIRFSA_VAL_TIMER_EVENT_STR ('TimerEvent') | The trigger is received from Timer Event on the digitizer. This value is valid on only the PXIe-5820/5840/5841/5842/5860 and for digital edge Advance Triggers on the PXIe-5644/5645/5646 and PXIe-5663E/5665. |\n| NIRFSA_VAL_DIO_PFI0 ('PFI1') | The trigger is received on PFI 0 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI1('PFI2') | The trigger is received on PFI 1 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI2 ('PFI3') | The trigger is received on PFI 2 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI3 ('PFI4') | The trigger is received on PFI 3 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI4 ('PFI5') | The trigger is received on PFI 4 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI5 ('PFI6') | The trigger is received on PFI 5 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI6 ('PFI7') | The trigger is received on PFI 6 of the DIO Terminal. |\n| NIRFSA_VAL_DIO_PFI7 ('PFI8') | The trigger is received on PFI 7 of the DIO Terminal. |" }, 'grpc_name': 'source_raw', 'name': 'source', @@ -539,7 +517,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the trigger edge to detect. The default value is NIRFSA_VAL_RISING_EDGE.\n\n| Value | Description |\n|:------------------------------|:--------------------------------|\n| NIRFSA_VAL_RISING_EDGE (900) | NI-RFSA detects a rising edge. |\n| NIRFSA_VAL_FALLING_EDGE (901) | NI-RFSA detects a falling edge. |', + 'description': 'Specifies the trigger edge to detect. The default value is NIRFSA_VAL_RISING_EDGE.\n\n| Value | Description |\n|:------------------------------|:--------------------------------|\n| NIRFSA_VAL_RISING_EDGE (900) | NI-RFSA detects a rising edge. |\n| NIRFSA_VAL_FALLING_EDGE (901) | NI-RFSA detects a falling edge. |' }, 'enum': 'StartTriggerDigitalEdgeEdge', 'name': 'edge', @@ -554,7 +532,7 @@ 'ConfigureIQPowerEdgeRefTrigger': { 'codegen_method': 'public', 'documentation': { - 'description': 'Configures the device to wait for the complex power of the I/Q data to cross the specified threshold to mark a reference point within the record.\n\nTo trigger on burst signals, add a minimum quiet time, configured with the NIRFSA_ATTR_REF_TRIGGER_MINIMUM_QUIET_TIME attribute, to ensure the trigger does not occur in the middle of a burst if the acquisition starts while a burst is being generated. The quiet time should be set to a value smaller than the time between bursts, but large enough to ignore power changes within a burst.\n\nYou can use this trigger with the `NI-TClk API `_.\n\n----\n**Note**\n This function is not supported if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function or if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_', + 'description': 'Configures the device to wait for the complex power of the I/Q data to cross the specified threshold to mark a reference point within the record.\n\nTo trigger on burst signals, add a minimum quiet time, configured with the NIRFSA_ATTR_REF_TRIGGER_MINIMUM_QUIET_TIME attribute, to ensure the trigger does not occur in the middle of a burst if the acquisition starts while a burst is being generated. The quiet time should be set to a value smaller than the time between bursts, but large enough to ignore power changes within a burst.\n\nYou can use this trigger with the `NI-TClk API `_.\n\n----\n**Note**\n This function is not supported if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function or if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_' }, 'grpc_name': 'ConfigureIQPowerEdgeRefTrigger', 'included_in_proto': True, @@ -571,7 +549,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -581,7 +559,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the source of the RF signal for the power edge Reference trigger. The only supported value is "0".', + 'description': 'Specifies the source of the RF signal for the power edge Reference trigger. The only supported value is "0".' }, 'name': 'source', 'type': 'ViConstString', @@ -591,7 +569,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the threshold, in dBm, above or below which the device triggers.', + 'description': 'Specifies the threshold, in dBm, above or below which the device triggers.' }, 'name': 'level', 'type': 'ViReal64', @@ -601,9 +579,9 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies whether the device detects a positive or negative slope on the trigger signal. The default value is NIRFSA_VAL_RISING_SLOPE.\n\n| Value | Description |\n|:--------------------------------|:-------------------------------------------------|\n| NIRFSA_VAL_RISING_SLOPE (1000) | NI-RFSA detects a rising edge (positive slope). |\n| NIRFSA_VAL_FALLING_SLOPE (1001) | NI-RFSA detects a falling edge (negative slope). |', + 'description': 'Specifies whether the device detects a positive or negative slope on the trigger signal. The default value is NIRFSA_VAL_RISING_SLOPE.\n\n| Value | Description |\n|:--------------------------------|:-------------------------------------------------|\n| NIRFSA_VAL_RISING_SLOPE (1000) | NI-RFSA detects a rising edge (positive slope). |\n| NIRFSA_VAL_FALLING_SLOPE (1001) | NI-RFSA detects a falling edge (negative slope). |' }, - 'enum' : 'ReferenceTriggerIQPowerEdgeSlope', + 'enum': 'ReferenceTriggerIQPowerEdgeSlope', 'name': 'slope', 'type': 'ViInt32', 'use_array': False, @@ -613,7 +591,7 @@ 'default_value': '0', 'direction': 'in', 'documentation': { - 'description': 'Specifies the number of samples to store for each record that was acquired in the time period immediately before the trigger occurred.', + 'description': 'Specifies the number of samples to store for each record that was acquired in the time period immediately before the trigger occurred.' }, 'name': 'pretriggerSamples', 'type': 'ViInt64', @@ -627,7 +605,7 @@ 'ConfigureRefClock': { 'codegen_method': 'public', 'documentation': { - 'description': 'Configures the NI-RFSA device Reference Clock.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5694, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`PXI-5661 Reference Clock `_\n\n`PXIe-5663 Timing Configurations `_\n\n`PXIe-5665 Timing Configurations `_\n\n`PXIe-5667 Timing Configurations `_\n\n`PXIe-5668 Timing Configurations `_\n\n`PXIe-5830 Timing Configurations `_\n\n`PXIe-5831 Timing Configurations `_', + 'description': 'Configures the NI-RFSA device Reference Clock.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5694, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`PXI-5661 Reference Clock `_\n\n`PXIe-5663 Timing Configurations `_\n\n`PXIe-5665 Timing Configurations `_\n\n`PXIe-5667 Timing Configurations `_\n\n`PXIe-5668 Timing Configurations `_\n\n`PXIe-5830 Timing Configurations `_\n\n`PXIe-5831 Timing Configurations `_' }, 'included_in_proto': True, 'is_error_handling': False, @@ -643,7 +621,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function' }, 'name': 'vi', 'type': 'ViSession', @@ -653,10 +631,10 @@ { 'direction': 'in', 'documentation': { - 'description': 'specifies the source of the Reference Clock signal.\n| Clock Source | Description |\n|-----------------------|-------------|\n| **Onboard Clock (default)** | Uses the onboard Reference Clock as the clock source.
**PXIe-5830/5831/5832**-
- PXIe-5830: Connect PXIe-5820 REF IN to PXIe-3621 REF OUT.
- PXIe-5831: Connect PXIe-5820 REF IN to PXIe-3622 REF OUT.
- PXIe-5832: Connect PXIe-5820 REF IN to PXIe-3623 REF OUT.
**PXIe-5831 with PXIe-5653**-
- Connect PXIe-5820 REF IN to PXIe-3622 REF OUT.
- Connect PXIe-5653 REF OUT (10 MHz) to PXIe-3622 REF IN.
**PXIe-5832 with PXIe-5653**-
- Connect PXIe-5820 REF IN to PXIe-3623 REF OUT.
- Connect PXIe-5653 REF OUT (10 MHz) to PXIe-3623 REF IN.
**PXIe-5841 with PXIe-5655**-
- Lock to PXIe-5655 onboard clock. Connect REF OUT on PXIe-5655 to PXIe-5841 REF IN.
**PXIe-5842**-
- Lock to PXIe-5655 onboard clock. Use cables as shown in the Getting Started Guide. |\n| **RefIn** | Uses the signal at the front panel REF IN connector.
**PXIe-5830/5831/5832**-
- PXIe-5830: Connect PXIe-5820 REF IN to PXIe-3621 REF OUT; lock external signal to PXIe-3621 REF IN.
- PXIe-5831: Connect PXIe-5820 REF IN to PXIe-3622 REF OUT; lock external signal to PXIe-3622 REF IN.
- PXIe-5832: Connect PXIe-5820 REF IN to PXIe-3623 REF OUT; lock external signal to PXIe-3623 REF IN.
**PXIe-5831 with PXIe-5653**-
- Connect PXIe-5820 REF IN to PXIe-3622 REF OUT.
- Connect PXIe-5653 REF OUT (10 MHz) to PXIe-3622 REF IN.
- Lock external signal to PXIe-5653 REF IN.
**PXIe-5832 with PXIe-5653**-
- Connect PXIe-5820 REF IN to PXIe-3623 REF OUT.
- Connect PXIe-5653 REF OUT (10 MHz) to PXIe-3623 REF IN.
- Lock external signal to PXIe-5653 REF IN.
**PXIe-5841 with PXIe-5655**-
- Lock to signal at REF IN on PXIe-5655. Connect REF OUT on PXIe-5655 to PXIe-5841 REF IN.
**PXIe-5842**-
- Lock to signal at REF IN on PXIe-5655. Use cables as shown in the Getting Started Guide. |\n| **PXI Clock** | Uses the PXI_CLK signal present on the PXI backplane. |\n| **PXI_ClkMaster** | Valid only for PXIe-5831 with PXIe-5653 and PXIe-5832 with PXIe-5653.
**PXIe-5831 with PXIe-5653**-
- NI-RFSG configures PXIe-5653 to export Reference Clock.
- Configures PXIe-5820 and PXIe-3622 to use PXI_Clk.
- Connect PXIe-5653 REF OUT (10 MHz) to PXI chassis REF IN.
**PXIe-5832 with PXIe-5653**-
- NI-RFSG configures PXIe-5653 to export Reference Clock.
- Configures PXIe-5820 and PXIe-3623 to use PXI_Clk.
- Connect PXIe-5653 REF OUT (10 MHz) to PXI chassis REF IN. |', + 'description': 'specifies the source of the Reference Clock signal.\n| Clock Source | Description |\n|-----------------------|-------------|\n| **Onboard Clock (default)** | Uses the onboard Reference Clock as the clock source.
**PXIe-5830/5831/5832**-
- PXIe-5830: Connect PXIe-5820 REF IN to PXIe-3621 REF OUT.
- PXIe-5831: Connect PXIe-5820 REF IN to PXIe-3622 REF OUT.
- PXIe-5832: Connect PXIe-5820 REF IN to PXIe-3623 REF OUT.
**PXIe-5831 with PXIe-5653**-
- Connect PXIe-5820 REF IN to PXIe-3622 REF OUT.
- Connect PXIe-5653 REF OUT (10 MHz) to PXIe-3622 REF IN.
**PXIe-5832 with PXIe-5653**-
- Connect PXIe-5820 REF IN to PXIe-3623 REF OUT.
- Connect PXIe-5653 REF OUT (10 MHz) to PXIe-3623 REF IN.
**PXIe-5841 with PXIe-5655**-
- Lock to PXIe-5655 onboard clock. Connect REF OUT on PXIe-5655 to PXIe-5841 REF IN.
**PXIe-5842**-
- Lock to PXIe-5655 onboard clock. Use cables as shown in the Getting Started Guide. |\n| **RefIn** | Uses the signal at the front panel REF IN connector.
**PXIe-5830/5831/5832**-
- PXIe-5830: Connect PXIe-5820 REF IN to PXIe-3621 REF OUT; lock external signal to PXIe-3621 REF IN.
- PXIe-5831: Connect PXIe-5820 REF IN to PXIe-3622 REF OUT; lock external signal to PXIe-3622 REF IN.
- PXIe-5832: Connect PXIe-5820 REF IN to PXIe-3623 REF OUT; lock external signal to PXIe-3623 REF IN.
**PXIe-5831 with PXIe-5653**-
- Connect PXIe-5820 REF IN to PXIe-3622 REF OUT.
- Connect PXIe-5653 REF OUT (10 MHz) to PXIe-3622 REF IN.
- Lock external signal to PXIe-5653 REF IN.
**PXIe-5832 with PXIe-5653**-
- Connect PXIe-5820 REF IN to PXIe-3623 REF OUT.
- Connect PXIe-5653 REF OUT (10 MHz) to PXIe-3623 REF IN.
- Lock external signal to PXIe-5653 REF IN.
**PXIe-5841 with PXIe-5655**-
- Lock to signal at REF IN on PXIe-5655. Connect REF OUT on PXIe-5655 to PXIe-5841 REF IN.
**PXIe-5842**-
- Lock to signal at REF IN on PXIe-5655. Use cables as shown in the Getting Started Guide. |\n| **PXI Clock** | Uses the PXI_CLK signal present on the PXI backplane. |\n| **PXI_ClkMaster** | Valid only for PXIe-5831 with PXIe-5653 and PXIe-5832 with PXIe-5653.
**PXIe-5831 with PXIe-5653**-
- NI-RFSG configures PXIe-5653 to export Reference Clock.
- Configures PXIe-5820 and PXIe-3622 to use PXI_Clk.
- Connect PXIe-5653 REF OUT (10 MHz) to PXI chassis REF IN.
**PXIe-5832 with PXIe-5653**-
- NI-RFSG configures PXIe-5653 to export Reference Clock.
- Configures PXIe-5820 and PXIe-3623 to use PXI_Clk.
- Connect PXIe-5653 REF OUT (10 MHz) to PXI chassis REF IN. |' }, - 'name': 'clockSource', 'enum': 'ReferenceClockSource', + 'name': 'clockSource', 'type': 'ViConstString', 'use_array': False, 'use_in_python_api': True @@ -664,7 +642,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. This parameter is only valid when the **ref clock source** parameter is set to **RefIn**. The default value is Auto (-1.0), which allows NI-RFSG to use the default Reference Clock rate for the device or automatically detect the Reference Clock rate, if supported. Refer to the Reference Clock Rate property for possible values.', + 'description': 'specifies the Reference Clock rate, in hertz (Hz), of the signal present at the REF IN or CLK IN connector. This parameter is only valid when the **ref clock source** parameter is set to **RefIn**. The default value is Auto (-1.0), which allows NI-RFSG to use the default Reference Clock rate for the device or automatically detect the Reference Clock rate, if supported. Refer to the Reference Clock Rate property for possible values.' }, 'name': 'refClockRate', 'type': 'ViReal64', @@ -678,7 +656,7 @@ 'ConfigureSoftwareEdgeAdvanceTrigger': { 'codegen_method': 'public', 'documentation': { - 'description': 'Configures the device to wait for a software Advance Trigger.\n\nThe Advance Trigger indicates where a new record begins. The device waits until you call the nirfsa_SendSoftwareEdgeTrigger function to assert the trigger.\n\n----\n**Note**\n This function is not supported if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function or if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_', + 'description': 'Configures the device to wait for a software Advance Trigger.\n\nThe Advance Trigger indicates where a new record begins. The device waits until you call the nirfsa_SendSoftwareEdgeTrigger function to assert the trigger.\n\n----\n**Note**\n This function is not supported if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function or if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_' }, 'included_in_proto': True, 'is_error_handling': False, @@ -694,7 +672,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -708,7 +686,7 @@ 'ConfigureSoftwareEdgeRefTrigger': { 'codegen_method': 'public', 'documentation': { - 'description': 'Configures the device to wait for a software Reference Trigger to mark a reference point within the record.\n\nThe device waits until you call the nirfsa_SendSoftwareEdgeTrigger function to assert the trigger.\n\nYou can use this trigger with the `NI-TClk API `_.\n\n----\n**Note**\n The PXIe-5644/5645/5646 does not support the NI-TClk API.\n\n----\n\n----\n**Note**\n This function is not supported if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function or if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_', + 'description': 'Configures the device to wait for a software Reference Trigger to mark a reference point within the record.\n\nThe device waits until you call the nirfsa_SendSoftwareEdgeTrigger function to assert the trigger.\n\nYou can use this trigger with the `NI-TClk API `_.\n\n----\n**Note**\n The PXIe-5644/5645/5646 does not support the NI-TClk API.\n\n----\n\n----\n**Note**\n This function is not supported if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function or if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_' }, 'included_in_proto': True, 'is_error_handling': False, @@ -724,7 +702,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -732,12 +710,12 @@ 'use_in_python_api': True }, { + 'default_value': '0', 'direction': 'in', 'documentation': { - 'description': 'Specifies the number of samples to store for each record that was acquired in the time period immediately before the trigger occurred.', + 'description': 'Specifies the number of samples to store for each record that was acquired in the time period immediately before the trigger occurred.' }, 'name': 'pretriggerSamples', - 'default_value': '0', 'type': 'ViInt64', 'use_array': False, 'use_in_python_api': True @@ -749,7 +727,7 @@ 'ConfigureSoftwareEdgeStartTrigger': { 'codegen_method': 'public', 'documentation': { - 'description': 'Configures the device to wait for a software Start Trigger at the beginning of the acquisition.\n\nThe device waits until you call the nirfsa_SendSoftwareEdgeTrigger function to assert the trigger.\n\nYou can use this trigger with the `NI-TClk API `_.\n\n----\n**Note**\n The PXIe-5644/5645/5646 does not support the NI-TClk API.\n\n----\n\n----\n**Note**\n This function is not supported if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function or if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_', + 'description': 'Configures the device to wait for a software Start Trigger at the beginning of the acquisition.\n\nThe device waits until you call the nirfsa_SendSoftwareEdgeTrigger function to assert the trigger.\n\nYou can use this trigger with the `NI-TClk API `_.\n\n----\n**Note**\n The PXIe-5644/5645/5646 does not support the NI-TClk API.\n\n----\n\n----\n**Note**\n This function is not supported if you set the **acquisitionType** parameter to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function or if you set the NIRFSA_ATTR_ACQUISITION_TYPE attribute to NIRFSA_VAL_SPECTRUM.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_' }, 'included_in_proto': True, 'is_error_handling': False, @@ -765,7 +743,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -778,12 +756,13 @@ }, 'ConfigureSpectrumFrequencyCenterSpan': { 'codegen_method': 'private', - 'method_name_for_documentation': 'configure_spectrum_frequency', 'documentation': { - 'description': 'Configures the span and center frequency of the spectrum read by NI-RFSA.\n\nA spectrum acquisition consists of data surrounding the center frequency.\n\n----\n**Note**\nIf you configure the spectrum span to a value larger than the instantaneous bandwidth of the device, NI-RFSA performs multiple acquisitions and combines them into a spectrum of the size you requested.\n\n----\n\n----\n**Note**\n For the PXIe-5663/5663E, NI-RFSA does not support multispan acquisitions from frequency ranges that correspond with different instantaneous bandwidths. For example, you cannot configure a multispan acquisition that acquires one span from 110 MHz to 120 MHz and a second from 120 MHz to 130 MHz because the bandwidths that correspond to each span are different (10 MHz and 20 MHz, respectively).\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + 'description': 'Configures the span and center frequency of the spectrum read by NI-RFSA.\n\nA spectrum acquisition consists of data surrounding the center frequency.\n\n----\n**Note**\nIf you configure the spectrum span to a value larger than the instantaneous bandwidth of the device, NI-RFSA performs multiple acquisitions and combines them into a spectrum of the size you requested.\n\n----\n\n----\n**Note**\n For the PXIe-5663/5663E, NI-RFSA does not support multispan acquisitions from frequency ranges that correspond with different instantaneous bandwidths. For example, you cannot configure a multispan acquisition that acquires one span from 110 MHz to 120 MHz and a second from 120 MHz to 130 MHz because the bandwidths that correspond to each span are different (10 MHz and 20 MHz, respectively).\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, + 'has_repeated_capability': True, 'included_in_proto': True, 'is_error_handling': False, + 'method_name_for_documentation': 'configure_spectrum_frequency', 'method_templates': [ { 'documentation_filename': 'default_method', @@ -796,7 +775,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -806,11 +785,11 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.' }, 'is_repeated_capability': True, - 'repeated_capability_type': 'channels', 'name': 'channelList', + 'repeated_capability_type': 'channels', 'type': 'ViConstString', 'use_array': False, 'use_in_python_api': True @@ -818,7 +797,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the center frequency in a spectrum acquisition. The value is expressed in hertz (Hz). The NI-RFSA device you use determines the valid range. Refer to your device specifications document for more information about frequency range.', + 'description': 'Specifies the center frequency in a spectrum acquisition. The value is expressed in hertz (Hz). The NI-RFSA device you use determines the valid range. Refer to your device specifications document for more information about frequency range.' }, 'name': 'centerFrequency', 'type': 'ViReal64', @@ -828,7 +807,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the span of a spectrum acquisition. The value is expressed in hertz (Hz).\n\n----\n\n*Note* For the PXIe-5663/5663E/5665/5667/5668, NI-RFSA enables dithering by default. The dither noise can appear in your passband and affect your measurements. Refer to the NIRFSA_ATTR_DIGITIZER_DITHER_ENABLED attribute for more information about dithering.\n\n----', + 'description': 'Specifies the span of a spectrum acquisition. The value is expressed in hertz (Hz).\n\n----\n\n*Note* For the PXIe-5663/5663E/5665/5667/5668, NI-RFSA enables dithering by default. The dither noise can appear in your passband and affect your measurements. Refer to the NIRFSA_ATTR_DIGITIZER_DITHER_ENABLED attribute for more information about dithering.\n\n----' }, 'name': 'span', 'type': 'ViReal64', @@ -836,30 +815,32 @@ 'use_in_python_api': True } ], + 'repeated_capability_type': 'channels', 'returns': 'ViStatus', 'use_session_lock': True }, - 'ConfigureSpectrumFrequencyStartStop': { - 'codegen_method': 'private', - 'method_name_for_documentation': 'configure_spectrum_frequency', + 'ConfigureSpectrumFrequencyDispatcher': { + 'codegen_method': 'python-only', 'documentation': { - 'description': 'Configures the start and stop frequencies of a spectrum read by NI-RFSA.\n\n----\n**Note**\nIf you configure the spectrum span (**NIRFSA_ATTR_STOP_FREQUENCY** **NIRFSA_ATTR_START_FREQUENCY**) to a value larger than the instantaneous bandwidth of the device, NI-RFSA performs multiple acquisitions and combines them into a spectrum of the size you request.\n\n----\n\n----\n**Note**\n For the PXIe-5663/5663E, NI-RFSA does not support multispan acquisitions from frequency ranges that correspond with different instantaneous bandwidths. For example, you cannot configure a multispan acquisition that acquires one span from 110 MHz to 120 MHz and a second from 120 MHz to 130 MHz because the bandwidths that correspond to each span are different (10 MHz and 20 MHz, respectively).\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + 'description': 'Configures the frequency range of a spectrum acquisition.\n\nYou can specify the frequency range using either center frequency and span, or start and stop frequencies.\n\n----\n**Note**\nIf you configure the spectrum span to a value larger than the instantaneous bandwidth of the device, NI-RFSA performs multiple acquisitions and combines them into a spectrum of the size you requested.\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, - 'included_in_proto': True, + 'has_repeated_capability': True, + 'included_in_proto': False, 'is_error_handling': False, + 'method_name_for_documentation': 'configure_spectrum_frequency', 'method_templates': [ { 'documentation_filename': 'default_method', - 'library_interpreter_filename': 'default_method', + 'library_interpreter_filename': 'none', 'method_python_name_suffix': '', - 'session_filename': 'default_method' + 'session_filename': 'configure_spectrum_frequency' } ], 'parameters': [ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -869,19 +850,42 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.' }, 'is_repeated_capability': True, - 'repeated_capability_type': 'channels', 'name': 'channelList', + 'repeated_capability_type': 'channels', 'type': 'ViConstString', 'use_array': False, 'use_in_python_api': True }, { + 'default_value': 'None', + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the center frequency in a spectrum acquisition. The value is expressed in hertz (Hz). Must be used together with **span**.' + }, + 'name': 'centerFrequency', + 'type': 'ViReal64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'default_value': 'None', + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the span of a spectrum acquisition. The value is expressed in hertz (Hz). Must be used together with **center_frequency**.' + }, + 'name': 'span', + 'type': 'ViReal64', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'default_value': 'None', 'direction': 'in', 'documentation': { - 'description': 'Specifies the lower limit of a span of frequencies. This value is expressed in hertz (Hz).', + 'description': 'Specifies the lower limit of a span of frequencies. The value is expressed in hertz (Hz). Must be used together with **stop_frequency**.' }, 'name': 'startFrequency', 'type': 'ViReal64', @@ -889,9 +893,10 @@ 'use_in_python_api': True }, { + 'default_value': 'None', 'direction': 'in', 'documentation': { - 'description': 'Specifies the upper limit of a span of frequencies. This value is expressed in hertz (Hz).', + 'description': 'Specifies the upper limit of a span of frequencies. The value is expressed in hertz (Hz). Must be used together with **start_frequency**.' }, 'name': 'stopFrequency', 'type': 'ViReal64', @@ -899,30 +904,33 @@ 'use_in_python_api': True } ], + 'python_name': 'configure_spectrum_frequency', + 'repeated_capability_type': 'channels', 'returns': 'ViStatus', - 'use_session_lock': True + 'use_session_lock': False }, - 'ConfigureSpectrumFrequencyDispatcher': { - 'codegen_method': 'python-only', + 'ConfigureSpectrumFrequencyStartStop': { + 'codegen_method': 'private', 'documentation': { - 'description': 'Configures the frequency range of a spectrum acquisition.\n\nYou can specify the frequency range using either center frequency and span, or start and stop frequencies.\n\n----\n**Note**\nIf you configure the spectrum span to a value larger than the instantaneous bandwidth of the device, NI-RFSA performs multiple acquisitions and combines them into a spectrum of the size you requested.\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + 'description': 'Configures the start and stop frequencies of a spectrum read by NI-RFSA.\n\n----\n**Note**\nIf you configure the spectrum span (**NIRFSA_ATTR_STOP_FREQUENCY** **NIRFSA_ATTR_START_FREQUENCY**) to a value larger than the instantaneous bandwidth of the device, NI-RFSA performs multiple acquisitions and combines them into a spectrum of the size you request.\n\n----\n\n----\n**Note**\n For the PXIe-5663/5663E, NI-RFSA does not support multispan acquisitions from frequency ranges that correspond with different instantaneous bandwidths. For example, you cannot configure a multispan acquisition that acquires one span from 110 MHz to 120 MHz and a second from 120 MHz to 130 MHz because the bandwidths that correspond to each span are different (10 MHz and 20 MHz, respectively).\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, - 'included_in_proto': False, + 'has_repeated_capability': True, + 'included_in_proto': True, 'is_error_handling': False, 'method_name_for_documentation': 'configure_spectrum_frequency', 'method_templates': [ { 'documentation_filename': 'default_method', - 'library_interpreter_filename': 'none', + 'library_interpreter_filename': 'default_method', 'method_python_name_suffix': '', - 'session_filename': 'configure_spectrum_frequency' + 'session_filename': 'default_method' } ], 'parameters': [ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -932,63 +940,171 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.' }, 'is_repeated_capability': True, - 'repeated_capability_type': 'channels', 'name': 'channelList', + 'repeated_capability_type': 'channels', 'type': 'ViConstString', 'use_array': False, 'use_in_python_api': True }, { - 'default_value': 'None', 'direction': 'in', 'documentation': { - 'description': 'Specifies the center frequency in a spectrum acquisition. The value is expressed in hertz (Hz). Must be used together with **span**.', + 'description': 'Specifies the lower limit of a span of frequencies. This value is expressed in hertz (Hz).' }, - 'name': 'centerFrequency', + 'name': 'startFrequency', 'type': 'ViReal64', 'use_array': False, 'use_in_python_api': True }, { - 'default_value': 'None', 'direction': 'in', 'documentation': { - 'description': 'Specifies the span of a spectrum acquisition. The value is expressed in hertz (Hz). Must be used together with **center_frequency**.', + 'description': 'Specifies the upper limit of a span of frequencies. This value is expressed in hertz (Hz).' }, - 'name': 'span', + 'name': 'stopFrequency', 'type': 'ViReal64', 'use_array': False, 'use_in_python_api': True + } + ], + 'repeated_capability_type': 'channels', + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'CreateDeembeddingSparameterTableArray': { + 'codegen_method': 'private', + 'documentation': { + 'description': '\nCreates an s-parameter de-embedding table for the port from the input data.\n\nIf you only create one table for a port, NI-RFSA 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 `_', + }, + 'included_in_proto': True, + 'method_templates': [ + { + 'documentation_filename': 'numpy_method', + 'library_interpreter_filename': 'numpy_write_method', + 'method_python_name_suffix': '', + 'session_filename': 'numpy_write_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.' + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True }, { - 'default_value': 'None', 'direction': 'in', 'documentation': { - 'description': 'Specifies the lower limit of a span of frequencies. The value is expressed in hertz (Hz). Must be used together with **stop_frequency**.', + 'description': 'Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842/5860 is "" (empty string).', }, - 'name': 'startFrequency', - 'type': 'ViReal64', + 'name': 'port', + 'type': 'ViConstString', 'use_array': False, 'use_in_python_api': True }, { - 'default_value': 'None', 'direction': 'in', 'documentation': { - 'description': 'Specifies the upper limit of a span of frequencies. The value is expressed in hertz (Hz). Must be used together with **start_frequency**.', + 'description': 'Specifies the name of the table. The name must be unique for a given port, but not across ports. If you use the same name as an existing table, the table is replaced.', }, - 'name': 'stopFrequency', - 'type': 'ViReal64', + 'name': 'tableName', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the frequencies for the NIRFSA_ATTR_SPARAMETER_TABLE rows. Frequencies must be unique and in ascending order.' + }, + 'name': 'frequencies', + 'numpy': True, + 'size': { + 'mechanism': 'len', + 'value': 'frequenciesSize' + }, + 'type': 'ViReal64[]', + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the size of the frequency array.' + }, + 'name': 'frequenciesSize', + 'type': 'ViInt32', + 'use_array': False + }, + { + 'array_dimensions': 3, + 'complex_array_representation': 'complex_number_array', + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the S-parameters for each frequency. S-parameters for each frequency are placed in the array in the following order: s11, s12, s21, s22.' + }, + 'name': 'sparameterTable', + 'numpy': True, + 'size': { + 'mechanism': 'len', + 'value': 'sparameterTableSize' + }, + 'type': 'NIComplexNumber[]', + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the size of the S-parameter table array.' + }, + 'name': 'sparameterTableSize', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': False + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the number of DUT ports.' + }, + 'name': 'numberOfPorts', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': False + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the orientation of the input data relative to the port on the DUT port.\n\n**Defined Values** :', + 'table_body': [ + [ + 'NIRFSA_VAL_PORT1_TOWARDS_DUT', + 'Port 1 of the S2P is oriented towards the DUT port.' + ], + [ + 'NIRFSA_VAL_PORT2_TOWARDS_DUT', + 'Port 2 of the S2P is oriented towards the DUT port.' + ] + ], + 'table_header': [ + 'Name', + 'Description' + ] + }, + 'enum': 'SparameterOrientation', + 'name': 'sparameterOrientation', + 'type': 'ViInt32', 'use_array': False, 'use_in_python_api': True } ], - 'python_name': 'configure_spectrum_frequency', - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, 'CreateDeembeddingSparameterTableS2PFile': { 'codegen_method': 'public', @@ -1009,7 +1125,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -1094,7 +1210,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -1124,7 +1240,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -1158,7 +1274,7 @@ 'DisableAdvanceTrigger': { 'codegen_method': 'public', 'documentation': { - 'description': 'Configures the device to not use an Advance Trigger.\n\nThis function is necessary only if you configured an Advance Trigger in the past and now want to disable it.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_', + 'description': 'Configures the device to not use an Advance Trigger.\n\nThis function is necessary only if you configured an Advance Trigger in the past and now want to disable it.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_' }, 'included_in_proto': True, 'is_error_handling': False, @@ -1174,7 +1290,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -1188,7 +1304,7 @@ 'DisableRefTrigger': { 'codegen_method': 'public', 'documentation': { - 'description': 'Configures the device to not wait for a Reference Trigger to mark a reference point within a record.\n\nThis function is necessary only if you previously configured a Reference trigger in the past and now want to disable it.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5668, PXIe-5820/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_', + 'description': 'Configures the device to not wait for a Reference Trigger to mark a reference point within a record.\n\nThis function is necessary only if you previously configured a Reference trigger in the past and now want to disable it.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5668, PXIe-5820/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_' }, 'included_in_proto': True, 'is_error_handling': False, @@ -1204,7 +1320,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -1218,7 +1334,7 @@ 'DisableStartTrigger': { 'codegen_method': 'public', 'documentation': { - 'description': 'Configures the device to not wait for a Start Trigger at the beginning of the acquisition.\n\nThis function is necessary only if you previously configured a Start Trigger in the past and now want to disable it.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_', + 'description': 'Configures the device to not wait for a Start Trigger at the beginning of the acquisition.\n\nThis function is necessary only if you previously configured a Start Trigger in the past and now want to disable it.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_' }, 'included_in_proto': True, 'is_error_handling': False, @@ -1234,7 +1350,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -1248,7 +1364,7 @@ 'EnableSessionAccess': { 'codegen_method': 'public', 'documentation': { - 'description': 'Enables or disables SFP session access for the specified instrument.\n\nSFP session access allows the NI-RFSA Soft Front Panel (SFP) to access a device with an existing open session and can help you debug your code. To enable session access, pass VI_TRUE to the **enabled** parameter. To disable session access, pass VI_FALSE to the **enabled** parameter.\n\nRefer to `Configuring SFP Session Access using LabWindows/CVI or C `_ for more information about SFP session access.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694, PXIe-5830/5831/5832/5840/5841/5842/5860\n\n----\n**Note**\nNI-RFSA does not support NI-TClk when driver session debugging is enabled.\n\n----', + 'description': 'Enables or disables SFP session access for the specified instrument.\n\nSFP session access allows the NI-RFSA Soft Front Panel (SFP) to access a device with an existing open session and can help you debug your code. To enable session access, pass VI_TRUE to the **enabled** parameter. To disable session access, pass VI_FALSE to the **enabled** parameter.\n\nRefer to `Configuring SFP Session Access using LabWindows/CVI or C `_ for more information about SFP session access.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694, PXIe-5830/5831/5832/5840/5841/5842/5860\n\n----\n**Note**\nNI-RFSA does not support NI-TClk when driver session debugging is enabled.\n\n----' }, 'included_in_proto': True, 'is_error_handling': False, @@ -1264,7 +1380,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -1274,7 +1390,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Enables or disables SFP session access for the specified device.\n\n| Value | Description |\n|:---------|:-------------------------|\n| VI_TRUE | Enables session access. |\n| VI_FALSE | Disables session access. |', + 'description': 'Enables or disables SFP session access for the specified device.\n\n| Value | Description |\n|:---------|:-------------------------|\n| VI_TRUE | Enables session access. |\n| VI_FALSE | Disables session access. |' }, 'name': 'enable', 'type': 'ViBoolean', @@ -1288,7 +1404,7 @@ 'ErrorMessage': { 'codegen_method': 'public', 'documentation': { - 'description': 'Converts an error code returned by an NI-RFSA function into a user-readable string.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5840', + 'description': 'Converts an error code returned by an NI-RFSA function into a user-readable string.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5840' }, 'included_in_proto': True, 'is_error_handling': True, @@ -1304,7 +1420,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'The ViSession handle that you obtain from nirfsa_Init or nirfsa_InitWithOptions. The handle identifies a particular instrument session.\n\nYou can pass VI_NULL for this parameter. Passing VI_NULL is useful when nirfsa_Init or nirfsa_InitWithOptions fails.', + 'description': 'The ViSession handle that you obtain from nirfsa_Init or nirfsa_InitWithOptions. The handle identifies a particular instrument session.\n\nYou can pass VI_NULL for this parameter. Passing VI_NULL is useful when nirfsa_Init or nirfsa_InitWithOptions fails.' }, 'name': 'vi', 'type': 'ViSession', @@ -1314,10 +1430,11 @@ { 'direction': 'in', 'documentation': { - 'description': 'Passes the **errorCode** parameter that is returned from any NI-RFSA function.', + 'description': 'Passes the **errorCode** parameter that is returned from any NI-RFSA function.' }, 'grpc_name': 'status_code', - 'name': 'errorCode', + 'name': 'statusCode', + 'python_name': 'error_code', 'type': 'ViStatus', 'use_array': False, 'use_in_python_api': True @@ -1325,7 +1442,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the user-readable message string that corresponds to the error code you specify.\n\nYou must pass a ViChar array with 1024 bytes or more to this parameter. Only the first 1024 bytes of the array are used.', + 'description': 'Returns the user-readable message string that corresponds to the error code you specify.\n\nYou must pass a ViChar array with 1024 bytes or more to this parameter. Only the first 1024 bytes of the array are used.' }, 'name': 'errorMessage', 'size': { @@ -1340,25 +1457,26 @@ 'returns': 'ViStatus', 'use_session_lock': False }, - 'CreateDeembeddingSparameterTableArray': { - 'codegen_method': 'private', + 'FancyCreateDeembeddingSparameterTableArray': { + 'codegen_method': 'python-only', 'documentation': { - 'description': '\nCreates an s-parameter de-embedding table for the port from the input data.\n\nIf you only create one table for a port, NI-RFSA 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 `_', + 'description': '\nCreates an s-parameter de-embedding table for the port from the input data.\n\nIf you only create one table for a port, NI-RFSA 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`_' }, 'included_in_proto': True, + 'method_name_for_documentation': 'create_deembedding_sparameter_table_array', 'method_templates': [ { - 'documentation_filename': 'numpy_method', - 'library_interpreter_filename': 'numpy_write_method', + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'none', 'method_python_name_suffix': '', - 'session_filename': 'numpy_write_method' + 'session_filename': 'create_deembedding_sparameter_table_array' } ], 'parameters': [ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.', + 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.' }, 'name': 'vi', 'type': 'ViSession', @@ -1368,7 +1486,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842/5860 is "" (empty string).', + 'description': 'Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842/5860 is "" (empty string).' }, 'name': 'port', 'type': 'ViConstString', @@ -1378,7 +1496,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the name of the table. The name must be unique for a given port, but not across ports. If you use the same name as an existing table, the table is replaced.', + 'description': 'Specifies the name of the table. The name must be unique for a given port, but not across ports. If you use the same name as an existing table, the table is replaced.' }, 'name': 'tableName', 'type': 'ViConstString', @@ -1388,158 +1506,25 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the frequencies for the NIRFSA_ATTR_SPARAMETER_TABLE rows. Frequencies must be unique and in ascending order.', + 'description': 'Specifies the frequencies for the NIRFSA_ATTR_SPARAMETER_TABLE rows. Frequencies must be unique and in ascending order.' }, 'name': 'frequencies', 'numpy': True, - 'size': { - 'mechanism': 'len', - 'value': 'frequenciesSize' - }, 'type': 'ViReal64[]', + 'type_in_documentation': 'numpy.array(dtype=numpy.float64)', 'use_in_python_api': True }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Specifies the size of the frequency array.', - }, - 'name': 'frequenciesSize', - 'type': 'ViInt32', - 'use_array': False - }, { 'array_dimensions': 3, 'complex_array_representation': 'complex_number_array', 'direction': 'in', 'documentation': { - 'description': 'Specifies the S-parameters for each frequency. S-parameters for each frequency are placed in the array in the following order: s11, s12, s21, s22.', + 'description': 'Specifies the S-parameters for each frequency. S-parameters for each frequency are placed in the array in the following order: s11, s12, s21, s22.' }, 'name': 'sparameterTable', 'numpy': True, - 'size': { - 'mechanism': 'len', - 'value': 'sparameterTableSize' - }, 'type': 'NIComplexNumber[]', - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Specifies the size of the S-parameter table array.', - }, - 'name': 'sparameterTableSize', - 'type': 'ViInt32', - 'use_array': False, - 'use_in_python_api': False - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Specifies the number of DUT ports.', - }, - 'name': 'numberOfPorts', - 'type': 'ViInt32', - 'use_array': False, - 'use_in_python_api': False - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Specifies the orientation of the input data relative to the port on the DUT port.\n\n**Defined Values** :', - 'table_body': [ - [ - 'NIRFSA_VAL_PORT1_TOWARDS_DUT', - 'Port 1 of the S2P is oriented towards the DUT port.' - ], - [ - 'NIRFSA_VAL_PORT2_TOWARDS_DUT', - 'Port 2 of the S2P is oriented towards the DUT port.' - ] - ], - 'table_header': [ - 'Name', - 'Description' - ] - }, - 'enum': 'SparameterOrientation', - 'name': 'sparameterOrientation', - 'type': 'ViInt32', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'returns': 'ViStatus' - }, - 'FancyCreateDeembeddingSparameterTableArray': { - 'codegen_method': 'python-only', - 'documentation': { - 'description': '\nCreates an s-parameter de-embedding table for the port from the input data.\n\nIf you only create one table for a port, NI-RFSA 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`_', - }, - 'included_in_proto': True, - 'method_name_for_documentation': 'create_deembedding_sparameter_table_array', - 'method_templates': [ - { - 'documentation_filename': 'default_method', - 'library_interpreter_filename': 'none', - 'method_python_name_suffix': '', - 'session_filename': 'create_deembedding_sparameter_table_array' - } - ], - 'parameters': [ - { - 'direction': 'in', - 'documentation': { - 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.', - }, - 'name': 'vi', - 'type': 'ViSession', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Specifies the name of the port. The only valid value for the PXIe-5840/5841/5842/5860 is "" (empty string).', - }, - 'name': 'port', - 'type': 'ViConstString', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Specifies the name of the table. The name must be unique for a given port, but not across ports. If you use the same name as an existing table, the table is replaced.', - }, - 'name': 'tableName', - 'type': 'ViConstString', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Specifies the frequencies for the NIRFSA_ATTR_SPARAMETER_TABLE rows. Frequencies must be unique and in ascending order.', - }, - 'name': 'frequencies', - 'numpy': True, - 'type': 'ViReal64[]', - 'type_in_documentation': 'numpy.array(dtype=numpy.float64)', - 'use_in_python_api': True - }, - { - 'array_dimensions': 3, - 'complex_array_representation': 'complex_number_array', - 'direction': 'in', - 'documentation': { - 'description': 'Specifies the S-parameters for each frequency. S-parameters for each frequency are placed in the array in the following order: s11, s12, s21, s22.', - }, - 'name': 'sparameterTable', - 'numpy': True, - 'type': 'NIComplexNumber[]', - 'type_in_documentation': 'numpy.array(dtype=numpy.complex128)', + 'type_in_documentation': 'numpy.array(dtype=numpy.complex128)', 'use_in_python_api': True }, { @@ -1573,111 +1558,6 @@ 'returns': 'ViStatus', 'use_session_lock': False }, - 'GetDeembeddingSparameters': { - 'codegen_method': 'private', - 'documentation': { - 'description': '\nReturns the S-parameters used for de-embedding a measurement on the selected port.\n\nThis includes interpolation of the parameters based on the configured carrier frequency. This function returns an empty array if no de-embedding is done.\n\nIf you want to call this function just to get the required buffer size, you can pass 0 for **S-parameter Size** and VI_NULL for the **S-parameters** buffer.\n\n**Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860', - 'note': 'The port orientation for the returned S-parameters is normalized to NIRFSA_VAL_PORT1_TOWARDS_DUT.' - }, - 'included_in_proto': True, - 'method_templates': [ - { - 'documentation_filename': 'numpy_method', - 'library_interpreter_filename': 'get_deembedding_sparameter', - 'method_python_name_suffix': '', - 'session_filename': 'none' - } - ], - 'parameters': [ - { - 'direction': 'in', - 'documentation': { - 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.', - }, - 'name': 'vi', - 'type': 'ViSession', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'array_dimensions': 2, - 'complex_array_representation': 'complex_number_array', - 'direction': 'out', - 'documentation': { - 'description': 'Returns an array of S-parameters. The S-parameters are returned in the following order: s11, s12, s21, s22.', - }, - 'name': 'sparameters', - 'numpy': True, - 'type': 'NIComplexNumber[]', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Specifies the size of the array that is returned by the NIRFSA_ATTR_SPARAMETERS output.', - }, - 'name': 'sparametersArraySize', - 'type': 'ViInt32', - 'use_array': False - }, - { - 'direction': 'out', - 'documentation': { - 'description': 'Returns the number of S-parameters.', - }, - 'name': 'numberOfSparameters', - 'type': 'ViInt32', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'out', - 'documentation': { - 'description': 'Returns the number of S-parameter ports. The **sparameter** array is always *n* x *n*, where span *n* is the number of ports.', - }, - 'name': 'numberOfPorts', - 'type': 'ViInt32', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'returns': 'ViStatus' - }, - 'GetDeembeddingTableNumberOfPorts': { - 'codegen_method': 'private', - 'documentation': { - 'description': '\nReturns the number of S-parameter ports.', - }, - 'included_in_proto': True, - 'method_templates': [ - { - 'documentation_filename': 'default_method', - 'library_interpreter_filename': 'default_method', - 'method_python_name_suffix': '', - 'session_filename': 'none' - } - ], - 'parameters': [ - { - 'direction': 'in', - 'documentation': { - 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.', - }, - 'name': 'vi', - 'type': 'ViSession' - }, - { - 'direction': 'out', - 'documentation': { - 'description': 'Returns the number of S-parameter ports. The **sparameter** array is always *n* x *n*, where span *n* is the number of ports.', - }, - 'name': 'numberOfPorts', - 'type': 'ViInt32' - } - ], - 'returns': 'ViStatus' - }, 'FancyGetDeembeddingSparameters': { 'codegen_method': 'python-only', 'documentation': { @@ -1698,7 +1578,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.', + 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.' }, 'name': 'vi', 'type': 'ViSession', @@ -1710,7 +1590,7 @@ 'complex_array_representation': 'complex_number_array', 'direction': 'out', 'documentation': { - 'description': 'Returns an array of S-parameters. The S-parameters are returned in the following order: s11, s12, s21, s22.', + 'description': 'Returns an array of S-parameters. The S-parameters are returned in the following order: s11, s12, s21, s22.' }, 'name': 'sparameters', 'numpy': True, @@ -1724,192 +1604,13 @@ 'returns': None, 'use_session_lock': False }, - 'ReadIqSingleRecordDispatcher': { - 'codegen_method': 'python-only', - 'documentation': { - 'description': 'Initiates an acquisition and fetches a single I/Q data record.\n\nDo not use this function if you have configured the device to continuously acquire data samples or to acquire multiple records.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_', - }, - 'included_in_proto': False, - 'is_error_handling': False, - 'method_name_for_documentation': 'read_iq_single_record', - 'method_templates': [ - { - 'documentation_filename': 'default_method', - 'library_interpreter_filename': 'none', - 'method_python_name_suffix': '_into', - 'session_filename': 'read_iq_single_record' - } - ], - 'parameters': [ - { - 'direction': 'in', - 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', - }, - 'name': 'vi', - 'type': 'ViSession', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', - }, - 'is_repeated_capability': True, - 'repeated_capability_type': 'channels', - 'name': 'channelList', - 'type': 'ViConstString', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Specifies in seconds the time allotted for the function to complete before returning a timeout error. A value of specifies the function waits until all data is available.', - }, - 'default_value': 'hightime.timedelta(seconds=10.0)', - 'name': 'timeout', - 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', - 'type': 'ViReal64', - 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds', - 'use_array': False, - 'use_in_python_api': True, - }, - { - 'complex_array_representation': 'complex_number_array', - 'direction': 'in', - 'documentation': { - 'description': 'Returns the acquired waveform. Allocate an NIComplexNumber array at least as large as the number of samples configured in the nirfsa_ConfigureNumberOfSamples function.', - }, - 'name': 'iq_data_array', - 'numpy': True, - 'size': {'mechanism': 'fixed', 'value': 1}, - 'type': 'NIComplexNumber[]', - 'type_in_documentation': 'numpy array of numpy.complex64, numpy array of numpy.complex128 or interleaved complex data in the form of numpy array of numpy.int16', - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Specifies the size of the array for the NIRFSA_ATTR_DATA parameter. The array needs to be at least as large as the number of samples configured in the nirfsa_ConfigureNumberOfSamples function.', - }, - 'name': 'dataArraySize', - 'size': {'mechanism': 'python-code', 'value': '0 if iq_data_array is None else len(iq_data_array)'}, - 'type': 'ViInt64', - 'use_array': False, - 'use_in_python_api': False - }, - { - 'direction': 'out', - 'documentation': { - 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5830/5831/5832/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.', - }, - 'name': 'wfmInfo', - 'type': 'niRFSA_wfmInfo', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'python_name': 'read_iq_single_record', - 'returns': 'ViStatus', - 'use_session_lock': False - }, - 'ReadIQSingleRecordComplexF64': { - 'codegen_method': 'private', - 'documentation': { - 'description': 'Initiates an acquisition and fetches a single I/Q data record.\n\nDo not use this function if you have configured the device to continuously acquire data samples or to acquire multiple records.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_', - }, - 'grpc_name': 'ReadIQSingleRecordComplexF64', - 'included_in_proto': True, - 'is_error_handling': False, - 'method_templates': [ - { - 'documentation_filename': 'numpy_method', - 'library_interpreter_filename': 'numpy_read_method', - 'method_python_name_suffix': '', - 'session_filename': 'numpy_read_method' - } - ], - 'parameters': [ - { - 'direction': 'in', - 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', - }, - 'name': 'vi', - 'type': 'ViSession', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', - }, - 'name': 'channelList', - 'is_repeated_capability': True, - 'repeated_capability_type': 'channels', - 'type': 'ViConstString', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Specifies in seconds the time allotted for the function to complete before returning a timeout error. A value of specifies the function waits until all data is available.', - }, - 'default_value': 'hightime.timedelta(seconds=10.0)', - 'name': 'timeout', - 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', - 'type': 'ViReal64', - 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds', - 'use_array': False, - 'use_in_python_api': True, - }, - { - 'complex_array_representation': 'complex_number_array', - 'direction': 'in', - 'documentation': { - 'description': 'Returns the acquired waveform. Allocate an NIComplexNumber array at least as large as the number of samples configured in the nirfsa_ConfigureNumberOfSamples function.', - }, - 'name': 'iq_data_array', - 'numpy': True, - 'size': {'mechanism': 'fixed', 'value': 1}, - 'type': 'NIComplexNumber[]', - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Specifies the size of the array for the NIRFSA_ATTR_DATA parameter. The array needs to be at least as large as the number of samples configured in the nirfsa_ConfigureNumberOfSamples function.', - }, - 'name': 'dataArraySize', - 'size': {'mechanism': 'python-code', 'value': '0 if iq_data_array is None else len(iq_data_array)'}, - 'type': 'ViInt64', - 'use_array': False, - 'use_in_python_api': False - }, - { - 'direction': 'out', - 'documentation': { - 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5830/5831/5832/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.', - }, - 'name': 'wfmInfo', - 'type': 'niRFSA_wfmInfo', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'returns': 'ViStatus', - 'use_session_lock': True - }, 'FetchIQMultiRecordComplexF32': { 'codegen_method': 'private', 'documentation': { - 'description': 'Fetches I/Q data from multiple records in an acquisition.\n\nA fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function is not necessary if you use the read IQ single record complex F64 function because the read IQ single record complex F64 function performs the fetch as part of the function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_', + 'description': 'Fetches I/Q data from multiple records in an acquisition.\n\nA fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function is not necessary if you use the read IQ single record complex F64 function because the read IQ single record complex F64 function performs the fetch as part of the function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_' }, 'grpc_name': 'FetchIQMultiRecordComplexF32', + 'has_repeated_capability': True, 'included_in_proto': True, 'method_name_for_documentation': 'fetch_iq_multi_record', 'method_templates': [ @@ -1924,7 +1625,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -1934,11 +1635,11 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.' }, 'is_repeated_capability': True, - 'repeated_capability_type': 'channels', 'name': 'channelList', + 'repeated_capability_type': 'channels', 'type': 'ViConstString', 'use_array': False, 'use_in_python_api': True @@ -1946,7 +1647,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the first record to retrieve. Record numbers are zero-based. The default value is 0.', + 'description': 'Specifies the first record to retrieve. Record numbers are zero-based. The default value is 0.' }, 'name': 'startingRecord', 'type': 'ViInt64', @@ -1956,7 +1657,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the number of records to fetch.', + 'description': 'Specifies the number of records to fetch.' }, 'name': 'numberOfRecords', 'type': 'ViInt64', @@ -1966,7 +1667,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the number of samples per record.', + 'description': 'Specifies the number of samples per record.' }, 'name': 'numberOfSamples', 'type': 'ViInt64', @@ -1974,11 +1675,11 @@ 'use_in_python_api': True }, { + 'default_value': 'hightime.timedelta(seconds=10.0)', 'direction': 'in', 'documentation': { - 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----', + 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----' }, - 'default_value': 'hightime.timedelta(seconds=10.0)', 'name': 'timeout', 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', 'type': 'ViReal64', @@ -1990,18 +1691,23 @@ 'complex_array_representation': 'complex_number_array', 'direction': 'in', 'documentation': { - 'description': 'Specifies a pre-allocated 2D numpy array of shape (number_of_records, number_of_samples) to be filled with the acquired I/Q waveforms. Each row corresponds to one record. The real and imaginary parts of this complex data array correspond to the in-phase (I) and quadrature-phase (Q) data, respectively.', + 'description': 'Specifies a pre-allocated 2D numpy array of shape (number_of_records, number_of_samples) to be filled with the acquired I/Q waveforms. Each row corresponds to one record. The real and imaginary parts of this complex data array correspond to the in-phase (I) and quadrature-phase (Q) data, respectively.' }, - 'name': 'iq_data_arrays', + 'grpc_name': 'data', + 'name': 'data', 'numpy': True, - 'size': {'mechanism': 'passed-in', 'value': 'numberOfSamples'}, + 'python_name': 'iq_data_arrays', + 'size': { + 'mechanism': 'passed-in', + 'value': 'numberOfSamples' + }, 'type': 'NIComplexNumberF32[]', 'use_in_python_api': True }, { 'direction': 'out', 'documentation': { - 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read. Each element of this array corresponds to a record.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.The actual number of samples for each record can vary if the NIRFSA ATTR NUMBER OF SAMPLES attribute changes per step during RF list mode.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.', + 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read. Each element of this array corresponds to a record.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.The actual number of samples for each record can vary if the NIRFSA ATTR NUMBER OF SAMPLES attribute changes per step during RF list mode.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.' }, 'name': 'wfmInfo', 'type': 'niRFSA_wfmInfo', @@ -2009,15 +1715,17 @@ 'use_in_python_api': True } ], + 'repeated_capability_type': 'channels', 'returns': 'ViStatus', 'use_session_lock': True }, 'FetchIQMultiRecordComplexF64': { 'codegen_method': 'private', 'documentation': { - 'description': 'Fetches I/Q data from multiple records in an acquisition.\n\nA fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function is not necessary if you use the read IQ single record complex F64 function because the read IQ single record complex F64 function performs the fetch as part of the function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_', + 'description': 'Fetches I/Q data from multiple records in an acquisition.\n\nA fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function is not necessary if you use the read IQ single record complex F64 function because the read IQ single record complex F64 function performs the fetch as part of the function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_' }, 'grpc_name': 'FetchIQMultiRecordComplexF64', + 'has_repeated_capability': True, 'included_in_proto': True, 'is_error_handling': False, 'method_name_for_documentation': 'fetch_iq_multi_record', @@ -2033,7 +1741,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -2043,11 +1751,11 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.' }, 'is_repeated_capability': True, - 'repeated_capability_type': 'channels', 'name': 'channelList', + 'repeated_capability_type': 'channels', 'type': 'ViConstString', 'use_array': False, 'use_in_python_api': True @@ -2055,7 +1763,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the first record to retrieve. Record numbers are zero-based. The default value is 0.', + 'description': 'Specifies the first record to retrieve. Record numbers are zero-based. The default value is 0.' }, 'name': 'startingRecord', 'type': 'ViInt64', @@ -2065,7 +1773,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the number of records to fetch.', + 'description': 'Specifies the number of records to fetch.' }, 'name': 'numberOfRecords', 'type': 'ViInt64', @@ -2075,7 +1783,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the number of samples per record.', + 'description': 'Specifies the number of samples per record.' }, 'name': 'numberOfSamples', 'type': 'ViInt64', @@ -2083,11 +1791,11 @@ 'use_in_python_api': True }, { + 'default_value': 'hightime.timedelta(seconds=10.0)', 'direction': 'in', 'documentation': { - 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----', + 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----' }, - 'default_value': 'hightime.timedelta(seconds=10.0)', 'name': 'timeout', 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', 'type': 'ViReal64', @@ -2099,18 +1807,23 @@ 'complex_array_representation': 'complex_number_array', 'direction': 'in', 'documentation': { - 'description': 'Specifies a pre-allocated 2D numpy array of shape (number_of_records, number_of_samples) to be filled with the acquired I/Q waveforms. Each row corresponds to one record. The real and imaginary parts of this complex data array correspond to the in-phase (I) and quadrature-phase (Q) data, respectively.', + 'description': 'Specifies a pre-allocated 2D numpy array of shape (number_of_records, number_of_samples) to be filled with the acquired I/Q waveforms. Each row corresponds to one record. The real and imaginary parts of this complex data array correspond to the in-phase (I) and quadrature-phase (Q) data, respectively.' }, - 'name': 'iq_data_arrays', + 'grpc_name': 'data', + 'name': 'data', 'numpy': True, - 'size': {'mechanism': 'passed-in', 'value': 'numberOfSamples'}, + 'python_name': 'iq_data_arrays', + 'size': { + 'mechanism': 'passed-in', + 'value': 'numberOfSamples' + }, 'type': 'NIComplexNumber[]', 'use_in_python_api': True }, { 'direction': 'out', 'documentation': { - 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read. Each element of this array corresponds to a record.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.The actual number of samples for each record can vary if the NIRFSA ATTR NUMBER OF SAMPLES attribute changes per step during RF list mode.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.', + 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read. Each element of this array corresponds to a record.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.The actual number of samples for each record can vary if the NIRFSA ATTR NUMBER OF SAMPLES attribute changes per step during RF list mode.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.' }, 'name': 'wfmInfo', 'type': 'niRFSA_wfmInfo', @@ -2118,15 +1831,17 @@ 'use_in_python_api': True } ], + 'repeated_capability_type': 'channels', 'returns': 'ViStatus', 'use_session_lock': True }, 'FetchIQMultiRecordComplexI16': { 'codegen_method': 'private', 'documentation': { - 'description': 'Fetches binary I/Q data from multiple records in an acquisition.\n\nFetching transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function is not necessary if you use the read IQ single record complex F64 function because the read IQ single record complex F64 function performs the fetch as part of the function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_', + 'description': 'Fetches binary I/Q data from multiple records in an acquisition.\n\nFetching transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function is not necessary if you use the read IQ single record complex F64 function because the read IQ single record complex F64 function performs the fetch as part of the function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_' }, 'grpc_name': 'FetchIQMultiRecordComplexI16', + 'has_repeated_capability': True, 'included_in_proto': True, 'is_error_handling': False, 'method_name_for_documentation': 'fetch_iq_multi_record', @@ -2142,7 +1857,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -2152,11 +1867,11 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.' }, 'is_repeated_capability': True, - 'repeated_capability_type': 'channels', 'name': 'channelList', + 'repeated_capability_type': 'channels', 'type': 'ViConstString', 'use_array': False, 'use_in_python_api': True @@ -2164,7 +1879,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the first record to retrieve. Record numbers are zero-based. The default value is 0.', + 'description': 'Specifies the first record to retrieve. Record numbers are zero-based. The default value is 0.' }, 'name': 'startingRecord', 'type': 'ViInt64', @@ -2174,7 +1889,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the number of records to fetch.', + 'description': 'Specifies the number of records to fetch.' }, 'name': 'numberOfRecords', 'type': 'ViInt64', @@ -2184,7 +1899,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the number of samples per record.', + 'description': 'Specifies the number of samples per record.' }, 'name': 'numberOfSamples', 'type': 'ViInt64', @@ -2192,11 +1907,11 @@ 'use_in_python_api': True }, { + 'default_value': 'hightime.timedelta(seconds=10.0)', 'direction': 'in', 'documentation': { - 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----', + 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----' }, - 'default_value': 'hightime.timedelta(seconds=10.0)', 'name': 'timeout', 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', 'type': 'ViReal64', @@ -2208,18 +1923,23 @@ 'complex_array_representation': 'interleaved_real_number_array', 'direction': 'in', 'documentation': { - 'description': 'Specifies a pre-allocated 2D numpy array of shape (number_of_records, number_of_samples) to be filled with the acquired I/Q waveforms. Each row corresponds to one record. The real and imaginary parts of this interleaved data array correspond to the in-phase (I) and quadrature-phase (Q) data, respectively.', + 'description': 'Specifies a pre-allocated 2D numpy array of shape (number_of_records, number_of_samples) to be filled with the acquired I/Q waveforms. Each row corresponds to one record. The real and imaginary parts of this interleaved data array correspond to the in-phase (I) and quadrature-phase (Q) data, respectively.' }, - 'name': 'iq_data_arrays', + 'grpc_name': 'data', + 'name': 'data', 'numpy': True, - 'size': {'mechanism': 'passed-in', 'value': 'numberOfSamples'}, + 'python_name': 'iq_data_arrays', + 'size': { + 'mechanism': 'passed-in', + 'value': 'numberOfSamples' + }, 'type': 'NIComplexI16[]', 'use_in_python_api': True }, { 'direction': 'out', 'documentation': { - 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read. Each element of this array corresponds to a record.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5830/5831/5832/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.The actual number of samples for each record can vary if the NIRFSA ATTR NUMBER OF SAMPLES attribute changes per step during RF list mode.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.', + 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read. Each element of this array corresponds to a record.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5830/5831/5832/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.The actual number of samples for each record can vary if the NIRFSA ATTR NUMBER OF SAMPLES attribute changes per step during RF list mode.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.' }, 'name': 'wfmInfo', 'type': 'niRFSA_wfmInfo', @@ -2227,14 +1947,16 @@ 'use_in_python_api': True } ], + 'repeated_capability_type': 'channels', 'returns': 'ViStatus', 'use_session_lock': True }, - 'FetchIqMultiRecordDispatcher': { + 'FetchIQMultiRecordDispatcher': { 'codegen_method': 'python-only', 'documentation': { - 'description': 'Fetches I/Q data from multiple records in an acquisition.\n\nA fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function accepts a data_type parameter to specify the desired data format: numpy.complex64, numpy.complex128, or numpy.int16.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_', + 'description': 'Fetches I/Q data from multiple records in an acquisition.\n\nA fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function accepts a data_type parameter to specify the desired data format: numpy.complex64, numpy.complex128, or numpy.int16.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_' }, + 'has_repeated_capability': True, 'included_in_proto': False, 'is_error_handling': False, 'method_name_for_documentation': 'fetch_iq_multi_record', @@ -2250,7 +1972,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -2260,11 +1982,11 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.' }, 'is_repeated_capability': True, - 'repeated_capability_type': 'channels', 'name': 'channelList', + 'repeated_capability_type': 'channels', 'type': 'ViConstString', 'use_array': False, 'use_in_python_api': True @@ -2273,7 +1995,7 @@ 'default_value': 0, 'direction': 'in', 'documentation': { - 'description': 'Specifies the first record to retrieve. Record numbers are zero-based. The default value is 0.', + 'description': 'Specifies the first record to retrieve. Record numbers are zero-based. The default value is 0.' }, 'name': 'startingRecord', 'type': 'ViInt64', @@ -2284,7 +2006,7 @@ 'default_value': None, 'direction': 'in', 'documentation': { - 'description': 'Specifies the number of records to fetch.', + 'description': 'Specifies the number of records to fetch.' }, 'name': 'numberOfRecords', 'type': 'ViInt64', @@ -2295,7 +2017,7 @@ 'default_value': None, 'direction': 'in', 'documentation': { - 'description': 'Specifies the number of samples per record.', + 'description': 'Specifies the number of samples per record.' }, 'name': 'numberOfSamples', 'type': 'ViInt64', @@ -2306,7 +2028,7 @@ 'complex_array_representation': 'complex_number_array', 'direction': 'in', 'documentation': { - 'description': 'Specifies a pre-allocated 2D numpy array of shape (number_of_records, number_of_samples) to be filled with the acquired I/Q data. Each row corresponds to one record. The real and imaginary parts of this complex data array correspond to the in-phase (I) and quadrature-phase (Q) data, respectively.', + 'description': 'Specifies a pre-allocated 2D numpy array of shape (number_of_records, number_of_samples) to be filled with the acquired I/Q data. Each row corresponds to one record. The real and imaginary parts of this complex data array correspond to the in-phase (I) and quadrature-phase (Q) data, respectively.' }, 'name': 'iq_data_arrays', 'numpy': True, @@ -2318,7 +2040,7 @@ 'default_value': 'hightime.timedelta(seconds=10.0)', 'direction': 'in', 'documentation': { - 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----', + 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----' }, 'name': 'timeout', 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', @@ -2329,15 +2051,17 @@ } ], 'python_name': 'fetch_iq_multi_record', + 'repeated_capability_type': 'channels', 'returns': 'ViStatus', 'use_session_lock': False }, 'FetchIQSingleRecordComplexF32': { 'codegen_method': 'private', 'documentation': { - 'description': 'Fetches I/Q data from a single record in an acquisition.\n\nThe fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function is not necessary if you use the read IQ single record complex F64 function because the read IQ single record complex F64 function performs the fetch as part of the function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_', + 'description': 'Fetches I/Q data from a single record in an acquisition.\n\nThe fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function is not necessary if you use the read IQ single record complex F64 function because the read IQ single record complex F64 function performs the fetch as part of the function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_' }, 'grpc_name': 'FetchIQSingleRecordComplexF32', + 'has_repeated_capability': True, 'included_in_proto': True, 'is_error_handling': False, 'method_name_for_documentation': 'fetch_iq_single_record', @@ -2353,7 +2077,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -2363,11 +2087,11 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.' }, 'is_repeated_capability': True, - 'repeated_capability_type': 'channels', 'name': 'channelList', + 'repeated_capability_type': 'channels', 'type': 'ViConstString', 'use_array': False, 'use_in_python_api': True @@ -2375,7 +2099,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the record to retrieve. Record numbers are zero-based.', + 'description': 'Specifies the record to retrieve. Record numbers are zero-based.' }, 'name': 'recordNumber', 'type': 'ViInt64', @@ -2385,7 +2109,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the number of samples to fetch. The value must specify the array size of the NIRFSA_ATTR_DATA parameter.', + 'description': 'Specifies the number of samples to fetch. The value must specify the array size of the NIRFSA_ATTR_DATA parameter.' }, 'name': 'numberOfSamples', 'type': 'ViInt64', @@ -2393,11 +2117,11 @@ 'use_in_python_api': True }, { + 'default_value': 'hightime.timedelta(seconds=10.0)', 'direction': 'in', 'documentation': { - 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----', + 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----' }, - 'default_value': 'hightime.timedelta(seconds=10.0)', 'name': 'timeout', 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', 'type': 'ViReal64', @@ -2409,18 +2133,23 @@ 'complex_array_representation': 'complex_number_array', 'direction': 'in', 'documentation': { - 'description': 'Returns the acquired waveform. Allocate an NIComplexNumberF32 array at least as large as **NIRFSA_ATTR_NUMBER_OF_SAMPLES**.', + 'description': 'Returns the acquired waveform. Allocate an NIComplexNumberF32 array at least as large as **NIRFSA_ATTR_NUMBER_OF_SAMPLES**.' }, - 'name': 'iq_data_array', + 'grpc_name': 'data', + 'name': 'data', 'numpy': True, - 'size': {'mechanism': 'passed-in', 'value': 'numberOfSamples'}, + 'python_name': 'iq_data_array', + 'size': { + 'mechanism': 'passed-in', + 'value': 'numberOfSamples' + }, 'type': 'NIComplexNumberF32[]', 'use_in_python_api': True }, { 'direction': 'out', 'documentation': { - 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5830/5831/5832/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.', + 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5830/5831/5832/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.' }, 'name': 'wfmInfo', 'type': 'niRFSA_wfmInfo', @@ -2428,15 +2157,17 @@ 'use_in_python_api': True } ], + 'repeated_capability_type': 'channels', 'returns': 'ViStatus', 'use_session_lock': True }, 'FetchIQSingleRecordComplexF64': { 'codegen_method': 'private', 'documentation': { - 'description': 'Fetches I/Q data from a single record in an acquisition.\n\nThe fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function is not necessary if you use the read IQ single record complex F64 function because the read IQ single record complex F64 function performs the fetch as part of the function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_', + 'description': 'Fetches I/Q data from a single record in an acquisition.\n\nThe fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function is not necessary if you use the read IQ single record complex F64 function because the read IQ single record complex F64 function performs the fetch as part of the function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_' }, 'grpc_name': 'FetchIQSingleRecordComplexF64', + 'has_repeated_capability': True, 'included_in_proto': True, 'is_error_handling': False, 'method_name_for_documentation': 'fetch_iq_single_record', @@ -2452,7 +2183,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -2462,11 +2193,11 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.' }, 'is_repeated_capability': True, - 'repeated_capability_type': 'channels', 'name': 'channelList', + 'repeated_capability_type': 'channels', 'type': 'ViConstString', 'use_array': False, 'use_in_python_api': True @@ -2474,7 +2205,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the record to retrieve. Record numbers are zero-based.', + 'description': 'Specifies the record to retrieve. Record numbers are zero-based.' }, 'name': 'recordNumber', 'type': 'ViInt64', @@ -2484,7 +2215,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the number of samples to fetch. The value must specify the array size of the NIRFSA_ATTR_DATA parameter.', + 'description': 'Specifies the number of samples to fetch. The value must specify the array size of the NIRFSA_ATTR_DATA parameter.' }, 'name': 'numberOfSamples', 'type': 'ViInt64', @@ -2492,11 +2223,11 @@ 'use_in_python_api': True }, { + 'default_value': 'hightime.timedelta(seconds=10.0)', 'direction': 'in', 'documentation': { - 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----', + 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----' }, - 'default_value': 'hightime.timedelta(seconds=10.0)', 'name': 'timeout', 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', 'type': 'ViReal64', @@ -2508,18 +2239,23 @@ 'complex_array_representation': 'complex_number_array', 'direction': 'in', 'documentation': { - 'description': 'Returns the acquired waveform. Allocate an NIComplexNumber array at least as large as **NIRFSA_ATTR_NUMBER_OF_SAMPLES**.', + 'description': 'Returns the acquired waveform. Allocate an NIComplexNumber array at least as large as **NIRFSA_ATTR_NUMBER_OF_SAMPLES**.' }, - 'name': 'iq_data_array', + 'grpc_name': 'data', + 'name': 'data', 'numpy': True, - 'size': {'mechanism': 'passed-in', 'value': 'numberOfSamples'}, + 'python_name': 'iq_data_array', + 'size': { + 'mechanism': 'passed-in', + 'value': 'numberOfSamples' + }, 'type': 'NIComplexNumber[]', 'use_in_python_api': True }, { 'direction': 'out', 'documentation': { - 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5830/5831/5832/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.', + 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5830/5831/5832/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.' }, 'name': 'wfmInfo', 'type': 'niRFSA_wfmInfo', @@ -2527,15 +2263,17 @@ 'use_in_python_api': True } ], + 'repeated_capability_type': 'channels', 'returns': 'ViStatus', 'use_session_lock': True }, 'FetchIQSingleRecordComplexI16': { 'codegen_method': 'private', 'documentation': { - 'description': 'Fetches binary I/Q data from a single record in an acquisition.\n\nThe fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function is not necessary if you use the read IQ single record complex F64 function because the read IQ single record complex F64 function performs the fetch as part of the function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_', + 'description': 'Fetches binary I/Q data from a single record in an acquisition.\n\nThe fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function is not necessary if you use the read IQ single record complex F64 function because the read IQ single record complex F64 function performs the fetch as part of the function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_' }, 'grpc_name': 'FetchIQSingleRecordComplexI16', + 'has_repeated_capability': True, 'included_in_proto': True, 'is_error_handling': False, 'method_name_for_documentation': 'fetch_iq_single_record', @@ -2551,7 +2289,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -2561,11 +2299,11 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.' }, 'is_repeated_capability': True, - 'repeated_capability_type': 'channels', 'name': 'channelList', + 'repeated_capability_type': 'channels', 'type': 'ViConstString', 'use_array': False, 'use_in_python_api': True @@ -2573,7 +2311,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the record to retrieve. Record numbers are zero-based.', + 'description': 'Specifies the record to retrieve. Record numbers are zero-based.' }, 'name': 'recordNumber', 'type': 'ViInt64', @@ -2583,7 +2321,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the number of samples to fetch. The value must specify the array size of the NIRFSA_ATTR_DATA parameter.', + 'description': 'Specifies the number of samples to fetch. The value must specify the array size of the NIRFSA_ATTR_DATA parameter.' }, 'name': 'numberOfSamples', 'type': 'ViInt64', @@ -2591,11 +2329,11 @@ 'use_in_python_api': True }, { + 'default_value': 'hightime.timedelta(seconds=10.0)', 'direction': 'in', 'documentation': { - 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----', + 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----' }, - 'default_value': 'hightime.timedelta(seconds=10.0)', 'name': 'timeout', 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', 'type': 'ViReal64', @@ -2607,11 +2345,16 @@ 'complex_array_representation': 'interleaved_real_number_array', 'direction': 'in', 'documentation': { - 'description': 'Returns the acquired waveform. Allocate an NIComplexI16 array at least as large as **NIRFSA_ATTR_NUMBER_OF_SAMPLES**.', + 'description': 'Returns the acquired waveform. Allocate an NIComplexI16 array at least as large as **NIRFSA_ATTR_NUMBER_OF_SAMPLES**.' }, - 'name': 'iq_data_array', + 'grpc_name': 'data', + 'name': 'data', 'numpy': True, - 'size': {'mechanism': 'passed-in', 'value': 'numberOfSamples'}, + 'python_name': 'iq_data_array', + 'size': { + 'mechanism': 'passed-in', + 'value': 'numberOfSamples' + }, 'type': 'NIComplexI16[]', 'use_array': True, 'use_in_python_api': True @@ -2619,7 +2362,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5830/5831/5832/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.', + 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5830/5831/5832/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.' }, 'name': 'wfmInfo', 'type': 'niRFSA_wfmInfo', @@ -2627,14 +2370,16 @@ 'use_in_python_api': True } ], + 'repeated_capability_type': 'channels', 'returns': 'ViStatus', 'use_session_lock': True }, - 'FetchIqSingleRecordDispatcher': { + 'FetchIQSingleRecordDispatcher': { 'codegen_method': 'python-only', 'documentation': { - 'description': 'Fetches I/Q data from a single record in an acquisition.\n\nThe fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function accepts a data_type parameter to specify the desired data format: numpy.complex64, numpy.complex128, or numpy.int16.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_', + 'description': 'Fetches I/Q data from a single record in an acquisition.\n\nThe fetch transfers acquired waveform data from device memory to computer memory. The data was acquired to onboard memory previously by the hardware after the acquisition was initiated.\n\nThis function accepts a data_type parameter to specify the desired data format: numpy.complex64, numpy.complex128, or numpy.int16.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_' }, + 'has_repeated_capability': True, 'included_in_proto': False, 'is_error_handling': False, 'method_name_for_documentation': 'fetch_iq_single_record', @@ -2650,7 +2395,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -2660,11 +2405,11 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.' }, 'is_repeated_capability': True, - 'repeated_capability_type': 'channels', 'name': 'channelList', + 'repeated_capability_type': 'channels', 'type': 'ViConstString', 'use_array': False, 'use_in_python_api': True @@ -2673,7 +2418,7 @@ 'default_value': 0, 'direction': 'in', 'documentation': { - 'description': 'Specifies the record to retrieve. Record numbers are zero-based.', + 'description': 'Specifies the record to retrieve. Record numbers are zero-based.' }, 'name': 'recordNumber', 'type': 'ViInt64', @@ -2684,7 +2429,7 @@ 'default_value': None, 'direction': 'in', 'documentation': { - 'description': 'Specifies the number of samples to fetch. The value must specify the array size of the NIRFSA_ATTR_DATA parameter.', + 'description': 'Specifies the number of samples to fetch. The value must specify the array size of the NIRFSA_ATTR_DATA parameter.' }, 'name': 'numberOfSamples', 'type': 'ViInt64', @@ -2695,7 +2440,7 @@ 'complex_array_representation': 'complex_number_array', 'direction': 'in', 'documentation': { - 'description': 'Specifies the pre-allocated numpy array to be filled with the acquired I/Q data. The real and imaginary parts of this complex data array correspond to the in-phase (I) and quadrature-phase (Q) data, respectively.', + 'description': 'Specifies the pre-allocated numpy array to be filled with the acquired I/Q data. The real and imaginary parts of this complex data array correspond to the in-phase (I) and quadrature-phase (Q) data, respectively.' }, 'name': 'iq_data_array', 'numpy': True, @@ -2707,7 +2452,7 @@ 'default_value': 'hightime.timedelta(seconds=10.0)', 'direction': 'in', 'documentation': { - 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----', + 'description': '**PXI-5661, PXIe-5663/5665/5667** Specifies the time, in seconds, allotted for the function to complete before returning a timeout error.\n\n**PXIe-5644/5645/5646, PXIe-5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860** Specifies the time, in seconds, allotted to receive the reference trigger.\n\n----\n\nFor all supported devices, a value of specifies the function waits until all data is available. A value of 0 specifies the function immediately returns available data.\n\n----' }, 'name': 'timeout', 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', @@ -2718,13 +2463,14 @@ } ], 'python_name': 'fetch_iq_single_record', + 'repeated_capability_type': 'channels', 'returns': 'ViStatus', 'use_session_lock': False }, 'GetAttributeViBoolean': { 'codegen_method': 'private', 'documentation': { - 'description': 'Queries the value of a ViBoolean attribute.\n\nYou can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + 'description': 'Queries the value of a ViBoolean attribute.\n\nYou can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'is_error_handling': False, @@ -2740,7 +2486,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -2750,7 +2496,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.' }, 'name': 'channelName', 'type': 'ViConstString', @@ -2760,7 +2506,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Pass the ID of an attribute.', + 'description': 'Pass the ID of an attribute.' }, 'name': 'attributeId', 'type': 'ViAttr', @@ -2770,7 +2516,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the current value of the attribute. Pass the address of a ViBoolean variable.', + 'description': 'Returns the current value of the attribute. Pass the address of a ViBoolean variable.' }, 'name': 'value', 'type': 'ViBoolean', @@ -2784,7 +2530,7 @@ 'GetAttributeViInt32': { 'codegen_method': 'private', 'documentation': { - 'description': 'Queries the value of a ViInt32 attribute.\n\nYou can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + 'description': 'Queries the value of a ViInt32 attribute.\n\nYou can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'is_error_handling': False, @@ -2800,7 +2546,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -2810,7 +2556,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.' }, 'name': 'channelName', 'type': 'ViConstString', @@ -2820,7 +2566,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Pass the ID of an attribute.', + 'description': 'Pass the ID of an attribute.' }, 'name': 'attributeId', 'type': 'ViAttr', @@ -2830,7 +2576,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the current value of the attribute. Pass the address of a ViInt32 variable.', + 'description': 'Returns the current value of the attribute. Pass the address of a ViInt32 variable.' }, 'name': 'value', 'type': 'ViInt32', @@ -2844,7 +2590,7 @@ 'GetAttributeViInt64': { 'codegen_method': 'private', 'documentation': { - 'description': 'Queries the value of a ViInt64 attribute.\n\nYou can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + 'description': 'Queries the value of a ViInt64 attribute.\n\nYou can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'is_error_handling': False, @@ -2860,7 +2606,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -2870,7 +2616,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.' }, 'name': 'channelName', 'type': 'ViConstString', @@ -2880,7 +2626,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Pass the ID of an attribute.', + 'description': 'Pass the ID of an attribute.' }, 'name': 'attributeId', 'type': 'ViAttr', @@ -2890,7 +2636,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the current value of the attribute. Pass the address of a ViInt64 variable.', + 'description': 'Returns the current value of the attribute. Pass the address of a ViInt64 variable.' }, 'name': 'value', 'type': 'ViInt64', @@ -2904,7 +2650,7 @@ 'GetAttributeViReal64': { 'codegen_method': 'private', 'documentation': { - 'description': 'Queries the value of a ViReal64 attribute.\n\nYou can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + 'description': 'Queries the value of a ViReal64 attribute.\n\nYou can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'is_error_handling': False, @@ -2920,7 +2666,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -2930,7 +2676,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.' }, 'name': 'channelName', 'type': 'ViConstString', @@ -2940,7 +2686,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Pass the ID of an attribute.', + 'description': 'Pass the ID of an attribute.' }, 'name': 'attributeId', 'type': 'ViAttr', @@ -2950,7 +2696,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the current value of the attribute. Pass the address of a ViReal64 variable.', + 'description': 'Returns the current value of the attribute. Pass the address of a ViReal64 variable.' }, 'name': 'value', 'type': 'ViReal64', @@ -2964,7 +2710,7 @@ 'GetAttributeViSession': { 'codegen_method': 'private', 'documentation': { - 'description': 'Queries the value of a ViSession attribute.\n\nYou can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698', + 'description': 'Queries the value of a ViSession attribute.\n\nYou can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698' }, 'included_in_proto': True, 'is_error_handling': False, @@ -2980,7 +2726,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -2990,7 +2736,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.' }, 'name': 'channelName', 'type': 'ViConstString', @@ -3000,7 +2746,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Pass the ID of an attribute.', + 'description': 'Pass the ID of an attribute.' }, 'name': 'attributeId', 'type': 'ViAttr', @@ -3010,7 +2756,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the current value of the attribute. Pass the address of a ViSession variable.', + 'description': 'Returns the current value of the attribute. Pass the address of a ViSession variable.' }, 'name': 'value', 'type': 'ViSession', @@ -3024,7 +2770,7 @@ 'GetAttributeViString': { 'codegen_method': 'private', 'documentation': { - 'description': 'Queries the value of a ViString attribute.\n\nYou can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.\n\nYou must provide a ViChar array to serve as a buffer for the value. You pass the number of bytes in the buffer as the **NIRFSA_ATTR_BUF_SIZE** parameter. If the current value of the attribute, including the terminating NULL byte, is larger than the size you indicate in the **NIRFSA_ATTR_BUF_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\nIf you want to call this function just to get the required buffer size, you can pass 0 for **NIRFSA_ATTR_BUF_SIZE** and VI_NULL for the **attributeValue** buffer.\n\n**Supported Devices:** PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + 'description': 'Queries the value of a ViString attribute.\n\nYou can use this low-level function to get the values of inherent IVI attributes and instrument-specific attributes.\n\nYou must provide a ViChar array to serve as a buffer for the value. You pass the number of bytes in the buffer as the **NIRFSA_ATTR_BUF_SIZE** parameter. If the current value of the attribute, including the terminating NULL byte, is larger than the size you indicate in the **NIRFSA_ATTR_BUF_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\nIf you want to call this function just to get the required buffer size, you can pass 0 for **NIRFSA_ATTR_BUF_SIZE** and VI_NULL for the **attributeValue** buffer.\n\n**Supported Devices:** PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'is_error_handling': False, @@ -3040,7 +2786,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -3050,7 +2796,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.' }, 'name': 'channelName', 'type': 'ViConstString', @@ -3060,7 +2806,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Pass the ID of an attribute.', + 'description': 'Pass the ID of an attribute.' }, 'name': 'attributeId', 'type': 'ViAttr', @@ -3070,7 +2816,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Pass the number of bytes in the ViChar buffer you specify for the attribute value parameter.\n\nIf you pass 0, you can pass VI_NULL for the attribute value buffer parameter.', + 'description': 'Pass the number of bytes in the ViChar buffer you specify for the attribute value parameter.\n\nIf you pass 0, you can pass VI_NULL for the attribute value buffer parameter.' }, 'name': 'bufSize', 'type': 'ViInt32', @@ -3080,7 +2826,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 **NIRFSA_ATTR_BUF_SIZE**.\n\nIf you specify 0 for the **NIRFSA_ATTR_BUF_SIZE** parameter, you can pass VI_NULL for this parameter.', + '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 **NIRFSA_ATTR_BUF_SIZE**.\n\nIf you specify 0 for the **NIRFSA_ATTR_BUF_SIZE** parameter, you can pass VI_NULL for this parameter.' }, 'name': 'value', 'size': { @@ -3095,17 +2841,17 @@ 'returns': 'ViStatus', 'use_session_lock': True }, - 'GetError': { - 'codegen_method': 'public', + 'GetDeembeddingSparameters': { + 'codegen_method': 'private', 'documentation': { - 'description': 'Retrieves and then clears the IVI error information for the session or the current execution thread.\n\n----\n**Note**\nIf the **NIRFSA_ATTR_ERROR_DESCRIPTION_BUFFER_SIZE** parameter is 0, this function does not clear the error information. By passing 0 to **NIRFSA_ATTR_ERROR_DESCRIPTION_BUFFER_SIZE**, you can determine the buffer size required to read the entire error description string. You can then call this function again with a sufficiently large buffer.\n\nIf you specify a valid IVI session for the NIRFSA_ATTR_VI parameter, this function retrieves and then clears the error information for the session. If you pass VI_NULL for NIRFSA_ATTR_VI, this function retrieves and then clears the error information for the current execution thread. If NIRFSA_ATTR_VI is an invalid session, this function does nothing and returns an error. Normally, the error information describes the first error that occurred since you last called this function or the nirfsa_ClearError function.\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5840', + 'description': '\nReturns the S-parameters used for de-embedding a measurement on the selected port.\n\nThis includes interpolation of the parameters based on the configured carrier frequency. This function returns an empty array if no de-embedding is done.\n\nIf you want to call this function just to get the required buffer size, you can pass 0 for **S-parameter Size** and VI_NULL for the **S-parameters** buffer.\n\n**Supported Devices** : PXIe-5830/5831/5832/5840/5841/5842/5860', + 'note': 'The port orientation for the returned S-parameters is normalized to NIRFSA_VAL_PORT1_TOWARDS_DUT.' }, 'included_in_proto': True, - 'is_error_handling': True, 'method_templates': [ { - 'documentation_filename': 'default_method', - 'library_interpreter_filename': 'default_method', + 'documentation_filename': 'numpy_method', + 'library_interpreter_filename': 'get_deembedding_sparameter', 'method_python_name_suffix': '', 'session_filename': 'none' } @@ -3114,7 +2860,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.' }, 'name': 'vi', 'type': 'ViSession', @@ -3122,21 +2868,33 @@ 'use_in_python_api': True }, { + 'array_dimensions': 2, + 'complex_array_representation': 'complex_number_array', 'direction': 'out', 'documentation': { - 'description': 'Returns the error code for the session or execution thread. If you pass 0 for the **NIRFSA_ATTR_ERROR_DESCRIPTION_BUFFER_SIZE** parameter, you can pass VI_NULL for this parameter.', + 'description': 'Returns an array of S-parameters. The S-parameters are returned in the following order: s11, s12, s21, s22.' }, - 'name': 'errorCode', - 'type': 'ViStatus', + 'name': 'sparameters', + 'numpy': True, + 'type': 'NIComplexNumber[]', 'use_array': False, 'use_in_python_api': True }, { 'direction': 'in', 'documentation': { - 'description': 'Passes the number of bytes in the ViChar array you specify in **description**.\n\nIf the error description, including the terminating NULL byte, contains more bytes than you indicate in this parameter, the function copies **NIRFSA_ATTR_ERROR_DESCRIPTION_BUFFER_SIZE** 1 bytes into the buffer, places an ASCII NULL byte at the end of the buffer, and returns the size of the buffer that 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\nIf you pass 0, you can pass VI_NULL for the **NIRFSA_ATTR_ERROR_DESCRIPTION** parameter.', + 'description': 'Specifies the size of the array that is returned by the NIRFSA_ATTR_SPARAMETERS output.' }, - 'name': 'errorDescriptionBufferSize', + 'name': 'sparametersArraySize', + 'type': 'ViInt32', + 'use_array': False + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the number of S-parameters.' + }, + 'name': 'numberOfSparameters', 'type': 'ViInt32', 'use_array': False, 'use_in_python_api': True @@ -3144,103 +2902,127 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the error description for the IVI session or execution thread. If there is no description, this function returns an empty string.\n\nThe buffer must contain at least as many elements as the value you specify with the **NIRFSA_ATTR_ERROR_DESCRIPTION_BUFFER_SIZE** parameter. If the error description, including the terminating NULL byte, contains more bytes than you indicate in this parameter, the function copies **NIRFSA_ATTR_ERROR_DESCRIPTION_BUFFER_SIZE** 1 bytes into the buffer, places an ASCII NULL byte at the end of the buffer, and returns the size of the buffer, in the **status** return value, that 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\nIf you pass 0, you can pass VI_NULL for the this parameter.', + 'description': 'Returns the number of S-parameter ports. The **sparameter** array is always *n* x *n*, where span *n* is the number of ports.' }, - 'name': 'errorDescription', - 'size': { - 'mechanism': 'ivi-dance', - 'value': 'errorDescriptionBufferSize' - }, - 'type': 'ViChar[]', + 'name': 'numberOfPorts', + 'type': 'ViInt32', 'use_array': False, 'use_in_python_api': True } ], - 'returns': 'ViStatus', - 'use_session_lock': False + 'returns': 'ViStatus' }, - 'GetLastExtCalLastDateAndTime': { - 'codegen_method': 'python-only', + 'GetDeembeddingTableNumberOfPorts': { + 'codegen_method': 'private', 'documentation': { - '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', + 'description': '\nReturns the number of S-parameter ports.' }, 'included_in_proto': True, 'method_templates': [ { 'documentation_filename': 'default_method', - 'library_interpreter_filename': 'none', + 'library_interpreter_filename': 'default_method', 'method_python_name_suffix': '', - 'session_filename': 'datetime_wrappers' + 'session_filename': 'none' } ], 'parameters': [ { 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.' + }, 'name': 'vi', 'type': 'ViSession' }, { 'direction': 'out', - 'name': 'lastCalDatetime', - 'type': 'hightime.datetime' + 'documentation': { + 'description': 'Returns the number of S-parameter ports. The **sparameter** array is always *n* x *n*, where span *n* is the number of ports.' + }, + 'name': 'numberOfPorts', + 'type': 'ViInt32' } ], - 'python_name': 'get_ext_cal_last_date_and_time', - 'real_datetime_call': 'GetExtCalLastDateAndTime', 'returns': 'ViStatus' }, - 'GetLastSelfCalLastDateAndTime': { - 'codegen_method': 'python-only', + 'GetError': { + 'codegen_method': 'public', 'documentation': { - '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-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + 'description': 'Retrieves and then clears the IVI error information for the session or the current execution thread.\n\n----\n**Note**\nIf the **NIRFSA_ATTR_ERROR_DESCRIPTION_BUFFER_SIZE** parameter is 0, this function does not clear the error information. By passing 0 to **NIRFSA_ATTR_ERROR_DESCRIPTION_BUFFER_SIZE**, you can determine the buffer size required to read the entire error description string. You can then call this function again with a sufficiently large buffer.\n\nIf you specify a valid IVI session for the NIRFSA_ATTR_VI parameter, this function retrieves and then clears the error information for the session. If you pass VI_NULL for NIRFSA_ATTR_VI, this function retrieves and then clears the error information for the current execution thread. If NIRFSA_ATTR_VI is an invalid session, this function does nothing and returns an error. Normally, the error information describes the first error that occurred since you last called this function or the nirfsa_ClearError function.\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5840' }, 'included_in_proto': True, + 'is_error_handling': True, 'method_templates': [ { 'documentation_filename': 'default_method', - 'library_interpreter_filename': 'none', + 'library_interpreter_filename': 'default_method', 'method_python_name_suffix': '', - 'session_filename': 'datetime_wrappers' + 'session_filename': 'none' } ], 'parameters': [ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the self-calibration step to query for the last successful self-calibration date and time data.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, - 'enum': 'SelfCalibrationStep', - 'name': 'selfCalibrationStep', - 'type': 'ViInt64' + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the error code for the session or execution thread. If you pass 0 for the **NIRFSA_ATTR_ERROR_DESCRIPTION_BUFFER_SIZE** parameter, you can pass VI_NULL for this parameter.' + }, + 'name': 'errorCode', + 'type': 'ViStatus', + 'use_array': False, + 'use_in_python_api': True }, { 'direction': 'in', - 'name': 'vi', - 'type': 'ViSession' + 'documentation': { + 'description': 'Passes the number of bytes in the ViChar array you specify in **description**.\n\nIf the error description, including the terminating NULL byte, contains more bytes than you indicate in this parameter, the function copies **NIRFSA_ATTR_ERROR_DESCRIPTION_BUFFER_SIZE** 1 bytes into the buffer, places an ASCII NULL byte at the end of the buffer, and returns the size of the buffer that 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\nIf you pass 0, you can pass VI_NULL for the **NIRFSA_ATTR_ERROR_DESCRIPTION** parameter.' + }, + 'name': 'errorDescriptionBufferSize', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True }, { 'direction': 'out', - 'name': 'lastCalDatetime', - 'type': 'hightime.datetime' + 'documentation': { + 'description': 'Returns the error description for the IVI session or execution thread. If there is no description, this function returns an empty string.\n\nThe buffer must contain at least as many elements as the value you specify with the **NIRFSA_ATTR_ERROR_DESCRIPTION_BUFFER_SIZE** parameter. If the error description, including the terminating NULL byte, contains more bytes than you indicate in this parameter, the function copies **NIRFSA_ATTR_ERROR_DESCRIPTION_BUFFER_SIZE** 1 bytes into the buffer, places an ASCII NULL byte at the end of the buffer, and returns the size of the buffer, in the **status** return value, that 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\nIf you pass 0, you can pass VI_NULL for the this parameter.' + }, + 'name': 'errorDescription', + 'size': { + 'mechanism': 'ivi-dance', + 'value': 'errorDescriptionBufferSize' + }, + 'type': 'ViChar[]', + 'use_array': False, + 'use_in_python_api': True } ], - 'python_name': 'get_self_cal_last_date_and_time', - 'real_datetime_call': 'GetSelfCalLastDateAndTime', - 'returns': 'ViStatus' + 'returns': 'ViStatus', + 'use_session_lock': False }, 'GetExtCalLastDateAndTime': { 'codegen_method': 'private', 'documentation': { - 'description': 'Returns the date and time of the last successful external calibration.\n\nThe time returned is 24-hour local time, and the date is returned as integer values. For example, if the device was calibrated at 2:30 PM on December 31, 2010, this function returns 14 for the NIRFSA_ATTR_HOUR parameter, 30 for the NIRFSA_ATTR_MINUTE parameter, 12 for the NIRFSA_ATTR_MONTH parameter, 31 for the NIRFSA_ATTR_DAY parameter, and 2010 for the NIRFSA_ATTR_YEAR parameter.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + 'description': 'Returns the date and time of the last successful external calibration.\n\nThe time returned is 24-hour local time, and the date is returned as integer values. For example, if the device was calibrated at 2:30 PM on December 31, 2010, this function returns 14 for the NIRFSA_ATTR_HOUR parameter, 30 for the NIRFSA_ATTR_MINUTE parameter, 12 for the NIRFSA_ATTR_MONTH parameter, 31 for the NIRFSA_ATTR_DAY parameter, and 2010 for the NIRFSA_ATTR_YEAR parameter.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, - 'method_name_for_documentation': 'get_ext_cal_last_date_and_time', 'is_error_handling': False, + 'method_name_for_documentation': 'get_ext_cal_last_date_and_time', 'parameters': [ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init, nirfsa_InitWithOptions, or nirfsa_InitExtCal function and identifies a particular instrument session.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init, nirfsa_InitWithOptions, or nirfsa_InitExtCal function and identifies a particular instrument session.' }, 'name': 'vi', 'type': 'ViSession', @@ -3250,7 +3032,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the year of the last external calibration.', + 'description': 'Returns the year of the last external calibration.' }, 'name': 'year', 'type': 'ViInt32', @@ -3260,7 +3042,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the month of the last external calibration.', + 'description': 'Returns the month of the last external calibration.' }, 'name': 'month', 'type': 'ViInt32', @@ -3270,7 +3052,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the day of the last external calibration.', + 'description': 'Returns the day of the last external calibration.' }, 'name': 'day', 'type': 'ViInt32', @@ -3280,7 +3062,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the hour of the last external calibration.', + 'description': 'Returns the hour of the last external calibration.' }, 'name': 'hour', 'type': 'ViInt32', @@ -3290,13 +3072,13 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the minute of the last external calibration.', + 'description': 'Returns the minute of the last external calibration.' }, 'name': 'minute', 'type': 'ViInt32', 'use_array': False, 'use_in_python_api': True - }, + } ], 'returns': 'ViStatus', 'use_session_lock': True @@ -3304,7 +3086,7 @@ 'GetExtCalRecommendedInterval': { 'codegen_method': 'public', 'documentation': { - 'description': 'Returns the recommended interval between external calibrations, in months.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + 'description': 'Returns the recommended interval between external calibrations, in months.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'is_error_handling': False, @@ -3320,7 +3102,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init, nirfsa_InitWithOptions, or nirfsa_InitExtCal function and identifies a particular instrument session.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init, nirfsa_InitWithOptions, or nirfsa_InitExtCal function and identifies a particular instrument session.' }, 'name': 'vi', 'type': 'ViSession', @@ -3330,12 +3112,12 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the recommended maximum interval between external calibrations, in months.', + 'description': 'Returns the recommended maximum interval between external calibrations, in months.' }, 'name': 'months', 'python_api_converter_name': 'convert_month_to_timedelta', - 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or int in months', 'type': 'ViInt32', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or int in months', 'use_array': False, 'use_in_python_api': True } @@ -3346,8 +3128,9 @@ 'GetFetchBacklog': { 'codegen_method': 'public', 'documentation': { - 'description': 'Returns the number of points acquired that have not yet been fetched.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + 'description': 'Returns the number of points acquired that have not yet been fetched.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, + 'has_repeated_capability': True, 'included_in_proto': True, 'is_error_handling': False, 'method_templates': [ @@ -3362,7 +3145,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -3372,11 +3155,11 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.' }, 'is_repeated_capability': True, - 'repeated_capability_type': 'channels', 'name': 'channelList', + 'repeated_capability_type': 'channels', 'type': 'ViConstString', 'use_array': False, 'use_in_python_api': True @@ -3384,7 +3167,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the record from which to read the backlog. Record numbers are zero-based.', + 'description': 'Specifies the record from which to read the backlog. Record numbers are zero-based.' }, 'name': 'recordNumber', 'type': 'ViInt64', @@ -3394,7 +3177,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the number of samples available to read for the requested record.', + 'description': 'Returns the number of samples available to read for the requested record.' }, 'name': 'backlog', 'type': 'ViInt64', @@ -3402,14 +3185,16 @@ 'use_in_python_api': True } ], + 'repeated_capability_type': 'channels', 'returns': 'ViStatus', 'use_session_lock': True }, 'GetFrequencyResponse': { 'codegen_method': 'public', 'documentation': { - 'description': 'Returns the requested device response type, based on current NI-RFSA settings. The PXI-5661 and PXIe-5663/5663E/5665/5667/5668 automatically corrects the IF and RF response when you set the Digital IF Equalization Enabled property to TRUE. If you are using external digitizer mode, you can use information returned from this VI to correct your measurement.\n\nRefer to the *Factory Calibration* topic for your device for more information about frequency-response calibration.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698', + 'description': 'Returns the requested device response type, based on current NI-RFSA settings. The PXI-5661 and PXIe-5663/5663E/5665/5667/5668 automatically corrects the IF and RF response when you set the Digital IF Equalization Enabled property to TRUE. If you are using external digitizer mode, you can use information returned from this VI to correct your measurement.\n\nRefer to the *Factory Calibration* topic for your device for more information about frequency-response calibration.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698' }, + 'has_repeated_capability': True, 'included_in_proto': True, 'is_error_handling': False, 'method_templates': [ @@ -3424,7 +3209,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -3434,11 +3219,11 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.' }, 'is_repeated_capability': True, - 'repeated_capability_type': 'channels', 'name': 'channelList', + 'repeated_capability_type': 'channels', 'type': 'ViConstString', 'use_array': False, 'use_in_python_api': True @@ -3446,7 +3231,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the size of the array you specify for the NIRFSA_ATTR_FREQUENCIES, **NIRFSA_ATTR_MAGNITUDE_RESPONSE**, and **NIRFSA_ATTR_PHASE_RESPONSE** parameters.', + 'description': 'Specifies the size of the array you specify for the NIRFSA_ATTR_FREQUENCIES, **NIRFSA_ATTR_MAGNITUDE_RESPONSE**, and **NIRFSA_ATTR_PHASE_RESPONSE** parameters.' }, 'name': 'bufferSize', 'type': 'ViInt32', @@ -3456,7 +3241,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns an array containing the frequencies, in hertz (Hz), that correspond to the response data.\n\nPass VI_NULL if you do not want to use this parameter.', + 'description': 'Returns an array containing the frequencies, in hertz (Hz), that correspond to the response data.\n\nPass VI_NULL if you do not want to use this parameter.' }, 'name': 'frequencies', 'size': { @@ -3470,7 +3255,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns an array containing the magnitude of the requested response, in decibels (dB). The magnitude response is normalized to the center frequency at each frequency in the NIRFSA_ATTR_FREQUENCIES array.\n\nPass VI_NULL if you do not want to use this parameter.', + 'description': 'Returns an array containing the magnitude of the requested response, in decibels (dB). The magnitude response is normalized to the center frequency at each frequency in the NIRFSA_ATTR_FREQUENCIES array.\n\nPass VI_NULL if you do not want to use this parameter.' }, 'name': 'magnitudeResponse', 'size': { @@ -3484,7 +3269,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns an array containing the phase of the requested response, in radians. The phase response is normalized to the center frequency at each frequency entry in the NIRFSA_ATTR_FREQUENCIES array.\n\nPass VI_NULL if you do not want to use this parameter. This array may contain zeros if the device does not contain a stored phase response in its calibration data.', + 'description': 'Returns an array containing the phase of the requested response, in radians. The phase response is normalized to the center frequency at each frequency entry in the NIRFSA_ATTR_FREQUENCIES array.\n\nPass VI_NULL if you do not want to use this parameter. This array may contain zeros if the device does not contain a stored phase response in its calibration data.' }, 'name': 'phaseResponse', 'size': { @@ -3498,7 +3283,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the required number of elements in the NIRFSA_ATTR_FREQUENCIES array and the response arrays. If **NIRFSA_ATTR_BUFFER_SIZE** is 0, this parameter returns the expected array size. The expected array size depends on which NI-RFSA device you use (PXI-5661, PXIe-5663/5663E/5665) and on the current settings (PXIe-5663/5663E/5665 only).', + 'description': 'Returns the required number of elements in the NIRFSA_ATTR_FREQUENCIES array and the response arrays. If **NIRFSA_ATTR_BUFFER_SIZE** is 0, this parameter returns the expected array size. The expected array size depends on which NI-RFSA device you use (PXI-5661, PXIe-5663/5663E/5665) and on the current settings (PXIe-5663/5663E/5665 only).' }, 'name': 'numberOfFrequencies', 'type': 'ViInt32', @@ -3506,13 +3291,162 @@ 'use_in_python_api': True } ], + 'repeated_capability_type': 'channels', + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'GetLastExtCalLastDateAndTime': { + 'codegen_method': 'python-only', + 'documentation': { + '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_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'none', + 'method_python_name_suffix': '', + 'session_filename': 'datetime_wrappers' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'out', + 'name': 'lastCalDatetime', + 'type': 'hightime.datetime' + } + ], + 'python_name': 'get_ext_cal_last_date_and_time', + 'real_datetime_call': 'GetExtCalLastDateAndTime', + 'returns': 'ViStatus' + }, + 'GetLastSelfCalLastDateAndTime': { + 'codegen_method': 'python-only', + 'documentation': { + '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-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'included_in_proto': True, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'none', + 'method_python_name_suffix': '', + 'session_filename': 'datetime_wrappers' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the self-calibration step to query for the last successful self-calibration date and time data.' + }, + 'enum': 'SelfCalibrationStep', + 'name': 'selfCalibrationStep', + 'type': 'ViInt64' + }, + { + 'direction': 'in', + 'name': 'vi', + 'type': 'ViSession' + }, + { + 'direction': 'out', + 'name': 'lastCalDatetime', + 'type': 'hightime.datetime' + } + ], + 'python_name': 'get_self_cal_last_date_and_time', + 'real_datetime_call': 'GetSelfCalLastDateAndTime', + 'returns': 'ViStatus' + }, + 'GetScalingCoefficients': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Returns coefficients you can use to convert unscaled data to scaled I/Q data.\n\nAcquired data may be unscaled when sent by a peer-to-peer stream or fetched as unscaled data. Use this function to obtain nirfsa_GetScalingCoefficients structures in the **NIRFSA_ATTR_COEFFICIENT_INFO** array that provide gain and offset values you can use to scale this data into the actual I/Q values. The **NIRFSA_ATTR_COEFFICIENT_INFO** array returns one element for each channel specified in the **NIRFSA_ATTR_CHANNEL_LIST** parameter. The element order matches the order specified by the **NIRFSA_ATTR_CHANNEL_LIST** parameter. To get the actual I/Q values, scale the unscaled data from an acquisition by multiplying it by the gain value of the appropriate **NIRFSA_ATTR_COEFFICIENT_INFO** element then adding the offset from the same element.\n\n----\n**Note**\nThe coefficients are calculated by NI-RFSA for the current configuration of the device, so they are only valid for acquisitions obtained with the same device configuration.\n\n----\n\nTo get the required size of the array, call this function with **NIRFSA_ATTR_ARRAY_SIZE** set to 0 and NULL for the **NIRFSA_ATTR_COEFFICIENT_INFO** array. This function returns the required size in the **NIRFSA_ATTR_NUMBER_OF_COEFFICIENT_SETS** parameter.\n\n**Supported Devices**: PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'has_repeated_capability': True, + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.' + }, + 'is_repeated_capability': True, + 'name': 'channelList', + 'repeated_capability_type': 'channels', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the size of the array you specify for the **NIRFSA_ATTR_COEFFICIENT_INFO** parameter.' + }, + 'name': 'arraySize', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Specifies the array for storing the coefficient info.\n\n- **offset** is the number that should be added to the data from a peer-to-peer stream after the gain has been applied if you want to scale unscaled data.\n- **gain** returns the multiplier that you should use to scale data obtained from a peer-to-peer stream.' + }, + 'name': 'coefficientInfo', + 'size': { + 'mechanism': 'ivi-dance-with-a-twist', + 'value': 'arraySize', + 'value_twist': 'numberOfCoefficientSets' + }, + 'type': 'niRFSA_coefficientInfo[]', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns the number of valid coefficient sets.' + }, + 'name': 'numberOfCoefficientSets', + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'repeated_capability_type': 'channels', 'returns': 'ViStatus', 'use_session_lock': True }, 'GetSelfCalLastDateAndTime': { 'codegen_method': 'private', 'documentation': { - 'description': 'Returns the date and time of the last successful self-calibration.\n\nThe time returned is 24-hour local time, and the date is returned as integer values. For example, if the device was calibrated at 2:30 PM on December 31, 2010, this function returns 14 for the NIRFSA_ATTR_HOUR parameter, 30 for the NIRFSA_ATTR_MINUTE parameter, 12 for the NIRFSA_ATTR_MONTH parameter, 31 for the NIRFSA_ATTR_DAY parameter, and 2010 for the NIRFSA_ATTR_YEAR parameter.\n\n----\n**Note**\nFor the PXIe-5644/5645/5646, you must select NIRFSA_VAL_SELF_CAL_IMAGE_SUPPRESSION for the **NIRFSA_ATTR_SELF_CALIBRATION_STEP** parameter.\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + 'description': 'Returns the date and time of the last successful self-calibration.\n\nThe time returned is 24-hour local time, and the date is returned as integer values. For example, if the device was calibrated at 2:30 PM on December 31, 2010, this function returns 14 for the NIRFSA_ATTR_HOUR parameter, 30 for the NIRFSA_ATTR_MINUTE parameter, 12 for the NIRFSA_ATTR_MONTH parameter, 31 for the NIRFSA_ATTR_DAY parameter, and 2010 for the NIRFSA_ATTR_YEAR parameter.\n\n----\n**Note**\nFor the PXIe-5644/5645/5646, you must select NIRFSA_VAL_SELF_CAL_IMAGE_SUPPRESSION for the **NIRFSA_ATTR_SELF_CALIBRATION_STEP** parameter.\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'grpc_name': 'GetSelfCalLastDateAndTime', 'included_in_proto': True, @@ -3521,7 +3455,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -3590,7 +3524,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the year of the last external calibration.', + 'description': 'Returns the year of the last external calibration.' }, 'name': 'year', 'type': 'ViInt32', @@ -3600,7 +3534,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the month of the last external calibration.', + 'description': 'Returns the month of the last external calibration.' }, 'name': 'month', 'type': 'ViInt32', @@ -3610,7 +3544,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the day of the last external calibration.', + 'description': 'Returns the day of the last external calibration.' }, 'name': 'day', 'type': 'ViInt32', @@ -3620,7 +3554,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the year of the last external calibration. It is expressed as an integer.', + 'description': 'Returns the year of the last external calibration. It is expressed as an integer.' }, 'name': 'hour', 'type': 'ViInt32', @@ -3630,7 +3564,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the minute of the last external calibration.', + 'description': 'Returns the minute of the last external calibration.' }, 'name': 'minute', 'type': 'ViInt32', @@ -3641,92 +3575,14 @@ 'returns': 'ViStatus', 'use_session_lock': True }, - 'GetScalingCoefficients': { - 'codegen_method': 'public', - 'documentation': { - 'description': 'Returns coefficients you can use to convert unscaled data to scaled I/Q data.\n\nAcquired data may be unscaled when sent by a peer-to-peer stream or fetched as unscaled data. Use this function to obtain nirfsa_GetScalingCoefficients structures in the **NIRFSA_ATTR_COEFFICIENT_INFO** array that provide gain and offset values you can use to scale this data into the actual I/Q values. The **NIRFSA_ATTR_COEFFICIENT_INFO** array returns one element for each channel specified in the **NIRFSA_ATTR_CHANNEL_LIST** parameter. The element order matches the order specified by the **NIRFSA_ATTR_CHANNEL_LIST** parameter. To get the actual I/Q values, scale the unscaled data from an acquisition by multiplying it by the gain value of the appropriate **NIRFSA_ATTR_COEFFICIENT_INFO** element then adding the offset from the same element.\n\n----\n**Note**\nThe coefficients are calculated by NI-RFSA for the current configuration of the device, so they are only valid for acquisitions obtained with the same device configuration.\n\n----\n\nTo get the required size of the array, call this function with **NIRFSA_ATTR_ARRAY_SIZE** set to 0 and NULL for the **NIRFSA_ATTR_COEFFICIENT_INFO** array. This function returns the required size in the **NIRFSA_ATTR_NUMBER_OF_COEFFICIENT_SETS** parameter.\n\n**Supported Devices**: PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', - }, - 'included_in_proto': True, - 'is_error_handling': False, - 'method_templates': [ - { - 'documentation_filename': 'default_method', - 'library_interpreter_filename': 'default_method', - 'method_python_name_suffix': '', - 'session_filename': 'default_method' - } - ], - 'parameters': [ - { - 'direction': 'in', - 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', - }, - 'name': 'vi', - 'type': 'ViSession', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', - }, - 'is_repeated_capability': True, - 'repeated_capability_type': 'channels', - 'name': 'channelList', - 'type': 'ViConstString', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Specifies the size of the array you specify for the **NIRFSA_ATTR_COEFFICIENT_INFO** parameter.', - }, - 'name': 'arraySize', - 'type': 'ViInt32', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'out', - 'documentation': { - 'description': 'Specifies the array for storing the coefficient info.\n\n- **offset** is the number that should be added to the data from a peer-to-peer stream after the gain has been applied if you want to scale unscaled data.\n- **gain** returns the multiplier that you should use to scale data obtained from a peer-to-peer stream.', - }, - 'name': 'coefficientInfo', - 'size': { - 'mechanism': 'ivi-dance-with-a-twist', - 'value': 'arraySize', - 'value_twist': 'numberOfCoefficientSets' - }, - 'type': 'niRFSA_coefficientInfo[]', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'out', - 'documentation': { - 'description': 'Returns the number of valid coefficient sets.', - }, - 'name': 'numberOfCoefficientSets', - 'type': 'ViInt32', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'returns': 'ViStatus', - 'use_session_lock': True - }, 'GetSelfCalLastTemp': { 'codegen_method': 'public', 'documentation': { - 'description': 'Returns the temperature, in degrees Celsius, at the last successful self-calibration.\n\n----\n**Note**\nFor the PXIe-5644/5645/5646, you must select NIRFSA_VAL_SELF_CAL_IMAGE_SUPPRESSION for the **selfCalibrationStep** parameter.\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831 (IF only)/5832 (IF only)/5840/5841/5842/5860', + 'description': 'Returns the temperature, in degrees Celsius, at the last successful self-calibration.\n\n----\n**Note**\nFor the PXIe-5644/5645/5646, you must select NIRFSA_VAL_SELF_CAL_IMAGE_SUPPRESSION for the **selfCalibrationStep** parameter.\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831 (IF only)/5832 (IF only)/5840/5841/5842/5860' }, 'grpc_name': 'GetSelfCalLastTemp', 'included_in_proto': True, 'is_error_handling': False, - 'python_name': 'get_self_calibration_temperature', 'method_templates': [ { 'documentation_filename': 'default_method', @@ -3739,7 +3595,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -3808,7 +3664,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the temperature, in degrees Celsius, of the device at the last successful self-calibration.', + 'description': 'Returns the temperature, in degrees Celsius, of the device at the last successful self-calibration.' }, 'grpc_name': 'temp', 'name': 'temperature', @@ -3817,13 +3673,14 @@ 'use_in_python_api': True } ], + 'python_name': 'get_self_calibration_temperature', 'returns': 'ViStatus', 'use_session_lock': True }, 'GetTerminalName': { 'codegen_method': 'public', 'documentation': { - 'description': 'Returns the fully qualified name of the signal being queried.\n\nSignals can be triggers, clocks, or events.\n\nYou can pass the **NIRFSA_ATTR_TERMINAL_NAME** parameter that is returned to the **source** parameter of a configure trigger function.\n\n**Supported Devices**: PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Events `_', + 'description': 'Returns the fully qualified name of the signal being queried.\n\nSignals can be triggers, clocks, or events.\n\nYou can pass the **NIRFSA_ATTR_TERMINAL_NAME** parameter that is returned to the **source** parameter of a configure trigger function.\n\n**Supported Devices**: PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Events `_' }, 'included_in_proto': True, 'is_error_handling': False, @@ -3839,7 +3696,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -3900,11 +3757,11 @@ 'use_in_python_api': True }, { + 'default_value': '""', 'direction': 'in', 'documentation': { - 'description': 'Specifies a particular instance of a trigger. NI-RFSA does not support this parameter.', + 'description': 'Specifies a particular instance of a trigger. NI-RFSA does not support this parameter.' }, - 'default_value': '""', 'name': 'signalIdentifier', 'type': 'ViConstString', 'use_array': False, @@ -3913,7 +3770,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Passes the number of bytes in the ViChar buffer that you allocate for the **NIRFSA_ATTR_TERMINAL_NAME** parameter.', + 'description': 'Passes the number of bytes in the ViChar buffer that you allocate for the **NIRFSA_ATTR_TERMINAL_NAME** parameter.' }, 'name': 'bufferSize', 'type': 'ViInt32', @@ -3923,7 +3780,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the fully qualified name of the signal being queried.', + 'description': 'Returns the fully qualified name of the signal being queried.' }, 'name': 'terminalName', 'size': { @@ -3941,11 +3798,11 @@ 'InitWithOptions': { 'codegen_method': 'private', 'documentation': { - 'description': 'Creates a new session for the device.\n\nThis function sets the initial value of certain attributes and sends initialization commands to reset all hardware modules to a known state necessary for NI-RFSA operation.\n\nTo create a new session, pass the downconverter resource name for the RF vector signal analyzer to the **resource name** parameter.\n\nYou can access the device session this VI creates using the NI-RFSA Soft Front Panel (SFP). Accessing the device session with the SFP can help you debug your code. Refer to `Debugging Your Application Using SFP Session Access `_ for more information about accessing your session with the SFP.\n\n----\n**Note**\nBefore initializing your device, you must first associate the modules that comprise your device in MAX. After associating the modules, pass the resource name of the device to this function to initialize all the modules. Refer to `Associating NI-RFSA Modules `_ for information about MAX association.\n\n----\n\n----\n**Note**\nFor 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.\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Driver Setup Options `_', + 'description': 'Creates a new session for the device.\n\nThis function sets the initial value of certain attributes and sends initialization commands to reset all hardware modules to a known state necessary for NI-RFSA operation.\n\nTo create a new session, pass the downconverter resource name for the RF vector signal analyzer to the **resource name** parameter.\n\nYou can access the device session this VI creates using the NI-RFSA Soft Front Panel (SFP). Accessing the device session with the SFP can help you debug your code. Refer to `Debugging Your Application Using SFP Session Access `_ for more information about accessing your session with the SFP.\n\n----\n**Note**\nBefore initializing your device, you must first associate the modules that comprise your device in MAX. After associating the modules, pass the resource name of the device to this function to initialize all the modules. Refer to `Associating NI-RFSA Modules `_ for information about MAX association.\n\n----\n\n----\n**Note**\nFor 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.\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Driver Setup Options `_' }, 'included_in_proto': True, - 'method_name_for_documentation': '__init__', 'is_error_handling': False, + 'method_name_for_documentation': '__init__', 'method_templates': [ { 'documentation_filename': 'default_method', @@ -3958,7 +3815,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the resource name of the device to initialize.\n\nFor NI-RFSA devices, the syntax is the device name specified in MAX. The typical default name for your device in MAX is PXI1Slot2. You can rename your device by right-clicking the name in MAX, selecting **Rename** from the drop-down menu, and entering a new name. You can also pass in the name of an IVI logical name configured with the IVI Configuration utility. For additional information, refer to the **Installed Devices IVI** topic of the *Measurement & Automation Explorer Help*.\n\nDevice names are not case-sensitive. However, IVI logical names are case-sensitive. If you use an IVI logical name, verify the name is identical to the name shown in the IVI Configuration Utility.', + 'description': 'Specifies the resource name of the device to initialize.\n\nFor NI-RFSA devices, the syntax is the device name specified in MAX. The typical default name for your device in MAX is PXI1Slot2. You can rename your device by right-clicking the name in MAX, selecting **Rename** from the drop-down menu, and entering a new name. You can also pass in the name of an IVI logical name configured with the IVI Configuration utility. For additional information, refer to the **Installed Devices IVI** topic of the *Measurement & Automation Explorer Help*.\n\nDevice names are not case-sensitive. However, IVI logical names are case-sensitive. If you use an IVI logical name, verify the name is identical to the name shown in the IVI Configuration Utility.' }, 'name': 'resourceName', 'type': 'ViRsrc', @@ -4004,8 +3861,8 @@ 'Description' ] }, - 'grpc_name': 'reset', - 'name': 'resetDevice', + 'grpc_name': 'reset', + 'name': 'resetDevice', 'type': 'ViBoolean', 'use_array': False, 'use_in_python_api': True @@ -4014,17 +3871,17 @@ 'default_value': '""', 'direction': 'in', 'documentation': { - 'description': 'Sets the initial value of certain attributes for the session. The attributes shown in the following table are used in this parameter.\n\n| Name | Attribute |\n|:-----------------|:-------------------------------------------------------------------------------------------------------------------------------------------|\n| RangeCheck | NIRFSA_ATTR_RANGE_CHECK |\n| QueryInstrStatus | NIRFSA_ATTR_QUERY_INSTRUMENT_STATUS |\n| Cache | NIRFSA_ATTR_CACHE |\n| RecordCoercions | NIRFSA_ATTR_RECORD_COERCIONS |\n| DriverSetup | NIRFSA_ATTR_DRIVER_SETUP |\n| Simulate | NIRFSA_ATTR_SIMULATE |\n\nThe format of this string is *AttributeName=Value*, where *AttributeName* is the name of the attribute and *Value* is the value to which the attribute will be set. For example, you can simulate the PXIe-5663 using the following strings:\n\n*Simulate=1, DriverSetup=Model:5663\\E*.\n\n*Simulate=1, DriverSetup=Model:5601*; *Digitizer:5622; LO:5652; LOBoardType:PXIe*.\n\nTo set multiple attributes, separate their assignments with a comma.\n\nRefer to `Driver Setup Options `_ for more information about the driver setup string.\n\nNote: To simulate a device using the PXIe-5622 25 MHz digitizer, set the *Digitizer* field to 5622_25MHz_DDC and the *Simulate* field to 1. You can set the *Digitizer* field to 5622_25MHz_DDC only when using the PXIe-5665.', + 'description': 'Sets the initial value of certain attributes for the session. The attributes shown in the following table are used in this parameter.\n\n| Name | Attribute |\n|:-----------------|:-------------------------------------------------------------------------------------------------------------------------------------------|\n| RangeCheck | NIRFSA_ATTR_RANGE_CHECK |\n| QueryInstrStatus | NIRFSA_ATTR_QUERY_INSTRUMENT_STATUS |\n| Cache | NIRFSA_ATTR_CACHE |\n| RecordCoercions | NIRFSA_ATTR_RECORD_COERCIONS |\n| DriverSetup | NIRFSA_ATTR_DRIVER_SETUP |\n| Simulate | NIRFSA_ATTR_SIMULATE |\n\nThe format of this string is *AttributeName=Value*, where *AttributeName* is the name of the attribute and *Value* is the value to which the attribute will be set. For example, you can simulate the PXIe-5663 using the following strings:\n\n*Simulate=1, DriverSetup=Model:5663\\E*.\n\n*Simulate=1, DriverSetup=Model:5601*; *Digitizer:5622; LO:5652; LOBoardType:PXIe*.\n\nTo set multiple attributes, separate their assignments with a comma.\n\nRefer to `Driver Setup Options `_ for more information about the driver setup string.\n\nNote: To simulate a device using the PXIe-5622 25 MHz digitizer, set the *Digitizer* field to 5622_25MHz_DDC and the *Simulate* field to 1. You can set the *Digitizer* field to 5622_25MHz_DDC only when using the PXIe-5665.' }, 'name': 'optionString', 'python_api_converter_name': 'convert_init_with_options_dictionary', 'type': 'ViConstString', - 'type_in_documentation': 'dict', + 'type_in_documentation': 'dict' }, { 'direction': 'out', 'documentation': { - 'description': 'Identifies your instrument session.', + 'description': 'Identifies your instrument session.' }, 'grpc_name': 'vi', 'name': 'newVi', @@ -4039,7 +3896,7 @@ 'Initiate': { 'codegen_method': 'private', 'documentation': { - 'description': 'Commits settings to hardware, waits for hardware settling, and starts an acquisition.\n\nYou can use this function in conjunction with one of the niRFSA fetch I/Q functions to retrieve acquired I/Q data, or you can use the read IQ single record complex F64 function to both initiate the acquisition and retrieve I/Q data at one time.\n\n----\n**Note**\nIf you are using external digitizer mode, this function commits settings and waits for settling, but it does not start an acquisition. Notice that using the nirfsa_Commit function on its own commits settings to hardware, but the device does not wait for hardware settling.\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_\n\n`RF List Mode `_\n\n`NI RF Vector Signal Analyzer State Diagram `_', + 'description': 'Commits settings to hardware, waits for hardware settling, and starts an acquisition.\n\nYou can use this function in conjunction with one of the niRFSA fetch I/Q functions to retrieve acquired I/Q data, or you can use the read IQ single record complex F64 function to both initiate the acquisition and retrieve I/Q data at one time.\n\n----\n**Note**\nIf you are using external digitizer mode, this function commits settings and waits for settling, but it does not start an acquisition. Notice that using the nirfsa_Commit function on its own commits settings to hardware, but the device does not wait for hardware settling.\n\n----\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_\n\n`RF List Mode `_\n\n`NI RF Vector Signal Analyzer State Diagram `_' }, 'included_in_proto': True, 'is_error_handling': False, @@ -4047,7 +3904,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -4055,12 +3912,12 @@ 'use_in_python_api': True } ], - 'returns': 'ViStatus', + 'returns': 'ViStatus' }, 'IsSelfCalValid': { 'codegen_method': 'public', 'documentation': { - 'description': 'Indicates which calibration steps contain valid calibration data.\n\nTo omit steps with valid calibration data from self-calibration, you can pass the **NIRFSA_ATTR_VALID_STEPS** parameter to the **stepsToOmit** parameter of the nirfsa_SelfCalibrate function.\n\n**Supported Devices**: PXI-5661, PXIe-5663/5663E/5665/5667/5668', + 'description': 'Indicates which calibration steps contain valid calibration data.\n\nTo omit steps with valid calibration data from self-calibration, you can pass the **NIRFSA_ATTR_VALID_STEPS** parameter to the **stepsToOmit** parameter of the nirfsa_SelfCalibrate function.\n\n**Supported Devices**: PXI-5661, PXIe-5663/5663E/5665/5667/5668' }, 'included_in_proto': True, 'is_error_handling': False, @@ -4076,7 +3933,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -4086,7 +3943,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns VI_TRUE if all the calibration data is valid and VI_FALSE if any of the calibration data is invalid.', + 'description': 'Returns VI_TRUE if all the calibration data is valid and VI_FALSE if any of the calibration data is invalid.' }, 'name': 'selfCalValid', 'type': 'ViBoolean', @@ -4162,7 +4019,7 @@ 'LoadConfigurationsFromFile': { 'codegen_method': 'public', 'documentation': { - 'description': '\nLoads the configurations from the specified file to the NI-RFSA 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', + 'description': '\nLoads the configurations from the specified file to the NI-RFSA 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': [ @@ -4177,7 +4034,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.', + 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.' }, 'name': 'vi', 'type': 'ViSession', @@ -4187,7 +4044,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the name of the channel.', + 'description': 'Specifies the name of the channel.' }, 'name': 'channelName', 'type': 'ViConstString', @@ -4197,7 +4054,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the absolute path of the file from which the NI-RFSA loads the configurations.', + 'description': 'Specifies the absolute path of the file from which the NI-RFSA loads the configurations.' }, 'name': 'filePath', 'type': 'ViConstString', @@ -4210,7 +4067,7 @@ 'LockSession': { 'codegen_method': 'public', 'documentation': { - 'description': 'Obtains 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 this function.\n- A call to NI-RFSA locked the session.\n\nAfter the call to this function returns successfully, no other threads can access the instrument session until you call the nirfsa_UnlockSession function. Use the nirfsa_LockSession function and the nirfsa_UnlockSession function around a sequence of calls to NI-RFSA functions if you require that the NI-RFSA device retain its settings through the end of the sequence.\n\nYou can safely make nested calls to the nirfsa_LockSession function within the same thread. To completely unlock the session, balance each call to the nirfsa_LockSession function with a call to the nirfsa_UnlockSession function. If, however, you use **NIRFSA_ATTR_CALLER_HAS_LOCK** in all calls to the nirfsa_LockSession function and the nirfsa_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 nirfsa_LockSession function. Locking the session only once allows you to call the nirfsa_UnlockSession function just once at the end of the function.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698', + 'description': 'Obtains 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 this function.\n- A call to NI-RFSA locked the session.\n\nAfter the call to this function returns successfully, no other threads can access the instrument session until you call the nirfsa_UnlockSession function. Use the nirfsa_LockSession function and the nirfsa_UnlockSession function around a sequence of calls to NI-RFSA functions if you require that the NI-RFSA device retain its settings through the end of the sequence.\n\nYou can safely make nested calls to the nirfsa_LockSession function within the same thread. To completely unlock the session, balance each call to the nirfsa_LockSession function with a call to the nirfsa_UnlockSession function. If, however, you use **NIRFSA_ATTR_CALLER_HAS_LOCK** in all calls to the nirfsa_LockSession function and the nirfsa_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 nirfsa_LockSession function. Locking the session only once allows you to call the nirfsa_UnlockSession function just once at the end of the function.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698' }, 'included_in_proto': True, 'method_templates': [ @@ -4225,7 +4082,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -4235,7 +4092,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Keeps track of whether you obtain a lock and therefore need to unlock the session in complex functions. 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 this function or the nirfsa_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 nirfsa_LockSession function and the nirfsa_UnlockSession function each inspect the current value and take the actions shown in the following table.\n\n| Function | Boolean Value | Action |\n|:---------------------|:--------------|:-----------------------------------------------------------------------------------------------------|\n| nirfsa_LockSession | VI_TRUE | The nirfsa_LockSession function does not lock the session again. |\n| | VI_FALSE | The nirfsa_LockSession function obtains the lock and sets the value of the parameter to VI_TRUE. |\n| nirfsa_UnlockSession | VI_FALSE | The nirfsa_UnlockSession function does not attempt to unlock the session. |\n| | VI_TRUE | The nirfsa_UnlockSession function releases the lock and sets the value of the parameter to VI_FALSE. |\n\nThus, you can call the nirfsa_UnlockSession function at the end of your function regardless of whether you actually have the lock.', + 'description': 'Keeps track of whether you obtain a lock and therefore need to unlock the session in complex functions. 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 this function or the nirfsa_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 nirfsa_LockSession function and the nirfsa_UnlockSession function each inspect the current value and take the actions shown in the following table.\n\n| Function | Boolean Value | Action |\n|:---------------------|:--------------|:-----------------------------------------------------------------------------------------------------|\n| nirfsa_LockSession | VI_TRUE | The nirfsa_LockSession function does not lock the session again. |\n| | VI_FALSE | The nirfsa_LockSession function obtains the lock and sets the value of the parameter to VI_TRUE. |\n| nirfsa_UnlockSession | VI_FALSE | The nirfsa_UnlockSession function does not attempt to unlock the session. |\n| | VI_TRUE | The nirfsa_UnlockSession function releases the lock and sets the value of the parameter to VI_FALSE. |\n\nThus, you can call the nirfsa_UnlockSession function at the end of your function regardless of whether you actually have the lock.' }, 'name': 'callerHasLock', 'type': 'ViBoolean', @@ -4251,7 +4108,7 @@ 'PerformThermalCorrection': { 'codegen_method': 'public', 'documentation': { - 'description': 'Corrects for temperature variations while acquiring the same signal for an extended period of time in a continuous acquisition.\n\nNI-RFSA internally acquires the temperature every time you initiate an acquisition. If you are performing a continuous acquisition, National Instruments recommends calling this function once every 10 minutes in a stable temperature environment to periodically update temperature calibration. If the ambient temperature varies, call this function more frequently.\n\n----\n**Note**\nYou cannot call this function if your device is operating in `RF list mode `_.\n\n----\n\nRefer to the *Thermal Management* section for your device for more information about typical operating temperatures.\n\n**Supported Devices**: PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694, PXIe-5830/5831/5832/5840/5841/5842', + 'description': 'Corrects for temperature variations while acquiring the same signal for an extended period of time in a continuous acquisition.\n\nNI-RFSA internally acquires the temperature every time you initiate an acquisition. If you are performing a continuous acquisition, National Instruments recommends calling this function once every 10 minutes in a stable temperature environment to periodically update temperature calibration. If the ambient temperature varies, call this function more frequently.\n\n----\n**Note**\nYou cannot call this function if your device is operating in `RF list mode `_.\n\n----\n\nRefer to the *Thermal Management* section for your device for more information about typical operating temperatures.\n\n**Supported Devices**: PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694, PXIe-5830/5831/5832/5840/5841/5842' }, 'included_in_proto': True, 'is_error_handling': False, @@ -4267,7 +4124,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -4278,26 +4135,28 @@ 'returns': 'ViStatus', 'use_session_lock': True }, - 'ReadPowerSpectrumF32': { + 'ReadIQSingleRecordComplexF64': { 'codegen_method': 'private', 'documentation': { - 'description': 'Initiates a spectrum acquisition and returns power spectrum data.\n\n----\n**Note**\n Under certain configurations, negative infinity is returned from this VI. If the Reference Level is very high and if the Signal Bandwidth is comparatively less, the ADC returns zero, which equates to negative infinity in dBm. This is expected behavior.\n\n----\n\n**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860', + 'description': 'Initiates an acquisition and fetches a single I/Q data record.\n\nDo not use this function if you have configured the device to continuously acquire data samples or to acquire multiple records.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_' }, + 'grpc_name': 'ReadIQSingleRecordComplexF64', + 'has_repeated_capability': True, 'included_in_proto': True, - 'method_name_for_documentation': 'read_power_spectrum', + 'is_error_handling': False, 'method_templates': [ { - 'documentation_filename': 'default_method', - 'library_interpreter_filename': 'default_method', + 'documentation_filename': 'numpy_method', + 'library_interpreter_filename': 'numpy_read_method', 'method_python_name_suffix': '', - 'session_filename': 'default_method' + 'session_filename': 'numpy_read_method' } ], 'parameters': [ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -4307,11 +4166,11 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.' }, 'is_repeated_capability': True, - 'repeated_capability_type': 'channels', 'name': 'channelList', + 'repeated_capability_type': 'channels', 'type': 'ViConstString', 'use_array': False, 'use_in_python_api': True @@ -4320,7 +4179,7 @@ 'default_value': 'hightime.timedelta(seconds=10.0)', 'direction': 'in', 'documentation': { - 'description': 'Specifies the time, in seconds, allotted for the function to complete before returning a timeout error. A value of specifies the function waits until all data is available.', + 'description': 'Specifies in seconds the time allotted for the function to complete before returning a timeout error. A value of specifies the function waits until all data is available.' }, 'name': 'timeout', 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', @@ -4330,62 +4189,73 @@ 'use_in_python_api': True }, { + 'complex_array_representation': 'complex_number_array', 'direction': 'in', 'documentation': { - 'description': 'Returns power spectrum data. Allocate an array as large as **NIRFSA_ATTR_DATA_ARRAY_SIZE**.', + 'description': 'Returns the acquired waveform. Allocate an NIComplexNumber array at least as large as the number of samples configured in the nirfsa_ConfigureNumberOfSamples function.' }, - 'name': 'powerSpectrumDataArray', + 'grpc_name': 'data', + 'name': 'data', 'numpy': True, - 'size': {'mechanism': 'fixed', 'value': 1}, - 'type': 'ViReal32[]', + 'python_name': 'iq_data_array', + 'size': { + 'mechanism': 'fixed', + 'value': 1 + }, + 'type': 'NIComplexNumber[]', 'use_in_python_api': True }, { 'direction': 'in', 'documentation': { - 'description': 'Specifies the size of the array that is returned by the **NIRFSA_ATTR_POWER_SPECTRUM_DATA** parameter. Use the nirfsa_GetNumberOfSpectralLines function to obtain the array size to allocate. The array must be at least as large as the number of spectral lines that NI-RFSA computes for the power spectrum.', + 'description': 'Specifies the size of the array for the NIRFSA_ATTR_DATA parameter. The array needs to be at least as large as the number of samples configured in the nirfsa_ConfigureNumberOfSamples function.' }, 'name': 'dataArraySize', - 'size': {'mechanism': 'python-code', 'value': 'len(power_spectrum_data_array)'}, - 'type': 'ViInt32', + 'size': { + 'mechanism': 'python-code', + 'value': '0 if iq_data_array is None else len(iq_data_array)' + }, + 'type': 'ViInt64', 'use_array': False, 'use_in_python_api': False }, { 'direction': 'out', 'documentation': { - 'description': 'Returns additional information about the **NIRFSA_ATTR_POWER_SPECTRUM_DATA** array. This information includes the frequency, in hertz (Hz), corresponding to the first element in the array, the frequency increment, in Hz, between adjacent array elements, and the number of spectral lines the function returned.', + 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5830/5831/5832/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.' }, - 'name': 'spectrumInfo', - 'type': 'niRFSA_spectrumInfo', + 'name': 'wfmInfo', + 'type': 'niRFSA_wfmInfo', 'use_array': False, 'use_in_python_api': True } ], + 'repeated_capability_type': 'channels', 'returns': 'ViStatus', 'use_session_lock': True }, - 'ReadPowerSpectrumF64': { - 'codegen_method': 'private', + 'ReadIQSingleRecordDispatcher': { + 'codegen_method': 'python-only', 'documentation': { - 'description': 'Initiates a spectrum acquisition and returns power spectrum data.\n\n----\n**Note**\n Under certain configurations, negative infinity is returned from this VI. If the Reference Level is very high and if the Signal Bandwidth is comparatively less, the ADC returns zero, which equates to negative infinity in dBm. This is expected behavior.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5830/5831/5832/5840/5841/5842/5860', + 'description': 'Initiates an acquisition and fetches a single I/Q data record.\n\nDo not use this function if you have configured the device to continuously acquire data samples or to acquire multiple records.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`None (Trigger Type) `_' }, - 'included_in_proto': True, + 'has_repeated_capability': True, + 'included_in_proto': False, 'is_error_handling': False, - 'method_name_for_documentation': 'read_power_spectrum', + 'method_name_for_documentation': 'read_iq_single_record', 'method_templates': [ { 'documentation_filename': 'default_method', - 'library_interpreter_filename': 'default_method', - 'method_python_name_suffix': '', - 'session_filename': 'default_method' + 'library_interpreter_filename': 'none', + 'method_python_name_suffix': '_into', + 'session_filename': 'read_iq_single_record' } ], 'parameters': [ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -4395,11 +4265,11 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.' }, 'is_repeated_capability': True, - 'repeated_capability_type': 'channels', 'name': 'channelList', + 'repeated_capability_type': 'channels', 'type': 'ViConstString', 'use_array': False, 'use_in_python_api': True @@ -4408,7 +4278,7 @@ 'default_value': 'hightime.timedelta(seconds=10.0)', 'direction': 'in', 'documentation': { - 'description': 'Specifies the time, in seconds, allotted for the function to complete before returning a timeout error. A value of specifies the function waits until all data is available.', + 'description': 'Specifies in seconds the time allotted for the function to complete before returning a timeout error. A value of specifies the function waits until all data is available.' }, 'name': 'timeout', 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', @@ -4418,46 +4288,57 @@ 'use_in_python_api': True }, { + 'complex_array_representation': 'complex_number_array', 'direction': 'in', 'documentation': { - 'description': 'Specifies a pre-allocated numpy array to be filled with power spectrum data. Allocate an array at least as large as the number of spectral lines returned by the get_number_of_spectral_lines method.', + 'description': 'Returns the acquired waveform. Allocate an NIComplexNumber array at least as large as the number of samples configured in the nirfsa_ConfigureNumberOfSamples function.' }, - 'name': 'powerSpectrumDataArray', + 'name': 'iq_data_array', 'numpy': True, - 'size': {'mechanism': 'fixed', 'value': 1}, - 'type': 'ViReal64[]', + 'size': { + 'mechanism': 'fixed', + 'value': 1 + }, + 'type': 'NIComplexNumber[]', + 'type_in_documentation': 'numpy array of numpy.complex64, numpy array of numpy.complex128 or interleaved complex data in the form of numpy array of numpy.int16', 'use_in_python_api': True }, { 'direction': 'in', 'documentation': { - 'description': 'Specifies the size of the array that is returned by the **NIRFSA_ATTR_POWER_SPECTRUM_DATA** parameter. Use the nirfsa_GetNumberOfSpectralLines function to obtain the array size to allocate. The array must be at least as large as the number of spectral lines that NI-RFSA computes for the power spectrum.', + 'description': 'Specifies the size of the array for the NIRFSA_ATTR_DATA parameter. The array needs to be at least as large as the number of samples configured in the nirfsa_ConfigureNumberOfSamples function.' }, 'name': 'dataArraySize', - 'size': {'mechanism': 'python-code', 'value': 'len(power_spectrum_data_array)'}, - 'type': 'ViInt32', + 'size': { + 'mechanism': 'python-code', + 'value': '0 if iq_data_array is None else len(iq_data_array)' + }, + 'type': 'ViInt64', 'use_array': False, 'use_in_python_api': False }, { 'direction': 'out', 'documentation': { - 'description': 'Returns additional information about the **NIRFSA_ATTR_POWER_SPECTRUM_DATA** array. This information includes the frequency, in hertz (Hz), corresponding to the first element in the array, the frequency increment, in Hz, between adjacent array elements, and the number of spectral lines the function returned.', + 'description': 'Contains the absolute and relative timestamps for the operation, the time interval (dt), and the actual number of samples read.\n\nThe following list provides more information about each of these properties:\n\n- **absolute timestamp** Returns the timestamp, in seconds, of the first fetched sample that is comparable between records and acquisitions.\n\n----\n\nThe value of the absolute timestamp returned is always 0 for the PXIe-5644/5645/5646, PXIe-5668, and PXIe-5820/5830/5831/5832/5840/5841/5842/5860.\n\n----\n\n- **relative timestamp** Returns a timestamp that corresponds to the difference, in seconds, between the first sample returned and the Reference Trigger location. The timestamp is zero if the Reference Trigger has not occurred.\n\n----\n\n\nThe value of the relative timestamp returned is always 0 for the PXIe-5644/5645/5646.\n\n----\n\n- **dt** Returns the time interval between data points in the acquired signal. The I/Q data sample rate is the reciprocal of this value.\n- **actual samples read** Returns an integer representing the number of samples in the waveform.\n- **offset** Returns the offset to scale data, (*b*), in *mx* + *b* form.\n- **gain** Returns the gain to scale data, (*m*), in *mx* + *b* form.' }, - 'name': 'spectrumInfo', - 'type': 'niRFSA_spectrumInfo', + 'name': 'wfmInfo', + 'type': 'niRFSA_wfmInfo', 'use_array': False, 'use_in_python_api': True } ], + 'python_name': 'read_iq_single_record', + 'repeated_capability_type': 'channels', 'returns': 'ViStatus', - 'use_session_lock': True + 'use_session_lock': False }, 'ReadPowerSpectrumDispatcher': { 'codegen_method': 'python-only', 'documentation': { - 'description': 'Initiates a spectrum acquisition and returns power spectrum data.\n\n----\n**Note**\n Under certain configurations, negative infinity is returned from this VI. If the Reference Level is very high and if the Signal Bandwidth is comparatively less, the ADC returns zero, which equates to negative infinity in dBm. This is expected behavior.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5830/5831/5832/5840/5841/5842/5860', + 'description': 'Initiates a spectrum acquisition and returns power spectrum data.\n\n----\n**Note**\n Under certain configurations, negative infinity is returned from this VI. If the Reference Level is very high and if the Signal Bandwidth is comparatively less, the ADC returns zero, which equates to negative infinity in dBm. This is expected behavior.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5830/5831/5832/5840/5841/5842/5860' }, + 'has_repeated_capability': True, 'included_in_proto': False, 'is_error_handling': False, 'method_name_for_documentation': 'read_power_spectrum', @@ -4473,7 +4354,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -4483,11 +4364,11 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.', + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.' }, 'is_repeated_capability': True, - 'repeated_capability_type': 'channels', 'name': 'channelList', + 'repeated_capability_type': 'channels', 'type': 'ViConstString', 'use_array': False, 'use_in_python_api': True @@ -4495,7 +4376,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies a pre-allocated numpy array to be filled with power spectrum data. The dtype of this array determines the data format: numpy.float64 or numpy.float32. Allocate an array at least as large as the number of spectral lines returned by the get_number_of_spectral_lines method.', + 'description': 'Specifies a pre-allocated numpy array to be filled with power spectrum data. The dtype of this array determines the data format: numpy.float64 or numpy.float32. Allocate an array at least as large as the number of spectral lines returned by the get_number_of_spectral_lines method.' }, 'name': 'powerSpectrumDataArray', 'numpy': True, @@ -4507,7 +4388,7 @@ 'default_value': None, 'direction': 'in', 'documentation': { - 'description': 'Specifies the expected number of spectral lines. If None, falls back to self.number_of_spectral_lines.', + 'description': 'Specifies the expected number of spectral lines. If None, falls back to self.number_of_spectral_lines.' }, 'name': 'dataArraySize', 'type': 'ViInt32', @@ -4518,7 +4399,7 @@ 'default_value': 'hightime.timedelta(seconds=10.0)', 'direction': 'in', 'documentation': { - 'description': 'Specifies the time, in seconds, allotted for the function to complete before returning a timeout error. A value of specifies the function waits until all data is available.', + 'description': 'Specifies the time, in seconds, allotted for the function to complete before returning a timeout error. A value of specifies the function waits until all data is available.' }, 'name': 'timeout', 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', @@ -4529,17 +4410,116 @@ } ], 'python_name': 'read_power_spectrum', + 'repeated_capability_type': 'channels', 'returns': 'ViStatus', 'use_session_lock': False }, - 'reset': { - 'codegen_method': 'public', + 'ReadPowerSpectrumF32': { + 'codegen_method': 'private', 'documentation': { - 'description': 'Resets all properties to default values, deletes all de-embedding tables, and stops the export of all external signals and events.\n\nFor the PXI-5600, this function does not reset the PXI Clock signal that is driven by devices installed in the Trigger Controller Slot, also known as the System Timing Slot.\n\nThis 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. To avoid resetting routes on the device that are in use by NI-RFSG sessions, NI recommends using the nirfsa_ResetWithOptions function, with **stepsToOmit** set to NIRFSA_VAL_RESET_WITH_OPTIONS_ROUTES.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_\n\n`Events `_', + 'description': 'Initiates a spectrum acquisition and returns power spectrum data.\n\n----\n**Note**\n Under certain configurations, negative infinity is returned from this VI. If the Reference Level is very high and if the Signal Bandwidth is comparatively less, the ADC returns zero, which equates to negative infinity in dBm. This is expected behavior.\n\n----\n\n**Supported Devices**: PXIe-5830/5831/5832/5840/5841/5842/5860' }, - 'grpc_name': 'Reset', + 'has_repeated_capability': True, + 'included_in_proto': True, + 'method_name_for_documentation': 'read_power_spectrum', + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.' + }, + 'is_repeated_capability': True, + 'name': 'channelList', + 'repeated_capability_type': 'channels', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'default_value': 'hightime.timedelta(seconds=10.0)', + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the time, in seconds, allotted for the function to complete before returning a timeout error. A value of specifies the function waits until all data is available.' + }, + 'name': 'timeout', + 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Returns power spectrum data. Allocate an array as large as **NIRFSA_ATTR_DATA_ARRAY_SIZE**.' + }, + 'grpc_name': 'power_spectrum_data', + 'name': 'powerSpectrumData', + 'numpy': True, + 'python_name': 'power_spectrum_data_array', + 'size': { + 'mechanism': 'fixed', + 'value': 1 + }, + 'type': 'ViReal32[]', + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the size of the array that is returned by the **NIRFSA_ATTR_POWER_SPECTRUM_DATA** parameter. Use the nirfsa_GetNumberOfSpectralLines function to obtain the array size to allocate. The array must be at least as large as the number of spectral lines that NI-RFSA computes for the power spectrum.' + }, + 'name': 'dataArraySize', + 'size': { + 'mechanism': 'python-code', + 'value': 'len(power_spectrum_data_array)' + }, + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': False + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns additional information about the **NIRFSA_ATTR_POWER_SPECTRUM_DATA** array. This information includes the frequency, in hertz (Hz), corresponding to the first element in the array, the frequency increment, in Hz, between adjacent array elements, and the number of spectral lines the function returned.' + }, + 'name': 'spectrumInfo', + 'type': 'niRFSA_spectrumInfo', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'repeated_capability_type': 'channels', + 'returns': 'ViStatus', + 'use_session_lock': True + }, + 'ReadPowerSpectrumF64': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Initiates a spectrum acquisition and returns power spectrum data.\n\n----\n**Note**\n Under certain configurations, negative infinity is returned from this VI. If the Reference Level is very high and if the Signal Bandwidth is comparatively less, the ADC returns zero, which equates to negative infinity in dBm. This is expected behavior.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5830/5831/5832/5840/5841/5842/5860' + }, + 'has_repeated_capability': True, 'included_in_proto': True, 'is_error_handling': False, + 'method_name_for_documentation': 'read_power_spectrum', 'method_templates': [ { 'documentation_filename': 'default_method', @@ -4552,21 +4532,87 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', 'use_array': False, 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies which channels to apply settings. Specify an empty string as the value of this parameter.' + }, + 'is_repeated_capability': True, + 'name': 'channelList', + 'repeated_capability_type': 'channels', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'default_value': 'hightime.timedelta(seconds=10.0)', + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the time, in seconds, allotted for the function to complete before returning a timeout error. A value of specifies the function waits until all data is available.' + }, + 'name': 'timeout', + 'python_api_converter_name': 'convert_timedelta_to_seconds_real64', + 'type': 'ViReal64', + 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds', + 'use_array': False, + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies a pre-allocated numpy array to be filled with power spectrum data. Allocate an array at least as large as the number of spectral lines returned by the get_number_of_spectral_lines method.' + }, + 'grpc_name': 'power_spectrum_data', + 'name': 'powerSpectrumData', + 'numpy': True, + 'python_name': 'power_spectrum_data_array', + 'size': { + 'mechanism': 'fixed', + 'value': 1 + }, + 'type': 'ViReal64[]', + 'use_in_python_api': True + }, + { + 'direction': 'in', + 'documentation': { + 'description': 'Specifies the size of the array that is returned by the **NIRFSA_ATTR_POWER_SPECTRUM_DATA** parameter. Use the nirfsa_GetNumberOfSpectralLines function to obtain the array size to allocate. The array must be at least as large as the number of spectral lines that NI-RFSA computes for the power spectrum.' + }, + 'name': 'dataArraySize', + 'size': { + 'mechanism': 'python-code', + 'value': 'len(power_spectrum_data_array)' + }, + 'type': 'ViInt32', + 'use_array': False, + 'use_in_python_api': False + }, + { + 'direction': 'out', + 'documentation': { + 'description': 'Returns additional information about the **NIRFSA_ATTR_POWER_SPECTRUM_DATA** array. This information includes the frequency, in hertz (Hz), corresponding to the first element in the array, the frequency increment, in Hz, between adjacent array elements, and the number of spectral lines the function returned.' + }, + 'name': 'spectrumInfo', + 'type': 'niRFSA_spectrumInfo', + 'use_array': False, + 'use_in_python_api': True } ], + 'repeated_capability_type': 'channels', 'returns': 'ViStatus', 'use_session_lock': True }, 'ResetDevice': { 'codegen_method': 'public', 'documentation': { - 'description': 'Performs a hard reset on the device.\n\nA hard reset consists of the following actions:\n\n- Signal acquisition 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. For example, a trigger signal exported to a PXI trigger line that is used by another device is no longer exported.\n\nOn the PXI-5600, if you are driving the PXI_CLK10 line, you continue to drive the clock even after a device reset. To stop driving the PXI_CLK10 line, use the nirfsa_ConfigurePxiChassisClk10 function and set the **pxiClk10Source** parameter to NIRFSA_VAL_NONE or set the NIRFSA_ATTR_PXI_CHASSIS_CLK10_SOURCE attribute to NIRFSA_VAL_NONE.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698', + 'description': 'Performs a hard reset on the device.\n\nA hard reset consists of the following actions:\n\n- Signal acquisition 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. For example, a trigger signal exported to a PXI trigger line that is used by another device is no longer exported.\n\nOn the PXI-5600, if you are driving the PXI_CLK10 line, you continue to drive the clock even after a device reset. To stop driving the PXI_CLK10 line, use the nirfsa_ConfigurePxiChassisClk10 function and set the **pxiClk10Source** parameter to NIRFSA_VAL_NONE or set the NIRFSA_ATTR_PXI_CHASSIS_CLK10_SOURCE attribute to NIRFSA_VAL_NONE.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698' }, 'included_in_proto': True, 'is_error_handling': False, @@ -4582,7 +4628,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -4596,7 +4642,7 @@ 'ResetWithOptions': { 'codegen_method': 'public', 'documentation': { - 'description': 'Resets all properties to default values and specifies steps to omit during the reset process, such as signal routes.\n\nFor the PXI-5600, this function does not reset the PXI Clock signal that is driven by devices installed in the Star Trigger Controller Slot, also known as the System Timing Slot.\n\nBy default, this function resets all properties to their default values, deletes all de-embedding tables, aborts generation, clears all routes, and resets session properties to initial values. You can specify steps to omit using the steps to omit parameter. For example, if you specify NIRFSA_VAL_RESET_WITH_OPTIONS_ROUTES for the **NIRFSA_ATTR_STEPS_TO_OMIT** parameter, this function does not release signal routes during the reset process.\n\nWhen routes of signals between two devices are released, they are released regardless of which device created the route.\n\nTo avoid resetting routes on PXIe-5820/5830/5831/5832/5840/5841/5842/5860 that are in use by NI-RFSG sessions, NI recommends using this function instead of nirfsa_Reset, with **NIRFSA_ATTR_STEPS_TO_OMIT** set to NIRFSA_VAL_RESET_WITH_OPTIONS_ROUTES.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_\n\n`Events `_', + 'description': 'Resets all properties to default values and specifies steps to omit during the reset process, such as signal routes.\n\nFor the PXI-5600, this function does not reset the PXI Clock signal that is driven by devices installed in the Star Trigger Controller Slot, also known as the System Timing Slot.\n\nBy default, this function resets all properties to their default values, deletes all de-embedding tables, aborts generation, clears all routes, and resets session properties to initial values. You can specify steps to omit using the steps to omit parameter. For example, if you specify NIRFSA_VAL_RESET_WITH_OPTIONS_ROUTES for the **NIRFSA_ATTR_STEPS_TO_OMIT** parameter, this function does not release signal routes during the reset process.\n\nWhen routes of signals between two devices are released, they are released regardless of which device created the route.\n\nTo avoid resetting routes on PXIe-5820/5830/5831/5832/5840/5841/5842/5860 that are in use by NI-RFSG sessions, NI recommends using this function instead of nirfsa_Reset, with **NIRFSA_ATTR_STEPS_TO_OMIT** set to NIRFSA_VAL_RESET_WITH_OPTIONS_ROUTES.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_\n\n`Events `_' }, 'included_in_proto': True, 'is_error_handling': False, @@ -4612,7 +4658,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -4656,7 +4702,7 @@ 'SaveConfigurationsToFile': { 'codegen_method': 'public', 'documentation': { - 'description': '\nSaves the configurations of the session to the specified file.\n\n**Supported Devices** : PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + 'description': '\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': [ @@ -4671,7 +4717,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.', + 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.' }, 'name': 'vi', 'type': 'ViSession', @@ -4681,7 +4727,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the name of the channel.', + 'description': 'Specifies the name of the channel.' }, 'name': 'channelName', 'type': 'ViConstString', @@ -4691,7 +4737,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the absolute path of the file to which the NI-RFSA saves the configurations.', + 'description': 'Specifies the absolute path of the file to which the NI-RFSA saves the configurations.' }, 'name': 'filePath', 'type': 'ViConstString', @@ -4704,7 +4750,7 @@ 'SelfCalibrateRange': { 'codegen_method': 'public', 'documentation': { - 'description': 'Self-calibrates all configurations within the specified frequency and reference level limits.\n\nSelf-calibration range data is valid until you restart the system or call the nirfsa_ClearSelfCalibrateRange function.\n\nNI recommends that no external signals are present on the RF In port while the calibration is taking place.\n\n----\n**Note**\nThis function does not update self-calibration date and temperature.\n\n----\n\nFor best results, NI recommends that you perform a complete self-calibration without omitting any steps. However, if certain aspects of performance are less important for your application, you can omit that step for faster execution.\n\n----\n**Note**\nIf there is an existing NI-RFSG 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 niRFSG Commit or niRFSG Initiate.\n\n----\n\n----\n**Note**\nIf there is an existing NI-RFSG session open for the same PXIe-5644/5645/5646, it may remain open but cannot be used while this function runs.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842', + 'description': 'Self-calibrates all configurations within the specified frequency and reference level limits.\n\nSelf-calibration range data is valid until you restart the system or call the nirfsa_ClearSelfCalibrateRange function.\n\nNI recommends that no external signals are present on the RF In port while the calibration is taking place.\n\n----\n**Note**\nThis function does not update self-calibration date and temperature.\n\n----\n\nFor best results, NI recommends that you perform a complete self-calibration without omitting any steps. However, if certain aspects of performance are less important for your application, you can omit that step for faster execution.\n\n----\n**Note**\nIf there is an existing NI-RFSG 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 niRFSG Commit or niRFSG Initiate.\n\n----\n\n----\n**Note**\nIf there is an existing NI-RFSG session open for the same PXIe-5644/5645/5646, it may remain open but cannot be used while this function runs.\n\n----\n\n**Supported Devices**: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842' }, 'included_in_proto': True, 'is_error_handling': False, @@ -4720,7 +4766,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -4730,7 +4776,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies which calibration steps to skip as part of the self-calibration process. A value of 0 specifies all supported calibration steps are performed.\n\n----\n\nTo omit two or more calibration steps, specify a bitwise-OR combination of the following constants. For example, if you wanted to omit NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY and NIRFSA_VAL_SELF_CAL_LO_SELF_CAL, you would pass the following string to the nirfsa_SelfCalibrate function: NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY | NIRFSA_VAL_SELF_CAL_LO_SELF_CAL\n\n----\n\n| Value | Description |\n|:------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| NIRFSA_VAL_RESET_WITH_OPTIONS_NONE | No step is omitted during self-calibration. |\n| NIRFSA_VAL_SELF_CAL_PRESELECTOR_ALIGNMENT | Not used by this function. |\n| NIRFSA_VAL_SELF_CAL_GAIN_REFERENCE | Not used by this function. |\n| NIRFSA_VAL_SELF_CAL_IF_FLATNESS | Not used by this function. |\n| NIRFSA_VAL_SELF_CAL_DIGITIZER_SELF_CAL | Not used by this function. |\n| NIRFSA_VAL_SELF_CAL_LO_SELF_CAL | Omits the Local Oscillator (LO) Self Cal step. If you omit this step and the nirfsa_IsSelfCalValid function indicates the calibration data for this step is invalid, the LO phase-locked loop (PLL) may fail to lock. |\n| NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY | Omits the Amplitude Accuracy step. If you omit this step, the absolute accuracy of the device is not adjusted. |\n| NIRFSA_VAL_SELF_CAL_RESIDUAL_LO_POWER | Omits the Residual LO Power step. If you omit this step, the Residual LO Power performance is not adjusted. |\n|NIRFSA_VAL_SELF_CAL_IMAGE_SUPPRESSION | Omits the Image Suppression step. If you omit this step, the Residual Sideband Image Performance is not adjusted. |\n| NIRFSA_VAL_SELF_CAL_SYNTHESIZER_ALIGNMENT | Omits the Synthesizer Alignment step. If you omit this step, the LO PLL is not adjusted. This step is not valid for the PXIe-5820. |\n| NIRFSA_VAL_SELF_CAL_DC_OFFSET | Omits the DC Offset step. This step applies only to the PXIe-5820. |', + 'description': 'Specifies which calibration steps to skip as part of the self-calibration process. A value of 0 specifies all supported calibration steps are performed.\n\n----\n\nTo omit two or more calibration steps, specify a bitwise-OR combination of the following constants. For example, if you wanted to omit NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY and NIRFSA_VAL_SELF_CAL_LO_SELF_CAL, you would pass the following string to the nirfsa_SelfCalibrate function: NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY | NIRFSA_VAL_SELF_CAL_LO_SELF_CAL\n\n----\n\n| Value | Description |\n|:------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| NIRFSA_VAL_RESET_WITH_OPTIONS_NONE | No step is omitted during self-calibration. |\n| NIRFSA_VAL_SELF_CAL_PRESELECTOR_ALIGNMENT | Not used by this function. |\n| NIRFSA_VAL_SELF_CAL_GAIN_REFERENCE | Not used by this function. |\n| NIRFSA_VAL_SELF_CAL_IF_FLATNESS | Not used by this function. |\n| NIRFSA_VAL_SELF_CAL_DIGITIZER_SELF_CAL | Not used by this function. |\n| NIRFSA_VAL_SELF_CAL_LO_SELF_CAL | Omits the Local Oscillator (LO) Self Cal step. If you omit this step and the nirfsa_IsSelfCalValid function indicates the calibration data for this step is invalid, the LO phase-locked loop (PLL) may fail to lock. |\n| NIRFSA_VAL_SELF_CAL_AMPLITUDE_ACCURACY | Omits the Amplitude Accuracy step. If you omit this step, the absolute accuracy of the device is not adjusted. |\n| NIRFSA_VAL_SELF_CAL_RESIDUAL_LO_POWER | Omits the Residual LO Power step. If you omit this step, the Residual LO Power performance is not adjusted. |\n|NIRFSA_VAL_SELF_CAL_IMAGE_SUPPRESSION | Omits the Image Suppression step. If you omit this step, the Residual Sideband Image Performance is not adjusted. |\n| NIRFSA_VAL_SELF_CAL_SYNTHESIZER_ALIGNMENT | Omits the Synthesizer Alignment step. If you omit this step, the LO PLL is not adjusted. This step is not valid for the PXIe-5820. |\n| NIRFSA_VAL_SELF_CAL_DC_OFFSET | Omits the DC Offset step. This step applies only to the PXIe-5820. |' }, 'enum': 'SelfCalibrateRangeStepsToOmit', 'name': 'stepsToOmit', @@ -4742,10 +4788,11 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the minimum RF frequency in Hz.', + 'description': 'Specifies the minimum RF frequency in Hz.' }, 'grpc_name': 'min_frequency', - 'name': 'minimumFrequency', + 'name': 'minFrequency', + 'python_name': 'minimum_frequency', 'type': 'ViReal64', 'use_array': False, 'use_in_python_api': True @@ -4753,10 +4800,11 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the maximum RF frequency in Hz.', + 'description': 'Specifies the maximum RF frequency in Hz.' }, 'grpc_name': 'max_frequency', - 'name': 'maximumFrequency', + 'name': 'maxFrequency', + 'python_name': 'maximum_frequency', 'type': 'ViReal64', 'use_array': False, 'use_in_python_api': True @@ -4764,10 +4812,11 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the minimum reference level in dBm.', + 'description': 'Specifies the minimum reference level in dBm.' }, 'grpc_name': 'min_reference_level', - 'name': 'minimumReferenceLevel', + 'name': 'minReferenceLevel', + 'python_name': 'minimum_reference_level', 'type': 'ViReal64', 'use_array': False, 'use_in_python_api': True @@ -4775,10 +4824,11 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the maximum reference level in dBm.', + 'description': 'Specifies the maximum reference level in dBm.' }, 'grpc_name': 'max_reference_level', - 'name': 'maximumReferenceLevel', + 'name': 'maxReferenceLevel', + 'python_name': 'maximum_reference_level', 'type': 'ViReal64', 'use_array': False, 'use_in_python_api': True @@ -4790,7 +4840,7 @@ 'SendSoftwareEdgeTrigger': { 'codegen_method': 'public', 'documentation': { - 'description': 'Sends a trigger to the device when you use a software version of a supported trigger and the device is waiting for the trigger to be sent.\n\nYou can also use this function to override a hardware trigger.\n\nThis function returns an error in the following situations:\n\n- You configure an invalid trigger.\n- You set the **acquisitionType** to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function.\n- You have not previously called the nirfsa_Initiate function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Software Trigger `_\n\n`Triggers `_', + 'description': 'Sends a trigger to the device when you use a software version of a supported trigger and the device is waiting for the trigger to be sent.\n\nYou can also use this function to override a hardware trigger.\n\nThis function returns an error in the following situations:\n\n- You configure an invalid trigger.\n- You set the **acquisitionType** to NIRFSA_VAL_SPECTRUM using the nirfsa_ConfigureAcquisitionType function.\n- You have not previously called the nirfsa_Initiate function.\n\n**Supported Devices**: PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Software Trigger `_\n\n`Triggers `_' }, 'included_in_proto': True, 'is_error_handling': False, @@ -4806,7 +4856,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -4839,11 +4889,11 @@ 'use_in_python_api': True }, { + 'default_value': '""', 'direction': 'in', 'documentation': { - 'description': 'Specifies a particular instance of a trigger. NI-RFSA does not currently support this parameter.', + 'description': 'Specifies a particular instance of a trigger. NI-RFSA does not currently support this parameter.' }, - 'default_value': '""', 'name': 'triggerIdentifier', 'type': 'ViConstString', 'use_array': False, @@ -4856,7 +4906,7 @@ 'SetAttributeViBoolean': { 'codegen_method': 'private', 'documentation': { - 'description': 'Sets the value of a ViBoolean attribute.\n\nUse this low-level function to set the values of inherent IVI attributes and instrument-specific attributes.\n\nNI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread locking for you.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + 'description': 'Sets the value of a ViBoolean attribute.\n\nUse this low-level function to set the values of inherent IVI attributes and instrument-specific attributes.\n\nNI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread locking for you.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'is_error_handling': False, @@ -4872,7 +4922,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -4882,7 +4932,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.' }, 'name': 'channelName', 'type': 'ViConstString', @@ -4892,7 +4942,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Pass the ID of an attribute.', + 'description': 'Pass the ID of an attribute.' }, 'name': 'attributeId', 'type': 'ViAttr', @@ -4902,7 +4952,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Pass the value to which you want to set the attribute.\n\n----\n\nSome of the values might not be valid depending on the current state of the instrument session.\n\n----', + 'description': 'Pass the value to which you want to set the attribute.\n\n----\n\nSome of the values might not be valid depending on the current state of the instrument session.\n\n----' }, 'name': 'value', 'type': 'ViBoolean', @@ -4916,7 +4966,7 @@ 'SetAttributeViInt32': { 'codegen_method': 'private', 'documentation': { - 'description': 'Sets the value of a ViInt32 attribute.\n\nUse this low-level function to set the values of inherent IVI attributes and instrument-specific attributes.\n\nNI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread locking for you.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + 'description': 'Sets the value of a ViInt32 attribute.\n\nUse this low-level function to set the values of inherent IVI attributes and instrument-specific attributes.\n\nNI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread locking for you.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'is_error_handling': False, @@ -4932,7 +4982,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -4942,7 +4992,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel-based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel-based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.' }, 'name': 'channelName', 'type': 'ViConstString', @@ -4952,7 +5002,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Pass the ID of an attribute.', + 'description': 'Pass the ID of an attribute.' }, 'name': 'attributeId', 'type': 'ViAttr', @@ -4962,7 +5012,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Pass the value to which you want to set the attribute.\n\n----\n\nSome of the values might not be valid depending on the current state of the instrument session.\n\n----', + 'description': 'Pass the value to which you want to set the attribute.\n\n----\n\nSome of the values might not be valid depending on the current state of the instrument session.\n\n----' }, 'grpc_enum': 'NiRFSAInt32AttributeValues', 'grpc_mapped_enum': 'NiRFSAInt32AttributeValuesMapped', @@ -4978,7 +5028,7 @@ 'SetAttributeViInt64': { 'codegen_method': 'private', 'documentation': { - 'description': 'Sets the value of a ViInt64 attribute.\n\nUse this low-level function to set the values of inherent IVI attributes and instrument-specific attributes.\n\nNI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread locking for you.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + 'description': 'Sets the value of a ViInt64 attribute.\n\nUse this low-level function to set the values of inherent IVI attributes and instrument-specific attributes.\n\nNI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread locking for you.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'is_error_handling': False, @@ -4994,7 +5044,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -5004,7 +5054,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.' }, 'name': 'channelName', 'type': 'ViConstString', @@ -5014,7 +5064,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Pass the ID of an attribute.', + 'description': 'Pass the ID of an attribute.' }, 'name': 'attributeId', 'type': 'ViAttr', @@ -5024,7 +5074,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Pass the value to which you want to set the attribute.\n\n----\n\nSome of the values might not be valid depending on the current state of the instrument session.\n\n----', + 'description': 'Pass the value to which you want to set the attribute.\n\n----\n\nSome of the values might not be valid depending on the current state of the instrument session.\n\n----' }, 'grpc_name': 'value_raw', 'name': 'value', @@ -5039,7 +5089,7 @@ 'SetAttributeViReal64': { 'codegen_method': 'private', 'documentation': { - 'description': 'Sets the value of a ViReal64 attribute.\n\nUse this low-level function to set the values of inherent IVI attributes, and instrument-specific attributes.\n\nNI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread-locking for you.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + 'description': 'Sets the value of a ViReal64 attribute.\n\nUse this low-level function to set the values of inherent IVI attributes, and instrument-specific attributes.\n\nNI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread-locking for you.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'is_error_handling': False, @@ -5055,7 +5105,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -5065,7 +5115,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.' }, 'name': 'channelName', 'type': 'ViConstString', @@ -5075,7 +5125,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Pass the ID of an attribute.', + 'description': 'Pass the ID of an attribute.' }, 'name': 'attributeId', 'type': 'ViAttr', @@ -5085,7 +5135,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Pass the value to which you want to set the attribute.\n\n----\n\nSome of the values might not be valid depending on the current state of the instrument session.\n\n----', + 'description': 'Pass the value to which you want to set the attribute.\n\n----\n\nSome of the values might not be valid depending on the current state of the instrument session.\n\n----' }, 'grpc_enum': 'NiRFSAReal64AttributeValues', 'name': 'value', @@ -5100,7 +5150,7 @@ 'SetAttributeViSession': { 'codegen_method': 'private', 'documentation': { - 'description': 'Sets the value of a ViSession attribute.\n\nUse this low-level function to set the values of inherent IVI attributes and instrument-specific attributes.\n\nNI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread locking for you.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698', + 'description': 'Sets the value of a ViSession attribute.\n\nUse this low-level function to set the values of inherent IVI attributes and instrument-specific attributes.\n\nNI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread locking for you.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698' }, 'included_in_proto': True, 'is_error_handling': False, @@ -5116,7 +5166,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -5126,7 +5176,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.' }, 'name': 'channelName', 'type': 'ViConstString', @@ -5136,7 +5186,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Pass the ID of an attribute.', + 'description': 'Pass the ID of an attribute.' }, 'name': 'attributeId', 'type': 'ViAttr', @@ -5146,7 +5196,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Pass the value to which you want to set the attribute.\n\n----\n\nSome of the values might not be valid depending on the current state of the instrument session.\n\n----', + 'description': 'Pass the value to which you want to set the attribute.\n\n----\n\nSome of the values might not be valid depending on the current state of the instrument session.\n\n----' }, 'name': 'value', 'type': 'ViSession', @@ -5160,7 +5210,7 @@ 'SetAttributeViString': { 'codegen_method': 'private', 'documentation': { - 'description': 'Sets the value of a ViString attribute.\n\nUse this low-level function to set the values of inherent IVI attributes and instrument-specific attributes.\n\nNI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread locking for you.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860', + 'description': 'Sets the value of a ViString attribute.\n\nUse this low-level function to set the values of inherent IVI attributes and instrument-specific attributes.\n\nNI-RFSA contains high-level functions that set most of the instrument attributes. NI recommends you use the high-level functions as much as possible. High-level functions handle order dependencies and multithread locking for you.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'included_in_proto': True, 'is_error_handling': False, @@ -5176,7 +5226,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -5186,7 +5236,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.', + 'description': 'Specifies the name of the channel on which to check the attribute value if the attribute is channel based. If the attribute is not channel based, set this parameter to "" (empty string) or VI_NULL.' }, 'name': 'channelName', 'type': 'ViConstString', @@ -5196,7 +5246,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Pass the ID of an attribute.', + 'description': 'Pass the ID of an attribute.' }, 'name': 'attributeId', 'type': 'ViAttr', @@ -5206,7 +5256,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Pass the value to which you want to set the attribute.\n\n----\n\nSome of the values might not be valid depending on the current state of the instrument session.\n\n----', + 'description': 'Pass the value to which you want to set the attribute.\n\n----\n\nSome of the values might not be valid depending on the current state of the instrument session.\n\n----' }, 'grpc_mapped_enum': 'NiRFSAStringAttributeValuesMapped', 'name': 'value', @@ -5221,7 +5271,7 @@ 'UnlockSession': { 'codegen_method': 'public', 'documentation': { - 'description': 'Releases a lock obtained on an NI-RFSA device session by calling the nirfsa_LockSession function.\n\nRefer to the nirfsa_LockSession function for additional information on session locks.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698', + 'description': 'Releases a lock obtained on an NI-RFSA device session by calling the nirfsa_LockSession function.\n\nRefer to the nirfsa_LockSession function for additional information on session locks.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698' }, 'included_in_proto': True, 'method_templates': [ @@ -5236,7 +5286,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.', + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' }, 'name': 'vi', 'type': 'ViSession', @@ -5246,7 +5296,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Keeps track of whether you obtain a lock and therefore need to unlock the session in complex functions. 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 this function or the nirfsa_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 nirfsa_LockSession function and the nirfsa_UnlockSession function each inspect the current value and take the actions shown in the following table.\n\n| Function | Boolean Value | Action |\n|:---------------------|:--------------|:-----------------------------------------------------------------------------------------------------|\n| nirfsa_LockSession | VI_TRUE | The nirfsa_LockSession function does not lock the session again. |\n| | VI_FALSE | The nirfsa_LockSession function obtains the lock and sets the value of the parameter to VI_TRUE. |\n| nirfsa_UnlockSession | VI_FALSE | The nirfsa_UnlockSession function does not attempt to unlock the session. |\n| | VI_TRUE | The nirfsa_UnlockSession function releases the lock and sets the value of the parameter to VI_FALSE. |\n\nThus, you can call the nirfsa_UnlockSession function at the end of your function regardless of whether you actually have the lock.', + 'description': 'Keeps track of whether you obtain a lock and therefore need to unlock the session in complex functions. 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 this function or the nirfsa_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 nirfsa_LockSession function and the nirfsa_UnlockSession function each inspect the current value and take the actions shown in the following table.\n\n| Function | Boolean Value | Action |\n|:---------------------|:--------------|:-----------------------------------------------------------------------------------------------------|\n| nirfsa_LockSession | VI_TRUE | The nirfsa_LockSession function does not lock the session again. |\n| | VI_FALSE | The nirfsa_LockSession function obtains the lock and sets the value of the parameter to VI_TRUE. |\n| nirfsa_UnlockSession | VI_FALSE | The nirfsa_UnlockSession function does not attempt to unlock the session. |\n| | VI_TRUE | The nirfsa_UnlockSession function releases the lock and sets the value of the parameter to VI_FALSE. |\n\nThus, you can call the nirfsa_UnlockSession function at the end of your function regardless of whether you actually have the lock.' }, 'name': 'callerHasLock', 'type': 'ViBoolean', @@ -5259,6 +5309,30 @@ 'returns': 'ViStatus', 'use_session_lock': False }, + 'close': { + 'codegen_method': 'private', + 'documentation': { + 'description': 'Closes the session to the device.\n\nIf you close a session that has Soft Front Panel (SFP) session access enabled, any application connected to the shared device session is no longer usable. Refer to `Debugging Your Application Using SFP Session Access `_ for more information about using SFP session access.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' + }, + 'grpc_name': 'Close', + 'included_in_proto': True, + 'is_error_handling': False, + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'python_name': '_close', + 'returns': 'ViStatus', + 'use_session_lock': False + }, 'fancy_self_test': { 'codegen_method': 'python-only', 'documentation': { @@ -5292,7 +5366,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.', + 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.' }, 'name': 'vi', 'type': 'ViSession' @@ -5301,10 +5375,41 @@ 'python_name': 'self_test', 'returns': 'ViStatus' }, + 'reset': { + 'codegen_method': 'public', + 'documentation': { + 'description': 'Resets all properties to default values, deletes all de-embedding tables, and stops the export of all external signals and events.\n\nFor the PXI-5600, this function does not reset the PXI Clock signal that is driven by devices installed in the Trigger Controller Slot, also known as the System Timing Slot.\n\nThis 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. To avoid resetting routes on the device that are in use by NI-RFSG sessions, NI recommends using the nirfsa_ResetWithOptions function, with **stepsToOmit** set to NIRFSA_VAL_RESET_WITH_OPTIONS_ROUTES.\n\n**Supported Devices**: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694/5698, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Triggers `_\n\n`Events `_' + }, + 'grpc_name': 'Reset', + 'included_in_proto': True, + 'is_error_handling': False, + 'method_templates': [ + { + 'documentation_filename': 'default_method', + 'library_interpreter_filename': 'default_method', + 'method_python_name_suffix': '', + 'session_filename': 'default_method' + } + ], + 'parameters': [ + { + 'direction': 'in', + 'documentation': { + 'description': 'Identifies your instrument session. NIRFSA_ATTR_VI is obtained from the nirfsa_Init or nirfsa_InitWithOptions function.' + }, + 'name': 'vi', + 'type': 'ViSession', + 'use_array': False, + 'use_in_python_api': True + } + ], + 'returns': 'ViStatus', + 'use_session_lock': True + }, 'self_test': { 'codegen_method': 'private', 'documentation': { - 'description': 'Performs a self-test on the NI-RFSA device and returns the test results.\n\nThis function performs a simple series of tests to ensure that the NI-RFSA 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-RFSA 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 `_', + 'description': 'Performs a self-test on the NI-RFSA device and returns the test results.\n\nThis function performs a simple series of tests to ensure that the NI-RFSA 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-RFSA 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 `_' }, 'grpc_name': 'SelfTest', 'included_in_proto': True, @@ -5313,7 +5418,7 @@ { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.', + 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsa_Init function or the nirfsa_InitWithOptions function and identifies a particular instrument session.' }, 'name': 'vi', 'type': 'ViSession' @@ -5344,7 +5449,7 @@ { 'direction': 'out', 'documentation': { - 'description': 'Returns the self-test response string from the NI-RFSA 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.', + 'description': 'Returns the self-test response string from the NI-RFSA 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.' }, 'grpc_name': 'test_message', 'name': 'selfTestMessage', @@ -5356,5 +5461,5 @@ } ], 'returns': 'ViStatus' - }, + } } diff --git a/src/nirfsa/templates/session.py/fetch_iq_multi_record.py.mako b/src/nirfsa/templates/session.py/fetch_iq_multi_record.py.mako index 7f85f89f3..ab9a69a76 100644 --- a/src/nirfsa/templates/session.py/fetch_iq_multi_record.py.mako +++ b/src/nirfsa/templates/session.py/fetch_iq_multi_record.py.mako @@ -50,4 +50,4 @@ waveform_info._populate_samples_info(wfm_info, iq_data_arrays) - return wfm_info \ No newline at end of file + return wfm_info diff --git a/src/nirfsa/templates/session.py/fetch_iq_single_record.py.mako b/src/nirfsa/templates/session.py/fetch_iq_single_record.py.mako index af52f767a..7cf6fd7ac 100644 --- a/src/nirfsa/templates/session.py/fetch_iq_single_record.py.mako +++ b/src/nirfsa/templates/session.py/fetch_iq_single_record.py.mako @@ -4,7 +4,6 @@ import build.helper as helper suffix = method_template['method_python_name_suffix'] %>\ - def ${f['python_name']}${suffix}(${helper.get_params_snippet(f, helper.ParameterUsageOptions.SESSION_NUMPY_INTO_METHOD_DECLARATION)}): '''${f['python_name']}