From 2b4ec4a302d5757499ce53005f292d84890c54ba Mon Sep 17 00:00:00 2001 From: vnktshr21 Date: Thu, 20 Nov 2025 17:19:27 +0530 Subject: [PATCH 1/3] removal of IVI and old HW API --- docs/nirfsg/class.rst | 1891 +---------------- docs/nirfsg/enums.rst | 175 -- generated/nirfsg/nirfsg/_library.py | 126 -- .../nirfsg/nirfsg/_library_interpreter.py | 118 - generated/nirfsg/nirfsg/enums.py | 75 - generated/nirfsg/nirfsg/session.py | 987 +-------- .../nirfsg/nirfsg/unit_tests/_mock_helper.py | 169 -- src/nirfsg/metadata/attributes.py | 574 +---- src/nirfsg/metadata/enums.py | 125 -- src/nirfsg/metadata/functions.py | 781 +------ 10 files changed, 125 insertions(+), 4896 deletions(-) diff --git a/docs/nirfsg/class.rst b/docs/nirfsg/class.rst index d1373815c..82fb19703 100644 --- a/docs/nirfsg/class.rst +++ b/docs/nirfsg/class.rst @@ -210,259 +210,6 @@ change_external_calibration_password :type new_password: str -check_attribute_vi_boolean --------------------------- - - .. py:currentmodule:: nirfsg.Session - - .. py:method:: check_attribute_vi_boolean(attribute, value) - - Checks the validity of a value you specify for a ViBoolean property. - - - - - .. tip:: This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. - Use Python index notation on the repeated capabilities container channels to specify a subset, - and then call this method on the result. - - Example: :py:meth:`my_session.channels[ ... ].check_attribute_vi_boolean` - - To call the method on all channels, you can call it directly on the :py:class:`nirfsg.Session`. - - Example: :py:meth:`my_session.check_attribute_vi_boolean` - - - :param attribute: - - - Pass the ID of a property. - - - - - :type attribute: int - :param value: - - - Pass the value that you want to verify as a valid value for the property. - - - - .. note:: Some of the values might not be valid depending on the current settings of the instrument session. - - - :type value: bool - -check_attribute_vi_int32 ------------------------- - - .. py:currentmodule:: nirfsg.Session - - .. py:method:: check_attribute_vi_int32(attribute, value) - - Checks the validity of a value you specify for a ViInt32 property. - - - - - .. tip:: This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. - Use Python index notation on the repeated capabilities container channels to specify a subset, - and then call this method on the result. - - Example: :py:meth:`my_session.channels[ ... ].check_attribute_vi_int32` - - To call the method on all channels, you can call it directly on the :py:class:`nirfsg.Session`. - - Example: :py:meth:`my_session.check_attribute_vi_int32` - - - :param attribute: - - - Pass the ID of a property. - - - - - :type attribute: int - :param value: - - - Pass the value that you want to verify as a valid value for the property. - - - - .. note:: Some of the values might not be valid depending on the current settings of the instrument session. - - - :type value: int - -check_attribute_vi_int64 ------------------------- - - .. py:currentmodule:: nirfsg.Session - - .. py:method:: check_attribute_vi_int64(attribute, value) - - Checks the validity of a value you specify for a ViInt64 property. - - - - - .. tip:: This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. - Use Python index notation on the repeated capabilities container channels to specify a subset, - and then call this method on the result. - - Example: :py:meth:`my_session.channels[ ... ].check_attribute_vi_int64` - - To call the method on all channels, you can call it directly on the :py:class:`nirfsg.Session`. - - Example: :py:meth:`my_session.check_attribute_vi_int64` - - - :param attribute: - - - Pass the ID of a property. - - - - - :type attribute: int - :param value: - - - Pass the value that you want to verify as a valid value for the property. - - - - .. note:: Some of the values might not be valid depending on the current settings of the instrument session. - - - :type value: int - -check_attribute_vi_real64 -------------------------- - - .. py:currentmodule:: nirfsg.Session - - .. py:method:: check_attribute_vi_real64(attribute, value) - - Checks the validity of a value you specify for a ViReal64 property. - - - - - .. tip:: This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. - Use Python index notation on the repeated capabilities container channels to specify a subset, - and then call this method on the result. - - Example: :py:meth:`my_session.channels[ ... ].check_attribute_vi_real64` - - To call the method on all channels, you can call it directly on the :py:class:`nirfsg.Session`. - - Example: :py:meth:`my_session.check_attribute_vi_real64` - - - :param attribute: - - - Pass the ID of a property. - - - - - :type attribute: int - :param value: - - - Pass the value that you want to verify as a valid value for the property. - - - - .. note:: Some of the values might not be valid depending on the current settings of the instrument session. - - - :type value: float - -check_attribute_vi_session --------------------------- - - .. py:currentmodule:: nirfsg.Session - - .. py:method:: check_attribute_vi_session(attribute) - - Checks the validity of a value you specify for a ViSession property. - - - - - .. tip:: This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. - Use Python index notation on the repeated capabilities container channels to specify a subset, - and then call this method on the result. - - Example: :py:meth:`my_session.channels[ ... ].check_attribute_vi_session` - - To call the method on all channels, you can call it directly on the :py:class:`nirfsg.Session`. - - Example: :py:meth:`my_session.check_attribute_vi_session` - - - :param attribute: - - - Pass the ID of a property. - - - - - :type attribute: int - -check_attribute_vi_string -------------------------- - - .. py:currentmodule:: nirfsg.Session - - .. py:method:: check_attribute_vi_string(attribute, value) - - Checks the validity of a value you specify for a ViString property. - - - - - .. tip:: This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. - Use Python index notation on the repeated capabilities container channels to specify a subset, - and then call this method on the result. - - Example: :py:meth:`my_session.channels[ ... ].check_attribute_vi_string` - - To call the method on all channels, you can call it directly on the :py:class:`nirfsg.Session`. - - Example: :py:meth:`my_session.check_attribute_vi_string` - - - :param attribute: - - - Pass the ID of a property. - - - - - :type attribute: int - :param value: - - - Pass the value that you want to verify as a valid value for the property. The value must be a NULL-terminated string. - - - - .. note:: Some of the values might not be valid depending on the current settings of the instrument session. - - - :type value: str - check_generation_status ----------------------- @@ -636,29 +383,6 @@ clear_arb_waveform :type name: str -clear_error ------------ - - .. py:currentmodule:: nirfsg.Session - - .. py:method:: clear_error() - - Clears the error information associated with the session. - - If you pass VI_NULL for the :py:attr:`nirfsg.Session.VI` parameter, this method clears the error information for the current execution thread. - - The IVI Engine also maintains this error information separately for each thread. This feature of the IVI Engine is useful if you do not have a session handle to pass to the :py:meth:`nirfsg.Session.clear_error` method or the :py:meth:`nirfsg.Session.get_error` method, which occurs when a call to the :py:meth:`nirfsg.Session.Init` method or the :py:meth:`nirfsg.Session.__init__` method fails. - - **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860 - - - - .. note:: The :py:meth:`nirfsg.Session.get_error` method clears the error information after it is retrieved. A call to the :py:meth:`nirfsg.Session.clear_error` method is necessary only when you do not use a call to the :py:meth:`nirfsg.Session.get_error` method to retrieve error information. - - .. note:: One or more of the referenced properties are not in the Python API for this driver. - - - clear_self_calibrate_range -------------------------- @@ -991,75 +715,6 @@ configure_digital_level_script_trigger :type level: int -configure_digital_modulation_user_defined_waveform --------------------------------------------------- - - .. py:currentmodule:: nirfsg.Session - - .. py:method:: configure_digital_modulation_user_defined_waveform(number_of_samples, user_defined_waveform) - - Specifies the message signal used for digital modulation when the :py:attr:`nirfsg.Session.digital_modulation_waveform_type` property is set to :py:data:`~nirfsg.NIRFSG_VAL_USER_DEFINED`. - - **Supported Devices** : PXI/PXIe-5650/5651/5652 - - - - .. 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. - - - - :param number_of_samples: - - - Specifies the number of samples in the message signal. - - - - - :type number_of_samples: int - :param user_defined_waveform: - - - Specifies the user-defined message signal used for digital modulation. - - - - - :type user_defined_waveform: list of int - -configure_pxi_chassis_clk10 ---------------------------- - - .. py:currentmodule:: nirfsg.Session - - .. py:method:: configure_pxi_chassis_clk10(pxi_clk10_source) - - Specifies the signal to drive the 10MHz Reference Clock on the PXI backplane. - - This option can only be configured when the PXI-5610 is in Slot 2 of the PXI chassis. The NI-RFSG device must be in the Configuration state before you call this method. - - **Supported Devices** : PXI-5610, PXI-5670/5671 - - **Related Topics** - - `Timing Configurations `_ - - `System Reference Clock `_ - - - - - - :param pxi_clk10_source: - - - Specifies the source of the Reference Clock signal. - - - - - :type pxi_clk10_source: str - configure_ref_clock ------------------- @@ -1416,31 +1071,16 @@ delete_deembedding_table :type table_name: str -disable -------- +disable_script_trigger +---------------------- .. py:currentmodule:: nirfsg.Session - .. py:method:: disable() + .. py:method:: disable_script_trigger() - Places the instrument in a quiescent state where it has minimal or no impact on the system to which it is connected. + Configures the device not to wait for the specified Script Trigger. - **Supported Devices** : PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXI-5670/5671, PXIe-5672/5673/5673E - - - - - -disable_script_trigger ----------------------- - - .. py:currentmodule:: nirfsg.Session - - .. py:method:: disable_script_trigger() - - Configures the device not to wait for the specified Script Trigger. - - Call this method only if you previously configured a Script Trigger and now want it disabled. The NI-RFSG device must be in the Configuration state before you call this method. + Call this method only if you previously configured a Script Trigger and now want it disabled. The NI-RFSG device must be in the Configuration state before you call this method. **Supported Devices** : PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 @@ -1521,44 +1161,6 @@ error_message :type error_message: str -error_query ------------ - - .. py:currentmodule:: nirfsg.Session - - .. py:method:: error_query() - - Reads an error code and an error message from the instrument error queue. - - **Supported Devices** : PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860 - - - - - - :rtype: tuple (error_code, error_message) - - WHERE - - error_code (int): - - - Returns the error code read from the instrument error queue. - - - - - error_message (str): - - - Returns the error message string read from the instrument error message queue. - - You must pass a ViChar array with at least 256 bytes. - - - - - get_all_named_waveform_names ---------------------------- @@ -1609,41 +1211,6 @@ get_all_script_names -get_channel_name ----------------- - - .. py:currentmodule:: nirfsg.Session - - .. py:method:: get_channel_name(index) - - Returns the channel string that is in the channel table at an index you specify. - - **Supported Devices** : PXI-5670/5671, PXIe-5672/5673/5673E - - - - - - :param index: - - - Specifies a one-based index into the channel table. - - - - - :type index: int - - :rtype: str - :return: - - - Returns a channel string from the channel table at the index you specify in the Index parameter. Do not modify the contents of the channel string. - - - - - get_deembedding_sparameters --------------------------- @@ -1688,7 +1255,9 @@ get_error - .. note:: If the **bufferSize** parameter is 0, this method does not clear the error information. By passing 0 to the **bufferSize** parameter, you can determine the buffer size required to obtain the entire :py:attr:`nirfsg.Session.ERROR_DESCRIPTION` string. You can then call this method again with a sufficiently large buffer. If you specify a valid IVI session for the :py:attr:`nirfsg.Session.VI` parameter, this method retrieves and clears the error information for the session. If you pass VI_NULL for the :py:attr:`nirfsg.Session.VI` parameter, this method retrieves and clears the error information for the current execution thread. If the :py:attr:`nirfsg.Session.VI` parameter is an invalid session, this method does nothing and returns an error. Normally, the error information describes the first error that occurred since the user last called this method or the :py:meth:`nirfsg.Session.clear_error` method. + .. note:: If the **bufferSize** parameter is 0, this method does not clear the error information. By passing 0 to the **bufferSize** parameter, you can determine the buffer size required to obtain the entire :py:attr:`nirfsg.Session.ERROR_DESCRIPTION` string. You can then call this method again with a sufficiently large buffer. If you specify a valid IVI session for the :py:attr:`nirfsg.Session.VI` parameter, this method retrieves and clears the error information for the session. If you pass VI_NULL for the :py:attr:`nirfsg.Session.VI` parameter, this method retrieves and clears the error information for the current execution thread. If the :py:attr:`nirfsg.Session.VI` parameter is an invalid session, this method does nothing and returns an error. Normally, the error information describes the first error that occurred since the user last called this method or the :py:meth:`nirfsg.Session.ClearError` method. + + .. note:: One or more of the referenced methods are not in the Python API for this driver. .. note:: One or more of the referenced properties are not in the Python API for this driver. @@ -2359,41 +1928,6 @@ reset -reset_attribute ---------------- - - .. py:currentmodule:: nirfsg.Session - - .. py:method:: reset_attribute(attribute_id) - - Resets the property to its default value. - - **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - - - - - .. tip:: This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. - Use Python index notation on the repeated capabilities container channels to specify a subset, - and then call this method on the result. - - Example: :py:meth:`my_session.channels[ ... ].reset_attribute` - - To call the method on all channels, you can call it directly on the :py:class:`nirfsg.Session`. - - Example: :py:meth:`my_session.reset_attribute` - - - :param attribute_id: - - - Pass the ID of a property. - - - - - :type attribute_id: int - reset_device ------------ @@ -2495,46 +2029,6 @@ reset_with_options :type steps_to_omit: :py:data:`nirfsg.ResetWithOptionsStepsToOmit` -revision_query --------------- - - .. py:currentmodule:: nirfsg.Session - - .. py:method:: revision_query() - - Returns the revision numbers of the NI-RFSG driver and the instrument firmware. - - **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - - - - - - :rtype: tuple (instrument_driver_revision, firmware_revision) - - WHERE - - instrument_driver_revision (str): - - - Returns the value of the :py:attr:`nirfsg.Session.specific_driver_revision` property in the form of a string. - - You must pass a ViChar array with at least 256 bytes. - - - - - firmware_revision (str): - - - Returns the value of the :py:attr:`nirfsg.Session.instrument_firmware_revision` property in the form of a string. - - You must pass a ViChar array with at least 256 bytes. - - - - - save_configurations_to_file --------------------------- @@ -3493,41 +2987,6 @@ analog_modulation_fm_band - LabVIEW Property: **Modulation:Analog:FM Band** - C Attribute: **NIRFSG_ATTR_ANALOG_MODULATION_FM_BAND** -analog_modulation_fm_deviation ------------------------------- - - .. py:attribute:: analog_modulation_fm_deviation - - Specifies the frequency deviation to use in frequency modulation. - - **Units**: hertz (Hz) - - **Default Value:** 1kHz - - **Supported Devices:** PXI/PXIe-5650/5651/5652 - - **Related Topics** - - `Modulation Schemes `_ - - The following table lists the characteristics of this property. - - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | float | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Modulation:Analog:FM Deviation (Hz)** - - C Attribute: **NIRFSG_ATTR_ANALOG_MODULATION_FM_DEVIATION** - analog_modulation_fm_narrowband_integrator ------------------------------------------ @@ -3776,86 +3235,6 @@ analog_modulation_type - LabVIEW Property: **Modulation:Analog:Modulation Type** - C Attribute: **NIRFSG_ATTR_ANALOG_MODULATION_TYPE** -analog_modulation_waveform_frequency ------------------------------------- - - .. py:attribute:: analog_modulation_waveform_frequency - - Specifies the frequency of the waveform to use as the message signal in analog modulation. - - **Units:** hertz (Hz) - - **Default Value:** 1kHz - - **Supported Devices:** PXI/PXIe-5650/5651/5652 - - **Related Topics** - - `Modulation Schemes `_ - - The following table lists the characteristics of this property. - - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | float | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Modulation:Analog:Waveform Frequency (Hz)** - - C Attribute: **NIRFSG_ATTR_ANALOG_MODULATION_WAVEFORM_FREQUENCY** - -analog_modulation_waveform_type -------------------------------- - - .. py:attribute:: analog_modulation_waveform_type - - Specifies the type of waveform to use as the message signal for analog modulation. - - **Default Value:** :py:data:`~nirfsg.AnalogModulationWaveformType.SINE` - - **Supported Devices:** PXI/PXIe-5650/5651/5652 - - **Related Topics** - - `Modulation Schemes `_ - - **Defined Values**: - - +----------------------------------------------------------+--------------+-----------------------------------------------------------------+ - | Name | Value | Description | - +==========================================================+==============+=================================================================+ - | :py:data:`~nirfsg.AnalogModulationWaveformType.SINE` | 3000 (0xbb8) | Specifies that the analog modulation waveform type is sine. | - +----------------------------------------------------------+--------------+-----------------------------------------------------------------+ - | :py:data:`~nirfsg.AnalogModulationWaveformType.SQUARE` | 3001 (0xbb9) | Specifies that the analog modulation waveform type is square. | - +----------------------------------------------------------+--------------+-----------------------------------------------------------------+ - | :py:data:`~nirfsg.AnalogModulationWaveformType.TRIANGLE` | 3002 (0xbba) | Specifies that the analog modulation waveform type is triangle. | - +----------------------------------------------------------+--------------+-----------------------------------------------------------------+ - - The following table lists the characteristics of this property. - - +-----------------------+------------------------------------+ - | Characteristic | Value | - +=======================+====================================+ - | Datatype | enums.AnalogModulationWaveformType | - +-----------------------+------------------------------------+ - | Permissions | read-write | - +-----------------------+------------------------------------+ - | Repeated Capabilities | None | - +-----------------------+------------------------------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Modulation:Analog:Waveform Type** - - C Attribute: **NIRFSG_ATTR_ANALOG_MODULATION_WAVEFORM_TYPE** - arb_carrier_frequency --------------------- @@ -3930,144 +3309,47 @@ arb_digital_gain - C Attribute: **NIRFSG_ATTR_ARB_DIGITAL_GAIN** -arb_filter_raised_cosine_alpha ------------------------------- +arb_max_number_waveforms +------------------------ + + .. py:attribute:: arb_max_number_waveforms - .. py:attribute:: arb_filter_raised_cosine_alpha + Returns the maximum number of waveforms the device can hold in memory. + + **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - Specifies the alpha value to use when calculating the pulse-shaping filter coefficients. You can use this property only when the :py:attr:`nirfsg.Session.arb_filter_type` property is set to :py:data:`~nirfsg.FilterType.ARB_FILTER_TYPE_RAISED_COSINE` and with signal generators that support onboard signal processing (OSP). NI-RFSG returns an error if you use this property with a device that does not support OSP. + **High-Level Methods**: - **Supported Devices:** PXI-5671, PXIe-5672/5673/5673E + - :py:meth:`nirfsg.Session.query_arb_waveform_capabilities` The following table lists the characteristics of this property. - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | float | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ + +-----------------------+-----------+ + | Characteristic | Value | + +=======================+===========+ + | Datatype | int | + +-----------------------+-----------+ + | Permissions | read only | + +-----------------------+-----------+ + | Repeated Capabilities | None | + +-----------------------+-----------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: - - LabVIEW Property: **Arb:Pulse Shaping:Raised Cosine Alpha** - - C Attribute: **NIRFSG_ATTR_ARB_FILTER_RAISED_COSINE_ALPHA** + - LabVIEW Property: **Arb:Waveform Capabilities:Max Number Waveforms** + - C Attribute: **NIRFSG_ATTR_ARB_MAX_NUMBER_WAVEFORMS** -arb_filter_root_raised_cosine_alpha ------------------------------------ +arb_onboard_sample_clock_mode +----------------------------- - .. py:attribute:: arb_filter_root_raised_cosine_alpha + .. py:attribute:: arb_onboard_sample_clock_mode - Specifies the alpha value to use when calculating the pulse-shaping FIR filter coefficients. You can use this property only when the :py:attr:`nirfsg.Session.arb_filter_type` property is set to :py:data:`~nirfsg.FilterType.ARB_FILTER_TYPE_ROOT_RAISED_COSINE` and with signal generators that support onboard signal processing (OSP). NI-RFSG returns an error if you use this property with a device that does not support OSP. + Specifies the Sample Clock mode on the device. To set this property, the device must be in the Configuration state. - **Supported Devices:** PXI-5671, PXIe-5672/5673/5673E + PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: :py:data:`~nirfsg.ArbOnboardSampleClockMode.DIVIDE_DOWN` is the only supported value for this device. - The following table lists the characteristics of this property. - - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | float | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arb:Pulse Shaping:Root Raised Cosine Alpha** - - C Attribute: **NIRFSG_ATTR_ARB_FILTER_ROOT_RAISED_COSINE_ALPHA** - -arb_filter_type ---------------- - - .. py:attribute:: arb_filter_type - - Specifies the pulse-shaping filter type for the FIR filter. You can use this property only with signal generators that support onboard signal processing (OSP). NI-RFSG returns an error if you use this property with a device that does not support OSP. - - **Default Value:** :py:data:`~nirfsg.FilterType.NONE` - - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - - **Defined Values**: - - +------------------------------------------------------------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +==================================================================+================+=================================================================================================================================================================+ - | :py:data:`~nirfsg.FilterType.NONE` | 0 (0x0) | Disables analog modulation. | - +------------------------------------------------------------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.FilterType.ARB_FILTER_TYPE_RAISED_COSINE` | 10002 (0x2712) | Applies a raised cosine filter to the data with the alpha value specified with the :py:attr:`nirfsg.Session.arb_filter_raised_cosine_alpha` property. | - +------------------------------------------------------------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.FilterType.ARB_FILTER_TYPE_ROOT_RAISED_COSINE` | 10001 (0x2711) | Applies a root-raised cosine filter to the data with the alpha value specified with the :py:attr:`nirfsg.Session.arb_filter_root_raised_cosine_alpha` property. | - +------------------------------------------------------------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. - - The following table lists the characteristics of this property. - - +-----------------------+------------------+ - | Characteristic | Value | - +=======================+==================+ - | Datatype | enums.FilterType | - +-----------------------+------------------+ - | Permissions | read-write | - +-----------------------+------------------+ - | Repeated Capabilities | None | - +-----------------------+------------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arb:Pulse Shaping:Filter Type** - - C Attribute: **NIRFSG_ATTR_ARB_FILTER_TYPE** - -arb_max_number_waveforms ------------------------- - - .. py:attribute:: arb_max_number_waveforms - - Returns the maximum number of waveforms the device can hold in memory. - - **Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - - **High-Level Methods**: - - - :py:meth:`nirfsg.Session.query_arb_waveform_capabilities` - - The following table lists the characteristics of this property. - - +-----------------------+-----------+ - | Characteristic | Value | - +=======================+===========+ - | Datatype | int | - +-----------------------+-----------+ - | Permissions | read only | - +-----------------------+-----------+ - | Repeated Capabilities | None | - +-----------------------+-----------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arb:Waveform Capabilities:Max Number Waveforms** - - C Attribute: **NIRFSG_ATTR_ARB_MAX_NUMBER_WAVEFORMS** - -arb_onboard_sample_clock_mode ------------------------------ - - .. py:attribute:: arb_onboard_sample_clock_mode - - Specifies the Sample Clock mode on the device. To set this property, the device must be in the Configuration state. - - PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: :py:data:`~nirfsg.ArbOnboardSampleClockMode.DIVIDE_DOWN` is the only supported value for this device. - - **Default Values:** + **Default Values:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: :py:data:`~nirfsg.ArbOnboardSampleClockMode.DIVIDE_DOWN` @@ -4109,66 +3391,6 @@ arb_onboard_sample_clock_mode - LabVIEW Property: **Clock:Arb Onboard Sample Clock Mode** - C Attribute: **NIRFSG_ATTR_ARB_ONBOARD_SAMPLE_CLOCK_MODE** -arb_oscillator_phase_dac_value ------------------------------- - - .. py:attribute:: arb_oscillator_phase_dac_value - - Specifies the oscillator phase digital-to-analog converter (DAC) value on the arbitrary waveform generator (AWG). Use this property to reduce the trigger jitter when synchronizing multiple devices with NI-TClk. This property can also help maintain synchronization repeatability by writing a previous measurement's phase DAC value to the current session. This property is applicable only when using the :py:attr:`nirfsg.Session.arb_sample_clock_source` property set to ClkIn. - - **Supported Devices:** PXIe-5673/5673E - - **Related Topics** - - `NI-TClk Overview `_ - - The following table lists the characteristics of this property. - - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | int | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Clock:Advanced:Arb Oscillator Phase DAC Value** - - C Attribute: **NIRFSG_ATTR_ARB_OSCILLATOR_PHASE_DAC_VALUE** - -arb_power ---------- - - .. py:attribute:: arb_power - - Indicates the average output power from the PXI-5421, PXI-5441, PXIe-5442, and PXIe-5450 AWG module. If an arbitrary waveform is being generated, this property specifies either the average power or the peak power of the signal, depending on the :py:attr:`nirfsg.Session.power_level_type` property setting. - - **Units**: dBm - - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - - The following table lists the characteristics of this property. - - +-----------------------+-----------+ - | Characteristic | Value | - +=======================+===========+ - | Datatype | float | - +-----------------------+-----------+ - | Permissions | read only | - +-----------------------+-----------+ - | Repeated Capabilities | None | - +-----------------------+-----------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arb:Arb Power (dBm)** - - C Attribute: **NIRFSG_ATTR_ARB_POWER** - arb_pre_filter_gain ------------------- @@ -4548,107 +3770,6 @@ arb_waveform_software_scaling_factor - LabVIEW Property: **Arb:Software Scaling Factor** - C Attribute: **NIRFSG_ATTR_ARB_WAVEFORM_SOFTWARE_SCALING_FACTOR** -attenuator_hold_enabled ------------------------ - - .. py:attribute:: attenuator_hold_enabled - - Specifies whether attenuator hold is enabled. While this property is set to True, changing the power level causes NI-RFSG to scale the digital data sent to the AWG instead of adjusting the attenuators. Changing power levels in this manner allows the device to increase or decrease the power level in more accurate increments, but it may affect signal-to-noise ratios (noise density). - - Setting the :py:attr:`nirfsg.Session.attenuator_hold_enabled` property to True limits the power levels that can be attained. With attenuator hold enabled, the power level must satisfy the following conditions: - - - Power level less than or equal to :py:attr:`nirfsg.Session.attenuator_hold_max_power` - - Power level greater than or equal to (maximum power level -70dB) - - Power level greater than or equal to -145dBm - - To set this property, the NI-RFSG device must be in the Configuration state. - - **Default Value:** False - - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - - **Related Topics** - - `Attenuator Hold `_ - - `Settling Times `_ - - **Defined Values**: - - +-------+---------------------------+ - | Value | Description | - +=======+===========================+ - | True | Enables attenuator hold. | - +-------+---------------------------+ - | False | Disables attenuator hold. | - +-------+---------------------------+ - - .. note:: The frequency cannot be changed on the PXI-5670/5671 or PXIe-5672 while this property is set to True. - - The following table lists the characteristics of this property. - - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | bool | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **RF:Attenuator Hold Enabled** - - C Attribute: **NIRFSG_ATTR_ATTENUATOR_HOLD_ENABLED** - -attenuator_hold_max_power -------------------------- - - .. py:attribute:: attenuator_hold_max_power - - Specifies the maximum power level of the RF output signal when the :py:attr:`nirfsg.Session.attenuator_hold_enabled` property is set to True. - - To set this property, the NI-RFSG device must be in the Configuration state. - - **Units**: dBm - - **Defined Values**: - Refer to the specifications document for your device for allowable maximum power levels. - - **Default Value:** - - PXI-5670/5671, PXIe-5672: 17 - - PXIe-5673/5673E: 10 - - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - - **Related Topics** - - `Attenuator Hold `_ - - `Settling Times `_ - - The following table lists the characteristics of this property. - - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | float | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **RF:Attenuator Hold Max Power (dBm)** - - C Attribute: **NIRFSG_ATTR_ATTENUATOR_HOLD_MAX_POWER** - attenuator_setting ------------------ @@ -4826,310 +3947,82 @@ available_ports | Datatype | str | +-----------------------+-----------+ | Permissions | read only | - +-----------------------+-----------+ - | Repeated Capabilities | None | - +-----------------------+-----------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Device Specific:Vector Signal Transceiver:Signal Path:Available Ports** - - C Attribute: **NIRFSG_ATTR_AVAILABLE_PORTS** - -cache ------ - - .. py:attribute:: cache - - Specifies whether to cache the value of properties. When caching is enabled, NI-RFSG tracks the current NI-RFSG device settings and avoids sending redundant commands to the device. NI-RFSG can always cache or never cache particular properties, regardless of the setting of this property. Call the :py:meth:`nirfsg.Session.__init__` method to override the default value. - - **Default Value:** True - - **Supported Devices:** PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - - **Defined Values**: - - +-------+-------------------+ - | Value | Description | - +=======+===================+ - | True | Enables caching. | - +-------+-------------------+ - | False | Disables caching. | - +-------+-------------------+ - - The following table lists the characteristics of this property. - - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | bool | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Inherent IVI Attributes:User Options:Cache** - - C Attribute: **NIRFSG_ATTR_CACHE** - -compensate_for_filter_group_delay ---------------------------------- - - .. py:attribute:: compensate_for_filter_group_delay - - Enables or disables compensation for filter group delay on the AWG module. This property also accounts for the upconverter group delay and aligns the RF output with the Started Event, Done Event, and Marker Events. - - At a low I/Q rate, the group delay can become so large that some devices may not be able to align the events with the RF output, in which case you must increase the I/Q rate or disable this property. - - **Default Value:** False - - **Supported Devices:** PXIe-5672 - - **Defined Values**: - - +-------+-----------------------------------------------+ - | Value | Description | - +=======+===============================================+ - | True | Enables compensation for filter group delay. | - +-------+-----------------------------------------------+ - | False | Disables compensation for filter group delay. | - +-------+-----------------------------------------------+ - - The following table lists the characteristics of this property. - - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | bool | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arb:Advanced:Compensate for Filter Group Delay** - - C Attribute: **NIRFSG_ATTR_COMPENSATE_FOR_FILTER_GROUP_DELAY** - -configuration_settled_event_terminal_name ------------------------------------------ - - .. py:attribute:: configuration_settled_event_terminal_name - - Returns the name of the fully qualified signal name as a string. - - **Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842 - - **Default Values**: - - PXIe-5654/5654 with PXIe-5696: /*ModuleName*/ConfigurationSettledEvent, where *ModuleName* is the name of your device in MAX. - - PXIe-5830/5831/5832: /*BasebandModule*/ao/0/ConfigurationSettledEvent, where *BasebandModule* is the name of the baseband module of your device in MAX. - - PXIe-5820/5840/5841/5842: /*ModuleName*/ao/0/ConfigurationSettledEvent, where *ModuleName* is the name of your device in MAX. - - **Related Topics** - - `Events `_ - - `Syntax for Terminal Names `_ - - The following table lists the characteristics of this property. - - +-----------------------+-----------+ - | Characteristic | Value | - +=======================+===========+ - | Datatype | str | - +-----------------------+-----------+ - | Permissions | read only | - +-----------------------+-----------+ - | Repeated Capabilities | None | - +-----------------------+-----------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Events:Configuration Settled Event Terminal Name** - - C Attribute: **NIRFSG_ATTR_CONFIGURATION_SETTLED_EVENT_TERMINAL_NAME** - -correction_temperature ----------------------- - - .. py:attribute:: correction_temperature - - Specifies the temperature, in degrees Celsius, to use for adjusting the device settings to correct for temperature changes. If you set this property, NI-RFSG uses the value you specify and therefore no longer uses the actual device temperature as the correction temperature. If you do not set this property, NI-RFSG checks the current device temperature in the Committed state and automatically sets the value of this property. - - PXIe-5820/5830/5831/5832/5840/5841/5842/5860: This property is read only. - - **Units**: Degrees Celsius - - **Supported Devices**: PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - - - - .. note:: - Resetting this property reverts back to the default unset behavior. - - - Use this property only when your application requires the same settings to be used every time, regardless of the temperature variation. In these cases, it is best to ensure that the temperature does not vary too much. - - The following table lists the characteristics of this property. - - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | float | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **RF:Advanced:Correction Temperature** - - C Attribute: **NIRFSG_ATTR_CORRECTION_TEMPERATURE** - -data_transfer_block_size ------------------------- - - .. py:attribute:: data_transfer_block_size - - Indicates the number of samples to transfer at one time from the device to host memory. This property is useful when the total data to be transferred to onboard memory is large. - - **Units**: samples (s) - - **Default Value**: 1Ms - - **Supported Devices:** PXIe-5672/5673/5673E - - The following table lists the characteristics of this property. - - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | int | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Arb:Data Transfer:Data Transfer Block Size** - - C Attribute: **NIRFSG_ATTR_DATA_TRANSFER_BLOCK_SIZE** - -data_transfer_maximum_bandwidth -------------------------------- - - .. py:attribute:: data_transfer_maximum_bandwidth - - Specifies the maximum amount of bus bandwidth to use for data transfers. - - **Units**: bytes per second - - **Default Value**: Device maximum - - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - - **Related Topics** - - `Improving Streaming Performance `_ - - The following table lists the characteristics of this property. - - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | float | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ + +-----------------------+-----------+ + | Repeated Capabilities | None | + +-----------------------+-----------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: - - LabVIEW Property: **Arb:Data Transfer:Maximum Bandwidth** - - C Attribute: **NIRFSG_ATTR_DATA_TRANSFER_MAXIMUM_BANDWIDTH** + - LabVIEW Property: **Device Specific:Vector Signal Transceiver:Signal Path:Available Ports** + - C Attribute: **NIRFSG_ATTR_AVAILABLE_PORTS** -data_transfer_maximum_in_flight_reads -------------------------------------- +configuration_settled_event_terminal_name +----------------------------------------- - .. py:attribute:: data_transfer_maximum_in_flight_reads + .. py:attribute:: configuration_settled_event_terminal_name - Specifies the maximum number of concurrent PCI Express read requests the RF signal generator can issue. + Returns the name of the fully qualified signal name as a string. - When transferring data from computer memory to device onboard memory across the PCI Express bus, the signal generator can issue multiple memory reads at the same time. In general, the larger the number of read requests, the more efficiently the device uses the bus because the multiple read requests keep the data flowing, even in a PCI Express topology that has high latency due to PCI Express switches in the data path. Most NI devices can issue a large number of read requests (typically 8 or 16). By default, this property is set to the highest value the RF signal generator supports. + **Supported Devices:** PXIe-5654/5654 with PXIe-5696, PXIe-5820/5830/5831/5832/5840/5841/5842 - If other devices in your system cannot tolerate long data latencies, it may be helpful to decrease the number of in-flight read requests the RF signal generator issues. This helps to reduce the amount of data the signal generator reads at one time. + **Default Values**: - **Units**: number of packets + PXIe-5654/5654 with PXIe-5696: /*ModuleName*/ConfigurationSettledEvent, where *ModuleName* is the name of your device in MAX. - **Default Value**: Device maximum + PXIe-5830/5831/5832: /*BasebandModule*/ao/0/ConfigurationSettledEvent, where *BasebandModule* is the name of the baseband module of your device in MAX. - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E + PXIe-5820/5840/5841/5842: /*ModuleName*/ao/0/ConfigurationSettledEvent, where *ModuleName* is the name of your device in MAX. **Related Topics** - `Improving Streaming Performance `_ + `Events `_ + + `Syntax for Terminal Names `_ The following table lists the characteristics of this property. - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | int | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ + +-----------------------+-----------+ + | Characteristic | Value | + +=======================+===========+ + | Datatype | str | + +-----------------------+-----------+ + | Permissions | read only | + +-----------------------+-----------+ + | Repeated Capabilities | None | + +-----------------------+-----------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: - - LabVIEW Property: **Arb:Data Transfer:Advanced:Maximum In-Flight Read Requests** - - C Attribute: **NIRFSG_ATTR_DATA_TRANSFER_MAXIMUM_IN_FLIGHT_READS** - -data_transfer_preferred_packet_size ------------------------------------ - - .. py:attribute:: data_transfer_preferred_packet_size - - Specifies the preferred size of the data field in a PCI Express read request packet. + - LabVIEW Property: **Events:Configuration Settled Event Terminal Name** + - C Attribute: **NIRFSG_ATTR_CONFIGURATION_SETTLED_EVENT_TERMINAL_NAME** - In general, the larger the packet size, the more efficiently the device uses the bus. By default, NI RF signal generators use the largest packet size allowed by the system. However, due to different system implementations, some systems may perform better with smaller packet sizes. +correction_temperature +---------------------- - Recommended values for this property are powers of two between 64 and 512. + .. py:attribute:: correction_temperature - **Units**: bytes + Specifies the temperature, in degrees Celsius, to use for adjusting the device settings to correct for temperature changes. If you set this property, NI-RFSG uses the value you specify and therefore no longer uses the actual device temperature as the correction temperature. If you do not set this property, NI-RFSG checks the current device temperature in the Committed state and automatically sets the value of this property. - **Default Value**: Device maximum + PXIe-5820/5830/5831/5832/5840/5841/5842/5860: This property is read only. - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E + **Units**: Degrees Celsius - **Related Topics** + **Supported Devices**: PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - `Improving Streaming Performance `_ + .. note:: - Resetting this property reverts back to the default unset behavior. - .. note:: In some cases, the RF signal generator generates packets smaller than the preferred size you set with this property. + - Use this property only when your application requires the same settings to be used every time, regardless of the temperature variation. In these cases, it is best to ensure that the temperature does not vary too much. The following table lists the characteristics of this property. +-----------------------+------------+ | Characteristic | Value | +=======================+============+ - | Datatype | int | + | Datatype | float | +-----------------------+------------+ | Permissions | read-write | +-----------------------+------------+ @@ -5139,8 +4032,8 @@ data_transfer_preferred_packet_size .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: - - LabVIEW Property: **Arb:Data Transfer:Advanced:Preferred Packet Size** - - C Attribute: **NIRFSG_ATTR_DATA_TRANSFER_PREFERRED_PACKET_SIZE** + - LabVIEW Property: **RF:Advanced:Correction Temperature** + - C Attribute: **NIRFSG_ATTR_CORRECTION_TEMPERATURE** deembedding_compensation_gain ----------------------------- @@ -5912,284 +4805,13 @@ digital_level_script_trigger_source | Permissions | read-write | +-----------------------+-----------------+ | Repeated Capabilities | script_triggers | - +-----------------------+-----------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Triggers:Script:Digital Level:Source** - - C Attribute: **NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_SOURCE** - -digital_modulation_fsk_deviation --------------------------------- - - .. py:attribute:: digital_modulation_fsk_deviation - - Specifies the deviation to use in FSK modulation. - - **Units**: hertz (Hz) - - **Default Value:** 1,000 - - **Supported Devices:** PXI/PXIe-5650/5651/5652 - - **Related Topics** - - `Modulation Schemes `_ - - The following table lists the characteristics of this property. - - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | float | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Modulation:Digital:FSK Deviation (Hz)** - - C Attribute: **NIRFSG_ATTR_DIGITAL_MODULATION_FSK_DEVIATION** - -digital_modulation_prbs_order ------------------------------ - - .. py:attribute:: digital_modulation_prbs_order - - Specifies the order of pseudorandom bit sequence (PRBS) internally generated by hardware and used as the message signal in digital modulation. - - **Default Value:** 16 - - **Supported Devices:** PXI/PXIe-5650/5651/5652 - - **Related Topics** - - `Modulation Schemes `_ - - The following table lists the characteristics of this property. - - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | int | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Modulation:Digital:PRBS Order** - - C Attribute: **NIRFSG_ATTR_DIGITAL_MODULATION_PRBS_ORDER** - -digital_modulation_prbs_seed ----------------------------- - - .. py:attribute:: digital_modulation_prbs_seed - - Specifies the seed of the internally generated pseudorandom bit sequence (PRBS). - - **Default Value:** 1 - - **Supported Devices:** PXI/PXIe-5650/5651/5652 - - **Related Topics** - - `Modulation Schemes `_ - - The following table lists the characteristics of this property. - - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | int | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Modulation:Digital:PRBS Seed** - - C Attribute: **NIRFSG_ATTR_DIGITAL_MODULATION_PRBS_SEED** - -digital_modulation_symbol_rate ------------------------------- - - .. py:attribute:: digital_modulation_symbol_rate - - Specifies the symbol rate of the bit stream for digital modulation. - - **Units**: hertz (Hz) - - **Default Value:** 1kHz - - **Supported Devices:** PXI/PXIe-5650/5651/5652 - - **Related Topics** - - `Modulation Schemes `_ - - The following table lists the characteristics of this property. - - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | float | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Modulation:Digital:Symbol Rate** - - C Attribute: **NIRFSG_ATTR_DIGITAL_MODULATION_SYMBOL_RATE** - -digital_modulation_type ------------------------ - - .. py:attribute:: digital_modulation_type - - Specifies the digital modulation format to use. - - **Default Value:** :py:data:`~nirfsg.DigitalModulationType.NONE` - - **Supported Devices:** PXI/PXIe-5650/5651/5652 - - **Related Topics** - - `Modulation Schemes `_ - - **Defined Values**: - - +-----------------------------------------------+--------------+-----------------------------------------------------------------------------+ - | Name | Value | Description | - +===============================================+==============+=============================================================================+ - | :py:data:`~nirfsg.DigitalModulationType.FSK` | 4000 (0xfa0) | Specifies that the digital modulation type is frequency-shift keying (FSK). | - +-----------------------------------------------+--------------+-----------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DigitalModulationType.NONE` | 0 (0x0) | Disables digital modulation. | - +-----------------------------------------------+--------------+-----------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DigitalModulationType.OOK` | 4001 (0xfa1) | Specifies that the digital modulation type is on-off keying (OOK). | - +-----------------------------------------------+--------------+-----------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DigitalModulationType.PSK` | 4002 (0xfa2) | Specifies that the digital modulation type is phase-shift keying (PSK). | - +-----------------------------------------------+--------------+-----------------------------------------------------------------------------+ - - .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. - - The following table lists the characteristics of this property. - - +-----------------------+-----------------------------+ - | Characteristic | Value | - +=======================+=============================+ - | Datatype | enums.DigitalModulationType | - +-----------------------+-----------------------------+ - | Permissions | read-write | - +-----------------------+-----------------------------+ - | Repeated Capabilities | None | - +-----------------------+-----------------------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Modulation:Digital:Modulation Type** - - C Attribute: **NIRFSG_ATTR_DIGITAL_MODULATION_TYPE** - -digital_modulation_waveform_type --------------------------------- - - .. py:attribute:: digital_modulation_waveform_type - - Specifies the type of waveform to use as the message signal in digital modulation. - - **Default Value:** :py:data:`~nirfsg.DigitalModulationWaveformType.PRBS` - - **Supported Devices:** PXI/PXIe-5650/5651/5652 - - **Related Topics** - - `Modulation Schemes `_ - - **Defined Values**: - - +---------------------------------------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +===============================================================+===============+==========================================================================================================================================================================================================+ - | :py:data:`~nirfsg.DigitalModulationWaveformType.PRBS` | 5000 (0x1388) | Specifies that the digital modulation waveform type is pseudorandom bit sequence (PRBS). | - +---------------------------------------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :py:data:`~nirfsg.DigitalModulationWaveformType.USER_DEFINED` | 5001 (0x1389) | Specifies that the digital modulation waveform type is user defined. To specify the user-defined waveform, call the :py:meth:`nirfsg.Session.configure_digital_modulation_user_defined_waveform` method. | - +---------------------------------------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. - - The following table lists the characteristics of this property. - - +-----------------------+-------------------------------------+ - | Characteristic | Value | - +=======================+=====================================+ - | Datatype | enums.DigitalModulationWaveformType | - +-----------------------+-------------------------------------+ - | Permissions | read-write | - +-----------------------+-------------------------------------+ - | Repeated Capabilities | None | - +-----------------------+-------------------------------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Modulation:Digital:Waveform Type** - - C Attribute: **NIRFSG_ATTR_DIGITAL_MODULATION_WAVEFORM_TYPE** - -digital_pattern ---------------- - - .. py:attribute:: digital_pattern - - Enables or disables digital pattern on the PXI-5421/5441 AWG module. This property must be set to True to enable signal routing to and from the Digital Data & Control connector. - - To set this property, the NI-RFSG device must be in the Configuration state. - - **Default Value:** False - - **Supported Devices:** PXI-5670/5671 - - **Defined Values**: - - +-------+--------------------------+ - | Value | Description | - +=======+==========================+ - | True | Signal routing enabled. | - +-------+--------------------------+ - | False | Signal routing disabled. | - +-------+--------------------------+ - - The following table lists the characteristics of this property. - - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | bool | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ + +-----------------------+-----------------+ .. tip:: This property corresponds to the following LabVIEW Property or C Attribute: - - LabVIEW Property: **Arb:Digital Pattern** - - C Attribute: **NIRFSG_ATTR_DIGITAL_PATTERN** + - LabVIEW Property: **Triggers:Script:Digital Level:Source** + - C Attribute: **NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_SOURCE** direct_download --------------- @@ -7441,49 +6063,6 @@ frequency_settling_units - LabVIEW Property: **RF:Frequency Settling Units** - C Attribute: **NIRFSG_ATTR_FREQUENCY_SETTLING_UNITS** -frequency_tolerance -------------------- - - .. py:attribute:: frequency_tolerance - - Specifies the allowable frequency error introduced during the software upconversion process. NI-RFSG may introduce a frequency error up to the specified amount to optimize computational speed and onboard memory usage while upconverting phase-continuous signals. - - If the :py:attr:`nirfsg.Session.phase_continuity_enabled` property is set to :py:data:`~nirfsg.NIRFSG_VAL_DISABLE`, the :py:attr:`nirfsg.Session.frequency_tolerance` property is ignored, and the driver does not introduce a frequency error. On devices that do not use software upconversion, this property is ignored. The PXI-5670 always uses software upconversion, and the PXI-5671 uses software upconversion for I/Q rates greater than 8.33MS/s. - - To set this property, the NI-RFSG device must be in the Configuration state. - - **Units**: hertz (Hz) - - **Default Value:** 50 - - **Supported Devices:** PXI-5670/5671 - - **Related Topics** - - `Phase Continuity `_ - - - - .. note:: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. - - The following table lists the characteristics of this property. - - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | float | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **RF:Frequency Tolerance (Hz)** - - C Attribute: **NIRFSG_ATTR_FREQUENCY_TOLERANCE** - generation_mode --------------- @@ -7602,10 +6181,6 @@ instrument_firmware_revision **Supported Devices:** PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - **High-Level Methods**: - - - :py:meth:`nirfsg.Session.revision_query` - The following table lists the characteristics of this property. +-----------------------+-----------+ @@ -7678,47 +6253,6 @@ instrument_model - LabVIEW Property: **Inherent IVI Attributes:Instrument Identification:Model** - C Attribute: **NIRFSG_ATTR_INSTRUMENT_MODEL** -interchange_check ------------------ - - .. py:attribute:: interchange_check - - Specifies whether to perform interchangeability checking and retrieve interchangeability warnings. - - **Default Value:** False - - **Supported Devices:** PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - - **Defined Values**: - - +-------+--------------------------------+ - | Value | Description | - +=======+================================+ - | True | Interchange check is enabled. | - +-------+--------------------------------+ - | False | Interchange check is disabled. | - +-------+--------------------------------+ - - .. note:: Enabling interchangeability check is not supported. - - The following table lists the characteristics of this property. - - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | bool | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Inherent IVI Attributes:User Options:Interchange Check** - - C Attribute: **NIRFSG_ATTR_INTERCHANGE_CHECK** - interpolation_delay ------------------- @@ -7906,7 +6440,7 @@ iq_offset_units If the :py:attr:`nirfsg.Session.iq_i_offset` property is set to 100%, :py:attr:`nirfsg.Session.iq_q_offset` property is set to 0%, and :py:attr:`nirfsg.Session.power_level` property set to 0 dBm, the desired RF signal is at 0 dBm and the carrier leakage is also at 0 dBm. - The AWG or VST peak power level changes when settings change in other properties such as the :py:attr:`nirfsg.Session.power_level`, :py:attr:`nirfsg.Session.frequency`, :py:attr:`nirfsg.Session.iq_skew`, :py:attr:`nirfsg.Session.iq_gain_imbalance`, :py:attr:`nirfsg.Session.attenuator_hold_enabled`, and :py:attr:`nirfsg.Session.arb_pre_filter_gain` properties. When the :py:attr:`nirfsg.Session.iq_offset_units` property is set to :py:data:`~nirfsg.OffsetUnits.PERCENT`, the actual AWG or VST offset changes as the AWG or VST peak power level changes to satisfy the preceding equations. These changes are useful if you are intentionally adding carrier leakage to test the tolerance of a receiver. When the :py:attr:`nirfsg.Session.iq_offset_units` property is set to :py:data:`~nirfsg.OffsetUnits.PERCENT`, the carrier leakage, in dBc, remains at a consistent level. + The AWG or VST peak power level changes when settings change in other properties such as the :py:attr:`nirfsg.Session.power_level`, :py:attr:`nirfsg.Session.frequency`, :py:attr:`nirfsg.Session.iq_skew`, :py:attr:`nirfsg.Session.iq_gain_imbalance` and :py:attr:`nirfsg.Session.arb_pre_filter_gain` properties. When the :py:attr:`nirfsg.Session.iq_offset_units` property is set to :py:data:`~nirfsg.OffsetUnits.PERCENT`, the actual AWG or VST offset changes as the AWG or VST peak power level changes to satisfy the preceding equations. These changes are useful if you are intentionally adding carrier leakage to test the tolerance of a receiver. When the :py:attr:`nirfsg.Session.iq_offset_units` property is set to :py:data:`~nirfsg.OffsetUnits.PERCENT`, the carrier leakage, in dBc, remains at a consistent level. If you are trying to eliminate residual carrier leakage due to calibration inaccuracies or drift, set the :py:attr:`nirfsg.Session.iq_offset_units` property to :py:data:`~nirfsg.OffsetUnits.VOLTS`. Offset correction voltage is applied to the I/Q modulator or VST, regardless of changes to the AWG or VST peak power level. @@ -9761,55 +8295,12 @@ peak_power_adjustment - LabVIEW Property: **RF:Peak Power Adjustment (dB)** - C Attribute: **NIRFSG_ATTR_PEAK_POWER_ADJUSTMENT** -peak_power_adjustment_inheritance ---------------------------------- - - .. py:attribute:: peak_power_adjustment_inheritance - - Determines the inheritance behavior of the :py:attr:`nirfsg.Session.peak_power_adjustment` property when a script inherits values from specified waveforms. - - **Default Value:** :py:data:`~nirfsg.PpaInheritance.EXACT_MATCH` - - **Supported Devices:** PXIe-5673/5673E - - **Related Topics** - - `Assigning Properties or Properties to a Waveform `_ - - **Defined Values**: - - +-----------------------------------------------+------------------------------------------------------------+ - | Value | Description | - +===============================================+============================================================+ - | :py:data:`~nirfsg.PpaInheritance.EXACT_MATCH` | Errors out if different values are detected in the script. | - +-----------------------------------------------+------------------------------------------------------------+ - | :py:data:`~nirfsg.PpaInheritance.MINIMUM` | Uses the minimum value found in the script. | - +-----------------------------------------------+------------------------------------------------------------+ - - The following table lists the characteristics of this property. - - +-----------------------+----------------------+ - | Characteristic | Value | - +=======================+======================+ - | Datatype | enums.PpaInheritance | - +-----------------------+----------------------+ - | Permissions | read-write | - +-----------------------+----------------------+ - | Repeated Capabilities | None | - +-----------------------+----------------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **RF:Peak Power Adjustment Inheritance** - - C Attribute: **NIRFSG_ATTR_PEAK_POWER_ADJUSTMENT_INHERITANCE** - phase_continuity_enabled ------------------------ .. py:attribute:: phase_continuity_enabled - Specifies whether the driver maintains phase continuity in the arbitrary waveforms. When this property is set to :py:data:`~nirfsg.PhaseContinuityEnabled.ENABLE`, NI-RFSG may increase the waveform size. When this property is set to :py:data:`~nirfsg.PhaseContinuityEnabled.ENABLE`, the :py:attr:`nirfsg.Session.frequency_tolerance` property specifies the maximum allowable frequency error that can be introduced when keeping the signal phase-continuous. To set the :py:attr:`nirfsg.Session.phase_continuity_enabled` property, the NI-RFSG device must be in the Configuration state. :py:attr:`nirfsg.Session.phase_continuity_enabled` applies only when the :py:attr:`nirfsg.Session.generation_mode` property is set to :py:data:`~nirfsg.GenerationMode.ARB_WAVEFORM` or :py:data:`~nirfsg.GenerationMode.SCRIPT`. + Specifies whether the driver maintains phase continuity in the arbitrary waveforms. When this property is set to :py:data:`~nirfsg.PhaseContinuityEnabled.ENABLE`, NI-RFSG may increase the waveform size. To set the :py:attr:`nirfsg.Session.phase_continuity_enabled` property, the NI-RFSG device must be in the Configuration state. :py:attr:`nirfsg.Session.phase_continuity_enabled` applies only when the :py:attr:`nirfsg.Session.generation_mode` property is set to :py:data:`~nirfsg.GenerationMode.ARB_WAVEFORM` or :py:data:`~nirfsg.GenerationMode.SCRIPT`. PXI-5671: When using the PXI-5671 with I/Q rates less than or equal to 8.33MS/s, an input phase-continuous signal is always phase-continuous upon output, and this property has no effect. @@ -10187,189 +8678,6 @@ pulse_modulation_source - LabVIEW Property: **Modulation:Pulse:Pulse Modulation Source** - C Attribute: **NIRFSG_ATTR_PULSE_MODULATION_SOURCE** -pxi_chassis_clk10_source ------------------------- - - .. py:attribute:: pxi_chassis_clk10_source - - Specifies the clock source for driving the PXI 10 MHz backplane Reference Clock. This property is configurable if the PXI-5610 upconverter module is installed in *only* Slot 2 of a PXI chassis. To set this property, the NI-RFSG device must be in the Configuration state. - - **Possible Values**: - - Possible Value: Description - - "" :Do not drive the PXI_CLK10 signal. - - "OnboardClock" :Uses the highly stable oven-controlled onboard Reference Clock to drive the PXI_CLK signal. - - "RefIn" :Uses the clock present at the front panel REF IN connector to drive the PXI_CLK signal. - - **Default Value:** "" - - **Supported Devices:** PXI-5610, PXI-5670/5671 - - **Related Topics** - - `Timing Configurations `_ - - `System Reference Clock `_ - - **High-Level Methods**: - - - :py:meth:`nirfsg.Session.configure_pxi_chassis_clk10` - - - Only certain combinations of this property and the :py:attr:`nirfsg.Session.ref_clock_source` property are valid, as shown in the following table. - - +------------------------------------------------------------+----------------------------------------------------+ - | :py:attr:`nirfsg.Session.pxi_chassis_clk10_source` Setting | :py:attr:`nirfsg.Session.ref_clock_source` Setting | - +============================================================+====================================================+ - | "", OnboardClock | OnboardClock | - +------------------------------------------------------------+----------------------------------------------------+ - | "", RefIn | RefIn | - +------------------------------------------------------------+----------------------------------------------------+ - | "", RefIn | PXI_CLK | - +------------------------------------------------------------+----------------------------------------------------+ - - The following table lists the characteristics of this property. - - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | str | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Clock:PXI Chassis Clk 10 Source** - - C Attribute: **NIRFSG_ATTR_PXI_CHASSIS_CLK10_SOURCE** - -query_instrument_status ------------------------ - - .. py:attribute:: query_instrument_status - - Specifies whether NI-RFSG queries the NI-RFSG device status after each operation. Querying the device status is useful for debugging. After you validate your program, set this property to False to disable status checking and maximize performance. - - NI-RFSG can choose to ignore status checking for particular properties, regardless of the setting of this property. Use the :py:meth:`nirfsg.Session.__init__` method to override the default value. - - **Default Value:** False - - **Supported Devices:** PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - - **Defined Values**: - - +-------+-------------------------------------------------------------+ - | Value | Description | - +=======+=============================================================+ - | True | NI-RFSG queries the instrument status after each operation. | - +-------+-------------------------------------------------------------+ - | False | NI-RFSG does not query the instrument status. | - +-------+-------------------------------------------------------------+ - - The following table lists the characteristics of this property. - - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | bool | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Inherent IVI Attributes:User Options:Query Instrument Status** - - C Attribute: **NIRFSG_ATTR_QUERY_INSTRUMENT_STATUS** - -range_check ------------ - - .. py:attribute:: range_check - - Specifies whether to validate property values and method parameters. Range checking parameters is very useful for debugging. After you validate your program, set this property to False to disable range checking and maximize performance. NI-RFSG can choose to ignore range checking for particular properties, regardless of the setting of this property. Use the :py:meth:`nirfsg.Session.__init__` method to override the default value. - - **Default Value:** True - - **Supported Devices:** PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - - **Defined Values**: - - +-------+-------------------------+ - | Value | Description | - +=======+=========================+ - | True | Enable range checking. | - +-------+-------------------------+ - | False | Disable range checking. | - +-------+-------------------------+ - - The following table lists the characteristics of this property. - - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | bool | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Inherent IVI Attributes:User Options:Range Check** - - C Attribute: **NIRFSG_ATTR_RANGE_CHECK** - -record_coercions ----------------- - - .. py:attribute:: record_coercions - - Specifies whether the IVI engine keeps a list of the value coercions it makes for integer and real type properties. - - **Default Value:** False - - **Supported Devices:** PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - - **Defined Values**: - - +-------+---------------------------------------------------+ - | Value | Description | - +=======+===================================================+ - | True | The IVI engine keeps a list of coercions. | - +-------+---------------------------------------------------+ - | False | The IVI engine does not keep a list of coercions. | - +-------+---------------------------------------------------+ - - .. note:: Enabling record value coercions is not supported. - - The following table lists the characteristics of this property. - - +-----------------------+------------+ - | Characteristic | Value | - +=======================+============+ - | Datatype | bool | - +-----------------------+------------+ - | Permissions | read-write | - +-----------------------+------------+ - | Repeated Capabilities | None | - +-----------------------+------------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Inherent IVI Attributes:User Options:Record Value Coercions** - - C Attribute: **NIRFSG_ATTR_RECORD_COERCIONS** - ref_clock_rate -------------- @@ -10444,7 +8752,7 @@ ref_clock_source .. py:attribute:: ref_clock_source - Specifies the Reference Clock source. To set this property, the NI-RFSG device must be in the Configuration state. Only certain combinations of this property and the :py:attr:`nirfsg.Session.pxi_chassis_clk10_source` property are valid, as shown in the following table. + Specifies the Reference Clock source. To set this property, the NI-RFSG device must be in the Configuration state. **Default Value:** OnboardClock @@ -10476,8 +8784,6 @@ ref_clock_source | "PXI_ClkMaster" | This value is valid on only the PXIe-5831/5832 with PXIe-5653. **PXIe-5831/5832 with PXIe-5653** —NI-RFSG configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3622 to use PXI_CLK as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. | +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - .. note:: The PXI-5670/5671 and PXIe-5672 devices also allow you to drive the PXI 10 MHz backplane clock on PXI chassis *only* using the :py:attr:`nirfsg.Session.pxi_chassis_clk10_source` property. - The following table lists the characteristics of this property. +-----------------------+------------+ @@ -11038,43 +9344,6 @@ signal_bandwidth - LabVIEW Property: **Arb:Signal Bandwidth (Hz)** - C Attribute: **NIRFSG_ATTR_SIGNAL_BANDWIDTH** -simulate --------- - - .. py:attribute:: simulate - - Returns whether NI-RFSG simulates I/O operations. This property is useful for debugging applications without using hardware. After a session is opened, you cannot change the simulation state. Use the :py:meth:`nirfsg.Session.__init__` method to enable simulation. - - **Supported Devices:** PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - - **Defined Values**: - - +-------+-------------------------+ - | Value | Description | - +=======+=========================+ - | True | Simulation is enabled. | - +-------+-------------------------+ - | False | Simulation is disabled. | - +-------+-------------------------+ - - The following table lists the characteristics of this property. - - +-----------------------+-----------+ - | Characteristic | Value | - +=======================+===========+ - | Datatype | bool | - +-----------------------+-----------+ - | Permissions | read only | - +-----------------------+-----------+ - | Repeated Capabilities | None | - +-----------------------+-----------+ - - .. tip:: - This property corresponds to the following LabVIEW Property or C Attribute: - - - LabVIEW Property: **Inherent IVI Attributes:User Options:Simulate** - - C Attribute: **NIRFSG_ATTR_SIMULATE** - specific_driver_class_spec_major_version ---------------------------------------- diff --git a/docs/nirfsg/enums.rst b/docs/nirfsg/enums.rst index 0bb75f666..4ed2eaf82 100644 --- a/docs/nirfsg/enums.rst +++ b/docs/nirfsg/enums.rst @@ -186,41 +186,6 @@ AnalogModulationType -AnalogModulationWaveformType ----------------------------- - -.. py:class:: AnalogModulationWaveformType - - .. py:attribute:: AnalogModulationWaveformType.SINE - - - - Specifies that the analog modulation waveform type is sine. - - - - - - .. py:attribute:: AnalogModulationWaveformType.SQUARE - - - - Specifies that the analog modulation waveform type is square. - - - - - - .. py:attribute:: AnalogModulationWaveformType.TRIANGLE - - - - Specifies that the analog modulation waveform type is triangle. - - - - - ArbOnboardSampleClockMode ------------------------- @@ -381,76 +346,6 @@ DigitalEqualizationEnabled -DigitalModulationType ---------------------- - -.. py:class:: DigitalModulationType - - .. py:attribute:: DigitalModulationType.NONE - - - - Disables digital modulation. - - - - - - .. py:attribute:: DigitalModulationType.FSK - - - - Specifies that the digital modulation type is frequency-shift keying (FSK). - - - - - - .. py:attribute:: DigitalModulationType.OOK - - - - Specifies that the digital modulation type is on-off keying (OOK). - - - - - - .. py:attribute:: DigitalModulationType.PSK - - - - Specifies that the digital modulation type is phase-shift keying (PSK). - - - - - -DigitalModulationWaveformType ------------------------------ - -.. py:class:: DigitalModulationWaveformType - - .. py:attribute:: DigitalModulationWaveformType.PRBS - - - - Specifies that the digital modulation waveform type is pseudorandom bit sequence (PRBS). - - - - - - .. py:attribute:: DigitalModulationWaveformType.USER_DEFINED - - - - Specifies that the digital modulation waveform type is user defined. To specify the user-defined waveform, call the :py:meth:`nirfsg.Session.configure_digital_modulation_user_defined_waveform` method. - - - - - DirectDownload -------------- @@ -486,41 +381,6 @@ DirectDownload -FilterType ----------- - -.. py:class:: FilterType - - .. py:attribute:: FilterType.NONE - - - - No filter type is applied. - - - - - - .. py:attribute:: FilterType.ARB_FILTER_TYPE_ROOT_RAISED_COSINE - - - - Applies a root-raised cosine filter to the data with the alpha value specified with the :py:attr:`nirfsg.Session.arb_filter_root_raised_cosine_alpha` property. - - - - - - .. py:attribute:: FilterType.ARB_FILTER_TYPE_RAISED_COSINE - - - - Applies a raised cosine filter to the data with the alpha value specified with the :py:attr:`nirfsg.Session.arb_filter_raised_cosine_alpha` property. - - - - - Format ------ @@ -1071,41 +931,6 @@ PowerLevelType -PpaInheritance --------------- - -.. py:class:: PpaInheritance - - .. py:attribute:: PpaInheritance.EXACT_MATCH - - - - Errors out if different values are detected in the script. - - - - - - .. py:attribute:: PpaInheritance.MINIMUM - - - - Uses the minimum value found in the script. - - - - - - .. py:attribute:: PpaInheritance.MAXIMUM - - - - Uses the maximum value found in the script. - - - - - PulseModulationMode ------------------- diff --git a/generated/nirfsg/nirfsg/_library.py b/generated/nirfsg/nirfsg/_library.py index b6ffcca37..d62f5cc90 100644 --- a/generated/nirfsg/nirfsg/_library.py +++ b/generated/nirfsg/nirfsg/_library.py @@ -23,18 +23,11 @@ def __init__(self, ctypes_library): self.niRFSG_Abort_cfunc = None self.niRFSG_AllocateArbWaveform_cfunc = None self.niRFSG_ChangeExternalCalibrationPassword_cfunc = None - self.niRFSG_CheckAttributeViBoolean_cfunc = None - self.niRFSG_CheckAttributeViInt32_cfunc = None - self.niRFSG_CheckAttributeViInt64_cfunc = None - self.niRFSG_CheckAttributeViReal64_cfunc = None - self.niRFSG_CheckAttributeViSession_cfunc = None - self.niRFSG_CheckAttributeViString_cfunc = None self.niRFSG_CheckGenerationStatus_cfunc = None self.niRFSG_CheckIfScriptExists_cfunc = None self.niRFSG_CheckIfWaveformExists_cfunc = None self.niRFSG_ClearAllArbWaveforms_cfunc = None self.niRFSG_ClearArbWaveform_cfunc = None - self.niRFSG_ClearError_cfunc = None self.niRFSG_ClearSelfCalibrateRange_cfunc = None self.niRFSG_Commit_cfunc = None self.niRFSG_ConfigureDeembeddingTableInterpolationLinear_cfunc = None @@ -43,8 +36,6 @@ def __init__(self, ctypes_library): self.niRFSG_ConfigureDigitalEdgeScriptTrigger_cfunc = None self.niRFSG_ConfigureDigitalEdgeStartTrigger_cfunc = None self.niRFSG_ConfigureDigitalLevelScriptTrigger_cfunc = None - self.niRFSG_ConfigureDigitalModulationUserDefinedWaveform_cfunc = None - self.niRFSG_ConfigurePxiChassisClk10_cfunc = None self.niRFSG_ConfigureRF_cfunc = None self.niRFSG_ConfigureRefClock_cfunc = None self.niRFSG_ConfigureSoftwareScriptTrigger_cfunc = None @@ -53,11 +44,9 @@ def __init__(self, ctypes_library): self.niRFSG_CreateDeembeddingSparameterTableS2PFile_cfunc = None self.niRFSG_DeleteAllDeembeddingTables_cfunc = None self.niRFSG_DeleteDeembeddingTable_cfunc = None - self.niRFSG_Disable_cfunc = None self.niRFSG_DisableScriptTrigger_cfunc = None self.niRFSG_DisableStartTrigger_cfunc = None self.niRFSG_ErrorMessage_cfunc = None - self.niRFSG_ErrorQuery_cfunc = None self.niRFSG_GetAllNamedWaveformNames_cfunc = None self.niRFSG_GetAllScriptNames_cfunc = None self.niRFSG_GetAttributeViBoolean_cfunc = None @@ -66,7 +55,6 @@ def __init__(self, ctypes_library): self.niRFSG_GetAttributeViReal64_cfunc = None self.niRFSG_GetAttributeViSession_cfunc = None self.niRFSG_GetAttributeViString_cfunc = None - self.niRFSG_GetChannelName_cfunc = None self.niRFSG_GetDeembeddingSparameters_cfunc = None self.niRFSG_GetDeembeddingTableNumberOfPorts_cfunc = None self.niRFSG_GetError_cfunc = None @@ -86,11 +74,9 @@ def __init__(self, ctypes_library): self.niRFSG_PerformThermalCorrection_cfunc = None self.niRFSG_QueryArbWaveformCapabilities_cfunc = None self.niRFSG_ReadAndDownloadWaveformFromFileTDMS_cfunc = None - self.niRFSG_ResetAttribute_cfunc = None self.niRFSG_ResetDevice_cfunc = None self.niRFSG_ResetWithDefaults_cfunc = None self.niRFSG_ResetWithOptions_cfunc = None - self.niRFSG_RevisionQuery_cfunc = None self.niRFSG_SaveConfigurationsToFile_cfunc = None self.niRFSG_SelectArbWaveform_cfunc = None self.niRFSG_SelfCal_cfunc = None @@ -147,54 +133,6 @@ def niRFSG_ChangeExternalCalibrationPassword(self, vi, old_password, new_passwor self.niRFSG_ChangeExternalCalibrationPassword_cfunc.restype = ViStatus # noqa: F405 return self.niRFSG_ChangeExternalCalibrationPassword_cfunc(vi, old_password, new_password) - def niRFSG_CheckAttributeViBoolean(self, vi, channel_name, attribute, value): # noqa: N802 - with self._func_lock: - if self.niRFSG_CheckAttributeViBoolean_cfunc is None: - self.niRFSG_CheckAttributeViBoolean_cfunc = self._get_library_function('niRFSG_CheckAttributeViBoolean') - self.niRFSG_CheckAttributeViBoolean_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViAttr, ViBoolean] # noqa: F405 - self.niRFSG_CheckAttributeViBoolean_cfunc.restype = ViStatus # noqa: F405 - return self.niRFSG_CheckAttributeViBoolean_cfunc(vi, channel_name, attribute, value) - - def niRFSG_CheckAttributeViInt32(self, vi, channel_name, attribute, value): # noqa: N802 - with self._func_lock: - if self.niRFSG_CheckAttributeViInt32_cfunc is None: - self.niRFSG_CheckAttributeViInt32_cfunc = self._get_library_function('niRFSG_CheckAttributeViInt32') - self.niRFSG_CheckAttributeViInt32_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViAttr, ViInt32] # noqa: F405 - self.niRFSG_CheckAttributeViInt32_cfunc.restype = ViStatus # noqa: F405 - return self.niRFSG_CheckAttributeViInt32_cfunc(vi, channel_name, attribute, value) - - def niRFSG_CheckAttributeViInt64(self, vi, channel_name, attribute, value): # noqa: N802 - with self._func_lock: - if self.niRFSG_CheckAttributeViInt64_cfunc is None: - self.niRFSG_CheckAttributeViInt64_cfunc = self._get_library_function('niRFSG_CheckAttributeViInt64') - self.niRFSG_CheckAttributeViInt64_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViAttr, ViInt64] # noqa: F405 - self.niRFSG_CheckAttributeViInt64_cfunc.restype = ViStatus # noqa: F405 - return self.niRFSG_CheckAttributeViInt64_cfunc(vi, channel_name, attribute, value) - - def niRFSG_CheckAttributeViReal64(self, vi, channel_name, attribute, value): # noqa: N802 - with self._func_lock: - if self.niRFSG_CheckAttributeViReal64_cfunc is None: - self.niRFSG_CheckAttributeViReal64_cfunc = self._get_library_function('niRFSG_CheckAttributeViReal64') - self.niRFSG_CheckAttributeViReal64_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViAttr, ViReal64] # noqa: F405 - self.niRFSG_CheckAttributeViReal64_cfunc.restype = ViStatus # noqa: F405 - return self.niRFSG_CheckAttributeViReal64_cfunc(vi, channel_name, attribute, value) - - def niRFSG_CheckAttributeViSession(self, vi, channel_name, attribute, value): # noqa: N802 - with self._func_lock: - if self.niRFSG_CheckAttributeViSession_cfunc is None: - self.niRFSG_CheckAttributeViSession_cfunc = self._get_library_function('niRFSG_CheckAttributeViSession') - self.niRFSG_CheckAttributeViSession_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViAttr, ViSession] # noqa: F405 - self.niRFSG_CheckAttributeViSession_cfunc.restype = ViStatus # noqa: F405 - return self.niRFSG_CheckAttributeViSession_cfunc(vi, channel_name, attribute, value) - - def niRFSG_CheckAttributeViString(self, vi, channel_name, attribute, value): # noqa: N802 - with self._func_lock: - if self.niRFSG_CheckAttributeViString_cfunc is None: - self.niRFSG_CheckAttributeViString_cfunc = self._get_library_function('niRFSG_CheckAttributeViString') - self.niRFSG_CheckAttributeViString_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViAttr, ctypes.POINTER(ViChar)] # noqa: F405 - self.niRFSG_CheckAttributeViString_cfunc.restype = ViStatus # noqa: F405 - return self.niRFSG_CheckAttributeViString_cfunc(vi, channel_name, attribute, value) - def niRFSG_CheckGenerationStatus(self, vi, is_done): # noqa: N802 with self._func_lock: if self.niRFSG_CheckGenerationStatus_cfunc is None: @@ -235,14 +173,6 @@ def niRFSG_ClearArbWaveform(self, vi, name): # noqa: N802 self.niRFSG_ClearArbWaveform_cfunc.restype = ViStatus # noqa: F405 return self.niRFSG_ClearArbWaveform_cfunc(vi, name) - def niRFSG_ClearError(self, vi): # noqa: N802 - with self._func_lock: - if self.niRFSG_ClearError_cfunc is None: - self.niRFSG_ClearError_cfunc = self._get_library_function('niRFSG_ClearError') - self.niRFSG_ClearError_cfunc.argtypes = [ViSession] # noqa: F405 - self.niRFSG_ClearError_cfunc.restype = ViStatus # noqa: F405 - return self.niRFSG_ClearError_cfunc(vi) - def niRFSG_ClearSelfCalibrateRange(self, vi): # noqa: N802 with self._func_lock: if self.niRFSG_ClearSelfCalibrateRange_cfunc is None: @@ -307,22 +237,6 @@ def niRFSG_ConfigureDigitalLevelScriptTrigger(self, vi, trigger_id, source, leve self.niRFSG_ConfigureDigitalLevelScriptTrigger_cfunc.restype = ViStatus # noqa: F405 return self.niRFSG_ConfigureDigitalLevelScriptTrigger_cfunc(vi, trigger_id, source, level) - def niRFSG_ConfigureDigitalModulationUserDefinedWaveform(self, vi, number_of_samples, user_defined_waveform): # noqa: N802 - with self._func_lock: - if self.niRFSG_ConfigureDigitalModulationUserDefinedWaveform_cfunc is None: - self.niRFSG_ConfigureDigitalModulationUserDefinedWaveform_cfunc = self._get_library_function('niRFSG_ConfigureDigitalModulationUserDefinedWaveform') - self.niRFSG_ConfigureDigitalModulationUserDefinedWaveform_cfunc.argtypes = [ViSession, ViInt32, ctypes.POINTER(ViInt8)] # noqa: F405 - self.niRFSG_ConfigureDigitalModulationUserDefinedWaveform_cfunc.restype = ViStatus # noqa: F405 - return self.niRFSG_ConfigureDigitalModulationUserDefinedWaveform_cfunc(vi, number_of_samples, user_defined_waveform) - - def niRFSG_ConfigurePxiChassisClk10(self, vi, pxi_clk10_source): # noqa: N802 - with self._func_lock: - if self.niRFSG_ConfigurePxiChassisClk10_cfunc is None: - self.niRFSG_ConfigurePxiChassisClk10_cfunc = self._get_library_function('niRFSG_ConfigurePxiChassisClk10') - self.niRFSG_ConfigurePxiChassisClk10_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar)] # noqa: F405 - self.niRFSG_ConfigurePxiChassisClk10_cfunc.restype = ViStatus # noqa: F405 - return self.niRFSG_ConfigurePxiChassisClk10_cfunc(vi, pxi_clk10_source) - def niRFSG_ConfigureRF(self, vi, frequency, power_level): # noqa: N802 with self._func_lock: if self.niRFSG_ConfigureRF_cfunc is None: @@ -387,14 +301,6 @@ def niRFSG_DeleteDeembeddingTable(self, vi, port, table_name): # noqa: N802 self.niRFSG_DeleteDeembeddingTable_cfunc.restype = ViStatus # noqa: F405 return self.niRFSG_DeleteDeembeddingTable_cfunc(vi, port, table_name) - def niRFSG_Disable(self, vi): # noqa: N802 - with self._func_lock: - if self.niRFSG_Disable_cfunc is None: - self.niRFSG_Disable_cfunc = self._get_library_function('niRFSG_Disable') - self.niRFSG_Disable_cfunc.argtypes = [ViSession] # noqa: F405 - self.niRFSG_Disable_cfunc.restype = ViStatus # noqa: F405 - return self.niRFSG_Disable_cfunc(vi) - def niRFSG_DisableScriptTrigger(self, vi, trigger_id): # noqa: N802 with self._func_lock: if self.niRFSG_DisableScriptTrigger_cfunc is None: @@ -419,14 +325,6 @@ def niRFSG_ErrorMessage(self, vi, error_code, error_message): # noqa: N802 self.niRFSG_ErrorMessage_cfunc.restype = ViStatus # noqa: F405 return self.niRFSG_ErrorMessage_cfunc(vi, error_code, error_message) - def niRFSG_ErrorQuery(self, vi, error_code, error_message): # noqa: N802 - with self._func_lock: - if self.niRFSG_ErrorQuery_cfunc is None: - self.niRFSG_ErrorQuery_cfunc = self._get_library_function('niRFSG_ErrorQuery') - self.niRFSG_ErrorQuery_cfunc.argtypes = [ViSession, ctypes.POINTER(ViInt32), ctypes.POINTER(ViChar)] # noqa: F405 - self.niRFSG_ErrorQuery_cfunc.restype = ViStatus # noqa: F405 - return self.niRFSG_ErrorQuery_cfunc(vi, error_code, error_message) - def niRFSG_GetAllNamedWaveformNames(self, vi, waveform_names, buffer_size, actual_buffer_size): # noqa: N802 with self._func_lock: if self.niRFSG_GetAllNamedWaveformNames_cfunc is None: @@ -491,14 +389,6 @@ def niRFSG_GetAttributeViString(self, vi, channel_name, attribute, buf_size, val self.niRFSG_GetAttributeViString_cfunc.restype = ViStatus # noqa: F405 return self.niRFSG_GetAttributeViString_cfunc(vi, channel_name, attribute, buf_size, value) - def niRFSG_GetChannelName(self, vi, index, buffer_size, name): # noqa: N802 - with self._func_lock: - if self.niRFSG_GetChannelName_cfunc is None: - self.niRFSG_GetChannelName_cfunc = self._get_library_function('niRFSG_GetChannelName') - self.niRFSG_GetChannelName_cfunc.argtypes = [ViSession, ViInt32, ViInt32, ctypes.POINTER(ViChar)] # noqa: F405 - self.niRFSG_GetChannelName_cfunc.restype = ViStatus # noqa: F405 - return self.niRFSG_GetChannelName_cfunc(vi, index, buffer_size, name) - def niRFSG_GetDeembeddingSparameters(self, vi, sparameters, sparameters_array_size, number_of_sparameters, number_of_ports): # noqa: N802 with self._func_lock: if self.niRFSG_GetDeembeddingSparameters_cfunc is None: @@ -651,14 +541,6 @@ def niRFSG_ReadAndDownloadWaveformFromFileTDMS(self, vi, waveform_name, file_pat self.niRFSG_ReadAndDownloadWaveformFromFileTDMS_cfunc.restype = ViStatus # noqa: F405 return self.niRFSG_ReadAndDownloadWaveformFromFileTDMS_cfunc(vi, waveform_name, file_path, waveform_index) - def niRFSG_ResetAttribute(self, vi, channel_name, attribute_id): # noqa: N802 - with self._func_lock: - if self.niRFSG_ResetAttribute_cfunc is None: - self.niRFSG_ResetAttribute_cfunc = self._get_library_function('niRFSG_ResetAttribute') - self.niRFSG_ResetAttribute_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ViAttr] # noqa: F405 - self.niRFSG_ResetAttribute_cfunc.restype = ViStatus # noqa: F405 - return self.niRFSG_ResetAttribute_cfunc(vi, channel_name, attribute_id) - def niRFSG_ResetDevice(self, vi): # noqa: N802 with self._func_lock: if self.niRFSG_ResetDevice_cfunc is None: @@ -683,14 +565,6 @@ def niRFSG_ResetWithOptions(self, vi, steps_to_omit): # noqa: N802 self.niRFSG_ResetWithOptions_cfunc.restype = ViStatus # noqa: F405 return self.niRFSG_ResetWithOptions_cfunc(vi, steps_to_omit) - def niRFSG_RevisionQuery(self, vi, instrument_driver_revision, firmware_revision): # noqa: N802 - with self._func_lock: - if self.niRFSG_RevisionQuery_cfunc is None: - self.niRFSG_RevisionQuery_cfunc = self._get_library_function('niRFSG_RevisionQuery') - self.niRFSG_RevisionQuery_cfunc.argtypes = [ViSession, ctypes.POINTER(ViChar), ctypes.POINTER(ViChar)] # noqa: F405 - self.niRFSG_RevisionQuery_cfunc.restype = ViStatus # noqa: F405 - return self.niRFSG_RevisionQuery_cfunc(vi, instrument_driver_revision, firmware_revision) - def niRFSG_SaveConfigurationsToFile(self, vi, channel_name, file_path): # noqa: N802 with self._func_lock: if self.niRFSG_SaveConfigurationsToFile_cfunc is None: diff --git a/generated/nirfsg/nirfsg/_library_interpreter.py b/generated/nirfsg/nirfsg/_library_interpreter.py index 588a8d404..f875c618a 100644 --- a/generated/nirfsg/nirfsg/_library_interpreter.py +++ b/generated/nirfsg/nirfsg/_library_interpreter.py @@ -112,60 +112,6 @@ def change_external_calibration_password(self, old_password, new_password): # n errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) return - def check_attribute_vi_boolean(self, channel_name, attribute, value): # noqa: N802 - vi_ctype = _visatype.ViSession(self._vi) # case S110 - channel_name_ctype = ctypes.create_string_buffer(channel_name.encode(self._encoding)) # case C010 - attribute_ctype = _visatype.ViAttr(attribute) # case S150 - value_ctype = _visatype.ViBoolean(value) # case S150 - error_code = self._library.niRFSG_CheckAttributeViBoolean(vi_ctype, channel_name_ctype, attribute_ctype, value_ctype) - errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) - return - - def check_attribute_vi_int32(self, channel_name, attribute, value): # noqa: N802 - vi_ctype = _visatype.ViSession(self._vi) # case S110 - channel_name_ctype = ctypes.create_string_buffer(channel_name.encode(self._encoding)) # case C010 - attribute_ctype = _visatype.ViAttr(attribute) # case S150 - value_ctype = _visatype.ViInt32(value) # case S150 - error_code = self._library.niRFSG_CheckAttributeViInt32(vi_ctype, channel_name_ctype, attribute_ctype, value_ctype) - errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) - return - - def check_attribute_vi_int64(self, channel_name, attribute, value): # noqa: N802 - vi_ctype = _visatype.ViSession(self._vi) # case S110 - channel_name_ctype = ctypes.create_string_buffer(channel_name.encode(self._encoding)) # case C010 - attribute_ctype = _visatype.ViAttr(attribute) # case S150 - value_ctype = _visatype.ViInt64(value) # case S150 - error_code = self._library.niRFSG_CheckAttributeViInt64(vi_ctype, channel_name_ctype, attribute_ctype, value_ctype) - errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) - return - - def check_attribute_vi_real64(self, channel_name, attribute, value): # noqa: N802 - vi_ctype = _visatype.ViSession(self._vi) # case S110 - channel_name_ctype = ctypes.create_string_buffer(channel_name.encode(self._encoding)) # case C010 - attribute_ctype = _visatype.ViAttr(attribute) # case S150 - value_ctype = _visatype.ViReal64(value) # case S150 - error_code = self._library.niRFSG_CheckAttributeViReal64(vi_ctype, channel_name_ctype, attribute_ctype, value_ctype) - errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) - return - - def check_attribute_vi_session(self, channel_name, attribute): # noqa: N802 - vi_ctype = _visatype.ViSession(self._vi) # case S110 - channel_name_ctype = ctypes.create_string_buffer(channel_name.encode(self._encoding)) # case C010 - attribute_ctype = _visatype.ViAttr(attribute) # case S150 - value_ctype = _visatype.ViSession(self._vi) # case S110 - error_code = self._library.niRFSG_CheckAttributeViSession(vi_ctype, channel_name_ctype, attribute_ctype, value_ctype) - errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) - return - - def check_attribute_vi_string(self, channel_name, attribute, value): # noqa: N802 - vi_ctype = _visatype.ViSession(self._vi) # case S110 - channel_name_ctype = ctypes.create_string_buffer(channel_name.encode(self._encoding)) # case C010 - attribute_ctype = _visatype.ViAttr(attribute) # case S150 - value_ctype = ctypes.create_string_buffer(value.encode(self._encoding)) # case C020 - error_code = self._library.niRFSG_CheckAttributeViString(vi_ctype, channel_name_ctype, attribute_ctype, value_ctype) - errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) - return - def check_generation_status(self): # noqa: N802 vi_ctype = _visatype.ViSession(self._vi) # case S110 is_done_ctype = _visatype.ViBoolean() # case S220 @@ -202,12 +148,6 @@ def clear_arb_waveform(self, name): # noqa: N802 errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) return - def clear_error(self): # noqa: N802 - vi_ctype = _visatype.ViSession(self._vi) # case S110 - error_code = self._library.niRFSG_ClearError(vi_ctype) - errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) - return - def clear_self_calibrate_range(self): # noqa: N802 vi_ctype = _visatype.ViSession(self._vi) # case S110 error_code = self._library.niRFSG_ClearSelfCalibrateRange(vi_ctype) @@ -271,21 +211,6 @@ def configure_digital_level_script_trigger(self, trigger_id, source, level): # errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) return - def configure_digital_modulation_user_defined_waveform(self, number_of_samples, user_defined_waveform): # noqa: N802 - vi_ctype = _visatype.ViSession(self._vi) # case S110 - number_of_samples_ctype = _visatype.ViInt32(0 if user_defined_waveform is None else len(user_defined_waveform)) # case S160 - user_defined_waveform_ctype = _get_ctypes_pointer_for_buffer(value=user_defined_waveform, library_type=_visatype.ViInt8) # case B550 - error_code = self._library.niRFSG_ConfigureDigitalModulationUserDefinedWaveform(vi_ctype, number_of_samples_ctype, user_defined_waveform_ctype) - errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) - return - - def configure_pxi_chassis_clk10(self, pxi_clk10_source): # noqa: N802 - vi_ctype = _visatype.ViSession(self._vi) # case S110 - pxi_clk10_source_ctype = ctypes.create_string_buffer(pxi_clk10_source.encode(self._encoding)) # case C020 - error_code = self._library.niRFSG_ConfigurePxiChassisClk10(vi_ctype, pxi_clk10_source_ctype) - errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) - return - def configure_rf(self, frequency, power_level): # noqa: N802 vi_ctype = _visatype.ViSession(self._vi) # case S110 frequency_ctype = _visatype.ViReal64(frequency) # case S150 @@ -353,12 +278,6 @@ def delete_deembedding_table(self, port, table_name): # noqa: N802 errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) return - def disable(self): # noqa: N802 - vi_ctype = _visatype.ViSession(self._vi) # case S110 - error_code = self._library.niRFSG_Disable(vi_ctype) - errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) - return - def disable_script_trigger(self, trigger_id): # noqa: N802 vi_ctype = _visatype.ViSession(self._vi) # case S110 trigger_id_ctype = ctypes.create_string_buffer(trigger_id.encode(self._encoding)) # case C010 @@ -380,14 +299,6 @@ def error_message(self, error_code, error_message): # noqa: N802 errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=True) return - def error_query(self): # noqa: N802 - vi_ctype = _visatype.ViSession(self._vi) # case S110 - error_code_ctype = _visatype.ViInt32() # case S220 - error_message_ctype = (_visatype.ViChar * 256)() # case C070 - error_code = self._library.niRFSG_ErrorQuery(vi_ctype, None if error_code_ctype is None else (ctypes.pointer(error_code_ctype)), error_message_ctype) - errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) - return int(error_code_ctype.value), error_message_ctype.value.decode(self._encoding) - def get_all_named_waveform_names(self): # noqa: N802 vi_ctype = _visatype.ViSession(self._vi) # case S110 waveform_names_ctype = None # case C090 @@ -473,19 +384,6 @@ def get_attribute_vi_string(self, channel_name, attribute): # noqa: N802 errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) return value_ctype.value.decode(self._encoding) - def get_channel_name(self, index): # noqa: N802 - vi_ctype = _visatype.ViSession(self._vi) # case S110 - index_ctype = _visatype.ViInt32(index) # case S150 - buffer_size_ctype = _visatype.ViInt32() # case S170 - name_ctype = None # case C050 - error_code = self._library.niRFSG_GetChannelName(vi_ctype, index_ctype, buffer_size_ctype, name_ctype) - errors.handle_error(self, error_code, ignore_warnings=True, is_error_handling=False) - buffer_size_ctype = _visatype.ViInt32(error_code) # case S180 - name_ctype = (_visatype.ViChar * buffer_size_ctype.value)() # case C060 - error_code = self._library.niRFSG_GetChannelName(vi_ctype, index_ctype, buffer_size_ctype, name_ctype) - errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) - return name_ctype.value.decode(self._encoding) - def get_deembedding_sparameters(self, sparameters, sparameters_array_size): # noqa: N802 vi_ctype = _visatype.ViSession(self._vi) # case S110 sparameters_ctype = _get_ctypes_pointer_for_buffer(value=sparameters, library_type=_complextype.NIComplexNumber) # case B510 @@ -676,14 +574,6 @@ def read_and_download_waveform_from_file_tdms(self, waveform_name, file_path, wa errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) return - def reset_attribute(self, channel_name, attribute_id): # noqa: N802 - vi_ctype = _visatype.ViSession(self._vi) # case S110 - channel_name_ctype = ctypes.create_string_buffer(channel_name.encode(self._encoding)) # case C010 - attribute_id_ctype = _visatype.ViAttr(attribute_id) # case S150 - error_code = self._library.niRFSG_ResetAttribute(vi_ctype, channel_name_ctype, attribute_id_ctype) - errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) - return - def reset_device(self): # noqa: N802 vi_ctype = _visatype.ViSession(self._vi) # case S110 error_code = self._library.niRFSG_ResetDevice(vi_ctype) @@ -703,14 +593,6 @@ def reset_with_options(self, steps_to_omit): # noqa: N802 errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) return - def revision_query(self): # noqa: N802 - vi_ctype = _visatype.ViSession(self._vi) # case S110 - instrument_driver_revision_ctype = (_visatype.ViChar * 256)() # case C070 - firmware_revision_ctype = (_visatype.ViChar * 256)() # case C070 - error_code = self._library.niRFSG_RevisionQuery(vi_ctype, instrument_driver_revision_ctype, firmware_revision_ctype) - errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False) - return instrument_driver_revision_ctype.value.decode(self._encoding), firmware_revision_ctype.value.decode(self._encoding) - def save_configurations_to_file(self, channel_name, file_path): # noqa: N802 vi_ctype = _visatype.ViSession(self._vi) # case S110 channel_name_ctype = ctypes.create_string_buffer(channel_name.encode(self._encoding)) # case C010 diff --git a/generated/nirfsg/nirfsg/enums.py b/generated/nirfsg/nirfsg/enums.py index 3b4e41eed..0379df2f1 100644 --- a/generated/nirfsg/nirfsg/enums.py +++ b/generated/nirfsg/nirfsg/enums.py @@ -83,21 +83,6 @@ class AnalogModulationType(Enum): ''' -class AnalogModulationWaveformType(Enum): - SINE = 3000 - r''' - Specifies that the analog modulation waveform type is sine. - ''' - SQUARE = 3001 - r''' - Specifies that the analog modulation waveform type is square. - ''' - TRIANGLE = 3002 - r''' - Specifies that the analog modulation waveform type is triangle. - ''' - - class ArbOnboardSampleClockMode(Enum): HIGH_RESOLUTION = 6000 r''' @@ -168,36 +153,6 @@ class DigitalEqualizationEnabled(Enum): ''' -class DigitalModulationType(Enum): - NONE = 0 - r''' - Disables digital modulation. - ''' - FSK = 4000 - r''' - Specifies that the digital modulation type is frequency-shift keying (FSK). - ''' - OOK = 4001 - r''' - Specifies that the digital modulation type is on-off keying (OOK). - ''' - PSK = 4002 - r''' - Specifies that the digital modulation type is phase-shift keying (PSK). - ''' - - -class DigitalModulationWaveformType(Enum): - PRBS = 5000 - r''' - Specifies that the digital modulation waveform type is pseudorandom bit sequence (PRBS). - ''' - USER_DEFINED = 5001 - r''' - Specifies that the digital modulation waveform type is user defined. To specify the user-defined waveform, call the configure_digital_modulation_user_defined_waveform method. - ''' - - class DirectDownload(Enum): DISABLE = 0 r''' @@ -213,21 +168,6 @@ class DirectDownload(Enum): ''' -class FilterType(Enum): - NONE = 0 - r''' - No filter type is applied. - ''' - ARB_FILTER_TYPE_ROOT_RAISED_COSINE = 10001 - r''' - Applies a root-raised cosine filter to the data with the alpha value specified with the arb_filter_root_raised_cosine_alpha property. - ''' - ARB_FILTER_TYPE_RAISED_COSINE = 10002 - r''' - Applies a raised cosine filter to the data with the alpha value specified with the arb_filter_raised_cosine_alpha property. - ''' - - class Format(Enum): MAGNITUDE_AND_PHASE = 26001 r''' @@ -466,21 +406,6 @@ class PowerLevelType(Enum): ''' -class PpaInheritance(Enum): - EXACT_MATCH = 0 - r''' - Errors out if different values are detected in the script. - ''' - MINIMUM = 1 - r''' - Uses the minimum value found in the script. - ''' - MAXIMUM = 2 - r''' - Uses the maximum value found in the script. - ''' - - class PulseModulationMode(Enum): OPTIMAL_MATCH = 20000 r''' diff --git a/generated/nirfsg/nirfsg/session.py b/generated/nirfsg/nirfsg/session.py index 4da8acc00..5ba85ac21 100644 --- a/generated/nirfsg/nirfsg/session.py +++ b/generated/nirfsg/nirfsg/session.py @@ -289,21 +289,6 @@ class _SessionBase(object): | AnalogModulationFmBand.WIDEBAND | 17001 (0x4269) | Specifies wideband frequency modulation. | +-----------------------------------+----------------+--------------------------------------------+ ''' - analog_modulation_fm_deviation = _attributes.AttributeViReal64(1150035) - '''Type: float - - Specifies the frequency deviation to use in frequency modulation. - - **Units**: hertz (Hz) - - **Default Value:** 1kHz - - **Supported Devices:** PXI/PXIe-5650/5651/5652 - - **Related Topics** - - `Modulation Schemes `_ - ''' analog_modulation_fm_narrowband_integrator = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.AnalogModulationFmNarrowbandIntegrator, 1150165) '''Type: enums.AnalogModulationFmNarrowbandIntegrator @@ -433,46 +418,6 @@ class _SessionBase(object): Note: One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. ''' - analog_modulation_waveform_frequency = _attributes.AttributeViReal64(1150034) - '''Type: float - - Specifies the frequency of the waveform to use as the message signal in analog modulation. - - **Units:** hertz (Hz) - - **Default Value:** 1kHz - - **Supported Devices:** PXI/PXIe-5650/5651/5652 - - **Related Topics** - - `Modulation Schemes `_ - ''' - analog_modulation_waveform_type = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.AnalogModulationWaveformType, 1150033) - '''Type: enums.AnalogModulationWaveformType - - Specifies the type of waveform to use as the message signal for analog modulation. - - **Default Value:** AnalogModulationWaveformType.SINE - - **Supported Devices:** PXI/PXIe-5650/5651/5652 - - **Related Topics** - - `Modulation Schemes `_ - - **Defined Values**: - - +---------------------------------------+--------------+-----------------------------------------------------------------+ - | Name | Value | Description | - +=======================================+==============+=================================================================+ - | AnalogModulationWaveformType.SINE | 3000 (0xbb8) | Specifies that the analog modulation waveform type is sine. | - +---------------------------------------+--------------+-----------------------------------------------------------------+ - | AnalogModulationWaveformType.SQUARE | 3001 (0xbb9) | Specifies that the analog modulation waveform type is square. | - +---------------------------------------+--------------+-----------------------------------------------------------------+ - | AnalogModulationWaveformType.TRIANGLE | 3002 (0xbba) | Specifies that the analog modulation waveform type is triangle. | - +---------------------------------------+--------------+-----------------------------------------------------------------+ - ''' arb_carrier_frequency = _attributes.AttributeViReal64(1150015) '''Type: float @@ -508,44 +453,6 @@ class _SessionBase(object): **Supported Devices:** PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 ''' - arb_filter_raised_cosine_alpha = _attributes.AttributeViReal64(1150060) - '''Type: float - - Specifies the alpha value to use when calculating the pulse-shaping filter coefficients. You can use this property only when the arb_filter_type property is set to FilterType.ARB_FILTER_TYPE_RAISED_COSINE and with signal generators that support onboard signal processing (OSP). NI-RFSG returns an error if you use this property with a device that does not support OSP. - - **Supported Devices:** PXI-5671, PXIe-5672/5673/5673E - ''' - arb_filter_root_raised_cosine_alpha = _attributes.AttributeViReal64(1150057) - '''Type: float - - Specifies the alpha value to use when calculating the pulse-shaping FIR filter coefficients. You can use this property only when the arb_filter_type property is set to FilterType.ARB_FILTER_TYPE_ROOT_RAISED_COSINE and with signal generators that support onboard signal processing (OSP). NI-RFSG returns an error if you use this property with a device that does not support OSP. - - **Supported Devices:** PXI-5671, PXIe-5672/5673/5673E - ''' - arb_filter_type = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.FilterType, 1150056) - '''Type: enums.FilterType - - Specifies the pulse-shaping filter type for the FIR filter. You can use this property only with signal generators that support onboard signal processing (OSP). NI-RFSG returns an error if you use this property with a device that does not support OSP. - - **Default Value:** FilterType.NONE - - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - - **Defined Values**: - - +-----------------------------------------------+----------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +===============================================+================+=======================================================================================================================================+ - | FilterType.NONE | 0 (0x0) | Disables analog modulation. | - +-----------------------------------------------+----------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | FilterType.ARB_FILTER_TYPE_RAISED_COSINE | 10002 (0x2712) | Applies a raised cosine filter to the data with the alpha value specified with the arb_filter_raised_cosine_alpha property. | - +-----------------------------------------------+----------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | FilterType.ARB_FILTER_TYPE_ROOT_RAISED_COSINE | 10001 (0x2711) | Applies a root-raised cosine filter to the data with the alpha value specified with the arb_filter_root_raised_cosine_alpha property. | - +-----------------------------------------------+----------------+---------------------------------------------------------------------------------------------------------------------------------------+ - - Note: - One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. - ''' arb_max_number_waveforms = _attributes.AttributeViInt32(1250454) '''Type: int @@ -588,26 +495,6 @@ class _SessionBase(object): Note: Using the high resolution clock may result in increased phase noise. ''' - arb_oscillator_phase_dac_value = _attributes.AttributeViInt32(1150089) - '''Type: int - - Specifies the oscillator phase digital-to-analog converter (DAC) value on the arbitrary waveform generator (AWG). Use this property to reduce the trigger jitter when synchronizing multiple devices with NI-TClk. This property can also help maintain synchronization repeatability by writing a previous measurement's phase DAC value to the current session. This property is applicable only when using the arb_sample_clock_source property set to ClkIn. - - **Supported Devices:** PXIe-5673/5673E - - **Related Topics** - - `NI-TClk Overview `_ - ''' - arb_power = _attributes.AttributeViReal64(1150016) - '''Type: float - - Indicates the average output power from the PXI-5421, PXI-5441, PXIe-5442, and PXIe-5450 AWG module. If an arbitrary waveform is being generated, this property specifies either the average power or the peak power of the signal, depending on the power_level_type property setting. - - **Units**: dBm - - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - ''' arb_pre_filter_gain = _attributes.AttributeViReal64(1150025) '''Type: float @@ -765,67 +652,6 @@ class _SessionBase(object): `Spurious Performance `_ ''' - attenuator_hold_enabled = _attributes.AttributeViBoolean(1150009) - '''Type: bool - - Specifies whether attenuator hold is enabled. While this property is set to True, changing the power level causes NI-RFSG to scale the digital data sent to the AWG instead of adjusting the attenuators. Changing power levels in this manner allows the device to increase or decrease the power level in more accurate increments, but it may affect signal-to-noise ratios (noise density). - - Setting the attenuator_hold_enabled property to True limits the power levels that can be attained. With attenuator hold enabled, the power level must satisfy the following conditions: - - - Power level less than or equal to attenuator_hold_max_power - - Power level greater than or equal to (maximum power level -70dB) - - Power level greater than or equal to -145dBm - - To set this property, the NI-RFSG device must be in the Configuration state. - - **Default Value:** False - - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - - **Related Topics** - - `Attenuator Hold `_ - - `Settling Times `_ - - **Defined Values**: - - +-------+---------------------------+ - | Value | Description | - +=======+===========================+ - | True | Enables attenuator hold. | - +-------+---------------------------+ - | False | Disables attenuator hold. | - +-------+---------------------------+ - - Note: The frequency cannot be changed on the PXI-5670/5671 or PXIe-5672 while this property is set to True. - ''' - attenuator_hold_max_power = _attributes.AttributeViReal64(1150010) - '''Type: float - - Specifies the maximum power level of the RF output signal when the attenuator_hold_enabled property is set to True. - - To set this property, the NI-RFSG device must be in the Configuration state. - - **Units**: dBm - - **Defined Values**: - Refer to the specifications document for your device for allowable maximum power levels. - - **Default Value:** - - PXI-5670/5671, PXIe-5672: 17 - - PXIe-5673/5673E: 10 - - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - - **Related Topics** - - `Attenuator Hold `_ - - `Settling Times `_ - ''' attenuator_setting = _attributes.AttributeViReal64(1150173) '''Type: float @@ -913,46 +739,6 @@ class _SessionBase(object): **Supported Devices**: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 ''' - cache = _attributes.AttributeViBoolean(1050004) - '''Type: bool - - Specifies whether to cache the value of properties. When caching is enabled, NI-RFSG tracks the current NI-RFSG device settings and avoids sending redundant commands to the device. NI-RFSG can always cache or never cache particular properties, regardless of the setting of this property. Call the __init__ method to override the default value. - - **Default Value:** True - - **Supported Devices:** PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - - **Defined Values**: - - +-------+-------------------+ - | Value | Description | - +=======+===================+ - | True | Enables caching. | - +-------+-------------------+ - | False | Disables caching. | - +-------+-------------------+ - ''' - compensate_for_filter_group_delay = _attributes.AttributeViBoolean(1152832) - '''Type: bool - - Enables or disables compensation for filter group delay on the AWG module. This property also accounts for the upconverter group delay and aligns the RF output with the Started Event, Done Event, and Marker Events. - - At a low I/Q rate, the group delay can become so large that some devices may not be able to align the events with the RF output, in which case you must increase the I/Q rate or disable this property. - - **Default Value:** False - - **Supported Devices:** PXIe-5672 - - **Defined Values**: - - +-------+-----------------------------------------------+ - | Value | Description | - +=======+===============================================+ - | True | Enables compensation for filter group delay. | - +-------+-----------------------------------------------+ - | False | Disables compensation for filter group delay. | - +-------+-----------------------------------------------+ - ''' configuration_settled_event_terminal_name = _attributes.AttributeViString(1150194) '''Type: str @@ -989,72 +775,6 @@ class _SessionBase(object): - Use this property only when your application requires the same settings to be used every time, regardless of the temperature variation. In these cases, it is best to ensure that the temperature does not vary too much. ''' - data_transfer_block_size = _attributes.AttributeViInt32(1150048) - '''Type: int - - Indicates the number of samples to transfer at one time from the device to host memory. This property is useful when the total data to be transferred to onboard memory is large. - - **Units**: samples (s) - - **Default Value**: 1Ms - - **Supported Devices:** PXIe-5672/5673/5673E - ''' - data_transfer_maximum_bandwidth = _attributes.AttributeViReal64(1150086) - '''Type: float - - Specifies the maximum amount of bus bandwidth to use for data transfers. - - **Units**: bytes per second - - **Default Value**: Device maximum - - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - - **Related Topics** - - `Improving Streaming Performance `_ - ''' - data_transfer_maximum_in_flight_reads = _attributes.AttributeViInt32(1150088) - '''Type: int - - Specifies the maximum number of concurrent PCI Express read requests the RF signal generator can issue. - - When transferring data from computer memory to device onboard memory across the PCI Express bus, the signal generator can issue multiple memory reads at the same time. In general, the larger the number of read requests, the more efficiently the device uses the bus because the multiple read requests keep the data flowing, even in a PCI Express topology that has high latency due to PCI Express switches in the data path. Most NI devices can issue a large number of read requests (typically 8 or 16). By default, this property is set to the highest value the RF signal generator supports. - - If other devices in your system cannot tolerate long data latencies, it may be helpful to decrease the number of in-flight read requests the RF signal generator issues. This helps to reduce the amount of data the signal generator reads at one time. - - **Units**: number of packets - - **Default Value**: Device maximum - - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - - **Related Topics** - - `Improving Streaming Performance `_ - ''' - data_transfer_preferred_packet_size = _attributes.AttributeViInt32(1150087) - '''Type: int - - Specifies the preferred size of the data field in a PCI Express read request packet. - - In general, the larger the packet size, the more efficiently the device uses the bus. By default, NI RF signal generators use the largest packet size allowed by the system. However, due to different system implementations, some systems may perform better with smaller packet sizes. - - Recommended values for this property are powers of two between 64 and 512. - - **Units**: bytes - - **Default Value**: Device maximum - - **Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E - - **Related Topics** - - `Improving Streaming Performance `_ - - Note: In some cases, the RF signal generator generates packets smaller than the preferred size you set with this property. - ''' deembedding_compensation_gain = _attributes.AttributeViReal64(1150289) '''Type: float @@ -1592,139 +1312,6 @@ class _SessionBase(object): Example: :py:attr:`my_session.digital_level_script_trigger_source` ''' - digital_modulation_fsk_deviation = _attributes.AttributeViReal64(1150041) - '''Type: float - - Specifies the deviation to use in FSK modulation. - - **Units**: hertz (Hz) - - **Default Value:** 1,000 - - **Supported Devices:** PXI/PXIe-5650/5651/5652 - - **Related Topics** - - `Modulation Schemes `_ - ''' - digital_modulation_prbs_order = _attributes.AttributeViInt32(1150039) - '''Type: int - - Specifies the order of pseudorandom bit sequence (PRBS) internally generated by hardware and used as the message signal in digital modulation. - - **Default Value:** 16 - - **Supported Devices:** PXI/PXIe-5650/5651/5652 - - **Related Topics** - - `Modulation Schemes `_ - ''' - digital_modulation_prbs_seed = _attributes.AttributeViInt32(1150040) - '''Type: int - - Specifies the seed of the internally generated pseudorandom bit sequence (PRBS). - - **Default Value:** 1 - - **Supported Devices:** PXI/PXIe-5650/5651/5652 - - **Related Topics** - - `Modulation Schemes `_ - ''' - digital_modulation_symbol_rate = _attributes.AttributeViReal64(1150037) - '''Type: float - - Specifies the symbol rate of the bit stream for digital modulation. - - **Units**: hertz (Hz) - - **Default Value:** 1kHz - - **Supported Devices:** PXI/PXIe-5650/5651/5652 - - **Related Topics** - - `Modulation Schemes `_ - ''' - digital_modulation_type = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.DigitalModulationType, 1150036) - '''Type: enums.DigitalModulationType - - Specifies the digital modulation format to use. - - **Default Value:** DigitalModulationType.NONE - - **Supported Devices:** PXI/PXIe-5650/5651/5652 - - **Related Topics** - - `Modulation Schemes `_ - - **Defined Values**: - - +----------------------------+--------------+-----------------------------------------------------------------------------+ - | Name | Value | Description | - +============================+==============+=============================================================================+ - | DigitalModulationType.FSK | 4000 (0xfa0) | Specifies that the digital modulation type is frequency-shift keying (FSK). | - +----------------------------+--------------+-----------------------------------------------------------------------------+ - | DigitalModulationType.NONE | 0 (0x0) | Disables digital modulation. | - +----------------------------+--------------+-----------------------------------------------------------------------------+ - | DigitalModulationType.OOK | 4001 (0xfa1) | Specifies that the digital modulation type is on-off keying (OOK). | - +----------------------------+--------------+-----------------------------------------------------------------------------+ - | DigitalModulationType.PSK | 4002 (0xfa2) | Specifies that the digital modulation type is phase-shift keying (PSK). | - +----------------------------+--------------+-----------------------------------------------------------------------------+ - - 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. - ''' - digital_modulation_waveform_type = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.DigitalModulationWaveformType, 1150038) - '''Type: enums.DigitalModulationWaveformType - - Specifies the type of waveform to use as the message signal in digital modulation. - - **Default Value:** DigitalModulationWaveformType.PRBS - - **Supported Devices:** PXI/PXIe-5650/5651/5652 - - **Related Topics** - - `Modulation Schemes `_ - - **Defined Values**: - - +--------------------------------------------+---------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Value | Description | - +============================================+===============+================================================================================================================================================================================+ - | DigitalModulationWaveformType.PRBS | 5000 (0x1388) | Specifies that the digital modulation waveform type is pseudorandom bit sequence (PRBS). | - +--------------------------------------------+---------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | DigitalModulationWaveformType.USER_DEFINED | 5001 (0x1389) | Specifies that the digital modulation waveform type is user defined. To specify the user-defined waveform, call the configure_digital_modulation_user_defined_waveform method. | - +--------------------------------------------+---------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - Note: - One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. - ''' - digital_pattern = _attributes.AttributeViBoolean(1150044) - '''Type: bool - - Enables or disables digital pattern on the PXI-5421/5441 AWG module. This property must be set to True to enable signal routing to and from the Digital Data & Control connector. - - To set this property, the NI-RFSG device must be in the Configuration state. - - **Default Value:** False - - **Supported Devices:** PXI-5670/5671 - - **Defined Values**: - - +-------+--------------------------+ - | Value | Description | - +=======+==========================+ - | True | Signal routing enabled. | - +-------+--------------------------+ - | False | Signal routing disabled. | - +-------+--------------------------+ - ''' direct_download = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.DirectDownload, 1150042) '''Type: enums.DirectDownload @@ -2490,28 +2077,6 @@ class _SessionBase(object): Note: One or more of the referenced properties are not in the Python API for this driver. ''' - frequency_tolerance = _attributes.AttributeViReal64(1150006) - '''Type: float - - Specifies the allowable frequency error introduced during the software upconversion process. NI-RFSG may introduce a frequency error up to the specified amount to optimize computational speed and onboard memory usage while upconverting phase-continuous signals. - - If the phase_continuity_enabled property is set to NIRFSG_VAL_DISABLE, the frequency_tolerance property is ignored, and the driver does not introduce a frequency error. On devices that do not use software upconversion, this property is ignored. The PXI-5670 always uses software upconversion, and the PXI-5671 uses software upconversion for I/Q rates greater than 8.33MS/s. - - To set this property, the NI-RFSG device must be in the Configuration state. - - **Units**: hertz (Hz) - - **Default Value:** 50 - - **Supported Devices:** PXI-5670/5671 - - **Related Topics** - - `Phase Continuity `_ - - Note: - One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. - ''' generation_mode = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.GenerationMode, 1150018) '''Type: enums.GenerationMode @@ -2567,10 +2132,6 @@ class _SessionBase(object): Returns a string that contains the firmware revision information for the NI-RFSG device you are currently using. **Supported Devices:** PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - - **High-Level Methods**: - - - revision_query ''' instrument_manufacturer = _attributes.AttributeViString(1050511) '''Type: str @@ -2586,27 +2147,6 @@ class _SessionBase(object): **Supported Devices:** PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 ''' - interchange_check = _attributes.AttributeViBoolean(1050021) - '''Type: bool - - Specifies whether to perform interchangeability checking and retrieve interchangeability warnings. - - **Default Value:** False - - **Supported Devices:** PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - - **Defined Values**: - - +-------+--------------------------------+ - | Value | Description | - +=======+================================+ - | True | Interchange check is enabled. | - +-------+--------------------------------+ - | False | Interchange check is disabled. | - +-------+--------------------------------+ - - Note: Enabling interchangeability check is not supported. - ''' interpolation_delay = _attributes.AttributeViReal64(1150153) '''Type: float @@ -2692,7 +2232,7 @@ class _SessionBase(object): If the iq_i_offset property is set to 100%, iq_q_offset property is set to 0%, and power_level property set to 0 dBm, the desired RF signal is at 0 dBm and the carrier leakage is also at 0 dBm. - The AWG or VST peak power level changes when settings change in other properties such as the power_level, frequency, iq_skew, iq_gain_imbalance, attenuator_hold_enabled, and arb_pre_filter_gain properties. When the iq_offset_units property is set to OffsetUnits.PERCENT, the actual AWG or VST offset changes as the AWG or VST peak power level changes to satisfy the preceding equations. These changes are useful if you are intentionally adding carrier leakage to test the tolerance of a receiver. When the iq_offset_units property is set to OffsetUnits.PERCENT, the carrier leakage, in dBc, remains at a consistent level. + The AWG or VST peak power level changes when settings change in other properties such as the power_level, frequency, iq_skew, iq_gain_imbalance and arb_pre_filter_gain properties. When the iq_offset_units property is set to OffsetUnits.PERCENT, the actual AWG or VST offset changes as the AWG or VST peak power level changes to satisfy the preceding equations. These changes are useful if you are intentionally adding carrier leakage to test the tolerance of a receiver. When the iq_offset_units property is set to OffsetUnits.PERCENT, the carrier leakage, in dBc, remains at a consistent level. If you are trying to eliminate residual carrier leakage due to calibration inaccuracies or drift, set the iq_offset_units property to OffsetUnits.VOLTS. Offset correction voltage is applied to the I/Q modulator or VST, regardless of changes to the AWG or VST peak power level. @@ -3747,33 +3287,10 @@ class _SessionBase(object): - For the PXIe-5645, this property is ignored if you are using the I/Q ports. ''' - peak_power_adjustment_inheritance = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.PpaInheritance, 1150141) - '''Type: enums.PpaInheritance - - Determines the inheritance behavior of the peak_power_adjustment property when a script inherits values from specified waveforms. - - **Default Value:** PpaInheritance.EXACT_MATCH - - **Supported Devices:** PXIe-5673/5673E - - **Related Topics** - - `Assigning Properties or Properties to a Waveform `_ - - **Defined Values**: - - +----------------------------+------------------------------------------------------------+ - | Value | Description | - +============================+============================================================+ - | PpaInheritance.EXACT_MATCH | Errors out if different values are detected in the script. | - +----------------------------+------------------------------------------------------------+ - | PpaInheritance.MINIMUM | Uses the minimum value found in the script. | - +----------------------------+------------------------------------------------------------+ - ''' phase_continuity_enabled = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.PhaseContinuityEnabled, 1150005) '''Type: enums.PhaseContinuityEnabled - Specifies whether the driver maintains phase continuity in the arbitrary waveforms. When this property is set to PhaseContinuityEnabled.ENABLE, NI-RFSG may increase the waveform size. When this property is set to PhaseContinuityEnabled.ENABLE, the frequency_tolerance property specifies the maximum allowable frequency error that can be introduced when keeping the signal phase-continuous. To set the phase_continuity_enabled property, the NI-RFSG device must be in the Configuration state. phase_continuity_enabled applies only when the generation_mode property is set to GenerationMode.ARB_WAVEFORM or GenerationMode.SCRIPT. + Specifies whether the driver maintains phase continuity in the arbitrary waveforms. When this property is set to PhaseContinuityEnabled.ENABLE, NI-RFSG may increase the waveform size. To set the phase_continuity_enabled property, the NI-RFSG device must be in the Configuration state. phase_continuity_enabled applies only when the generation_mode property is set to GenerationMode.ARB_WAVEFORM or GenerationMode.SCRIPT. PXI-5671: When using the PXI-5671 with I/Q rates less than or equal to 8.33MS/s, an input phase-continuous signal is always phase-continuous upon output, and this property has no effect. @@ -3960,141 +3477,38 @@ class _SessionBase(object): +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | NIRFSG_VAL_PULSE_MODULATION_ANALOG_HIGH_ISOLATION | Allows for the best on/off power ratio of the pulsed signal. | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | NIRFSG_VAL_PULSE_MODULATION_ANALOG | Analog switch blanking. Balance between switching speed and on/off power ratio of the pulsed signal. | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | NIRFSG_VAL_PULSE_MODULATION_DIGITAL | Digital only modulation. Provides the best on/off switching speed of the pulsed signal at the cost of signal isolation. | - +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - - Note: - One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed. - ''' - pulse_modulation_source = _attributes.AttributeViString(1150308) - '''Type: str - - Specifies the source of the pulse modulation signal. When Pulse In in used, the pulse modulation is applied with the lowest latency and jitter, but is not aligned to any particular waveform sample. When a marker is used, the RF pulse is aligned to a specific sample in the arbitrary waveform. To set this property, the NI-RFSG device must be in the Configuration state. - - **Default Value:** PulseIn - - **Supported Devices:** PXIe-5842 - - **Possible Values**: - - +----------------+----------------------------------------------------------------------------------------------+ - | Possible Value | Description | - +================+==============================================================================================+ - | "PulseIn" | The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842. | - +----------------+----------------------------------------------------------------------------------------------+ - | "Marker0" | The trigger is received from the Marker 0. | - +----------------+----------------------------------------------------------------------------------------------+ - | "Marker1" | The trigger is received from the Marker 1. | - +----------------+----------------------------------------------------------------------------------------------+ - | "Marker2" | The trigger is received from the Marker 2. | - +----------------+----------------------------------------------------------------------------------------------+ - | "Marker3" | The trigger is received from the Marker 3. | - +----------------+----------------------------------------------------------------------------------------------+ - ''' - pxi_chassis_clk10_source = _attributes.AttributeViString(1150004) - '''Type: str - - Specifies the clock source for driving the PXI 10 MHz backplane Reference Clock. This property is configurable if the PXI-5610 upconverter module is installed in *only* Slot 2 of a PXI chassis. To set this property, the NI-RFSG device must be in the Configuration state. - - **Possible Values**: - - Possible Value: Description - - "" :Do not drive the PXI_CLK10 signal. - - "OnboardClock" :Uses the highly stable oven-controlled onboard Reference Clock to drive the PXI_CLK signal. - - "RefIn" :Uses the clock present at the front panel REF IN connector to drive the PXI_CLK signal. - - **Default Value:** "" - - **Supported Devices:** PXI-5610, PXI-5670/5671 - - **Related Topics** - - `Timing Configurations `_ - - `System Reference Clock `_ - - **High-Level Methods**: - - - configure_pxi_chassis_clk10 - - - Only certain combinations of this property and the ref_clock_source property are valid, as shown in the following table. - - +----------------------------------+--------------------------+ - | pxi_chassis_clk10_source Setting | ref_clock_source Setting | - +==================================+==========================+ - | "", OnboardClock | OnboardClock | - +----------------------------------+--------------------------+ - | "", RefIn | RefIn | - +----------------------------------+--------------------------+ - | "", RefIn | PXI_CLK | - +----------------------------------+--------------------------+ - ''' - query_instrument_status = _attributes.AttributeViBoolean(1050003) - '''Type: bool - - Specifies whether NI-RFSG queries the NI-RFSG device status after each operation. Querying the device status is useful for debugging. After you validate your program, set this property to False to disable status checking and maximize performance. - - NI-RFSG can choose to ignore status checking for particular properties, regardless of the setting of this property. Use the __init__ method to override the default value. - - **Default Value:** False - - **Supported Devices:** PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - - **Defined Values**: - - +-------+-------------------------------------------------------------+ - | Value | Description | - +=======+=============================================================+ - | True | NI-RFSG queries the instrument status after each operation. | - +-------+-------------------------------------------------------------+ - | False | NI-RFSG does not query the instrument status. | - +-------+-------------------------------------------------------------+ - ''' - range_check = _attributes.AttributeViBoolean(1050002) - '''Type: bool - - Specifies whether to validate property values and method parameters. Range checking parameters is very useful for debugging. After you validate your program, set this property to False to disable range checking and maximize performance. NI-RFSG can choose to ignore range checking for particular properties, regardless of the setting of this property. Use the __init__ method to override the default value. - - **Default Value:** True - - **Supported Devices:** PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - - **Defined Values**: + | NIRFSG_VAL_PULSE_MODULATION_ANALOG | Analog switch blanking. Balance between switching speed and on/off power ratio of the pulsed signal. | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | NIRFSG_VAL_PULSE_MODULATION_DIGITAL | Digital only modulation. Provides the best on/off switching speed of the pulsed signal at the cost of signal isolation. | + +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - +-------+-------------------------+ - | Value | Description | - +=======+=========================+ - | True | Enable range checking. | - +-------+-------------------------+ - | False | Disable range checking. | - +-------+-------------------------+ + 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. ''' - record_coercions = _attributes.AttributeViBoolean(1050006) - '''Type: bool - - Specifies whether the IVI engine keeps a list of the value coercions it makes for integer and real type properties. + pulse_modulation_source = _attributes.AttributeViString(1150308) + '''Type: str - **Default Value:** False + Specifies the source of the pulse modulation signal. When Pulse In in used, the pulse modulation is applied with the lowest latency and jitter, but is not aligned to any particular waveform sample. When a marker is used, the RF pulse is aligned to a specific sample in the arbitrary waveform. To set this property, the NI-RFSG device must be in the Configuration state. - **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 + **Default Value:** PulseIn - **Defined Values**: + **Supported Devices:** PXIe-5842 - +-------+---------------------------------------------------+ - | Value | Description | - +=======+===================================================+ - | True | The IVI engine keeps a list of coercions. | - +-------+---------------------------------------------------+ - | False | The IVI engine does not keep a list of coercions. | - +-------+---------------------------------------------------+ + **Possible Values**: - Note: Enabling record value coercions is not supported. + +----------------+----------------------------------------------------------------------------------------------+ + | Possible Value | Description | + +================+==============================================================================================+ + | "PulseIn" | The trigger is received on the PULSE IN terminal. This value is valid on only the PXIe-5842. | + +----------------+----------------------------------------------------------------------------------------------+ + | "Marker0" | The trigger is received from the Marker 0. | + +----------------+----------------------------------------------------------------------------------------------+ + | "Marker1" | The trigger is received from the Marker 1. | + +----------------+----------------------------------------------------------------------------------------------+ + | "Marker2" | The trigger is received from the Marker 2. | + +----------------+----------------------------------------------------------------------------------------------+ + | "Marker3" | The trigger is received from the Marker 3. | + +----------------+----------------------------------------------------------------------------------------------+ ''' ref_clock_rate = _attributes.AttributeEnum(_attributes.AttributeViReal64, enums.ReferenceClockRate, 1250322) '''Type: enums.ReferenceClockRate @@ -4149,7 +3563,7 @@ class _SessionBase(object): ref_clock_source = _attributes.AttributeViString(1150001) '''Type: str - Specifies the Reference Clock source. To set this property, the NI-RFSG device must be in the Configuration state. Only certain combinations of this property and the pxi_chassis_clk10_source property are valid, as shown in the following table. + Specifies the Reference Clock source. To set this property, the NI-RFSG device must be in the Configuration state. **Default Value:** OnboardClock @@ -4180,8 +3594,6 @@ class _SessionBase(object): +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | "PXI_ClkMaster" | This value is valid on only the PXIe-5831/5832 with PXIe-5653. **PXIe-5831/5832 with PXIe-5653** —NI-RFSG configures the PXIe-5653 to export the Reference clock and configures the PXIe-5820 and PXIe-3622 to use PXI_CLK as the Reference Clock source. Connect the PXIe-5653 REF OUT (10 MHz) connector to the PXI chassis REF IN connector. | +-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - Note: The PXI-5670/5671 and PXIe-5672 devices also allow you to drive the PXI 10 MHz backplane clock on PXI chassis *only* using the pxi_chassis_clk10_source property. ''' ref_pll_bandwidth = _attributes.AttributeEnum(_attributes.AttributeViInt32, enums.ReferencePllBandwidth, 1150133) '''Type: enums.ReferencePllBandwidth @@ -4482,23 +3894,6 @@ class _SessionBase(object): `PXIe-5841 Frequency and Bandwidth Selection `_ ''' - simulate = _attributes.AttributeViBoolean(1050005) - '''Type: bool - - Returns whether NI-RFSG simulates I/O operations. This property is useful for debugging applications without using hardware. After a session is opened, you cannot change the simulation state. Use the __init__ method to enable simulation. - - **Supported Devices:** PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - - **Defined Values**: - - +-------+-------------------------+ - | Value | Description | - +=======+=========================+ - | True | Simulation is enabled. | - +-------+-------------------------+ - | False | Simulation is disabled. | - +-------+-------------------------+ - ''' specific_driver_class_spec_major_version = _attributes.AttributeViInt32(1050515) '''Type: int @@ -5318,164 +4713,6 @@ def __setattr__(self, key, value): ''' These are code-generated ''' - @ivi_synchronized - def check_attribute_vi_boolean(self, attribute, value): - r'''check_attribute_vi_boolean - - Checks the validity of a value you specify for a ViBoolean property. - - Tip: - This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. - Use Python index notation on the repeated capabilities container channels to specify a subset, - and then call this method on the result. - - Example: :py:meth:`my_session.channels[ ... ].check_attribute_vi_boolean` - - To call the method on all channels, you can call it directly on the :py:class:`nirfsg.Session`. - - Example: :py:meth:`my_session.check_attribute_vi_boolean` - - Args: - attribute (int): Pass the ID of a property. - - value (bool): Pass the value that you want to verify as a valid value for the property. - - Note: Some of the values might not be valid depending on the current settings of the instrument session. - - ''' - self._interpreter.check_attribute_vi_boolean(self._repeated_capability, attribute, value) - - @ivi_synchronized - def check_attribute_vi_int32(self, attribute, value): - r'''check_attribute_vi_int32 - - Checks the validity of a value you specify for a ViInt32 property. - - Tip: - This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. - Use Python index notation on the repeated capabilities container channels to specify a subset, - and then call this method on the result. - - Example: :py:meth:`my_session.channels[ ... ].check_attribute_vi_int32` - - To call the method on all channels, you can call it directly on the :py:class:`nirfsg.Session`. - - Example: :py:meth:`my_session.check_attribute_vi_int32` - - Args: - attribute (int): Pass the ID of a property. - - value (int): Pass the value that you want to verify as a valid value for the property. - - Note: Some of the values might not be valid depending on the current settings of the instrument session. - - ''' - self._interpreter.check_attribute_vi_int32(self._repeated_capability, attribute, value) - - @ivi_synchronized - def check_attribute_vi_int64(self, attribute, value): - r'''check_attribute_vi_int64 - - Checks the validity of a value you specify for a ViInt64 property. - - Tip: - This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. - Use Python index notation on the repeated capabilities container channels to specify a subset, - and then call this method on the result. - - Example: :py:meth:`my_session.channels[ ... ].check_attribute_vi_int64` - - To call the method on all channels, you can call it directly on the :py:class:`nirfsg.Session`. - - Example: :py:meth:`my_session.check_attribute_vi_int64` - - Args: - attribute (int): Pass the ID of a property. - - value (int): Pass the value that you want to verify as a valid value for the property. - - Note: Some of the values might not be valid depending on the current settings of the instrument session. - - ''' - self._interpreter.check_attribute_vi_int64(self._repeated_capability, attribute, value) - - @ivi_synchronized - def check_attribute_vi_real64(self, attribute, value): - r'''check_attribute_vi_real64 - - Checks the validity of a value you specify for a ViReal64 property. - - Tip: - This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. - Use Python index notation on the repeated capabilities container channels to specify a subset, - and then call this method on the result. - - Example: :py:meth:`my_session.channels[ ... ].check_attribute_vi_real64` - - To call the method on all channels, you can call it directly on the :py:class:`nirfsg.Session`. - - Example: :py:meth:`my_session.check_attribute_vi_real64` - - Args: - attribute (int): Pass the ID of a property. - - value (float): Pass the value that you want to verify as a valid value for the property. - - Note: Some of the values might not be valid depending on the current settings of the instrument session. - - ''' - self._interpreter.check_attribute_vi_real64(self._repeated_capability, attribute, value) - - @ivi_synchronized - def check_attribute_vi_session(self, attribute): - r'''check_attribute_vi_session - - Checks the validity of a value you specify for a ViSession property. - - Tip: - This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. - Use Python index notation on the repeated capabilities container channels to specify a subset, - and then call this method on the result. - - Example: :py:meth:`my_session.channels[ ... ].check_attribute_vi_session` - - To call the method on all channels, you can call it directly on the :py:class:`nirfsg.Session`. - - Example: :py:meth:`my_session.check_attribute_vi_session` - - Args: - attribute (int): Pass the ID of a property. - - ''' - self._interpreter.check_attribute_vi_session(self._repeated_capability, attribute) - - @ivi_synchronized - def check_attribute_vi_string(self, attribute, value): - r'''check_attribute_vi_string - - Checks the validity of a value you specify for a ViString property. - - Tip: - This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. - Use Python index notation on the repeated capabilities container channels to specify a subset, - and then call this method on the result. - - Example: :py:meth:`my_session.channels[ ... ].check_attribute_vi_string` - - To call the method on all channels, you can call it directly on the :py:class:`nirfsg.Session`. - - Example: :py:meth:`my_session.check_attribute_vi_string` - - Args: - attribute (int): Pass the ID of a property. - - value (str): Pass the value that you want to verify as a valid value for the property. The value must be a NULL-terminated string. - - Note: Some of the values might not be valid depending on the current settings of the instrument session. - - ''' - self._interpreter.check_attribute_vi_string(self._repeated_capability, attribute, value) - @ivi_synchronized def configure_digital_edge_script_trigger(self, source, edge): r'''configure_digital_edge_script_trigger @@ -5976,31 +5213,6 @@ def lock(self): # that will handle the unlock for them return _Lock(self) - @ivi_synchronized - def reset_attribute(self, attribute_id): - r'''reset_attribute - - Resets the property to its default value. - - **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - - Tip: - This method can be called on specific channels within your :py:class:`nirfsg.Session` instance. - Use Python index notation on the repeated capabilities container channels to specify a subset, - and then call this method on the result. - - Example: :py:meth:`my_session.channels[ ... ].reset_attribute` - - To call the method on all channels, you can call it directly on the :py:class:`nirfsg.Session`. - - Example: :py:meth:`my_session.reset_attribute` - - Args: - attribute_id (int): Pass the ID of a property. - - ''' - self._interpreter.reset_attribute(self._repeated_capability, attribute_id) - @ivi_synchronized def save_configurations_to_file(self, file_path): r'''save_configurations_to_file @@ -6745,25 +5957,6 @@ def clear_arb_waveform(self, name): ''' self._interpreter.clear_arb_waveform(name) - @ivi_synchronized - def clear_error(self): - r'''clear_error - - Clears the error information associated with the session. - - If you pass VI_NULL for the VI parameter, this method clears the error information for the current execution thread. - - The IVI Engine also maintains this error information separately for each thread. This feature of the IVI Engine is useful if you do not have a session handle to pass to the clear_error method or the get_error method, which occurs when a call to the Init method or the __init__ method fails. - - **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860 - - Note: The get_error method clears the error information after it is retrieved. A call to the clear_error method is necessary only when you do not use a call to the get_error method to retrieve error information. - - Note: - One or more of the referenced properties are not in the Python API for this driver. - ''' - self._interpreter.clear_error() - @ivi_synchronized def clear_self_calibrate_range(self): r'''clear_self_calibrate_range @@ -6886,47 +6079,6 @@ def configure_digital_edge_start_trigger(self, source, edge): raise TypeError('Parameter edge must be of type ' + str(enums.StartTriggerDigitalEdgeEdge)) self._interpreter.configure_digital_edge_start_trigger(source, edge) - @ivi_synchronized - def configure_digital_modulation_user_defined_waveform(self, number_of_samples, user_defined_waveform): - r'''configure_digital_modulation_user_defined_waveform - - Specifies the message signal used for digital modulation when the digital_modulation_waveform_type property is set to NIRFSG_VAL_USER_DEFINED. - - **Supported Devices** : PXI/PXIe-5650/5651/5652 - - 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. - - Args: - number_of_samples (int): Specifies the number of samples in the message signal. - - user_defined_waveform (list of int): Specifies the user-defined message signal used for digital modulation. - - ''' - self._interpreter.configure_digital_modulation_user_defined_waveform(number_of_samples, user_defined_waveform) - - @ivi_synchronized - def configure_pxi_chassis_clk10(self, pxi_clk10_source): - r'''configure_pxi_chassis_clk10 - - Specifies the signal to drive the 10MHz Reference Clock on the PXI backplane. - - This option can only be configured when the PXI-5610 is in Slot 2 of the PXI chassis. The NI-RFSG device must be in the Configuration state before you call this method. - - **Supported Devices** : PXI-5610, PXI-5670/5671 - - **Related Topics** - - `Timing Configurations `_ - - `System Reference Clock `_ - - Args: - pxi_clk10_source (str): Specifies the source of the Reference Clock signal. - - ''' - self._interpreter.configure_pxi_chassis_clk10(pxi_clk10_source) - @ivi_synchronized def configure_rf(self, frequency, power_level): r'''configure_rf @@ -7145,16 +6297,6 @@ def delete_deembedding_table(self, port, table_name): ''' self._interpreter.delete_deembedding_table(port, table_name) - @ivi_synchronized - def disable(self): - r'''disable - - Places the instrument in a quiescent state where it has minimal or no impact on the system to which it is connected. - - **Supported Devices** : PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXI-5670/5671, PXIe-5672/5673/5673E - ''' - self._interpreter.disable() - @ivi_synchronized def disable_start_trigger(self): r'''disable_start_trigger @@ -7171,25 +6313,6 @@ def disable_start_trigger(self): ''' self._interpreter.disable_start_trigger() - @ivi_synchronized - def error_query(self): - r'''error_query - - Reads an error code and an error message from the instrument error queue. - - **Supported Devices** : PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860 - - Returns: - error_code (int): Returns the error code read from the instrument error queue. - - error_message (str): Returns the error message string read from the instrument error message queue. - - You must pass a ViChar array with at least 256 bytes. - - ''' - error_code, error_message = self._interpreter.error_query() - return error_code, error_message - def create_deembedding_sparameter_table_array(self, port, table_name, frequencies, sparameter_table, sparameter_orientation): '''create_deembedding_sparameter_table_array @@ -7299,25 +6422,6 @@ def get_all_script_names(self): script_names = self._interpreter.get_all_script_names() return _converters.convert_comma_separated_string_to_list(script_names) - @ivi_synchronized - def get_channel_name(self, index): - r'''get_channel_name - - Returns the channel string that is in the channel table at an index you specify. - - **Supported Devices** : PXI-5670/5671, PXIe-5672/5673/5673E - - Args: - index (int): Specifies a one-based index into the channel table. - - - Returns: - name (str): Returns a channel string from the channel table at the index you specify in the Index parameter. Do not modify the contents of the channel string. - - ''' - name = self._interpreter.get_channel_name(index) - return name - @ivi_synchronized def _get_deembedding_sparameters(self, sparameters, sparameters_array_size): r'''_get_deembedding_sparameters @@ -7678,20 +6782,6 @@ def _init_with_options(self, resource_name, id_query=False, reset_device=False, The `DriverSetup string `_ is required in order to simulate a specific device. - +------------------+-------------------------+ - | Name | Property Name | - +==================+=========================+ - | RangeCheck | range_check | - +------------------+-------------------------+ - | QueryInstrStatus | query_instrument_status | - +------------------+-------------------------+ - | Cache | cache | - +------------------+-------------------------+ - | RecordCoercions | record_coercions | - +------------------+-------------------------+ - | Simulate | simulate | - +------------------+-------------------------+ - Returns: new_vi (int): Returns a ViSession handle that you use to identify the NI-RFSG device in all subsequent NI-RFSG method calls. @@ -7900,27 +6990,6 @@ def reset_with_options(self, steps_to_omit): raise TypeError('Parameter steps_to_omit must be of type ' + str(enums.ResetWithOptionsStepsToOmit)) self._interpreter.reset_with_options(steps_to_omit) - @ivi_synchronized - def revision_query(self): - r'''revision_query - - Returns the revision numbers of the NI-RFSG driver and the instrument firmware. - - **Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860 - - Returns: - instrument_driver_revision (str): Returns the value of the specific_driver_revision property in the form of a string. - - You must pass a ViChar array with at least 256 bytes. - - firmware_revision (str): Returns the value of the instrument_firmware_revision property in the form of a string. - - You must pass a ViChar array with at least 256 bytes. - - ''' - instrument_driver_revision, firmware_revision = self._interpreter.revision_query() - return instrument_driver_revision, firmware_revision - @ivi_synchronized def select_arb_waveform(self, name): r'''select_arb_waveform diff --git a/generated/nirfsg/nirfsg/unit_tests/_mock_helper.py b/generated/nirfsg/nirfsg/unit_tests/_mock_helper.py index 2b25158b2..fa6277b7d 100644 --- a/generated/nirfsg/nirfsg/unit_tests/_mock_helper.py +++ b/generated/nirfsg/nirfsg/unit_tests/_mock_helper.py @@ -22,18 +22,6 @@ def __init__(self): self._defaults['AllocateArbWaveform']['return'] = 0 self._defaults['ChangeExternalCalibrationPassword'] = {} self._defaults['ChangeExternalCalibrationPassword']['return'] = 0 - self._defaults['CheckAttributeViBoolean'] = {} - self._defaults['CheckAttributeViBoolean']['return'] = 0 - self._defaults['CheckAttributeViInt32'] = {} - self._defaults['CheckAttributeViInt32']['return'] = 0 - self._defaults['CheckAttributeViInt64'] = {} - self._defaults['CheckAttributeViInt64']['return'] = 0 - self._defaults['CheckAttributeViReal64'] = {} - self._defaults['CheckAttributeViReal64']['return'] = 0 - self._defaults['CheckAttributeViSession'] = {} - self._defaults['CheckAttributeViSession']['return'] = 0 - self._defaults['CheckAttributeViString'] = {} - self._defaults['CheckAttributeViString']['return'] = 0 self._defaults['CheckGenerationStatus'] = {} self._defaults['CheckGenerationStatus']['return'] = 0 self._defaults['CheckGenerationStatus']['isDone'] = None @@ -47,8 +35,6 @@ def __init__(self): self._defaults['ClearAllArbWaveforms']['return'] = 0 self._defaults['ClearArbWaveform'] = {} self._defaults['ClearArbWaveform']['return'] = 0 - self._defaults['ClearError'] = {} - self._defaults['ClearError']['return'] = 0 self._defaults['ClearSelfCalibrateRange'] = {} self._defaults['ClearSelfCalibrateRange']['return'] = 0 self._defaults['Commit'] = {} @@ -65,10 +51,6 @@ def __init__(self): self._defaults['ConfigureDigitalEdgeStartTrigger']['return'] = 0 self._defaults['ConfigureDigitalLevelScriptTrigger'] = {} self._defaults['ConfigureDigitalLevelScriptTrigger']['return'] = 0 - self._defaults['ConfigureDigitalModulationUserDefinedWaveform'] = {} - self._defaults['ConfigureDigitalModulationUserDefinedWaveform']['return'] = 0 - self._defaults['ConfigurePxiChassisClk10'] = {} - self._defaults['ConfigurePxiChassisClk10']['return'] = 0 self._defaults['ConfigureRF'] = {} self._defaults['ConfigureRF']['return'] = 0 self._defaults['ConfigureRefClock'] = {} @@ -85,18 +67,12 @@ def __init__(self): self._defaults['DeleteAllDeembeddingTables']['return'] = 0 self._defaults['DeleteDeembeddingTable'] = {} self._defaults['DeleteDeembeddingTable']['return'] = 0 - self._defaults['Disable'] = {} - self._defaults['Disable']['return'] = 0 self._defaults['DisableScriptTrigger'] = {} self._defaults['DisableScriptTrigger']['return'] = 0 self._defaults['DisableStartTrigger'] = {} self._defaults['DisableStartTrigger']['return'] = 0 self._defaults['ErrorMessage'] = {} self._defaults['ErrorMessage']['return'] = 0 - self._defaults['ErrorQuery'] = {} - self._defaults['ErrorQuery']['return'] = 0 - self._defaults['ErrorQuery']['errorCode'] = None - self._defaults['ErrorQuery']['errorMessage'] = None self._defaults['GetAllNamedWaveformNames'] = {} self._defaults['GetAllNamedWaveformNames']['return'] = 0 self._defaults['GetAllNamedWaveformNames']['actualBufferSize'] = None @@ -123,9 +99,6 @@ def __init__(self): self._defaults['GetAttributeViString'] = {} self._defaults['GetAttributeViString']['return'] = 0 self._defaults['GetAttributeViString']['value'] = None - self._defaults['GetChannelName'] = {} - self._defaults['GetChannelName']['return'] = 0 - self._defaults['GetChannelName']['name'] = None self._defaults['GetDeembeddingSparameters'] = {} self._defaults['GetDeembeddingSparameters']['return'] = 0 self._defaults['GetDeembeddingSparameters']['sparameters'] = None @@ -197,18 +170,12 @@ def __init__(self): self._defaults['QueryArbWaveformCapabilities']['maxWaveformSize'] = None self._defaults['ReadAndDownloadWaveformFromFileTDMS'] = {} self._defaults['ReadAndDownloadWaveformFromFileTDMS']['return'] = 0 - self._defaults['ResetAttribute'] = {} - self._defaults['ResetAttribute']['return'] = 0 self._defaults['ResetDevice'] = {} self._defaults['ResetDevice']['return'] = 0 self._defaults['ResetWithDefaults'] = {} self._defaults['ResetWithDefaults']['return'] = 0 self._defaults['ResetWithOptions'] = {} self._defaults['ResetWithOptions']['return'] = 0 - self._defaults['RevisionQuery'] = {} - self._defaults['RevisionQuery']['return'] = 0 - self._defaults['RevisionQuery']['instrumentDriverRevision'] = None - self._defaults['RevisionQuery']['firmwareRevision'] = None self._defaults['SaveConfigurationsToFile'] = {} self._defaults['SaveConfigurationsToFile']['return'] = 0 self._defaults['SelectArbWaveform'] = {} @@ -281,36 +248,6 @@ def niRFSG_ChangeExternalCalibrationPassword(self, vi, old_password, new_passwor return self._defaults['ChangeExternalCalibrationPassword']['return'] return self._defaults['ChangeExternalCalibrationPassword']['return'] - def niRFSG_CheckAttributeViBoolean(self, vi, channel_name, attribute, value): # noqa: N802 - if self._defaults['CheckAttributeViBoolean']['return'] != 0: - return self._defaults['CheckAttributeViBoolean']['return'] - return self._defaults['CheckAttributeViBoolean']['return'] - - def niRFSG_CheckAttributeViInt32(self, vi, channel_name, attribute, value): # noqa: N802 - if self._defaults['CheckAttributeViInt32']['return'] != 0: - return self._defaults['CheckAttributeViInt32']['return'] - return self._defaults['CheckAttributeViInt32']['return'] - - def niRFSG_CheckAttributeViInt64(self, vi, channel_name, attribute, value): # noqa: N802 - if self._defaults['CheckAttributeViInt64']['return'] != 0: - return self._defaults['CheckAttributeViInt64']['return'] - return self._defaults['CheckAttributeViInt64']['return'] - - def niRFSG_CheckAttributeViReal64(self, vi, channel_name, attribute, value): # noqa: N802 - if self._defaults['CheckAttributeViReal64']['return'] != 0: - return self._defaults['CheckAttributeViReal64']['return'] - return self._defaults['CheckAttributeViReal64']['return'] - - def niRFSG_CheckAttributeViSession(self, vi, channel_name, attribute, value): # noqa: N802 - if self._defaults['CheckAttributeViSession']['return'] != 0: - return self._defaults['CheckAttributeViSession']['return'] - return self._defaults['CheckAttributeViSession']['return'] - - def niRFSG_CheckAttributeViString(self, vi, channel_name, attribute, value): # noqa: N802 - if self._defaults['CheckAttributeViString']['return'] != 0: - return self._defaults['CheckAttributeViString']['return'] - return self._defaults['CheckAttributeViString']['return'] - def niRFSG_CheckGenerationStatus(self, vi, is_done): # noqa: N802 if self._defaults['CheckGenerationStatus']['return'] != 0: return self._defaults['CheckGenerationStatus']['return'] @@ -351,11 +288,6 @@ def niRFSG_ClearArbWaveform(self, vi, name): # noqa: N802 return self._defaults['ClearArbWaveform']['return'] return self._defaults['ClearArbWaveform']['return'] - def niRFSG_ClearError(self, vi): # noqa: N802 - if self._defaults['ClearError']['return'] != 0: - return self._defaults['ClearError']['return'] - return self._defaults['ClearError']['return'] - def niRFSG_ClearSelfCalibrateRange(self, vi): # noqa: N802 if self._defaults['ClearSelfCalibrateRange']['return'] != 0: return self._defaults['ClearSelfCalibrateRange']['return'] @@ -396,16 +328,6 @@ def niRFSG_ConfigureDigitalLevelScriptTrigger(self, vi, trigger_id, source, leve return self._defaults['ConfigureDigitalLevelScriptTrigger']['return'] return self._defaults['ConfigureDigitalLevelScriptTrigger']['return'] - def niRFSG_ConfigureDigitalModulationUserDefinedWaveform(self, vi, number_of_samples, user_defined_waveform): # noqa: N802 - if self._defaults['ConfigureDigitalModulationUserDefinedWaveform']['return'] != 0: - return self._defaults['ConfigureDigitalModulationUserDefinedWaveform']['return'] - return self._defaults['ConfigureDigitalModulationUserDefinedWaveform']['return'] - - def niRFSG_ConfigurePxiChassisClk10(self, vi, pxi_clk10_source): # noqa: N802 - if self._defaults['ConfigurePxiChassisClk10']['return'] != 0: - return self._defaults['ConfigurePxiChassisClk10']['return'] - return self._defaults['ConfigurePxiChassisClk10']['return'] - def niRFSG_ConfigureRF(self, vi, frequency, power_level): # noqa: N802 if self._defaults['ConfigureRF']['return'] != 0: return self._defaults['ConfigureRF']['return'] @@ -446,11 +368,6 @@ def niRFSG_DeleteDeembeddingTable(self, vi, port, table_name): # noqa: N802 return self._defaults['DeleteDeembeddingTable']['return'] return self._defaults['DeleteDeembeddingTable']['return'] - def niRFSG_Disable(self, vi): # noqa: N802 - if self._defaults['Disable']['return'] != 0: - return self._defaults['Disable']['return'] - return self._defaults['Disable']['return'] - def niRFSG_DisableScriptTrigger(self, vi, trigger_id): # noqa: N802 if self._defaults['DisableScriptTrigger']['return'] != 0: return self._defaults['DisableScriptTrigger']['return'] @@ -466,25 +383,6 @@ def niRFSG_ErrorMessage(self, vi, error_code, error_message): # noqa: N802 return self._defaults['ErrorMessage']['return'] return self._defaults['ErrorMessage']['return'] - def niRFSG_ErrorQuery(self, vi, error_code, error_message): # noqa: N802 - if self._defaults['ErrorQuery']['return'] != 0: - return self._defaults['ErrorQuery']['return'] - # error_code - if self._defaults['ErrorQuery']['errorCode'] is None: - raise MockFunctionCallError("niRFSG_ErrorQuery", param='errorCode') - if error_code is not None: - error_code.contents.value = self._defaults['ErrorQuery']['errorCode'] - # error_message - if self._defaults['ErrorQuery']['errorMessage'] is None: - raise MockFunctionCallError("niRFSG_ErrorQuery", param='errorMessage') - test_value = self._defaults['ErrorQuery']['errorMessage'] - if type(test_value) is str: - test_value = test_value.encode('ascii') - assert len(error_message) >= len(test_value) - for i in range(len(test_value)): - error_message[i] = test_value[i] - return self._defaults['ErrorQuery']['return'] - def niRFSG_GetAllNamedWaveformNames(self, vi, waveform_names, buffer_size, actual_buffer_size): # noqa: N802 if self._defaults['GetAllNamedWaveformNames']['return'] != 0: return self._defaults['GetAllNamedWaveformNames']['return'] @@ -578,17 +476,6 @@ def niRFSG_GetAttributeViString(self, vi, channel_name, attribute, buf_size, val value.value = self._defaults['GetAttributeViString']['value'].encode('ascii') return self._defaults['GetAttributeViString']['return'] - def niRFSG_GetChannelName(self, vi, index, buffer_size, name): # noqa: N802 - if self._defaults['GetChannelName']['return'] != 0: - return self._defaults['GetChannelName']['return'] - # name - if self._defaults['GetChannelName']['name'] is None: - raise MockFunctionCallError("niRFSG_GetChannelName", param='name') - if buffer_size.value == 0: - return len(self._defaults['GetChannelName']['name']) - name.value = self._defaults['GetChannelName']['name'].encode('ascii') - return self._defaults['GetChannelName']['return'] - def niRFSG_GetDeembeddingSparameters(self, vi, sparameters, sparameters_array_size, number_of_sparameters, number_of_ports): # noqa: N802 if self._defaults['GetDeembeddingSparameters']['return'] != 0: return self._defaults['GetDeembeddingSparameters']['return'] @@ -875,11 +762,6 @@ def niRFSG_ReadAndDownloadWaveformFromFileTDMS(self, vi, waveform_name, file_pat return self._defaults['ReadAndDownloadWaveformFromFileTDMS']['return'] return self._defaults['ReadAndDownloadWaveformFromFileTDMS']['return'] - def niRFSG_ResetAttribute(self, vi, channel_name, attribute_id): # noqa: N802 - if self._defaults['ResetAttribute']['return'] != 0: - return self._defaults['ResetAttribute']['return'] - return self._defaults['ResetAttribute']['return'] - def niRFSG_ResetDevice(self, vi): # noqa: N802 if self._defaults['ResetDevice']['return'] != 0: return self._defaults['ResetDevice']['return'] @@ -895,29 +777,6 @@ def niRFSG_ResetWithOptions(self, vi, steps_to_omit): # noqa: N802 return self._defaults['ResetWithOptions']['return'] return self._defaults['ResetWithOptions']['return'] - def niRFSG_RevisionQuery(self, vi, instrument_driver_revision, firmware_revision): # noqa: N802 - if self._defaults['RevisionQuery']['return'] != 0: - return self._defaults['RevisionQuery']['return'] - # instrument_driver_revision - if self._defaults['RevisionQuery']['instrumentDriverRevision'] is None: - raise MockFunctionCallError("niRFSG_RevisionQuery", param='instrumentDriverRevision') - test_value = self._defaults['RevisionQuery']['instrumentDriverRevision'] - if type(test_value) is str: - test_value = test_value.encode('ascii') - assert len(instrument_driver_revision) >= len(test_value) - for i in range(len(test_value)): - instrument_driver_revision[i] = test_value[i] - # firmware_revision - if self._defaults['RevisionQuery']['firmwareRevision'] is None: - raise MockFunctionCallError("niRFSG_RevisionQuery", param='firmwareRevision') - test_value = self._defaults['RevisionQuery']['firmwareRevision'] - if type(test_value) is str: - test_value = test_value.encode('ascii') - assert len(firmware_revision) >= len(test_value) - for i in range(len(test_value)): - firmware_revision[i] = test_value[i] - return self._defaults['RevisionQuery']['return'] - def niRFSG_SaveConfigurationsToFile(self, vi, channel_name, file_path): # noqa: N802 if self._defaults['SaveConfigurationsToFile']['return'] != 0: return self._defaults['SaveConfigurationsToFile']['return'] @@ -1056,18 +915,6 @@ def set_side_effects_and_return_values(self, mock_library): mock_library.niRFSG_AllocateArbWaveform.return_value = 0 mock_library.niRFSG_ChangeExternalCalibrationPassword.side_effect = MockFunctionCallError("niRFSG_ChangeExternalCalibrationPassword") mock_library.niRFSG_ChangeExternalCalibrationPassword.return_value = 0 - mock_library.niRFSG_CheckAttributeViBoolean.side_effect = MockFunctionCallError("niRFSG_CheckAttributeViBoolean") - mock_library.niRFSG_CheckAttributeViBoolean.return_value = 0 - mock_library.niRFSG_CheckAttributeViInt32.side_effect = MockFunctionCallError("niRFSG_CheckAttributeViInt32") - mock_library.niRFSG_CheckAttributeViInt32.return_value = 0 - mock_library.niRFSG_CheckAttributeViInt64.side_effect = MockFunctionCallError("niRFSG_CheckAttributeViInt64") - mock_library.niRFSG_CheckAttributeViInt64.return_value = 0 - mock_library.niRFSG_CheckAttributeViReal64.side_effect = MockFunctionCallError("niRFSG_CheckAttributeViReal64") - mock_library.niRFSG_CheckAttributeViReal64.return_value = 0 - mock_library.niRFSG_CheckAttributeViSession.side_effect = MockFunctionCallError("niRFSG_CheckAttributeViSession") - mock_library.niRFSG_CheckAttributeViSession.return_value = 0 - mock_library.niRFSG_CheckAttributeViString.side_effect = MockFunctionCallError("niRFSG_CheckAttributeViString") - mock_library.niRFSG_CheckAttributeViString.return_value = 0 mock_library.niRFSG_CheckGenerationStatus.side_effect = MockFunctionCallError("niRFSG_CheckGenerationStatus") mock_library.niRFSG_CheckGenerationStatus.return_value = 0 mock_library.niRFSG_CheckIfScriptExists.side_effect = MockFunctionCallError("niRFSG_CheckIfScriptExists") @@ -1078,8 +925,6 @@ def set_side_effects_and_return_values(self, mock_library): mock_library.niRFSG_ClearAllArbWaveforms.return_value = 0 mock_library.niRFSG_ClearArbWaveform.side_effect = MockFunctionCallError("niRFSG_ClearArbWaveform") mock_library.niRFSG_ClearArbWaveform.return_value = 0 - mock_library.niRFSG_ClearError.side_effect = MockFunctionCallError("niRFSG_ClearError") - mock_library.niRFSG_ClearError.return_value = 0 mock_library.niRFSG_ClearSelfCalibrateRange.side_effect = MockFunctionCallError("niRFSG_ClearSelfCalibrateRange") mock_library.niRFSG_ClearSelfCalibrateRange.return_value = 0 mock_library.niRFSG_Commit.side_effect = MockFunctionCallError("niRFSG_Commit") @@ -1096,10 +941,6 @@ def set_side_effects_and_return_values(self, mock_library): mock_library.niRFSG_ConfigureDigitalEdgeStartTrigger.return_value = 0 mock_library.niRFSG_ConfigureDigitalLevelScriptTrigger.side_effect = MockFunctionCallError("niRFSG_ConfigureDigitalLevelScriptTrigger") mock_library.niRFSG_ConfigureDigitalLevelScriptTrigger.return_value = 0 - mock_library.niRFSG_ConfigureDigitalModulationUserDefinedWaveform.side_effect = MockFunctionCallError("niRFSG_ConfigureDigitalModulationUserDefinedWaveform") - mock_library.niRFSG_ConfigureDigitalModulationUserDefinedWaveform.return_value = 0 - mock_library.niRFSG_ConfigurePxiChassisClk10.side_effect = MockFunctionCallError("niRFSG_ConfigurePxiChassisClk10") - mock_library.niRFSG_ConfigurePxiChassisClk10.return_value = 0 mock_library.niRFSG_ConfigureRF.side_effect = MockFunctionCallError("niRFSG_ConfigureRF") mock_library.niRFSG_ConfigureRF.return_value = 0 mock_library.niRFSG_ConfigureRefClock.side_effect = MockFunctionCallError("niRFSG_ConfigureRefClock") @@ -1116,16 +957,12 @@ def set_side_effects_and_return_values(self, mock_library): mock_library.niRFSG_DeleteAllDeembeddingTables.return_value = 0 mock_library.niRFSG_DeleteDeembeddingTable.side_effect = MockFunctionCallError("niRFSG_DeleteDeembeddingTable") mock_library.niRFSG_DeleteDeembeddingTable.return_value = 0 - mock_library.niRFSG_Disable.side_effect = MockFunctionCallError("niRFSG_Disable") - mock_library.niRFSG_Disable.return_value = 0 mock_library.niRFSG_DisableScriptTrigger.side_effect = MockFunctionCallError("niRFSG_DisableScriptTrigger") mock_library.niRFSG_DisableScriptTrigger.return_value = 0 mock_library.niRFSG_DisableStartTrigger.side_effect = MockFunctionCallError("niRFSG_DisableStartTrigger") mock_library.niRFSG_DisableStartTrigger.return_value = 0 mock_library.niRFSG_ErrorMessage.side_effect = MockFunctionCallError("niRFSG_ErrorMessage") mock_library.niRFSG_ErrorMessage.return_value = 0 - mock_library.niRFSG_ErrorQuery.side_effect = MockFunctionCallError("niRFSG_ErrorQuery") - mock_library.niRFSG_ErrorQuery.return_value = 0 mock_library.niRFSG_GetAllNamedWaveformNames.side_effect = MockFunctionCallError("niRFSG_GetAllNamedWaveformNames") mock_library.niRFSG_GetAllNamedWaveformNames.return_value = 0 mock_library.niRFSG_GetAllScriptNames.side_effect = MockFunctionCallError("niRFSG_GetAllScriptNames") @@ -1142,8 +979,6 @@ def set_side_effects_and_return_values(self, mock_library): mock_library.niRFSG_GetAttributeViSession.return_value = 0 mock_library.niRFSG_GetAttributeViString.side_effect = MockFunctionCallError("niRFSG_GetAttributeViString") mock_library.niRFSG_GetAttributeViString.return_value = 0 - mock_library.niRFSG_GetChannelName.side_effect = MockFunctionCallError("niRFSG_GetChannelName") - mock_library.niRFSG_GetChannelName.return_value = 0 mock_library.niRFSG_GetDeembeddingSparameters.side_effect = MockFunctionCallError("niRFSG_GetDeembeddingSparameters") mock_library.niRFSG_GetDeembeddingSparameters.return_value = 0 mock_library.niRFSG_GetDeembeddingTableNumberOfPorts.side_effect = MockFunctionCallError("niRFSG_GetDeembeddingTableNumberOfPorts") @@ -1182,16 +1017,12 @@ def set_side_effects_and_return_values(self, mock_library): mock_library.niRFSG_QueryArbWaveformCapabilities.return_value = 0 mock_library.niRFSG_ReadAndDownloadWaveformFromFileTDMS.side_effect = MockFunctionCallError("niRFSG_ReadAndDownloadWaveformFromFileTDMS") mock_library.niRFSG_ReadAndDownloadWaveformFromFileTDMS.return_value = 0 - mock_library.niRFSG_ResetAttribute.side_effect = MockFunctionCallError("niRFSG_ResetAttribute") - mock_library.niRFSG_ResetAttribute.return_value = 0 mock_library.niRFSG_ResetDevice.side_effect = MockFunctionCallError("niRFSG_ResetDevice") mock_library.niRFSG_ResetDevice.return_value = 0 mock_library.niRFSG_ResetWithDefaults.side_effect = MockFunctionCallError("niRFSG_ResetWithDefaults") mock_library.niRFSG_ResetWithDefaults.return_value = 0 mock_library.niRFSG_ResetWithOptions.side_effect = MockFunctionCallError("niRFSG_ResetWithOptions") mock_library.niRFSG_ResetWithOptions.return_value = 0 - mock_library.niRFSG_RevisionQuery.side_effect = MockFunctionCallError("niRFSG_RevisionQuery") - mock_library.niRFSG_RevisionQuery.return_value = 0 mock_library.niRFSG_SaveConfigurationsToFile.side_effect = MockFunctionCallError("niRFSG_SaveConfigurationsToFile") mock_library.niRFSG_SaveConfigurationsToFile.return_value = 0 mock_library.niRFSG_SelectArbWaveform.side_effect = MockFunctionCallError("niRFSG_SelectArbWaveform") diff --git a/src/nirfsg/metadata/attributes.py b/src/nirfsg/metadata/attributes.py index 287bde7f9..44403da7e 100644 --- a/src/nirfsg/metadata/attributes.py +++ b/src/nirfsg/metadata/attributes.py @@ -1,152 +1,6 @@ # -*- coding: utf-8 -*- # This file is generated from NI-RFSG API metadata version 25.8.0d197 attributes = { - 1050002: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies whether to validate attribute values and function parameters. Range checking parameters is very useful for debugging. After you validate your program, set this attribute to VI_FALSE to disable range checking and maximize performance. NI-RFSG can choose to ignore range checking for particular attributes, regardless of the setting of this attribute. Use the nirfsg_InitWithOptions function to override the default value.\n\n**Default Value:** VI_TRUE\n\n**Supported Devices:** PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', - 'table_body': [ - [ - 'VI_TRUE', - 'Enable range checking.' - ], - [ - 'VI_FALSE', - 'Disable range checking.' - ] - ], - 'table_header': [ - 'Value', - 'Description' - ] - }, - 'lv_property': 'Inherent IVI Attributes:User Options:Range Check', - 'name': 'RANGE_CHECK', - 'type': 'ViBoolean' - }, - 1050003: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies whether NI-RFSG queries the NI-RFSG device status after each operation. Querying the device status is useful for debugging. After you validate your program, set this attribute to VI_FALSE to disable status checking and maximize performance.\n\nNI-RFSG can choose to ignore status checking for particular attributes, regardless of the setting of this attribute. Use the nirfsg_InitWithOptions function to override the default value.\n\n**Default Value:** VI_FALSE\n\n**Supported Devices:** PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', - 'table_body': [ - [ - 'VI_TRUE', - 'NI-RFSG queries the instrument status after each operation.' - ], - [ - 'VI_FALSE', - 'NI-RFSG does not query the instrument status.' - ] - ], - 'table_header': [ - 'Value', - 'Description' - ] - }, - 'lv_property': 'Inherent IVI Attributes:User Options:Query Instrument Status', - 'name': 'QUERY_INSTRUMENT_STATUS', - 'type': 'ViBoolean' - }, - 1050004: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies whether to cache the value of attributes. When caching is enabled, NI-RFSG tracks the current NI-RFSG device settings and avoids sending redundant commands to the device. NI-RFSG can always cache or never cache particular attributes, regardless of the setting of this attribute. Call the nirfsg_InitWithOptions function to override the default value.\n\n**Default Value:** VI_TRUE\n\n**Supported Devices:** PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', - 'table_body': [ - [ - 'VI_TRUE', - 'Enables caching.' - ], - [ - 'VI_FALSE', - 'Disables caching.' - ] - ], - 'table_header': [ - 'Value', - 'Description' - ] - }, - 'lv_property': 'Inherent IVI Attributes:User Options:Cache', - 'name': 'CACHE', - 'type': 'ViBoolean' - }, - 1050005: { - 'access': 'read only', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Returns whether NI-RFSG simulates I/O operations. This attribute is useful for debugging applications without using hardware. After a session is opened, you cannot change the simulation state. Use the nirfsg_InitWithOptions function to enable simulation.\n\n**Supported Devices:** PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', - 'table_body': [ - [ - 'VI_TRUE', - 'Simulation is enabled.' - ], - [ - 'VI_FALSE', - 'Simulation is disabled.' - ] - ], - 'table_header': [ - 'Value', - 'Description' - ] - }, - 'lv_property': 'Inherent IVI Attributes:User Options:Simulate', - 'name': 'SIMULATE', - 'type': 'ViBoolean' - }, - 1050006: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies whether the IVI engine keeps a list of the value coercions it makes for integer and real type attributes.\n\n**Default Value:** VI_FALSE\n\n**Supported Devices:** PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', - 'note': 'Enabling record value coercions is not supported.', - 'table_body': [ - [ - 'VI_TRUE', - 'The IVI engine keeps a list of coercions.' - ], - [ - 'VI_FALSE', - 'The IVI engine does not keep a list of coercions.' - ] - ], - 'table_header': [ - 'Value', - 'Description' - ] - }, - 'lv_property': 'Inherent IVI Attributes:User Options:Record Value Coercions', - 'name': 'RECORD_COERCIONS', - 'type': 'ViBoolean' - }, - 1050021: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies whether to perform interchangeability checking and retrieve interchangeability warnings.\n\n**Default Value:** VI_FALSE\n\n**Supported Devices:** PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Defined Values**:', - 'note': 'Enabling interchangeability check is not supported.', - 'table_body': [ - [ - 'VI_TRUE', - 'Interchange check is enabled.' - ], - [ - 'VI_FALSE', - 'Interchange check is disabled.' - ] - ], - 'table_header': [ - 'Value', - 'Description' - ] - }, - 'lv_property': 'Inherent IVI Attributes:User Options:Interchange Check', - 'name': 'INTERCHANGE_CHECK', - 'type': 'ViBoolean' - }, 1050302: { 'access': 'read only', 'codegen_method': 'public', @@ -201,7 +55,7 @@ 'access': 'read only', 'codegen_method': 'public', 'documentation': { - 'description': 'Returns a string that contains the firmware revision information for the NI-RFSG device you are currently using.\n\n**Supported Devices:** PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**High-Level Functions**:\n\n- nirfsg_RevisionQuery' + 'description': 'Returns a string that contains the firmware revision information for the NI-RFSG device you are currently using.\n\n**Supported Devices:** PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' }, 'lv_property': 'Inherent IVI Attributes:Instrument Identification:Firmware Revision', 'name': 'INSTRUMENT_FIRMWARE_REVISION', @@ -281,8 +135,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': 'Specifies the Reference Clock source. To set this attribute, the NI-RFSG device must be in the Configuration state. Only certain combinations of this attribute and the NIRFSG_ATTR_PXI_CHASSIS_CLK10_SOURCE attribute are valid, as shown in the following table.\n\n**Default Value:** OnboardClock\n\n**Supported Devices:** PXI-5610, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Timing Configurations `_\n\n**High-Level Functions**:\n\n- nirfsg_ConfigureRefClock\n\n**Possible Values**:', - 'note': 'The PXI-5670/5671 and PXIe-5672 devices also allow you to drive the PXI 10 MHz backplane clock on PXI chassis *only* using the NIRFSG_ATTR_PXI_CHASSIS_CLK10_SOURCE attribute.', + 'description': 'Specifies the Reference Clock source. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** OnboardClock\n\n**Supported Devices:** PXI-5610, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Timing Configurations `_\n\n**High-Level Functions**:\n\n- nirfsg_ConfigureRefClock\n\n**Possible Values**:', 'table_body': [ [ '"OnboardClock"', @@ -534,39 +387,11 @@ 'name': 'EXPORTED_START_TRIGGER_OUTPUT_TERMINAL', 'type': 'ViString' }, - 1150004: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies the clock source for driving the PXI 10 MHz backplane Reference Clock. This attribute is configurable if the PXI-5610 upconverter module is installed in *only* Slot 2 of a PXI chassis. To set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Possible Values**:\n\nPossible Value: Description\n\n"" :Do not drive the PXI_CLK10 signal.\n\n"OnboardClock" :Uses the highly stable oven-controlled onboard Reference Clock to drive the PXI_CLK signal.\n\n"RefIn" :Uses the clock present at the front panel REF IN connector to drive the PXI_CLK signal.\n\n**Default Value:** ""\n\n**Supported Devices:** PXI-5610, PXI-5670/5671\n\n**Related Topics**\n\n`Timing Configurations `_\n\n`System Reference Clock `_\n\n**High-Level Functions**:\n\n- nirfsg_ConfigurePxiChassisClk10\n\n\nOnly certain combinations of this attribute and the NIRFSG_ATTR_REF_CLOCK_SOURCE attribute are valid, as shown in the following table.', - 'table_body': [ - [ - '"", OnboardClock', - 'OnboardClock' - ], - [ - '"", RefIn', - 'RefIn' - ], - [ - '"", RefIn', - 'PXI_CLK' - ] - ], - 'table_header': [ - 'NIRFSG_ATTR_PXI_CHASSIS_CLK10_SOURCE Setting', - 'NIRFSG_ATTR_REF_CLOCK_SOURCE Setting' - ] - }, - 'lv_property': 'Clock:PXI Chassis Clk 10 Source', - 'name': 'PXI_CHASSIS_CLK10_SOURCE', - 'type': 'ViString' - }, 1150005: { 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': 'Specifies whether the driver maintains phase continuity in the arbitrary waveforms. When this attribute is set to NIRFSG_VAL_ENABLE, NI-RFSG may increase the waveform size. When this attribute is set to NIRFSG_VAL_ENABLE, the NIRFSG_ATTR_FREQUENCY_TOLERANCE attribute specifies the maximum allowable frequency error that can be introduced when keeping the signal phase-continuous. To set the NIRFSG_ATTR_PHASE_CONTINUITY_ENABLED attribute, the NI-RFSG device must be in the Configuration state. NIRFSG_ATTR_PHASE_CONTINUITY_ENABLED applies only when the NIRFSG_ATTR_GENERATION_MODE attribute is set to NIRFSG_VAL_ARB_WAVEFORM or NIRFSG_VAL_SCRIPT.\n\nPXI-5671: When using the PXI-5671 with I/Q rates less than or equal to 8.33MS/s, an input phase-continuous signal is always phase-continuous upon output, and this attribute has no effect.\n\nPXIe-5644/5645/5646, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: Phase continuity is *always* enabled on this device.\n\n**Default Value:** NIRFSG_VAL_AUTO\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Phase Continuity `_\n\n`Arb Waveform Mode Tuning Speed Factors `_\n\n**Defined Values**:', + 'description': 'Specifies whether the driver maintains phase continuity in the arbitrary waveforms. When this attribute is set to NIRFSG_VAL_ENABLE, NI-RFSG may increase the waveform size. To set the NIRFSG_ATTR_PHASE_CONTINUITY_ENABLED attribute, the NI-RFSG device must be in the Configuration state. NIRFSG_ATTR_PHASE_CONTINUITY_ENABLED applies only when the NIRFSG_ATTR_GENERATION_MODE attribute is set to NIRFSG_VAL_ARB_WAVEFORM or NIRFSG_VAL_SCRIPT.\n\nPXI-5671: When using the PXI-5671 with I/Q rates less than or equal to 8.33MS/s, an input phase-continuous signal is always phase-continuous upon output, and this attribute has no effect.\n\nPXIe-5644/5645/5646, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860: Phase continuity is *always* enabled on this device.\n\n**Default Value:** NIRFSG_VAL_AUTO\n\n**Supported Devices:** PXIe-5644/5645/5646, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860\n\n**Related Topics**\n\n`Phase Continuity `_\n\n`Arb Waveform Mode Tuning Speed Factors `_\n\n**Defined Values**:', 'table_body': [ [ 'NIRFSG_VAL_AUTO', @@ -595,16 +420,6 @@ 'name': 'PHASE_CONTINUITY_ENABLED', 'type': 'ViInt32' }, - 1150006: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies the allowable frequency error introduced during the software upconversion process. NI-RFSG may introduce a frequency error up to the specified amount to optimize computational speed and onboard memory usage while upconverting phase-continuous signals.\n\nIf the NIRFSG_ATTR_PHASE_CONTINUITY_ENABLED attribute is set to NIRFSG_VAL_DISABLE, the NIRFSG_ATTR_FREQUENCY_TOLERANCE attribute is ignored, and the driver does not introduce a frequency error. On devices that do not use software upconversion, this attribute is ignored. The PXI-5670 always uses software upconversion, and the PXI-5671 uses software upconversion for I/Q rates greater than 8.33MS/s.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Units**: hertz (Hz)\n\n**Default Value:** 50\n\n**Supported Devices:** PXI-5670/5671\n\n**Related Topics**\n\n`Phase Continuity `_' - }, - 'lv_property': 'RF:Frequency Tolerance (Hz)', - 'name': 'FREQUENCY_TOLERANCE', - 'type': 'ViReal64' - }, 1150007: { 'access': 'read-write', 'codegen_method': 'public', @@ -643,41 +458,6 @@ 'name': 'AUTOMATIC_THERMAL_CORRECTION', 'type': 'ViInt32' }, - 1150009: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies whether attenuator hold is enabled. While this attribute is set to VI_TRUE, changing the power level causes NI-RFSG to scale the digital data sent to the AWG instead of adjusting the attenuators. Changing power levels in this manner allows the device to increase or decrease the power level in more accurate increments, but it may affect signal-to-noise ratios (noise density).\n\nSetting the NIRFSG_ATTR_ATTENUATOR_HOLD_ENABLED attribute to VI_TRUE limits the power levels that can be attained. With attenuator hold enabled, the power level must satisfy the following conditions:\n\n- Power level less than or equal to NIRFSG_ATTR_ATTENUATOR_HOLD_MAX_POWER\n- Power level greater than or equal to (maximum power level -70dB)\n- Power level greater than or equal to -145dBm\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** VI_FALSE\n\n**Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E\n\n**Related Topics**\n\n`Attenuator Hold `_\n\n`Settling Times `_\n\n**Defined Values**:', - 'note': 'The frequency cannot be changed on the PXI-5670/5671 or PXIe-5672 while this attribute is set to VI_TRUE.', - 'table_body': [ - [ - 'VI_TRUE', - 'Enables attenuator hold.' - ], - [ - 'VI_FALSE', - 'Disables attenuator hold.' - ] - ], - 'table_header': [ - 'Value', - 'Description' - ] - }, - 'lv_property': 'RF:Attenuator Hold Enabled', - 'name': 'ATTENUATOR_HOLD_ENABLED', - 'type': 'ViBoolean' - }, - 1150010: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies the maximum power level of the RF output signal when the NIRFSG_ATTR_ATTENUATOR_HOLD_ENABLED attribute is set to VI_TRUE.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Units**: dBm\n\n**Defined Values**:\nRefer to the specifications document for your device for allowable maximum power levels.\n\n**Default Value:**\n\nPXI-5670/5671, PXIe-5672: 17\n\nPXIe-5673/5673E: 10\n\n**Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E\n\n**Related Topics**\n\n`Attenuator Hold `_\n\n`Settling Times `_' - }, - 'lv_property': 'RF:Attenuator Hold Max Power (dBm)', - 'name': 'ATTENUATOR_HOLD_MAX_POWER', - 'type': 'ViReal64' - }, 1150011: { 'access': 'read only', 'codegen_method': 'public', @@ -798,16 +578,6 @@ 'name': 'ARB_CARRIER_FREQUENCY', 'type': 'ViReal64' }, - 1150016: { - 'access': 'read only', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Indicates the average output power from the PXI-5421, PXI-5441, PXIe-5442, and PXIe-5450 AWG module. If an arbitrary waveform is being generated, this attribute specifies either the average power or the peak power of the signal, depending on the NIRFSG_ATTR_POWER_LEVEL_TYPE attribute setting.\n\n**Units**: dBm\n\n**Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E' - }, - 'lv_property': 'Arb:Arb Power (dBm)', - 'name': 'ARB_POWER', - 'type': 'ViReal64' - }, 1150017: { 'access': 'read only', 'codegen_method': 'public', @@ -1361,165 +1131,6 @@ 'name': 'ANALOG_MODULATION_TYPE', 'type': 'ViInt32' }, - 1150033: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies the type of waveform to use as the message signal for analog modulation.\n\n**Default Value:** NIRFSG_VAL_SINE\n\n**Supported Devices:** PXI/PXIe-5650/5651/5652\n\n**Related Topics**\n\n`Modulation Schemes `_\n\n**Defined Values**:', - 'table_body': [ - [ - 'NIRFSG_VAL_SINE', - '3000 (0xbb8)', - 'Specifies that the analog modulation waveform type is sine.' - ], - [ - 'NIRFSG_VAL_SQUARE', - '3001 (0xbb9)', - 'Specifies that the analog modulation waveform type is square.' - ], - [ - 'NIRFSG_VAL_TRIANGLE', - '3002 (0xbba)', - 'Specifies that the analog modulation waveform type is triangle.' - ] - ], - 'table_header': [ - 'Name', - 'Value', - 'Description' - ] - }, - 'enum': 'AnalogModulationWaveformType', - 'lv_property': 'Modulation:Analog:Waveform Type', - 'name': 'ANALOG_MODULATION_WAVEFORM_TYPE', - 'type': 'ViInt32' - }, - 1150034: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies the frequency of the waveform to use as the message signal in analog modulation.\n\n**Units:** hertz (Hz)\n\n**Default Value:** 1kHz\n\n**Supported Devices:** PXI/PXIe-5650/5651/5652\n\n**Related Topics**\n\n`Modulation Schemes `_' - }, - 'lv_property': 'Modulation:Analog:Waveform Frequency (Hz)', - 'name': 'ANALOG_MODULATION_WAVEFORM_FREQUENCY', - 'type': 'ViReal64' - }, - 1150035: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies the frequency deviation to use in frequency modulation.\n\n**Units**: hertz (Hz)\n\n**Default Value:** 1kHz\n\n**Supported Devices:** PXI/PXIe-5650/5651/5652\n\n**Related Topics**\n\n`Modulation Schemes `_' - }, - 'lv_property': 'Modulation:Analog:FM Deviation (Hz)', - 'name': 'ANALOG_MODULATION_FM_DEVIATION', - 'type': 'ViReal64' - }, - 1150036: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies the digital modulation format to use.\n\n**Default Value:** NIRFSG_VAL_NONE\n\n**Supported Devices:** PXI/PXIe-5650/5651/5652\n\n**Related Topics**\n\n`Modulation Schemes `_\n\n**Defined Values**:', - 'table_body': [ - [ - 'NIRFSG_VAL_FSK', - '4000 (0xfa0)', - 'Specifies that the digital modulation type is frequency-shift keying (FSK).' - ], - [ - 'NIRFSG_VAL_NONE', - '0 (0x0)', - 'Disables digital modulation.' - ], - [ - 'NIRFSG_VAL_OOK', - '4001 (0xfa1)', - 'Specifies that the digital modulation type is on-off keying (OOK).' - ], - [ - 'NIRFSG_VAL_PSK', - '4002 (0xfa2)', - 'Specifies that the digital modulation type is phase-shift keying (PSK).' - ] - ], - 'table_header': [ - 'Name', - 'Value', - 'Description' - ] - }, - 'enum': 'DigitalModulationType', - 'lv_property': 'Modulation:Digital:Modulation Type', - 'name': 'DIGITAL_MODULATION_TYPE', - 'type': 'ViInt32' - }, - 1150037: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies the symbol rate of the bit stream for digital modulation.\n\n**Units**: hertz (Hz)\n\n**Default Value:** 1kHz\n\n**Supported Devices:** PXI/PXIe-5650/5651/5652\n\n**Related Topics**\n\n`Modulation Schemes `_' - }, - 'lv_property': 'Modulation:Digital:Symbol Rate', - 'name': 'DIGITAL_MODULATION_SYMBOL_RATE', - 'type': 'ViReal64' - }, - 1150038: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies the type of waveform to use as the message signal in digital modulation.\n\n**Default Value:** NIRFSG_VAL_PRBS\n\n**Supported Devices:** PXI/PXIe-5650/5651/5652\n\n**Related Topics**\n\n`Modulation Schemes `_\n\n**Defined Values**:', - 'table_body': [ - [ - 'NIRFSG_VAL_PRBS', - '5000 (0x1388)', - 'Specifies that the digital modulation waveform type is pseudorandom bit sequence (PRBS).' - ], - [ - 'NIRFSG_VAL_USER_DEFINED', - '5001 (0x1389)', - 'Specifies that the digital modulation waveform type is user defined. To specify the user-defined waveform, call the niRFSG_ConfigureDigitalModulationUserDefinedWaveform function.' - ] - ], - 'table_header': [ - 'Name', - 'Value', - 'Description' - ] - }, - 'enum': 'DigitalModulationWaveformType', - 'lv_property': 'Modulation:Digital:Waveform Type', - 'name': 'DIGITAL_MODULATION_WAVEFORM_TYPE', - 'type': 'ViInt32' - }, - 1150039: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies the order of pseudorandom bit sequence (PRBS) internally generated by hardware and used as the message signal in digital modulation.\n\n**Default Value:** 16\n\n**Supported Devices:** PXI/PXIe-5650/5651/5652\n\n**Related Topics**\n\n`Modulation Schemes `_' - }, - 'lv_property': 'Modulation:Digital:PRBS Order', - 'name': 'DIGITAL_MODULATION_PRBS_ORDER', - 'type': 'ViInt32' - }, - 1150040: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies the seed of the internally generated pseudorandom bit sequence (PRBS).\n\n**Default Value:** 1\n\n**Supported Devices:** PXI/PXIe-5650/5651/5652\n\n**Related Topics**\n\n`Modulation Schemes `_' - }, - 'lv_property': 'Modulation:Digital:PRBS Seed', - 'name': 'DIGITAL_MODULATION_PRBS_SEED', - 'type': 'ViInt32' - }, - 1150041: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies the deviation to use in FSK modulation.\n\n**Units**: hertz (Hz)\n\n**Default Value:** 1,000\n\n**Supported Devices:** PXI/PXIe-5650/5651/5652\n\n**Related Topics**\n\n`Modulation Schemes `_' - }, - 'lv_property': 'Modulation:Digital:FSK Deviation (Hz)', - 'name': 'DIGITAL_MODULATION_FSK_DEVIATION', - 'type': 'ViReal64' - }, 1150042: { 'access': 'read-write', 'codegen_method': 'public', @@ -1578,30 +1189,6 @@ 'name': 'POWER_LEVEL_TYPE', 'type': 'ViInt32' }, - 1150044: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Enables or disables digital pattern on the PXI-5421/5441 AWG module. This attribute must be set to VI_TRUE to enable signal routing to and from the Digital Data & Control connector.\n\nTo set this attribute, the NI-RFSG device must be in the Configuration state.\n\n**Default Value:** VI_FALSE\n\n**Supported Devices:** PXI-5670/5671\n\n**Defined Values**:', - 'table_body': [ - [ - 'VI_TRUE', - 'Signal routing enabled.' - ], - [ - 'VI_FALSE', - 'Signal routing disabled.' - ] - ], - 'table_header': [ - 'Value', - 'Description' - ] - }, - 'lv_property': 'Arb:Digital Pattern', - 'name': 'DIGITAL_PATTERN', - 'type': 'ViBoolean' - }, 1150045: { 'access': 'read-write', 'codegen_method': 'public', @@ -1646,16 +1233,6 @@ 'name': 'STREAMING_SPACE_AVAILABLE_IN_WAVEFORM', 'type': 'ViInt64' }, - 1150048: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Indicates the number of samples to transfer at one time from the device to host memory. This attribute is useful when the total data to be transferred to onboard memory is large.\n\n**Units**: samples (s)\n\n**Default Value**: 1Ms\n\n**Supported Devices:** PXIe-5672/5673/5673E' - }, - 'lv_property': 'Arb:Data Transfer:Data Transfer Block Size', - 'name': 'DATA_TRANSFER_BLOCK_SIZE', - 'type': 'ViInt32' - }, 1150052: { 'access': 'read-write', 'codegen_method': 'public', @@ -1846,59 +1423,6 @@ ], 'type': 'ViInt32' }, - 1150056: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies the pulse-shaping filter type for the FIR filter. You can use this attribute only with signal generators that support onboard signal processing (OSP). NI-RFSG returns an error if you use this attribute with a device that does not support OSP.\n\n**Default Value:** NIRFSG_VAL_NONE\n\n**Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E\n\n**Defined Values**:', - 'table_body': [ - [ - 'NIRFSG_VAL_NONE', - '0 (0x0)', - 'Disables analog modulation.' - ], - [ - 'NIRFSG_VAL_ARB_FILTER_TYPE_RAISED_COSINE', - '10002 (0x2712)', - 'Applies a raised cosine filter to the data with the alpha value specified with the NIRFSG_ATTR_ARB_FILTER_RAISED_COSINE_ALPHA attribute.' - ], - [ - 'NIRFSG_VAL_ARB_FILTER_TYPE_ROOT_RAISED_COSINE', - '10001 (0x2711)', - 'Applies a root-raised cosine filter to the data with the alpha value specified with the NIRFSG_ATTR_ARB_FILTER_ROOT_RAISED_COSINE_ALPHA attribute.' - ] - ], - 'table_header': [ - 'Name', - 'Value', - 'Description' - ] - }, - 'enum': 'FilterType', - 'lv_property': 'Arb:Pulse Shaping:Filter Type', - 'name': 'ARB_FILTER_TYPE', - 'type': 'ViInt32' - }, - 1150057: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies the alpha value to use when calculating the pulse-shaping FIR filter coefficients. You can use this attribute only when the NIRFSG_ATTR_ARB_FILTER_TYPE attribute is set to NIRFSG_VAL_ARB_FILTER_TYPE_ROOT_RAISED_COSINE and with signal generators that support onboard signal processing (OSP). NI-RFSG returns an error if you use this attribute with a device that does not support OSP.\n\n**Supported Devices:** PXI-5671, PXIe-5672/5673/5673E' - }, - 'lv_property': 'Arb:Pulse Shaping:Root Raised Cosine Alpha', - 'name': 'ARB_FILTER_ROOT_RAISED_COSINE_ALPHA', - 'type': 'ViReal64' - }, - 1150060: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies the alpha value to use when calculating the pulse-shaping filter coefficients. You can use this attribute only when the NIRFSG_ATTR_ARB_FILTER_TYPE attribute is set to NIRFSG_VAL_ARB_FILTER_TYPE_RAISED_COSINE and with signal generators that support onboard signal processing (OSP). NI-RFSG returns an error if you use this attribute with a device that does not support OSP.\n\n**Supported Devices:** PXI-5671, PXIe-5672/5673/5673E' - }, - 'lv_property': 'Arb:Pulse Shaping:Raised Cosine Alpha', - 'name': 'ARB_FILTER_RAISED_COSINE_ALPHA', - 'type': 'ViReal64' - }, 1150061: { 'access': 'read only', 'codegen_method': 'public', @@ -2359,7 +1883,7 @@ 'access': 'read-write', 'codegen_method': 'public', 'documentation': { - 'description': 'Specifies the units of the NIRFSG_ATTR_IQ_I_OFFSET attribute and NIRFSG_ATTR_IQ_Q_OFFSET attribute. Offset units are either percent or volts.\n\nThe AWG or VST offset is the specified percentage of the AWG or VST peak power level when the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute is set to NIRFSG_VAL_PERCENT. Given perfect carrier leakage suppression, the following equation is satisfied\n\n\nor equivalently\n\nIf the NIRFSG_ATTR_IQ_I_OFFSET attribute is set to 100%, NIRFSG_ATTR_IQ_Q_OFFSET attribute is set to 0%, and NIRFSG_ATTR_POWER_LEVEL attribute set to 0 dBm, the desired RF signal is at 0 dBm and the carrier leakage is also at 0 dBm.\n\nThe AWG or VST peak power level changes when settings change in other attributes such as the NIRFSG_ATTR_POWER_LEVEL, NIRFSG_ATTR_FREQUENCY, NIRFSG_ATTR_IQ_SKEW, NIRFSG_ATTR_IQ_GAIN_IMBALANCE, NIRFSG_ATTR_ATTENUATOR_HOLD_ENABLED, and NIRFSG_ATTR_ARB_PRE_FILTER_GAIN attributes. When the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute is set to NIRFSG_VAL_PERCENT, the actual AWG or VST offset changes as the AWG or VST peak power level changes to satisfy the preceding equations. These changes are useful if you are intentionally adding carrier leakage to test the tolerance of a receiver. When the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute is set to NIRFSG_VAL_PERCENT, the carrier leakage, in dBc, remains at a consistent level.\n\nIf you are trying to eliminate residual carrier leakage due to calibration inaccuracies or drift, set the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute to NIRFSG_VAL_VOLTS. Offset correction voltage is applied to the I/Q modulator or VST, regardless of changes to the AWG or VST peak power level.\n\n**Default Value**: NIRFSG_VAL_PERCENT\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Defined Values**:', + 'description': 'Specifies the units of the NIRFSG_ATTR_IQ_I_OFFSET attribute and NIRFSG_ATTR_IQ_Q_OFFSET attribute. Offset units are either percent or volts.\n\nThe AWG or VST offset is the specified percentage of the AWG or VST peak power level when the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute is set to NIRFSG_VAL_PERCENT. Given perfect carrier leakage suppression, the following equation is satisfied\n\n\nor equivalently\n\nIf the NIRFSG_ATTR_IQ_I_OFFSET attribute is set to 100%, NIRFSG_ATTR_IQ_Q_OFFSET attribute is set to 0%, and NIRFSG_ATTR_POWER_LEVEL attribute set to 0 dBm, the desired RF signal is at 0 dBm and the carrier leakage is also at 0 dBm.\n\nThe AWG or VST peak power level changes when settings change in other attributes such as the NIRFSG_ATTR_POWER_LEVEL, NIRFSG_ATTR_FREQUENCY, NIRFSG_ATTR_IQ_SKEW, NIRFSG_ATTR_IQ_GAIN_IMBALANCE and NIRFSG_ATTR_ARB_PRE_FILTER_GAIN attributes. When the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute is set to NIRFSG_VAL_PERCENT, the actual AWG or VST offset changes as the AWG or VST peak power level changes to satisfy the preceding equations. These changes are useful if you are intentionally adding carrier leakage to test the tolerance of a receiver. When the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute is set to NIRFSG_VAL_PERCENT, the carrier leakage, in dBc, remains at a consistent level.\n\nIf you are trying to eliminate residual carrier leakage due to calibration inaccuracies or drift, set the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute to NIRFSG_VAL_VOLTS. Offset correction voltage is applied to the I/Q modulator or VST, regardless of changes to the AWG or VST peak power level.\n\n**Default Value**: NIRFSG_VAL_PERCENT\n\n**Supported Devices:** PXIe-5644/5645/5646, PXIe-5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842\n\n**Defined Values**:', 'note': 'For any devices except PXIe-5820, if the NIRFSG_ATTR_IQ_OFFSET_UNITS attribute is set to NIRFSG_VAL_VOLTS, a 0.1 I offset results in a 0.1 V offset in the output. For PXIe-5820 devices, 0.1 I offset results in a 10% offset in the output.', 'table_body': [ [ @@ -2444,47 +1968,6 @@ 'name': 'EXTERNAL_GAIN', 'type': 'ViReal64' }, - 1150086: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies the maximum amount of bus bandwidth to use for data transfers.\n\n**Units**: bytes per second\n\n**Default Value**: Device maximum\n\n**Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E\n\n**Related Topics**\n\n`Improving Streaming Performance `_' - }, - 'lv_property': 'Arb:Data Transfer:Maximum Bandwidth', - 'name': 'DATA_TRANSFER_MAXIMUM_BANDWIDTH', - 'type': 'ViReal64' - }, - 1150087: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies the preferred size of the data field in a PCI Express read request packet.\n\nIn general, the larger the packet size, the more efficiently the device uses the bus. By default, NI RF signal generators use the largest packet size allowed by the system. However, due to different system implementations, some systems may perform better with smaller packet sizes.\n\nRecommended values for this attribute are powers of two between 64 and 512.\n\n**Units**: bytes\n\n**Default Value**: Device maximum\n\n**Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E\n\n**Related Topics**\n\n`Improving Streaming Performance `_', - 'note': 'In some cases, the RF signal generator generates packets smaller than the preferred size you set with this attribute.' - }, - 'lv_property': 'Arb:Data Transfer:Advanced:Preferred Packet Size', - 'name': 'DATA_TRANSFER_PREFERRED_PACKET_SIZE', - 'type': 'ViInt32' - }, - 1150088: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Specifies the maximum number of concurrent PCI Express read requests the RF signal generator can issue.\n\nWhen transferring data from computer memory to device onboard memory across the PCI Express bus, the signal generator can issue multiple memory reads at the same time. In general, the larger the number of read requests, the more efficiently the device uses the bus because the multiple read requests keep the data flowing, even in a PCI Express topology that has high latency due to PCI Express switches in the data path. Most NI devices can issue a large number of read requests (typically 8 or 16). By default, this attribute is set to the highest value the RF signal generator supports.\n\nIf other devices in your system cannot tolerate long data latencies, it may be helpful to decrease the number of in-flight read requests the RF signal generator issues. This helps to reduce the amount of data the signal generator reads at one time.\n\n**Units**: number of packets\n\n**Default Value**: Device maximum\n\n**Supported Devices:** PXI-5670/5671, PXIe-5672/5673/5673E\n\n**Related Topics**\n\n`Improving Streaming Performance `_' - }, - 'lv_property': 'Arb:Data Transfer:Advanced:Maximum In-Flight Read Requests', - 'name': 'DATA_TRANSFER_MAXIMUM_IN_FLIGHT_READS', - 'type': 'ViInt32' - }, - 1150089: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': "Specifies the oscillator phase digital-to-analog converter (DAC) value on the arbitrary waveform generator (AWG). Use this attribute to reduce the trigger jitter when synchronizing multiple devices with NI-TClk. This attribute can also help maintain synchronization repeatability by writing a previous measurement's phase DAC value to the current session. This attribute is applicable only when using the NIRFSG_ATTR_ARB_SAMPLE_CLOCK_SOURCE attribute set to ClkIn.\n\n**Supported Devices:** PXIe-5673/5673E\n\n**Related Topics**\n\n`NI-TClk Overview `_" - }, - 'lv_property': 'Clock:Advanced:Arb Oscillator Phase DAC Value', - 'name': 'ARB_OSCILLATOR_PHASE_DAC_VALUE', - 'type': 'ViInt32' - }, 1150100: { 'access': 'read-write', 'attribute_class': 'AttributeViReal64TimeDeltaSeconds', @@ -2719,31 +2202,6 @@ 'type': 'ViReal64', 'type_in_documentation': 'hightime.timedelta, datetime.timedelta, or float in seconds' }, - 1150141: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Determines the inheritance behavior of the NIRFSG_ATTR_PEAK_POWER_ADJUSTMENT attribute when a script inherits values from specified waveforms.\n\n**Default Value:** NIRFSG_VAL_EXACT_MATCH\n\n**Supported Devices:** PXIe-5673/5673E\n\n**Related Topics**\n\n`Assigning Properties or Attributes to a Waveform `_\n\n**Defined Values**:', - 'table_body': [ - [ - 'NIRFSG_VAL_EXACT_MATCH', - 'Errors out if different values are detected in the script.' - ], - [ - 'NIRFSG_VAL_MINIMUM', - 'Uses the minimum value found in the script.' - ] - ], - 'table_header': [ - 'Value', - 'Description' - ] - }, - 'enum': 'PpaInheritance', - 'lv_property': 'RF:Peak Power Adjustment Inheritance', - 'name': 'PEAK_POWER_ADJUSTMENT_INHERITANCE', - 'type': 'ViInt32' - }, 1150142: { 'access': 'read-write', 'codegen_method': 'public', @@ -4397,30 +3855,6 @@ 'name': 'AVAILABLE_PATHS', 'type': 'ViString' }, - 1152832: { - 'access': 'read-write', - 'codegen_method': 'public', - 'documentation': { - 'description': 'Enables or disables compensation for filter group delay on the AWG module. This attribute also accounts for the upconverter group delay and aligns the RF output with the Started Event, Done Event, and Marker Events.\n\nAt a low I/Q rate, the group delay can become so large that some devices may not be able to align the events with the RF output, in which case you must increase the I/Q rate or disable this attribute.\n\n**Default Value:** VI_FALSE\n\n**Supported Devices:** PXIe-5672\n\n**Defined Values**:', - 'table_body': [ - [ - 'VI_TRUE', - 'Enables compensation for filter group delay.' - ], - [ - 'VI_FALSE', - 'Disables compensation for filter group delay.' - ] - ], - 'table_header': [ - 'Value', - 'Description' - ] - }, - 'lv_property': 'Arb:Advanced:Compensate for Filter Group Delay', - 'name': 'COMPENSATE_FOR_FILTER_GROUP_DELAY', - 'type': 'ViBoolean' - }, 1154097: { 'access': 'read-write', 'codegen_method': 'public', diff --git a/src/nirfsg/metadata/enums.py b/src/nirfsg/metadata/enums.py index bab928fa4..a6f0cd99d 100644 --- a/src/nirfsg/metadata/enums.py +++ b/src/nirfsg/metadata/enums.py @@ -133,31 +133,6 @@ } ] }, - 'AnalogModulationWaveformType': { - 'values': [ - { - 'documentation': { - 'description': 'Specifies that the analog modulation waveform type is sine.' - }, - 'name': 'NIRFSG_VAL_SINE', - 'value': 3000 - }, - { - 'documentation': { - 'description': 'Specifies that the analog modulation waveform type is square.' - }, - 'name': 'NIRFSG_VAL_SQUARE', - 'value': 3001 - }, - { - 'documentation': { - 'description': 'Specifies that the analog modulation waveform type is triangle.' - }, - 'name': 'NIRFSG_VAL_TRIANGLE', - 'value': 3002 - } - ] - }, 'ArbOnboardSampleClockMode': { 'values': [ { @@ -273,56 +248,6 @@ } ] }, - 'DigitalModulationType': { - 'values': [ - { - 'documentation': { - 'description': 'Disables digital modulation.' - }, - 'name': 'NIRFSG_VAL_NONE', - 'value': 0 - }, - { - 'documentation': { - 'description': 'Specifies that the digital modulation type is frequency-shift keying (FSK).' - }, - 'name': 'NIRFSG_VAL_FSK', - 'value': 4000 - }, - { - 'documentation': { - 'description': 'Specifies that the digital modulation type is on-off keying (OOK).' - }, - 'name': 'NIRFSG_VAL_OOK', - 'value': 4001 - }, - { - 'documentation': { - 'description': 'Specifies that the digital modulation type is phase-shift keying (PSK).' - }, - 'name': 'NIRFSG_VAL_PSK', - 'value': 4002 - } - ] - }, - 'DigitalModulationWaveformType': { - 'values': [ - { - 'documentation': { - 'description': 'Specifies that the digital modulation waveform type is pseudorandom bit sequence (PRBS).' - }, - 'name': 'NIRFSG_VAL_PRBS', - 'value': 5000 - }, - { - 'documentation': { - 'description': 'Specifies that the digital modulation waveform type is user defined. To specify the user-defined waveform, call the nirfsg_ConfigureDigitalModulationUserDefinedWaveform function.' - }, - 'name': 'NIRFSG_VAL_USER_DEFINED', - 'value': 5001 - } - ] - }, 'DirectDownload': { 'values': [ { @@ -348,31 +273,6 @@ } ] }, - 'FilterType': { - 'values': [ - { - 'documentation': { - 'description': 'No filter type is applied.' - }, - 'name': 'NIRFSG_VAL_NONE', - 'value': 0 - }, - { - 'documentation': { - 'description': 'Applies a root-raised cosine filter to the data with the alpha value specified with the NIRFSG_ATTR_ARB_FILTER_ROOT_RAISED_COSINE_ALPHA attribute.' - }, - 'name': 'NIRFSG_VAL_ARB_FILTER_TYPE_ROOT_RAISED_COSINE', - 'value': 10001 - }, - { - 'documentation': { - 'description': 'Applies a raised cosine filter to the data with the alpha value specified with the NIRFSG_ATTR_ARB_FILTER_RAISED_COSINE_ALPHA attribute.' - }, - 'name': 'NIRFSG_VAL_ARB_FILTER_TYPE_RAISED_COSINE', - 'value': 10002 - } - ] - }, 'Format': { 'values': [ { @@ -767,31 +667,6 @@ } ] }, - 'PpaInheritance': { - 'values': [ - { - 'documentation': { - 'description': 'Errors out if different values are detected in the script.' - }, - 'name': 'NIRFSG_VAL_EXACT_MATCH', - 'value': 0 - }, - { - 'documentation': { - 'description': 'Uses the minimum value found in the script.' - }, - 'name': 'NIRFSG_VAL_MINIMUM', - 'value': 1 - }, - { - 'documentation': { - 'description': 'Uses the maximum value found in the script.' - }, - 'name': 'NIRFSG_VAL_MAXIMUM', - 'value': 2 - } - ] - }, 'PulseModulationMode': { 'values': [ { diff --git a/src/nirfsg/metadata/functions.py b/src/nirfsg/metadata/functions.py index 6fe04d2fc..f20b5a18c 100644 --- a/src/nirfsg/metadata/functions.py +++ b/src/nirfsg/metadata/functions.py @@ -125,370 +125,6 @@ ], 'returns': 'ViStatus' }, - 'CheckAttributeViBoolean': { - 'codegen_method': 'public', - 'documentation': { - 'description': '\nChecks the validity of a value you specify for a ViBoolean attribute.' - }, - 'included_in_proto': True, - '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. The ViSession handle is obtained from the nirfsg_Init function or the nirfsg_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 waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' - }, - 'name': 'channelName', - 'type': 'ViConstString', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Pass the ID of an attribute.' - }, - 'name': 'attribute', - 'grpc_name': 'attribute_id', - 'type': 'ViAttr', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Pass the value that you want to verify as a valid value for the attribute.', - 'note': 'Some of the values might not be valid depending on the current settings of the instrument session.' - }, - 'name': 'value', - 'type': 'ViBoolean', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'returns': 'ViStatus' - }, - 'CheckAttributeViInt32': { - 'codegen_method': 'public', - 'documentation': { - 'description': '\nChecks the validity of a value you specify for a ViInt32 attribute.' - }, - 'included_in_proto': True, - '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. The ViSession handle is obtained from the nirfsg_Init function or the nirfsg_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 waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' - }, - 'name': 'channelName', - 'type': 'ViConstString', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Pass the ID of an attribute.' - }, - 'name': 'attribute', - 'grpc_name': 'attribute_id', - 'type': 'ViAttr', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Pass the value that you want to verify as a valid value for the attribute.', - 'note': 'Some of the values might not be valid depending on the current settings of the instrument session.' - }, - 'grpc_enum': 'NiRFSGInt32AttributeValues', - 'name': 'value', - 'type': 'ViInt32', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'returns': 'ViStatus' - }, - 'CheckAttributeViInt64': { - 'codegen_method': 'public', - 'documentation': { - 'description': '\nChecks the validity of a value you specify for a ViInt64 attribute.' - }, - 'included_in_proto': True, - '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. The ViSession handle is obtained from the nirfsg_Init function or the nirfsg_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 waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' - }, - 'name': 'channelName', - 'type': 'ViConstString', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Pass the ID of an attribute.' - }, - 'name': 'attribute', - 'grpc_name': 'attribute_id', - 'type': 'ViAttr', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Pass the value that you want to verify as a valid value for the attribute.', - 'note': 'Some of the values might not be valid depending on the current settings of the instrument session.' - }, - 'grpc_enum': 'NiRFSGInt64AttributeValues', - 'name': 'value', - 'type': 'ViInt64', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'returns': 'ViStatus' - }, - 'CheckAttributeViReal64': { - 'codegen_method': 'public', - 'documentation': { - 'description': '\nChecks the validity of a value you specify for a ViReal64 attribute.' - }, - 'included_in_proto': True, - '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. The ViSession handle is obtained from the nirfsg_Init function or the nirfsg_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 waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' - }, - 'name': 'channelName', - 'type': 'ViConstString', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Pass the ID of an attribute.' - }, - 'name': 'attribute', - 'grpc_name': 'attribute_id', - 'type': 'ViAttr', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Pass the value that you want to verify as a valid value for the attribute.', - 'note': 'Some of the values might not be valid depending on the current settings of the instrument session.' - }, - 'grpc_enum': 'NiRFSGReal64AttributeValues', - 'name': 'value', - 'type': 'ViReal64', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'returns': 'ViStatus' - }, - 'CheckAttributeViSession': { - 'codegen_method': 'public', - 'documentation': { - 'description': '\nChecks the validity of a value you specify for a ViSession attribute.' - }, - 'included_in_proto': True, - '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. The ViSession handle is obtained from the nirfsg_Init function or the nirfsg_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 waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' - }, - 'name': 'channelName', - 'type': 'ViConstString', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Pass the ID of an attribute.' - }, - 'name': 'attribute', - 'grpc_name': 'attribute_id', - 'type': 'ViAttr', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Pass the value that you want to verify as a valid value for the attribute.', - 'note': 'Some of the values might not be valid depending on the current settings of the instrument session.' - }, - 'name': 'value', - 'type': 'ViSession', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'returns': 'ViStatus' - }, - 'CheckAttributeViString': { - 'codegen_method': 'public', - 'documentation': { - 'description': '\nChecks the validity of a value you specify for a ViString attribute.' - }, - 'included_in_proto': True, - '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. The ViSession handle is obtained from the nirfsg_Init function or the nirfsg_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 waveform name and the marker name.\n\nExample:\n\n"waveform::waveform0/marker0"' - }, - 'name': 'channelName', - 'type': 'ViConstString', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Pass the ID of an attribute.' - }, - 'name': 'attribute', - 'grpc_name': 'attribute_id', - 'type': 'ViAttr', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Pass the value that you want to verify as a valid value for the attribute. The value must be a NULL-terminated string.', - 'note': 'Some of the values might not be valid depending on the current settings of the instrument session.' - }, - 'grpc_mapped_enum': 'NiRFSGStringAttributeValuesMapped', - 'name': 'value', - 'type': 'ViConstString', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'returns': 'ViStatus' - }, 'CheckGenerationStatus': { 'codegen_method': 'public', 'documentation': { @@ -731,35 +367,6 @@ ], 'returns': 'ViStatus' }, - 'ClearError': { - 'codegen_method': 'public', - 'documentation': { - 'description': '\nClears the error information associated with the session.\n\nIf you pass VI_NULL for the NIRFSG_ATTR_VI parameter, this function clears the error information for the current execution thread.\n\nThe IVI Engine also maintains this error information separately for each thread. This feature of the IVI Engine is useful if you do not have a session handle to pass to the nirfsg_ClearError function or the nirfsg_GetError function, which occurs when a call to the nirfsg_Init function or the nirfsg_InitWithOptions function fails.\n\n**Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860', - 'note': 'The nirfsg_GetError function clears the error information after it is retrieved. A call to the nirfsg_ClearError function is necessary only when you do not use a call to the nirfsg_GetError function to retrieve error information.' - }, - 'included_in_proto': True, - '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. The ViSession handle is obtained from the nirfsg_Init function or the nirfsg_InitWithOptions function and identifies a particular instrument session.' - }, - 'name': 'vi', - 'type': 'ViSession', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'returns': 'ViStatus' - }, 'ClearSelfCalibrateRange': { 'codegen_method': 'public', 'documentation': { @@ -1141,123 +748,33 @@ }, 'is_repeated_capability': True, 'name': 'triggerId', - 'repeated_capability_type': 'script_triggers', - 'type': 'ViConstString', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Specifies the trigger source terminal for the digital level Script Trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_SOURCE attribute to this value.' - }, - 'name': 'source', - 'type': 'ViConstString', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Specifies the active level for the digital level Script Trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_ACTIVE_LEVEL attribute to this value.' - }, - 'name': 'level', - 'type': 'ViInt32', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'repeated_capability_type': 'script_triggers', - 'returns': 'ViStatus' - }, - 'ConfigureDigitalModulationUserDefinedWaveform': { - 'codegen_method': 'public', - 'documentation': { - 'description': '\nSpecifies the message signal used for digital modulation when the NIRFSG_ATTR_DIGITAL_MODULATION_WAVEFORM_TYPE attribute is set to NIRFSG_VAL_USER_DEFINED.\n\n**Supported Devices** : PXI/PXIe-5650/5651/5652' - }, - 'included_in_proto': True, - 'method_templates': [ - { - '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. The ViSession handle is obtained from the nirfsg_Init function or the nirfsg_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 number of samples in the message signal.' - }, - 'name': 'numberOfSamples', - 'type': 'ViInt32', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Specifies the user-defined message signal used for digital modulation.' - }, - 'name': 'userDefinedWaveform', - 'size': { - 'mechanism': 'passed-in', - 'value': 'numberOfSamples' - }, - 'type': 'ViInt8[]', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'returns': 'ViStatus' - }, - 'ConfigurePxiChassisClk10': { - 'codegen_method': 'public', - 'documentation': { - 'description': '\nSpecifies the signal to drive the 10MHz Reference Clock on the PXI backplane.\n\nThis option can only be configured when the PXI-5610 is in Slot 2 of the PXI chassis. The NI-RFSG device must be in the Configuration state before you call this function.\n\n**Supported Devices** : PXI-5610, PXI-5670/5671\n\n**Related Topics**\n\n`Timing Configurations `_\n\n`System Reference Clock `_' - }, - 'included_in_proto': True, - 'method_templates': [ - { - 'documentation_filename': 'default_method', - 'library_interpreter_filename': 'default_method', - 'method_python_name_suffix': '', - 'session_filename': 'default_method' - } - ], - 'parameters': [ + 'repeated_capability_type': 'script_triggers', + 'type': 'ViConstString', + 'use_array': False, + 'use_in_python_api': True + }, { 'direction': 'in', 'documentation': { - 'description': 'Identifies your instrument session. The ViSession handle is obtained from the nirfsg_Init function or the nirfsg_InitWithOptions function and identifies a particular instrument session.' + 'description': 'Specifies the trigger source terminal for the digital level Script Trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_SOURCE attribute to this value.' }, - 'name': 'vi', - 'type': 'ViSession', + 'name': 'source', + 'type': 'ViConstString', 'use_array': False, 'use_in_python_api': True }, { 'direction': 'in', 'documentation': { - 'description': 'Specifies the source of the Reference Clock signal.' + 'description': 'Specifies the active level for the digital level Script Trigger. NI-RFSG sets the NIRFSG_ATTR_DIGITAL_LEVEL_SCRIPT_TRIGGER_ACTIVE_LEVEL attribute to this value.' }, - 'name': 'pxiClk10Source', - 'type': 'ViConstString', + 'name': 'level', + 'type': 'ViInt32', 'use_array': False, 'use_in_python_api': True } ], + 'repeated_capability_type': 'script_triggers', 'returns': 'ViStatus' }, 'ConfigureRF': { @@ -1749,34 +1266,6 @@ ], 'returns': 'ViStatus' }, - 'Disable': { - 'codegen_method': 'public', - 'documentation': { - 'description': '\nPlaces the instrument in a quiescent state where it has minimal or no impact on the system to which it is connected.\n\n**Supported Devices** : PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXI-5670/5671, PXIe-5672/5673/5673E' - }, - 'included_in_proto': True, - 'method_templates': [ - { - '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. The ViSession handle is obtained from the nirfsg_Init function or the nirfsg_InitWithOptions function and identifies a particular instrument session.' - }, - 'name': 'vi', - 'type': 'ViSession', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'returns': 'ViStatus' - }, 'DisableScriptTrigger': { 'codegen_method': 'public', 'documentation': { @@ -1901,58 +1390,6 @@ 'returns': 'ViStatus', 'use_session_lock': False }, - 'ErrorQuery': { - 'codegen_method': 'public', - 'documentation': { - 'description': '\nReads an error code and an error message from the instrument error queue.\n\n**Supported Devices** : PXI-5610, PXIe-5611, PXI/PXIe-5650/5651/5652, PXIe-5653, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5840/5841/5842/5860' - }, - 'included_in_proto': True, - '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. The ViSession handle is obtained from the nirfsg_Init function or the nirfsg_InitWithOptions function and identifies a particular instrument session.' - }, - 'name': 'vi', - 'type': 'ViSession', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'out', - 'documentation': { - 'description': 'Returns the error code read from the instrument error queue.' - }, - 'name': 'errorCode', - 'type': 'ViInt32', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'out', - 'documentation': { - 'description': 'Returns the error message string read from the instrument error message queue.\n\nYou must pass a ViChar array with at least 256 bytes.' - }, - 'name': 'errorMessage', - 'size': { - 'mechanism': 'fixed', - 'value': 256 - }, - 'type': 'ViChar[]', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'returns': 'ViStatus' - }, 'FancyCreateDeembeddingSparameterTableArray': { 'codegen_method': 'python-only', 'documentation': { @@ -2601,68 +2038,6 @@ ], 'returns': 'ViStatus' }, - 'GetChannelName': { - 'codegen_method': 'public', - 'documentation': { - 'description': '\nReturns the channel string that is in the channel table at an index you specify.\n\n**Supported Devices** : PXI-5670/5671, PXIe-5672/5673/5673E' - }, - 'included_in_proto': True, - 'method_templates': [ - { - '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. The ViSession handle is obtained from the nirfsg_Init function or the nirfsg_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 a one-based index into the channel table.' - }, - 'name': 'index', - 'type': 'ViInt32', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Specifies the size of the buffer for the channel string.' - }, - 'name': 'bufferSize', - 'type': 'ViInt32', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'out', - 'documentation': { - 'description': 'Returns a channel string from the channel table at the index you specify in the Index parameter. Do not modify the contents of the channel string.' - }, - 'name': 'name', - 'size': { - 'mechanism': 'ivi-dance', - 'value': 'bufferSize' - }, - 'type': 'ViChar[]', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'returns': 'ViStatus' - }, 'GetDeembeddingSparameters': { 'codegen_method': 'private', 'documentation': { @@ -3647,33 +3022,7 @@ 'default_value': '""', 'direction': 'in', 'documentation': { - 'description': 'Specifies the initial value of certain attributes for the session. The following table lists the attributes and the name you pass in this parameter to identify the attribute.\n\nThe format of this string consists of the following relations:\n"AttributeName=Value"\n\nwhere\n*AttributeName* is the name of the attribute and *Value* is the value to which the attribute is set. To set multiple attributes, separate their assignments with a comma, as shown in the following option string:\n\n"RangeCheck=1,QueryInstrStatus=0,Cache=1,DriverSetup=AWG:pxi1slot4"\n\nThe `DriverSetup string `_ is required in order to simulate a specific device.', - 'table_body': [ - [ - 'RangeCheck', - 'NIRFSG_ATTR_RANGE_CHECK' - ], - [ - 'QueryInstrStatus', - 'NIRFSG_ATTR_QUERY_INSTRUMENT_STATUS' - ], - [ - 'Cache', - 'NIRFSG_ATTR_CACHE' - ], - [ - 'RecordCoercions', - 'NIRFSG_ATTR_RECORD_COERCIONS' - ], - [ - 'Simulate', - 'NIRFSG_ATTR_SIMULATE' - ] - ], - 'table_header': [ - 'Name', - 'Attribute Name' - ] + 'description': 'Specifies the initial value of certain attributes for the session. The following table lists the attributes and the name you pass in this parameter to identify the attribute.\n\nThe format of this string consists of the following relations:\n"AttributeName=Value"\n\nwhere\n*AttributeName* is the name of the attribute and *Value* is the value to which the attribute is set. To set multiple attributes, separate their assignments with a comma, as shown in the following option string:\n\n"RangeCheck=1,QueryInstrStatus=0,Cache=1,DriverSetup=AWG:pxi1slot4"\n\nThe `DriverSetup string `_ is required in order to simulate a specific device.' }, 'name': 'optionString', 'python_api_converter_name': 'convert_init_with_options_dictionary', @@ -3987,54 +3336,6 @@ ], 'returns': 'ViStatus' }, - 'ResetAttribute': { - 'codegen_method': 'public', - 'documentation': { - 'description': '\nResets the attribute to its default value.\n\n**Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' - }, - 'included_in_proto': True, - 'method_templates': [ - { - '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. The ViSession handle is obtained from the nirfsg_Init function or the nirfsg_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 channel.' - }, - 'name': 'channelName', - 'type': 'ViConstString', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'in', - 'documentation': { - 'description': 'Pass the ID of an attribute.' - }, - 'name': 'attributeId', - 'type': 'ViAttr', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'returns': 'ViStatus' - }, 'ResetDevice': { 'codegen_method': 'public', 'documentation': { @@ -4165,62 +3466,6 @@ ], 'returns': 'ViStatus' }, - 'RevisionQuery': { - 'codegen_method': 'public', - 'documentation': { - 'description': '\nReturns the revision numbers of the NI-RFSG driver and the instrument firmware.\n\n**Supported Devices** : PXI-5610, PXIe-5611, PXIe-5644/5645/5646, PXI/PXIe-5650/5651/5652, PXIe-5653/5654/5654 with PXIe-5696, PXI-5670/5671, PXIe-5672/5673/5673E, PXIe-5820/5830/5831/5832/5840/5841/5842/5860' - }, - 'included_in_proto': True, - 'method_templates': [ - { - '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. The ViSession handle is obtained from the nirfsg_Init function or the nirfsg_InitWithOptions function and identifies a particular instrument session.' - }, - 'name': 'vi', - 'type': 'ViSession', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'out', - 'documentation': { - 'description': 'Returns the value of the NIRFSG_ATTR_SPECIFIC_DRIVER_REVISION attribute in the form of a string.\n\nYou must pass a ViChar array with at least 256 bytes.' - }, - 'name': 'instrumentDriverRevision', - 'size': { - 'mechanism': 'fixed', - 'value': 256 - }, - 'type': 'ViChar[]', - 'use_array': False, - 'use_in_python_api': True - }, - { - 'direction': 'out', - 'documentation': { - 'description': 'Returns the value of the NIRFSG_ATTR_INSTRUMENT_FIRMWARE_REVISION attribute in the form of a string.\n\nYou must pass a ViChar array with at least 256 bytes.' - }, - 'name': 'firmwareRevision', - 'size': { - 'mechanism': 'fixed', - 'value': 256 - }, - 'type': 'ViChar[]', - 'use_array': False, - 'use_in_python_api': True - } - ], - 'returns': 'ViStatus' - }, 'SaveConfigurationsToFile': { 'codegen_method': 'public', 'documentation': { From ab05ba93541bf4d6e784b41a309f723ddb315058 Mon Sep 17 00:00:00 2001 From: vnktshr21 Date: Thu, 20 Nov 2025 17:25:45 +0530 Subject: [PATCH 2/3] adding changelog --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index fc6172790..aa54d65fe 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1693,6 +1693,8 @@ - Changed - Fixed the return type of `get_all_script_names` and `get_all_named_waveform_names` to remove the size parameter and return a list of strings instead of a comma-separated string - Removed + - Methods and properties applicable only to hardware which are not supported anymore + - Methods and properties which are necessary for IVI compliance of the driver, but are not applicable for Python #### [nirfsg] 1.0.0 - 2025-08-05 - Added From 6fe67472c6d71981aa93cb958433f9186967f264 Mon Sep 17 00:00:00 2001 From: Venkatesh R <12389486+vnktshr21@users.noreply.github.com> Date: Mon, 8 Dec 2025 14:53:27 +0530 Subject: [PATCH 3/3] Added list of removed methods and properties Updated CHANGELOG to reflect method and property removals, including those not supported anymore and those necessary for IVI compliance but not applicable for Python. --- CHANGELOG.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 49 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index aa54d65fe..3e9c26e77 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1694,7 +1694,55 @@ - Fixed the return type of `get_all_script_names` and `get_all_named_waveform_names` to remove the size parameter and return a list of strings instead of a comma-separated string - Removed - Methods and properties applicable only to hardware which are not supported anymore + - Methods + - `configure_digital_modulation_user_defined_waveform` + - `configure_pxi_chassis_clk10` + - Properties + - `analog_modulation_fm_deviation` + - `analog_modulation_waveform_frequency` + - `arb_filter_raised_cosine_alpha` + - `arb_filter_root_raised_cosine_alpha` + - `arb_filter_type` + - `arb_oscillator_phase_dac_value` + - `arb_power` + - `attenuator_hold_enabled` + - `attenuator_hold_max_power` + - `compensate_for_filter_group_delay` + - `data_transfer_block_size` + - `data_transfer_maximum_bandwidth` + - `data_transfer_maximum_in_flight_reads` + - `data_transfer_preferred_packet_size` + - `digital_modulation_fsk_deviation` + - `digital_modulation_prbs_order` + - `digital_modulation_prbs_seed` + - `digital_modulation_symbol_rate` + - `digital_modulation_type` + - `digital_modulation_waveform_type` + - `digital_pattern` + - `frequency_tolerance` + - `peak_power_adjustment_inheritance` + - `pxi_chassis_clk10_source` - Methods and properties which are necessary for IVI compliance of the driver, but are not applicable for Python + - Methods + - `check_attribute_vi_boolean` + - `check_attribute_vi_int32` + - `check_attribute_vi_int64` + - `check_attribute_vi_real64` + - `check_attribute_vi_session` + - `check_attribute_vi_string` + - `clear_error` + - `disable` + - `error_query` + - `get_channel_name` + - `reset_attribute` + - `revision_query` + - Properties + - `cache` + - `interchange_check` + - `query_instrument_status` + - `range_check` + - `record_coercions` + - `simulate` #### [nirfsg] 1.0.0 - 2025-08-05 - Added @@ -2693,4 +2741,4 @@ and this project adheres to [Python Versioning](http://legacy.python.org/dev/pep - Added - Changed - Removed ---> \ No newline at end of file +-->